Struct TransactionHeader 

pub struct TransactionHeader { /* private fields */ }

A transaction header derived from a ProvenTransaction.

The header is essentially a direct copy of the transaction’s commitments, in particular the initial and final account state commitment as well as all nullifiers of consumed notes and all note IDs of created notes. While account updates may be aggregated and notes may be erased as part of batch and block building, the header retains the original transaction’s data.

Implementations

impl TransactionHeader

pub fn new( account_id: AccountId, initial_state_commitment: Word, final_state_commitment: Word, input_notes: InputNotes<InputNoteCommitment>, output_notes: Vec<NoteHeader>, ) -> Self

Constructs a new TransactionHeader from the provided parameters.

The TransactionId is computed from the provided parameters.

The input notes and output notes must be in the same order as they appeared in the transaction that this header represents, otherwise an incorrect ID will be computed.

Note that this cannot validate that the AccountId is valid with respect to the other data. This must be validated outside of this type.

pub fn new_unchecked( id: TransactionId, account_id: AccountId, initial_state_commitment: Word, final_state_commitment: Word, input_notes: InputNotes<InputNoteCommitment>, output_notes: Vec<NoteHeader>, ) -> Self

Constructs a new TransactionHeader from the provided parameters.

Warning

This does not validate the internal consistency of the data. Prefer Self::new whenever possible.

pub fn id(&self) -> TransactionId

Returns the unique identifier of this transaction.

pub fn account_id(&self) -> AccountId

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

pub fn initial_state_commitment(&self) -> Word

Returns a commitment to the state of the account before this update is applied.

This is equal to Word::empty() for new accounts.

pub fn final_state_commitment(&self) -> Word

Returns a commitment to the state of the account after this update is applied.

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

Returns a reference to the consumed notes of the transaction.

The returned input note commitments have the same order as the transaction to which the header belongs.

Note that the note may have been erased at the batch or block level, so it may not be present there.

pub fn output_notes(&self) -> &[NoteHeader]

Returns a reference to the ID and metadata of the output notes created by the transaction.

The returned output note data has the same order as the transaction to which the header belongs.

Note that the note may have been erased at the batch or block level, so it may not be present there.

Trait Implementations

impl Clone for TransactionHeader

fn clone(&self) -> TransactionHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionHeader

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

Formats the value using the given formatter.

impl Deserializable for TransactionHeader

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 read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

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

impl From<&ProvenTransaction> for TransactionHeader

fn from(tx: &ProvenTransaction) -> Self

Constructs a TransactionHeader from a ProvenTransaction.

impl PartialEq for TransactionHeader

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

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 TransactionHeader

impl StructuralPartialEq for TransactionHeader