Merge pull request #1014 from cosmos/improve-AminoTypes-constructor

Make prefix required in AminoTypes constructor
cosmos · Jan 27, 2022 · 53c5235 · 53c5235
2 parents f4342bb + 353f2da
commit 53c5235
Show file tree

Hide file tree

Showing 9 changed files with 80 additions and 54 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,15 @@ and this project adheres to
 
 ## [Unreleased]
 
+### Changed
+
+- @cosmjs/stargate: The `AminoTypes` now always requires an argument of type
+  `AminoTypesOptions`. This is an object with a required `prefix` field. Before
+  the prefix defaulted to "cosmos" but this is almost never the right choice for
+  CosmJS users that need to add Amino types manually. ([#989])
+
+[#989]: https://github.com/cosmos/cosmjs/issues/989
+
 ### Removed
 
 - @cosmjs/crypto: Remove the SHA1 implementation (`Sha1` and `sha1`) as it is

diff --git a/packages/cosmwasm-stargate/src/aminotypes.spec.ts b/packages/cosmwasm-stargate/src/aminotypes.spec.ts
@@ -29,7 +29,7 @@ describe("AminoTypes", () => {
         wasmByteCode: fromBase64("WUVMTE9XIFNVQk1BUklORQ=="),
         instantiatePermission: undefined,
       };
-      const aminoMsg = new AminoTypes({ additions: cosmWasmTypes }).toAmino({
+      const aminoMsg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).toAmino({
         typeUrl: "/cosmwasm.wasm.v1.MsgStoreCode",
         value: msg,
       });
@@ -54,7 +54,7 @@ describe("AminoTypes", () => {
           funds: coins(1234, "ucosm"),
           admin: "cosmos10dyr9899g6t0pelew4nvf4j5c3jcgv0r73qga5",
         };
-        const aminoMsg = new AminoTypes({ additions: cosmWasmTypes }).toAmino({
+        const aminoMsg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).toAmino({
           typeUrl: "/cosmwasm.wasm.v1.MsgInstantiateContract",
           value: msg,
         });
@@ -82,7 +82,7 @@ describe("AminoTypes", () => {
           funds: coins(1234, "ucosm"),
           admin: "",
         };
-        const aminoMsg = new AminoTypes({ additions: cosmWasmTypes }).toAmino({
+        const aminoMsg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).toAmino({
           typeUrl: "/cosmwasm.wasm.v1.MsgInstantiateContract",
           value: msg,
         });
@@ -107,7 +107,7 @@ describe("AminoTypes", () => {
         newAdmin: "cosmos10dyr9899g6t0pelew4nvf4j5c3jcgv0r73qga5",
         contract: "cosmos1xy4yqngt0nlkdcenxymg8tenrghmek4nmqm28k",
       };
-      const aminoMsg = new AminoTypes({ additions: cosmWasmTypes }).toAmino({
+      const aminoMsg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).toAmino({
         typeUrl: "/cosmwasm.wasm.v1.MsgUpdateAdmin",
         value: msg,
       });
@@ -127,7 +127,7 @@ describe("AminoTypes", () => {
         sender: "cosmos1pkptre7fdkl6gfrzlesjjvhxhlc3r4gmmk8rs6",
         contract: "cosmos1xy4yqngt0nlkdcenxymg8tenrghmek4nmqm28k",
       };
-      const aminoMsg = new AminoTypes({ additions: cosmWasmTypes }).toAmino({
+      const aminoMsg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).toAmino({
         typeUrl: "/cosmwasm.wasm.v1.MsgClearAdmin",
         value: msg,
       });
@@ -148,7 +148,7 @@ describe("AminoTypes", () => {
         msg: toUtf8(`{"foo":"bar"}`),
         funds: coins(1234, "ucosm"),
       };
-      const aminoMsg = new AminoTypes({ additions: cosmWasmTypes }).toAmino({
+      const aminoMsg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).toAmino({
         typeUrl: "/cosmwasm.wasm.v1.MsgExecuteContract",
         value: msg,
       });
@@ -171,7 +171,7 @@ describe("AminoTypes", () => {
         codeId: Long.fromString("98765"),
         msg: toUtf8(`{"foo":"bar"}`),
       };
-      const aminoMsg = new AminoTypes({ additions: cosmWasmTypes }).toAmino({
+      const aminoMsg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).toAmino({
         typeUrl: "/cosmwasm.wasm.v1.MsgMigrateContract",
         value: msg,
       });
@@ -197,7 +197,7 @@ describe("AminoTypes", () => {
           wasm_byte_code: "WUVMTE9XIFNVQk1BUklORQ==",
         },
       };
-      const msg = new AminoTypes({ additions: cosmWasmTypes }).fromAmino(aminoMsg);
+      const msg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).fromAmino(aminoMsg);
       const expectedValue: MsgStoreCode = {
         sender: "cosmos1pkptre7fdkl6gfrzlesjjvhxhlc3r4gmmk8rs6",
         wasmByteCode: fromBase64("WUVMTE9XIFNVQk1BUklORQ=="),
@@ -223,7 +223,7 @@ describe("AminoTypes", () => {
             admin: "cosmos10dyr9899g6t0pelew4nvf4j5c3jcgv0r73qga5",
           },
         };
-        const msg = new AminoTypes({ additions: cosmWasmTypes }).fromAmino(aminoMsg);
+        const msg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).fromAmino(aminoMsg);
         const expectedValue: MsgInstantiateContract = {
           sender: "cosmos1pkptre7fdkl6gfrzlesjjvhxhlc3r4gmmk8rs6",
           codeId: Long.fromString("12345"),
@@ -250,7 +250,7 @@ describe("AminoTypes", () => {
             funds: coins(1234, "ucosm"),
           },
         };
-        const msg = new AminoTypes({ additions: cosmWasmTypes }).fromAmino(aminoMsg);
+        const msg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).fromAmino(aminoMsg);
         const expectedValue: MsgInstantiateContract = {
           sender: "cosmos1pkptre7fdkl6gfrzlesjjvhxhlc3r4gmmk8rs6",
           codeId: Long.fromString("12345"),
@@ -275,7 +275,7 @@ describe("AminoTypes", () => {
           contract: "cosmos1xy4yqngt0nlkdcenxymg8tenrghmek4nmqm28k",
         },
       };
-      const msg = new AminoTypes({ additions: cosmWasmTypes }).fromAmino(aminoMsg);
+      const msg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).fromAmino(aminoMsg);
       const expectedValue: MsgUpdateAdmin = {
         sender: "cosmos1pkptre7fdkl6gfrzlesjjvhxhlc3r4gmmk8rs6",
         newAdmin: "cosmos10dyr9899g6t0pelew4nvf4j5c3jcgv0r73qga5",
@@ -295,7 +295,7 @@ describe("AminoTypes", () => {
           contract: "cosmos1xy4yqngt0nlkdcenxymg8tenrghmek4nmqm28k",
         },
       };
-      const msg = new AminoTypes({ additions: cosmWasmTypes }).fromAmino(aminoMsg);
+      const msg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).fromAmino(aminoMsg);
       const expectedValue: MsgClearAdmin = {
         sender: "cosmos1pkptre7fdkl6gfrzlesjjvhxhlc3r4gmmk8rs6",
         contract: "cosmos1xy4yqngt0nlkdcenxymg8tenrghmek4nmqm28k",
@@ -316,7 +316,7 @@ describe("AminoTypes", () => {
           funds: coins(1234, "ucosm"),
         },
       };
-      const msg = new AminoTypes({ additions: cosmWasmTypes }).fromAmino(aminoMsg);
+      const msg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).fromAmino(aminoMsg);
       const expectedValue: MsgExecuteContract = {
         sender: "cosmos1pkptre7fdkl6gfrzlesjjvhxhlc3r4gmmk8rs6",
         contract: "cosmos1xy4yqngt0nlkdcenxymg8tenrghmek4nmqm28k",
@@ -339,7 +339,7 @@ describe("AminoTypes", () => {
           msg: { foo: "bar" },
         },
       };
-      const msg = new AminoTypes({ additions: cosmWasmTypes }).fromAmino(aminoMsg);
+      const msg = new AminoTypes({ prefix: "cosmos", additions: cosmWasmTypes }).fromAmino(aminoMsg);
       const expectedValue: MsgMigrateContract = {
         sender: "cosmos1pkptre7fdkl6gfrzlesjjvhxhlc3r4gmmk8rs6",
         contract: "cosmos1xy4yqngt0nlkdcenxymg8tenrghmek4nmqm28k",

diff --git a/packages/cosmwasm-stargate/src/signingcosmwasmclient.spec.ts b/packages/cosmwasm-stargate/src/signingcosmwasmclient.spec.ts
@@ -818,6 +818,7 @@ describe("SigningCosmWasmClient", () => {
         };
         customRegistry.register(msgDelegateTypeUrl, CustomMsgDelegate);
         const customAminoTypes = new AminoTypes({
+          prefix: "cosmos",
           additions: {
             "/cosmos.staking.v1beta1.MsgDelegate": {
               aminoType: "cosmos-sdk/MsgDelegate",
@@ -1122,6 +1123,7 @@ describe("SigningCosmWasmClient", () => {
         };
         customRegistry.register(msgDelegateTypeUrl, CustomMsgDelegate);
         const customAminoTypes = new AminoTypes({
+          prefix: "cosmos",
           additions: {
             "/cosmos.staking.v1beta1.MsgDelegate": {
               aminoType: "cosmos-sdk/MsgDelegate",

diff --git a/packages/cosmwasm-stargate/src/signingcosmwasmclient.ts b/packages/cosmwasm-stargate/src/signingcosmwasmclient.ts
@@ -187,9 +187,11 @@ export class SigningCosmWasmClient extends CosmWasmClient {
     options: SigningCosmWasmClientOptions,
   ) {
     super(tmClient);
+    // TODO: do we really want to set a default here? Ideally we could get it from the signer such that users only have to set it once.
+    const prefix = options.prefix ?? "cosmos";
     const {
       registry = createDefaultRegistry(),
-      aminoTypes = new AminoTypes({ additions: cosmWasmTypes, prefix: options.prefix }),
+      aminoTypes = new AminoTypes({ prefix, additions: cosmWasmTypes }),
     } = options;
     this.registry = registry;
     this.aminoTypes = aminoTypes;