Cosm-Orc

Rust Cosmwasm smart contract integration testing and gas profiling library.

Store, instantiate, execute, and query Cosmwasm smart contracts against a configured Cosmos based chain.

Optionally, profile gas usage of the smart contract operations.

If you need a more general Cosmos SDK client library try cosm-tome, which we use here under the hood.

Potential uses: * Integration tests * Deployments / Bootstrapping environments * Gas profiling * Realistic adversarial testing

This project is not intended to be used for mainnet.

Quick Start

``rust // juno_local.yaml has thecw20basecode_id already stored // If the smart contract has not been stored on the chain yet use:cosmorc::storecontracts()` let mut cosmorc = CosmOrc::new(Config::fromyaml("./example-configs/junolocal.yaml")?, false)?; let key = SigningKey { name: "validator".tostring(), key: Key::Mnemonic("word1 word2 ...".tostring()), derivationpath: "m/44'/118'/0'/0/0".tostring(), };

cosmorc.instantiate( "cw20base", "memetokentest", &InstantiateMsg { name: "Meme Token".tostring(), symbol: "MEME".tostring(), decimals: 6, initial_balances: vec![], mint: None, marketing: None, }, &key, None, vec![] )?;

let res = cosmorc.query( "cw20base", &QueryMsg::TokenInfo {}, )?; let res: TokenInfoResponse = res.data()?; ```

See here for example usages.

Optimize and Store Contracts

If config.yaml doesn't have the pre-stored contract code ids, you can call optimize_contracts() and store_contracts(): ```rust let mut cosmorc = CosmOrc::new(Config::fromyaml("./example-configs/junolocal.yaml")?, false)?; let key = SigningKey { name: "validator".tostring(), key: Key::Mnemonic("word1 word2 ...".tostring()), derivationpath: "m/44'/118'/0'/0/0".to_string(), };

// Build + optimize all smart contracts in current workspace // This will save the optimized wasm files in ./artifacts cosmorc.optimizecontracts("./Cargo.toml")?;

// NOTE: currently cosm-orc is expecting a wasm filed called: cw20_base.wasm // to be in /artifacts, since cw20_base is used as the contract name in the instantiate()/query() calls below: cosmorc.storecontracts("./artifacts", &key, None)?;

let res = cosmorc.query( "cw20base", &QueryMsg::TokenInfo {}, )?; let res: TokenInfoResponse = res.data()?; ```

Gas Profiling

```rust let mut cosmorc = CosmOrc::new(Config::fromyaml("config.yaml")?, true)?;

let reports = cosmorc.gasprofiler_report(); ```

Gas Report Github Action

Use the cosm-orc-github-action to view the cosm-orc gas usage as a PR comment.

Github action also supports showing the diff between 2 different reports.

Examples: * https://github.com/de-husk/cosm-orc-examples/pull/7

Configuration

See ./example-configs directory for example yaml configs.