@dydxprotocol/v4-client-js 1.1.31 → 1.2.1

package/src/clients/modules/post.ts

@@ -33,6 +33,7 @@ import {
   MsgPlaceOrder,
   MsgCancelOrder,
   Order_ConditionType,
+  OrderBatch,
 } from './proto-includes';
 
 // Required for encoding and decoding queries that are of type Long.
@@ -520,6 +521,45 @@ export class Post {
     );
   }
 
+  async batchCancelShortTermOrders(
+    subaccount: SubaccountInfo,
+    shortTermOrders: OrderBatch[],
+    goodTilBlock: number,
+    broadcastMode?: BroadcastMode,
+  ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
+    const msg = await this.batchCancelShortTermOrdersMsg(
+      subaccount.address,
+      subaccount.subaccountNumber,
+      shortTermOrders,
+      goodTilBlock,
+    );
+    return this.send(
+      subaccount.wallet,
+      () => Promise.resolve([msg]),
+      true,
+      undefined,
+      undefined,
+      broadcastMode,
+    );
+  }
+
+  async batchCancelShortTermOrdersMsg(
+    address: string,
+    subaccountNumber: number,
+    shortTermOrders: OrderBatch[],
+    goodTilBlock: number,
+  ): Promise<EncodeObject> {
+    return new Promise((resolve) => {
+      const msg = this.composer.composeMsgBatchCancelShortTermOrders(
+        address,
+        subaccountNumber,
+        shortTermOrders,
+        goodTilBlock,
+      );
+      resolve(msg);
+    });
+  }
+
   async transfer(
     subaccount: SubaccountInfo,
     recipientAddress: string,

package/src/clients/types.ts

@@ -59,6 +59,11 @@ export interface IPlaceOrder extends IBasicOrder {
 
 export interface ICancelOrder extends IBasicOrder {}
 
+export interface IBatchCancelOrder {
+  shortTermOrders: { clobPairId: number; clientIds: number[] }[];
+  goodTilBlock: number;
+}
+
 // How long to wait and how often to check when calling Broadcast with
 // Method.BroadcastTxCommit
 export interface BroadcastOptions {

package/src/lib/validation.ts

@@ -2,7 +2,13 @@ import { decode } from 'bech32';
 import Long from 'long';
 
 import { MAX_SUBACCOUNT_NUMBER, MAX_UINT_32 } from '../clients/constants';
-import { Transfer, OrderFlags, ICancelOrder, IPlaceOrder } from '../clients/types';
+import {
+  Transfer,
+  OrderFlags,
+  ICancelOrder,
+  IPlaceOrder,
+  IBatchCancelOrder,
+} from '../clients/types';
 import { UserError } from './errors';
 
 /**
@@ -77,6 +83,35 @@ export function validateCancelOrderMessage(
   return undefined;
 }
 
+/**
+ * @describe validateBatchCancelOrderMessage validates that orders to batch cancel have fields that would be
+ *  valid on-chain.
+ */
+export function validateBatchCancelOrderMessage(
+  subaccountNumber: number,
+  orders: IBatchCancelOrder,
+): UserError | undefined {
+  for (const orderBatch of orders.shortTermOrders) {
+    for (const clientId of orderBatch.clientIds) {
+      if (!verifyNumberIsUint32(clientId)) {
+        return new UserError(`clientId: ${clientId} is not a valid uint32`);
+      }
+    }
+  }
+
+  if (!verifyGoodTilBlock(orders.goodTilBlock)) {
+    return new UserError(`goodTilBlock: ${orders.goodTilBlock} is not a valid uint32 or is 0`);
+  }
+
+  if (!verifySubaccountNumber(subaccountNumber)) {
+    return new UserError(
+      `subaccountNumber: ${subaccountNumber} cannot be < 0 or > ${MAX_SUBACCOUNT_NUMBER}`,
+    );
+  }
+
+  return undefined;
+}
+
 /**
  * @describe validateTransferMessage validates that a transfer to place has fields that would be
  *  valid on-chain.
@@ -84,12 +119,16 @@ export function validateCancelOrderMessage(
 export function validateTransferMessage(transfer: Transfer): UserError | undefined {
   if (!verifySubaccountNumber(transfer.sender!!.number || 0)) {
     return new UserError(
-      `senderSubaccountNumber: ${transfer.sender!!.number || 0} cannot be < 0 or > ${MAX_SUBACCOUNT_NUMBER}`,
+      `senderSubaccountNumber: ${
+        transfer.sender!!.number || 0
+      } cannot be < 0 or > ${MAX_SUBACCOUNT_NUMBER}`,
     );
   }
   if (!verifySubaccountNumber(transfer.recipient!!.number || 0)) {
     return new UserError(
-      `recipientSubaccountNumber: ${transfer.recipient!!.number || 0} cannot be < 0 or > ${MAX_SUBACCOUNT_NUMBER}`,
+      `recipientSubaccountNumber: ${
+        transfer.recipient!!.number || 0
+      } cannot be < 0 or > ${MAX_SUBACCOUNT_NUMBER}`,
     );
   }
   if (transfer.assetId !== 0) {

package/src/types.ts

@@ -40,4 +40,5 @@ export interface Options {
 
 export enum ClobPairId {
   PERPETUAL_PAIR_BTC_USD = 0,
+  PERPETUAL_PAIR_ETH_USD = 1,
 }