Merge pull request zcash#516 from zcash/feat/ironwood

Add support for the Ironwood shielded pool.

Author: nuttycom

CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "orchard"
-version = "0.14.0"
+version = "0.15.0"
 authors = [
     "Sean Bowe <ewillbefull@gmail.com>",
     "Jack Grigg <thestr4d@gmail.com>",

Cargo.lock

@@ -8,7 +8,8 @@ use pprof::criterion::{Output, PProfProfiler};
 
 use orchard::{
     builder::{Builder, BundleType},
-    circuit::{ProvingKey, VerifyingKey},
+    bundle::BundleVersion,
+    circuit::{OrchardCircuitVersion, ProvingKey, VerifyingKey},
     keys::{FullViewingKey, Scope, SpendingKey},
     value::NoteValue,
     Anchor, Bundle,
@@ -21,11 +22,17 @@ fn criterion_benchmark(c: &mut Criterion) {
     let sk = SpendingKey::from_bytes([7; 32]).unwrap();
     let recipient = FullViewingKey::from(&sk).address_at(0u32, Scope::External);
 
-    let vk = VerifyingKey::build();
-    let pk = ProvingKey::build();
+    let vk = VerifyingKey::build(OrchardCircuitVersion::FixedPostNu6_2);
+    let pk = ProvingKey::build(OrchardCircuitVersion::FixedPostNu6_2);
 
     let create_bundle = |num_recipients| {
-        let mut builder = Builder::new(BundleType::DEFAULT, Anchor::from_bytes([0; 32]).unwrap());
+        let mut builder = Builder::new(
+            BundleType::DEFAULT,
+            BundleVersion::orchard_v2(),
+            BundleVersion::orchard_v2().default_flags(),
+            Anchor::from_bytes([0; 32]).unwrap(),
+        )
+        .unwrap();
         for _ in 0..num_recipients {
             builder
                 .add_output(None, recipient, NoteValue::from_raw(10), [0; 512])

Cargo.toml

@@ -1,7 +1,8 @@
 use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion, Throughput};
 use orchard::{
     builder::{Builder, BundleType},
-    circuit::ProvingKey,
+    bundle::BundleVersion,
+    circuit::{OrchardCircuitVersion, ProvingKey},
     keys::{FullViewingKey, PreparedIncomingViewingKey, Scope, SpendingKey},
     note_encryption::{CompactAction, OrchardDomain},
     value::NoteValue,
@@ -15,7 +16,7 @@ use pprof::criterion::{Output, PProfProfiler};
 
 fn bench_note_decryption(c: &mut Criterion) {
     let rng = OsRng;
-    let pk = ProvingKey::build();
+    let pk = ProvingKey::build(OrchardCircuitVersion::FixedPostNu6_2);
 
     let fvk = FullViewingKey::from(&SpendingKey::from_bytes([7; 32]).unwrap());
     let valid_ivk = fvk.to_ivk(Scope::External);
@@ -44,7 +45,13 @@ fn bench_note_decryption(c: &mut Criterion) {
         .collect();
 
     let bundle = {
-        let mut builder = Builder::new(BundleType::DEFAULT, Anchor::from_bytes([0; 32]).unwrap());
+        let mut builder = Builder::new(
+            BundleType::DEFAULT,
+            BundleVersion::orchard_v2(),
+            BundleVersion::orchard_v2().default_flags(),
+            Anchor::from_bytes([0; 32]).unwrap(),
+        )
+        .unwrap();
         // The builder pads to two actions, and shuffles their order. Add two recipients
         // so the first action is always decryptable.
         builder

benches/circuit.rs

@@ -201,7 +201,7 @@ pub(crate) mod testing {
         note_encryption::{OrchardDomain, OrchardNoteEncryption},
         primitives::redpallas::{self, testing::arb_valid_spendauth_keypair},
         value::{NoteValue, ValueCommitTrapdoor, ValueCommitment},
-        Note,
+        Note, NoteVersion,
     };
 
     use super::Action;
@@ -228,10 +228,10 @@ pub(crate) mod testing {
 
     prop_compose! {
         /// Generate an action without authorization data.
-        pub fn arb_unauthorized_action(spend_value: NoteValue, output_value: NoteValue)(
+        pub fn arb_unauthorized_action(note_version: NoteVersion, spend_value: NoteValue, output_value: NoteValue)(
             nf in arb_nullifier(),
             (_, rk) in arb_valid_spendauth_keypair(),
-            note in arb_note(output_value),
+            note in arb_note(output_value, note_version),
             rng_seed in prop::array::uniform32(prop::num::u8::ANY),
         ) -> Action<()> {
             let cmx = ExtractedNoteCommitment::from(note.commitment());
@@ -254,10 +254,10 @@ pub(crate) mod testing {
 
     prop_compose! {
         /// Generate an action with invalid (random) authorization data.
-        pub fn arb_action(spend_value: NoteValue, output_value: NoteValue)(
+        pub fn arb_action(note_version: NoteVersion, spend_value: NoteValue, output_value: NoteValue)(
             nf in arb_nullifier(),
             (rsk, rk) in arb_valid_spendauth_keypair(),
-            note in arb_note(output_value),
+            note in arb_note(output_value, note_version),
             enc_rng_seed in prop::array::uniform32(prop::num::u8::ANY),
             rng_seed in prop::array::uniform32(prop::num::u8::ANY),
             fake_sighash in prop::array::uniform32(prop::num::u8::ANY),

benches/note_decryption.rs

@@ -47,6 +47,16 @@ impl Address {
         &self.pk_d
     }
 
+    /// Returns whether `self` and `other` correspond to the same expanded receiver, i.e.
+    /// have equal `(g_d, pk_d)`.
+    ///
+    /// This matches the equality notion used by the `disableCrossAddress` circuit
+    /// constraint, and is intentionally distinct from `PartialEq` on `Address`, which
+    /// compares the raw diversifier encoding.
+    pub(crate) fn same_expanded_receiver(&self, other: &Self) -> bool {
+        self.g_d() == other.g_d() && self.pk_d() == other.pk_d()
+    }
+
     /// Serializes this address to its "raw" encoding as specified in [Zcash Protocol Spec § 5.6.4.2: Orchard Raw Payment Addresses][orchardpaymentaddrencoding]
     ///
     /// [orchardpaymentaddrencoding]: https://zips.z.cash/protocol/protocol.pdf#orchardpaymentaddrencoding