feat: cast decode-eof & forge inspect <contract> eof (#8478)

* feat: cast decode-eof & forge inspect <contract> eof

* add docs

* clippy

* fix tests

* review fixes

Author: klkvr

Cargo.lock

@@ -263,3 +263,4 @@ tower-http = "0.5"
 soldeer = "0.2.19"
 
 proptest = "1"
+comfy-table = "7"

Cargo.toml

@@ -68,7 +68,7 @@ foundry-cli.workspace = true
 clap = { version = "4", features = ["derive", "env", "unicode", "wrap_help"] }
 clap_complete = "4"
 clap_complete_fig = "4"
-comfy-table = "7"
+comfy-table.workspace = true
 dunce.workspace = true
 indicatif = "0.17"
 itertools.workspace = true

crates/cast/Cargo.toml

@@ -567,6 +567,10 @@ async fn main() -> Result<()> {
 
             println!("{}", serde_json::to_string_pretty(&tx)?);
         }
+        CastSubcommand::DecodeEof { eof } => {
+            let eof = stdin::unwrap_line(eof)?;
+            println!("{}", SimpleCast::decode_eof(&eof)?);
+        }
     };
     Ok(())
 }

crates/cast/bin/main.rs

@@ -905,7 +905,7 @@ pub enum CastSubcommand {
     },
 
     /// Decodes a raw signed EIP 2718 typed transaction
-    #[command(visible_alias = "dt")]
+    #[command(visible_aliases = &["dt", "decode-tx"])]
     DecodeTransaction { tx: Option<String> },
 
     /// Extracts function selectors and arguments from bytecode
@@ -918,6 +918,10 @@ pub enum CastSubcommand {
         #[arg(long, short)]
         resolve: bool,
     },
+
+    /// Decodes EOF container bytes
+    #[command()]
+    DecodeEof { eof: Option<String> },
 }
 
 /// CLI arguments for `cast --to-base`.

crates/cast/bin/opts.rs

@@ -34,6 +34,7 @@ use foundry_compilers::flatten::Flattener;
 use foundry_config::Chain;
 use futures::{future::Either, FutureExt, StreamExt};
 use rayon::prelude::*;
+use revm::primitives::Eof;
 use std::{
     borrow::Cow,
     io,
@@ -1990,6 +1991,24 @@ impl SimpleCast {
         let tx = TxEnvelope::decode_2718(&mut tx_hex.as_slice())?;
         Ok(tx)
     }
+
+    /// Decodes EOF container bytes
+    /// Pretty prints the decoded EOF container contents
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// use cast::SimpleCast as Cast;
+    ///
+    /// let eof = "0xef0001010004020001005604002000008000046080806040526004361015e100035f80fd5f3560e01c63773d45e01415e1ffee6040600319360112e10028600435906024358201809211e100066020918152f3634e487b7160e01b5f52601160045260245ffd5f80fd0000000000000000000000000124189fc71496f8660db5189f296055ed757632";
+    /// let decoded = Cast::decode_eof(&eof)?;
+    /// println!("{}", decoded);
+    /// # Ok::<(), eyre::Report>(())
+    pub fn decode_eof(eof: &str) -> Result<String> {
+        let eof_hex = hex::decode(eof)?;
+        let eof = Eof::decode(eof_hex.into())?;
+        Ok(pretty_eof(&eof)?)
+    }
 }
 
 fn strip_0x(s: &str) -> &str {

crates/cast/src/lib.rs

@@ -46,7 +46,7 @@ tower.workspace = true
 
 async-trait.workspace = true
 clap = { version = "4", features = ["derive", "env", "unicode", "wrap_help"] }
-comfy-table = "7"
+comfy-table.workspace = true
 dunce.workspace = true
 eyre.workspace = true
 num-format.workspace = true

crates/common/Cargo.toml

@@ -25,6 +25,8 @@ alloy-serde.workspace = true
 serde.workspace = true
 serde_json.workspace = true
 chrono.workspace = true
+revm-primitives.workspace = true
+comfy-table.workspace = true
 
 [dev-dependencies]
 foundry-macros.workspace = true

crates/common/fmt/Cargo.toml

@@ -0,0 +1,75 @@
+use comfy_table::{ContentArrangement, Table};
+use revm_primitives::{
+    eof::{EofBody, EofHeader},
+    Eof,
+};
+use std::fmt::{self, Write};
+
+pub fn pretty_eof(eof: &Eof) -> Result<String, fmt::Error> {
+    let Eof {
+        header:
+            EofHeader {
+                types_size,
+                code_sizes,
+                container_sizes,
+                data_size,
+                sum_code_sizes: _,
+                sum_container_sizes: _,
+            },
+        body:
+            EofBody { types_section, code_section, container_section, data_section, is_data_filled: _ },
+        raw: _,
+    } = eof;
+
+    let mut result = String::new();
+
+    let mut table = Table::new();
+    table.add_row(vec!["type_size", &types_size.to_string()]);
+    table.add_row(vec!["num_code_sections", &code_sizes.len().to_string()]);
+    if !code_sizes.is_empty() {
+        table.add_row(vec!["code_sizes", &format!("{code_sizes:?}")]);
+    }
+    table.add_row(vec!["num_container_sections", &container_sizes.len().to_string()]);
+    if !container_sizes.is_empty() {
+        table.add_row(vec!["container_sizes", &format!("{container_sizes:?}")]);
+    }
+    table.add_row(vec!["data_size", &data_size.to_string()]);
+
+    write!(result, "Header:\n{table}")?;
+
+    if !code_section.is_empty() {
+        let mut table = Table::new();
+        table.set_content_arrangement(ContentArrangement::Dynamic);
+        table.set_header(vec!["", "Inputs", "Outputs", "Max stack height", "Code"]);
+        for (idx, (code, type_section)) in code_section.iter().zip(types_section).enumerate() {
+            table.add_row(vec![
+                &idx.to_string(),
+                &type_section.inputs.to_string(),
+                &type_section.outputs.to_string(),
+                &type_section.max_stack_size.to_string(),
+                &code.to_string(),
+            ]);
+        }
+
+        write!(result, "\n\nCode sections:\n{table}")?;
+    }
+
+    if !container_section.is_empty() {
+        let mut table = Table::new();
+        table.set_content_arrangement(ContentArrangement::Dynamic);
+        for (idx, container) in container_section.iter().enumerate() {
+            table.add_row(vec![&idx.to_string(), &container.to_string()]);
+        }
+
+        write!(result, "\n\nContainer sections:\n{table}")?;
+    }
+
+    if !data_section.is_empty() {
+        let mut table = Table::new();
+        table.set_content_arrangement(ContentArrangement::Dynamic);
+        table.add_row(vec![&data_section.to_string()]);
+        write!(result, "\n\nData section:\n{table}")?;
+    }
+
+    Ok(result)
+}

crates/common/fmt/src/eof.rs

@@ -11,3 +11,6 @@ pub use exp::{format_int_exp, format_uint_exp, to_exp_notation};
 
 mod ui;
 pub use ui::{get_pretty_block_attr, get_pretty_tx_attr, EthValue, UIfmt};
+
+mod eof;
+pub use eof::pretty_eof;