fix: fixes broken logging and adds structure to logs (#411)

* feat: add structured show call logging * feat: tx summary logs structured * chore: clean up * chore: wip for gas details * wip: broken but uses builder * chore: clean up * fix: fixes log structure * chore: clean up * fix: address issue with event topics, being filtered, clean up and udpate comments * chore: add paid field * fix: address broken test * chore: minor fixes * chore: fix lint * chore:small fix * fix: print console logs once per call, fix spacing * fix: lint --------- Co-authored-by: Roman Petriv <[email protected]>
matter-labs · Dec 3, 2024 · f3e58cd · f3e58cd
1 parent 1578ee4
commit f3e58cd
Show file tree

Hide file tree

Showing 8 changed files with 1,012 additions and 619 deletions.
diff --git a/src/config/cli.rs b/src/config/cli.rs
@@ -87,7 +87,12 @@ pub struct Cli {
     /// Show call debug information.
     pub show_calls: Option<ShowCalls>,
 
-    #[arg(long, default_missing_value = "true", num_args(0..=1), help_heading = "Debugging Options")]
+    #[arg(
+        default_missing_value = "true", num_args(0..=1),
+        long,
+        requires = "show_calls",
+        help_heading = "Debugging Options"
+    )]
     /// Show call output information.
     pub show_outputs: Option<bool>,
 
@@ -325,22 +330,7 @@ impl Cli {
     pub fn into_test_node_config(self) -> eyre::Result<TestNodeConfig> {
         let genesis_balance = U256::from(self.balance as u128 * 10u128.pow(18));
 
-        let vm_log_detail = if let Some(output) = self.show_outputs {
-            if output {
-                Some(ShowVMDetails::All)
-            } else {
-                Some(ShowVMDetails::None)
-            }
-        } else if let Some(logs) = self.show_storage_logs {
-            match logs {
-                ShowStorageLogs::None => Some(ShowVMDetails::None),
-                _ => Some(ShowVMDetails::All),
-            }
-        } else {
-            None
-        };
-
-        let config = TestNodeConfig::default()
+        let mut config = TestNodeConfig::default()
             .with_port(self.port)
             .with_l1_gas_price(self.l1_gas_price)
             .with_l2_gas_price(self.l2_gas_price)
@@ -349,7 +339,12 @@ impl Cli {
             .with_show_event_logs(self.show_event_logs)
             .with_disable_console_log(self.disable_console_log)
             .with_show_calls(self.show_calls)
-            .with_vm_log_detail(vm_log_detail)
+            .with_vm_log_detail(self.show_vm_details)
+            .with_show_storage_logs(self.show_storage_logs)
+            .with_show_gas_details(self.show_gas_details)
+            .with_show_outputs(self.show_outputs)
+            .with_show_event_logs(self.show_event_logs)
+            .with_resolve_hashes(self.resolve_hashes)
             .with_gas_limit_scale(self.limit_scale_factor)
             .with_price_scale(self.price_scale_factor)
             .with_resolve_hashes(self.resolve_hashes)
@@ -396,13 +391,10 @@ impl Cli {
         }
 
         if self.debug_mode {
-            Ok(config
-                .with_show_calls(Some(ShowCalls::All))
-                .with_vm_log_detail(Some(ShowVMDetails::All))
-                .with_resolve_hashes(Some(true)))
-        } else {
-            Ok(config)
+            config = config.with_debug_mode();
         }
+
+        Ok(config)
     }
 
     fn account_generator(&self) -> AccountGenerator {

diff --git a/src/config/mod.rs b/src/config/mod.rs
@@ -600,6 +600,15 @@ impl TestNodeConfig {
         &self.log_file_path
     }
 
+    /// Applies the defaults for debug mode.
+    #[must_use]
+    pub fn with_debug_mode(mut self) -> Self {
+        self.show_calls = ShowCalls::User;
+        self.resolve_hashes = true;
+        self.show_gas_details = ShowGasDetails::All;
+        self
+    }
+
     /// Set the visibility of call logs
     #[must_use]
     pub fn with_show_calls(mut self, show_calls: Option<ShowCalls>) -> Self {
@@ -658,6 +667,11 @@ impl TestNodeConfig {
         self
     }
 
+    /// Get the visibility of event logs
+    pub fn get_show_event_logs(&self) -> bool {
+        self.show_event_logs
+    }
+
     // Enable or disable printing of `console.log` invocations to stdout
     #[must_use]
     pub fn with_disable_console_log(mut self, disable_console_log: Option<bool>) -> Self {
@@ -672,6 +686,62 @@ impl TestNodeConfig {
         self.resolve_hashes
     }
 
+    /// Set the visibility of storage logs
+    #[must_use]
+    pub fn with_show_storage_logs(mut self, show_storage_logs: Option<ShowStorageLogs>) -> Self {
+        if let Some(show_storage_logs) = show_storage_logs {
+            self.show_storage_logs = show_storage_logs;
+        }
+        self
+    }
+
+    /// Get the visibility of storage logs
+    pub fn get_show_storage_logs(&self) -> ShowStorageLogs {
+        self.show_storage_logs
+    }
+
+    /// Set the detail level of VM execution logs
+    #[must_use]
+    pub fn with_vm_log_detail(mut self, detail: Option<ShowVMDetails>) -> Self {
+        if let Some(detail) = detail {
+            self.show_vm_details = detail;
+        }
+        self
+    }
+
+    /// Get the detail level of VM execution logs
+    pub fn get_vm_log_detail(&self) -> ShowVMDetails {
+        self.show_vm_details
+    }
+
+    /// Set the visibility of gas usage logs
+    #[must_use]
+    pub fn with_show_gas_details(mut self, show_gas_details: Option<ShowGasDetails>) -> Self {
+        if let Some(show_gas_details) = show_gas_details {
+            self.show_gas_details = show_gas_details;
+        }
+        self
+    }
+
+    /// Get the visibility of gas usage logs
+    pub fn get_show_gas_details(&self) -> ShowGasDetails {
+        self.show_gas_details
+    }
+
+    /// Set show outputs
+    #[must_use]
+    pub fn with_show_outputs(mut self, show_outputs: Option<bool>) -> Self {
+        if let Some(show_outputs) = show_outputs {
+            self.show_outputs = show_outputs;
+        }
+        self
+    }
+
+    /// Get show outputs
+    pub fn get_show_outputs(&self) -> bool {
+        self.show_outputs
+    }
+
     /// Set the gas limit scale factor
     #[must_use]
     pub fn with_gas_limit_scale(mut self, scale: Option<f32>) -> Self {
@@ -714,20 +784,6 @@ impl TestNodeConfig {
         self
     }
 
-    /// Set the detail level of VM execution logs
-    #[must_use]
-    pub fn with_vm_log_detail(mut self, detail: Option<ShowVMDetails>) -> Self {
-        if let Some(detail) = detail {
-            self.show_vm_details = detail;
-        }
-        self
-    }
-
-    /// Get the detail level of VM execution logs
-    pub fn get_vm_log_detail(&self) -> ShowVMDetails {
-        self.show_vm_details
-    }
-
     /// Sets the balance of the genesis accounts in the genesis block
     #[must_use]
     pub fn with_genesis_balance<U: Into<U256>>(mut self, balance: U) -> Self {

diff --git a/src/console_log.rs b/src/console_log.rs
@@ -35,6 +35,14 @@ impl Default for ConsoleLogHandler {
 }
 
 impl ConsoleLogHandler {
+    pub fn handle_calls_recursive(&self, calls: &Vec<Call>) {
+        tracing::info!("");
+        tracing::info!("==== Console logs: ");
+
+        for call in calls {
+            self.handle_call_recursive(call);
+        }
+    }
     pub fn handle_call_recursive(&self, current_call: &Call) {
         self.handle_call(current_call);
         for call in &current_call.calls {

diff --git a/src/data/address_map.json b/src/data/address_map.json
@@ -1,102 +1,45 @@
 [
-    [
-        "0x0000000000000000000000000000000000008001",
-        "bootloader",
-        "System"
-    ],
-    [
-        "0x0000000000000000000000000000000000008002",
-        "Account Code Storage",
-        "System"
-    ],
-    [
-        "0x0000000000000000000000000000000000008003",
-        "Nonce Holder",
-        "System"
-    ],
-    [
-        "0x0000000000000000000000000000000000008004",
-        "Known code storage",
-        "System"
-    ],
-    [
-        "0x0000000000000000000000000000000000008005",
-        "ImmutableSimulator",
-        "System"
-    ],
-    [
-        "0x0000000000000000000000000000000000008006",
-        "L2 deployer",
-        "System"
-    ],
-    [
-        "0x0000000000000000000000000000000000008007",
-        "Force L2 deployer",
-        "System"
-    ],
-    [
-        "0x0000000000000000000000000000000000008008",
-        "L1 messenger",
-        "System"
-    ],
-    [
-        "0x0000000000000000000000000000000000008009",
-        "Msg Value System Contract",
-        "System"
-    ],
-    [
-        "0x000000000000000000000000000000000000800a",
-        "EthToken System Contract",
-        "System"
-    ],
-    [
-        "0x000000000000000000000000000000000000800b",
-        "System context",
-        "System"
-    ],
-    [
-        "0x000000000000000000000000000000000000800c",
-        "Bootloader utilities",
-        "System"
-    ],
-    [
-        "0x000000000000000000000000000000000000800d",
-        "Event writer",
-        "System"
-    ],
-    [
-        "0x000000000000000000000000000000000000800e",
-        "Compressor",
-        "System"
-    ],
-    [
-        "0x000000000000000000000000000000000000800f",
-        "ComplexUpgrader",
-        "System"
-    ],
-    [
-        "0x0000000000000000000000000000000000008010",
-        "Keccak",
-        "Precompile"
-    ],
-    [
-        "0x0000000000000000000000000000000000008011",
-        "PubdataChunkPublisher",
-        "System"
-    ],
-    [
-        "0x0000000000000000000000000000000000008012",
-        "CodeOracle",
-        "System"
-    ],
-    [
-        "0x000000000000000000636f6e736f6c652e6c6f67",
-        "Console log",
-        "Precompile"
-    ],
-    [
-        "0x0000000000000000000000000000000000010000",
-        "Create2Factory",
-        "Popular"
-    ]
-]
+  ["0x0000000000000000000000000000000000008001", "bootloader", "System"],
+  [
+    "0x0000000000000000000000000000000000008002",
+    "AccountCodeStorage",
+    "System"
+  ],
+  ["0x0000000000000000000000000000000000008003", "NonceHolder", "System"],
+  ["0x0000000000000000000000000000000000008004", "KnownCodesStorage", "System"],
+  [
+    "0x0000000000000000000000000000000000008005",
+    "ImmutableSimulator",
+    "System"
+  ],
+  ["0x0000000000000000000000000000000000008006", "ContractDeployer", "System"],
+  ["0x0000000000000000000000000000000000008007", "ForceL2Deployer", "System"],
+  ["0x0000000000000000000000000000000000008008", "L1Messenger", "System"],
+  ["0x0000000000000000000000000000000000008009", "MsgValueSimulator", "System"],
+  ["0x000000000000000000000000000000000000800a", "L2BaseToken", "System"],
+  ["0x000000000000000000000000000000000000800b", "SystemContext", "System"],
+  [
+    "0x000000000000000000000000000000000000800c",
+    "BootloaderUtilities",
+    "System"
+  ],
+  ["0x000000000000000000000000000000000000800d", "EventWriter", "System"],
+  ["0x000000000000000000000000000000000000800e", "Compressor", "System"],
+  ["0x000000000000000000000000000000000000800f", "ComplexUpgrader", "System"],
+  ["0x0000000000000000000000000000000000008010", "Keccak", "Precompile"],
+  [
+    "0x0000000000000000000000000000000000008011",
+    "PubdataChunkPublisher",
+    "System"
+  ],
+  ["0x0000000000000000000000000000000000008012", "CodeOracle", "System"],
+  ["0x000000000000000000636f6e736f6c652e6c6f67", "ConsoleLog", "Precompile"],
+  ["0x0000000000000000000000000000000000010000", "Create2Factory", "System"],
+  ["0x0000000000000000000000000000000000000002", "SHA256", "Precompile"],
+  ["0x0000000000000000000000000000000000000001", "ECRecover", "Precompile"],
+  ["0x0000000000000000000000000000000000000006", "EcAdd", "Precompile"],
+  ["0x0000000000000000000000000000000000000007", "EcMul", "Precompile"],
+  ["0x0000000000000000000000000000000000000008", "EcPairing", "Precompile"],
+  ["0xc706EC7dfA5D4Dc87f29f859094165E8290530f5", "GasBoundCaller", "System"],
+  ["0x0000000000000000000000000000000000000100", "P256Verify", "System"]
+]