feat!: remove addNote, compute_note_hash_... by nventuro · Pull Request #12171 · AztecProtocol/aztec-packages

nventuro · 2025-02-20T20:48:28Z

This removes the addNote function from PXE (addNullifiedNote had been removed in #11822). With this change, PXE no longer needs to understand how to compute note hashes and perform nonce discovery, which means we can also get rid of all of that code, plus we can delete the mandatory compute_note_hash_and_optionally_a_nullifier contract function, plus all of the auxiliary code used to call those.

Instead, contracts that wish to deliver notes to their recipients via offchain mechanisms (i.e. not the protocol logs) must create custom unconstrained functions that know how to construct said notes and add them to PXE. For cases such as TransparentNote, where all of the note contents are public already, this is quite simple: aztec::discovery::process_private_log can be leveraged to a great degree by mimicking the log encoding aztec-nr uses - see the TokenBlacklist and Test contracts for examples of this. More fine grained control could be achieved by calling aztec::discovery::attempt_note_nonce_discovery and then the deliver_note oracle (which is essentially what process_private_log does, sans the decoding).

The removal of compute_note_hash_and_optionally_a_nullifier freed us from some legacy burdens in having to produce the 4 field array, dealing with optional nullifier computation, etc., which in turn allowed for the contract library method _compute_note_hash_and_optionally_a_nullifier to be streamlined and converted into the new compute_note_hash_and_nullifier, which matches aztec::discovery::ComputeNoteHashAndNullifier and hence results in much easier use of the discovery functions.

Tagging @critesjosh since addNote was quite a basic and old primitive.

Closes #11638.

nventuro · 2025-02-20T22:10:09Z

 /// }
 /// ```
-type ComputeNoteHashAndNullifier<Env> = fn[Env](/* packed_note_content */BoundedVec<Field, MAX_NOTE_PACKED_LEN>, /* contract_address */ AztecAddress, /* nonce */ Field, /* storage_slot */ Field, /* note_type_id */ Field) -> Option<NoteHashAndNullifier>;
+type ComputeNoteHashAndNullifier<Env> = unconstrained fn[Env](/* packed_note_content */BoundedVec<Field, MAX_NOTE_PACKED_LEN>, /* storage_slot */ Field, /* note_type_id */ Field, /* contract_address */ AztecAddress, /* nonce */ Field) -> Option<NoteHashAndNullifier>;


I changed this order to one that was more natural - the old one was related to the original order of compute_note_hash....

What's "natural"?

Why is storage_slot before contract_address natural, ser? I do not respect this nature

Because you need the packed content and storage slot to compute the note hash. It later gets siloed by contract address, and later by nonce. If you just compute the inner note hash you never use contract address. Storage slot and note type id are emitted in that order in the logs and passed in that order in the functions - once we extend logs to have things that are not note logs we'll likely change this (since there'll be no storage slot), but this is highly internally consistent right now.

iAmMichaelConnor · 2025-02-21T11:37:35Z

        // `get_note_type_id()` function of each note type that we know of, in order to identify the note type. Once we
-        // know it we call `aztec::note::utils::compute_note_hash_and_optionally_a_nullifier` (which is the one that
-        // actually does the work) with the correct `unpack()` function.
+        // know it we call we correct `unpack` method from the `Packable` trait to obtain the underlying note type, and


"we call we correct unpack method from the Packable trait to obtain the underlying note type"

That seems correct?

"we call we correct" confused me to the point where I blacked out.

Also got short-circuited, lol

benesjan

Lovely

benesjan · 2025-02-21T12:50:14Z

 /// }
 /// ```
-type ComputeNoteHashAndNullifier<Env> = fn[Env](/* packed_note_content */BoundedVec<Field, MAX_NOTE_PACKED_LEN>, /* contract_address */ AztecAddress, /* nonce */ Field, /* storage_slot */ Field, /* note_type_id */ Field) -> Option<NoteHashAndNullifier>;
+type ComputeNoteHashAndNullifier<Env> = unconstrained fn[Env](/* packed_note_content */BoundedVec<Field, MAX_NOTE_PACKED_LEN>, /* storage_slot */ Field, /* note_type_id */ Field, /* contract_address */ AztecAddress, /* nonce */ Field) -> Option<NoteHashAndNullifier>;


Why is storage_slot before contract_address natural, ser? I do not respect this nature

AztecProtocol/aztec-packages#12171

* Version update * changed to stdlib and some patches * Build errors fix * fixed incorrect versioning tag * Build error fix * Contract Canon type error fix * api update imports * invoking node directly * fixed it * added comment * new cannon senario for updating an contract * update packages * Api update for version bump * types package update * parsing fix block * remove console log * api runs without error and Tracking instance update event * migrate scripts * Update packages/backend-utils/src/parse-block.ts Co-authored-by: Filip Harald <Filip.harald@gmail.com> * not mendetory funcion anymore AztecProtocol/aztec-packages#12171 * update packed byte code * update computed address * remove TODO * added to do * moved todo --------- Co-authored-by: filip <filip.harald@gmail.com>

Remove add note

3b905c3

nventuro added the e2e-all label Feb 20, 2025

nventuro requested a review from charlielye as a code owner February 20, 2025 20:48

nventuro removed the request for review from charlielye February 20, 2025 20:48

nventuro added 5 commits February 20, 2025 20:50

Merge branch 'master' into nv/rm-compute-note-hash

15ac04a

Add migration notes

2b7583c

Noir formatting

a853732

Fix removal of compute_note_hash

eee3434

Remove compute_note_hash_and_opt_...

4a32aaa

nventuro requested review from benesjan and iAmMichaelConnor and removed request for benesjan and iAmMichaelConnor February 20, 2025 22:05

Fix yarn lints

f2dcacf

nventuro commented Feb 20, 2025

View reviewed changes

Comment thread docs/docs/aztec/concepts/accounts/index.md

Use fn type

dfdbe93

nventuro commented Feb 20, 2025

View reviewed changes

Comment thread yarn-project/end-to-end/src/e2e_offchain_note_delivery.ts

nventuro commented Feb 20, 2025

View reviewed changes

Comment thread yarn-project/simulator/src/client/private_execution.test.ts

nventuro commented Feb 20, 2025

View reviewed changes

Comment thread yarn-project/simulator/src/client/simulator.test.ts

nventuro requested review from benesjan, critesjosh and iAmMichaelConnor February 20, 2025 22:13

nventuro added 2 commits February 20, 2025 22:22

Fix blacklist tests

22ff683

Remove all mentions

d74c114

iAmMichaelConnor approved these changes Feb 21, 2025

View reviewed changes

benesjan approved these changes Feb 21, 2025

View reviewed changes

Fix blacklist test

2aec304

nventuro enabled auto-merge (squash) February 21, 2025 13:44

Fix offchain delivery test file name

4d9a065

nventuro merged commit 436def3 into master Feb 21, 2025

nventuro deleted the nv/rm-compute-note-hash branch February 21, 2025 15:07

nventuro mentioned this pull request Mar 11, 2025

Allow wallets to discover notes created in a PXE call #12649

Open

Mautjee added a commit to aztec-scan/chicmoz that referenced this pull request Apr 4, 2025

not mendetory funcion anymore

e66793d

AztecProtocol/aztec-packages#12171

Conversation

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

Uh oh!

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!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

benesjan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nventuro commented Feb 20, 2025 •

edited

Loading

benesjan Feb 21, 2025 •

edited

Loading