From 81191742c6e230c21522aca4f93f3a085faf73b8 Mon Sep 17 00:00:00 2001
From: Vladislav Markushin <negigic@gmail.com>
Date: Tue, 19 Dec 2023 14:08:42 -0300
Subject: [PATCH] Primitive packet trace
Allows to check the current status of the packet
---
Cargo.lock | 1 +
contracts/pallet-ibc/rpc/Cargo.toml | 1 +
contracts/pallet-ibc/rpc/src/lib.rs | 8 ++
hyperspace/core/src/command.rs | 126 ++++++++++++++++++++++++++--
hyperspace/cosmos/src/client.rs | 8 +-
hyperspace/src/main.rs | 5 ++
6 files changed, 140 insertions(+), 9 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
index e4cbdedcf..0eeb254de 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -4994,6 +4994,7 @@ name = "ibc-rpc"
version = "0.1.0"
dependencies = [
"frame-system",
+ "hex",
"ibc",
"ibc-derive",
"ibc-primitives 0.1.0",
diff --git a/contracts/pallet-ibc/rpc/Cargo.toml b/contracts/pallet-ibc/rpc/Cargo.toml
index 6eb4d9314..8e5a2c606 100644
--- a/contracts/pallet-ibc/rpc/Cargo.toml
+++ b/contracts/pallet-ibc/rpc/Cargo.toml
@@ -27,6 +27,7 @@ sp-core = { git = "https://github.com/paritytech/substrate", branch = "polkadot-
sp-runtime = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.43" }
sp-trie = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.43" }
tendermint-proto = { git = "https://github.com/informalsystems/tendermint-rs", rev = "e81f7bf23d63ffbcd242381d1ce5e35da3515ff1", default-features = false }
+hex = "0.4.3"
[dependencies.ibc]
path = "../../../ibc/modules"
diff --git a/contracts/pallet-ibc/rpc/src/lib.rs b/contracts/pallet-ibc/rpc/src/lib.rs
index 81ba81caa..3dc90ede3 100644
--- a/contracts/pallet-ibc/rpc/src/lib.rs
+++ b/contracts/pallet-ibc/rpc/src/lib.rs
@@ -136,6 +136,14 @@ pub struct PacketInfo {
pub ack: Option<Vec<u8>>,
}
+impl Display for PacketInfo {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ write!(f, "PacketInfo {{ height: {}, seq: {}, src_chan: {}/{}, dst_chan: {}/{}, data: {}, timeout_height: {}-{}, timeout_timestamp: {}, ack: {} }}",
+ self.height.unwrap_or(0), self.sequence, self.source_port, self.source_channel, self.destination_port, self.destination_channel,
+ String::from_utf8(self.data.clone()).unwrap_or_else(|_| hex::encode(&self.data)), self.timeout_height.revision_number, self.timeout_height.revision_height, self.timeout_timestamp, self.ack.clone().map(|ack| String::from_utf8(ack.clone()).unwrap_or_else(|_| hex::encode(&ack))).unwrap_or_default())
+ }
+}
+
impl TryFrom<RawPacketInfo> for PacketInfo {
type Error = ();
diff --git a/hyperspace/core/src/command.rs b/hyperspace/core/src/command.rs
index cea44bfcc..98f209ec8 100644
--- a/hyperspace/core/src/command.rs
+++ b/hyperspace/core/src/command.rs
@@ -13,14 +13,18 @@
// limitations under the License.
use crate::{
- chain::{AnyConfig, Config, CoreConfig},
+ chain::{AnyChain, AnyConfig, Config, CoreConfig},
fish, relay, Mode,
};
use anyhow::{anyhow, Result};
use clap::{Args, Parser};
-use ibc::core::{ics04_channel::channel::Order, ics24_host::identifier::PortId};
+use ibc::core::{
+ ics04_channel::channel::{ChannelEnd, Order},
+ ics24_host::identifier::PortId,
+};
use metrics::{data::Metrics, handler::MetricsHandler, init_prometheus};
use primitives::{
+ error::Error,
utils::{create_channel, create_clients, create_connection},
Chain, IbcProvider,
};
@@ -52,9 +56,9 @@ pub enum Subcommand {
#[clap(name = "create-channel", about = "Creates a channel on the specified port")]
CreateChannel(Cmd),
#[clap(name = "query", about = "Query commands")]
- Client {
+ Query {
#[command(subcommand)]
- client: QueryCmd,
+ query: QueryCmd,
#[command(flatten)]
cmd: Cmd,
},
@@ -126,7 +130,7 @@ impl UploadWasmCmd {
}
impl Cmd {
- async fn parse_config(&self) -> Result<Config> {
+ pub async fn parse_config(&self) -> Result<Config> {
use tokio::fs::read_to_string;
let path_a: PathBuf = self.config_a.parse()?;
let path_b: PathBuf = self.config_b.parse()?;
@@ -289,12 +293,124 @@ pub enum QueryCmd {
Packets(QueryPacketsCmd),
}
+impl QueryCmd {
+ pub async fn run(&self, config: Config) -> anyhow::Result<()> {
+ let chain_a = config.chain_a.into_client().await?;
+ let chain_b = config.chain_b.into_client().await?;
+
+ match self {
+ QueryCmd::Packets(query) => query.run(chain_a, chain_b).await,
+ }
+ }
+}
+
#[derive(Debug, Clone, clap::Subcommand)]
pub enum QueryPacketsCmd {
/// Trace packets
Trace(TracePacketsCmd),
}
+impl QueryPacketsCmd {
+ pub(crate) async fn run(&self, chain_a: AnyChain, chain_b: AnyChain) -> anyhow::Result<()> {
+ let name_a = chain_a.name();
+ let name_b = chain_b.name();
+ let (height_a, _) = chain_a.latest_height_and_timestamp().await?;
+ let (_height_b, _) = chain_b.latest_height_and_timestamp().await?;
+
+ match self {
+ QueryPacketsCmd::Trace(cmd) => {
+ let sequence = cmd.sequence;
+ let set = chain_a.channel_whitelist();
+ if set.is_empty() {
+ println!("No channels found on {name_a}");
+ return Ok(())
+ }
+ for (channel_id, port_id) in set {
+ let channel_response =
+ chain_a.query_channel_end(height_a, channel_id, port_id.clone()).await?;
+ let channel_end =
+ ChannelEnd::try_from(channel_response.channel.ok_or_else(|| {
+ Error::Custom("ChannelEnd not could not be decoded".to_string())
+ })?)
+ .map_err(|e| Error::Custom(e.to_string()))?;
+ let counterparty_channel_id =
+ channel_end.counterparty().channel_id.ok_or_else(|| {
+ Error::Custom("Expected counterparty channel id".to_string())
+ })?;
+ let counterparty_port_id = channel_end.counterparty().port_id.clone();
+
+ let maybe_received = chain_b
+ .query_received_packets(
+ counterparty_channel_id.clone(),
+ counterparty_port_id.clone(),
+ vec![sequence],
+ )
+ .await?
+ .pop();
+
+ if let Some(received) = maybe_received {
+ println!("Packet {sequence} was received on {name_b}: {received}");
+ let unreceived_acks = chain_a
+ .query_unreceived_acknowledgements(
+ height_a,
+ channel_id.clone(),
+ port_id.clone(),
+ vec![sequence],
+ )
+ .await?;
+ if unreceived_acks.is_empty() {
+ println!("Packet {sequence} was acknowledged on {name_a}");
+ } else {
+ println!("Packet {sequence} was not acknowledged on {name_a}");
+ }
+ continue;
+ }
+ let sent_packets = chain_a
+ .query_send_packets(channel_id.clone(), port_id.clone(), vec![sequence])
+ .await?;
+ if sent_packets.is_empty() {
+ println!("Packet {sequence} not found");
+ continue;
+ }
+ for packet_info in sent_packets {
+ let seq = packet_info.sequence;
+ println!("Sent packet {} ({name_a}->{name_b}): {}", seq, packet_info);
+ let received = chain_b
+ .query_received_packets(
+ packet_info.destination_channel.parse()?,
+ packet_info.destination_port.parse()?,
+ vec![seq],
+ )
+ .await?
+ .pop();
+ if received.is_none() {
+ println!("Packet {seq} ({name_a}->{name_b}) was not received");
+ continue;
+ }
+
+ println!("Received packet {seq} ({name_a}->{name_b}) {received:?}");
+
+ let ack = chain_a
+ .query_unreceived_acknowledgements(
+ height_a,
+ channel_id.clone(),
+ port_id.clone(),
+ vec![seq],
+ )
+ .await?;
+ if ack.is_empty() {
+ println!("Packet {seq} ({name_a}->{name_b}) was acknowledged");
+ } else {
+ println!("Packet {seq} ({name_a}->{name_b}) was not acknowledged");
+ }
+ }
+ }
+ Ok(())
+ },
+ }
+ }
+}
+
#[derive(Debug, Clone, Args)]
pub struct TracePacketsCmd {
pub sequence: u64,
diff --git a/hyperspace/cosmos/src/client.rs b/hyperspace/cosmos/src/client.rs
index c49c7be68..53b4fcbfa 100644
--- a/hyperspace/cosmos/src/client.rs
+++ b/hyperspace/cosmos/src/client.rs
@@ -253,15 +253,15 @@ where
pub async fn new(config: CosmosClientConfig) -> Result<Self, Error> {
let (rpc_client, rpc_driver) = WebSocketClient::new(config.websocket_url.clone())
.await
- .map_err(|e| Error::RpcError(format!("{:?}", e)))?;
+ .map_err(|e| Error::RpcError(format!("failed to connect to WS: {:?}", e)))?;
let rpc_http_client = HttpClient::new(config.rpc_url.clone())
- .map_err(|e| Error::RpcError(format!("{:?}", e)))?;
+ .map_err(|e| Error::RpcError(format!("failed to connect to RPC: {:?}", e)))?;
let ws_driver_jh = tokio::spawn(rpc_driver.run());
let grpc_client = tonic::transport::Endpoint::new(config.grpc_url.to_string())
- .map_err(|e| Error::RpcError(format!("{:?}", e)))?
+ .map_err(|e| Error::RpcError(format!("failed to connect to GRPC: {:?}", e)))?
.connect()
.await
- .map_err(|e| Error::RpcError(format!("{:?}", e)))?;
+ .map_err(|e| Error::RpcError(format!("failed to connect to GRPC: {:?}", e)))?;
let chain_id = ChainId::from(config.chain_id);
let light_client =
diff --git a/hyperspace/src/main.rs b/hyperspace/src/main.rs
index e09b143e8..2e8b459dd 100644
--- a/hyperspace/src/main.rs
+++ b/hyperspace/src/main.rs
@@ -42,5 +42,10 @@ async fn main() -> Result<()> {
cmd.save_config(&new_config).await
},
Subcommand::Fish(cmd) => cmd.fish().await,
+ Subcommand::Query { cmd, query } => {
+ let config = cmd.parse_config().await?;
+ query.run(config).await?;
+ Ok(())
+ },
}
}