Struct TransactionArgs

pub struct TransactionArgs { /* private fields */ }

Optional transaction arguments.

• Transaction script: a program that is executed in a transaction after all input notes scripts have been executed.
• Note arguments: data put onto the stack right before a note script is executed. These are different from note inputs, as the user executing the transaction can specify arbitrary note args.
• Advice inputs: Provides data needed by the runtime, like the details of public output notes.
• Account inputs: Provides account data that will be accessed in the transaction.

Implementations

impl TransactionArgs

pub fn new( tx_script: Option<TransactionScript>, note_args: Option<BTreeMap<NoteId, Word>>, advice_map: AdviceMap, foreign_account_inputs: Vec<AccountInputs>, ) -> Self

Returns new TransactionArgs instantiated with the provided transaction script and note arguments.

If tx_script is provided, this also adds all mappings from the transaction script inputs to the advice inputs’ map.

pub fn with_tx_script(self, tx_script: TransactionScript) -> Self

Returns new TransactionArgs instantiated with the provided transaction script.

pub fn with_note_args(self, note_args: BTreeMap<NoteId, Word>) -> Self

Returns new TransactionArgs instantiated with the provided note arguments.

pub fn tx_script(&self) -> Option<&TransactionScript>

Returns a reference to the transaction script.

pub fn get_note_args(&self, note_id: NoteId) -> Option<&Word>

Returns a reference to a specific note argument.

pub fn advice_inputs(&self) -> &AdviceInputs

Returns a reference to the args AdviceInputs.

pub fn foreign_account_inputs(&self) -> &[AccountInputs]

Returns a reference to the foreign account inputs in the transaction args.

pub fn foreign_account_code_commitments(&self) -> BTreeSet<Digest>

Collects and returns a set containing all code commitments from foreign accounts.

pub fn add_output_note_recipient<T: AsRef<NoteRecipient>>( &mut self, note_recipient: T, )

Populates the advice inputs with the expected recipient data for creating output notes.

The advice inputs’ map is extended with the following keys:

• recipient_digest |-> recipient details (inputs_hash, script_root, serial_num).
• inputs_commitment |-> inputs.
• script_root |-> script.

pub fn extend_output_note_recipients<T, L>(&mut self, notes: L)

where L: IntoIterator<Item = T>, T: AsRef<NoteRecipient>,

Populates the advice inputs with the specified note recipient details.

The advice inputs’ map is extended with the following keys:

• recipient |-> recipient details (inputs_hash, script_root, serial_num).
• inputs_commitment |-> inputs.
• script_root |-> script.

pub fn extend_advice_inputs(&mut self, advice_inputs: AdviceInputs)

Extends the advice inputs in self with the provided ones.

pub fn extend_advice_map<T: IntoIterator<Item = (Digest, Vec<Felt>)>>( &mut self, iter: T, )

Extends the internal advice inputs’ map with the provided key-value pairs.

pub fn extend_merkle_store<I: Iterator<Item = InnerNodeInfo>>( &mut self, iter: I, )

Extends the internal advice inputs’ merkle store with the provided nodes.

Trait Implementations

impl Clone for TransactionArgs

fn clone(&self) -> TransactionArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionArgs

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

Formats the value using the given formatter.

impl Default for TransactionArgs

fn default() -> TransactionArgs

Returns the “default value” for a type.

impl Deserializable for TransactionArgs

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 PartialEq for TransactionArgs

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

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 TransactionArgs

impl StructuralPartialEq for TransactionArgs