Merge pull request #56 from persistenceOne/puneet/lsmprotos

Puneet/lsmprotos

.github/workflows/check.yml

@@ -0,0 +1,26 @@
+---
+name: Check build
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  install-build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [ 16.x ]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: "https://registry.npmjs.org"
+      - name: Install dependencies
+        run: npm ci
+      - name: Build
+        run: npm run build

README.md

@@ -17,6 +17,14 @@
 
 ---
 
+## Maintain
+- open file to scripts/update-protos.sh and update the commits/ tags
+- do `npm run update-protos`
+- do `npm run build:telescope`
+- update package.json version
+- commit and open PR
+- tag a release for publishing on npmjs
+
 ## Setup
 
 ```sh

package.json

@@ -1,6 +1,6 @@
 {
   "name": "persistenceonejs",
-  "version": "2.1.1",
+  "version": "2.2.0-rc0",
   "description": "Client side JS libraries for persistenceSDK transaction generation, signing and broadcasting.",
   "main": "main/index.js",
   "module": "module/index.js",

proto/pstake/liquidstakeibc/v1beta1/liquidstakeibc.proto

@@ -57,6 +57,12 @@ message HostChain {
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
     (gogoproto.nullable) = false
   ];
+  // host chain flags
+  HostChainFlags flags = 16;
+}
+
+message HostChainFlags {
+  bool lsm = 1;
 }
 
 message HostChainLSParams {
@@ -154,6 +160,45 @@ message Deposit {
   string ibc_sequence_id = 5;
 }
 
+message LSMDeposit {
+  enum LSMDepositState {
+    // no action has been initiated on the deposit
+    DEPOSIT_PENDING = 0;
+    // deposit sent to the host chain delegator address
+    DEPOSIT_SENT = 1;
+    // deposit received by the host chain delegator address
+    DEPOSIT_RECEIVED = 2;
+    // deposit started the untokenization process
+    DEPOSIT_UNTOKENIZING = 3;
+  }
+
+  // deposit target chain
+  string chain_id = 1;
+  // this is calculated when liquid staking [lsm_shares * validator_exchange_rate]
+  string amount = 2 [
+    (cosmos_proto.scalar) = "cosmos.Int",
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
+    (gogoproto.nullable) = false
+  ];
+  // LSM token shares, they are mapped 1:1 with the delegator shares that are tokenized
+  // https://github.com/iqlusioninc/cosmos-sdk/pull/19
+  string shares = 3 [
+    (cosmos_proto.scalar) = "cosmos.Dec",
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable) = false
+  ];
+  // LSM token denom
+  string denom = 4;
+  // LSM token ibc denom
+  string ibc_denom = 5;
+  // address of the delegator
+  string delegator_address = 6;
+  // state o the deposit
+  LSMDepositState state = 7;
+  // sequence id of the ibc transaction
+  string ibc_sequence_id = 8;
+}
+
 message Unbonding {
   enum UnbondingState {
     // no action has been initiated on the unbonding

proto/pstake/liquidstakeibc/v1beta1/msgs.proto

@@ -21,6 +21,10 @@ service Msg {
     option (google.api.http).post = "/pstake/liquidstakeibc/v1beta1/LiquidStake";
   }
 
+  rpc LiquidStakeLSM(MsgLiquidStakeLSM) returns (MsgLiquidStakeLSMResponse) {
+    option (google.api.http).post = "/pstake/liquidstakeibc/v1beta1/LiquidStakeLSM";
+  }
+
   rpc LiquidUnstake(MsgLiquidUnstake) returns (MsgLiquidUnstakeResponse) {
     option (google.api.http).post = "/pstake/liquidstakeibc/v1beta1/LiquidUnstake";
   }
@@ -96,6 +100,15 @@ message MsgLiquidStake {
 
 message MsgLiquidStakeResponse {}
 
+message MsgLiquidStakeLSM {
+  option (cosmos.msg.v1.signer) = "delegator_address";
+
+  string delegator_address = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString" ];
+  repeated cosmos.base.v1beta1.Coin delegations = 2;
+}
+
+message MsgLiquidStakeLSMResponse {}
+
 message MsgLiquidUnstake {
   option (cosmos.msg.v1.signer) = "delegator_address";
 

proto/pstake/liquidstakeibc/v1beta1/query.proto

@@ -35,6 +35,11 @@ service Query {
     option (google.api.http).get = "/pstake/liquidstakeibc/v1beta1/deposits/{chain_id}";
   }
 
+  // Queries for all the deposits for a host chain.
+  rpc LSMDeposits(QueryLSMDepositsRequest) returns (QueryLSMDepositsResponse) {
+    option (google.api.http).get = "/pstake/liquidstakeibc/v1beta1/lsm_deposits/{chain_id}";
+  }
+
   // Queries all unbondings for a host chain.
   rpc Unbondings(QueryUnbondingsRequest) returns (QueryUnbondingsResponse) {
     option (google.api.http).get = "/pstake/liquidstakeibc/v1beta1/unbondings/{chain_id}";
@@ -95,6 +100,14 @@ message QueryDepositsResponse {
   repeated Deposit deposits = 1;
 }
 
+message QueryLSMDepositsRequest {
+  string chain_id = 1;
+}
+
+message QueryLSMDepositsResponse {
+  repeated LSMDeposit deposits = 1;
+}
+
 message QueryUnbondingsRequest {
   string chain_id = 1;
 }

scripts/update-protos.sh

@@ -13,7 +13,7 @@ ibc_git=https://github.com/persistenceOne/ibc-go.git
 ibc_tag=v7.2.0-lsm2
 
 pstake_git=https://github.com/persistenceOne/pstake-native.git
-pstake_tag=v2.2.0
+pstake_tag=main
 
 persistence_sdk_git=https://github.com/persistenceOne/persistence-sdk.git
 persistence_sdk_tag=v2.1.0