Struct concordium_smart_contract_testing::ContractInvokeSuccess

pub struct ContractInvokeSuccess {
    pub trace_elements: Vec<DebugTraceElement>,
    pub energy_used: Energy,
    pub transaction_fee: Amount,
    pub return_value: ReturnValue,
    pub state_changed: bool,
    pub new_balance: Amount,
}

Represents a successful contract update (or invocation).

Fields

trace_elements: Vec<DebugTraceElement>

Host events that occurred. This includes interrupts, resumes, and upgrades.

energy_used: Energy

Energy used.

transaction_fee: Amount

Cost of transaction.

return_value: ReturnValue

The returned value.

state_changed: bool

Whether the state of the invoked contract was changed.

new_balance: Amount

The new balance of the smart contract.

Implementations

impl ContractInvokeSuccess

pub fn events( &self ) -> impl Iterator<Item = (ContractAddress, &[ContractEvent])>

Extract all the events logged by all the contracts in the invocation. The events are returned in the order that they are emitted, and are paired with the address of the contract that emitted it.

Only events from effective trace elements are included. See Self::effective_trace_elements for more details.

pub fn account_transfers( &self ) -> impl Iterator<Item = (ContractAddress, Amount, AccountAddress)> + '_

Extract the transfers to accounts that occurred during invocation. The return value is an iterator over triples (from, amount, to) where from is the sender contract, and to is the receiver account. The transfers are returned in the order that they occurred.

Only tranfers from effective trace elements are included. See Self::effective_trace_elements for more details.

pub fn effective_trace_elements( &self ) -> impl Iterator<Item = &ContractTraceElement>

Get an iterator over references of all the ContractTraceElements that have not been rolled back.

The trace elements returned here corresponds to the ones returned by the node.

See also Self::effective_trace_elements_cloned for a version with clones.

pub fn effective_trace_elements_cloned(&self) -> Vec<ContractTraceElement>

Get an iterator over clones of all the ContractTraceElements that have not been rolled back.

The trace elements returned here corresponds to the ones returned by the node.

See also Self::effective_trace_elements for a version with references.

pub fn trace_elements( &self ) -> BTreeMap<ContractAddress, Vec<ContractTraceElement>>

Get the successful trace elements grouped by which contract they originated from.

pub fn updates(&self) -> impl Iterator<Item = &InstanceUpdatedEvent>

Get the successful contract updates that happened in the transaction. The order is the order of returns. Concretely, if A calls B (and no other calls are made) then first there will be “B updated” event, followed by “A updated”, assuming the invocation of both succeeded.

pub fn rollbacks_occurred(&self) -> bool

Check whether any rollbacks occurred.

That is, whether any contract calls failed which lead to state and balances being rolled back.

If true is returned, the relevant traces can be seen in the self.trace_elements vector.

pub fn parse_return_value<T: Deserial>(&self) -> ParseResult<T>

Try to parse the return value into a type that implements Deserial.

Ensures that all bytes of the return value are read.

Trait Implementations

impl Debug for ContractInvokeSuccess

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

Formats the value using the given formatter.

impl DebugInfoExt for ContractInvokeSuccess

fn debug_events(&self) -> Box<dyn Iterator<Item = DebugItem<'_>> + '_>

Get an iterator over all the debug traces emitted by the execution.

fn print_debug(self, level: DebugOutputKind) -> Self

Print the desired level of debug information that was recorded. This function is meant to be used in a method-chaining style.

fn print_emitted_events(self) -> Self

Print (to stderr) all the events generated by concordium_dbg! statements.

fn host_calls(&self) -> Box<dyn Iterator<Item = HostCallInfo<'_>> + '_>

Get an iterator over all host calls that have occurred, both in the remaining trace and in the rolled back part.

fn emitted_debug_prints( &self ) -> Box<dyn Iterator<Item = (ContractAddress, &EmittedDebugStatement)> + '_>

Get an iterator over all the emitted concordium_dbg! events.

fn host_calls_summary( &self ) -> BTreeMap<ContractAddress, BTreeMap<HostFunctionV1, (usize, InterpreterEnergy)>>

Get host function calls grouped by contract address that generated them. The value at each address and host function is the pair of the number of times the host function was called, and the total amount of interpreter energy that was used by all the calls.

fn host_calls_summary_per_entrypoint( &self ) -> BTreeMap<(ContractAddress, EntrypointName<'_>), BTreeMap<HostFunctionV1, (usize, InterpreterEnergy)>>

Get host function calls grouped by contract address and entrypoint that generated them. The value at each address and host function is the pair of the number of times the host function was called, and the total amount of interpreter energy that was used by all the calls.