Struct InvocationResources

pub struct InvocationResources {
    pub instructions: i64,
    pub mem_bytes: i64,
    pub read_entries: u32,
    pub write_entries: u32,
    pub read_bytes: u32,
    pub write_bytes: u32,
    pub contract_events_size_bytes: u32,
    pub persistent_rent_ledger_bytes: i64,
    pub persistent_entry_rent_bumps: u32,
    pub temporary_rent_ledger_bytes: i64,
    pub temporary_entry_rent_bumps: u32,
}

Represents the resources measured during an invocation.

This resembles the resources necessary to build a Soroban transaction and compute its fee with a few exceptions (specifically, the transaction size and the return value size).

Fields

instructions: i64

Number of modelled CPU instructions.

mem_bytes: i64

Size of modelled memory in bytes.

read_entries: u32

Number of entries that need to be read from the ledger (without modification, i.e. excluding the entries that need to be written).

write_entries: u32

Number of entries that need to be written to the ledger due to modification.

read_bytes: u32

Total number of bytes that need to be read from the ledger. This is the total size of the ‘initial’ states all the storage entries accessed.

write_bytes: u32

Total number of bytes that need to be written to the ledger. This is the total size of all the entries accounted in write_entries.

contract_events_size_bytes: u32

Total size of the contract events emitted.

persistent_rent_ledger_bytes: i64

Cumulative rent bump of all the persistent entries in ‘ledger-bytes’. ‘Ledger-byte’ is a rent bump of 1 byte for 1 ledger. Rent fee is proportional to the total amount of ‘ledger-bytes’.

persistent_entry_rent_bumps: u32

Number of persistent entries that had their rent bumped.

temporary_rent_ledger_bytes: i64

Cumulative rent bump of all the temporary entries in ‘ledger-bytes’. ‘Ledger-byte’ is a rent bump of 1 byte for 1 ledger. Rent fee is proportional to the total amount of ‘ledger-bytes’.

temporary_entry_rent_bumps: u32

Number of temporary entries that had their rent bumped.

Implementations

impl InvocationResources

pub fn estimate_fees( &self, fee_config: &FeeConfiguration, persistent_rent_rate_denominator: i64, temporary_rent_rate_denominator: i64, ) -> FeeEstimate

Estimates the fees necesary for the current resources based on the provided fee configuration.

This is only an estimate and it can’t be used for the actual transaction submission (simulation using the Soroban RPC should be used instead).

The quality of the estimate depends on the provided fee configuration, so it must resemble the target network as close as possible.

Trait Implementations

impl Clone for InvocationResources

fn clone(&self) -> InvocationResources

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InvocationResources

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

Formats the value using the given formatter.

impl Default for InvocationResources

fn default() -> InvocationResources

Returns the “default value” for a type.

impl PartialEq for InvocationResources

fn eq(&self, other: &InvocationResources) -> 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 Eq for InvocationResources

impl StructuralPartialEq for InvocationResources