Struct TransactionSummary 

pub struct TransactionSummary { /* private fields */ }

The summary of the changes that result from executing a transaction.

These are the account delta, the consumed and created notes, the commitment to the reference block, the transaction’s expiration block delta and the user-defined parameters (see TransactionSummaryUserParams).

Because this data is intended to be signed, the user-defined parameters give an account’s authentication procedure a way to bind arbitrary additional data to that signature, for example a salt providing replay protection or a maximum fee.

Implementations

impl TransactionSummary

pub const NUM_ELEMENTS: usize

The number of elements in the preimage of a TransactionSummary commitment, i.e. the length of the vector returned by TransactionSummary::to_elements (6 words).

Must match TX_SUMMARY_NUM_ELEMENTS in the standard auth library (crates/miden-standards/asm/standards/auth/mod.masm).

pub fn new( account_delta: AccountDelta, input_notes: InputNotes<InputNote>, output_notes: RawOutputNotes, block_commitment: Word, expiration_delta: u16, user_params: TransactionSummaryUserParams, ) -> Self

Creates a new TransactionSummary from the provided parts.

pub fn account_delta(&self) -> &AccountDelta

Returns the account delta of this transaction summary.

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

Returns the input notes of this transaction summary.

pub fn output_notes(&self) -> &RawOutputNotes

Returns the output notes of this transaction summary.

pub fn block_commitment(&self) -> Word

Returns the commitment to the reference block of this transaction summary.

pub fn expiration_delta(&self) -> u16

Returns the expiration block delta of the transaction, or 0 if it has not been set.

pub fn user_params(&self) -> TransactionSummaryUserParams

Returns the user-defined parameters bound by this transaction summary.

pub fn to_elements(&self) -> Vec<Felt>

Returns the elements this transaction summary commits to, i.e. the preimage of TransactionSummary::to_commitment.

The returned vector contains TransactionSummary::NUM_ELEMENTS elements laid out as:

[
    ACCOUNT_DELTA_COMMITMENT, INPUT_NOTES_COMMITMENT, OUTPUT_NOTES_COMMITMENT,
    BLOCK_COMMITMENT, [expiration_delta, user_param0, user_param1, user_param2],
    [user_param3, user_param4, user_param5, user_param6],
]

pub fn to_commitment(&self) -> Word

Computes the commitment to the TransactionSummary.

This can be used to sign the transaction.

pub fn try_params_from_elements( elements: &[Felt], ) -> Result<(u16, TransactionSummaryUserParams), TransactionSummaryError>

Decodes the transaction’s expiration block delta and its TransactionSummaryUserParams from the preimage of a transaction summary commitment.

elements must be a full preimage as returned by TransactionSummary::to_elements. The four leading commitments are not decoded because they cannot be inverted: a caller reconstructing a summary from a preimage must rebuild the committed data from its own state, pass it to TransactionSummary::new alongside the decoded values and check the result against TransactionSummary::to_commitment.

Errors

Returns an error if:

• elements does not contain exactly TransactionSummary::NUM_ELEMENTS elements.
• the expiration block delta element does not fit into a u16.

Trait Implementations

impl Clone for TransactionSummary

fn clone(&self) -> TransactionSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionSummary

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

Formats the value using the given formatter.

impl Deserializable for TransactionSummary

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 Eq for TransactionSummary

impl PartialEq for TransactionSummary

fn eq(&self, other: &TransactionSummary) -> bool

Equality operator ==.

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

Inequality operator !=.

impl SequentialCommit for TransactionSummary

type Commitment = Word

A type of the commitment which must be derivable from Word.

fn to_elements(&self) -> Vec<Felt>

Returns a representation of the object as a sequence of fields elements.

fn to_commitment(&self) -> Self::Commitment

Computes the commitment to the object.

impl Serializable for TransactionSummary

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 StructuralPartialEq for TransactionSummary