@dydxprotocol/v4-client-js 1.1.13 → 1.1.15

package/src/clients/socket-client.ts

@@ -35,246 +35,246 @@ export enum CandlesResolution {
 }
 
 export class SocketClient {
-    private url: string;
-    private ws?: WebSocket;
-    private onOpenCallback?: () => void;
-    private onCloseCallback?: () => void;
-    private onMessageCallback?: (event: MessageEvent) => void;
-    private lastMessageTime: number = Date.now();
+  private url: string;
+  private ws?: WebSocket;
+  private onOpenCallback?: () => void;
+  private onCloseCallback?: () => void;
+  private onMessageCallback?: (event: MessageEvent) => void;
+  private lastMessageTime: number = Date.now();
 
-    constructor(
-      config: IndexerConfig,
-      onOpenCallback: () => void,
-      onCloseCallback: ()=> void,
-      onMessageCallback: (event: MessageEvent)=> void,
-    ) {
-      this.url = config.websocketEndpoint;
-      this.onOpenCallback = onOpenCallback;
-      this.onCloseCallback = onCloseCallback;
-      this.onMessageCallback = onMessageCallback;
-    }
+  constructor(
+    config: IndexerConfig,
+    onOpenCallback: () => void,
+    onCloseCallback: () => void,
+    onMessageCallback: (event: MessageEvent) => void,
+  ) {
+    this.url = config.websocketEndpoint;
+    this.onOpenCallback = onOpenCallback;
+    this.onCloseCallback = onCloseCallback;
+    this.onMessageCallback = onMessageCallback;
+  }
 
-    connect(): void {
-      this.ws = new WebSocket(this.url);
-      this.ws.addEventListener('open', this.handleOpen.bind(this));
-      this.ws.addEventListener('close', this.handleClose.bind(this));
-      this.ws.addEventListener('message', this.handleMessage.bind(this));
-    }
+  connect(): void {
+    this.ws = new WebSocket(this.url);
+    this.ws.addEventListener('open', this.handleOpen.bind(this));
+    this.ws.addEventListener('close', this.handleClose.bind(this));
+    this.ws.addEventListener('message', this.handleMessage.bind(this));
+  }
 
-    /**
-     * @description Close the websocket connection.
-     *
-     */
-    close(): void {
-      this.ws?.close();
-      this.ws = undefined;
-    }
+  /**
+   * @description Close the websocket connection.
+   *
+   */
+  close(): void {
+    this.ws?.close();
+    this.ws = undefined;
+  }
 
-    /**
-     * @description Send data to the websocket connection.
-     *
-     */
-    send(data: string): void {
-      this.ws?.send(data);
-    }
+  /**
+   * @description Send data to the websocket connection.
+   *
+   */
+  send(data: string): void {
+    this.ws?.send(data);
+  }
 
-    private handleOpen(): void {
-      if (this.onOpenCallback) {
-        this.onOpenCallback();
-      }
+  private handleOpen(): void {
+    if (this.onOpenCallback) {
+      this.onOpenCallback();
     }
+  }
 
-    private handleClose(): void {
-      if (this.onCloseCallback) {
-        this.onCloseCallback();
-      }
+  private handleClose(): void {
+    if (this.onCloseCallback) {
+      this.onCloseCallback();
     }
+  }
 
-    private handleMessage(event: MessageEvent): void {
-      if (event.data === 'PING') {
-        this.send('PONG');
-      } else {
-        this.lastMessageTime = Date.now();
-        if (this.onMessageCallback) {
-          this.onMessageCallback(event);
-        }
+  private handleMessage(event: MessageEvent): void {
+    if (event.data === 'PING') {
+      this.send('PONG');
+    } else {
+      this.lastMessageTime = Date.now();
+      if (this.onMessageCallback) {
+        this.onMessageCallback(event);
       }
     }
+  }
 
-    /**
-     * @description Set callback when the socket is opened.
-     *
-     */
-    set onOpen(callback: () => void) {
-      this.onOpenCallback = callback;
-    }
+  /**
+   * @description Set callback when the socket is opened.
+   *
+   */
+  set onOpen(callback: () => void) {
+    this.onOpenCallback = callback;
+  }
 
-    /**
-     * @description Set callback when the socket is closed.
-     *
-     */
-    set onClose(callback: () => void) {
-      this.onCloseCallback = callback;
-    }
+  /**
+   * @description Set callback when the socket is closed.
+   *
+   */
+  set onClose(callback: () => void) {
+    this.onCloseCallback = callback;
+  }
 
-    /**
-     * @description Set callback when the socket receives a message.
-     *
-     */
-    set onMessage(callback: (event: MessageEvent) => void) {
-      this.onMessageCallback = callback;
-    }
+  /**
+   * @description Set callback when the socket receives a message.
+   *
+   */
+  set onMessage(callback: (event: MessageEvent) => void) {
+    this.onMessageCallback = callback;
+  }
 
-    /**
-     * @description Send a subscribe message to the websocket connection.
-     *
-     */
-    subscribe(channel: string, params?: object): void {
-      const message = {
-        type: OutgoingMessageTypes.SUBSCRIBE,
-        channel,
-        ...params,
-      };
-      this.send(JSON.stringify(message));
-    }
+  /**
+   * @description Send a subscribe message to the websocket connection.
+   *
+   */
+  subscribe(channel: string, params?: object): void {
+    const message = {
+      type: OutgoingMessageTypes.SUBSCRIBE,
+      channel,
+      ...params,
+    };
+    this.send(JSON.stringify(message));
+  }
 
-    /**
-     * @description Send an unsubscribe message to the websocket connection.
-     *
-     */
-    unsubscribe(channel: string, params?: object): void {
-      const message = {
-        type: OutgoingMessageTypes.UNSUBSCRIBE,
-        channel,
-        ...params,
-      };
-      this.send(JSON.stringify(message));
-    }
+  /**
+   * @description Send an unsubscribe message to the websocket connection.
+   *
+   */
+  unsubscribe(channel: string, params?: object): void {
+    const message = {
+      type: OutgoingMessageTypes.UNSUBSCRIBE,
+      channel,
+      ...params,
+    };
+    this.send(JSON.stringify(message));
+  }
 
-    /**
-     * @description Subscribe to markets channel.
-     *
-     */
-    subscribeToMarkets(): void {
-      const channel = SocketChannels.MARKETS;
-      const params = {
-        batched: true,
-      };
-      this.subscribe(channel, params);
-    }
+  /**
+   * @description Subscribe to markets channel.
+   *
+   */
+  subscribeToMarkets(): void {
+    const channel = SocketChannels.MARKETS;
+    const params = {
+      batched: true,
+    };
+    this.subscribe(channel, params);
+  }
 
-    /**
-     * @description Unsubscribe from markets channel
-     *
-     */
-    unsubscribeFromMarkets(): void {
-      const channel = SocketChannels.MARKETS;
-      this.unsubscribe(channel);
-    }
+  /**
+   * @description Unsubscribe from markets channel
+   *
+   */
+  unsubscribeFromMarkets(): void {
+    const channel = SocketChannels.MARKETS;
+    this.unsubscribe(channel);
+  }
 
-    /**
-     * @description Subscribe to trade channel
-     * for a specific market.
-     *
-     */
-    subscribeToTrades(market: string): void {
-      const channel = SocketChannels.TRADES;
-      const params = {
-        id: market,
-        batched: true,
-      };
-      this.subscribe(channel, params);
-    }
+  /**
+   * @description Subscribe to trade channel
+   * for a specific market.
+   *
+   */
+  subscribeToTrades(market: string): void {
+    const channel = SocketChannels.TRADES;
+    const params = {
+      id: market,
+      batched: true,
+    };
+    this.subscribe(channel, params);
+  }
 
-    /**
-     * @description Unscribed from trade channel
-     * for a specific market.
-     *
-     */
-    unsubscribeFromTrades(market: string): void {
-      const channel = SocketChannels.TRADES;
-      const params = {
-        id: market,
-      };
-      this.unsubscribe(channel, params);
-    }
+  /**
+   * @description Unscribed from trade channel
+   * for a specific market.
+   *
+   */
+  unsubscribeFromTrades(market: string): void {
+    const channel = SocketChannels.TRADES;
+    const params = {
+      id: market,
+    };
+    this.unsubscribe(channel, params);
+  }
 
-    /**
-     * @description Subscribe to orderbook channel
-     * for a specific market.
-     *
-     */
-    subscribeToOrderbook(market: string): void {
-      const channel = SocketChannels.ORDERBOOK;
-      const params = {
-        id: market,
-        batched: true,
-      };
-      this.subscribe(channel, params);
-    }
+  /**
+   * @description Subscribe to orderbook channel
+   * for a specific market.
+   *
+   */
+  subscribeToOrderbook(market: string): void {
+    const channel = SocketChannels.ORDERBOOK;
+    const params = {
+      id: market,
+      batched: true,
+    };
+    this.subscribe(channel, params);
+  }
 
-    /**
-     * @description Unsubscribe from orderbook channel
-     * for a specific market.
-     */
-    unsubscribeFromOrderbook(market: string): void {
-      const channel = SocketChannels.ORDERBOOK;
-      const params = {
-        id: market,
-      };
-      this.unsubscribe(channel, params);
-    }
+  /**
+   * @description Unsubscribe from orderbook channel
+   * for a specific market.
+   */
+  unsubscribeFromOrderbook(market: string): void {
+    const channel = SocketChannels.ORDERBOOK;
+    const params = {
+      id: market,
+    };
+    this.unsubscribe(channel, params);
+  }
 
-    /**
-     * @description Subscribe to candles channel
-     * for a specific market and resolution.
-     *
-     */
-    subscribeToCandles(market: string, resolution: CandlesResolution): void {
-      const channel = SocketChannels.CANDLES;
-      const params = {
-        id: `${market}/${resolution}`,
-        batched: true,
-      };
-      this.subscribe(channel, params);
-    }
+  /**
+   * @description Subscribe to candles channel
+   * for a specific market and resolution.
+   *
+   */
+  subscribeToCandles(market: string, resolution: CandlesResolution): void {
+    const channel = SocketChannels.CANDLES;
+    const params = {
+      id: `${market}/${resolution}`,
+      batched: true,
+    };
+    this.subscribe(channel, params);
+  }
 
-    /**
-     * @description Unsubscribe from candles channel
-     * for a specific market and resolution.
-     */
-    unsubscribeFromCandles(market: string, resolution: CandlesResolution): void {
-      const channel = SocketChannels.CANDLES;
-      const params = {
-        id: `${market}/${resolution}`,
-      };
-      this.unsubscribe(channel, params);
-    }
+  /**
+   * @description Unsubscribe from candles channel
+   * for a specific market and resolution.
+   */
+  unsubscribeFromCandles(market: string, resolution: CandlesResolution): void {
+    const channel = SocketChannels.CANDLES;
+    const params = {
+      id: `${market}/${resolution}`,
+    };
+    this.unsubscribe(channel, params);
+  }
 
-    /**
-     * @description Subscribe to subaccount channel
-     * for a specific address and subaccount number.
-     */
-    subscribeToSubaccount(address: string, subaccountNumber: number): void {
-      const channel = SocketChannels.SUBACCOUNTS;
-      const subaccountId = `${address}/${subaccountNumber}`;
-      const params = {
-        id: subaccountId,
-      };
-      this.subscribe(channel, params);
-    }
+  /**
+   * @description Subscribe to subaccount channel
+   * for a specific address and subaccount number.
+   */
+  subscribeToSubaccount(address: string, subaccountNumber: number): void {
+    const channel = SocketChannels.SUBACCOUNTS;
+    const subaccountId = `${address}/${subaccountNumber}`;
+    const params = {
+      id: subaccountId,
+    };
+    this.subscribe(channel, params);
+  }
 
-    /**
-     * @description Unsubscribe from subaccount channel
-     * for a specific address and subaccount number.
-     *
-     */
-    unsubscribeFromSubaccount(address: string, subaccountNumber: number): void {
-      const channel = SocketChannels.SUBACCOUNTS;
-      const subaccountId = `${address}/${subaccountNumber}`;
-      const params = {
-        id: subaccountId,
-      };
-      this.unsubscribe(channel, params);
-    }
+  /**
+   * @description Unsubscribe from subaccount channel
+   * for a specific address and subaccount number.
+   *
+   */
+  unsubscribeFromSubaccount(address: string, subaccountNumber: number): void {
+    const channel = SocketChannels.SUBACCOUNTS;
+    const subaccountId = `${address}/${subaccountNumber}`;
+    const params = {
+      id: subaccountId,
+    };
+    this.unsubscribe(channel, params);
+  }
 }

package/src/clients/subaccount.ts

@@ -2,24 +2,24 @@ import { MAX_SUBACCOUNT_NUMBER } from './constants';
 import LocalWallet from './modules/local-wallet';
 
 export class SubaccountInfo {
-    readonly wallet: LocalWallet;
-    // TODO, change address to Wallet object when implementing validator functions
-    readonly subaccountNumber: number;
+  readonly wallet: LocalWallet;
+  // TODO, change address to Wallet object when implementing validator functions
+  readonly subaccountNumber: number;
 
-    constructor(wallet: LocalWallet, subaccountNumber: number = 0) {
-      if (subaccountNumber < 0 || subaccountNumber > MAX_SUBACCOUNT_NUMBER) {
-        throw new Error(`Subaccount number must be between 0 and ${MAX_SUBACCOUNT_NUMBER}`);
-      }
-      this.wallet = wallet;
-      this.subaccountNumber = subaccountNumber;
+  constructor(wallet: LocalWallet, subaccountNumber: number = 0) {
+    if (subaccountNumber < 0 || subaccountNumber > MAX_SUBACCOUNT_NUMBER) {
+      throw new Error(`Subaccount number must be between 0 and ${MAX_SUBACCOUNT_NUMBER}`);
     }
+    this.wallet = wallet;
+    this.subaccountNumber = subaccountNumber;
+  }
 
-    get address(): string {
-      const address = this.wallet.address;
-      if (address !== undefined) {
-        return address;
-      } else {
-        throw new Error('Address not set');
-      }
+  get address(): string {
+    const address = this.wallet.address;
+    if (address !== undefined) {
+      return address;
+    } else {
+      throw new Error('Address not set');
     }
+  }
 }

package/src/clients/types.ts

@@ -1,6 +1,10 @@
 import { Coin } from '@cosmjs/proto-signing';
 import { Method } from '@cosmjs/tendermint-rpc';
-import { Order_ConditionType, Order_Side, Order_TimeInForce } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/order';
+import {
+  Order_ConditionType,
+  Order_Side,
+  Order_TimeInForce,
+} from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/order';
 import { PerpetualMarketType } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/perpetuals/perpetual';
 import BigNumber from 'bignumber.js';
 import Long from 'long';
@@ -36,7 +40,7 @@ export enum OrderFlags {
 
 export interface IBasicOrder {
   clientId: number;
-  orderFlags: OrderFlags,
+  orderFlags: OrderFlags;
   clobPairId: number;
   goodTilBlock?: number;
   goodTilBlockTime?: number;
@@ -46,15 +50,14 @@ export interface IPlaceOrder extends IBasicOrder {
   side: Order_Side;
   quantums: Long;
   subticks: Long;
-  timeInForce: Order_TimeInForce,
+  timeInForce: Order_TimeInForce;
   reduceOnly: boolean;
   clientMetadata: number;
-  conditionType?: Order_ConditionType,
-  conditionalOrderTriggerSubticks?: Long,
+  conditionType?: Order_ConditionType;
+  conditionalOrderTriggerSubticks?: Long;
 }
 
-export interface ICancelOrder extends IBasicOrder {
-}
+export interface ICancelOrder extends IBasicOrder {}
 
 // How long to wait and how often to check when calling Broadcast with
 // Method.BroadcastTxCommit
@@ -78,9 +81,10 @@ export interface DenomConfig {
 // 2. Once the transaction is added to the memPool
 // 3. Once the transaction is committed to a block
 // See https://docs.cosmos.network/master/run-node/txs.html for more information
-export type BroadcastMode = (
-  Method.BroadcastTxAsync | Method.BroadcastTxSync | Method.BroadcastTxCommit
-);
+export type BroadcastMode =
+  | Method.BroadcastTxAsync
+  | Method.BroadcastTxSync
+  | Method.BroadcastTxCommit;
 
 // ------ Utility Endpoint Responses ------ //
 export interface TimeResponse {

package/src/clients/validator-client.ts

@@ -26,36 +26,34 @@ export class ValidatorClient {
   private _post?: Post;
 
   /**
-     * @description Connect to a validator client
-     *
-     * @returns The validator client
-     */
+   * @description Connect to a validator client
+   *
+   * @returns The validator client
+   */
   static async connect(config: ValidatorConfig): Promise<ValidatorClient> {
     const client = new ValidatorClient(config);
     await client.initialize();
     return client;
   }
 
-  private constructor(
-    config: ValidatorConfig,
-  ) {
+  private constructor(config: ValidatorConfig) {
     this.config = config;
   }
 
   /**
-     * @description Get the query module, used for retrieving on-chain data.
-     *
-     * @returns The query module
-     */
+   * @description Get the query module, used for retrieving on-chain data.
+   *
+   * @returns The query module
+   */
   get get(): Get {
     return this._get!;
   }
 
   /**
-     * @description transaction module, used for sending transactions.
-     *
-     * @returns The transaction module
-     */
+   * @description transaction module, used for sending transactions.
+   *
+   * @returns The transaction module
+   */
   get post(): Post {
     return this._post!;
   }
@@ -80,7 +78,7 @@ export class ValidatorClient {
       broadcastPollIntervalMs: BROADCAST_POLL_INTERVAL_MS,
       broadcastTimeoutMs: BROADCAST_TIMEOUT_MS,
     });
-    const queryClient: (QueryClient & TxExtension) = QueryClient.withExtensions(
+    const queryClient: QueryClient & TxExtension = QueryClient.withExtensions(
       tendermint37Client,
       setupTxExtension,
     );