refactor!: note interfaces by benesjan · Pull Request #12106 · AztecProtocol/aztec-packages

benesjan · 2025-02-19T14:16:04Z

Fixes #12012

Implements a solution described in this comment

benesjan · 2025-02-19T14:16:20Z

refactor!: note interfaces #12106 👈 (View in Graphite)
master

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

benesjan · 2025-02-19T16:32:54Z

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


 Since the `entrypoint` interface is not enshrined, there is nothing that differentiates an account contract from an application one in the protocol. This means that a transaction can be initiated in any contract. This allows implementing functions that do not need to be called by any particular user and are just intended to advance the state of a contract.

-As an example, we can think of a lottery contract, where at some point a prize needs to be paid out to its winners. This `pay` action does not require authentication and does not need to be executed by any user in particular, so anyone could submit a transaction that defines the lottery contract itself as `origin` and `pay` as entrypoint function. For an example of this behavior see our [non_contract_account test](https://github.com/AztecProtocol/aztec-packages/blob/master/yarn-project/end-to-end/src/e2e_non_contract_account.test.ts) and the [SignerLess wallet](https://github.com/AztecProtocol/aztec-packages/blob/master/yarn-project/aztec.js/src/wallet/signerless_wallet.ts) implementation.


Nuke the test link because I nuked the test because it was some stale thing that made no sense.

docs/docs/aztec/smart_contracts/functions/attributes.md

benesjan · 2025-02-20T11:52:28Z

docs/docs/developers/guides/smart_contracts/writing_contracts/notes/custom_note.md

@@ -1,53 +0,0 @@
---


Renamed this to implementing a note and largely rewrote that as it was very stale.

benesjan · 2025-02-20T11:54:32Z

docs/docs/migration_notes.md

@@ -25,8 +25,11 @@ The 3 test accounts deployed in the sandbox are pre-funded with 10 ^ 22 fee juic
 In addition to the native fee juice, users can pay the transaction fees using tokens that have a corresponding FPC contract. The sandbox now includes `BananaCoin` and `BananaFPC`. Users can use a funded test account to mint banana coin for a new account. The new account can then start sending transactions and pay fees with banana coin.

 ```typescript


Just applied formatting here.

benesjan · 2025-02-20T11:54:45Z

docs/docs/migration_notes.md

 + );
 ```

-### [Aztec.nr] Changes to `NoteInterface`


Here is where real changes begin.

benesjan · 2025-02-20T12:15:02Z

noir-projects/aztec-nr/aztec/src/macros/functions/call_interface_stubs.nr

 use crate::macros::utils::{
-    add_to_field_slice, AsStrQuote, compute_fn_selector, get_trait_impl_method, is_fn_private,
-    is_fn_view,
+    add_to_field_slice, AsStrQuote, compute_fn_selector, is_fn_private, is_fn_view,


This just contained an unused import

benesjan · 2025-02-20T12:19:04Z

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

+) -> NoteGetterOptions<ValueNote, N, Field, Field>
+where
+    ValueNote: Packable<N>,
+{


Sneaked this in (Nico 😝) - we relied on VALUE_NOTE_LEN being exported which is an anti-pattern.

Oh this is interesting.

benesjan · 2025-02-20T12:19:30Z

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

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

-pub(crate) global VALUE_NOTE_LEN: u32 = 3; // 3 plus a header.


Sneaked this in (Nico 😝) - we relied on VALUE_NOTE_LEN being exported which is an anti-pattern. On top of that now it could cause a problem if the derived Packable impl. did not match it.

noir-projects/noir-contracts/contracts/test_contract/Nargo.toml

benesjan · 2025-02-20T12:22:45Z

noir-projects/noir-contracts/contracts/test_contract/src/main.nr


-    #[private]
-    // Adapted from TokenContract#redeem_shield but without an initcheck so it can be run in simulator/src/client/private_execution.test.ts
-    fn consume_note_from_secret(secret: Field) {


This was just used in one test which made zero sense so I just nuked it all.

benesjan · 2025-02-20T12:25:22Z

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

@@ -1,54 +0,0 @@
-import { ExtendedNote, Fr, type Logger, Note, type Wallet } from '@aztec/aztec.js';


This test was just weird - it contains just one test case which looks useless at this point and the test case has nothing to do with non_contract_accounts. So I just nuked it all.

benesjan · 2025-02-20T12:26:47Z

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

      });
    });
-
-    it('Should be able to consume a dummy public to private message', async () => {


This test seems like a non-sense. It does nothing with messaging!

This test case was first created 20 months ago and I think it has been updated like 426 times in a negligent way that it became something completely different. So I nuked it

benesjan · 2025-02-20T12:39:06Z

noir-projects/noir-contracts/contracts/docs_example_contract/src/options.nr

@@ -1,18 +1,21 @@
-use crate::types::card_note::{CARD_NOTE_LEN, CardNote};
+use crate::types::card_note::CardNote;


Sneaked changes in this file in (Nico 😝) - we relied on CARD_NOTE_LEN being exported which is an anti-pattern.

boxes/boxes/vanilla/src/contracts/src/main.nr

benesjan · 2025-02-20T13:37:56Z

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

-// docs:start:address_note_struct
-// Stores an address
 #[note]
-#[derive(Eq, Serialize)]


The Serialize trait impl. was unused here so I nuked it.

docs/docs/aztec/smart_contracts/functions/attributes.md

docs/docs/developers/guides/smart_contracts/writing_contracts/common_patterns/index.md

docs/docs/developers/guides/smart_contracts/writing_contracts/notes/address_note.md

docs/docs/developers/guides/smart_contracts/writing_contracts/notes/implementing_a_note.md

docs/docs/developers/reference/smart_contract_reference/storage/private_state.md

noir-projects/aztec-nr/aztec/src/note/note_interface.nr

noir-projects/aztec-nr/uint-note/src/uint_note.nr

nventuro · 2025-02-24T16:55:33Z

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

+) -> NoteGetterOptions<ValueNote, N, Field, Field>
+where
+    ValueNote: Packable<N>,
+{


Oh this is interesting.

noir-projects/noir-contracts/contracts/test_contract/src/main.nr

nventuro · 2025-02-25T18:50:55Z

noir-projects/aztec-nr/aztec/src/encrypted_logs/log_assembly_strategies/default_aes128/note.nr

 ) -> [u8; N * 32 + 64]
 where
-    Note: NoteInterface + Packable<N>,
+    Note: NoteType + Packable<N>,


Been thinking for a while now that this should be NOTE, not Note. Note looks like a type, and we always use caps for generics in other places.

e.g. below Note::get_id() looks quite confusing - as if Note was a trait, which also sounds quite reasonable.

Agree. Created an issue and I will tackle it once we get our note-related PRs merged.

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

* master: (92 commits) chore: Log prover publisher address on creation (#12267) feat: https for bootnode in devnet (#12161) feat(avm): support shifts in lookups (#12280) feat(docs): Add flamegraph tool to counter contract tutorial (#12202) feat(spartan): 192 node 1 tps - additional validator service (#12238) feat(avm): class id derivation (#12263) docs: Fees doc snippets and code snippets (#12229) refactor: proving cost in fee header (#12048) fix: prometheus scrapes itself in the cluster (#12277) feat: metrics (#12256) chore: cleanup stdlib internal imports (#12274) git subrepo push --branch=master noir-projects/aztec-nr git_subrepo.sh: Fix parent in .gitrepo file. [skip ci] chore: replace relative paths to noir-protocol-circuits git subrepo push --branch=master barretenberg fix: Enforce no import side effects (#12268) refactor!: note interfaces (#12106) yolo undenoise tests feat: new transcript functionality to hash elements without including in proof (#12233) chore: remove gcloud metrics (#12265) ...

benesjan changed the title ~~refactor: note interfaces~~ refactor!: note interfaces Feb 19, 2025

benesjan force-pushed the 02-19-refactor_note_interfaces branch from 87bf0e8 to 958aca1 Compare February 19, 2025 15:23

benesjan added the e2e-all label Feb 19, 2025

benesjan force-pushed the 02-19-refactor_note_interfaces branch from 21d1e1c to a004487 Compare February 19, 2025 16:17

benesjan marked this pull request as ready for review February 19, 2025 16:20

benesjan commented Feb 19, 2025

View reviewed changes

benesjan force-pushed the 02-19-refactor_note_interfaces branch 2 times, most recently from ea68afa to 15d71a3 Compare February 20, 2025 08:49

benesjan marked this pull request as draft February 20, 2025 09:01

benesjan force-pushed the 02-19-refactor_note_interfaces branch from 15d71a3 to c9a156d Compare February 20, 2025 11:43