@ritbit/v4-client-js 1.3.17

package/src/clients/lib/errors.ts

@@ -0,0 +1,63 @@
+import { tendermint37 } from '@cosmjs/tendermint-rpc';
+
+type BroadcastTxSyncResponse = tendermint37.BroadcastTxSyncResponse;
+
+/**
+ * An edge-case was hit in the client that should never have been reached.
+ */
+export class UnexpectedClientError extends Error {
+  constructor() {
+    super('An unexpected error occurred on the client');
+    this.name = 'UnexpectedClientError';
+  }
+}
+
+/**
+ * An error occurred during the broadcasting process.
+ */
+export class BroadcastErrorObject extends Error {
+  result: BroadcastTxSyncResponse;
+  code: number;
+  codespace?: string;
+
+  constructor(message: string, result: BroadcastTxSyncResponse) {
+    super(message);
+    this.name = 'BroadcastError';
+    this.result = result;
+    this.code = result.code;
+    this.codespace = result.codespace;
+  }
+}
+
+/**
+ * User error occurred during a client operation.
+ */
+export class UserError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'UserError';
+  }
+}
+
+/**
+ * @description Base class for custom errors.
+ */
+export class CustomError extends Error {
+  constructor(message: string) {
+    super(message);
+    // Set a more specific name. This will show up in e.g. console.log.
+    this.name = this.constructor.toString();
+  }
+}
+
+/**
+ * @description Base class for a custom error which wraps another error.
+ */
+export class WrappedError extends CustomError {
+  public readonly originalError: Error;
+
+  constructor(message: string, originalError: Error) {
+    super(message);
+    this.originalError = originalError;
+  }
+}

package/src/clients/lib/registry.ts

@@ -0,0 +1,88 @@
+import { GeneratedType, Registry } from '@cosmjs/proto-signing';
+import { defaultRegistryTypes } from '@cosmjs/stargate';
+import { MsgAddAuthenticator, MsgRemoveAuthenticator } from '@ritbit/v4-proto/src/codegen/ritbit/accountplus/tx';
+import { MsgRegisterAffiliate } from '@ritbit/v4-proto/src/codegen/ritbit/affiliates/tx';
+import {
+  MsgPlaceOrder,
+  MsgCancelOrder,
+  MsgCreateClobPair,
+  MsgUpdateClobPair,
+  MsgBatchCancel,
+} from '@ritbit/v4-proto/src/codegen/ritbit/clob/tx';
+import { MsgDelayMessage } from '@ritbit/v4-proto/src/codegen/ritbit/delaymsg/tx';
+import { MsgCreateMarketPermissionless } from '@ritbit/v4-proto/src/codegen/ritbit/listing/tx';
+import { MsgCreatePerpetual } from '@ritbit/v4-proto/src/codegen/ritbit/perpetuals/tx';
+import { MsgCreateOracleMarket } from '@ritbit/v4-proto/src/codegen/ritbit/prices/tx';
+import {
+  MsgWithdrawFromSubaccount,
+  MsgDepositToSubaccount,
+} from '@ritbit/v4-proto/src/codegen/ritbit/sending/transfer';
+import { MsgCreateTransfer } from '@ritbit/v4-proto/src/codegen/ritbit/sending/tx';
+import {
+  MsgDepositToMegavault,
+  MsgWithdrawFromMegavault,
+} from '@ritbit/v4-proto/src/codegen/ritbit/vault/tx';
+
+import {
+  TYPE_URL_MSG_PLACE_ORDER,
+  TYPE_URL_MSG_CANCEL_ORDER,
+  TYPE_URL_MSG_CREATE_CLOB_PAIR,
+  TYPE_URL_MSG_UPDATE_CLOB_PAIR,
+  TYPE_URL_MSG_DELAY_MESSAGE,
+  TYPE_URL_MSG_CREATE_PERPETUAL,
+  TYPE_URL_MSG_CREATE_ORACLE_MARKET,
+  TYPE_URL_MSG_CREATE_TRANSFER,
+  TYPE_URL_MSG_WITHDRAW_FROM_SUBACCOUNT,
+  TYPE_URL_MSG_DEPOSIT_TO_SUBACCOUNT,
+  TYPE_URL_BATCH_CANCEL,
+  TYPE_URL_MSG_DEPOSIT_TO_MEGAVAULT,
+  TYPE_URL_MSG_WITHDRAW_FROM_MEGAVAULT,
+  TYPE_URL_MSG_REGISTER_AFFILIATE,
+  TYPE_URL_MSG_CREATE_MARKET_PERMISSIONLESS,
+  TYPE_URL_MSG_ADD_AUTHENTICATOR,
+  TYPE_URL_MSG_REMOVE_AUTHENTICATOR,
+} from '../constants';
+
+export const registry: ReadonlyArray<[string, GeneratedType]> = [];
+export function generateRegistry(): Registry {
+  return new Registry([
+    // clob
+    [TYPE_URL_MSG_PLACE_ORDER, MsgPlaceOrder as GeneratedType],
+    [TYPE_URL_MSG_CANCEL_ORDER, MsgCancelOrder as GeneratedType],
+    [TYPE_URL_BATCH_CANCEL, MsgBatchCancel as GeneratedType],
+    [TYPE_URL_MSG_CREATE_CLOB_PAIR, MsgCreateClobPair as GeneratedType],
+    [TYPE_URL_MSG_UPDATE_CLOB_PAIR, MsgUpdateClobPair as GeneratedType],
+
+    // delaymsg
+    [TYPE_URL_MSG_DELAY_MESSAGE, MsgDelayMessage as GeneratedType],
+
+    // listing
+    [TYPE_URL_MSG_CREATE_MARKET_PERMISSIONLESS, MsgCreateMarketPermissionless as GeneratedType],
+
+    // perpetuals
+    [TYPE_URL_MSG_CREATE_PERPETUAL, MsgCreatePerpetual as GeneratedType],
+
+    // prices
+    [TYPE_URL_MSG_CREATE_ORACLE_MARKET, MsgCreateOracleMarket as GeneratedType],
+
+    // vaults
+    [TYPE_URL_MSG_DEPOSIT_TO_MEGAVAULT, MsgDepositToMegavault as GeneratedType],
+    [TYPE_URL_MSG_WITHDRAW_FROM_MEGAVAULT, MsgWithdrawFromMegavault as GeneratedType],
+
+    // sending
+    [TYPE_URL_MSG_CREATE_TRANSFER, MsgCreateTransfer as GeneratedType],
+    [TYPE_URL_MSG_WITHDRAW_FROM_SUBACCOUNT, MsgWithdrawFromSubaccount as GeneratedType],
+    [TYPE_URL_MSG_DEPOSIT_TO_SUBACCOUNT, MsgDepositToSubaccount as GeneratedType],
+
+    // affiliates
+    [TYPE_URL_MSG_REGISTER_AFFILIATE, MsgRegisterAffiliate as GeneratedType],
+
+
+    // authentication
+    [TYPE_URL_MSG_ADD_AUTHENTICATOR, MsgAddAuthenticator as GeneratedType],
+    [TYPE_URL_MSG_REMOVE_AUTHENTICATOR, MsgRemoveAuthenticator as GeneratedType],
+
+    // default types
+    ...defaultRegistryTypes,
+  ]);
+}

package/src/clients/modules/account.ts

@@ -0,0 +1,388 @@
+import {
+  OrderSide,
+  OrderStatus,
+  OrderType,
+  PositionStatus,
+  TickerType,
+  TradingRewardAggregationPeriod,
+} from '../constants';
+import { Data } from '../types';
+import RestClient from './rest';
+
+/**
+ * @description REST endpoints for data related to a particular address.
+ */
+export default class AccountClient extends RestClient {
+  // ------ Subaccount ------ //
+
+  async getSubaccounts(address: string, limit?: number): Promise<Data> {
+    const uri = `/v4/addresses/${address}`;
+    return this.get(uri, { limit });
+  }
+
+  async getSubaccount(address: string, subaccountNumber: number): Promise<Data> {
+    const uri = `/v4/addresses/${address}/subaccountNumber/${subaccountNumber}`;
+    return this.get(uri);
+  }
+
+  async getParentSubaccount(address: string, parentSubaccountNumber: number): Promise<Data> {
+    const uri = `/v4/addresses/${address}/parentSubaccountNumber/${parentSubaccountNumber}`;
+    return this.get(uri);
+  }
+
+  // ------ Positions ------ //
+
+  async getSubaccountPerpetualPositions(
+    address: string,
+    subaccountNumber: number,
+    status?: PositionStatus | null,
+    limit?: number | null,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null,
+  ): Promise<Data> {
+    const uri = '/v4/perpetualPositions';
+    return this.get(uri, {
+      address,
+      subaccountNumber,
+      status,
+      limit,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+    });
+  }
+
+  async getSubaccountAssetPositions(
+    address: string,
+    subaccountNumber: number,
+    status?: PositionStatus | null,
+    limit?: number | null,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null,
+  ): Promise<Data> {
+    const uri = '/v4/assetPositions';
+    return this.get(uri, {
+      address,
+      subaccountNumber,
+      status,
+      limit,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+    });
+  }
+
+  // ------ Transfers ------ //
+
+  async getTransfersBetween(
+    sourceAddress: string,
+    sourceSubaccountNumber: string,
+    recipientAddress: string,
+    recipientSubaccountNumber: string,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null,
+  ): Promise<Data> {
+    const uri = '/v4/transfers/between';
+    return this.get(uri, {
+      sourceAddress,
+      sourceSubaccountNumber,
+      recipientAddress,
+      recipientSubaccountNumber,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+    });
+  }
+
+  async getSubaccountTransfers(
+    address: string,
+    subaccountNumber: number,
+    limit?: number | null,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null,
+    page?: number | null,
+  ): Promise<Data> {
+    const uri = '/v4/transfers';
+    return this.get(uri, {
+      address,
+      subaccountNumber,
+      limit,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+      page,
+    });
+  }
+
+  async getParentSubaccountNumberTransfers(
+    address: string,
+    parentSubaccountNumber: number,
+    limit?: number | null,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null,
+    page?: number | null,
+  ): Promise<Data> {
+    const uri = '/v4/transfers/parentSubaccountNumber';
+    return this.get(uri, {
+      address,
+      parentSubaccountNumber,
+      limit,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+      page,
+    });
+  }
+
+  // ------ Orders ------ //
+
+  async getSubaccountOrders(
+    address: string,
+    subaccountNumber: number,
+    ticker?: string | null,
+    tickerType: TickerType = TickerType.PERPETUAL,
+    side?: OrderSide | null,
+    status?: OrderStatus | null,
+    type?: OrderType | null,
+    limit?: number | null,
+    goodTilBlockBeforeOrAt?: number | null,
+    goodTilBlockTimeBeforeOrAt?: string | null,
+    returnLatestOrders?: boolean | null,
+  ): Promise<Data> {
+    const uri = '/v4/orders';
+    return this.get(uri, {
+      address,
+      subaccountNumber,
+      ticker,
+      tickerType,
+      side,
+      status,
+      type,
+      limit,
+      goodTilBlockBeforeOrAt,
+      goodTilBlockTimeBeforeOrAt,
+      returnLatestOrders,
+    });
+  }
+
+  async getParentSubaccountNumberOrders(
+    address: string,
+    parentSubaccountNumber: number,
+    ticker?: string | null,
+    side?: OrderSide | null,
+    status?: OrderStatus | null,
+    type?: OrderType | null,
+    limit?: number | null,
+    goodTilBlockBeforeOrAt?: number | null,
+    goodTilBlockTimeBeforeOrAt?: string | null,
+    returnLatestOrders?: boolean | null,
+  ): Promise<Data> {
+    const uri = '/v4/orders/parentSubaccountNumber';
+    return this.get(uri, {
+      address,
+      parentSubaccountNumber,
+      ticker,
+      side,
+      status,
+      type,
+      limit,
+      goodTilBlockBeforeOrAt,
+      goodTilBlockTimeBeforeOrAt,
+      returnLatestOrders,
+    });
+  }
+
+  async getOrder(orderId: string): Promise<Data> {
+    const uri = `/v4/orders/${orderId}`;
+    return this.get(uri);
+  }
+
+  // ------ Fills ------ //
+
+  async getSubaccountFills(
+    address: string,
+    subaccountNumber: number,
+    ticker?: string | null,
+    tickerType: TickerType = TickerType.PERPETUAL,
+    limit?: number | null,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null,
+    page?: number | null,
+  ): Promise<Data> {
+    const uri = '/v4/fills';
+    return this.get(uri, {
+      address,
+      subaccountNumber,
+      ticker,
+      tickerType,
+      limit,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+      page,
+    });
+  }
+
+  async getParentSubaccountNumberFills(
+    address: string,
+    parentSubaccountNumber: number,
+    ticker?: string | null,
+    tickerType: TickerType = TickerType.PERPETUAL,
+    limit?: number | null,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null,
+    page?: number | null,
+  ): Promise<Data> {
+    const uri = '/v4/fills/parentSubaccountNumber';
+    return this.get(uri, {
+      address,
+      parentSubaccountNumber,
+      ticker,
+      tickerType,
+      limit,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+      page,
+    });
+  }
+
+  // ------ Pnl ------ //
+
+  async getSubaccountHistoricalPNLs(
+    address: string,
+    subaccountNumber: number,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null,
+    createdOnOrAfterHeight?: number | null,
+    createdOnOrAfter?: string | null,
+    limit?: number | null,
+    page?: number | null,
+  ): Promise<Data> {
+    const uri = '/v4/historical-pnl';
+    return this.get(uri, {
+      address,
+      subaccountNumber,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+      createdOnOrAfterHeight,
+      createdOnOrAfter,
+      limit,
+      page,
+    });
+  }
+
+  // limit applies to the subaccount ticks, so expect number of results to be much lower than limit
+  async getParentSubaccountNumberHistoricalPNLs(
+    address: string,
+    parentSubaccountNumber: number,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null,
+    createdOnOrAfterHeight?: number | null,
+    createdOnOrAfter?: string | null,
+    limit?: number | null,
+    page?: number | null,
+  ): Promise<Data> {
+    const uri = '/v4/historical-pnl/parentSubaccountNumber';
+    return this.get(uri, {
+      address,
+      parentSubaccountNumber,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+      createdOnOrAfterHeight,
+      createdOnOrAfter,
+      limit,
+      page,
+    });
+  }
+
+  async getSubaccountHistoricalPNLsV2(
+    address: string,
+    subaccountNumber: number,
+    // false or undefined = hourly
+    daily?: boolean,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null,
+    createdOnOrAfterHeight?: number | null,
+    createdOnOrAfter?: string | null,
+    limit?: number | null,
+    page?: number | null,
+  ): Promise<Data> {
+    const uri = '/v4/pnl';
+    return this.get(uri, {
+      address,
+      subaccountNumber,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+      createdOnOrAfterHeight,
+      createdOnOrAfter,
+      limit,
+      page,
+      daily,
+    });
+  }
+
+  async getParentSubaccountNumberHistoricalPNLsV2(
+    address: string,
+    parentSubaccountNumber: number,
+    // false or undefined = hourly
+    daily?: boolean,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null,
+    createdOnOrAfterHeight?: number | null,
+    createdOnOrAfter?: string | null,
+  ): Promise<Data> {
+    const uri = '/v4/pnl/parentSubaccountNumber';
+    return this.get(uri, {
+      address,
+      parentSubaccountNumber,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+      createdOnOrAfterHeight,
+      createdOnOrAfter,
+      daily,
+    });
+  }
+
+  // ------ Rewards ------ //
+
+  async getHistoricalTradingRewardsAggregations(
+    address: string,
+    period: TradingRewardAggregationPeriod,
+    limit?: number,
+    startingBeforeOrAt?: string,
+    startingBeforeOrAtHeight?: string,
+  ): Promise<Data> {
+    const uri = `/v4/historicalTradingRewardAggregations/${address}`;
+    return this.get(uri, { period, limit, startingBeforeOrAt, startingBeforeOrAtHeight });
+  }
+
+  async getHistoricalBlockTradingRewards(
+    address: string,
+    limit?: number,
+    startingBeforeOrAt?: string,
+    startingBeforeOrAtHeight?: string,
+  ): Promise<Data> {
+    const uri = `/v4/historicalBlockTradingRewards/${address}`;
+    return this.get(uri, { limit, startingBeforeOrAt, startingBeforeOrAtHeight });
+  }
+
+  // ------ Funding Payments------ //
+
+  async getSubaccountFundingPayments(
+    address: string,
+    subaccountNumber: number,
+    limit?: number,
+    ticker?: string,
+    afterOrAt?: string,
+    page?: number,
+  ): Promise<Data> {
+    const uri = `/v4/fundingPayments`;
+    return this.get(uri, { address, subaccountNumber, limit, ticker, afterOrAt, page });
+  }
+
+  async getParentSubaccountNumberFundingPayments(
+    address: string,
+    parentSubaccountNumber: number,
+    limit?: number,
+    ticker?: string,
+    afterOrAt?: string,
+    page?: number,
+  ): Promise<Data> {
+    const uri = `/v4/fundingPayments/parentSubaccount`;
+    return this.get(uri, { address, parentSubaccountNumber, limit, ticker, afterOrAt, page });
+  }
+}