Merge pull request #961 from CosmWasm/merge-messages-submessages

Merge messages submessages

Author: webmaster128

CHANGELOG.md

@@ -40,6 +40,15 @@ and this project adheres to
   in `cosmwasm-vm` itself instead of being imported from `cosmwasm-crypto`.
 - cosmwasm-vm: Filesystem storage layout now distinguishes clearly between state
   and cache.
+- cosmwasm-std: Add enum case `ReplyOn::Never`; Remove default implementation of
+  `ReplyOn` as there is no natural default case anymore ([#961]).
+- cosmwasm-std: Merge `messages` and `submessages` into one list, using
+  `ReplyOn::Never` to model the "fire and forget" semantics ([#961]).
+- cosmwasm-std: Add `SubMsg` constructors: `::new()`, `::reply_on_error()`,
+  `::reply_on_success()`, `::reply_always()`; Add `with_gas_limit` to add a gas
+  limit to any those constructors ([#961]).
+
+[#961]: https://github.com/CosmWasm/cosmwasm/pull/961
 
 ### Fixed
 

MIGRATING.md

@@ -4,7 +4,64 @@ This guide explains what is needed to upgrade contracts when migrating over
 major releases of `cosmwasm`. Note that you can also view the
 [complete CHANGELOG](./CHANGELOG.md) to understand the differences.
 
-## 0.13 -> 0.14 (unreleased)
+## 0.14 -> 0.15 (unreleased)
+
+- Combine `messages` and `submessages` on the `Response` object. The new format
+  uses `messages: Vec<SubMsg<T>>`, so copy `submessages` content, and wrap old
+  messages using `SubMsg::new`. Here is how to change messages:
+
+  ```rust
+  let send = BankMsg::Send { to_address, amount };
+
+  // before
+  let res = Response {
+    messages: vec![send.into()],
+    ..Response::default()
+  }
+
+  // after
+  let res = Response {
+    messages: vec![SubMsg::new(send)],
+    ..Response::default()
+  }
+
+  // alternate approach
+  let mut res = Response::new();
+  res.add_message(send);
+  ```
+
+  And here is how to change submessages:
+
+  ```rust
+  // before
+  let sub_msg = SubMsg {
+    id: INIT_CALLBACK_ID,
+    msg: msg.into(),
+    gas_limit: None,
+    reply_on: ReplyOn::Success,
+  };
+  let res = Response {
+    submessages: vec![sub_msg],
+    ..Response::default()
+  };
+
+  // after
+  let msg = SubMsg::reply_on_success(msg, INIT_CALLBACK_ID);
+  let res = Response {
+    messages: vec![msg],
+    ..Response::default()
+  };
+
+  // alternate approach
+  let msg = SubMsg::reply_on_success(msg, INIT_CALLBACK_ID);
+  let mut res = Response::new();
+  res.add_submessage(msg);
+  ```
+
+  Note that this means you can mix "messages" and "submessages" in any execution
+  order. You are no more restricted to doing "submessages" first.
+
+## 0.13 -> 0.14
 
 - The minimum Rust supported version for 0.14 is 1.51.0. Verify your Rust
   version is >= 1.51.0 with: `rustc --version`

contracts/burner/src/contract.rs

@@ -1,5 +1,6 @@
 use cosmwasm_std::{
     attr, entry_point, BankMsg, DepsMut, Env, MessageInfo, Order, Response, StdError, StdResult,
+    SubMsg,
 };
 
 use crate::msg::{InstantiateMsg, MigrateMsg};
@@ -39,8 +40,7 @@ pub fn migrate(deps: DepsMut, env: Env, msg: MigrateMsg) -> StdResult<Response>
     let data_msg = format!("burnt {} keys", count).into_bytes();
 
     Ok(Response {
-        submessages: vec![],
-        messages: vec![send.into()],
+        messages: vec![SubMsg::new(send)],
         attributes: vec![attr("action", "burn"), attr("payout", msg.payout)],
         data: Some(data_msg.into()),
     })
@@ -90,11 +90,10 @@ mod tests {
         let msg = res.messages.get(0).expect("no message");
         assert_eq!(
             msg,
-            &BankMsg::Send {
+            &SubMsg::new(BankMsg::Send {
                 to_address: payout,
                 amount: coins(123456, "gold"),
-            }
-            .into(),
+            })
         );
 
         // check there is no data in storage

contracts/burner/tests/integration.rs

@@ -17,7 +17,7 @@
 //!      });
 //! 4. Anywhere you see query(&deps, ...) you must replace it with query(&mut deps, ...)
 
-use cosmwasm_std::{coins, BankMsg, ContractResult, Order, Response};
+use cosmwasm_std::{coins, BankMsg, ContractResult, Order, Response, SubMsg};
 use cosmwasm_vm::testing::{instantiate, migrate, mock_env, mock_info, mock_instance};
 
 use burner::msg::{InstantiateMsg, MigrateMsg};
@@ -70,11 +70,10 @@ fn migrate_cleans_up_data() {
     let msg = res.messages.get(0).expect("no message");
     assert_eq!(
         msg,
-        &BankMsg::Send {
+        &SubMsg::new(BankMsg::Send {
             to_address: payout,
             amount: coins(123456, "gold"),
-        }
-        .into(),
+        }),
     );
 
     // check there is no data in storage

contracts/hackatom/src/contract.rs

@@ -285,7 +285,7 @@ mod tests {
         mock_dependencies, mock_dependencies_with_balances, mock_env, mock_info, MOCK_CONTRACT_ADDR,
     };
     // import trait Storage to get access to read
-    use cosmwasm_std::{attr, coins, Binary, Storage};
+    use cosmwasm_std::{attr, coins, Binary, Storage, SubMsg};
 
     #[test]
     fn proper_initialization() {
@@ -394,7 +394,7 @@ mod tests {
         let res = sudo(deps.as_mut(), mock_env(), sys_msg).unwrap();
         assert_eq!(1, res.messages.len());
         let msg = res.messages.get(0).expect("no message");
-        assert_eq!(msg, &BankMsg::Send { to_address, amount }.into(),);
+        assert_eq!(msg, &SubMsg::new(BankMsg::Send { to_address, amount }));
     }
 
     #[test]
@@ -446,11 +446,10 @@ mod tests {
         let msg = execute_res.messages.get(0).expect("no message");
         assert_eq!(
             msg,
-            &BankMsg::Send {
+            &SubMsg::new(BankMsg::Send {
                 to_address: beneficiary,
                 amount: coins(1000, "earth"),
-            }
-            .into(),
+            }),
         );
         assert_eq!(
             execute_res.attributes,

contracts/hackatom/tests/integration.rs

@@ -19,7 +19,7 @@
 
 use cosmwasm_std::{
     attr, coins, from_binary, to_vec, Addr, AllBalanceResponse, BankMsg, Binary, ContractResult,
-    Empty, Response,
+    Empty, Response, SubMsg,
 };
 use cosmwasm_vm::{
     call_execute, from_slice,
@@ -173,7 +173,7 @@ fn sudo_can_steal_tokens() {
     let res: Response = sudo(&mut deps, mock_env(), sys_msg).unwrap();
     assert_eq!(1, res.messages.len());
     let msg = res.messages.get(0).expect("no message");
-    assert_eq!(msg, &BankMsg::Send { to_address, amount }.into(),);
+    assert_eq!(msg, &SubMsg::new(BankMsg::Send { to_address, amount }));
 }
 
 #[test]
@@ -242,11 +242,10 @@ fn execute_release_works() {
     let msg = execute_res.messages.get(0).expect("no message");
     assert_eq!(
         msg,
-        &BankMsg::Send {
+        &SubMsg::new(BankMsg::Send {
             to_address: beneficiary,
             amount: coins(1000, "earth"),
-        }
-        .into(),
+        }),
     );
     assert_eq!(
         execute_res.attributes,

contracts/ibc-reflect-send/src/contract.rs

@@ -23,10 +23,8 @@ pub fn instantiate(
     config(deps.storage).save(&cfg)?;
 
     Ok(Response {
-        data: None,
-        submessages: vec![],
-        messages: vec![],
         attributes: vec![attr("action", "instantiate")],
+        ..Response::default()
     })
 }
 
@@ -61,13 +59,11 @@ pub fn handle_update_admin(
     config(deps.storage).save(&cfg)?;
 
     Ok(Response {
-        submessages: vec![],
-        messages: vec![],
         attributes: vec![
             attr("action", "handle_update_admin"),
             attr("new_admin", cfg.admin),
         ],
-        data: None,
+        ..Response::default()
     })
 }
 
@@ -94,12 +90,10 @@ pub fn handle_send_msgs(
         timeout: env.block.time.plus_seconds(PACKET_LIFETIME).into(),
     };
 
-    Ok(Response {
-        submessages: vec![],
-        messages: vec![msg.into()],
-        attributes: vec![attr("action", "handle_send_msgs")],
-        data: None,
-    })
+    let mut res = Response::new();
+    res.add_message(msg);
+    res.add_attribute("action", "handle_send_msgs");
+    Ok(res)
 }
 
 pub fn handle_check_remote_balance(
@@ -124,12 +118,10 @@ pub fn handle_check_remote_balance(
         timeout: env.block.time.plus_seconds(PACKET_LIFETIME).into(),
     };
 
-    Ok(Response {
-        submessages: vec![],
-        messages: vec![msg.into()],
-        attributes: vec![attr("action", "handle_check_remote_balance")],
-        data: None,
-    })
+    let mut res = Response::new();
+    res.add_message(msg);
+    res.add_attribute("action", "handle_check_remote_balance");
+    Ok(res)
 }
 
 pub fn handle_send_funds(
@@ -174,12 +166,10 @@ pub fn handle_send_funds(
         timeout: env.block.time.plus_seconds(PACKET_LIFETIME).into(),
     };
 
-    Ok(Response {
-        submessages: vec![],
-        messages: vec![msg.into()],
-        attributes: vec![attr("action", "handle_send_funds")],
-        data: None,
-    })
+    let mut res = Response::new();
+    res.add_message(msg);
+    res.add_attribute("action", "handle_send_funds");
+    Ok(res)
 }
 
 #[entry_point]

contracts/ibc-reflect-send/src/ibc.rs

@@ -1,6 +1,6 @@
 use cosmwasm_std::{
     attr, entry_point, from_slice, to_binary, DepsMut, Env, IbcAcknowledgement, IbcBasicResponse,
-    IbcChannel, IbcMsg, IbcOrder, IbcPacket, IbcReceiveResponse, StdError, StdResult,
+    IbcChannel, IbcMsg, IbcOrder, IbcPacket, IbcReceiveResponse, StdError, StdResult, SubMsg,
 };
 
 use crate::ibc_msg::{
@@ -62,8 +62,7 @@ pub fn ibc_channel_connect(
     };
 
     Ok(IbcBasicResponse {
-        submessages: vec![],
-        messages: vec![msg.into()],
+        messages: vec![SubMsg::new(msg)],
         attributes: vec![
             attr("action", "ibc_connect"),
             attr("channel_id", channel_id),
@@ -83,9 +82,8 @@ pub fn ibc_channel_close(
     accounts(deps.storage).remove(channel_id.as_bytes());
 
     Ok(IbcBasicResponse {
-        submessages: vec![],
-        messages: vec![],
         attributes: vec![attr("action", "ibc_close"), attr("channel_id", channel_id)],
+        messages: vec![],
     })
 }
 
@@ -98,7 +96,6 @@ pub fn ibc_packet_receive(
 ) -> StdResult<IbcReceiveResponse> {
     Ok(IbcReceiveResponse {
         acknowledgement: b"{}".into(),
-        submessages: vec![],
         messages: vec![],
         attributes: vec![attr("action", "ibc_packet_ack")],
     })
@@ -139,7 +136,6 @@ fn acknowledge_dispatch(
 ) -> StdResult<IbcBasicResponse> {
     // TODO: actually handle success/error?
     Ok(IbcBasicResponse {
-        submessages: vec![],
         messages: vec![],
         attributes: vec![attr("action", "acknowledge_dispatch")],
     })
@@ -157,7 +153,6 @@ fn acknowledge_who_am_i(
         AcknowledgementMsg::Ok(res) => res,
         AcknowledgementMsg::Err(e) => {
             return Ok(IbcBasicResponse {
-                submessages: vec![],
                 messages: vec![],
                 attributes: vec![attr("action", "acknowledge_who_am_i"), attr("error", e)],
             })
@@ -178,7 +173,6 @@ fn acknowledge_who_am_i(
     })?;
 
     Ok(IbcBasicResponse {
-        submessages: vec![],
         messages: vec![],
         attributes: vec![attr("action", "acknowledge_who_am_i")],
     })
@@ -196,7 +190,6 @@ fn acknowledge_balances(
         AcknowledgementMsg::Ok(res) => res,
         AcknowledgementMsg::Err(e) => {
             return Ok(IbcBasicResponse {
-                submessages: vec![],
                 messages: vec![],
                 attributes: vec![attr("action", "acknowledge_balances"), attr("error", e)],
             })
@@ -225,7 +218,6 @@ fn acknowledge_balances(
     })?;
 
     Ok(IbcBasicResponse {
-        submessages: vec![],
         messages: vec![],
         attributes: vec![attr("action", "acknowledge_balances")],
     })
@@ -239,7 +231,6 @@ pub fn ibc_packet_timeout(
     _packet: IbcPacket,
 ) -> StdResult<IbcBasicResponse> {
     Ok(IbcBasicResponse {
-        submessages: vec![],
         messages: vec![],
         attributes: vec![attr("action", "ibc_packet_timeout")],
     })
@@ -283,7 +274,7 @@ mod tests {
 
         // this should send a WhoAmI request, which is received some blocks later
         assert_eq!(1, res.messages.len());
-        match &res.messages[0] {
+        match &res.messages[0].msg {
             CosmosMsg::Ibc(IbcMsg::SendPacket {
                 channel_id: packet_channel,
                 ..
@@ -376,7 +367,7 @@ mod tests {
         let info = mock_info(CREATOR, &[]);
         let mut res = execute(deps.as_mut(), mock_env(), info, handle_msg).unwrap();
         assert_eq!(1, res.messages.len());
-        let packet = match res.messages.swap_remove(0) {
+        let packet = match res.messages.swap_remove(0).msg {
             CosmosMsg::Ibc(IbcMsg::SendPacket {
                 channel_id, data, ..
             }) => {
@@ -435,7 +426,7 @@ mod tests {
         let info = mock_info(CREATOR, &coins(12344, "utrgd"));
         let res = execute(deps.as_mut(), mock_env(), info, msg).unwrap();
         assert_eq!(1, res.messages.len());
-        match &res.messages[0] {
+        match &res.messages[0].msg {
             CosmosMsg::Ibc(IbcMsg::Transfer {
                 channel_id,
                 to_address,