@dydxprotocol/v4-client-js 2.5.2 → 2.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v4-client-js",
-  "version": "2.5.2",
+  "version": "2.7.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": "8.0.0",
+    "@dydxprotocol/v4-proto": "9.0.0",
     "@osmonauts/lcd": "^0.6.0",
     "@scure/bip32": "^1.1.5",
     "@scure/bip39": "^1.1.1",

package/src/clients/modules/composer.ts

@@ -57,7 +57,7 @@ import {
   TYPE_URL_MSG_REMOVE_AUTHENTICATOR,
   AuthenticatorType,
 } from '../constants';
-import { DenomConfig } from '../types';
+import { DenomConfig, ITwapParameters, IBuilderCodeParameters } from '../types';
 import {
   OrderId,
   Order,
@@ -95,6 +95,9 @@ export class Composer {
     clientMetadata: number,
     conditionType: Order_ConditionType = Order_ConditionType.CONDITION_TYPE_UNSPECIFIED,
     conditionalOrderTriggerSubticks: Long = Long.fromInt(0),
+    twapParameters?: ITwapParameters,
+    builderCodeParameters?: IBuilderCodeParameters,
+    orderRouterAddress: string = "",
   ): EncodeObject {
     this.validateGoodTilBlockAndTime(orderFlags, goodTilBlock, goodTilBlockTime);
 
@@ -122,6 +125,9 @@ export class Composer {
       clientMetadata: clientMetadata ?? 0,
       conditionType,
       conditionalOrderTriggerSubticks,
+      twapParameters,
+      builderCodeParameters,
+      orderRouterAddress,
     };
     const msg: MsgPlaceOrder = {
       order,

package/src/clients/modules/post.ts

@@ -21,6 +21,8 @@ import {
   IPlaceOrder,
   ICancelOrder,
   DenomConfig,
+  ITwapParameters,
+  IBuilderCodeParameters,
 } from '../types';
 import { Composer } from './composer';
 import { Get } from './get';
@@ -411,6 +413,9 @@ export class Post {
     clientMetadata: number = 0,
     conditionType: Order_ConditionType = Order_ConditionType.CONDITION_TYPE_UNSPECIFIED,
     conditionalOrderTriggerSubticks: Long = Long.fromInt(0),
+    twapParameters?: ITwapParameters,
+    builderCodeParameters?: IBuilderCodeParameters,
+    orderRouterAddress?: string,
     broadcastMode?: BroadcastMode,
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     const msg = await this.placeOrderMsg(
@@ -429,6 +434,9 @@ export class Post {
       clientMetadata,
       conditionType,
       conditionalOrderTriggerSubticks,
+      twapParameters,
+      builderCodeParameters,
+      orderRouterAddress,
     );
     const account: Promise<Account> = this.account(subaccount.address, orderFlags);
     return this.send(
@@ -458,6 +466,9 @@ export class Post {
     clientMetadata: number = 0,
     conditionType: Order_ConditionType = Order_ConditionType.CONDITION_TYPE_UNSPECIFIED,
     conditionalOrderTriggerSubticks: Long = Long.fromInt(0),
+    twapParameters?: ITwapParameters,
+    builderCodeParameters?: IBuilderCodeParameters,
+    orderRouterAddress?: string,
   ): Promise<EncodeObject> {
     return new Promise((resolve) => {
       const msg = this.composer.composeMsgPlaceOrder(
@@ -476,6 +487,9 @@ export class Post {
         clientMetadata,
         conditionType,
         conditionalOrderTriggerSubticks,
+        twapParameters,
+        builderCodeParameters,
+        orderRouterAddress,
       );
       resolve(msg);
     });
@@ -501,6 +515,9 @@ export class Post {
       placeOrder.clientMetadata,
       placeOrder.conditionType ?? Order_ConditionType.CONDITION_TYPE_UNSPECIFIED,
       placeOrder.conditionalOrderTriggerSubticks ?? Long.fromInt(0),
+      placeOrder.twapParameters,
+      placeOrder.builderCodeParameters,
+      placeOrder.orderRouterAddress,
       broadcastMode,
     );
   }

package/src/clients/types.ts

@@ -39,6 +39,19 @@ export enum OrderFlags {
   CONDITIONAL = 32,
 }
 
+// TWAP order parameters
+export interface ITwapParameters {
+  duration: number; // Duration in seconds [300, 86400]
+  interval: number; // Interval in seconds [30, 3600]
+  priceTolerance: number; // Price tolerance in ppm [0, 1_000_000)
+}
+
+// Builder code parameters for partner/builder fees
+export interface IBuilderCodeParameters {
+  builderAddress: string; // Address to receive the fee
+  feePpm: number; // Fee in parts per million
+}
+
 export interface IBasicOrder {
   clientId: number;
   orderFlags: OrderFlags;
@@ -56,6 +69,9 @@ export interface IPlaceOrder extends IBasicOrder {
   clientMetadata: number;
   conditionType?: Order_ConditionType;
   conditionalOrderTriggerSubticks?: Long;
+  twapParameters?: ITwapParameters;
+  builderCodeParameters?: IBuilderCodeParameters;
+  orderRouterAddress?: string;
 }
 
 export interface ICancelOrder extends IBasicOrder {}