Enum iota_types::transaction::TransactionKind

pub enum TransactionKind {
    ProgrammableTransaction(ProgrammableTransaction),
    Genesis(GenesisTransaction),
    ConsensusCommitPrologueV1(ConsensusCommitPrologueV1),
    AuthenticatorStateUpdateV1(AuthenticatorStateUpdateV1),
    EndOfEpochTransaction(Vec<EndOfEpochTransactionKind>),
    RandomnessStateUpdate(RandomnessStateUpdate),
}

Variants

ProgrammableTransaction(ProgrammableTransaction)

A transaction that allows the interleaving of native commands and Move calls

Genesis(GenesisTransaction)

A system transaction that will update epoch information on-chain. It will only ever be executed once in an epoch. The argument is the next epoch number, which is critical because it ensures that this transaction has a unique digest. This will eventually be translated to a Move call during execution. It also doesn’t require/use a gas object. A validator will not sign a transaction of this kind from outside. It only signs internally during epoch changes.

ConsensusCommitPrologueV1(ConsensusCommitPrologueV1)

AuthenticatorStateUpdateV1(AuthenticatorStateUpdateV1)

EndOfEpochTransaction(Vec<EndOfEpochTransactionKind>)

EndOfEpochTransaction contains a list of transactions that are allowed to run at the end of the epoch.

RandomnessStateUpdate(RandomnessStateUpdate)

Implementations

impl TransactionKind

pub fn programmable(pt: ProgrammableTransaction) -> Self

present to make migrations to programmable transactions eaier. Will be removed

pub fn is_system_tx(&self) -> bool

pub fn is_end_of_epoch_tx(&self) -> bool

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

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

pub fn contains_shared_object(&self) -> bool

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

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

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

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

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

pub fn num_commands(&self) -> usize

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

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

pub fn tx_count(&self) -> usize

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

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

Trait Implementations

impl Clone for TransactionKind

fn clone(&self) -> TransactionKind

Returns a copy 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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TransactionKind

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

Formats the value using the given formatter.

impl<'_derivative_strum> From<&'_derivative_strum TransactionKind> for &'static str

fn from(x: &'_derivative_strum TransactionKind) -> &'static str

Converts to this type from the input type.

impl From<TransactionKind> for &'static str

fn from(x: TransactionKind) -> &'static str

Converts to this type from the input type.

impl From<TransactionKind> for TransactionKind

fn from(value: TransactionKind) -> Self

Converts to this type from the input type.

impl From<TransactionKind> for TransactionKind

fn from(value: TransactionKind) -> Self

Converts to this type from the input type.

impl Hash for TransactionKind

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

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TransactionKind

impl StructuralPartialEq for TransactionKind