refactor!: Notes implementing `Packable<N>` by benesjan · Pull Request #12004 · AztecProtocol/aztec-packages

benesjan · 2025-02-14T09:09:13Z

Fixes #11981
+\ note macro cleanup

benesjan · 2025-02-14T09:09:32Z

refactor: function macros cleanup #12066
fix: #[aztec] macro warnings #12038
refactor!: Notes implementing Packable<N> #12004 👈 (View in Graphite)
refactor!: nuking NoteHeader #11942
refactor: moving storage slot out of NoteHeader #11904
fix: note hash collision #11869
master

This stack of pull requests is managed by Graphite. Learn more about stacking.

benesjan · 2025-02-14T14:09:29Z

noir-projects/aztec-nr/aztec/src/macros/notes/mod.nr

 ///         ...
 ///     }
+/// }
+comptime fn generate_note_interface(s: StructDefinition, note_type_id: Field) -> Quoted {


I separated original generate_note_interface to generate_note_interface_for_partial_note and generate_note_interface because for normal notes we can use poseidon2 which is much cheaper. It also makes it clearer what is partial notes related complexity and what is not.

benesjan · 2025-02-14T14:10:11Z

noir-projects/aztec-nr/aztec/src/macros/notes/mod.nr

-        quote { packed_content }, // "packed_content" is argument of NoteInterface::unpack_content
-        0,
-        packing_enabled,
-    );


All this code was related to pack_content and unpack_content ^.

noir-projects/aztec-nr/aztec/src/macros/notes/mod.nr

benesjan · 2025-02-14T14:15:11Z

noir-projects/aztec-nr/aztec/src/prelude.nr

        note_interface::{NoteInterface, NullifiableNote},
        note_viewer_options::NoteViewerOptions,
        retrieved_note::RetrievedNote,
-        utils::compute_note_hash_and_optionally_a_nullifier as utils_compute_note_hash_and_optionally_a_nullifier,


This re-export was unused and I see no reason for having it. I think it was just forgottent.

benesjan · 2025-02-14T14:16:50Z

noir-projects/aztec-nr/value-note/src/value_note.nr


 // docs:start:value-note-def
 #[note]
+#[derive(Eq)]


Should have done this in the PR down the stack as this became unblocked after nuking of the NoteHeader.

benesjan · 2025-02-14T14:18:01Z

noir-projects/noir-contracts/contracts/ecdsa_public_key_note/src/lib.nr

 // Stores an ECDSA public key composed of two 32-byte elements
 // TODO: Do we need to include a nonce, in case we want to read/nullify/recreate with the same pubkey value?
-#[note_custom_interface]
+#[note]


With the separation of the packing functionality from the NoteInterface it no longer made sense to use the #[note_custom_interface] here because the only custom thing here was the packing.

benesjan · 2025-02-14T14:20:47Z

noir-projects/noir-protocol-circuits/crates/types/src/meta/mod.nr

 /// - If the deserialization logic encounters a type it does not support.
 /// - If an incorrect number of fields are consumed when deserializing a string.
-pub comptime fn generate_deserialize_from_fields<N>(
+pub comptime fn generate_deserialize_from_fields(


The N here had no use.

AztecBot · 2025-02-14T14:43:30Z

Docs Preview

Hey there! 👋 You can check your preview at https://67af767f287cbd166c251616--aztec-docs-dev.netlify.app

github-actions · 2025-02-14T15:15:28Z

Changes to public function bytecode sizes

Generated at commit: 6b27ea94c138a8ed6f9f34f03262b4e7b14c7a46, compared to commit: aafc2249a53c1e9873fbaca40efd70cb55689a71

🧾 Summary (100% most significant diffs)

Program	Bytecode size in bytes (+/-)	%
TokenBlacklist::public_dispatch	-479 ✅	-2.03%
TokenBlacklist::mint_private	-251 ✅	-7.13%
TokenBlacklist::shield	-495 ✅	-8.87%

Full diff report 👇

Program	Bytecode size in bytes (+/-)	%
TokenBlacklist::public_dispatch	23,100 (-479)	-2.03%
TokenBlacklist::mint_private	3,269 (-251)	-7.13%
TokenBlacklist::shield	5,086 (-495)	-8.87%

benesjan · 2025-02-14T16:41:24Z

noir-projects/aztec-nr/aztec/src/macros/notes/mod.nr

 pub comptime fn note_custom_interface(s: StructDefinition) -> Quoted {
-    let note_properties = generate_note_properties(s);
+    let (packable_impl, note_packed_len) = derive_packable_if_not_implemented_and_get_len(s);
+    // TODO(https://github.com/AztecProtocol/aztec-packages/issues/12012): This is broken


This is an issue which I uncovered in this PR.

benesjan · 2025-02-14T16:42:30Z

noir-projects/aztec-nr/address-note/src/address_note.nr

    },
 };

+// TODO(#12008): Remove the need for the manual import of `Packable` trait here. This is a bug in macros.


This issue was already present before because we used Packable in the implementations of the pack_content and unpack_content function.s

benesjan · 2025-02-14T16:46:12Z

yarn-project/end-to-end/src/e2e_2_pxes.test.ts

    }

+    // TODO(#12013): We need to do this hack because NoteDao no longer populates noteTypeId
+    note.noteTypeId = TestContract.notes.ValueNote.id;


I am not really sure why this got triggered now as even before the noteTypeId should have been non-zero but now it caused the test to fail when adding the nullified note.

Given that note type id will be soon nuked from NoteDao and ExtendedNote and given that we will nuke the addNullifiedNote function doesn't make sense to bother with.

…e_interface

nventuro

nature is healing

noir-projects/aztec-nr/aztec/src/macros/notes/mod.nr

Co-authored-by: Nicolás Venturo <nicolas.venturo@gmail.com>

* master: (245 commits) chore: Fix unbound CI variable on release image bootstrap (#12095) fix: dry run on grind (#12088) fix(spartan): eth-execution logging (#12094) fix: aws_handle_evict recovery & termination (#12086) chore: Use native acvm when available on orchestrator tests (#11560) refactor: function macros cleanup (#12066) refactor: remove `addNullifiedNote` from pxe (#11822) fix: `#[aztec]` macro warnings (#12038) refactor!: Notes implementing `Packable<N>` (#12004) chore(ops): add gcloud cli into devbox base image (#12082) fix: hotfix grinding fix: L1 deployment on reth (#12060) fix: Add missing bootstrap fast aliases (#12078) fix: hash_str caching (#12074) fix: Naive attempt to fix nightly deployments (#12079) fix: kind smoke (#12084) refactor!: nuking `NoteHeader` (#11942) fix: inject dockerhub creds (#12072) feat(docs): Note discovery concepts page (#11760) chore: cleanup libp2p logger (#12058) ...

This was referenced Feb 14, 2025

fix: note hash collision #11869

Merged

refactor: moving storage slot out of NoteHeader #11904

Merged

benesjan mentioned this pull request Feb 14, 2025

refactor!: nuking NoteHeader #11942

Merged

benesjan changed the title ~~refactor: Notes implementing Packable<N>~~ refactor!: Notes implementing Packable<N> Feb 14, 2025

benesjan added the e2e-all label Feb 14, 2025

benesjan marked this pull request as ready for review February 14, 2025 11:01

benesjan marked this pull request as draft February 14, 2025 14:04

benesjan commented Feb 14, 2025

View reviewed changes

noir-projects/aztec-nr/aztec/src/macros/notes/mod.nr Show resolved Hide resolved

benesjan commented Feb 14, 2025

View reviewed changes

benesjan marked this pull request as ready for review February 14, 2025 14:22

benesjan commented Feb 14, 2025

View reviewed changes

benesjan requested review from Thunkar and iAmMichaelConnor February 14, 2025 17:19

benesjan force-pushed the 02-14-refactor_notes_implementing_packable_n_ branch from de1cc6f to 4a8b6e2 Compare February 17, 2025 09:49

benesjan force-pushed the 02-12-refactor_removing_noteheader_out_of_note branch from aafc224 to 14eb329 Compare February 17, 2025 09:49

benesjan mentioned this pull request Feb 17, 2025

fix: #[aztec] macro warnings #12038

Merged

benesjan force-pushed the 02-14-refactor_notes_implementing_packable_n_ branch from 4a8b6e2 to 0c4115b Compare February 18, 2025 08:15

benesjan force-pushed the 02-12-refactor_removing_noteheader_out_of_note branch from edd3cac to b6aa786 Compare February 18, 2025 08:15

benesjan marked this pull request as draft February 18, 2025 08:16

benesjan force-pushed the 02-14-refactor_notes_implementing_packable_n_ branch from 0c4115b to 37ce5ab Compare February 18, 2025 08:33

benesjan force-pushed the 02-14-refactor_notes_implementing_packable_n_ branch 3 times, most recently from c8e8515 to d8c127f Compare February 18, 2025 09:20

benesjan marked this pull request as ready for review February 18, 2025 09:34

benesjan mentioned this pull request Feb 18, 2025

refactor: function macros cleanup #12066

Merged

Base automatically changed from 02-12-refactor_removing_noteheader_out_of_note to master February 18, 2025 14:06

benesjan added 15 commits February 18, 2025 14:06

refactor: Notes implementing Packable<N>

383e961

stale naming fix

8922811

fix

e66257d

fix

42520de

fixes

b0eabb6

replacing usage of note content with packed note

b058280

separating generate_note_interface_for_partial_note from generate_not…

4f18904

…e_interface

WIP

3752142

fix

1ddccdc

migration notes

7df3ae6

deriving Eq for notes + linking issue

f83d289

cleanup

8f407b0

last touches

f9590d0

fix

01e192f

test fix

a1afb7a

benesjan force-pushed the 02-14-refactor_notes_implementing_packable_n_ branch from d8c127f to a1afb7a Compare February 18, 2025 14:07

benesjan removed the e2e-all label Feb 18, 2025

nventuro approved these changes Feb 18, 2025

View reviewed changes

noir-projects/aztec-nr/aztec/src/macros/notes/mod.nr Outdated Show resolved Hide resolved

Update noir-projects/aztec-nr/aztec/src/macros/notes/mod.nr

0def9c1

Co-authored-by: Nicolás Venturo <nicolas.venturo@gmail.com>

benesjan enabled auto-merge (squash) February 18, 2025 16:18

Merge branch 'master' into 02-14-refactor_notes_implementing_packable_n_

73a075d

benesjan merged commit 64e6b13 into master Feb 18, 2025

benesjan deleted the 02-14-refactor_notes_implementing_packable_n_ branch February 18, 2025 17:41

Conversation

benesjan commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

benesjan commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AztecBot commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Docs Preview

Uh oh!

github-actions bot commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes to public function bytecode sizes

🧾 Summary (100% most significant diffs)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nventuro left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

benesjan commented Feb 14, 2025 •

edited

Loading

benesjan commented Feb 14, 2025 •

edited

Loading

AztecBot commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading