@dydxprotocol/v4-client-js 1.0.0 → 1.0.2

package/examples/transfer_example_subaccount_transfer.ts

@@ -3,7 +3,7 @@ import Long from 'long';
 import { BECH32_PREFIX } from '../src';
 import { Network } from '../src/clients/constants';
 import LocalWallet from '../src/clients/modules/local-wallet';
-import { Subaccount } from '../src/clients/subaccount';
+import { SubaccountInfo } from '../src/clients/subaccount';
 import { ValidatorClient } from '../src/clients/validator-client';
 import { DYDX_TEST_MNEMONIC } from './constants';
 
@@ -15,7 +15,7 @@ async function test(): Promise<void> {
   console.log('**Client**');
   console.log(client);
 
-  const subaccount = new Subaccount(wallet, 0);
+  const subaccount = new SubaccountInfo(wallet, 0);
 
   const tx = await client.post.transfer(
     subaccount,

package/examples/transfer_example_withdraw.ts

@@ -3,7 +3,7 @@ import Long from 'long';
 import { BECH32_PREFIX } from '../src';
 import { Network } from '../src/clients/constants';
 import LocalWallet from '../src/clients/modules/local-wallet';
-import { Subaccount } from '../src/clients/subaccount';
+import { SubaccountInfo } from '../src/clients/subaccount';
 import { ValidatorClient } from '../src/clients/validator-client';
 import { DYDX_TEST_MNEMONIC } from './constants';
 
@@ -17,7 +17,7 @@ async function test(): Promise<void> {
   console.log('**Client**');
   console.log(client);
 
-  const subaccount = new Subaccount(wallet, 0);
+  const subaccount = new SubaccountInfo(wallet, 0);
 
   const tx = await client.post.withdraw(
     subaccount,

package/examples/transfer_example_withdraw_other.ts

@@ -6,7 +6,7 @@ import { TEST_RECIPIENT_ADDRESS } from '../__tests__/helpers/constants';
 import { BECH32_PREFIX } from '../src';
 import { Network } from '../src/clients/constants';
 import LocalWallet from '../src/clients/modules/local-wallet';
-import { Subaccount } from '../src/clients/subaccount';
+import { SubaccountInfo } from '../src/clients/subaccount';
 import { ValidatorClient } from '../src/clients/validator-client';
 import { DYDX_TEST_MNEMONIC } from './constants';
 
@@ -18,7 +18,7 @@ async function test(): Promise<void> {
   console.log('**Client**');
   console.log(client);
 
-  const subaccount = new Subaccount(wallet, 0);
+  const subaccount = new SubaccountInfo(wallet, 0);
 
   const amount = new Long(100_000_000);
 

package/examples/validator_post_example.ts

@@ -4,7 +4,7 @@ import protobuf from 'protobufjs';
 import { BECH32_PREFIX } from '../src';
 import { Network } from '../src/clients/constants';
 import LocalWallet from '../src/clients/modules/local-wallet';
-import { Subaccount } from '../src/clients/subaccount';
+import { SubaccountInfo } from '../src/clients/subaccount';
 import { IPlaceOrder } from '../src/clients/types';
 import { ValidatorClient } from '../src/clients/validator-client';
 import { randomInt } from '../src/lib/utils';
@@ -40,7 +40,7 @@ async function test(): Promise<void> {
   const value1 = Long.fromNumber(400000000000);
   console.log(value1.toString());
 
-  const subaccount = new Subaccount(wallet, 0);
+  const subaccount = new SubaccountInfo(wallet, 0);
   for (const orderParams of ordersParams) {
     const height = await client.get.latestBlockHeight();
     const placeOrder = dummyOrder(height);

package/package.json

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

package/src/clients/composite-client.ts

@@ -32,7 +32,7 @@ import {
 import { IndexerClient } from './indexer-client';
 import { UserError } from './lib/errors';
 import LocalWallet from './modules/local-wallet';
-import { Subaccount } from './subaccount';
+import { SubaccountInfo } from './subaccount';
 import { ValidatorClient } from './validator-client';
 
 // Required for encoding and decoding queries that are of type Long.
@@ -268,7 +268,7 @@ export class CompositeClient {
    * @returns The transaction hash.
    */
   async placeShortTermOrder(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     marketId: string,
     side: OrderSide,
     price: number,
@@ -340,7 +340,7 @@ export class CompositeClient {
      * @returns The transaction hash.
      */
   async placeOrder(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     marketId: string,
     type: OrderType,
     side: OrderSide,
@@ -420,7 +420,7 @@ export class CompositeClient {
      * @returns The message to be passed into the protocol
      */
   private async placeOrderMessage(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     marketId: string,
     type: OrderType,
     side: OrderSide,
@@ -541,7 +541,7 @@ export class CompositeClient {
      * @returns The message to be passed into the protocol
      */
   private async placeShortTermOrderMessage(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     marketId: string,
     side: OrderSide,
     price: number,
@@ -607,7 +607,7 @@ export class CompositeClient {
      * @returns The transaction hash.
      */
   async cancelRawOrder(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     clientId: number,
     orderFlags: OrderFlags,
     clobPairId: number,
@@ -639,7 +639,7 @@ export class CompositeClient {
      * @returns The transaction hash.
      */
   async cancelOrder(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     clientId: number,
     orderFlags: OrderFlags,
     marketId: string,
@@ -699,7 +699,7 @@ export class CompositeClient {
      * @returns The transaction hash.
      */
   async transferToSubaccount(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     recipientAddress: string,
     recipientSubaccountNumber: number,
     amount: string,
@@ -733,7 +733,7 @@ export class CompositeClient {
      * @returns The message
      */
   transferToSubaccountMessage(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     recipientAddress: string,
     recipientSubaccountNumber: number,
     amount: string,
@@ -771,7 +771,7 @@ export class CompositeClient {
      * @returns The transaction hash.
      */
   async depositToSubaccount(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     amount: string,
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     const msgs: Promise<EncodeObject[]> = new Promise((resolve) => {
@@ -797,7 +797,7 @@ export class CompositeClient {
      * @returns The message
      */
   depositToSubaccountMessage(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     amount: string,
   ): EncodeObject {
     const validatorClient = this._validatorClient;
@@ -832,7 +832,7 @@ export class CompositeClient {
      * @returns The transaction hash
      */
   async withdrawFromSubaccount(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     amount: string,
     recipient?: string,
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
@@ -863,7 +863,7 @@ export class CompositeClient {
      * @returns The message
      */
   withdrawFromSubaccountMessage(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     amount: string,
     recipient?: string,
   ): EncodeObject {
@@ -929,7 +929,7 @@ export class CompositeClient {
   }
 
   async signPlaceOrder(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     marketId: string,
     type: OrderType,
     side: OrderSide,
@@ -973,7 +973,7 @@ export class CompositeClient {
   }
 
   async signCancelOrder(
-    subaccount: Subaccount,
+    subaccount: SubaccountInfo,
     clientId: number,
     orderFlags: OrderFlags,
     clobPairId: number,

package/src/clients/modules/post.ts

@@ -25,7 +25,7 @@ import protobuf from 'protobufjs';
 import { GAS_MULTIPLIER } from '../constants';
 import { UnexpectedClientError } from '../lib/errors';
 import { generateRegistry } from '../lib/registry';
-import { Subaccount } from '../subaccount';
+import { SubaccountInfo } from '../subaccount';
 import {
   OrderFlags,
   BroadcastMode,
@@ -343,7 +343,7 @@ export class Post {
     // ------ State-Changing Requests ------ //
 
     async placeOrder(
-      subaccount: Subaccount,
+      subaccount: SubaccountInfo,
       clientId: number,
       clobPairId: number,
       side: Order_Side,
@@ -392,7 +392,7 @@ export class Post {
     }
 
     async placeOrderObject(
-      subaccount: Subaccount,
+      subaccount: SubaccountInfo,
       placeOrder: IPlaceOrder,
       broadcastMode?: BroadcastMode,
     ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
@@ -416,7 +416,7 @@ export class Post {
     }
 
     async cancelOrder(
-      subaccount: Subaccount,
+      subaccount: SubaccountInfo,
       clientId: number,
       orderFlags: OrderFlags,
       clobPairId: number,
@@ -446,7 +446,7 @@ export class Post {
     }
 
     async cancelOrderObject(
-      subaccount: Subaccount,
+      subaccount: SubaccountInfo,
       cancelOrder: ICancelOrder,
       broadcastMode?: BroadcastMode,
     ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
@@ -462,7 +462,7 @@ export class Post {
     }
 
     async transfer(
-      subaccount: Subaccount,
+      subaccount: SubaccountInfo,
       recipientAddress: string,
       recipientSubaccountNumber: number,
       assetId: number,
@@ -491,7 +491,7 @@ export class Post {
     }
 
     async deposit(
-      subaccount: Subaccount,
+      subaccount: SubaccountInfo,
       assetId: number,
       quantums: Long,
       broadcastMode?: BroadcastMode,
@@ -516,7 +516,7 @@ export class Post {
     }
 
     async withdraw(
-      subaccount: Subaccount,
+      subaccount: SubaccountInfo,
       assetId: number,
       quantums: Long,
       recipient?: string,
@@ -543,7 +543,7 @@ export class Post {
     }
 
     async sendToken(
-      subaccount: Subaccount,
+      subaccount: SubaccountInfo,
       recipient: string,
       coinDenom: string,
       quantums: string,

package/src/clients/native.ts

@@ -10,7 +10,7 @@ import Long from 'long';
 
 import { BECH32_PREFIX } from '../lib/constants';
 import { UserError } from '../lib/errors';
-import { encodeJson } from '../lib/helpers';
+import { ByteArrayEncoding, encodeJson } from '../lib/helpers';
 import { deriveHDKeyFromEthereumSignature } from '../lib/onboarding';
 import { NetworkOptimizer } from '../network_optimizer';
 import { CompositeClient, MarketInfo } from './composite-client';
@@ -19,7 +19,7 @@ import {
 } from './constants';
 import { FaucetClient } from './faucet-client';
 import LocalWallet from './modules/local-wallet';
-import { Subaccount } from './subaccount';
+import { SubaccountInfo } from './subaccount';
 import { OrderFlags } from './types';
 
 declare global {
@@ -172,6 +172,20 @@ export async function getUserFeeTier(address: string): Promise<string> {
   }
 }
 
+export async function getEquityTiers(): Promise<string> {
+  try {
+    const client = globalThis.client;
+    if (client === undefined) {
+      throw new UserError('client is not connected. Call connectClient() first');
+    }
+    const equityTiers = await globalThis.client?.validatorClient.get
+      .getEquityTierLimitConfiguration();
+    return encodeJson(equityTiers, ByteArrayEncoding.BIGINT);
+  } catch (e) {
+    return wrappedError(e);
+  }
+}
+
 export async function getPerpetualMarkets(): Promise<string> {
   try {
     const client = globalThis.client;
@@ -238,7 +252,7 @@ export async function placeOrder(
     const marketInfo = json.marketInfo as MarketInfo;
     const currentHeight = json.currentHeight as number;
 
-    const subaccount = new Subaccount(wallet, subaccountNumber);
+    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
     const tx = await client.placeOrder(
       subaccount,
       marketId,
@@ -300,7 +314,7 @@ export async function cancelOrder(
     const goodTilBlock = json.goodTilBlock;
     const goodTilBlockTime = json.goodTilBlockTime;
 
-    const subaccount = new Subaccount(wallet, subaccountNumber);
+    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
     const tx = await client.cancelRawOrder(
       subaccount,
       clientId,
@@ -338,7 +352,7 @@ export async function deposit(
       throw new UserError('amount is not set');
     }
 
-    const subaccount = new Subaccount(wallet, subaccountNumber);
+    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
     const tx = await client.depositToSubaccount(
       subaccount,
       amount,
@@ -372,7 +386,7 @@ export async function withdraw(
       throw new UserError('amount is not set');
     }
 
-    const subaccount = new Subaccount(wallet, subaccountNumber);
+    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
     const tx = await client.withdrawFromSubaccount(
       subaccount,
       amount,
@@ -440,7 +454,7 @@ export async function withdrawToIBC(
       value: json.msg,
     };
 
-    const subaccount = new Subaccount(wallet, subaccountNumber);
+    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
     const subaccountMsg = client.withdrawFromSubaccountMessage(subaccount, amount);
 
     const msgs = [subaccountMsg, ibcMsg];
@@ -583,7 +597,7 @@ export async function simulateDeposit(
       throw new UserError('amount is not set');
     }
 
-    const subaccount = new Subaccount(wallet, subaccountNumber);
+    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
     const msg: EncodeObject = client.depositToSubaccountMessage(
       subaccount,
       amount,
@@ -625,7 +639,7 @@ export async function simulateWithdraw(
       throw new UserError('amount is not set');
     }
 
-    const subaccount = new Subaccount(wallet, subaccountNumber);
+    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
     const msg: EncodeObject = client.withdrawFromSubaccountMessage(
       subaccount,
       amount,
@@ -766,7 +780,7 @@ export async function signPlaceOrder(
       throw new UserError('wallet is not set. Call connectWallet() first');
     }
 
-    const subaccount = new Subaccount(wallet, subaccountNumber);
+    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
     const signed = await client.signPlaceOrder(
       subaccount,
       marketId,
@@ -805,7 +819,7 @@ export async function signCancelOrder(
       throw new UserError('wallet is not set. Call connectWallet() first');
     }
 
-    const subaccount = new Subaccount(wallet, subaccountNumber);
+    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
     const signed = await client.signCancelOrder(
       subaccount,
       clientId,

package/src/clients/subaccount.ts

@@ -1,6 +1,6 @@
 import LocalWallet from './modules/local-wallet';
 
-export class Subaccount {
+export class SubaccountInfo {
     readonly wallet: LocalWallet;
     // TODO, change address to Wallet object when implementing validator functions
     readonly subaccountNumber: number;

package/src/index.ts

@@ -7,7 +7,7 @@ export * as validation from './lib/validation';
 export * as onboarding from './lib/onboarding';
 
 export { default as LocalWallet } from './clients/modules/local-wallet';
-export { Subaccount as SubaccountClient } from './clients/subaccount';
+export { SubaccountInfo as SubaccountClient } from './clients/subaccount';
 export { CompositeClient } from './clients/composite-client';
 export { IndexerClient } from './clients/indexer-client';
 export { ValidatorClient } from './clients/validator-client';

package/src/lib/helpers.ts

@@ -38,7 +38,26 @@ export function stripHexPrefix(input: string): string {
   return input;
 }
 
-export function encodeJson(object?: Object): string {
+function toBigInt(u: Uint8Array): BigInt {
+  if (u.length <= 1) {
+    return BigInt(0);
+  }
+  // eslint-disable-next-line no-bitwise
+  const negated: boolean = (u[0] & 1) === 1;
+  const hex: string = Buffer.from(u.slice(1)).toString('hex');
+  const abs: bigint = BigInt(`0x${hex}`);
+  return negated ? -abs : abs;
+}
+
+export enum ByteArrayEncoding {
+  HEX = 'hex',
+  BIGINT = 'bigint',
+}
+
+export function encodeJson(
+  object?: Object,
+  byteArrayEncoding: ByteArrayEncoding = ByteArrayEncoding.HEX,
+): string {
   // eslint-disable-next-line prefer-arrow-callback
   return JSON.stringify(object, function replacer(_key, value) {
     // Even though we set the an UInt8Array as the value,
@@ -50,9 +69,17 @@ export function encodeJson(object?: Object): string {
       return value.toString();
     }
     if (value?.buffer instanceof Uint8Array) {
-      return toHex(value.buffer);
+      if (byteArrayEncoding === ByteArrayEncoding.HEX) {
+        return toHex(value.buffer);
+      } else {
+        return toBigInt(value.buffer).toString();
+      }
     } else if (value instanceof Uint8Array) {
-      return toHex(value);
+      if (byteArrayEncoding === ByteArrayEncoding.HEX) {
+        return toHex(value);
+      } else {
+        return toBigInt(value).toString();
+      }
     }
     return value;
   });