@zoguxprotocol/client-js 0.2.0

package/src/clients/modules/get.ts

@@ -0,0 +1,686 @@
+import { Coin } from '@cosmjs/proto-signing';
+import {
+  Account,
+  accountFromAny,
+  Block,
+  QueryClient as StargateQueryClient,
+  TxExtension,
+  QueryAbciResponse,
+} from '@cosmjs/stargate';
+import {
+  GetAuthenticatorsRequest,
+  GetAuthenticatorsResponse,
+} from '@zoguxprotocol/proto/src/codegen/zogux/accountplus/query';
+import * as AuthModule from 'cosmjs-types/cosmos/auth/v1beta1/query';
+import * as BankModule from 'cosmjs-types/cosmos/bank/v1beta1/query';
+import { Any } from 'cosmjs-types/google/protobuf/any';
+import Long from 'long';
+import protobuf from 'protobufjs';
+
+import { bigIntToBytes } from '../../lib/helpers';
+import { PAGE_REQUEST } from '../constants';
+import { UnexpectedClientError } from '../lib/errors';
+import {
+  AffiliateModule,
+  BridgeModule,
+  ClobModule,
+  DistributionModule,
+  FeeTierModule,
+  GovV1Module,
+  PerpetualsModule,
+  PricesModule,
+  ProposalStatus,
+  RateLimitModule,
+  RewardsModule,
+  StakingModule,
+  StatsModule,
+  SubaccountsModule,
+  VaultModule,
+} from './proto-includes';
+import { TendermintClient } from './tendermintClient';
+
+// Required for encoding and decoding queries that are of type Long.
+// Must be done once but since the individal modules should be usable without
+// ZoguxClient - must be set in each module that encounters encoding/decoding Longs.
+// Reference: https://github.com/protobufjs/protobuf.js/issues/921
+protobuf.util.Long = Long;
+protobuf.configure();
+
+export class Get {
+  readonly tendermintClient: TendermintClient;
+  readonly stargateQueryClient: StargateQueryClient & TxExtension;
+
+  constructor(
+    tendermintClient: TendermintClient,
+    stargateQueryClient: StargateQueryClient & TxExtension,
+  ) {
+    this.tendermintClient = tendermintClient;
+    this.stargateQueryClient = stargateQueryClient;
+  }
+
+  /**
+   * @description Get latest block
+   *
+   * @returns last block structure
+   */
+  async latestBlock(): Promise<Block> {
+    return this.tendermintClient.getBlock();
+  }
+
+  /**
+   * @description Get latest block height
+   *
+   * @returns last height
+   */
+  async latestBlockHeight(): Promise<number> {
+    const block = await this.latestBlock();
+    return block.header.height;
+  }
+
+  /**
+   * @description Get all fee tier params.
+   *
+   * @returns All fee tier params.
+   */
+  async getFeeTiers(): Promise<FeeTierModule.QueryPerpetualFeeParamsResponse> {
+    const requestData = Uint8Array.from(
+      FeeTierModule.QueryPerpetualFeeParamsRequest.encode({}).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.feetiers.Query/PerpetualFeeParams',
+      requestData,
+    );
+    return FeeTierModule.QueryPerpetualFeeParamsResponse.decode(data);
+  }
+
+  /**
+   * @description Get fee tier the user belongs to
+   *
+   * @returns the fee tier user belongs to.
+   */
+  async getUserFeeTier(address: string): Promise<FeeTierModule.QueryUserFeeTierResponse> {
+    const requestData = Uint8Array.from(
+      FeeTierModule.QueryUserFeeTierRequest.encode({ user: address }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.feetiers.Query/UserFeeTier',
+      requestData,
+    );
+    return FeeTierModule.QueryUserFeeTierResponse.decode(data);
+  }
+
+  /**
+   * @description Get get trading stats
+   *
+   * @returns return the user's taker and maker volume
+   */
+  async getUserStats(
+    address: string,
+  ): Promise<{ takerNotional: Long; makerNotional: Long } | undefined> {
+    const requestData = Uint8Array.from(
+      StatsModule.QueryUserStatsRequest.encode({ user: address }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.stats.Query/UserStats',
+      requestData,
+    );
+    return StatsModule.QueryUserStatsResponse.decode(data).stats;
+  }
+
+  /**
+   * @description Get all balances for an account.
+   *
+   * @returns Array of Coin balances for all tokens held by an account.
+   */
+  async getAccountBalances(address: string): Promise<Coin[]> {
+    const requestData: Uint8Array = Uint8Array.from(
+      BankModule.QueryAllBalancesRequest.encode({ address }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/cosmos.bank.v1beta1.Query/AllBalances',
+      requestData,
+    );
+    return BankModule.QueryAllBalancesResponse.decode(data).balances;
+  }
+
+  /**
+   * @description Get balances of one denom for an account.
+   *
+   * @returns Coin balance for denom tokens held by an account.
+   */
+  async getAccountBalance(address: string, denom: string): Promise<Coin | undefined> {
+    const requestData: Uint8Array = Uint8Array.from(
+      BankModule.QueryBalanceRequest.encode({
+        address,
+        denom,
+      }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/cosmos.bank.v1beta1.Query/Balance',
+      requestData,
+    );
+    const coin = BankModule.QueryBalanceResponse.decode(data).balance;
+    return coin;
+  }
+
+  /**
+   * @description Get all subaccounts
+   *
+   * @returns All subaccounts
+   */
+  async getSubaccounts(): Promise<SubaccountsModule.QuerySubaccountAllResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      SubaccountsModule.QueryAllSubaccountRequest.encode({}).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.subaccounts.Query/SubaccountAll',
+      requestData,
+    );
+    return SubaccountsModule.QuerySubaccountAllResponse.decode(data);
+  }
+
+  /**
+   * @description Get a specific subaccount for an account.
+   *
+   * @returns Subaccount for account with given accountNumber or default subaccount if none exists.
+   */
+  async getSubaccount(
+    address: string,
+    accountNumber: number,
+  ): Promise<SubaccountsModule.QuerySubaccountResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      SubaccountsModule.QueryGetSubaccountRequest.encode({
+        owner: address,
+        number: accountNumber,
+      }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.subaccounts.Query/Subaccount',
+      requestData,
+    );
+    return SubaccountsModule.QuerySubaccountResponse.decode(data);
+  }
+
+  /**
+   * @description Get the params for the rewards module.
+   *
+   * @returns Params for the rewards module.
+   */
+  async getRewardsParams(): Promise<RewardsModule.QueryParamsResponse> {
+    const requestData = Uint8Array.from(RewardsModule.QueryParamsRequest.encode({}).finish());
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.rewards.Query/Params',
+      requestData,
+    );
+    return RewardsModule.QueryParamsResponse.decode(data);
+  }
+
+  /**
+   * @description Get all Clob Pairs.
+   *
+   * @returns Information on all Clob Pairs.
+   */
+  async getAllClobPairs(): Promise<ClobModule.QueryClobPairAllResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      ClobModule.QueryAllClobPairRequest.encode({ pagination: PAGE_REQUEST }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.clob.Query/ClobPairAll',
+      requestData,
+    );
+    return ClobModule.QueryClobPairAllResponse.decode(data);
+  }
+
+  /**
+   * @description Get Clob Pair for an Id or the promise is rejected if no pair exists.
+   *
+   * @returns Clob Pair for a given Clob Pair Id.
+   */
+  async getClobPair(pairId: number): Promise<ClobModule.QueryClobPairResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      ClobModule.QueryGetClobPairRequest.encode({ id: pairId }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery('/zogux.clob.Query/ClobPair', requestData);
+    return ClobModule.QueryClobPairResponse.decode(data);
+  }
+
+  /**
+   * @description Get all Prices across markets.
+   *
+   * @returns Prices across all markets.
+   */
+  async getAllPrices(): Promise<PricesModule.QueryAllMarketPricesResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      PricesModule.QueryAllMarketPricesRequest.encode({ pagination: PAGE_REQUEST }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.prices.Query/AllMarketPrices',
+      requestData,
+    );
+    return PricesModule.QueryAllMarketPricesResponse.decode(data);
+  }
+
+  /**
+   * @description Get Price for a clob Id or the promise is rejected if none exists.
+   *
+   * @returns Price for a given Market Id.
+   */
+  async getPrice(marketId: number): Promise<PricesModule.QueryMarketPriceResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      PricesModule.QueryMarketPriceRequest.encode({ id: marketId }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.prices.Query/MarketPrice',
+      requestData,
+    );
+    return PricesModule.QueryMarketPriceResponse.decode(data);
+  }
+
+  /**
+   * @description Get all Perpetuals.
+   *
+   * @returns Information on all Perpetual pairs.
+   */
+  async getAllPerpetuals(): Promise<PerpetualsModule.QueryAllPerpetualsResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      PerpetualsModule.QueryAllPerpetualsRequest.encode({ pagination: PAGE_REQUEST }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.perpetuals.Query/AllPerpetuals',
+      requestData,
+    );
+    return PerpetualsModule.QueryAllPerpetualsResponse.decode(data);
+  }
+
+  /**
+   * @description Get Perpetual for an Id or the promise is rejected if none exists.
+   *
+   * @returns The Perpetual for a given Perpetual Id.
+   */
+  async getPerpetual(perpetualId: number): Promise<PerpetualsModule.QueryPerpetualResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      PerpetualsModule.QueryPerpetualRequest.encode({ id: perpetualId }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.perpetuals.Query/Perpetual',
+      requestData,
+    );
+    return PerpetualsModule.QueryPerpetualResponse.decode(data);
+  }
+
+  /**
+   * @description Get Account for an address or the promise is rejected if the account
+   * does not exist on-chain.
+   *
+   * @throws UnexpectedClientError if a malformed response is returned with no GRPC error.
+   * @returns An account for a given address.
+   */
+  async getAccount(address: string): Promise<Account> {
+    const requestData: Uint8Array = Uint8Array.from(
+      AuthModule.QueryAccountRequest.encode({ address }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/cosmos.auth.v1beta1.Query/Account',
+      requestData,
+    );
+    const rawAccount: Any | undefined = AuthModule.QueryAccountResponse.decode(data).account;
+
+    // The promise should have been rejected if the rawAccount was undefined.
+    if (rawAccount === undefined) {
+      throw new UnexpectedClientError();
+    }
+    return accountFromAny(rawAccount);
+  }
+
+  /**
+   * @description Get equity tier limit configuration.
+   *
+   * @returns Information on all equity tiers that are configured.
+   */
+  async getEquityTierLimitConfiguration(): Promise<ClobModule.QueryEquityTierLimitConfigurationResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      ClobModule.QueryEquityTierLimitConfigurationRequest.encode({}).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.clob.Query/EquityTierLimitConfiguration',
+      requestData,
+    );
+    return ClobModule.QueryEquityTierLimitConfigurationResponse.decode(data);
+  }
+
+  /**
+   *
+   * @description Get all delegations from a delegator.
+   *
+   * @returns All delegations from a delegator.
+   */
+  async getDelegatorDelegations(
+    delegatorAddr: string,
+  ): Promise<StakingModule.QueryDelegatorDelegationsResponse> {
+    const requestData = Uint8Array.from(
+      StakingModule.QueryDelegatorDelegationsRequest.encode({
+        delegatorAddr,
+        pagination: PAGE_REQUEST,
+      }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/cosmos.staking.v1beta1.Query/DelegatorDelegations',
+      requestData,
+    );
+    return StakingModule.QueryDelegatorDelegationsResponse.decode(data);
+  }
+
+  /**
+   *
+   * @description Get all unbonding delegations from a delegator.
+   *
+   * @returns All unbonding delegations from a delegator.
+   */
+  async getDelegatorUnbondingDelegations(
+    delegatorAddr: string,
+  ): Promise<StakingModule.QueryDelegatorUnbondingDelegationsResponse> {
+    const requestData = Uint8Array.from(
+      StakingModule.QueryDelegatorUnbondingDelegationsRequest.encode({
+        delegatorAddr,
+        pagination: PAGE_REQUEST,
+      }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/cosmos.staking.v1beta1.Query/DelegatorUnbondingDelegations',
+      requestData,
+    );
+    return StakingModule.QueryDelegatorUnbondingDelegationsResponse.decode(data);
+  }
+
+  /**
+   *
+   * @description Get all unbonding delegations from a delegator.
+   *
+   * @returns All unbonding delegations from a delegator.
+   */
+  async getDelegationTotalRewards(
+    delegatorAddress: string,
+  ): Promise<DistributionModule.QueryDelegationTotalRewardsResponse> {
+    const requestData = Uint8Array.from(
+      DistributionModule.QueryDelegationTotalRewardsRequest.encode({
+        delegatorAddress,
+      }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/cosmos.distribution.v1beta1.Query/DelegationTotalRewards',
+      requestData,
+    );
+    return DistributionModule.QueryDelegationTotalRewardsResponse.decode(data);
+  }
+
+  /**
+   * @description Get all delayed complete bridge messages, optionally filtered by address.
+   *
+   * @returns Information on all delayed complete bridge messages.
+   */
+  async getDelayedCompleteBridgeMessages(
+    address: string = '',
+  ): Promise<BridgeModule.QueryDelayedCompleteBridgeMessagesResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      BridgeModule.QueryDelayedCompleteBridgeMessagesRequest.encode({ address }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.bridge.Query/DelayedCompleteBridgeMessages',
+      requestData,
+    );
+    return BridgeModule.QueryDelayedCompleteBridgeMessagesResponse.decode(data);
+  }
+
+  /**
+   * @description Get all validators of a status.
+   *
+   * @returns all validators of a status.
+   */
+  async getAllValidators(status: string = ''): Promise<StakingModule.QueryValidatorsResponse> {
+    const requestData = Uint8Array.from(
+      StakingModule.QueryValidatorsRequest.encode({
+        status,
+        pagination: PAGE_REQUEST,
+      }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/cosmos.staking.v1beta1.Query/Validators',
+      requestData,
+    );
+    return StakingModule.QueryValidatorsResponse.decode(data);
+  }
+
+  /**
+   * @description Get all gov proposals.
+   *
+   * @param proposalStatus Status of the proposal to filter by.
+   * @param voter Voter to filter by.
+   * @param depositor Depositor to filter by.
+   *
+   * @returns All gov proposals that match the filters above.
+   */
+  async getAllGovProposals(
+    proposalStatus: ProposalStatus = ProposalStatus.PROPOSAL_STATUS_VOTING_PERIOD,
+    voter: string = '',
+    depositor: string = '',
+  ): Promise<GovV1Module.QueryProposalsResponse> {
+    const requestData = Uint8Array.from(
+      GovV1Module.QueryProposalsRequest.encode({
+        proposalStatus,
+        voter,
+        depositor,
+        pagination: PAGE_REQUEST,
+      }).finish(),
+    );
+    const data: Uint8Array = await this.sendQuery('/cosmos.gov.v1.Query/Proposals', requestData);
+    return GovV1Module.QueryProposalsResponse.decode(data);
+  }
+
+  async getWithdrawalAndTransferGatingStatus(
+    perpetualId: number,
+  ): Promise<SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoResponse> {
+    const requestData = Uint8Array.from(
+      SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoRequest.encode({
+        perpetualId,
+      }).finish(),
+    );
+
+    const data = await this.sendQuery(
+      '/zogux.subaccounts.Query/GetWithdrawalAndTransfersBlockedInfo',
+      requestData,
+    );
+
+    return SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoResponse.decode(data);
+  }
+
+  async getWithdrawalCapacityByDenom(
+    denom: string,
+  ): Promise<RateLimitModule.QueryCapacityByDenomResponse> {
+    const requestData = Uint8Array.from(
+      RateLimitModule.QueryCapacityByDenomRequest.encode({
+        denom,
+      }).finish(),
+    );
+
+    const data = await this.sendQuery('/zogux.ratelimit.Query/CapacityByDenom', requestData);
+
+    return RateLimitModule.QueryCapacityByDenomResponse.decode(data);
+  }
+
+  async getMegavaultOwnerShares(
+    address: string,
+  ): Promise<VaultModule.QueryMegavaultOwnerSharesResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      VaultModule.QueryMegavaultOwnerSharesRequest.encode({
+        address,
+      }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.vault.Query/MegavaultOwnerShares',
+      requestData,
+    );
+
+    return VaultModule.QueryMegavaultOwnerSharesResponse.decode(data);
+  }
+
+  async getMegavaultWithdrawalInfo(
+    sharesToWithdraw: bigint,
+  ): Promise<VaultModule.QueryMegavaultWithdrawalInfoResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      VaultModule.QueryMegavaultWithdrawalInfoRequest.encode({
+        sharesToWithdraw: {
+          numShares: bigIntToBytes(sharesToWithdraw),
+        },
+      }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/zogux.vault.Query/MegavaultWithdrawalInfo',
+      requestData,
+    );
+
+    return VaultModule.QueryMegavaultWithdrawalInfoResponse.decode(data);
+  }
+
+  async getAffiliateInfo(address: string): Promise<AffiliateModule.AffiliateInfoResponse> {
+    const requestData = Uint8Array.from(
+      AffiliateModule.AffiliateInfoRequest.encode({
+        address,
+      }).finish(),
+    );
+
+    const data = await this.sendQuery('/zogux.affiliates.Query/AffiliateInfo', requestData);
+
+    return AffiliateModule.AffiliateInfoResponse.decode(data);
+  }
+
+  async getReferredBy(address: string): Promise<AffiliateModule.ReferredByResponse> {
+    const requestData = Uint8Array.from(
+      AffiliateModule.ReferredByRequest.encode({
+        address,
+      }).finish(),
+    );
+
+    const data = await this.sendQuery('/zogux.affiliates.Query/ReferredBy', requestData);
+
+    return AffiliateModule.ReferredByResponse.decode(data);
+  }
+
+  async getAllAffiliateTiers(): Promise<AffiliateModule.AllAffiliateTiersResponse> {
+    const requestData = Uint8Array.from(
+      AffiliateModule.AllAffiliateTiersRequest.encode({}).finish(),
+    );
+
+    const data = await this.sendQuery(
+      '/zogux.affiliates.Query/AllAffiliateTiers',
+      requestData,
+    );
+
+    return AffiliateModule.AllAffiliateTiersResponse.decode(data);
+  }
+
+  async getAffiliateWhitelist(): Promise<AffiliateModule.AffiliateWhitelistResponse> {
+    const requestData = Uint8Array.from(
+      AffiliateModule.AffiliateWhitelistRequest.encode({}).finish(),
+    );
+
+    const data = await this.sendQuery(
+      '/zogux.affiliates.Query/AffiliateWhitelist',
+      requestData,
+    );
+
+    return AffiliateModule.AffiliateWhitelistResponse.decode(data);
+  }
+
+  async getAuthenticators(address: string): Promise<GetAuthenticatorsResponse> {
+    const requestData = Uint8Array.from(
+      GetAuthenticatorsRequest.encode({
+        account: address,
+      }).finish(),
+    );
+
+    const data = await this.sendQuery(
+      '/zogux.accountplus.Query/GetAuthenticators',
+      requestData,
+    );
+
+    return GetAuthenticatorsResponse.decode(data);
+  }
+
+  /**
+   * @description Get fee discounts for all perp markets.
+   * @returns All markets' fee discounts.
+   */
+  async getAllPerpMarketFeeDiscounts(): Promise<FeeTierModule.QueryAllMarketFeeDiscountParamsResponse> {
+    const requestData = Uint8Array.from(
+      FeeTierModule.QueryAllMarketFeeDiscountParamsRequest.encode({}).finish(),
+    );
+
+    const data = await this.sendQuery(
+      '/zogux.feetiers.Query/AllMarketFeeDiscountParams',
+      requestData,
+    );
+
+    return FeeTierModule.QueryAllMarketFeeDiscountParamsResponse.decode(data);
+  }
+
+  /**
+   *
+   * @param address The address of the user to get the staking tier for.
+   * @returns The staking tier for the user.
+   */
+  async getUserStakingTier(address: string): Promise<FeeTierModule.QueryUserStakingTierResponse> {
+    const requestData = Uint8Array.from(
+      FeeTierModule.QueryUserStakingTierRequest.encode({
+        address,
+      }).finish(),
+    );
+
+    const data = await this.sendQuery('/zogux.feetiers.Query/UserStakingTier', requestData);
+
+    return FeeTierModule.QueryUserStakingTierResponse.decode(data);
+  }
+
+  /**
+   * @description Get all staking tiers.
+   * @returns All staking tiers.
+   */
+  async getAllStakingTiers(): Promise<FeeTierModule.QueryStakingTiersResponse> {
+    const requestData = Uint8Array.from(FeeTierModule.QueryStakingTiersRequest.encode({}).finish());
+
+    const data = await this.sendQuery('/zogux.feetiers.Query/StakingTiers', requestData);
+
+    return FeeTierModule.QueryStakingTiersResponse.decode(data);
+  }
+
+  private async sendQuery(requestUrl: string, requestData: Uint8Array): Promise<Uint8Array> {
+    // eslint-disable-next-line max-len
+    const resp: QueryAbciResponse = await this.stargateQueryClient.queryAbci(
+      requestUrl,
+      requestData,
+    );
+    return resp.value;
+  }
+}