@dydxprotocol/v4-client-js 0.35.0 → 0.36.0

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;
-}