Enum aleo_rust::snarkvm_types::Transaction

pub enum Transaction<N>where
    N: Network,{
    Deploy(<N as Network>::TransactionID, ProgramOwner<N>, Box<Deployment<N>, Global>, Fee<N>),
    Execute(<N as Network>::TransactionID, Execution<N>, Option<Fee<N>>),
    Fee(<N as Network>::TransactionID, Fee<N>),
}

Variants

Deploy(<N as Network>::TransactionID, ProgramOwner<N>, Box<Deployment<N>, Global>, Fee<N>)

The deploy transaction publishes an Aleo program to the network.

Execute(<N as Network>::TransactionID, Execution<N>, Option<Fee<N>>)

The execute transaction represents a call to an Aleo program.

Fee(<N as Network>::TransactionID, Fee<N>)

The fee transaction represents a fee paid to the network, used for rejected transactions.

Implementations

impl<N> Transaction<N>where N: Network,

pub fn to_root(&self) -> Result<Field<N>, Error>

Returns the transaction root, by computing the root for a Merkle tree of the transition IDs.

pub fn to_leaf(&self, id: &Field<N>) -> Result<TransactionLeaf<N>, Error>

Returns the Merkle leaf for the given ID of a function or transition in the transaction.

pub fn to_path( &self, leaf: &TransactionLeaf<N> ) -> Result<MerklePath<N, snarkvm_console_program::::state_path::configuration::TransactionPath::{constant#0}>, Error>

Returns the Merkle path for the transaction leaf.

pub fn to_tree( &self ) -> Result<MerkleTree<N, BHP<N, 8, 54>, BHP<N, 6, 43>, snarkvm_console_program::::state_path::configuration::TransactionTree::{constant#0}>, Error>

The Merkle tree of transition IDs for the transaction.

impl<N> Transaction<N>where N: Network,

pub fn deployment_tree( deployment: &Deployment<N>, fee: Option<&Fee<N>> ) -> Result<MerkleTree<N, BHP<N, 8, 54>, BHP<N, 6, 43>, snarkvm_console_program::::state_path::configuration::TransactionTree::{constant#0}>, Error>

Returns the Merkle tree for the given deployment.

pub fn execution_tree( execution: &Execution<N>, fee: &Option<Fee<N>> ) -> Result<MerkleTree<N, BHP<N, 8, 54>, BHP<N, 6, 43>, snarkvm_console_program::::state_path::configuration::TransactionTree::{constant#0}>, Error>

Returns the Merkle tree for the given execution.

pub fn fee_tree( fee: &Fee<N> ) -> Result<MerkleTree<N, BHP<N, 8, 54>, BHP<N, 6, 43>, snarkvm_console_program::::state_path::configuration::TransactionTree::{constant#0}>, Error>

Returns the Merkle tree for the given fee.

pub fn check_deployment_size(deployment: &Deployment<N>) -> Result<(), Error>

Returns true if the deployment is within the size bounds.

pub fn check_execution_size(num_transitions: usize) -> Result<(), Error>

Returns true if the execution is within the size bounds.

impl<N> Transaction<N>where N: Network,

pub fn from_deployment( owner: ProgramOwner<N>, deployment: Deployment<N>, fee: Fee<N> ) -> Result<Transaction<N>, Error>

Initializes a new deployment transaction.

pub fn from_execution( execution: Execution<N>, fee: Option<Fee<N>> ) -> Result<Transaction<N>, Error>

Initializes a new execution transaction.

pub fn from_fee(fee: Fee<N>) -> Result<Transaction<N>, Error>

Initializes a new fee transaction.

impl<N> Transaction<N>where N: Network,

pub fn is_deploy(&self) -> bool

Returns true if the transaction is a deploy transaction.

pub fn is_execute(&self) -> bool

Returns true if the transaction is an execute transaction.

pub fn is_fee(&self) -> bool

Returns true if the transaction is a fee transaction.

pub fn is_mint(&self) -> bool

Returns true if this is a mint transaction.

pub fn is_split(&self) -> bool

Returns true if this is a split transaction.

impl<N> Transaction<N>where N: Network,

pub fn owner(&self) -> Option<&ProgramOwner<N>>

Returns Some(owner) if the transaction is a deployment. Otherwise, returns None.

pub fn deployment(&self) -> Option<&Deployment<N>>

Returns Some(deployment) if the transaction is a deployment. Otherwise, returns None.

pub fn execution(&self) -> Option<&Execution<N>>

Returns Some(execution) if the transaction is an execution. Otherwise, returns None.

impl<N> Transaction<N>where N: Network,

pub const fn id(&self) -> <N as Network>::TransactionID

Returns the transaction ID.

pub fn fee(&self) -> Result<Integer<N, u64>, Error>

Returns the transaction fee.

pub fn fee_transition(&self) -> Option<Fee<N>>

Returns the fee transition.

impl<N> Transaction<N>where N: Network,

pub fn contains_transition( &self, transition_id: &<N as Network>::TransitionID ) -> bool

Returns true if the transaction contains the given transition ID.

pub fn contains_serial_number(&self, serial_number: &Field<N>) -> bool

Returns true if the transaction contains the given serial number.

pub fn contains_commitment(&self, commitment: &Field<N>) -> bool

Returns true if the transaction contains the given commitment.

impl<N> Transaction<N>where N: Network,

pub fn find_transition( &self, transition_id: &<N as Network>::TransitionID ) -> Option<&Transition<N>>

Returns the transition with the corresponding transition ID, if it exists.

pub fn find_transition_for_serial_number( &self, serial_number: &Field<N> ) -> Option<&Transition<N>>

Returns the transition for the given serial number, if it exists.

pub fn find_transition_for_commitment( &self, commitment: &Field<N> ) -> Option<&Transition<N>>

Returns the transition for the given commitment, if it exists.

pub fn find_record( &self, commitment: &Field<N> ) -> Option<&Record<N, Ciphertext<N>>>

Returns the record with the corresponding commitment, if it exists.

impl<N> Transaction<N>where N: Network,

pub fn transition_ids( &self ) -> impl Iterator<Item = &<N as Network>::TransitionID>

Returns an iterator over the transition IDs, for all transitions.

pub fn transitions(&self) -> impl Iterator<Item = &Transition<N>>

Returns an iterator over all transitions.

pub fn input_ids(&self) -> impl Iterator<Item = &Field<N>>

Returns an iterator over the input IDs, for all transition inputs that are records.

pub fn serial_numbers(&self) -> impl Iterator<Item = &Field<N>>

Returns an iterator over the serial numbers, for all transition inputs that are records.

pub fn tags(&self) -> impl Iterator<Item = &Field<N>>

Returns an iterator over the tags, for all transition inputs that are records.

pub fn output_ids(&self) -> impl Iterator<Item = &Field<N>>

Returns an iterator over the output IDs, for all transition inputs that are records.

pub fn commitments(&self) -> impl Iterator<Item = &Field<N>>

Returns an iterator over the commitments, for all transition outputs that are records.

pub fn records( &self ) -> impl Iterator<Item = (&Field<N>, &Record<N, Ciphertext<N>>)>

Returns an iterator over the records, for all transition outputs that are records.

pub fn nonces(&self) -> impl Iterator<Item = &Group<N>>

Returns an iterator over the nonces, for all transition outputs that are records.

pub fn transition_public_keys(&self) -> impl Iterator<Item = &Group<N>>

Returns an iterator over the transition public keys, for all transitions.

pub fn transition_commitments(&self) -> impl Iterator<Item = &Field<N>>

Returns an iterator over the transition commitments, for all transitions.

impl<N> Transaction<N>where N: Network,

pub fn into_transition_ids( self ) -> impl Iterator<Item = <N as Network>::TransitionID>

Returns a consuming iterator over the transition IDs, for all transitions.

pub fn into_transitions(self) -> impl Iterator<Item = Transition<N>>

Returns a consuming iterator over all transitions.

pub fn into_transition_public_keys(self) -> impl Iterator<Item = Group<N>>

Returns a consuming iterator over the transition public keys, for all transitions.

pub fn into_tags(self) -> impl Iterator<Item = Field<N>>

Returns a consuming iterator over the tags, for all transition inputs that are records.

pub fn into_serial_numbers(self) -> impl Iterator<Item = Field<N>>

Returns a consuming iterator over the serial numbers, for all transition inputs that are records.

pub fn into_commitments(self) -> impl Iterator<Item = Field<N>>

Returns a consuming iterator over the commitments, for all transition outputs that are records.

pub fn into_records( self ) -> impl Iterator<Item = (Field<N>, Record<N, Ciphertext<N>>)>

Returns a consuming iterator over the records, for all transition outputs that are records.

pub fn into_nonces(self) -> impl Iterator<Item = Group<N>>

Returns a consuming iterator over the nonces, for all transition outputs that are records.

Trait Implementations

impl<N> Clone for Transaction<N>where N: Clone + Network, <N as Network>::TransactionID: Clone,

fn clone(&self) -> Transaction<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Transaction<N>where N: Network,

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

Prints the transaction as a JSON-string.

impl<'de, N> Deserialize<'de> for Transaction<N>where N: Network,

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

Deserializes the transaction from a JSON-string or buffer.

impl<N> Display for Transaction<N>where N: Network,

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

Displays the transaction as a JSON-string.

impl<N> FromBytes for Transaction<N>where N: Network,

fn read_le<R>(reader: R) -> Result<Transaction<N>, Error>where R: Read,

Reads the transaction from the buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<N> FromStr for Transaction<N>where N: Network,

fn from_str( transaction: &str ) -> Result<Transaction<N>, <Transaction<N> as FromStr>::Err>

Initializes the transaction from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> PartialEq<Transaction<N>> for Transaction<N>where N: PartialEq<N> + Network, <N as Network>::TransactionID: PartialEq<<N as Network>::TransactionID>,

fn eq(&self, other: &Transaction<N>) -> 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<N> Serialize for Transaction<N>where N: Network,

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,

Serializes the transaction to a JSON-string or buffer.

impl<N> ToBytes for Transaction<N>where N: Network,

fn write_le<W>(&self, writer: W) -> Result<(), Error>where W: Write,

Writes the transaction to the buffer.

fn to_bytes_le(&self) -> Result<Vec<u8, Global>, Error>where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N> Eq for Transaction<N>where N: Eq + Network, <N as Network>::TransactionID: Eq,

impl<N> StructuralEq for Transaction<N>where N: Network,

impl<N> StructuralPartialEq for Transaction<N>where N: Network,