@dydxprotocol/v4-client-js 2.7.0 → 3.0.0

package/examples/batch_cancel_orders_example.ts

@@ -57,7 +57,7 @@ async function test(): Promise<void> {
     const client = await CompositeClient.connect(network);
     console.log('**Client**', client);
 
-    const subaccount = new SubaccountInfo(wallet, 0);
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
     const currentBlock = await client.validatorClient.get.latestBlockHeight();
     const goodTilBlock = currentBlock + 10;
 
@@ -100,7 +100,7 @@ const placeShortTermOrders = async (
 
   // Wait for all order placements to complete
   await Promise.all(orderPromises);
-}
+};
 
 const batchCancelOrders = async (
   client: CompositeClient,
@@ -119,7 +119,7 @@ const batchCancelOrders = async (
   } catch (error) {
     console.error('**Batch Cancel Short Term Orders Failed**', error.message);
   }
-}
+};
 
 test()
   .then(() => {

package/examples/composite_example.ts

@@ -24,7 +24,7 @@ async function test(): Promise<void> {
   const client = await CompositeClient.connect(network);
   console.log('**Client**');
   console.log(client);
-  const subaccount = new SubaccountInfo(wallet, 0);
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
   for (const orderParams of ordersParams) {
     try {
       const type = OrderType[orderParams.type as keyof typeof OrderType];

package/examples/long_term_order_cancel_example.ts

@@ -23,7 +23,7 @@ async function test(): Promise<void> {
   const client = await CompositeClient.connect(network);
   console.log('**Client**');
   console.log(client);
-  const subaccount = new SubaccountInfo(wallet, 0);
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
 
   /*
   Note this example places a stateful order.

package/examples/noble_example.ts

@@ -1,6 +1,7 @@
 import { EncodeObject } from '@cosmjs/proto-signing';
 import Long from 'long';
 
+import { SubaccountInfo } from '../src';
 import { Network } from '../src/clients/constants';
 import LocalWallet from '../src/clients/modules/local-wallet';
 import { NobleClient } from '../src/clients/noble-client';
@@ -43,7 +44,7 @@ async function test(): Promise<void> {
   const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
 
   await dydxClient.post.send(
-    dydxWallet,
+    SubaccountInfo.forLocalWallet(dydxWallet),
     () => {
       return encodeObjects;
     },

package/examples/permissioned_keys_example.ts

@@ -20,9 +20,9 @@ async function test(): Promise<void> {
   console.log('**Client**');
   console.log(client);
 
-  const subaccount1 = new SubaccountInfo(wallet1, 0);
-  const subaccount2 = new SubaccountInfo(wallet2, 0);
-  const subaccount3 = new SubaccountInfo(wallet3, 0);
+  const subaccount1 = SubaccountInfo.forLocalWallet(wallet1, 0);
+  const subaccount2 = SubaccountInfo.forLocalWallet(wallet2, 0);
+  const subaccount3 = SubaccountInfo.forLocalWallet(wallet3, 0);
 
   // Change second wallet pubkey
   // Add an authenticator to allow wallet2 to place orders
@@ -136,7 +136,12 @@ async function placeOrder(
     const clientId = Math.floor(Math.random() * 10000);
 
     const tx = await client.placeShortTermOrder(
-      fromAccount,
+      SubaccountInfo.forPermissionedWallet(
+        fromAccount.signingWallet,
+        forAccount.address,
+        forAccount.subaccountNumber,
+        [authenticatorId],
+      ),
       'ETH-USD',
       side,
       price,
@@ -146,10 +151,6 @@ async function placeOrder(
       timeInForce,
       false,
       undefined,
-      {
-        authenticators: [authenticatorId],
-        accountForOrder: forAccount,
-      },
     );
     console.log('**Order Tx**');
     console.log(Buffer.from(tx.hash).toString('hex'));

package/examples/short_term_order_cancel_example.ts

@@ -13,7 +13,7 @@ async function test(): Promise<void> {
   const client = await CompositeClient.connect(network);
   console.log('**Client**');
   console.log(client);
-  const subaccount = new SubaccountInfo(wallet, 0);
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
 
   const currentBlock = await client.validatorClient.get.latestBlockHeight();
   const nextValidBlockHeight = currentBlock + 1;

package/examples/short_term_order_composite_example.ts

@@ -20,7 +20,7 @@ async function test(): Promise<void> {
   const client = await CompositeClient.connect(network);
   console.log('**Client**');
   console.log(client);
-  const subaccount = new SubaccountInfo(wallet, 0);
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
   for (const orderParams of ordersParams) {
     try {
       const side = OrderSide[orderParams.side as keyof typeof OrderSide];

package/examples/test.ts

@@ -24,7 +24,7 @@ async function test(): Promise<void> {
   const client = await CompositeClient.connect(network);
   console.log('**Client**');
   console.log(client);
-  const subaccount = new SubaccountInfo(wallet, 0);
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
   for (const orderParams of ordersParams) {
     try {
       const type = OrderType[orderParams.type as keyof typeof OrderType];

package/examples/transfer_example_deposit.ts

@@ -15,7 +15,7 @@ async function test(): Promise<void> {
   console.log('**Client**');
   console.log(client);
 
-  const subaccount = new SubaccountInfo(wallet, 0);
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
   const tx = await client.post.deposit(subaccount, 0, new Long(10_000_000));
   console.log('**Deposit Tx**');
   console.log(tx);

package/examples/transfer_example_send.ts

@@ -18,7 +18,7 @@ async function test(): Promise<void> {
   console.log('**Client**');
   console.log(client);
 
-  const subaccount = new SubaccountInfo(wallet, 0);
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
 
   const amount = new Long(100_000_000);
 
@@ -33,7 +33,7 @@ async function test(): Promise<void> {
     resolve([msg]);
   });
 
-  const totalFee = await client.post.simulate(subaccount.wallet, () => msgs, undefined, undefined);
+  const totalFee = await client.post.simulate(subaccount, () => msgs, undefined, undefined);
   console.log('**Total Fee**');
   console.log(totalFee);
 

package/examples/transfer_example_subaccount_transfer.ts

@@ -15,7 +15,7 @@ async function test(): Promise<void> {
   console.log('**Client**');
   console.log(client);
 
-  const subaccount = new SubaccountInfo(wallet, 0);
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
 
   const tx = await client.post.transfer(subaccount, subaccount.address, 1, 0, new Long(10_000_000));
   console.log('**Transfer Tx**');

package/examples/transfer_example_withdraw.ts

@@ -17,7 +17,7 @@ async function test(): Promise<void> {
   console.log('**Client**');
   console.log(client);
 
-  const subaccount = new SubaccountInfo(wallet, 0);
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
 
   const tx = await client.post.withdraw(subaccount, 0, new Long(1_00_000_000));
   console.log('**Withdraw Tx**');

package/examples/transfer_example_withdraw_other.ts

@@ -18,7 +18,7 @@ async function test(): Promise<void> {
   console.log('**Client**');
   console.log(client);
 
-  const subaccount = new SubaccountInfo(wallet, 0);
+  const subaccount = SubaccountInfo.forLocalWallet(wallet, 0);
 
   const amount = new Long(100_000_000);
 
@@ -34,7 +34,7 @@ async function test(): Promise<void> {
     resolve([msg]);
   });
 
-  const totalFee = await client.post.simulate(subaccount.wallet, () => msgs, undefined);
+  const totalFee = await client.post.simulate(subaccount, () => msgs, undefined);
   console.log('**Total Fee**');
   console.log(totalFee);
 

package/examples/validator_post_example.ts

@@ -40,7 +40,7 @@ async function test(): Promise<void> {
   const value1 = Long.fromNumber(400000000000);
   console.log(value1.toString());
 
-  const subaccount = new SubaccountInfo(wallet, 0);
+  const subaccount = SubaccountInfo.forLocalWallet(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": "2.7.0",
+  "version": "3.0.0",
   "description": "General client library for the new dYdX system (v4 decentralized)",
   "main": "build/cjs/src/index.js",
   "module": "build/esm/src/index.js",

package/src/clients/composite-client.ts

@@ -69,11 +69,6 @@ export interface OrderBatchWithMarketId {
   clientIds: number[];
 }
 
-export interface PermissionedKeysAccountAuth {
-  authenticators: Long[];
-  accountForOrder: SubaccountInfo;
-}
-
 export type PlaceOrderPayload = {
   subaccountNumber: number;
   marketId: string;
@@ -167,14 +162,14 @@ export class CompositeClient {
    * @returns The Signature.
    */
   async sign(
-    wallet: LocalWallet,
+    subaccount: SubaccountInfo,
     messaging: () => Promise<EncodeObject[]>,
     zeroFee: boolean,
     gasPrice?: GasPrice,
     memo?: string,
     account?: () => Promise<Account>,
   ): Promise<Uint8Array> {
-    return this.validatorClient.post.sign(wallet, messaging, zeroFee, gasPrice, memo, account);
+    return this.validatorClient.post.sign(subaccount, messaging, zeroFee, gasPrice, memo, account);
   }
 
   /**
@@ -186,17 +181,16 @@ export class CompositeClient {
    * @returns The Transaction Hash.
    */
   async send(
-    wallet: LocalWallet,
+    subaccount: SubaccountInfo,
     messaging: () => Promise<EncodeObject[]>,
     zeroFee: boolean,
     gasPrice?: GasPrice,
     memo?: string,
     broadcastMode?: BroadcastMode,
     account?: () => Promise<Account>,
-    authenticators?: Long[],
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     return this.validatorClient.post.send(
-      wallet,
+      subaccount,
       messaging,
       zeroFee,
       gasPrice,
@@ -204,7 +198,6 @@ export class CompositeClient {
       broadcastMode,
       account,
       undefined,
-      authenticators,
     );
   }
 
@@ -237,13 +230,13 @@ export class CompositeClient {
    * @returns The gas estimate.
    */
   async simulate(
-    wallet: LocalWallet,
+    subaccount: SubaccountInfo,
     messaging: () => Promise<EncodeObject[]>,
     gasPrice?: GasPrice,
     memo?: string,
     account?: () => Promise<Account>,
   ): Promise<StdFee> {
-    return this.validatorClient.post.simulate(wallet, messaging, gasPrice, memo, account);
+    return this.validatorClient.post.simulate(subaccount, messaging, gasPrice, memo, account);
   }
 
   /**
@@ -342,16 +335,10 @@ export class CompositeClient {
     timeInForce: Order_TimeInForce,
     reduceOnly: boolean,
     memo?: string,
-    permissionedKeysAccountAuth?: PermissionedKeysAccountAuth,
   ): 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 msgs: Promise<EncodeObject[]> = new Promise((resolve, reject) => {
       const msg = this.placeShortTermOrderMessage(
-        accountForOrder,
+        subaccount,
         marketId,
         side,
         price,
@@ -371,18 +358,17 @@ export class CompositeClient {
         });
     });
     const account: Promise<Account> = this.validatorClient.post.account(
-      accountForOrder.address,
+      subaccount.address,
       undefined,
     );
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => msgs,
       true,
       undefined,
       memo,
       undefined,
       () => account,
-      permissionedKeysAccountAuth?.authenticators,
     );
   }
 
@@ -467,7 +453,7 @@ export class CompositeClient {
       orderFlags,
     );
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => msgs,
       true,
       undefined,
@@ -846,7 +832,7 @@ export class CompositeClient {
       resolve([msg]);
     });
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => msgs,
       false,
       undefined,
@@ -915,7 +901,7 @@ export class CompositeClient {
       const msg = this.depositToSubaccountMessage(subaccount, amount);
       resolve([msg]);
     });
-    return this.validatorClient.post.send(subaccount.wallet, () => msgs, false, undefined, memo);
+    return this.validatorClient.post.send(subaccount, () => msgs, false, undefined, memo);
   }
 
   /**
@@ -970,7 +956,7 @@ export class CompositeClient {
       const msg = this.withdrawFromSubaccountMessage(subaccount, amount, recipient);
       resolve([msg]);
     });
-    return this.send(subaccount.wallet, () => msgs, false, undefined, memo);
+    return this.send(subaccount, () => msgs, false, undefined, memo);
   }
 
   /**
@@ -1082,7 +1068,7 @@ export class CompositeClient {
           console.log(err);
         });
     });
-    const signature = await this.sign(subaccount.wallet, () => msgs, true);
+    const signature = await this.sign(subaccount, () => msgs, true);
 
     return Buffer.from(signature).toString('base64');
   }
@@ -1107,7 +1093,7 @@ export class CompositeClient {
       );
       resolve([msg]);
     });
-    const signature = await this.sign(subaccount.wallet, () => msgs, true);
+    const signature = await this.sign(subaccount, () => msgs, true);
 
     return Buffer.from(signature).toString('base64');
   }
@@ -1142,10 +1128,7 @@ export class CompositeClient {
 
     const msgs: Promise<EncodeObject[]> = (async () => {
       const cancelMsgPromises = cancelOrderPayloads.map(async (cancelPayload) => {
-        const cancelSubaccount = new SubaccountInfo(
-          subaccount.wallet,
-          cancelPayload.subaccountNumber,
-        );
+        const cancelSubaccount = subaccount.cloneWithSubaccount(cancelPayload.subaccountNumber);
         return this.validatorClient.post.cancelOrderMsg(
           cancelSubaccount.address,
           cancelSubaccount.subaccountNumber,
@@ -1161,9 +1144,8 @@ export class CompositeClient {
         if (transferToSubaccountPayload == null) {
           return undefined;
         }
-        const transferSubaccount = new SubaccountInfo(
-          subaccount.wallet,
-          transferToSubaccountPayload?.sourceSubaccountNumber,
+        const transferSubaccount = subaccount.cloneWithSubaccount(
+          transferToSubaccountPayload.sourceSubaccountNumber,
         );
         return this.transferToSubaccountMessage(
           transferSubaccount,
@@ -1174,10 +1156,7 @@ export class CompositeClient {
       })();
 
       const placeOrderMsgPromises = placeOrderPayloads.map((placePayload) => {
-        const placeSubaccount = new SubaccountInfo(
-          subaccount.wallet,
-          placePayload.subaccountNumber,
-        );
+        const placeSubaccount = subaccount.cloneWithSubaccount(placePayload.subaccountNumber);
         return this.placeOrderMessage(
           placeSubaccount,
           placePayload.marketId,
@@ -1206,7 +1185,7 @@ export class CompositeClient {
     })();
 
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => msgs,
       true,
       undefined,
@@ -1362,7 +1341,7 @@ export class CompositeClient {
       resolve([submitProposal]);
     });
 
-    return this.send(wallet, () => msg, false, undefined, memo);
+    return this.send(SubaccountInfo.forLocalWallet(wallet), () => msg, false, undefined, memo);
   }
 
   async createMarketPermissionless(

package/src/clients/modules/local-wallet.ts

@@ -1,7 +1,9 @@
 import { Secp256k1Pubkey, StdFee, encodeSecp256k1Pubkey } from '@cosmjs/amino';
+import { fromHex } from '@cosmjs/encoding';
 import {
   AccountData,
   DirectSecp256k1HdWallet,
+  DirectSecp256k1Wallet,
   EncodeObject,
   OfflineSigner,
 } from '@cosmjs/proto-signing';
@@ -9,6 +11,7 @@ import { SigningStargateClient } from '@cosmjs/stargate';
 import Long from 'long';
 import protobuf from 'protobufjs';
 
+import { stripHexPrefix } from '../../lib/helpers';
 import { generateRegistry } from '../lib/registry';
 import { TransactionOptions } from '../types';
 import { TransactionSigner } from './signer';
@@ -36,6 +39,12 @@ export default class LocalWallet {
     return wallet;
   }
 
+  static async fromPrivateKey(pkHex: string, prefix?: string): Promise<LocalWallet> {
+    const wallet = new LocalWallet();
+    await wallet.setPrivateKey(pkHex, prefix);
+    return wallet;
+  }
+
   async setSigner(signer: OfflineSigner): Promise<void> {
     this.offlineSigner = signer;
     const stargateClient = await SigningStargateClient.offline(signer, {
@@ -54,6 +63,11 @@ export default class LocalWallet {
     return this.setSigner(signer);
   }
 
+  async setPrivateKey(pkHex: string, prefix?: string): Promise<void> {
+    const signer = await DirectSecp256k1Wallet.fromKey(fromHex(stripHexPrefix(pkHex)), prefix);
+    return this.setSigner(signer);
+  }
+
   public async signTransaction(
     messages: EncodeObject[],
     transactionOptions: TransactionOptions,