@dydxprotocol/v4-client-js 1.18.0 → 1.20.0

package/examples/permissioned_keys_example.ts

@@ -47,31 +47,57 @@ async function test(): Promise<void> {
   await placeOrder(client, subaccount2, subaccount1, authenticatorID);
 }
 
-async function removeAuthenticator(client: CompositeClient,subaccount: SubaccountInfo, id: Long): Promise<void> {
+async function removeAuthenticator(
+  client: CompositeClient,
+  subaccount: SubaccountInfo,
+  id: Long,
+): Promise<void> {
   await client.removeAuthenticator(subaccount, id);
 }
 
-async function addAuthenticator(client: CompositeClient, subaccount: SubaccountInfo, authedPubKey:string): Promise<void> {
-  const subAuthenticators = [{
+async function addAuthenticator(
+  client: CompositeClient,
+  subaccount: SubaccountInfo,
+  authedPubKey: string,
+): Promise<void> {
+  const subAuth = [ {
     type: AuthenticatorType.SIGNATURE_VERIFICATION,
     config: authedPubKey,
   },
   {
-    type: AuthenticatorType.MESSAGE_FILTER,
-    config: toBase64(new TextEncoder().encode("/dydxprotocol.clob.MsgPlaceOrder")),
-  },
+    type: AuthenticatorType.ANY_OF,
+    config: [
+    {
+      type: AuthenticatorType.MESSAGE_FILTER,
+      config: toBase64(new TextEncoder().encode('/dydxprotocol.clob.MsgPlaceOrder')),
+    },
+    {
+      type: AuthenticatorType.MESSAGE_FILTER,
+      config: toBase64(new TextEncoder().encode('/dydxprotocol.clob.MsgPlaceOrder')),
+    },
+    ]
+  }
 ];
 
-  const jsonString = JSON.stringify(subAuthenticators);
+  const jsonString = JSON.stringify(subAuth);
   const encodedData = new TextEncoder().encode(jsonString);
 
-  await client.addAuthenticator(subaccount, AuthenticatorType.ALL_OF, encodedData);
+  try {
+    await client.addAuthenticator(subaccount, AuthenticatorType.ALL_OF, encodedData);
+  } catch (error) {
+    console.log(error.message);
+  }
 }
 
-async function placeOrder(client: CompositeClient, fromAccount: SubaccountInfo, forAccount: SubaccountInfo, authenticatorId: Long): Promise<void> {
+async function placeOrder(
+  client: CompositeClient,
+  fromAccount: SubaccountInfo,
+  forAccount: SubaccountInfo,
+  authenticatorId: Long,
+): Promise<void> {
   try {
-    const side = OrderSide.BUY
-    const price = Number("1000");
+    const side = OrderSide.BUY;
+    const price = Number('1000');
     const currentBlock = await client.validatorClient.get.latestBlockHeight();
     const nextValidBlockHeight = currentBlock + 5;
     const goodTilBlock = nextValidBlockHeight + 10;
@@ -94,7 +120,7 @@ async function placeOrder(client: CompositeClient, fromAccount: SubaccountInfo,
       {
         authenticators: [authenticatorId],
         accountForOrder: forAccount,
-      }
+      },
     );
     console.log('**Order Tx**');
     console.log(Buffer.from(tx.hash).toString('hex'));

package/examples/websocket_orderbook_example.ts

@@ -1,252 +1,239 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable no-param-reassign */
 import { Network } from '../src/clients/constants';
 import { SocketClient } from '../src/clients/socket-client';
 
 function test(): void {
-    let orderBookBidList: [number, number, number][] = [];
-    let orderBookAskList: [number, number, number][] = [];
-
-    const mySocket = new SocketClient(
-        Network.mainnet().indexerConfig,
-        () => {
-            console.log('socket opened');
-
-            mySocket.subscribeToOrderbook('ETH-USD');
-        },
-        () => {
-            console.log('socket closed');
-        },
-        (message) => {
-            try {
-                if (typeof message.data === "string") {
-                    const jsonString = message.data;
-                    const parsingData = JSON.parse(jsonString);
-                    const messageId = parsingData.message_id;
-                    const orderBookDataList = parsingData.contents;
-
-                    if (orderBookDataList instanceof Array) {
-                        // common orderBook data;
-                        [orderBookBidList, orderBookAskList] = updateOrderBook(
-                            orderBookDataList,
-                            orderBookBidList,
-                            orderBookAskList,
-                            messageId,
-                        );
-
-                        // sort
-                        orderBookBidList = sortByNthElementDesc(
-                            orderBookBidList,
-                            0,
-                        );
-                        orderBookAskList = sortByNthElementAsc(
-                            orderBookAskList,
-                            0,
-                        );
-
-                        // resolving crossed orderBook
-                        if (
-                            orderBookBidList &&
-                            orderBookAskList &&
-                            orderBookBidList.length > 0 &&
-                            orderBookAskList.length > 0 &&
-                            orderBookBidList[0][0] >= orderBookAskList[0][0]
-                        ) {
-                            [orderBookBidList, orderBookAskList] =
-                                resolveCrossedOrderBook(
-                                    orderBookBidList,
-                                    orderBookAskList,
-                                );
-                        }
-
-                        printOrderBook(orderBookBidList, orderBookAskList);
-
-                        if (orderBookBidList.length > 300) {
-                            orderBookBidList.splice(50);
-                        }
-
-                        if (orderBookAskList.length > 300) {
-                            orderBookAskList.splice(50);
-                        }
-                    } else if (
-                        orderBookDataList !== null &&
-                        orderBookDataList !== undefined
-                    ) {
-                        // initial OrderBook data
-                        setInitialOrderBook(
-                            orderBookDataList,
-                            orderBookBidList,
-                            orderBookAskList,
-                            messageId,
-                        );
-                    }
-                }
-            } catch (e) {
-                console.error('Error parsing JSON message:', e);
+  let orderBookBidList: [number, number, number][] = [];
+  let orderBookAskList: [number, number, number][] = [];
+
+  const mySocket = new SocketClient(
+    Network.mainnet().indexerConfig,
+    () => {
+      console.log('socket opened');
+
+      mySocket.subscribeToOrderbook('ETH-USD');
+    },
+    () => {
+      console.log('socket closed');
+    },
+    (message) => {
+      try {
+        if (typeof message.data === 'string') {
+          const jsonString = message.data;
+          const parsingData = JSON.parse(jsonString);
+          const messageId = parsingData.message_id;
+          const orderBookDataList = parsingData.contents;
+
+          if (orderBookDataList instanceof Array) {
+            // common orderBook data;
+            [orderBookBidList, orderBookAskList] = updateOrderBook(
+              orderBookDataList,
+              orderBookBidList,
+              orderBookAskList,
+              messageId,
+            );
+
+            // sort
+            orderBookBidList = sortByNthElementDesc(orderBookBidList, 0);
+            orderBookAskList = sortByNthElementAsc(orderBookAskList, 0);
+
+            // resolving crossed orderBook
+            if (
+              orderBookBidList.length > 0 &&
+              orderBookAskList.length > 0 &&
+              orderBookBidList[0][0] >= orderBookAskList[0][0]
+            ) {
+              [orderBookBidList, orderBookAskList] = resolveCrossedOrderBook(
+                orderBookBidList,
+                orderBookAskList,
+              );
             }
-        },
-        (event) => {
-            console.error('Encountered error:', event.message);
-        },
-    );
 
-    mySocket.connect();
+            printOrderBook(orderBookBidList, orderBookAskList);
+
+            if (orderBookBidList.length > 300) {
+              orderBookBidList.splice(50);
+            }
+
+            if (orderBookAskList.length > 300) {
+              orderBookAskList.splice(50);
+            }
+          } else if (orderBookDataList !== null && orderBookDataList !== undefined) {
+            // initial OrderBook data
+            setInitialOrderBook(orderBookDataList, orderBookBidList, orderBookAskList, messageId);
+          }
+        }
+      } catch (e) {
+        console.error('Error parsing JSON message:', e);
+      }
+    },
+    (event) => {
+      console.error('Encountered error:', event.message);
+    },
+  );
+
+  mySocket.connect();
 }
 
-const sortByNthElementAsc = (arr: [number, number, number][], n: number): [number, number, number][] => {
-    return arr.sort((a, b) => {
-        if (a[n] < b[n]) return -1;
-        if (a[n] > b[n]) return 1;
-        return 0;
-    });
+const sortByNthElementAsc = (
+  arr: [number, number, number][],
+  n: number,
+): [number, number, number][] => {
+  return arr.sort((a, b) => {
+    if (a[n] < b[n]) return -1;
+    if (a[n] > b[n]) return 1;
+    return 0;
+  });
 };
-const sortByNthElementDesc = (arr: [number, number, number][], n: number): [number, number, number][] => {
-    return arr.sort((a, b) => {
-        if (a[n] > b[n]) return -1;
-        if (a[n] < b[n]) return 1;
-        return 0;
-    });
+const sortByNthElementDesc = (
+  arr: [number, number, number][],
+  n: number,
+): [number, number, number][] => {
+  return arr.sort((a, b) => {
+    if (a[n] > b[n]) return -1;
+    if (a[n] < b[n]) return 1;
+    return 0;
+  });
 };
 
 const printOrderBook = (
-    orderBookBidList: [number, number, number][],
-    orderBookAskList: [number, number, number][],
+  orderBookBidList: [number, number, number][],
+  orderBookAskList: [number, number, number][],
 ): void => {
-    // print
-    console.log(`OrderBook for ETH-USD:`);
-    console.log(`Price     Qty`);
-    for (let i = 4; i > -1; i--) {
-        const priceStr = String(orderBookAskList[i][0]);
-        const spaces = createSpaces(10 - priceStr.length);
-        console.log(`${priceStr}${spaces}${orderBookAskList[i][1]}`);
-    }
-    console.log('---------------------');
-    for (let i = 0; i < 5; i++) {
-        const priceStr = String(orderBookBidList[i][0]);
-        const spaces = createSpaces(10 - priceStr.length);
-        console.log(`${priceStr}${spaces}${orderBookBidList[i][1]}`);
-    }
-    console.log('');
+  // print
+  console.log(`OrderBook for ETH-USD:`);
+  console.log(`Price     Qty`);
+  for (let i = 4; i > -1; i--) {
+    const priceStr = String(orderBookAskList[i][0]);
+    const spaces = createSpaces(10 - priceStr.length);
+    console.log(`${priceStr}${spaces}${orderBookAskList[i][1]}`);
+  }
+  console.log('---------------------');
+  for (let i = 0; i < 5; i++) {
+    const priceStr = String(orderBookBidList[i][0]);
+    const spaces = createSpaces(10 - priceStr.length);
+    console.log(`${priceStr}${spaces}${orderBookBidList[i][1]}`);
+  }
+  console.log('');
 };
 
 function createSpaces(count: number): string {
-    if(count <= 0 ){
-        return "";
-    }
-
-    let spaces = "";
-    for (let i = 0; i < count; i++) {
-        spaces += " ";
-    }
-    return spaces;
+  if (count <= 0) {
+    return '';
+  }
+
+  let spaces = '';
+  for (let i = 0; i < count; i++) {
+    spaces += ' ';
+  }
+  return spaces;
 }
 
 const resolveCrossedOrderBook = (
-    orderBookBidList: [number, number, number][],
-    orderBookAskList: [number, number, number][],
+  orderBookBidList: [number, number, number][],
+  orderBookAskList: [number, number, number][],
 ): [[number, number, number][], [number, number, number][]] => {
-    while (orderBookBidList[0][0] >= orderBookAskList[0][0]) {
-        if (orderBookBidList[0][2] < orderBookAskList[0][2]) {
-            orderBookBidList.shift();
-        } else if (orderBookBidList[0][2] > orderBookAskList[0][2]) {
-            orderBookAskList.shift();
-        } else {
-            if (orderBookBidList[0][1] > orderBookAskList[0][1]) {
-                orderBookBidList[0][1] -= orderBookAskList[0][1];
-                orderBookAskList.shift();
-            } else if (orderBookBidList[0][1] < orderBookAskList[0][1]) {
-                orderBookAskList[0][1] -= orderBookBidList[0][1];
-                orderBookBidList.shift();
-            } else {
-                orderBookAskList.shift();
-                orderBookBidList.shift();
-            }
-        }
+  while (orderBookBidList[0][0] >= orderBookAskList[0][0]) {
+    if (orderBookBidList[0][2] < orderBookAskList[0][2]) {
+      orderBookBidList.shift();
+    } else if (orderBookBidList[0][2] > orderBookAskList[0][2]) {
+      orderBookAskList.shift();
+    } else {
+      if (orderBookBidList[0][1] > orderBookAskList[0][1]) {
+        orderBookBidList[0][1] -= orderBookAskList[0][1];
+        orderBookAskList.shift();
+      } else if (orderBookBidList[0][1] < orderBookAskList[0][1]) {
+        orderBookAskList[0][1] -= orderBookBidList[0][1];
+        orderBookBidList.shift();
+      } else {
+        orderBookAskList.shift();
+        orderBookBidList.shift();
+      }
     }
+  }
 
-    return [orderBookBidList, orderBookAskList];
+  return [orderBookBidList, orderBookAskList];
 };
 const setInitialOrderBook = (
-    orderBookDataList: { bids: []; asks: [] },
-    orderBookBidList: [number, number, number][],
-    orderBookAskList: [number, number, number][],
-    messageId: number,
+  orderBookDataList: { bids: []; asks: [] },
+  orderBookBidList: [number, number, number][],
+  orderBookAskList: [number, number, number][],
+  messageId: number,
 ): void => {
-    orderBookDataList.bids.forEach((item: { price: string; size: string }) => {
-        orderBookBidList.push([Number(item.price), Number(item.size), messageId]);
-    });
+  orderBookDataList.bids.forEach((item: { price: string; size: string }) => {
+    orderBookBidList.push([Number(item.price), Number(item.size), messageId]);
+  });
 
-    orderBookDataList.asks.forEach((item: { price: string; size: string }) => {
-        orderBookAskList.push([Number(item.price), Number(item.size), messageId]);
-    });
+  orderBookDataList.asks.forEach((item: { price: string; size: string }) => {
+    orderBookAskList.push([Number(item.price), Number(item.size), messageId]);
+  });
 };
 
 const updateOrderBook = (
-    orderBookDataList: { bids: [[]]; asks: [[]] }[],
-    orderBookBidList: [number, number, number][],
-    orderBookAskList: [number, number, number][],
-    messageId: number,
+  orderBookDataList: { bids: [[]]; asks: [[]] }[],
+  orderBookBidList: [number, number, number][],
+  orderBookAskList: [number, number, number][],
+  messageId: number,
 ): [[number, number, number][], [number, number, number][]] => {
-    orderBookDataList.forEach((entry: { bids: [[]]; asks: [[]] }) => {
-        if (entry.bids !== null && entry.bids !== undefined) {
-            const flattened = entry.bids.reduce((acc: any[], val: any[]) => acc.concat(val), []);
-            const entryBidPrice = Number(flattened[0]);
-            const entryBidSize = Number(flattened[1]);
-
-            // remove prices with zero Qty
-            if (entryBidSize === 0) {
-                for (let i = orderBookBidList.length - 1; i >= 0; i--) {
-                    if (orderBookBidList[i][0] === entryBidPrice) {
-                        orderBookBidList.splice(i, 1);
-                    }
-                }
-            } else {
-                // The price that already exists in the order book is modified only Qty
-                if (
-                    orderBookBidList.some((innerArray) => innerArray[0] === entryBidPrice)
-                ) {
-                    orderBookBidList.forEach((item, index) => {
-                        if (item[0] === entryBidPrice) {
-                            orderBookBidList[index][1] = entryBidSize;
-                            orderBookBidList[index][2] = messageId;
-                        }
-                    });
-                } else {
-                    // Add new data to order book
-                    orderBookBidList.push([entryBidPrice, entryBidSize, messageId]);
-                }
+  orderBookDataList.forEach((entry: { bids: [[]]; asks: [[]] }) => {
+    if (entry.bids !== null && entry.bids !== undefined) {
+      const flattened = entry.bids.reduce((acc: any[], val: any[]) => acc.concat(val), []);
+      const entryBidPrice = Number(flattened[0]);
+      const entryBidSize = Number(flattened[1]);
+
+      // remove prices with zero Qty
+      if (entryBidSize === 0) {
+        for (let i = orderBookBidList.length - 1; i >= 0; i--) {
+          if (orderBookBidList[i][0] === entryBidPrice) {
+            orderBookBidList.splice(i, 1);
+          }
+        }
+      } else {
+        // The price that already exists in the order book is modified only Qty
+        if (orderBookBidList.some((innerArray) => innerArray[0] === entryBidPrice)) {
+          orderBookBidList.forEach((item, index) => {
+            if (item[0] === entryBidPrice) {
+              orderBookBidList[index][1] = entryBidSize;
+              orderBookBidList[index][2] = messageId;
             }
+          });
+        } else {
+          // Add new data to order book
+          orderBookBidList.push([entryBidPrice, entryBidSize, messageId]);
         }
-        if (entry.asks !== null && entry.asks !== undefined) {
-            const flattened = entry.asks.reduce((acc: any[], val: any[]) => acc.concat(val), []);
-            const entryAskPrice = Number(flattened[0]);
-            const entryAskSize = Number(flattened[1]);
-
-            if (entryAskSize === 0) {
-                // remove prices with zero Qty
-                for (let i = orderBookAskList.length - 1; i >= 0; i--) {
-                    if (orderBookAskList[i][0] === entryAskPrice) {
-                        orderBookAskList.splice(i, 1);
-                    }
-                }
-            } else {
-                // The price that already exists in the order book is modified only Qty
-                if (
-                    orderBookAskList.some((innerArray) => innerArray[0] === entryAskPrice)
-                ) {
-                    orderBookAskList.forEach((item, index) => {
-                        if (item[0] === entryAskPrice) {
-                            orderBookAskList[index][1] = entryAskSize;
-                            orderBookAskList[index][2] = messageId;
-                        }
-                    });
-                } else {
-                    // Add new data to order book
-                    orderBookAskList.push([entryAskPrice, entryAskSize, messageId]);
-                }
+      }
+    }
+    if (entry.asks !== null && entry.asks !== undefined) {
+      const flattened = entry.asks.reduce((acc: any[], val: any[]) => acc.concat(val), []);
+      const entryAskPrice = Number(flattened[0]);
+      const entryAskSize = Number(flattened[1]);
+
+      if (entryAskSize === 0) {
+        // remove prices with zero Qty
+        for (let i = orderBookAskList.length - 1; i >= 0; i--) {
+          if (orderBookAskList[i][0] === entryAskPrice) {
+            orderBookAskList.splice(i, 1);
+          }
+        }
+      } else {
+        // The price that already exists in the order book is modified only Qty
+        if (orderBookAskList.some((innerArray) => innerArray[0] === entryAskPrice)) {
+          orderBookAskList.forEach((item, index) => {
+            if (item[0] === entryAskPrice) {
+              orderBookAskList[index][1] = entryAskSize;
+              orderBookAskList[index][2] = messageId;
             }
+          });
+        } else {
+          // Add new data to order book
+          orderBookAskList.push([entryAskPrice, entryAskSize, messageId]);
         }
-    });
+      }
+    }
+  });
 
-    return [orderBookBidList, orderBookAskList];
+  return [orderBookBidList, orderBookAskList];
 };
 
-test();
+test();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v4-client-js",
-  "version": "1.18.0",
+  "version": "1.20.0",
   "description": "General client library for the new dYdX system (v4 decentralized)",
   "main": "build/src/index.js",
   "scripts": {

package/src/clients/composite-client.ts

@@ -1,3 +1,5 @@
+import { TextDecoder } from 'util';
+
 import { EncodeObject } from '@cosmjs/proto-signing';
 import { Account, GasPrice, IndexedTx, StdFee } from '@cosmjs/stargate';
 import { Method } from '@cosmjs/tendermint-rpc';
@@ -18,6 +20,7 @@ import { bigIntToBytes } from '../lib/helpers';
 import { isStatefulOrder, verifyOrderFlags } from '../lib/validation';
 import { GovAddNewMarketParams, OrderFlags } from '../types';
 import {
+  Authenticator,
   AuthenticatorType,
   Network,
   OrderExecution,
@@ -169,7 +172,7 @@ export class CompositeClient {
       broadcastMode,
       account,
       undefined,
-     authenticators,
+      authenticators,
     );
   }
 
@@ -311,9 +314,10 @@ export class CompositeClient {
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     // For permissioned orders, use the permissioning account details instead of the subaccount
     // This allows placing orders on behalf of another account when using permissioned keys
-    const accountForOrder = permissionedKeysAccountAuth ? permissionedKeysAccountAuth.accountForOrder : subaccount;
+    const accountForOrder = permissionedKeysAccountAuth
+      ? permissionedKeysAccountAuth.accountForOrder
+      : subaccount;
     const msgs: Promise<EncodeObject[]> = new Promise((resolve, reject) => {
-
       const msg = this.placeShortTermOrderMessage(
         accountForOrder,
         marketId,
@@ -1233,7 +1237,13 @@ export class CompositeClient {
     gasAdjustment?: number,
     memo?: string,
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
-    return this.validatorClient.post.createMarketPermissionless(ticker, subaccount, broadcastMode, gasAdjustment, memo);
+    return this.validatorClient.post.createMarketPermissionless(
+      ticker,
+      subaccount,
+      broadcastMode,
+      gasAdjustment,
+      memo,
+    );
   }
 
   async addAuthenticator(
@@ -1241,17 +1251,60 @@ export class CompositeClient {
     authenticatorType: AuthenticatorType,
     data: Uint8Array,
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
-    return this.validatorClient.post.addAuthenticator(subaccount, authenticatorType, data)
+    // Validate the provided authenticators before sending to the validator
+    const authenticator: Authenticator = {
+      type: authenticatorType,
+      config: JSON.parse(new TextDecoder().decode(data)),
+    };
+    if (!this.validateAuthenticator(authenticator)) {
+      throw new Error(
+        'Invalid authenticator, please ensure the authenticator permissions are correct',
+      );
+    }
+
+    return this.validatorClient.post.addAuthenticator(subaccount, authenticatorType, data);
   }
 
   async removeAuthenticator(
     subaccount: SubaccountInfo,
     id: Long,
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
-    return this.validatorClient.post.removeAuthenticator(subaccount, id)
+    return this.validatorClient.post.removeAuthenticator(subaccount, id);
   }
 
-  async getAuthenticators(address: string): Promise<GetAuthenticatorsResponse>{
+  async getAuthenticators(address: string): Promise<GetAuthenticatorsResponse> {
     return this.validatorClient.get.getAuthenticators(address);
   }
+
+  validateAuthenticator(authenticator: Authenticator): boolean {
+    function checkAuthenticator(auth: Authenticator): boolean {
+      if (auth.type === AuthenticatorType.SIGNATURE_VERIFICATION) {
+        return true; // A SignatureVerification authenticator is safe.
+      }
+
+      if (!Array.isArray(auth.config)) {
+        return false; // Unsafe case: a non-array config for a composite authenticator
+      }
+
+      if (auth.type === AuthenticatorType.ANY_OF) {
+        // ANY_OF is safe only if ALL sub-authenticators return true
+        return auth.config.every((nestedAuth) => checkAuthenticator(nestedAuth));
+      }
+
+      if (auth.type === AuthenticatorType.ALL_OF) {
+        // ALL_OF is safe if at least one sub-authenticator returns true
+        return auth.config.some((nestedAuth) => checkAuthenticator(nestedAuth));
+      }
+
+      // If it's a base-case authenticator but not SignatureVerification, it's unsafe
+      return false;
+    }
+
+    // The top-level authenticator must pass validation
+    if (!checkAuthenticator(authenticator)) {
+      return false
+    }
+
+    return true;
+  }
 }

package/src/clients/constants.ts

@@ -211,6 +211,11 @@ export enum AuthenticatorType {
   SUBACCOUNT_FILTER = 'SubaccountFilter',
 }
 
+export interface Authenticator {
+  type: AuthenticatorType;
+  config: string | Authenticator[];
+}
+
 export enum TradingRewardAggregationPeriod {
   DAILY = 'DAILY',
   WEEKLY = 'WEEKLY',