feat: cast mktx (#7056)

ay · mattsse · web-flow · commit e57e82ce569a · 2024-03-01T10:37:23.000+01:00
* feat: `cast mktx`

* refactor: similar code in `cast send` and `cast mktx`

* update clap

---------

Co-authored-by: Matthias Seitz &lt;matthias.seitz@outlook.de&gt;
diff --git a/crates/cast/bin/cmd/mktx.rs b/crates/cast/bin/cmd/mktx.rs
@@ -0,0 +1,109 @@
+use crate::tx;
+use clap::Parser;
+use ethers_core::types::NameOrAddress;
+use ethers_middleware::MiddlewareBuilder;
+use ethers_providers::Middleware;
+use ethers_signers::Signer;
+use eyre::Result;
+use foundry_cli::{
+    opts::{EthereumOpts, TransactionOpts},
+    utils,
+};
+use foundry_common::types::ToAlloy;
+use foundry_config::Config;
+use std::str::FromStr;
+
+/// CLI arguments for `cast mktx`.
+#[derive(Debug, Parser)]
+pub struct MakeTxArgs {
+    /// The destination of the transaction.
+    ///
+    /// If not provided, you must use `cast mktx --create`.
+    #[arg(value_parser = NameOrAddress::from_str)]
+    to: Option<NameOrAddress>,
+
+    /// The signature of the function to call.
+    sig: Option<String>,
+
+    /// The arguments of the function to call.
+    args: Vec<String>,
+
+    /// Reuse the latest nonce for the sender account.
+    #[arg(long, conflicts_with = "nonce")]
+    resend: bool,
+
+    #[command(subcommand)]
+    command: Option<MakeTxSubcommands>,
+
+    #[command(flatten)]
+    tx: TransactionOpts,
+
+    #[command(flatten)]
+    eth: EthereumOpts,
+}
+
+#[derive(Debug, Parser)]
+pub enum MakeTxSubcommands {
+    /// Use to deploy raw contract bytecode.
+    #[clap(name = "--create")]
+    Create {
+        /// The initialization bytecode of the contract to deploy.
+        code: String,
+
+        /// The signature of the constructor.
+        sig: Option<String>,
+
+        /// The constructor arguments.
+        args: Vec<String>,
+    },
+}
+
+impl MakeTxArgs {
+    pub async fn run(self) -> Result<()> {
+        let MakeTxArgs { to, mut sig, mut args, resend, command, mut tx, eth } = self;
+
+        let code = if let Some(MakeTxSubcommands::Create {
+            code,
+            sig: constructor_sig,
+            args: constructor_args,
+        }) = command
+        {
+            sig = constructor_sig;
+            args = constructor_args;
+            Some(code)
+        } else {
+            None
+        };
+
+        tx::validate_to_address(&code, &to)?;
+
+        let config = Config::from(&eth);
+        let provider = utils::get_provider(&config)?;
+        let chain = utils::get_chain(config.chain, &provider).await?;
+        let api_key = config.get_etherscan_api_key(Some(chain));
+
+        // Retrieve the signer, and bail if it can't be constructed.
+        let signer = eth.wallet.signer().await?;
+        let from = signer.address();
+
+        tx::validate_from_address(eth.wallet.from, from.to_alloy())?;
+
+        if resend {
+            tx.nonce = Some(provider.get_transaction_count(from, None).await?.to_alloy());
+        }
+
+        let provider = provider.with_signer(signer);
+
+        let (mut tx, _) =
+            tx::build_tx(&provider, from, to, code, sig, args, tx, chain, api_key).await?;
+
+        // Fill nonce, gas limit, gas price, and max priority fee per gas if needed
+        provider.fill_transaction(&mut tx, None).await?;
+
+        let signature = provider.sign_transaction(&tx, from).await?;
+        let signed_tx = tx.rlp_signed(&signature);
+        println!("{signed_tx}");
+
+        Ok(())
+    }
+}
diff --git a/crates/cast/bin/cmd/mod.rs b/crates/cast/bin/cmd/mod.rs
@@ -13,6 +13,7 @@ pub mod estimate;
 pub mod find_block;
 pub mod interface;
 pub mod logs;
+pub mod mktx;
 pub mod rpc;
 pub mod run;
 pub mod send;
diff --git a/crates/cast/bin/cmd/send.rs b/crates/cast/bin/cmd/send.rs
@@ -1,4 +1,5 @@
-use cast::{Cast, TxBuilder};
+use crate::tx;
+use cast::Cast;
 use clap::Parser;
 use ethers_core::types::NameOrAddress;
 use ethers_middleware::SignerMiddleware;
@@ -82,7 +83,7 @@ impl SendTxArgs {
         let SendTxArgs {
             eth,
             to,
-            sig,
+            mut sig,
             cast_async,
             mut args,
             mut tx,
@@ -93,24 +94,20 @@ impl SendTxArgs {
             unlocked,
         } = self;
 
-        let mut sig = sig.unwrap_or_default();
         let code = if let Some(SendTxSubcommands::Create {
             code,
             sig: constructor_sig,
             args: constructor_args,
         }) = command
         {
-            sig = constructor_sig.unwrap_or_default();
+            sig = constructor_sig;
             args = constructor_args;
             Some(code)
         } else {
             None
         };
 
-        // ensure mandatory fields are provided
-        if code.is_none() && to.is_none() {
-            eyre::bail!("Must specify a recipient address or contract code to deploy");
-        }
+        tx::validate_to_address(&code, &to)?;
 
         let config = Config::from(&eth);
         let provider = utils::get_provider(&config)?;
@@ -155,7 +152,8 @@ impl SendTxArgs {
                 config.sender.to_ethers(),
                 to,
                 code,
-                (sig, args),
+                sig,
+                args,
                 tx,
                 chain,
                 api_key,
@@ -173,19 +171,7 @@ impl SendTxArgs {
             let signer = eth.wallet.signer().await?;
             let from = signer.address();
 
-            // prevent misconfigured hwlib from sending a transaction that defies
-            // user-specified --from
-            if let Some(specified_from) = eth.wallet.from {
-                if specified_from != from.to_alloy() {
-                    eyre::bail!(
-                        "\
-The specified sender via CLI/env vars does not match the sender configured via
-the hardware wallet's HD Path.
-Please use the `--hd-path <PATH>` parameter to specify the BIP32 Path which
-corresponds to the sender, or let foundry automatically detect it by not specifying any sender address."
-                    )
-                }
-            }
+            tx::validate_from_address(eth.wallet.from, from.to_alloy())?;
 
             if resend {
                 tx.nonce = Some(provider.get_transaction_count(from, None).await?.to_alloy());
@@ -198,7 +184,8 @@ corresponds to the sender, or let foundry automatically detect it by not specify
                 from,
                 to,
                 code,
-                (sig, args),
+                sig,
+                args,
                 tx,
                 chain,
                 api_key,
@@ -217,7 +204,8 @@ async fn cast_send<M: Middleware, F: Into<NameOrAddress>, T: Into<NameOrAddress>
     from: F,
     to: Option<T>,
     code: Option<String>,
-    args: (String, Vec<String>),
+    sig: Option<String>,
+    args: Vec<String>,
     tx: TransactionOpts,
     chain: Chain,
     etherscan_api_key: Option<String>,
@@ -228,30 +216,8 @@ async fn cast_send<M: Middleware, F: Into<NameOrAddress>, T: Into<NameOrAddress>
 where
     M::Error: 'static,
 {
-    let (sig, params) = args;
-    let params = if !sig.is_empty() { Some((&sig[..], params)) } else { None };
-    let mut builder = TxBuilder::new(&provider, from, to, chain, tx.legacy).await?;
-    builder
-        .etherscan_api_key(etherscan_api_key)
-        .gas(tx.gas_limit)
-        .gas_price(tx.gas_price)
-        .priority_gas_price(tx.priority_gas_price)
-        .value(tx.value)
-        .nonce(tx.nonce);
-
-    if let Some(code) = code {
-        let mut data = hex::decode(code)?;
-
-        if let Some((sig, args)) = params {
-            let (mut sigdata, _) = builder.create_args(sig, args).await?;
-            data.append(&mut sigdata);
-        }
-
-        builder.set_data(data);
-    } else {
-        builder.args(params).await?;
-    };
-    let builder_output = builder.build();
+    let builder_output =
+        tx::build_tx(&provider, from, to, code, sig, args, tx, chain, etherscan_api_key).await?;
 
     let cast = Cast::new(provider);
 
diff --git a/crates/cast/bin/main.rs b/crates/cast/bin/main.rs
@@ -26,6 +26,7 @@ use std::time::Instant;
 
 pub mod cmd;
 pub mod opts;
+pub mod tx;
 
 use opts::{Cast as Opts, CastSubcommand, ToBaseArgs};
 
@@ -366,6 +367,7 @@ async fn main() -> Result<()> {
         // Calls & transactions
         CastSubcommand::Call(cmd) => cmd.run().await?,
         CastSubcommand::Estimate(cmd) => cmd.run().await?,
+        CastSubcommand::MakeTx(cmd) => cmd.run().await?,
         CastSubcommand::PublishTx { raw_tx, cast_async, rpc } => {
             let config = Config::from(&rpc);
             let provider = utils::get_provider(&config)?;
diff --git a/crates/cast/bin/opts.rs b/crates/cast/bin/opts.rs
@@ -1,7 +1,8 @@
 use crate::cmd::{
     access_list::AccessListArgs, bind::BindArgs, call::CallArgs, create2::Create2Args,
     estimate::EstimateArgs, find_block::FindBlockArgs, interface::InterfaceArgs, logs::LogsArgs,
-    rpc::RpcArgs, run::RunArgs, send::SendTxArgs, storage::StorageArgs, wallet::WalletSubcommands,
+    mktx::MakeTxArgs, rpc::RpcArgs, run::RunArgs, send::SendTxArgs, storage::StorageArgs,
+    wallet::WalletSubcommands,
 };
 use alloy_primitives::{Address, B256, U256};
 use clap::{Parser, Subcommand, ValueHint};
@@ -381,6 +382,10 @@ pub enum CastSubcommand {
         bytecode: String,
     },
 
+    /// Build and sign a transaction.
+    #[command(name = "mktx", visible_alias = "m")]
+    MakeTx(MakeTxArgs),
+
     /// Calculate the ENS namehash of a name.
     #[command(visible_aliases = &["na", "nh"])]
     Namehash { name: Option<String> },
diff --git a/crates/cast/bin/tx.rs b/crates/cast/bin/tx.rs
@@ -0,0 +1,73 @@
+use alloy_primitives::Address;
+use cast::{TxBuilder, TxBuilderOutput};
+use ethers_core::types::NameOrAddress;
+use ethers_providers::Middleware;
+use eyre::Result;
+use foundry_cli::opts::TransactionOpts;
+use foundry_config::Chain;
+
+/// Prevents a misconfigured hwlib from sending a transaction that defies user-specified --from
+pub fn validate_from_address(
+    specified_from: Option<Address>,
+    signer_address: Address,
+) -> Result<()> {
+    if let Some(specified_from) = specified_from {
+        if specified_from != signer_address {
+            eyre::bail!(
+                "\
+The specified sender via CLI/env vars does not match the sender configured via
+the hardware wallet's HD Path.
+Please use the `--hd-path <PATH>` parameter to specify the BIP32 Path which
+corresponds to the sender, or let foundry automatically detect it by not specifying any sender address."
+            )
+        }
+    }
+    Ok(())
+}
+
+/// Ensures the transaction is either a contract deployment or a recipient address is specified
+pub fn validate_to_address(code: &Option<String>, to: &Option<NameOrAddress>) -> Result<()> {
+    if code.is_none() && to.is_none() {
+        eyre::bail!("Must specify a recipient address or contract code to deploy");
+    }
+    Ok(())
+}
+
+#[allow(clippy::too_many_arguments)]
+pub async fn build_tx<M: Middleware, F: Into<NameOrAddress>, T: Into<NameOrAddress>>(
+    provider: &M,
+    from: F,
+    to: Option<T>,
+    code: Option<String>,
+    sig: Option<String>,
+    args: Vec<String>,
+    tx: TransactionOpts,
+    chain: impl Into<Chain>,
+    etherscan_api_key: Option<String>,
+) -> Result<TxBuilderOutput> {
+    let mut builder = TxBuilder::new(provider, from, to, chain, tx.legacy).await?;
+    builder
+        .etherscan_api_key(etherscan_api_key)
+        .gas(tx.gas_limit)
+        .gas_price(tx.gas_price)
+        .priority_gas_price(tx.priority_gas_price)
+        .value(tx.value)
+        .nonce(tx.nonce);
+
+    let params = sig.as_deref().map(|sig| (sig, args));
+    if let Some(code) = code {
+        let mut data = hex::decode(code)?;
+
+        if let Some((sig, args)) = params {
+            let (mut sigdata, _) = builder.create_args(sig, args).await?;
+            data.append(&mut sigdata);
+        }
+
+        builder.set_data(data);
+    } else {
+        builder.args(params).await?;
+    }
+
+    let builder_output = builder.build();
+    Ok(builder_output)
+}
diff --git a/crates/cast/src/lib.rs b/crates/cast/src/lib.rs
@@ -34,7 +34,7 @@ use std::{
     sync::atomic::{AtomicBool, Ordering},
 };
 use tokio::signal::ctrl_c;
-use tx::{TxBuilderOutput, TxBuilderPeekOutput};
+use tx::TxBuilderPeekOutput;
 
 use foundry_common::abi::encode_function_args_packed;
 pub use foundry_evm::*;
@@ -43,7 +43,7 @@ pub use rusoto_core::{
     request::HttpClient as AwsHttpClient, Client as AwsClient,
 };
 pub use rusoto_kms::KmsClient;
-pub use tx::TxBuilder;
+pub use tx::{TxBuilder, TxBuilderOutput};
 
 pub mod base;
 pub mod errors;
diff --git a/crates/cast/tests/cli/main.rs b/crates/cast/tests/cli/main.rs
