Enum TransactionEffects 

#[non_exhaustive]
pub enum TransactionEffects {
    V1(Box<TransactionEffectsV1>),
}

The output or effects of executing a transaction

BCS

The BCS serialized form for this type is defined by the following ABNF:

transaction-effects = %d00 transaction-effects-v1   ; V1

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

V1(Box<TransactionEffectsV1>)

Implementations

impl TransactionEffects

pub fn digest(&self) -> Digest

impl TransactionEffects

pub fn is_v1(&self) -> bool

Checks if this is a v1 variant.

pub fn as_v1(&self) -> &TransactionEffectsV1

pub fn into_v1(self) -> TransactionEffectsV1

Trait Implementations

impl Arbitrary for TransactionEffects

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<TransactionEffects>

The type of Strategy used to generate values of type Self.

fn arbitrary_with( args_shared: <TransactionEffects as Arbitrary>::Parameters, ) -> <TransactionEffects as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransactionEffects

fn deserialize<D>( deserializer: D, ) -> Result<TransactionEffects, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for TransactionEffects

const SCOPE: IntentScope = IntentScope::TransactionEffects

type DigestType = Digest

fn digest(&self) -> Self::DigestType

fn scope(&self) -> IntentScope

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 as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TransactionEffectsAPI for TransactionEffects

fn status(&self) -> &ExecutionStatus

Return the status of the transaction.

fn into_status(self) -> ExecutionStatus

Consume self and return the owned status of the transaction.

fn epoch(&self) -> EpochId

Return the epoch in which this transaction was executed.

fn modified_at_versions(&self) -> Vec<(ObjectId, Version)>

Return the (ObjectId, Version) pair, at their pre-execution version, of every object that existed in the store before this transaction and was modified by it (mutated, wrapped, or deleted).

fn lamport_version(&self) -> Version

The version assigned to all output objects (apart from packages).

fn old_object_metadata(&self) -> Vec<(ObjectRef, Owner)>

Metadata of objects prior to modification. This includes any object that exists in the store prior to this transaction and is modified in this transaction. It includes objects that are mutated, wrapped and deleted.

fn input_shared_objects(&self) -> Vec<InputSharedObject>

Returns the list of sequenced shared objects used in the input. This is needed in effects because in transaction we only have object ID for shared objects. Their version and digest can only be figured out after sequencing. Also provides the use kind to indicate whether the object was mutated or read-only. It does not include per epoch config objects since they do not require sequencing. TODO: Rename this function to indicate sequencing requirement.

fn created(&self) -> Vec<(ObjectRef, Owner)>

Objects (Move objects and packages) newly created by this transaction, paired with their owner. Excludes objects that were created and then wrapped within the same transaction.

fn mutated(&self) -> Vec<(ObjectRef, Owner)>

Objects that existed before this transaction and whose contents were updated by it (in-place mutations and system package upgrades), reported at their post-execution (ObjectRef, Owner).

fn unwrapped(&self) -> Vec<(ObjectRef, Owner)>

Objects that were wrapped inside another object before this transaction and have been promoted back to top-level objects in the store by it.

fn deleted(&self) -> Vec<ObjectRef>

Objects that existed before this transaction and were deleted by it. References use the post-execution version and the TransactionEffectsDigest::OBJECT_DELETED tombstone digest.

fn unwrapped_then_deleted(&self) -> Vec<ObjectRef>

Objects that were unwrapped and then deleted within this same transaction (i.e. did not exist as top-level objects either before or after). References use the post-execution version and the TransactionEffectsDigest::OBJECT_DELETED tombstone digest.

fn wrapped(&self) -> Vec<ObjectRef>

Objects that existed as top-level objects before this transaction and have been wrapped inside another object by it (i.e. no longer visible in the object store as top-level). References use the post-execution version and the TransactionEffectsDigest::OBJECT_WRAPPED tombstone digest.

fn object_changes(&self) -> Vec<ObjectChange>

Returns a flattened view of every object change recorded in these effects: for each touched object, the input and output version/digest (when present) together with the IDOperation describing whether the ID was created, deleted, or unchanged.

fn gas_object(&self) -> (ObjectRef, Owner)

Returns the post-execution reference and owner of the gas object.

fn events_digest(&self) -> Option<&TransactionEventsDigest>

Digest of the events emitted by this transaction, or None if it emitted no events.

fn dependencies(&self) -> &[TransactionDigest]

Digests of the transactions this one depends on, i.e. transactions that must be executed before this one for its inputs to be available.

fn transaction_digest(&self) -> &TransactionDigest

Digest of the transaction that produced these effects.

fn gas_cost_summary(&self) -> &GasCostSummary

Return the gas cost summary of the transaction.

fn unchanged_shared_objects(&self) -> Vec<(ObjectId, UnchangedSharedKind)>

Returns all root shared objects (i.e. not child object) that are read-only in the transaction.

fn deleted_mutably_accessed_shared_objects(&self) -> Vec<ObjectId>

IDs of shared objects that were declared as mutable inputs by the transaction but had already been deleted at the time of execution.

impl TransactionEffectsAPIForTesting for TransactionEffects

fn status_mut_for_testing(&mut self) -> &mut ExecutionStatus

Returns a mutable reference to the execution status, for tests.

fn gas_cost_summary_mut_for_testing(&mut self) -> &mut GasCostSummary

Returns a mutable reference to the gas cost summary, for tests.

fn transaction_digest_mut_for_testing(&mut self) -> &mut TransactionDigest

Returns a mutable reference to the transaction digest, for tests.

fn dependencies_mut_for_testing(&mut self) -> &mut Vec<TransactionDigest>

Returns a mutable reference to the dependency list, for tests.

fn unsafe_add_input_shared_object_for_testing( &mut self, kind: InputSharedObject, )

Records kind as an input shared object without validating that it is consistent with the rest of the effects. For tests only.

fn unsafe_add_deleted_live_object_for_testing(&mut self, object_ref: ObjectRef)

Records an entry that represents the pre-execution version of a still live object, without validating consistency with the rest of the effects. For tests only.

fn unsafe_add_object_tombstone_for_testing(&mut self, object_ref: ObjectRef)

Records a tombstone entry for a deleted object, without validating consistency with the rest of the effects. For tests only.

impl TransactionEffectsExt for TransactionEffects

fn new_from_execution_v1( status: ExecutionStatus, epoch: EpochId, gas_cost_summary: GasCostSummary, shared_objects: Vec<SharedInput>, loaded_per_epoch_config_objects: BTreeSet<ObjectId>, transaction_digest: TransactionDigest, lamport_version: SequenceNumber, changed_objects: BTreeMap<ObjectId, EffectsObjectChange>, gas_object: Option<ObjectId>, events_digest: Option<TransactionEventsDigest>, dependencies: Vec<TransactionDigest>, ) -> Self

Build effects from the results of executing a transaction under the V1 protocol shape.

fn new_empty_v1(transaction_digest: TransactionDigest) -> Self

Build empty V1 effects for transaction_digest: success status, no object changes, and no gas object. For tests that need a placeholder whose effects content is irrelevant, e.g. system transactions.

fn execution_digests(&self) -> ExecutionDigests

Returns the (transaction_digest, effects_digest) pair identifying this execution.

fn all_changed_objects(&self) -> Vec<(ObjectRef, Owner, WriteKind)>

Return an iterator that iterates through all changed objects, including mutated, created and unwrapped objects. In other words, all objects that still exist in the object state after this transaction. It doesn’t include deleted/wrapped objects.

fn all_removed_objects(&self) -> Vec<(ObjectRef, ObjectRemoveKind)>

Return all objects that existed in the state prior to the transaction but no longer exist in the state after the transaction. It includes deleted and wrapped objects, but does not include unwrapped_then_deleted objects.

fn all_tombstones(&self) -> Vec<(ObjectId, SequenceNumber)>

Returns all objects that will become a tombstone after this transaction. This includes deleted, unwrapped_then_deleted and wrapped objects.

fn created_then_wrapped_objects(&self) -> Vec<(ObjectId, SequenceNumber)>

Returns all objects that were created + wrapped in the same transaction.

fn mutated_excluding_gas(&self) -> Vec<(ObjectRef, Owner)>

Return an iterator of mutated objects, but excluding the gas object.

fn all_affected_objects(&self) -> Vec<ObjectRef>

Returns all affected objects in this transaction effects. Affected objects include created, mutated, unwrapped, deleted, unwrapped_then_deleted, wrapped and input shared objects.

fn summary_for_debug(&self) -> TransactionEffectsDebugSummary

Returns a condensed TransactionEffectsDebugSummary suitable for logging and inspection.

fn estimate_size_upperbound_v1( num_writes: usize, num_modifies: usize, num_deps: usize, ) -> usize

Upper-bound estimate of the serialized size in bytes of effects with the given number of writes, modifies, and dependencies under the V1 protocol shape.

impl Eq for TransactionEffects

impl StructuralPartialEq for TransactionEffects