Struct ink_e2e::Client

pub struct Client<C, E>where
    C: Config,
    E: Environment,{ /* private fields */ }

The Client takes care of communicating with the node.

This node’s RPC interface will be used for instantiating the contract and interacting with it .

Implementations

impl<C, E> Client<C, E>where C: Config, C::AccountId: From<PublicKey> + Codec + DeserializeOwned + Debug, C::Address: From<PublicKey>, C::Signature: From<Signature>, <C::ExtrinsicParams as ExtrinsicParams<C::Hash>>::OtherParams: Default, E: Environment, E::AccountId: Debug, E::Balance: Debug + HasCompact + Serialize, E::Hash: Debug + Encode,

pub async fn new( client: OnlineClient<C>, contracts: impl IntoIterator<Item = &str> ) -> Self

Creates a new Client instance using a subxt client.

pub async fn create_and_fund_account( &self, origin: &Keypair, amount: E::Balance ) -> Keypairwhere E::Balance: Clone, C::AccountId: Clone + Display + Debug,

Generate a new keypair and fund with the given amount from the origin account.

Because many tests may execute this in parallel, transfers may fail due to a race condition with account indices. Therefore this will reattempt transfers a number of times.

pub async fn instantiate<ContractRef, Args, R>( &mut self, contract_name: &str, signer: &Keypair, constructor: CreateBuilder<E, ContractRef, Unset<<E as Environment>::Hash>, Unset<u64>, Unset<<E as Environment>::Balance>, Set<ExecutionInput<Args>>, Unset<Salt>, Set<ReturnType<R>>>, value: E::Balance, storage_deposit_limit: Option<E::Balance> ) -> Result<InstantiationResult<C, E>, Error<C, E>>where Args: Encode,

This function extracts the metadata of the contract at the file path target/ink/$contract_name.contract.

The function subsequently uploads and instantiates an instance of the contract.

Calling this function multiple times is idempotent, the contract is newly instantiated each time using a unique salt. No existing contract instance is reused!

pub async fn instantiate_dry_run<ContractRef, Args, R>( &mut self, contract_name: &str, signer: &Keypair, constructor: CreateBuilder<E, ContractRef, Unset<<E as Environment>::Hash>, Unset<u64>, Unset<<E as Environment>::Balance>, Set<ExecutionInput<Args>>, Unset<Salt>, Set<ReturnType<R>>>, value: E::Balance, storage_deposit_limit: Option<E::Balance> ) -> ContractInstantiateResult<C::AccountId, E::Balance, ()>where Args: Encode,

Dry run contract instantiation using the given constructor.

pub async fn upload( &mut self, contract_name: &str, signer: &Keypair, storage_deposit_limit: Option<E::Balance> ) -> Result<UploadResult<C, E>, Error<C, E>>

This function extracts the Wasm of the contract for the specified contract.

The function subsequently uploads and instantiates an instance of the contract.

Calling this function multiple times is idempotent, the contract is newly instantiated each time using a unique salt. No existing contract instance is reused!

pub async fn exec_upload( &mut self, signer: &Keypair, code: Vec<u8>, storage_deposit_limit: Option<E::Balance> ) -> Result<UploadResult<C, E>, Error<C, E>>

Executes an upload call and captures the resulting events.

pub async fn call<RetType>( &mut self, signer: &Keypair, message: Message<E, RetType>, value: E::Balance, storage_deposit_limit: Option<E::Balance> ) -> Result<CallResult<C, E, RetType>, Error<C, E>>where RetType: Decode,

Executes a call for the contract at account_id.

Returns when the transaction is included in a block. The return value contains all events that are associated with this transaction.

pub async fn runtime_call<'a>( &mut self, signer: &Keypair, pallet_name: &'a str, call_name: &'a str, call_data: Vec<Value> ) -> Result<ExtrinsicEvents<C>, Error<C, E>>

Executes a runtime call call_name for the pallet_name. The call_data is a Vec<Value>

Note:

• pallet_name must be in camel case, for example Balances.
• call_name must be snake case, for example force_transfer.
• call_data is a Vec<subxt::dynamic::Value> that holds a representation of some value.

Returns when the transaction is included in a block. The return value contains all events that are associated with this transaction.

pub async fn call_dry_run<RetType>( &mut self, signer: &Keypair, message: &Message<E, RetType>, value: E::Balance, storage_deposit_limit: Option<E::Balance> ) -> CallDryRunResult<E, RetType>where RetType: Decode,

Executes a dry-run call.

Returns the result of the dry run, together with the decoded return value of the invoked message.

pub async fn balance( &self, account_id: E::AccountId ) -> Result<E::Balance, Error<C, E>>where E::Balance: TryFrom<u128>,

Returns the balance of account_id.