Struct polymesh_api::polymesh::api::utility::UtilityCallApi

pub struct UtilityCallApi<'api> { /* private fields */ }

Implementations

impl<'api> UtilityCallApi<'api>

pub fn batch(&self, calls: Vec<RuntimeCall>) -> Result<WrappedCall>

Send a batch of dispatch calls.

May be called from any origin except None.

• calls: The calls to be dispatched from the same origin. The number of call must not exceed the constant: batched_calls_limit (available in constant metadata).

If origin is root then the calls are dispatched without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

Complexity

• O(C) where C is the number of calls to be batched.

This will return Ok in all circumstances. To determine the success of the batch, an event is deposited. If a call failed and the batch was interrupted, then the BatchInterrupted event is deposited, along with the number of successful calls made and the error of the failed call. If all were successful, then the BatchCompleted event is deposited.

pub fn relay_tx( &self, target: AccountId, signature: MultiSignature, call: UniqueCall<RuntimeCall> ) -> Result<WrappedCall>

Relay a call for a target from an origin

Relaying in this context refers to the ability of origin to make a call on behalf of target.

Fees are charged to origin

Parameters

• target: Account to be relayed
• signature: Signature from target authorizing the relay
• call: Call to be relayed on behalf of target

POLYMESH: added.

pub fn batch_all(&self, calls: Vec<RuntimeCall>) -> Result<WrappedCall>

Send a batch of dispatch calls and atomically execute them. The whole transaction will rollback and fail if any of the calls failed.

May be called from any origin except None.

• calls: The calls to be dispatched from the same origin. The number of call must not exceed the constant: batched_calls_limit (available in constant metadata).

If origin is root then the calls are dispatched without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

Complexity

• O(C) where C is the number of calls to be batched.

pub fn dispatch_as( &self, as_origin: OriginCaller, call: RuntimeCall ) -> Result<WrappedCall>

Dispatches a function call with a provided origin.

The dispatch origin for this call must be Root.

Complexity

• O(1).

pub fn force_batch(&self, calls: Vec<RuntimeCall>) -> Result<WrappedCall>

Send a batch of dispatch calls. Unlike batch, it allows errors and won’t interrupt.

May be called from any origin except None.

• calls: The calls to be dispatched from the same origin. The number of call must not exceed the constant: batched_calls_limit (available in constant metadata).

If origin is root then the calls are dispatch without checking origin filter. (This includes bypassing frame_system::Config::BaseCallFilter).

Complexity

• O(C) where C is the number of calls to be batched.

pub fn with_weight( &self, call: RuntimeCall, weight: Weight ) -> Result<WrappedCall>

Dispatch a function call with a specified weight.

This function does not check the weight of the call, and instead allows the Root origin to specify the weight of the call.

The dispatch origin for this call must be Root.

pub fn batch_old(&self, calls: Vec<RuntimeCall>) -> Result<WrappedCall>

Dispatch multiple calls from the sender’s origin.

This will execute until the first one fails and then stop.

May be called from root or a signed origin.

Parameters

• calls: The calls to be dispatched from the same origin.

Weight

• The sum of the weights of the calls.
• One event.

This will return Ok in all circumstances except an unsigned origin. To determine the success of the batch, an event is deposited. If a call failed and the batch was interrupted, then the BatchInterruptedOld event is deposited, along with the number of successful calls made and the error of the failed call. If all were successful, then the BatchCompletedOld event is deposited.

POLYMESH: Renamed from batch and deprecated.

pub fn batch_atomic(&self, calls: Vec<RuntimeCall>) -> Result<WrappedCall>

Dispatch multiple calls from the sender’s origin.

This will execute all calls, in order, stopping at the first failure, in which case the state changes are rolled back. On failure, an event BatchInterruptedOld(failure_idx, error) is deposited.

May be called from root or a signed origin.

Parameters

• calls: The calls to be dispatched from the same origin.

Weight

• The sum of the weights of the calls.
• One event.

This will return Ok in all circumstances except an unsigned origin. To determine the success of the batch, an event is deposited. If any call failed, then BatchInterruptedOld is deposited. If all were successful, then the BatchCompletedOld event is deposited.

POLYMESH: deprecated.

pub fn batch_optimistic(&self, calls: Vec<RuntimeCall>) -> Result<WrappedCall>

Dispatch multiple calls from the sender’s origin.

This will execute all calls, in order, irrespective of failures. Any failures will be available in a BatchOptimisticFailed event.

May be called from root or a signed origin.

Parameters

• calls: The calls to be dispatched from the same origin.

Weight

• The sum of the weights of the calls.
• One event.

This will return Ok in all circumstances except an unsigned origin. To determine the success of the batch, an event is deposited. If any call failed, then BatchOptimisticFailed is deposited, with a vector of event counts for each call as well as a vector of errors. If all were successful, then the BatchCompletedOld event is deposited.

POLYMESH: deprecated.

Trait Implementations

impl<'api> Clone for UtilityCallApi<'api>

fn clone(&self) -> UtilityCallApi<'api>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'api> From<&'api Api> for UtilityCallApi<'api>

fn from(api: &'api Api) -> Self

Converts to this type from the input type.