feat: Add getHeightWithHeaders to Utility Module (#464)

- get Fn swallows response headers and only returns data
- Added new get Fn that will return headers as well. Headers will be
used for geo restriction

Author: jaredvu

v4-client-js/package-lock.json

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

v4-client-js/package.json

@@ -1,6 +1,13 @@
+import type { AxiosResponseHeaders } from 'axios';
+
 export enum RequestMethod {
   POST = 'POST',
   PUT = 'PUT',
   GET = 'GET',
   DELETE = 'DELETE',
 }
+
+export interface AxiosResponseWithGeoHeaders<Data> {
+  data: Data;
+  headers: AxiosResponseHeaders;
+}

v4-client-js/src/clients/lib/axios/types.ts

@@ -28,6 +28,16 @@ export default class RestClient {
     return response.data;
   }
 
+  async getWithResponseHeaders(requestPath: string, params: {} = {}): Promise<Data> {
+    const url = `${this.host}${generateQueryPath(requestPath, params)}`;
+    const response = await this.axiosInstance.get(url);
+
+    return {
+      data: response.data,
+      headers: response.headers,
+    };
+  }
+
   async post(
     requestPath: string,
     params: {} = {},

v4-client-js/src/clients/modules/rest.ts

@@ -2,6 +2,7 @@ import type {
   ComplianceResponse,
   ComplianceV2Response,
   HeightResponse,
+  HeightResponseWithHeaders,
   TimeResponse,
 } from '../types';
 import RestClient from './rest';
@@ -25,6 +26,15 @@ export default class UtilityClient extends RestClient {
     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 getHeightWithHeaders(): Promise<HeightResponseWithHeaders> {
+    const uri = '/v4/height';
+    return this.getWithResponseHeaders(uri);
+  }
+
   /**
    * @description Screen an address to see if it is restricted
    * @param {string} address evm or dydx address

v4-client-js/src/clients/modules/utility.ts

@@ -9,6 +9,8 @@ import { PerpetualMarketType } from '@dydxprotocol/v4-proto/src/codegen/dydxprot
 import BigNumber from 'bignumber.js';
 import Long from 'long';
 
+import { AxiosResponseWithGeoHeaders } from './lib/axios/types';
+
 export type Integer = BigNumber;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -119,6 +121,8 @@ export interface HeightResponse {
   time: string;
 }
 
+export type HeightResponseWithHeaders = AxiosResponseWithGeoHeaders<HeightResponse>;
+
 export interface ComplianceResponse {
   restricted: boolean;
   reason?: string;