Struct MockTransactionBuilder 

pub struct MockTransactionBuilder<'chain> { /* private fields */ }

Available on crate feature testing only.

A builder for a MockTransaction that is coupled to a concrete MockChain.

It is the public entry point for executing a transaction against a chain and is created through MockChain::build_transaction. Input notes are added explicitly through Self::authenticated_input_note and Self::unauthenticated_input_note. The transaction inputs are only resolved against the chain in Self::build, once all input notes are known, by calling MockChain::get_transaction_inputs.

Examples

let mut builder = MockChain::builder();
let sender = builder.add_existing_mock_account(Auth::IncrNonce)?;
let account = builder.add_existing_mock_account(Auth::IncrNonce)?;
let note = builder.add_p2id_note(
    sender.id(),
    account.id(),
    &[FungibleAsset::mock(100)],
    NoteType::Public,
)?;
let chain = builder.build()?;

let executed = chain
    .build_transaction(account.id())
    .authenticated_input_note(note.id())
    .build()?
    .execute()
    .await?;

assert_eq!(executed.input_notes().num_notes(), 1);

Implementations

impl<'chain> MockTransactionBuilder<'chain>

pub fn authenticated_input_note( self, note_id: NoteId, ) -> MockTransactionBuilder<'chain>

Adds an authenticated input note that the transaction consumes.

The note must already be committed to the chain so that its inclusion proof can be resolved in Self::build.

pub fn authenticated_input_notes( self, note_ids: impl IntoIterator<Item = NoteId>, ) -> MockTransactionBuilder<'chain>

Adds multiple authenticated input notes that the transaction consumes.

This is the iterator equivalent of Self::authenticated_input_note.

pub fn unauthenticated_input_note( self, note: Note, ) -> MockTransactionBuilder<'chain>

Adds an unauthenticated input note that the transaction consumes.

Contrary to Self::authenticated_input_note, the note does not need to be committed to the chain.

pub fn unauthenticated_input_notes( self, notes: impl IntoIterator<Item = Note>, ) -> MockTransactionBuilder<'chain>

Adds multiple unauthenticated input notes that the transaction consumes.

This is the iterator equivalent of Self::unauthenticated_input_note.

pub fn reference_block( self, reference_block: impl Into<BlockNumber>, ) -> MockTransactionBuilder<'chain>

Sets the block the transaction executes against.

By default the transaction is built against the chain’s latest block. Use this to execute against an earlier block instead, e.g. to test block-height-dependent script logic such as timelocks or note expiration. All input notes must have been created at or before this block.

pub fn authenticator( self, authenticator: Option<BasicAuthenticator>, ) -> MockTransactionBuilder<'chain>

Set the authenticator for the transaction (if needed).

pub fn extend_advice_inputs( self, advice_inputs: AdviceInputs, ) -> MockTransactionBuilder<'chain>

Extends the advice inputs with the provided AdviceInputs instance.

pub fn add_advice_map_entry( self, key: Word, value: Vec<Felt>, ) -> MockTransactionBuilder<'chain>

Inserts a single key-value pair into the advice inputs map.

To add multiple entries, call this repeatedly or use Self::extend_advice_inputs.

pub fn foreign_accounts( self, inputs: impl IntoIterator<Item = (Account, AccountWitness)>, ) -> MockTransactionBuilder<'chain>

Sets foreign account inputs that are used by the transaction.

pub fn tx_script( self, tx_script: TransactionScript, ) -> MockTransactionBuilder<'chain>

Sets the desired transaction script.

pub fn tx_script_args( self, tx_script_args: Word, ) -> MockTransactionBuilder<'chain>

Sets the transaction script arguments.

pub fn send_notes_script( self, script: &SendNotesTransactionScript, ) -> MockTransactionBuilder<'chain>

Sets the transaction script and script arguments required to execute the provided SendNotesTransactionScript.

The script’s advice map entries are embedded in its MAST forest, so they load with the script and need not be set here.

pub fn auth_args(self, auth_args: Word) -> MockTransactionBuilder<'chain>

Sets the desired auth arguments.

pub fn extend_note_args( self, note_args: BTreeMap<NoteId, Word>, ) -> MockTransactionBuilder<'chain>

Extends the note arguments map with the provided one.

pub fn expected_output_note( self, output_note: RawOutputNote, ) -> MockTransactionBuilder<'chain>

Adds a single expected output note.

A RawOutputNote::Partial note is ignored, since it does not carry the recipient details required to reconstruct the note.

pub fn expected_output_notes( self, output_notes: Vec<RawOutputNote>, ) -> MockTransactionBuilder<'chain>

Extends the expected output notes.

This is the iterator equivalent of Self::expected_output_note.

pub fn add_signature( self, pub_key: PublicKeyCommitment, message: Word, signature: Signature, ) -> MockTransactionBuilder<'chain>

Adds a new signature for the message and the public key.

pub fn add_note_script( self, script: NoteScript, ) -> MockTransactionBuilder<'chain>

Adds a note script to the mock transaction for testing.

pub fn with_source_manager( self, source_manager: Arc<dyn SourceManagerSync>, ) -> MockTransactionBuilder<'chain>

Sets the SourceManagerSync on the MockTransaction that will be built.

This source manager should contain the sources of all involved scripts and account code in order to provide better error messages if an error occurs.

pub fn build(self) -> Result<MockTransaction, Error>

Builds the MockTransaction.

The configured account and input notes are resolved into TransactionInputs against the Self::reference_block (defaulting to the chain’s latest block) through MockChain::get_transaction_inputs, and the remaining configuration is assembled into the MockTransaction.

Trait Implementations

impl<'chain> Clone for MockTransactionBuilder<'chain>

fn clone(&self) -> MockTransactionBuilder<'chain>

Returns a duplicate of the value.

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

Performs copy-assignment from source.