Enum Call

pub enum Call<T: Config>
where
    BalanceOf<T>: Into<U256> + TryFrom<U256>,
    MomentOf<T>: Into<U256>,
    T::Hash: IsType<H256>,
{
    eth_transact {
        payload: Vec<u8>,
    },
    call {
        dest: H160,
        value: BalanceOf<T>,
        gas_limit: Weight,
        storage_deposit_limit: BalanceOf<T>,
        data: Vec<u8>,
    },
    instantiate {
        value: BalanceOf<T>,
        gas_limit: Weight,
        storage_deposit_limit: BalanceOf<T>,
        code_hash: H256,
        data: Vec<u8>,
        salt: Option<[u8; 32]>,
    },
    instantiate_with_code {
        value: BalanceOf<T>,
        gas_limit: Weight,
        storage_deposit_limit: BalanceOf<T>,
        code: Vec<u8>,
        data: Vec<u8>,
        salt: Option<[u8; 32]>,
    },
    eth_instantiate_with_code {
        value: U256,
        gas_limit: Weight,
        storage_deposit_limit: BalanceOf<T>,
        code: Vec<u8>,
        data: Vec<u8>,
    },
    eth_call {
        dest: H160,
        value: U256,
        gas_limit: Weight,
        storage_deposit_limit: BalanceOf<T>,
        data: Vec<u8>,
    },
    upload_code {
        code: Vec<u8>,
        storage_deposit_limit: BalanceOf<T>,
    },
    remove_code {
        code_hash: H256,
    },
    set_code {
        dest: H160,
        code_hash: H256,
    },
    map_account {},
    unmap_account {},
    dispatch_as_fallback_account {
        call: Box<<T as Config>::RuntimeCall>,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

eth_transact

A raw EVM transaction, typically dispatched by an Ethereum JSON-RPC server.

Parameters

• payload: The encoded crate::evm::TransactionSigned.
• gas_limit: The gas limit enforced during contract execution.
• storage_deposit_limit: The maximum balance that can be charged to the caller for storage usage.

Note

This call cannot be dispatched directly; attempting to do so will result in a failed transaction. It serves as a wrapper for an Ethereum transaction. When submitted, the runtime converts it into a [sp_runtime::generic::CheckedExtrinsic] by recovering the signer and validating the transaction.

Fields

payload: Vec<u8>

call

Makes a call to an account, optionally transferring some balance.

Parameters

• dest: Address of the contract to call.

• value: The balance to transfer from the origin to dest.

• gas_limit: The gas limit enforced when executing the constructor.

• storage_deposit_limit: The maximum amount of balance that can be charged from the caller to pay for the storage consumed.

• data: The input data to pass to the contract.

• If the account is a smart-contract account, the associated code will be executed and any value will be transferred.

• If the account is a regular account, any value will be transferred.

• If no account exists and the call value is not less than existential_deposit, a regular account will be created and any value will be transferred.

Fields

dest: H160

value: BalanceOf<T>

gas_limit: Weight

storage_deposit_limit: BalanceOf<T>

data: Vec<u8>

instantiate

Instantiates a contract from a previously deployed vm binary.

This function is identical to Self::instantiate_with_code but without the code deployment step. Instead, the code_hash of an on-chain deployed vm binary must be supplied.

Fields

value: BalanceOf<T>

gas_limit: Weight

storage_deposit_limit: BalanceOf<T>

code_hash: H256

data: Vec<u8>

salt: Option<[u8; 32]>

instantiate_with_code

Instantiates a new contract from the supplied code optionally transferring some balance.

This dispatchable has the same effect as calling Self::upload_code + Self::instantiate. Bundling them together provides efficiency gains. Please also check the documentation of Self::upload_code.

Parameters

• value: The balance to transfer from the origin to the newly created contract.
• gas_limit: The gas limit enforced when executing the constructor.
• storage_deposit_limit: The maximum amount of balance that can be charged/reserved from the caller to pay for the storage consumed.
• code: The contract code to deploy in raw bytes.
• data: The input data to pass to the contract constructor.
• salt: Used for the address derivation. If Some is supplied then CREATE2 semantics are used. If None then CRATE1 is used.

Instantiation is executed as follows:

• The supplied code is deployed, and a code_hash is created for that code.
• If the code_hash already exists on the chain the underlying code will be shared.
• The destination address is computed based on the sender, code_hash and the salt.
• The smart-contract account is created at the computed address.
• The value is transferred to the new account.
• The deploy function is executed in the context of the newly-created account.

Fields

value: BalanceOf<T>

gas_limit: Weight

storage_deposit_limit: BalanceOf<T>

code: Vec<u8>

data: Vec<u8>

salt: Option<[u8; 32]>

eth_instantiate_with_code

Same as Self::instantiate_with_code, but intended to be dispatched only by an EVM transaction through the EVM compatibility layer.

Calling this dispatchable ensures that the origin’s nonce is bumped only once, via the CheckNonce transaction extension. In contrast, Self::instantiate_with_code also bumps the nonce after contract instantiation, since it may be invoked multiple times within a batch call transaction.

Fields

value: U256

gas_limit: Weight

storage_deposit_limit: BalanceOf<T>

code: Vec<u8>

data: Vec<u8>

eth_call

Same as Self::call, but intended to be dispatched only by an EVM transaction through the EVM compatibility layer.

Fields

dest: H160

value: U256

gas_limit: Weight

storage_deposit_limit: BalanceOf<T>

data: Vec<u8>

upload_code

Upload new code without instantiating a contract from it.

If the code does not already exist a deposit is reserved from the caller The size of the reserve depends on the size of the supplied code.

Note

Anyone can instantiate a contract from any uploaded code and thus prevent its removal. To avoid this situation a constructor could employ access control so that it can only be instantiated by permissioned entities. The same is true when uploading through Self::instantiate_with_code.

If the refcount of the code reaches zero after terminating the last contract that references this code, the code will be removed automatically.

Fields

code: Vec<u8>

storage_deposit_limit: BalanceOf<T>

remove_code

Remove the code stored under code_hash and refund the deposit to its owner.

A code can only be removed by its original uploader (its owner) and only if it is not used by any contract.

Fields

code_hash: H256

set_code

Privileged function that changes the code of an existing contract.

This takes care of updating refcounts and all other necessary operations. Returns an error if either the code_hash or dest do not exist.

Note

This does not change the address of the contract in question. This means that the contract address is no longer derived from its code hash after calling this dispatchable.

Fields

dest: H160

code_hash: H256

map_account

Register the callers account id so that it can be used in contract interactions.

This will error if the origin is already mapped or is a eth native Address20. It will take a deposit that can be released by calling Self::unmap_account.

unmap_account

Unregister the callers account id in order to free the deposit.

There is no reason to ever call this function other than freeing up the deposit. This is only useful when the account should no longer be used.

dispatch_as_fallback_account

Dispatch an call with the origin set to the callers fallback address.

Every AccountId32 can control its corresponding fallback account. The fallback account is the AccountId20 with the last 12 bytes set to 0xEE. This is essentially a recovery function in case an AccountId20 was used without creating a mapping first.

Fields

call: Box<<T as Config>::RuntimeCall>

Implementations

impl<T: Config> Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

pub fn new_call_variant_eth_transact(payload: Vec<u8>) -> Self

Create a call with the variant eth_transact.

pub fn new_call_variant_call( dest: H160, value: BalanceOf<T>, gas_limit: Weight, storage_deposit_limit: BalanceOf<T>, data: Vec<u8>, ) -> Self

Create a call with the variant call.

pub fn new_call_variant_instantiate( value: BalanceOf<T>, gas_limit: Weight, storage_deposit_limit: BalanceOf<T>, code_hash: H256, data: Vec<u8>, salt: Option<[u8; 32]>, ) -> Self

Create a call with the variant instantiate.

pub fn new_call_variant_instantiate_with_code( value: BalanceOf<T>, gas_limit: Weight, storage_deposit_limit: BalanceOf<T>, code: Vec<u8>, data: Vec<u8>, salt: Option<[u8; 32]>, ) -> Self

Create a call with the variant instantiate_with_code.

pub fn new_call_variant_eth_instantiate_with_code( value: U256, gas_limit: Weight, storage_deposit_limit: BalanceOf<T>, code: Vec<u8>, data: Vec<u8>, ) -> Self

Create a call with the variant eth_instantiate_with_code.

pub fn new_call_variant_eth_call( dest: H160, value: U256, gas_limit: Weight, storage_deposit_limit: BalanceOf<T>, data: Vec<u8>, ) -> Self

Create a call with the variant eth_call.

pub fn new_call_variant_upload_code( code: Vec<u8>, storage_deposit_limit: BalanceOf<T>, ) -> Self

Create a call with the variant upload_code.

pub fn new_call_variant_remove_code(code_hash: H256) -> Self

Create a call with the variant remove_code.

pub fn new_call_variant_set_code(dest: H160, code_hash: H256) -> Self

Create a call with the variant set_code.

pub fn new_call_variant_map_account() -> Self

Create a call with the variant map_account.

pub fn new_call_variant_unmap_account() -> Self

Create a call with the variant unmap_account.

pub fn new_call_variant_dispatch_as_fallback_account( call: Box<<T as Config>::RuntimeCall>, ) -> Self

Create a call with the variant dispatch_as_fallback_account.

Trait Implementations

impl<T: Config> Authorize for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

fn authorize( &self, source: TransactionSource, ) -> Option<Result<(ValidTransaction, Weight), TransactionValidityError>>

The authorize function.

fn weight_of_authorize(&self) -> Weight

The weight of the authorization function.

impl<T: Config> CheckIfFeeless for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

type Origin = <T as Config>::RuntimeOrigin

The Origin type of the runtime.

fn is_feeless(&self, origin: &Self::Origin) -> bool

Checks if the dispatchable satisfies the feeless condition as defined by #[pallet::feeless_if]

impl<T: Config> Clone for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Config> Debug for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> GetCallIndex for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

fn get_call_index(&self) -> u8

Return the index of this Call.

fn get_call_indices() -> &'static [u8]

Return all call indices in the same order as [GetCallName].

impl<T: Config> GetCallName for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names in the same order as [GetCallIndex].

impl<T: Config> GetDispatchInfo for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> TypeInfo for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256> + HasCompact, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>, PhantomData<(T,)>: TypeInfo + 'static, Box<<T as Config>::RuntimeCall>: TypeInfo + 'static, T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

type RuntimeOrigin = <T as Config>::RuntimeOrigin

The origin type of the runtime, (i.e. frame_system::Config::RuntimeOrigin).

fn dispatch_bypass_filter( self, origin: Self::RuntimeOrigin, ) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config> DecodeWithMemTracking for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256> + HasCompact, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>, Box<<T as Config>::RuntimeCall>: DecodeWithMemTracking, <BalanceOf<T> as HasCompact>::Type: DecodeWithMemTracking,

impl<T: Config> EncodeLike for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,

impl<T: Config> Eq for Call<T>

where BalanceOf<T>: Into<U256> + TryFrom<U256>, MomentOf<T>: Into<U256>, T::Hash: IsType<H256>,