light_batched_merkle_tree/

batch.rs

use light_bloom_filter::BloomFilter;
use light_hasher::{Hasher, Poseidon};
use light_zero_copy::vec::ZeroCopyVecU64;
use zerocopy::{FromBytes, Immutable, IntoBytes, KnownLayout};

use crate::{errors::BatchedMerkleTreeError, BorshDeserialize, BorshSerialize};

#[derive(Clone, Debug, PartialEq, Eq, Copy)]
#[repr(u64)]
pub enum BatchState {
    /// Batch can be filled with values.
    Fill,
    /// Batch has been inserted into the tree.
    Inserted,
    /// Batch is full.
    Full,
}

impl From<u64> for BatchState {
    fn from(value: u64) -> Self {
        match value {
            0 => BatchState::Fill,
            1 => BatchState::Inserted,
            2 => BatchState::Full,
            _ => panic!("Invalid BatchState value"),
        }
    }
}

impl From<BatchState> for u64 {
    fn from(val: BatchState) -> Self {
        val as u64
    }
}

/// Batch structure that holds
/// the metadata and state of a batch.
///
/// A batch:
/// - has a size and a number of zkp batches.
/// - size must be divisible by zkp batch size.
/// - is part of a queue, each queue has two batches.
/// - is inserted into the tree by zkp batch.
#[repr(C)]
#[derive(
    Clone,
    Copy,
    Debug,
    PartialEq,
    Eq,
    KnownLayout,
    Immutable,
    IntoBytes,
    FromBytes,
    Default,
    BorshSerialize,
    BorshDeserialize,
)]
pub struct Batch {
    /// Number of inserted elements in the zkp batch.
    num_inserted: u64,
    state: u64,
    /// Number of full zkp batches in the batch,
    /// that are ready to be inserted into the tree.
    pub(crate) num_full_zkp_batches: u64,
    /// Number zkp batches that are inserted into the tree.
    num_inserted_zkp_batches: u64,
    /// Number of iterations for the bloom_filter.
    pub num_iters: u64,
    /// Theoretical capacity of the bloom_filter in bits.
    /// We want to make it much larger
    /// than batch_size to avoid false positives.
    pub bloom_filter_capacity: u64,
    /// Number of elements in a batch.
    pub batch_size: u64,
    /// Number of elements in a zkp batch.
    /// A batch consists out of one or more zkp batches.
    pub zkp_batch_size: u64,
    /// Sequence number when it is save to clear the batch without advancing to
    /// the saved root index.
    pub sequence_number: u64,
    /// Start leaf index of the first
    pub start_index: u64,
    /// Slot of the first insertion into the batch.
    /// Indexers can use this slot to reindex inserted elements.
    /// Is not used for the batch itself.
    pub start_slot: u64,
    pub root_index: u32,
    start_slot_is_set: u8,
    bloom_filter_is_zeroed: u8,
    _padding: [u8; 2],
}

impl Batch {
    pub fn new(
        num_iters: u64,
        bloom_filter_capacity: u64,
        batch_size: u64,
        zkp_batch_size: u64,
        start_index: u64,
    ) -> Self {
        Batch {
            num_iters,
            bloom_filter_capacity,
            batch_size,
            num_inserted: 0,
            state: BatchState::Fill.into(),
            zkp_batch_size,
            num_full_zkp_batches: 0,
            num_inserted_zkp_batches: 0,
            sequence_number: 0,
            root_index: 0,
            start_index,
            start_slot: 0,
            start_slot_is_set: 0,
            bloom_filter_is_zeroed: 0,
            _padding: [0u8; 2],
        }
    }

    /// Returns the state of the batch.
    pub fn get_state(&self) -> BatchState {
        self.state.into()
    }

    pub fn bloom_filter_is_zeroed(&self) -> bool {
        self.bloom_filter_is_zeroed == 1
    }

    pub fn set_bloom_filter_to_zeroed(&mut self) {
        // 1 if bloom filter is zeroed
        // 0 if bloom filter is not zeroed
        self.bloom_filter_is_zeroed = 1;
    }

    pub fn set_bloom_filter_to_not_zeroed(&mut self) {
        // 1 if bloom filter is zeroed
        // 0 if bloom filter is not zeroed
        self.bloom_filter_is_zeroed = 0;
    }

    pub fn start_slot_is_set(&self) -> bool {
        self.start_slot_is_set == 1
    }

    pub fn set_start_slot(&mut self, start_slot: &u64) {
        if !self.start_slot_is_set() {
            self.start_slot = *start_slot;
            self.start_slot_is_set = 1;
        }
    }

    /// fill -> full -> inserted -> fill
    /// (from tree insertion perspective is pending if fill or full)
    pub fn advance_state_to_fill(
        &mut self,
        start_index: Option<u64>,
    ) -> Result<(), BatchedMerkleTreeError> {
        if self.get_state() == BatchState::Inserted {
            self.state = BatchState::Fill.into();
            self.set_bloom_filter_to_not_zeroed();
            self.sequence_number = 0;
            self.root_index = 0;
            self.num_inserted_zkp_batches = 0;
            self.start_slot_is_set = 0;
            self.start_slot = 0;
            if let Some(start_index) = start_index {
                self.start_index = start_index;
            }
            self.num_full_zkp_batches = 0;
        } else {
            #[cfg(feature = "solana")]
            solana_msg::msg!(
                "Batch is in incorrect state {} expected BatchState::Inserted 1",
                self.state
            );
            return Err(BatchedMerkleTreeError::BatchNotReady);
        }
        Ok(())
    }

    /// fill -> full -> inserted -> fill
    /// (from tree insertion perspective is pending if fill or full)
    pub fn advance_state_to_inserted(&mut self) -> Result<(), BatchedMerkleTreeError> {
        if self.get_state() == BatchState::Full {
            self.state = BatchState::Inserted.into();
        } else {
            #[cfg(feature = "solana")]
            solana_msg::msg!(
                "Batch is in incorrect state {} expected BatchState::Full 2",
                self.state
            );
            return Err(BatchedMerkleTreeError::BatchNotReady);
        }
        Ok(())
    }

    /// fill -> full -> inserted -> fill
    /// (from tree insertion perspective is pending if fill or full)
    pub fn advance_state_to_full(&mut self) -> Result<(), BatchedMerkleTreeError> {
        if self.get_state() == BatchState::Fill {
            self.state = BatchState::Full.into();
        } else {
            #[cfg(feature = "solana")]
            solana_msg::msg!(
                "Batch is in incorrect state {} expected BatchState::Fill 0",
                self.state
            );
            return Err(BatchedMerkleTreeError::BatchNotReady);
        }
        Ok(())
    }

    pub fn get_first_ready_zkp_batch(&self) -> Result<u64, BatchedMerkleTreeError> {
        if self.get_state() == BatchState::Inserted {
            Err(BatchedMerkleTreeError::BatchAlreadyInserted)
        } else if self.batch_is_ready_to_insert() {
            Ok(self.num_inserted_zkp_batches)
        } else {
            Err(BatchedMerkleTreeError::BatchNotReady)
        }
    }

    pub fn batch_is_ready_to_insert(&self) -> bool {
        self.num_full_zkp_batches > self.num_inserted_zkp_batches
    }

    /// Returns the number of zkp batch updates
    /// that are ready to be inserted into the tree.
    pub fn get_num_ready_zkp_updates(&self) -> u64 {
        self.num_full_zkp_batches
            .saturating_sub(self.num_inserted_zkp_batches)
    }

    /// Returns the number of inserted elements
    /// in the current zkp batch.
    pub fn get_num_inserted_zkp_batch(&self) -> u64 {
        self.num_inserted
    }

    /// Returns the current zkp batch index.
    /// New values are inserted into the current zkp batch.
    pub fn get_current_zkp_batch_index(&self) -> u64 {
        self.num_full_zkp_batches
    }

    /// Returns the number of inserted zkps.
    pub fn get_num_inserted_zkps(&self) -> u64 {
        self.num_inserted_zkp_batches
    }

    /// Returns the number of elements inserted into the tree.
    pub fn get_num_elements_inserted_into_tree(&self) -> u64 {
        self.num_inserted_zkp_batches * self.zkp_batch_size
    }

    /// Returns the number of inserted elements in the batch.
    pub fn get_num_inserted_elements(&self) -> u64 {
        self.num_full_zkp_batches * self.zkp_batch_size + self.num_inserted
    }

    /// Returns the number of zkp batches in the batch.
    pub fn get_num_zkp_batches(&self) -> u64 {
        self.batch_size / self.zkp_batch_size
    }

    /// Returns the number of the hash_chain stores.
    pub fn get_num_hash_chain_store(&self) -> usize {
        self.get_num_zkp_batches() as usize
    }

    /// Returns the index of a value by leaf index in the value store,
    /// provided it does exist in the batch.
    pub fn get_value_index_in_batch(&self, leaf_index: u64) -> Result<u64, BatchedMerkleTreeError> {
        self.check_leaf_index_exists(leaf_index)?;
        let index = leaf_index
            .checked_sub(self.start_index)
            .ok_or(BatchedMerkleTreeError::LeafIndexNotInBatch)?;
        Ok(index)
    }

    /// Stores the value in a value store,
    /// and adds the value to the current hash chain.
    pub fn store_and_hash_value(
        &mut self,
        value: &[u8; 32],
        value_store: &mut ZeroCopyVecU64<[u8; 32]>,
        hash_chain_store: &mut ZeroCopyVecU64<[u8; 32]>,
        start_slot: &u64,
    ) -> Result<(), BatchedMerkleTreeError> {
        self.set_start_slot(start_slot);
        self.add_to_hash_chain(value, hash_chain_store)?;
        value_store.push(*value)?;
        Ok(())
    }

    /// Insert into the bloom filter and
    /// add value to current hash chain.
    /// (used by nullifier & address queues)
    /// 1. set start slot
    /// 2. Add value to hash chain.
    /// 3. Insert value into the bloom filter at bloom_filter_index.
    /// 4. Check that value is not in any other bloom filter.
    pub fn insert(
        &mut self,
        bloom_filter_value: &[u8; 32],
        hash_chain_value: &[u8; 32],
        bloom_filter_stores: &mut [&mut [u8]],
        hash_chain_store: &mut ZeroCopyVecU64<[u8; 32]>,
        bloom_filter_index: usize,
        start_slot: &u64,
    ) -> Result<(), BatchedMerkleTreeError> {
        // 1. set start slot if not set.
        self.set_start_slot(start_slot);
        // 2. add value to hash chain
        self.add_to_hash_chain(hash_chain_value, hash_chain_store)?;
        // insert into bloom filter & check non inclusion
        {
            let other_bloom_filter_index = if bloom_filter_index == 0 { 1 } else { 0 };

            // 3. Insert value into the bloom filter at bloom_filter_index.
            BloomFilter::new(
                self.num_iters as usize,
                self.bloom_filter_capacity,
                bloom_filter_stores[bloom_filter_index],
            )?
            .insert(bloom_filter_value)?;
            // 4. Check that value is not in any other bloom filter.
            Self::check_non_inclusion(
                self.num_iters as usize,
                self.bloom_filter_capacity,
                bloom_filter_value,
                bloom_filter_stores[other_bloom_filter_index],
            )?;
        }
        Ok(())
    }

    /// Add a value to the current hash chain, and advance batch state.
    /// 1. Check that the batch is ready.
    /// 2. If the zkp batch is empty, start a new hash chain.
    /// 3. If the zkp batch is not empty, add value to last hash chain.
    /// 4. If the zkp batch is full, increment the zkp batch index.
    /// 5. If all zkp batches are full, set batch state to full.
    pub fn add_to_hash_chain(
        &mut self,
        value: &[u8; 32],
        hash_chain_store: &mut ZeroCopyVecU64<[u8; 32]>,
    ) -> Result<(), BatchedMerkleTreeError> {
        // 1. Check that the batch is ready.
        if self.get_state() != BatchState::Fill {
            return Err(BatchedMerkleTreeError::BatchNotReady);
        }
        let start_new_hash_chain = self.num_inserted == 0;
        if start_new_hash_chain {
            // 2. Start a new hash chain.
            hash_chain_store.push(*value)?;
        } else if let Some(last_hash_chain) = hash_chain_store.last_mut() {
            // 3. Add value to last hash chain.
            let hash_chain = Poseidon::hashv(&[last_hash_chain, value.as_slice()])?;
            *last_hash_chain = hash_chain;
        } else {
            unreachable!();
        }
        self.num_inserted += 1;

        // 4. If the zkp batch is full, increment the zkp batch index.
        let zkp_batch_is_full = self.num_inserted == self.zkp_batch_size;
        if zkp_batch_is_full {
            self.num_full_zkp_batches += 1;
            // To start a new hash chain in the next insertion
            // set num inserted to zero.
            self.num_inserted = 0;

            // 5. If all zkp batches are full, set batch state to full.
            let batch_is_full = self.num_full_zkp_batches == self.get_num_zkp_batches();
            if batch_is_full {
                self.advance_state_to_full()?;
            }
        }

        Ok(())
    }

    /// Checks that value is not in the bloom filter.
    pub fn check_non_inclusion(
        num_iters: usize,
        bloom_filter_capacity: u64,
        value: &[u8; 32],
        store: &mut [u8],
    ) -> Result<(), BatchedMerkleTreeError> {
        let mut bloom_filter = BloomFilter::new(num_iters, bloom_filter_capacity, store)?;
        if bloom_filter.contains(value) {
            return Err(BatchedMerkleTreeError::NonInclusionCheckFailed);
        }
        Ok(())
    }

    /// Marks the batch as inserted in the merkle tree.
    /// 1. Checks that the batch is ready.
    /// 2. increments the number of inserted zkps.
    /// 3. If all zkps are inserted, sets the state to inserted.
    /// 4. Returns the updated state of the batch.
    pub fn mark_as_inserted_in_merkle_tree(
        &mut self,
        sequence_number: u64,
        root_index: u32,
        root_history_length: u32,
    ) -> Result<BatchState, BatchedMerkleTreeError> {
        // 1. Check that batch is ready.
        self.get_first_ready_zkp_batch()?;

        let num_zkp_batches = self.get_num_zkp_batches();

        // 2. increments the number of inserted zkps.
        self.num_inserted_zkp_batches += 1;
        // 3. If all zkp batches are inserted, sets the state to inserted.
        let batch_is_completely_inserted = self.num_inserted_zkp_batches == num_zkp_batches;
        if batch_is_completely_inserted {
            self.advance_state_to_inserted()?;
            // Saving sequence number and root index for the batch.
            // When the batch is cleared check that sequence number is greater or equal than self.sequence_number
            // if not advance current root index to root index
            self.sequence_number = sequence_number + root_history_length as u64;
            self.root_index = root_index;
        }

        Ok(self.get_state())
    }

    pub fn check_leaf_index_exists(&self, leaf_index: u64) -> Result<(), BatchedMerkleTreeError> {
        if !self.leaf_index_exists(leaf_index) {
            return Err(BatchedMerkleTreeError::LeafIndexNotInBatch);
        }
        Ok(())
    }

    /// Returns true if value of leaf index could exist in batch.
    /// `True` doesn't mean that the value exists in the batch,
    /// just that it is possible. The value might already be spent
    /// or never have been inserted in case an invalid index was provided.
    pub fn leaf_index_exists(&self, leaf_index: u64) -> bool {
        let next_batch_leaf_index = self.get_num_inserted_elements() + self.start_index;
        let min_batch_leaf_index = self.start_index;
        leaf_index < next_batch_leaf_index && leaf_index >= min_batch_leaf_index
    }
}

#[cfg(test)]
mod tests {

    use light_compressed_account::{pubkey::Pubkey, QueueType};
    use light_merkle_tree_metadata::queue::QueueMetadata;

    use super::*;
    use crate::queue::BatchedQueueAccount;

    fn get_test_batch() -> Batch {
        Batch::new(3, 160_000, 500, 100, 0)
    }

    /// simulate zkp batch insertion
    fn test_mark_as_inserted(mut batch: Batch) {
        let mut sequence_number = 10;
        let mut root_index = 20;
        let root_history_length = 23;
        let current_slot = 1;
        for i in 0..batch.get_num_zkp_batches() {
            sequence_number += i;
            root_index += i as u32;
            batch
                .mark_as_inserted_in_merkle_tree(sequence_number, root_index, root_history_length)
                .unwrap();
            if i != batch.get_num_zkp_batches() - 1 {
                assert_eq!(batch.get_state(), BatchState::Full);
                assert_eq!(batch.get_num_inserted_zkp_batch(), 0);
                assert_eq!(batch.get_current_zkp_batch_index(), 5);
                assert_eq!(batch.get_num_inserted_zkps(), i + 1);
            } else {
                assert_eq!(batch.get_state(), BatchState::Inserted);
                assert_eq!(batch.get_num_inserted_zkp_batch(), 0);
                assert_eq!(batch.get_current_zkp_batch_index(), 5);
                assert_eq!(batch.get_num_inserted_zkps(), i + 1);
            }
        }
        assert_eq!(batch.get_state(), BatchState::Inserted);
        assert_eq!(batch.get_num_inserted_zkp_batch(), 0);
        let mut ref_batch = get_test_batch();
        ref_batch.state = BatchState::Inserted.into();
        ref_batch.root_index = root_index;
        ref_batch.sequence_number = sequence_number + root_history_length as u64;
        ref_batch.num_inserted_zkp_batches = 5;
        ref_batch.start_slot = current_slot;
        ref_batch.start_slot_is_set = 1;
        ref_batch.num_full_zkp_batches = 5;
        assert_eq!(batch, ref_batch);
        batch.advance_state_to_fill(Some(1)).unwrap();
        let mut ref_batch = get_test_batch();
        ref_batch.start_index = 1;
        assert_eq!(batch, ref_batch);
    }

    #[test]
    fn test_store_value() {
        let mut batch = get_test_batch();
        let current_slot = 1;

        let mut value_store_bytes =
            vec![0u8; ZeroCopyVecU64::<[u8; 32]>::required_size_for_capacity(batch.batch_size)];
        let mut value_store =
            ZeroCopyVecU64::new(batch.batch_size, &mut value_store_bytes).unwrap();
        let mut hash_chain_store_bytes = vec![
            0u8;
            ZeroCopyVecU64::<[u8; 32]>::required_size_for_capacity(
                batch.get_num_hash_chain_store() as u64
            )
        ];
        let mut hash_chain_store = ZeroCopyVecU64::new(
            batch.get_num_hash_chain_store() as u64,
            hash_chain_store_bytes.as_mut_slice(),
        )
        .unwrap();

        let mut ref_batch = get_test_batch();
        for i in 0..batch.batch_size {
            if i == 0 {
                ref_batch.start_slot = current_slot;
                ref_batch.start_slot_is_set = 1;
            }
            ref_batch.num_inserted %= ref_batch.zkp_batch_size;

            let mut value = [0u8; 32];
            value[24..].copy_from_slice(&i.to_be_bytes());
            assert!(batch
                .store_and_hash_value(
                    &value,
                    &mut value_store,
                    &mut hash_chain_store,
                    &current_slot
                )
                .is_ok());
            ref_batch.num_inserted += 1;
            if ref_batch.num_inserted == ref_batch.zkp_batch_size {
                ref_batch.num_full_zkp_batches += 1;
                ref_batch.num_inserted = 0;
            }
            if ref_batch.num_full_zkp_batches == ref_batch.get_num_zkp_batches() {
                ref_batch.state = BatchState::Full.into();
                ref_batch.num_inserted = 0;
            }
            assert_eq!(batch, ref_batch);
            assert_eq!(*value_store.get(i as usize).unwrap(), value);
        }
        let result = batch.store_and_hash_value(
            &[1u8; 32],
            &mut value_store,
            &mut hash_chain_store,
            &current_slot,
        );
        assert_eq!(result.unwrap_err(), BatchedMerkleTreeError::BatchNotReady);
        assert_eq!(batch.get_state(), BatchState::Full);
        assert_eq!(batch.get_num_inserted_zkp_batch(), 0);
        assert_eq!(batch.get_current_zkp_batch_index(), 5);
        assert_eq!(batch.get_num_zkp_batches(), 5);
        assert_eq!(batch.get_num_inserted_zkps(), 0);

        test_mark_as_inserted(batch);
    }

    #[test]
    fn test_insert() {
        // Behavior Input queue
        let mut batch = get_test_batch();
        let mut current_slot = 1;
        let mut stores = vec![vec![0u8; 20_000]; 2];
        let mut bloom_filter_stores = stores
            .iter_mut()
            .map(|store| &mut store[..])
            .collect::<Vec<_>>();
        let mut hash_chain_store_bytes = vec![
            0u8;
            ZeroCopyVecU64::<[u8; 32]>::required_size_for_capacity(
                batch.get_num_hash_chain_store() as u64
            )
        ];
        ZeroCopyVecU64::<[u8; 32]>::new(
            batch.get_num_hash_chain_store() as u64,
            hash_chain_store_bytes.as_mut_slice(),
        )
        .unwrap();

        let mut ref_batch = get_test_batch();
        for processing_index in 0..=1 {
            for i in 0..(batch.batch_size / 2) {
                let i = i + (batch.batch_size / 2) * (processing_index as u64);
                if i == 0 && processing_index == 0 {
                    assert_eq!(batch.start_slot, 0);
                    assert_eq!(batch.start_slot_is_set, 0);
                    ref_batch.start_slot = current_slot;
                    ref_batch.start_slot_is_set = 1;
                } else {
                    assert_eq!(batch.start_slot, 1);
                    assert_eq!(batch.start_slot_is_set, 1);
                }

                ref_batch.num_inserted %= ref_batch.zkp_batch_size;
                let mut hash_chain_store =
                    ZeroCopyVecU64::<[u8; 32]>::from_bytes(hash_chain_store_bytes.as_mut_slice())
                        .unwrap();

                let mut value = [0u8; 32];
                value[24..].copy_from_slice(&i.to_be_bytes());
                #[allow(clippy::manual_is_multiple_of)]
                let ref_hash_chain = if i % batch.zkp_batch_size == 0 {
                    value
                } else {
                    Poseidon::hashv(&[hash_chain_store.last().unwrap(), &value]).unwrap()
                };
                let result = batch.insert(
                    &value,
                    &value,
                    bloom_filter_stores.as_mut_slice(),
                    &mut hash_chain_store,
                    processing_index,
                    &current_slot,
                );
                // First insert should succeed
                assert!(result.is_ok(), "Failed result: {:?}", result);
                assert_eq!(*hash_chain_store.last().unwrap(), ref_hash_chain);

                {
                    let mut cloned_hash_chain_store = hash_chain_store_bytes.clone();
                    let mut hash_chain_store = ZeroCopyVecU64::<[u8; 32]>::from_bytes(
                        cloned_hash_chain_store.as_mut_slice(),
                    )
                    .unwrap();
                    let mut batch = batch;
                    // Reinsert should fail
                    assert!(batch
                        .insert(
                            &value,
                            &value,
                            bloom_filter_stores.as_mut_slice(),
                            &mut hash_chain_store,
                            processing_index,
                            &current_slot
                        )
                        .is_err());
                }
                let mut bloom_filter = BloomFilter {
                    num_iters: batch.num_iters as usize,
                    capacity: batch.bloom_filter_capacity,
                    store: bloom_filter_stores[processing_index],
                };
                assert!(bloom_filter.contains(&value));
                let other_index = if processing_index == 0 { 1 } else { 0 };
                Batch::check_non_inclusion(
                    batch.num_iters as usize,
                    batch.bloom_filter_capacity,
                    &value,
                    bloom_filter_stores[other_index],
                )
                .unwrap();
                Batch::check_non_inclusion(
                    batch.num_iters as usize,
                    batch.bloom_filter_capacity,
                    &value,
                    bloom_filter_stores[processing_index],
                )
                .unwrap_err();

                ref_batch.num_inserted += 1;
                if ref_batch.num_inserted == ref_batch.zkp_batch_size {
                    ref_batch.num_full_zkp_batches += 1;
                    ref_batch.num_inserted = 0;
                }
                if i == batch.batch_size - 1 {
                    ref_batch.state = BatchState::Full.into();
                    ref_batch.num_inserted = 0;
                }
                assert_eq!(batch, ref_batch);
                current_slot += 1;
            }
        }
        test_mark_as_inserted(batch);
    }

    #[test]
    fn test_add_to_hash_chain() {
        let mut batch = get_test_batch();
        let mut hash_chain_store_bytes = vec![
            0u8;
            ZeroCopyVecU64::<[u8; 32]>::required_size_for_capacity(
                batch.get_num_hash_chain_store() as u64
            )
        ];
        let mut hash_chain_store = ZeroCopyVecU64::<[u8; 32]>::new(
            batch.get_num_hash_chain_store() as u64,
            hash_chain_store_bytes.as_mut_slice(),
        )
        .unwrap();
        let value = [1u8; 32];

        assert!(batch
            .add_to_hash_chain(&value, &mut hash_chain_store)
            .is_ok());
        let mut ref_batch = get_test_batch();
        let user_hash_chain = value;
        ref_batch.num_inserted = 1;
        assert_eq!(batch, ref_batch);
        assert_eq!(hash_chain_store[0], user_hash_chain);
        let value = [2u8; 32];
        let ref_hash_chain = Poseidon::hashv(&[&user_hash_chain, &value]).unwrap();
        assert!(batch
            .add_to_hash_chain(&value, &mut hash_chain_store)
            .is_ok());

        ref_batch.num_inserted = 2;
        assert_eq!(batch, ref_batch);
        assert_eq!(hash_chain_store[0], ref_hash_chain);
    }

    #[test]
    fn test_check_non_inclusion() {
        let mut current_slot = 1;
        for processing_index in 0..=1 {
            let mut batch = get_test_batch();

            let value = [1u8; 32];
            let mut stores = vec![vec![0u8; 20_000]; 2];
            let mut bloom_filter_stores = stores
                .iter_mut()
                .map(|store| &mut store[..])
                .collect::<Vec<_>>();
            let mut hash_chain_store_bytes = vec![
            0u8;
            ZeroCopyVecU64::<[u8; 32]>::required_size_for_capacity(
                batch.get_num_hash_chain_store() as u64
            )
        ];
            let mut hash_chain_store = ZeroCopyVecU64::<[u8; 32]>::new(
                batch.get_num_hash_chain_store() as u64,
                hash_chain_store_bytes.as_mut_slice(),
            )
            .unwrap();

            assert_eq!(
                Batch::check_non_inclusion(
                    batch.num_iters as usize,
                    batch.bloom_filter_capacity,
                    &value,
                    bloom_filter_stores[processing_index]
                ),
                Ok(())
            );
            let ref_batch = get_test_batch();
            assert_eq!(batch, ref_batch);
            batch
                .insert(
                    &value,
                    &value,
                    bloom_filter_stores.as_mut_slice(),
                    &mut hash_chain_store,
                    processing_index,
                    &current_slot,
                )
                .unwrap();
            current_slot += 1;
            assert!(Batch::check_non_inclusion(
                batch.num_iters as usize,
                batch.bloom_filter_capacity,
                &value,
                bloom_filter_stores[processing_index]
            )
            .is_err());

            let other_index = if processing_index == 0 { 1 } else { 0 };
            assert!(Batch::check_non_inclusion(
                batch.num_iters as usize,
                batch.bloom_filter_capacity,
                &value,
                bloom_filter_stores[other_index]
            )
            .is_ok());
        }
    }

    #[test]
    fn test_getters() {
        let mut batch = get_test_batch();
        assert_eq!(batch.get_num_zkp_batches(), 5);
        assert_eq!(batch.get_num_hash_chain_store(), 5);
        assert_eq!(batch.get_state(), BatchState::Fill);
        assert_eq!(batch.get_num_inserted_zkp_batch(), 0);
        assert_eq!(batch.get_current_zkp_batch_index(), 0);
        assert_eq!(batch.get_num_inserted_zkps(), 0);
        batch.advance_state_to_full().unwrap();
        assert_eq!(batch.get_state(), BatchState::Full);
        batch.advance_state_to_inserted().unwrap();
        assert_eq!(batch.get_state(), BatchState::Inserted);
    }

    /// Tests:
    /// 1. Failing test lowest value in eligble range - 1
    /// 2. Functional test lowest value in eligble range
    /// 3. Functional test highest value in eligble range
    /// 4. Failing test eligble range + 1
    #[test]
    fn test_value_is_inserted_in_batch() {
        let mut batch = get_test_batch();
        batch.advance_state_to_full().unwrap();
        batch.advance_state_to_inserted().unwrap();
        batch.start_index = 1;
        batch.num_inserted = 5;
        let lowest_eligible_value = batch.start_index;
        let highest_eligible_value = batch.start_index + batch.get_num_inserted_elements() - 1;
        // 1. Failing test lowest value in eligible range - 1
        assert!(!batch.leaf_index_exists(lowest_eligible_value - 1));
        // 2. Functional test lowest value in eligible range
        assert!(batch.leaf_index_exists(lowest_eligible_value));
        // 3. Functional test highest value in eligible range
        assert!(batch.leaf_index_exists(highest_eligible_value));
        // 4. Failing test eligible range + 1
        assert!(!batch.leaf_index_exists(highest_eligible_value + 1));
    }

    /// 1. Failing: empty batch
    /// 2. Functional: if zkp batch size is full else failing
    /// 3. Failing: batch is completely inserted
    #[test]
    fn test_can_insert_batch() {
        let mut batch = get_test_batch();
        let mut current_slot = 1;
        assert_eq!(
            batch.get_first_ready_zkp_batch(),
            Err(BatchedMerkleTreeError::BatchNotReady)
        );
        let mut value_store_bytes =
            vec![0u8; ZeroCopyVecU64::<[u8; 32]>::required_size_for_capacity(batch.batch_size)];
        let mut value_store =
            ZeroCopyVecU64::<[u8; 32]>::new(batch.batch_size, &mut value_store_bytes).unwrap();
        let mut hash_chain_store_bytes = vec![
            0u8;
            ZeroCopyVecU64::<[u8; 32]>::required_size_for_capacity(
                batch.get_num_hash_chain_store() as u64
            )
        ];
        let mut hash_chain_store = ZeroCopyVecU64::<[u8; 32]>::new(
            batch.get_num_hash_chain_store() as u64,
            hash_chain_store_bytes.as_mut_slice(),
        )
        .unwrap();

        for i in 0..batch.batch_size + 10 {
            let mut value = [0u8; 32];
            value[24..].copy_from_slice(&i.to_be_bytes());
            if i < batch.batch_size {
                batch
                    .store_and_hash_value(
                        &value,
                        &mut value_store,
                        &mut hash_chain_store,
                        &current_slot,
                    )
                    .unwrap();
            }
            #[allow(clippy::manual_is_multiple_of)]
            if (i + 1) % batch.zkp_batch_size == 0 && i != 0 {
                assert_eq!(
                    batch.get_first_ready_zkp_batch().unwrap(),
                    i / batch.zkp_batch_size
                );
                batch.mark_as_inserted_in_merkle_tree(0, 0, 0).unwrap();
            } else if i >= batch.batch_size {
                assert_eq!(
                    batch.get_first_ready_zkp_batch(),
                    Err(BatchedMerkleTreeError::BatchAlreadyInserted)
                );
            } else {
                assert_eq!(
                    batch.get_first_ready_zkp_batch(),
                    Err(BatchedMerkleTreeError::BatchNotReady)
                );
            }
            current_slot += 1;
        }
    }

    #[test]
    fn test_get_state() {
        let mut batch = get_test_batch();
        assert_eq!(batch.get_state(), BatchState::Fill);
        {
            let result = batch.advance_state_to_inserted();
            assert_eq!(result, Err(BatchedMerkleTreeError::BatchNotReady));
            let result = batch.advance_state_to_fill(None);
            assert_eq!(result, Err(BatchedMerkleTreeError::BatchNotReady));
        }
        batch.advance_state_to_full().unwrap();
        assert_eq!(batch.get_state(), BatchState::Full);
        {
            let result = batch.advance_state_to_full();
            assert_eq!(result, Err(BatchedMerkleTreeError::BatchNotReady));
            let result = batch.advance_state_to_fill(None);
            assert_eq!(result, Err(BatchedMerkleTreeError::BatchNotReady));
        }
        batch.advance_state_to_inserted().unwrap();
        assert_eq!(batch.get_state(), BatchState::Inserted);
    }

    #[test]
    fn test_bloom_filter_is_zeroed() {
        let mut batch = get_test_batch();
        assert!(!batch.bloom_filter_is_zeroed());
        batch.set_bloom_filter_to_zeroed();
        assert!(batch.bloom_filter_is_zeroed());
        batch.set_bloom_filter_to_not_zeroed();
        assert!(!batch.bloom_filter_is_zeroed());
    }

    #[test]
    fn test_num_ready_zkp_updates() {
        let mut batch = get_test_batch();
        assert_eq!(batch.get_num_ready_zkp_updates(), 0);
        batch.num_full_zkp_batches = 1;
        assert_eq!(batch.get_num_ready_zkp_updates(), 1);
        batch.num_inserted_zkp_batches = 1;
        assert_eq!(batch.get_num_ready_zkp_updates(), 0);
        batch.num_full_zkp_batches = 2;
        assert_eq!(batch.get_num_ready_zkp_updates(), 1);
    }

    #[test]
    fn test_get_num_inserted_elements() {
        let mut batch = get_test_batch();
        assert_eq!(batch.get_num_inserted_elements(), 0);
        let mut hash_chain_bytes = vec![0u8; 32 * batch.batch_size as usize];
        let mut hash_chain_store = ZeroCopyVecU64::<[u8; 32]>::new(
            batch.get_num_zkp_batches(),
            hash_chain_bytes.as_mut_slice(),
        )
        .unwrap();

        for i in 0..batch.batch_size {
            let mut value = [0u8; 32];
            value[24..].copy_from_slice(&i.to_be_bytes());
            batch
                .add_to_hash_chain(&value, &mut hash_chain_store)
                .unwrap();
            assert_eq!(batch.get_num_inserted_elements(), i + 1);
        }
    }

    #[test]
    fn test_get_num_elements_inserted_into_tree() {
        let mut batch = get_test_batch();
        assert_eq!(batch.get_num_elements_inserted_into_tree(), 0);
        for i in 0..batch.get_num_zkp_batches() {
            #[allow(clippy::manual_is_multiple_of)]
            if i % batch.zkp_batch_size == 0 {
                batch.num_full_zkp_batches += 1;
                batch
                    .mark_as_inserted_in_merkle_tree(i, i as u32, 0)
                    .unwrap();
                assert_eq!(
                    batch.get_num_elements_inserted_into_tree(),
                    (i + 1) * batch.zkp_batch_size
                );
            }
        }
    }

    // Moved BatchedQueueAccount test to this file
    // to modify private Batch variables for assertions.
    #[test]
    fn test_get_num_inserted() {
        let mut account_data = vec![0u8; 1000];
        let mut queue_metadata = QueueMetadata::default();
        let associated_merkle_tree = Pubkey::new_unique();
        queue_metadata.associated_merkle_tree = associated_merkle_tree;
        queue_metadata.queue_type = QueueType::OutputStateV2 as u64;
        let batch_size = 4;
        let zkp_batch_size = 2;
        let bloom_filter_capacity = 0;
        let num_iters = 0;
        let mut current_slot = 1;
        let mut account = BatchedQueueAccount::init(
            &mut account_data,
            queue_metadata,
            batch_size,
            zkp_batch_size,
            num_iters,
            bloom_filter_capacity,
            Pubkey::new_unique(),
            16, // Tree height 4 -> capacity 16
        )
        .unwrap();
        assert_eq!(account.get_num_inserted_in_current_batch(), 0);
        // Fill first batch
        for i in 1..=batch_size {
            account
                .insert_into_current_batch(&[1u8; 32], &current_slot)
                .unwrap();
            if i == batch_size {
                // Current batch is batch[1] now since batch[0] is full
                assert_eq!(account.get_num_inserted_in_current_batch(), 0);
                assert_eq!(
                    account.batch_metadata.batches[0].get_num_inserted_elements(),
                    i
                );
            } else {
                assert_eq!(account.get_num_inserted_in_current_batch(), i);
            }
            current_slot += 1;
        }
        println!("full batch 0 {:?}", account.batch_metadata.batches[0]);

        // Fill second batch
        for i in 1..=batch_size {
            account
                .insert_into_current_batch(&[2u8; 32], &current_slot)
                .unwrap();
            if i == batch_size {
                // Current batch is batch[0] and it is still full
                assert_eq!(account.get_num_inserted_in_current_batch(), 4);
                assert_eq!(
                    account.batch_metadata.batches[1].get_num_inserted_elements(),
                    i
                );
            } else {
                assert_eq!(account.get_num_inserted_in_current_batch(), i);
            }
            current_slot += 1;
        }
        println!("account {:?}", account.batch_metadata);
        println!("account {:?}", account.batch_metadata.batches[0]);
        println!("account {:?}", account.batch_metadata.batches[1]);
        assert_eq!(account.get_num_inserted_in_current_batch(), batch_size);
        assert_eq!(
            account.insert_into_current_batch(&[1u8; 32], &current_slot),
            Err(BatchedMerkleTreeError::BatchNotReady)
        );
        let ref_value_array = vec![[1u8; 32]; 4];
        assert_eq!(account.value_vecs[0].as_slice(), ref_value_array.as_slice());
        let ref_value_array = vec![[2u8; 32]; 4];
        assert_eq!(account.value_vecs[1].as_slice(), ref_value_array.as_slice());
        assert_eq!(account.batch_metadata.get_current_batch().start_index, 0);
        {
            let batch_0 = account.batch_metadata.batches[0];
            let mut expected_batch = Batch::new(
                num_iters,
                bloom_filter_capacity,
                batch_size,
                zkp_batch_size,
                0,
            );
            expected_batch.num_full_zkp_batches = 2;
            expected_batch.start_slot = 1;
            expected_batch.start_slot_is_set = 1;
            expected_batch.advance_state_to_full().unwrap();
            assert_eq!(batch_0, expected_batch);
        }
        {
            let batch_1 = account.batch_metadata.batches[1];
            let mut expected_batch = Batch::new(
                num_iters,
                bloom_filter_capacity,
                batch_size,
                zkp_batch_size,
                batch_size,
            );
            expected_batch.num_full_zkp_batches = 2;
            expected_batch.start_slot = 1 + batch_size;
            expected_batch.start_slot_is_set = 1;
            expected_batch.advance_state_to_full().unwrap();
            assert_eq!(batch_1, expected_batch);
        }
        // Mark first batch as inserted
        {
            account.batch_metadata.batches[0]
                .advance_state_to_inserted()
                .unwrap();
        }
        // Check that batch is cleared properly.
        {
            assert_eq!(
                account.batch_metadata.get_current_batch().get_state(),
                BatchState::Inserted
            );
            account
                .insert_into_current_batch(&[1u8; 32], &current_slot)
                .unwrap();
            assert_eq!(account.value_vecs[0].as_slice(), [[1u8; 32]].as_slice());
            assert_eq!(account.value_vecs[1].as_slice(), ref_value_array.as_slice());
            assert_eq!(
                account.hash_chain_stores[0].as_slice(),
                [[1u8; 32]].as_slice()
            );
            assert_eq!(
                account.batch_metadata.get_current_batch().get_state(),
                BatchState::Fill
            );
            let mut expected_batch = Batch::new(
                num_iters,
                bloom_filter_capacity,
                batch_size,
                zkp_batch_size,
                batch_size * 2,
            );

            assert_ne!(*account.batch_metadata.get_current_batch(), expected_batch);
            expected_batch.num_inserted = 1;
            expected_batch.start_slot_is_set = 1;
            expected_batch.start_slot = current_slot;
            assert_eq!(*account.batch_metadata.get_current_batch(), expected_batch);

            assert_eq!(account.batch_metadata.get_current_batch().start_index, 8);
        }
        // Fill cleared batch
        {
            let expected_start_slot = current_slot;
            for i in 1..batch_size {
                assert_eq!(account.get_num_inserted_in_current_batch(), i);
                account
                    .insert_into_current_batch(&[1u8; 32], &current_slot)
                    .unwrap();
                current_slot += 1;
            }
            assert_eq!(account.get_num_inserted_in_current_batch(), batch_size);
            let mut expected_batch = Batch::new(
                num_iters,
                bloom_filter_capacity,
                batch_size,
                zkp_batch_size,
                batch_size * 2,
            );

            expected_batch.num_full_zkp_batches = 2;
            expected_batch.advance_state_to_full().unwrap();
            expected_batch.start_slot = expected_start_slot;
            expected_batch.start_slot_is_set = 1;
            assert_eq!(account.batch_metadata.batches[0], expected_batch);
            assert_ne!(*account.batch_metadata.get_current_batch(), expected_batch);
            assert_eq!(
                *account.batch_metadata.get_current_batch(),
                account.batch_metadata.batches[1]
            );
        }
        assert_eq!(account.batch_metadata.next_index, 12);
        // Mark second batch as inserted
        account
            .batch_metadata
            .get_current_batch_mut()
            .advance_state_to_inserted()
            .unwrap();

        {
            let expected_start_slot = current_slot;
            for _ in 0..batch_size {
                assert!(!account.tree_is_full());
                assert!(account.check_tree_is_full().is_ok());
                account
                    .insert_into_current_batch(&[1u8; 32], &current_slot)
                    .unwrap();
                current_slot += 1;
            }
            assert_eq!(account.get_num_inserted_in_current_batch(), batch_size);
            let mut expected_batch = Batch::new(
                num_iters,
                bloom_filter_capacity,
                batch_size,
                zkp_batch_size,
                batch_size * 3,
            );
            expected_batch.num_full_zkp_batches = 2;
            expected_batch.start_slot = expected_start_slot;
            expected_batch.start_slot_is_set = 1;
            expected_batch.advance_state_to_full().unwrap();
            assert_eq!(account.batch_metadata.batches[1], expected_batch);
        }
        assert_eq!(account.batch_metadata.next_index, 16);
        assert!(account.tree_is_full());
        assert_eq!(
            account.check_tree_is_full(),
            Err(BatchedMerkleTreeError::TreeIsFull)
        );
    }
}