Adjust docs and naming

Author: chipshort

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

@@ -419,7 +419,7 @@
       "type": "object",
       "required": [
         "ack_fee",
-        "recv_fee",
+        "receive_fee",
         "timeout_fee"
       ],
       "properties": {
@@ -429,7 +429,7 @@
             "$ref": "#/definitions/Coin"
           }
         },
-        "recv_fee": {
+        "receive_fee": {
           "type": "array",
           "items": {
             "$ref": "#/definitions/Coin"
@@ -597,7 +597,7 @@
           "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 { recv_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)); ```",
+          "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"
@@ -624,7 +624,7 @@
                   "type": "string"
                 },
                 "relayers": {
-                  "description": "Allowlist of relayer addresses that can receive the fee. This is currently not implemented and *must* be empty.",
+                  "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"
@@ -637,7 +637,7 @@
           "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.",
+          "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"
@@ -665,7 +665,7 @@
                   "type": "string"
                 },
                 "relayers": {
-                  "description": "Allowlist of relayer addresses that can receive the fee. This is currently not implemented and *must* be empty.",
+                  "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"

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. Most of 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. Most of 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/tests/cosmwasm_std__IbcMsg.go

@@ -62,7 +62,7 @@ type IBCAcknowledgement struct {
 }
 type IBCFee struct {
 	AckFee     Array[Coin] `json:"ack_fee"`
-	RecvFee    Array[Coin] `json:"recv_fee"`
+	ReceiveFee Array[Coin] `json:"receive_fee"`
 	TimeoutFee Array[Coin] `json:"timeout_fee"`
 }
 

packages/std/src/ibc.rs

@@ -91,7 +91,7 @@ pub enum IbcMsg {
     ///     port_id: "transfer".to_string(),
     ///     channel_id: "source-channel".to_string(),
     ///     fee: IbcFee {
-    ///         recv_fee: coins(100, "token"),
+    ///         receive_fee: coins(100, "token"),
     ///         ack_fee: coins(201, "token"),
     ///         timeout_fee: coins(200, "token"),
     ///     },
@@ -118,12 +118,15 @@ pub enum IbcMsg {
         channel_id: String,
         fee: IbcFee,
         /// Allowlist of relayer addresses that can receive the fee.
+        /// An empty list means that any relayer can receive the fee.
+        ///
         /// This is currently not implemented and *must* be empty.
         relayers: Vec<String>,
     },
     /// 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.
     #[cfg(feature = "cosmwasm_2_2")]
     PayPacketFeeAsync {
         /// The port id on the chain where the packet is sent from (this chain).
@@ -134,6 +137,8 @@ pub enum IbcMsg {
         sequence: u64,
         fee: IbcFee,
         /// Allowlist of relayer addresses that can receive the fee.
+        /// An empty list means that any relayer can receive the fee.
+        ///
         /// This is currently not implemented and *must* be empty.
         relayers: Vec<String>,
     },
@@ -142,7 +147,7 @@ pub enum IbcMsg {
 #[derive(Serialize, Deserialize, Default, Clone, Debug, PartialEq, Eq, JsonSchema)]
 pub struct IbcFee {
     // the packet receive fee
-    pub recv_fee: Vec<Coin>,
+    pub receive_fee: Vec<Coin>,
     // the packet acknowledgement fee
     pub ack_fee: Vec<Coin>,
     // the packet timeout fee