@dydxprotocol/v4-client-js 3.3.0 → 3.5.0

package/examples/account_endpoints.ts

@@ -120,6 +120,20 @@ async function test(): Promise<void> {
   } catch (error) {
     console.log(error.message);
   }
+
+  // Get trade history
+  try {
+    const response = await client.account.getSubaccountTradeHistory(address, 0);
+    console.log(response);
+    const trades = response.tradeHistory;
+    console.log(trades);
+    if (trades.length > 0) {
+      const trade0 = trades[0];
+      console.log(trade0);
+    }
+  } catch (error) {
+    console.log(error.message);
+  }
 }
 
 test()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v4-client-js",
-  "version": "3.3.0",
+  "version": "3.5.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/scripts/publish-if-not-exists.sh

@@ -1,21 +1,40 @@
-#!/bin/bash
-set -euxo pipefail
+#!/usr/bin/env bash
+set -euo pipefail
 
-VERSION=$(cat package.json | jq -r '.version')
-NAME=$(cat package.json | jq -r '.name')
+VERSION=$(jq -r '.version' package.json)
+NAME=$(jq -r '.name' package.json)
+TAG="v${VERSION}"
 
-test -z "$(npm info $NAME@$VERSION)"
-if [ $? -eq 0 ]; then
-	set -e
+echo "Checking npm registry for ${NAME}@${VERSION}..."
 
-	git config --global user.email "ci@dydx.exchange"
-	git config --global user.name "github_actions"
+set +e
+VIEW_OUTPUT=$(npm view "${NAME}@${VERSION}" 2>&1)
+VIEW_EXIT=$?
+set -e
 
-	# Get version and tag
-	git tag v4-client-js@${VERSION}
-	git push --tags
+if [ $VIEW_EXIT -eq 0 ]; then
+  echo "Skipping publish: ${NAME}@${VERSION} already exists"
+  exit 0
+fi
+
+if ! echo "$VIEW_OUTPUT" | grep -qiE 'E404|not found|No matching version'; then
+  echo "Registry check failed unexpectedly:"
+  echo "$VIEW_OUTPUT"
+  exit 1
+fi
 
-	npm publish
+echo "Version not found. Proceeding with release."
+
+git fetch --tags --quiet
+git config user.email "ci@dydx.exchange"
+git config user.name "github_actions"
+
+if git show-ref --tags --verify --quiet "refs/tags/$TAG"; then
+  echo "Tag $TAG already exists"
 else
-	echo "skipping publish, package $NAME@$VERSION already published"
+  git tag -a "$TAG" -m "Release $TAG"
+  git push origin "$TAG"
 fi
+
+unset NODE_AUTH_TOKEN
+npm publish --provenance --access public

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 = {
@@ -318,6 +321,8 @@ export class CompositeClient {
    * @param timeInForce The time in force of the order to place
    * @param goodTilBlock The goodTilBlock of the order to place
    * @param reduceOnly The reduceOnly of the order to place
+   * @param builderCodeParameters The builder code parameters of the order to place.
+   * @param orderRouterAddress The order router address of the order to place.
    *
    *
    * @throws UnexpectedClientError if a malformed response is returned with no GRPC error
@@ -335,6 +340,8 @@ export class CompositeClient {
     timeInForce: Order_TimeInForce,
     reduceOnly: boolean,
     memo?: string,
+    builderCodeParameters?: IBuilderCodeParameters,
+    orderRouterAddress?: string,
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     const msgs: Promise<EncodeObject[]> = new Promise((resolve, reject) => {
       const msg = this.placeShortTermOrderMessage(
@@ -347,6 +354,8 @@ export class CompositeClient {
         goodTilBlock,
         timeInForce,
         reduceOnly,
+        builderCodeParameters,
+        orderRouterAddress,
       );
       msg
         .then((it) => {
@@ -397,7 +406,10 @@ export class CompositeClient {
    *        trip to Indexer API will be made.
    * @param currentHeight Current block height. This can be obtained from ValidatorClient.
    *        If set to null, additional round trip to ValidatorClient will be made.
-   *
+   * @param goodTilBlock The goodTilBlock of the order to place.
+   * @param twapParameters The twap parameters of the order to place.
+   * @param builderCodeParameters The builder code parameters of the order to place.
+   * @param orderRouterAddress The order router address of the order to place.
    *
    * @throws UnexpectedClientError if a malformed response is returned with no GRPC error
    * at any point.
@@ -422,6 +434,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 +456,9 @@ export class CompositeClient {
         marketInfo,
         currentHeight,
         goodTilBlock,
+        twapParameters,
+        builderCodeParameters,
+        orderRouterAddress,
       );
       msg
         .then((it) => resolve([it]))
@@ -506,6 +524,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 +582,9 @@ export class CompositeClient {
       clientMetadata,
       conditionalType,
       conditionalOrderTriggerSubticks,
+      twapParameters,
+      builderCodeParameters,
+      orderRouterAddress,
     );
   }
 
@@ -600,7 +624,8 @@ export class CompositeClient {
    * @param timeInForce The time in force of the order to place
    * @param goodTilBlock The goodTilBlock of the order to place
    * @param reduceOnly The reduceOnly of the order to place
-   *
+   * @param builderCodeParameters The builder code parameters of the order to place.
+   * @param orderRouterAddress The order router address of the order to place.
    *
    * @throws UnexpectedClientError if a malformed response is returned with no GRPC error
    * at any point.
@@ -616,6 +641,8 @@ export class CompositeClient {
     goodTilBlock: number,
     timeInForce: Order_TimeInForce,
     reduceOnly: boolean,
+    builderCodeParameters?: IBuilderCodeParameters,
+    orderRouterAddress?: string,
   ): Promise<EncodeObject> {
     await this.validateGoodTilBlock(goodTilBlock);
 
@@ -651,6 +678,9 @@ export class CompositeClient {
       0, // Client metadata is 0 for short term orders.
       Order_ConditionType.CONDITION_TYPE_UNSPECIFIED, // Short term orders cannot be conditional.
       Long.fromInt(0), // Short term orders cannot be conditional.
+      undefined,
+      builderCodeParameters,
+      orderRouterAddress,
     );
   }
 

package/src/clients/constants.ts

@@ -144,6 +144,8 @@ export enum OrderType {
   TAKE_PROFIT_LIMIT = 'TAKE_PROFIT',
   STOP_MARKET = 'STOP_MARKET',
   TAKE_PROFIT_MARKET = 'TAKE_PROFIT_MARKET',
+  TWAP = 'TWAP',
+  TWAP_SUBORDER = 'TWAP_SUBORDER',
 }
 
 // ------------ Order Side ------------

package/src/clients/helpers/chain-helpers.ts

@@ -45,6 +45,7 @@ export function calculateSubticks(
   return Long.fromNumber(result);
 }
 
+
 export function calculateSide(side: OrderSide): Order_Side {
   return side === OrderSide.BUY ? Order_Side.SIDE_BUY : Order_Side.SIDE_SELL;
 }
@@ -133,6 +134,10 @@ export function calculateTimeInForce(
           throw new Error('Unexpected code path: timeInForce');
       }
 
+    case OrderType.TWAP:
+    case OrderType.TWAP_SUBORDER:
+      return Order_TimeInForce.TIME_IN_FORCE_UNSPECIFIED;
+
     default:
       throw new Error('Unexpected code path: timeInForce');
   }
@@ -159,6 +164,12 @@ export function calculateOrderFlags(type: OrderType, timeInForce?: OrderTimeInFo
     case OrderType.TAKE_PROFIT_MARKET:
       return OrderFlags.CONDITIONAL;
 
+    case OrderType.TWAP:
+      return OrderFlags.TWAP;
+
+    case OrderType.TWAP_SUBORDER:
+      return OrderFlags.TWAP_SUBORDER;
+
     default:
       throw new Error('Unexpected code path: orderFlags');
   }

package/src/clients/modules/account.ts

@@ -385,4 +385,30 @@ export default class AccountClient extends RestClient {
     const uri = `/v4/fundingPayments/parentSubaccount`;
     return this.get(uri, { address, parentSubaccountNumber, limit, ticker, afterOrAt, page });
   }
+
+  // ------ Trade History ------ //
+
+  async getSubaccountTradeHistory(
+    address: string,
+    subaccountNumber: number,
+    market?: string,
+    marketType?: string,
+    limit?: number,
+    page?: number,
+  ): Promise<Data> {
+    const uri = `/v4/tradeHistory`;
+    return this.get(uri, { address, subaccountNumber, market, marketType, limit, page });
+  }
+
+  async getParentSubaccountNumberTradeHistory(
+    address: string,
+    parentSubaccountNumber: number,
+    market?: string,
+    marketType?: string,
+    limit?: number,
+    page?: number,
+  ): Promise<Data> {
+    const uri = `/v4/tradeHistory/parentSubaccountNumber`;
+    return this.get(uri, { address, parentSubaccountNumber, market, marketType, limit, page });
+  }
 }

package/src/clients/types.ts

@@ -39,6 +39,8 @@ export enum OrderFlags {
   SHORT_TERM = 0,
   LONG_TERM = 64,
   CONDITIONAL = 32,
+  TWAP = 128,
+  TWAP_SUBORDER = 256,
 }
 
 // TWAP order parameters

package/src/lib/validation.ts

@@ -173,12 +173,14 @@ export function verifyOrderFlags(orderFlags: OrderFlags): boolean {
   return (
     orderFlags === OrderFlags.SHORT_TERM ||
     orderFlags === OrderFlags.LONG_TERM ||
-    orderFlags === OrderFlags.CONDITIONAL
+    orderFlags === OrderFlags.CONDITIONAL ||
+    orderFlags === OrderFlags.TWAP ||
+    orderFlags === OrderFlags.TWAP_SUBORDER
   );
 }
 
 export function isStatefulOrder(orderFlags: OrderFlags): boolean {
-  return orderFlags === OrderFlags.LONG_TERM || orderFlags === OrderFlags.CONDITIONAL;
+  return orderFlags === OrderFlags.LONG_TERM || orderFlags === OrderFlags.CONDITIONAL || orderFlags === OrderFlags.TWAP || orderFlags === OrderFlags.TWAP_SUBORDER;
 }
 
 function verifyIsBech32(address: string): Error | undefined {

package/CHANGELOG.md

@@ -1,12 +0,0 @@
-# [3.3.0](https://github.com/dydxprotocol/v4-clients/compare/v4-client-js@3.2.0...v4-client-js@3.3.0) (2025-12-12)
-
-
-### Bug Fixes
-
-* rust test failure ([#460](https://github.com/dydxprotocol/v4-clients/issues/460)) ([c0a6dfd](https://github.com/dydxprotocol/v4-clients/commit/c0a6dfd295975efaaea28e34f8d4a766921badae))
-
-
-### Features
-
-* add examples for batch cancel, cancel, and long-term order using permissioned keys ([#462](https://github.com/dydxprotocol/v4-clients/issues/462)) ([5fc63f3](https://github.com/dydxprotocol/v4-clients/commit/5fc63f3677b851e9652125f2009e7046a53c2975))
-* Add getHeightWithHeaders to Utility Module ([#464](https://github.com/dydxprotocol/v4-clients/issues/464)) ([074c16e](https://github.com/dydxprotocol/v4-clients/commit/074c16e87c59d39923e78ef3d853641b0679da3b))