Enum SendNotesTransactionScript 

#[non_exhaustive]
pub enum SendNotesTransactionScript {
    Wallet(SendWalletNotesTransactionScript),
    Fungible(SendFungibleFaucetNotesTransactionScript),
    NonFungible(SendNonFungibleFaucetNotesTransactionScript),
}

A send_notes TransactionScript for an account, abstracting over the concrete script that the account’s code interface calls for.

Each variant wraps the dedicated type for one canonical script. Use Self::new to let the account’s interface decide, or construct a concrete type directly when the kind is known.

The script is picked from the interfaces the account exposes, cross-checked against the composition of the assets being sent: a faucet script is built only for notes its faucet can mint, and any other notes are sent with the BasicWallet script.

Example

let script = SendNotesTransactionScript::new(&interface, &notes)?;

let tx_args = TransactionArgs::new(AdviceMap::default())
    .with_tx_script_and_args(script.tx_script().clone(), script.tx_script_args());

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Wallet(SendWalletNotesTransactionScript)

Sends notes holding assets the account already owns.

Fungible(SendFungibleFaucetNotesTransactionScript)

Sends notes holding assets the fungible faucet mints as part of note creation.

NonFungible(SendNonFungibleFaucetNotesTransactionScript)

Sends notes holding assets the non-fungible faucet mints as part of note creation.

Implementations

impl SendNotesTransactionScript

pub const PAYLOAD_HEADER_NUM_ELEMENTS: usize = 4

Number of elements in the payload header word: [num_notes, expiration_delta, 0, 0].

See encode_payload for the full payload layout.

pub const NOTE_RECORD_NUM_ASSETS_OFFSET: usize = 6

Element offset of the asset count within a note record, after the RECIPIENT word and the tag and note_type elements.

See encode_payload for the full payload layout.

pub const NOTE_RECORD_ITEMS_OFFSET: usize = 8

Element offset of the first asset or attachment item within a note record, after the RECIPIENT word and the metadata word.

See encode_payload for the full payload layout.

pub const ITEM_NUM_ELEMENTS: usize = 8

Number of elements a single asset or attachment item occupies (two words).

See encode_payload for the full payload layout.

pub fn new( interface: &AccountCodeInterface, output_notes: &[PartialNote], ) -> Result<Self, SendNotesTransactionScriptError>

Builds the send_notes script that the account described by interface calls for, without an expiration delta.

See Self::with_expiration_delta for the variant that pins the transaction to a reference-block delta.

Errors

Returns an error if the interface exposes none of the wallet, fungible faucet or non-fungible faucet procedures, or if the notes fail the selected script’s validation.

pub fn with_expiration_delta( interface: &AccountCodeInterface, output_notes: &[PartialNote], expiration_delta: NonZeroU16, ) -> Result<Self, SendNotesTransactionScriptError>

Builds the send_notes script that the account described by interface calls for, with the given non-zero expiration delta.

The delta specifies how close to the transaction’s reference block the transaction must be included into the chain. For example, with a reference block of 100 and a delta of 10, the transaction must be included by block 110.

Errors

See Self::new.

pub fn tx_script(&self) -> &TransactionScript

The underlying TransactionScript, to be set as the transaction’s script.

pub fn tx_script_args(&self) -> Word

The transaction script argument the script reads its payload commitment from.

Pass this as the transaction’s TX_SCRIPT_ARGS.

pub fn script_roots() -> [TransactionScriptRoot; 3]

The TransactionScriptRoots of every canonical send_notes script.

Allowlisting all of them covers any account this type can build a script for.

Trait Implementations

impl Clone for SendNotesTransactionScript

fn clone(&self) -> SendNotesTransactionScript

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SendNotesTransactionScript

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

Formats the value using the given formatter.