Enum TransactionEffects

pub enum TransactionEffects {
    V1(TransactionEffectsV1),
    V2(TransactionEffectsV2),
}

The response from processing a transaction or a certified transaction

Variants

V1(TransactionEffectsV1)

V2(TransactionEffectsV2)

Implementations

impl TransactionEffects

pub fn new_from_execution_v1( status: ExecutionStatus, executed_epoch: EpochId, gas_used: GasCostSummary, modified_at_versions: Vec<(ObjectID, SequenceNumber)>, shared_objects: Vec<ObjectRef>, transaction_digest: TransactionDigest, created: Vec<(ObjectRef, Owner)>, mutated: Vec<(ObjectRef, Owner)>, unwrapped: Vec<(ObjectRef, Owner)>, deleted: Vec<ObjectRef>, unwrapped_then_deleted: Vec<ObjectRef>, wrapped: Vec<ObjectRef>, gas_object: (ObjectRef, Owner), events_digest: Option<TransactionEventsDigest>, dependencies: Vec<TransactionDigest>, ) -> Self

Creates a TransactionEffects message from the results of execution, choosing the correct format for the current protocol version.

pub fn new_from_execution_v2( status: ExecutionStatus, executed_epoch: EpochId, gas_used: 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

Creates a TransactionEffects message from the results of execution, choosing the correct format for the current protocol version.

pub fn execution_digests(&self) -> ExecutionDigests

pub fn estimate_effects_size_upperbound_v1( num_writes: usize, num_mutables: usize, num_deletes: usize, num_deps: usize, ) -> usize

pub fn estimate_effects_size_upperbound_v2( num_writes: usize, num_modifies: usize, num_deps: usize, ) -> usize

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

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

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

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

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

pub fn summary_for_debug(&self) -> TransactionEffectsDebugSummary

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 From<TransactionEffectsV1> for TransactionEffects

fn from(v: TransactionEffectsV1) -> TransactionEffects

Converts to this type from the input type.

impl From<TransactionEffectsV2> for TransactionEffects

fn from(v: TransactionEffectsV2) -> TransactionEffects

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

const SCOPE: IntentScope = IntentScope::TransactionEffects

type DigestType = TransactionEffectsDigest

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TransactionEffectsAPI for TransactionEffects

fn lamport_version(&self) -> SequenceNumber

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. This API is only available on effects v2 and above.

fn input_consensus_objects(&self) -> Vec<InputConsensusObject>

Returns the list of sequenced consensus objects used in the input. This is needed in effects because in transaction we only have object ID for consensus 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.

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

The set of object refs written by this transaction, including deleted and wrapped objects. Unlike object_changes(), returns no information about the starting state of the object.

fn unchanged_consensus_objects(&self) -> Vec<(ObjectID, UnchangedConsensusKind)>

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

fn accumulator_updates(&self) -> Vec<(ObjectID, AccumulatorWriteV1)>

Returns all accumulator updates in the transaction.

fn status(&self) -> &ExecutionStatus

fn into_status(self) -> ExecutionStatus

fn executed_epoch(&self) -> EpochId

fn modified_at_versions(&self) -> Vec<(ObjectID, SequenceNumber)>

fn move_abort(&self) -> Option<(MoveLocation, u64)>

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 transferred_from_consensus(&self) -> Vec<ObjectRef>

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

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

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

fn accumulator_events(&self) -> Vec<AccumulatorEvent>

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 stream_ended_mutably_accessed_consensus_objects(&self) -> Vec<ObjectID>

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

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

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

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

fn unsafe_add_input_consensus_object_for_testing( &mut self, __enum_dispatch_arg_0: InputConsensusObject, )

fn unsafe_add_deleted_live_object_for_testing( &mut self, __enum_dispatch_arg_0: ObjectRef, )

fn unsafe_add_object_tombstone_for_testing( &mut self, __enum_dispatch_arg_0: ObjectRef, )

impl TryFrom<TransactionEffects> for TransactionEffects

type Error = SdkTypeConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<TransactionEffects> for TransactionEffects

type Error = SdkTypeConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<TransactionEffectsV1> for TransactionEffects

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TransactionEffectsV1, <Self as TryInto<TransactionEffectsV1>>::Error>

Performs the conversion.

impl TryInto<TransactionEffectsV2> for TransactionEffects

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TransactionEffectsV2, <Self as TryInto<TransactionEffectsV2>>::Error>

Performs the conversion.

impl Eq for TransactionEffects

impl StructuralPartialEq for TransactionEffects