feat(forge compile): print compiled contract names (#682)

* feat(forge compile): print compiled contract names

Print the names of the compiled contracts after
running `forge compile`. Its useful to know which
contracts were compiled and the compiler version
that was used.

The output looks like this:

```bash
$ forge build --hardhat

compiling...
compiled contracts:
compiler version: 0.5.17+commit.d19bba13.Linux.gcc
  - WETH9
compiler version: 0.8.11+commit.d7f03943.Linux.gcc
  - AddressDictator
  - ChugSplashDictator
  - IL1CrossDomainMessenger
  - IL1ERC20Bridge
  - IL1StandardBridge
  - L1CrossDomainMessenger
  - L1StandardBridge
  - CanonicalTransactionChain
  - ChainStorageContainer
  - ICanonicalTransactionChain
  - IChainStorageContainer
  - IStateCommitmentChain
  - StateCommitmentChain
success.
```

* updates + fixes

* fmt

* clippy

* chore: add newline to separate names from sizes

Co-authored-by: Georgios Konstantopoulos <[email protected]>

cli/src/cmd/build.rs

@@ -113,6 +113,12 @@ pub struct BuildArgs {
     #[serde(flatten)]
     pub compiler: CompilerArgs,
 
+    #[clap(help = "print compiled contract names", long = "names")]
+    pub names: bool,
+
+    #[clap(help = "print compiled contract sizes", long = "sizes")]
+    pub sizes: bool,
+
     #[clap(help = "ignore warnings with specific error codes", long)]
     #[serde(skip_serializing_if = "Vec::is_empty")]
     pub ignored_error_codes: Vec<u64>,
@@ -155,7 +161,7 @@ impl Cmd for BuildArgs {
     type Output = ProjectCompileOutput;
     fn run(self) -> eyre::Result<Self::Output> {
         let project = self.project()?;
-        super::compile(&project)
+        super::compile(&project, self.names, self.sizes)
     }
 }
 

cli/src/cmd/create.rs

@@ -60,7 +60,7 @@ impl Cmd for CreateArgs {
     fn run(self) -> Result<Self::Output> {
         // Find Project & Compile
         let project = self.opts.project()?;
-        let compiled = super::compile(&project)?;
+        let compiled = super::compile(&project, self.opts.names, self.opts.sizes)?;
 
         // Get ABI and BIN
         let (abi, bin, _) = super::read_artifact(&project, compiled, self.contract.clone())?;

cli/src/cmd/flatten.rs

@@ -73,6 +73,8 @@ impl Cmd for FlattenArgs {
             lib_paths,
             out_path: None,
             compiler: Default::default(),
+            names: false,
+            sizes: false,
             ignored_error_codes: vec![],
             no_auto_detect: false,
             offline: false,

cli/src/cmd/mod.rs

@@ -57,7 +57,7 @@ use ethers::{
     prelude::artifacts::{CompactBytecode, CompactDeployedBytecode},
     solc::cache::SolFilesCache,
 };
-use std::path::PathBuf;
+use std::{collections::BTreeMap, path::PathBuf};
 
 /// Common trait for all cli commands
 pub trait Cmd: clap::Parser + Sized {
@@ -67,9 +67,15 @@ pub trait Cmd: clap::Parser + Sized {
 
 use ethers::solc::{artifacts::CompactContractBytecode, Project, ProjectCompileOutput};
 
+use foundry_utils::to_table;
+
 /// Compiles the provided [`Project`], throws if there's any compiler error and logs whether
 /// compilation was successful or if there was a cache hit.
-pub fn compile(project: &Project) -> eyre::Result<ProjectCompileOutput> {
+pub fn compile(
+    project: &Project,
+    print_names: bool,
+    print_sizes: bool,
+) -> eyre::Result<ProjectCompileOutput> {
     if !project.paths.sources.exists() {
         eyre::bail!(
             r#"no contracts to compile, contracts folder "{}" does not exist.
@@ -88,9 +94,51 @@ If you are in a subdirectory in a Git repository, try adding `--root .`"#,
     } else if output.is_unchanged() {
         println!("No files changed, compilation skipped");
     } else {
+        if print_names {
+            let compiled_contracts = output.compiled_contracts_by_compiler_version();
+            println!("compiled contracts:");
+            for (version, contracts) in compiled_contracts.into_iter() {
+                println!(
+                    "  compiler version: {}.{}.{}",
+                    version.major, version.minor, version.patch
+                );
+                for (name, _) in contracts {
+                    println!("    - {}", name);
+                }
+            }
+        }
+        if print_sizes {
+            // add extra newline if names were already printed
+            if print_names {
+                println!();
+            }
+            let compiled_contracts = output.compiled_contracts_by_compiler_version();
+            let mut sizes = BTreeMap::new();
+            for (_, contracts) in compiled_contracts.into_iter() {
+                for (name, contract) in contracts {
+                    let bytecode: CompactContractBytecode = contract.into();
+                    let size = if let Some(code) = bytecode.bytecode {
+                        if let Some(object) = code.object.as_bytes() {
+                            object.to_vec().len()
+                        } else {
+                            0
+                        }
+                    } else {
+                        0
+                    };
+                    sizes.insert(name, size);
+                }
+            }
+            let json = serde_json::to_value(&sizes)?;
+            println!("name             size (bytes)");
+            println!("-----------------------------");
+            println!("{}", to_table(json));
+        }
+
         println!("{}", output);
         println!("Success");
     }
+
     Ok(output)
 }
 

config/src/lib.rs

@@ -186,6 +186,10 @@ pub struct Config {
     /// by proptest, to be encountered during usage of `vm.assume`
     /// cheatcode.
     pub fuzz_max_global_rejects: u32,
+    /// Print the names of the compiled contracts
+    pub names: bool,
+    /// Print the sizes of the compiled contracts
+    pub sizes: bool,
     /// The root path where the config detection started from, `Config::with_root`
     #[doc(hidden)]
     //  We're skipping serialization here, so it won't be included in the [`Config::to_string()`]
@@ -800,6 +804,8 @@ impl Default for Config {
             optimizer_details: None,
             extra_output: Default::default(),
             extra_output_files: Default::default(),
+            names: false,
+            sizes: false,
             fuzz_runs: 256,
             fuzz_max_local_rejects: 1024,
             fuzz_max_global_rejects: 65536,