feat: --log-traffic for logging provider traffic

Adds a new option `--log-traffic` to commands that use a provider. When this option is used, raw request/response data will be logged to the standard error stream.
xJonathanLEI · Jul 16, 2023 · b0d90fb · b0d90fb
1 parent 2d3cebd
commit b0d90fb
Show file tree

Hide file tree

Showing 24 changed files with 126 additions and 17 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -19,6 +19,7 @@ colored_json = "3.2.0"
 env_logger = "0.10.0"
 hex = "0.4.3"
 hex-literal = "0.4.1"
+log = "0.4.19"
 num-bigint = "0.4.3"
 regex = "1.8.4"
 rpassword = "7.2.0"

diff --git a/src/main.rs b/src/main.rs
@@ -15,6 +15,7 @@ mod provider;
 mod signer;
 mod subcommands;
 mod utils;
+mod verbosity;
 
 const VERSION_STRING: &str = concat!(env!("CARGO_PKG_VERSION"), " (", env!("VERGEN_GIT_SHA"), ")");
 
@@ -101,8 +102,6 @@ enum Subcommands {
 
 #[tokio::main]
 async fn main() {
-    env_logger::init();
-
     if let Err(err) = run_command(Cli::parse()).await {
         eprintln!("{}", format!("Error: {err}").red());
         std::process::exit(1);

diff --git a/src/subcommands/account/deploy.rs b/src/subcommands/account/deploy.rs
@@ -14,6 +14,7 @@ use crate::{
     account::{AccountConfig, AccountVariant, DeployedStatus, DeploymentStatus},
     signer::SignerArgs,
     utils::watch_tx,
+    verbosity::VerbosityArgs,
     ProviderArgs,
 };
 
@@ -30,10 +31,14 @@ pub struct Deploy {
     estimate_only: bool,
     #[clap(help = "Path to the account config file")]
     file: PathBuf,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl Deploy {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = Arc::new(self.provider.into_provider());
         let signer = Arc::new(self.signer.into_signer()?);
 

diff --git a/src/subcommands/account/fetch.rs b/src/subcommands/account/fetch.rs
@@ -14,6 +14,7 @@ use crate::{
         AccountConfig, AccountVariant, AccountVariantType, DeployedStatus, DeploymentStatus,
         OzAccountConfig, KNOWN_ACCOUNT_CLASSES,
     },
+    verbosity::VerbosityArgs,
     ProviderArgs,
 };
 
@@ -27,10 +28,14 @@ pub struct Fetch {
     output: Option<PathBuf>,
     #[clap(help = "Contract address")]
     address: String,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl Fetch {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         // We allow not saving the config to just identify the account contract
         if self.output.is_none() {
             eprintln!(

diff --git a/src/subcommands/block.rs b/src/subcommands/block.rs
@@ -3,7 +3,7 @@ use clap::Parser;
 use colored_json::{ColorMode, Output};
 use starknet::providers::Provider;
 
-use crate::{utils::parse_block_id, ProviderArgs};
+use crate::{utils::parse_block_id, verbosity::VerbosityArgs, ProviderArgs};
 
 #[derive(Debug, Parser)]
 pub struct Block {
@@ -16,10 +16,14 @@ pub struct Block {
         help = "Block number, hash, or tag (latest/pending)"
     )]
     block_id: String,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl Block {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = self.provider.into_provider();
 
         let block_id = parse_block_id(&self.block_id)?;

diff --git a/src/subcommands/block_hash.rs b/src/subcommands/block_hash.rs
@@ -2,16 +2,20 @@ use anyhow::Result;
 use clap::Parser;
 use starknet::providers::Provider;
 
-use crate::ProviderArgs;
+use crate::{verbosity::VerbosityArgs, ProviderArgs};
 
 #[derive(Debug, Parser)]
 pub struct BlockHash {
     #[clap(flatten)]
     provider: ProviderArgs,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl BlockHash {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = self.provider.into_provider();
 
         let block = provider.block_hash_and_number().await?;

diff --git a/src/subcommands/block_number.rs b/src/subcommands/block_number.rs
@@ -2,16 +2,20 @@ use anyhow::Result;
 use clap::Parser;
 use starknet::providers::Provider;
 
-use crate::ProviderArgs;
+use crate::{verbosity::VerbosityArgs, ProviderArgs};
 
 #[derive(Debug, Parser)]
 pub struct BlockNumber {
     #[clap(flatten)]
     provider: ProviderArgs,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl BlockNumber {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = self.provider.into_provider();
 
         let block = provider.block_hash_and_number().await?;

diff --git a/src/subcommands/block_time.rs b/src/subcommands/block_time.rs
@@ -3,7 +3,7 @@ use chrono::{TimeZone, Utc};
 use clap::Parser;
 use starknet::{core::types::MaybePendingBlockWithTxHashes, providers::Provider};
 
-use crate::{utils::parse_block_id, ProviderArgs};
+use crate::{utils::parse_block_id, verbosity::VerbosityArgs, ProviderArgs};
 
 #[derive(Debug, Parser)]
 pub struct BlockTime {
@@ -26,10 +26,14 @@ pub struct BlockTime {
         help = "Block number, hash, or tag (latest/pending)"
     )]
     block_id: String,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl BlockTime {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = self.provider.into_provider();
 
         let block_id = parse_block_id(&self.block_id)?;

diff --git a/src/subcommands/call.rs b/src/subcommands/call.rs
@@ -10,7 +10,9 @@ use starknet::{
     providers::Provider,
 };
 
-use crate::{address_book::AddressBookResolver, decode::FeltDecoder, ProviderArgs};
+use crate::{
+    address_book::AddressBookResolver, decode::FeltDecoder, verbosity::VerbosityArgs, ProviderArgs,
+};
 
 #[derive(Debug, Parser)]
 pub struct Call {
@@ -22,10 +24,14 @@ pub struct Call {
     selector: String,
     #[clap(help = "Raw function call arguments")]
     calldata: Vec<String>,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl Call {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = Arc::new(self.provider.into_provider());
         let felt_decoder = FeltDecoder::new(AddressBookResolver::new(provider.clone()));
 

diff --git a/src/subcommands/chain_id.rs b/src/subcommands/chain_id.rs
@@ -2,7 +2,7 @@ use anyhow::Result;
 use clap::Parser;
 use starknet::{core::utils::parse_cairo_short_string, providers::Provider};
 
-use crate::ProviderArgs;
+use crate::{verbosity::VerbosityArgs, ProviderArgs};
 
 #[derive(Debug, Parser)]
 pub struct ChainId {
@@ -20,10 +20,14 @@ pub struct ChainId {
         help = "Block number, hash, or tag (latest/pending)"
     )]
     block_id: String,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl ChainId {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = self.provider.into_provider();
 
         let raw_chain_id = provider.chain_id().await?;

diff --git a/src/subcommands/class_at.rs b/src/subcommands/class_at.rs
@@ -6,18 +6,22 @@ use starknet::{
     providers::Provider,
 };
 
-use crate::ProviderArgs;
+use crate::{verbosity::VerbosityArgs, ProviderArgs};
 
 #[derive(Debug, Parser)]
 pub struct ClassAt {
     #[clap(flatten)]
     provider: ProviderArgs,
     #[clap(help = "Contract address")]
     address: String,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl ClassAt {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = self.provider.into_provider();
         let address = FieldElement::from_hex_be(&self.address)?;
 

diff --git a/src/subcommands/class_by_hash.rs b/src/subcommands/class_by_hash.rs
@@ -6,18 +6,22 @@ use starknet::{
     providers::Provider,
 };
 
-use crate::ProviderArgs;
+use crate::{verbosity::VerbosityArgs, ProviderArgs};
 
 #[derive(Debug, Parser)]
 pub struct ClassByHash {
     #[clap(flatten)]
     provider: ProviderArgs,
     #[clap(help = "Class hash")]
     hash: String,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl ClassByHash {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = self.provider.into_provider();
         let class_hash = FieldElement::from_hex_be(&self.hash)?;
 

diff --git a/src/subcommands/class_hash_at.rs b/src/subcommands/class_hash_at.rs
@@ -5,18 +5,22 @@ use starknet::{
     providers::Provider,
 };
 
-use crate::ProviderArgs;
+use crate::{verbosity::VerbosityArgs, ProviderArgs};
 
 #[derive(Debug, Parser)]
 pub struct ClassHashAt {
     #[clap(flatten)]
     provider: ProviderArgs,
     #[clap(help = "Contract address")]
     address: String,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl ClassHashAt {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = self.provider.into_provider();
         let address = FieldElement::from_hex_be(&self.address)?;
 

diff --git a/src/subcommands/declare.rs b/src/subcommands/declare.rs
@@ -17,6 +17,7 @@ use crate::{
     casm::{CasmArgs, CasmHashSource},
     signer::SignerArgs,
     utils::watch_tx,
+    verbosity::VerbosityArgs,
     ProviderArgs,
 };
 
@@ -43,10 +44,14 @@ pub struct Declare {
     watch: bool,
     #[clap(help = "Path to contract artifact file")]
     file: PathBuf,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl Declare {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = Arc::new(self.provider.into_provider());
 
         if !self.account.exists() {

diff --git a/src/subcommands/deploy.rs b/src/subcommands/deploy.rs
@@ -20,6 +20,7 @@ use crate::{
     decode::FeltDecoder,
     signer::SignerArgs,
     utils::watch_tx,
+    verbosity::VerbosityArgs,
     ProviderArgs,
 };
 
@@ -58,10 +59,14 @@ pub struct Deploy {
     class_hash: String,
     #[clap(help = "Raw constructor arguments")]
     ctor_args: Vec<String>,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl Deploy {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = Arc::new(self.provider.into_provider());
         let felt_decoder = FeltDecoder::new(AddressBookResolver::new(provider.clone()));
 

diff --git a/src/subcommands/invoke.rs b/src/subcommands/invoke.rs
@@ -18,6 +18,7 @@ use crate::{
     decode::FeltDecoder,
     signer::SignerArgs,
     utils::watch_tx,
+    verbosity::VerbosityArgs,
     ProviderArgs,
 };
 
@@ -42,10 +43,14 @@ pub struct Invoke {
     watch: bool,
     #[clap(help = "One or more contract calls. See documentation for more details")]
     calls: Vec<String>,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl Invoke {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = Arc::new(self.provider.into_provider());
         let felt_decoder = FeltDecoder::new(AddressBookResolver::new(provider.clone()));
 

diff --git a/src/subcommands/nonce.rs b/src/subcommands/nonce.rs
@@ -5,18 +5,22 @@ use starknet::{
     providers::Provider,
 };
 
-use crate::ProviderArgs;
+use crate::{verbosity::VerbosityArgs, ProviderArgs};
 
 #[derive(Debug, Parser)]
 pub struct Nonce {
     #[clap(flatten)]
     provider: ProviderArgs,
     #[clap(help = "Contract address")]
     address: String,
+    #[clap(flatten)]
+    verbosity: VerbosityArgs,
 }
 
 impl Nonce {
     pub async fn run(self) -> Result<()> {
+        self.verbosity.setup_logging();
+
         let provider = self.provider.into_provider();
         let address = FieldElement::from_hex_be(&self.address)?;