Struct ContractResult

pub struct ContractResult<R, Balance, EventRecord> {
    pub gas_consumed: Weight,
    pub gas_required: Weight,
    pub storage_deposit: StorageDeposit<Balance>,
    pub debug_message: Vec<u8>,
    pub result: R,
    pub events: Option<Vec<EventRecord>>,
}

Result type of a bare_call or bare_instantiate call as well as ContractsApi::call and ContractsApi::instantiate.

It contains the execution result together with some auxiliary information.

#Note

It has been extended to include events at the end of the struct while not bumping the ContractsApi version. Therefore when SCALE decoding a ContractResult its trailing data should be ignored to avoid any potential compatibility issues.

Fields

gas_consumed: Weight

How much weight was consumed during execution.

gas_required: Weight

How much weight is required as gas limit in order to execute this call.

This value should be used to determine the weight limit for on-chain execution.

Note

This can only different from Self::gas_consumed when weight pre charging is used. Currently, only seal_call_runtime makes use of pre charging. Additionally, any seal_call or seal_instantiate makes use of pre-charging when a non-zero gas_limit argument is supplied.

storage_deposit: StorageDeposit<Balance>

How much balance was paid by the origin into the contract’s deposit account in order to pay for storage.

The storage deposit is never actually charged from the origin in case of Self::result is Err. This is because on error all storage changes are rolled back including the payment of the deposit.

debug_message: Vec<u8>

An optional debug message. This message is only filled when explicitly requested by the code that calls into the contract. Otherwise it is empty.

The contained bytes are valid UTF-8. This is not declared as String because this type is not allowed within the runtime.

Clients should not make any assumptions about the format of the buffer. They should just display it as-is. It is not only a collection of log lines provided by a contract but a formatted buffer with different sections.

Note

The debug message is never generated during on-chain execution. It is reserved for RPC calls.

result: R

The execution result of the wasm code.

events: Option<Vec<EventRecord>>

The events that were emitted during execution. It is an option as event collection is optional.

Trait Implementations

impl<R: Clone, Balance: Clone, EventRecord: Clone> Clone for ContractResult<R, Balance, EventRecord>

fn clone(&self) -> ContractResult<R, Balance, EventRecord>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R, Balance, EventRecord> Debug for ContractResult<R, Balance, EventRecord>

where R: Debug, Balance: Debug, EventRecord: Debug,

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

Formats the value using the given formatter.

impl<R, Balance, EventRecord> Decode for ContractResult<R, Balance, EventRecord>

where StorageDeposit<Balance>: Decode, R: Decode, Option<Vec<EventRecord>>: Decode,

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<R, Balance, EventRecord> Encode for ContractResult<R, Balance, EventRecord>

where StorageDeposit<Balance>: Encode, R: Encode, Option<Vec<EventRecord>>: 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<R: PartialEq, Balance: PartialEq, EventRecord: PartialEq> PartialEq for ContractResult<R, Balance, EventRecord>

fn eq(&self, other: &ContractResult<R, Balance, EventRecord>) -> 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<R, Balance, EventRecord> TypeInfo for ContractResult<R, Balance, EventRecord>

where StorageDeposit<Balance>: TypeInfo + 'static, R: TypeInfo + 'static, Option<Vec<EventRecord>>: TypeInfo + 'static, Balance: TypeInfo + 'static, EventRecord: TypeInfo + 'static,

type Identity = ContractResult<R, Balance, EventRecord>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<R, Balance, EventRecord> EncodeLike for ContractResult<R, Balance, EventRecord>

where StorageDeposit<Balance>: Encode, R: Encode, Option<Vec<EventRecord>>: Encode,

impl<R: Eq, Balance: Eq, EventRecord: Eq> Eq for ContractResult<R, Balance, EventRecord>

impl<R, Balance, EventRecord> StructuralPartialEq for ContractResult<R, Balance, EventRecord>