feat: implement OutputNote::hash

0xPolygonMiden · Jul 2, 2024 · 4978633 · 4978633
1 parent 6831761
commit 4978633
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 5 deletions.
diff --git a/objects/src/notes/header.rs b/objects/src/notes/header.rs
@@ -41,13 +41,26 @@ impl NoteHeader {
     ///
     /// > hash(NOTE_ID || NOTE_METADATA)
     ///
-    /// This value is used primarily for authenticating notes consumed when the are consumed
+    /// This value is used primarily for authenticating notes consumed when they are consumed
     /// in a transaction.
     pub fn hash(&self) -> Digest {
-        Hasher::merge(&[self.id().inner(), Word::from(self.metadata()).into()])
+        note_hash(self.id(), self.metadata())
     }
 }
 
+// UTILITIES
+// ================================================================================================
+
+/// Returns a commitment to the note and its metadata.
+///
+/// > hash(NOTE_ID || NOTE_METADATA)
+///
+/// This value is used primarily for authenticating notes consumed when they are consumed
+/// in a transaction.
+pub fn note_hash(id: NoteId, metadata: &NoteMetadata) -> Digest {
+    Hasher::merge(&[id.inner(), Word::from(metadata).into()])
+}
+
 // CONVERSIONS FROM NOTE HEADER
 // ================================================================================================
 

diff --git a/objects/src/notes/mod.rs b/objects/src/notes/mod.rs
@@ -21,7 +21,7 @@ mod details;
 pub use details::NoteDetails;
 
 mod header;
-pub use header::NoteHeader;
+pub use header::{note_hash, NoteHeader};
 
 mod inputs;
 pub use inputs::NoteInputs;

diff --git a/objects/src/transaction/outputs.rs b/objects/src/transaction/outputs.rs
@@ -6,10 +6,9 @@ use vm_processor::DeserializationError;
 
 use crate::{
     accounts::AccountStub,
-    notes::{Note, NoteAssets, NoteHeader, NoteId, NoteMetadata, PartialNote},
+    notes::{note_hash, Note, NoteAssets, NoteHeader, NoteId, NoteMetadata, PartialNote},
     Digest, Felt, Hasher, TransactionOutputError, Word, MAX_OUTPUT_NOTES_PER_TX,
 };
-
 // TRANSACTION OUTPUTS
 // ================================================================================================
 
@@ -205,6 +204,16 @@ impl OutputNote {
             _ => self.clone(),
         }
     }
+
+    /// Returns a commitment to the note and its metadata.
+    ///
+    /// > hash(NOTE_ID || NOTE_METADATA)
+    ///
+    /// This value is used primarily for authenticating notes consumed when they are consumed
+    /// in a transaction.
+    pub fn hash(&self) -> Digest {
+        note_hash(self.id(), self.metadata())
+    }
 }
 
 // CONVERSIONS