Add V5 transparent and sapling to transaction::check, add missing coinbase PrevOut check

zebra-chain/Cargo.toml

@@ -10,7 +10,7 @@ edition = "2018"
 [features]
 
 default = []
-proptest-impl = ["proptest", "proptest-derive"]
+proptest-impl = ["proptest", "proptest-derive", "itertools"]
 bench = ["zebra-test"]
 
 [dependencies]
@@ -40,6 +40,7 @@ x25519-dalek = { version = "1.1", features = ["serde"] }
 
 proptest = { version = "0.10", optional = true }
 proptest-derive = { version = "0.3.0", optional = true }
+itertools = { version = "0.10.0", optional = true }
 
 # ZF deps
 ed25519-zebra = "2.2.0"
@@ -55,10 +56,9 @@ criterion = { version = "0.3", features = ["html_reports"] }
 spandoc = "0.2"
 tracing = "0.1.25"
 
-itertools = "0.10.0"
-
 proptest = "0.10"
 proptest-derive = "0.3"
+itertools = "0.10.0"
 
 zebra-test = { path = "../zebra-test/" }
 

zebra-chain/src/transaction.rs

@@ -10,7 +10,7 @@ mod serialize;
 mod sighash;
 
 #[cfg(any(test, feature = "proptest-impl"))]
-mod arbitrary;
+pub mod arbitrary;
 #[cfg(test)]
 mod tests;
 
@@ -113,11 +113,63 @@ pub enum Transaction {
 }
 
 impl Transaction {
-    /// Compute the hash of this transaction.
+    // hashes
+
+    /// Compute the hash (id) of this transaction.
     pub fn hash(&self) -> Hash {
         Hash::from(self)
     }
 
+    /// Calculate the sighash for the current transaction
+    ///
+    /// # Details
+    ///
+    /// The `input` argument indicates the transparent Input for which we are
+    /// producing a sighash. It is comprised of the index identifying the
+    /// transparent::Input within the transaction and the transparent::Output
+    /// representing the UTXO being spent by that input.
+    ///
+    /// # Panics
+    ///
+    /// - if passed in any NetworkUpgrade from before NetworkUpgrade::Overwinter
+    /// - if called on a v1 or v2 transaction
+    /// - if the input index points to a transparent::Input::CoinBase
+    /// - if the input index is out of bounds for self.inputs()
+    pub fn sighash(
+        &self,
+        network_upgrade: NetworkUpgrade,
+        hash_type: sighash::HashType,
+        input: Option<(u32, transparent::Output)>,
+    ) -> blake2b_simd::Hash {
+        sighash::SigHasher::new(self, hash_type, network_upgrade, input).sighash()
+    }
+
+    // header
+
+    /// Get this transaction's lock time.
+    pub fn lock_time(&self) -> LockTime {
+        match self {
+            Transaction::V1 { lock_time, .. } => *lock_time,
+            Transaction::V2 { lock_time, .. } => *lock_time,
+            Transaction::V3 { lock_time, .. } => *lock_time,
+            Transaction::V4 { lock_time, .. } => *lock_time,
+            Transaction::V5 { lock_time, .. } => *lock_time,
+        }
+    }
+
+    /// Get this transaction's expiry height, if any.
+    pub fn expiry_height(&self) -> Option<block::Height> {
+        match self {
+            Transaction::V1 { .. } => None,
+            Transaction::V2 { .. } => None,
+            Transaction::V3 { expiry_height, .. } => Some(*expiry_height),
+            Transaction::V4 { expiry_height, .. } => Some(*expiry_height),
+            Transaction::V5 { expiry_height, .. } => Some(*expiry_height),
+        }
+    }
+
+    // transparent
+
     /// Access the transparent inputs of this transaction, regardless of version.
     pub fn inputs(&self) -> &[transparent::Input] {
         match self {
@@ -140,25 +192,65 @@ impl Transaction {
         }
     }
 
-    /// Get this transaction's lock time.
-    pub fn lock_time(&self) -> LockTime {
-        match self {
-            Transaction::V1 { lock_time, .. } => *lock_time,
-            Transaction::V2 { lock_time, .. } => *lock_time,
-            Transaction::V3 { lock_time, .. } => *lock_time,
-            Transaction::V4 { lock_time, .. } => *lock_time,
-            Transaction::V5 { lock_time, .. } => *lock_time,
-        }
+    /// Returns `true` if this transaction is a coinbase transaction.
+    pub fn is_coinbase(&self) -> bool {
+        self.inputs().len() == 1
+            && matches!(
+                self.inputs().get(0),
+                Some(transparent::Input::Coinbase { .. })
+            )
     }
 
-    /// Get this transaction's expiry height, if any.
-    pub fn expiry_height(&self) -> Option<block::Height> {
+    /// Returns `true` if transaction contains any coinbase inputs.
+    pub fn contains_coinbase_input(&self) -> bool {
+        self.inputs()
+            .iter()
+            .any(|input| matches!(input, transparent::Input::Coinbase { .. }))
+    }
+
+    /// Returns `true` if transaction contains any `PrevOut` inputs.
+    ///
+    /// `PrevOut` inputs are also known as `transparent` inputs in the spec.
+    pub fn contains_prevout_input(&self) -> bool {
+        self.inputs()
+            .iter()
+            .any(|input| matches!(input, transparent::Input::PrevOut { .. }))
+    }
+
+    // sprout
+
+    /// Returns the number of `JoinSplit`s in this transaction, regardless of version.
+    pub fn joinsplit_count(&self) -> usize {
         match self {
-            Transaction::V1 { .. } => None,
-            Transaction::V2 { .. } => None,
-            Transaction::V3 { expiry_height, .. } => Some(*expiry_height),
-            Transaction::V4 { expiry_height, .. } => Some(*expiry_height),
-            Transaction::V5 { expiry_height, .. } => Some(*expiry_height),
+            // JoinSplits with Bctv14 Proofs
+            Transaction::V2 {
+                joinsplit_data: Some(joinsplit_data),
+                ..
+            }
+            | Transaction::V3 {
+                joinsplit_data: Some(joinsplit_data),
+                ..
+            } => joinsplit_data.joinsplits().count(),
+            // JoinSplits with Groth Proofs
+            Transaction::V4 {
+                joinsplit_data: Some(joinsplit_data),
+                ..
+            } => joinsplit_data.joinsplits().count(),
+            // No JoinSplits
+            Transaction::V1 { .. }
+            | Transaction::V2 {
+                joinsplit_data: None,
+                ..
+            }
+            | Transaction::V3 {
+                joinsplit_data: None,
+                ..
+            }
+            | Transaction::V4 {
+                joinsplit_data: None,
+                ..
+            }
+            | Transaction::V5 { .. } => 0,
         }
     }
 
@@ -201,6 +293,71 @@ impl Transaction {
         }
     }
 
+    // sapling
+
+    /// Iterate over the sapling [`Spend`](sapling::Spend)s for this transaction,
+    /// returning `Spend<PerSpendAnchor>` regardless of the underlying
+    /// transaction version.
+    ///
+    /// # Correctness
+    ///
+    /// Do not use this function for serialization.
+    pub fn sapling_spends_per_anchor(
+        &self,
+    ) -> Box<dyn Iterator<Item = sapling::Spend<sapling::PerSpendAnchor>> + '_> {
+        match self {
+            Transaction::V4 {
+                sapling_shielded_data: Some(sapling_shielded_data),
+                ..
+            } => Box::new(sapling_shielded_data.spends_per_anchor()),
+            Transaction::V5 {
+                sapling_shielded_data: Some(sapling_shielded_data),
+                ..
+            } => Box::new(sapling_shielded_data.spends_per_anchor()),
+
+            // No Spends
+            Transaction::V1 { .. }
+            | Transaction::V2 { .. }
+            | Transaction::V3 { .. }
+            | Transaction::V4 {
+                sapling_shielded_data: None,
+                ..
+            }
+            | Transaction::V5 {
+                sapling_shielded_data: None,
+                ..
+            } => Box::new(std::iter::empty()),
+        }
+    }
+
+    /// Iterate over the sapling [`Output`](sapling::Output)s for this
+    /// transaction
+    pub fn sapling_outputs(&self) -> Box<dyn Iterator<Item = &sapling::Output> + '_> {
+        match self {
+            Transaction::V4 {
+                sapling_shielded_data: Some(sapling_shielded_data),
+                ..
+            } => Box::new(sapling_shielded_data.outputs()),
+            Transaction::V5 {
+                sapling_shielded_data: Some(sapling_shielded_data),
+                ..
+            } => Box::new(sapling_shielded_data.outputs()),
+
+            // No Outputs
+            Transaction::V1 { .. }
+            | Transaction::V2 { .. }
+            | Transaction::V3 { .. }
+            | Transaction::V4 {
+                sapling_shielded_data: None,
+                ..
+            }
+            | Transaction::V5 {
+                sapling_shielded_data: None,
+                ..
+            } => Box::new(std::iter::empty()),
+        }
+    }
+
     /// Access the sapling::Nullifiers in this transaction, regardless of version.
     pub fn sapling_nullifiers(&self) -> Box<dyn Iterator<Item = &sapling::Nullifier> + '_> {
         // This function returns a boxed iterator because the different
@@ -231,43 +388,5 @@ impl Transaction {
         }
     }
 
-    /// Returns `true` if transaction contains any coinbase inputs.
-    pub fn contains_coinbase_input(&self) -> bool {
-        self.inputs()
-            .iter()
-            .any(|input| matches!(input, transparent::Input::Coinbase { .. }))
-    }
-
-    /// Returns `true` if this transaction is a coinbase transaction.
-    pub fn is_coinbase(&self) -> bool {
-        self.inputs().len() == 1
-            && matches!(
-                self.inputs().get(0),
-                Some(transparent::Input::Coinbase { .. })
-            )
-    }
-
-    /// Calculate the sighash for the current transaction
-    ///
-    /// # Details
-    ///
-    /// The `input` argument indicates the transparent Input for which we are
-    /// producing a sighash. It is comprised of the index identifying the
-    /// transparent::Input within the transaction and the transparent::Output
-    /// representing the UTXO being spent by that input.
-    ///
-    /// # Panics
-    ///
-    /// - if passed in any NetworkUpgrade from before NetworkUpgrade::Overwinter
-    /// - if called on a v1 or v2 transaction
-    /// - if the input index points to a transparent::Input::CoinBase
-    /// - if the input index is out of bounds for self.inputs()
-    pub fn sighash(
-        &self,
-        network_upgrade: NetworkUpgrade,
-        hash_type: sighash::HashType,
-        input: Option<(u32, transparent::Output)>,
-    ) -> blake2b_simd::Hash {
-        sighash::SigHasher::new(self, hash_type, network_upgrade, input).sighash()
-    }
+    // TODO: orchard
 }