refactor!: contract logging plumbing cleanup (#20282)

The `debug_log` naming became problematic as different log levels are
supported and hence the name collides with the debug log level even
though it's a generic util.

For this reason I've renamed `debug_log` simply as `log` and I've
cleaned up what used to be `debug_log.nr` file (in this PR renamed to
`logging.nr`). The cleanup consists of:
- dropping the log_slice functions (use of slices is now discouraged),
- introducing individual functions for different log levels,
- un-exposing the log level constants (the specific functions should be
used instead)

This is a breaking change as the imports need to get updated.

This PR is a followup of
#19960

Author: benesjan

avm-transpiler/src/transpile.rs

@@ -563,7 +563,7 @@ fn handle_foreign_call(
         "avmOpcodeRevert" => handle_revert(avm_instrs, destinations, inputs),
         "avmOpcodeStorageRead" => handle_storage_read(avm_instrs, destinations, inputs),
         "avmOpcodeStorageWrite" => handle_storage_write(avm_instrs, destinations, inputs),
-        "utilityDebugLog" => handle_debug_log(avm_instrs, destinations, inputs),
+        "utilityLog" => handle_debug_log(avm_instrs, destinations, inputs),
         // Getters.
         _ if inputs.is_empty() && destinations.len() == 1 => {
             handle_getter_instruction(avm_instrs, function, destinations, inputs);
@@ -1348,8 +1348,8 @@ fn handle_debug_log(
 ) {
     // We need to handle two flavors here:
     //
-    // #[oracle(utilityDebugLog)]
-    // unconstrained fn debug_log_array_oracle<let M: u32, let N: u32>(
+    // #[oracle(utilityLog)]
+    // unconstrained fn log_oracle<let M: u32, let N: u32>(
     //     log_level: u8,
     //     msg: str<M>,
     //     length: u32,
@@ -1358,8 +1358,8 @@ fn handle_debug_log(
     //
     // and
     //
-    //#[oracle(utilityDebugLog)]
-    // unconstrained fn debug_log_slice_oracle<let M: u32>(log_level: u8, msg: str<M>, args: [Field]) {}
+    //#[oracle(utilityLog)]
+    // unconstrained fn log_slice_oracle<let M: u32>(log_level: u8, msg: str<M>, args: [Field]) {}
     //
     // Luckily, these two flavors have both 4 arguments, since noir inserts a length field for slices before the slice.
     // So we can handle both cases with mostly the same code.

docs/docs-developers/docs/resources/migration_notes.md

@@ -9,6 +9,35 @@ Aztec is in active development. Each version may introduce breaking changes that
 
 ## TBD
 
+### [Aztec.nr] `debug_log` module renamed to `logging`
+
+The `debug_log` module has been renamed to `logging` to avoid naming collisions with per-level logging functions that were introduced in this PR (`warn_log`, `info_log`, `debug_log`... and the "format" versions `warn_log_format`, `debug_log_format`). Update all import paths accordingly:
+
+```diff
+- use aztec::oracle::debug_log::debug_log;
+- use aztec::oracle::debug_log::debug_log_format;
++ use aztec::oracle::logging::debug_log;
++ use aztec::oracle::logging::debug_log_format;
+```
+
+For inline paths:
+
+```diff
+- aztec::oracle::debug_log::debug_log_format("msg: {}", [value]);
++ aztec::oracle::logging::debug_log_format("msg: {}", [value]);
+```
+
+The function names themselves (`debug_log`, `debug_log_format`, `debug_log_with_level`, `debug_log_format_with_level`) are unchanged.
+
+Additionally, `debug_log_format_slice` has been removed. Use `debug_log_format` instead, which accepts a fixed-size array of fields:
+
+```diff
+- debug_log_format_slice("values: {}", &[value1, value2]);
++ debug_log_format("values: {}", [value1, value2]);
+```
+
+This has been done as usage of Noir slices is discouraged and the function was unused in the aztec codebase.
+
 ### [aztec.js] `getDecodedPublicEvents` renamed to `getPublicEvents` with new signature
 
 The `getDecodedPublicEvents` function has been renamed to `getPublicEvents` and now uses a filter object instead of positional parameters:

docs/examples/contracts/counter_contract/src/main.nr

@@ -8,7 +8,7 @@ pub contract Counter {
     use aztec::{
         macros::{functions::{external, initializer}, storage::storage},
         messages::message_delivery::MessageDelivery,
-        oracle::debug_log::debug_log_format,
+        oracle::logging::debug_log_format,
         protocol::{address::AztecAddress, traits::ToField},
         state_vars::Owned,
     };

docs/examples/contracts/recursive_verification_contract/src/main.nr

@@ -8,7 +8,7 @@ pub contract ValueNotEqual {
     // docs:start:imports
     use aztec::{
         macros::{functions::{external, initializer, only_self, view}, storage::storage},
-        oracle::debug_log::debug_log_format,
+        oracle::logging::debug_log_format,
         protocol::{address::AztecAddress, traits::ToField},
         state_vars::{Map, PublicImmutable, PublicMutable},
     };

docs/static/typescript-api/devnet/pxe.md

@@ -365,7 +365,7 @@ new Oracle(handler: IMiscOracle | IUtilityExecutionOracle | IPrivateExecutionOra
 - `utilityBulkRetrieveLogs(__namedParameters: string[], __namedParameters: string[], __namedParameters: string[]) => Promise<string[]>`
 - `utilityCheckNullifierExists(__namedParameters: string[]) => Promise<string[]>`
 - `utilityCopyCapsule(__namedParameters: string[], __namedParameters: string[], __namedParameters: string[], __namedParameters: string[]) => Promise<string[]>`
-- `utilityDebugLog(level: string[], message: string[], _ignoredFieldsSize: string[], fields: string[]) => Promise<string[]>`
+- `utilityLog(level: string[], message: string[], _ignoredFieldsSize: string[], fields: string[]) => Promise<string[]>`
 - `utilityDeleteCapsule(__namedParameters: string[], __namedParameters: string[]) => Promise<string[]>`
 - `utilityEmitOffchainEffect(data: string[]) => Promise<never[]>`
 - `utilityFetchTaggedLogs(__namedParameters: string[]) => Promise<string[]>`
@@ -542,7 +542,7 @@ new PrivateExecutionOracle(argsHash: Fr, txContext: TxContext, callContext: Call
 - `utilityBulkRetrieveLogs(contractAddress: AztecAddress, logRetrievalRequestsArrayBaseSlot: Fr, logRetrievalResponsesArrayBaseSlot: Fr) => Promise<void>`
 - `utilityCheckNullifierExists(innerNullifier: Fr) => Promise<boolean>` - Check if a nullifier exists in the nullifier tree.
 - `utilityCopyCapsule(contractAddress: AztecAddress, srcSlot: Fr, dstSlot: Fr, numEntries: number) => Promise<void>`
-- `utilityDebugLog(level: number, message: string, fields: Fr[]) => void`
+- `utilityLog(level: number, message: string, fields: Fr[]) => void`
 - `utilityDeleteCapsule(contractAddress: AztecAddress, slot: Fr) => Promise<void>`
 - `utilityEmitOffchainEffect(data: Fr[]) => Promise<void>`
 - `utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) => Promise<void>`
@@ -769,7 +769,7 @@ new UtilityExecutionOracle(contractAddress: AztecAddress, authWitnesses: AuthWit
 - `utilityBulkRetrieveLogs(contractAddress: AztecAddress, logRetrievalRequestsArrayBaseSlot: Fr, logRetrievalResponsesArrayBaseSlot: Fr) => Promise<void>`
 - `utilityCheckNullifierExists(innerNullifier: Fr) => Promise<boolean>` - Check if a nullifier exists in the nullifier tree.
 - `utilityCopyCapsule(contractAddress: AztecAddress, srcSlot: Fr, dstSlot: Fr, numEntries: number) => Promise<void>`
-- `utilityDebugLog(level: number, message: string, fields: Fr[]) => void`
+- `utilityLog(level: number, message: string, fields: Fr[]) => void`
 - `utilityDeleteCapsule(contractAddress: AztecAddress, slot: Fr) => Promise<void>`
 - `utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) => Promise<void>`
 - `utilityGetAuthWitness(messageHash: Fr) => Promise<Fr[]>` - Returns an auth witness for the given message hash. Checks on the list of transient witnesses for this transaction first, and falls back to the local database if not found.
@@ -838,7 +838,7 @@ Miscellaneous oracle methods, not very Aztec-specific and expected to be availab
 
 **Methods**
 - `utilityAssertCompatibleOracleVersion(version: number) => void`
-- `utilityDebugLog(level: number, message: string, fields: Fr[]) => void`
+- `utilityLog(level: number, message: string, fields: Fr[]) => void`
 - `utilityGetRandomField() => Fr`
 
 ### IPrivateExecutionOracle

noir-projects/aztec-nr/aztec/src/context/private_context.nr

@@ -529,7 +529,7 @@ impl PrivateContext {
     /// balance (>= the gas limits specified in the TxContext) by the time we reach the public setup phase of the tx.
     ///
     pub fn set_as_fee_payer(&mut self) {
-        crate::protocol::debug_log::debug_log_format("Setting {0} as fee payer", [self.this_address().to_field()]);
+        crate::protocol::logging::debug_log_format("Setting {0} as fee payer", [self.this_address().to_field()]);
         self.is_fee_payer = true;
     }
 
@@ -578,7 +578,7 @@ impl PrivateContext {
         // Incrementing the side effect counter when ending setup ensures non ambiguity for the counter where we change
         // phases.
         self.side_effect_counter += 1;
-        // crate::protocol::debug_log::debug_log_format(
+        // crate::protocol::logging::debug_log_format(
         //     "Ending setup at counter {0}",
         //     [self.side_effect_counter as Field]
         // );

noir-projects/aztec-nr/aztec/src/messages/discovery/mod.nr

@@ -1,4 +1,4 @@
-use crate::protocol::{address::AztecAddress, debug_log::{debug_log, debug_log_format}};
+use crate::protocol::{address::AztecAddress, logging::{debug_log, debug_log_format}};
 
 pub mod nonce_discovery;
 pub mod partial_notes;

noir-projects/aztec-nr/aztec/src/messages/discovery/nonce_discovery.nr

@@ -3,8 +3,8 @@ use crate::messages::{discovery::ComputeNoteHashAndNullifier, logs::note::MAX_NO
 use crate::protocol::{
     address::AztecAddress,
     constants::MAX_NOTE_HASHES_PER_TX,
-    debug_log::debug_log_format,
     hash::{compute_note_hash_nonce, compute_siloed_note_hash, compute_unique_note_hash},
+    logging::debug_log_format,
     traits::ToField,
 };
 

noir-projects/aztec-nr/aztec/src/messages/discovery/partial_notes.nr

@@ -14,8 +14,8 @@ use crate::{
 
 use crate::protocol::{
     address::AztecAddress,
-    debug_log::debug_log_format,
     hash::sha256_to_field,
+    logging::debug_log_format,
     traits::{Deserialize, Serialize},
 };
 

noir-projects/aztec-nr/aztec/src/messages/discovery/private_notes.nr

@@ -4,7 +4,7 @@ use crate::messages::{
     logs::note::{decode_private_note_message, MAX_NOTE_PACKED_LEN},
     processing::enqueue_note_for_validation,
 };
-use crate::protocol::{address::AztecAddress, constants::MAX_NOTE_HASHES_PER_TX, debug_log::debug_log_format};
+use crate::protocol::{address::AztecAddress, constants::MAX_NOTE_HASHES_PER_TX, logging::debug_log_format};
 
 pub unconstrained fn process_private_note_msg<Env>(
     contract_address: AztecAddress,