Skip to main content
Version: 1.0

Setting Up Environment

You need an environment to run contracts. You can either run your node locally or connect to an existing network. For easy testing, the oysternet testnet is live. You can use this to deploy and run your contracts. If you want to setup and run against a local blockchain, follow these instructions.

To verify the testnet is currently running, make sure the following URLs are all working for you:

We have set up two native tokens - STAR (ustar) for becoming a validator and SPONGE (usponge) for paying fees. Available frontends:

You can use these to explore txs, addresses, validators and contracts. Feel free to deploy one pointing to our rpc/lcd servers and we will list it.

You can find more information about other testnets: CosmWasm/testnets and Testnet section.

When interacting with this network, you can either use wasmd which is a Go client, or the Node REPL. The Node REPL is recommended for contract operations, since JSON manipulation is not intuitive with the Shell/Go client.

Setup Go CLI#

Let's configure the wasmd executable, point it to the testnet, create a wallet and ask for tokens from faucet:

First source the oysternet network configuration in the shell:

source <(curl -sSL

Setup the client:

# add wallets for testingwasmd keys add fred>{  "name": "fred",  "type": "local",  "address": "wasm13nt9rxj7v2ly096hm8qsyfjzg5pr7vn5saqd50",  "pubkey": "wasmpub1addwnpepqf4n9afaefugnfztg7udk50duwr4n8p7pwcjlm9tuumtlux5vud6qvfgp9g",  "mnemonic": "hobby bunker rotate piano satoshi planet network verify else market spring toward pledge turkey tip slim word jaguar congress thumb flag project chalk inspire"}
wasmd keys add bobwasmd keys add thief

You need some tokens in your address to interact. If you are using a local node you can skip this step. Requesting tokens from faucet can be accomplished like so:

JSON=$(jq -n --arg addr $(wasmd keys show -a fred) '{"denom":"usponge","address":$addr}') && curl -X POST --header "Content-Type: application/json" --data "$JSON"$(jq -n --arg addr $(wasmd keys show -a thief) '{"denom":"usponge","address":$addr}') && curl -X POST --header "Content-Type: application/json" --data "$JSON"

Export wasmd Parameters#

If you intend to use wasmd as a client, we recommend you set these variables. If you don't set them, you will have to define type in node, chain id and gas-prices details with every command you execute. Make sure you export these before proceeding.

# bashexport NODE="--node $RPC"export TXFLAG="${NODE} --chain-id ${CHAIN_ID} --gas-prices 0.001usponge --gas auto --gas-adjustment 1.3"
# zshexport NODE=(--node $RPC)export TXFLAG=($NODE --chain-id $CHAIN_ID --gas-prices 0.001usponge --gas auto --gas-adjustment 1.3)

If any of the commands above throws an error, this means your shell is different. If the command succeeded, then try running:

wasmd query bank total $NODE

Setup Node REPL#

Beyond the standard CLI tooling, we have also produced a flexible TypeScript library CosmJS, which runs in Node.js as well as in modern browsers. It handles queries and submitting transactions. Along with this library, we produced @cosmjs/cli, which is a super-charged Node console. It supports await, does type checking for helpful error messages, and preloads many CosmJS utilities. If you are comfortable with the Node console, you will probably find this easier and more powerful than the CLI tooling.

Using the REPL:

// Create or load accountconst mnemonic = loadOrCreateMnemonic('fred.key')mnemonicToAddress(mnemonic)
const {address, client} = await connect(mnemonic, {})address
client.getAccount()// if empty - this only works with CosmWasmhitFaucet(defaultFaucetUrl, address, 'STAR')client.getAccount()

Run Local Node (optional)#

If you are interested in running your local network you can use the script below:

# default home is ~/.wasmd# if you want to setup multiple apps on your local make sure to change this valueAPP_HOME="~/.wasmd"RPC="http://localhost:26657"CHAIN_ID="localnet"# initialize wasmd configuration fileswasmd init localnet --chain-id ${CHAIN_ID} --home ${APP_HOME}
# add minimum gas prices config to app configuration filesed -i -r 's/minimum-gas-prices = ""/minimum-gas-prices = "0.01ucosm"/' ${APP_HOME}/config/app.toml
# Create main address# --keyring-backend test is for testing purposes# Change it to --keyring-backend file for secure usage.export KEYRING="--keyring-backend test --keyring-dir $HOME/.wasmd_keys"wasmd keys add main $KEYRING
# create validator addresswasmd keys add validator $KEYRING
# add your wallet addresses to genesiswasmd add-genesis-account $(wasmd keys show -a main $KEYRING) 10000000000ucosm,10000000000stake --home ${APP_HOME}wasmd add-genesis-account $(wasmd keys show -a validator $KEYRING) 10000000000ucosm,10000000000stake --home ${APP_HOME}
# add fred's address as validator's addresswasmd gentx validator 1000000000stake --home ${APP_HOME} --chain-id ${CHAIN_ID} $KEYRING
# collect gentxs to genesiswasmd collect-gentxs --home ${APP_HOME}
# validate the genesis filewasmd validate-genesis --home ${APP_HOME}
# run the nodewasmd start --home ${APP_HOME}