Struct TxClient

pub struct TxClient<T: Config, Client> { /* private fields */ }

A client for working with transactions.

Implementations

impl<T: Config, Client> TxClient<T, Client>

pub fn new(client: Client) -> Self

Create a new TxClient

impl<T: Config, C: OfflineClientT<T>> TxClient<T, C>

pub fn validate<Call>(&self, call: &Call) -> Result<(), Error>

where Call: Payload,

Run the validation logic against some extrinsic you’d like to submit. Returns Ok(()) if the call is valid (or if it’s not possible to check since the call has no validation hash). Return an error if the call was not valid or something went wrong trying to validate it (ie the pallet or call in question do not exist at all).

pub fn call_data<Call>(&self, call: &Call) -> Result<Vec<u8>, Error>

where Call: Payload,

Return the SCALE encoded bytes representing the call data of the transaction.

pub fn create_unsigned<Call>( &self, call: &Call, ) -> Result<SubmittableExtrinsic<T, C>, Error>

where Call: Payload,

Creates an unsigned extrinsic without submitting it.

pub fn create_partial_signed_offline<Call>( &self, call: &Call, params: <T::ExtrinsicParams as ExtrinsicParams<T>>::Params, ) -> Result<PartialExtrinsic<T, C>, Error>

where Call: Payload,

Create a partial extrinsic.

Note: if not provided, the default account nonce will be set to 0 and the default mortality will be immortal. This is because this method runs offline, and so is unable to fetch the data needed for more appropriate values.

pub fn create_signed_offline<Call, Signer>( &self, call: &Call, signer: &Signer, params: <T::ExtrinsicParams as ExtrinsicParams<T>>::Params, ) -> Result<SubmittableExtrinsic<T, C>, Error>

where Call: Payload, Signer: SignerT<T>,

Creates a signed extrinsic without submitting it.

Note: if not provided, the default account nonce will be set to 0 and the default mortality will be immortal. This is because this method runs offline, and so is unable to fetch the data needed for more appropriate values.

impl<T, C> TxClient<T, C>

where T: Config, C: OnlineClientT<T>,

pub async fn account_nonce( &self, account_id: &T::AccountId, ) -> Result<u64, Error>

Get the account nonce for a given account ID.

pub async fn create_partial_signed<Call>( &self, call: &Call, account_id: &T::AccountId, params: <T::ExtrinsicParams as ExtrinsicParams<T>>::Params, ) -> Result<PartialExtrinsic<T, C>, Error>

where Call: Payload,

Creates a partial signed extrinsic, without submitting it.

pub async fn create_signed<Call, Signer>( &self, call: &Call, signer: &Signer, params: <T::ExtrinsicParams as ExtrinsicParams<T>>::Params, ) -> Result<SubmittableExtrinsic<T, C>, Error>

where Call: Payload, Signer: SignerT<T>,

Creates a signed extrinsic, without submitting it.

pub async fn sign_and_submit_then_watch_default<Call, Signer>( &self, call: &Call, signer: &Signer, ) -> Result<TxProgress<T, C>, Error>

where Call: Payload, Signer: SignerT<T>, <T::ExtrinsicParams as ExtrinsicParams<T>>::Params: Default,

Creates and signs an extrinsic and submits it to the chain. Passes default parameters to construct the “signed extra” and “additional” payloads needed by the extrinsic.

Returns a TxProgress, which can be used to track the status of the transaction and obtain details about it, once it has made it into a block.

pub async fn sign_and_submit_then_watch<Call, Signer>( &self, call: &Call, signer: &Signer, params: <T::ExtrinsicParams as ExtrinsicParams<T>>::Params, ) -> Result<TxProgress<T, C>, Error>

where Call: Payload, Signer: SignerT<T>,

Creates and signs an extrinsic and submits it to the chain.

Returns a TxProgress, which can be used to track the status of the transaction and obtain details about it, once it has made it into a block.

pub async fn sign_and_submit_default<Call, Signer>( &self, call: &Call, signer: &Signer, ) -> Result<T::Hash, Error>

where Call: Payload, Signer: SignerT<T>, <T::ExtrinsicParams as ExtrinsicParams<T>>::Params: Default,

Creates and signs an extrinsic and submits to the chain for block inclusion. Passes default parameters to construct the “signed extra” and “additional” payloads needed by the extrinsic.

Returns Ok with the extrinsic hash if it is valid extrinsic.

Note

Success does not mean the extrinsic has been included in the block, just that it is valid and has been included in the transaction pool.

pub async fn sign_and_submit<Call, Signer>( &self, call: &Call, signer: &Signer, params: <T::ExtrinsicParams as ExtrinsicParams<T>>::Params, ) -> Result<T::Hash, Error>

where Call: Payload, Signer: SignerT<T>,

Creates and signs an extrinsic and submits to the chain for block inclusion.

Returns Ok with the extrinsic hash if it is valid extrinsic.

Note

Success does not mean the extrinsic has been included in the block, just that it is valid and has been included in the transaction pool.

Trait Implementations

impl<T: Config, Client> Clone for TxClient<T, Client>

where Client: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.