@dydxprotocol/v4-client-js 0.34.0 → 0.36.0

package/examples/utility_endpoints.ts

@@ -0,0 +1,41 @@
+/**
+ * Simple JS example demostrating accessing public data with Indexer REST endpoints
+ */
+
+import { Network } from '../src/clients/constants';
+import { IndexerClient } from '../src/clients/indexer-client';
+
+async function test(): Promise<void> {
+  const client = new IndexerClient(Network.staging().indexerConfig);
+
+  // Get indexer server time
+  try {
+    const response = await client.utility.getTime();
+    console.log(response);
+    const timeIso = response.iso;
+    const timeEpoch = response.epoch;
+    console.log('time');
+    console.log(timeIso);
+    console.log(timeEpoch);
+  } catch (error) {
+    console.log(error.message);
+  }
+
+  // Get indexer server height
+  try {
+    const response = await client.utility.getHeight();
+    console.log(response);
+    const height = response.height;
+    const heightTime = response.time;
+    console.log('height');
+    console.log(height);
+    console.log(heightTime);
+  } catch (error) {
+    console.log(error.message);
+  }
+}
+
+test().then(() => {
+}).catch((error) => {
+  console.log(error.message);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v4-client-js",
-  "version": "0.34.0",
+  "version": "0.36.0",
   "description": "General client library for the new dYdX system (v4 decentralized)",
   "main": "build/src/index.js",
   "scripts": {

package/src/clients/constants.ts

@@ -14,27 +14,27 @@ export const TESTNET_CHAIN_ID = 'dydx-testnet-2';
 export enum IndexerApiHost {
   DEV = 'https://indexer.v4dev.dydx.exchange',
   STAGING = 'https://indexer.v4staging.dydx.exchange',
-  TESTNET = 'https://indexer.v4testnet2.dydx.exchange',
+  TESTNET = 'https://indexer.v4testnet.dydx.exchange',
   // TODO: Add MAINNET
 }
 
 export enum IndexerWSHost {
   DEV = 'wss://indexer.v4dev.dydx.exchange/v4/ws',
   STAGING = 'wss://indexer.v4staging.dydx.exchange/v4/ws',
-  TESTNET = 'wss://indexer.v4testnet2.dydx.exchange/v4/ws',
+  TESTNET = 'wss://indexer.v4testnet.dydx.exchange/v4/ws',
   // TODO: Add MAINNET
 }
 
 export enum FaucetApiHost {
   DEV = 'https://faucet.v4dev.expotrading.com',
   STAGING = 'https://faucet.v4staging.dydx.exchange',
-  TESTNET = 'https://faucet.v4testnet2.dydx.exchange',
+  TESTNET = 'https://faucet.v4testnet.dydx.exchange',
 }
 
 export enum ValidatorApiHost {
   DEV = 'https://validator.v4dev.dydx.exchange',
   STAGING = 'https://validator.v4staging.dydx.exchange',
-  TESTNET = 'https://validator.v4testnet2.dydx.exchange',
+  TESTNET = 'https://validator.v4testnet.dydx.exchange',
   // TODO: Add MAINNET
 }
 
@@ -43,7 +43,7 @@ export enum ValidatorApiHost {
 export enum NetworkId {
   DEV = 'dydxprotocol-testnet',
   STAGING = 'dydxprotocol-testnet',
-  TESTNET = 'dydx-testnet-2',
+  TESTNET = 'dydx-testnet-3',
   // TODO: Add MAINNET
 }
 export const NETWORK_ID_MAINNET: string | null = null;

package/src/clients/indexer-client.ts

@@ -1,6 +1,7 @@
 import { IndexerConfig, DEFAULT_API_TIMEOUT } from './constants';
 import AccountClient from './modules/account';
 import MarketsClient from './modules/markets';
+import UtilityClient from './modules/utility';
 
 /**
  * @description Client for Indexer
@@ -10,6 +11,7 @@ export class IndexerClient {
     readonly apiTimeout: number;
     readonly _markets: MarketsClient;
     readonly _account: AccountClient;
+    readonly _utility: UtilityClient;
 
     constructor(config: IndexerConfig, apiTimeout?: number) {
       this.config = config;
@@ -17,6 +19,7 @@ export class IndexerClient {
 
       this._markets = new MarketsClient(config.restEndpoint);
       this._account = new AccountClient(config.restEndpoint);
+      this._utility = new UtilityClient(config.restEndpoint);
     }
 
     /**
@@ -36,4 +39,11 @@ export class IndexerClient {
     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;
+    }
 }

package/src/clients/modules/markets.ts

@@ -64,14 +64,4 @@ export default class MarketsClient extends RestClient {
       timePeriod: period,
     });
   }
-
-  async getTime(): Promise<Data> {
-    const uri = '/v4/time';
-    return this.get(uri);
-  }
-
-  async getHeight(): Promise<Data> {
-    const uri = '/v4/height';
-    return this.get(uri);
-  }
 }

package/src/clients/modules/utility.ts

@@ -0,0 +1,32 @@
+import type { ComplianceResponse, HeightResponse, TimeResponse } from '../types';
+import RestClient from './rest';
+
+export default class UtilityClient extends RestClient {
+  /**
+   * @description Get the current time of the Indexer
+   * @returns {TimeResponse} isoString and epoch
+   */
+  async getTime(): Promise<TimeResponse> {
+    const uri = '/v4/time';
+    return this.get(uri);
+  }
+
+  /**
+   * @description Get the block height of the most recent block processed by the Indexer
+   * @returns {HeightResponse} block height and time
+   */
+  async getHeight(): Promise<HeightResponse> {
+    const uri = '/v4/height';
+    return this.get(uri);
+  }
+
+  /**
+   * @description Screen an address to see if it is restricted
+   * @param {string} address evm or dydx address
+   * @returns {ComplianceResponse} whether the specified address is restricted
+   */
+  async screen(address: string): Promise<ComplianceResponse> {
+    const uri = '/v4/screen';
+    return this.get(uri, { address });
+  }
+}

package/src/clients/types.ts

@@ -70,4 +70,19 @@ export type BroadcastMode = (
   Method.BroadcastTxAsync | Method.BroadcastTxSync | Method.BroadcastTxCommit
 );
 
+// ------ Utility Endpoint Responses ------ //
+export interface TimeResponse {
+  iso: string;
+  epoch: number;
+}
+
+export interface HeightResponse {
+  height: number;
+  time: string;
+}
+
+export interface ComplianceResponse {
+  restricted: boolean;
+}
+
 export * from './modules/proto-includes';

package/src/network_optimizer.ts

@@ -89,7 +89,7 @@ export class NetworkOptimizer {
     const responses = (await Promise.all(
       clients
         .map(async (client) => {
-          const block = await client.markets.getHeight();
+          const block = await client.utility.getHeight();
           const response = new PingResponse(+block.height);
           return {
             endpoint: client.config.restEndpoint,

package/src/types.ts

@@ -42,17 +42,3 @@ export interface Options {
 export enum ClobPairId {
   PERPETUAL_PAIR_BTC_USD = 0,
 }
-
-export enum MarketId {
-  PERPETUAL_PRICE_BTC_USD = 0,
-}
-
-export enum PerpetualId {
-  PERPETUAL_BTC_USD = 0,
-}
-
-export interface FaucetRequest {
-  address: string;
-  subaccountNumber: number;
-  amount: number;
-}