Make transparent tests generic over backend implementation and move to zcash_client_backend crate

zcash_client_backend/src/data_api/testing.rs

@@ -88,6 +88,8 @@ use {
 pub mod orchard;
 pub mod pool;
 pub mod sapling;
+#[cfg(feature = "transparent-inputs")]
+pub mod transparent;
 
 /// Information about a transaction that the wallet is interested in.
 pub struct TransactionSummary<AccountId> {

zcash_client_backend/src/data_api/testing/transparent.rs

@@ -0,0 +1,242 @@
+use crate::{
+    data_api::{
+        testing::{AddressType, TestBuilder, TestState},
+        testing::{DataStoreFactory, ShieldedProtocol, TestCache},
+        wallet::input_selection::GreedyInputSelector,
+        Account as _, InputSource, WalletRead, WalletWrite,
+    },
+    fees::{fixed, DustOutputPolicy},
+    wallet::WalletTransparentOutput,
+};
+use assert_matches::assert_matches;
+use sapling::zip32::ExtendedSpendingKey;
+use zcash_primitives::{
+    block::BlockHash,
+    transaction::{
+        components::{amount::NonNegativeAmount, OutPoint, TxOut},
+        fees::fixed::FeeRule as FixedFeeRule,
+    },
+};
+
+pub fn put_received_transparent_utxo<DSF>(dsf: DSF)
+where
+    DSF: DataStoreFactory,
+    <<DSF as DataStoreFactory>::DataStore as WalletWrite>::UtxoRef: std::fmt::Debug + PartialEq,
+{
+    let mut st = TestBuilder::new()
+        .with_data_store_factory(dsf)
+        .with_account_from_sapling_activation(BlockHash([0; 32]))
+        .build();
+
+    let birthday = st.test_account().unwrap().birthday().height();
+    let account_id = st.test_account().unwrap().id();
+    let uaddr = st
+        .wallet()
+        .get_current_address(account_id)
+        .unwrap()
+        .unwrap();
+    let taddr = uaddr.transparent().unwrap();
+
+    let height_1 = birthday + 12345;
+    st.wallet_mut().update_chain_tip(height_1).unwrap();
+
+    let bal_absent = st
+        .wallet()
+        .get_transparent_balances(account_id, height_1)
+        .unwrap();
+    assert!(bal_absent.is_empty());
+
+    // Create a fake transparent output.
+    let value = NonNegativeAmount::const_from_u64(100000);
+    let outpoint = OutPoint::fake();
+    let txout = TxOut {
+        value,
+        script_pubkey: taddr.script(),
+    };
+
+    // Pretend the output's transaction was mined at `height_1`.
+    let utxo = WalletTransparentOutput::from_parts(outpoint.clone(), txout.clone(), Some(height_1))
+        .unwrap();
+    let res0 = st.wallet_mut().put_received_transparent_utxo(&utxo);
+    assert_matches!(res0, Ok(_));
+
+    // Confirm that we see the output unspent as of `height_1`.
+    assert_matches!(
+        st.wallet().get_spendable_transparent_outputs(
+            taddr,
+            height_1,
+            0
+        ).as_deref(),
+        Ok([ret]) if (ret.outpoint(), ret.txout(), ret.mined_height()) == (utxo.outpoint(), utxo.txout(), Some(height_1))
+    );
+    assert_matches!(
+        st.wallet().get_unspent_transparent_output(utxo.outpoint()),
+        Ok(Some(ret)) if (ret.outpoint(), ret.txout(), ret.mined_height()) == (utxo.outpoint(), utxo.txout(), Some(height_1))
+    );
+
+    // Change the mined height of the UTXO and upsert; we should get back
+    // the same `UtxoId`.
+    let height_2 = birthday + 34567;
+    st.wallet_mut().update_chain_tip(height_2).unwrap();
+    let utxo2 = WalletTransparentOutput::from_parts(outpoint, txout, Some(height_2)).unwrap();
+    let res1 = st.wallet_mut().put_received_transparent_utxo(&utxo2);
+    assert_matches!(res1, Ok(id) if id == res0.unwrap());
+
+    // Confirm that we no longer see any unspent outputs as of `height_1`.
+    assert_matches!(
+        st.wallet()
+            .get_spendable_transparent_outputs(taddr, height_1, 0)
+            .as_deref(),
+        Ok(&[])
+    );
+
+    // We can still look up the specific output, and it has the expected height.
+    assert_matches!(
+        st.wallet().get_unspent_transparent_output(utxo2.outpoint()),
+        Ok(Some(ret)) if (ret.outpoint(), ret.txout(), ret.mined_height()) == (utxo2.outpoint(), utxo2.txout(), Some(height_2))
+    );
+
+    // If we include `height_2` then the output is returned.
+    assert_matches!(
+        st.wallet()
+            .get_spendable_transparent_outputs(taddr, height_2, 0)
+            .as_deref(),
+        Ok([ret]) if (ret.outpoint(), ret.txout(), ret.mined_height()) == (utxo.outpoint(), utxo.txout(), Some(height_2))
+    );
+
+    assert_matches!(
+        st.wallet().get_transparent_balances(account_id, height_2),
+        Ok(h) if h.get(taddr) == Some(&value)
+    );
+}
+
+pub fn transparent_balance_across_shielding<DSF>(dsf: DSF, cache: impl TestCache)
+where
+    DSF: DataStoreFactory,
+{
+    let mut st = TestBuilder::new()
+        .with_data_store_factory(dsf)
+        .with_block_cache(cache)
+        .with_account_from_sapling_activation(BlockHash([0; 32]))
+        .build();
+
+    let account = st.test_account().cloned().unwrap();
+    let uaddr = st
+        .wallet()
+        .get_current_address(account.id())
+        .unwrap()
+        .unwrap();
+    let taddr = uaddr.transparent().unwrap();
+
+    // Initialize the wallet with chain data that has no shielded notes for us.
+    let not_our_key = ExtendedSpendingKey::master(&[]).to_diversifiable_full_viewing_key();
+    let not_our_value = NonNegativeAmount::const_from_u64(10000);
+    let (start_height, _, _) =
+        st.generate_next_block(&not_our_key, AddressType::DefaultExternal, not_our_value);
+    for _ in 1..10 {
+        st.generate_next_block(&not_our_key, AddressType::DefaultExternal, not_our_value);
+    }
+    st.scan_cached_blocks(start_height, 10);
+
+    let check_balance = |st: &TestState<_, DSF::DataStore, _>, min_confirmations: u32, expected| {
+        // Check the wallet summary returns the expected transparent balance.
+        let summary = st
+            .wallet()
+            .get_wallet_summary(min_confirmations)
+            .unwrap()
+            .unwrap();
+        let balance = summary.account_balances().get(&account.id()).unwrap();
+        // TODO: in the future, we will distinguish between available and total
+        // balance according to `min_confirmations`
+        assert_eq!(balance.unshielded(), expected);
+
+        // Check the older APIs for consistency.
+        let mempool_height = st.wallet().chain_height().unwrap().unwrap() + 1;
+        assert_eq!(
+            st.wallet()
+                .get_transparent_balances(account.id(), mempool_height)
+                .unwrap()
+                .get(taddr)
+                .cloned()
+                .unwrap_or(NonNegativeAmount::ZERO),
+            expected,
+        );
+        assert_eq!(
+            st.wallet()
+                .get_spendable_transparent_outputs(taddr, mempool_height, 0)
+                .unwrap()
+                .into_iter()
+                .map(|utxo| utxo.value())
+                .sum::<Option<NonNegativeAmount>>(),
+            Some(expected),
+        );
+    };
+
+    // The wallet starts out with zero balance.
+    // TODO: Once we have refactored `get_wallet_summary` to distinguish between available
+    // and total balance, we should perform additional checks against available balance;
+    // we use minconf 0 here because all transparent funds are considered shieldable,
+    // irrespective of confirmation depth.
+    check_balance(&st, 0, NonNegativeAmount::ZERO);
+
+    // Create a fake transparent output.
+    let value = NonNegativeAmount::from_u64(100000).unwrap();
+    let txout = TxOut {
+        value,
+        script_pubkey: taddr.script(),
+    };
+
+    // Pretend the output was received in the chain tip.
+    let height = st.wallet().chain_height().unwrap().unwrap();
+    let utxo = WalletTransparentOutput::from_parts(OutPoint::fake(), txout, Some(height)).unwrap();
+    st.wallet_mut()
+        .put_received_transparent_utxo(&utxo)
+        .unwrap();
+
+    // The wallet should detect the balance as available
+    check_balance(&st, 0, value);
+
+    // Shield the output.
+    let input_selector = GreedyInputSelector::new(
+        fixed::SingleOutputChangeStrategy::new(
+            FixedFeeRule::non_standard(NonNegativeAmount::ZERO),
+            None,
+            ShieldedProtocol::Sapling,
+        ),
+        DustOutputPolicy::default(),
+    );
+    let txid = st
+        .shield_transparent_funds(&input_selector, value, account.usk(), &[*taddr], 1)
+        .unwrap()[0];
+
+    // The wallet should have zero transparent balance, because the shielding
+    // transaction can be mined.
+    check_balance(&st, 0, NonNegativeAmount::ZERO);
+
+    // Mine the shielding transaction.
+    let (mined_height, _) = st.generate_next_block_including(txid);
+    st.scan_cached_blocks(mined_height, 1);
+
+    // The wallet should still have zero transparent balance.
+    check_balance(&st, 0, NonNegativeAmount::ZERO);
+
+    // Unmine the shielding transaction via a reorg.
+    st.wallet_mut()
+        .truncate_to_height(mined_height - 1)
+        .unwrap();
+    assert_eq!(st.wallet().chain_height().unwrap(), Some(mined_height - 1));
+
+    // The wallet should still have zero transparent balance.
+    check_balance(&st, 0, NonNegativeAmount::ZERO);
+
+    // Expire the shielding transaction.
+    let expiry_height = st
+        .wallet()
+        .get_transaction(txid)
+        .unwrap()
+        .expect("Transaction exists in the wallet.")
+        .expiry_height();
+    st.wallet_mut().update_chain_tip(expiry_height).unwrap();
+
+    check_balance(&st, 0, value);
+}