Trait TransactionEffectsAPI

Source

pub trait TransactionEffectsAPI: Sealed {
Show 21 methods    // Required methods
    fn status(&self) -> &ExecutionStatus;
    fn into_status(self) -> ExecutionStatus;
    fn epoch(&self) -> EpochId;
    fn modified_at_versions(&self) -> Vec<(ObjectId, Version)>;
    fn lamport_version(&self) -> Version;
    fn old_object_metadata(&self) -> Vec<(ObjectRef, Owner)>;
    fn input_shared_objects(&self) -> Vec<InputSharedObject>;
    fn created(&self) -> Vec<(ObjectRef, Owner)>;
    fn mutated(&self) -> Vec<(ObjectRef, Owner)>;
    fn unwrapped(&self) -> Vec<(ObjectRef, Owner)>;
    fn deleted(&self) -> Vec<ObjectRef>;
    fn unwrapped_then_deleted(&self) -> Vec<ObjectRef>;
    fn wrapped(&self) -> Vec<ObjectRef>;
    fn object_changes(&self) -> Vec<ObjectChange>;
    fn gas_object(&self) -> (ObjectRef, Owner);
    fn events_digest(&self) -> Option<&TransactionEventsDigest>;
    fn dependencies(&self) -> &[TransactionDigest] ⓘ;
    fn transaction_digest(&self) -> &TransactionDigest;
    fn gas_cost_summary(&self) -> &GasCostSummary;
    fn unchanged_shared_objects(&self) -> Vec<(ObjectId, UnchangedSharedKind)>;

    // Provided method
    fn deleted_mutably_accessed_shared_objects(&self) -> Vec<ObjectId> { ... }
}

Expand description

Version-agnostic accessors for TransactionEffects.

Sealed; implemented for the enum and each version struct. The enum impl dispatches to the active variant.

Required Methods§

Source

fn status(&self) -> &ExecutionStatus

Return the status of the transaction.

Source

fn into_status(self) -> ExecutionStatus

Consume self and return the owned status of the transaction.

Source

fn epoch(&self) -> EpochId

Return the epoch in which this transaction was executed.

Source

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).

Source

fn lamport_version(&self) -> Version

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

Source

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.

Source

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.

Source

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.

Source

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).

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source