Merge pull request #2466 from CosmWasm/rm-ListChannels

Remove IbcQuery::ListChannels and ListChannelsResponse

Author: chipshort

CHANGELOG.md

@@ -73,6 +73,8 @@ and this project adheres to
 - cosmwasm-std: Remove support for `BankQuery::AllBalances` and
   `query_all_balances`. ([#2433])
 - cosmwasm-std: source_client instead of channel_id in IBCv2 - ([#2450])
+- cosmwasm-std: Remove previously deprecated `IbcQuery::ListChannels` and
+  `ListChannelsResponse`. ([#2223])
 
 ## Fixed
 
@@ -86,6 +88,7 @@ and this project adheres to
 [#2156]: https://github.com/CosmWasm/cosmwasm/issues/2156
 [#2195]: https://github.com/CosmWasm/cosmwasm/issues/2195
 [#2201]: https://github.com/CosmWasm/cosmwasm/issues/2201
+[#2223]: https://github.com/CosmWasm/cosmwasm/issues/2223
 [#2237]: https://github.com/CosmWasm/cosmwasm/issues/2237
 [#2262]: https://github.com/CosmWasm/cosmwasm/issues/2262
 [#2268]: https://github.com/CosmWasm/cosmwasm/issues/2268

contracts/reflect/schema/raw/query.json

@@ -351,29 +351,6 @@
           },
           "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.\n\nReturns a `ListChannelsResponse`.",
-          "deprecated": true,
-          "type": "object",
-          "required": [
-            "list_channels"
-          ],
-          "properties": {
-            "list_channels": {
-              "type": "object",
-              "properties": {
-                "port_id": {
-                  "type": [
-                    "string",
-                    "null"
-                  ]
-                }
-              },
-              "additionalProperties": false
-            }
-          },
-          "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)\n\nReturns a `ChannelResponse`.",
           "type": "object",

contracts/reflect/schema/reflect.json

@@ -1611,29 +1611,6 @@
             },
             "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.\n\nReturns a `ListChannelsResponse`.",
-            "deprecated": true,
-            "type": "object",
-            "required": [
-              "list_channels"
-            ],
-            "properties": {
-              "list_channels": {
-                "type": "object",
-                "properties": {
-                  "port_id": {
-                    "type": [
-                      "string",
-                      "null"
-                    ]
-                  }
-                },
-                "additionalProperties": false
-              }
-            },
-            "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)\n\nReturns a `ChannelResponse`.",
             "type": "object",

packages/go-gen/tests/cosmwasm_std__IbcQuery.go

@@ -1,15 +1,6 @@
 type PortIDQuery struct {
 }
 
-// ListChannelsQuery is an IBCQuery that lists all channels that are bound to a given port.
-// If `PortID` is unset, this list all channels bound to the contract's port.
-// Returns a `ListChannelsResponse`.
-// This is the counterpart of [IbcQuery::ListChannels](https://github.com/CosmWasm/cosmwasm/blob/v0.14.0-beta1/packages/std/src/ibc.rs#L70-L73).
-type ListChannelsQuery struct {
-	// optional argument
-	PortID string `json:"port_id,omitempty"`
-}
-
 type ChannelQuery struct {
 	ChannelID string `json:"channel_id"`
 	// optional argument
@@ -24,7 +15,6 @@ type FeeEnabledChannelQuery struct {
 // This is the counterpart of [IbcQuery](https://github.com/CosmWasm/cosmwasm/blob/v0.14.0-beta1/packages/std/src/ibc.rs#L61-L83).
 type IBCQuery struct {
 	PortID            *PortIDQuery            `json:"port_id,omitempty"`
-	ListChannels      *ListChannelsQuery      `json:"list_channels,omitempty"`
 	Channel           *ChannelQuery           `json:"channel,omitempty"`
 	FeeEnabledChannel *FeeEnabledChannelQuery `json:"fee_enabled_channel,omitempty"`
 }

packages/std/src/lib.rs

@@ -95,9 +95,8 @@ pub use crate::query::{
     CustomQuery, DecCoin, Delegation, DelegationResponse, DelegationRewardsResponse,
     DelegationTotalRewardsResponse, DelegatorReward, DelegatorValidatorsResponse,
     DelegatorWithdrawAddressResponse, DenomMetadataResponse, DistributionQuery,
-    FeeEnabledChannelResponse, FullDelegation, GrpcQuery, IbcQuery, ListChannelsResponse,
-    PortIdResponse, QueryRequest, StakingQuery, SupplyResponse, Validator, ValidatorResponse,
-    WasmQuery,
+    FeeEnabledChannelResponse, FullDelegation, GrpcQuery, IbcQuery, PortIdResponse, QueryRequest,
+    StakingQuery, SupplyResponse, Validator, ValidatorResponse, WasmQuery,
 };
 #[cfg(all(feature = "stargate", feature = "cosmwasm_1_2"))]
 pub use crate::results::WeightedVoteOption;

packages/std/src/query/ibc.rs

@@ -15,12 +15,10 @@ pub enum IbcQuery {
     ///
     /// 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`.
-    #[deprecated = "Returns a potentially unbound number of results. If you think you have a valid usecase, please open an issue."]
-    ListChannels { port_id: Option<String> },
+    //
+    // ListChannels was removed in CosmWasm 3 due to potentially unbound number of results.
+    // See https://github.com/CosmWasm/cosmwasm/issues/2223
+    //
     /// 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)
@@ -50,14 +48,6 @@ pub struct PortIdResponse {
 
 impl_response_constructor!(PortIdResponse, port_id: String);
 
-#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
-#[non_exhaustive]
-pub struct ListChannelsResponse {
-    pub channels: Vec<IbcChannel>,
-}
-
-impl_response_constructor!(ListChannelsResponse, channels: Vec<IbcChannel>);
-
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
 #[non_exhaustive]
 pub struct ChannelResponse {

packages/std/src/testing/mock.rs

@@ -46,7 +46,7 @@ use crate::{
 };
 use crate::{Attribute, DenomMetadata};
 #[cfg(feature = "stargate")]
-use crate::{ChannelResponse, IbcQuery, ListChannelsResponse, PortIdResponse};
+use crate::{ChannelResponse, IbcQuery, PortIdResponse};
 #[cfg(feature = "cosmwasm_1_4")]
 use crate::{Decimal256, DelegationRewardsResponse, DelegatorValidatorsResponse};
 use crate::{RecoverPubkeyError, StdError, StdResult, SystemError, VerificationError};
@@ -1102,20 +1102,6 @@ impl IbcQuerier {
                 let res = ChannelResponse { channel };
                 to_json_binary(&res).into()
             }
-            #[allow(deprecated)]
-            IbcQuery::ListChannels { port_id } => {
-                let channels = self
-                    .channels
-                    .iter()
-                    .filter(|c| match port_id {
-                        Some(p) => c.endpoint.port_id.eq(p),
-                        None => c.endpoint.port_id == self.port_id,
-                    })
-                    .cloned()
-                    .collect();
-                let res = ListChannelsResponse { channels };
-                to_json_binary(&res).into()
-            }
             IbcQuery::PortId {} => {
                 let res = PortIdResponse {
                     port_id: self.port_id.clone(),
@@ -2434,40 +2420,6 @@ mod tests {
         assert_eq!(chan.channel, None);
     }
 
-    #[cfg(feature = "stargate")]
-    #[test]
-    #[allow(deprecated)]
-    fn ibc_querier_channels_matching() {
-        let chan1 = mock_ibc_channel("channel-0", IbcOrder::Ordered, "ibc");
-        let chan2 = mock_ibc_channel("channel-1", IbcOrder::Ordered, "ibc");
-
-        let ibc = IbcQuerier::new("myport", &[chan1.clone(), chan2.clone()]);
-
-        // query channels matching "my_port" (should match both above)
-        let query = &IbcQuery::ListChannels {
-            port_id: Some("my_port".to_string()),
-        };
-        let raw = ibc.query(query).unwrap().unwrap();
-        let res: ListChannelsResponse = from_json(raw).unwrap();
-        assert_eq!(res.channels, vec![chan1, chan2]);
-    }
-
-    #[cfg(feature = "stargate")]
-    #[test]
-    #[allow(deprecated)]
-    fn ibc_querier_channels_no_matching() {
-        let chan1 = mock_ibc_channel("channel-0", IbcOrder::Ordered, "ibc");
-        let chan2 = mock_ibc_channel("channel-1", IbcOrder::Ordered, "ibc");
-
-        let ibc = IbcQuerier::new("myport", &[chan1, chan2]);
-
-        // query channels matching "myport" (should be none)
-        let query = &IbcQuery::ListChannels { port_id: None };
-        let raw = ibc.query(query).unwrap().unwrap();
-        let res: ListChannelsResponse = from_json(raw).unwrap();
-        assert_eq!(res.channels, vec![]);
-    }
-
     #[cfg(feature = "stargate")]
     #[test]
     fn ibc_querier_port() {