Merge pull request #321 from CosmWasm/consistent-cw20-binary-receive

Make receiver msg non-optional in cw20 contracts
CosmWasm · Jul 12, 2021 · 070dd73 · 070dd73
2 parents c6f8663 + d50a356
commit 070dd73
Show file tree

Hide file tree

Showing 10 changed files with 21 additions and 52 deletions.
diff --git a/contracts/cw20-escrow/src/integration_test.rs b/contracts/cw20-escrow/src/integration_test.rs
@@ -89,11 +89,10 @@ fn escrow_happy_path_cw20_tokens() {
         end_time: None,
         cw20_whitelist: None,
     });
-    let create_bin = to_binary(&create_msg).unwrap();
     let send_msg = Cw20ExecuteMsg::Send {
         contract: escrow_addr.to_string(),
         amount: Uint128::new(1200),
-        msg: Some(create_bin),
+        msg: to_binary(&create_msg).unwrap(),
     };
     let res = router
         .execute_contract(owner.clone(), cash_addr.clone(), &send_msg, &[])

diff --git a/contracts/cw721-base/schema/execute_msg.json b/contracts/cw721-base/schema/execute_msg.json
@@ -39,21 +39,15 @@
           "type": "object",
           "required": [
             "contract",
+            "msg",
             "token_id"
           ],
           "properties": {
             "contract": {
               "type": "string"
             },
             "msg": {
-              "anyOf": [
-                {
-                  "$ref": "#/definitions/Binary"
-                },
-                {
-                  "type": "null"
-                }
-              ]
+              "$ref": "#/definitions/Binary"
             },
             "token_id": {
               "type": "string"

diff --git a/contracts/cw721-base/src/contract.rs b/contracts/cw721-base/src/contract.rs
@@ -142,7 +142,7 @@ pub fn execute_send_nft(
     info: MessageInfo,
     contract: String,
     token_id: String,
-    msg: Option<Binary>,
+    msg: Binary,
 ) -> Result<Response, ContractError> {
     // Transfer token
     _transfer_nft(deps, &env, &info, &contract, &token_id)?;
@@ -797,7 +797,7 @@ mod tests {
         let send_msg = ExecuteMsg::SendNft {
             contract: target.clone(),
             token_id: token_id.clone(),
-            msg: Some(msg.clone()),
+            msg: msg.clone(),
         };
 
         let random = mock_info("random", &[]);
@@ -811,7 +811,7 @@ mod tests {
         let payload = Cw721ReceiveMsg {
             sender: String::from("venus"),
             token_id: token_id.clone(),
-            msg: Some(msg),
+            msg,
         };
         let expected = SubMsg::new(payload.into_cosmos_msg(target.clone()).unwrap());
         // ensure expected serializes as we think it should
@@ -1009,7 +1009,7 @@ mod tests {
         let send_msg = ExecuteMsg::SendNft {
             contract: String::from("another_contract"),
             token_id: token_id2,
-            msg: Some(to_binary(&msg).unwrap()),
+            msg: to_binary(&msg).unwrap(),
         };
         execute(deps.as_mut(), mock_env(), random, send_msg).unwrap();
 

diff --git a/contracts/cw721-base/src/msg.rs b/contracts/cw721-base/src/msg.rs
@@ -29,7 +29,7 @@ pub enum ExecuteMsg {
     SendNft {
         contract: String,
         token_id: String,
-        msg: Option<Binary>,
+        msg: Binary,
     },
     /// Allows operator to transfer / send the token from the owner's account.
     /// If expiration is set, then this allowance has a time/height limit

diff --git a/packages/cw20/schema/cw20_execute_msg.json b/packages/cw20/schema/cw20_execute_msg.json
@@ -59,7 +59,8 @@
           "type": "object",
           "required": [
             "amount",
-            "contract"
+            "contract",
+            "msg"
           ],
           "properties": {
             "amount": {
@@ -69,14 +70,7 @@
               "type": "string"
             },
             "msg": {
-              "anyOf": [
-                {
-                  "$ref": "#/definitions/Binary"
-                },
-                {
-                  "type": "null"
-                }
-              ]
+              "$ref": "#/definitions/Binary"
             }
           }
         }
@@ -194,6 +188,7 @@
           "required": [
             "amount",
             "contract",
+            "msg",
             "owner"
           ],
           "properties": {
@@ -204,14 +199,7 @@
               "type": "string"
             },
             "msg": {
-              "anyOf": [
-                {
-                  "$ref": "#/definitions/Binary"
-                },
-                {
-                  "type": "null"
-                }
-              ]
+              "$ref": "#/definitions/Binary"
             },
             "owner": {
               "type": "string"

diff --git a/packages/cw20/src/msg.rs b/packages/cw20/src/msg.rs
@@ -16,7 +16,7 @@ pub enum Cw20ExecuteMsg {
     Send {
         contract: String,
         amount: Uint128,
-        msg: Option<Binary>,
+        msg: Binary,
     },
     /// Only with "approval" extension. Allows spender to access an additional amount tokens
     /// from the owner's (env.sender) account. If expires is Some(), overwrites current allowance
@@ -47,7 +47,7 @@ pub enum Cw20ExecuteMsg {
         owner: String,
         contract: String,
         amount: Uint128,
-        msg: Option<Binary>,
+        msg: Binary,
     },
     /// Only with "approval" extension. Destroys tokens forever
     BurnFrom { owner: String, amount: Uint128 },

diff --git a/packages/cw721/schema/cw721_execute_msg.json b/packages/cw721/schema/cw721_execute_msg.json
@@ -38,21 +38,15 @@
           "type": "object",
           "required": [
             "contract",
+            "msg",
             "token_id"
           ],
           "properties": {
             "contract": {
               "type": "string"
             },
             "msg": {
-              "anyOf": [
-                {
-                  "$ref": "#/definitions/Binary"
-                },
-                {
-                  "type": "null"
-                }
-              ]
+              "$ref": "#/definitions/Binary"
             },
             "token_id": {
               "type": "string"

diff --git a/packages/cw721/schema/cw721_receive_msg.json b/packages/cw721/schema/cw721_receive_msg.json
@@ -4,19 +4,13 @@
   "description": "Cw721ReceiveMsg should be de/serialized under `Receive()` variant in a ExecuteMsg",
   "type": "object",
   "required": [
+    "msg",
     "sender",
     "token_id"
   ],
   "properties": {
     "msg": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/Binary"
-        },
-        {
-          "type": "null"
-        }
-      ]
+      "$ref": "#/definitions/Binary"
     },
     "sender": {
       "type": "string"

diff --git a/packages/cw721/src/msg.rs b/packages/cw721/src/msg.rs
@@ -14,7 +14,7 @@ pub enum Cw721ExecuteMsg {
     SendNft {
         contract: String,
         token_id: String,
-        msg: Option<Binary>,
+        msg: Binary,
     },
     /// Allows operator to transfer / send the token from the owner's account.
     /// If expiration is set, then this allowance has a time/height limit

diff --git a/packages/cw721/src/receiver.rs b/packages/cw721/src/receiver.rs
@@ -9,7 +9,7 @@ use cosmwasm_std::{to_binary, Binary, CosmosMsg, StdResult, WasmMsg};
 pub struct Cw721ReceiveMsg {
     pub sender: String,
     pub token_id: String,
-    pub msg: Option<Binary>,
+    pub msg: Binary,
 }
 
 impl Cw721ReceiveMsg {