Merge pull request #60 from persistenceOne/puneet/add-amino

feat: add amino encodings

Author: puneet2019

.gitignore

@@ -23,6 +23,9 @@
 /persistence/
 /helpers.*
 /index.*
+/binary.*
+/utf8.*
+/varint.*
 /proofs.*
 
 # misc

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "persistenceonejs",
-  "version": "2.2.0",
+  "version": "2.3.0-rc0",
   "description": "Client side JS libraries for persistenceSDK transaction generation, signing and broadcasting.",
   "main": "main/index.js",
   "module": "module/index.js",
@@ -33,13 +33,14 @@
     "url": "https://github.com/persistenceOne/persistenceJS/issues"
   },
   "homepage": "https://github.com/persistenceOne/persistenceJS#readme",
-  "dependencies": {
-    "long": "^4.0.0",
-    "protobufjs": "~6.11.2"
-  },
+  "dependencies": {},
   "devDependencies": {
+    "@cosmjs/amino": "^0.31.1",
+    "@cosmjs/stargate": "^0.31.1",
+    "@cosmjs/proto-signing": "^0.31.1",
+    "@cosmjs/tendermint-rpc": "^0.31.1",
+    "@cosmjs/encoding": "^0.31.1",
     "@types/node": "^18.6.3",
-    "@types/long": "^4.0.1",
     "@cosmology/telescope": "^0.109.4",
     "cosmwasm-typescript-gen": "^0.3.9",
     "husky": "^8.0.1",

package.json

@@ -6,6 +6,7 @@ import "cosmos_proto/cosmos.proto";
 import "gogoproto/gogo.proto";
 import "cosmos/msg/v1/msg.proto";
 import "cosmos/base/v1beta1/coin.proto";
+import "amino/amino.proto";
 
 import "pstake/liquidstakeibc/v1beta1/liquidstakeibc.proto";
 import "pstake/liquidstakeibc/v1beta1/params.proto";
@@ -39,6 +40,8 @@ service Msg {
 message MsgRegisterHostChain {
   option (gogoproto.equal) = false;
   option (gogoproto.goproto_getters) = false;
+  option (cosmos.msg.v1.signer) = "authority";
+  option (amino.name) = "pstake/MsgRegisterHostChain";
 
   // authority is the address of the governance account
   string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
@@ -81,18 +84,20 @@ message MsgRegisterHostChainResponse {}
 message MsgUpdateHostChain {
   option (gogoproto.equal) = false;
   option (gogoproto.goproto_getters) = false;
-
+  option (cosmos.msg.v1.signer) = "authority";
+  option (amino.name) = "pstake/MsgUpdateHostChain";
   // authority is the address of the governance account
   string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 
   string chain_id = 2;
-  repeated KVUpdate updates = 3;
+  repeated KVUpdate updates = 3 [(amino.dont_omitempty) = true];
 }
 
 message MsgUpdateHostChainResponse {}
 
 message MsgLiquidStake {
   option (cosmos.msg.v1.signer) = "delegator_address";
+  option (amino.name) = "pstake/MsgLiquidStake";
 
   string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
   cosmos.base.v1beta1.Coin amount = 2 [(gogoproto.nullable) = false];
@@ -102,6 +107,7 @@ message MsgLiquidStakeResponse {}
 
 message MsgLiquidStakeLSM {
   option (cosmos.msg.v1.signer) = "delegator_address";
+  option (amino.name) = "pstake/MsgLiquidStakeLSM";
 
   string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
   repeated cosmos.base.v1beta1.Coin delegations = 2 [(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
@@ -112,6 +118,7 @@ message MsgLiquidStakeLSMResponse {}
 
 message MsgLiquidUnstake {
   option (cosmos.msg.v1.signer) = "delegator_address";
+  option (amino.name) = "pstake/MsgLiquidUnstake";
 
   string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
   cosmos.base.v1beta1.Coin amount = 2 [(gogoproto.nullable) = false];
@@ -121,6 +128,7 @@ message MsgLiquidUnstakeResponse {}
 
 message MsgRedeem {
   option (cosmos.msg.v1.signer) = "delegator_address";
+  option (amino.name) = "pstake/MsgRedeem";
 
   string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
   cosmos.base.v1beta1.Coin amount = 2 [(gogoproto.nullable) = false];
@@ -133,9 +141,10 @@ message MsgUpdateParams {
   option (gogoproto.goproto_getters) = false;
 
   option (cosmos.msg.v1.signer) = "authority";
+  option (amino.name) = "pstake/MsgUpdateParams";
 
   string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
-  Params params = 2 [(gogoproto.nullable) = false];
+  Params params = 2 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
 }
 
 message MsgUpdateParamsResponse {}

proto/pstake/liquidstakeibc/v1beta1/msgs.proto

@@ -3,11 +3,14 @@ package pstake.liquidstakeibc.v1beta1;
 
 import "gogoproto/gogo.proto";
 import "cosmos_proto/cosmos.proto";
+import "amino/amino.proto";
 
 option go_package = "github.com/persistenceOne/pstake-native/v2/x/liquidstakeibc/types";
 
 // Params defines the parameters for the module.
 message Params {
+  option (amino.name) = "pstake/x/liquidstakeibc/Params";
+
   string admin_address = 1 [
     (cosmos_proto.scalar) = "cosmos.AddressString"
   ]; // protocol admin address

proto/pstake/liquidstakeibc/v1beta1/params.proto

@@ -1,16 +1,33 @@
 #!/bin/bash
+
 set -o errexit -o nounset -o pipefail
 command -v shellcheck >/dev/null && shellcheck "$0"
 
-DIRS="amino cosmos cosmos_proto cosmwasm gogoproto google ibc tendermint pstake persistence"
-FILES="helpers.d.ts helpers.js helpers.js.map index.d.ts index.js index.js.map"
+DIRS=(amino cosmos cosmos_proto cosmwasm gogoproto google ibc tendermint pstake persistence)
+FILES=(
+  helpers.d.ts
+  helpers.js
+  helpers.js.map
+  index.d.ts
+  index.js
+  index.js.map
+  binary.d.ts
+  binary.js
+  binary.js.map
+  utf8.d.ts
+  utf8.js
+  utf8.js.map
+  varint.d.ts
+  varint.js
+  varint.js.map
+)
 
-for dir in $DIRS; do
+for dir in "${DIRS[@]}"; do
   rm -rf "$dir"
   cp -R "./build/$dir" ./
 done
 
-for f in $FILES; do
+for f in "${FILES[@]}"; do
   rm -rf "$f"
   cp "./build/$f" ./
-done
+done

scripts/prepare-publishing.sh

@@ -12,7 +12,22 @@ telescope({
     logLevel: 0,
     useSDKTypes: false,
     tsDisable: {
-      disableAll: false
+      patterns: ["**/tx.registry.ts", "**/msgs.registry.ts"],
+      files: [
+        "ibc/core/types/v1/genesis.ts",
+        "ibc/applications/interchain_accounts/genesis/v1/genesis.ts",
+        "cosmos/tx/signing/v1beta1/signing.ts",
+        "cosmos/staking/v1beta1/tx.ts",
+        "cosmos/staking/v1beta1/staking.ts",
+
+        "cosmos/authz/v1beta1/tx.amino.ts",
+        "cosmos/staking/v1beta1/tx.amino.ts",
+        "cosmos/slashing/v1beta1/tx.amino.ts",
+        "cosmos/upgrade/v1beta1/tx.amino.ts",
+
+        "cosmos/consensus/v1/tx.amino.ts",
+        "cosmos/gov/v1/tx.amino.ts"
+      ]
     },
     eslintDisable: {
       disableAll: true
@@ -54,13 +69,25 @@ telescope({
         // There are users who need those functions. CosmJS does not need them directly.
         // See https://github.com/cosmos/cosmjs/pull/1329
         fromJSON: true,
-        toJSON: true
+        toJSON: true,
+        fromPartial: true
+
+        // encode: true,
+        // decode: true,
+        // toSDK: true,
+        // fromSDK: true,
+        // toAmino: true,
+        // fromAmino: true,
+        // fromProto: true,
+        // toProto: true
       },
       typingsFormat: {
-        useDeepPartial: true,
-        useExact: true,
+        useDeepPartial: false,
+        useExact: false,
         timestamp: "timestamp",
-        duration: "duration"
+        duration: "duration",
+        num64: "bigint",
+        setDefaultCustomTypesToUndefined: false
       }
     },
     lcdClients: {
@@ -79,8 +106,12 @@ telescope({
         "ABCIApplication"
       ]
     },
+    stargateClients: {
+      enabled: false,
+      includeCosmosDefaultTypes: false
+    },
     aminoEncoding: {
-      enabled: false
+      enabled: true
     }
   }
 }).then(() => {