@dydxprotocol/v4-client-js 1.1.30 → 1.2.0

package/src/clients/lib/registry.ts

@@ -5,6 +5,7 @@ import {
   MsgCancelOrder,
   MsgCreateClobPair,
   MsgUpdateClobPair,
+  MsgBatchCancel,
 } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/tx';
 import { MsgDelayMessage } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/delaymsg/tx';
 import { MsgCreatePerpetual } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/perpetuals/tx';
@@ -26,6 +27,7 @@ import {
   TYPE_URL_MSG_CREATE_TRANSFER,
   TYPE_URL_MSG_WITHDRAW_FROM_SUBACCOUNT,
   TYPE_URL_MSG_DEPOSIT_TO_SUBACCOUNT,
+  TYPE_URL_BATCH_CANCEL,
 } from '../constants';
 
 export const registry: ReadonlyArray<[string, GeneratedType]> = [];
@@ -34,6 +36,7 @@ export function generateRegistry(): Registry {
     // clob
     [TYPE_URL_MSG_PLACE_ORDER, MsgPlaceOrder as GeneratedType],
     [TYPE_URL_MSG_CANCEL_ORDER, MsgCancelOrder as GeneratedType],
+    [TYPE_URL_BATCH_CANCEL, MsgBatchCancel as GeneratedType],
     [TYPE_URL_MSG_CREATE_CLOB_PAIR, MsgCreateClobPair as GeneratedType],
     [TYPE_URL_MSG_UPDATE_CLOB_PAIR, MsgUpdateClobPair as GeneratedType],
 

package/src/clients/modules/account.ts

@@ -175,8 +175,10 @@ export default class AccountClient extends RestClient {
   async getSubaccountHistoricalPNLs(
     address: string,
     subaccountNumber: number,
-    effectiveBeforeOrAt?: string | null,
-    effectiveAtOrAfter?: string | null,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null,
+    createdOnOrAfterHeight?: number | null,
+    createdOnOrAfter?: string | null,
     limit?: number | null,
     page?: number | null,
   ): Promise<Data> {
@@ -184,8 +186,10 @@ export default class AccountClient extends RestClient {
     return this.get(uri, {
       address,
       subaccountNumber,
-      effectiveBeforeOrAt,
-      effectiveAtOrAfter,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+      createdOnOrAfterHeight,
+      createdOnOrAfter,
       limit,
       page,
     });

package/src/clients/modules/composer.ts

@@ -9,8 +9,10 @@ import {
 } from '@dydxprotocol/v4-proto/src/codegen/cosmos/staking/v1beta1/tx';
 import { ClobPair_Status } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/clob_pair';
 import {
+  MsgBatchCancel,
   MsgCreateClobPair,
   MsgUpdateClobPair,
+  OrderBatch,
 } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/clob/tx';
 import { MsgDelayMessage } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/delaymsg/tx';
 import { PerpetualMarketType } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/perpetuals/perpetual';
@@ -40,6 +42,7 @@ import {
   TYPE_URL_MSG_DELEGATE,
   TYPE_URL_MSG_UNDELEGATE,
   TYPE_URL_MSG_WITHDRAW_DELEGATOR_REWARD,
+  TYPE_URL_BATCH_CANCEL,
 } from '../constants';
 import { DenomConfig } from '../types';
 import {
@@ -149,6 +152,29 @@ export class Composer {
     };
   }
 
+  public composeMsgBatchCancelShortTermOrders(
+    address: string,
+    subaccountNumber: number,
+    shortTermCancels: OrderBatch[],
+    goodTilBlock: number,
+  ): EncodeObject {
+    const subaccountId: SubaccountId = {
+      owner: address,
+      number: subaccountNumber,
+    };
+
+    const msg: MsgBatchCancel = {
+      subaccountId,
+      shortTermCancels,
+      goodTilBlock,
+    };
+
+    return {
+      typeUrl: TYPE_URL_BATCH_CANCEL,
+      value: msg,
+    };
+  }
+
   public composeMsgCreateClobPair(
     clobId: number,
     perpetualId: number,

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/native.ts

@@ -47,7 +47,7 @@ declare global {
   var hdKey: {
     privateKey: Uint8Array | null;
     publicKey: Uint8Array | null;
-  }
+  };
 
   // eslint-disable-next-line vars-on-top, no-var
   var nobleClient: NobleClient | undefined;
@@ -174,8 +174,9 @@ export async function deriveMnemomicFromEthereumSignature(signature: string): Pr
     const { mnemonic, privateKey, publicKey } = deriveHDKeyFromEthereumSignature(signature);
     const wallet = await LocalWallet.fromMnemonic(mnemonic, BECH32_PREFIX);
     globalThis.hdKey = {
-      privateKey, publicKey
-    }
+      privateKey,
+      publicKey,
+    };
     const result = { mnemonic, address: wallet.address! };
     return new Promise((resolve) => {
       resolve(encodeJson(result));
@@ -293,15 +294,15 @@ export async function placeOrder(payload: string): Promise<string> {
       throw new UserError('clientId is not set');
     }
     const timeInForce = json.timeInForce;
-    const goodTilTimeInSeconds = json.goodTilTimeInSeconds;
-    const goodTilBlock = json.goodTilBlock;
+    const goodTilTimeInSeconds = json.goodTilTimeInSeconds ?? 0;
+    const goodTilBlock = json.goodTilBlock ?? undefined;
     const execution = json.execution;
     const postOnly = json.postOnly ?? false;
     const reduceOnly = json.reduceOnly ?? false;
-    const triggerPrice = json.triggerPrice;
+    const triggerPrice = json.triggerPrice ?? undefined;
 
-    const marketInfo = json.marketInfo as MarketInfo;
-    const currentHeight = json.currentHeight as number;
+    const marketInfo = (json.marketInfo as MarketInfo) ?? undefined;
+    const currentHeight = (json.currentHeight as number) ?? undefined;
 
     const subaccount = new SubaccountInfo(wallet, subaccountNumber);
     const tx = await client.placeOrder(
@@ -1287,11 +1288,11 @@ export async function signCompliancePayload(payload: string): Promise<string> {
     if (!globalThis.hdKey?.privateKey || !globalThis.hdKey?.publicKey) {
       throw new Error('Missing hdKey');
     }
-  
+
     const timestampInSeconds = Math.floor(Date.now() / 1000);
     const messageToSign: string = `${message}:${action}"${currentStatus ?? ''}:${timestampInSeconds}`;
     const messageHash = sha256(Buffer.from(messageToSign));
-  
+
     const signed = await Secp256k1.createSignature(messageHash, globalThis.hdKey.privateKey);
     const signedMessage = signed.toFixedLength();
 
@@ -1316,4 +1317,4 @@ export async function setSelectedGasDenom(gasDenom: string): Promise<string> {
   } catch (error) {
     return wrappedError(error);
   }
-}
+}