Merge pull request #2474 from CosmWasm/aw/ibcv2-ack-recv

Introduce API for IBCv2 Acknowledge Receive

Author: aumetra

.circleci/config.yml

@@ -1254,7 +1254,7 @@ jobs:
           name: Run tests with coverage
           command: |
             # Generate full coverage report
-            cargo llvm-cov nextest --lcov --output-path lcov.info
+            cargo llvm-cov nextest --all-features --lcov --output-path lcov.info
 
             # List of package directories and their flags
             # ToDo: Re-add "core:cosmwasm-core" when enabling core coverage again

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
   "rust-analyzer.cargo.features": [
+    "ibc2",
     "stargate",
     "staking",
     "cosmwasm_2_1"

CHANGELOG.md

@@ -27,6 +27,8 @@ and this project adheres to
 - cosmwasm-std: Add `cosmwasm_std::testing::Envs`, which is an `Env` factory for
   testing environments. It auto-increments block heights and timestamps. It
   allows for advanced configurations such as custom address prefixes. ([#2442])
+- cosmwasm-vm: Add support for `ibc2_packet_ack` endpoint ([#2474])
+- cosmwasm-std: Add support for `ibc2_packet_ack` endpoint ([#2474])
 
 ## Changed
 

contracts/ibc2/schema/ibc2.json

@@ -37,12 +37,18 @@
       "title": "State",
       "type": "object",
       "required": [
+        "ibc2_packet_ack_counter",
         "ibc2_packet_receive_counter",
         "ibc2_packet_timeout_counter",
         "last_packet_seq",
         "last_source_client"
       ],
       "properties": {
+        "ibc2_packet_ack_counter": {
+          "type": "integer",
+          "format": "uint32",
+          "minimum": 0.0
+        },
         "ibc2_packet_receive_counter": {
           "type": "integer",
           "format": "uint32",

contracts/ibc2/schema/raw/response_to_query_state.json

@@ -3,12 +3,18 @@
   "title": "State",
   "type": "object",
   "required": [
+    "ibc2_packet_ack_counter",
     "ibc2_packet_receive_counter",
     "ibc2_packet_timeout_counter",
     "last_packet_seq",
     "last_source_client"
   ],
   "properties": {
+    "ibc2_packet_ack_counter": {
+      "type": "integer",
+      "format": "uint32",
+      "minimum": 0.0
+    },
     "ibc2_packet_receive_counter": {
       "type": "integer",
       "format": "uint32",

contracts/ibc2/src/contract.rs

@@ -1,7 +1,8 @@
 use cosmwasm_std::{
     entry_point, from_json, to_json_vec, Binary, Deps, DepsMut, Empty, Env, Ibc2Msg,
-    Ibc2PacketReceiveMsg, Ibc2PacketTimeoutMsg, Ibc2Payload, IbcAcknowledgement, IbcBasicResponse,
-    IbcReceiveResponse, MessageInfo, QueryResponse, Response, StdAck, StdError, StdResult,
+    Ibc2PacketAckMsg, Ibc2PacketReceiveMsg, Ibc2PacketTimeoutMsg, Ibc2Payload, IbcAcknowledgement,
+    IbcBasicResponse, IbcReceiveResponse, MessageInfo, QueryResponse, Response, StdAck, StdError,
+    StdResult,
 };
 
 use crate::msg::{IbcPayload, QueryMsg};
@@ -17,6 +18,7 @@ pub fn instantiate(
     deps.storage.set(
         STATE_KEY,
         &to_json_vec(&State {
+            ibc2_packet_ack_counter: 0,
             ibc2_packet_receive_counter: 0,
             ibc2_packet_timeout_counter: 0,
             last_source_client: "".to_owned(),
@@ -40,6 +42,29 @@ pub fn query(deps: Deps, _env: Env, msg: QueryMsg) -> StdResult<QueryResponse> {
     }
 }
 
+#[entry_point]
+pub fn ibc2_packet_ack(
+    deps: DepsMut,
+    _env: Env,
+    _msg: Ibc2PacketAckMsg,
+) -> StdResult<IbcBasicResponse> {
+    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_ack_counter: state.ibc2_packet_ack_counter + 1,
+            ..state
+        })?,
+    );
+
+    Ok(IbcBasicResponse::default())
+}
+
 #[entry_point]
 pub fn ibc2_packet_receive(
     deps: DepsMut,

contracts/ibc2/src/state.rs

@@ -3,6 +3,7 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Default, Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
 pub struct State {
+    pub ibc2_packet_ack_counter: u32,
     pub ibc2_packet_receive_counter: u32,
     pub ibc2_packet_timeout_counter: u32,
     pub last_source_client: String,

packages/std/src/exports/exports.rs

@@ -26,7 +26,7 @@ use crate::ibc::{
 };
 use crate::ibc::{IbcChannelOpenMsg, IbcChannelOpenResponse};
 #[cfg(feature = "ibc2")]
-use crate::ibc2::{Ibc2PacketReceiveMsg, Ibc2PacketTimeoutMsg};
+use crate::ibc2::{Ibc2PacketAckMsg, Ibc2PacketReceiveMsg, Ibc2PacketTimeoutMsg};
 use crate::query::CustomQuery;
 use crate::results::{ContractResult, QueryResponse, Reply, Response};
 use crate::serde::{from_json, to_json_vec};
@@ -525,6 +525,35 @@ where
     Region::from_vec(v).to_heap_ptr() as u32
 }
 
+/// do_ibc2_packet_ack is designed for use with #[entry_point] to make a "C" extern
+///
+/// contract_fn is called when this chain receives an Ibc2 acknowledge payload on port belonging
+/// to this contract
+///
+/// - `Q`: custom query type (see QueryRequest)
+/// - `C`: custom response message type (see CosmosMsg)
+/// - `E`: error type for responses
+#[cfg(feature = "ibc2")]
+pub fn do_ibc2_packet_ack<Q, C, E>(
+    contract_fn: &dyn Fn(DepsMut<Q>, Env, Ibc2PacketAckMsg) -> Result<IbcBasicResponse<C>, E>,
+    env_ptr: u32,
+    msg_ptr: u32,
+) -> u32
+where
+    Q: CustomQuery,
+    C: CustomMsg,
+    E: ToString,
+{
+    install_panic_handler();
+    let res = _do_ibc2_packet_ack(
+        contract_fn,
+        env_ptr as *mut Region<Owned>,
+        msg_ptr as *mut Region<Owned>,
+    );
+    let v = to_json_vec(&res).unwrap();
+    Region::from_vec(v).to_heap_ptr() as u32
+}
+
 /// do_ibc2_packet_receive is designed for use with #[entry_point] to make a "C" extern
 ///
 /// contract_fn is called when this chain receives an Ibc2 payload on port belonging
@@ -938,6 +967,29 @@ where
     contract_fn(deps.as_mut(), env, msg).into()
 }
 
+#[cfg(feature = "ibc2")]
+fn _do_ibc2_packet_ack<Q, C, E>(
+    contract_fn: &dyn Fn(DepsMut<Q>, Env, Ibc2PacketAckMsg) -> Result<IbcBasicResponse<C>, E>,
+    env_ptr: *mut Region<Owned>,
+    msg_ptr: *mut Region<Owned>,
+) -> ContractResult<IbcBasicResponse<C>>
+where
+    Q: CustomQuery,
+    C: CustomMsg,
+    E: ToString,
+{
+    let env: Vec<u8> =
+        unsafe { Region::from_heap_ptr(ptr::NonNull::new(env_ptr).unwrap()).into_vec() };
+    let msg: Vec<u8> =
+        unsafe { Region::from_heap_ptr(ptr::NonNull::new(msg_ptr).unwrap()).into_vec() };
+
+    let env: Env = try_into_contract_result!(from_json(env));
+    let msg: Ibc2PacketAckMsg = try_into_contract_result!(from_json(msg));
+
+    let mut deps = deps_from_imports();
+    contract_fn(deps.as_mut(), env, msg).into()
+}
+
 #[cfg(feature = "ibc2")]
 fn _do_ibc2_packet_receive<Q, C, E>(
     contract_fn: &dyn Fn(DepsMut<Q>, Env, Ibc2PacketReceiveMsg) -> Result<IbcReceiveResponse<C>, E>,

packages/std/src/exports/mod.rs

@@ -10,7 +10,7 @@ pub use exports::{
     do_query, do_reply, do_sudo,
 };
 #[cfg(feature = "ibc2")]
-pub use exports::{do_ibc2_packet_receive, do_ibc2_packet_timeout};
+pub use exports::{do_ibc2_packet_ack, do_ibc2_packet_receive, do_ibc2_packet_timeout};
 #[cfg(feature = "stargate")]
 pub use exports::{
     do_ibc_channel_close, do_ibc_channel_connect, do_ibc_channel_open, do_ibc_packet_ack,

packages/std/src/ibc2.rs

@@ -132,6 +132,35 @@ impl Ibc2PacketTimeoutMsg {
     }
 }
 
+/// Message sent to the IBCv2 app upon receiving an acknowledgement packet
+#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, JsonSchema)]
+#[non_exhaustive]
+pub struct Ibc2PacketAckMsg {
+    pub source_client: String,
+    pub destination_client: String,
+    pub data: Ibc2Payload,
+    pub acknowledgement: Vec<u8>,
+    pub relayer: Addr,
+}
+
+impl Ibc2PacketAckMsg {
+    pub fn new(
+        source_client: String,
+        destination_client: String,
+        data: Ibc2Payload,
+        acknowledgement: Vec<u8>,
+        relayer: Addr,
+    ) -> Self {
+        Self {
+            source_client,
+            destination_client,
+            data,
+            acknowledgement,
+            relayer,
+        }
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use serde_json::to_string;