Trait pallet_contracts::api_doc::seal0::Api

source · 
pub trait Api {

Show 85 methods    fn gas(amount: u64) -> Result<(), TrapReason>;
    fn set_storage(
        key_ptr: u32,
        value_ptr: u32,
        value_len: u32
    ) -> Result<(), TrapReason>;
    fn clear_storage(key_ptr: u32) -> Result<(), TrapReason>;
    fn get_storage(
        key_ptr: u32,
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn contains_storage(key_ptr: u32) -> Result<u32, TrapReason>;
    fn take_storage(
        key_ptr: u32,
        key_len: u32,
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn transfer(
        account_ptr: u32,
        _account_len: u32,
        value_ptr: u32,
        _value_len: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn call(
        callee_ptr: u32,
        _callee_len: u32,
        gas: u64,
        value_ptr: u32,
        _value_len: u32,
        input_data_ptr: u32,
        input_data_len: u32,
        output_ptr: u32,
        output_len_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn delegate_call(
        flags: u32,
        code_hash_ptr: u32,
        input_data_ptr: u32,
        input_data_len: u32,
        output_ptr: u32,
        output_len_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn instantiate(
        code_hash_ptr: u32,
        _code_hash_len: u32,
        gas: u64,
        value_ptr: u32,
        _value_len: u32,
        input_data_ptr: u32,
        input_data_len: u32,
        address_ptr: u32,
        address_len_ptr: u32,
        output_ptr: u32,
        output_len_ptr: u32,
        salt_ptr: u32,
        salt_len: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn terminate(
        beneficiary_ptr: u32,
        _beneficiary_len: u32
    ) -> Result<(), TrapReason>;
    fn input(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn seal_return(
        flags: u32,
        data_ptr: u32,
        data_len: u32
    ) -> Result<(), TrapReason>;
    fn caller(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn is_contract(account_ptr: u32) -> Result<u32, TrapReason>;
    fn code_hash(
        account_ptr: u32,
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn own_code_hash(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn caller_is_origin() -> Result<u32, TrapReason>;
    fn address(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn weight_to_fee(
        gas: u64,
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<(), TrapReason>;
    fn gas_left(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn balance(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn value_transferred(
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<(), TrapReason>;
    fn random(
        subject_ptr: u32,
        subject_len: u32,
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<(), TrapReason>;
    fn now(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn minimum_balance(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn tombstone_deposit(
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<(), TrapReason>;
    fn restore_to(
        _dest_ptr: u32,
        _dest_len: u32,
        _code_hash_ptr: u32,
        _code_hash_len: u32,
        _rent_allowance_ptr: u32,
        _rent_allowance_len: u32,
        _delta_ptr: u32,
        _delta_count: u32
    ) -> Result<(), TrapReason>;
    fn deposit_event(
        topics_ptr: u32,
        topics_len: u32,
        data_ptr: u32,
        data_len: u32
    ) -> Result<(), TrapReason>;
    fn set_rent_allowance(
        _value_ptr: u32,
        _value_len: u32
    ) -> Result<(), TrapReason>;
    fn rent_allowance(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn block_number(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn hash_sha2_256(
        input_ptr: u32,
        input_len: u32,
        output_ptr: u32
    ) -> Result<(), TrapReason>;
    fn hash_keccak_256(
        input_ptr: u32,
        input_len: u32,
        output_ptr: u32
    ) -> Result<(), TrapReason>;
    fn hash_blake2_256(
        input_ptr: u32,
        input_len: u32,
        output_ptr: u32
    ) -> Result<(), TrapReason>;
    fn hash_blake2_128(
        input_ptr: u32,
        input_len: u32,
        output_ptr: u32
    ) -> Result<(), TrapReason>;
    fn call_chain_extension(
        id: u32,
        input_ptr: u32,
        input_len: u32,
        output_ptr: u32,
        output_len_ptr: u32
    ) -> Result<u32, TrapReason>;
    fn debug_message(
        str_ptr: u32,
        str_len: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn call_runtime(
        call_ptr: u32,
        call_len: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn ecdsa_recover(
        signature_ptr: u32,
        message_hash_ptr: u32,
        output_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn set_code_hash(code_hash_ptr: u32) -> Result<ReturnCode, TrapReason>;
    fn ecdsa_to_eth_address(
        key_ptr: u32,
        out_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn reentrance_count() -> Result<u32, TrapReason>;
    fn account_reentrance_count(account_ptr: u32) -> Result<u32, TrapReason>;
    fn instantiation_nonce() -> Result<u64, TrapReason>;
    fn seal_set_storage(
        key_ptr: u32,
        value_ptr: u32,
        value_len: u32
    ) -> Result<(), TrapReason>;
    fn seal_clear_storage(key_ptr: u32) -> Result<(), TrapReason>;
    fn seal_get_storage(
        key_ptr: u32,
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn seal_contains_storage(key_ptr: u32) -> Result<u32, TrapReason>;
    fn seal_take_storage(
        key_ptr: u32,
        key_len: u32,
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn seal_transfer(
        account_ptr: u32,
        _account_len: u32,
        value_ptr: u32,
        _value_len: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn seal_call(
        callee_ptr: u32,
        _callee_len: u32,
        gas: u64,
        value_ptr: u32,
        _value_len: u32,
        input_data_ptr: u32,
        input_data_len: u32,
        output_ptr: u32,
        output_len_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn seal_delegate_call(
        flags: u32,
        code_hash_ptr: u32,
        input_data_ptr: u32,
        input_data_len: u32,
        output_ptr: u32,
        output_len_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn seal_instantiate(
        code_hash_ptr: u32,
        _code_hash_len: u32,
        gas: u64,
        value_ptr: u32,
        _value_len: u32,
        input_data_ptr: u32,
        input_data_len: u32,
        address_ptr: u32,
        address_len_ptr: u32,
        output_ptr: u32,
        output_len_ptr: u32,
        salt_ptr: u32,
        salt_len: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn seal_terminate(
        beneficiary_ptr: u32,
        _beneficiary_len: u32
    ) -> Result<(), TrapReason>;
    fn seal_input(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn seal_caller(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn seal_is_contract(account_ptr: u32) -> Result<u32, TrapReason>;
    fn seal_code_hash(
        account_ptr: u32,
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn seal_own_code_hash(
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<(), TrapReason>;
    fn seal_caller_is_origin() -> Result<u32, TrapReason>;
    fn seal_address(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn seal_weight_to_fee(
        gas: u64,
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<(), TrapReason>;
    fn seal_gas_left(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn seal_balance(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn seal_value_transferred(
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<(), TrapReason>;
    fn seal_random(
        subject_ptr: u32,
        subject_len: u32,
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<(), TrapReason>;
    fn seal_now(out_ptr: u32, out_len_ptr: u32) -> Result<(), TrapReason>;
    fn seal_minimum_balance(
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<(), TrapReason>;
    fn seal_tombstone_deposit(
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<(), TrapReason>;
    fn seal_restore_to(
        _dest_ptr: u32,
        _dest_len: u32,
        _code_hash_ptr: u32,
        _code_hash_len: u32,
        _rent_allowance_ptr: u32,
        _rent_allowance_len: u32,
        _delta_ptr: u32,
        _delta_count: u32
    ) -> Result<(), TrapReason>;
    fn seal_deposit_event(
        topics_ptr: u32,
        topics_len: u32,
        data_ptr: u32,
        data_len: u32
    ) -> Result<(), TrapReason>;
    fn seal_set_rent_allowance(
        _value_ptr: u32,
        _value_len: u32
    ) -> Result<(), TrapReason>;
    fn seal_rent_allowance(
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<(), TrapReason>;
    fn seal_block_number(
        out_ptr: u32,
        out_len_ptr: u32
    ) -> Result<(), TrapReason>;
    fn seal_hash_sha2_256(
        input_ptr: u32,
        input_len: u32,
        output_ptr: u32
    ) -> Result<(), TrapReason>;
    fn seal_hash_keccak_256(
        input_ptr: u32,
        input_len: u32,
        output_ptr: u32
    ) -> Result<(), TrapReason>;
    fn seal_hash_blake2_256(
        input_ptr: u32,
        input_len: u32,
        output_ptr: u32
    ) -> Result<(), TrapReason>;
    fn seal_hash_blake2_128(
        input_ptr: u32,
        input_len: u32,
        output_ptr: u32
    ) -> Result<(), TrapReason>;
    fn seal_call_chain_extension(
        id: u32,
        input_ptr: u32,
        input_len: u32,
        output_ptr: u32,
        output_len_ptr: u32
    ) -> Result<u32, TrapReason>;
    fn seal_debug_message(
        str_ptr: u32,
        str_len: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn seal_call_runtime(
        call_ptr: u32,
        call_len: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn seal_ecdsa_recover(
        signature_ptr: u32,
        message_hash_ptr: u32,
        output_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;
    fn seal_set_code_hash(code_hash_ptr: u32) -> Result<ReturnCode, TrapReason>;
    fn seal_ecdsa_to_eth_address(
        key_ptr: u32,
        out_ptr: u32
    ) -> Result<ReturnCode, TrapReason>;

}
Expand description

Every function in this trait represents (at least) one function that can be imported by a contract.

The function’s identifier is to be set as the name in the import definition. Where it is specifically indicated, an alias function having seal_-prefixed identifier and just the same signature and body, is also available (for backwards-compatibility purposes).

Required Methods§

Account for used gas. Traps if gas used is greater than gas limit.

NOTE: This is a implementation defined call and is NOT a part of the public API. This call is supposed to be called only by instrumentation injected code.

  • amount: How much gas is used.

Set the value at the given key in the contract storage.

Equivalent to the newer version super::seal1::Api::set_storage with the exception of the return type. Still a valid thing to call when not interested in the return value.

Clear the value at the given key in the contract storage.

Equivalent to the newer version super::seal1::Api::clear_storage with the exception of the return type. Still a valid thing to call when not interested in the return value.

Retrieve the value under the given key from storage.

This version is to be used with a fixed sized storage key. For runtimes supporting transparent hashing, please use the newer version of this function.

Parameters
  • key_ptr: pointer into the linear memory where the key of the requested value is placed.
  • out_ptr: pointer to the linear memory where the value is written to.
  • out_len_ptr: in-out pointer into linear memory where the buffer length is read from and the value length is written to.
Errors

ReturnCode::KeyNotFound

Checks whether there is a value stored under the given key.

This version is to be used with a fixed sized storage key. For runtimes supporting transparent hashing, please use the newer version of this function.

Parameters
  • key_ptr: pointer into the linear memory where the key of the requested value is placed.
Return Value

Returns the size of the pre-existing value at the specified key if any. Otherwise SENTINEL is returned as a sentinel value.

Retrieve and remove the value under the given key from storage.

Parameters
  • key_ptr: pointer into the linear memory where the key of the requested value is placed.
  • key_len: the length of the key in bytes.
  • out_ptr: pointer to the linear memory where the value is written to.
  • out_len_ptr: in-out pointer into linear memory where the buffer length is read from and the value length is written to.
Errors
  • ReturnCode::KeyNotFound

Transfer some value to another account.

Parameters
  • account_ptr: a pointer to the address of the beneficiary account Should be decodable as an T::AccountId. Traps otherwise.
  • account_len: length of the address buffer.
  • value_ptr: a pointer to the buffer with value, how much value to send. Should be decodable as a T::Balance. Traps otherwise.
  • value_len: length of the value buffer.
Errors
  • ReturnCode::TransferFailed

Make a call to another contract.

Deprecation

This is equivalent to calling the newer version of this function with flags set to ALLOW_REENTRY. See the newer version for documentation.

Note

The values _callee_len and _value_len are ignored because the encoded sizes of those types are fixed through codec::MaxEncodedLen. The fields exist for backwards compatibility. Consider switching to the newest version of this function.

Execute code in the context (storage, caller, value) of the current contract.

Reentrancy protection is always disabled since the callee is allowed to modify the callers storage. This makes going through a reentrancy attack unnecessary for the callee when it wants to exploit the caller.

Parameters
  • flags: see crate::wasm::runtime::CallFlags for a documentation of the supported flags.
  • code_hash: a pointer to the hash of the code to be called.
  • input_data_ptr: a pointer to a buffer to be used as input data to the callee.
  • input_data_len: length of the input data buffer.
  • output_ptr: a pointer where the output buffer is copied to.
  • output_len_ptr: in-out pointer to where the length of the buffer is read from and the actual length is written to.
Errors

An error means that the call wasn’t successful and no output buffer is returned unless stated otherwise.

  • ReturnCode::CalleeReverted: Output buffer is returned.
  • ReturnCode::CalleeTrapped
  • ReturnCode::CodeNotFound

Instantiate a contract with the specified code hash.

Deprecation

This is equivalent to calling the newer version of this function. The newer version drops the now unnecessary length fields.

Note

The values _code_hash_len and _value_len are ignored because the encoded sizes of those types are fixed through codec::MaxEncodedLen. The fields exist for backwards compatibility. Consider switching to the newest version of this function.

Remove the calling account and transfer remaining balance.

Deprecation

This is equivalent to calling the newer version of this function. The newer version drops the now unnecessary length fields.

Note

The value _beneficiary_len is ignored because the encoded sizes this type is fixed through [MaxEncodedLen`]. The field exist for backwards compatibility. Consider switching to the newest version of this function.

Stores the input passed by the caller into the supplied buffer.

The value is stored to linear memory at the address pointed to by out_ptr. out_len_ptr must point to a u32 value that describes the available space at out_ptr. This call overwrites it with the size of the value. If the available space at out_ptr is less than the size of the value a trap is triggered.

Note

This function traps if the input was previously forwarded by a call().

Cease contract execution and save a data buffer as a result of the execution.

This function never returns as it stops execution of the caller. This is the only way to return a data buffer to the caller. Returning from execution without calling this function is equivalent to calling:

seal_return(0, 0, 0);

The flags argument is a bitfield that can be used to signal special return conditions to the supervisor: — lsb — bit 0 : REVERT - Revert all storage changes made by the caller. bit [1, 31]: Reserved for future use. — msb —

Using a reserved bit triggers a trap.

Stores the address of the caller into the supplied buffer.

The value is stored to linear memory at the address pointed to by out_ptr. out_len_ptr must point to a u32 value that describes the available space at out_ptr. This call overwrites it with the size of the value. If the available space at out_ptr is less than the size of the value a trap is triggered.

If this is a top-level call (i.e. initiated by an extrinsic) the origin address of the extrinsic will be returned. Otherwise, if this call is initiated by another contract then the address of the contract will be returned. The value is encoded as T::AccountId.

Checks whether a specified address belongs to a contract.

Parameters
  • account_ptr: a pointer to the address of the beneficiary account Should be decodable as an T::AccountId. Traps otherwise.

Returned value is a u32-encoded boolean: (0 = false, 1 = true).

Retrieve the code hash for a specified contract address.

Parameters
  • account_ptr: a pointer to the address in question. Should be decodable as an T::AccountId. Traps otherwise.
  • out_ptr: pointer to the linear memory where the returning value is written to.
  • out_len_ptr: in-out pointer into linear memory where the buffer length is read from and the value length is written to.
Errors
  • ReturnCode::KeyNotFound

Retrieve the code hash of the currently executing contract.

Parameters
  • out_ptr: pointer to the linear memory where the returning value is written to.
  • out_len_ptr: in-out pointer into linear memory where the buffer length is read from and the value length is written to.

Checks whether the caller of the current contract is the origin of the whole call stack.

Prefer this over is_contract() when checking whether your contract is being called by a contract or a plain account. The reason is that it performs better since it does not need to do any storage lookups.

A return value of true indicates that this contract is being called by a plain account and false indicates that the caller is another contract.

Returned value is a u32-encoded boolean: (0 = false, 1 = true).

Stores the address of the current contract into the supplied buffer.

The value is stored to linear memory at the address pointed to by out_ptr. out_len_ptr must point to a u32 value that describes the available space at out_ptr. This call overwrites it with the size of the value. If the available space at out_ptr is less than the size of the value a trap is triggered.

Stores the price for the specified amount of gas into the supplied buffer.

The value is stored to linear memory at the address pointed to by out_ptr. out_len_ptr must point to a u32 value that describes the available space at out_ptr. This call overwrites it with the size of the value. If the available space at out_ptr is less than the size of the value a trap is triggered.

The data is encoded as T::Balance.

Note

It is recommended to avoid specifying very small values for gas as the prices for a single gas can be smaller than one.

Stores the amount of gas left into the supplied buffer.

The value is stored to linear memory at the address pointed to by out_ptr. out_len_ptr must point to a u32 value that describes the available space at out_ptr. This call overwrites it with the size of the value. If the available space at out_ptr is less than the size of the value a trap is triggered.

The data is encoded as Gas.

Stores the free balance of the current account into the supplied buffer.

The value is stored to linear memory at the address pointed to by out_ptr. out_len_ptr must point to a u32 value that describes the available space at out_ptr. This call overwrites it with the size of the value. If the available space at out_ptr is less than the size of the value a trap is triggered.

The data is encoded as T::Balance.

Stores the value transferred along with this call/instantiate into the supplied buffer.

The value is stored to linear memory at the address pointed to by out_ptr. out_len_ptr must point to a u32 value that describes the available space at out_ptr. This call overwrites it with the size of the value. If the available space at out_ptr is less than the size of the value a trap is triggered.

The data is encoded as T::Balance.

Stores a random number for the current block and the given subject into the supplied buffer.

The value is stored to linear memory at the address pointed to by out_ptr. out_len_ptr must point to a u32 value that describes the available space at out_ptr. This call overwrites it with the size of the value. If the available space at out_ptr is less than the size of the value a trap is triggered.

The data is encoded as T::Hash.

Deprecation

This function is deprecated. Users should migrate to the super::seal1::Api::random() version.

Load the latest block timestamp into the supplied buffer

The value is stored to linear memory at the address pointed to by out_ptr. out_len_ptr must point to a u32 value that describes the available space at out_ptr. This call overwrites it with the size of the value. If the available space at out_ptr is less than the size of the value a trap is triggered.

Stores the minimum balance (a.k.a. existential deposit) into the supplied buffer.

The data is encoded as T::Balance.

Stores the tombstone deposit into the supplied buffer.

The value is stored to linear memory at the address pointed to by out_ptr. out_len_ptr must point to a u32 value that describes the available space at out_ptr. This call overwrites it with the size of the value. If the available space at out_ptr is less than the size of the value a trap is triggered.

Deprecation

There is no longer a tombstone deposit. This function always returns 0.

Was used to restore the given destination contract sacrificing the caller.

Note

The state rent functionality was removed. This is stub only exists for backwards compatiblity

Deposit a contract event with the data buffer and optional list of topics. There is a limit on the maximum number of topics specified by event_topics.

  • topics_ptr: a pointer to the buffer of topics encoded as Vec<T::Hash>. The value of this is ignored if topics_len is set to 0. The topics list can’t contain duplicates.
  • topics_len: the length of the topics buffer. Pass 0 if you want to pass an empty vector.
  • data_ptr: a pointer to a raw data buffer which will saved along the event.
  • data_len: the length of the data buffer.

Was used to set rent allowance of the contract.

Note

The state rent functionality was removed. This is stub only exists for backwards compatiblity.

Was used to store the rent allowance into the supplied buffer.

Note

The state rent functionality was removed. This is stub only exists for backwards compatiblity.

Stores the current block number of the current contract into the supplied buffer.

The value is stored to linear memory at the address pointed to by out_ptr. out_len_ptr must point to a u32 value that describes the available space at out_ptr. This call overwrites it with the size of the value. If the available space at out_ptr is less than the size of the value a trap is triggered.

Computes the SHA2 256-bit hash on the given input buffer.

Returns the result directly into the given output buffer.

Note
  • The input and output buffer may overlap.
  • The output buffer is expected to hold at least 32 bytes (256 bits).
  • It is the callers responsibility to provide an output buffer that is large enough to hold the expected amount of bytes returned by the chosen hash function.
Parameters
  • input_ptr: the pointer into the linear memory where the input data is placed.
  • input_len: the length of the input data in bytes.
  • output_ptr: the pointer into the linear memory where the output data is placed. The function will write the result directly into this buffer.

Computes the KECCAK 256-bit hash on the given input buffer.

Returns the result directly into the given output buffer.

Note
  • The input and output buffer may overlap.
  • The output buffer is expected to hold at least 32 bytes (256 bits).
  • It is the callers responsibility to provide an output buffer that is large enough to hold the expected amount of bytes returned by the chosen hash function.
Parameters
  • input_ptr: the pointer into the linear memory where the input data is placed.
  • input_len: the length of the input data in bytes.
  • output_ptr: the pointer into the linear memory where the output data is placed. The function will write the result directly into this buffer.

Computes the BLAKE2 256-bit hash on the given input buffer.

Returns the result directly into the given output buffer.

Note
  • The input and output buffer may overlap.
  • The output buffer is expected to hold at least 32 bytes (256 bits).
  • It is the callers responsibility to provide an output buffer that is large enough to hold the expected amount of bytes returned by the chosen hash function.
Parameters
  • input_ptr: the pointer into the linear memory where the input data is placed.
  • input_len: the length of the input data in bytes.
  • output_ptr: the pointer into the linear memory where the output data is placed. The function will write the result directly into this buffer.

Computes the BLAKE2 128-bit hash on the given input buffer.

Returns the result directly into the given output buffer.

Note
  • The input and output buffer may overlap.
  • The output buffer is expected to hold at least 16 bytes (128 bits).
  • It is the callers responsibility to provide an output buffer that is large enough to hold the expected amount of bytes returned by the chosen hash function.
Parameters
  • input_ptr: the pointer into the linear memory where the input data is placed.
  • input_len: the length of the input data in bytes.
  • output_ptr: the pointer into the linear memory where the output data is placed. The function will write the result directly into this buffer.

Call into the chain extension provided by the chain if any.

Handling of the input values is up to the specific chain extension and so is the return value. The extension can decide to use the inputs as primitive inputs or as in/out arguments by interpreting them as pointers. Any caller of this function must therefore coordinate with the chain that it targets.

Note

If no chain extension exists the contract will trap with the NoChainExtension module error.

Emit a custom debug message.

No newlines are added to the supplied message. Specifying invalid UTF-8 triggers a trap.

This is a no-op if debug message recording is disabled which is always the case when the code is executing on-chain. The message is interpreted as UTF-8 and appended to the debug buffer which is then supplied to the calling RPC client.

Note

Even though no action is taken when debug message recording is disabled there is still a non trivial overhead (and weight cost) associated with calling this function. Contract languages should remove calls to this function (either at runtime or compile time) when not being executed as an RPC. For example, they could allow users to disable logging through compile time flags (cargo features) for on-chain deployment. Additionally, the return value of this function can be cached in order to prevent further calls at runtime.

Call some dispatchable of the runtime.

This function decodes the passed in data as the overarching Call type of the runtime and dispatches it. The weight as specified in the runtime is charged from the gas meter. Any weight refunds made by the dispatchable are considered.

The filter specified by Config::CallFilter is attached to the origin of the dispatched call.

Parameters
  • input_ptr: the pointer into the linear memory where the input data is placed.
  • input_len: the length of the input data in bytes.
Return Value

Returns ReturnCode::Success when the dispatchable was succesfully executed and returned Ok. When the dispatchable was exeuted but returned an error ReturnCode::CallRuntimeReturnedError is returned. The full error is not provided because it is not guaranteed to be stable.

Comparison with ChainExtension

Just as a chain extension this API allows the runtime to extend the functionality of contracts. While making use of this function is generelly easier it cannot be used in call cases. Consider writing a chain extension if you need to do perform one of the following tasks:

  • Return data.
  • Provide functionality exclusively to contracts.
  • Provide custom weights.
  • Avoid the need to keep the Call data structure stable.
Unstable

This function is unstable and it is a subject to change (or removal) in the future. Do not deploy a contract using it to a production chain.

Recovers the ECDSA public key from the given message hash and signature.

Writes the public key into the given output buffer. Assumes the secp256k1 curve.

Parameters
  • signature_ptr: the pointer into the linear memory where the signature is placed. Should be decodable as a 65 bytes. Traps otherwise.
  • message_hash_ptr: the pointer into the linear memory where the message hash is placed. Should be decodable as a 32 bytes. Traps otherwise.
  • output_ptr: the pointer into the linear memory where the output data is placed. The buffer should be 33 bytes. The function will write the result directly into this buffer.
Errors
  • ReturnCode::EcdsaRecoverFailed

Replace the contract code at the specified address with new code.

Note

There are a couple of important considerations which must be taken into account when using this API:

  1. The storage at the code address will remain untouched. This means that contract developers must ensure that the storage layout of the new code is compatible with that of the old code.

  2. Contracts using this API can’t be assumed as having deterministic addresses. Said another way, when using this API you lose the guarantee that an address always identifies a specific code hash.

  3. If a contract calls into itself after changing its code the new call would use the new code. However, if the original caller panics after returning from the sub call it would revert the changes made by set_code_hash() and the next caller would use the old code.

Parameters
  • code_hash_ptr: A pointer to the buffer that contains the new code hash.
Errors
  • ReturnCode::CodeNotFound

Calculates Ethereum address from the ECDSA compressed public key and stores it into the supplied buffer.

Parameters
  • key_ptr: a pointer to the ECDSA compressed public key. Should be decodable as a 33 bytes value. Traps otherwise.
  • out_ptr: the pointer into the linear memory where the output data is placed. The function will write the result directly into this buffer.

The value is stored to linear memory at the address pointed to by out_ptr. If the available space at out_ptr is less than the size of the value a trap is triggered.

Errors
  • ReturnCode::EcdsaRecoverFailed

Returns the number of times the currently executing contract exists on the call stack in addition to the calling instance.

Return Value

Returns 0 when there is no reentrancy.

Unstable

This function is unstable and it is a subject to change (or removal) in the future. Do not deploy a contract using it to a production chain.

Returns the number of times specified contract exists on the call stack. Delegated calls are not counted as separate calls.

Parameters
  • account_ptr: a pointer to the contract address.
Return Value

Returns 0 when the contract does not exist on the call stack.

Unstable

This function is unstable and it is a subject to change (or removal) in the future. Do not deploy a contract using it to a production chain.

Returns a nonce that is unique per contract instantiation.

The nonce is incremented for each succesful contract instantiation. This is a sensible default salt for contract instantiations.

Unstable

This function is unstable and it is a subject to change (or removal) in the future. Do not deploy a contract using it to a production chain.

This is just an alias function to set_storage() with backwards-compatible prefixed identifier.

This is just an alias function to clear_storage() with backwards-compatible prefixed identifier.

This is just an alias function to get_storage() with backwards-compatible prefixed identifier.

This is just an alias function to contains_storage() with backwards-compatible prefixed identifier.

This is just an alias function to take_storage() with backwards-compatible prefixed identifier.

This is just an alias function to transfer() with backwards-compatible prefixed identifier.

This is just an alias function to call() with backwards-compatible prefixed identifier.

This is just an alias function to delegate_call() with backwards-compatible prefixed identifier.

This is just an alias function to instantiate() with backwards-compatible prefixed identifier.

This is just an alias function to terminate() with backwards-compatible prefixed identifier.

This is just an alias function to input() with backwards-compatible prefixed identifier.

This is just an alias function to caller() with backwards-compatible prefixed identifier.

This is just an alias function to is_contract() with backwards-compatible prefixed identifier.

This is just an alias function to code_hash() with backwards-compatible prefixed identifier.

This is just an alias function to own_code_hash() with backwards-compatible prefixed identifier.

This is just an alias function to caller_is_origin() with backwards-compatible prefixed identifier.

This is just an alias function to address() with backwards-compatible prefixed identifier.

This is just an alias function to weight_to_fee() with backwards-compatible prefixed identifier.

This is just an alias function to gas_left() with backwards-compatible prefixed identifier.

This is just an alias function to balance() with backwards-compatible prefixed identifier.

This is just an alias function to value_transferred() with backwards-compatible prefixed identifier.

This is just an alias function to random() with backwards-compatible prefixed identifier.

This is just an alias function to now() with backwards-compatible prefixed identifier.

This is just an alias function to minimum_balance() with backwards-compatible prefixed identifier.

This is just an alias function to tombstone_deposit() with backwards-compatible prefixed identifier.

This is just an alias function to restore_to() with backwards-compatible prefixed identifier.

This is just an alias function to deposit_event() with backwards-compatible prefixed identifier.

This is just an alias function to set_rent_allowance() with backwards-compatible prefixed identifier.

This is just an alias function to rent_allowance() with backwards-compatible prefixed identifier.

This is just an alias function to block_number() with backwards-compatible prefixed identifier.

This is just an alias function to hash_sha2_256() with backwards-compatible prefixed identifier.

This is just an alias function to hash_keccak_256() with backwards-compatible prefixed identifier.

This is just an alias function to hash_blake2_256() with backwards-compatible prefixed identifier.

This is just an alias function to hash_blake2_128() with backwards-compatible prefixed identifier.

This is just an alias function to call_chain_extension() with backwards-compatible prefixed identifier.

This is just an alias function to debug_message() with backwards-compatible prefixed identifier.

This is just an alias function to call_runtime() with backwards-compatible prefixed identifier.

This is just an alias function to ecdsa_recover() with backwards-compatible prefixed identifier.

This is just an alias function to set_code_hash() with backwards-compatible prefixed identifier.

This is just an alias function to ecdsa_to_eth_address() with backwards-compatible prefixed identifier.

Implementors§