Merge pull request #2196 from CosmWasm/co/ibc-fees

IBC Fees messages

Author: chipshort

CHANGELOG.md

@@ -14,8 +14,12 @@ and this project adheres to
   These functions are meant to be used similarly to their JSON counterparts.
   [MessagePack](https://msgpack.org) is a more compact, binary encoding.
   ([#2118])
+- cosmwasm-std: Add `IbcMsg::{PayPacketFee, PayPacketFeeAsync}` and
+  `IbcQuery::FeeEnabledChannel` to allow contracts to incentivize IBC packets
+  using IBC Fees. ([#2196])
 
 [#2118]: https://github.com/CosmWasm/cosmwasm/pull/2118
+[#2196]: https://github.com/CosmWasm/cosmwasm/pull/2196
 
 ### Changed
 

contracts/ibc-reflect/Cargo.toml

@@ -30,9 +30,12 @@ cranelift = ["cosmwasm-vm/cranelift"]
 
 [dependencies]
 cosmwasm-schema = { path = "../../packages/schema" }
-cosmwasm-std = { path = "../../packages/std", features = ["iterator", "stargate", "cosmwasm_2_1"] }
+cosmwasm-std = { path = "../../packages/std", features = ["iterator", "stargate", "cosmwasm_2_2"] }
 schemars = "0.8.12"
 serde = { version = "1.0.103", default-features = false, features = ["derive"] }
 
 [dev-dependencies]
-cosmwasm-vm = { path = "../../packages/vm", default-features = false, features = ["iterator", "stargate"] }
+cosmwasm-vm = { path = "../../packages/vm", default-features = false, features = [
+  "iterator",
+  "stargate",
+] }

contracts/ibc-reflect/schema/ibc/packet_msg.json

@@ -415,6 +415,35 @@
       },
       "additionalProperties": false
     },
+    "IbcFee": {
+      "type": "object",
+      "required": [
+        "ack_fee",
+        "receive_fee",
+        "timeout_fee"
+      ],
+      "properties": {
+        "ack_fee": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Coin"
+          }
+        },
+        "receive_fee": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Coin"
+          }
+        },
+        "timeout_fee": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Coin"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
     "IbcMsg": {
       "description": "These are messages in the IBC lifecycle. Only usable by IBC-enabled contracts (contracts that directly speak the IBC protocol via 6 entry points)",
       "oneOf": [
@@ -566,6 +595,93 @@
             }
           },
           "additionalProperties": false
+        },
+        {
+          "description": "Incentivizes the next IBC packet sent after this message with a fee. Note that this does not necessarily have to be a packet sent by this contract. The fees are taken from the contract's balance immediately and locked until the packet is handled.\n\n# Example\n\nMost commonly, you will attach this message to a response right before sending a packet using [`IbcMsg::SendPacket`] or [`IbcMsg::Transfer`].\n\n```rust # use cosmwasm_std::{IbcMsg, IbcEndpoint, IbcFee, IbcTimeout, Coin, coins, CosmosMsg, Response, Timestamp};\n\nlet incentivize = IbcMsg::PayPacketFee { port_id: \"transfer\".to_string(), channel_id: \"source-channel\".to_string(), fee: IbcFee { receive_fee: coins(100, \"token\"), ack_fee: coins(201, \"token\"), timeout_fee: coins(200, \"token\"), }, relayers: vec![], }; let transfer = IbcMsg::Transfer { channel_id: \"source-channel\".to_string(), to_address: \"receiver\".to_string(), amount: Coin::new(100u32, \"token\"), timeout: IbcTimeout::with_timestamp(Timestamp::from_nanos(0)), memo: None, };\n\n# #[cfg(feature = \"stargate\")] let _: Response = Response::new() .add_message(CosmosMsg::Ibc(incentivize)) .add_message(CosmosMsg::Ibc(transfer)); ```",
+          "type": "object",
+          "required": [
+            "pay_packet_fee"
+          ],
+          "properties": {
+            "pay_packet_fee": {
+              "type": "object",
+              "required": [
+                "channel_id",
+                "fee",
+                "port_id",
+                "relayers"
+              ],
+              "properties": {
+                "channel_id": {
+                  "description": "The channel id on the chain where the packet is sent from (this chain).",
+                  "type": "string"
+                },
+                "fee": {
+                  "$ref": "#/definitions/IbcFee"
+                },
+                "port_id": {
+                  "description": "The port id on the chain where the packet is sent from (this chain).",
+                  "type": "string"
+                },
+                "relayers": {
+                  "description": "Allowlist of relayer addresses that can receive the fee. An empty list means that any relayer can receive the fee.\n\nThis is currently not implemented and *must* be empty.",
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "description": "Incentivizes the existing IBC packet with the given port, channel and sequence with a fee. Note that this does not necessarily have to be a packet sent by this contract. The fees are taken from the contract's balance immediately and locked until the packet is handled. They are added to the existing fees on the packet.",
+          "type": "object",
+          "required": [
+            "pay_packet_fee_async"
+          ],
+          "properties": {
+            "pay_packet_fee_async": {
+              "type": "object",
+              "required": [
+                "channel_id",
+                "fee",
+                "port_id",
+                "relayers",
+                "sequence"
+              ],
+              "properties": {
+                "channel_id": {
+                  "description": "The channel id on the chain where the packet is sent from (this chain).",
+                  "type": "string"
+                },
+                "fee": {
+                  "$ref": "#/definitions/IbcFee"
+                },
+                "port_id": {
+                  "description": "The port id on the chain where the packet is sent from (this chain).",
+                  "type": "string"
+                },
+                "relayers": {
+                  "description": "Allowlist of relayer addresses that can receive the fee. An empty list means that any relayer can receive the fee.\n\nThis is currently not implemented and *must* be empty.",
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "sequence": {
+                  "description": "The sequence number of the packet that should be incentivized.",
+                  "type": "integer",
+                  "format": "uint64",
+                  "minimum": 0.0
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "additionalProperties": false
         }
       ]
     },

contracts/reflect/schema/raw/query.json

@@ -357,7 +357,7 @@
       "additionalProperties": false
     },
     "IbcQuery": {
-      "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\"",
+      "description": "These are queries to the various IBC modules to see the state of the contract's IBC connection. Most of these will return errors if the contract is not \"ibc enabled\".",
       "oneOf": [
         {
           "description": "Gets the Port ID the current contract is bound to.\n\nReturns a `PortIdResponse`.",

contracts/reflect/schema/reflect.json

@@ -1450,7 +1450,7 @@
         "additionalProperties": false
       },
       "IbcQuery": {
-        "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\"",
+        "description": "These are queries to the various IBC modules to see the state of the contract's IBC connection. Most of these will return errors if the contract is not \"ibc enabled\".",
         "oneOf": [
           {
             "description": "Gets the Port ID the current contract is bound to.\n\nReturns a `PortIdResponse`.",

packages/go-gen/Cargo.toml

@@ -10,7 +10,7 @@ release = false
 
 [dependencies]
 cosmwasm-std = { version = "2.1.1", path = "../std", features = [
-  "cosmwasm_2_1",
+  "cosmwasm_2_2",
   "staking",
   "stargate",
 ] }

packages/go-gen/tests/cosmwasm_std__IbcMsg.go

@@ -21,12 +21,34 @@ type WriteAcknowledgementMsg struct {
 type CloseChannelMsg struct {
 	ChannelID string `json:"channel_id"`
 }
+type PayPacketFeeMsg struct {
+	// The channel id on the chain where the packet is sent from (this chain).
+	ChannelID string `json:"channel_id"`
+	Fee       IBCFee `json:"fee"`
+	// The port id on the chain where the packet is sent from (this chain).
+	PortID string `json:"port_id"`
+	// Allowlist of relayer addresses that can receive the fee. This is currently not implemented and *must* be empty.
+	Relayers Array[string] `json:"relayers"`
+}
+type PayPacketFeeAsyncMsg struct {
+	// The channel id on the chain where the packet is sent from (this chain).
+	ChannelID string `json:"channel_id"`
+	Fee       IBCFee `json:"fee"`
+	// The port id on the chain where the packet is sent from (this chain).
+	PortID string `json:"port_id"`
+	// Allowlist of relayer addresses that can receive the fee. This is currently not implemented and *must* be empty.
+	Relayers Array[string] `json:"relayers"`
+	// The sequence number of the packet that should be incentivized.
+	Sequence uint64 `json:"sequence"`
+}
 
 type IBCMsg struct {
 	Transfer             *TransferMsg             `json:"transfer,omitempty"`
 	SendPacket           *SendPacketMsg           `json:"send_packet,omitempty"`
 	WriteAcknowledgement *WriteAcknowledgementMsg `json:"write_acknowledgement,omitempty"`
 	CloseChannel         *CloseChannelMsg         `json:"close_channel,omitempty"`
+	PayPacketFee         *PayPacketFeeMsg         `json:"pay_packet_fee,omitempty"`
+	PayPacketFeeAsync    *PayPacketFeeAsyncMsg    `json:"pay_packet_fee_async,omitempty"`
 }
 
 // Coin is a string representation of the sdk.Coin type (more portable than sdk.Int)
@@ -38,6 +60,11 @@ type Coin struct {
 type IBCAcknowledgement struct {
 	Data []byte `json:"data"`
 }
+type IBCFee struct {
+	AckFee     Array[Coin] `json:"ack_fee"`
+	ReceiveFee Array[Coin] `json:"receive_fee"`
+	TimeoutFee Array[Coin] `json:"timeout_fee"`
+}
 
 // IBCTimeout is the timeout for an IBC packet. At least one of block and timestamp is required.
 type IBCTimeout struct {

packages/go-gen/tests/cosmwasm_std__IbcQuery.go

@@ -15,11 +15,16 @@ type ChannelQuery struct {
 	// optional argument
 	PortID string `json:"port_id,omitempty"`
 }
+type FeeEnabledChannelQuery struct {
+	ChannelID string `json:"channel_id"`
+	PortID    string `json:"port_id,omitempty"`
+}
 
 // IBCQuery defines a query request from the contract into the chain.
 // 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"`
+	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/Cargo.toml

@@ -9,7 +9,7 @@ license = "Apache-2.0"
 readme = "README.md"
 
 [package.metadata.docs.rs]
-features = ["abort", "stargate", "staking", "cosmwasm_2_1"]
+features = ["abort", "stargate", "staking", "cosmwasm_2_2"]
 
 [features]
 default = ["iterator", "abort", "std"]
@@ -48,6 +48,9 @@ cosmwasm_2_0 = ["cosmwasm_1_4"]
 # This enables functionality that is only available on 2.1 chains.
 # It adds verification and key recovery for the secp256r1 elliptic curve.
 cosmwasm_2_1 = ["cosmwasm_2_0"]
+# This enables functionality that is only available on 2.2 chains.
+# It adds `IbcMsg::PayPacketFee` and `IbcMsg::PayPacketFeeAsync`.
+cosmwasm_2_2 = ["cosmwasm_2_1"]
 
 [dependencies]
 base64 = "0.22.0"

packages/std/src/exports.rs

@@ -35,45 +35,49 @@ use crate::{CustomMsg, Deps, DepsMut, MessageInfo};
 // See `docs/CAPABILITIES.md` for more details.
 #[cfg(feature = "iterator")]
 #[no_mangle]
-extern "C" fn requires_iterator() -> () {}
+extern "C" fn requires_iterator() {}
 
 #[cfg(feature = "staking")]
 #[no_mangle]
-extern "C" fn requires_staking() -> () {}
+extern "C" fn requires_staking() {}
 
 #[cfg(feature = "stargate")]
 #[no_mangle]
-extern "C" fn requires_stargate() -> () {}
+extern "C" fn requires_stargate() {}
 
 #[cfg(feature = "cosmwasm_1_1")]
 #[no_mangle]
-extern "C" fn requires_cosmwasm_1_1() -> () {}
+extern "C" fn requires_cosmwasm_1_1() {}
 
 #[cfg(feature = "cosmwasm_1_2")]
 #[no_mangle]
-extern "C" fn requires_cosmwasm_1_2() -> () {}
+extern "C" fn requires_cosmwasm_1_2() {}
 
 #[cfg(feature = "cosmwasm_1_3")]
 #[no_mangle]
-extern "C" fn requires_cosmwasm_1_3() -> () {}
+extern "C" fn requires_cosmwasm_1_3() {}
 
 #[cfg(feature = "cosmwasm_1_4")]
 #[no_mangle]
-extern "C" fn requires_cosmwasm_1_4() -> () {}
+extern "C" fn requires_cosmwasm_1_4() {}
 
 #[cfg(feature = "cosmwasm_2_0")]
 #[no_mangle]
-extern "C" fn requires_cosmwasm_2_0() -> () {}
+extern "C" fn requires_cosmwasm_2_0() {}
 
 #[cfg(feature = "cosmwasm_2_1")]
 #[no_mangle]
-extern "C" fn requires_cosmwasm_2_1() -> () {}
+extern "C" fn requires_cosmwasm_2_1() {}
+
+#[cfg(feature = "cosmwasm_2_2")]
+#[no_mangle]
+extern "C" fn requires_cosmwasm_2_2() {}
 
 /// interface_version_* exports mark which Wasm VM interface level this contract is compiled for.
 /// They can be checked by cosmwasm_vm.
 /// Update this whenever the Wasm VM interface breaks.
 #[no_mangle]
-extern "C" fn interface_version_8() -> () {}
+extern "C" fn interface_version_8() {}
 
 /// allocate reserves the given number of bytes in wasm memory and returns a pointer
 /// to a Region defining this data. This space is managed by the calling process