feat: http headers for Tendermint RPC client (#644)

rnbguy · web-flow · commit fa1018a60ba7 · 2025-09-05T08:37:33.000+02:00
* add rpc_header

* use tm HttpClient over reqwest

* use CanQueryAbci

* use prost::Message derive

* fix string type in proto message

* avoid unwrap

* use struct for header name and value

* fix compile
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -91,7 +91,7 @@ num-bigint                       = { version = "0.4" }
 num-rational                     = { version = "0.4.1" }
 prost                            = { version = "0.13.3" }
 prost-types                      = { version = "0.13.3" }
-reqwest                          = { version = "0.12.9", features = [ "json" ] }
+reqwest                          = { version = "0.11.27", features = [ "json" ] }
 ripemd                           = { version = "0.1.3" }
 serde                            = { version = "1.0.214" }
 serde_derive                     = { version = "1.0.104" }
diff --git a/crates/cli/cli/src/commands/query/channel/ends.rs b/crates/cli/cli/src/commands/query/channel/ends.rs
@@ -97,7 +97,11 @@ impl CommandRunner<HermesApp> for QueryChannelEnds {
         let channel_end_path = format!("channelEnds/ports/{port_id}/channels/{channel_id}");
 
         let channel_end_bytes: Vec<u8> = chain
-            .query_abci(IBC_QUERY_PATH, channel_end_path.as_bytes(), &query_height)
+            .query_abci(
+                IBC_QUERY_PATH,
+                channel_end_path.as_bytes(),
+                Some(&query_height),
+            )
             .await?
             .ok_or_else(|| {
                 HermesApp::raise_error(format!("channel not found: {channel_id}/{port_id}"))
@@ -135,7 +139,11 @@ impl CommandRunner<HermesApp> for QueryChannelEnds {
         let client_state_path = format!("clients/{client_id}/clientState");
 
         let client_state_bytes = chain
-            .query_abci(IBC_QUERY_PATH, client_state_path.as_bytes(), &query_height)
+            .query_abci(
+                IBC_QUERY_PATH,
+                client_state_path.as_bytes(),
+                Some(&query_height),
+            )
             .await?
             .ok_or_else(|| {
                 HermesApp::raise_error(format!("client state not found: {client_id}"))
diff --git a/crates/cosmos/cosmos-chain-components/Cargo.toml b/crates/cosmos/cosmos-chain-components/Cargo.toml
@@ -19,8 +19,8 @@ hermes-cosmos-encoding-components    = { workspace = true }
 hermes-comet-light-client-components = { workspace = true }
 hermes-comet-light-client-context    = { workspace = true }
 
-ibc = { workspace = true }
-ibc-proto = { workspace = true, features = [ "client", "transport" ] }
+ibc = { workspace = true, features = [ "serde" ] }
+ibc-proto = { workspace = true, features = [ "serde", "client", "transport" ] }
 ibc-client-tendermint = { workspace = true }
 tendermint = { workspace = true, features = [ "secp256k1" ] }
 tendermint-light-client = { workspace = true }
diff --git a/crates/cosmos/cosmos-chain-components/src/impls/queries/abci.rs b/crates/cosmos/cosmos-chain-components/src/impls/queries/abci.rs
@@ -41,14 +41,17 @@ where
         chain: &Chain,
         path: &str,
         data: &[u8],
-        height: &Height,
+        height: Option<&Height>,
     ) -> Result<Option<Vec<u8>>, Chain::Error> {
-        let tm_height =
-            TendermintHeight::try_from(height.revision_height()).map_err(Chain::raise_error)?;
+        let tm_height = height
+            .map(|height| {
+                TendermintHeight::try_from(height.revision_height()).map_err(Chain::raise_error)
+            })
+            .transpose()?;
 
         let response = chain
             .rpc_client()
-            .abci_query(Some(path.to_owned()), data, Some(tm_height), false)
+            .abci_query(Some(path.to_owned()), data, tm_height, false)
             .await
             .map_err(Chain::raise_error)?;
 
@@ -119,7 +122,7 @@ where
         chain: &Chain,
         path: &str,
         data: &[u8],
-        height: &Chain::Height,
+        height: Option<&Chain::Height>,
     ) -> Result<Option<Vec<u8>>, Chain::Error> {
         chain
             .perform_with_retry("query_abci", 5, async || {
diff --git a/crates/cosmos/cosmos-chain-components/src/impls/queries/chain_id.rs b/crates/cosmos/cosmos-chain-components/src/impls/queries/chain_id.rs
@@ -45,7 +45,11 @@ where
         let channel_end_path = format!("channelEnds/ports/{port_id}/channels/{channel_id}");
 
         let channel_end_bytes = chain
-            .query_abci(IBC_QUERY_PATH, channel_end_path.as_bytes(), &latest_height)
+            .query_abci(
+                IBC_QUERY_PATH,
+                channel_end_path.as_bytes(),
+                Some(&latest_height),
+            )
             .await?
             .ok_or_else(|| {
                 Chain::raise_error(format!("channel not found: {channel_id}/{port_id}"))
@@ -71,7 +75,11 @@ where
         let connection_path = format!("connections/{connection_id}");
 
         let connnection_end_bytes = chain
-            .query_abci(IBC_QUERY_PATH, connection_path.as_bytes(), &latest_height)
+            .query_abci(
+                IBC_QUERY_PATH,
+                connection_path.as_bytes(),
+                Some(&latest_height),
+            )
             .await?
             .ok_or_else(|| Chain::raise_error(format!("connection not found: {connection_id}")))?;
 
diff --git a/crates/cosmos/cosmos-chain-components/src/impls/queries/channel_end.rs b/crates/cosmos/cosmos-chain-components/src/impls/queries/channel_end.rs
@@ -33,7 +33,7 @@ where
         let channel_end_path = format!("channelEnds/ports/{port_id}/channels/{channel_id}");
 
         let channel_end_bytes = chain
-            .query_abci(IBC_QUERY_PATH, channel_end_path.as_bytes(), height)
+            .query_abci(IBC_QUERY_PATH, channel_end_path.as_bytes(), Some(height))
             .await?
             .ok_or_else(|| {
                 Chain::raise_error(format!("channel not found: {channel_id}/{port_id}"))
diff --git a/crates/cosmos/cosmos-chain-components/src/impls/queries/client_state.rs b/crates/cosmos/cosmos-chain-components/src/impls/queries/client_state.rs
@@ -41,7 +41,7 @@ where
         let client_state_path = format!("clients/{client_id}/clientState");
 
         let client_state_bytes = chain
-            .query_abci(IBC_QUERY_PATH, client_state_path.as_bytes(), height)
+            .query_abci(IBC_QUERY_PATH, client_state_path.as_bytes(), Some(height))
             .await?
             .ok_or_else(|| Chain::raise_error(format!("client state not found: {client_id}")))?;
 
@@ -108,7 +108,11 @@ where
         let data = prost::Message::encode_to_vec(&request);
 
         let response = chain
-            .query_abci("/ibc.core.client.v1.Query/ClientStates", &data, height)
+            .query_abci(
+                "/ibc.core.client.v1.Query/ClientStates",
+                &data,
+                Some(height),
+            )
             .await?
             .ok_or_else(|| Chain::raise_error("failed to query for client states"))?;
 
diff --git a/crates/cosmos/cosmos-chain-components/src/impls/queries/connection_end.rs b/crates/cosmos/cosmos-chain-components/src/impls/queries/connection_end.rs
@@ -33,7 +33,7 @@ where
         let connection_path = format!("connections/{connection_id}");
 
         let connnection_end_bytes = chain
-            .query_abci(IBC_QUERY_PATH, connection_path.as_bytes(), height)
+            .query_abci(IBC_QUERY_PATH, connection_path.as_bytes(), Some(height))
             .await?
             .ok_or_else(|| {
                 Chain::raise_error(format!("connection end not found: {connection_id}"))
diff --git a/crates/cosmos/cosmos-chain-components/src/impls/queries/consensus_state.rs b/crates/cosmos/cosmos-chain-components/src/impls/queries/consensus_state.rs
@@ -41,7 +41,7 @@ where
             .query_abci(
                 IBC_QUERY_PATH,
                 consensus_state_path.as_bytes(),
-                query_height,
+                Some(query_height),
             )
             .await?
             .ok_or_else(|| Chain::raise_error(format!("consensus state not found: {client_id}")))?;
diff --git a/crates/cosmos/cosmos-chain-components/src/impls/queries/eip/feemarket.rs b/crates/cosmos/cosmos-chain-components/src/impls/queries/eip/feemarket.rs
@@ -2,10 +2,9 @@ use core::str::FromStr;
 
 use hermes_prelude::*;
 use prost::DecodeError;
-use subtle_encoding::base64;
 
-use crate::impls::{EipBaseFeeHTTPResult, EipQueryError, GasPriceResponse};
-use crate::traits::{EipQuerier, EipQuerierComponent, HasRpcClient};
+use crate::impls::{GasPriceRequest, GasPriceResponse};
+use crate::traits::{CanQueryAbci, EipQuerier, EipQuerierComponent};
 use crate::types::DynamicGasConfig;
 
 /// Query EIP-1559 base fee using Skip's feemarket endpoint and decode it using
@@ -15,40 +14,35 @@ pub struct QueryEipFromFeeMarket;
 #[cgp_provider(EipQuerierComponent)]
 impl<Chain> EipQuerier<Chain> for QueryEipFromFeeMarket
 where
-    Chain: HasRpcClient
-        + CanRaiseAsyncError<reqwest::Error>
-        + CanRaiseAsyncError<subtle_encoding::Error>
+    Chain: CanQueryAbci
         + CanRaiseAsyncError<DecodeError>
-        + CanRaiseAsyncError<core::num::ParseIntError>
         + CanRaiseAsyncError<core::num::ParseFloatError>
-        + CanRaiseAsyncError<&'static str>
-        + CanRaiseAsyncError<EipQueryError>,
+        + CanRaiseAsyncError<&'static str>,
 {
     async fn query_eip_base_fee(
         chain: &Chain,
         dynamic_gas_config: &DynamicGasConfig,
     ) -> Result<f64, Chain::Error> {
-        let url = format!(
-            "{}abci_query?path=\"/feemarket.feemarket.v1.Query/GasPrices\"&denom={}",
-            chain.rpc_address(),
-            dynamic_gas_config.denom,
-        );
+        let gas_price_request = GasPriceRequest {
+            denom: dynamic_gas_config.denom.clone(),
+        };
 
-        let response = reqwest::get(&url).await.map_err(Chain::raise_error)?;
+        let proto_encoded = prost::Message::encode_to_vec(&gas_price_request);
 
-        if !response.status().is_success() {
-            return Err(Chain::raise_error(EipQueryError { response }));
-        }
-
-        let result: EipBaseFeeHTTPResult = response.json().await.map_err(Chain::raise_error)?;
-
-        let decoded = base64::decode(result.result.response.value).map_err(Chain::raise_error)?;
+        let abci_value = chain
+            .query_abci(
+                "/feemarket.feemarket.v1.Query/GasPrice",
+                &proto_encoded,
+                None,
+            )
+            .await?
+            .ok_or_else(|| Chain::raise_error("GasPrice response is empty"))?;
 
         let gas_price_response: GasPriceResponse =
-            prost::Message::decode(decoded.as_ref()).map_err(Chain::raise_error)?;
+            prost::Message::decode(abci_value.as_ref()).map_err(Chain::raise_error)?;
         let dec_coin = gas_price_response
             .price
-            .ok_or_else(|| Chain::raise_error("missing price in GasPriceRespone"))?;
+            .ok_or_else(|| Chain::raise_error("missing price in GasPriceResponse"))?;
 
         let raw_amount = f64::from_str(&dec_coin.amount).map_err(Chain::raise_error)?;
         let amount = raw_amount / 1000000000000000000.0;
diff --git a/crates/cosmos/cosmos-chain-components/src/impls/queries/eip/osmosis.rs b/crates/cosmos/cosmos-chain-components/src/impls/queries/eip/osmosis.rs
@@ -3,10 +3,8 @@ use core::str::FromStr;
 use hermes_prelude::*;
 use ibc_proto::cosmos::base::v1beta1::DecProto;
 use prost::DecodeError;
-use subtle_encoding::base64;
 
-use crate::impls::{EipBaseFeeHTTPResult, EipQueryError};
-use crate::traits::{EipQuerier, EipQuerierComponent, HasRpcClient};
+use crate::traits::{CanQueryAbci, EipQuerier, EipQuerierComponent};
 use crate::types::DynamicGasConfig;
 
 /// Query EIP-1559 base fee using Osmosis endpoint and decode it using
@@ -16,35 +14,22 @@ pub struct OsmosisQueryEip;
 #[cgp_provider(EipQuerierComponent)]
 impl<Chain> EipQuerier<Chain> for OsmosisQueryEip
 where
-    Chain: HasRpcClient
-        + CanRaiseAsyncError<reqwest::Error>
-        + CanRaiseAsyncError<subtle_encoding::Error>
+    Chain: CanQueryAbci
         + CanRaiseAsyncError<DecodeError>
-        + CanRaiseAsyncError<core::num::ParseIntError>
         + CanRaiseAsyncError<core::num::ParseFloatError>
-        + CanRaiseAsyncError<EipQueryError>,
+        + CanRaiseAsyncError<&'static str>,
 {
     async fn query_eip_base_fee(
         chain: &Chain,
         _dynamic_gas_config: &DynamicGasConfig,
     ) -> Result<f64, Chain::Error> {
-        let url = format!(
-            "{}abci_query?path=\"/osmosis.txfees.v1beta1.Query/GetEipBaseFee\"",
-            chain.rpc_address()
-        );
-
-        let response = reqwest::get(&url).await.map_err(Chain::raise_error)?;
-
-        if !response.status().is_success() {
-            return Err(Chain::raise_error(EipQueryError { response }));
-        }
-
-        let result: EipBaseFeeHTTPResult = response.json().await.map_err(Chain::raise_error)?;
-
-        let decoded = base64::decode(result.result.response.value).map_err(Chain::raise_error)?;
+        let abci_value = chain
+            .query_abci("/osmosis.txfees.v1beta1.Query/GetEipBaseFee", &[], None)
+            .await?
+            .ok_or_else(|| Chain::raise_error("GetEipBaseFee response is empty"))?;
 
         let dec_proto: DecProto =
-            prost::Message::decode(decoded.as_ref()).map_err(Chain::raise_error)?;
+            prost::Message::decode(abci_value.as_ref()).map_err(Chain::raise_error)?;
 
         let raw_amount = f64::from_str(&dec_proto.dec).map_err(Chain::raise_error)?;
         let amount = raw_amount / 1000000000000000000.0;
diff --git a/crates/cosmos/cosmos-chain-components/src/impls/queries/eip/types.rs b/crates/cosmos/cosmos-chain-components/src/impls/queries/eip/types.rs
@@ -1,25 +1,12 @@
 use ibc_proto::cosmos::base::v1beta1::DecCoin;
-use reqwest::Response;
-use serde::Deserialize;
 
-#[derive(Debug)]
-pub struct EipQueryError {
-    pub response: Response,
-}
-
-#[derive(Deserialize)]
-pub struct EipBaseFeeHTTPResult {
-    pub result: EipBaseFeeResult,
-}
-
-#[derive(Deserialize)]
-pub struct EipBaseFeeResult {
-    pub response: EipBaseFeeResponse,
-}
-
-#[derive(Deserialize)]
-pub struct EipBaseFeeResponse {
-    pub value: String,
+/// GasPriceRequest is the request type for the Query/GasPrice RPC method.
+#[allow(clippy::derive_partial_eq_without_eq)]
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct GasPriceRequest {
+    /// denom we are querying gas price in
+    #[prost(string, tag = "1")]
+    pub denom: ::prost::alloc::string::String,
 }
 
 /// GasPriceResponse is the response type for the Query/GasPrice RPC method.
diff --git a/crates/cosmos/cosmos-chain-components/src/impls/types/config.rs b/crates/cosmos/cosmos-chain-components/src/impls/types/config.rs
@@ -14,6 +14,12 @@ pub struct RelayerConfig {
     pub chains: Vec<CosmosChainConfig>,
 }
 
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct HttpHeader {
+    pub name: String,
+    pub value: String,
+}
+
 #[derive(Clone, Debug, Serialize, Deserialize)]
 pub struct CosmosChainConfig {
     pub id: String,
@@ -27,6 +33,7 @@ pub struct CosmosChainConfig {
     pub max_block_time: Duration,
 
     pub rpc_addr: Url,
+    pub rpc_header: Option<Vec<HttpHeader>>,
     pub rpc_timeout: Duration,
     pub address_type: String,
     pub max_msg_num: usize,
diff --git a/crates/cosmos/cosmos-chain-components/src/impls/unbonding_period.rs b/crates/cosmos/cosmos-chain-components/src/impls/unbonding_period.rs
@@ -26,7 +26,7 @@ where
             .query_abci(
                 "/cosmos.staking.v1beta1.Query/Params",
                 &"".to_owned().into_bytes(),
-                &latest_height,
+                Some(&latest_height),
             )
             .await?
             .ok_or_else(|| Chain::raise_error("failed to query for staking params"))?;
diff --git a/crates/cosmos/cosmos-chain-components/src/traits/abci_query.rs b/crates/cosmos/cosmos-chain-components/src/traits/abci_query.rs
@@ -11,7 +11,7 @@ pub trait CanQueryAbci: HasHeightType + HasCommitmentProofType + HasAsyncErrorTy
         &self,
         path: &str,
         data: &[u8],
-        height: &Self::Height,
+        height: Option<&Self::Height>,
     ) -> Result<Option<Vec<u8>>, Self::Error>;
 
     async fn query_abci_with_proofs(
diff --git a/crates/cosmos/cosmos-integration-tests/src/impls/bootstrap/relayer_chain_config.rs b/crates/cosmos/cosmos-integration-tests/src/impls/bootstrap/relayer_chain_config.rs
@@ -122,6 +122,7 @@ where
             id: chain_node_config.chain_id.to_string(),
             rpc_addr: Url::from_str(&format!("http://localhost:{}", chain_node_config.rpc_port))
                 .map_err(Bootstrap::raise_error)?,
+            rpc_header: None,
             grpc_addr: Url::from_str(&format!("http://localhost:{}", chain_node_config.grpc_port))
                 .map_err(Bootstrap::raise_error)?,
             rpc_timeout: Duration::from_secs(10),
diff --git a/crates/cosmos/cosmos-relayer/src/contexts/build.rs b/crates/cosmos/cosmos-relayer/src/contexts/build.rs
@@ -172,7 +172,22 @@ impl CosmosBuilder {
     ) -> Result<CosmosChain, Error> {
         let keys = get_keypair(&chain_config)?;
 
-        let mut rpc_client = HttpClient::new(chain_config.rpc_addr.clone())?;
+        let mut rpc_client = HttpClient::builder(chain_config.rpc_addr.clone().try_into()?)
+            .client(
+                reqwest::Client::builder()
+                    .default_headers(reqwest::header::HeaderMap::from_iter(
+                        chain_config
+                            .rpc_header
+                            .clone()
+                            .into_iter()
+                            .flatten()
+                            .map(|header| Ok((header.name.try_into()?, header.value.try_into()?)))
+                            .collect::<Result<Vec<_>, Error>>()?
+                            .into_iter(),
+                    ))
+                    .build()?,
+            )
+            .build()?;
 
         let compat_mode = if let Some(compat_mode) = &chain_config.compat_mode {
             CompatMode::from_str(compat_mode.as_str()).unwrap()
diff --git a/crates/cosmos/cosmos-relayer/src/impls/error.rs b/crates/cosmos/cosmos-relayer/src/impls/error.rs

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ where`
`41`	`41`	`.query_abci(`
`42`	`42`	`IBC_QUERY_PATH,`
`43`	`43`	`consensus_state_path.as_bytes(),`
`44`		`- query_height,`
	`44`	`+ Some(query_height),`
`45`	`45`	`)`
`46`	`46`	`.await?`
`47`	`47`	`.ok_or_else(\|\| Chain::raise_error(format!("consensus state not found: {client_id}")))?;`