Update ShieldedOutput implementation to return reference from enc_cip…

…hertext (#112) This PR updates the `ShieldedOutput` implementation for the `Action`/`CompactAction` struct to align with the recent changes in the `zcash_note_encryption` crate. Specifically, the `enc_ciphertext` method now returns a reference instead of a copy. This change was discussed and suggested in PR zcash/zcash_note_encryption#2 review. --------- Co-authored-by: Dmitry Demin <[email protected]>
QED-it · Aug 14, 2024 · 07b3697 · 07b3697
1 parent 6e6112c
commit 07b3697
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 11 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/src/bundle/commitments.rs b/src/bundle/commitments.rs
@@ -2,13 +2,11 @@
 
 use blake2b_simd::{Hash as Blake2bHash, Params, State};
 
-use zcash_note_encryption_zsa::MEMO_SIZE;
-
 use crate::{
     bundle::{Authorization, Authorized, Bundle},
     issuance::{IssueAuth, IssueBundle, Signed},
     note::AssetBase,
-    note_encryption::OrchardDomainCommon,
+    note_encryption::{OrchardDomainCommon, MEMO_SIZE},
     orchard_flavor::{OrchardVanilla, OrchardZSA},
     value::NoteValue,
 };

diff --git a/src/note_encryption.rs b/src/note_encryption.rs
@@ -11,6 +11,8 @@ mod orchard_domain;
 mod orchard_domain_vanilla;
 mod orchard_domain_zsa;
 
+pub(crate) use domain::MEMO_SIZE;
+
 pub use {
     compact_action::CompactAction,
     orchard_domain::{OrchardDomain, OrchardDomainCommon},

diff --git a/src/note_encryption/compact_action.rs b/src/note_encryption/compact_action.rs
@@ -20,8 +20,8 @@ impl<A, D: OrchardDomainCommon> ShieldedOutput<OrchardDomain<D>> for Action<A, D
         self.cmx().to_bytes()
     }
 
-    fn enc_ciphertext(&self) -> Option<D::NoteCiphertextBytes> {
-        Some(self.encrypted_note().enc_ciphertext)
+    fn enc_ciphertext(&self) -> Option<&D::NoteCiphertextBytes> {
+        Some(&self.encrypted_note().enc_ciphertext)
     }
 
     fn enc_ciphertext_compact(&self) -> D::CompactNoteCiphertextBytes {
@@ -69,7 +69,7 @@ impl<D: OrchardDomainCommon> ShieldedOutput<OrchardDomain<D>> for CompactAction<
         self.cmx.to_bytes()
     }
 
-    fn enc_ciphertext(&self) -> Option<D::NoteCiphertextBytes> {
+    fn enc_ciphertext(&self) -> Option<&D::NoteCiphertextBytes> {
         None
     }
 
@@ -115,12 +115,13 @@ impl<D: OrchardDomainCommon> CompactAction<D> {
 pub mod testing {
     use rand::RngCore;
 
-    use zcash_note_encryption_zsa::{note_bytes::NoteBytes, Domain, NoteEncryption, MEMO_SIZE};
+    use zcash_note_encryption_zsa::{note_bytes::NoteBytes, Domain, NoteEncryption};
 
     use crate::{
         address::Address,
         keys::OutgoingViewingKey,
         note::{AssetBase, ExtractedNoteCommitment, Note, Nullifier, RandomSeed, Rho},
+        note_encryption::MEMO_SIZE,
         value::NoteValue,
     };
 

diff --git a/src/note_encryption/domain.rs b/src/note_encryption/domain.rs
@@ -8,7 +8,7 @@ use blake2b_simd::Params;
 
 use zcash_note_encryption_zsa::{
     note_bytes::NoteBytes, BatchDomain, Domain, EphemeralKeyBytes, OutPlaintextBytes,
-    OutgoingCipherKey, MEMO_SIZE, OUT_PLAINTEXT_SIZE,
+    OutgoingCipherKey, OUT_PLAINTEXT_SIZE,
 };
 
 use crate::{
@@ -51,6 +51,9 @@ pub(super) const NOTE_VERSION_BYTE_V2: u8 = 0x02;
 /// The version byte for ZSA.
 pub(super) const NOTE_VERSION_BYTE_V3: u8 = 0x03;
 
+/// The size of the memo.
+pub(crate) const MEMO_SIZE: usize = 512;
+
 pub(super) type Memo = [u8; MEMO_SIZE];
 
 /// Defined in [Zcash Protocol Spec § 5.4.2: Pseudo Random Functions][concreteprfs].

diff --git a/src/note_encryption/orchard_domain.rs b/src/note_encryption/orchard_domain.rs
@@ -3,15 +3,18 @@
 
 use core::fmt;
 
-use zcash_note_encryption_zsa::{note_bytes::NoteBytes, AEAD_TAG_SIZE, MEMO_SIZE};
+use zcash_note_encryption_zsa::{note_bytes::NoteBytes, AEAD_TAG_SIZE};
 
 use crate::{
     action::Action,
     note::{AssetBase, Rho},
     Note,
 };
 
-use super::{compact_action::CompactAction, domain::Memo};
+use super::{
+    compact_action::CompactAction,
+    domain::{Memo, MEMO_SIZE},
+};
 
 /// Represents the Orchard protocol domain specifics required for note encryption and decryption.
 pub trait OrchardDomainCommon: fmt::Debug + Clone {