feat: add support for revert strings

cli/src/cmd/forge/build.rs

@@ -9,7 +9,7 @@ use crate::{
     opts::forge::CompilerArgs,
 };
 use clap::{Parser, ValueHint};
-use ethers::solc::{remappings::Remapping, utils::canonicalized};
+use ethers::solc::{artifacts::RevertStrings, remappings::Remapping, utils::canonicalized};
 use foundry_config::{
     figment::{
         self,
@@ -138,6 +138,15 @@ pub struct CoreBuildArgs {
     )]
     #[serde(skip)]
     pub config_path: Option<PathBuf>,
+
+    #[clap(
+        help_heading = "PROJECT OPTIONS",
+        help = r#"How to treat revert (and require) reason strings. Possible values are "default", "strip", "debug" and "verboseDebug""#,
+        long = "revert-strings",
+        value_name = "revert"
+    )]
+    #[serde(skip)]
+    pub revert_strings: Option<RevertStrings>,
 }
 
 impl CoreBuildArgs {
@@ -202,6 +211,10 @@ impl Provider for CoreBuildArgs {
             dict.insert("extra_output_files".to_string(), selection.into());
         }
 
+        if let Some(ref revert) = self.revert_strings {
+            dict.insert("revert_strings".to_string(), revert.to_string().into());
+        }
+
         Ok(Map::from([(Config::selected_profile(), dict)]))
     }
 }

cli/src/cmd/forge/flatten.rs

@@ -40,6 +40,7 @@ impl Cmd for FlattenArgs {
             libraries: vec![],
             via_ir: false,
             config_path: None,
+            revert_strings: None,
         };
 
         let config = Config::from(&build_args);

cli/src/cmd/forge/verify.rs

@@ -136,6 +136,7 @@ impl VerifyArgs {
             libraries: vec![],
             via_ir: false,
             config_path: None,
+            revert_strings: None,
         };
 
         let project = build_args.project()?;

cli/tests/it/config.rs

@@ -1,6 +1,7 @@
 //! Contains various tests for checking forge commands related to config values
 use ethers::{
     prelude::artifacts::YulDetails,
+    solc::artifacts::RevertStrings,
     types::{Address, U256},
 };
 use forge::executor::opts::EvmOpts;
@@ -83,6 +84,7 @@ forgetest!(can_extract_config_values, |prj: TestProject, mut cmd: TestCommand| {
         },
         no_storage_caching: true,
         bytecode_hash: Default::default(),
+        revert_strings: Some(RevertStrings::Strip),
         sparse_mode: true,
         __non_exhaustive: (),
     };

config/README.md

@@ -94,6 +94,13 @@ block_base_fee_per_gas = 0
 block_coinbase = '0x0000000000000000000000000000000000000000'
 block_timestamp = 0
 block_difficulty = 0
+# How to treat revert (and require) reason strings.
+# Possible values are: "default", "strip", "debug" and "verboseDebug".
+#  "default" does not inject compiler-generated revert strings and keeps user-supplied ones.
+# "strip" removes all revert strings (if possible, i.e. if literals are used) keeping side-effects
+# "debug" injects strings for compiler-generated internal reverts, implemented for ABI encoders V1 and V2 for now.
+# "verboseDebug" even appends further information to user-supplied revert strings (not yet implemented)
+revert_strings = "default"
 # caches storage retrieved locally for certain chains and endpoints
 # can also be restrictied to `chains = ["optimism", "mainnet"]`
 # by default all endpoints will be cached, alternative options are "remote" for only caching non localhost endpoints and "<regex>"

config/src/lib.rs

@@ -11,7 +11,10 @@ use crate::caching::StorageCachingConfig;
 use ethers_core::types::{Address, U256};
 pub use ethers_solc::artifacts::OptimizerDetails;
 use ethers_solc::{
-    artifacts::{output_selection::ContractOutputSelection, BytecodeHash, Optimizer, Settings},
+    artifacts::{
+        output_selection::ContractOutputSelection, serde_helpers, BytecodeHash, DebuggingSettings,
+        Optimizer, RevertStrings, Settings,
+    },
     cache::SOLIDITY_FILES_CACHE_FILENAME,
     error::SolcError,
     remappings::{RelativeRemapping, Remapping},
@@ -221,6 +224,9 @@ pub struct Config {
     /// The metadata hash is machine dependent. By default, this is set to [BytecodeHash::None] to allow for deterministic code, See: <https://docs.soliditylang.org/en/latest/metadata.html>
     #[serde(with = "from_str_lowercase")]
     pub bytecode_hash: BytecodeHash,
+    /// How to treat revert (and require) reason strings.
+    #[serde(with = "serde_helpers::display_from_str_opt")]
+    pub revert_strings: Option<RevertStrings>,
     /// Whether to compile in sparse mode
     ///
     /// If this option is enabled, only the required contracts/files will be selected to be
@@ -567,6 +573,10 @@ impl Config {
             evm_version: Some(self.evm_version),
             libraries,
             metadata: Some(self.bytecode_hash.into()),
+            debug: self.revert_strings.map(|revert_strings| DebuggingSettings {
+                revert_strings: Some(revert_strings),
+                debug_info: Vec::new(),
+            }),
             ..Default::default()
         }
         .with_extra_output(self.configured_artifacts_handler().output_selection())
@@ -939,6 +949,7 @@ impl Default for Config {
             rpc_storage_caching: Default::default(),
             no_storage_caching: false,
             bytecode_hash: BytecodeHash::Ipfs,
+            revert_strings: None,
             sparse_mode: false,
         }
     }
@@ -1643,6 +1654,7 @@ mod tests {
                 via_ir = true
                 rpc_storage_caching = { chains = [1, "optimism", 999999], endpoints = "all"}
                 bytecode_hash = "ipfs"
+                revert_strings = "strip"
             "#,
             )?;
 
@@ -1666,6 +1678,7 @@ mod tests {
                         endpoints: CachedEndpoints::All
                     },
                     bytecode_hash: BytecodeHash::Ipfs,
+                    revert_strings: Some(RevertStrings::Strip),
                     ..Config::default()
                 }
             );