Add more V6 tests to zebra-chain, refactor OrchardZSA tests in zebra-test (#62)

* Rename orchard_..._zsa test vector files to orchard_zsa_..., same for structs and consts declardd there

* Add tests for empty tx v6 into zebra-chain

* Add V6 roundtrip tests based on ORCHARD_ZSA_WORKFLOW_BLOCKS test vectors to zebra-chain

* Address PR #62 review comments

* Improve OrchardZSA V6 round-trip and conversion tests

Author: dmidem

zebra-chain/src/primitives/zcash_primitives.rs

@@ -180,12 +180,16 @@ impl TryFrom<&Transaction> for zp_tx::Transaction {
             Transaction::V1 { .. }
             | Transaction::V2 { .. }
             | Transaction::V3 { .. }
-            | Transaction::V4 { .. } => panic!("Zebra only uses librustzcash for V5 transactions"),
+            | Transaction::V4 { .. } => {
+                panic!("Zebra only uses librustzcash for V5/V6 transactions");
+            }
         };
 
         convert_tx_to_librustzcash(
             trans,
-            network_upgrade.branch_id().expect("V5 txs have branch IDs"),
+            network_upgrade
+                .branch_id()
+                .expect("V5/V6 txs have branch IDs"),
         )
     }
 }

zebra-chain/src/transaction/tests/vectors.rs

@@ -30,6 +30,18 @@ lazy_static! {
         sapling_shielded_data: None,
         orchard_shielded_data: None,
     };
+
+    #[cfg(feature = "tx-v6")]
+    pub static ref EMPTY_V6_TX: Transaction = Transaction::V6 {
+        network_upgrade: NetworkUpgrade::Nu7,
+        lock_time: LockTime::min_lock_time_timestamp(),
+        expiry_height: block::Height(0),
+        inputs: Vec::new(),
+        outputs: Vec::new(),
+        sapling_shielded_data: None,
+        orchard_shielded_data: None,
+        orchard_zsa_issue_data: None
+    };
 }
 
 /// Build a mock output list for pre-V5 transactions, with (index+1)
@@ -257,18 +269,9 @@ fn deserialize_large_transaction() {
         .expect_err("transaction should not deserialize due to its size");
 }
 
-// Transaction V5 test vectors
-
-/// An empty transaction v5, with no Orchard, Sapling, or Transparent data
-///
-/// empty transaction are invalid, but Zebra only checks this rule in
-/// zebra_consensus::transaction::Verifier
-#[test]
-fn empty_v5_round_trip() {
+fn tx_round_trip(tx: &Transaction) {
     let _init_guard = zebra_test::init();
 
-    let tx: &Transaction = &EMPTY_V5_TX;
-
     let data = tx.zcash_serialize_to_vec().expect("tx should serialize");
     let tx2: &Transaction = &data
         .zcash_deserialize_into()
@@ -314,18 +317,47 @@ fn empty_v4_round_trip() {
     assert_eq!(data, data2, "data must be equal if structs are equal");
 }
 
-/// Check if an empty V5 transaction can be deserialized by librustzcash too.
+/// An empty transaction v5, with no Orchard, Sapling, or Transparent data
+///
+/// empty transaction are invalid, but Zebra only checks this rule in
+/// zebra_consensus::transaction::Verifier
 #[test]
-fn empty_v5_librustzcash_round_trip() {
+fn empty_v5_round_trip() {
+    tx_round_trip(&EMPTY_V5_TX)
+}
+
+#[cfg(feature = "tx-v6")]
+/// An empty transaction v6, with no Orchard/OrchardZSA, Sapling, or Transparent data
+///
+/// empty transaction are invalid, but Zebra only checks this rule in
+/// zebra_consensus::transaction::Verifier
+#[test]
+fn empty_v6_round_trip() {
+    tx_round_trip(&EMPTY_V6_TX)
+}
+
+fn tx_librustzcash_round_trip(tx: &Transaction) {
     let _init_guard = zebra_test::init();
 
-    let tx: &Transaction = &EMPTY_V5_TX;
     let _alt_tx: zcash_primitives::transaction::Transaction = tx.try_into().expect(
         "librustzcash deserialization might work for empty zebra serialized transactions. \
         Hint: if empty transactions fail, but other transactions work, delete this test",
     );
 }
 
+/// Check if an empty V5 transaction can be deserialized by librustzcash too.
+#[test]
+fn empty_v5_librustzcash_round_trip() {
+    tx_librustzcash_round_trip(&EMPTY_V5_TX);
+}
+
+#[cfg(feature = "tx-v6")]
+/// Check if an empty V6 transaction can be deserialized by librustzcash too.
+#[test]
+fn empty_v6_librustzcash_round_trip() {
+    tx_librustzcash_round_trip(&EMPTY_V6_TX);
+}
+
 /// Do a round-trip test on fake v5 transactions created from v4 transactions
 /// in the block test vectors.
 ///
@@ -450,6 +482,54 @@ fn fake_v5_round_trip_for_network(network: Network) {
     }
 }
 
+#[cfg(feature = "tx-v6")]
+/// Do a serialization round-trip on OrchardZSA workflow blocks and their V6
+/// transactions.
+#[test]
+fn v6_round_trip() {
+    use zebra_test::vectors::ORCHARD_ZSA_WORKFLOW_BLOCKS;
+
+    let _init_guard = zebra_test::init();
+
+    for block_bytes in ORCHARD_ZSA_WORKFLOW_BLOCKS.iter() {
+        let block = block_bytes
+            .zcash_deserialize_into::<Block>()
+            .expect("block is structurally valid");
+
+        // test full blocks
+        let block_bytes2 = block
+            .zcash_serialize_to_vec()
+            .expect("vec serialization is infallible");
+
+        assert_eq!(
+            block_bytes, &block_bytes2,
+            "data must be equal if structs are equal"
+        );
+
+        // test each transaction
+        for tx in &block.transactions {
+            let tx_bytes = tx
+                .zcash_serialize_to_vec()
+                .expect("vec serialization is infallible");
+
+            let tx2 = tx_bytes
+                .zcash_deserialize_into::<Transaction>()
+                .expect("tx is structurally valid");
+
+            assert_eq!(tx.as_ref(), &tx2);
+
+            let tx_bytes2 = tx2
+                .zcash_serialize_to_vec()
+                .expect("vec serialization is infallible");
+
+            assert_eq!(
+                tx_bytes, tx_bytes2,
+                "data must be equal if structs are equal"
+            );
+        }
+    }
+}
+
 #[test]
 fn invalid_orchard_nullifier() {
     let _init_guard = zebra_test::init();
@@ -549,6 +629,34 @@ fn fake_v5_librustzcash_round_trip_for_network(network: Network) {
     }
 }
 
+#[cfg(feature = "tx-v6")]
+/// Confirms each V6 transaction in the OrchardZSA test blocks converts to librustzcash’s
+/// transaction type without error.
+#[test]
+fn v6_librustzcash_tx_conversion() {
+    use zebra_test::vectors::ORCHARD_ZSA_WORKFLOW_BLOCKS;
+
+    let _init_guard = zebra_test::init();
+
+    for block_bytes in ORCHARD_ZSA_WORKFLOW_BLOCKS.iter() {
+        let block = block_bytes
+            .zcash_deserialize_into::<Block>()
+            .expect("block is structurally valid");
+
+        // Test each V6 transaction
+        for tx in block
+            .transactions
+            .iter()
+            .filter(|tx| matches!(tx.as_ref(), &Transaction::V6 { .. }))
+        {
+            let _alt_tx: zcash_primitives::transaction::Transaction = tx
+                .as_ref()
+                .try_into()
+                .expect("librustzcash conversion must work for zebra transactions");
+        }
+    }
+}
+
 #[test]
 fn zip244_round_trip() -> Result<()> {
     let _init_guard = zebra_test::init();

zebra-consensus/src/orchard_zsa/tests.rs

@@ -24,14 +24,14 @@ use zebra_chain::{
 
 use zebra_test::{
     transcript::{ExpectedTranscriptError, Transcript},
-    vectors::ORCHARD_WORKFLOW_BLOCKS_ZSA,
+    vectors::ORCHARD_ZSA_WORKFLOW_BLOCKS,
 };
 
 use crate::{block::Request, Config};
 
 fn create_transcript_data() -> impl Iterator<Item = (Request, Result<Hash, ExpectedTranscriptError>)>
 {
-    let workflow_blocks = ORCHARD_WORKFLOW_BLOCKS_ZSA.iter().map(|block_bytes| {
+    let workflow_blocks = ORCHARD_ZSA_WORKFLOW_BLOCKS.iter().map(|block_bytes| {
         Arc::new(Block::zcash_deserialize(&block_bytes[..]).expect("block should deserialize"))
     });
 

zebra-consensus/src/primitives/halo2/tests.rs

@@ -24,7 +24,6 @@ use zebra_chain::{
 
 use crate::primitives::halo2::*;
 
-// FIXME: Where is this function called from?
 #[allow(dead_code, clippy::print_stdout)]
 fn generate_test_vectors<Flavor: ShieldedDataFlavor>()
 where
@@ -199,7 +198,7 @@ async fn verify_generated_halo2_proofs_vanilla() {
 #[cfg(feature = "tx-v6")]
 #[tokio::test(flavor = "multi_thread")]
 async fn verify_generated_halo2_proofs_zsa() {
-    verify_generated_halo2_proofs::<OrchardZSA>(&zebra_test::vectors::ORCHARD_SHIELDED_DATA_ZSA)
+    verify_generated_halo2_proofs::<OrchardZSA>(&zebra_test::vectors::ORCHARD_ZSA_SHIELDED_DATA)
         .await
 }
 
@@ -291,7 +290,7 @@ async fn correctly_err_on_invalid_halo2_proofs_vanilla() {
 #[tokio::test(flavor = "multi_thread")]
 async fn correctly_err_on_invalid_halo2_proofs_zsa() {
     correctly_err_on_invalid_halo2_proofs::<OrchardZSA>(
-        &zebra_test::vectors::ORCHARD_SHIELDED_DATA_ZSA,
+        &zebra_test::vectors::ORCHARD_ZSA_SHIELDED_DATA,
     )
     .await
 }

zebra-test/src/vectors.rs

@@ -8,20 +8,20 @@ mod orchard_note_encryption;
 mod orchard_shielded_data;
 
 #[cfg(feature = "tx-v6")]
-mod orchard_shielded_data_zsa;
+mod orchard_zsa_shielded_data;
 
 #[cfg(feature = "tx-v6")]
-mod orchard_workflow_blocks_zsa;
+mod orchard_zsa_workflow_blocks;
 
 pub use block::*;
 pub use orchard_note_encryption::*;
 pub use orchard_shielded_data::*;
 
 #[cfg(feature = "tx-v6")]
-pub use orchard_shielded_data_zsa::*;
+pub use orchard_zsa_shielded_data::*;
 
 #[cfg(feature = "tx-v6")]
-pub use orchard_workflow_blocks_zsa::*;
+pub use orchard_zsa_workflow_blocks::*;
 
 /// A testnet transaction test vector
 ///