chore: address some nits

AztecProtocol · Sep 29, 2023 · c82c1ff · c82c1ff
1 parent 2dd2b52
commit c82c1ff
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/yarn-project/noir-contracts/src/contracts/token_contract/src/types/token_note.nr b/yarn-project/noir-contracts/src/contracts/token_contract/src/types/token_note.nr
@@ -31,6 +31,7 @@ struct TokenNote {
     // randomness of the note to hide contents.
     randomness: Field,
     // the note header (contract_address, nonce, storage_slot)
+    // included in the note such that it becomes part of encrypted logs for later use.
     header: NoteHeader,
 }
 

diff --git a/yarn-project/noir-contracts/src/contracts/token_contract/src/types/transparent_note.nr b/yarn-project/noir-contracts/src/contracts/token_contract/src/types/transparent_note.nr
@@ -15,8 +15,9 @@ global TRANSPARENT_NOTE_LEN: Field = 2;
 struct TransparentNote {
     amount: Field,
     secret_hash: Field,
-    // the fields below are not serialized/deserialized
+    // the secret is just here for ease of use and won't be (de)serialized
     secret: Field,
+    // header is just here to satisfy the NoteInterface
     header: NoteHeader,
 }
 
@@ -69,8 +70,7 @@ impl TransparentNote {
     }
 
     fn compute_nullifier(self) -> Field {
-        // TODO(https://github.com/AztecProtocol/aztec-packages/issues/1386): should use
-        // `compute_note_hash_for_read_or_nullify` once public functions inject nonce!
+        // TODO(#1386): should use `compute_note_hash_for_read_or_nullify` once public functions inject nonce!
         let siloed_note_hash = compute_siloed_note_hash(TransparentNoteMethods, self);
         // TODO(#1205) Should use a non-zero generator index.
         pedersen([self.secret, siloed_note_hash])[0]