Merge pull request #857 from CosmWasm/854-submsg-reply-control

854 submsg reply control

contracts/reflect/schema/execute_msg.json

@@ -396,6 +396,15 @@
         }
       }
     },
+    "ReplyOn": {
+      "description": "Use this to define when the contract gets a response callback. If you only need it for errors or success you can select just those in order to save gas.",
+      "type": "string",
+      "enum": [
+        "always",
+        "error",
+        "success"
+      ]
+    },
     "StakingMsg": {
       "description": "The message types of the staking module.\n\nSee https://github.com/cosmos/cosmos-sdk/blob/v0.40.0/proto/cosmos/staking/v1beta1/tx.proto",
       "anyOf": [
@@ -517,7 +526,8 @@
       "type": "object",
       "required": [
         "id",
-        "msg"
+        "msg",
+        "reply_on"
       ],
       "properties": {
         "gas_limit": {
@@ -535,6 +545,9 @@
         },
         "msg": {
           "$ref": "#/definitions/CosmosMsg_for_CustomMsg"
+        },
+        "reply_on": {
+          "$ref": "#/definitions/ReplyOn"
         }
       }
     },

contracts/reflect/schema/response_for__custom_msg.json

@@ -384,6 +384,15 @@
         }
       }
     },
+    "ReplyOn": {
+      "description": "Use this to define when the contract gets a response callback. If you only need it for errors or success you can select just those in order to save gas.",
+      "type": "string",
+      "enum": [
+        "always",
+        "error",
+        "success"
+      ]
+    },
     "StakingMsg": {
       "description": "The message types of the staking module.\n\nSee https://github.com/cosmos/cosmos-sdk/blob/v0.40.0/proto/cosmos/staking/v1beta1/tx.proto",
       "anyOf": [
@@ -505,7 +514,8 @@
       "type": "object",
       "required": [
         "id",
-        "msg"
+        "msg",
+        "reply_on"
       ],
       "properties": {
         "gas_limit": {
@@ -523,6 +533,9 @@
         },
         "msg": {
           "$ref": "#/definitions/CosmosMsg_for_CustomMsg"
+        },
+        "reply_on": {
+          "$ref": "#/definitions/ReplyOn"
         }
       }
     },

contracts/reflect/src/contract.rs

@@ -198,7 +198,7 @@ mod tests {
     use cosmwasm_std::testing::{mock_env, mock_info, MOCK_CONTRACT_ADDR};
     use cosmwasm_std::{
         coin, coins, from_binary, AllBalanceResponse, Api, BankMsg, BankQuery, Binary,
-        ContractResult, Event, StakingMsg, StdError, SubcallResponse,
+        ContractResult, Event, ReplyOn, StakingMsg, StdError, SubcallResponse,
     };
 
     #[test]
@@ -466,6 +466,7 @@ mod tests {
                 amount: coins(1, "token"),
             }
             .into(),
+            reply_on: ReplyOn::default(),
         };
 
         let msg = ExecuteMsg::ReflectSubCall {

contracts/reflect/tests/integration.rs

@@ -204,6 +204,7 @@ fn reflect_subcall() {
             amount: coins(1, "token"),
         }
         .into(),
+        reply_on: Default::default(),
     };
 
     let msg = ExecuteMsg::ReflectSubCall {

packages/std/src/lib.rs

@@ -44,8 +44,8 @@ pub use crate::query::{
 };
 pub use crate::results::{
     attr, wasm_execute, wasm_instantiate, Attribute, BankMsg, ContractResult, CosmosMsg, Empty,
-    Event, QueryResponse, Reply, Response, StakingMsg, SubMsg, SubcallResponse, SystemResult,
-    WasmMsg,
+    Event, QueryResponse, Reply, ReplyOn, Response, StakingMsg, SubMsg, SubcallResponse,
+    SystemResult, WasmMsg,
 };
 #[allow(deprecated)]
 pub use crate::results::{Context, HandleResponse, InitResponse, MigrateResponse};

packages/std/src/results/mod.rs

@@ -18,7 +18,7 @@ pub use cosmos_msg::{wasm_execute, wasm_instantiate, BankMsg, CosmosMsg, Staking
 pub use empty::Empty;
 pub use query::QueryResponse;
 pub use response::Response;
-pub use subcall::{Event, Reply, SubMsg, SubcallResponse};
+pub use subcall::{Event, Reply, ReplyOn, SubMsg, SubcallResponse};
 pub use system_result::SystemResult;
 
 #[deprecated(since = "0.14.0", note = "Renamed to Response.")]

packages/std/src/results/response.rs

@@ -2,7 +2,7 @@ use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use std::fmt;
 
-use crate::Binary;
+use crate::{Binary, ReplyOn};
 
 use super::{Attribute, CosmosMsg, Empty};
 use crate::results::SubMsg;
@@ -125,11 +125,13 @@ where
         id: u64,
         msg: U,
         gas_limit: Option<u64>,
+        reply_on: ReplyOn,
     ) {
         let sub = SubMsg {
             id,
             msg: msg.into(),
             gas_limit,
+            reply_on,
         };
         self.submessages.push(sub);
     }
@@ -157,6 +159,7 @@ mod tests {
                 }
                 .into(),
                 gas_limit: Some(12345u64),
+                reply_on: ReplyOn::Always,
             }],
             messages: vec![BankMsg::Send {
                 to_address: HumanAddr::from("you"),

packages/std/src/results/subcall.rs

@@ -6,6 +6,26 @@ use crate::{Binary, ContractResult};
 
 use super::{Attribute, CosmosMsg, Empty};
 
+/// Use this to define when the contract gets a response callback.
+/// If you only need it for errors or success you can select just those in order
+/// to save gas.
+#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
+#[serde(rename_all = "snake_case")]
+pub enum ReplyOn {
+    /// Always perform a callback after SubMsg is processed
+    Always,
+    /// Only callback if SubMsg returned an error, no callback on success case
+    Error,
+    /// Only callback if SubMsg was successful, no callback on error case
+    Success,
+}
+
+impl Default for ReplyOn {
+    fn default() -> Self {
+        ReplyOn::Always
+    }
+}
+
 /// A sub-message that will guarantee a subcall_response callback on success or error
 /// Note on error the subcall will revert any partial state changes due to this message,
 /// but not revert any state changes in the calling contract (that must be done in the
@@ -18,6 +38,7 @@ where
     pub id: u64,
     pub msg: CosmosMsg<T>,
     pub gas_limit: Option<u64>,
+    pub reply_on: ReplyOn,
 }
 
 /// The Result object returned to subcall_response. We always get the same id back