Struct miden_client::transactions::request::TransactionRequest

pub struct TransactionRequest { /* private fields */ }

A request for executing a transaction against a specific account.

A request contains information about input notes to be consumed by the transaction (if any), description of the transaction script to be executed (if any), and a set of notes expected to be generated by the transaction or by consuming notes generated by the transaction.

Implementations

impl TransactionRequest

pub fn new() -> Self

pub fn with_unauthenticated_input_notes( self, notes: impl IntoIterator<Item = (Note, Option<NoteArgs>)>, ) -> Self

Adds the specified notes as unauthenticated input notes to the transaction request.

pub fn with_authenticated_input_notes( self, notes: impl IntoIterator<Item = (NoteId, Option<NoteArgs>)>, ) -> Self

Adds the specified notes as authenticated input notes to the transaction request.

pub fn with_own_output_notes( self, notes: impl IntoIterator<Item = OutputNote>, ) -> Result<Self, TransactionRequestError>

Specifies the output notes that should be created in the transaction script and will be used as a transaction script template. These notes will also be added the the expected output notes of the transaction.

If a transaction script template is already set (e.g. by calling with_custom_script), this method will return an error.

pub fn with_custom_script( self, script: TransactionScript, ) -> Result<Self, TransactionRequestError>

Specifies a custom transaction script to be used.

If a script template is already set (e.g. by calling with_own_output_notes), this method will return an error.

pub fn with_expected_output_notes(self, notes: Vec<Note>) -> Self

pub fn with_expected_future_notes(self, notes: Vec<NoteDetails>) -> Self

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

pub fn extend_merkle_store<T: IntoIterator<Item = InnerNodeInfo>>( self, iter: T, ) -> Self

pub fn consume_notes(note_ids: Vec<NoteId>) -> Self

Returns a new TransactionRequest for a transaction to consume the specified notes.

• note_ids is a list of note IDs to be consumed.

pub fn mint_fungible_asset( asset: FungibleAsset, target_id: AccountId, note_type: NoteType, rng: &mut impl FeltRng, ) -> Result<Self, TransactionRequestError>

Returns a new TransactionRequest for a transaction to mint fungible assets. This request must be executed against a fungible faucet account.

• asset is the fungible asset to be minted.
• target_id is the account ID of the account to receive the minted asset.
• note_type determines the visibility of the note to be created.
• rng is the random number generator used to generate the serial number for the created note.

pub fn pay_to_id( payment_data: PaymentTransactionData, recall_height: Option<u32>, note_type: NoteType, rng: &mut impl FeltRng, ) -> Result<Self, TransactionRequestError>

Returns a new TransactionRequest for a transaction to send a P2ID or P2IDR note. This request must be executed against the wallet sender account.

• payment_data is the data for the payment transaction that contains the asset to be transferred, the sender account ID, and the target account ID.
• recall_height is the block height after which the sender can recall the assets. If None, a P2ID note is created. If Some(), a P2IDR note is created.
• note_type determines the visibility of the note to be created.
• rng is the random number generator used to generate the serial number for the created note.

pub fn swap( swap_data: SwapTransactionData, note_type: NoteType, rng: &mut impl FeltRng, ) -> Result<Self, TransactionRequestError>

Returns a new TransactionRequest for a transaction to send a SWAP note. This request must be executed against the wallet sender account.

• swap_data is the data for the swap transaction that contains the sender account ID, the offered asset, and the requested asset.
• note_type determines the visibility of the note to be created.
• rng is the random number generator used to generate the serial number for the created note.

pub fn unauthenticated_input_notes(&self) -> &[Note]

pub fn unauthenticated_input_note_ids( &self, ) -> impl Iterator<Item = NoteId> + '_

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

pub fn input_notes(&self) -> &BTreeMap<NoteId, Option<NoteArgs>>

pub fn get_input_note_ids(&self) -> Vec<NoteId>

pub fn get_note_args(&self) -> BTreeMap<NoteId, NoteArgs>

pub fn expected_output_notes(&self) -> impl Iterator<Item = &Note>

pub fn expected_future_notes(&self) -> impl Iterator<Item = &NoteDetails>

pub fn script_template(&self) -> &Option<TransactionScriptTemplate>

pub fn advice_map(&self) -> &AdviceMap

pub fn merkle_store(&self) -> &MerkleStore

Trait Implementations

impl Clone for TransactionRequest

fn clone(&self) -> TransactionRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionRequest

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

Formats the value using the given formatter.

impl Default for TransactionRequest

fn default() -> Self

Returns the “default value” for a type.

impl Deserializable for TransactionRequest

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 TransactionRequest

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

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.