![\"terrain](\"./logo.png\"){kind=logo}
\r\n\r\n\r\n\r\n\r\n\r\n
\r\nTerrain – A Terra development environment for seamless smart contract development.\r\n
\r\n\r\n---\r\n\r\n[](https://oclif.io) [](https://npmjs.org/package/terrain) [](https://npmjs.org/package/terrain)\r\n\r\nTerrain allows you to:\r\n\r\n- Scaffold a template smart contract and frontend for app development.\r\n- Dramatically simplify the development and deployment process.\r\n\r\nTerrain is **not**:\r\n\r\n- A fully-featured Terra command-line interface (CLI). If you need a fully-featured client, use terrad.\r\n- A Light Client Daemon (LCD). You will still need an RPC endpoint to deploy your contract. LocalTerra is the recommended option for this.\r\n\r\n---\r\n\r\n# Table of contents\r\n\r\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\r\n* [Terrain](#terrain)\r\n* [Table of contents](#table-of-contents)\r\n* [Setup](#setup)\r\n* [Getting Started](#getting-started)\r\n* [Migrating CosmWasm Contracts on Terra](#migrating-cosmwasm-contracts-on-terra)\r\n* [Use Terrain Main Branch Locally](#use-terrain-main-branch-locally)\r\n* [Terrain Commands](#terrain-commands)\r\n\r\n* [Terrain](#terrain)\r\n* [Table of contents](#table-of-contents)\r\n* [Setup](#setup)\r\n* [Getting Started](#getting-started)\r\n* [Migrating CosmWasm Contracts on Terra](#migrating-cosmwasm-contracts-on-terra)\r\n* [Use Terrain Main Branch Locally](#use-terrain-main-branch-locally)\r\n* [Terrain Commands](#terrain-commands)\r\n\r\n\r\n# Setup\r\n\r\n## Download LocalTerra\r\n\r\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 \r\nLocalTerra documentation.\r\n\r\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._\r\n\r\nOnce all dependencies have been installed, do the following:\r\n\r\n1. Clone the LocalTerra repo.\r\n\r\n```\r\ngit clone https://github.com/terra-money/LocalTerra.git\r\n```\r\n\r\n2. Navigate to the newly created `LocalTerra` directory.\r\n\r\n```\r\ncd LocalTerra\r\n```\r\n\r\n3. Spin up an instance of the environment with `docker-compose`.\r\n\r\n```\r\ndocker-compose up\r\n```\r\n\r\n## Setup Rust\r\n\r\nWhile WASM smart contracts can be written in any programming language, **it is strongly recommended that you utilize 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:\r\n\r\n1. Set the default release channel used to update Rust to stable:\r\n\r\n```sh\r\nrustup default stable\r\n```\r\n\r\n2. Add wasm as the compilation target:\r\n\r\n```sh\r\nrustup target add wasm32-unknown-unknown\r\n```\r\n\r\n3. Install the necessary dependencies for generating contracts:\r\n\r\n```sh\r\ncargo install cargo-run-script\r\n```\r\n\r\n## Install Node JS and NPM\r\n\r\nTo run Terrain, you will need to install Node.js and NPM. We recommend that you install Node.js v16 (LTS). Node Package Manager (NPM) is automatically installed along with your Node.js download.\r\n\r\n**Note:** _Use Node.js v16 (LTS) if you encounter the following error code: `error:0308010C:digital envelope routines::unsupported`_\r\n\r\n# Getting Started\r\n\r\nNow that you have completed the initial setup, generate your first smart contract using the procedure described below:\r\n\r\n1. Install the terrain package globally.\r\n\r\n```sh\r\nnpm install -g @terra-money/terrain\r\n```\r\n\r\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 utilize the command `npx terrain new my-terra-dapp`._\r\n\r\n2. Generate your smart contract and corresponding frontend templates.\r\n\r\n```sh\r\nterrain new my-terra-dapp\r\n```\r\n\r\n3. Navigate to the new `my-terra-dapp` directory.\r\n\r\n```sh\r\ncd my-terra-dapp\r\n```\r\n\r\n4. Install all necessary Node dependencies in your project.\r\n\r\n```sh\r\nnpm install\r\n```\r\n\r\n## Project Structure\r\n\r\nThe `terrain new` command generates a project with the following structure:\r\n\r\n```\r\n.\r\n├── contracts # the smart contract directory\r\n│ ├── counter # template smart contract\r\n│ └── ...\r\n├── frontend # template frontend application\r\n├── lib # predefined task and console functions\r\n├── tasks # predefined tasks\r\n├── keys.terrain.js # keys for signing transactions\r\n├── config.terrain.json # config for connections and contract deployments\r\n└── refs.terrain.json # deployed code and contract references\r\n```\r\n\r\n## Deployment\r\n\r\nThe `terrain deploy` command does the following:\r\n\r\n- Builds, optimizes and stores the wasm code on the blockchain.\r\n- Instantiates the contract.\r\n\r\nTo deploy your new counter smart contract, run the following command in the terminal.\r\n\r\n```sh\r\nterrain deploy counter --signer test1\r\n```\r\n\r\n **Note:** _You can also store the wasm code and instantiate the contract separately using the command [`terrain code:store CONTRACT`](#terrain-codestore-contract) followed by [`terrain contract:instantiate CONTRACT`](#terrain-contractmigrate-contract). In this case, you must also run the command `terrain sync-refs` in your project directory to update the `refs.terrain.json` file which references contract deployments on all networks._\r\n\r\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.\r\n\r\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. You may also deploy to `mainnet`, the live Terra blockchain, as well as `testnet`, a network similar to mainnet used for testing.\r\n\r\n