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.
• Transaction script argument: a Word, which will be pushed to the operand stack before the transaction script execution. If this argument is not specified, the EMPTY_WORD would be used as a default value. If the AdviceInputs are propagated with some user defined map entries, this script argument could be used as a key to access the corresponding value.
• 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.
• Foreign account inputs: provides foreign account data that will be used during the foreign procedure invocation (FPI).

Implementations

impl TransactionArgs

pub fn new( advice_map: AdviceMap, foreign_account_inputs: Vec<AccountInputs>, ) -> Self

Returns new TransactionArgs instantiated with the provided transaction script, advice map and foreign account inputs.

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

Returns new TransactionArgs instantiated with the provided transaction script.

If the transaction script is already set, it will be overwritten with the newly provided one.

pub fn with_tx_script_and_arg( self, tx_script: TransactionScript, tx_script_arg: Word, ) -> Self

Returns new TransactionArgs instantiated with the provided transaction script and its argument.

If the transaction script and argument are already set, they will be overwritten with the newly provided ones.

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

Returns new TransactionArgs instantiated with the provided note arguments.

If the note arguments were already set, they will be overwritten with the newly provided ones.

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

Returns a reference to the transaction script.

pub fn tx_script_arg(&self) -> Word

Returns the transaction script argument, or EMPTY_WORD if the argument was not specified.

This argument could be potentially used as a key to access the advice map during the transaction script execution. Notice that the corresponding map entry should be provided separately during the creation with the TransactionArgs::new or using the TransactionArgs::extend_advice_map method.

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 internal AdviceInputs.

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

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

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_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