Merge pull request #228 from teonite/list_transactions_subcommand

Add `list-transactions` subcommand

Author: wojcik91

Cargo.toml

@@ -45,7 +45,7 @@ jsonrpc-lite = "0.6.0"
 num-traits = "0.2.15"
 once_cell = "1.18.0"
 rand = "0.8.5"
-reqwest = { version = "0.12.5", features = ["json"] }
+reqwest = { version = "0.12.12", features = ["json"] }
 schemars = "0.8.18"
 serde = { version = "1", default-features = false, features = ["derive"] }
 serde-map-to-array = "1.1.1"

lib/error.rs

@@ -170,6 +170,10 @@ pub enum Error {
     /// Failed to construct HTTP client.
     #[error("failed to construct HTTP client")]
     FailedToConstructHttpClient,
+
+    /// Failed to parse provided node address as URL.
+    #[error("failed to parse node address as valid URL")]
+    FailedToParseNodeAddress,
 }
 
 impl From<ToBytesError> for Error {

lib/json_rpc/call.rs

@@ -1,11 +1,17 @@
+#[cfg(not(target_arch = "wasm32"))]
+use std::time::Duration;
+
 use crate::{Error, JsonRpcId, SuccessResponse, Verbosity};
 use jsonrpc_lite::{JsonRpc, Params};
 use once_cell::sync::OnceCell;
-use reqwest::Client;
+use reqwest::{Client, Url};
 use serde::{de::DeserializeOwned, Serialize};
 use serde_json::json;
 
 const RPC_API_PATH: &str = "rpc";
+#[cfg(not(target_arch = "wasm32"))]
+const REQUEST_TIMEOUT: Duration = Duration::from_secs(5);
+
 /// Statically declared client used when making HTTP requests
 /// so opened connections are pooled.
 static CLIENT: OnceCell<Client> = OnceCell::new();
@@ -14,32 +20,38 @@ static CLIENT: OnceCell<Client> = OnceCell::new();
 #[derive(Debug)]
 pub(crate) struct Call {
     rpc_id: JsonRpcId,
-    node_address: String,
+    node_address: Url,
     #[allow(dead_code)]
     verbosity: Verbosity,
 }
 
 /// `Call` encapsulates JSON-RPC calls made to the casper node service.
 impl Call {
-    pub(crate) fn new(rpc_id: JsonRpcId, node_address: &str, verbosity: Verbosity) -> Self {
-        Self {
+    pub(crate) fn new(
+        rpc_id: JsonRpcId,
+        node_address: &str,
+        verbosity: Verbosity,
+    ) -> Result<Self, Error> {
+        let url = if node_address.ends_with(RPC_API_PATH) {
+            node_address.to_string()
+        } else {
+            format!("{}/{}", node_address, RPC_API_PATH)
+        };
+
+        let node_address = Url::parse(&url).map_err(|_| Error::FailedToParseNodeAddress)?;
+        Ok(Self {
             rpc_id,
-            node_address: node_address.trim_end_matches('/').to_string(),
+            // node_address: node_address.trim_end_matches('/').to_string(),
+            node_address,
             verbosity,
-        }
+        })
     }
 
     pub(crate) async fn send_request<P: Serialize, R: DeserializeOwned>(
         self,
         method: &'static str,
         maybe_params: Option<P>,
     ) -> Result<SuccessResponse<R>, Error> {
-        let url = if self.node_address.ends_with(RPC_API_PATH) {
-            self.node_address
-        } else {
-            format!("{}/{}", self.node_address, RPC_API_PATH)
-        };
-
         let rpc_request = match maybe_params {
             Some(params) => {
                 let params = Params::Map(
@@ -56,9 +68,16 @@ impl Call {
         #[cfg(feature = "std-fs-io")]
         crate::json_pretty_print(&rpc_request, self.verbosity)?;
 
-        let client = CLIENT.get_or_init(Client::new);
+        let client = CLIENT.get_or_init(|| {
+            let builder = Client::builder();
+
+            #[cfg(not(target_arch = "wasm32"))]
+            let builder = builder.timeout(REQUEST_TIMEOUT);
+
+            builder.build().expect("failed to initialize HTTP client")
+        });
         let http_response = client
-            .post(&url)
+            .post(self.node_address)
             .json(&rpc_request)
             .send()
             .await

lib/lib.rs

@@ -141,7 +141,7 @@ pub async fn put_deploy(
     verbosity: Verbosity,
     deploy: Deploy,
 ) -> Result<SuccessResponse<PutDeployResult>, Error> {
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(PUT_DEPLOY_METHOD, Some(PutDeployParams::new(deploy)))
         .await
 }
@@ -157,7 +157,7 @@ pub async fn put_transaction(
     verbosity: Verbosity,
     transaction: Transaction,
 ) -> Result<SuccessResponse<PutTransactionResult>, Error> {
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(
             PUT_TRANSACTION_METHOD,
             Some(PutTransactionParams::new(transaction)),
@@ -177,7 +177,7 @@ pub async fn speculative_exec(
     verbosity: Verbosity,
     deploy: Deploy,
 ) -> Result<SuccessResponse<SpeculativeExecResult>, Error> {
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(
             SPECULATIVE_EXEC_METHOD,
             Some(SpeculativeExecParams::new(deploy)),
@@ -196,7 +196,7 @@ pub async fn speculative_exec_txn(
     verbosity: Verbosity,
     transaction: Transaction,
 ) -> Result<SuccessResponse<SpeculativeExecTxnResult>, Error> {
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(
             SPECULATIVE_EXEC_TXN_METHOD,
             Some(SpeculativeExecTxnParams::new(transaction)),
@@ -318,7 +318,7 @@ pub async fn get_deploy(
     deploy_hash: DeployHash,
     finalized_approvals: bool,
 ) -> Result<SuccessResponse<GetDeployResult>, Error> {
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(
             GET_DEPLOY_METHOD,
             Some(GetDeployParams::new(deploy_hash, finalized_approvals)),
@@ -341,7 +341,7 @@ pub async fn get_transaction(
     transaction_hash: TransactionHash,
     finalized_approvals: bool,
 ) -> Result<SuccessResponse<GetTransactionResult>, Error> {
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(
             GET_TRANSACTION_METHOD,
             Some(GetTransactionParams::new(
@@ -364,7 +364,7 @@ pub async fn get_block(
     maybe_block_identifier: Option<BlockIdentifier>,
 ) -> Result<SuccessResponse<GetBlockResult>, Error> {
     let params = maybe_block_identifier.map(GetBlockParams::new);
-    let success_response = JsonRpcCall::new(rpc_id, node_address, verbosity)
+    let success_response = JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(GET_BLOCK_METHOD, params)
         .await?;
     validation::validate_get_block_result(maybe_block_identifier, &success_response.result)?;
@@ -383,7 +383,7 @@ pub async fn get_block_transfers(
     maybe_block_identifier: Option<BlockIdentifier>,
 ) -> Result<SuccessResponse<GetBlockTransfersResult>, Error> {
     let params = maybe_block_identifier.map(GetBlockTransfersParams::new);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(GET_BLOCK_TRANSFERS_METHOD, params)
         .await
 }
@@ -400,7 +400,7 @@ pub async fn get_state_root_hash(
     maybe_block_identifier: Option<BlockIdentifier>,
 ) -> Result<SuccessResponse<GetStateRootHashResult>, Error> {
     let params = maybe_block_identifier.map(GetStateRootHashParams::new);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(GET_STATE_ROOT_HASH_METHOD, params)
         .await
 }
@@ -417,7 +417,7 @@ pub async fn get_era_summary(
     maybe_block_identifier: Option<BlockIdentifier>,
 ) -> Result<SuccessResponse<GetEraSummaryResult>, Error> {
     let params = maybe_block_identifier.map(GetEraSummaryParams::new);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(GET_ERA_SUMMARY_METHOD, params)
         .await
 }
@@ -445,7 +445,7 @@ pub async fn query_global_state(
     path: Vec<String>,
 ) -> Result<SuccessResponse<QueryGlobalStateResult>, Error> {
     let params = QueryGlobalStateParams::new(global_state_identifier, key, path);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(QUERY_GLOBAL_STATE_METHOD, Some(params))
         .await
 }
@@ -463,7 +463,7 @@ pub async fn query_balance(
     purse_identifier: PurseIdentifier,
 ) -> Result<SuccessResponse<QueryBalanceResult>, Error> {
     let params = QueryBalanceParams::new(maybe_global_state_identifier, purse_identifier);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(QUERY_BALANCE_METHOD, Some(params))
         .await
 }
@@ -481,7 +481,7 @@ pub async fn query_balance_details(
     purse_identifier: PurseIdentifier,
 ) -> Result<SuccessResponse<QueryBalanceDetailsResult>, Error> {
     let params = QueryBalanceDetailsParams::new(maybe_global_state_identifier, purse_identifier);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(QUERY_BALANCE_DETAILS_METHOD, Some(params))
         .await
 }
@@ -499,7 +499,7 @@ pub async fn get_dictionary_item(
     dictionary_item_identifier: DictionaryItemIdentifier,
 ) -> Result<SuccessResponse<GetDictionaryItemResult>, Error> {
     let params = GetDictionaryItemParams::new(state_root_hash, dictionary_item_identifier);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(GET_DICTIONARY_ITEM_METHOD, Some(params))
         .await
 }
@@ -517,7 +517,7 @@ pub async fn get_balance(
     purse: URef,
 ) -> Result<SuccessResponse<GetBalanceResult>, Error> {
     let params = GetBalanceParams::new(state_root_hash, purse);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(GET_BALANCE_METHOD, Some(params))
         .await
 }
@@ -535,7 +535,7 @@ pub async fn get_account(
     account_identifier: AccountIdentifier,
 ) -> Result<SuccessResponse<GetAccountResult>, Error> {
     let params = GetAccountParams::new(account_identifier, maybe_block_identifier);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(GET_ACCOUNT_METHOD, Some(params))
         .await
 }
@@ -553,7 +553,7 @@ pub async fn get_entity(
     entity_identifier: EntityIdentifier,
 ) -> Result<SuccessResponse<GetAddressableEntityResult>, Error> {
     let params = GetAddressableEntityParams::new(entity_identifier, maybe_block_identifier);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(GET_ENTITY_METHOD, Some(params))
         .await
 }
@@ -572,7 +572,7 @@ pub async fn get_reward(
     delegator: Option<PublicKey>,
 ) -> Result<SuccessResponse<GetRewardResult>, Error> {
     let params = GetRewardParams::new(maybe_era_identifier, validator, delegator);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(GET_REWARD_METHOD, Some(params))
         .await
 }
@@ -589,7 +589,7 @@ pub async fn get_auction_info(
     maybe_block_identifier: Option<BlockIdentifier>,
 ) -> Result<SuccessResponse<GetAuctionInfoResult>, Error> {
     let params = maybe_block_identifier.map(GetAuctionInfoParams::new);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(GET_AUCTION_INFO_METHOD, params)
         .await
 }
@@ -604,7 +604,7 @@ pub async fn get_validator_changes(
     node_address: &str,
     verbosity: Verbosity,
 ) -> Result<SuccessResponse<GetValidatorChangesResult>, Error> {
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request::<(), _>(GET_VALIDATOR_CHANGES_METHOD, None)
         .await
 }
@@ -619,7 +619,7 @@ pub async fn get_peers(
     node_address: &str,
     verbosity: Verbosity,
 ) -> Result<SuccessResponse<GetPeersResult>, Error> {
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request::<(), _>(GET_PEERS_METHOD, None)
         .await
 }
@@ -634,7 +634,7 @@ pub async fn get_node_status(
     node_address: &str,
     verbosity: Verbosity,
 ) -> Result<SuccessResponse<GetNodeStatusResult>, Error> {
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request::<(), _>(GET_NODE_STATUS_METHOD, None)
         .await
 }
@@ -649,7 +649,7 @@ pub async fn get_chainspec(
     node_address: &str,
     verbosity: Verbosity,
 ) -> Result<SuccessResponse<GetChainspecResult>, Error> {
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request::<(), _>(GET_CHAINSPEC_METHOD, None)
         .await
 }
@@ -665,7 +665,7 @@ pub async fn list_rpcs(
     node_address: &str,
     verbosity: Verbosity,
 ) -> Result<SuccessResponse<ListRpcsResult>, Error> {
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request::<(), _>(LIST_RPCS_METHOD, None)
         .await
 }
@@ -761,7 +761,7 @@ pub async fn get_era_info(
     maybe_block_identifier: Option<BlockIdentifier>,
 ) -> Result<SuccessResponse<GetEraInfoResult>, Error> {
     let params = maybe_block_identifier.map(GetEraInfoParams::new);
-    JsonRpcCall::new(rpc_id, node_address, verbosity)
+    JsonRpcCall::new(rpc_id, node_address, verbosity)?
         .send_request(GET_ERA_INFO_METHOD, params)
         .await
 }

src/main.rs

@@ -58,7 +58,9 @@ use keygen::Keygen;
 use list_rpcs::ListRpcs;
 use query_balance::QueryBalance;
 use query_global_state::QueryGlobalState;
-use transaction::{MakeTransaction, PutTransaction, SendTransaction, SignTransaction};
+use transaction::{
+    ListTransactions, MakeTransaction, PutTransaction, SendTransaction, SignTransaction,
+};
 use verify_contract::VerifyContract;
 
 const APP_NAME: &str = "Casper client";
@@ -95,6 +97,7 @@ enum DisplayOrder {
     GetBlock,
     GetBlockTransfers,
     ListDeploys,
+    ListTransactions,
     GetStateRootHash,
     GetEraSummary,
     GetEraInfo,
@@ -145,6 +148,9 @@ fn cli() -> Command {
             DisplayOrder::GetBlockTransfers as usize,
         ))
         .subcommand(ListDeploys::build(DisplayOrder::ListDeploys as usize))
+        .subcommand(ListTransactions::build(
+            DisplayOrder::ListTransactions as usize,
+        ))
         .subcommand(GetStateRootHash::build(
             DisplayOrder::GetStateRootHash as usize,
         ))
@@ -205,6 +211,7 @@ async fn main() {
         GetBlock::NAME => GetBlock::run(matches).await,
         GetBlockTransfers::NAME => GetBlockTransfers::run(matches).await,
         ListDeploys::NAME => ListDeploys::run(matches).await,
+        ListTransactions::NAME => ListTransactions::run(matches).await,
         GetStateRootHash::NAME => GetStateRootHash::run(matches).await,
         GetEraSummary::NAME => GetEraSummary::run(matches).await,
         GetEraInfo::NAME => GetEraInfo::run(matches).await,

src/transaction.rs

@@ -1,11 +1,13 @@
 mod creation_common;
 mod get;
+mod list;
 mod make;
 mod put;
 mod send;
 mod sign;
 
 pub use get::GetTransaction;
+pub use list::ListTransactions;
 pub use make::MakeTransaction;
 pub use put::PutTransaction;
 pub use send::SendTransaction;