Struct TransactionContextBuilder

pub struct TransactionContextBuilder { /* private fields */ }

TransactionContextBuilder is a utility to construct TransactionContext for testing purposes. It allows users to build accounts, create notes, provide advice inputs, and execute code. The VM process can be inspected afterward.

Examples

Create a new account and execute code:

let tx_context = TransactionContextBuilder::with_existing_mock_account().build().unwrap();

let code = "
use.kernel::prologue
use.test::account

begin
    exec.prologue::prepare_transaction
    push.5
    swap drop
end
";

let process = tx_context.execute_code(code).unwrap();
assert_eq!(process.stack.get(0), Felt::new(5),);

Implementations

impl TransactionContextBuilder

pub fn new(account: Account) -> Self

pub fn with_existing_mock_account() -> Self

Initializes a TransactionContextBuilder with a mock account.

The wallet:

• Includes a series of mocked assets (miden_objects::asset::AssetVault::mock()).
• Has a nonce of 1 (so it does not imply seed validation).
• Has an ID of ACCOUNT_ID_REGULAR_PUBLIC_ACCOUNT_UPDATABLE_CODE.
• Has an account code based on an miden_objects::testing::account_component::AccountMockComponent.

pub fn with_noop_auth_account(nonce: Felt) -> Self

pub fn with_fungible_faucet( acct_id: u128, nonce: Felt, initial_balance: Felt, ) -> Self

Initializes a TransactionContextBuilder with a mocked fungible faucet.

pub fn with_non_fungible_faucet( acct_id: u128, nonce: Felt, empty_reserved_slot: bool, ) -> Self

Initializes a TransactionContextBuilder with a mocked non-fungible faucet.

pub fn assembler(&self) -> Assembler

Returns a clone of the assembler.

This is primarily useful to assemble a script whose source will end up in the source manager that is passed to the processor. This will help generate better error messages.

pub fn account_seed(self, account_seed: Option<Word>) -> Self

Override and set the account seed manually

pub fn extend_advice_inputs(self, advice_inputs: AdviceInputs) -> Self

Extend the advice inputs with the provided AdviceInputs instance.

pub fn extend_advice_map( self, map_entries: impl IntoIterator<Item = (Word, Vec<Felt>)>, ) -> Self

Extend the advice inputs map with the provided iterator.

pub fn authenticator( self, authenticator: Option<BasicAuthenticator<ChaCha20Rng>>, ) -> Self

Set the authenticator for the transaction (if needed)

pub fn foreign_accounts(self, inputs: Vec<AccountInputs>) -> Self

Set foreign account codes that are used by the transaction

pub fn extend_input_notes(self, input_notes: Vec<Note>) -> Self

Extend the set of used input notes

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

Set the desired transaction script

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

Set the transaction script argument

pub fn tx_inputs(self, tx_inputs: TransactionInputs) -> Self

Set the desired transaction inputs

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

Extend the note arguments map with the provided one.

pub fn extend_expected_output_notes(self, output_notes: Vec<OutputNote>) -> Self

Extend the expected output notes.

pub fn build(self) -> Result<TransactionContext>

Builds the TransactionContext.

If no transaction inputs were provided manually, an ad-hoc MockChain is created in order to generate valid block data for the required notes.

Trait Implementations

impl Default for TransactionContextBuilder

fn default() -> Self

Returns the “default value” for a type.