Refactor insert_fake_orchard_shielded_data into separate V5 and V6 helpers

dmidem · dmidem · commit dab5fd939c22 · 2026-03-26T14:20:37.000Z
diff --git a/zebra-chain/src/orchard/shielded_data_flavor.rs b/zebra-chain/src/orchard/shielded_data_flavor.rs
@@ -52,6 +52,7 @@ pub trait ShieldedDataFlavor: OrchardFlavor {
     /// A type representing a burn field for this protocol version.
     #[cfg(feature = "tx_v6")]
     type BurnType: Clone
+        + Default
         + Debug
         + ZcashDeserialize
         + ZcashSerialize
diff --git a/zebra-chain/src/transaction/arbitrary.rs b/zebra-chain/src/transaction/arbitrary.rs
@@ -1140,22 +1140,13 @@ pub fn transactions_from_blocks<'a>(
     })
 }
 
-// FIXME: make it a generic to support V6?
-/// Modify a V5 transaction to insert fake Orchard shielded data.
-///
 /// Creates a fake instance of [`orchard::ShieldedData`] with one fake action. Note that both the
 /// action and the shielded data are invalid and shouldn't be used in tests that require them to be
 /// valid.
-///
-/// A mutable reference to the inserted shielded data is returned, so that the caller can further
-/// customize it if required.
-///
-/// # Panics
-///
-/// Panics if the transaction to be modified is not V5.
-pub fn insert_fake_orchard_shielded_data(
-    transaction: &mut Transaction,
-) -> &mut orchard::ShieldedData<orchard::OrchardVanilla> {
+pub fn create_fake_orchard_shielded_data<Flavor: orchard::ShieldedDataFlavor + 'static>(
+) -> orchard::ShieldedData<Flavor>
+//where <<Flavor as orchard::ShieldedDataFlavor>::EncryptedNote as Arbitrary>::Strategy: 'static
+{
     // Create a dummy action
     let mut runner = TestRunner::default();
     let dummy_action = orchard::Action::arbitrary()
@@ -1170,7 +1161,7 @@ pub fn insert_fake_orchard_shielded_data(
     };
 
     // Place the dummy action inside the Orchard shielded data
-    let dummy_shielded_data = orchard::ShieldedData::<orchard::OrchardVanilla> {
+    orchard::ShieldedData::<Flavor> {
         flags: orchard::Flags::empty(),
         value_balance: Amount::try_from(0).expect("invalid transaction amount"),
         shared_anchor: orchard::tree::Root::default(),
@@ -1179,15 +1170,27 @@ pub fn insert_fake_orchard_shielded_data(
         binding_sig: Signature::from([0u8; 64]),
         #[cfg(feature = "tx_v6")]
         burn: Default::default(),
-    };
+    }
+}
 
+/// Modify a V5 transaction to insert fake Orchard shielded data.
+///
+/// A mutable reference to the inserted shielded data is returned, so that the caller can further
+/// customize it if required.
+///
+/// # Panics
+///
+/// Panics if the transaction to be modified is not V5.
+pub fn insert_fake_v5_orchard_shielded_data(
+    transaction: &mut Transaction,
+) -> &mut orchard::ShieldedData<orchard::OrchardVanilla> {
     // Replace the shielded data in the transaction
     match transaction {
         Transaction::V5 {
             orchard_shielded_data,
             ..
         } => {
-            *orchard_shielded_data = Some(dummy_shielded_data);
+            *orchard_shielded_data = Some(create_fake_orchard_shielded_data());
 
             orchard_shielded_data
                 .as_mut()
@@ -1196,3 +1199,30 @@ pub fn insert_fake_orchard_shielded_data(
         _ => panic!("Fake V5 transaction is not V5"),
     }
 }
+
+/// Modify a V6 transaction to insert fake Orchard shielded data.
+///
+/// A mutable reference to the inserted shielded data is returned, so that the caller can further
+/// customize it if required.
+///
+/// # Panics
+///
+/// Panics if the transaction to be modified is not V6.
+pub fn insert_fake_v6_orchard_shielded_data(
+    transaction: &mut Transaction,
+) -> &mut orchard::ShieldedData<orchard::OrchardZSA> {
+    // Replace the shielded data in the transaction
+    match transaction {
+        Transaction::V6 {
+            orchard_shielded_data,
+            ..
+        } => {
+            *orchard_shielded_data = Some(create_fake_orchard_shielded_data());
+
+            orchard_shielded_data
+                .as_mut()
+                .expect("shielded data was just inserted")
+        }
+        _ => panic!("Fake V6 transaction is not V6"),
+    }
+}
diff --git a/zebra-consensus/src/transaction/tests.rs b/zebra-consensus/src/transaction/tests.rs
@@ -20,8 +20,8 @@ use zebra_chain::{
     sprout,
     transaction::{
         arbitrary::{
-            fake_v5_transactions_for_network, insert_fake_orchard_shielded_data, test_transactions,
-            transactions_from_blocks,
+            fake_v5_transactions_for_network, insert_fake_v5_orchard_shielded_data,
+            test_transactions, transactions_from_blocks,
         },
         zip317, Hash, HashType, JoinSplitData, LockTime, Transaction,
     },
@@ -77,7 +77,7 @@ fn fake_v5_transaction_with_orchard_actions_has_inputs_and_outputs() {
 
     // Insert fake Orchard shielded data to the transaction, which has at least one action (this is
     // guaranteed structurally by `orchard::ShieldedData`)
-    insert_fake_orchard_shielded_data(&mut transaction);
+    insert_fake_v5_orchard_shielded_data(&mut transaction);
 
     // The check will fail if the transaction has no flags
     assert_eq!(
@@ -86,8 +86,8 @@ fn fake_v5_transaction_with_orchard_actions_has_inputs_and_outputs() {
     );
 
     // If we add ENABLE_SPENDS flag it will pass the inputs check but fails with the outputs
-    // TODO: Avoid new calls to `insert_fake_orchard_shielded_data` for each check #2409.
-    let shielded_data = insert_fake_orchard_shielded_data(&mut transaction);
+    // TODO: Avoid new calls to `insert_fake_v5_orchard_shielded_data` for each check #2409.
+    let shielded_data = insert_fake_v5_orchard_shielded_data(&mut transaction);
     shielded_data.flags = zebra_chain::orchard::Flags::ENABLE_SPENDS;
 
     assert_eq!(
@@ -96,7 +96,7 @@ fn fake_v5_transaction_with_orchard_actions_has_inputs_and_outputs() {
     );
 
     // If we add ENABLE_OUTPUTS flag it will pass the outputs check but fails with the inputs
-    let shielded_data = insert_fake_orchard_shielded_data(&mut transaction);
+    let shielded_data = insert_fake_v5_orchard_shielded_data(&mut transaction);
     shielded_data.flags = zebra_chain::orchard::Flags::ENABLE_OUTPUTS;
 
     assert_eq!(
@@ -105,7 +105,7 @@ fn fake_v5_transaction_with_orchard_actions_has_inputs_and_outputs() {
     );
 
     // Finally make it valid by adding both required flags
-    let shielded_data = insert_fake_orchard_shielded_data(&mut transaction);
+    let shielded_data = insert_fake_v5_orchard_shielded_data(&mut transaction);
     shielded_data.flags =
         zebra_chain::orchard::Flags::ENABLE_SPENDS | zebra_chain::orchard::Flags::ENABLE_OUTPUTS;
 
@@ -131,7 +131,7 @@ fn fake_v5_transaction_with_orchard_actions_has_flags() {
 
     // Insert fake Orchard shielded data to the transaction, which has at least one action (this is
     // guaranteed structurally by `orchard::ShieldedData`)
-    insert_fake_orchard_shielded_data(&mut transaction);
+    insert_fake_v5_orchard_shielded_data(&mut transaction);
 
     // The check will fail if the transaction has no flags
     assert_eq!(
@@ -140,17 +140,17 @@ fn fake_v5_transaction_with_orchard_actions_has_flags() {
     );
 
     // If we add ENABLE_SPENDS flag it will pass.
-    let shielded_data = insert_fake_orchard_shielded_data(&mut transaction);
+    let shielded_data = insert_fake_v5_orchard_shielded_data(&mut transaction);
     shielded_data.flags = zebra_chain::orchard::Flags::ENABLE_SPENDS;
     assert!(check::has_enough_orchard_flags(&transaction).is_ok());
 
     // If we add ENABLE_OUTPUTS flag instead, it will pass.
-    let shielded_data = insert_fake_orchard_shielded_data(&mut transaction);
+    let shielded_data = insert_fake_v5_orchard_shielded_data(&mut transaction);
     shielded_data.flags = zebra_chain::orchard::Flags::ENABLE_OUTPUTS;
     assert!(check::has_enough_orchard_flags(&transaction).is_ok());
 
     // If we add BOTH ENABLE_SPENDS and ENABLE_OUTPUTS flags it will pass.
-    let shielded_data = insert_fake_orchard_shielded_data(&mut transaction);
+    let shielded_data = insert_fake_v5_orchard_shielded_data(&mut transaction);
     shielded_data.flags =
         zebra_chain::orchard::Flags::ENABLE_SPENDS | zebra_chain::orchard::Flags::ENABLE_OUTPUTS;
     assert!(check::has_enough_orchard_flags(&transaction).is_ok());
@@ -823,7 +823,7 @@ fn v5_coinbase_transaction_without_enable_spends_flag_passes_validation() {
     .find(|transaction| transaction.is_coinbase())
     .expect("At least one fake V5 coinbase transaction in the test vectors");
 
-    insert_fake_orchard_shielded_data(&mut transaction);
+    insert_fake_v5_orchard_shielded_data(&mut transaction);
 
     assert!(check::coinbase_tx_no_prevout_joinsplit_spend(&transaction).is_ok());
 }
@@ -838,7 +838,7 @@ fn v5_coinbase_transaction_with_enable_spends_flag_fails_validation() {
     .find(|transaction| transaction.is_coinbase())
     .expect("At least one fake V5 coinbase transaction in the test vectors");
 
-    let shielded_data = insert_fake_orchard_shielded_data(&mut transaction);
+    let shielded_data = insert_fake_v5_orchard_shielded_data(&mut transaction);
 
     shielded_data.flags = zebra_chain::orchard::Flags::ENABLE_SPENDS;
 
@@ -2415,7 +2415,7 @@ fn v5_with_duplicate_orchard_action() {
 
         // Insert fake Orchard shielded data to the transaction, which has at least one action (this is
         // guaranteed structurally by `orchard::ShieldedData`)
-        let shielded_data = insert_fake_orchard_shielded_data(&mut transaction);
+        let shielded_data = insert_fake_v5_orchard_shielded_data(&mut transaction);
 
         // Enable spends
         shielded_data.flags = zebra_chain::orchard::Flags::ENABLE_SPENDS
@@ -2865,7 +2865,7 @@ fn coinbase_outputs_are_decryptable_for_fake_v5_blocks() {
                 })
                 .expect("At least one fake V5 transaction with no inputs and no outputs");
 
-        let shielded_data = insert_fake_orchard_shielded_data(&mut transaction);
+        let shielded_data = insert_fake_v5_orchard_shielded_data(&mut transaction);
         shielded_data.flags = zebra_chain::orchard::Flags::ENABLE_SPENDS
             | zebra_chain::orchard::Flags::ENABLE_OUTPUTS;
 
@@ -2907,7 +2907,7 @@ fn shielded_outputs_are_not_decryptable_for_fake_v5_blocks() {
                 })
                 .expect("At least one fake V5 transaction with no inputs and no outputs");
 
-        let shielded_data = insert_fake_orchard_shielded_data(&mut transaction);
+        let shielded_data = insert_fake_v5_orchard_shielded_data(&mut transaction);
         shielded_data.flags = zebra_chain::orchard::Flags::ENABLE_SPENDS
             | zebra_chain::orchard::Flags::ENABLE_OUTPUTS;
 
