Merge pull request #1572 from CosmWasm/fix-VoteWeighted

webmaster128 · web-flow · commit 099384ac56b0 · 2023-01-11T19:10:40.000+01:00
Fix VoteWeighted
diff --git a/contracts/ibc-reflect-send/schema/ibc-reflect-send.json b/contracts/ibc-reflect-send/schema/ibc-reflect-send.json
@@ -378,7 +378,12 @@
                     "minimum": 0.0
                   },
                   "vote": {
-                    "$ref": "#/definitions/VoteOption"
+                    "description": "The vote option.\n\nThis should be called \"option\" for consistency with Cosmos SDK. Sorry for that. See <https://github.com/CosmWasm/cosmwasm/issues/1571>.",
+                    "allOf": [
+                      {
+                        "$ref": "#/definitions/VoteOption"
+                      }
+                    ]
                   }
                 }
               }
diff --git a/contracts/ibc-reflect-send/schema/packet_msg.json b/contracts/ibc-reflect-send/schema/packet_msg.json
@@ -316,7 +316,12 @@
                   "minimum": 0.0
                 },
                 "vote": {
-                  "$ref": "#/definitions/VoteOption"
+                  "description": "The vote option.\n\nThis should be called \"option\" for consistency with Cosmos SDK. Sorry for that. See <https://github.com/CosmWasm/cosmwasm/issues/1571>.",
+                  "allOf": [
+                    {
+                      "$ref": "#/definitions/VoteOption"
+                    }
+                  ]
                 }
               }
             }
diff --git a/contracts/ibc-reflect-send/schema/raw/execute.json b/contracts/ibc-reflect-send/schema/raw/execute.json
@@ -367,7 +367,12 @@
                   "minimum": 0.0
                 },
                 "vote": {
-                  "$ref": "#/definitions/VoteOption"
+                  "description": "The vote option.\n\nThis should be called \"option\" for consistency with Cosmos SDK. Sorry for that. See <https://github.com/CosmWasm/cosmwasm/issues/1571>.",
+                  "allOf": [
+                    {
+                      "$ref": "#/definitions/VoteOption"
+                    }
+                  ]
                 }
               }
             }
diff --git a/contracts/ibc-reflect/schema/packet_msg.json b/contracts/ibc-reflect/schema/packet_msg.json
@@ -245,7 +245,12 @@
                   "minimum": 0.0
                 },
                 "vote": {
-                  "$ref": "#/definitions/VoteOption"
+                  "description": "The vote option.\n\nThis should be called \"option\" for consistency with Cosmos SDK. Sorry for that. See <https://github.com/CosmWasm/cosmwasm/issues/1571>.",
+                  "allOf": [
+                    {
+                      "$ref": "#/definitions/VoteOption"
+                    }
+                  ]
                 }
               }
             }
diff --git a/contracts/reflect/schema/raw/execute.json b/contracts/reflect/schema/raw/execute.json
@@ -362,7 +362,12 @@
                   "minimum": 0.0
                 },
                 "vote": {
-                  "$ref": "#/definitions/VoteOption"
+                  "description": "The vote option.\n\nThis should be called \"option\" for consistency with Cosmos SDK. Sorry for that. See <https://github.com/CosmWasm/cosmwasm/issues/1571>.",
+                  "allOf": [
+                    {
+                      "$ref": "#/definitions/VoteOption"
+                    }
+                  ]
                 }
               }
             }
diff --git a/contracts/reflect/schema/reflect.json b/contracts/reflect/schema/reflect.json
@@ -372,7 +372,12 @@
                     "minimum": 0.0
                   },
                   "vote": {
-                    "$ref": "#/definitions/VoteOption"
+                    "description": "The vote option.\n\nThis should be called \"option\" for consistency with Cosmos SDK. Sorry for that. See <https://github.com/CosmWasm/cosmwasm/issues/1571>.",
+                    "allOf": [
+                      {
+                        "$ref": "#/definitions/VoteOption"
+                      }
+                    ]
                   }
                 }
               }
diff --git a/packages/std/src/results/cosmos_msg.rs b/packages/std/src/results/cosmos_msg.rs
@@ -208,12 +208,19 @@ pub enum WasmMsg {
 #[serde(rename_all = "snake_case")]
 pub enum GovMsg {
     /// This maps directly to [MsgVote](https://github.com/cosmos/cosmos-sdk/blob/v0.42.5/proto/cosmos/gov/v1beta1/tx.proto#L46-L56) in the Cosmos SDK with voter set to the contract address.
-    Vote { proposal_id: u64, vote: VoteOption },
+    Vote {
+        proposal_id: u64,
+        /// The vote option.
+        ///
+        /// This should be called "option" for consistency with Cosmos SDK. Sorry for that.
+        /// See <https://github.com/CosmWasm/cosmwasm/issues/1571>.
+        vote: VoteOption,
+    },
     /// This maps directly to [MsgVoteWeighted](https://github.com/cosmos/cosmos-sdk/blob/v0.45.8/proto/cosmos/gov/v1beta1/tx.proto#L66-L78) in the Cosmos SDK with voter set to the contract address.
     #[cfg(feature = "cosmwasm_1_2")]
     VoteWeighted {
         proposal_id: u64,
-        vote: WeightedVoteOption,
+        options: Vec<WeightedVoteOption>,
     },
 }
 
@@ -324,13 +331,76 @@ mod tests {
         }
     }
 
-    #[cosmwasm_schema::cw_serde]
-    enum ExecuteMsg {
-        Mint { coin: Coin },
+    #[test]
+    fn wasm_msg_serializes_to_correct_json() {
+        // Instantiate with admin
+        let msg = WasmMsg::Instantiate {
+            admin: Some("king".to_string()),
+            code_id: 7897,
+            msg: br#"{"claim":{}}"#.into(),
+            funds: vec![],
+            label: "my instance".to_string(),
+        };
+        let json = to_binary(&msg).unwrap();
+        assert_eq!(
+            String::from_utf8_lossy(&json),
+            r#"{"instantiate":{"admin":"king","code_id":7897,"msg":"eyJjbGFpbSI6e319","funds":[],"label":"my instance"}}"#,
+        );
+
+        // Instantiate without admin
+        let msg = WasmMsg::Instantiate {
+            admin: None,
+            code_id: 7897,
+            msg: br#"{"claim":{}}"#.into(),
+            funds: vec![],
+            label: "my instance".to_string(),
+        };
+        let json = to_binary(&msg).unwrap();
+        assert_eq!(
+            String::from_utf8_lossy(&json),
+            r#"{"instantiate":{"admin":null,"code_id":7897,"msg":"eyJjbGFpbSI6e319","funds":[],"label":"my instance"}}"#,
+        );
+
+        // Instantiate with funds
+        let msg = WasmMsg::Instantiate {
+            admin: None,
+            code_id: 7897,
+            msg: br#"{"claim":{}}"#.into(),
+            funds: vec![coin(321, "stones")],
+            label: "my instance".to_string(),
+        };
+        let json = to_binary(&msg).unwrap();
+        assert_eq!(
+            String::from_utf8_lossy(&json),
+            r#"{"instantiate":{"admin":null,"code_id":7897,"msg":"eyJjbGFpbSI6e319","funds":[{"denom":"stones","amount":"321"}],"label":"my instance"}}"#,
+        );
+
+        // Instantiate2
+        #[cfg(feature = "cosmwasm_1_2")]
+        {
+            let msg = WasmMsg::Instantiate2 {
+                admin: None,
+                code_id: 7897,
+                label: "my instance".to_string(),
+                msg: br#"{"claim":{}}"#.into(),
+                funds: vec![coin(321, "stones")],
+                salt: Binary::from_base64("UkOVazhiwoo=").unwrap(),
+            };
+            let json = to_binary(&msg).unwrap();
+            assert_eq!(
+                String::from_utf8_lossy(&json),
+                r#"{"instantiate2":{"admin":null,"code_id":7897,"label":"my instance","msg":"eyJjbGFpbSI6e319","funds":[{"denom":"stones","amount":"321"}],"salt":"UkOVazhiwoo="}}"#,
+            );
+        }
     }
 
     #[test]
     fn wasm_msg_debug_decodes_binary_string_when_possible() {
+        #[cosmwasm_schema::cw_serde]
+        enum ExecuteMsg {
+            Mint { coin: Coin },
+        }
+
         let msg = WasmMsg::Execute {
             contract_addr: "joe".to_string(),
             msg: to_binary(&ExecuteMsg::Mint {
@@ -359,4 +429,47 @@ mod tests {
             "Execute { contract_addr: \"joe\", msg: Binary(009f9296), funds: [] }"
         );
     }
+
+    #[test]
+    #[cfg(feature = "stargate")]
+    fn gov_msg_serializes_to_correct_json() {
+        // Vote
+        let msg = GovMsg::Vote {
+            proposal_id: 4,
+            vote: VoteOption::NoWithVeto,
+        };
+        let json = to_binary(&msg).unwrap();
+        assert_eq!(
+            String::from_utf8_lossy(&json),
+            r#"{"vote":{"proposal_id":4,"vote":"no_with_veto"}}"#,
+        );
+
+        // VoteWeighted
+        #[cfg(feature = "cosmwasm_1_2")]
+        {
+            let msg = GovMsg::VoteWeighted {
+                proposal_id: 25,
+                options: vec![
+                    WeightedVoteOption {
+                        weight: Decimal::percent(25),
+                        option: VoteOption::Yes,
+                    },
+                    WeightedVoteOption {
+                        weight: Decimal::percent(25),
+                        option: VoteOption::No,
+                    },
+                    WeightedVoteOption {
+                        weight: Decimal::percent(50),
+                        option: VoteOption::Abstain,
+                    },
+                ],
+            };
+
+            let json = to_binary(&msg).unwrap();
+            assert_eq!(
+                String::from_utf8_lossy(&json),
+                r#"{"vote_weighted":{"proposal_id":25,"options":[{"option":"yes","weight":"0.25"},{"option":"no","weight":"0.25"},{"option":"abstain","weight":"0.5"}]}}"#,
+            );
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -378,7 +378,12 @@`
`378`	`378`	`"minimum": 0.0`
`379`	`379`	`},`
`380`	`380`	`"vote": {`
`381`		`- "$ref": "#/definitions/VoteOption"`
	`381`	`+ "description": "The vote option.\n\nThis should be called \"option\" for consistency with Cosmos SDK. Sorry for that. See <https://github.com/CosmWasm/cosmwasm/issues/1571>.",`
	`382`	`+ "allOf": [`
	`383`	`+ {`
	`384`	`+ "$ref": "#/definitions/VoteOption"`
	`385`	`+ }`
	`386`	`+ ]`
`382`	`387`	`}`
`383`	`388`	`}`
`384`	`389`	`}`
Original file line number	Diff line number	Diff line change
`@@ -316,7 +316,12 @@`
`316`	`316`	`"minimum": 0.0`
`317`	`317`	`},`
`318`	`318`	`"vote": {`
`319`		`- "$ref": "#/definitions/VoteOption"`
	`319`	`+ "description": "The vote option.\n\nThis should be called \"option\" for consistency with Cosmos SDK. Sorry for that. See <https://github.com/CosmWasm/cosmwasm/issues/1571>.",`
	`320`	`+ "allOf": [`
	`321`	`+ {`
	`322`	`+ "$ref": "#/definitions/VoteOption"`
	`323`	`+ }`
	`324`	`+ ]`
`320`	`325`	`}`
`321`	`326`	`}`
`322`	`327`	`}`
Original file line number	Diff line number	Diff line change
`@@ -367,7 +367,12 @@`
`367`	`367`	`"minimum": 0.0`
`368`	`368`	`},`
`369`	`369`	`"vote": {`
`370`		`- "$ref": "#/definitions/VoteOption"`
	`370`	`+ "description": "The vote option.\n\nThis should be called \"option\" for consistency with Cosmos SDK. Sorry for that. See <https://github.com/CosmWasm/cosmwasm/issues/1571>.",`
	`371`	`+ "allOf": [`
	`372`	`+ {`
	`373`	`+ "$ref": "#/definitions/VoteOption"`
	`374`	`+ }`
	`375`	`+ ]`
`371`	`376`	`}`
`372`	`377`	`}`
`373`	`378`	`}`
Original file line number	Diff line number	Diff line change
`@@ -245,7 +245,12 @@`
`245`	`245`	`"minimum": 0.0`
`246`	`246`	`},`
`247`	`247`	`"vote": {`
`248`		`- "$ref": "#/definitions/VoteOption"`
	`248`	`+ "description": "The vote option.\n\nThis should be called \"option\" for consistency with Cosmos SDK. Sorry for that. See <https://github.com/CosmWasm/cosmwasm/issues/1571>.",`
	`249`	`+ "allOf": [`
	`250`	`+ {`
	`251`	`+ "$ref": "#/definitions/VoteOption"`
	`252`	`+ }`
	`253`	`+ ]`
`249`	`254`	`}`
`250`	`255`	`}`
`251`	`256`	`}`
Original file line number	Diff line number	Diff line change
`@@ -362,7 +362,12 @@`
`362`	`362`	`"minimum": 0.0`
`363`	`363`	`},`
`364`	`364`	`"vote": {`
`365`		`- "$ref": "#/definitions/VoteOption"`
	`365`	`+ "description": "The vote option.\n\nThis should be called \"option\" for consistency with Cosmos SDK. Sorry for that. See <https://github.com/CosmWasm/cosmwasm/issues/1571>.",`
	`366`	`+ "allOf": [`
	`367`	`+ {`
	`368`	`+ "$ref": "#/definitions/VoteOption"`
	`369`	`+ }`
	`370`	`+ ]`
`366`	`371`	`}`
`367`	`372`	`}`
`368`	`373`	`}`
Original file line number	Diff line number	Diff line change
`@@ -372,7 +372,12 @@`
`372`	`372`	`"minimum": 0.0`
`373`	`373`	`},`
`374`	`374`	`"vote": {`
`375`		`- "$ref": "#/definitions/VoteOption"`
	`375`	`+ "description": "The vote option.\n\nThis should be called \"option\" for consistency with Cosmos SDK. Sorry for that. See <https://github.com/CosmWasm/cosmwasm/issues/1571>.",`
	`376`	`+ "allOf": [`
	`377`	`+ {`
	`378`	`+ "$ref": "#/definitions/VoteOption"`
	`379`	`+ }`
	`380`	`+ ]`
`376`	`381`	`}`
`377`	`382`	`}`
`378`	`383`	`}`