@injectivelabs/chain-consumer - npm Package Compare versions

Comparing version 0.0.36 to 0.0.37

CHANGELOG.md

@@ -6,2 +6,8 @@ # Change Log
 
+## [0.0.37](https://github.com/InjectiveLabs/injective-ts/compare/@injectivelabs/chain-consumer@0.0.36...@injectivelabs/chain-consumer@0.0.37) (2021-04-08)
+
+### Features
+
+* added pagination ([5d7b9d7](https://github.com/InjectiveLabs/injective-ts/commit/5d7b9d7653ed7f9e7bbd541891c7a9e3a8e33f3a))
+
 ## [0.0.36](https://github.com/InjectiveLabs/injective-ts/compare/@injectivelabs/chain-consumer@0.0.35...@injectivelabs/chain-consumer@0.0.36) (2021-04-08)
@@ -8,0 +14,0 @@

dist/consumers/GovernanceConsumer.d.ts

 import { ProposalStatusMap } from '@injectivelabs/chain-api/cosmos/gov/v1beta1/gov_pb';
 import { QueryParamsResponse } from '@injectivelabs/chain-api/cosmos/gov/v1beta1/query_pb';
 import BaseConsumer from '../BaseConsumer';
+import { PaginationOption } from '../types';
 export declare class GovernanceConsumer extends BaseConsumer {
     fetchParams(type: string): Promise<QueryParamsResponse>;
-    fetchProposals(status: ProposalStatusMap[keyof ProposalStatusMap]): Promise<import("@injectivelabs/chain-api/cosmos/gov/v1beta1/gov_pb").Proposal[]>;
+    fetchProposals({ status, pagination, }: {
+        status: ProposalStatusMap[keyof ProposalStatusMap];
+        pagination?: PaginationOption;
+    }): Promise<{
+        proposals: import("@injectivelabs/chain-api/cosmos/gov/v1beta1/gov_pb").Proposal[];
+        pagination: import("@injectivelabs/chain-api/cosmos/base/query/v1beta1/pagination_pb").PageResponse | undefined;
+    }>;
     fetchProposal(proposalId: number): Promise<import("@injectivelabs/chain-api/cosmos/gov/v1beta1/gov_pb").Proposal | undefined>;
-    fetchProposalDeposits(proposalId: number): Promise<import("@injectivelabs/chain-api/cosmos/gov/v1beta1/gov_pb").Deposit[]>;
-    fetchProposalVotes(proposalId: number): Promise<import("@injectivelabs/chain-api/cosmos/gov/v1beta1/gov_pb").Vote[]>;
+    fetchProposalDeposits({ proposalId, pagination, }: {
+        proposalId: number;
+        pagination?: PaginationOption;
+    }): Promise<{
+        deposits: import("@injectivelabs/chain-api/cosmos/gov/v1beta1/gov_pb").Deposit[];
+        pagination: import("@injectivelabs/chain-api/cosmos/base/query/v1beta1/pagination_pb").PageResponse | undefined;
+    }>;
+    fetchProposalVotes({ proposalId, pagination, }: {
+        proposalId: number;
+        pagination?: PaginationOption;
+    }): Promise<{
+        votes: import("@injectivelabs/chain-api/cosmos/gov/v1beta1/gov_pb").Vote[];
+        pagination: import("@injectivelabs/chain-api/cosmos/base/query/v1beta1/pagination_pb").PageResponse | undefined;
+    }>;
     fetchProposalTally(proposalId: number): Promise<import("@injectivelabs/chain-api/cosmos/gov/v1beta1/gov_pb").TallyResult | undefined>;
 }
 //# sourceMappingURL=GovernanceConsumer.d.ts.map

dist/consumers/GovernanceConsumer.js

@@ -16,2 +16,3 @@ "use strict";
 exports.GovernanceConsumer = void 0;
+const pagination_pb_1 = require("@injectivelabs/chain-api/cosmos/base/query/v1beta1/pagination_pb");
 const query_pb_1 = require("@injectivelabs/chain-api/cosmos/gov/v1beta1/query_pb");
@@ -35,9 +36,17 @@ const query_pb_service_1 = require("@injectivelabs/chain-api/cosmos/gov/v1beta1/query_pb_service");
     }
-    fetchProposals(status) {
+    fetchProposals({ status, pagination, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const request = new query_pb_1.QueryProposalsRequest();
             request.setProposalStatus(status);
+            if (pagination) {
+                const paginationForRequest = new pagination_pb_1.PageRequest();
+                paginationForRequest.setKey(pagination.key);
+                request.setPagination(paginationForRequest);
+            }
             try {
                 const response = yield this.request(request, query_pb_service_1.Query.Proposals);
-                return response.getProposalsList();
+                return {
+                    proposals: response.getProposalsList(),
+                    pagination: response.getPagination(),
+                };
             }
@@ -62,9 +71,17 @@ catch (e) {
     }
-    fetchProposalDeposits(proposalId) {
+    fetchProposalDeposits({ proposalId, pagination, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const request = new query_pb_1.QueryDepositsRequest();
             request.setProposalId(proposalId);
+            if (pagination) {
+                const paginationForRequest = new pagination_pb_1.PageRequest();
+                paginationForRequest.setKey(pagination.key);
+                request.setPagination(paginationForRequest);
+            }
             try {
                 const response = yield this.request(request, query_pb_service_1.Query.Deposits);
-                return response.getDepositsList();
+                return {
+                    deposits: response.getDepositsList(),
+                    pagination: response.getPagination(),
+                };
             }
@@ -76,9 +93,17 @@ catch (e) {
     }
-    fetchProposalVotes(proposalId) {
+    fetchProposalVotes({ proposalId, pagination, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const request = new query_pb_1.QueryVotesRequest();
             request.setProposalId(proposalId);
+            if (pagination) {
+                const paginationForRequest = new pagination_pb_1.PageRequest();
+                paginationForRequest.setKey(pagination.key);
+                request.setPagination(paginationForRequest);
+            }
             try {
                 const response = yield this.request(request, query_pb_service_1.Query.Votes);
-                return response.getVotesList();
+                return {
+                    votes: response.getVotesList(),
+                    pagination: response.getPagination(),
+                };
             }
@@ -85,0 +110,0 @@ catch (e) {

dist/consumers/StakingConsumer.d.ts

@@ -1,10 +0,37 @@
-import { AccountAddress } from '@injectivelabs/ts-types';
 import BaseConsumer from '../BaseConsumer';
+import { PaginationOption } from '../types';
 export declare class StakingConsumer extends BaseConsumer {
-    fetchValidators(): Promise<import("@injectivelabs/chain-api/cosmos/staking/v1beta1/staking_pb").Validator[]>;
-    fetchDelegations(cosmosAddress: AccountAddress): Promise<import("@injectivelabs/chain-api/cosmos/staking/v1beta1/staking_pb").DelegationResponse[]>;
-    fetchDelegators(validatorOperatorAddress: string): Promise<import("@injectivelabs/chain-api/cosmos/staking/v1beta1/staking_pb").DelegationResponse[]>;
-    fetchUnbondingDelegations(cosmosAddress: AccountAddress): Promise<import("@injectivelabs/chain-api/cosmos/staking/v1beta1/staking_pb").UnbondingDelegation[]>;
-    fetchReDelegations(cosmosAddress: AccountAddress): Promise<import("@injectivelabs/chain-api/cosmos/staking/v1beta1/staking_pb").RedelegationResponse[]>;
+    fetchValidators(): Promise<{
+        validators: import("@injectivelabs/chain-api/cosmos/staking/v1beta1/staking_pb").Validator[];
+        pagination: import("@injectivelabs/chain-api/cosmos/base/query/v1beta1/pagination_pb").PageResponse | undefined;
+    }>;
+    fetchDelegations({ cosmosAddress, pagination, }: {
+        cosmosAddress: string;
+        pagination?: PaginationOption;
+    }): Promise<{
+        delegations: import("@injectivelabs/chain-api/cosmos/staking/v1beta1/staking_pb").DelegationResponse[];
+        pagination: import("@injectivelabs/chain-api/cosmos/base/query/v1beta1/pagination_pb").PageResponse | undefined;
+    }>;
+    fetchDelegators({ validatorAddress, pagination, }: {
+        validatorAddress: string;
+        pagination?: PaginationOption;
+    }): Promise<{
+        delegators: import("@injectivelabs/chain-api/cosmos/staking/v1beta1/staking_pb").DelegationResponse[];
+        pagination: import("@injectivelabs/chain-api/cosmos/base/query/v1beta1/pagination_pb").PageResponse | undefined;
+    }>;
+    fetchUnbondingDelegations({ cosmosAddress, pagination, }: {
+        cosmosAddress: string;
+        pagination?: PaginationOption;
+    }): Promise<{
+        unbondingDelegations: import("@injectivelabs/chain-api/cosmos/staking/v1beta1/staking_pb").UnbondingDelegation[];
+        pagination: import("@injectivelabs/chain-api/cosmos/base/query/v1beta1/pagination_pb").PageResponse | undefined;
+    }>;
+    fetchReDelegations({ cosmosAddress, pagination, }: {
+        cosmosAddress: string;
+        pagination?: PaginationOption;
+    }): Promise<{
+        redelegations: import("@injectivelabs/chain-api/cosmos/staking/v1beta1/staking_pb").RedelegationResponse[];
+        pagination: import("@injectivelabs/chain-api/cosmos/base/query/v1beta1/pagination_pb").PageResponse | undefined;
+    }>;
 }
 //# sourceMappingURL=StakingConsumer.d.ts.map

dist/consumers/StakingConsumer.js

@@ -19,2 +19,3 @@ "use strict";
 const query_pb_service_1 = require("@injectivelabs/chain-api/cosmos/staking/v1beta1/query_pb_service");
+const pagination_pb_1 = require("@injectivelabs/chain-api/cosmos/base/query/v1beta1/pagination_pb");
 const BaseConsumer_1 = __importDefault(require("../BaseConsumer"));
@@ -27,3 +28,6 @@ class StakingConsumer extends BaseConsumer_1.default {
                 const response = yield this.request(request, query_pb_service_1.Query.Validators);
-                return response.getValidatorsList();
+                return {
+                    validators: response.getValidatorsList(),
+                    pagination: response.getPagination(),
+                };
             }
@@ -35,9 +39,17 @@ catch (e) {
     }
-    fetchDelegations(cosmosAddress) {
+    fetchDelegations({ cosmosAddress, pagination, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const request = new query_pb_1.QueryDelegatorDelegationsRequest();
             request.setDelegatorAddr(cosmosAddress);
+            if (pagination) {
+                const paginationForRequest = new pagination_pb_1.PageRequest();
+                paginationForRequest.setKey(pagination.key);
+                request.setPagination(paginationForRequest);
+            }
             try {
                 const response = yield this.request(request, query_pb_service_1.Query.DelegatorDelegations);
-                return response.getDelegationResponsesList();
+                return {
+                    delegations: response.getDelegationResponsesList(),
+                    pagination: response.getPagination(),
+                };
             }
@@ -49,9 +61,17 @@ catch (e) {
     }
-    fetchDelegators(validatorOperatorAddress) {
+    fetchDelegators({ validatorAddress, pagination, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const request = new query_pb_1.QueryValidatorDelegationsRequest();
-            request.setValidatorAddr(validatorOperatorAddress);
+            request.setValidatorAddr(validatorAddress);
+            if (pagination) {
+                const paginationForRequest = new pagination_pb_1.PageRequest();
+                paginationForRequest.setKey(pagination.key);
+                request.setPagination(paginationForRequest);
+            }
             try {
                 const response = yield this.request(request, query_pb_service_1.Query.ValidatorDelegations);
-                return response.getDelegationResponsesList();
+                return {
+                    delegators: response.getDelegationResponsesList(),
+                    pagination: response.getPagination(),
+                };
             }
@@ -63,9 +83,17 @@ catch (e) {
     }
-    fetchUnbondingDelegations(cosmosAddress) {
+    fetchUnbondingDelegations({ cosmosAddress, pagination, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const request = new query_pb_1.QueryDelegatorUnbondingDelegationsRequest();
             request.setDelegatorAddr(cosmosAddress);
+            if (pagination) {
+                const paginationForRequest = new pagination_pb_1.PageRequest();
+                paginationForRequest.setKey(pagination.key);
+                request.setPagination(paginationForRequest);
+            }
             try {
                 const response = yield this.request(request, query_pb_service_1.Query.DelegatorUnbondingDelegations);
-                return response.getUnbondingResponsesList();
+                return {
+                    unbondingDelegations: response.getUnbondingResponsesList(),
+                    pagination: response.getPagination(),
+                };
             }
@@ -77,9 +105,17 @@ catch (e) {
     }
-    fetchReDelegations(cosmosAddress) {
+    fetchReDelegations({ cosmosAddress, pagination, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const request = new query_pb_1.QueryRedelegationsRequest();
             request.setDelegatorAddr(cosmosAddress);
+            if (pagination) {
+                const paginationForRequest = new pagination_pb_1.PageRequest();
+                paginationForRequest.setKey(pagination.key);
+                request.setPagination(paginationForRequest);
+            }
             try {
                 const response = yield this.request(request, query_pb_service_1.Query.Redelegations);
-                return response.getRedelegationResponsesList();
+                return {
+                    redelegations: response.getRedelegationResponsesList(),
+                    pagination: response.getPagination(),
+                };
             }
@@ -86,0 +122,0 @@ catch (e) {

dist/types.d.ts

@@ -7,3 +7,9 @@ import { Validator as GrpcValidator, Delegation as GrpcDelegation, Description as GrpcValidatorDescription, Commission as GrpcValidatorCommission, CommissionRates as GrpcValidatorCommissionRates, UnbondingDelegation as GrpcUnbondingDelegation, Redelegation as GrpcReDelegation, DelegationResponse as GrpcDelegationResponse, RedelegationResponse as GrpcReDelegationResponse } from '@injectivelabs/chain-api/cosmos/staking/v1beta1/staking_pb';
 import { Coin as GrpcCoin } from '@injectivelabs/chain-api/cosmos/base/v1beta1/coin_pb';
+export interface PaginationOption {
+    key: string;
+    offset?: number;
+    limit?: number;
+    countTotal?: boolean;
+}
 export { GrpcCoin, GrpcValidator, GrpcDelegation, GrpcValidatorDescription, GrpcValidatorCommission, GrpcValidatorCommissionRates, GrpcUnbondingDelegation, GrpcDelegationResponse, GrpcProposal, GrpcProposalDeposit, GrpcTallyParams, GrpcTallyResult, GrpcVote, GrpcProposalStatus, GrpcSupply, GrpcDelegationDelegatorReward, GrpcSpotMarket, GrpcMarketStatus, GrpcMarketStatusMap, GrpcSpotLimitOrder, GrpcSpotMarketOrder, GrpcSpotOrder, GrpcReDelegation, GrpcReDelegationResponse, };
 //# sourceMappingURL=types.d.ts.map

package.json

 {
   "name": "@injectivelabs/chain-consumer",
   "description": "Interacting with our Chain API made easy. Can be reused throughout Injective's projects.",
-  "version": "0.0.36",
+  "version": "0.0.37",
   "license": "MIT",
@@ -41,3 +41,3 @@ "main": "dist/index.js",
   },
-  "gitHead": "0c2f050f7512dc365f8eca9104936e98747644e3"
+  "gitHead": "22c6807f6b2c855380923e8994aa73d85f9f92ea"
 }

No alert changes

Improved metrics

Total package byte prevSize

97452

increased by8.62%

Lines of code

1058

increased by11.96%

No dependency changes