feat: richer EphemeralArray and TransientArray APIs

noir-projects/aztec-nr/aztec/src/lib.nr

@@ -39,6 +39,7 @@ pub mod nullifier;
 pub mod oracle;
 pub mod state_vars;
 pub mod capsules;
+pub mod unconstrained_array;
 pub mod ephemeral;
 pub mod transient;
 pub mod event;

noir-projects/aztec-nr/aztec/src/oracle/ephemeral.nr → noir-projects/aztec-nr/aztec/src/oracle/ephemeral_oracles.nr

@@ -8,23 +8,23 @@
 #[oracle(aztec_utl_pushEphemeral)]
 pub(crate) unconstrained fn push_oracle<let N: u32>(slot: Field, values: [Field; N]) -> u32 {}
 
-/// Removes and returns the last serialized element from the ephemeral array.
+/// Removes and returns the last serialized element from the ephemeral array. Panics if the array is empty.
 #[oracle(aztec_utl_popEphemeral)]
 pub(crate) unconstrained fn pop_oracle<let N: u32>(slot: Field) -> [Field; N] {}
 
-/// Returns the serialized element at the given index.
+/// Returns the serialized element at the given index. Panics if `index` is out of bounds.
 #[oracle(aztec_utl_getEphemeral)]
 pub(crate) unconstrained fn get_oracle<let N: u32>(slot: Field, index: u32) -> [Field; N] {}
 
-/// Overwrites the serialized element at the given index.
+/// Overwrites the serialized element at the given index. Panics if `index` is out of bounds.
 #[oracle(aztec_utl_setEphemeral)]
 pub(crate) unconstrained fn set_oracle<let N: u32>(slot: Field, index: u32, values: [Field; N]) {}
 
 /// Returns the number of elements in the ephemeral array.
 #[oracle(aztec_utl_getEphemeralLen)]
 pub(crate) unconstrained fn len_oracle(slot: Field) -> u32 {}
 
-/// Removes the element at the given index, shifting subsequent elements backward.
+/// Removes the element at the given index, shifting subsequent elements backward. Panics if `index` is out of bounds.
 #[oracle(aztec_utl_removeEphemeral)]
 pub(crate) unconstrained fn remove_oracle(slot: Field, index: u32) {}
 

noir-projects/aztec-nr/aztec/src/oracle/mod.nr

@@ -7,8 +7,8 @@ pub mod block_header;
 pub mod call_private_function;
 pub mod call_utility_function;
 pub mod capsules;
-pub mod ephemeral;
-pub mod transient;
+pub(crate) mod ephemeral_oracles;
+pub(crate) mod transient_oracles;
 pub mod contract_sync;
 pub mod public_call;
 pub mod tx_phase;

noir-projects/aztec-nr/aztec/src/oracle/transient.nr → noir-projects/aztec-nr/aztec/src/oracle/transient_oracles.nr

@@ -9,23 +9,23 @@
 #[oracle(aztec_utl_pushTransient)]
 pub(crate) unconstrained fn push_oracle<let N: u32>(slot: Field, values: [Field; N]) -> u32 {}
 
-/// Removes and returns the last serialized element from the transient array.
+/// Removes and returns the last serialized element from the transient array. Panics if the array is empty.
 #[oracle(aztec_utl_popTransient)]
 pub(crate) unconstrained fn pop_oracle<let N: u32>(slot: Field) -> [Field; N] {}
 
-/// Returns the serialized element at the given index.
+/// Returns the serialized element at the given index. Panics if `index` is out of bounds.
 #[oracle(aztec_utl_getTransient)]
 pub(crate) unconstrained fn get_oracle<let N: u32>(slot: Field, index: u32) -> [Field; N] {}
 
-/// Overwrites the serialized element at the given index.
+/// Overwrites the serialized element at the given index. Panics if `index` is out of bounds.
 #[oracle(aztec_utl_setTransient)]
 pub(crate) unconstrained fn set_oracle<let N: u32>(slot: Field, index: u32, values: [Field; N]) {}
 
 /// Returns the number of elements in the transient array.
 #[oracle(aztec_utl_getTransientLen)]
 pub(crate) unconstrained fn len_oracle(slot: Field) -> u32 {}
 
-/// Removes the element at the given index, shifting subsequent elements backward.
+/// Removes the element at the given index, shifting subsequent elements backward. Panics if `index` is out of bounds.
 #[oracle(aztec_utl_removeTransient)]
 pub(crate) unconstrained fn remove_oracle(slot: Field, index: u32) {}