Struct ProvenTransaction 

pub struct ProvenTransaction { /* private fields */ }

Result of executing and proving a transaction. Contains all the data required to verify that a transaction was executed correctly.

A proven transaction must not be empty. A transaction is empty if the account state is unchanged or the number of input notes is zero. This check prevents proving a transaction once and submitting it to the network many times. Output notes are not considered because they can be empty (i.e. contain no assets). Otherwise, a transaction with no account state change, no input notes and one such empty output note could be resubmitted many times to the network and fill up block space which is a form of DOS attack.

Implementations

impl ProvenTransaction

pub fn new( account_update: TxAccountUpdate, input_notes: impl IntoIterator<Item = impl Into<InputNoteCommitment>>, output_notes: impl IntoIterator<Item = impl Into<OutputNote>>, ref_block_num: BlockNumber, ref_block_commitment: Word, fee: FungibleAsset, expiration_block_num: BlockNumber, proof: ExecutionProof, ) -> Result<Self, ProvenTransactionError>

Creates a new ProvenTransaction from the specified components.

Errors

Returns an error if:

• The total number of input notes is greater than MAX_INPUT_NOTES_PER_TX.
• The vector of input notes contains duplicates.
• The total number of output notes is greater than MAX_OUTPUT_NOTES_PER_TX.
• The vector of output notes contains duplicates.
• The transaction is empty, which is the case if the account state is unchanged or the number of input notes is zero.
• The commitment computed on the actual account delta contained in TxAccountUpdate does not match its declared account delta commitment.

pub fn id(&self) -> TransactionId

Returns unique identifier of this transaction.

pub fn account_id(&self) -> AccountId

Returns ID of the account against which this transaction was executed.

pub fn account_update(&self) -> &TxAccountUpdate

Returns the account update details.

pub fn input_notes(&self) -> &InputNotes<InputNoteCommitment>

Returns a reference to the notes consumed by the transaction.

pub fn output_notes(&self) -> &OutputNotes

Returns a reference to the notes produced by the transaction.

pub fn proof(&self) -> &ExecutionProof

Returns the proof of the transaction.

pub fn ref_block_num(&self) -> BlockNumber

Returns the number of the reference block the transaction was executed against.

pub fn ref_block_commitment(&self) -> Word

Returns the commitment of the block transaction was executed against.

pub fn fee(&self) -> FungibleAsset

Returns the fee of the transaction.

pub fn unauthenticated_notes(&self) -> impl Iterator<Item = &NoteHeader>

Returns an iterator of the headers of unauthenticated input notes in this transaction.

pub fn expiration_block_num(&self) -> BlockNumber

Returns the block number at which the transaction will expire.

pub fn nullifiers(&self) -> impl Iterator<Item = Nullifier> + '_

Returns an iterator over the nullifiers of all input notes in this transaction.

This includes both authenticated and unauthenticated notes.

Trait Implementations

impl Clone for ProvenTransaction

fn clone(&self) -> ProvenTransaction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProvenTransaction

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

Formats the value using the given formatter.

impl Deserializable for ProvenTransaction

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl From<&ProvenTransaction> for TransactionHeader

fn from(tx: &ProvenTransaction) -> Self

Constructs a TransactionHeader from a ProvenTransaction.

impl From<&ProvenTransaction> for TransactionId

fn from(tx: &ProvenTransaction) -> Self

Converts to this type from the input type.

impl PartialEq for ProvenTransaction

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

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for ProvenTransaction

impl StructuralPartialEq for ProvenTransaction