Feat/add rpc header arg

FULL_HELP_DOCS.md

@@ -117,6 +117,7 @@ Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id a
 
 * `--asset <ASSET>` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5"
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--source-account <SOURCE_ACCOUNT>` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…")
@@ -136,6 +137,7 @@ Deploy builtin Soroban Asset Contract
 
 * `--asset <ASSET>` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5"
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--source-account <SOURCE_ACCOUNT>` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…")
@@ -182,6 +184,7 @@ Remove contract alias
 * `--global` — Use global config
 * `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 
@@ -202,6 +205,7 @@ Add contract alias
 * `--global` — Use global config
 * `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--overwrite` — Overwrite the contract alias if it already exists
@@ -224,6 +228,7 @@ Show the contract id associated with a given alias
 * `--global` — Use global config
 * `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 
@@ -295,6 +300,7 @@ Generate a TypeScript / JavaScript package
 * `--global` — Use global config
 * `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 
@@ -361,6 +367,7 @@ If no keys are specified the contract itself is extended.
     Temporary
 
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--source-account <SOURCE_ACCOUNT>` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…")
@@ -389,6 +396,7 @@ Deploy a wasm contract
 * `--wasm-hash <WASM_HASH>` — Hash of the already installed/deployed WASM file
 * `--salt <SALT>` — Custom salt 32-byte salt for the token id
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--source-account <SOURCE_ACCOUNT>` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…")
@@ -422,6 +430,7 @@ Fetch a contract's Wasm binary
 * `--global` — Use global config
 * `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 
@@ -450,6 +459,7 @@ Deploy builtin Soroban Asset Contract
 
 * `--asset <ASSET>` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5"
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--source-account <SOURCE_ACCOUNT>` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…")
@@ -469,6 +479,7 @@ Deploy normal Wasm Contract
 
 * `--salt <SALT>` — ID of the Soroban contract
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--source-account <SOURCE_ACCOUNT>` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…")
@@ -510,6 +521,7 @@ Outputs no data when no data is present in the contract.
 * `--wasm-hash <WASM_HASH>` — Wasm hash to get the data for
 * `--id <CONTRACT_ID>` — Contract id to get the data for
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--global` — Use global config
@@ -549,6 +561,7 @@ Outputs no data when no data is present in the contract.
 * `--wasm-hash <WASM_HASH>` — Wasm hash to get the data for
 * `--id <CONTRACT_ID>` — Contract id to get the data for
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--global` — Use global config
@@ -588,6 +601,7 @@ Outputs no data when no data is present in the contract.
 * `--wasm-hash <WASM_HASH>` — Wasm hash to get the data for
 * `--id <CONTRACT_ID>` — Contract id to get the data for
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--global` — Use global config
@@ -667,6 +681,7 @@ Install a WASM file to the ledger without creating a contract instance
 ###### **Options:**
 
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--source-account <SOURCE_ACCOUNT>` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…")
@@ -706,6 +721,7 @@ stellar contract invoke ... -- --help
 * `--id <CONTRACT_ID>` — Contract ID to invoke
 * `--is-view` — View the result simulating and do not sign and submit transaction. Deprecated use `--send=no`
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--source-account <SOURCE_ACCOUNT>` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…")
@@ -783,6 +799,7 @@ Print the current value of a contract-data ledger entry
     Temporary
 
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--source-account <SOURCE_ACCOUNT>` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…")
@@ -820,6 +837,7 @@ If no keys are specificed the contract itself is restored.
 * `--ledgers-to-extend <LEDGERS_TO_EXTEND>` — Number of ledgers to extend the entry
 * `--ttl-ledger-only` — Only print the new Time To Live ledger
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--source-account <SOURCE_ACCOUNT>` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…")
@@ -880,6 +898,7 @@ Watch the network for contract events
 * `--global` — Use global config
 * `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 
@@ -953,6 +972,7 @@ Fund an identity on a test network
 ###### **Options:**
 
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--hd-path <HD_PATH>` — If identity is a seed phrase use this hd path, default is 0
@@ -981,6 +1001,7 @@ Generate a new identity with a seed phrase, currently 12 words
 * `--hd-path <HD_PATH>` — When generating a secret key, which `hd_path` should be used from the original `seed_phrase`
 * `-d`, `--default-seed` — Generate the default seed phrase. Useful for testing. Equivalent to --seed 0000000000000000
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 
@@ -1065,6 +1086,7 @@ Add a new network
 ###### **Options:**
 
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key header
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--global` — Use global config
 * `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
@@ -1275,6 +1297,7 @@ If a contract is a Stellar asset contract, it includes the asset issuer's accoun
 * `--global` — Use global config
 * `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--archive-url <ARCHIVE_URL>` — Archive URL
@@ -1305,6 +1328,7 @@ Simulate a transaction envelope from stdin
 ###### **Options:**
 
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--source-account <SOURCE_ACCOUNT>` — Account that signs the final transaction. Alias `source`. Can be an identity (--source alice), a secret key (--source SC36…), or a seed phrase (--source "kite urban…")
@@ -1323,6 +1347,7 @@ Calculate the hash of a transaction envelope from stdin
 ###### **Options:**
 
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 
@@ -1340,6 +1365,7 @@ Sign a transaction envelope appending the signature to the envelope
 * `--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
 * `--sign-with-lab` — Sign with <https://lab.stellar.org>
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--global` — Use global config
@@ -1356,6 +1382,7 @@ Send a transaction envelope to the network
 ###### **Options:**
 
 * `--rpc-url <RPC_URL>` — RPC server endpoint
+* `--rpc-header <RPC_HEADER>` — Optional RPC provider api key headers
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `--network <NETWORK>` — Name of network to use from config
 * `--global` — Use global config

cmd/crates/soroban-test/src/lib.rs

@@ -224,6 +224,7 @@ impl TestEnv {
         config::Args {
             network: network::Args {
                 rpc_url: Some(self.rpc_url.clone()),
+                rpc_header: None,
                 network_passphrase: Some(LOCAL_NETWORK_PASSPHRASE.to_string()),
                 network: None,
             },

cmd/soroban-cli/src/commands/contract/deploy/asset.rs

@@ -18,7 +18,8 @@ use crate::{
         NetworkRunnable,
     },
     config::{self, data, network},
-    rpc::{Client, Error as SorobanRpcError},
+    rpc::Error as SorobanRpcError,
+    rpc_client::{Error as RpcClientError, RpcClient},
     utils::{contract_id_hash_from_asset, parsing::parse_asset},
 };
 
@@ -44,6 +45,8 @@ pub enum Error {
     Data(#[from] data::Error),
     #[error(transparent)]
     Network(#[from] network::Error),
+    #[error(transparent)]
+    RpcClient(#[from] RpcClientError),
 }
 
 impl From<Infallible> for Error {
@@ -93,7 +96,7 @@ impl NetworkRunnable for Cmd {
         let asset = parse_asset(&self.asset)?;
 
         let network = config.get_network()?;
-        let client = Client::new(&network.rpc_url)?;
+        let client = RpcClient::new(network.clone())?;
         client
             .verify_network_passphrase(Some(&network.network_passphrase))
             .await?;

cmd/soroban-cli/src/commands/contract/deploy/wasm.rs

@@ -18,7 +18,8 @@ use soroban_env_host::{
 use crate::{
     commands::{contract::install, HEADING_RPC},
     config::{self, data, locator, network},
-    rpc::{self, Client},
+    rpc,
+    rpc_client::{Error as RpcClientError, RpcClient},
     utils, wasm,
 };
 use crate::{
@@ -115,6 +116,8 @@ pub enum Error {
     InvalidAliasFormat { alias: String },
     #[error(transparent)]
     Locator(#[from] locator::Error),
+    #[error(transparent)]
+    RpcClient(#[from] RpcClientError),
 }
 
 impl Cmd {
@@ -208,7 +211,7 @@ impl NetworkRunnable for Cmd {
             None => rand::thread_rng().gen::<[u8; 32]>(),
         };
 
-        let client = Client::new(&network.rpc_url)?;
+        let client = RpcClient::new(network.clone())?;
         client
             .verify_network_passphrase(Some(&network.network_passphrase))
             .await?;

cmd/soroban-cli/src/commands/contract/extend.rs

@@ -15,8 +15,8 @@ use crate::{
         NetworkRunnable,
     },
     config::{self, data, locator, network},
-    key,
-    rpc::{self, Client},
+    key, rpc,
+    rpc_client::{Error as RpcClientError, RpcClient},
     wasm, Pwd,
 };
 
@@ -86,6 +86,8 @@ pub enum Error {
     Network(#[from] network::Error),
     #[error(transparent)]
     Locator(#[from] locator::Error),
+    #[error(transparent)]
+    RpcClient(#[from] RpcClientError),
 }
 
 impl Cmd {
@@ -131,7 +133,7 @@ impl NetworkRunnable for Cmd {
         let network = config.get_network()?;
         tracing::trace!(?network);
         let keys = self.key.parse_keys(&config.locator, &network)?;
-        let client = Client::new(&network.rpc_url)?;
+        let client = RpcClient::new(network.clone())?;
         let key = config.source_account()?;
         let extend_to = self.ledgers_to_extend();
 

cmd/soroban-cli/src/commands/contract/fetch.rs

@@ -7,12 +7,14 @@ use std::{fmt::Debug, fs, io};
 
 use clap::{arg, command, Parser};
 
-use crate::commands::{global, NetworkRunnable};
-use crate::config::{
-    self, locator,
-    network::{self, Network},
+use crate::{
+    commands::{global, NetworkRunnable},
+    config::{
+        self, locator,
+        network::{self, Network},
+    },
+    wasm, Pwd,
 };
-use crate::{wasm, Pwd};
 
 #[derive(Parser, Debug, Default, Clone)]
 #[allow(clippy::struct_excessive_bools)]

cmd/soroban-cli/src/commands/contract/install.rs

@@ -11,13 +11,19 @@ use soroban_env_host::xdr::{
 };
 
 use super::restore;
-use crate::commands::txn_result::{TxnEnvelopeResult, TxnResult};
-use crate::commands::{global, NetworkRunnable};
-use crate::config::{self, data, network};
-use crate::key;
-use crate::print::Print;
-use crate::rpc::{self, Client};
-use crate::{utils, wasm};
+use crate::{
+    commands::{
+        global,
+        txn_result::{TxnEnvelopeResult, TxnResult},
+        NetworkRunnable,
+    },
+    config::{self, data, network},
+    key,
+    print::Print,
+    rpc,
+    rpc_client::{Error as RpcClientError, RpcClient},
+    utils, wasm,
+};
 
 const CONTRACT_META_SDK_KEY: &str = "rssdkver";
 const PUBLIC_NETWORK_PASSPHRASE: &str = "Public Global Stellar Network ; September 2015";
@@ -70,6 +76,8 @@ pub enum Error {
     Network(#[from] network::Error),
     #[error(transparent)]
     Data(#[from] data::Error),
+    #[error(transparent)]
+    RpcClient(#[from] RpcClientError),
 }
 
 impl Cmd {
@@ -100,7 +108,7 @@ impl NetworkRunnable for Cmd {
         let config = config.unwrap_or(&self.config);
         let contract = self.wasm.read()?;
         let network = config.get_network()?;
-        let client = Client::new(&network.rpc_url)?;
+        let client = RpcClient::new(network.clone())?;
         client
             .verify_network_passphrase(Some(&network.network_passphrase))
             .await?;