zcash_primitives: Generalise TransactionData protocol-specific bundles

zcash · May 16, 2024 · c9c2486 · c9c2486
1 parent 70f412c
commit c9c2486
Show file tree

Hide file tree

Showing 10 changed files with 314 additions and 136 deletions.
diff --git a/zcash_primitives/src/transaction/builder.rs b/zcash_primitives/src/transaction/builder.rs
@@ -21,6 +21,7 @@ use crate::{
         components::{
             amount::{Amount, BalanceError},
             transparent::{self, builder::TransparentBuilder, TxOut},
+            AllBundles,
         },
         fees::FeeRule,
         sighash::{signature_hash, SignableInput},
@@ -285,7 +286,7 @@ pub struct Builder<'a, P, U: sapling::builder::ProverProgress> {
     sapling_asks: Vec<sapling::keys::SpendAuthorizingKey>,
     orchard_saks: Vec<orchard::keys::SpendAuthorizingKey>,
     #[cfg(zcash_unstable = "zfuture")]
-    tze_builder: TzeBuilder<'a, TransactionData<Unauthorized>>,
+    tze_builder: TzeBuilder<'a, TransactionData<AllBundles<Unauthorized>>>,
     #[cfg(not(zcash_unstable = "zfuture"))]
     tze_builder: std::marker::PhantomData<&'a ()>,
     progress_notifier: U,
@@ -737,7 +738,7 @@ impl<'a, P: consensus::Parameters, U: sapling::builder::ProverProgress> Builder<
         #[cfg(zcash_unstable = "zfuture")]
         let (tze_bundle, tze_signers) = self.tze_builder.build();
 
-        let unauthed_tx: TransactionData<Unauthorized> = TransactionData {
+        let unauthed_tx: TransactionData<AllBundles<Unauthorized>> = TransactionData {
             version,
             consensus_branch_id: BranchId::for_height(&self.params, self.target_height),
             lock_time: 0,
@@ -756,7 +757,7 @@ impl<'a, P: consensus::Parameters, U: sapling::builder::ProverProgress> Builder<
         let txid_parts = unauthed_tx.digest(TxIdDigester);
 
         let transparent_bundle = unauthed_tx.transparent_bundle.clone().map(|b| {
-            b.apply_signatures(
+            b.apply_signatures::<_, _, AllBundles<Unauthorized>>(
                 #[cfg(feature = "transparent-inputs")]
                 &unauthed_tx,
                 #[cfg(feature = "transparent-inputs")]
@@ -832,7 +833,7 @@ impl<'a, P: consensus::Parameters, U: sapling::builder::ProverProgress> Builder<
 impl<'a, P: consensus::Parameters, U: sapling::builder::ProverProgress> ExtensionTxBuilder<'a>
     for Builder<'a, P, U>
 {
-    type BuildCtx = TransactionData<Unauthorized>;
+    type BuildCtx = TransactionData<AllBundles<Unauthorized>>;
     type BuildError = tze::builder::Error;
 
     fn add_tze_input<WBuilder, W: ToPayload>(

diff --git a/zcash_primitives/src/transaction/components.rs b/zcash_primitives/src/transaction/components.rs
@@ -34,9 +34,38 @@ pub use crate::sapling::bundle::{OutputDescription, SpendDescription};
 #[cfg(zcash_unstable = "zfuture")]
 pub use self::tze::{TzeIn, TzeOut};
 
+use super::Authorization;
+
 // π_A + π_B + π_C
 pub const GROTH_PROOF_SIZE: usize = 48 + 96 + 48;
 
+/// The protocol-specific bundles of data within a transaction.
+pub trait Bundles {
+    type Transparent: TransparentPart;
+    type Sprout: SproutPart;
+    type Sapling: SaplingPart;
+    type Orchard: OrchardPart;
+
+    #[cfg(zcash_unstable = "zfuture")]
+    type Tze: TzePart;
+}
+
+/// Marker type for a transaction that may contain payments within any Zcash protocol.
+#[derive(Debug)]
+pub struct AllBundles<A: Authorization> {
+    _auth: PhantomData<A>,
+}
+
+impl<A: Authorization> Bundles for AllBundles<A> {
+    type Transparent = Transparent<A::TransparentAuth>;
+    type Sprout = Sprout;
+    type Sapling = Sapling<A::SaplingAuth>;
+    type Orchard = Orchard<A::OrchardAuth>;
+
+    #[cfg(zcash_unstable = "zfuture")]
+    type Tze = Tze<A::TzeAuth>;
+}
+
 /// The protocol-agnostic parts of a shielded bundle.
 ///
 /// The trait methods can be implemented without any knowledge of protocol-specific

diff --git a/zcash_primitives/src/transaction/components/transparent/builder.rs b/zcash_primitives/src/transaction/components/transparent/builder.rs
@@ -5,6 +5,7 @@ use std::fmt;
 use crate::{
     legacy::{Script, TransparentAddress},
     transaction::{
+        self as tx,
         components::{
             amount::{Amount, BalanceError, NonNegativeAmount},
             transparent::{self, Authorization, Authorized, Bundle, TxIn, TxOut},
@@ -16,7 +17,6 @@ use crate::{
 #[cfg(feature = "transparent-inputs")]
 use {
     crate::transaction::{
-        self as tx,
         components::transparent::OutPoint,
         sighash::{signature_hash, SignableInput, SIGHASH_ALL},
         TransactionData, TxDigests,
@@ -239,9 +239,14 @@ impl TransparentAuthorizingContext for Unauthorized {
 }
 
 impl Bundle<Unauthorized> {
-    pub fn apply_signatures(
+    pub fn apply_signatures<
+        Sp: tx::sighash_v4::SproutSigDigester,
+        Sa: tx::sighash_v4::SaplingSigDigester,
+        B: tx::Bundles<Transparent = tx::Transparent<Unauthorized>, Sprout = Sp, Sapling = Sa>
+            + tx::sighash_v5::FutureBundles,
+    >(
         self,
-        #[cfg(feature = "transparent-inputs")] mtx: &TransactionData<tx::Unauthorized>,
+        #[cfg(feature = "transparent-inputs")] mtx: &TransactionData<B>,
         #[cfg(feature = "transparent-inputs")] txid_parts_cache: &TxDigests<Blake2bHash>,
     ) -> Bundle<Authorized> {
         #[cfg(feature = "transparent-inputs")]

diff --git a/zcash_primitives/src/transaction/components/tze/builder.rs b/zcash_primitives/src/transaction/components/tze/builder.rs
@@ -157,8 +157,8 @@ impl<'a, BuildCtx> TzeBuilder<'a, BuildCtx> {
 impl Bundle<Unauthorized> {
     pub fn into_authorized(
         self,
-        unauthed_tx: &tx::TransactionData<tx::Unauthorized>,
-        signers: Vec<TzeSigner<'_, tx::TransactionData<tx::Unauthorized>>>,
+        unauthed_tx: &tx::TransactionData<tx::AllBundles<tx::Unauthorized>>,
+        signers: Vec<TzeSigner<'_, tx::TransactionData<tx::AllBundles<tx::Unauthorized>>>>,
     ) -> Result<Bundle<Authorized>, Error> {
         // Create TZE input witnesses
         let payloads = signers