Skip to content
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

feat(forge): inspect - default to pretty output #9705

Merged
merged 18 commits into from
Jan 23, 2025
Merged

feat(forge): inspect - default to pretty output #9705

Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
b4ed7bf
fix(`forge`): inspect - mk --pretty default
yash-atreya Jan 17, 2025
3d7e3e2
print_table helper
yash-atreya Jan 20, 2025
6be16cb
print table method-identifier
yash-atreya Jan 20, 2025
0278a25
print table errors
yash-atreya Jan 20, 2025
0cd7545
print errors events
yash-atreya Jan 20, 2025
1da69ba
nit
yash-atreya Jan 20, 2025
8c1c48b
Merge branch 'master' into yash/fix-5165
yash-atreya Jan 20, 2025
fd860fd
fix
yash-atreya Jan 20, 2025
f47d6f5
rm pretty
yash-atreya Jan 20, 2025
8d1a9a9
fix
yash-atreya Jan 20, 2025
5d3a9de
print abi as table
yash-atreya Jan 21, 2025
c3e8a93
fix test
yash-atreya Jan 21, 2025
9399cab
test
yash-atreya Jan 21, 2025
514a43c
Merge branch 'master' into yash/fix-5165
yash-atreya Jan 21, 2025
b5e6fe9
nit
yash-atreya Jan 21, 2025
6852754
clippy
yash-atreya Jan 21, 2025
12d6480
dedup helpers and tests
yash-atreya Jan 21, 2025
45e2849
fix
yash-atreya Jan 21, 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
253 changes: 187 additions & 66 deletions crates/forge/bin/cmd/inspect.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use alloy_json_abi::{InternalType, JsonAbi, Param};
use alloy_primitives::{hex, keccak256, Address};
use clap::Parser;
use comfy_table::{modifiers::UTF8_ROUND_CORNERS, Cell, Table};
Expand All @@ -17,7 +18,8 @@ use foundry_compilers::{
utils::canonicalize,
};
use regex::Regex;
use std::{fmt, sync::LazyLock};
use serde_json::{Map, Value};
use std::{collections::BTreeMap, fmt, sync::LazyLock};

/// CLI arguments for `forge inspect`.
#[derive(Clone, Debug, Parser)]
Expand All @@ -29,18 +31,14 @@ pub struct InspectArgs {
#[arg(value_enum)]
pub field: ContractArtifactField,

/// Pretty print the selected field, if supported.
#[arg(long)]
pub pretty: bool,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should keep this with a warning or document as a breaking change

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, will be marked in release notes as breaking change given the breaking label


/// All build arguments are supported
#[command(flatten)]
build: BuildOpts,
}

impl InspectArgs {
pub fn run(self) -> Result<()> {
let Self { contract, field, build, pretty } = self;
let Self { contract, field, build } = self;

trace!(target: "forge", ?field, ?contract, "running forge inspect");

Expand Down Expand Up @@ -85,12 +83,7 @@ impl InspectArgs {
.abi
.as_ref()
.ok_or_else(|| eyre::eyre!("Failed to fetch lossless ABI"))?;
if pretty {
let source = foundry_cli::utils::abi_to_solidity(abi, &contract.name)?;
sh_println!("{source}")?;
} else {
print_json(abi)?;
}
print_abi(abi)?;
}
ContractArtifactField::Bytecode => {
print_json_str(&artifact.bytecode, Some("object"))?;
Expand All @@ -105,7 +98,7 @@ impl InspectArgs {
print_json_str(&artifact.legacy_assembly, None)?;
}
ContractArtifactField::MethodIdentifiers => {
print_json(&artifact.method_identifiers)?;
print_method_identifiers(&artifact.method_identifiers)?;
}
ContractArtifactField::GasEstimates => {
print_json(&artifact.gas_estimates)?;
Expand All @@ -117,10 +110,10 @@ impl InspectArgs {
print_json(&artifact.devdoc)?;
}
ContractArtifactField::Ir => {
print_yul(artifact.ir.as_deref(), self.pretty)?;
print_yul(artifact.ir.as_deref())?;
}
ContractArtifactField::IrOptimized => {
print_yul(artifact.ir_optimized.as_deref(), self.pretty)?;
print_yul(artifact.ir_optimized.as_deref())?;
}
ContractArtifactField::Metadata => {
print_json(&artifact.metadata)?;
Expand All @@ -132,37 +125,12 @@ impl InspectArgs {
print_json_str(&artifact.ewasm, None)?;
}
ContractArtifactField::Errors => {
let mut out = serde_json::Map::new();
if let Some(abi) = &artifact.abi {
let abi = &abi;
// Print the signature of all errors.
for er in abi.errors.iter().flat_map(|(_, errors)| errors) {
let types = er.inputs.iter().map(|p| p.ty.clone()).collect::<Vec<_>>();
let sig = format!("{:x}", er.selector());
let sig_trimmed = &sig[0..8];
out.insert(
format!("{}({})", er.name, types.join(",")),
sig_trimmed.to_string().into(),
);
}
}
print_json(&out)?;
let out = artifact.abi.as_ref().map_or(Map::new(), parse_errors);
print_errors_events(&out, true)?;
}
ContractArtifactField::Events => {
let mut out = serde_json::Map::new();
if let Some(abi) = &artifact.abi {
let abi = &abi;
// Print the topic of all events including anonymous.
for ev in abi.events.iter().flat_map(|(_, events)| events) {
let types = ev.inputs.iter().map(|p| p.ty.clone()).collect::<Vec<_>>();
let topic = hex::encode(keccak256(ev.signature()));
out.insert(
format!("{}({})", ev.name, types.join(",")),
format!("0x{topic}").into(),
);
}
}
print_json(&out)?;
let out = artifact.abi.as_ref().map_or(Map::new(), parse_events);
print_errors_events(&out, false)?;
yash-atreya marked this conversation as resolved.
Show resolved Hide resolved
}
ContractArtifactField::Eof => {
print_eof(artifact.deployed_bytecode.and_then(|b| b.bytecode))?;
Expand All @@ -176,6 +144,123 @@ impl InspectArgs {
}
}

fn parse_errors(abi: &JsonAbi) -> Map<String, Value> {
let mut out = serde_json::Map::new();
for er in abi.errors.iter().flat_map(|(_, errors)| errors) {
let types = er.inputs.iter().map(|p| p.ty.clone()).collect::<Vec<_>>();
let sig = format!("{:x}", er.selector());
let sig_trimmed = &sig[0..8];
out.insert(format!("{}({})", er.name, types.join(",")), sig_trimmed.to_string().into());
}
out
}

fn parse_events(abi: &JsonAbi) -> Map<String, Value> {
let mut out = serde_json::Map::new();
for ev in abi.events.iter().flat_map(|(_, events)| events) {
let types = ev.inputs.iter().map(|p| p.ty.clone()).collect::<Vec<_>>();
let topic = hex::encode(keccak256(ev.signature()));
out.insert(format!("{}({})", ev.name, types.join(",")), format!("0x{topic}").into());
}
out
}

fn print_abi(abi: &JsonAbi) -> Result<()> {
if !shell::is_json() {
let headers = vec![Cell::new("Type"), Cell::new("Signature"), Cell::new("Selector")];
print_table(headers, |table| {
let contract_ty = |c: &Option<String>, ty: &String| {
c.clone().map_or(ty.clone(), |c| format!("{c}.{ty}"))
};

let internal_ty = |ty: &InternalType| match ty {
InternalType::AddressPayable(addr) => addr.clone(),
InternalType::Contract(contract) => contract.clone(),
InternalType::Enum { contract, ty } => contract_ty(contract, ty),
InternalType::Struct { contract, ty } => contract_ty(contract, ty),
InternalType::Other { contract, ty } => contract_ty(contract, ty),
};

let get_ty_sig = |inputs: &Vec<Param>| {
inputs
.iter()
.map(|p| {
if let Some(ty) = p.internal_type() {
return internal_ty(ty);
}
p.ty.clone()
})
.collect::<Vec<_>>()
.join(",")
};
// Print events
for ev in abi.events.iter().flat_map(|(_, events)| events) {
let types = ev
.inputs
.iter()
.map(|p| {
if let Some(ty) = p.internal_type() {
return internal_ty(ty)
}
p.ty.clone()
})
.collect::<Vec<_>>();
let selector = ev.selector().to_string();
table.add_row(["event", &format!("{}({})", ev.name, types.join(",")), &selector]);
}

// Print errors
for er in abi.errors.iter().flat_map(|(_, errors)| errors) {
let selector = er.selector().to_string();
table.add_row([
"error",
&format!("{}({})", er.name, get_ty_sig(&er.inputs)),
&selector,
]);
}

// Print functions
for func in abi.functions.iter().flat_map(|(_, f)| f) {
let selector = func.selector().to_string();
let state_mut = func.state_mutability.as_json_str();
let func_sig = if !func.outputs.is_empty() {
format!(
"{}({}) {state_mut} returns ({})",
func.name,
get_ty_sig(&func.inputs),
get_ty_sig(&func.outputs)
)
} else {
format!("{}({}) {state_mut}", func.name, get_ty_sig(&func.inputs))
};
table.add_row(["function", &func_sig, &selector]);
}

if let Some(constructor) = abi.constructor() {
let state_mut = constructor.state_mutability.as_json_str();
table.add_row([
"constructor",
&format!("constructor({}) {state_mut}", get_ty_sig(&constructor.inputs)),
"",
]);
}

if let Some(fallback) = &abi.fallback {
let state_mut = fallback.state_mutability.as_json_str();
table.add_row(["fallback", &format!("fallback() {state_mut}"), ""]);
}

if let Some(receive) = &abi.receive {
let state_mut = receive.state_mutability.as_json_str();
table.add_row(["receive", &format!("receive() {state_mut}"), ""]);
}
})?;
} else {
print_json(abi)?;
}
yash-atreya marked this conversation as resolved.
Show resolved Hide resolved
Ok(())
}

pub fn print_storage_layout(storage_layout: Option<&StorageLayout>) -> Result<()> {
let Some(storage_layout) = storage_layout else {
eyre::bail!("Could not get storage layout");
Expand All @@ -185,30 +270,70 @@ pub fn print_storage_layout(storage_layout: Option<&StorageLayout>) -> Result<()
return print_json(&storage_layout)
}

let mut table = Table::new();
table.apply_modifier(UTF8_ROUND_CORNERS);

table.set_header(vec![
let headers = vec![
Cell::new("Name"),
Cell::new("Type"),
Cell::new("Slot"),
Cell::new("Offset"),
Cell::new("Bytes"),
Cell::new("Contract"),
]);

for slot in &storage_layout.storage {
let storage_type = storage_layout.types.get(&slot.storage_type);
table.add_row([
slot.label.as_str(),
storage_type.map_or("?", |t| &t.label),
&slot.slot,
&slot.offset.to_string(),
storage_type.map_or("?", |t| &t.number_of_bytes),
&slot.contract,
]);
];

print_table(headers, |table| {
for slot in &storage_layout.storage {
let storage_type = storage_layout.types.get(&slot.storage_type);
table.add_row([
slot.label.as_str(),
storage_type.map_or("?", |t| &t.label),
&slot.slot,
&slot.offset.to_string(),
storage_type.map_or("?", |t| &t.number_of_bytes),
&slot.contract,
]);
}
})
}

fn print_method_identifiers(method_identifiers: &Option<BTreeMap<String, String>>) -> Result<()> {
let Some(method_identifiers) = method_identifiers else {
eyre::bail!("Could not get method identifiers");
};

if shell::is_json() {
return print_json(method_identifiers)
}

let headers = vec![Cell::new("Method"), Cell::new("Identifier")];

print_table(headers, |table| {
for (method, identifier) in method_identifiers {
table.add_row([method, identifier]);
}
})
}

fn print_errors_events(map: &Map<String, Value>, is_err: bool) -> Result<()> {
if shell::is_json() {
return print_json(map);
}

let headers = if is_err {
vec![Cell::new("Error"), Cell::new("Selector")]
} else {
vec![Cell::new("Event"), Cell::new("Topic")]
};
print_table(headers, |table| {
for (method, selector) in map {
table.add_row([method, selector.as_str().unwrap()]);
}
})
}

fn print_table(headers: Vec<Cell>, add_rows: impl FnOnce(&mut Table)) -> Result<()> {
let mut table = Table::new();
table.apply_modifier(UTF8_ROUND_CORNERS);
table.set_header(headers);
add_rows(&mut table);
sh_println!("\n{table}\n")?;
Ok(())
}
Expand Down Expand Up @@ -407,19 +532,15 @@ fn print_json_str(obj: &impl serde::Serialize, key: Option<&str>) -> Result<()>
Ok(())
}

fn print_yul(yul: Option<&str>, pretty: bool) -> Result<()> {
fn print_yul(yul: Option<&str>) -> Result<()> {
let Some(yul) = yul else {
eyre::bail!("Could not get IR output");
};

static YUL_COMMENTS: LazyLock<Regex> =
LazyLock::new(|| Regex::new(r"(///.*\n\s*)|(\s*/\*\*.*\*/)").unwrap());

if pretty {
sh_println!("{}", YUL_COMMENTS.replace_all(yul, ""))?;
} else {
sh_println!("{yul}")?;
}
sh_println!("{}", YUL_COMMENTS.replace_all(yul, ""))?;

Ok(())
}
Expand Down
Loading
Loading