@dydxprotocol/v4-client-js 2.4.0 → 2.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v4-client-js",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "General client library for the new dYdX system (v4 decentralized)",
   "main": "build/cjs/src/index.js",
   "module": "build/esm/src/index.js",
@@ -62,6 +62,7 @@
     "cosmjs-types": "^0.9.0",
     "ethereum-cryptography": "^2.0.0",
     "ethers": "^6.6.1",
+    "https-proxy-agent": "^7.0.6",
     "long": "^4.0.0",
     "protobufjs": ">=6.11.4",
     "ws": "^8.14.2"

package/src/clients/constants.ts

@@ -1,4 +1,5 @@
 import { PageRequest } from '@dydxprotocol/v4-proto/src/codegen/cosmos/base/query/v1beta1/pagination';
+import { AxiosProxyConfig } from 'axios';
 import Long from 'long';
 
 import { BroadcastOptions, DenomConfig } from './types';
@@ -243,10 +244,12 @@ export const PAGE_REQUEST: PageRequest = {
 export class IndexerConfig {
   public restEndpoint: string;
   public websocketEndpoint: string;
+  public proxy?: AxiosProxyConfig;
 
-  constructor(restEndpoint: string, websocketEndpoint: string) {
+  constructor(restEndpoint: string, websocketEndpoint: string, proxy?: AxiosProxyConfig) {
     this.restEndpoint = restEndpoint;
     this.websocketEndpoint = websocketEndpoint;
+    this.proxy = proxy;
   }
 }
 

package/src/clients/indexer-client.ts

@@ -19,10 +19,10 @@ export class IndexerClient {
     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._vault = new VaultClient(config.restEndpoint);
+    this._markets = new MarketsClient(config.restEndpoint, apiTimeout, config.proxy);
+    this._account = new AccountClient(config.restEndpoint, apiTimeout, config.proxy);
+    this._utility = new UtilityClient(config.restEndpoint, apiTimeout, config.proxy);
+    this._vault = new VaultClient(config.restEndpoint, apiTimeout, config.proxy);
   }
 
   /**

package/src/clients/modules/rest.ts

@@ -1,24 +1,30 @@
+import axios, { AxiosInstance, AxiosProxyConfig } from 'axios';
+
 import { DEFAULT_API_TIMEOUT } from '../constants';
 import { generateQueryPath } from '../helpers/request-helpers';
-import { RequestMethod, Response, request } from '../lib/axios';
+import { Response } from '../lib/axios';
 import { Data } from '../types';
 
 export default class RestClient {
   readonly host: string;
   readonly apiTimeout: Number;
+  readonly axiosInstance: AxiosInstance;
 
-  constructor(host: string, apiTimeout?: Number | null) {
+  constructor(host: string, apiTimeout?: Number | null, proxy?: AxiosProxyConfig) {
     if (host.endsWith('/')) {
       this.host = host.slice(0, -1);
     } else {
       this.host = host;
     }
     this.apiTimeout = apiTimeout || DEFAULT_API_TIMEOUT;
+    this.axiosInstance = axios.create({
+      proxy,
+    });
   }
 
   async get(requestPath: string, params: {} = {}): Promise<Data> {
     const url = `${this.host}${generateQueryPath(requestPath, params)}`;
-    const response = await request(url);
+    const response = await this.axiosInstance.get(url);
     return response.data;
   }
 
@@ -29,6 +35,6 @@ export default class RestClient {
     headers: {} = {},
   ): Promise<Response> {
     const url = `${this.host}${generateQueryPath(requestPath, params)}`;
-    return request(url, RequestMethod.POST, body, headers);
+    return this.axiosInstance.post(url, body, { headers });
   }
 }

package/src/clients/socket-client.ts

@@ -1,5 +1,7 @@
+import { HttpsProxyAgent } from 'https-proxy-agent';
 import WebSocket, { ErrorEvent, MessageEvent } from 'ws';
 
+import { getProxyAgent } from '../lib/utils';
 import { IndexerConfig } from './constants';
 
 enum OutgoingMessageTypes {
@@ -37,6 +39,7 @@ export enum CandlesResolution {
 export class SocketClient {
   private url: string;
   private ws?: WebSocket;
+  private proxyAgent?: HttpsProxyAgent<string>;
   private onOpenCallback?: () => void;
   private onCloseCallback?: () => void;
   private onMessageCallback?: (event: MessageEvent) => void;
@@ -51,6 +54,7 @@ export class SocketClient {
     onErrorCallback: (event: ErrorEvent) => void,
   ) {
     this.url = config.websocketEndpoint;
+    this.proxyAgent = config.proxy ? getProxyAgent(config.proxy) : undefined;
     this.onOpenCallback = onOpenCallback;
     this.onCloseCallback = onCloseCallback;
     this.onMessageCallback = onMessageCallback;
@@ -58,7 +62,9 @@ export class SocketClient {
   }
 
   connect(): void {
-    this.ws = new WebSocket(this.url);
+    this.ws = new WebSocket(this.url, {
+      agent: this.proxyAgent,
+    });
     this.ws.addEventListener('open', this.handleOpen.bind(this));
     this.ws.addEventListener('close', this.handleClose.bind(this));
     this.ws.addEventListener('message', this.handleMessage.bind(this));

package/src/lib/utils.ts

@@ -1,3 +1,6 @@
+import { AxiosProxyConfig } from 'axios';
+import { HttpsProxyAgent } from 'https-proxy-agent';
+
 import { MAX_UINT_32 } from '../clients/constants';
 
 /**
@@ -74,3 +77,8 @@ export function calculateClockOffsetFromFetchDateHeader(
 
   return Math.floor(offset);
 }
+
+export function getProxyAgent(proxy: AxiosProxyConfig): HttpsProxyAgent<string> {
+  const auth = proxy.auth ? `${proxy.auth.username}:${proxy.auth.password}@` : '';
+  return new HttpsProxyAgent(`${proxy.protocol}://${auth}${proxy.host}:${proxy.port}`);
+}