Struct drink_next::session::Session

pub struct Session<R>
where
    R: Runtime,
    R::Config: Config,
{ /* private fields */ }

Wrapper around Sandbox that provides a convenient API for interacting with multiple contracts.

Instead of talking with a low-level Sandbox, you can use this struct to keep context, including: origin, gas_limit, transcoder and history of results.

Session has two APIs: chain-ish and for singular actions. The first one can be used like:

Session::<MinimalRuntime>::new()?
    .deploy_and(contract_bytes(), "new", NO_ARGS, NO_SALT, NO_ENDOWMENT, &get_transcoder())?
    .call_and("foo", NO_ARGS, NO_ENDOWMENT)?
    .with_actor(bob())
    .call_and("bar", NO_ARGS, NO_ENDOWMENT)?;

The second one serves for one-at-a-time actions:

let mut session = Session::<MinimalRuntime>::new()?;
let _address = session.deploy(contract_bytes(), "new", NO_ARGS, NO_SALT, NO_ENDOWMENT, &get_transcoder())?;
let _result: u32 = session.call("foo", NO_ARGS, NO_ENDOWMENT)??;
session.set_actor(bob());
session.call::<_, ()>("bar", NO_ARGS, NO_ENDOWMENT)??;

You can also work with .contract bundles like so:

// Simplest way, loading a bundle from the project's directory:
Session::<MinimalRuntime>::new()?
    .deploy_bundle_and(local_contract_file!(), "new", NO_ARGS, NO_SALT, NO_ENDOWMENT)?; /* ... */

// Or choosing the file explicitly:
let contract = ContractBundle::load("path/to/your.contract")?;
Session::<MinimalRuntime>::new()?
    .deploy_bundle_and(contract, "new", NO_ARGS, NO_SALT, NO_ENDOWMENT)?; /* ... */

Implementations

impl<R> Session<R>

where R: Runtime, R::Config: Config,

pub fn new() -> Result<Self, SessionError>

Creates a new Session.

pub fn with_actor(self, actor: AccountIdFor<R::Config>) -> Self

Sets a new actor and returns updated self.

pub fn get_actor(&self) -> AccountIdFor<R::Config>

Returns currently set actor.

pub fn set_actor( &mut self, actor: AccountIdFor<R::Config> ) -> AccountIdFor<R::Config>

Sets a new actor and returns the old one.

pub fn with_gas_limit(self, gas_limit: Weight) -> Self

Sets a new gas limit and returns updated self.

pub fn set_gas_limit(&mut self, gas_limit: Weight) -> Weight

Sets a new gas limit and returns the old one.

pub fn get_gas_limit(&self) -> Weight

Returns currently set gas limit.

pub fn with_determinism(self, determinism: Determinism) -> Self

Sets a new determinism policy and returns updated self.

pub fn set_determinism(&mut self, determinism: Determinism) -> Determinism

Sets a new determinism policy and returns the old one.

pub fn with_transcoder( self, contract_address: AccountIdFor<R::Config>, transcoder: &Rc<ContractMessageTranscoder> ) -> Self

Register a transcoder for a particular contract and returns updated self.

pub fn set_transcoder( &mut self, contract_address: AccountIdFor<R::Config>, transcoder: &Rc<ContractMessageTranscoder> )

Registers a transcoder for a particular contract.

pub fn sandbox(&mut self) -> &mut Sandbox<R>

The underlying Sandbox instance.

pub fn record(&self) -> &Record<R::Config>

Returns a reference to the record of the session.

pub fn mocking_api(&mut self) -> &mut impl MockingApi<R>

Returns a reference for mocking API.

pub fn deploy_and<S: AsRef<str> + Debug>( self, contract_bytes: Vec<u8>, constructor: &str, args: &[S], salt: Vec<u8>, endowment: Option<<<R::Config as Config>::Currency as Inspect<AccountIdFor<R::Config>>>::Balance>, transcoder: &Rc<ContractMessageTranscoder> ) -> Result<Self, SessionError>

Deploys a contract with a given constructor, arguments, salt and endowment. In case of success, returns self.

pub fn deploy<S: AsRef<str> + Debug>( &mut self, contract_bytes: Vec<u8>, constructor: &str, args: &[S], salt: Vec<u8>, endowment: Option<<<R::Config as Config>::Currency as Inspect<AccountIdFor<R::Config>>>::Balance>, transcoder: &Rc<ContractMessageTranscoder> ) -> Result<AccountIdFor<R::Config>, SessionError>

Deploys a contract with a given constructor, arguments, salt and endowment. In case of success, returns the address of the deployed contract.

pub fn deploy_bundle<S: AsRef<str> + Debug>( &mut self, contract_file: ContractBundle, constructor: &str, args: &[S], salt: Vec<u8>, endowment: Option<<<R::Config as Config>::Currency as Inspect<AccountIdFor<R::Config>>>::Balance> ) -> Result<AccountIdFor<R::Config>, SessionError>

Similar to deploy but takes the parsed contract file (ContractBundle) as a first argument.

You can get it with ContractBundle::load("some/path/your.contract") or local_contract_file!()

pub fn deploy_bundle_and<S: AsRef<str> + Debug>( self, contract_file: ContractBundle, constructor: &str, args: &[S], salt: Vec<u8>, endowment: Option<<<R::Config as Config>::Currency as Inspect<AccountIdFor<R::Config>>>::Balance> ) -> Result<Self, SessionError>

Similar to deploy_and but takes the parsed contract file (ContractBundle) as a first argument.

You can get it with ContractBundle::load("some/path/your.contract") or local_contract_file!()

pub fn upload_and(self, contract_bytes: Vec<u8>) -> Result<Self, SessionError>

Uploads a raw contract code. In case of success, returns self.

pub fn upload( &mut self, contract_bytes: Vec<u8> ) -> Result<HashFor<R::Config>, SessionError>

Uploads a raw contract code. In case of success returns the code hash.

pub fn upload_bundle_and( self, contract_file: ContractBundle ) -> Result<Self, SessionError>

Similar to upload_and but takes the contract bundle as the first argument.

You can obtain it using ContractBundle::load("some/path/your.contract") or local_contract_file!()

pub fn upload_bundle( &mut self, contract_file: ContractBundle ) -> Result<HashFor<R::Config>, SessionError>

Similar to upload but takes the contract bundle as the first argument.

You can obtain it using ContractBundle::load("some/path/your.contract") or local_contract_file!()

pub fn call_and<S: AsRef<str> + Debug>( self, message: &str, args: &[S], endowment: Option<<<R::Config as Config>::Currency as Inspect<AccountIdFor<R::Config>>>::Balance> ) -> Result<Self, SessionError>

Calls a contract with a given address. In case of a successful call, returns self.

pub fn call_with_address_and<S: AsRef<str> + Debug>( self, address: AccountIdFor<R::Config>, message: &str, args: &[S], endowment: Option<<<R::Config as Config>::Currency as Inspect<AccountIdFor<R::Config>>>::Balance> ) -> Result<Self, SessionError>

Calls the last deployed contract. In case of a successful call, returns self.

pub fn call<S: AsRef<str> + Debug, T: Decode>( &mut self, message: &str, args: &[S], endowment: Option<<<R::Config as Config>::Currency as Inspect<AccountIdFor<R::Config>>>::Balance> ) -> Result<MessageResult<T>, SessionError>

Calls the last deployed contract. In case of a successful call, returns the encoded result.

pub fn call_with_address<S: AsRef<str> + Debug, T: Decode>( &mut self, address: AccountIdFor<R::Config>, message: &str, args: &[S], endowment: Option<<<R::Config as Config>::Currency as Inspect<AccountIdFor<R::Config>>>::Balance> ) -> Result<MessageResult<T>, SessionError>

Calls a contract with a given address. In case of a successful call, returns the encoded result.

pub fn set_tracing_extension(&mut self, d: TracingExt)

Set the tracing extension

Trait Implementations

impl<R: Runtime> MockingApi<R> for Session<R>

where R::Config: Config,

fn deploy(&mut self, mock: ContractMock) -> AccountIdFor<R::Config>

Deploy mock as a standard contract. Returns the address of the deployed contract.

fn mock_existing_contract( &mut self, _mock: ContractMock, _address: AccountIdFor<R::Config> )

Mock part of an existing contract. In particular, allows to override real behavior of deployed contract’s messages.