miden_testing/mock_chain/

chain_builder.rs

use alloc::collections::{BTreeMap, BTreeSet};
use alloc::vec::Vec;

use anyhow::Context;

// CONSTANTS
// ================================================================================================

/// Default number of decimals for faucets created in tests.
const DEFAULT_FAUCET_DECIMALS: u8 = 10;

/// Default number of validators committed to by the genesis block of a mock chain.
///
/// This is purely a test default -- the protocol does not fix the size of a validator set.
const DEFAULT_VALIDATOR_COUNT: usize = 3;

// IMPORTS
// ================================================================================================

use itertools::Itertools;
use miden_processor::crypto::random::RandomCoin;
use miden_protocol::account::{
    Account,
    AccountBuilder,
    AccountComponent,
    AccountId,
    AccountPatch,
    AccountType,
    AccountUpdateDetails,
    StorageSlot,
};
use miden_protocol::asset::{Asset, AssetAmount, AssetId, FungibleAsset, TokenSymbol};
use miden_protocol::block::account_tree::AccountTree;
use miden_protocol::block::nullifier_tree::NullifierTree;
use miden_protocol::block::{
    BlockAccountUpdate,
    BlockBody,
    BlockHeader,
    BlockNoteTree,
    BlockNumber,
    BlockSignatures,
    Blockchain,
    FeeParameters,
    OutputNoteBatch,
    ProvenBlock,
    ValidatorConfig,
};
use miden_protocol::crypto::dsa::ecdsa_k256_keccak::SigningKey;
use miden_protocol::crypto::merkle::smt::Smt;
use miden_protocol::errors::NoteError;
use miden_protocol::note::{Note, NoteDetails, NoteScriptRoot, NoteType};
use miden_protocol::protocol_config::ProtocolConfig;
use miden_protocol::testing::account_id::ACCOUNT_ID_FEE_FAUCET;
use miden_protocol::testing::random_secret_key::random_secret_key;
use miden_protocol::transaction::{OrderedTransactionHeaders, RawOutputNote};
use miden_protocol::{MAX_OUTPUT_NOTES_PER_BATCH, Word};
use miden_standards::account::access::{AccessControl, Authority, Pausable, PausableManager};
use miden_standards::account::auth::{AuthNetworkAccount, SponsorshipPolicy};
use miden_standards::account::faucets::{FungibleFaucet, NonFungibleFaucet, TokenName};
use miden_standards::account::fees::{BasicConstantFeePolicy, FeePolicyManager};
use miden_standards::account::note_creator::NoteCreator;
use miden_standards::account::policies::{
    BurnPolicy,
    MintPolicy,
    TokenPolicyManager,
    TransferPolicy,
};
use miden_standards::account::wallets::BasicWallet;
use miden_standards::note::{BurnNote, MintNote, P2idNote, P2ideNote, SwapNote, TxFeeNote};
use miden_standards::testing::account_component::MockAccountComponent;
use rand::RngExt;

use crate::mock_chain::chain::AccountAuthenticator;
use crate::utils::{create_p2any_note, create_spawn_note};
use crate::{AccountState, Auth, MockChain};

/// A builder for a [`MockChain`]'s genesis block.
///
/// ## Example
///
/// ```
/// # use anyhow::Result;
/// # use miden_protocol::{
/// #    asset::{Asset, FungibleAsset},
/// #    note::NoteType,
/// # };
/// # use miden_testing::{Auth, MockChain};
/// #
/// # fn main() -> Result<()> {
/// let mut builder = MockChain::builder();
/// let existing_wallet =
///     builder.add_existing_wallet_with_assets(Auth::IncrNonce, [FungibleAsset::mock(500)])?;
/// let new_wallet = builder.create_new_wallet(Auth::IncrNonce)?;
///
/// let existing_note = builder.add_p2id_note(
///     existing_wallet.id(),
///     new_wallet.id(),
///     &[FungibleAsset::mock(100)],
///     NoteType::Private,
/// )?;
/// let chain = builder.build()?;
///
/// // The existing wallet and note should be part of the chain state.
/// assert!(chain.committed_account(existing_wallet.id()).is_ok());
/// assert!(chain.committed_notes().get(&existing_note.id()).is_some());
///
/// // The new wallet should *not* be part of the chain state - it must be created in
/// // a transaction first.
/// assert!(chain.committed_account(new_wallet.id()).is_err());
///
/// # Ok(())
/// # }
/// ```
///
/// Note the distinction between `add_` and `create_` APIs. Any `add_` APIs will add something to
/// the genesis chain state while `create_` APIs do not mutate the genesis state. The latter are
/// simply convenient for creating accounts or notes that will be created by transactions.
///
/// See also the [`MockChain`] docs for examples on using the mock chain.
#[derive(Debug, Clone)]
pub struct MockChainBuilder {
    accounts: BTreeMap<AccountId, Account>,
    account_authenticators: BTreeMap<AccountId, AccountAuthenticator>,
    notes: Vec<RawOutputNote>,
    rng: RandomCoin,
    validator_signing_keys: Option<Vec<SigningKey>>,
    // Fee parameters.
    fee_faucet_id: AccountId,
    verification_base_fee: u32,
}

impl MockChainBuilder {
    // CONSTRUCTORS
    // ----------------------------------------------------------------------------------------

    /// Initializes a new mock chain builder with an empty state.
    ///
    /// By default, the `fee_faucet_id` is set to [`ACCOUNT_ID_FEE_FAUCET`] and can be
    /// overwritten using [`Self::fee_faucet_id`].
    ///
    /// The `verification_base_fee` is initialized to 0 which means no fees are required by default.
    ///
    /// By default, three random validator signing keys are generated when building the chain.
    /// Use [`Self::validator_signing_keys`] to supply the keys instead.
    pub fn new() -> Self {
        let fee_faucet_id = ACCOUNT_ID_FEE_FAUCET.try_into().expect("account ID should be valid");

        Self {
            accounts: BTreeMap::new(),
            account_authenticators: BTreeMap::new(),
            notes: Vec::new(),
            rng: RandomCoin::new(Default::default()),
            validator_signing_keys: None,
            fee_faucet_id,
            verification_base_fee: 0,
        }
    }

    /// Initializes a new mock chain builder with the provided accounts.
    ///
    /// This method only adds the accounts and cannot not register any authenticators for them.
    /// Calling [`MockChain::build_transaction`] on accounts added in this way will not work if the
    /// account needs an authenticator.
    ///
    /// Due to these limitations, prefer using other methods to add accounts to the chain, e.g.
    /// [`MockChainBuilder::add_account_from_builder`].
    pub fn with_accounts(accounts: impl IntoIterator<Item = Account>) -> anyhow::Result<Self> {
        let mut builder = Self::new();

        for account in accounts {
            builder.add_account(account)?;
        }

        Ok(builder)
    }

    // BUILDER METHODS
    // ----------------------------------------------------------------------------------------

    /// Sets the fee faucet ID of the chain.
    ///
    /// This must be a fungible faucet [`AccountId`] and is the asset in which fees will be accepted
    /// by the transaction kernel.
    pub fn fee_faucet_id(mut self, fee_faucet_id: AccountId) -> Self {
        self.fee_faucet_id = fee_faucet_id;
        self
    }

    /// Sets the `verification_base_fee` of the chain.
    ///
    /// See [`FeeParameters`] for more details.
    pub fn verification_base_fee(mut self, verification_base_fee: u32) -> Self {
        self.verification_base_fee = verification_base_fee;
        self
    }

    /// Sets the validator signing keys for genesis and subsequent blocks, until validator rotation.
    ///
    /// By default, three random keys are generated. Supplied keys may be in any order; the genesis
    /// [`ValidatorConfig`] and signatures follow the config's canonical public key order. All keys
    /// must sign each block.
    ///
    /// [`Self::build`] returns an error if the set is empty, contains duplicate keys, or exceeds
    /// [`ValidatorConfig::MAX_VALIDATORS`].
    pub fn validator_signing_keys(mut self, keys: Vec<SigningKey>) -> Self {
        self.validator_signing_keys = Some(keys);
        self
    }

    /// Consumes the builder, creates the genesis block of the chain and returns the [`MockChain`].
    pub fn build(self) -> anyhow::Result<MockChain> {
        // Create the genesis block, consisting of the provided accounts and notes.
        let block_account_updates: Vec<BlockAccountUpdate> = self
            .accounts
            .into_values()
            .map(|account| {
                let account_id = account.id();
                let account_commitment = account.to_commitment();
                let update_details = if account_id.is_private() {
                    AccountUpdateDetails::Private
                } else {
                    let account_patch = AccountPatch::try_from(account)
                        .expect("chain builder should only store existing accounts without seeds");
                    AccountUpdateDetails::Public(account_patch)
                };

                BlockAccountUpdate::new(account_id, account_commitment, update_details)
            })
            .collect::<Result<_, _>>()?;

        let account_tree = AccountTree::with_entries(
            block_account_updates
                .iter()
                .map(|account| (account.account_id(), account.final_state_commitment())),
        )
        .context("failed to create genesis account tree")?;

        // Extract full notes before shrinking for later use in MockChain
        let full_notes: Vec<Note> = self
            .notes
            .iter()
            .filter_map(|note| match note {
                RawOutputNote::Full(n) => Some(n.clone()),
                _ => None,
            })
            .collect();

        let proven_notes: Vec<_> = self
            .notes
            .into_iter()
            .map(|note| note.into_output_note().expect("genesis note should be valid"))
            .collect();
        let note_chunks = proven_notes.into_iter().chunks(MAX_OUTPUT_NOTES_PER_BATCH);
        let output_note_batches: Vec<OutputNoteBatch> = note_chunks
            .into_iter()
            .map(|batch_notes| batch_notes.into_iter().enumerate().collect::<Vec<_>>())
            .collect();

        let created_nullifiers = Vec::new();
        let transactions = OrderedTransactionHeaders::new_unchecked(Vec::new());

        let note_tree = BlockNoteTree::from_note_batches(&output_note_batches)
            .context("failed to create block note tree")?;

        let prev_block_commitment = Word::empty();
        let block_num = BlockNumber::from(0u32);
        let chain_commitment = Blockchain::new().commitment();
        let account_root = account_tree.root();
        let nullifier_root = NullifierTree::<Smt>::default().root();
        let note_root = note_tree.root();
        let tx_commitment = transactions.commitment();
        let timestamp = MockChain::TIMESTAMP_START_SECS;
        let fee_parameters = FeeParameters::new(self.verification_base_fee);
        let protocol_config = ProtocolConfig::current(AssetId::new_fungible(self.fee_faucet_id))
            .context("failed to build the genesis protocol config")?;
        let validator_secret_keys = self
            .validator_signing_keys
            .unwrap_or_else(|| (0..DEFAULT_VALIDATOR_COUNT).map(|_| random_secret_key()).collect());
        let quorum = u16::try_from(validator_secret_keys.len())
            .context("genesis validator count exceeds u16::MAX")?;
        let validator_config = ValidatorConfig::new(
            validator_secret_keys.iter().map(|signer| signer.public_key()).collect(),
            quorum,
        )
        .context("failed to build the genesis validator config")?;

        let header = BlockHeader::new(
            prev_block_commitment,
            block_num,
            chain_commitment,
            account_root,
            nullifier_root,
            note_root,
            tx_commitment,
            validator_config.clone(),
            fee_parameters,
            protocol_config.to_commitment(),
            None,
            timestamp,
        );

        let body = BlockBody::new_unchecked(
            block_account_updates,
            output_note_batches,
            created_nullifiers,
            transactions,
        );

        // The genesis block is the trust root: it is self-signed by the validator set it commits
        // as the signer of block 1.
        let signatures = BlockSignatures::new(
            validator_config
                .keys()
                .iter()
                .map(|key| {
                    let signer = validator_secret_keys
                        .iter()
                        .find(|sk| &sk.public_key() == key)
                        .expect("a signer should exist for every validator key");
                    signer.sign(header.commitment())
                })
                .collect(),
        )
        .expect("signature count same as validator key count");
        let block_proof = miden_protocol::testing::dummy_execution_proof();
        let genesis_block = ProvenBlock::new_unchecked(header, body, signatures, block_proof);

        MockChain::from_genesis_block(
            genesis_block,
            account_tree,
            self.account_authenticators,
            validator_secret_keys,
            protocol_config,
            full_notes,
        )
    }

    // ACCOUNT METHODS
    // ----------------------------------------------------------------------------------------

    /// Creates a new public [`BasicWallet`] account and registers the authenticator (if any) for
    /// it.
    ///
    /// This does not add the account to the chain state, but it can still be used to call
    /// [`MockChain::build_transaction`] to automatically add the authenticator.
    pub fn create_new_wallet(&mut self, auth_method: Auth) -> anyhow::Result<Account> {
        let account_builder = AccountBuilder::new(self.rng.random())
            .account_type(AccountType::Public)
            .with_component(BasicWallet);

        self.add_account_from_builder(auth_method, account_builder, AccountState::New)
    }

    /// Adds an existing public [`BasicWallet`] account to the initial chain state and registers the
    /// authenticator (if any).
    pub fn add_existing_wallet(&mut self, auth_method: Auth) -> anyhow::Result<Account> {
        self.add_existing_wallet_with_assets(auth_method, [])
    }

    /// Adds an existing public [`BasicWallet`] account to the initial chain state and registers the
    /// authenticator (if any).
    pub fn add_existing_wallet_with_assets(
        &mut self,
        auth_method: Auth,
        assets: impl IntoIterator<Item = Asset>,
    ) -> anyhow::Result<Account> {
        let account_builder = Account::builder(self.rng.random())
            .account_type(AccountType::Public)
            .with_component(BasicWallet)
            .with_assets(assets);

        self.add_account_from_builder(auth_method, account_builder, AccountState::Exists)
    }

    /// Adds an existing public [`NoteCreator`] account to the initial chain state and registers the
    /// authenticator (if any).
    ///
    /// Unlike [`add_existing_wallet`](Self::add_existing_wallet), the account exposes only the
    /// `create_note` procedure, which is enough for tests that only create output notes.
    pub fn add_existing_note_creator(&mut self, auth_method: Auth) -> anyhow::Result<Account> {
        let account_builder = Account::builder(self.rng.random())
            .account_type(AccountType::Public)
            .with_component(NoteCreator);

        self.add_account_from_builder(auth_method, account_builder, AccountState::Exists)
    }

    /// Internal helper: adds an existing network-style fungible faucet (Ownable2Step / Rbac).
    /// Bundles [`PausableManager`] to match the `create_network_fungible_faucet` factory.
    fn add_existing_network_fungible_faucet(
        &mut self,
        allowed_script_roots: BTreeSet<NoteScriptRoot>,
        faucet: FungibleFaucet,
        account_type: AccountType,
        access_control: AccessControl,
        token_policy_manager: TokenPolicyManager,
        assets: Vec<Asset>,
    ) -> anyhow::Result<Account> {
        // network faucets authenticate with AuthNetworkAccount, which collects sponsored fees and
        // answers sponsorship fee estimates; both require an active fee policy. A constant policy
        // aborts fee estimation for note scripts without a schedule entry, so schedule an explicit
        // 0 fee for every allowlisted note; this keeps fees a no-op on fee-free chains.
        let mut basic_constant_fee_policy = BasicConstantFeePolicy::new();
        for note_script in &allowed_script_roots {
            basic_constant_fee_policy =
                basic_constant_fee_policy.with_fee(*note_script, AssetAmount::ZERO);
        }
        // `AuthNetworkAccount::new` allowlists its default notes on top, which the network auth
        // flow prices if they are ever consumed, so schedule them too.
        for note_script in AuthNetworkAccount::default_allowed_note_scripts() {
            basic_constant_fee_policy =
                basic_constant_fee_policy.with_fee(note_script, AssetAmount::ZERO);
        }

        let fee_policy_manager = FeePolicyManager::builder()
            .active_fee_policy(basic_constant_fee_policy.into())
            .fee_faucet_id(self.fee_faucet_id)
            .build();

        let account_builder = AccountBuilder::new(self.rng.random())
            .account_type(account_type)
            .with_component(faucet)
            .with_components(access_control)
            .with_components(token_policy_manager)
            .with_component(Pausable::unpaused())
            .with_component(PausableManager)
            .with_assets(assets);

        let auth = Auth::NetworkAccount {
            allowed_script_roots,
            allowed_tx_script_roots: BTreeSet::new(),
            fee_policy_manager,
            sponsorship_policy: SponsorshipPolicy::default(),
        };

        self.add_account_from_builder(auth, account_builder, AccountState::Exists)
    }

    /// Convenience: builds a basic auth-controlled fungible faucet from a token-symbol shorthand
    /// using default decimals and `AllowAll` policies, then adds it as an existing account with
    /// [`Authority::AuthControlled`].
    ///
    /// The faucet installs only `AllowAll` mint and burn policies and no transfer policy, so its
    /// account ID has asset callbacks disabled and its assets transfer freely without triggering a
    /// faucet callback. For a faucet with transfer policies (and thus callbacks), construct a
    /// [`FungibleFaucet`] with a [`TokenPolicyManager`] manually and use [`AccountBuilder`]
    /// directly.
    pub fn add_existing_basic_faucet(
        &mut self,
        auth_method: Auth,
        token_symbol: &str,
        max_supply: u64,
        token_supply: Option<u64>,
    ) -> anyhow::Result<Account> {
        let token_supply = token_supply.unwrap_or(0);
        let name = TokenName::new(token_symbol)?;
        let symbol = TokenSymbol::new(token_symbol)
            .with_context(|| format!("invalid token symbol: {token_symbol}"))?;
        let max_supply = AssetAmount::new(max_supply).context("invalid max_supply")?;
        let token_supply = AssetAmount::new(token_supply).context("invalid token_supply")?;
        let faucet = FungibleFaucet::builder()
            .name(name)
            .symbol(symbol)
            .decimals(DEFAULT_FAUCET_DECIMALS)
            .max_supply(max_supply)
            .token_supply(token_supply)
            .build()
            .context("failed to build FungibleFaucet")?;

        let token_policy_manager = TokenPolicyManager::builder()
            .active_mint_policy(MintPolicy::allow_all())
            .active_burn_policy(BurnPolicy::allow_all())
            .build();

        let account_builder = AccountBuilder::new(self.rng.random())
            .account_type(AccountType::Public)
            .with_component(faucet)
            .with_component(Authority::AuthControlled)
            .with_components(token_policy_manager)
            .with_component(Pausable::unpaused())
            .with_component(PausableManager);

        self.add_account_from_builder(auth_method, account_builder, AccountState::Exists)
    }

    /// Convenience: builds a non-fungible faucet from a token-symbol shorthand using `AllowAll`
    /// policies, then adds it as an existing account with [`Authority::AuthControlled`].
    ///
    /// Being auth-controlled, the faucet is not a network faucet, so `mint_and_send` can be called
    /// from a transaction script. Its transfer policies enable asset callbacks.
    pub fn add_existing_non_fungible_faucet(
        &mut self,
        auth_method: Auth,
        token_symbol: &str,
    ) -> anyhow::Result<Account> {
        let name = TokenName::new(token_symbol)?;
        let symbol = TokenSymbol::new(token_symbol)
            .with_context(|| format!("invalid token symbol: {token_symbol}"))?;
        let faucet = NonFungibleFaucet::builder().name(name).symbol(symbol).build();

        let token_policy_manager = TokenPolicyManager::builder()
            .active_mint_policy(MintPolicy::allow_all())
            .active_burn_policy(BurnPolicy::allow_all())
            .active_send_policy(TransferPolicy::allow_all())
            .active_receive_policy(TransferPolicy::allow_all())
            .build();

        let account_builder = AccountBuilder::new(self.rng.random())
            .account_type(AccountType::Public)
            .with_component(faucet)
            .with_component(Authority::AuthControlled)
            .with_components(token_policy_manager)
            .with_component(Pausable::unpaused());

        self.add_account_from_builder(auth_method, account_builder, AccountState::Exists)
    }

    /// Convenience: builds an owner-controlled (network-style) fungible faucet from a
    /// token-symbol shorthand using default decimals, the given `mint_policy`, and `BurnAllowAll`.
    ///
    /// The faucet is added with [`AccountType::Public`] and [`Auth::IncrNonce`].
    ///
    /// `mint_policy` selects the initial active mint policy on the faucet. The installed
    /// [`TokenPolicyManager`] is always owner-controlled.
    ///
    /// The [`MintNote`] and [`BurnNote`] script roots are always added to `allowed_script_roots`,
    /// so callers only need to provide any additional roots their test scripts require.
    pub fn add_existing_network_faucet(
        &mut self,
        token_symbol: &str,
        max_supply: u64,
        owner_account_id: AccountId,
        token_supply: Option<u64>,
        mint_policy: MintPolicy,
        allowed_script_roots: impl IntoIterator<Item = NoteScriptRoot>,
    ) -> anyhow::Result<Account> {
        self.add_existing_network_faucet_with_assets(
            token_symbol,
            max_supply,
            owner_account_id,
            token_supply,
            mint_policy,
            allowed_script_roots,
            [],
        )
    }

    /// Same as [`Self::add_existing_network_faucet`], but the faucet's vault additionally holds
    /// `assets` (e.g. the native fee asset, so the faucet can pay transaction fees).
    #[allow(clippy::too_many_arguments)]
    pub fn add_existing_network_faucet_with_assets(
        &mut self,
        token_symbol: &str,
        max_supply: u64,
        owner_account_id: AccountId,
        token_supply: Option<u64>,
        mint_policy: MintPolicy,
        allowed_script_roots: impl IntoIterator<Item = NoteScriptRoot>,
        assets: impl IntoIterator<Item = Asset>,
    ) -> anyhow::Result<Account> {
        let token_supply = token_supply.unwrap_or(0);
        let name = TokenName::new(token_symbol)?;
        let symbol = TokenSymbol::new(token_symbol)
            .with_context(|| format!("invalid token symbol: {token_symbol}"))?;
        let max_supply = AssetAmount::new(max_supply).context("invalid max_supply")?;
        let token_supply = AssetAmount::new(token_supply).context("invalid token_supply")?;
        let faucet = FungibleFaucet::builder()
            .name(name)
            .symbol(symbol)
            .decimals(DEFAULT_FAUCET_DECIMALS)
            .max_supply(max_supply)
            .token_supply(token_supply)
            .build()
            .context("failed to build FungibleFaucet")?;

        let token_policy_manager = TokenPolicyManager::builder()
            .active_mint_policy(mint_policy)
            .active_burn_policy(BurnPolicy::allow_all())
            .active_send_policy(TransferPolicy::allow_all())
            .active_receive_policy(TransferPolicy::allow_all())
            .build();

        let allowed_script_roots: BTreeSet<NoteScriptRoot> = allowed_script_roots
            .into_iter()
            .chain([MintNote::script_root(), BurnNote::script_root()])
            .collect();

        self.add_existing_network_fungible_faucet(
            allowed_script_roots,
            faucet,
            AccountType::Public,
            AccessControl::Ownable2Step { owner: owner_account_id },
            token_policy_manager,
            assets.into_iter().collect(),
        )
    }

    /// Convenience: adds an existing owner-controlled (network-style) fungible faucet whose token
    /// metadata is fully provided by the caller. Uses `OwnerOnly` mint policy and `AllowAll`
    /// burn policy by default.
    ///
    /// The [`MintNote`] and [`BurnNote`] script roots are always added to `allowed_script_roots`,
    /// so callers only need to provide any additional roots their test scripts require.
    pub fn add_existing_network_faucet_with_metadata(
        &mut self,
        owner_account_id: AccountId,
        faucet: FungibleFaucet,
        allowed_script_roots: impl IntoIterator<Item = NoteScriptRoot>,
    ) -> anyhow::Result<Account> {
        let token_policy_manager = TokenPolicyManager::builder()
            .active_mint_policy(MintPolicy::owner_only())
            .active_burn_policy(BurnPolicy::allow_all())
            .active_send_policy(TransferPolicy::allow_all())
            .active_receive_policy(TransferPolicy::allow_all())
            .build();

        let allowed_script_roots: BTreeSet<NoteScriptRoot> = allowed_script_roots
            .into_iter()
            .chain([MintNote::script_root(), BurnNote::script_root()])
            .collect();

        self.add_existing_network_fungible_faucet(
            allowed_script_roots,
            faucet,
            AccountType::Public,
            AccessControl::Ownable2Step { owner: owner_account_id },
            token_policy_manager,
            Vec::new(),
        )
    }

    /// Convenience: builds a new (uncreated) basic auth-controlled fungible faucet from a
    /// token-symbol shorthand using default decimals and `AllowAll` mint/burn policies (no transfer
    /// policy, so asset callbacks are disabled).
    pub fn create_new_faucet(
        &mut self,
        auth_method: Auth,
        token_symbol: &str,
        max_supply: u64,
    ) -> anyhow::Result<Account> {
        let name = TokenName::new(token_symbol)?;
        let symbol = TokenSymbol::new(token_symbol)
            .with_context(|| format!("invalid token symbol: {token_symbol}"))?;
        let max_supply = AssetAmount::new(max_supply).context("invalid max_supply")?;
        let faucet = FungibleFaucet::builder()
            .name(name)
            .symbol(symbol)
            .decimals(DEFAULT_FAUCET_DECIMALS)
            .max_supply(max_supply)
            .build()
            .context("failed to build FungibleFaucet")?;

        let token_policy_manager = TokenPolicyManager::builder()
            .active_mint_policy(MintPolicy::allow_all())
            .active_burn_policy(BurnPolicy::allow_all())
            .build();

        let account_builder = AccountBuilder::new(self.rng.random())
            .account_type(AccountType::Public)
            .with_component(faucet)
            .with_component(Authority::AuthControlled)
            .with_components(token_policy_manager)
            .with_component(Pausable::unpaused())
            .with_component(PausableManager);

        self.add_account_from_builder(auth_method, account_builder, AccountState::New)
    }

    /// Creates a new public account with an [`MockAccountComponent`] and registers the
    /// authenticator (if any).
    pub fn create_new_mock_account(&mut self, auth_method: Auth) -> anyhow::Result<Account> {
        let account_builder = Account::builder(self.rng.random())
            .account_type(AccountType::Public)
            .with_component(MockAccountComponent::with_empty_slots());

        self.add_account_from_builder(auth_method, account_builder, AccountState::New)
    }

    /// Adds an existing public account with an [`MockAccountComponent`] to the initial chain state
    /// and registers the authenticator (if any).
    pub fn add_existing_mock_account(&mut self, auth_method: Auth) -> anyhow::Result<Account> {
        self.add_existing_mock_account_with_storage_and_assets(auth_method, [], [])
    }

    /// Adds an existing public account with an [`MockAccountComponent`] to the initial chain state
    /// and registers the authenticator (if any).
    pub fn add_existing_mock_account_with_storage(
        &mut self,
        auth_method: Auth,
        slots: impl IntoIterator<Item = StorageSlot>,
    ) -> anyhow::Result<Account> {
        self.add_existing_mock_account_with_storage_and_assets(auth_method, slots, [])
    }

    /// Adds an existing public account with an [`MockAccountComponent`] to the initial chain state
    /// and registers the authenticator (if any).
    pub fn add_existing_mock_account_with_assets(
        &mut self,
        auth_method: Auth,
        assets: impl IntoIterator<Item = Asset>,
    ) -> anyhow::Result<Account> {
        self.add_existing_mock_account_with_storage_and_assets(auth_method, [], assets)
    }

    /// Adds an existing public account with an [`MockAccountComponent`] to the initial chain state
    /// and registers the authenticator (if any).
    pub fn add_existing_mock_account_with_storage_and_assets(
        &mut self,
        auth_method: Auth,
        slots: impl IntoIterator<Item = StorageSlot>,
        assets: impl IntoIterator<Item = Asset>,
    ) -> anyhow::Result<Account> {
        let account_builder = Account::builder(self.rng.random())
            .account_type(AccountType::Public)
            .with_component(MockAccountComponent::with_slots(slots.into_iter().collect()))
            .with_assets(assets);

        self.add_account_from_builder(auth_method, account_builder, AccountState::Exists)
    }

    /// Builds the provided [`AccountBuilder`] with the provided auth method and registers the
    /// authenticator (if any).
    ///
    /// - If [`AccountState::Exists`] is given the account is built as an existing account and added
    ///   to the initial chain state. It can then be used in a transaction without having to
    ///   validate its seed.
    /// - If [`AccountState::New`] is given the account is built as a new account and is **not**
    ///   added to the chain. Its authenticator is registered (if present). Its first transaction
    ///   will be its creation transaction. [`MockChain::build_transaction`] can be called with the
    ///   account to automatically add the authenticator.
    pub fn add_account_from_builder(
        &mut self,
        auth_method: Auth,
        mut account_builder: AccountBuilder,
        account_state: AccountState,
    ) -> anyhow::Result<Account> {
        let (auth_components, authenticator) = auth_method.build_components();
        account_builder = account_builder.with_components(auth_components);

        let account = if let AccountState::New = account_state {
            account_builder.build().context("failed to build account from builder")?
        } else {
            account_builder
                .build_existing()
                .context("failed to build account from builder")?
        };

        self.account_authenticators
            .insert(account.id(), AccountAuthenticator::new(authenticator));

        if let AccountState::Exists = account_state {
            self.accounts.insert(account.id(), account.clone());
        }

        Ok(account)
    }
    pub fn add_existing_account_from_components(
        &mut self,
        auth: Auth,
        components: impl IntoIterator<Item = AccountComponent>,
    ) -> anyhow::Result<Account> {
        let mut account_builder =
            Account::builder(rand::rng().random()).account_type(AccountType::Public);

        for component in components {
            account_builder = account_builder.with_component(component);
        }

        self.add_account_from_builder(auth, account_builder, AccountState::Exists)
    }

    /// Adds the provided account to the list of genesis accounts.
    ///
    /// This method only adds the account and does not store its account authenticator for it.
    /// Calling [`MockChain::build_transaction`] on accounts added in this way will not work if
    /// the account needs an authenticator.
    ///
    /// Due to these limitations, prefer using other methods to add accounts to the chain, e.g.
    /// [`MockChainBuilder::add_account_from_builder`].
    pub fn add_account(&mut self, account: Account) -> anyhow::Result<()> {
        self.accounts.insert(account.id(), account);

        // This returns a Result to be conservative in case we need to return an error in the future
        // and do not want to break this API.
        Ok(())
    }

    // NOTE ADD METHODS
    // ----------------------------------------------------------------------------------------

    /// Adds the provided note to the initial chain state.
    pub fn add_output_note(&mut self, note: impl Into<RawOutputNote>) {
        self.notes.push(note.into());
    }

    /// Creates a new P2ANY note from the provided parameters and adds it to the list of
    /// genesis notes.
    ///
    /// This note is similar to a P2ID note but can be consumed by any account.
    pub fn add_p2any_note(
        &mut self,
        sender_account_id: AccountId,
        note_type: NoteType,
        assets: impl IntoIterator<Item = Asset>,
    ) -> anyhow::Result<Note> {
        let note = create_p2any_note(sender_account_id, note_type, assets, &mut self.rng);
        self.add_output_note(RawOutputNote::Full(note.clone()));

        Ok(note)
    }

    /// Creates a new P2ID note from the provided parameters and adds it to the list of genesis
    /// notes.
    ///
    /// In the created [`MockChain`], the note will be immediately spendable by `target_account_id`
    /// and carries no additional reclaim or timelock conditions.
    pub fn add_p2id_note(
        &mut self,
        sender_account_id: AccountId,
        target_account_id: AccountId,
        asset: &[Asset],
        note_type: NoteType,
    ) -> Result<Note, NoteError> {
        let note: Note = P2idNote::builder()
            .sender(sender_account_id)
            .target(target_account_id)
            .assets(asset.iter().copied())
            .note_type(note_type)
            .generate_serial_number(&mut self.rng)
            .build()?
            .into();
        self.add_output_note(RawOutputNote::Full(note.clone()));

        Ok(note)
    }

    /// Creates a new TX_FEE note from the provided parameters and adds it to the list of genesis
    /// notes.
    ///
    /// In the created [`MockChain`], the note can be consumed right away by an account whose own
    /// code collects its assets.
    pub fn add_tx_fee_note(
        &mut self,
        sender_account_id: AccountId,
        assets: &[Asset],
    ) -> Result<Note, NoteError> {
        let note: Note = TxFeeNote::builder()
            .sender(sender_account_id)
            .assets(assets.iter().copied())
            .generate_serial_number(&mut self.rng)
            .build()?
            .into();
        self.add_output_note(RawOutputNote::Full(note.clone()));

        Ok(note)
    }

    /// Adds a P2IDE note (pay‑to‑ID‑extended) to the list of genesis notes.
    ///
    /// A P2IDE note can include an optional `timelock_height` and/or an optional
    /// `reclaim_height` after which the note's reclaimer may reclaim the funds.
    ///
    /// The `reclaimer` is the account allowed to reclaim the note; when `None` it
    /// defaults to `sender_account_id`.
    pub fn add_p2ide_note(
        &mut self,
        sender_account_id: AccountId,
        target_account_id: AccountId,
        reclaimer: Option<AccountId>,
        asset: &[Asset],
        note_type: NoteType,
        reclaim_height: Option<BlockNumber>,
        timelock_height: Option<BlockNumber>,
    ) -> Result<Note, NoteError> {
        let note: Note = P2ideNote::builder()
            .sender(sender_account_id)
            .target(target_account_id)
            .maybe_reclaimer(reclaimer)
            .assets(asset.iter().copied())
            .note_type(note_type)
            .maybe_reclaim_height(reclaim_height)
            .maybe_timelock_height(timelock_height)
            .generate_serial_number(&mut self.rng)
            .build()?
            .into();

        self.add_output_note(RawOutputNote::Full(note.clone()));

        Ok(note)
    }

    /// Adds a public SWAP note to the list of genesis notes.
    pub fn add_swap_note(
        &mut self,
        sender: AccountId,
        offered_asset: Asset,
        requested_asset: Asset,
        payback_note_type: NoteType,
    ) -> anyhow::Result<(Note, NoteDetails)> {
        let swap_note = SwapNote::builder()
            .sender(sender)
            .offered_asset(offered_asset)
            .requested_asset(requested_asset)
            .note_type(NoteType::Public)
            .payback_note_type(payback_note_type)
            .generate_serial_number(&mut self.rng)
            .build()?;

        let payback_note = swap_note.payback_note_details();
        let note = Note::from(swap_note);

        self.add_output_note(RawOutputNote::Full(note.clone()));

        Ok((note, payback_note))
    }

    /// Adds a public `SPAWN` note to the list of genesis notes.
    ///
    /// A `SPAWN` note contains a note script that creates all `output_notes` that get passed as a
    /// parameter.
    ///
    /// # Errors
    ///
    /// Returns an error if:
    /// - the sender account ID of the provided output notes is not consistent or does not match the
    ///   transaction's sender.
    pub fn add_spawn_note<'note, I>(
        &mut self,
        output_notes: impl IntoIterator<Item = &'note Note, IntoIter = I>,
    ) -> anyhow::Result<Note>
    where
        I: ExactSizeIterator<Item = &'note Note>,
    {
        let note = create_spawn_note(output_notes)?;
        self.add_output_note(RawOutputNote::Full(note.clone()));

        Ok(note)
    }

    /// Creates a new P2ID note with the provided amount of the fee asset of the chain.
    ///
    /// The fee faucet ID of the asset can be set using [`Self::fee_faucet_id`]. By default it
    /// is [`ACCOUNT_ID_FEE_FAUCET`].
    ///
    /// In the created [`MockChain`], the note will be immediately spendable by `target_account_id`.
    pub fn add_p2id_note_with_fee(
        &mut self,
        target_account_id: AccountId,
        amount: u64,
    ) -> anyhow::Result<Note> {
        let fee_asset = self.fee_asset(amount)?;
        let note = self.add_p2id_note(
            self.fee_faucet_id,
            target_account_id,
            &[Asset::from(fee_asset)],
            NoteType::Public,
        )?;

        Ok(note)
    }

    // HELPER FUNCTIONS
    // ----------------------------------------------------------------------------------------

    /// Returns a mutable reference to the builder's RNG.
    ///
    /// This can be used when creating accounts or notes and randomness is required.
    pub fn rng_mut(&mut self) -> &mut RandomCoin {
        &mut self.rng
    }

    /// Constructs a fungible asset based on the fee faucet ID and the provided amount.
    fn fee_asset(&self, amount: u64) -> anyhow::Result<FungibleAsset> {
        FungibleAsset::new(self.fee_faucet_id, amount).context("failed to create fee asset")
    }
}

impl Default for MockChainBuilder {
    fn default() -> Self {
        Self::new()
    }
}