Trait pallet_revive::SyscallDoc

source ·

pub trait SyscallDoc {
Show 57 methods    // Required methods
    fn noop();
    fn set_storage(
        flags: u32,
        key_ptr: u32,
        key_len: u32,
        value_ptr: u32,
        value_len: u32,
    ) -> u32;
    fn get_storage(
        flags: u32,
        key_ptr: u32,
        key_len: u32,
        out_ptr: u32,
        out_len_ptr: u32,
    ) -> ReturnErrorCode;
    fn call(
        flags: u32,
        callee_ptr: u32,
        ref_time_limit: u64,
        proof_size_limit: u64,
        deposit_ptr: u32,
        value_ptr: u32,
        input_data_ptr: u32,
        input_data_len: u32,
        output_ptr: u32,
        output_len_ptr: u32,
    ) -> ReturnErrorCode;
    fn delegate_call(
        flags: u32,
        address_ptr: u32,
        ref_time_limit: u64,
        proof_size_limit: u64,
        deposit_ptr: u32,
        input_data_ptr: u32,
        input_data_len: u32,
        output_ptr: u32,
        output_len_ptr: u32,
    ) -> ReturnErrorCode;
    fn instantiate(
        code_hash_ptr: u32,
        ref_time_limit: u64,
        proof_size_limit: u64,
        deposit_ptr: u32,
        value_ptr: u32,
        input_data_ptr: u32,
        input_data_len: u32,
        address_ptr: u32,
        output_ptr: u32,
        output_len_ptr: u32,
        salt_ptr: u32,
    ) -> ReturnErrorCode;
    fn call_data_size() -> u64;
    fn call_data_copy(out_ptr: u32, out_len: u32, offset: u32);
    fn call_data_load(out_ptr: u32, offset: u32);
    fn seal_return(flags: u32, data_ptr: u32, data_len: u32);
    fn caller(out_ptr: u32);
    fn origin(out_ptr: u32);
    fn code_hash(addr_ptr: u32, out_ptr: u32);
    fn code_size(addr_ptr: u32) -> u64;
    fn address(out_ptr: u32);
    fn weight_to_fee(ref_time_limit: u64, proof_size_limit: u64, out_ptr: u32);
    fn get_immutable_data(out_ptr: u32, out_len_ptr: u32);
    fn set_immutable_data(ptr: u32, len: u32);
    fn balance(out_ptr: u32);
    fn balance_of(addr_ptr: u32, out_ptr: u32);
    fn chain_id(out_ptr: u32);
    fn gas_limit() -> u64;
    fn value_transferred(out_ptr: u32);
    fn gas_price() -> u64;
    fn base_fee(out_ptr: u32);
    fn now(out_ptr: u32);
    fn deposit_event(
        topics_ptr: u32,
        num_topic: u32,
        data_ptr: u32,
        data_len: u32,
    );
    fn block_number(out_ptr: u32);
    fn block_hash(block_number_ptr: u32, out_ptr: u32);
    fn hash_keccak_256(input_ptr: u32, input_len: u32, output_ptr: u32);
    fn return_data_size() -> u64;
    fn return_data_copy(out_ptr: u32, out_len_ptr: u32, offset: u32);
    fn ref_time_left() -> u64;
    fn call_chain_extension(
        id: u32,
        input_ptr: u32,
        input_len: u32,
        output_ptr: u32,
        output_len_ptr: u32,
    ) -> u32;
    fn call_runtime(call_ptr: u32, call_len: u32) -> ReturnErrorCode;
    fn caller_is_origin() -> u32;
    fn caller_is_root() -> u32;
    fn clear_storage(flags: u32, key_ptr: u32, key_len: u32) -> u32;
    fn contains_storage(flags: u32, key_ptr: u32, key_len: u32) -> u32;
    fn debug_message(str_ptr: u32, str_len: u32) -> ReturnErrorCode;
    fn ecdsa_recover(
        signature_ptr: u32,
        message_hash_ptr: u32,
        output_ptr: u32,
    ) -> ReturnErrorCode;
    fn ecdsa_to_eth_address(key_ptr: u32, out_ptr: u32) -> ReturnErrorCode;
    fn hash_blake2_128(input_ptr: u32, input_len: u32, output_ptr: u32);
    fn hash_blake2_256(input_ptr: u32, input_len: u32, output_ptr: u32);
    fn hash_sha2_256(input_ptr: u32, input_len: u32, output_ptr: u32);
    fn is_contract(account_ptr: u32) -> u32;
    fn lock_delegate_dependency(code_hash_ptr: u32);
    fn minimum_balance(out_ptr: u32);
    fn own_code_hash(out_ptr: u32);
    fn set_code_hash(code_hash_ptr: u32);
    fn sr25519_verify(
        signature_ptr: u32,
        pub_key_ptr: u32,
        message_len: u32,
        message_ptr: u32,
    ) -> ReturnErrorCode;
    fn unlock_delegate_dependency(code_hash_ptr: u32);
    fn take_storage(
        flags: u32,
        key_ptr: u32,
        key_len: u32,
        out_ptr: u32,
        out_len_ptr: u32,
    ) -> ReturnErrorCode;
    fn terminate(beneficiary_ptr: u32);
    fn weight_left(out_ptr: u32, out_len_ptr: u32);
    fn xcm_execute(msg_ptr: u32, msg_len: u32) -> ReturnErrorCode;
    fn xcm_send(
        dest_ptr: u32,
        dest_len: u32,
        msg_ptr: u32,
        msg_len: u32,
        output_ptr: u32,
    ) -> ReturnErrorCode;
}

Expand description

Documentation of the syscalls (host functions) available to contracts.

Each of the functions in this trait represent a function that is callable by the contract. Guests use the function name as the import symbol.

§Note

This module is not meant to be used by any code. Rather, it is meant to be consumed by humans through rustdoc.

Required Methods§

source

fn noop()

Noop function used to benchmark the time it takes to execute an empty function.

Marked as stable because it needs to be called from benchmarks even when the benchmarked parachain has unstable functions disabled.