\n Terrain - A Terra development environment for seamless smart contract development.\n
\n\n
\n \n \n \n
\n\n---\n\nTerrain allows you to:\n\n- Scaffold a template smart contract and frontend for app development.\n- Dramatically simplify the development and deployment process.\n\nTerrain is **not**:\n\n- A fully-featured Terra command-line interface (CLI). If you need a fully-featured client, use terrad.\n- A Light Client Daemon (LCD). You will still need an RPC endpoint to deploy your contract. LocalTerra is the recommended option for this.\n\n---\n\n# Table of contents\n\n\n* [Terrain](#terrain)\n* [Table of contents](#table-of-contents)\n* [Setup](#setup)\n* [Getting Started](#getting-started)\n* [Migrating CosmWasm Contracts on Terra](#migrating-cosmwasm-contracts-on-terra)\n* [Use Terrain Main Branch Locally](#use-terrain-main-branch-locally)\n* [Terrain Commands](#terrain-commands)\n\n\n# Setup\n\n## Download LocalTerra\n\nFor testing purposes, we recommend to install and run LocalTerra on your personal computer. Instructions on how to get LocalTerra up and running can be found in the \nLocalTerra documentation.\n\n**Note:** _If you are using a Mac with an M1 chip, you might need to update your Docker Desktop due to the qemu bug._\n\nOnce all dependencies have been installed, do the following:\n\n1. Clone the LocalTerra repo.\n\n```\ngit clone https://github.com/terra-money/LocalTerra.git\n```\n\n2. Navigate to the newly created `LocalTerra` directory.\n\n```\ncd LocalTerra\n```\n\n3. Spin up an instance of the environment with `docker-compose`.\n\n```\ndocker-compose up\n```\n\n## Setup Rust\n\nWhile WASM smart contracts can be written in any programming language, **it is strongly recommended that you use Rust**, as it is the only language for which mature libraries and tooling exist for CosmWasm. To complete this tutorial, install the latest version of Rust by following the instructions here. Once Rust is installed on your computer, do the following:\n\n1. Set the default release channel used to update Rust to stable.\n\n```sh\nrustup default stable\n```\n\n2. Add wasm as the compilation target.\n\n```sh\nrustup target add wasm32-unknown-unknown\n```\n\n3. Install the necessary dependencies for generating contracts.\n\n```sh\ncargo install cargo-run-script\n```\n\n## Install Node JS and NPM\n\nTo run Terrain, you will need to install version 16 of Node.js and download Node Package Manager (npm). It is recommend that you install [Node.js v16 (LTS)](https://nodejs.org/en/download/). If you download the LTS version of Node.js v16, npm will be automatically installed along with your download.\n\n# Getting Started\n\nNow that you have completed the initial setup, generate your first smart contract using the procedure described below.\n\n1. Install the terrain package globally.\n\n```sh\nnpm install -g @terra-money/terrain\n```\n\n**Note:** _If you would like to install terrain locally, you can execute the command `npm install @terra-money/terrain`, without the `-g` flag, while in the directory in which you would like to be able to use the package. You can then execute any terrain commands by prefixing them with `npx`. For example, to scaffold a new project named `my-terra-dapp` with a locally installed terrain package, you would use the command `npx terrain new my-terra-dapp`._\n\n2. Generate your smart contract and corresponding frontend templates.\n\n```sh\nterrain new my-terra-dapp\n```\n\n3. After the project is generated and all necessary Node dependencies are installed, navigate to the new `my-terra-dapp` directory to interact with your app.\n\n```sh\ncd my-terra-dapp\n```\n\n## Project Structure\n\nThe `terrain new` command generates a project that contains a template smart contract, which is named after the specified app name, `my-terra-dapp`, and a corresponding frontend. Other supporting files are generated to provide further functionality. You may view the project structure below.\n\n```\n.\n├── contracts # the smart contract directory\n│ ├── my-terra-dapp # template smart contract\n│ └── ...\n├── frontend # template frontend application\n├── lib # predefined task and console functions\n├── tasks # predefined tasks\n├── keys.terrain.js # keys for signing transactions\n├── config.terrain.json # config for connections and contract deployments\n└── refs.terrain.json # deployed code and contract references\n```\n\n## Deployment\n\nThe `terrain deploy` command does the following:\n\n- Builds, optimizes, and stores the wasm code on the blockchain.\n- Instantiates the contract.\n\nTo deploy your new my-terra-dapp smart contract, run the following command in the terminal.\n\n```sh\nterrain deploy my-terra-dapp --signer test1\n```\n\nIn this case, we specify one of the preconfigured accounts with balances on LocalTerra, `test1`, as our signer. The signer account will be responsible for paying the gas fee associated with deploying the contract to the Terra blockchain and will be assigned as the owner of the project.\n\nYou can also specify the network on which you would like to deploy your contract by adding the `--network` flag. If the network is not specified, as is the case in our above example, your contract will be deployed to `localterra` by default. If your deployment command in the prior step resulted in an error, you will need to ensure that LocalTerra is up and running in the background and that you have properly spelled out your contract name and are utilizing the appropriate Terrain command. You may also deploy to `mainnet`, the live Terra blockchain, as well as `testnet`, a network similar to mainnet used for testing.\n\n### Step-by-step Deployment\n\nYou can also execute the build, optimize, store, and instantiate processes separately by executing the following commands in sequential order.\n\n1. [`terrain contract:build CONTRACT`](#terrain-contractbuild-contract)\n2. [`terrain contract:optimize CONTRACT`](#terrain-contractoptimize-contract)\n3. [`terrain contract:store CONTRACT`](#terrain-contractstore-contract)\n4. [`terrain contract:instantiate CONTRACT`](#terrain-contractinstantiate-contract)\n\nAfterward, you will have to run the `terrain sync-refs` command in your project directory to sync the `refs.terrain.json` file in the app root directory to the frontend directory. This file contains references to all contracts in the project which have been stored on any Terra network.\n\n \n\n### Deploying on Testnet or Mainnet\n\nThe predefined accounts in the `keys.terrain.js` file shown below can be used as signers on `testnet`. We will demonstrate how to deploy your smart contract utilizing the preconfigured `custom_tester_1` account. You may also add a personal account to the `keys.terrain.js` file by adding the account name as well as its corresponding private key. You can then use that account as the signer specifying the account name after the `--signer` flag in the `terrain deploy` command.\n\n**Warning:** _Utilizing a personal account for deployment requires the use of a private key or mnemonic. These are private keys that are generated upon the creation of your personal wallet. Saving or utilizing these keys on your personal computer may expose them to malicious actors who could gain access to your personal wallet if they are able to obtain them. You can create a wallet solely for testing purposes to eliminate risk. Alternatively, you can store your private keys as secret environment variables which you can then reference utilizing `process.env.SECRET_VAR` in `keys.terrain.json`. Use your private key or mnemonic at your own discretion._\n\n```js\n// can use `process.env.SECRET_MNEMONIC` or `process.env.SECRET_PRIV_KEY`\n// to populate secret in CI environment instead of hardcoding\n\nmodule.exports = {\n custom_tester_1: {\n mnemonic:\n 'shiver position copy catalog upset verify cheap library enjoy extend second peasant basic kit polar business document shrug pass chuckle lottery blind ecology stand',\n },\n custom_tester_2: {\n privateKey: 'fGl1yNoUnnNUqTUXXhxH9vJU0htlz9lWwBt3fQw+ixw=',\n },\n};\n```\n\nPrior to deploying your contract, ensure that your signer wallet contains the funds needed to pay for associated transaction fees. You can request funds from the Terra Testnet Faucet by submitting the wallet address of the account where you would like to receive the funds and clicking on the `Send me tokens` button.\n\nYou can retrieve the wallet address associated with the `custom_tester_1` account by executing the `terrain console` command in your terminal while in your project directory.\n\n```sh\nterrain console\n\nterrain > wallets.custom_tester_1.key.accAddress\n'terra1qd9fwwgnwmwlu2csv49fgtum3rgms64s8tcavp'\n```\n\nAfter you have received the Luna tokens from the Terra Testnet Faucet, query the balance of your account by utilizing the following command in the terrain console.\n\n```sh\nterrain > (await client.bank.balance(wallets.custom_tester_1.key.accAddress))[0]\n```\n\nFinally, exit the terrain console and deploy the `counter` smart contract to testnet with the `custom_tester_1` account as the signer.\n\n```sh\nterrain deploy counter --signer custom_tester_1 --network testnet\n```\n\n## Initializing the Frontend Template\n\nAfter deployment, the `refs.terrain.json` file will be updated in the project directory as well as the `frontend/src` directory. These files contain references to all contracts inside of your project which have been stored on any Terra network. This information is used by terrain's utility functions and also the frontend template. An example of `refs.terrain.json` can be found below:\n\n```json\n{\n \"localterra\": {\n \"counter\": {\n \"codeId\": \"1\",\n \"contractAddresses\": {\n \"default\": \"terra18vd8fpwxzck93qlwghaj6arh4p7c5n896xzem5\"\n }\n }\n },\n \"testnet\": {\n \"counter\": {\n \"codeId\": \"18160\",\n \"contractAddresses\": {\n \"default\": \"terra15faphq99pap3fr0dwk46826uqr2usve739l7ms\"\n }\n }\n }\n}\n```\n\n **Important:** _If you have initialized the contract without using the `terrain deploy` command or have manually changed the `refs.terrain.json` file in the project directory, you will need to sync the references to the `frontend/src` directory in order to ensure frontend functionality. To do so, use the `terrain sync-refs` command._\n\nAfter you have synced the contract references, navigate to the `frontend` directory and start the application.\n\n1. Navigate to the `frontend` directory.\n\n```sh\ncd frontend\n```\n\n2. Start the application.\n\n```sh\nnpm run start\n```\n\n **Note:** _Switching networks in your Terra Station extension will result in a change in reference to the contract address which corresponds with the new network._\n\n## Run Contract Functions with Terrain\n\nOnce you have successfully deployed your project, you can interact with the deployed contract and the underlying blockchain by utilizing functions defined in the `lib/index.js` file. You may also create your own abstractions in this file for querying or executing transactions.\n\nYou can call the functions defined in `lib/index.js` inside of the `terrain console`. An example using the template counter smart contract is shown below.\n\n```sh\nterrain console\nterrain > await lib.getCountQuery()\n{ count: 0 }\nterrain > await lib.increment()\nterrain > await lib.getCountQuery()\n{ count: 1 }\n```\n\nYou may also specify which network you would like to interact with by utilizing the `--network` flag with the `terrain console` command.\n\n```\nterrain console --network NETWORK\n```\n\n## Creating Tasks\n\nYou can use the functions available inside of the `lib/index.js` file to create tasks. Tasks are used in order to automate the execution of sequential functions or commands. An example task is provided for you in the `tasks/example-with-lib.js` file in your project directory.\n\n```js\n// tasks/example-with-lib.js\n\nconst { task } = require('@terra-money/terrain');\nconst lib = require('../lib');\n\ntask(async (env) => {\n const { getCountQuery, increment } = lib(env);\n console.log('count 1 = ', await getCountQuery());\n await increment();\n console.log('count 2 = ', await getCountQuery());\n});\n```\n\nTo run the example task shown above, which is located in the `tasks/example-with-lib.js` file, run the following command in the terminal.\n\n```sh\nterrain task:run example-with-lib\n```\n\nIn order to create a new task, run the following command replacing `` with the desired name for your new task.\n\n```sh\nterrain task:new \n```\n\nIf you would like to use JavaScript in your functions or tasks, you can import [Feather.js](https://github.com/terra-money/feather.js). The `tasks/example-custom-logic.js` file contains an example of a task that uses Terra.js functionality. To learn more about Terra.js, view the Terra.js documentation.\n\n```js\n// tasks/example-custom-logic.js\n\nconst { task, terrajs } = require('@terra-money/terrain');\n\n// terrajs is basically re-exported terra.js (https://terra-money.github.io/feather.js/)\n\ntask(async ({ wallets, refs, config, client }) => {\n console.log('creating new key');\n const key = terrajs.MnemonicKey();\n console.log('private key', key.privateKey.toString('base64'));\n console.log('mnemonic', key.mnemonic);\n});\n```\n\n## Scripting deployments\n\nAs of Terrain 0.4.0 it is possible to deploy and instantiate contracts from tasks. This can be useful for multi-contract, or multi-stage deployments.\n\n```js\nconst { task } = require('@terra-money/terrain');\n\ntask(async ({ wallets, client, deploy }) => {\n // First deploy the counter smart contract.\n await deploy.storeCode('counter', wallets.test1);\n const counterAddress = await deploy.instantiate(\n // Contract name\n 'counter',\n // Signer\n wallets.test1,\n {\n // Contract admin\n admin: wallets.test1.key.accAddress,\n },\n );\n\n // Now deploy a CW20 with the counter contract set as the minter in instantiation.\n await deploy.storeCode('cw20-base', wallets.test1);\n const cw20Address = await deploy.instantiate('cw20-base', wallets.test1, {\n admin: wallets.test1.key.accAddress,\n // Custom instantiation message.\n // with no message provided the default from config.terrain will be used.\n init: {\n name: 'counter',\n symbol: 'CTR',\n decimals: 6,\n initial_balances: [],\n mint: {\n minter: counterAddress,\n },\n },\n });\n\n // Update the CW20 address in counter.\n // Note: It's important to use the address returned by deploy.instantiate\n // Refs are only read into memory at the start of the task.\n await client.execute(counterAddress, wallets.test1, {\n update_token: { token: cw20Address },\n });\n\n console.log(`CW20 Address: ${cw20Address}`);\n});\n```\n\nIt is possible to tell Terrain to use a custom deploy task instead of the default deploy process. To do this, add the following to the `global` section in `config.terrain.json`:\n\n```json\n\"contracts\": {\n \"counter\": {\n \"deployTask\": \"deploy_counter\"\n }\n}\n```\n\nNow instead of running `terrain task:run deploy_counter` you can run `terrain deploy counter`.\n\n# Migrating CosmWasm Contracts on Terra\n\nOn Terra, it is possible to initialize a contract as migratable. This functionality allows the administrator to upload a new version of the contract and then send a migrate message to move to the new code. Contracts that have been deployed before implementing the following changes will not be able to be migrated and implemented changes will only be realized when redeploying the contract.\n\nThe contract migration tutorial builds on top of the Terrain Quick Start Guide and walks you through a contract migration.\n\n## Adding MigrateMsg to the Contract\n\nIn order for a contract to be migratable, it must be able to handle a `MigrateMsg` transaction.\n\nTo implement support for `MigrateMsg`, add the message to the `msg.rs` file. To do so, navigate to `msg.rs` and place the following code just above the `InstantiateMsg` struct.\n\n```rust\n#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]\npub struct MigrateMsg {}\n```\n\nWith `MigrateMsg` defined, update the `contract.rs` file. First, update the import from `crate::msg` to include `MigrateMsg`.\n\n```rust\nuse crate::msg::{CountResponse, ExecuteMsg, InstantiateMsg, QueryMsg, MigrateMsg};\n```\n\nNext, add the following method above `instantiate`.\n\n```rust\n#[cfg_attr(not(feature = \"library\"), entry_point)]\npub fn migrate(_deps: DepsMut, _env: Env, _msg: MigrateMsg) -> StdResult {\n Ok(Response::default())\n}\n```\n\n## Migrating the Contract\n\nAdding the MigrateMsg to the smart contract allows the contract's administrator to migrate the contract in the future. When we deploy our contract, the wallet address of the signer will be automatically designated as the contract administrator. In the following command, the contract is deployed with the preconfigured LocalTerra `test1` wallet as the signer and administrator of our counter contract.\n\n```sh\nterrain deploy counter --signer test1\n```\n\nIf you decide to make changes to the deployed contract, you can migrate to the updated code by executing the following command.\n\n```sh\nterrain contract:migrate counter --signer test1\n```\n\nIf you would like to specify the address of the desired administrator for your smart contract, you may use the `--admin-address` flag in the deploy command followed by the wallet address of the desired administrator.\n\n```sh\nterrain deploy counter --signer test1 --admin-address \n```\n\n# Use Terrain Main Branch Locally\n\nIn some cases, the latest features or bug fixes may be integrated into the main branch of the Terrain Github repo, but not yet released to the corresponding npm package. Subsequently, you may want to use the latest version of Terrain available on Github before it has been released to npm. The below described method may also be used if you are interested in developing on and contributing to Terrain.\n\n**Warning:** _Features and bug fixes that are implemented on the latest version of Terrain may still be subject to testing. As such, you should only use the main branch of the Terrain github repo in exceptional circumstances. In all other cases, use the npm package._\n\nTo use the main branch of the Terrain repo on your local machine, follow the procedure below.\n\n1. Clone the repo.\n\n```\ngit clone --branch main --depth 1 https://github.com/terra-money/terrain\n```\n\n2. Navigate to the project folder.\n\n```\ncd terrain\n```\n\n3. Inside the project folder, install all necessary node dependencies.\n\n```\nnpm install\n```\n\n4. Run the `npm link` command to set up the local repository as your global terrain instance.\n\n```\nnpm link\n```\n\nIf you would like to witness your changes immediately upon saving them, you may execute the following command while in your local Terrain directory and allow it to run in a tab in your terminal.\n\n```\nnpm run watch\n```\n\nTo unlink the terrain command from the cloned repository and revert back to the default functionality, you can execute the below command.\n\n```\nnpm unlink terrain\n```\n\n---\n\n# Terrain Commands\n\n\n* [`terrain console`](#terrain-console)\n* [`terrain contract:build CONTRACT`](#terrain-contractbuild-contract)\n* [`terrain contract:instantiate CONTRACT`](#terrain-contractinstantiate-contract)\n* [`terrain contract:migrate CONTRACT`](#terrain-contractmigrate-contract)\n* [`terrain contract:new NAME`](#terrain-contractnew-name)\n* [`terrain contract:optimize CONTRACT`](#terrain-contractoptimize-contract)\n* [`terrain contract:schema CONTRACT`](#terrain-contractschema-contract)\n* [`terrain contract:store CONTRACT`](#terrain-contractstore-contract)\n* [`terrain contract:updateAdmin CONTRACT ADMIN`](#terrain-contractupdateadmin-contract-admin)\n* [`terrain deploy CONTRACT`](#terrain-deploy-contract)\n* [`terrain help [COMMAND]`](#terrain-help-command)\n* [`terrain new NAME`](#terrain-new-name)\n* [`terrain query CONTRACT MSG`](#terrain-query-contract-msg)\n* [`terrain sync-refs`](#terrain-sync-refs)\n* [`terrain task:new [TASK]`](#terrain-tasknew-task)\n* [`terrain task:run [TASK]`](#terrain-taskrun-task)\n* [`terrain test CONTRACT-NAME`](#terrain-test-contract-name)\n* [`terrain test:coverage [CONTRACT-NAME]`](#terrain-testcoverage-contract-name)\n* [`terrain tx CONTRACT MSG`](#terrain-tx-contract-msg)\n* [`terrain wallet:new`](#terrain-walletnew)\n\n## `terrain console`\n\nStart a repl console that provides context and convenient utilities to interact with the blockchain and your contracts.\n\n```\nUSAGE\n $ terrain console [--signer ] [--network mainnet|testnet|localterra] [--prefix ] [--refs-path\n ] [--keys-path ]\n\nFLAGS\n --keys-path= [default: ./keys.terrain.js]\n --network=
![\"Terrain](\"img/terrain-banner.png\")
\n![](\"https://img.shields.io/badge/cli-oclif-brightgreen.svg\"){kind=icon}
\n ![](\"https://img.shields.io/npm/v/@terra-money/terrain\")
\n ![](\"https://img.shields.io/npm/dm/@terra-money/terrain\")
\n