From 9357d666a818cfcbf741313dac7621fd7193e4ab Mon Sep 17 00:00:00 2001 From: Greg Szabo <16846635+greg-szabo@users.noreply.github.com> Date: Thu, 24 Sep 2020 09:03:13 -0400 Subject: [PATCH] Removed TryFromRaw, implemented DomainType where needed (#252) * Removed TryFromRaw, implemented DomainType where needed * Update modules/src/ics03_connection/connection.rs Co-authored-by: Adi Seredinschi Co-authored-by: Adi Seredinschi --- docs/architecture/adr-001-repo.md | 14 +- modules/src/ics02_client/raw.rs | 22 ++- modules/src/ics03_connection/connection.rs | 30 +++- .../ics03_connection/handler/conn_open_ack.rs | 2 +- .../handler/conn_open_confirm.rs | 2 +- .../handler/conn_open_init.rs | 2 +- .../ics03_connection/handler/conn_open_try.rs | 2 +- modules/src/ics03_connection/msgs.rs | 30 ++-- modules/src/ics04_channel/channel.rs | 29 +++- modules/src/ics23_commitment/commitment.rs | 2 +- modules/src/lib.rs | 1 - modules/src/try_from_raw.rs | 21 --- proto/src/domaintype.rs | 139 ------------------ proto/src/error.rs | 37 ----- proto/src/lib.rs | 6 - relayer-cli/src/commands/query/channel.rs | 15 +- relayer-cli/src/commands/query/client.rs | 16 +- relayer-cli/src/commands/query/connection.rs | 8 +- relayer-cli/tests/integration.rs | 69 +++++---- relayer/src/chain.rs | 18 +-- relayer/src/chain/cosmos.rs | 31 +--- 21 files changed, 173 insertions(+), 323 deletions(-) delete mode 100644 modules/src/try_from_raw.rs delete mode 100644 proto/src/domaintype.rs delete mode 100644 proto/src/error.rs diff --git a/docs/architecture/adr-001-repo.md b/docs/architecture/adr-001-repo.md index a53124bd14..1daf4a43ec 100644 --- a/docs/architecture/adr-001-repo.md +++ b/docs/architecture/adr-001-repo.md @@ -124,17 +124,25 @@ name prefixed with "Raw", for example: use ibc_proto::channel::Channel as RawChannel; ``` -For any Raw data type that is defined in `ibc-proto` we implement the `TryFromRaw` trait, which serves as a translation +For any Raw data type that is defined in `ibc-proto` we implement the `DomainType` trait, which serves as a translation & validation layer between the proto ("Raw") types and the domain types. For example, for a `Channel` we do as follows: ```Rust -impl TryFromRaw for ChannelEnd { - type RawType = RawChannel; +impl DomainType for ChannelEnd {} + +impl TryFrom for ChannelEnd { type Error = anomaly::Error; fn try_from(value: RawChannel) -> Result { // Translate, validate each field from RawChannel into a Channel. } +} + +impl From for RawChannel { + fn from(value: ChannelEnd) -> Self { + // Translate Channel into a RawChannel + } +} ``` This issue [#130](https://github.com/informalsystems/ibc-rs/issues/130) is a good starting place for more context diff --git a/modules/src/ics02_client/raw.rs b/modules/src/ics02_client/raw.rs index c62de1abd1..2705e28487 100644 --- a/modules/src/ics02_client/raw.rs +++ b/modules/src/ics02_client/raw.rs @@ -1,7 +1,8 @@ use crate::ics03_connection::error::Kind; use crate::ics24_host::identifier::ConnectionId; -use crate::try_from_raw::TryFromRaw; +use std::convert::TryFrom; use std::str::FromStr; +use tendermint_proto::DomainType; //TODO: This might need to be migrated to ibc-proto crate. But ClientConnections (as array of strings) // might not be part of an official proto file @@ -11,9 +12,14 @@ pub struct RawClientConnections { pub connections: ::std::vec::Vec, } -impl TryFromRaw for Vec { - type RawType = RawClientConnections; +#[derive(Clone, Debug)] +pub struct ConnectionIds(pub Vec); + +impl DomainType for ConnectionIds {} + +impl TryFrom for ConnectionIds { type Error = anomaly::Error; + fn try_from(value: RawClientConnections) -> Result { if !value.connections.is_empty() { let mut connections: Vec = vec![]; @@ -24,9 +30,17 @@ impl TryFromRaw for Vec { Err(_e) => return Err(Kind::IdentifierError.into()), } } - Ok(connections) + Ok(ConnectionIds(connections)) } else { Err(Kind::ConnectionNotFound.into()) } } } + +impl From for RawClientConnections { + fn from(value: ConnectionIds) -> Self { + RawClientConnections { + connections: value.0.iter().map(|v| v.to_string()).collect(), + } + } +} diff --git a/modules/src/ics03_connection/connection.rs b/modules/src/ics03_connection/connection.rs index c3b511beae..1d7ab44518 100644 --- a/modules/src/ics03_connection/connection.rs +++ b/modules/src/ics03_connection/connection.rs @@ -2,12 +2,12 @@ use crate::ics03_connection::error::{Error, Kind}; use crate::ics23_commitment::commitment::CommitmentPrefix; use crate::ics24_host::error::ValidationError; use crate::ics24_host::identifier::{ClientId, ConnectionId}; -use crate::try_from_raw::TryFromRaw; use ibc_proto::ibc::connection::{ ConnectionEnd as RawConnectionEnd, Counterparty as RawCounterparty, }; use serde_derive::{Deserialize, Serialize}; use std::convert::{TryFrom, TryInto}; +use tendermint_proto::DomainType; #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] pub struct ConnectionEnd { @@ -17,8 +17,9 @@ pub struct ConnectionEnd { versions: Vec, } -impl TryFromRaw for ConnectionEnd { - type RawType = RawConnectionEnd; +impl DomainType for ConnectionEnd {} + +impl TryFrom for ConnectionEnd { type Error = anomaly::Error; fn try_from(value: RawConnectionEnd) -> Result { Ok(Self::new( @@ -36,6 +37,17 @@ impl TryFromRaw for ConnectionEnd { } } +impl From for RawConnectionEnd { + fn from(value: ConnectionEnd) -> Self { + RawConnectionEnd { + client_id: value.client_id.to_string(), + versions: value.versions, + state: value.state as i32, + counterparty: Some(RawCounterparty::from(value.counterparty)), + } + } +} + impl ConnectionEnd { pub fn new( state: State, @@ -134,6 +146,18 @@ impl TryFrom for Counterparty { } } +impl From for RawCounterparty { + fn from(value: Counterparty) -> Self { + RawCounterparty { + client_id: value.client_id.as_str().to_string(), + connection_id: value.connection_id.as_str().to_string(), + prefix: Some(ibc_proto::ibc::commitment::MerklePrefix { + key_prefix: value.prefix.0, + }), + } + } +} + impl Counterparty { pub fn new( client_id: ClientId, diff --git a/modules/src/ics03_connection/handler/conn_open_ack.rs b/modules/src/ics03_connection/handler/conn_open_ack.rs index 7ed8222d2e..119431f0ff 100644 --- a/modules/src/ics03_connection/handler/conn_open_ack.rs +++ b/modules/src/ics03_connection/handler/conn_open_ack.rs @@ -95,7 +95,7 @@ mod tests { use crate::ics03_connection::msgs::{ConnectionMsg, MsgConnectionOpenAck}; use crate::ics23_commitment::commitment::CommitmentPrefix; use crate::ics24_host::identifier::ClientId; - use crate::try_from_raw::TryFromRaw; + use std::convert::TryFrom; use std::str::FromStr; #[test] diff --git a/modules/src/ics03_connection/handler/conn_open_confirm.rs b/modules/src/ics03_connection/handler/conn_open_confirm.rs index 90f904b13e..df06ba971b 100644 --- a/modules/src/ics03_connection/handler/conn_open_confirm.rs +++ b/modules/src/ics03_connection/handler/conn_open_confirm.rs @@ -87,7 +87,7 @@ mod tests { use crate::ics03_connection::msgs::{ConnectionMsg, MsgConnectionOpenConfirm}; use crate::ics23_commitment::commitment::CommitmentPrefix; use crate::ics24_host::identifier::ClientId; - use crate::try_from_raw::TryFromRaw; + use std::convert::TryFrom; use std::str::FromStr; #[test] diff --git a/modules/src/ics03_connection/handler/conn_open_init.rs b/modules/src/ics03_connection/handler/conn_open_init.rs index 3a4a838faf..f087cae6db 100644 --- a/modules/src/ics03_connection/handler/conn_open_init.rs +++ b/modules/src/ics03_connection/handler/conn_open_init.rs @@ -57,7 +57,7 @@ mod tests { use crate::ics03_connection::handler::{dispatch, ConnectionResult}; use crate::ics03_connection::msgs::test_util::get_dummy_msg_conn_open_init; use crate::ics03_connection::msgs::{ConnectionMsg, MsgConnectionOpenInit}; - use crate::try_from_raw::TryFromRaw; + use std::convert::TryFrom; #[test] fn conn_open_init_msg_processing() { diff --git a/modules/src/ics03_connection/handler/conn_open_try.rs b/modules/src/ics03_connection/handler/conn_open_try.rs index 05068798cd..f74c042a9a 100644 --- a/modules/src/ics03_connection/handler/conn_open_try.rs +++ b/modules/src/ics03_connection/handler/conn_open_try.rs @@ -106,7 +106,7 @@ mod tests { use crate::ics03_connection::handler::{dispatch, ConnectionResult}; use crate::ics03_connection::msgs::test_util::get_dummy_msg_conn_open_try; use crate::ics03_connection::msgs::{ConnectionMsg, MsgConnectionOpenTry}; - use crate::try_from_raw::TryFromRaw; + use std::convert::TryFrom; #[test] fn conn_open_try_msg_processing() { diff --git a/modules/src/ics03_connection/msgs.rs b/modules/src/ics03_connection/msgs.rs index 64fd97d8e3..d1c5b21f22 100644 --- a/modules/src/ics03_connection/msgs.rs +++ b/modules/src/ics03_connection/msgs.rs @@ -20,7 +20,6 @@ use crate::ics03_connection::connection::{validate_version, validate_versions, C use crate::ics03_connection::error::{Error, Kind}; use crate::ics24_host::identifier::{ClientId, ConnectionId}; use crate::proofs::{ConsensusProof, Proofs}; -use crate::try_from_raw::TryFromRaw; use crate::tx_msg::Msg; use ibc_proto::ibc::connection::MsgConnectionOpenAck as RawMsgConnectionOpenAck; @@ -34,6 +33,7 @@ use tendermint::block::Height; use serde_derive::{Deserialize, Serialize}; use std::convert::{TryFrom, TryInto}; use std::str::{from_utf8, FromStr}; +use tendermint_proto::DomainType; /// Message type for the `MsgConnectionOpenInit` message. pub const TYPE_MSG_CONNECTION_OPEN_INIT: &str = "connection_open_init"; @@ -84,9 +84,11 @@ impl MsgConnectionOpenInit { } } -impl TryFromRaw for MsgConnectionOpenInit { - type RawType = RawMsgConnectionOpenInit; +impl DomainType for MsgConnectionOpenInit {} + +impl TryFrom for MsgConnectionOpenInit { type Error = anomaly::Error; + fn try_from(msg: RawMsgConnectionOpenInit) -> Result { Ok(Self { connection_id: msg @@ -109,6 +111,17 @@ impl TryFromRaw for MsgConnectionOpenInit { } } +impl From for RawMsgConnectionOpenInit { + fn from(value: MsgConnectionOpenInit) -> Self { + RawMsgConnectionOpenInit { + client_id: value.client_id.as_str().to_string(), + connection_id: value.connection_id.as_str().to_string(), + counterparty: Some(value.counterparty.into()), + signer: value.signer.as_bytes().to_vec(), + } + } +} + impl Msg for MsgConnectionOpenInit { type ValidationError = Error; @@ -217,8 +230,7 @@ impl Msg for MsgConnectionOpenTry { } } -impl TryFromRaw for MsgConnectionOpenTry { - type RawType = RawMsgConnectionOpenTry; +impl TryFrom for MsgConnectionOpenTry { type Error = Error; fn try_from(msg: RawMsgConnectionOpenTry) -> Result { @@ -340,8 +352,7 @@ impl Msg for MsgConnectionOpenAck { } } -impl TryFromRaw for MsgConnectionOpenAck { - type RawType = RawMsgConnectionOpenAck; +impl TryFrom for MsgConnectionOpenAck { type Error = anomaly::Error; fn try_from(msg: RawMsgConnectionOpenAck) -> Result { @@ -433,8 +444,7 @@ impl Msg for MsgConnectionOpenConfirm { } } -impl TryFromRaw for MsgConnectionOpenConfirm { - type RawType = RawMsgConnectionOpenConfirm; +impl TryFrom for MsgConnectionOpenConfirm { type Error = anomaly::Error; fn try_from(msg: RawMsgConnectionOpenConfirm) -> Result { @@ -569,13 +579,13 @@ mod tests { use crate::ics03_connection::msgs::{ MsgConnectionOpenAck, MsgConnectionOpenConfirm, MsgConnectionOpenTry, }; - use crate::try_from_raw::TryFromRaw; use ibc_proto::ibc::client::Height; use ibc_proto::ibc::connection::Counterparty as RawCounterparty; use ibc_proto::ibc::connection::MsgConnectionOpenAck as RawMsgConnectionOpenAck; use ibc_proto::ibc::connection::MsgConnectionOpenConfirm as RawMsgConnectionOpenConfirm; use ibc_proto::ibc::connection::MsgConnectionOpenInit as RawMsgConnectionOpenInit; use ibc_proto::ibc::connection::MsgConnectionOpenTry as RawMsgConnectionOpenTry; + use std::convert::TryFrom; #[test] fn parse_connection_open_init_msg() { diff --git a/modules/src/ics04_channel/channel.rs b/modules/src/ics04_channel/channel.rs index d7fb41a016..efb1c6975a 100644 --- a/modules/src/ics04_channel/channel.rs +++ b/modules/src/ics04_channel/channel.rs @@ -1,12 +1,13 @@ use crate::ics04_channel::error::{self, Error, Kind}; use crate::ics24_host::identifier::{ChannelId, ConnectionId, PortId}; -use crate::try_from_raw::TryFromRaw; use ibc_proto::ibc::channel::Channel as RawChannel; use anomaly::fail; use serde_derive::{Deserialize, Serialize}; +use std::convert::TryFrom; use std::str::FromStr; +use tendermint_proto::DomainType; #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] pub struct ChannelEnd { @@ -17,8 +18,9 @@ pub struct ChannelEnd { version: String, } -impl TryFromRaw for ChannelEnd { - type RawType = RawChannel; +impl DomainType for ChannelEnd {} + +impl TryFrom for ChannelEnd { type Error = anomaly::Error; fn try_from(value: RawChannel) -> Result { @@ -60,6 +62,25 @@ impl TryFromRaw for ChannelEnd { } } +impl From for RawChannel { + fn from(value: ChannelEnd) -> Self { + RawChannel { + state: value.state.clone() as i32, + ordering: value.ordering.clone() as i32, + counterparty: Some(ibc_proto::ibc::channel::Counterparty { + port_id: value.counterparty().port_id.to_string(), + channel_id: value.counterparty().channel_id.to_string(), + }), + connection_hops: value + .connection_hops + .iter() + .map(|v| v.as_str().to_string()) + .collect(), + version: value.version, + } + } +} + impl ChannelEnd { /// Creates a new ChannelEnd in state Uninitialized and other fields parametrized. pub fn new( @@ -226,10 +247,10 @@ mod tests { use std::str::FromStr; use crate::ics04_channel::channel::ChannelEnd; - use crate::try_from_raw::TryFromRaw; use ibc_proto::ibc::channel::Channel as RawChannel; use ibc_proto::ibc::channel::Counterparty as RawCounterparty; + use std::convert::TryFrom; #[test] fn channel_end_try_from_raw() { diff --git a/modules/src/ics23_commitment/commitment.rs b/modules/src/ics23_commitment/commitment.rs index 6b2112a4f2..ea32a4e758 100644 --- a/modules/src/ics23_commitment/commitment.rs +++ b/modules/src/ics23_commitment/commitment.rs @@ -36,7 +36,7 @@ impl From> for CommitmentProof { } #[derive(Clone, PartialEq, Serialize, Deserialize)] -pub struct CommitmentPrefix(Vec); +pub struct CommitmentPrefix(pub Vec); // Todo: decent getter or DomainType trait implementation impl CommitmentPrefix { pub fn is_empty(&self) -> bool { diff --git a/modules/src/lib.rs b/modules/src/lib.rs index 4bd759640b..ac6f41043d 100644 --- a/modules/src/lib.rs +++ b/modules/src/lib.rs @@ -32,7 +32,6 @@ pub mod ics24_host; pub mod keys; pub mod macros; pub mod proofs; -pub mod try_from_raw; pub mod tx_msg; #[cfg(test)] diff --git a/modules/src/try_from_raw.rs b/modules/src/try_from_raw.rs deleted file mode 100644 index d8901091dd..0000000000 --- a/modules/src/try_from_raw.rs +++ /dev/null @@ -1,21 +0,0 @@ -//! TryFromRaw trait for automatic protobuf deserialization - currently implemented with prost -//! This is similar to the pattern of using the #[serde(from="RawType") derive for automatic -//! conversion with the TryFrom::try_from(value: RawType) trait for validation. -//! Only serde does this for JSON and here we need to do it for protobuf. -use prost::Message; -use std::convert::Into; -use std::default::Default; -use std::error::Error as StdError; -use std::marker::Sized; - -/// TryFromRaw trait needs to implement a try_from() function and an Error type for the return of that function. -pub trait TryFromRaw: Sized { - /// RawType defines the prost-compiled protobuf-defined Rust struct - type RawType: Message + Default; - - /// Error defines the error type returned from validation. - type Error: Into>; - - /// try_from function will validate the incoming RawType and convert it to our domain type - fn try_from(value: Self::RawType) -> Result; -} diff --git a/proto/src/domaintype.rs b/proto/src/domaintype.rs deleted file mode 100644 index 576d474a6c..0000000000 --- a/proto/src/domaintype.rs +++ /dev/null @@ -1,139 +0,0 @@ -//! DomainType trait -//! -//! The DomainType trait allows separation of the data sent on the wire (currently encoded using -//! protobuf) from the structures used in Rust. The structures used to encode/decode from/to the -//! wire are called "Raw" types (they mirror the definitions in the specifications) and the Rust -//! types we use internally are called the "Domain" types. These Domain types can implement -//! additional checks and conversions to consume the incoming data easier for a Rust developer. -//! -//! The benefits include decoding the wire into a struct that is inherently valid as well as hiding -//! the encoding and decoding details from the developer. This latter is important if/when we decide -//! to exchange the underlying Prost library with something else. (Another protobuf implementation -//! or a completely different encoding.) Encoding is not the core product of IBC it's a -//! necessary dependency. -//! -//! -//! Decode: bytestream -> Raw -> Domain -//! The `decode` function takes two steps to decode from a bytestream to a DomainType: -//! -//! 1. Decode the bytestream into a Raw type using the Prost library, -//! 2. Transform that Raw type into a Domain type using the TryFrom trait of the DomainType. -//! -//! -//! Encode: Domain -> Raw -> bytestream -//! The `encode` function takes two steps to encode a DomainType into a bytestream: -//! -//! 1. Transform the Domain type into a Raw type using the From trait of the DomainType, -//! 2. Encode the Raw type into a bytestream using the Prost library. -//! -//! -//! Note that in the case of encode, the transformation to Raw type is infallible: -//! Rust structs should always be ready to be encoded to the wire. -//! -//! Note that the Prost library and the TryFrom method have their own set of errors. These are -//! merged into a custom Error type defined in this crate for easier handling. -//! -//! Requirements: -//! * The DomainType trait requires the struct to implement the Clone trait. -//! * Any RawType structure implements the prost::Message trait. (protobuf struct) -//! * The DomainType trait requires that the TryFrom implemented on the structure has an -//! error type that implements Into. (The current implementations with anomaly are -//! fine.) -//! -//! How to implement a DomainType struct: -//! 1. Implement your struct based on your expectations for the developer -//! 2. Add `impl DomainType for MyDomainType {}` blanket implementation of the trait -//! 4. Implement the `TryFrom for MyDomainType` trait -//! 5. Implement the `From for MyRawType` trait - -use crate::{Error, Kind}; -use anomaly::BoxError; -use bytes::{Buf, BufMut}; -use prost::{encoding::encoded_len_varint, Message}; -use std::convert::{TryFrom, TryInto}; - -/// DomainType trait allows protobuf encoding and decoding for domain types -pub trait DomainType + Default> -where - Self: Sized + Clone + TryFrom, - >::Error: Into, -{ - /// Encodes the DomainType into a buffer. - /// - /// This function replaces the Prost::Message encode() function for DomainTypes. - fn encode(&self, buf: &mut B) -> Result<(), Error> { - T::from(self.clone()) - .encode(buf) - .map_err(|e| Kind::EncodeMessage.context(e).into()) - } - - /// Encodes the DomainType with a length-delimiter to a buffer. - /// - /// An error will be returned if the buffer does not have sufficient capacity. - /// - /// This function replaces the Prost::Message encode_length_delimited() function for - /// DomainTypes. - fn encode_length_delimited(&self, buf: &mut B) -> Result<(), Error> { - T::from(self.clone()) - .encode_length_delimited(buf) - .map_err(|e| Kind::EncodeMessage.context(e).into()) - } - - /// Decodes an instance of the message from a buffer and then converts it into DomainType. - /// - /// The entire buffer will be consumed. - /// - /// This function replaces the Prost::Message decode() function for DomainTypes. - fn decode(buf: B) -> Result { - T::decode(buf).map_or_else( - |e| Err(Kind::DecodeMessage.context(e).into()), - |t| Self::try_from(t).map_err(|e| Kind::TryIntoDomainType.context(e).into()), - ) - } - - /// Decodes a length-delimited instance of the message from the buffer. - /// - /// The entire buffer will be consumed. - /// - /// This function replaces the Prost::Message decode_length_delimited() function for - /// DomainTypes. - fn decode_length_delimited(buf: B) -> Result { - T::decode_length_delimited(buf).map_or_else( - |e| Err(Kind::DecodeMessage.context(e).into()), - |t| Self::try_from(t).map_err(|e| Kind::TryIntoDomainType.context(e).into()), - ) - } - - /// Returns the encoded length of the message without a length delimiter. - /// - /// This function replaces the Prost::Message encoded_len() function for DomainTypes. - fn encoded_len(&self) -> usize { - T::from(self.clone()).encoded_len() - } - - /// Encodes the DomainType into a protobuf-encoded Vec - fn encode_vec(&self) -> Result, Error> { - let mut wire = Vec::with_capacity(self.encoded_len()); - self.encode(&mut wire).map(|_| wire) - } - - /// Decodes a protobuf-encoded instance of the message from a Vec and then converts it into - /// DomainType. - fn decode_vec(v: &[u8]) -> Result { - Self::decode(v) - } - - /// Encodes the DomainType with a length-delimiter to a Vec protobuf-encoded message. - fn encode_length_delimited_vec(&self) -> Result, Error> { - let len = self.encoded_len(); - let lenu64 = len.try_into().map_err(|e| Kind::EncodeMessage.context(e))?; - let mut wire = Vec::with_capacity(len + encoded_len_varint(lenu64)); - self.encode_length_delimited(&mut wire).map(|_| wire) - } - - /// Decodes a protobuf-encoded instance of the message with a length-delimiter from a Vec - /// and then converts it into DomainType. - fn decode_length_delimited_vec(v: &[u8]) -> Result { - Self::decode_length_delimited(v) - } -} diff --git a/proto/src/error.rs b/proto/src/error.rs deleted file mode 100644 index 4b6da606d4..0000000000 --- a/proto/src/error.rs +++ /dev/null @@ -1,37 +0,0 @@ -//! This module defines the various errors that be raised during DomainType conversions. - -use anomaly::{BoxError, Context}; -use thiserror::Error; - -/// An error that can be raised by the DomainType conversions. -pub type Error = anomaly::Error; - -/// Various kinds of errors that can be raised. -#[derive(Clone, Debug, Error)] -pub enum Kind { - /// TryFrom Prost Message failed during decoding - #[error("error converting message type into domain type")] - TryIntoDomainType, - - /// encoding prost Message into buffer failed - #[error("error encoding message into buffer")] - EncodeMessage, - - /// decoding buffer into prost Message failed - #[error("error decoding buffer into message")] - DecodeMessage, -} - -impl Kind { - /// Add a given source error as context for this error kind - /// - /// This is typically use with `map_err` as follows: - /// - /// ```ignore - /// let x = self.something.do_stuff() - /// .map_err(|e| error::Kind::Config.context(e))?; - /// ``` - pub fn context(self, source: impl Into) -> Context { - Context::new(self, Some(source.into())) - } -} diff --git a/proto/src/lib.rs b/proto/src/lib.rs index 1b99aeb72c..80ad5ce25e 100644 --- a/proto/src/lib.rs +++ b/proto/src/lib.rs @@ -114,9 +114,3 @@ pub mod tendermint { include!("prost/tendermint.version.rs"); } } - -mod domaintype; -pub use domaintype::DomainType; - -mod error; -pub use error::{Error, Kind}; diff --git a/relayer-cli/src/commands/query/channel.rs b/relayer-cli/src/commands/query/channel.rs index 71b4609258..8505171661 100644 --- a/relayer-cli/src/commands/query/channel.rs +++ b/relayer-cli/src/commands/query/channel.rs @@ -7,9 +7,11 @@ use ibc::ics04_channel::channel::ChannelEnd; use ibc::ics24_host::identifier::{ChannelId, PortId}; use ibc::ics24_host::Path::ChannelEnds; +use crate::error::{Error, Kind}; use ibc::ics24_host::error::ValidationError; use relayer::chain::{Chain, CosmosSDKChain}; use tendermint::chain::Id as ChainId; +use tendermint_proto::DomainType; #[derive(Clone, Command, Debug, Options)] pub struct QueryChannelEndCmd { @@ -97,11 +99,14 @@ impl Runnable for QueryChannelEndCmd { // run without proof: // cargo run --bin relayer -- -c relayer/tests/config/fixtures/simple_config.toml query channel end ibc-test firstport firstchannel --height 3 -p false let chain = CosmosSDKChain::from_config(chain_config).unwrap(); - let res = chain.query::( - ChannelEnds(opts.port_id, opts.channel_id), - opts.height, - opts.proof, - ); + let res: Result = chain + .query( + ChannelEnds(opts.port_id, opts.channel_id), + opts.height, + opts.proof, + ) + .map_err(|e| Kind::Query.context(e).into()) + .and_then(|v| ChannelEnd::decode_vec(&v).map_err(|e| Kind::Query.context(e).into())); match res { Ok(cs) => status_info!("Result for channel end query: ", "{:?}", cs), diff --git a/relayer-cli/src/commands/query/client.rs b/relayer-cli/src/commands/query/client.rs index b3545c7324..6a885692ea 100644 --- a/relayer-cli/src/commands/query/client.rs +++ b/relayer-cli/src/commands/query/client.rs @@ -5,8 +5,9 @@ use relayer::config::{ChainConfig, Config}; use crate::error::{Error, Kind}; use ibc::ics02_client::client_def::{AnyClientState, AnyConsensusState}; +use ibc::ics02_client::raw::ConnectionIds as ConnectionIDs; use ibc::ics24_host::error::ValidationError; -use ibc::ics24_host::identifier::{ClientId, ConnectionId}; +use ibc::ics24_host::identifier::ClientId; use ibc::ics24_host::Path::{ClientConnections, ClientConsensusState, ClientState}; use relayer::chain::Chain; use relayer::chain::CosmosSDKChain; @@ -81,7 +82,7 @@ impl Runnable for QueryClientStateCmd { let chain = CosmosSDKChain::from_config(chain_config).unwrap(); let res: Result = chain - .abci_query(ClientState(opts.client_id), opts.height, opts.proof) + .query(ClientState(opts.client_id), opts.height, opts.proof) .map_err(|e| Kind::Query.context(e).into()) .and_then(|v| { AnyClientState::decode_vec(&v).map_err(|e| Kind::Query.context(e).into()) @@ -170,7 +171,7 @@ impl Runnable for QueryClientConsensusCmd { let chain = CosmosSDKChain::from_config(chain_config).unwrap(); let res: Result = chain - .abci_query( + .query( ClientConsensusState(opts.client_id, opts.consensus_height), opts.height, opts.proof, @@ -284,11 +285,10 @@ impl Runnable for QueryClientConnectionsCmd { status_info!("Options", "{:?}", opts); let chain = CosmosSDKChain::from_config(chain_config).unwrap(); - let res = chain.query::>( - ClientConnections(opts.client_id), - opts.height, - opts.proof, - ); + let res: Result = chain + .query(ClientConnections(opts.client_id), opts.height, opts.proof) + .map_err(|e| Kind::Query.context(e).into()) + .and_then(|v| ConnectionIDs::decode_vec(&v).map_err(|e| Kind::Query.context(e).into())); match res { Ok(cs) => status_info!("client connections query result: ", "{:?}", cs), Err(e) => status_info!("client connections query error", "{}", e), diff --git a/relayer-cli/src/commands/query/connection.rs b/relayer-cli/src/commands/query/connection.rs index e03e6871d7..e9bc7a14c8 100644 --- a/relayer-cli/src/commands/query/connection.rs +++ b/relayer-cli/src/commands/query/connection.rs @@ -3,11 +3,13 @@ use crate::prelude::*; use abscissa_core::{Command, Options, Runnable}; use relayer::config::{ChainConfig, Config}; +use crate::error::{Error, Kind}; use ibc::ics24_host::error::ValidationError; use ibc::ics24_host::identifier::ConnectionId; use ibc::ics24_host::Path::Connections; use relayer::chain::{Chain, CosmosSDKChain}; use tendermint::chain::Id as ChainId; +use tendermint_proto::DomainType; use ibc::ics03_connection::connection::ConnectionEnd; @@ -85,8 +87,10 @@ impl Runnable for QueryConnectionEndCmd { let chain = CosmosSDKChain::from_config(chain_config).unwrap(); // run without proof: // cargo run --bin relayer -- -c relayer/tests/config/fixtures/simple_config.toml query connection end ibc-test connectionidone --height 3 -p false - let res = - chain.query::(Connections(opts.connection_id), opts.height, opts.proof); + let res: Result = chain + .query(Connections(opts.connection_id), opts.height, opts.proof) + .map_err(|e| Kind::Query.context(e).into()) + .and_then(|v| ConnectionEnd::decode_vec(&v).map_err(|e| Kind::Query.context(e).into())); match res { Ok(cs) => status_info!("connection query result: ", "{:?}", cs), diff --git a/relayer-cli/tests/integration.rs b/relayer-cli/tests/integration.rs index d393103c90..9c1a8612c9 100644 --- a/relayer-cli/tests/integration.rs +++ b/relayer-cli/tests/integration.rs @@ -11,16 +11,16 @@ unused_qualifications )] -use ibc::ics03_connection::connection::ConnectionEnd; -use ibc::ics03_connection::connection::State as ConnectionState; +use ibc::ics02_client::raw::ConnectionIds as DomainTypeClientConnections; use ibc::ics04_channel::channel::{ChannelEnd, Order, State as ChannelState}; use ibc::ics24_host::identifier::{ChannelId, ClientId, ConnectionId, PortId}; -use ibc::ics24_host::Path::{ChannelEnds, ClientConnections, Connections}; +use ibc::ics24_host::Path::{ChannelEnds, ClientConnections}; use relayer::chain::{Chain, CosmosSDKChain}; use relayer::config::{ChainConfig, Config}; use std::str::FromStr; use tendermint::chain::Id; use tendermint::net::Address; +use tendermint_proto::DomainType; /// Configuration that connects to the informaldev/simd DockerHub image running on localhost. fn simd_config() -> Config { @@ -47,14 +47,18 @@ fn simd_chain() -> CosmosSDKChain { #[test] #[ignore] fn query_connection_id() { + /* the current informaldev/simd image has an incompatible (old?) protobuf implementation let chain = simd_chain(); - let query = chain - .query::( - Connections(ConnectionId::from_str("connectionidone").unwrap()), - 0, - false, - ) - .unwrap(); + let query = ConnectionEnd::decode_vec( + &chain + .abci_query( + Connections(ConnectionId::from_str("connectionidone").unwrap()), + 0, + false, + ) + .unwrap(), + ); + .unwrap(); assert_eq!(query.state(), &ConnectionState::Init); assert_eq!(query.client_id(), "clientidone"); @@ -65,6 +69,7 @@ fn query_connection_id() { query.versions(), vec!["(1,[ORDER_ORDERED,ORDER_UNORDERED])"] ); + */ } /// Query channel ID. Requires the informaldev/simd Docker image running on localhost. @@ -72,16 +77,19 @@ fn query_connection_id() { #[ignore] fn query_channel_id() { let chain = simd_chain(); - let query = chain - .query::( - ChannelEnds( - PortId::from_str("firstport").unwrap(), - ChannelId::from_str("firstchannel").unwrap(), - ), - 0, - false, - ) - .unwrap(); + let query = ChannelEnd::decode_vec( + &chain + .query( + ChannelEnds( + PortId::from_str("firstport").unwrap(), + ChannelId::from_str("firstchannel").unwrap(), + ), + 0, + false, + ) + .unwrap(), + ) + .unwrap(); assert_eq!(query.state(), &ChannelState::Init); assert_eq!(query.ordering(), &Order::Ordered); @@ -96,16 +104,19 @@ fn query_channel_id() { #[ignore] fn query_client_id() { let chain = simd_chain(); - let query = chain - .query::>( - ClientConnections(ClientId::from_str("clientidone").unwrap()), - 0, - false, - ) - .unwrap(); + let query = DomainTypeClientConnections::decode_vec( + &chain + .query( + ClientConnections(ClientId::from_str("clientidone").unwrap()), + 0, + false, + ) + .unwrap(), + ) + .unwrap(); assert_eq!( - query[0], - ConnectionId::from_str("connections/connectionidone").unwrap() + query.0[0], + ConnectionId::from_str("connectionidone").unwrap() ); } diff --git a/relayer/src/chain.rs b/relayer/src/chain.rs index b9fb5b9e8e..cb3f633722 100644 --- a/relayer/src/chain.rs +++ b/relayer/src/chain.rs @@ -10,7 +10,6 @@ use ::tendermint_rpc::Client as RpcClient; use ibc::ics02_client::state::{ClientState, ConsensusState}; use ibc::ics24_host::Path; -use ibc::try_from_raw::TryFromRaw; use crate::config::ChainConfig; use crate::error; @@ -42,21 +41,8 @@ pub trait Chain { /// Error types defined by this chain type Error: Into>; - /// Perform a generic `query`, and return the corresponding deserialized response data. - // This is going to be a blocking request. - // From the "Asynchronous Programming in Rust" book: - // Important extensions like `async fn` syntax in trait methods are still unimplemented - // https://rust-lang.github.io/async-book/01_getting_started/03_state_of_async_rust.html - // DEPRECATED: implement abci_query instead. Since this will be removed before the next release - // I'm commenting out the deprectaed warning. It would just confuse the clippy check in CI. - //#[deprecated(since = "0.0.4", note = "please use `abci_query` instead")] - fn query(&self, data: Path, height: u64, prove: bool) -> Result - where - T: TryFromRaw; - - /// Perform a generic `query` using ABCI, and return the corresponding response data. - /// The naming is foreshadowing for an upcoming `grpc_query` function in the future. - fn abci_query(&self, data: Path, height: u64, prove: bool) -> Result, Self::Error>; + /// Perform a generic `query`, and return the corresponding response data. + fn query(&self, data: Path, height: u64, prove: bool) -> Result, Self::Error>; /// Returns the chain's identifier fn id(&self) -> &ChainId { diff --git a/relayer/src/chain/cosmos.rs b/relayer/src/chain/cosmos.rs index eb32a50c75..08c82a259e 100644 --- a/relayer/src/chain/cosmos.rs +++ b/relayer/src/chain/cosmos.rs @@ -11,15 +11,12 @@ use core::future::Future; use ibc::ics07_tendermint::client_state::ClientState; use ibc::ics07_tendermint::consensus_state::ConsensusState; use ibc::ics24_host::{Path, IBC_QUERY_PATH}; -use ibc::try_from_raw::TryFromRaw; use crate::client::rpc_requester::RpcRequester; use crate::config::ChainConfig; use crate::error::{Error, Kind}; use super::Chain; -use bytes::Bytes; -use prost::Message; use std::str::FromStr; pub struct CosmosSDKChain { @@ -50,33 +47,7 @@ impl Chain for CosmosSDKChain { type Requester = RpcRequester; type Error = anomaly::Error; - fn query(&self, data: Path, height: u64, prove: bool) -> Result - where - T: TryFromRaw, - { - let path = TendermintABCIPath::from_str(IBC_QUERY_PATH).unwrap(); - if !data.is_provable() & prove { - return Err(Kind::Store - .context("requested proof for a path in the privateStore") - .into()); - } - let response = block_on(abci_query(&self, path, data.to_string(), height, prove))?; - - // Verify response proof, if requested. - if prove { - dbg!("Todo: implement proof verification."); // Todo: Verify proof - } - - // Deserialize response data. This involves two steps: (1) `decode` from the wire bytes into - // a Prost type (such as `ibc_proto::channel::Channel`) called intuitively a raw type; - // and (2) then translate with `try_from` from the Prost raw type into an actual domain type - // (e.g., `ibc::ics04_channel::channel::ChannelEnd`). - T::RawType::decode(Bytes::from(response)) - .map_err(|e| Kind::ResponseParsing.context(e).into()) - .and_then(|r| T::try_from(r).map_err(|e| Kind::ResponseParsing.context(e).into())) - } - - fn abci_query(&self, data: Path, height: u64, prove: bool) -> Result, Self::Error> { + fn query(&self, data: Path, height: u64, prove: bool) -> Result, Self::Error> { let path = TendermintABCIPath::from_str(IBC_QUERY_PATH).unwrap(); if !data.is_provable() & prove { return Err(Kind::Store