Merge pull request #882 from CosmWasm/move_ibcquery

Move IbcQuery to query/ibc module

Author: webmaster128

contracts/reflect/schema/query_msg.json

@@ -164,7 +164,7 @@
       "description": "These are queries to the various IBC modules to see the state of the contract's IBC connection. These will return errors if the contract is not \"ibc enabled\"",
       "anyOf": [
         {
-          "description": "Gets the Port ID the current contract is bound to. Returns PortIdResponse",
+          "description": "Gets the Port ID the current contract is bound to.\n\nReturns a `PortIdResponse`.",
           "type": "object",
           "required": [
             "port_id"
@@ -177,7 +177,7 @@
           "additionalProperties": false
         },
         {
-          "description": "Lists all channels that are bound to a given port. If `port_id` is omitted, this list all channels bound to the contract's port. Returns a `ListChannelsResponse`.",
+          "description": "Lists all channels that are bound to a given port. If `port_id` is omitted, this list all channels bound to the contract's port.\n\nReturns a `ListChannelsResponse`.",
           "type": "object",
           "required": [
             "list_channels"
@@ -198,7 +198,7 @@
           "additionalProperties": false
         },
         {
-          "description": "Lists all information for a (portID, channelID) pair. If port_id is omitted, it will default to the contract's own channel. (To save a PortId{} call) Returns ChannelResponse.",
+          "description": "Lists all information for a (portID, channelID) pair. If port_id is omitted, it will default to the contract's own channel. (To save a PortId{} call)\n\nReturns a `ChannelResponse`.",
           "type": "object",
           "required": [
             "channel"

packages/std/src/ibc.rs

@@ -57,45 +57,6 @@ pub enum IbcMsg {
     CloseChannel { channel_id: String },
 }
 
-/// These are queries to the various IBC modules to see the state of the contract's
-/// IBC connection. These will return errors if the contract is not "ibc enabled"
-#[non_exhaustive]
-#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
-#[serde(rename_all = "snake_case")]
-pub enum IbcQuery {
-    /// Gets the Port ID the current contract is bound to.
-    /// Returns PortIdResponse
-    PortId {},
-    /// Lists all channels that are bound to a given port.
-    /// If `port_id` is omitted, this list all channels bound to the contract's port.
-    /// Returns a `ListChannelsResponse`.
-    ListChannels { port_id: Option<String> },
-    /// Lists all information for a (portID, channelID) pair.
-    /// If port_id is omitted, it will default to the contract's own channel.
-    /// (To save a PortId{} call)
-    /// Returns ChannelResponse.
-    Channel {
-        channel_id: String,
-        port_id: Option<String>,
-    },
-    // TODO: Add more
-}
-
-#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
-pub struct PortIdResponse {
-    pub port_id: String,
-}
-
-#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
-pub struct ListChannelsResponse {
-    pub channels: Vec<IbcChannel>,
-}
-
-#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
-pub struct ChannelResponse {
-    pub channel: Option<IbcChannel>,
-}
-
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
 pub struct IbcEndpoint {
     pub port_id: String,

packages/std/src/lib.rs

@@ -33,9 +33,8 @@ pub use crate::errors::{
 };
 #[cfg(feature = "stargate")]
 pub use crate::ibc::{
-    ChannelResponse, IbcAcknowledgement, IbcBasicResponse, IbcChannel, IbcEndpoint, IbcMsg,
-    IbcOrder, IbcPacket, IbcQuery, IbcReceiveResponse, IbcTimeoutBlock, ListChannelsResponse,
-    PortIdResponse,
+    IbcAcknowledgement, IbcBasicResponse, IbcChannel, IbcEndpoint, IbcMsg, IbcOrder, IbcPacket,
+    IbcReceiveResponse, IbcTimeoutBlock,
 };
 #[cfg(feature = "iterator")]
 #[allow(deprecated)]
@@ -49,6 +48,8 @@ pub use crate::query::{
     AllDelegationsResponse, AllValidatorsResponse, BondedDenomResponse, Delegation, FullDelegation,
     StakingQuery, Validator, ValidatorResponse,
 };
+#[cfg(feature = "stargate")]
+pub use crate::query::{ChannelResponse, IbcQuery, ListChannelsResponse, PortIdResponse};
 pub use crate::results::{
     attr, wasm_execute, wasm_instantiate, Attribute, BankMsg, ContractResult, CosmosMsg, Empty,
     Event, QueryResponse, Reply, ReplyOn, Response, SubMsg, SubcallResponse, SystemResult, WasmMsg,

packages/std/src/query/ibc.rs

@@ -0,0 +1,48 @@
+#![cfg(feature = "stargate")]
+
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+
+use crate::ibc::IbcChannel;
+
+/// These are queries to the various IBC modules to see the state of the contract's
+/// IBC connection. These will return errors if the contract is not "ibc enabled"
+#[non_exhaustive]
+#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
+#[serde(rename_all = "snake_case")]
+pub enum IbcQuery {
+    /// Gets the Port ID the current contract is bound to.
+    ///
+    /// Returns a `PortIdResponse`.
+    PortId {},
+    /// Lists all channels that are bound to a given port.
+    /// If `port_id` is omitted, this list all channels bound to the contract's port.
+    ///
+    /// Returns a `ListChannelsResponse`.
+    ListChannels { port_id: Option<String> },
+    /// Lists all information for a (portID, channelID) pair.
+    /// If port_id is omitted, it will default to the contract's own channel.
+    /// (To save a PortId{} call)
+    ///
+    /// Returns a `ChannelResponse`.
+    Channel {
+        channel_id: String,
+        port_id: Option<String>,
+    },
+    // TODO: Add more
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
+pub struct PortIdResponse {
+    pub port_id: String,
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
+pub struct ListChannelsResponse {
+    pub channels: Vec<IbcChannel>,
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
+pub struct ChannelResponse {
+    pub channel: Option<IbcChannel>,
+}

packages/std/src/query/mod.rs

@@ -1,18 +1,19 @@
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
-#[cfg(feature = "stargate")]
-use crate::ibc::IbcQuery;
 #[cfg(feature = "stargate")]
 use crate::Binary;
 use crate::Empty;
 
 mod bank;
+mod ibc;
 mod staking;
 mod stargate;
 mod wasm;
 
 pub use bank::{AllBalanceResponse, BalanceResponse, BankQuery};
+#[cfg(feature = "stargate")]
+pub use ibc::{ChannelResponse, IbcQuery, ListChannelsResponse, PortIdResponse};
 #[cfg(feature = "staking")]
 pub use staking::{
     AllDelegationsResponse, AllValidatorsResponse, BondedDenomResponse, Delegation,