OrchardZSA backward compatability #100
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,3 +4,5 @@ Cargo.lock | |
| .vscode | ||
| .idea | ||
| action-circuit-layout.png | ||
| *.[0-9] | ||
| *.[0-9][0-9] | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,6 +12,7 @@ use orchard::{ | |
| bundle::Flags, | ||
| circuit::{ProvingKey, VerifyingKey}, | ||
| keys::{FullViewingKey, Scope, SpendingKey}, | ||
| orchard_flavors::OrchardZSA, | ||
| value::NoteValue, | ||
| Anchor, Bundle, | ||
| }; | ||
|
|
@@ -23,8 +24,9 @@ fn criterion_benchmark(c: &mut Criterion) { | |
| let sk = SpendingKey::from_bytes([7; 32]).unwrap(); | ||
| let recipient = FullViewingKey::from(&sk).address_at(0u32, Scope::External); | ||
|
|
||
| // FIXME: consider adding test for OrchardVanilla as well | ||
|
There was a problem hiding this comment. From @PaulLaux: There was a problem hiding this comment. Done (we have created a new task). |
||
| let vk = VerifyingKey::build::<OrchardZSA>(); | ||
| let pk = ProvingKey::build::<OrchardZSA>(); | ||
|
|
||
| let create_bundle = |num_recipients| { | ||
| let mut builder = Builder::new( | ||
|
|
@@ -42,7 +44,7 @@ fn criterion_benchmark(c: &mut Criterion) { | |
| ) | ||
| .unwrap(); | ||
| } | ||
| let bundle: Bundle<_, i64, OrchardZSA> = builder.build(rng).unwrap(); | ||
|
|
||
| let instances: Vec<_> = bundle | ||
| .actions() | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ use memuse::DynamicUsage; | |
|
|
||
| use crate::{ | ||
| note::{ExtractedNoteCommitment, Nullifier, TransmittedNoteCiphertext}, | ||
| note_encryption::OrchardDomain, | ||
| primitives::redpallas::{self, SpendAuth}, | ||
| value::ValueCommitment, | ||
| }; | ||
|
|
@@ -15,30 +16,30 @@ use crate::{ | |
| /// Internally, this may both consume a note and create a note, or it may do only one of | ||
| /// the two. TODO: Determine which is more efficient (circuit size vs bundle size). | ||
| #[derive(Debug, Clone)] | ||
| pub struct Action<A, D: OrchardDomain> { | ||
| /// The nullifier of the note being spent. | ||
| nf: Nullifier, | ||
| /// The randomized verification key for the note being spent. | ||
| rk: redpallas::VerificationKey<SpendAuth>, | ||
| /// A commitment to the new note being created. | ||
| cmx: ExtractedNoteCommitment, | ||
| /// The transmitted note ciphertext. | ||
| encrypted_note: TransmittedNoteCiphertext<D>, | ||
| /// A commitment to the net value created or consumed by this action. | ||
| cv_net: ValueCommitment, | ||
| /// The authorization for this action. | ||
| authorization: A, | ||
| } | ||
|
|
||
| impl<A, D: OrchardDomain> Action<A, D> { | ||
| /// Constructs an `Action` from its constituent parts. | ||
| pub fn from_parts( | ||
| nf: Nullifier, | ||
| rk: redpallas::VerificationKey<SpendAuth>, | ||
| cmx: ExtractedNoteCommitment, | ||
| encrypted_note: TransmittedNoteCiphertext<D>, | ||
| cv_net: ValueCommitment, | ||
| authorization: A, | ||
| ) -> Self { | ||
| Action { | ||
| nf, | ||
|
|
@@ -66,7 +67,7 @@ impl<T> Action<T> { | |
| } | ||
|
|
||
| /// Returns the encrypted note ciphertext. | ||
| pub fn encrypted_note(&self) -> &TransmittedNoteCiphertext<D> { | ||
| &self.encrypted_note | ||
| } | ||
|
|
||
|
|
@@ -76,12 +77,12 @@ impl<T> Action<T> { | |
| } | ||
|
|
||
| /// Returns the authorization for this action. | ||
| pub fn authorization(&self) -> &A { | ||
| &self.authorization | ||
| } | ||
|
|
||
| /// Transitions this action from one authorization state to another. | ||
| pub fn map<U>(self, step: impl FnOnce(A) -> U) -> Action<U, D> { | ||
| Action { | ||
| nf: self.nf, | ||
| rk: self.rk, | ||
|
|
@@ -93,7 +94,7 @@ impl<T> Action<T> { | |
| } | ||
|
|
||
| /// Transitions this action from one authorization state to another. | ||
| pub fn try_map<U, E>(self, step: impl FnOnce(A) -> Result<U, E>) -> Result<Action<U, D>, E> { | ||
| Ok(Action { | ||
| nf: self.nf, | ||
| rk: self.rk, | ||
|
|
@@ -105,7 +106,7 @@ impl<T> Action<T> { | |
| } | ||
| } | ||
|
|
||
| impl<D: OrchardDomain> DynamicUsage for Action<redpallas::Signature<SpendAuth>, D> { | ||
| #[inline(always)] | ||
| fn dynamic_usage(&self) -> usize { | ||
| 0 | ||
|
|
@@ -132,6 +133,7 @@ pub(crate) mod testing { | |
| commitment::ExtractedNoteCommitment, nullifier::testing::arb_nullifier, | ||
| testing::arb_note, TransmittedNoteCiphertext, | ||
| }, | ||
| note_encryption::OrchardDomain, | ||
| primitives::redpallas::{ | ||
| self, | ||
| testing::{arb_spendauth_signing_key, arb_spendauth_verification_key}, | ||
|
|
@@ -141,70 +143,82 @@ pub(crate) mod testing { | |
|
|
||
| use super::Action; | ||
|
|
||
| /// `ActionArb` serves as a utility structure in property-based testing, designed specifically to adapt | ||
| /// `arb_...` functions for compatibility with both variations of the Orchard protocol: Vanilla and ZSA. | ||
| /// This adaptation is necessary due to the proptest crate's limitation, which prevents the direct | ||
| /// transformation of `arb_...` functions into generic forms suitable for testing different protocol | ||
| /// flavors. | ||
| #[derive(Debug)] | ||
| pub struct ActionArb<D: OrchardDomain> { | ||
| phantom: std::marker::PhantomData<D>, | ||
| } | ||
|
|
||
| impl<D: OrchardDomain> ActionArb<D> { | ||
| prop_compose! { | ||
| /// Generate an action without authorization data. | ||
| pub fn arb_unauthorized_action(spend_value: NoteValue, output_value: NoteValue)( | ||
| nf in arb_nullifier(), | ||
| rk in arb_spendauth_verification_key(), | ||
| note in arb_note(output_value), | ||
| asset in arb_asset_base() | ||
| ) -> Action<(), D> { | ||
| let cmx = ExtractedNoteCommitment::from(note.commitment()); | ||
| let cv_net = ValueCommitment::derive( | ||
| spend_value - output_value, | ||
| ValueCommitTrapdoor::zero(), | ||
| asset | ||
| ); | ||
| // FIXME: make a real one from the note. | ||
|
There was a problem hiding this comment. From @PaulLaux: |
||
| let encrypted_note = TransmittedNoteCiphertext::<D> { | ||
| epk_bytes: [0u8; 32], | ||
| enc_ciphertext: D::NoteCiphertextBytes::from(vec![0u8; D::ENC_CIPHERTEXT_SIZE].as_ref()), | ||
| out_ciphertext: [0u8; 80] | ||
| }; | ||
| Action { | ||
| nf, | ||
| rk, | ||
| cmx, | ||
| encrypted_note, | ||
| cv_net, | ||
| authorization: () | ||
| } | ||
| } | ||
| } | ||
|
|
||
| prop_compose! { | ||
| /// Generate an action with invalid (random) authorization data. | ||
| pub fn arb_action(spend_value: NoteValue, output_value: NoteValue)( | ||
| nf in arb_nullifier(), | ||
| sk in arb_spendauth_signing_key(), | ||
| note in arb_note(output_value), | ||
| rng_seed in prop::array::uniform32(prop::num::u8::ANY), | ||
| fake_sighash in prop::array::uniform32(prop::num::u8::ANY), | ||
| asset in arb_asset_base() | ||
| ) -> Action<redpallas::Signature<SpendAuth>, D> { | ||
| let cmx = ExtractedNoteCommitment::from(note.commitment()); | ||
| let cv_net = ValueCommitment::derive( | ||
| spend_value - output_value, | ||
| ValueCommitTrapdoor::zero(), | ||
| asset | ||
| ); | ||
|
|
||
| // FIXME: make a real one from the note. | ||
| let encrypted_note = TransmittedNoteCiphertext::<D> { | ||
| epk_bytes: [0u8; 32], | ||
| enc_ciphertext: D::NoteCiphertextBytes::from(vec![0u8; D::ENC_CIPHERTEXT_SIZE].as_ref()), | ||
| out_ciphertext: [0u8; 80] | ||
| }; | ||
|
|
||
| let rng = StdRng::from_seed(rng_seed); | ||
|
|
||
| Action { | ||
| nf, | ||
| rk: redpallas::VerificationKey::from(&sk), | ||
| cmx, | ||
| encrypted_note, | ||
| cv_net, | ||
| authorization: sk.sign(rng, &fake_sighash), | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From @PaulLaux (possibly outdated as the file was changed):
are you sure we need to override it twice?
here and lines 29,33
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. Fixed the
hexandhalfdependencies by removing them from "dev-dependencies". Regardinghash- in the upstream (zcash/orchard 0.8.0), they replaced hash withahash, which is only present in "dev-dependencies". As for other duplications (includinghalo2_gadgets), they cannot be removed from "dev-dependencies" because they have different features enabled.