Tutorial 01

1. Setting up the CosmWasm development environment

Gitpod users

To setup your workspace with all the neccessary tools & libraries for developing the CosmWasm smart contracts, please click button Open in Gitpod below. Gitpod will automatically install everything you need to deploy a smart contract.

Local development users

For those who want to develop the contracts locally, it's best to use Docker to automatically install all the libraries & tools for you.

docker-compose.yml file:

version: '3.3'
    image: orai/cosmwasm-optimizer:0.0.1 # derived from cosmwasm/workspace-optimizer:0.12.6. Source: https://github.com/CosmWasm/rust-optimizer
    entrypoint: tail -f /dev/null
      - ./:/code

Please note that the workspace that you run the container on should has a Cargo.toml file under its workspace root directory. Otherwise, the CosmWasm IDE will not display its interface to prevent unexpected errors.

2. Install the CosmWasm IDE extension (for local development users only)

You should navigate to the Extensions tab in the VS Code tab bar & install the CosmWasm IDE extension. After installing, it should show a new IDE button in the tab bar, as well as several buttons under the Status Bar of VSCode.

3. Build & deploy a contract

  • If you use Gitpod, then it is recommended to install Keplr wallet, as the extension works well with it when it comes to developing contracts on the browser.

  • If you don't want to use Gitpod, or you are developing locally, you will need a wallet to deploy & interact with the contract. Hence, please create a .env file under the workspace root, and insert your test wallet mnemonic.

Example of the .env file:

column fly toy delay blouse unable hundred story whale toast uniform hope
  • Next, choose an arbitrary file in the project.

  • Note: the file in the following picture can be found in https://github.com/oraichain/oraiwasm_scaffold

  • Then, please click Build Cosmwasm to build the smart contract.

  • Note: The extension provides four custom VS Code buttons: Build CosmWasm, Deploy CosmWasm, Upload CosmWasm and Instantiate CosmWasm under the status bar of Vs Code and a CosmWasm IDE Explorer under the Explorer tab of VS Code. If you installed dark mode extension for your browser or dark theme on gitpod, sometimes the CosmWasm IDE Explorer icon seems to missing but it is still there. Pressing the following button in order to deploy the contract.

    • Build CosmWasm button will build the smart contract to the .wasm file based on the file you open in VS Code.

    • Deploy Cosmwasm button will deploy your contract onto a network that you choose on the CosmWasm IDE explorer.

    • Upload CosmWasm button will upload your smart contract code.

    • Instantiate CosmWasm button will instantiate your smart contract given a code id.

  • Please note that the IDE will read all the json schemas of a project from the location artifacts/schema or schema. As a result, if the schemas are in a different location, the IDE will not be able to move to the next stage.

  • After finishing building, the CosmWasm IDE should move to a new page with basic information for contract deployment like in the image below.

  • After filling all the needed information, you can click Deploy / Upload / Instantiate CosmWasm to to deploy / upload / instantiate the contract.

4. Interacting with the IDE webview

After deploying or instantiating, the webview will display the deployed contract address & two interaction options: Execute & Query. You can freely play with it to suit your needs.

Last updated