Trait pallet_contracts::chain_extension::Ext

pub trait Ext: Sealed {
    type T: Config;

    // Required methods
    fn call(
        &mut self,
        gas_limit: Weight,
        deposit_limit: <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance,
        to: <Self::T as Config>::AccountId,
        value: <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance,
        input_data: Vec<u8>,
        allows_reentry: bool,
        read_only: bool,
    ) -> Result<ExecReturnValue, ExecError>;
    fn delegate_call(
        &mut self,
        code: <Self::T as Config>::Hash,
        input_data: Vec<u8>,
    ) -> Result<ExecReturnValue, ExecError>;
    fn instantiate(
        &mut self,
        gas_limit: Weight,
        deposit_limit: <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance,
        code: <Self::T as Config>::Hash,
        value: <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance,
        input_data: Vec<u8>,
        salt: &[u8],
    ) -> Result<(<Self::T as Config>::AccountId, ExecReturnValue), ExecError>;
    fn terminate(
        &mut self,
        beneficiary: &<Self::T as Config>::AccountId,
    ) -> DispatchResult;
    fn transfer(
        &mut self,
        to: &<Self::T as Config>::AccountId,
        value: <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance,
    ) -> DispatchResult;
    fn get_storage(&mut self, key: &Key<Self::T>) -> Option<Vec<u8>>;
    fn get_storage_size(&mut self, key: &Key<Self::T>) -> Option<u32>;
    fn set_storage(
        &mut self,
        key: &Key<Self::T>,
        value: Option<Vec<u8>>,
        take_old: bool,
    ) -> Result<WriteOutcome, DispatchError>;
    fn get_transient_storage(&self, key: &Key<Self::T>) -> Option<Vec<u8>>;
    fn get_transient_storage_size(&self, key: &Key<Self::T>) -> Option<u32>;
    fn set_transient_storage(
        &mut self,
        key: &Key<Self::T>,
        value: Option<Vec<u8>>,
        take_old: bool,
    ) -> Result<WriteOutcome, DispatchError>;
    fn caller(&self) -> Origin<Self::T>;
    fn is_contract(&self, address: &<Self::T as Config>::AccountId) -> bool;
    fn code_hash(
        &self,
        address: &<Self::T as Config>::AccountId,
    ) -> Option<<Self::T as Config>::Hash>;
    fn own_code_hash(&mut self) -> &<Self::T as Config>::Hash;
    fn caller_is_origin(&self) -> bool;
    fn caller_is_root(&self) -> bool;
    fn address(&self) -> &<Self::T as Config>::AccountId;
    fn balance(
        &self,
    ) -> <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance;
    fn value_transferred(
        &self,
    ) -> <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance;
    fn now(&self) -> &<<Self::T as Config>::Time as Time>::Moment;
    fn minimum_balance(
        &self,
    ) -> <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance;
    fn random(
        &self,
        subject: &[u8],
    ) -> (<Self::T as Config>::Hash, BlockNumberFor<Self::T>);
    fn deposit_event(
        &mut self,
        topics: Vec<<Self::T as Config>::Hash>,
        data: Vec<u8>,
    );
    fn block_number(&self) -> BlockNumberFor<Self::T>;
    fn max_value_size(&self) -> u32;
    fn get_weight_price(
        &self,
        weight: Weight,
    ) -> <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance;
    fn schedule(&self) -> &Schedule<Self::T>;
    fn gas_meter(&self) -> &GasMeter<Self::T>;
    fn gas_meter_mut(&mut self) -> &mut GasMeter<Self::T>;
    fn charge_storage(&mut self, diff: &Diff);
    fn append_debug_buffer(&mut self, msg: &str) -> bool;
    fn debug_buffer_enabled(&self) -> bool;
    fn call_runtime(
        &self,
        call: <Self::T as Config>::RuntimeCall,
    ) -> DispatchResultWithPostInfo;
    fn ecdsa_recover(
        &self,
        signature: &[u8; 65],
        message_hash: &[u8; 32],
    ) -> Result<[u8; 33], ()>;
    fn sr25519_verify(
        &self,
        signature: &[u8; 64],
        message: &[u8],
        pub_key: &[u8; 32],
    ) -> bool;
    fn ecdsa_to_eth_address(&self, pk: &[u8; 33]) -> Result<[u8; 20], ()>;
    fn contract_info(&mut self) -> &mut ContractInfo<Self::T>;
    fn transient_storage(&mut self) -> &mut TransientStorage<Self::T>;
    fn set_code_hash(
        &mut self,
        hash: <Self::T as Config>::Hash,
    ) -> DispatchResult;
    fn reentrance_count(&self) -> u32;
    fn account_reentrance_count(
        &self,
        account_id: &<Self::T as Config>::AccountId,
    ) -> u32;
    fn nonce(&mut self) -> u64;
    fn increment_refcount(
        code_hash: <Self::T as Config>::Hash,
    ) -> DispatchResult;
    fn decrement_refcount(code_hash: <Self::T as Config>::Hash);
    fn lock_delegate_dependency(
        &mut self,
        code_hash: <Self::T as Config>::Hash,
    ) -> DispatchResult;
    fn unlock_delegate_dependency(
        &mut self,
        code_hash: &<Self::T as Config>::Hash,
    ) -> DispatchResult;
    fn locked_delegate_dependencies_count(&mut self) -> usize;
    fn is_read_only(&self) -> bool;
}

An interface that provides access to the external environment in which the smart-contract is executed.

This interface is specialized to an account of the executing code, so all operations are implicitly performed on that account.

Note

This trait is sealed and cannot be implemented by downstream crates.

Required Associated Types

type T: Config

Required Methods

fn call( &mut self, gas_limit: Weight, deposit_limit: <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance, to: <Self::T as Config>::AccountId, value: <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance, input_data: Vec<u8>, allows_reentry: bool, read_only: bool, ) -> Result<ExecReturnValue, ExecError>

Call (possibly transferring some amount of funds) into the specified account.

Returns the code size of the called contract.

fn delegate_call( &mut self, code: <Self::T as Config>::Hash, input_data: Vec<u8>, ) -> Result<ExecReturnValue, ExecError>

Execute code in the current frame.

Returns the code size of the called contract.

fn instantiate( &mut self, gas_limit: Weight, deposit_limit: <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance, code: <Self::T as Config>::Hash, value: <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance, input_data: Vec<u8>, salt: &[u8], ) -> Result<(<Self::T as Config>::AccountId, ExecReturnValue), ExecError>

Instantiate a contract from the given code.

Returns the original code size of the called contract. The newly created account will be associated with code. value specifies the amount of value transferred from the caller to the newly created account.

fn terminate( &mut self, beneficiary: &<Self::T as Config>::AccountId, ) -> DispatchResult

Transfer all funds to beneficiary and delete the contract.

Since this function removes the self contract eagerly, if succeeded, no further actions should be performed on this Ext instance.

This function will fail if the same contract is present on the contract call stack.

fn transfer( &mut self, to: &<Self::T as Config>::AccountId, value: <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance, ) -> DispatchResult

Transfer some amount of funds into the specified account.

fn get_storage(&mut self, key: &Key<Self::T>) -> Option<Vec<u8>>

Returns the storage entry of the executing account by the given key.

Returns None if the key wasn’t previously set by set_storage or was deleted.

fn get_storage_size(&mut self, key: &Key<Self::T>) -> Option<u32>

Returns Some(len) (in bytes) if a storage item exists at key.

Returns None if the key wasn’t previously set by set_storage or was deleted.

fn set_storage( &mut self, key: &Key<Self::T>, value: Option<Vec<u8>>, take_old: bool, ) -> Result<WriteOutcome, DispatchError>

Sets the storage entry by the given key to the specified value. If value is None then the storage entry is deleted.

fn get_transient_storage(&self, key: &Key<Self::T>) -> Option<Vec<u8>>

Returns the transient storage entry of the executing account for the given key.

Returns None if the key wasn’t previously set by set_transient_storage or was deleted.

fn get_transient_storage_size(&self, key: &Key<Self::T>) -> Option<u32>

Returns Some(len) (in bytes) if a transient storage item exists at key.

Returns None if the key wasn’t previously set by set_transient_storage or was deleted.

fn set_transient_storage( &mut self, key: &Key<Self::T>, value: Option<Vec<u8>>, take_old: bool, ) -> Result<WriteOutcome, DispatchError>

Sets the transient storage entry for the given key to the specified value. If value is None then the storage entry is deleted.

fn caller(&self) -> Origin<Self::T>

Returns the caller.

fn is_contract(&self, address: &<Self::T as Config>::AccountId) -> bool

Check if a contract lives at the specified address.

fn code_hash( &self, address: &<Self::T as Config>::AccountId, ) -> Option<<Self::T as Config>::Hash>

Returns the code hash of the contract for the given address.

Returns None if the address does not belong to a contract.

fn own_code_hash(&mut self) -> &<Self::T as Config>::Hash

Returns the code hash of the contract being executed.

fn caller_is_origin(&self) -> bool

Check if the caller of the current contract is the origin of the whole call stack.

This can be checked with is_contract(self.caller()) as well. However, this function does not require any storage lookup and therefore uses less weight.

fn caller_is_root(&self) -> bool

Check if the caller is origin, and this origin is root.

fn address(&self) -> &<Self::T as Config>::AccountId

Returns a reference to the account id of the current contract.

fn balance( &self, ) -> <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance

Returns the balance of the current contract.

The value_transferred is already added.

fn value_transferred( &self, ) -> <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance

Returns the value transferred along with this call.

fn now(&self) -> &<<Self::T as Config>::Time as Time>::Moment

Returns a reference to the timestamp of the current block

fn minimum_balance( &self, ) -> <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance

Returns the minimum balance that is required for creating an account.

fn random( &self, subject: &[u8], ) -> (<Self::T as Config>::Hash, BlockNumberFor<Self::T>)

Returns a random number for the current block with the given subject.

fn deposit_event( &mut self, topics: Vec<<Self::T as Config>::Hash>, data: Vec<u8>, )

Deposit an event with the given topics.

There should not be any duplicates in topics.

fn block_number(&self) -> BlockNumberFor<Self::T>

Returns the current block number.

fn max_value_size(&self) -> u32

Returns the maximum allowed size of a storage item.

fn get_weight_price( &self, weight: Weight, ) -> <<Self::T as Config>::Currency as Inspect<<Self::T as Config>::AccountId>>::Balance

Returns the price for the specified amount of weight.

fn schedule(&self) -> &Schedule<Self::T>

Get a reference to the schedule used by the current call.

fn gas_meter(&self) -> &GasMeter<Self::T>

Get an immutable reference to the nested gas meter.

fn gas_meter_mut(&mut self) -> &mut GasMeter<Self::T>

Get a mutable reference to the nested gas meter.

fn charge_storage(&mut self, diff: &Diff)

Charges diff from the meter.

fn append_debug_buffer(&mut self, msg: &str) -> bool

Append a string to the debug buffer.

It is added as-is without any additional new line.

This is a no-op if debug message recording is disabled which is always the case when the code is executing on-chain.

Returns true if debug message recording is enabled. Otherwise false is returned.

fn debug_buffer_enabled(&self) -> bool

Returns true if debug message recording is enabled. Otherwise false is returned.

fn call_runtime( &self, call: <Self::T as Config>::RuntimeCall, ) -> DispatchResultWithPostInfo

Call some dispatchable and return the result.

fn ecdsa_recover( &self, signature: &[u8; 65], message_hash: &[u8; 32], ) -> Result<[u8; 33], ()>

Recovers ECDSA compressed public key based on signature and message hash.

fn sr25519_verify( &self, signature: &[u8; 64], message: &[u8], pub_key: &[u8; 32], ) -> bool

Verify a sr25519 signature.

fn ecdsa_to_eth_address(&self, pk: &[u8; 33]) -> Result<[u8; 20], ()>

Returns Ethereum address from the ECDSA compressed public key.

fn contract_info(&mut self) -> &mut ContractInfo<Self::T>

Tests sometimes need to modify and inspect the contract info directly.

fn transient_storage(&mut self) -> &mut TransientStorage<Self::T>

Get a mutable reference to the transient storage. Useful in benchmarks when it is sometimes necessary to modify and inspect the transient storage directly.

fn set_code_hash(&mut self, hash: <Self::T as Config>::Hash) -> DispatchResult

Sets new code hash for existing contract.

fn reentrance_count(&self) -> u32

Returns the number of times the currently executing contract exists on the call stack in addition to the calling instance. A value of 0 means no reentrancy.

fn account_reentrance_count( &self, account_id: &<Self::T as Config>::AccountId, ) -> u32

Returns the number of times the specified contract exists on the call stack. Delegated calls are not calculated as separate entrance. A value of 0 means it does not exist on the call stack.

fn nonce(&mut self) -> u64

Returns a nonce that is incremented for every instantiated contract.

fn increment_refcount(code_hash: <Self::T as Config>::Hash) -> DispatchResult

Increment the reference count of a of a stored code by one.

Errors

Error::CodeNotFound is returned if no stored code found having the specified code_hash.

fn decrement_refcount(code_hash: <Self::T as Config>::Hash)

Decrement the reference count of a stored code by one.

Note

A contract whose reference count dropped to zero isn’t automatically removed. A remove_code transaction must be submitted by the original uploader to do so.

fn lock_delegate_dependency( &mut self, code_hash: <Self::T as Config>::Hash, ) -> DispatchResult

Adds a delegate dependency to [ContractInfo]’s delegate_dependencies field.

This ensures that the delegated contract is not removed while it is still in use. It increases the reference count of the code hash and charges a fraction (see Config::CodeHashLockupDepositPercent) of the code deposit.

Errors

• Error::MaxDelegateDependenciesReached
• Error::CannotAddSelfAsDelegateDependency
• Error::DelegateDependencyAlreadyExists

fn unlock_delegate_dependency( &mut self, code_hash: &<Self::T as Config>::Hash, ) -> DispatchResult

Removes a delegate dependency from [ContractInfo]’s delegate_dependencies field.

This is the counterpart of Self::lock_delegate_dependency. It decreases the reference count and refunds the deposit that was charged by Self::lock_delegate_dependency.

Errors

• Error::DelegateDependencyNotFound

fn locked_delegate_dependencies_count(&mut self) -> usize

Returns the number of locked delegate dependencies.

Note: Requires &mut self to access the contract info.

fn is_read_only(&self) -> bool

Check if running in read-only context.

Object Safety

This trait is not object safe.

Implementors