Enum TransactionKind 

#[non_exhaustive]
pub enum TransactionKind {
    Programmable(ProgrammableTransaction),
    Genesis(GenesisTransaction),
    ConsensusCommitPrologueV1(ConsensusCommitPrologueV1),
    AuthenticatorStateUpdateV1Deprecated,
    EndOfEpoch(Vec<EndOfEpochTransactionKind>),
    RandomnessStateUpdate(RandomnessStateUpdate),
}

Transaction type

BCS

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

transaction-kind    =  %d00 programmable-transaction               ; Programmable
                    =/ %d01 genesis-transaction                    ; Genesis
                    =/ %d02 consensus-commit-prologue-v1           ; ConsensusCommitPrologueV1
                    =/ %d03                                        ; AuthenticatorStateUpdateV1Deprecated
                    =/ %d04 (vector end-of-epoch-transaction-kind) ; EndOfEpoch
                    =/ %d05 randomness-state-update                ; RandomnessStateUpdate

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.

Programmable(ProgrammableTransaction)

A user transaction comprised of a list of native commands and move calls

Genesis(GenesisTransaction)

Transaction used to initialize the chain state.

Only valid if in the genesis checkpoint (0) and if this is the very first transaction ever executed on the chain.

ConsensusCommitPrologueV1(ConsensusCommitPrologueV1)

V1 consensus commit update

AuthenticatorStateUpdateV1Deprecated

Update set of valid JWKs used for zklogin - Deprecated

EndOfEpoch(Vec<EndOfEpochTransactionKind>)

Set of operations to run at the end of the epoch to close out the current epoch and start the next one.

RandomnessStateUpdate(RandomnessStateUpdate)

Randomness update

Implementations

impl TransactionKind

pub fn is_consensus_commit_prologue_v1(&self) -> bool

Checks if this is a consensus_commit_prologue_v1 variant.

pub fn as_consensus_commit_prologue_v1(&self) -> &ConsensusCommitPrologueV1

Converts this into a consensus_commit_prologue_v1 if it is a consensus_commit_prologue_v1 variant, or panics otherwise.

pub fn as_consensus_commit_prologue_v1_mut( &mut self, ) -> &mut ConsensusCommitPrologueV1

Converts this into a mut consensus_commit_prologue_v1 if it is a consensus_commit_prologue_v1 variant, or panics otherwise.

pub fn as_consensus_commit_prologue_v1_opt( &self, ) -> Option<&ConsensusCommitPrologueV1>

Converts this into a consensus_commit_prologue_v1 if it is a consensus_commit_prologue_v1 variant, or returns None otherwise.

pub fn as_consensus_commit_prologue_v1_mut_opt( &mut self, ) -> Option<&mut ConsensusCommitPrologueV1>

Converts this into a mut consensus_commit_prologue_v1 if it is a consensus_commit_prologue_v1 variant, or returns None otherwise.

pub fn into_consensus_commit_prologue_v1_opt( self, ) -> Option<ConsensusCommitPrologueV1>

Converts this into a consensus_commit_prologue_v1 if it is a consensus_commit_prologue_v1 variant, or returns None otherwise.

pub fn into_consensus_commit_prologue_v1(self) -> ConsensusCommitPrologueV1

Converts this into a consensus_commit_prologue_v1 if it is a consensus_commit_prologue_v1 variant, or panics otherwise.

pub fn is_randomness_state_update(&self) -> bool

Checks if this is a randomness_state_update variant.

pub fn as_randomness_state_update(&self) -> &RandomnessStateUpdate

Converts this into a randomness_state_update if it is a randomness_state_update variant, or panics otherwise.

pub fn as_randomness_state_update_mut(&mut self) -> &mut RandomnessStateUpdate

Converts this into a mut randomness_state_update if it is a randomness_state_update variant, or panics otherwise.

pub fn as_randomness_state_update_opt(&self) -> Option<&RandomnessStateUpdate>

Converts this into a randomness_state_update if it is a randomness_state_update variant, or returns None otherwise.

pub fn as_randomness_state_update_mut_opt( &mut self, ) -> Option<&mut RandomnessStateUpdate>

Converts this into a mut randomness_state_update if it is a randomness_state_update variant, or returns None otherwise.

pub fn into_randomness_state_update_opt(self) -> Option<RandomnessStateUpdate>

Converts this into a randomness_state_update if it is a randomness_state_update variant, or returns None otherwise.

pub fn into_randomness_state_update(self) -> RandomnessStateUpdate

Converts this into a randomness_state_update if it is a randomness_state_update variant, or panics otherwise.

pub fn is_programmable(&self) -> bool

Checks if this is a programmable variant.

pub fn as_programmable(&self) -> &ProgrammableTransaction

Converts this into a programmable if it is a programmable variant, or panics otherwise.

pub fn as_programmable_mut(&mut self) -> &mut ProgrammableTransaction

Converts this into a mut programmable if it is a programmable variant, or panics otherwise.

pub fn as_programmable_opt(&self) -> Option<&ProgrammableTransaction>

Converts this into a programmable if it is a programmable variant, or returns None otherwise.

pub fn as_programmable_mut_opt( &mut self, ) -> Option<&mut ProgrammableTransaction>

Converts this into a mut programmable if it is a programmable variant, or returns None otherwise.

pub fn into_programmable_opt(self) -> Option<ProgrammableTransaction>

Converts this into a programmable if it is a programmable variant, or returns None otherwise.

pub fn into_programmable(self) -> ProgrammableTransaction

Converts this into a programmable if it is a programmable variant, or panics otherwise.

pub fn is_genesis(&self) -> bool

Checks if this is a genesis variant.

pub fn as_genesis(&self) -> &GenesisTransaction

Converts this into a genesis if it is a genesis variant, or panics otherwise.

pub fn as_genesis_mut(&mut self) -> &mut GenesisTransaction

Converts this into a mut genesis if it is a genesis variant, or panics otherwise.

pub fn as_genesis_opt(&self) -> Option<&GenesisTransaction>

Converts this into a genesis if it is a genesis variant, or returns None otherwise.

pub fn as_genesis_mut_opt(&mut self) -> Option<&mut GenesisTransaction>

Converts this into a mut genesis if it is a genesis variant, or returns None otherwise.

pub fn into_genesis_opt(self) -> Option<GenesisTransaction>

Converts this into a genesis if it is a genesis variant, or returns None otherwise.

pub fn into_genesis(self) -> GenesisTransaction

Converts this into a genesis if it is a genesis variant, or panics otherwise.

pub fn is_end_of_epoch(&self) -> bool

Checks if this is a end_of_epoch variant.

pub fn as_end_of_epoch(&self) -> &Vec<EndOfEpochTransactionKind>

Converts this into a end_of_epoch if it is a end_of_epoch variant, or panics otherwise.

pub fn as_end_of_epoch_mut(&mut self) -> &mut Vec<EndOfEpochTransactionKind>

Converts this into a mut end_of_epoch if it is a end_of_epoch variant, or panics otherwise.

pub fn as_end_of_epoch_opt(&self) -> Option<&Vec<EndOfEpochTransactionKind>>

Converts this into a end_of_epoch if it is a end_of_epoch variant, or returns None otherwise.

pub fn as_end_of_epoch_mut_opt( &mut self, ) -> Option<&mut Vec<EndOfEpochTransactionKind>>

Converts this into a mut end_of_epoch if it is a end_of_epoch variant, or returns None otherwise.

pub fn into_end_of_epoch_opt(self) -> Option<Vec<EndOfEpochTransactionKind>>

Converts this into a end_of_epoch if it is a end_of_epoch variant, or returns None otherwise.

pub fn into_end_of_epoch(self) -> Vec<EndOfEpochTransactionKind>

Converts this into a end_of_epoch if it is a end_of_epoch variant, or panics otherwise.

pub fn new_programmable(tx: ProgrammableTransaction) -> TransactionKind

Create a TransactionKind::Programmable.

pub fn new_genesis(tx: GenesisTransaction) -> TransactionKind

Create a TransactionKind::Genesis.

pub fn new_consensus_commit_prologue_v1( tx: ConsensusCommitPrologueV1, ) -> TransactionKind

Create a TransactionKind::ConsensusCommitPrologueV1.

pub fn new_end_of_epoch(tx: Vec<EndOfEpochTransactionKind>) -> TransactionKind

Create a TransactionKind::EndOfEpoch.

pub fn new_randomness_state_update(tx: RandomnessStateUpdate) -> TransactionKind

Create a TransactionKind::RandomnessStateUpdate.

pub fn is_system(&self) -> bool

Returns true if this is a system transaction.

pub fn num_commands(&self) -> usize

Returns the number of commands, or 0 if it is a system transaction.

pub fn num_transactions(&self) -> usize

Returns the number of transactions, or 1 if it is a system transaction.

Trait Implementations

impl Arbitrary for TransactionKind

type Parameters = ()

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

type Strategy = BoxedStrategy<TransactionKind>

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

fn arbitrary_with( args_shared: <TransactionKind as Arbitrary>::Parameters, ) -> <TransactionKind 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 TransactionKind

fn clone(&self) -> TransactionKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransactionKind

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TransactionKind

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

Formats the value using the given formatter.

impl Hash for TransactionKind

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TransactionKind

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

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 TransactionKindExt for TransactionKind

fn get_advance_epoch_tx_gas_summary(&self) -> Option<(u64, u64)>

If this is an advance epoch transaction, returns (total gas charged, total gas rebated). TODO: We should use GasCostSummary directly in ChangeEpoch struct, and return that directly.

fn contains_shared_object(&self) -> bool

Returns true if the transaction contains at least one shared object.

fn shared_input_objects(&self) -> impl Iterator<Item = SharedObjectRef> + '_

Returns an iterator of all shared input objects used by this transaction.

fn move_calls(&self) -> Vec<(&ObjectID, &str, &str)>

Returns the move calls made by this transaction as a list of (package, module, function) tuples.

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

Returns the objects received by this transaction.

fn input_objects(&self) -> UserInputResult<Vec<InputObjectKind>>

Return the metadata of each of the input objects for the transaction. For a Move object, we attach the object reference; for a Move package, we provide the object id only since they never change on chain. TODO: use an iterator over references here instead of a Vec to avoid allocations.

fn validity_check(&self, config: &ProtocolConfig) -> UserInputResult

Validates the transaction against the given protocol config.

fn iter_commands(&self) -> impl Iterator<Item = &Command>

Returns an iterator over the commands in this transaction.

fn name(&self) -> &'static str

Returns a human-readable name for this transaction kind.

impl Eq for TransactionKind

impl StructuralPartialEq for TransactionKind