Struct TestBuilder

pub struct TestBuilder<Cache, DataStoreFactory> { /* private fields */ }

Available on crate feature test-dependencies only.

A TestState builder, that configures the environment for a test.

Implementations

impl TestBuilder<(), ()>

pub const DEFAULT_NETWORK: LocalNetwork

The default network used by TestBuilder::new.

This is a fake network where Sapling through NU5 activate at the same height. We pick height 100,000 to be large enough to handle any hard-coded test offsets.

pub fn new() -> Self

Constructs a new test environment builder.

impl<A> TestBuilder<(), A>

pub fn with_block_cache<C: TestCache>(self, cache: C) -> TestBuilder<C, A>

Adds a block cache to the test environment.

impl<A> TestBuilder<A, ()>

pub fn with_data_store_factory<DsFactory>( self, ds_factory: DsFactory, ) -> TestBuilder<A, DsFactory>

Adds a wallet data store to the test environment.

impl<A, B> TestBuilder<A, B>

pub fn with_gap_limits(self, gap_limits: GapLimits) -> TestBuilder<A, B>

Available on crate feature transparent-inputs only.

impl<Cache, DsFactory> TestBuilder<Cache, DsFactory>

pub fn with_initial_chain_state( self, chain_state: impl FnOnce(&mut ChaChaRng, &LocalNetwork) -> InitialChainState, ) -> Self

Configures the test to start with the given initial chain state.

Panics

• Must not be called twice.
• Must be called before Self::with_account_from_sapling_activation or Self::with_account_having_current_birthday.

Examples

use std::num::NonZeroU8;

use incrementalmerkletree::frontier::Frontier;
use zcash_primitives::{block::BlockHash, consensus::Parameters};
use zcash_protocol::consensus::NetworkUpgrade;
use zcash_client_backend::data_api::{
    chain::{ChainState, CommitmentTreeRoot},
    testing::{InitialChainState, TestBuilder},
};

// For this test, we'll start inserting leaf notes 5 notes after the end of the
// third subtree, with a gap of 10 blocks. After `scan_cached_blocks`, the scan
// queue should have a requested scan range of 300..310 with `FoundNote` priority,
// 310..320 with `Scanned` priority. We set both Sapling and Orchard to the same
// initial tree size for simplicity.
let prior_block_hash = BlockHash([0; 32]);
let initial_sapling_tree_size: u32 = (0x1 << 16) * 3 + 5;
let initial_orchard_tree_size: u32 = (0x1 << 16) * 3 + 5;
let initial_height_offset = 310;

let mut st = TestBuilder::new()
    .with_initial_chain_state(|rng, network| {
        // For simplicity, assume Sapling and NU5 activated at the same height.
        let sapling_activation_height =
            network.activation_height(NetworkUpgrade::Sapling).unwrap();

        // Construct a fake chain state for the end of block 300
        let (prior_sapling_roots, sapling_initial_tree) =
            Frontier::random_with_prior_subtree_roots(
                rng,
                initial_sapling_tree_size.into(),
                NonZeroU8::new(16).unwrap(),
            );
        let prior_sapling_roots = prior_sapling_roots
            .into_iter()
            .zip(1u32..)
            .map(|(root, i)| {
                CommitmentTreeRoot::from_parts(sapling_activation_height + (100 * i), root)
            })
            .collect::<Vec<_>>();

        #[cfg(feature = "orchard")]
        let (prior_orchard_roots, orchard_initial_tree) =
            Frontier::random_with_prior_subtree_roots(
                rng,
                initial_orchard_tree_size.into(),
                NonZeroU8::new(16).unwrap(),
            );
        #[cfg(feature = "orchard")]
        let prior_orchard_roots = prior_orchard_roots
            .into_iter()
            .zip(1u32..)
            .map(|(root, i)| {
                CommitmentTreeRoot::from_parts(sapling_activation_height + (100 * i), root)
            })
            .collect::<Vec<_>>();

        InitialChainState {
            chain_state: ChainState::new(
                sapling_activation_height + initial_height_offset - 1,
                prior_block_hash,
                sapling_initial_tree,
                #[cfg(feature = "orchard")]
                orchard_initial_tree,
            ),
            prior_sapling_roots,
            #[cfg(feature = "orchard")]
            prior_orchard_roots,
        }
    });

pub fn with_account_from_sapling_activation(self, prev_hash: BlockHash) -> Self

Configures the environment with a TestAccount that has a birthday at Sapling activation.

Panics

• Must not be called twice.
• Do not call both Self::with_account_having_current_birthday and this method.

pub fn with_account_having_current_birthday(self) -> Self

Configures the environment with a TestAccount that has a birthday one block after the initial chain state.

Panics

• Must not be called twice.
• Must call Self::with_initial_chain_state before calling this method.
• Do not call both Self::with_account_from_sapling_activation and this method.

pub fn set_account_index(self, index: AccountId) -> Self

Sets the account index for the test account.

Does nothing unless either Self::with_account_from_sapling_activation or Self::with_account_having_current_birthday is also called.

Panics

• Must not be called twice.

impl<Cache, DsFactory: DataStoreFactory> TestBuilder<Cache, DsFactory>

pub fn build(self) -> TestState<Cache, DsFactory::DataStore, LocalNetwork>

Builds the state for this test.

Trait Implementations

impl Default for TestBuilder<(), ()>

fn default() -> Self

Returns the “default value” for a type.