Terrain – Terra development environment for better smart contract development experience

Terrain will help you:

• scaffold your dapp project
• ease the development and deployment process
• create custom task for blockchain and contract interaction with less boilerplate code
  • using terra.js directly could be cumbersome, Terrain gives you extensions and utilities to help you
• console to terra blockchain, an interactive repl which have the same extensions and utilities as custom task
• ability to predefine functions to be used in task and console

• Terrain
• Setup
• Getting Started
• Usage
• Commands

For local developement environment, you need LocalTerra.

note: if you are using m1 chip, you might need to update your Docker Desktop due to qemu bug

git clone --branch v0.5.2 --depth 1 https://github.com/terra-money/localterra
cd localterra
docker-compose up

While WASM smart contracts can theoretically be written in any programming language, we currently only recommend using Rust as it is the only language for which mature libraries and tooling exist for CosmWasm. For this tutorial, you'll need to also install the latest version of Rust by following the instructions here.

Then run the following commands

# set 'stable' as default release channel (used when updating rust)
rustup default stable

# add wasm as compilation target
rustup target add wasm32-unknown-unknown

# for generating contract
cargo install cargo-generate --features vendored-openssl
cargo install cargo-run-script

Assumed that you have npm installed, let's generate our first app

# for first time, you might want to `npm install -g @iboss/terrain` 
# or run `npx @iboss/terrain new my-terra-dapp`
# since `terrain` npm module name is occupied by another module
npx terrain new my-terra-dapp
cd my-terra-dapp
npm install

The project structure will look like this:

.
├── contracts              # contracts' source code
│   ├── counter
│   └── ...                # more contract can be added here
├── frontend               # frontend application
├── lib                    # predefined functions for task and console
├── tasks                  # predefined tasks
├── keys.terrain.js        # keys for signing transacitons
├── config.terrain.json    # config for connections and contract deployments
└── refs.terrain.json      # deployed code and contract referecnes

You will now have counter example contract (no pun intended).

We can right away deploy the contract on LocalTerra. Not specifying network will be defaulted to localterra.

npx terrain deploy counter --signer validator

npx will use project's terrain binary instead of the global one.

note that signer validator is one of a pre-configured accounts with balances on LocalTerra.

Deploy command will build and optimize wasm code, store it on the blockchain and instantiate the contract.

You can deploy to different network defined in the config.terrain.json (mainnet and testnet). But you can not use the pre-configured accounts anymore. So you need to first update your keys.terrain.js

// can use `process.env.SECRET_MNEMONIC` or `process.env.SECRET_PRIV_KEY`
// to populate secret in CI environment instead of hardcoding

module.exports = {
  custom_tester_1: {
    mnemonic:
      "shiver position copy catalog upset verify cheap library enjoy extend second peasant basic kit polar business document shrug pass chuckle lottery blind ecology stand",
  },
  custom_tester_2: {
    privateKey: "fGl1yNoUnnNUqTUXXhxH9vJU0htlz9lWwBt3fQw+ixw=",
  },
};

Apparently, there are some example accounts pre-defined in there. But DON'T USE THEM ON MAINNET since it is not a secret anymore.

For demonstration purpose, we are going to use custom_tester_1.

First, get some Luna from the faucet to pay for gas. Notice that it requires address but you only have mnenomic or private_key in keys.terrain.js.

The easiest way to retrive the address is to use console:

npx terrain console

terrain > wallets.custom_tester_1.key.accAddress
'terra1qd9fwwgnwmwlu2csv49fgtum3rgms64s8tcavp'

Now you can request for Luna on the faucet then check your balance in console.

terrain > (await client.bank.balance(wallets.custom_tester_1.key.accAddress))[0]

client is an LCDClient (LCD stands for "Light Client Daemon" as opposed to FCD a "Fulll Client Daemon", if you are curious) with some extra utility function. And wallets contains list of Wallet.

npx terrain deploy counter --signer custom_tester_1 --network testnet

Same goes for mainnet deployment, you might want to store your secrets in enviroment variable instead, which you can populate them through process.env.SOME_SECRET in keys.terrain.json.

You can also separate storing code from contract instantiation as using:

• terrain code:store CONTRACT
• terrain contract:instantiate CONTRACT

After deployment, refs.terrain.json will get updated. Refs file contains contract references on all network.

{
  "localterra": {
    "counter": {
      "codeId": "1",
      "contractAddresses": {
        "default": "terra18vd8fpwxzck93qlwghaj6arh4p7c5n896xzem5"
      }
    }
  },
  "testnet": {
    "counter": {
      "codeId": "18160",
      "contractAddresses": {
        "default": "terra15faphq99pap3fr0dwk46826uqr2usve739l7ms"
      }
    }
  }
}

This information is used by terrain's utility functions and also the frontend template.

But in order to use it with frontend, You sync this in to frontend/src since it can not import file outside its rootDir (src). Todo so, run:

npx terrain sync-refs

This is not ideal, ideas and contribution are more than welcome

With this, we can now start frontend:

cd frontend
npm run start

Switching network in your terra wallet extension will result in referencing to different contract address in the respective network.

With the template setup, you can do this

npx terrain console
terrain > await lib.increment()
...
terrain > await lib.getCount()
{ count: 0 }

npx terrain console --network <NETWORK> is also possible

Where does this lib functions comes from?

The answer is here:

// lib/index.js

module.exports = ({ wallets, refs, config, client }) => ({
  getCount: () => client.query("counter", { get_count: {} }),
  increment: (signer = wallets.validator) =>
    client.execute(signer, "counter", { increment: {} }),
});

With this, you can interact with your contract or the blockchain interactively with your own abstractions.

You can use the lib to create task as well:

// tasks/example-with-lib.js

const { task } = require("@iboss/terrain");
const lib = require("../lib");

task(async (env) => {
  const { getCount, increment } = lib(env);
  console.log("count 1 = ", await getCount());
  await increment();
  console.log("count 2 = ", await getCount());
});

To run this task:

npx terrain task:run example-with-lib

To create new task, run:

npx terrain task:new task-name

You might noticed by now that the env (wallets, refs, config, client) in task and lib are the ones that available in the console context.

Also, you can access terrajs in the console or import it in the lib or task to create custom interaction like in tasks/example-custom-logic.js or more complex one, if you are willing to do so, please consult terra.js doc.

// tasks/example-custom-logic.js

const { task, terrajs } = require("@iboss/terrain");

// terrajs is basically re-exported terra.js (https://terra-money.github.io/terra.js/)

task(async ({ wallets, refs, config, client }) => {
  console.log("creating new key");
  const key = terrajs.MnemonicKey();
  console.log("private key", key.privateKey.toString("base64"));
  console.log("mnemonic", key.mnemonic);
});

$ npm install -g @iboss/terrain
$ terrain COMMAND
running command...
$ terrain (-v|--version|version)
@iboss/terrain/0.0.8 darwin-x64 node-v17.0.1
$ terrain --help [COMMAND]
USAGE
  $ terrain COMMAND
...

• terrain code:new [NAME]
• terrain code:store CONTRACT
• terrain console
• terrain contract:instantiate CONTRACT
• terrain contract:migrate [CONTRACT]
• terrain deploy CONTRACT
• terrain help [COMMAND]
• terrain new NAME
• terrain sync-refs [FILE]
• terrain task:new [TASK]
• terrain task:run [TASK]

Generate new contract.

USAGE
  $ terrain code:new [NAME]

OPTIONS
  --path=path        [default: ./contracts] path to keep the contracts
  --version=version  [default: 0.16]

See code: src/commands/code/new.ts

Store code on chain.

USAGE
  $ terrain code:store CONTRACT

OPTIONS
  --code-id=code-id
  --config-path=config-path  [default: ./config.terrain.json]
  --keys-path=keys-path      [default: ./keys.terrain.js]
  --network=network          [default: localterra]
  --no-rebuild
  --refs-path=refs-path      [default: ./refs.terrain.json]
  --signer=signer            (required)

See code: src/commands/code/store.ts

Start a repl console that provides context and convinient utilities to interact with the blockchain and your contracts.

USAGE
  $ terrain console

OPTIONS
  --config-path=config-path  [default: config.terrain.json]
  --keys-path=keys-path      [default: keys.terrain.js]
  --network=network          [default: localterra]
  --refs-path=refs-path      [default: refs.terrain.json]

See code: src/commands/console.ts

Instantiate the contract.

USAGE
  $ terrain contract:instantiate CONTRACT

OPTIONS
  --code-id=code-id          target code id for migration, can do only once after columbus-5 upgrade
  --config-path=config-path  [default: ./config.terrain.json]
  --instance-id=instance-id  [default: default]
  --keys-path=keys-path      [default: ./keys.terrain.js]
  --network=network          [default: localterra]
  --refs-path=refs-path      [default: ./refs.terrain.json]
  --set-signer-as-admin
  --signer=signer            (required)

See code: src/commands/contract/instantiate.ts

Migrate the contract.

USAGE
  $ terrain contract:migrate [CONTRACT]

OPTIONS
  --code-id=code-id          target code id for migration, can do only once after columbus-5 upgrade
  --config-path=config-path  [default: ./config.terrain.json]
  --instance-id=instance-id  [default: default]
  --keys-path=keys-path      [default: ./keys.terrain.js]
  --network=network          [default: localterra]
  --refs-path=refs-path      [default: ./refs.terrain.json]
  --signer=signer            (required)

See code: src/commands/contract/migrate.ts

Build wasm bytecode, store code on chain and instantiate.

USAGE
  $ terrain deploy CONTRACT

OPTIONS
  --admin-address=admin-address  set custom address as contract admin to allow migration.
  --config-path=config-path      [default: ./config.terrain.json]
  --instance-id=instance-id      [default: default]
  --keys-path=keys-path          [default: ./keys.terrain.js]
  --network=network              [default: localterra]
  --no-rebuild                   deploy the wasm bytecode as is.
  --refs-path=refs-path          [default: ./refs.terrain.json]
  --set-signer-as-admin          set signer (deployer) as admin to allow migration.
  --signer=signer                (required)

See code: src/commands/deploy.ts

display help for terrain

USAGE
  $ terrain help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

Create new dapp from template.

USAGE
  $ terrain new NAME

OPTIONS
  --path=path        path to keep the project
  --version=version  [default: 0.16]

EXAMPLES
  $ terrain new awesome-dapp
  $ terrain new awesome-dapp --path path/to/dapp

See code: src/commands/new.ts

Sync configuration with frontend app.

USAGE
  $ terrain sync-refs [FILE]

OPTIONS
  --dest=dest            [default: ./frontend/src/refs.terrain.json]
  --refs-path=refs-path  [default: ./refs.terrain.json]

See code: src/commands/sync-refs.ts

create new task

USAGE
  $ terrain task:new [TASK]

See code: src/commands/task/new.ts

run predefined task

USAGE
  $ terrain task:run [TASK]

OPTIONS
  --config-path=config-path  [default: config.terrain.json]
  --keys-path=keys-path      [default: keys.terrain.js]
  --network=network          [default: localterra]
  --refs-path=refs-path      [default: refs.terrain.json]

See code: src/commands/task/run.ts