Enum pallet_contracts::pallet::Call

pub enum Call<T: Config>
where
    <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,
{
    call_old_weight {
        dest: <<T as Config>::Lookup as StaticLookup>::Source,
        value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance,
        gas_limit: u64,
        storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>,
        data: Vec<u8>,
    },
    instantiate_with_code_old_weight {
        value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance,
        gas_limit: u64,
        storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>,
        code: Vec<u8>,
        data: Vec<u8>,
        salt: Vec<u8>,
    },
    instantiate_old_weight {
        value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance,
        gas_limit: u64,
        storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>,
        code_hash: <T as Config>::Hash,
        data: Vec<u8>,
        salt: Vec<u8>,
    },
    upload_code {
        code: Vec<u8>,
        storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>,
        determinism: Determinism,
    },
    remove_code {
        code_hash: <T as Config>::Hash,
    },
    set_code {
        dest: <<T as Config>::Lookup as StaticLookup>::Source,
        code_hash: <T as Config>::Hash,
    },
    call {
        dest: <<T as Config>::Lookup as StaticLookup>::Source,
        value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance,
        gas_limit: Weight,
        storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>,
        data: Vec<u8>,
    },
    instantiate_with_code {
        value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance,
        gas_limit: Weight,
        storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>,
        code: Vec<u8>,
        data: Vec<u8>,
        salt: Vec<u8>,
    },
    instantiate {
        value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance,
        gas_limit: Weight,
        storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>,
        code_hash: <T as Config>::Hash,
        data: Vec<u8>,
        salt: Vec<u8>,
    },
    migrate {
        weight_limit: Weight,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

call_old_weight

Deprecated version if Self::call for use in an in-storage Call.

Fields

dest: <<T as Config>::Lookup as StaticLookup>::Source

value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance

gas_limit: u64

storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>

data: Vec<u8>

instantiate_with_code_old_weight

Deprecated version if Self::instantiate_with_code for use in an in-storage Call.

Fields

value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance

gas_limit: u64

storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>

code: Vec<u8>

data: Vec<u8>

salt: Vec<u8>

instantiate_old_weight

Deprecated version if Self::instantiate for use in an in-storage Call.

Fields

value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance

gas_limit: u64

storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>

code_hash: <T as Config>::Hash

data: Vec<u8>

salt: 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 and unreserved only when Self::remove_code is called. The size of the reserve depends on the size of the supplied code.

If the code already exists in storage it will still return Ok and upgrades the in storage version to the current InstructionWeights::version.

• determinism: If this is set to any other value but Determinism::Enforced then the only way to use this code is to delegate call into it from an offchain execution. Set to Determinism::Enforced if in doubt.

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.

Use Determinism::Relaxed exclusively for non-deterministic code. If the uploaded code is deterministic, specifying Determinism::Relaxed will be disregarded and result in higher gas costs.

Fields

code: Vec<u8>

storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>

determinism: Determinism

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: <T as Config>::Hash

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: <<T as Config>::Lookup as StaticLookup>::Source

code_hash: <T as Config>::Hash

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: <<T as Config>::Lookup as StaticLookup>::Source

value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance

gas_limit: Weight

storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>

data: Vec<u8>

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. See Pallet::contract_address.

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: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance

gas_limit: Weight

storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>

code: Vec<u8>

data: Vec<u8>

salt: Vec<u8>

instantiate

Instantiates a contract from a previously deployed wasm 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 wasm binary must be supplied.

Fields

value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance

gas_limit: Weight

storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>

code_hash: <T as Config>::Hash

data: Vec<u8>

salt: Vec<u8>

migrate

When a migration is in progress, this dispatchable can be used to run migration steps. Calls that contribute to advancing the migration have their fees waived, as it’s helpful for the chain. Note that while the migration is in progress, the pallet will also leverage the on_idle hooks to run migration steps.

Fields

weight_limit: Weight

Implementations

impl<T: Config> Call<T>

where <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

pub fn new_call_variant_call_old_weight( dest: <<T as Config>::Lookup as StaticLookup>::Source, value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: u64, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, data: Vec<u8>, ) -> Self

Create a call with the variant call_old_weight.

pub fn new_call_variant_instantiate_with_code_old_weight( value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: u64, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, code: Vec<u8>, data: Vec<u8>, salt: Vec<u8>, ) -> Self

Create a call with the variant instantiate_with_code_old_weight.

pub fn new_call_variant_instantiate_old_weight( value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: u64, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, code_hash: <T as Config>::Hash, data: Vec<u8>, salt: Vec<u8>, ) -> Self

Create a call with the variant instantiate_old_weight.

pub fn new_call_variant_upload_code( code: Vec<u8>, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, determinism: Determinism, ) -> Self

Create a call with the variant upload_code.

pub fn new_call_variant_remove_code(code_hash: <T as Config>::Hash) -> Self

Create a call with the variant remove_code.

pub fn new_call_variant_set_code( dest: <<T as Config>::Lookup as StaticLookup>::Source, code_hash: <T as Config>::Hash, ) -> Self

Create a call with the variant set_code.

pub fn new_call_variant_call( dest: <<T as Config>::Lookup as StaticLookup>::Source, value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: Weight, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, data: Vec<u8>, ) -> Self

Create a call with the variant call.

pub fn new_call_variant_instantiate_with_code( value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: Weight, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, code: Vec<u8>, data: Vec<u8>, salt: Vec<u8>, ) -> Self

Create a call with the variant instantiate_with_code.

pub fn new_call_variant_instantiate( value: <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, gas_limit: Weight, storage_deposit_limit: Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>, code_hash: <T as Config>::Hash, data: Vec<u8>, salt: Vec<u8>, ) -> Self

Create a call with the variant instantiate.

pub fn new_call_variant_migrate(weight_limit: Weight) -> Self

Create a call with the variant migrate.

Trait Implementations

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

where <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

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 <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

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 <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

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

Formats the value using the given formatter.

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

where <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

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 <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

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 <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

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 <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

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 <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

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

where <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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 <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode, PhantomData<(T,)>: TypeInfo + 'static, <<T as Config>::Lookup as StaticLookup>::Source: TypeInfo + 'static, <<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance: HasCompact, Option<<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type>: TypeInfo + 'static, <T as Config>::Hash: 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 <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

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> EncodeLike for Call<T>

where <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,

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

where <<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance as HasCompact>::Type: Clone + Eq + PartialEq + Debug + TypeInfo + Encode,