Skip to content

chore: simplify note getter oracle #12807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nventuro merged 5 commits into from
Mar 17, 2025
Merged

chore: simplify note getter oracle #12807

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d699d8a
remove placeholder_note_length
nventuro Mar 17, 2025
de1ccaa
Remove placeholder fields, oracle wrapper
nventuro Mar 17, 2025
d7e26b1
chore: begin simplification of get_notes
nventuro Mar 17, 2025
bc8d573
rm more types
nventuro Mar 17, 2025
d6ad969
Update noir-projects/aztec-nr/aztec/src/oracle/notes.nr
nventuro Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 7 additions & 19 deletions noir-projects/aztec-nr/aztec/src/note/note_getter.nr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,8 @@ where
let filter_args = options.filter_args;
let filtered_notes = filter_fn(opt_notes, filter_args);

let notes: BoundedVec<RetrievedNote<Note>, 16> = crate::utils::array::collapse(filtered_notes);
let mut note_hashes: BoundedVec<Field, MAX_NOTE_HASH_READ_REQUESTS_PER_CALL> =
BoundedVec::new();
let notes = crate::utils::array::collapse(filtered_notes);
let mut note_hashes = BoundedVec::new();

// We have now collapsed the sparse array of Options into a BoundedVec. This is a more ergonomic type and also
// results in reduced gate counts when setting a limit value, since we guarantee that the limit is an upper bound
Expand Down Expand Up @@ -185,10 +184,8 @@ unconstrained fn get_note_internal<Note, let N: u32>(storage_slot: Field) -> Ret
where
Note: NoteType + Packable<N>,
{
let placeholder_note = [Option::none()];
let placeholder_fields = [0; GET_NOTE_ORACLE_RETURN_LENGTH];
let placeholder_note_length = [0; N];
oracle::notes::get_notes(
let opt_notes: [_; 1] = oracle::notes::get_notes(
storage_slot,
0,
[],
Expand All @@ -203,11 +200,10 @@ where
1, // limit
0, // offset
NoteStatus.ACTIVE,
placeholder_note,
placeholder_fields,
placeholder_note_length,
)[0]
.expect(f"Failed to get a note") // Notice: we don't allow dummies to be returned from get_note (singular).
);

opt_notes[0].expect(f"Failed to get a note") // Notice: we don't allow dummies to be returned from get_note (singular).
}

unconstrained fn get_notes_internal<Note, let N: u32, PREPROCESSOR_ARGS, FILTER_ARGS>(
Expand All @@ -220,9 +216,7 @@ where
// This function simply performs some transformations from NoteGetterOptions into the types required by the oracle.
let (num_selects, select_by_indexes, select_by_offsets, select_by_lengths, select_values, select_comparators, sort_by_indexes, sort_by_offsets, sort_by_lengths, sort_order) =
flatten_options(options.selects, options.sorts);
let placeholder_opt_notes = [Option::none(); MAX_NOTE_HASH_READ_REQUESTS_PER_CALL];
let placeholder_fields = [0; GET_NOTES_ORACLE_RETURN_LENGTH];
let placeholder_note_length = [0; N];

let opt_notes = oracle::notes::get_notes(
storage_slot,
Expand All @@ -239,9 +233,7 @@ where
options.limit,
options.offset,
options.status,
placeholder_opt_notes,
placeholder_fields,
placeholder_note_length,
);

apply_preprocessor(opt_notes, options.preprocessor, options.preprocessor_args)
Expand All @@ -256,11 +248,9 @@ where
{
let (num_selects, select_by_indexes, select_by_offsets, select_by_lengths, select_values, select_comparators, sort_by_indexes, sort_by_offsets, sort_by_lengths, sort_order) =
flatten_options(options.selects, options.sorts);
let placeholder_opt_notes = [Option::none(); MAX_NOTES_PER_PAGE];
let placeholder_fields = [0; VIEW_NOTE_ORACLE_RETURN_LENGTH];
let placeholder_note_length = [0; N];

let notes_array = oracle::notes::get_notes(
let notes_array: [_; MAX_NOTES_PER_PAGE] = oracle::notes::get_notes(
storage_slot,
num_selects,
select_by_indexes,
Expand All @@ -275,9 +265,7 @@ where
options.limit,
options.offset,
options.status,
placeholder_opt_notes,
placeholder_fields,
placeholder_note_length,
);

let mut notes = BoundedVec::new();
Expand Down
35 changes: 16 additions & 19 deletions noir-projects/aztec-nr/aztec/src/oracle/notes.nr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ unconstrained fn notify_created_nullifier_oracle_wrapper(nullifier: Field) {
unconstrained fn notify_created_nullifier_oracle(_nullifier: Field) -> Field {}

#[oracle(getNotes)]
unconstrained fn get_notes_oracle<let N: u32, let S: u32>(
unconstrained fn get_notes_oracle<let N: u32, let ORACLE_RETURN_FIELD_LENGTH: u32>(
_storage_slot: Field,
_num_selects: u8,
_select_by_indexes: [u8; N],
Expand All @@ -105,10 +105,9 @@ unconstrained fn get_notes_oracle<let N: u32, let S: u32>(
_offset: u32,
_status: u8,
_return_size: u32,
_placeholder_fields: [Field; S],
) -> [Field; S] {}
) -> [Field; ORACLE_RETURN_FIELD_LENGTH] {}

unconstrained fn get_notes_oracle_wrapper<let N: u32, let S: u32>(
unconstrained fn get_notes_oracle_wrapper<let N: u32, let ORACLE_RETURN_FIELD_LENGTH: u32>(
storage_slot: Field,
num_selects: u8,
select_by_indexes: [u8; N],
Expand All @@ -123,9 +122,9 @@ unconstrained fn get_notes_oracle_wrapper<let N: u32, let S: u32>(
limit: u32,
offset: u32,
status: u8,
mut placeholder_fields: [Field; S],
) -> [Field; S] {
let return_size = placeholder_fields.len() as u32;
) -> [Field; ORACLE_RETURN_FIELD_LENGTH] {
// This wrapper exists to extract the ORACLE_RETURN_FIELD_LENGTH generic numeric param into a value and pass it to
// the oracle, so that it knows how big the return array must be.
get_notes_oracle(
storage_slot,
num_selects,
Expand All @@ -141,12 +140,11 @@ unconstrained fn get_notes_oracle_wrapper<let N: u32, let S: u32>(
limit,
offset,
status,
return_size,
placeholder_fields,
ORACLE_RETURN_FIELD_LENGTH,
)
}

pub unconstrained fn get_notes<Note, let N: u32, let M: u32, let S: u32, let NS: u32>(
pub unconstrained fn get_notes<Note, let N: u32, let M: u32, let MAX_NOTES: u32, let ORACLE_RETURN_FIELD_LENGTH: u32>(
storage_slot: Field,
num_selects: u8,
select_by_indexes: [u8; M],
Expand All @@ -161,14 +159,12 @@ pub unconstrained fn get_notes<Note, let N: u32, let M: u32, let S: u32, let NS:
limit: u32,
offset: u32,
status: u8,
mut placeholder_opt_notes: [Option<RetrievedNote<Note>>; S], // TODO: Remove it and use `limit` to initialize the note array.
placeholder_fields: [Field; NS], // TODO: Remove it and use `limit` to initialize the note array.
_placeholder_note_length: [Field; N], // Turbofish hack? Compiler breaks calculating read_offset unless we add this parameter TODO(benesjan): try removing this.
) -> [Option<RetrievedNote<Note>>; S]
_placeholder_fields: [Field; ORACLE_RETURN_FIELD_LENGTH], // TODO: Compute this value automatically from S
Comment thread
nventuro marked this conversation as resolved.
Outdated
) -> [Option<RetrievedNote<Note>>; MAX_NOTES]
where
Note: NoteType + Packable<N>,
{
let fields = get_notes_oracle_wrapper(
let fields: [_; ORACLE_RETURN_FIELD_LENGTH] = get_notes_oracle_wrapper(
storage_slot,
num_selects,
select_by_indexes,
Expand All @@ -183,11 +179,12 @@ where
limit,
offset,
status,
placeholder_fields,
);
let num_notes = fields[0] as u32;
let contract_address = AztecAddress::from_field(fields[1]);
for i in 0..placeholder_opt_notes.len() {

let mut opt_notes = [Option::none(); MAX_NOTES];
for i in 0..opt_notes.len() {
if i < num_notes {
// lengths named as per typescript.
let return_header_length: u32 = 2; // num_notes & contract_address.
Expand All @@ -205,10 +202,10 @@ where
metadata: NoteMetadata::from_raw_data(maybe_note_hash_counter != 0, maybe_nonce),
};

placeholder_opt_notes[i] = Option::some(retrieved_note);
opt_notes[i] = Option::some(retrieved_note);
};
}
placeholder_opt_notes
opt_notes
}

/// Returns true if the nullifier exists. Note that a `true` value can be constrained by proving existence of the
Expand Down