Struct TransactionEffects

#[non_exhaustive]
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_consensus_objects: Vec<UnchangedConsensusObject>,
    pub auxiliary_data_digest: Option<String>,
}

The effects of executing a transaction.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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_consensus_objects: Vec<UnchangedConsensusObject>

Consensus objects that are not mutated in this transaction. Unlike owned objects, read-only consensus 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_CONSENSUS_OBJECTS_FIELD: &'static MessageField

pub const AUXILIARY_DATA_DIGEST_FIELD: &'static MessageField

impl TransactionEffects

pub fn path_builder() -> TransactionEffectsFieldPathBuilder

impl TransactionEffects

pub const fn const_default() -> Self

pub fn bcs(&self) -> &Bcs

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

pub fn bcs_opt_mut(&mut self) -> Option<&mut Bcs>

If bcs is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn bcs_mut(&mut self) -> &mut Bcs

Returns a mutable reference to bcs. If the field is unset, it is first initialized with the default value.

pub fn bcs_opt(&self) -> Option<&Bcs>

If bcs is set, returns Some with the value; otherwise returns None.

pub fn set_bcs<T: Into<Bcs>>(&mut self, field: T)

Sets bcs with the provided value.

pub fn with_bcs<T: Into<Bcs>>(self, field: T) -> Self

Sets bcs with the provided value.

pub fn digest_opt_mut(&mut self) -> Option<&mut String>

If digest is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn digest_mut(&mut self) -> &mut String

Returns a mutable reference to digest. If the field is unset, it is first initialized with the default value.

pub fn digest_opt(&self) -> Option<&str>

If digest is set, returns Some with the value; otherwise returns None.

pub fn set_digest<T: Into<String>>(&mut self, field: T)

Sets digest with the provided value.

pub fn with_digest<T: Into<String>>(self, field: T) -> Self

Sets digest with the provided value.

pub fn version_opt_mut(&mut self) -> Option<&mut i32>

If version is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn version_mut(&mut self) -> &mut i32

Returns a mutable reference to version. If the field is unset, it is first initialized with the default value.

pub fn version_opt(&self) -> Option<i32>

If version is set, returns Some with the value; otherwise returns None.

pub fn set_version<T: Into<i32>>(&mut self, field: T)

Sets version with the provided value.

pub fn with_version<T: Into<i32>>(self, field: T) -> Self

Sets version with the provided value.

pub fn status(&self) -> &ExecutionStatus

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

pub fn status_opt_mut(&mut self) -> Option<&mut ExecutionStatus>

If status is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn status_mut(&mut self) -> &mut ExecutionStatus

Returns a mutable reference to status. If the field is unset, it is first initialized with the default value.

pub fn status_opt(&self) -> Option<&ExecutionStatus>

If status is set, returns Some with the value; otherwise returns None.

pub fn set_status<T: Into<ExecutionStatus>>(&mut self, field: T)

Sets status with the provided value.

pub fn with_status<T: Into<ExecutionStatus>>(self, field: T) -> Self

Sets status with the provided value.

pub fn epoch_opt_mut(&mut self) -> Option<&mut u64>

If epoch is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn epoch_mut(&mut self) -> &mut u64

Returns a mutable reference to epoch. If the field is unset, it is first initialized with the default value.

pub fn epoch_opt(&self) -> Option<u64>

If epoch is set, returns Some with the value; otherwise returns None.

pub fn set_epoch<T: Into<u64>>(&mut self, field: T)

Sets epoch with the provided value.

pub fn with_epoch<T: Into<u64>>(self, field: T) -> Self

Sets epoch with the provided value.

pub fn gas_used(&self) -> &GasCostSummary

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

pub fn gas_used_opt_mut(&mut self) -> Option<&mut GasCostSummary>

If gas_used is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn gas_used_mut(&mut self) -> &mut GasCostSummary

Returns a mutable reference to gas_used. If the field is unset, it is first initialized with the default value.

pub fn gas_used_opt(&self) -> Option<&GasCostSummary>

If gas_used is set, returns Some with the value; otherwise returns None.

pub fn set_gas_used<T: Into<GasCostSummary>>(&mut self, field: T)

Sets gas_used with the provided value.

pub fn with_gas_used<T: Into<GasCostSummary>>(self, field: T) -> Self

Sets gas_used with the provided value.

pub fn transaction_digest_opt_mut(&mut self) -> Option<&mut String>

If transaction_digest is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn transaction_digest_mut(&mut self) -> &mut String

Returns a mutable reference to transaction_digest. If the field is unset, it is first initialized with the default value.

pub fn transaction_digest_opt(&self) -> Option<&str>

If transaction_digest is set, returns Some with the value; otherwise returns None.

pub fn set_transaction_digest<T: Into<String>>(&mut self, field: T)

Sets transaction_digest with the provided value.

pub fn with_transaction_digest<T: Into<String>>(self, field: T) -> Self

Sets transaction_digest with the provided value.

pub fn gas_object(&self) -> &ChangedObject

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

pub fn gas_object_opt_mut(&mut self) -> Option<&mut ChangedObject>

If gas_object is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn gas_object_mut(&mut self) -> &mut ChangedObject

Returns a mutable reference to gas_object. If the field is unset, it is first initialized with the default value.

pub fn gas_object_opt(&self) -> Option<&ChangedObject>

If gas_object is set, returns Some with the value; otherwise returns None.

pub fn set_gas_object<T: Into<ChangedObject>>(&mut self, field: T)

Sets gas_object with the provided value.

pub fn with_gas_object<T: Into<ChangedObject>>(self, field: T) -> Self

Sets gas_object with the provided value.

pub fn events_digest_opt_mut(&mut self) -> Option<&mut String>

If events_digest is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn events_digest_mut(&mut self) -> &mut String

Returns a mutable reference to events_digest. If the field is unset, it is first initialized with the default value.

pub fn events_digest_opt(&self) -> Option<&str>

If events_digest is set, returns Some with the value; otherwise returns None.

pub fn set_events_digest<T: Into<String>>(&mut self, field: T)

Sets events_digest with the provided value.

pub fn with_events_digest<T: Into<String>>(self, field: T) -> Self

Sets events_digest with the provided value.

pub fn dependencies(&self) -> &[String]

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

pub fn dependencies_mut(&mut self) -> &mut Vec<String>

Returns a mutable reference to dependencies. If the field is unset, it is first initialized with the default value.

pub fn set_dependencies(&mut self, field: Vec<String>)

Sets dependencies with the provided value.

pub fn with_dependencies(self, field: Vec<String>) -> Self

Sets dependencies with the provided value.

pub fn lamport_version_opt_mut(&mut self) -> Option<&mut u64>

If lamport_version is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn lamport_version_mut(&mut self) -> &mut u64

Returns a mutable reference to lamport_version. If the field is unset, it is first initialized with the default value.

pub fn lamport_version_opt(&self) -> Option<u64>

If lamport_version is set, returns Some with the value; otherwise returns None.

pub fn set_lamport_version<T: Into<u64>>(&mut self, field: T)

Sets lamport_version with the provided value.

pub fn with_lamport_version<T: Into<u64>>(self, field: T) -> Self

Sets lamport_version with the provided value.

pub fn changed_objects(&self) -> &[ChangedObject]

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

pub fn changed_objects_mut(&mut self) -> &mut Vec<ChangedObject>

Returns a mutable reference to changed_objects. If the field is unset, it is first initialized with the default value.

pub fn set_changed_objects(&mut self, field: Vec<ChangedObject>)

Sets changed_objects with the provided value.

pub fn with_changed_objects(self, field: Vec<ChangedObject>) -> Self

Sets changed_objects with the provided value.

pub fn unchanged_consensus_objects(&self) -> &[UnchangedConsensusObject]

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

pub fn unchanged_consensus_objects_mut( &mut self, ) -> &mut Vec<UnchangedConsensusObject>

Returns a mutable reference to unchanged_consensus_objects. If the field is unset, it is first initialized with the default value.

pub fn set_unchanged_consensus_objects( &mut self, field: Vec<UnchangedConsensusObject>, )

Sets unchanged_consensus_objects with the provided value.

pub fn with_unchanged_consensus_objects( self, field: Vec<UnchangedConsensusObject>, ) -> Self

Sets unchanged_consensus_objects with the provided value.

pub fn auxiliary_data_digest_opt_mut(&mut self) -> Option<&mut String>

If auxiliary_data_digest is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn auxiliary_data_digest_mut(&mut self) -> &mut String

Returns a mutable reference to auxiliary_data_digest. If the field is unset, it is first initialized with the default value.

pub fn auxiliary_data_digest_opt(&self) -> Option<&str>

If auxiliary_data_digest is set, returns Some with the value; otherwise returns None.

pub fn set_auxiliary_data_digest<T: Into<String>>(&mut self, field: T)

Sets auxiliary_data_digest with the provided value.

pub fn with_auxiliary_data_digest<T: Into<String>>(self, field: T) -> Self

Sets auxiliary_data_digest with the provided value.

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 duplicate 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<'de> Deserialize<'de> for TransactionEffects

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TransactionEffects> for TransactionEffects

fn from(value: TransactionEffects) -> Self

Converts to this type from the input type.

impl Merge<&TransactionEffects> for TransactionEffects

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

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Merge<&TransactionEffects> for TransactionEffects

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

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Merge<&TransactionEffectsV1> for TransactionEffects

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

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Merge<&TransactionEffectsV2> for TransactionEffects

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

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

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 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 Serialize for TransactionEffects

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

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