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_standard_account(Felt::ONE).build();

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_standard_account(nonce: Felt) -> Self

Initializes a TransactionContextBuilder with a mocked standard wallet.

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 account_seed(self, account_seed: Option<Word>) -> Self

Override and set the account seed manually

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

Override and set the AdviceInputs

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 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_inputs(self, tx_inputs: TransactionInputs) -> Self

Set the desired transaction inputs

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

Defines the expected output notes

pub fn with_mock_notes_too_few_input(self) -> Self

Adds a set of input notes that output notes where inputs are smaller than needed and do not add up to match the output.

pub fn with_mock_notes_preserved(self) -> Self

Adds a set of input notes that output notes in an asset-preserving manner.

pub fn with_mock_notes_preserved_with_account_vault_delta(self) -> Self

pub fn with_mock_notes_too_many_fungible_input(self) -> Self

pub fn with_mock_notes_too_many_non_fungible_input(self) -> Self

pub fn build(self) -> 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.