@dydxprotocol/v4-client-js 3.2.0 → 3.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v4-client-js",
-  "version": "3.2.0",
+  "version": "3.4.0",
   "description": "General client library for the new dYdX system (v4 decentralized)",
   "main": "build/cjs/src/index.js",
   "module": "build/esm/src/index.js",
@@ -52,7 +52,7 @@
     "@cosmjs/stargate": "^0.32.1",
     "@cosmjs/tendermint-rpc": "^0.32.1",
     "@cosmjs/utils": "^0.32.1",
-    "@dydxprotocol/v4-proto": "9.4.0-rc.0",
+    "@dydxprotocol/v4-proto": "9.5.0",
     "@osmonauts/lcd": "^0.6.0",
     "@scure/bip32": "^1.1.5",
     "@scure/bip39": "^1.1.1",

package/src/clients/composite-client.ts

@@ -45,7 +45,7 @@ import { UserError } from './lib/errors';
 import { generateRegistry } from './lib/registry';
 import LocalWallet from './modules/local-wallet';
 import { SubaccountInfo } from './subaccount';
-import { BroadcastMode, OrderBatch } from './types';
+import { BroadcastMode, IBuilderCodeParameters, ITwapParameters, OrderBatch } from './types';
 import { ValidatorClient } from './validator-client';
 
 // Required for encoding and decoding queries that are of type Long.
@@ -86,6 +86,9 @@ export type PlaceOrderPayload = {
   marketInfo?: MarketInfo;
   currentHeight?: number;
   goodTilBlock?: number;
+  twapParameters?: ITwapParameters;
+  builderCodeParameters?: IBuilderCodeParameters;
+  orderRouterAddress?: string;
 };
 
 export type CancelRawOrderPayload = {
@@ -422,6 +425,9 @@ export class CompositeClient {
     goodTilBlock?: number,
     memo?: string,
     broadcastMode?: BroadcastMode,
+    twapParameters?: ITwapParameters,
+    builderCodeParameters?: IBuilderCodeParameters,
+    orderRouterAddress?: string,
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     const msgs: Promise<EncodeObject[]> = new Promise((resolve) => {
       const msg = this.placeOrderMessage(
@@ -441,6 +447,9 @@ export class CompositeClient {
         marketInfo,
         currentHeight,
         goodTilBlock,
+        twapParameters,
+        builderCodeParameters,
+        orderRouterAddress,
       );
       msg
         .then((it) => resolve([it]))
@@ -506,6 +515,9 @@ export class CompositeClient {
     marketInfo?: MarketInfo,
     currentHeight?: number,
     goodTilBlock?: number,
+    twapParameters?: ITwapParameters,
+    builderCodeParameters?: IBuilderCodeParameters,
+    orderRouterAddress?: string,
   ): Promise<EncodeObject> {
     const orderFlags = calculateOrderFlags(type, timeInForce);
 
@@ -561,6 +573,9 @@ export class CompositeClient {
       clientMetadata,
       conditionalType,
       conditionalOrderTriggerSubticks,
+      twapParameters,
+      builderCodeParameters,
+      orderRouterAddress,
     );
   }
 

package/src/clients/lib/axios/types.ts

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

package/src/clients/modules/rest.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: {} = {},

package/src/clients/modules/utility.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

package/src/clients/types.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;