feat: add mesc --rpc-url support (#320)

* add mesc * fix(config): handle mesc error * fix(config): handle mesc error * fix(config): handle mesc error * fix(config): handle mesc error --------- Co-authored-by: Jonathan Becker <jonathan@jbecker.dev>
Jon-Becker · Feb 1, 2024 · 3fc0cd6 · 3fc0cd6
1 parent 65c1c3a
commit 3fc0cd6
Show file tree

Hide file tree

Showing 10 changed files with 77 additions and 9 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/config/Cargo.toml b/config/Cargo.toml
@@ -11,6 +11,7 @@ keywords = ["ethereum", "web3", "decompiler", "evm", "crypto"]
 heimdall-common = { path = "./../common" }
 clap-verbosity-flag = "1.0.0"
 clap = { version = "3.1.18", features = ["derive"] }
+mesc = { version = "0.2.0" }
 serde = { version = "1.0", features = ["derive"] }
 toml = { version = "0.7.6" }
 thiserror = "1.0.50"

diff --git a/config/src/lib.rs b/config/src/lib.rs
@@ -3,7 +3,7 @@ pub mod error;
 use crate::error::Error;
 use clap::{AppSettings, Parser};
 use heimdall_common::{
-    error, info, success,
+    debug, error, info, success,
     utils::io::file::{delete_path, read_file, write_file},
 };
 use serde::{Deserialize, Serialize};
@@ -74,8 +74,39 @@ impl Configuration {
         .map_err(|e| Error::Generic(format!("failed to read config file: {}", e)))?;
 
         // parse the config file
-        let config: Configuration = toml::from_str(&contents)
+        let mut config: Configuration = toml::from_str(&contents)
             .map_err(|e| Error::ParseError(format!("failed to parse config file: {}", e)))?;
+
+        // load mesc config if enabled
+        if !mesc::is_mesc_enabled() {
+            return Ok(config);
+        }
+
+        if let Some(endpoint) = mesc::get_default_endpoint(Some("heimdall"))
+            .map_err(|e| Error::Generic(format!("MESC error: {}", e)))?
+        {
+            debug!("overriding rpc_url with mesc endpoint");
+            config.rpc_url = endpoint.url;
+        }
+        if let Some(key) = mesc::metadata::get_api_key("etherscan", Some("heimdall"))
+            .map_err(|e| Error::Generic(format!("MESC error: {}", e)))?
+        {
+            debug!("overriding etherscan_api_key with mesc key");
+            config.etherscan_api_key = key;
+        }
+        if let Some(key) = mesc::metadata::get_api_key("transpose", Some("heimdall"))
+            .map_err(|e| Error::Generic(format!("MESC error: {}", e)))?
+        {
+            debug!("overriding transpose_api_key with mesc key");
+            config.transpose_api_key = key;
+        }
+        if let Some(key) = mesc::metadata::get_api_key("openai", Some("heimdall"))
+            .map_err(|e| Error::Generic(format!("MESC error: {}", e)))?
+        {
+            debug!("overriding openai_api_key with mesc key");
+            config.openai_api_key = key;
+        }
+
         Ok(config)
     }
 
@@ -169,6 +200,16 @@ pub fn config(args: ConfigArgs) -> Result<(), Error> {
     Ok(())
 }
 
+/// Parse user input --rpc-url into a full url
+pub fn parse_url_arg(url: &str) -> Result<String, String> {
+    if mesc::is_mesc_enabled() {
+        if let Ok(Some(endpoint)) = mesc::get_endpoint_by_query(url, Some("heimdall")) {
+            return Ok(endpoint.url)
+        }
+    }
+    Ok(url.to_string())
+}
+
 #[allow(deprecated)]
 #[cfg(test)]
 mod tests {

diff --git a/core/src/cfg/mod.rs b/core/src/cfg/mod.rs
@@ -16,6 +16,7 @@ use heimdall_common::{
     },
     warn,
 };
+use heimdall_config::parse_url_arg;
 use indicatif::ProgressBar;
 use std::time::Duration;
 
@@ -46,7 +47,8 @@ pub struct CFGArgs {
     pub verbose: clap_verbosity_flag::Verbosity,
 
     /// The RPC provider to use for fetching target bytecode.
-    #[clap(long = "rpc-url", short, default_value = "", hide_default_value = true)]
+    /// This can be an explicit URL or a reference to a MESC endpoint.
+    #[clap(long, short, parse(try_from_str = parse_url_arg), default_value = "", hide_default_value = true)]
     pub rpc_url: String,
 
     /// When prompted, always select the default value.

diff --git a/core/src/decode/mod.rs b/core/src/decode/mod.rs
@@ -30,6 +30,7 @@ use heimdall_common::{
     },
     warn,
 };
+use heimdall_config::parse_url_arg;
 
 use indicatif::ProgressBar;
 
@@ -55,7 +56,8 @@ pub struct DecodeArgs {
     pub verbose: clap_verbosity_flag::Verbosity,
 
     /// The RPC provider to use for fetching target calldata.
-    #[clap(long = "rpc-url", short, default_value = "", hide_default_value = true)]
+    /// This can be an explicit URL or a reference to a MESC endpoint.
+    #[clap(long, short, parse(try_from_str = parse_url_arg), default_value = "", hide_default_value = true)]
     pub rpc_url: String,
 
     /// Your OpenAI API key, used for explaining calldata.

diff --git a/core/src/decompile/mod.rs b/core/src/decompile/mod.rs
@@ -15,6 +15,7 @@ use heimdall_common::{
     },
     warn,
 };
+use heimdall_config::parse_url_arg;
 
 use crate::{
     decompile::{
@@ -63,7 +64,8 @@ pub struct DecompilerArgs {
     pub verbose: clap_verbosity_flag::Verbosity,
 
     /// The RPC provider to use for fetching target bytecode.
-    #[clap(long = "rpc-url", short, default_value = "", hide_default_value = true)]
+    /// This can be an explicit URL or a reference to a MESC endpoint.
+    #[clap(long, short, parse(try_from_str = parse_url_arg), default_value = "", hide_default_value = true)]
     pub rpc_url: String,
 
     /// When prompted, always select the default value.

diff --git a/core/src/disassemble/mod.rs b/core/src/disassemble/mod.rs
@@ -6,6 +6,7 @@ use heimdall_common::{
     info,
     utils::{io::logging::set_logger_env, strings::encode_hex},
 };
+use heimdall_config::parse_url_arg;
 
 use crate::error::Error;
 
@@ -24,7 +25,8 @@ pub struct DisassemblerArgs {
     pub verbose: clap_verbosity_flag::Verbosity,
 
     /// The RPC provider to use for fetching target bytecode.
-    #[clap(long = "rpc-url", short, default_value = "", hide_default_value = true)]
+    /// This can be an explicit URL or a reference to a MESC endpoint.
+    #[clap(long, short, parse(try_from_str = parse_url_arg), default_value = "", hide_default_value = true)]
     pub rpc_url: String,
 
     /// Whether to use base-10 for the program counter.

diff --git a/core/src/dump/mod.rs b/core/src/dump/mod.rs
@@ -11,6 +11,7 @@ use heimdall_common::{
     resources::transpose::{get_contract_creation, get_transaction_list},
     utils::io::logging::*,
 };
+use heimdall_config::parse_url_arg;
 use std::{collections::HashMap, env, str::FromStr, time::Instant};
 
 use crate::error::Error;
@@ -44,7 +45,8 @@ pub struct DumpArgs {
     pub output: String,
 
     /// The RPC URL to use for fetching data.
-    #[clap(long = "rpc-url", short, default_value = "", hide_default_value = true)]
+    /// This can be an explicit URL or a reference to a MESC endpoint.
+    #[clap(long, short, parse(try_from_str = parse_url_arg), default_value = "", hide_default_value = true)]
     pub rpc_url: String,
 
     /// Your Transpose.io API Key

diff --git a/core/src/inspect/mod.rs b/core/src/inspect/mod.rs
@@ -18,6 +18,7 @@ use heimdall_common::{
     },
     warn,
 };
+use heimdall_config::parse_url_arg;
 
 use crate::error::Error;
 
@@ -40,7 +41,8 @@ pub struct InspectArgs {
     pub verbose: clap_verbosity_flag::Verbosity,
 
     /// The RPC provider to use for fetching target calldata.
-    #[clap(long = "rpc-url", short, default_value = "", hide_default_value = true)]
+    /// This can be an explicit URL or a reference to a MESC endpoint.
+    #[clap(long, short, parse(try_from_str = parse_url_arg), default_value = "", hide_default_value = true)]
     pub rpc_url: String,
 
     /// When prompted, always select the default value.

diff --git a/core/src/snapshot/mod.rs b/core/src/snapshot/mod.rs
@@ -15,6 +15,7 @@ use heimdall_common::{
     },
     warn,
 };
+use heimdall_config::parse_url_arg;
 
 use std::{
     collections::{HashMap, HashSet},
@@ -62,7 +63,8 @@ pub struct SnapshotArgs {
     pub verbose: clap_verbosity_flag::Verbosity,
 
     /// The RPC provider to use for fetching target bytecode.
-    #[clap(long = "rpc-url", short, default_value = "", hide_default_value = true)]
+    /// This can be an explicit URL or a reference to a MESC endpoint.
+    #[clap(long, short, parse(try_from_str = parse_url_arg), default_value = "", hide_default_value = true)]
     pub rpc_url: String,
 
     /// When prompted, always select the default value.