# cw-orchestrator

A Rust tool for interacting with CosmWasm smart contracts. It provides a type-safe interface to CosmWasm contracts and allows you to easily interact with them. It does this by providing a set of macros that generate type-safe interfaces to your contracts. You can then combine your contract interfaces into a single object that can be shared with others to ease integration efforts and encourage collaboration.

The documentation here gives you a brief overview of the functionality that cw-orchestrator provides. We provide more documentation at orchestrator.abstract.money.

How it works

Interacting with a CosmWasm contract is done by calling the contract's endpoints using the appropriate message for that endpoint (ExecuteMsg,InstantiateMsg, QueryMsg, MigrateMsg, etc.). cw-orchestrator generates typed interfaces for your contracts, allowing them to be type-checked at compile time. This generic interface then allows you to write environment-generic code, meaning that you can re-use the code that you write to deploy your application to cw-multi-test when deploying to test/mainnet.

Maintained Interfaces

We maintain a small set of interfaces ourselves that we use in our own projects. These interfaces are maintained by the Abstract team and are a good reference for how to use the library.

| Codebase | Latest Version | |---|---| | cw-plus | | | wyndex | | | AbstractSDK | |

Creating an Interface

In order to generate a typed interface to your contract you can either pass the contract's message types into the contract macro or you can add the interface macro to your endpoint function exports!

The contract Macro

Provide your messages to a new struct that's named after your contract.

```rust use cworch::interface; use cw20base::msg::{InstantiateMsg, ExecuteMsg, QueryMsg, MigrateMsg};

// Provide the messages in the order Init, Exec, Query, Migrate.

[interface(InstantiateMsg, ExecuteMsg, QueryMsg, MigrateMsg)]

pub struct Cw20; ```

The macro will generate a new function that takes the contract name and the chain that you want to interact with. You can then use this interface to interact with the contract.

The interface_entry_point Macro

You create a contract interface by adding the interface_entry_point macro to your contract endpoints. The name of the generated interface will be the crate name in PascalCase.

```ts use cworch::interfaceentry_point;

[cworch::interfaceentry_point]

fn instantiate(...)

[cworch::interfaceentry_point]

fn execute(...) ```

You now have a contract interface that you can use to interact with your contract.

Usage

You can use this interface to interact with the contract:

```rust use cworch::interface; use cworch::prelude::*; use cw20::{Cw20Coin, BalanceResponse}; use cw20_base::msg::{InstantiateMsg, ExecuteMsg, QueryMsg, MigrateMsg};

[interface(InstantiateMsg, ExecuteMsg, QueryMsg, MigrateMsg)]

pub struct Cw20;

// Implement the Uploadable trait so it can be uploaded to the mock. impl Uploadable for Cw20 { fn wrapper(&self) -> Box> { Box::new( ContractWrapper::newwithempty( cw20base::contract::execute, cw20base::contract::instantiate, cw20base::contract::query, ) .withmigrate(cw20_base::contract::migrate), ) } }

// ## Environment setup ##

let sender = Addr::unchecked("sender"); // Create a new mock chain (backed by cw-multi-test) let chain = Mock::new(&sender);

// Create a new Cw20 interface let cw20base: Cw20 = Cw20::new("mytoken", chain);

// Upload the contract cw20_base.upload().unwrap();

// Instantiate a CW20 token let cw20initmsg = InstantiateMsg { decimals: 6, name: "Test Token".tostring(), initialbalances: vec![Cw20Coin { address: sender.tostring(), amount: 10u128.into(), }], marketing: None, mint: None, symbol: "TEST".tostring(), }; cw20base.instantiate(&cw20init_msg, None, None).unwrap();

// Query the balance let balance: BalanceResponse = cw20base.query(&QueryMsg::Balance { address: sender.tostring() }).unwrap();

assert_eq!(balance.balance.u128(), 10u128); ```

Features

cw-orchestrator provides two additional macros that can be used to improve the scripting experience.

ExecuteFns

The ExecuteFns macro can be added to the ExecuteMsg definition of your contract. It will generate a trait that allows you to call the variants of the message directly without the need to construct the struct yourself.

The macros should only be added to the structs when the "interface" trait is enable. This is ensured by the interface feature in the following example

Example:

```rust use cw_orch::prelude::*;

[cosmwasmschema::cwserde]

[derive(cw_orch::ExecuteFns)]

pub enum ExecuteMsg { Freeze {}, UpdateAdmins { admins: Vec }, /// the payable attribute will add a coins argument to the generated function #[payable] Deposit {} }

// Define the interface, which is generic over the CosmWasm environment (Chain)

[cw_orch::interface(Empty,ExecuteMsg,Empty,Empty)]

struct Cw1;

impl Cw1 { pub fn testmacro(&self) { self.freeze().unwrap(); self.updateadmins(vec!["newadmin".tostring()]).unwrap(); self.deposit(&[Coin::new(13,"juno")]).unwrap(); } } ```

We recommend shielding the ExecuteMsgFns macro behind a feature flag to avoid pulling in cw-orchestrator by default.

QueryFns

The QueryFns derive macro works in the same way as the ExecuteFns macro but it also uses the #[returns(QueryResponse)] attribute from cosmwasm-schema to generate the queries with the correct response types.

impl_into Attribute

For nested messages (execute and query) you can add an impl_into attribute. This expects the enum to implement the Into trait for the provided type. This is extremly useful when working with generic messages:

```rust use cworch::interface; use cworch::prelude::*;

// An execute message that is generic.

[cosmwasmschema::cwserde]

pub enum GenericExecuteMsg { Generic(T), }

// Now the following is possible: type ExecuteMsg = GenericExecuteMsg;

[cosmwasmschema::cwserde]

[derive(cw_orch::ExecuteFns)]

[impl_into(ExecuteMsg)]

pub enum Foo { Bar { a: String }, }

impl From for ExecuteMsg { fn from(msg: Foo) -> Self { ExecuteMsg::Generic(msg) } }

[interface(Empty, ExecuteMsg, Empty, Empty)]

struct Example;

impl Example { pub fn testmacro(&self) { // function bar is available because of the impl_into attribute! self.bar("hello".tostring()).unwrap(); } } ```

Contributing

We'd really appreciate your help! Please read our contributing guidelines to get started.

Documentation

The documentation is generated using mdbook. Edit the files in the docs/src folder and run

shell just serve-docs

to view the changes.

Release Docs Dev Docs

Testing

To test the full application you can run the following command:

shell cargo test --jobs 1 --all-features

References

Enjoy scripting your smart contracts with ease? Build your contracts with ease by using Abstract.

Disclaimer

This software is provided as-is without any guarantees.

Credits

cw-orchestrator is inspired by terra-rust-api and uses cosmos-rust for protocol buffer gRPC communication.