chore(deps): pin librustzcash crates to NU6.3 testnet-supporting pre-release version. (#10789)

chore(deps): pin librustzcash crates to NU6.3-testnet supporting versions

Add [patch.crates-io] directives pinning equihash, f4jumble, transparent
(zcash_transparent), and the zcash_* crates to librustzcash main
(rev 703fe3e6608fab8be0dedbbcbf684f030a1ea451).

Removes the `zcash_unstable=nu6.3` config flag gates and updates the
miner-reward transaction builders in zebra-rpc to adapt to the removed
lifetime parameter on zcash_primitives' transaction `Builder` (now
`Builder<P, U>` instead of `Builder<'a, P, U>`).

Author: nuttycom

CHANGELOG.md

@@ -9,10 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 ### Added
 
-- Experimental, off-by-default support for the NU6.3 "Ironwood" shielded pool and
-  v6 transaction format, behind the `zcash_unstable="nu6.3"` cfg. This is incomplete
-  pending the deploy ZIP (no real activation height, version group ID, or consensus
-  branch ID yet) and is not built by default.
+- Experimental support for the NU6.3 "Ironwood" shielded pool and v6 transaction
+  format. This is incomplete pending the deploy ZIP (no real activation height,
+  version group ID, or consensus branch ID yet), so it cannot activate on any
+  network.
 - Added a Regtest configuration option, `should_allow_unshielded_coinbase_spends`,
   to forbid spending coinbase outputs into transparent outputs (the inverse of
   zcashd's `-regtestshieldcoinbase`). It defaults to allowing such spends, preserving

Cargo.lock

@@ -1551,24 +1551,14 @@ dependencies = [
 [[package]]
 name = "equihash"
 version = "0.3.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "306286e8dcc39ab3dfceb74c792ce8baffdab90591321d3ffaae64829734c37f"
+source = "git+https://github.com/zcash/librustzcash.git?rev=703fe3e6608fab8be0dedbbcbf684f030a1ea451#703fe3e6608fab8be0dedbbcbf684f030a1ea451"
 dependencies = [
  "blake2b_simd",
  "cc",
  "corez",
  "document-features",
 ]
 
-[[package]]
-name = "equihash"
-version = "0.3.0"
-source = "git+https://github.com/valargroup/librustzcash?branch=adam%2Fironwood-split-2-v6-txid#d098a6d7f5f62aa1d50c936f16d81428e17a2898"
-dependencies = [
- "blake2b_simd",
- "corez",
-]
-
 [[package]]
 name = "equivalent"
 version = "1.0.2"
@@ -1609,7 +1599,7 @@ dependencies = [
 [[package]]
 name = "f4jumble"
 version = "0.1.1"
-source = "git+https://github.com/valargroup/librustzcash?branch=adam%2Fironwood-split-2-v6-txid#d098a6d7f5f62aa1d50c936f16d81428e17a2898"
+source = "git+https://github.com/zcash/librustzcash.git?rev=703fe3e6608fab8be0dedbbcbf684f030a1ea451#703fe3e6608fab8be0dedbbcbf684f030a1ea451"
 dependencies = [
  "blake2b_simd",
 ]
@@ -3577,8 +3567,9 @@ checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d"
 
 [[package]]
 name = "orchard"
-version = "0.14.0"
-source = "git+https://github.com/valargroup/qr_orchard?rev=6f1a5eaddcf0e016101c0c62a477d48f31e7a83f#6f1a5eaddcf0e016101c0c62a477d48f31e7a83f"
+version = "0.15.0-pre.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e8e277dd4b46f5d06deae3ffb8af1a951e8622368f028c2a4d6fe59339566403"
 dependencies = [
  "aes",
  "bitvec",
@@ -7118,8 +7109,8 @@ dependencies = [
 
 [[package]]
 name = "zcash_address"
-version = "0.12.0"
-source = "git+https://github.com/valargroup/librustzcash?branch=adam%2Fironwood-split-2-v6-txid#d098a6d7f5f62aa1d50c936f16d81428e17a2898"
+version = "0.13.0-pre.0"
+source = "git+https://github.com/zcash/librustzcash.git?rev=703fe3e6608fab8be0dedbbcbf684f030a1ea451#703fe3e6608fab8be0dedbbcbf684f030a1ea451"
 dependencies = [
  "bech32",
  "bs58",
@@ -7132,7 +7123,7 @@ dependencies = [
 [[package]]
 name = "zcash_encoding"
 version = "0.4.0"
-source = "git+https://github.com/valargroup/librustzcash?branch=adam%2Fironwood-split-2-v6-txid#d098a6d7f5f62aa1d50c936f16d81428e17a2898"
+source = "git+https://github.com/zcash/librustzcash.git?rev=703fe3e6608fab8be0dedbbcbf684f030a1ea451#703fe3e6608fab8be0dedbbcbf684f030a1ea451"
 dependencies = [
  "corez",
  "hex",
@@ -7141,8 +7132,8 @@ dependencies = [
 
 [[package]]
 name = "zcash_history"
-version = "0.4.0"
-source = "git+https://github.com/valargroup/librustzcash?branch=adam%2Fironwood-split-2-v6-txid#d098a6d7f5f62aa1d50c936f16d81428e17a2898"
+version = "0.5.0-pre.0"
+source = "git+https://github.com/zcash/librustzcash.git?rev=703fe3e6608fab8be0dedbbcbf684f030a1ea451#703fe3e6608fab8be0dedbbcbf684f030a1ea451"
 dependencies = [
  "blake2b_simd",
  "byteorder",
@@ -7151,8 +7142,8 @@ dependencies = [
 
 [[package]]
 name = "zcash_keys"
-version = "0.14.0"
-source = "git+https://github.com/valargroup/librustzcash?branch=adam%2Fironwood-split-2-v6-txid#d098a6d7f5f62aa1d50c936f16d81428e17a2898"
+version = "0.15.0-pre.0"
+source = "git+https://github.com/zcash/librustzcash.git?rev=703fe3e6608fab8be0dedbbcbf684f030a1ea451#703fe3e6608fab8be0dedbbcbf684f030a1ea451"
 dependencies = [
  "bech32",
  "blake2b_simd",
@@ -7191,15 +7182,15 @@ dependencies = [
 
 [[package]]
 name = "zcash_primitives"
-version = "0.28.0"
-source = "git+https://github.com/valargroup/librustzcash?branch=adam%2Fironwood-split-2-v6-txid#d098a6d7f5f62aa1d50c936f16d81428e17a2898"
+version = "0.29.0-pre.0"
+source = "git+https://github.com/zcash/librustzcash.git?rev=703fe3e6608fab8be0dedbbcbf684f030a1ea451#703fe3e6608fab8be0dedbbcbf684f030a1ea451"
 dependencies = [
  "blake2b_simd",
  "block-buffer 0.11.0-rc.3",
  "corez",
  "crypto-common 0.2.0-rc.1",
  "document-features",
- "equihash 0.3.0 (git+https://github.com/valargroup/librustzcash?branch=adam%2Fironwood-split-2-v6-txid)",
+ "equihash",
  "ff",
  "hex",
  "incrementalmerkletree",
@@ -7221,8 +7212,8 @@ dependencies = [
 
 [[package]]
 name = "zcash_proofs"
-version = "0.28.0"
-source = "git+https://github.com/valargroup/librustzcash?branch=adam%2Fironwood-split-2-v6-txid#d098a6d7f5f62aa1d50c936f16d81428e17a2898"
+version = "0.29.0-pre.0"
+source = "git+https://github.com/zcash/librustzcash.git?rev=703fe3e6608fab8be0dedbbcbf684f030a1ea451#703fe3e6608fab8be0dedbbcbf684f030a1ea451"
 dependencies = [
  "bellman",
  "blake2b_simd",
@@ -7243,8 +7234,8 @@ dependencies = [
 
 [[package]]
 name = "zcash_protocol"
-version = "0.9.0"
-source = "git+https://github.com/valargroup/librustzcash?branch=adam%2Fironwood-split-2-v6-txid#d098a6d7f5f62aa1d50c936f16d81428e17a2898"
+version = "0.10.0-pre.0"
+source = "git+https://github.com/zcash/librustzcash.git?rev=703fe3e6608fab8be0dedbbcbf684f030a1ea451#703fe3e6608fab8be0dedbbcbf684f030a1ea451"
 dependencies = [
  "corez",
  "document-features",
@@ -7281,8 +7272,8 @@ dependencies = [
 
 [[package]]
 name = "zcash_transparent"
-version = "0.8.0"
-source = "git+https://github.com/valargroup/librustzcash?branch=adam%2Fironwood-split-2-v6-txid#d098a6d7f5f62aa1d50c936f16d81428e17a2898"
+version = "0.9.0-pre.0"
+source = "git+https://github.com/zcash/librustzcash.git?rev=703fe3e6608fab8be0dedbbcbf684f030a1ea451#703fe3e6608fab8be0dedbbcbf684f030a1ea451"
 dependencies = [
  "bip32",
  "bs58",
@@ -7322,7 +7313,7 @@ dependencies = [
  "derive-getters",
  "dirs",
  "ed25519-zebra",
- "equihash 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)",
+ "equihash",
  "futures",
  "group",
  "halo2_proofs",

Cargo.toml

@@ -30,16 +30,16 @@ edition = "2021"
 
 [workspace.dependencies]
 incrementalmerkletree = { version = "0.8.2", features = ["legacy-api"] }
-orchard = "0.14"
+orchard = "0.15.0-pre.1"
 sapling-crypto = "0.7"
-zcash_address = "0.12"
+zcash_address = "0.13.0-pre.0"
 zcash_encoding = "0.4"
-zcash_history = "0.4"
-zcash_keys = "0.14"
-zcash_primitives = "0.28"
-zcash_proofs = "0.28"
-zcash_transparent = "0.8"
-zcash_protocol = "0.9"
+zcash_history = "0.5.0-pre.0"
+zcash_keys = "0.15.0-pre.0"
+zcash_primitives = "0.29.0-pre.0"
+zcash_proofs = "0.29.0-pre.0"
+zcash_transparent = "0.9.0-pre.0"
+zcash_protocol = "0.10.0-pre.0"
 zip32 = "0.2"
 abscissa_core = "0.7"
 base64 = "0.22.1"
@@ -329,7 +329,7 @@ debug = false
 # The linter should ignore these expected config flags/values
 unexpected_cfgs = { level = "warn", check-cfg = [
     'cfg(tokio_unstable)', # Used by tokio-console
-    'cfg(zcash_unstable, values("zfuture", "nu6.1", "nu6.3", "nu7", "zip235"))' # Used in Zebra and librustzcash
+    'cfg(zcash_unstable, values("zfuture", "nu6.1", "nu7", "zip235"))' # Used in Zebra and librustzcash
 ] }
 
 # High-risk code
@@ -379,19 +379,15 @@ unwrap_in_result = "warn"
 # TODOs: fix this lint eventually
 result_large_err = "allow"
 
-# EXPERIMENTAL (NU6.3 / Ironwood spike): pin the librustzcash family to the
-# valargroup fork that adds v6 Ironwood txid/sighash support, and orchard to the
-# matching qr_orchard fork it depends on. Versions match our crates.io pins
-# (zcash_primitives 0.28, zcash_protocol 0.9, orchard 0.14), so this is a
-# source-only patch. Revert this block to return to the released crates.
-# Fork branch is force-pushed; pin to a rev before relying on this.
 [patch.crates-io]
-zcash_primitives = { git = "https://github.com/valargroup/librustzcash", branch = "adam/ironwood-split-2-v6-txid" }
-zcash_protocol = { git = "https://github.com/valargroup/librustzcash", branch = "adam/ironwood-split-2-v6-txid" }
-zcash_proofs = { git = "https://github.com/valargroup/librustzcash", branch = "adam/ironwood-split-2-v6-txid" }
-zcash_keys = { git = "https://github.com/valargroup/librustzcash", branch = "adam/ironwood-split-2-v6-txid" }
-zcash_address = { git = "https://github.com/valargroup/librustzcash", branch = "adam/ironwood-split-2-v6-txid" }
-zcash_encoding = { git = "https://github.com/valargroup/librustzcash", branch = "adam/ironwood-split-2-v6-txid" }
-zcash_transparent = { git = "https://github.com/valargroup/librustzcash", branch = "adam/ironwood-split-2-v6-txid" }
-zcash_history = { git = "https://github.com/valargroup/librustzcash", branch = "adam/ironwood-split-2-v6-txid" }
-orchard = { git = "https://github.com/valargroup/qr_orchard", rev = "6f1a5eaddcf0e016101c0c62a477d48f31e7a83f" }
+# TEMPORARY: Pin librustzcash crates to https://github.com/zcash/librustzcash/pull/2509
+equihash = { git = "https://github.com/zcash/librustzcash.git", rev = "703fe3e6608fab8be0dedbbcbf684f030a1ea451" }
+f4jumble = { git = "https://github.com/zcash/librustzcash.git", rev = "703fe3e6608fab8be0dedbbcbf684f030a1ea451" }
+transparent = { package = "zcash_transparent", git = "https://github.com/zcash/librustzcash.git", rev = "703fe3e6608fab8be0dedbbcbf684f030a1ea451" }
+zcash_address = { git = "https://github.com/zcash/librustzcash.git", rev = "703fe3e6608fab8be0dedbbcbf684f030a1ea451" }
+zcash_encoding = { git = "https://github.com/zcash/librustzcash.git", rev = "703fe3e6608fab8be0dedbbcbf684f030a1ea451" }
+zcash_history = { git = "https://github.com/zcash/librustzcash.git", rev = "703fe3e6608fab8be0dedbbcbf684f030a1ea451" }
+zcash_keys = { git = "https://github.com/zcash/librustzcash.git", rev = "703fe3e6608fab8be0dedbbcbf684f030a1ea451" }
+zcash_primitives = { git = "https://github.com/zcash/librustzcash.git", rev = "703fe3e6608fab8be0dedbbcbf684f030a1ea451" }
+zcash_proofs = { git = "https://github.com/zcash/librustzcash.git", rev = "703fe3e6608fab8be0dedbbcbf684f030a1ea451" }
+zcash_protocol = { git = "https://github.com/zcash/librustzcash.git", rev = "703fe3e6608fab8be0dedbbcbf684f030a1ea451" }

zebra-chain/src/block/arbitrary.rs

@@ -608,7 +608,6 @@ where
                 sapling_shielded_data,
                 ..
             } => *sapling_shielded_data = None,
-            #[cfg(zcash_unstable = "nu6.3")]
             Transaction::V6 {
                 sapling_shielded_data,
                 ..

zebra-chain/src/ironwood.rs

@@ -7,10 +7,8 @@
 //! value pool — while reusing all of Orchard's wire-format and proof-verification machinery.
 //!
 //! The Ironwood *state* (nullifier set, note commitment tree, anchors, and chain value pool) is
-//! always compiled, so the on-disk database format is stable across build flags; it simply stays
-//! empty until NU6.3 transactions appear (which only happens in the experimental
-//! `zcash_unstable="nu6.3"` build). The Ironwood *transaction bundle*
-//! ([`ShieldedData`]) is only compiled for that experimental build.
+//! always present, so the on-disk database format is stable; it simply stays empty until NU6.3
+//! transactions appear on-chain.
 
 use crate::orchard;
 
@@ -39,11 +37,9 @@ impl From<orchard::Nullifier> for Nullifier {
 /// Orchard bundle; this newtype keeps the two type-distinct so they cannot be accidentally
 /// interchanged, and so the Ironwood bundle can commit into a separate note commitment tree and
 /// nullifier set.
-#[cfg(zcash_unstable = "nu6.3")]
 #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
 pub struct ShieldedData(orchard::ShieldedDataV6);
 
-#[cfg(zcash_unstable = "nu6.3")]
 impl ShieldedData {
     /// Wraps a v6 Orchard-protocol bundle as Ironwood shielded data.
     pub fn new(shielded_data: orchard::ShieldedDataV6) -> Self {

zebra-chain/src/orchard.rs

@@ -24,5 +24,4 @@ pub use keys::Diversifier;
 pub use note::{EncryptedNote, Note, Nullifier, WrappedNoteKey};
 pub use shielded_data::{AuthorizedAction, Flags, ShieldedData};
 
-#[cfg(zcash_unstable = "nu6.3")]
 pub use shielded_data::{FlagsV6, ShieldedDataV6};

zebra-chain/src/orchard/shielded_data.rs

@@ -63,11 +63,9 @@ pub struct ShieldedData {
 /// pre-NU6.3 serialization that the bare [`ShieldedData`] uses for v5 Orchard bundles. The two
 /// formats differ only in which flag bits are reserved; encoding the format in the type keeps the
 /// v5 and v6 (de)serialization paths from being confused.
-#[cfg(zcash_unstable = "nu6.3")]
 #[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
 pub struct ShieldedDataV6(ShieldedData);
 
-#[cfg(zcash_unstable = "nu6.3")]
 impl ShieldedDataV6 {
     /// Wraps a v5-shaped Orchard [`ShieldedData`] as a v6 (NU6.3) Orchard bundle.
     pub fn new(shielded_data: ShieldedData) -> Self {
@@ -311,11 +309,9 @@ bitflags! {
 /// pre-NU6.3 (v5 Orchard) format, where bits 2..7 are all reserved. Encoding the format in the type
 /// keeps the v5 and v6 flag-parsing paths from being confused (parallels
 /// [`ShieldedDataV6`](super::ShieldedDataV6)).
-#[cfg(zcash_unstable = "nu6.3")]
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub struct FlagsV6(Flags);
 
-#[cfg(zcash_unstable = "nu6.3")]
 impl From<FlagsV6> for Flags {
     fn from(flags: FlagsV6) -> Self {
         flags.0
@@ -327,7 +323,6 @@ impl Flags {
     const PRE_NU6_3_RESERVED: u8 = !(Self::ENABLE_SPENDS.bits() | Self::ENABLE_OUTPUTS.bits());
 
     /// The flag bits that are reserved (MUST be zero) in the NU6.3 format.
-    #[cfg(zcash_unstable = "nu6.3")]
     const NU6_3_RESERVED: u8 = !(Self::ENABLE_SPENDS.bits()
         | Self::ENABLE_OUTPUTS.bits()
         | Self::ENABLE_CROSS_ADDRESS.bits());
@@ -397,7 +392,6 @@ impl ZcashDeserialize for Flags {
     }
 }
 
-#[cfg(zcash_unstable = "nu6.3")]
 impl ZcashDeserialize for FlagsV6 {
     /// # Consensus
     ///

zebra-chain/src/orchard/tests/flags.rs

@@ -2,7 +2,6 @@
 
 use crate::{orchard::Flags, serialization::ZcashDeserialize};
 
-#[cfg(zcash_unstable = "nu6.3")]
 use crate::orchard::FlagsV6;
 
 /// In the pre-NU6.3 format (the default `Flags` codec, v5 Orchard bundles), only bits 0..1 are
@@ -30,7 +29,6 @@ fn pre_nu6_3_format_rejects_reserved_bits() {
 
 /// In the NU6.3 format (the `FlagsV6` codec, v6 Orchard and Ironwood bundles), bit 2 is the valid
 /// `enableCrossAddress` flag; bits 3..7 stay reserved.
-#[cfg(zcash_unstable = "nu6.3")]
 #[test]
 fn nu6_3_format_accepts_cross_address_but_rejects_higher_bits() {
     // Bits 0..2 are all valid in the NU6.3 format.

zebra-chain/src/parameters/network_upgrade.rs

@@ -538,7 +538,6 @@ impl From<zcash_protocol::consensus::NetworkUpgrade> for NetworkUpgrade {
             zcash_protocol::consensus::NetworkUpgrade::Nu6 => Self::Nu6,
             zcash_protocol::consensus::NetworkUpgrade::Nu6_1 => Self::Nu6_1,
             zcash_protocol::consensus::NetworkUpgrade::Nu6_2 => Self::Nu6_2,
-            #[cfg(zcash_unstable = "nu6.3")]
             zcash_protocol::consensus::NetworkUpgrade::Nu6_3 => Self::Nu6_3,
             #[cfg(zcash_unstable = "nu7")]
             zcash_protocol::consensus::NetworkUpgrade::Nu7 => Self::Nu7,

zebra-chain/src/primitives/zcash_primitives.rs

@@ -290,7 +290,6 @@ impl PrecomputedTxData {
     ///
     /// The Ironwood bundle reuses the Orchard bundle type; it differs only by pool (separate tree,
     /// nullifier set, and value balance) and is verified under the NU6.3 Action circuit key.
-    #[cfg(zcash_unstable = "nu6.3")]
     pub fn ironwood_bundle(
         &self,
     ) -> Option<orchard::bundle::Bundle<orchard::bundle::Authorized, ZatBalance>> {