Skip to content

Commit

Permalink
refactor: call interface macros cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
@benesjan
benesjan committed Feb 18, 2025
1 parent 518ab62 commit 2c5df4b
Show file tree
Hide file tree
Showing 6 changed files with 415 additions and 177 deletions.
221 changes: 165 additions & 56 deletions noir-projects/aztec-nr/aztec/src/context/call_interfaces.nr
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,28 @@ pub trait CallInterface<let N: u32> {
}

pub struct PrivateCallInterface<let N: u32, T> {
pub target_contract: AztecAddress,
pub selector: FunctionSelector,
pub name: str<N>,
pub args_hash: Field,
pub args: [Field],
pub return_type: T,
pub is_static: bool,
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args_hash: Field,
args: [Field],
return_type: T,
is_static: bool,
}

impl<let N: u32, T> PrivateCallInterface<N, T> {
pub fn new(
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args: [Field],
return_type: T,
is_static: bool,
) -> Self {
let args_hash = hash_args(args);
Self { target_contract, selector, name, args_hash, args, return_type, is_static }
}

pub fn call<let M: u32>(self, context: &mut PrivateContext) -> T
where
T: Deserialize<M>,
Expand Down Expand Up @@ -79,16 +91,27 @@ impl<let N: u32> CallInterface<N> for PrivateVoidCallInterface<N> {
}

pub struct PrivateVoidCallInterface<let N: u32> {
pub target_contract: AztecAddress,
pub selector: FunctionSelector,
pub name: str<N>,
pub args_hash: Field,
pub args: [Field],
pub return_type: (),
pub is_static: bool,
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args_hash: Field,
args: [Field],
return_type: (), // Unit type () indicates this interface is for functions that return nothing (void)
is_static: bool,
}

impl<let N: u32> PrivateVoidCallInterface<N> {
pub fn new(
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args: [Field],
is_static: bool,
) -> Self {
let args_hash = hash_args(args);
Self { target_contract, selector, name, args_hash, args, return_type: (), is_static }
}

pub fn call(self, context: &mut PrivateContext) {
execution_cache::store(self.args);
context
Expand Down Expand Up @@ -137,16 +160,27 @@ impl<let N: u32, T> CallInterface<N> for PrivateStaticCallInterface<N, T> {
}

pub struct PrivateStaticCallInterface<let N: u32, T> {
pub target_contract: AztecAddress,
pub selector: FunctionSelector,
pub name: str<N>,
pub args_hash: Field,
pub args: [Field],
pub return_type: T,
pub is_static: bool,
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args_hash: Field,
args: [Field],
return_type: T,
is_static: bool,
}

impl<let N: u32, T> PrivateStaticCallInterface<N, T> {
pub fn new(
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args: [Field],
return_type: T,
) -> Self {
let args_hash = hash_args(args);
Self { target_contract, selector, name, args_hash, args, return_type, is_static: true }
}

pub fn view<let M: u32>(self, context: &mut PrivateContext) -> T
where
T: Deserialize<M>,
Expand Down Expand Up @@ -185,16 +219,26 @@ impl<let N: u32> CallInterface<N> for PrivateStaticVoidCallInterface<N> {
}

pub struct PrivateStaticVoidCallInterface<let N: u32> {
pub target_contract: AztecAddress,
pub selector: FunctionSelector,
pub name: str<N>,
pub args_hash: Field,
pub args: [Field],
pub return_type: (),
pub is_static: bool,
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args_hash: Field,
args: [Field],
return_type: (), // Unit type () indicates this interface is for functions that return nothing (void)
is_static: bool,
}

impl<let N: u32> PrivateStaticVoidCallInterface<N> {
pub fn new(
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args: [Field],
) -> Self {
let args_hash = hash_args(args);
Self { target_contract, selector, name, args_hash, args, return_type: (), is_static: true }
}

pub fn view(self, context: &mut PrivateContext) {
execution_cache::store(self.args);
context
Expand Down Expand Up @@ -231,16 +275,35 @@ impl<let N: u32, T> CallInterface<N> for PublicCallInterface<N, T> {
}

pub struct PublicCallInterface<let N: u32, T> {
pub target_contract: AztecAddress,
pub selector: FunctionSelector,
pub name: str<N>,
pub args: [Field],
pub gas_opts: GasOpts,
pub return_type: T,
pub is_static: bool,
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args: [Field],
gas_opts: GasOpts,
return_type: T,
is_static: bool,
}

impl<let N: u32, T> PublicCallInterface<N, T> {
pub fn new(
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args: [Field],
return_type: T,
is_static: bool,
) -> Self {
Self {
target_contract,
selector,
name,
args,
gas_opts: GasOpts::default(),
return_type,
is_static,
}
}

pub fn with_gas(self: &mut Self, gas_opts: GasOpts) -> &mut Self {
self.gas_opts = gas_opts;
self
Expand Down Expand Up @@ -320,16 +383,27 @@ impl<let N: u32> CallInterface<N> for PublicVoidCallInterface<N> {
}

pub struct PublicVoidCallInterface<let N: u32> {
pub target_contract: AztecAddress,
pub selector: FunctionSelector,
pub name: str<N>,
pub args: [Field],
pub return_type: (),
pub is_static: bool,
pub gas_opts: GasOpts,
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args: [Field],
return_type: (), // Unit type () indicates this interface is for functions that return nothing (void)
is_static: bool,
gas_opts: GasOpts,
}

impl<let N: u32> PublicVoidCallInterface<N> {
pub fn new(
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args: [Field],
is_static: bool,
gas_opts: GasOpts,
) -> Self {
Self { target_contract, selector, name, args, return_type: (), is_static, gas_opts }
}

pub fn with_gas(self: &mut Self, gas_opts: GasOpts) -> &mut Self {
self.gas_opts = gas_opts;
self
Expand Down Expand Up @@ -403,16 +477,34 @@ impl<let N: u32, T> CallInterface<N> for PublicStaticCallInterface<N, T> {
}

pub struct PublicStaticCallInterface<let N: u32, T> {
pub target_contract: AztecAddress,
pub selector: FunctionSelector,
pub name: str<N>,
pub args: [Field],
pub return_type: T,
pub is_static: bool,
pub gas_opts: GasOpts,
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args: [Field],
return_type: T,
is_static: bool,
gas_opts: GasOpts,
}

impl<let N: u32, T> PublicStaticCallInterface<N, T> {
pub fn new(
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args: [Field],
return_type: T,
) -> Self {
Self {
target_contract,
selector,
name,
args,
return_type,
is_static: true,
gas_opts: GasOpts::default(),
}
}

pub fn with_gas(self: &mut Self, gas_opts: GasOpts) -> &mut Self {
self.gas_opts = gas_opts;
self
Expand Down Expand Up @@ -467,16 +559,33 @@ impl<let N: u32> CallInterface<N> for PublicStaticVoidCallInterface<N> {
}

pub struct PublicStaticVoidCallInterface<let N: u32> {
pub target_contract: AztecAddress,
pub selector: FunctionSelector,
pub name: str<N>,
pub args: [Field],
pub return_type: (),
pub is_static: bool,
pub gas_opts: GasOpts,
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args: [Field],
return_type: (), // Unit type () indicates this interface is for functions that return nothing (void)
is_static: bool,
gas_opts: GasOpts,
}

impl<let N: u32> PublicStaticVoidCallInterface<N> {
pub fn new(
target_contract: AztecAddress,
selector: FunctionSelector,
name: str<N>,
args: [Field],
) -> Self {
Self {
target_contract,
selector,
name,
args,
return_type: (),
is_static: true,
gas_opts: GasOpts::default(),
}
}

pub fn with_gas(self: &mut Self, gas_opts: GasOpts) -> &mut Self {
self.gas_opts = gas_opts;
self
Expand Down
35 changes: 35 additions & 0 deletions noir-projects/aztec-nr/aztec/src/macros/functions/abi_export.nr
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
use std::meta::type_of;

pub(crate) comptime fn create_fn_abi_export(f: FunctionDefinition) -> Quoted {
let name = f.name();
let mut parameters =
f.parameters().map(|(name, typ): (Quoted, Type)| quote { pub $name: $typ }).join(quote {,});

let parameters_struct_name = f"{name}_parameters".quoted_contents();
let parameters = quote {
pub struct $parameters_struct_name {
$parameters
}
};

let return_value_type = f.return_type();
let return_type = if return_value_type != type_of(()) {
quote { return_type: $return_value_type }
} else {
quote {}
};

let abi_struct_name = f"{name}_abi".quoted_contents();

let result = quote {

$parameters

#[abi(functions)]
pub struct $abi_struct_name {
parameters: $parameters_struct_name,
$return_type
}
};
result
}
Loading

0 comments on commit 2c5df4b

Please sign in to comment.