Base smart contract

Base smart contract for Vara Network using Sails.

⚙️ Settings

Rust: You need to have rust 1.88 to be able to compile your contract:

Note: GitPod will automatically execute these commands.

• Install necessary rust version and components:

rustup install 1.91.0
rustup default 1.91.0
rustup target add wasm32v1-none

• Install the wasm-opt for contract compilations:

sudo apt install binaryen

📁 Smart Contract Architecture

The contract works under a workspace which helps with the management of crate versions.

Contract crates:

• client: This crate generates the contract client and incorporates it in its code, it can be used in tests.

• app: Here goes all the business logic of the smart contract.

  Note: To avoid conflicts, it is recommended that you keep the "program" name (ContractProgram), everything else, such as services, state, etc. can change.

📄 Generated files

when you compile your smart contract, it will generate some files inside an target/wasm32-gear/release directory that you will need:

• contract_client.rs: File to be used to send message to this smart contract.
• contract.idl: File that contains detailed information about the application, including:
  • Types: Custom types used within the program.
  • Constructors: The program's constructor.
  • Services: Commands and queries for all the services exposed by the program.
  • Events: Events utilized within the program.
• contract.opt.wasm: optimized WASM smart contract code.
• contract.wasm: WASM smart contract code (use only the optimized one).

💻 Usage

• 🏗️ Compilation: To build the contract execute:

  cargo b -r

• ✅ Tests: to tests your contract code you can execute:

  • To do unit testing with Syscalls mocks (and cfg(test) in each service):

    cargo test -p contract-app

    or

    cd app
    cargo test

  • To run tests with gtest:

    cargo test -r

  • To test your contract in Vara Network testnet:

    cargo test -r -- --ignored

  • In case that you write "println" macros in your gtest and gclient tests, to see your logs in your terminal you have to add the flag -- --no-capture, example:

    cargo test -r -- --no-capture
    cargo test -r -- --ignored --no-capture

Gitpod

You can also program your smart contract from GitPod by clicking the following button (The necessary packages and dependencies will be installed automatically):

Deploy the Contract on the IDEA Platform and Interact with Your Contract

Step 1: Compile and Deploy the Smart Contract (On gitpod or local environment)

Compile the smart contract by running the following command:

cargo b -r

Once the compilation is complete, locate the contract.opt.wasm and contract.idl file in the target/wasm32-gear/release directory.

Step 2: Download Your Substrate Wallet.

1. To interact with the Gear IDEA and deploy your contract, you will need to download a wallet extension such as Polkadot-JS, Talisman, or Subwallet to interact with Substrate-based chains.

Step 3: Deploy Your Contract on Vara Network

1. Access Gear IDE using your web browser.
2. Connect your Substrate wallet to Gear IDEA.
3. Upload the contract.opt.wasm and contract.idl files by clicking the "Upload Program" button.

Standards: Standards