Update IbcAcknowledgement type

Author: ethanfrey

packages/std/src/ibc.rs

@@ -185,11 +185,18 @@ pub struct IbcPacket {
 }
 
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
-pub struct IbcAcknowledgement {
-    pub acknowledgement: Binary,
+pub struct IbcAcknowledgementWithPacket {
+    pub acknowledgement: IbcAcknowledgement,
     pub original_packet: IbcPacket,
 }
 
+#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
+pub struct IbcAcknowledgement {
+    pub data: Binary,
+    // we may add more info here in the future (meta-data from the acknowledgement)
+    // there have been proposals to extend this type in core ibc for future versions
+}
+
 /// This is the return value for the majority of the ibc handlers.
 /// That are able to dispatch messages / events on their own,
 /// but have no meaningful return value to the calling code.

packages/std/src/ibc_exports.rs

@@ -12,7 +12,7 @@ use crate::memory::{consume_region, release_buffer, Region};
 use crate::results::ContractResult;
 use crate::serde::{from_slice, to_vec};
 use crate::types::Env;
-use crate::{IbcAcknowledgement, IbcPacket, IbcReceiveResponse};
+use crate::{IbcAcknowledgementWithPacket, IbcPacket, IbcReceiveResponse};
 
 // TODO: replace with https://doc.rust-lang.org/std/ops/trait.Try.html once stabilized
 macro_rules! r#try_into_contract_result {
@@ -177,7 +177,11 @@ where
 /// contract_fn is called when this chain receives an IBC Acknowledgement for a packet
 /// that this contract previously sent
 pub fn do_ibc_packet_ack<C, E>(
-    contract_fn: &dyn Fn(DepsMut, Env, IbcAcknowledgement) -> Result<IbcBasicResponse<C>, E>,
+    contract_fn: &dyn Fn(
+        DepsMut,
+        Env,
+        IbcAcknowledgementWithPacket,
+    ) -> Result<IbcBasicResponse<C>, E>,
     env_ptr: u32,
     msg_ptr: u32,
 ) -> u32
@@ -191,7 +195,11 @@ where
 }
 
 fn _do_ibc_packet_ack<C, E>(
-    contract_fn: &dyn Fn(DepsMut, Env, IbcAcknowledgement) -> Result<IbcBasicResponse<C>, E>,
+    contract_fn: &dyn Fn(
+        DepsMut,
+        Env,
+        IbcAcknowledgementWithPacket,
+    ) -> Result<IbcBasicResponse<C>, E>,
     env_ptr: *mut Region,
     msg_ptr: *mut Region,
 ) -> ContractResult<IbcBasicResponse<C>>
@@ -203,7 +211,7 @@ where
     let msg: Vec<u8> = unsafe { consume_region(msg_ptr) };
 
     let env: Env = try_into_contract_result!(from_slice(&env));
-    let msg: IbcAcknowledgement = try_into_contract_result!(from_slice(&msg));
+    let msg: IbcAcknowledgementWithPacket = try_into_contract_result!(from_slice(&msg));
 
     let mut deps = make_dependencies();
     contract_fn(deps.as_mut(), env, msg).into()

packages/std/src/lib.rs

@@ -34,8 +34,8 @@ pub use crate::errors::{
 };
 #[cfg(feature = "stargate")]
 pub use crate::ibc::{
-    IbcAcknowledgement, IbcBasicResponse, IbcChannel, IbcEndpoint, IbcMsg, IbcOrder, IbcPacket,
-    IbcReceiveResponse, IbcTimeout, IbcTimeoutBlock,
+    IbcAcknowledgementWithPacket, IbcBasicResponse, IbcChannel, IbcEndpoint, IbcMsg, IbcOrder,
+    IbcPacket, IbcReceiveResponse, IbcTimeout, IbcTimeoutBlock,
 };
 #[cfg(feature = "iterator")]
 #[allow(deprecated)]

packages/vm/src/calls.rs

@@ -6,7 +6,7 @@ use wasmer::Val;
 use cosmwasm_std::{ContractResult, Env, MessageInfo, QueryResponse, Reply, Response};
 #[cfg(feature = "stargate")]
 use cosmwasm_std::{
-    IbcAcknowledgement, IbcBasicResponse, IbcChannel, IbcPacket, IbcReceiveResponse,
+    IbcAcknowledgementWithPacket, IbcBasicResponse, IbcChannel, IbcPacket, IbcReceiveResponse,
 };
 
 use crate::backend::{BackendApi, Querier, Storage};
@@ -294,7 +294,7 @@ where
 pub fn call_ibc_packet_ack<A, S, Q, U>(
     instance: &mut Instance<A, S, Q>,
     env: &Env,
-    ack: &IbcAcknowledgement,
+    ack: &IbcAcknowledgementWithPacket,
 ) -> VmResult<ContractResult<IbcBasicResponse<U>>>
 where
     A: BackendApi + 'static,
@@ -745,7 +745,7 @@ mod tests {
             let mut instance = mock_instance(&CONTRACT, &[]);
             setup(&mut instance, CHANNEL_ID, ACCOUNT);
             let packet = mock_ibc_packet_ack(CHANNEL_ID, br#"{}"#).unwrap();
-            let ack = IbcAcknowledgement {
+            let ack = IbcAcknowledgementWithPacket {
                 acknowledgement: br#"{}"#.into(),
                 original_packet: packet,
             };

packages/vm/src/testing/calls.rs

@@ -8,7 +8,7 @@ use std::fmt;
 use cosmwasm_std::{ContractResult, Env, MessageInfo, QueryResponse, Reply, Response};
 #[cfg(feature = "stargate")]
 use cosmwasm_std::{
-    IbcAcknowledgement, IbcBasicResponse, IbcChannel, IbcPacket, IbcReceiveResponse,
+    IbcAcknowledgementWithPacket, IbcBasicResponse, IbcChannel, IbcPacket, IbcReceiveResponse,
 };
 
 use crate::calls::{
@@ -214,7 +214,7 @@ where
 pub fn ibc_packet_ack<A, S, Q, U>(
     instance: &mut Instance<A, S, Q>,
     env: Env,
-    ack: IbcAcknowledgement,
+    ack: IbcAcknowledgementWithPacket,
 ) -> ContractResult<IbcBasicResponse<U>>
 where
     A: BackendApi + 'static,