refactor: cleaning up flow of calls generation #18265
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| use crate::macros::{ | ||
| calls_generation::external_functions_stubs::{ | ||
| create_private_self_call_stub, create_private_static_stub, create_private_stub, | ||
| create_public_self_call_static_stub, create_public_self_call_stub, | ||
| create_public_self_enqueue_static_stub, create_public_self_enqueue_stub, | ||
| create_public_static_stub, create_public_stub, create_utility_stub, | ||
| }, | ||
| internals_functions_generation::external_functions_registry, | ||
| utils::is_fn_view, | ||
| }; | ||
|
|
||
| /// Generates external function calls that are to be injected into the contract interface. | ||
| /// | ||
| /// The contract interface enables you to form calls such as `Token::at(address).some_function(args)`. | ||
| /// This function generates the implementation of `some_function` within the interface. | ||
| pub(crate) comptime fn generate_external_function_calls(m: Module) -> Quoted { | ||
| let private_functions = external_functions_registry::get_private_functions(m); | ||
| let public_functions = external_functions_registry::get_public_functions(m); | ||
| let utility_functions = external_functions_registry::get_utility_functions(m); | ||
|
|
||
| let private_contract_methods = private_functions | ||
| .map(|function| { | ||
| if is_fn_view(function) { | ||
| create_private_static_stub(function) | ||
| } else { | ||
| create_private_stub(function) | ||
| } | ||
| }) | ||
| .join(quote {}); | ||
|
|
||
| let public_contract_methods = public_functions | ||
| .map(|function| { | ||
| if is_fn_view(function) { | ||
| create_public_static_stub(function) | ||
| } else { | ||
| create_public_stub(function) | ||
| } | ||
| }) | ||
| .join(quote {}); | ||
|
|
||
| let utility_contract_methods = | ||
| utility_functions.map(|function| create_utility_stub(function)).join(quote {}); | ||
|
|
||
| quote { | ||
| $private_contract_methods | ||
| $public_contract_methods | ||
| $utility_contract_methods | ||
| } | ||
| } | ||
|
|
||
| /// Generates helper structs for convenient self-invocation of contract functions: | ||
| /// | ||
| /// - `CallSelf`: Call your own private or public functions, e.g.: | ||
| /// `self.call_self.some_private_function(args)` | ||
| /// - `CallSelfStatic`: Call your own view (static) functions, e.g.: | ||
| /// `self.call_self_static.some_view_function(args)` | ||
| /// - `EnqueueSelf`: Enqueue your own (non-view) public functions for deferred execution, e.g.: | ||
| /// `self.enqueue_self.some_public_function(args)` | ||
| /// - `EnqueueSelfStatic`: Enqueue your own view public functions, e.g.: | ||
| /// `self.enqueue_self_static.some_view_function(args)` | ||
| pub(crate) comptime fn generate_external_function_self_calls_structs(m: Module) -> Quoted { | ||
| let private_functions = external_functions_registry::get_private_functions(m); | ||
| let public_functions = external_functions_registry::get_public_functions(m); | ||
|
|
||
| let call_self_private_methods = private_functions | ||
| .map(|function| { | ||
| if is_fn_view(function) { | ||
| quote {} | ||
| } else { | ||
| create_private_self_call_stub(function, false) | ||
| } | ||
| }) | ||
| .join(quote {}); | ||
|
|
||
| let call_self_private_static_methods = private_functions | ||
| .map(|function| { | ||
| if is_fn_view(function) { | ||
| create_private_self_call_stub(function, true) | ||
| } else { | ||
| quote {} | ||
| } | ||
| }) | ||
| .join(quote {}); | ||
|
|
||
| let call_self_public_methods = public_functions | ||
| .map(|function| { | ||
| if is_fn_view(function) { | ||
| quote {} | ||
| } else { | ||
| create_public_self_call_stub(function) | ||
| } | ||
| }) | ||
| .join(quote {}); | ||
|
|
||
| let call_self_public_static_methods = public_functions | ||
| .map(|function| { | ||
| if is_fn_view(function) { | ||
| create_public_self_call_static_stub(function) | ||
| } else { | ||
| quote {} | ||
| } | ||
| }) | ||
| .join(quote {}); | ||
|
|
||
| let enqueue_self_methods = public_functions | ||
| .map(|function| { | ||
| if is_fn_view(function) { | ||
| quote {} | ||
| } else { | ||
| create_public_self_enqueue_stub(function) | ||
| } | ||
| }) | ||
| .join(quote {}); | ||
|
|
||
| let enqueue_self_static_methods = public_functions | ||
| .map(|function| { | ||
| if is_fn_view(function) { | ||
| create_public_self_enqueue_static_stub(function) | ||
| } else { | ||
| quote {} | ||
| } | ||
| }) | ||
| .join(quote {}); | ||
|
|
||
| quote { | ||
| pub struct CallSelf<Context> { | ||
| pub address: dep::aztec::protocol_types::address::AztecAddress, | ||
| pub context: Context, | ||
| } | ||
|
|
||
| impl CallSelf<&mut dep::aztec::context::private_context::PrivateContext> { | ||
| $call_self_private_methods | ||
| } | ||
|
|
||
| impl CallSelf<dep::aztec::context::public_context::PublicContext> { | ||
| $call_self_public_methods | ||
| } | ||
|
|
||
| pub struct CallSelfStatic<Context> { | ||
| pub address: dep::aztec::protocol_types::address::AztecAddress, | ||
| pub context: Context, | ||
| } | ||
|
|
||
| impl CallSelfStatic<&mut dep::aztec::context::private_context::PrivateContext> { | ||
| $call_self_private_static_methods | ||
| } | ||
|
|
||
| impl CallSelfStatic<dep::aztec::context::public_context::PublicContext> { | ||
| $call_self_public_static_methods | ||
| } | ||
|
|
||
| pub struct EnqueueSelf<Context> { | ||
| pub address: dep::aztec::protocol_types::address::AztecAddress, | ||
| pub context: Context, | ||
| } | ||
|
|
||
| impl EnqueueSelf<&mut dep::aztec::context::private_context::PrivateContext> { | ||
| $enqueue_self_methods | ||
| } | ||
|
|
||
| pub struct EnqueueSelfStatic<Context> { | ||
| pub address: dep::aztec::protocol_types::address::AztecAddress, | ||
| pub context: Context, | ||
| } | ||
|
|
||
| impl EnqueueSelfStatic<&mut dep::aztec::context::private_context::PrivateContext> { | ||
| $enqueue_self_static_methods | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Somewhat unrelated but felt like the original function name was no longer descriptive enough.