@dydxprotocol/v4-client-js 1.1.13 → 1.1.15

package/src/clients/constants.ts

@@ -25,7 +25,7 @@ export enum IndexerApiHost {
   TESTNET = 'https://dydx-testnet.imperator.co',
   LOCAL = 'http://localhost:3002',
   // For the deployment by DYDX token holders
-  MAINNET = 'https://indexer.dydx.trade'
+  MAINNET = 'https://indexer.dydx.trade',
 }
 
 export enum IndexerWSHost {
@@ -43,7 +43,7 @@ export enum ValidatorApiHost {
   TESTNET = 'https://test-dydx.kingnodes.com',
   LOCAL = 'http://localhost:26657',
   // For the deployment by DYDX token holders
-  MAINNET = 'https://dydx-ops-rpc.kingnodes.com:443'
+  MAINNET = 'https://dydx-ops-rpc.kingnodes.com:443',
 }
 
 // ------------ Network IDs ------------
@@ -51,7 +51,7 @@ export enum ValidatorApiHost {
 export enum NetworkId {
   TESTNET = 'dydx-testnet-4',
   // For the deployment by DYDX token holders
-  MAINNET = 'dydx-mainnet-1'
+  MAINNET = 'dydx-mainnet-1',
 }
 export const NETWORK_ID_TESTNET: string = 'dydxprotocol-testnet';
 // For the deployment by DYDX token holders
@@ -89,9 +89,16 @@ export const TYPE_URL_MSG_CREATE_ORACLE_MARKET = '/dydxprotocol.prices.MsgCreate
 
 // x/sending
 export const TYPE_URL_MSG_CREATE_TRANSFER = '/dydxprotocol.sending.MsgCreateTransfer';
-export const TYPE_URL_MSG_WITHDRAW_FROM_SUBACCOUNT = '/dydxprotocol.sending.MsgWithdrawFromSubaccount';
+export const TYPE_URL_MSG_WITHDRAW_FROM_SUBACCOUNT =
+  '/dydxprotocol.sending.MsgWithdrawFromSubaccount';
 export const TYPE_URL_MSG_DEPOSIT_TO_SUBACCOUNT = '/dydxprotocol.sending.MsgDepositToSubaccount';
 
+// x/staking
+export const TYPE_URL_MSG_DELEGATE = '/cosmos.staking.v1beta1.MsgDelegate';
+export const TYPE_URL_MSG_UNDELEGATE = '/cosmos.staking.v1beta1.MsgUndelegate';
+export const TYPE_URL_MSG_WITHDRAW_DELEGATOR_REWARD =
+  '/cosmos.staking.v1beta1.MsgWithdrawDelegatorReward';
+
 // ------------ Chain Constants ------------
 // The following are same across different networks / deployments.
 export const GOV_MODULE_ADDRESS = 'dydx10d07y265gmmuvt4z0w9aw880jnsr700jnmapky';
@@ -150,7 +157,7 @@ export enum OrderStatus {
 }
 
 export enum TickerType {
-  PERPETUAL = 'PERPETUAL',  // Only PERPETUAL is supported right now
+  PERPETUAL = 'PERPETUAL', // Only PERPETUAL is supported right now
 }
 
 export enum PositionStatus {
@@ -188,8 +195,7 @@ export class IndexerConfig {
   public restEndpoint: string;
   public websocketEndpoint: string;
 
-  constructor(restEndpoint: string,
-    websocketEndpoint: string) {
+  constructor(restEndpoint: string, websocketEndpoint: string) {
     this.restEndpoint = restEndpoint;
     this.websocketEndpoint = websocketEndpoint;
   }
@@ -223,54 +229,60 @@ export class Network {
     public env: string,
     public indexerConfig: IndexerConfig,
     public validatorConfig: ValidatorConfig,
-  ) { }
+  ) {}
 
   static testnet(): Network {
-    const indexerConfig = new IndexerConfig(
-      IndexerApiHost.TESTNET,
-      IndexerWSHost.TESTNET,
-    );
-    const validatorConfig = new ValidatorConfig(ValidatorApiHost.TESTNET, TESTNET_CHAIN_ID,
+    const indexerConfig = new IndexerConfig(IndexerApiHost.TESTNET, IndexerWSHost.TESTNET);
+    const validatorConfig = new ValidatorConfig(
+      ValidatorApiHost.TESTNET,
+      TESTNET_CHAIN_ID,
       {
         CHAINTOKEN_DENOM: 'adv4tnt',
         USDC_DENOM: 'ibc/8E27BA2D5493AF5636760E354E46004562C46AB7EC0CC4C1CA14E9E20E2545B5',
         USDC_GAS_DENOM: 'uusdc',
         USDC_DECIMALS: 6,
         CHAINTOKEN_DECIMALS: 18,
-      }, undefined, 'Client Example');
+      },
+      undefined,
+      'Client Example',
+    );
     return new Network('testnet', indexerConfig, validatorConfig);
   }
 
   static local(): Network {
-    const indexerConfig = new IndexerConfig(
-      IndexerApiHost.LOCAL,
-      IndexerWSHost.LOCAL,
-    );
-    const validatorConfig = new ValidatorConfig(ValidatorApiHost.LOCAL, LOCAL_CHAIN_ID,
+    const indexerConfig = new IndexerConfig(IndexerApiHost.LOCAL, IndexerWSHost.LOCAL);
+    const validatorConfig = new ValidatorConfig(
+      ValidatorApiHost.LOCAL,
+      LOCAL_CHAIN_ID,
       {
         CHAINTOKEN_DENOM: 'adv4tnt',
         USDC_DENOM: 'ibc/8E27BA2D5493AF5636760E354E46004562C46AB7EC0CC4C1CA14E9E20E2545B5',
         USDC_GAS_DENOM: 'uusdc',
         USDC_DECIMALS: 6,
         CHAINTOKEN_DECIMALS: 18,
-      }, undefined, 'Client Example');
+      },
+      undefined,
+      'Client Example',
+    );
     return new Network('local', indexerConfig, validatorConfig);
   }
 
   // For the deployment by DYDX token holders.
   static mainnet(): Network {
-    const indexerConfig = new IndexerConfig(
-      IndexerApiHost.MAINNET,
-      IndexerWSHost.MAINNET,
-    );
-    const validatorConfig = new ValidatorConfig(ValidatorApiHost.MAINNET, MAINNET_CHAIN_ID,
+    const indexerConfig = new IndexerConfig(IndexerApiHost.MAINNET, IndexerWSHost.MAINNET);
+    const validatorConfig = new ValidatorConfig(
+      ValidatorApiHost.MAINNET,
+      MAINNET_CHAIN_ID,
       {
         CHAINTOKEN_DENOM: 'adydx',
         USDC_DENOM: 'ibc/8E27BA2D5493AF5636760E354E46004562C46AB7EC0CC4C1CA14E9E20E2545B5',
         USDC_GAS_DENOM: 'uusdc',
         USDC_DECIMALS: 6,
         CHAINTOKEN_DECIMALS: 18,
-      }, undefined, 'Client Example');
+      },
+      undefined,
+      'Client Example',
+    );
     return new Network('mainnet', indexerConfig, validatorConfig);
   }
 

package/src/clients/faucet-client.ts

@@ -3,10 +3,10 @@ import RestClient from './modules/rest';
 
 export class FaucetClient extends RestClient {
   /**
-     * @description For testnet only, add USDC to an subaccount
-     *
-     * @returns The HTTP response.
-     */
+   * @description For testnet only, add USDC to an subaccount
+   *
+   * @returns The HTTP response.
+   */
   public async fill(
     address: string,
     subaccountNumber: number,
@@ -33,10 +33,7 @@ export class FaucetClient extends RestClient {
    * @param headers requestHeaders
    * @returns The HTTP response.
    */
-  public async fillNative(
-    address: string,
-    headers?: {},
-  ): Promise<Response> {
+  public async fillNative(address: string, headers?: {}): Promise<Response> {
     const uri = '/faucet/native-token';
 
     return this.post(

package/src/clients/helpers/chain-helpers.ts

@@ -1,8 +1,6 @@
 import Long from 'long';
 
-import {
-  OrderType, OrderSide, OrderTimeInForce, OrderExecution,
-} from '../constants';
+import { OrderType, OrderSide, OrderTimeInForce, OrderExecution } from '../constants';
 import { Order_ConditionType, Order_Side, Order_TimeInForce } from '../modules/proto-includes';
 import { OrderFlags } from '../types';
 
@@ -105,10 +103,14 @@ export function calculateTimeInForce(
       }
       switch (execution) {
         case OrderExecution.DEFAULT:
-          throw new Error('Execution value DEFAULT not supported for STOP_MARKET or TAKE_PROFIT_MARKET');
+          throw new Error(
+            'Execution value DEFAULT not supported for STOP_MARKET or TAKE_PROFIT_MARKET',
+          );
 
         case OrderExecution.POST_ONLY:
-          throw new Error('Execution value POST_ONLY not supported for STOP_MARKET or TAKE_PROFIT_MARKET');
+          throw new Error(
+            'Execution value POST_ONLY not supported for STOP_MARKET or TAKE_PROFIT_MARKET',
+          );
 
         case OrderExecution.FOK:
           return Order_TimeInForce.TIME_IN_FORCE_FILL_OR_KILL;
@@ -201,7 +203,9 @@ export function calculateConditionalOrderTriggerSubticks(
     case OrderType.TAKE_PROFIT_LIMIT:
     case OrderType.TAKE_PROFIT_MARKET:
       if (triggerPrice === undefined) {
-        throw new Error('triggerPrice must be set if orderType is STOP_LIMIT, STOP_MARKET, TAKE_PROFIT_LIMIT, or TAKE_PROFIT_MARKET');
+        throw new Error(
+          'triggerPrice must be set if orderType is STOP_LIMIT, STOP_MARKET, TAKE_PROFIT_LIMIT, or TAKE_PROFIT_MARKET',
+        );
       }
       return calculateSubticks(
         triggerPrice,

package/src/clients/helpers/request-helpers.ts

@@ -1,13 +1,14 @@
 export function generateQueryPath(url: string, params: {}): string {
-  const definedEntries = Object.entries(params)
-    .filter(([_key, value]: [string, unknown]) => value !== undefined);
+  const definedEntries = Object.entries(params).filter(
+    ([_key, value]: [string, unknown]) => value !== undefined,
+  );
 
   if (!definedEntries.length) {
     return url;
   }
 
-  const paramsString = definedEntries.map(
-    ([key, value]: [string, unknown]) => `${key}=${value}`,
-  ).join('&');
+  const paramsString = definedEntries
+    .map(([key, value]: [string, unknown]) => `${key}=${value}`)
+    .join('&');
   return `${url}?${paramsString}`;
 }

package/src/clients/indexer-client.ts

@@ -7,43 +7,43 @@ import UtilityClient from './modules/utility';
  * @description Client for Indexer
  */
 export class IndexerClient {
-    public readonly config: IndexerConfig;
-    readonly apiTimeout: number;
-    readonly _markets: MarketsClient;
-    readonly _account: AccountClient;
-    readonly _utility: UtilityClient;
+  public readonly config: IndexerConfig;
+  readonly apiTimeout: number;
+  readonly _markets: MarketsClient;
+  readonly _account: AccountClient;
+  readonly _utility: UtilityClient;
 
-    constructor(config: IndexerConfig, apiTimeout?: number) {
-      this.config = config;
-      this.apiTimeout = apiTimeout ?? DEFAULT_API_TIMEOUT;
+  constructor(config: IndexerConfig, apiTimeout?: number) {
+    this.config = config;
+    this.apiTimeout = apiTimeout ?? DEFAULT_API_TIMEOUT;
 
-      this._markets = new MarketsClient(config.restEndpoint);
-      this._account = new AccountClient(config.restEndpoint);
-      this._utility = new UtilityClient(config.restEndpoint);
-    }
+    this._markets = new MarketsClient(config.restEndpoint);
+    this._account = new AccountClient(config.restEndpoint);
+    this._utility = new UtilityClient(config.restEndpoint);
+  }
 
-    /**
-     * @description Get the public module, used for interacting with public endpoints.
-     *
-     * @returns The public module
-     */
-    get markets(): MarketsClient {
-      return this._markets;
-    }
+  /**
+   * @description Get the public module, used for interacting with public endpoints.
+   *
+   * @returns The public module
+   */
+  get markets(): MarketsClient {
+    return this._markets;
+  }
 
-    /**
-     * @description Get the private module, used for interacting with private endpoints.
-     *
-     * @returns The private module
-     */
-    get account(): AccountClient {
-      return this._account;
-    }
+  /**
+   * @description Get the private module, used for interacting with private endpoints.
+   *
+   * @returns The private module
+   */
+  get account(): AccountClient {
+    return this._account;
+  }
 
-    /**
-     * @description Get the utility module, used for interacting with non-market public endpoints.
-     */
-    get utility(): UtilityClient {
-      return this._utility;
-    }
+  /**
+   * @description Get the utility module, used for interacting with non-market public endpoints.
+   */
+  get utility(): UtilityClient {
+    return this._utility;
+  }
 }

package/src/clients/lib/axios/axiosRequest.ts

@@ -1,16 +1,13 @@
 import axios, { AxiosRequestConfig } from 'axios';
 
 import { Data } from '../../types';
-import {
-  AxiosServerError,
-  AxiosError,
-} from './errors';
+import { AxiosServerError, AxiosError } from './errors';
 import { RequestMethod } from './types';
 
 export interface Response {
-  status: number,
-  data: Data,
-  headers: {},
+  status: number;
+  data: Data;
+  headers: {};
 }
 
 async function axiosRequest(options: AxiosRequestConfig): Promise<Response> {

package/src/clients/lib/axios/errors.ts

@@ -1,6 +1,4 @@
-import {
-  WrappedError,
-} from '../errors';
+import { WrappedError } from '../errors';
 
 interface AxiosOriginalError extends Error {
   isAxiosError: true;
@@ -8,9 +6,9 @@ interface AxiosOriginalError extends Error {
 }
 
 interface AxiosErrorResponse {
-  status: number,
-  statusText: string,
-  data: {},
+  status: number;
+  statusText: string;
+  data: {};
 }
 
 /**
@@ -27,20 +25,17 @@ export class AxiosError extends WrappedError {}
  * @description Axios error with response error fields.
  */
 export class AxiosServerError extends AxiosError {
-    public readonly status: number;
-    public readonly statusText: string;
-    public readonly data: {};
+  public readonly status: number;
+  public readonly statusText: string;
+  public readonly data: {};
 
-    constructor(
-      response: AxiosErrorResponse,
-      originalError: AxiosOriginalError,
-    ) {
-      super(
-        `${response.status}: ${response.statusText} - ${JSON.stringify(response.data, null, 2)}`,
-        originalError,
-      );
-      this.status = response.status;
-      this.statusText = response.statusText;
-      this.data = response.data;
-    }
+  constructor(response: AxiosErrorResponse, originalError: AxiosOriginalError) {
+    super(
+      `${response.status}: ${response.statusText} - ${JSON.stringify(response.data, null, 2)}`,
+      originalError,
+    );
+    this.status = response.status;
+    this.statusText = response.statusText;
+    this.data = response.data;
+  }
 }