make helper constructors for internal/utility in public

Author: vezenovm

noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/public.nr

@@ -18,10 +18,7 @@ use crate::macros::{
 /// helper keeps that AVM-bytecode-heavy preamble from being duplicated into every public function body.
 pub(crate) comptime fn generate_public_self_builder_from_context(m: Module) -> Quoted {
     let (storage_type, storage_init) = if module_has_storage(m) {
-        (
-            quote { Storage<aztec::context::PublicContext> },
-            quote { let storage = Storage::init(context); },
-        )
+        (quote { Storage<aztec::context::PublicContext> }, quote { let storage = Storage::init(context); })
     } else {
         // Contract does not have Storage defined, so we set storage to the unit type `()`. ContractSelfPublic requires
         // a storage struct in its constructor. Using an Option type would lead to worse developer experience and

noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/utility.nr

@@ -1,33 +1,43 @@
 use crate::macros::utils::{fn_has_noinitcheck, module_has_initializer, module_has_storage};
 
-pub(crate) comptime fn generate_utility_external(f: FunctionDefinition) -> Quoted {
-    let module_has_initializer = module_has_initializer(f.module());
-
-    // Initialize Storage if module has storage
-    let storage_init = if module_has_storage(f.module()) {
-        quote {
-            let storage = Storage::init(context);
-        }
+/// Emits a per-contract helper that builds the `self` value used by every utility external function.
+///
+/// Each utility external function calls this helper instead of inlining the construction, so the
+/// `UtilityContext::new`/`Storage::init`/`CallSelfUtility`/`ContractSelfUtility::new` chain does not appear duplicated
+/// in every utility function body. We let Noir's inliner decide whether to inline the helper at each call site rather
+/// than forcing it via macro expansion.
+///
+/// Unlike the public counterpart, this helper takes no arguments because `UtilityContext::new` does not need calldata.
+pub(crate) comptime fn generate_utility_self_creator(m: Module) -> Quoted {
+    let (storage_type, storage_init) = if module_has_storage(m) {
+        (quote { Storage<aztec::context::UtilityContext> }, quote { let storage = Storage::init(context); })
     } else {
-        // Contract does not have Storage defined, so we set storage to the unit type `()`. ContractSelfUtility
-        // requires a
-        // storage struct in its constructor. Using an Option type would lead to worse developer experience and higher
+        // Contract does not have Storage defined, so we set storage to the unit type `()`. ContractSelfUtility requires
+        // a storage struct in its constructor. Using an Option type would lead to worse developer experience and higher
         // constraint counts so we use the unit type `()` instead.
-        quote {
-            let storage = ();
-        }
+        (quote { () }, quote { let storage = (); })
     };
 
-    // Create utility context
-    let contract_self_creation = quote {
-        #[allow(unused_variables)]
-        let mut self = {
+    quote {
+        #[contract_library_method]
+        unconstrained fn __aztec_nr_internals__create_utility_self() -> aztec::contract_self::ContractSelfUtility<$storage_type, CallSelfUtility> {
             let context = aztec::context::UtilityContext::new();
             $storage_init
             let self_address = context.this_address();
             let call_self = CallSelfUtility { address: self_address };
             aztec::contract_self::ContractSelfUtility::new(context, storage, call_self)
-        };
+        }
+    }
+}
+
+pub(crate) comptime fn generate_utility_external(f: FunctionDefinition) -> Quoted {
+    let module_has_initializer = module_has_initializer(f.module());
+
+    // Construct `self` via the per-contract `__aztec_nr_internals__create_utility_self` helper rather than inlining the
+    // preamble in every utility function. See `generate_utility_self_creator` for the helper definition.
+    let contract_self_creation = quote {
+        #[allow(unused_variables)]
+        let mut self = __aztec_nr_internals__create_utility_self();
     };
 
     // Initialization checks are not included in contracts that don't have initializers.

noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/internal.nr

@@ -57,6 +57,7 @@ pub(crate) comptime fn generate_private_internal(f: FunctionDefinition) -> Quote
 /// this module.
 ///
 /// The `self` value is constructed by delegating to the per-contract
+///
 /// [`__aztec_nr_internals__build_public_self_from_context`](super::external::public::generate_public_self_builder_from_context)
 /// helper rather than inlining the preamble in every internal body.
 pub(crate) comptime fn generate_public_internal(f: FunctionDefinition) -> Quoted {

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

@@ -13,11 +13,8 @@ pub(crate) mod internal;
 use abi_export::create_fn_abi_export;
 use external::{
     private::generate_private_external,
-    public::{
-        generate_public_external, generate_public_self_builder_from_context,
-        generate_public_self_creator,
-    },
-    utility::generate_utility_external,
+    public::{generate_public_external, generate_public_self_builder_from_context, generate_public_self_creator},
+    utility::{generate_utility_external, generate_utility_self_creator},
 };
 use internal::{generate_private_internal, generate_public_internal};
 
@@ -72,6 +69,15 @@ pub(crate) comptime fn process_functions(m: Module) -> Quoted {
         quote {}
     };
 
+    // Same idea for utility functions: emit a per-contract helper that builds the `self` value, so the construction is
+    // not duplicated into every utility body. UtilityContext takes no calldata, so a single helper is enough; there is
+    // no internal/external split to share with.
+    let utility_self_creator = if utility_functions.len() > 0 {
+        generate_utility_self_creator(m)
+    } else {
+        quote {}
+    };
+
     // Now that we have generated quotes of the new functions based on the original function definitions, we replace
     // the original functions' bodies with `static_assert(false, ...)` to prevent them from being called directly from
     // within the contract. We also need to set the return type to `()` to avoid compilation errors.
@@ -107,6 +113,7 @@ pub(crate) comptime fn process_functions(m: Module) -> Quoted {
     quote {
         $public_self_builder_from_context
         $public_self_creator
+        $utility_self_creator
         $transformed_private_functions
         $transformed_public_functions
         $transformed_utility_functions

noir-projects/contract-snapshots/tests/snapshots/compile_failure/authorize_once_from_wrong_type/snapshots__stderr.snap

@@ -14,13 +14,13 @@ error: Argument from in function foo must be of type AztecAddress, but is of typ
     2: aztec
             at <repo>/noir-projects/aztec-nr/aztec/src/macros/aztec.nr:97:21
     3: process_functions
-            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:51:9
+            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:48:9
     4: [T]::map
             at std/vector.nr:67:33
     5: process_functions
-            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:51:41
+            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:48:41
     6: generate_public_external
-            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/public.nr:139:9
+            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/public.nr:136:9
     7: create_authorize_once_check
             at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/helpers.nr:72:9
 

noir-projects/contract-snapshots/tests/snapshots/compile_failure/authorize_once_missing_from_param/snapshots__stderr.snap

@@ -14,13 +14,13 @@ error: Function foo does not have a from parameter. Please specify which one to
     2: aztec
             at <repo>/noir-projects/aztec-nr/aztec/src/macros/aztec.nr:97:21
     3: process_functions
-            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:51:9
+            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:48:9
     4: [T]::map
             at std/vector.nr:67:33
     5: process_functions
-            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:51:41
+            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:48:41
     6: generate_public_external
-            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/public.nr:139:9
+            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/public.nr:136:9
     7: create_authorize_once_check
             at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/helpers.nr:67:9
 

noir-projects/contract-snapshots/tests/snapshots/compile_failure/authorize_once_missing_nonce_param/snapshots__stderr.snap

@@ -14,13 +14,13 @@ error: Function foo does not have a authwit_nonce. Please specify which one to u
     2: aztec
             at <repo>/noir-projects/aztec-nr/aztec/src/macros/aztec.nr:97:21
     3: process_functions
-            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:51:9
+            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:48:9
     4: [T]::map
             at std/vector.nr:67:33
     5: process_functions
-            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:51:41
+            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:48:41
     6: generate_public_external
-            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/public.nr:139:9
+            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/public.nr:136:9
     7: create_authorize_once_check
             at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/helpers.nr:81:9
 

noir-projects/contract-snapshots/tests/snapshots/compile_failure/authorize_once_nonce_wrong_type/snapshots__stderr.snap

@@ -14,13 +14,13 @@ error: Argument authwit_nonce in function foo must be of type Field, but is of t
     2: aztec
             at <repo>/noir-projects/aztec-nr/aztec/src/macros/aztec.nr:97:21
     3: process_functions
-            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:51:9
+            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:48:9
     4: [T]::map
             at std/vector.nr:67:33
     5: process_functions
-            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:51:41
+            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/mod.nr:48:41
     6: generate_public_external
-            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/public.nr:139:9
+            at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/public.nr:136:9
     7: create_authorize_once_check
             at <repo>/noir-projects/aztec-nr/aztec/src/macros/internals_functions_generation/external/helpers.nr:86:9
 

noir-projects/contract-snapshots/tests/snapshots/expand/amm_contract/snapshots__expanded.snap

@@ -2546,15 +2546,18 @@ pub contract AMM {
         aztec::macros::functions::initialization_utils::mark_as_initialized_from_public_initializer(self.context);
     }
 
+    #[contract_library_method]
+    unconstrained fn __aztec_nr_internals__create_utility_self() -> aztec::contract_self::contract_self_utility::ContractSelfUtility<Storage<aztec::context::UtilityContext>, CallSelfUtility> {
+        let context: aztec::context::UtilityContext = aztec::context::UtilityContext::new();
+        let storage: Storage<aztec::context::UtilityContext> = Storage::<aztec::context::UtilityContext>::init(context);
+        let self_address: AztecAddress = context.this_address();
+        let call_self: CallSelfUtility = CallSelfUtility { address: self_address};
+        aztec::contract_self::contract_self_utility::ContractSelfUtility::<Storage<aztec::context::UtilityContext>, CallSelfUtility>::new(context, storage, call_self)
+    }
+
     unconstrained fn __aztec_nr_internals__get_amount_in_for_exact_out(balance_in: u128, balance_out: u128, amount_out: u128) -> pub u128 {
         aztec::oracle::version::assert_compatible_oracle_version();
-        let mut self: aztec::contract_self::contract_self_utility::ContractSelfUtility<Storage<aztec::context::UtilityContext>, CallSelfUtility> = {
-            let context: aztec::context::UtilityContext = aztec::context::UtilityContext::new();
-            let storage: Storage<aztec::context::UtilityContext> = Storage::<aztec::context::UtilityContext>::init(context);
-            let self_address: AztecAddress = context.this_address();
-            let call_self: CallSelfUtility = CallSelfUtility { address: self_address};
-            aztec::contract_self::contract_self_utility::ContractSelfUtility::<Storage<aztec::context::UtilityContext>, CallSelfUtility>::new(context, storage, call_self)
-        };
+        let mut self: aztec::contract_self::contract_self_utility::ContractSelfUtility<Storage<aztec::context::UtilityContext>, CallSelfUtility> = __aztec_nr_internals__create_utility_self();
         aztec::macros::functions::initialization_utils::assert_is_initialized_utility(self.context);
         {
             get_amount_in(amount_out, balance_in, balance_out)
@@ -2563,13 +2566,7 @@ pub contract AMM {
 
     unconstrained fn __aztec_nr_internals__get_amount_out_for_exact_in(balance_in: u128, balance_out: u128, amount_in: u128) -> pub u128 {
         aztec::oracle::version::assert_compatible_oracle_version();
-        let mut self: aztec::contract_self::contract_self_utility::ContractSelfUtility<Storage<aztec::context::UtilityContext>, CallSelfUtility> = {
-            let context: aztec::context::UtilityContext = aztec::context::UtilityContext::new();
-            let storage: Storage<aztec::context::UtilityContext> = Storage::<aztec::context::UtilityContext>::init(context);
-            let self_address: AztecAddress = context.this_address();
-            let call_self: CallSelfUtility = CallSelfUtility { address: self_address};
-            aztec::contract_self::contract_self_utility::ContractSelfUtility::<Storage<aztec::context::UtilityContext>, CallSelfUtility>::new(context, storage, call_self)
-        };
+        let mut self: aztec::contract_self::contract_self_utility::ContractSelfUtility<Storage<aztec::context::UtilityContext>, CallSelfUtility> = __aztec_nr_internals__create_utility_self();
         aztec::macros::functions::initialization_utils::assert_is_initialized_utility(self.context);
         {
             get_amount_out(amount_in, balance_in, balance_out)

noir-projects/contract-snapshots/tests/snapshots/expand/token_contract/snapshots__expanded.snap

@@ -3986,15 +3986,18 @@ pub contract Token {
         }
     }
 
+    #[contract_library_method]
+    unconstrained fn __aztec_nr_internals__create_utility_self() -> aztec::contract_self::contract_self_utility::ContractSelfUtility<Storage<aztec::context::UtilityContext>, CallSelfUtility> {
+        let context: aztec::context::UtilityContext = aztec::context::UtilityContext::new();
+        let storage: Storage<aztec::context::UtilityContext> = Storage::<aztec::context::UtilityContext>::init(context);
+        let self_address: AztecAddress = context.this_address();
+        let call_self: CallSelfUtility = CallSelfUtility { address: self_address};
+        aztec::contract_self::contract_self_utility::ContractSelfUtility::<Storage<aztec::context::UtilityContext>, CallSelfUtility>::new(context, storage, call_self)
+    }
+
     unconstrained fn __aztec_nr_internals__balance_of_private(owner: AztecAddress) -> pub u128 {
         aztec::oracle::version::assert_compatible_oracle_version();
-        let mut self: aztec::contract_self::contract_self_utility::ContractSelfUtility<Storage<aztec::context::UtilityContext>, CallSelfUtility> = {
-            let context: aztec::context::UtilityContext = aztec::context::UtilityContext::new();
-            let storage: Storage<aztec::context::UtilityContext> = Storage::<aztec::context::UtilityContext>::init(context);
-            let self_address: AztecAddress = context.this_address();
-            let call_self: CallSelfUtility = CallSelfUtility { address: self_address};
-            aztec::contract_self::contract_self_utility::ContractSelfUtility::<Storage<aztec::context::UtilityContext>, CallSelfUtility>::new(context, storage, call_self)
-        };
+        let mut self: aztec::contract_self::contract_self_utility::ContractSelfUtility<Storage<aztec::context::UtilityContext>, CallSelfUtility> = __aztec_nr_internals__create_utility_self();
         aztec::macros::functions::initialization_utils::assert_is_initialized_utility(self.context);
         {
             self.storage.balances.at(owner).balance_of()