refactor: function macros cleanup by benesjan · Pull Request #12066 · AztecProtocol/aztec-packages

benesjan · 2025-02-18T10:57:22Z

Cleans up CallInterfaces by adding a "new(...)" function and hiding struct fields.
Attempts making stub_fn readable.

benesjan · 2025-02-18T10:57:48Z

refactor: function macros cleanup #12066 👈 (View in Graphite)
fix: #[aztec] macro warnings #12038
refactor!: Notes implementing Packable<N> #12004
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-18T13:49:53Z

noir-projects/aztec-nr/aztec/src/context/call_interfaces.nr

@@ -16,16 +16,35 @@ pub trait CallInterface<let N: u32> {
 }

 pub struct PrivateCallInterface<let N: u32, T> {


As Nico proposed in a PR down the stack - makes sense to have the args private and instead use the new method. All the changes in this file are a reflection of that.

benesjan · 2025-02-18T13:51:21Z

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

@@ -0,0 +1,35 @@
+use std::meta::type_of;
+
+pub(crate) comptime fn create_fn_abi_export(f: FunctionDefinition) -> Quoted {


Moved this function from intercaces.nr as that file was too cluttered. There is no code change here.

benesjan · 2025-02-18T13:52:37Z

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

+
+comptime global SERIALIZED_ARGS_SLICE_NAME: Quoted = quote { serialized_args };
+
+pub comptime fn stub_fn(f: FunctionDefinition) -> Quoted {


This function was originally in interfaces.nr but I have completely rewrote it because it was impossible to read. In hindsight I shouldn't have moved it in the same PR. Sorry for the bad diff. (The diff would be huge here anyway as I reshufled it)

benesjan · 2025-02-18T13:53:19Z

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

+    let is_static_call = is_fn_view(f);
+    let is_void = f.return_type() == type_of(());
+
+    if is_fn_private(f) {


This is the main change here. I branch into individual cases and there I return the complete quote from there.

benesjan · 2025-02-18T13:56:52Z

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

@@ -1,14 +1,10 @@
-pub mod interfaces;
-pub mod initialization_utils;


I found this file very hard to read so I decided to keep here only the public functions and moved the rest to other files.

benesjan · 2025-02-18T13:57:46Z

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

-    // Marker attribute
-}
-
-comptime fn create_internal_check(f: FunctionDefinition) -> Quoted {


Moved these utility functions to utils.nr in the same folder.

benesjan · 2025-02-18T13:59:28Z

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

@@ -0,0 +1,19 @@
+use std::{collections::umap::UHashMap, hash::{BuildHasherDefault, poseidon2::Poseidon2Hasher}};


This got moved in here from interfaces.nr. The other change here is that instead of exposing the STUBS global I just expose the setter and getter. This makes it nicer to read as everywhere we either use only the getter or the setter.

benesjan · 2025-02-18T13:59:55Z

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

@@ -0,0 +1,320 @@
+use crate::macros::{


All the code here is just copied from mod.nr.

benesjan · 2025-02-18T14:00:36Z

noir-projects/aztec-nr/aztec/src/macros/utils.nr

 }

-trait AsStrQuote {
+pub(crate) trait AsStrQuote {


Did this to fix warnings when importing it.

* 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 18, 2025

fix: note hash collision #11869

Merged

refactor: moving storage slot out of NoteHeader #11904

Merged

refactor!: nuking NoteHeader #11942

Merged

refactor!: Notes implementing Packable<N> #12004

Merged

benesjan mentioned this pull request Feb 18, 2025

fix: #[aztec] macro warnings #12038

Merged

benesjan force-pushed the 02-18-refactor_call_interface_macros_cleanup branch from 0f6b664 to 2c5df4b Compare February 18, 2025 11:33

benesjan added the e2e-all label Feb 18, 2025

benesjan marked this pull request as ready for review February 18, 2025 12:47

benesjan commented Feb 18, 2025

View reviewed changes

benesjan force-pushed the 02-18-refactor_call_interface_macros_cleanup branch from b396777 to a1e5a72 Compare February 18, 2025 14:07

benesjan force-pushed the 02-17-fix_missing_import_warnings_in_macros branch from 518ab62 to a21c5bc Compare February 18, 2025 14:07

benesjan force-pushed the 02-18-refactor_call_interface_macros_cleanup branch 2 times, most recently from b16a373 to fc2655a Compare February 18, 2025 15:16

benesjan force-pushed the 02-17-fix_missing_import_warnings_in_macros branch from 381501c to fb8222e Compare February 18, 2025 18:05

benesjan force-pushed the 02-18-refactor_call_interface_macros_cleanup branch from eba9bf3 to 2c9a324 Compare February 18, 2025 18:05

Base automatically changed from 02-17-fix_missing_import_warnings_in_macros to master February 18, 2025 18:44

benesjan added 5 commits February 18, 2025 18:55

refactor: call interface macros cleanup

2429004

WIP

5d6617a

WIP

a1a4a3d

WIP

27fee05

moving stuff around

def6d9f

benesjan added 3 commits February 18, 2025 18:55

comment

a5ab82f

fmt

cc8d152

fix

ff5849b

benesjan force-pushed the 02-18-refactor_call_interface_macros_cleanup branch from 2c9a324 to ff5849b Compare February 18, 2025 18:56

benesjan changed the title ~~refactor: call interface macros cleanup~~ refactor: function macros cleanup Feb 18, 2025

benesjan requested a review from nventuro February 18, 2025 19:21

nventuro approved these changes Feb 18, 2025

View reviewed changes

benesjan merged commit a00fa0e into master Feb 18, 2025

benesjan deleted the 02-18-refactor_call_interface_macros_cleanup branch February 18, 2025 19:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: function macros cleanup#12066

refactor: function macros cleanup#12066
benesjan merged 8 commits intomasterfrom
02-18-refactor_call_interface_macros_cleanup

benesjan commented Feb 18, 2025 •

edited

Loading

Uh oh!

benesjan commented Feb 18, 2025 •

edited

Loading

Uh oh!

benesjan Feb 18, 2025

Uh oh!

benesjan Feb 18, 2025

Uh oh!

benesjan Feb 18, 2025 •

edited

Loading

Uh oh!

benesjan Feb 18, 2025

Uh oh!

benesjan Feb 18, 2025

Uh oh!

benesjan Feb 18, 2025

Uh oh!

benesjan Feb 18, 2025

Uh oh!

nventuro Feb 18, 2025

Uh oh!

benesjan Feb 18, 2025

Uh oh!

benesjan Feb 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -16,16 +16,35 @@ pub trait CallInterface<let N: u32> {
		}

		pub struct PrivateCallInterface<let N: u32, T> {

		@@ -0,0 +1,35 @@
		use std::meta::type_of;

		pub(crate) comptime fn create_fn_abi_export(f: FunctionDefinition) -> Quoted {


		comptime global SERIALIZED_ARGS_SLICE_NAME: Quoted = quote { serialized_args };

		pub comptime fn stub_fn(f: FunctionDefinition) -> Quoted {

		@@ -1,14 +1,10 @@
		pub mod interfaces;
		pub mod initialization_utils;

		@@ -0,0 +1,19 @@
		use std::{collections::umap::UHashMap, hash::{BuildHasherDefault, poseidon2::Poseidon2Hasher}};

Conversation

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

Uh oh!

Uh oh!

benesjan commented Feb 18, 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!

benesjan Feb 18, 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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

benesjan commented Feb 18, 2025 •

edited

Loading

benesjan commented Feb 18, 2025 •

edited

Loading

benesjan Feb 18, 2025 •

edited

Loading