Struct AppBuilder

pub struct AppBuilder<Bank, Api, Storage, Custom, Wasm, Staking, Distr, Ibc, Gov, Stargate> { /* private fields */ }

The chain builder.

Utility structure for building a chain in stages. When particular properties are not explicitly set, then default values are used.

Implementations

impl AppBuilder<BankKeeper, MockApi, MockStorage, FailingModule<Empty, Empty, Empty>, WasmKeeper<Empty, Empty>, StakeKeeper, DistributionKeeper, IbcFailingModule, GovFailingModule, StargateFailing>

pub fn new() -> Self

Creates a builder with default components working with empty exec and query messages.

Examples

use cw_multi_test::{no_init, AppBuilder};

let app = AppBuilder::new().build(no_init);

let sender_addr = app.api().addr_make("sender");
assert!(sender_addr.as_str().starts_with("cosmwasm1"));

impl<ExecC, QueryC> AppBuilder<BankKeeper, MockApi, MockStorage, FailingModule<ExecC, QueryC, Empty>, WasmKeeper<ExecC, QueryC>, StakeKeeper, DistributionKeeper, IbcFailingModule, GovFailingModule, StargateFailing>

where ExecC: CustomMsg + DeserializeOwned + 'static, QueryC: Debug + CustomQuery + DeserializeOwned + 'static,

pub fn new_custom() -> Self

Creates builder with default components designed to work with custom exec and query messages.

impl<BankT, ApiT, StorageT, CustomT, WasmT, StakingT, DistrT, IbcT, GovT, StargateT> AppBuilder<BankT, ApiT, StorageT, CustomT, WasmT, StakingT, DistrT, IbcT, GovT, StargateT>

where CustomT: Module, WasmT: Wasm<CustomT::ExecT, CustomT::QueryT>,

pub fn with_wasm<NewWasm: Wasm<CustomT::ExecT, CustomT::QueryT>>( self, wasm: NewWasm, ) -> AppBuilder<BankT, ApiT, StorageT, CustomT, NewWasm, StakingT, DistrT, IbcT, GovT, StargateT>

Overwrites the default wasm executor.

At this point it is needed that new wasm implements some Wasm trait, but it doesn’t need to be bound to Bank or Custom yet - as those may change. The cross-components validation is done on final building.

pub fn with_bank<NewBank: Bank>( self, bank: NewBank, ) -> AppBuilder<NewBank, ApiT, StorageT, CustomT, WasmT, StakingT, DistrT, IbcT, GovT, StargateT>

Overwrites the default bank interface.

pub fn with_api<NewApi: Api>( self, api: NewApi, ) -> AppBuilder<BankT, NewApi, StorageT, CustomT, WasmT, StakingT, DistrT, IbcT, GovT, StargateT>

Overwrites the default api interface.

pub fn with_storage<NewStorage: Storage>( self, storage: NewStorage, ) -> AppBuilder<BankT, ApiT, NewStorage, CustomT, WasmT, StakingT, DistrT, IbcT, GovT, StargateT>

Overwrites the default storage interface.

pub fn with_custom<NewCustom: Module>( self, custom: NewCustom, ) -> AppBuilder<BankT, ApiT, StorageT, NewCustom, WasmT, StakingT, DistrT, IbcT, GovT, StargateT>

Overwrites the default handler for custom messages.

At this point it is needed that new custom implements some Module trait, but it doesn’t need to be bound to ExecC or QueryC yet - as those may change. The cross-components validation is done on final building.

pub fn with_staking<NewStaking: Staking>( self, staking: NewStaking, ) -> AppBuilder<BankT, ApiT, StorageT, CustomT, WasmT, NewStaking, DistrT, IbcT, GovT, StargateT>

Overwrites the default staking interface.

pub fn with_distribution<NewDistribution: Distribution>( self, distribution: NewDistribution, ) -> AppBuilder<BankT, ApiT, StorageT, CustomT, WasmT, StakingT, NewDistribution, IbcT, GovT, StargateT>

Overwrites the default distribution interface.

pub fn with_ibc<NewIbc: Ibc>( self, ibc: NewIbc, ) -> AppBuilder<BankT, ApiT, StorageT, CustomT, WasmT, StakingT, DistrT, NewIbc, GovT, StargateT>

Overwrites the default ibc interface.

If you wish to simply ignore/drop all returned IBC Messages, you can use the IbcAcceptingModule type:

builder.with_ibc(IbcAcceptingModule::new())

pub fn with_gov<NewGov: Gov>( self, gov: NewGov, ) -> AppBuilder<BankT, ApiT, StorageT, CustomT, WasmT, StakingT, DistrT, IbcT, NewGov, StargateT>

Overwrites the default governance module.

Examples

use cw_multi_test::{no_init, AppBuilder, GovAcceptingModule};

let app = AppBuilder::default()
    .with_gov(GovAcceptingModule::new())
    .build(no_init);

// use the app with accepting governance module in your test

pub fn with_stargate<NewStargate: Stargate>( self, stargate: NewStargate, ) -> AppBuilder<BankT, ApiT, StorageT, CustomT, WasmT, StakingT, DistrT, IbcT, GovT, NewStargate>

Overwrites the default stargate interface.

pub fn with_block(self, block: BlockInfo) -> Self

Overwrites the initial block.

pub fn build<F>( self, init_fn: F, ) -> App<BankT, ApiT, StorageT, CustomT, WasmT, StakingT, DistrT, IbcT, GovT, StargateT>

where BankT: Bank, ApiT: Api, StorageT: Storage, CustomT: Module, WasmT: Wasm<CustomT::ExecT, CustomT::QueryT>, StakingT: Staking, DistrT: Distribution, IbcT: Ibc, GovT: Gov, StargateT: Stargate, F: FnOnce(&mut Router<BankT, CustomT, WasmT, StakingT, DistrT, IbcT, GovT, StargateT>, &ApiT, &mut dyn Storage),

Builds the final App with initialization.

At this point all component types have to be properly related to each other.

Trait Implementations

impl Default for AppBuilder<BankKeeper, MockApi, MockStorage, FailingModule<Empty, Empty, Empty>, WasmKeeper<Empty, Empty>, StakeKeeper, DistributionKeeper, IbcFailingModule, GovFailingModule, StargateFailing>

fn default() -> Self

Creates a chain with default settings.

Examples

use cw_multi_test::{no_init, AppBuilder};

let app = AppBuilder::default().build(no_init);

let sender_addr = app.api().addr_make("sender");
assert!(sender_addr.as_str().starts_with("cosmwasm1"));