Struct TransactionEffects

pub struct TransactionEffects {

    pub bcs: Option<Bcs>,
    pub digest: Option<String>,
    pub version: Option<i32>,
    pub status: Option<ExecutionStatus>,
    pub epoch: Option<u64>,
    pub gas_used: Option<GasCostSummary>,
    pub transaction_digest: Option<String>,
    pub gas_object: Option<ChangedObject>,
    pub events_digest: Option<String>,
    pub dependencies: Vec<String>,
    pub lamport_version: Option<u64>,
    pub changed_objects: Vec<ChangedObject>,
    pub unchanged_shared_objects: Vec<UnchangedSharedObject>,
    pub auxiliary_data_digest: Option<String>,
}

The effects of executing a transaction.

Fields

bcs: Option<Bcs>

This TransactionEffects serialized as BCS.

digest: Option<String>

The digest of this TransactionEffects.

version: Option<i32>

Version of this TransactionEffects.

status: Option<ExecutionStatus>

The status of the execution.

epoch: Option<u64>

The epoch when this transaction was executed.

gas_used: Option<GasCostSummary>

The gas used by this transaction.

transaction_digest: Option<String>

The transaction digest.

gas_object: Option<ChangedObject>

Information about the gas object. Also present in the changed_objects vector.

System transaction that don’t require gas will leave this as None.

events_digest: Option<String>

The digest of the events emitted during execution, can be None if the transaction does not emit any event.

dependencies: Vec<String>

The set of transaction digests this transaction depends on.

lamport_version: Option<u64>

The version number of all the written objects (excluding packages) by this transaction.

changed_objects: Vec<ChangedObject>

Objects whose state are changed by this transaction.

unchanged_shared_objects: Vec<UnchangedSharedObject>

Shared objects that are not mutated in this transaction. Unlike owned objects, read-only shared objects’ version are not committed in the transaction, and in order for a node to catch up and execute it without consensus sequencing, the version needs to be committed in the effects.

auxiliary_data_digest: Option<String>

Auxiliary data that are not protocol-critical, generated as part of the effects but are stored separately. Storing it separately allows us to avoid bloating the effects with data that are not critical. It also provides more flexibility on the format and type of the data.

Implementations

impl TransactionEffects

pub const BCS_FIELD: &'static MessageField

pub const DIGEST_FIELD: &'static MessageField

pub const VERSION_FIELD: &'static MessageField

pub const STATUS_FIELD: &'static MessageField

pub const EPOCH_FIELD: &'static MessageField

pub const GAS_USED_FIELD: &'static MessageField

pub const TRANSACTION_DIGEST_FIELD: &'static MessageField

pub const GAS_OBJECT_FIELD: &'static MessageField

pub const EVENTS_DIGEST_FIELD: &'static MessageField

pub const DEPENDENCIES_FIELD: &'static MessageField

pub const LAMPORT_VERSION_FIELD: &'static MessageField

pub const CHANGED_OBJECTS_FIELD: &'static MessageField

pub const UNCHANGED_SHARED_OBJECTS_FIELD: &'static MessageField

pub const AUXILIARY_DATA_DIGEST_FIELD: &'static MessageField

impl TransactionEffects

pub fn digest(&self) -> &str

Returns the value of digest, or the default value if digest is unset.

pub fn version(&self) -> i32

Returns the value of version, or the default value if version is unset.

pub fn epoch(&self) -> u64

Returns the value of epoch, or the default value if epoch is unset.

pub fn transaction_digest(&self) -> &str

Returns the value of transaction_digest, or the default value if transaction_digest is unset.

pub fn events_digest(&self) -> &str

Returns the value of events_digest, or the default value if events_digest is unset.

pub fn lamport_version(&self) -> u64

Returns the value of lamport_version, or the default value if lamport_version is unset.

pub fn auxiliary_data_digest(&self) -> &str

Returns the value of auxiliary_data_digest, or the default value if auxiliary_data_digest is unset.

Trait Implementations

impl Clone for TransactionEffects

fn clone(&self) -> TransactionEffects

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionEffects

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

Formats the value using the given formatter.

impl Default for TransactionEffects

fn default() -> Self

Returns the “default value” for a type.

impl From<TransactionEffects> for TransactionEffects

fn from(value: TransactionEffects) -> Self

Converts to this type from the input type.

impl Message for TransactionEffects

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for TransactionEffects

const FIELDS: &'static [&'static MessageField]

impl MessageMerge<&TransactionEffects> for TransactionEffects

fn merge(&mut self, source: &TransactionEffects, mask: &FieldMaskTree)

impl MessageMerge<&TransactionEffects> for TransactionEffects

fn merge(&mut self, _: &TransactionEffects, mask: &FieldMaskTree)

impl MessageMerge<&TransactionEffectsV1> for TransactionEffects

fn merge(&mut self, _: &TransactionEffectsV1, mask: &FieldMaskTree)

impl MessageMerge<&TransactionEffectsV2> for TransactionEffects

fn merge(&mut self, _: &TransactionEffectsV2, mask: &FieldMaskTree)

impl PartialEq for TransactionEffects

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

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(value: &TransactionEffects) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for TransactionEffects