feat: Add WriteAcknowledgement to Ibc2Msg (#2425)

Author: kulikthebird

contracts/ibc2/schema/ibc2.json

@@ -37,13 +37,23 @@
       "title": "State",
       "type": "object",
       "required": [
-        "ibc2_packet_receive_counter"
+        "ibc2_packet_receive_counter",
+        "last_channel_id",
+        "last_packet_seq"
       ],
       "properties": {
         "ibc2_packet_receive_counter": {
           "type": "integer",
           "format": "uint32",
           "minimum": 0.0
+        },
+        "last_channel_id": {
+          "type": "string"
+        },
+        "last_packet_seq": {
+          "type": "integer",
+          "format": "uint64",
+          "minimum": 0.0
         }
       },
       "additionalProperties": false

contracts/ibc2/schema/raw/response_to_query_state.json

@@ -3,13 +3,23 @@
   "title": "State",
   "type": "object",
   "required": [
-    "ibc2_packet_receive_counter"
+    "ibc2_packet_receive_counter",
+    "last_channel_id",
+    "last_packet_seq"
   ],
   "properties": {
     "ibc2_packet_receive_counter": {
       "type": "integer",
       "format": "uint32",
       "minimum": 0.0
+    },
+    "last_channel_id": {
+      "type": "string"
+    },
+    "last_packet_seq": {
+      "type": "integer",
+      "format": "uint64",
+      "minimum": 0.0
     }
   },
   "additionalProperties": false

contracts/ibc2/src/contract.rs

@@ -1,10 +1,10 @@
 use cosmwasm_std::{
     entry_point, from_json, to_json_vec, Binary, Deps, DepsMut, Empty, Env, Ibc2Msg,
-    Ibc2PacketReceiveMsg, Ibc2Payload, IbcReceiveResponse, MessageInfo, QueryResponse, Response,
-    StdAck, StdError, StdResult, Timestamp,
+    Ibc2PacketReceiveMsg, Ibc2Payload, IbcAcknowledgement, IbcReceiveResponse, MessageInfo,
+    QueryResponse, Response, StdAck, StdError, StdResult, Timestamp,
 };
 
-use crate::msg::QueryMsg;
+use crate::msg::{IbcPayload, QueryMsg};
 use crate::state::{State, STATE_KEY};
 
 #[entry_point]
@@ -18,6 +18,8 @@ pub fn instantiate(
         STATE_KEY,
         &to_json_vec(&State {
             ibc2_packet_receive_counter: 0,
+            last_channel_id: "".to_owned(),
+            last_packet_seq: 0,
         })?,
     );
 
@@ -43,15 +45,21 @@ pub fn ibc2_packet_receive(
     _env: Env,
     msg: Ibc2PacketReceiveMsg,
 ) -> StdResult<IbcReceiveResponse> {
+    let binary_payload = &msg.payload.value;
+    let json_payload: IbcPayload = from_json(binary_payload)?;
+
     let data = deps
         .storage
         .get(STATE_KEY)
         .ok_or_else(|| StdError::generic_err("State not found."))?;
     let state: State = from_json(data)?;
+
     deps.storage.set(
         STATE_KEY,
         &to_json_vec(&State {
             ibc2_packet_receive_counter: state.ibc2_packet_receive_counter + 1,
+            last_channel_id: msg.source_client.clone(),
+            last_packet_seq: msg.packet_sequence,
         })?,
     );
     // Workaround for now.
@@ -71,7 +79,23 @@ pub fn ibc2_packet_receive(
         // timeout: _env.block.time.plus_seconds(5_u64),
     };
 
-    Ok(IbcReceiveResponse::new(StdAck::success(b"\x01"))
-        .add_message(new_msg)
-        .add_attribute("action", "handle_increment"))
+    let resp = if json_payload.response_without_ack {
+        IbcReceiveResponse::without_ack().add_attribute("action", "handle_increment")
+    } else {
+        IbcReceiveResponse::new(StdAck::success(b"\x01"))
+            .add_message(new_msg)
+            .add_attribute("action", "handle_increment")
+    };
+
+    if json_payload.send_async_ack_for_prev_msg {
+        Ok(
+            resp.add_message(cosmwasm_std::Ibc2Msg::WriteAcknowledgement {
+                channel_id: state.last_channel_id,
+                packet_sequence: state.last_packet_seq,
+                ack: IbcAcknowledgement::new([1, 2, 3]),
+            }),
+        )
+    } else {
+        Ok(resp)
+    }
 }

contracts/ibc2/src/msg.rs

@@ -6,3 +6,9 @@ pub enum QueryMsg {
     #[returns(crate::state::State)]
     QueryState {},
 }
+
+#[cw_serde]
+pub struct IbcPayload {
+    pub response_without_ack: bool,
+    pub send_async_ack_for_prev_msg: bool,
+}

contracts/ibc2/src/state.rs

@@ -4,6 +4,8 @@ use serde::{Deserialize, Serialize};
 #[derive(Default, Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
 pub struct State {
     pub ibc2_packet_receive_counter: u32,
+    pub last_channel_id: String,
+    pub last_packet_seq: u64,
 }
 
 pub const STATE_KEY: &[u8] = b"state";

packages/std/src/ibc2.rs

@@ -1,7 +1,7 @@
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
-use crate::{Addr, Binary, Timestamp};
+use crate::{Addr, Binary, IbcAcknowledgement, Timestamp};
 
 /// Payload value should be encoded in a format defined by the channel version,
 /// and the module on the other side should know how to parse this.
@@ -51,6 +51,16 @@ pub enum Ibc2Msg {
         timeout: Timestamp,
         payloads: Vec<Ibc2Payload>,
     },
+    /// Acknowledges a packet that this contract received over IBC.
+    /// This allows acknowledging a packet that was not acknowledged yet in the `ibc2_packet_receive` call.
+    WriteAcknowledgement {
+        /// Existing channel where the packet was received
+        channel_id: String,
+        /// Sequence number of the packet that was received
+        packet_sequence: u64,
+        /// The acknowledgement to send back
+        ack: IbcAcknowledgement,
+    },
 }
 
 /// The message that is passed into `ibc2_packet_receive`
@@ -60,14 +70,21 @@ pub struct Ibc2PacketReceiveMsg {
     pub payload: Ibc2Payload,
     pub relayer: Addr,
     pub source_client: String,
+    pub packet_sequence: u64,
 }
 
 impl Ibc2PacketReceiveMsg {
-    pub fn new(payload: Ibc2Payload, relayer: Addr, source_client: String) -> Self {
+    pub fn new(
+        payload: Ibc2Payload,
+        relayer: Addr,
+        source_client: String,
+        packet_sequence: u64,
+    ) -> Self {
         Self {
             payload,
             relayer,
             source_client,
+            packet_sequence,
         }
     }
 }

packages/std/src/testing/mock.rs

@@ -528,6 +528,7 @@ pub fn mock_ibc2_packet_recv(data: &impl Serialize) -> StdResult<Ibc2PacketRecei
         },
         Addr::unchecked("relayer"),
         "channel_id23".to_string(),
+        42,
     ))
 }