@dydxprotocol/v4-client-js 2.8.0 → 3.0.0

package/src/clients/modules/post.ts

@@ -26,7 +26,6 @@ import {
 } from '../types';
 import { Composer } from './composer';
 import { Get } from './get';
-import LocalWallet from './local-wallet';
 import {
   Order_Side,
   Order_TimeInForce,
@@ -121,7 +120,7 @@ export class Post {
    * @returns The Fee for broadcasting a transaction.
    */
   async simulate(
-    wallet: LocalWallet,
+    subaccount: SubaccountInfo,
     messaging: () => Promise<EncodeObject[]>,
     gasPrice: GasPrice = this.getGasPrice(),
     memo?: string,
@@ -135,13 +134,19 @@ export class Post {
       msgs = await messaging();
     } else {
       const msgsPromise = messaging();
-      const accountPromise = account ? await account() : this.account(wallet.address!);
+      const accountPromise = account ? await account() : this.account(subaccount.address);
       const msgsAndAccount = await Promise.all([msgsPromise, accountPromise]);
       msgs = msgsAndAccount[0];
       sequence = msgsAndAccount[1].sequence;
     }
 
-    return this.simulateTransaction(wallet.pubKey!, sequence, msgs, gasPrice, memo);
+    return this.simulateTransaction(
+      subaccount.signingWallet.pubKey!,
+      sequence,
+      msgs,
+      gasPrice,
+      memo,
+    );
   }
 
   /**
@@ -153,7 +158,7 @@ export class Post {
    * @returns The Signature.
    */
   async sign(
-    wallet: LocalWallet,
+    subaccount: SubaccountInfo,
     messaging: () => Promise<EncodeObject[]>,
     zeroFee: boolean,
     gasPrice: GasPrice = this.getGasPrice(),
@@ -161,10 +166,10 @@ export class Post {
     account?: () => Promise<Account>,
   ): Promise<Uint8Array> {
     const msgsPromise = await messaging();
-    const accountPromise = account ? await account() : this.account(wallet.address!);
+    const accountPromise = account ? await account() : this.account(subaccount.address);
     const msgsAndAccount = await Promise.all([msgsPromise, accountPromise]);
     const msgs = msgsAndAccount[0];
-    return this.signTransaction(wallet, msgs, msgsAndAccount[1], zeroFee, gasPrice, memo);
+    return this.signTransaction(subaccount, msgs, msgsAndAccount[1], zeroFee, gasPrice, memo);
   }
 
   /**
@@ -176,7 +181,7 @@ export class Post {
    * @returns The Tx Hash.
    */
   async send(
-    wallet: LocalWallet,
+    subaccount: SubaccountInfo,
     messaging: () => Promise<EncodeObject[]>,
     zeroFee: boolean,
     gasPrice: GasPrice = this.getGasPrice(),
@@ -184,15 +189,14 @@ export class Post {
     broadcastMode?: BroadcastMode,
     account?: () => Promise<Account>,
     gasAdjustment: number = GAS_MULTIPLIER,
-    authenticators?: Long[],
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     const msgsPromise = messaging();
-    const accountPromise = account ? await account() : this.account(wallet.address!);
+    const accountPromise = account ? await account() : this.account(subaccount.address);
     const msgsAndAccount = await Promise.all([msgsPromise, accountPromise]);
     const msgs = msgsAndAccount[0];
 
     return this.signAndSendTransaction(
-      wallet,
+      subaccount,
       msgsAndAccount[1],
       msgs,
       zeroFee,
@@ -200,7 +204,6 @@ export class Post {
       memo ?? this.defaultClientMemo,
       broadcastMode ?? this.defaultBroadcastMode(msgs),
       gasAdjustment,
-      authenticators,
     );
   }
 
@@ -239,14 +242,13 @@ export class Post {
    * @returns The Tx Response.
    */
   private async signTransaction(
-    wallet: LocalWallet,
+    subaccount: SubaccountInfo,
     messages: EncodeObject[],
     account: Account,
     zeroFee: boolean,
     gasPrice: GasPrice = this.getGasPrice(),
     memo?: string,
     gasAdjustment: number = GAS_MULTIPLIER,
-    authenticators?: Long[],
   ): Promise<Uint8Array> {
     // protocol expects timestamp nonce in UTC milliseconds, which is the unit returned by Date.now()
     const sequence = this.useTimestampNonce
@@ -259,7 +261,7 @@ export class Post {
           gas: '1000000',
         }
       : await this.simulateTransaction(
-          wallet.pubKey!,
+          subaccount.signingWallet.pubKey!,
           sequence,
           messages,
           gasPrice,
@@ -271,10 +273,10 @@ export class Post {
       sequence,
       accountNumber: account.accountNumber,
       chainId: this.chainId,
-      authenticators,
+      authenticators: subaccount.authenticators,
     };
     // Generate signed transaction.
-    return wallet.signTransaction(messages, txOptions, fee, memo);
+    return subaccount.signingWallet.signTransaction(messages, txOptions, fee, memo);
   }
 
   /**
@@ -301,7 +303,7 @@ export class Post {
    * @returns The Tx Response.
    */
   private async signAndSendTransaction(
-    wallet: LocalWallet,
+    subaccount: SubaccountInfo,
     account: Account,
     messages: EncodeObject[],
     zeroFee: boolean,
@@ -309,17 +311,15 @@ export class Post {
     memo?: string,
     broadcastMode?: BroadcastMode,
     gasAdjustment: number = GAS_MULTIPLIER,
-    authenticators?: Long[],
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     const signedTransaction = await this.signTransaction(
-      wallet,
+      subaccount,
       messages,
       account,
       zeroFee,
       gasPrice,
       memo,
       gasAdjustment,
-      authenticators,
     );
     return this.sendSignedTransaction(signedTransaction, broadcastMode);
   }
@@ -440,7 +440,7 @@ export class Post {
     );
     const account: Promise<Account> = this.account(subaccount.address, orderFlags);
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       true,
       undefined,
@@ -541,7 +541,7 @@ export class Post {
       goodTilBlockTime ?? 0,
     );
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       true,
       undefined,
@@ -602,7 +602,7 @@ export class Post {
       goodTilBlock,
     );
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       true,
       undefined,
@@ -645,7 +645,7 @@ export class Post {
       amount,
     );
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       false,
       undefined,
@@ -688,7 +688,7 @@ export class Post {
       quantums,
     );
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       false,
       undefined,
@@ -729,7 +729,7 @@ export class Post {
       recipient,
     );
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       false,
       undefined,
@@ -767,7 +767,7 @@ export class Post {
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     const msg = await this.sendTokenMsg(subaccount.address, recipient, coinDenom, quantums);
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       zeroFee,
       coinDenom === this.denoms.CHAINTOKEN_DENOM ? this.defaultDydxGasPrice : this.defaultGasPrice,
@@ -804,7 +804,7 @@ export class Post {
       amount,
     });
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       false,
       this.defaultDydxGasPrice,
@@ -832,7 +832,7 @@ export class Post {
       amount,
     });
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       false,
       this.defaultDydxGasPrice,
@@ -856,7 +856,7 @@ export class Post {
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     const msg = this.composer.composeMsgWithdrawDelegatorReward(delegator, validator);
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       false,
       this.defaultGasPrice,
@@ -881,7 +881,7 @@ export class Post {
       quoteQuantums,
     );
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       false,
       undefined,
@@ -909,7 +909,7 @@ export class Post {
       minQuoteQuantums,
     );
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       false,
       undefined,
@@ -932,7 +932,7 @@ export class Post {
   ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
     const msg = this.registerAffiliateMsg(subaccount.address, affiliate);
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       false,
       undefined,
@@ -963,7 +963,7 @@ export class Post {
     const msg = this.launchMarketMsg(subaccount.address, ticker, subaccount.subaccountNumber);
 
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       false,
       undefined,
@@ -986,7 +986,7 @@ export class Post {
     );
 
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       false,
       undefined,
@@ -1004,7 +1004,7 @@ export class Post {
     const msg = this.composer.composeMsgRemoveAuthenticator(subaccount.address, id);
 
     return this.send(
-      subaccount.wallet,
+      subaccount,
       () => Promise.resolve([msg]),
       false,
       undefined,

package/src/clients/native.ts

@@ -275,7 +275,7 @@ export async function isWalletConnected(): Promise<string> {
     if (wallet === undefined) {
       throw new UserError('wallet is not set. Call connectWallet() first');
     }
-    return await encodeJson( { "result": true } );
+    return await encodeJson({ result: true });
   } catch (e) {
     return wrappedError(e);
   }
@@ -333,7 +333,7 @@ export async function placeOrder(payload: string): Promise<string> {
     const marketInfo = (json.marketInfo as MarketInfo) ?? undefined;
     const currentHeight = (json.currentHeight as number) ?? undefined;
 
-    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
     const tx = await client.placeOrder(
       subaccount,
       marketId,
@@ -394,7 +394,7 @@ export async function cancelOrder(payload: string): Promise<string> {
     const goodTilBlock = json.goodTilBlock;
     const goodTilBlockTime = json.goodTilBlockTime;
 
-    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
     const tx = await client.cancelRawOrder(
       subaccount,
       clientId,
@@ -430,7 +430,7 @@ export async function deposit(payload: string): Promise<string> {
       throw new UserError('amount is not set');
     }
 
-    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
     const tx = await client.depositToSubaccount(subaccount, amount);
     return encodeJson(tx);
   } catch (error) {
@@ -459,7 +459,7 @@ export async function withdraw(payload: string): Promise<string> {
       throw new UserError('amount is not set');
     }
 
-    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
     const tx = await client.withdrawFromSubaccount(subaccount, amount, json.recipient, json.memo);
     return encodeJson(tx);
   } catch (error) {
@@ -532,14 +532,14 @@ export async function withdrawToIBC(
       },
     };
 
-    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
     const subaccountMsg = client.withdrawFromSubaccountMessage(subaccount, amount);
 
     const msgs = [subaccountMsg, ibcMsg];
     const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
 
     const tx = await client.send(
-      wallet,
+      subaccount,
       () => {
         return encodeObjects;
       },
@@ -575,7 +575,7 @@ export async function transferNativeToken(payload: string): Promise<string> {
     const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
 
     const tx = await client.send(
-      wallet,
+      SubaccountInfo.forLocalWallet(wallet),
       () => {
         return encodeObjects;
       },
@@ -669,12 +669,12 @@ export async function simulateDeposit(payload: string): Promise<string> {
       throw new UserError('amount is not set');
     }
 
-    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
     const msg: EncodeObject = client.depositToSubaccountMessage(subaccount, amount);
     const msgs: EncodeObject[] = [msg];
     const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
 
-    const stdFee = await client.simulate(globalThis.wallet, () => {
+    const stdFee = await client.simulate(subaccount, () => {
       return encodeObjects;
     });
     return JSON.stringify(stdFee);
@@ -703,7 +703,7 @@ export async function simulateWithdraw(payload: string): Promise<string> {
       throw new UserError('amount is not set');
     }
 
-    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
     const msg: EncodeObject = client.withdrawFromSubaccountMessage(
       subaccount,
       amount,
@@ -712,7 +712,7 @@ export async function simulateWithdraw(payload: string): Promise<string> {
     const msgs: EncodeObject[] = [msg];
     const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
 
-    const stdFee = await client.simulate(globalThis.wallet, () => {
+    const stdFee = await client.simulate(subaccount, () => {
       return encodeObjects;
     });
     return encodeJson(stdFee);
@@ -746,7 +746,7 @@ export async function simulateTransferNativeToken(payload: string): Promise<stri
     const encodeObjects: Promise<EncodeObject[]> = new Promise((resolve) => resolve(msgs));
 
     const stdFee = await client.simulate(
-      globalThis.wallet,
+      SubaccountInfo.forLocalWallet(wallet),
       () => {
         return encodeObjects;
       },
@@ -800,7 +800,11 @@ export async function signRawPlaceOrder(
       );
       resolve([msg]);
     });
-    const signed = await client.sign(wallet, () => msgs, true);
+    const signed = await client.sign(
+      SubaccountInfo.forLocalWallet(wallet, subaccountNumber),
+      () => msgs,
+      true,
+    );
     return Buffer.from(signed).toString('base64');
   } catch (error) {
     return wrappedError(error);
@@ -832,7 +836,7 @@ export async function signPlaceOrder(
       throw new UserError('wallet is not set. Call connectWallet() first');
     }
 
-    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
     const signed = await client.signPlaceOrder(
       subaccount,
       marketId,
@@ -871,7 +875,7 @@ export async function signCancelOrder(
       throw new UserError('wallet is not set. Call connectWallet() first');
     }
 
-    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
     const signed = await client.signCancelOrder(
       subaccount,
       clientId,
@@ -1128,8 +1132,9 @@ export async function withdrawToNobleIBC(payload: string): Promise<String> {
 
     const parsedIbcPayload: SquidIBCPayload = JSON.parse(decoded);
 
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
     const msg = client.withdrawFromSubaccountMessage(
-      new SubaccountInfo(wallet, subaccountNumber),
+      subaccount,
       parseFloat(amount).toFixed(client.validatorClient.config.denoms.USDC_DECIMALS),
     );
     const ibcMsg: MsgTransferEncodeObject = {
@@ -1143,7 +1148,7 @@ export async function withdrawToNobleIBC(payload: string): Promise<String> {
       },
     };
 
-    const tx = await client.send(wallet, () => Promise.resolve([msg, ibcMsg]), false);
+    const tx = await client.send(subaccount, () => Promise.resolve([msg, ibcMsg]), false);
 
     return encodeJson({
       txHash: `0x${Buffer.from(tx?.hash).toString('hex')}`,
@@ -1187,11 +1192,10 @@ export async function cctpWithdraw(squidPayload: string): Promise<String> {
   }
 }
 
-
 export async function cctpMultiMsgWithdraw(cosmosPayload: string): Promise<string> {
   try {
     const client = globalThis.nobleClient;
-    const messages: { typeUrl:string, value: { amount: string } }[] = JSON.parse(cosmosPayload)
+    const messages: { typeUrl: string; value: { amount: string } }[] = JSON.parse(cosmosPayload);
     if (client === undefined || !client.isConnected) {
       throw new UserError('client is not connected.');
     }
@@ -1217,7 +1221,7 @@ export async function cctpMultiMsgWithdraw(cosmosPayload: string): Promise<strin
 
     return encodeJson(tx);
   } catch (error) {
-    return wrappedError(error)
+    return wrappedError(error);
   }
 }
 
@@ -1247,7 +1251,8 @@ export async function getWithdrawalAndTransferGatingStatus(perpetualId: number):
       throw new UserError('client is not connected. Call connectClient() first');
     }
 
-    const response = await client.validatorClient.get.getWithdrawalAndTransferGatingStatus(perpetualId);
+    const response =
+      await client.validatorClient.get.getWithdrawalAndTransferGatingStatus(perpetualId);
     return encodeJson(response);
   } catch (error) {
     return wrappedError(error);
@@ -1285,7 +1290,7 @@ export async function subaccountTransfer(payload: string): Promise<string> {
       throw new UserError('destinationSubaccountNumber is not set');
     }
 
-    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
     const tx = await client.transferToSubaccount(
       subaccount,
       destinationAddress,
@@ -1335,7 +1340,9 @@ export async function signCompliancePayload(payload: string): Promise<string> {
   }
 }
 
-export async function signPushNotificationTokenRegistrationPayload(payload: string): Promise<string> {
+export async function signPushNotificationTokenRegistrationPayload(
+  payload: string,
+): Promise<string> {
   try {
     const json = JSON.parse(payload);
     const message = json.message;
@@ -1387,17 +1394,14 @@ export async function getMegavaultOwnerShares(payload: string): Promise<string>
     if (address === undefined) {
       throw new UserError('address is not set');
     }
-    const response =
-      await globalThis.client?.validatorClient.get.getMegavaultOwnerShares(address);
+    const response = await globalThis.client?.validatorClient.get.getMegavaultOwnerShares(address);
     return encodeJson(parseToPrimitives(response));
   } catch (e) {
     return wrappedError(e);
   }
 }
 
-export async function getMegavaultWithdrawalInfo(
-  sharesToWithdraw: bigint
-): Promise<string> {
+export async function getMegavaultWithdrawalInfo(sharesToWithdraw: bigint): Promise<string> {
   try {
     const client = globalThis.client;
     if (client === undefined) {
@@ -1405,7 +1409,7 @@ export async function getMegavaultWithdrawalInfo(
     }
     const response =
       await globalThis.client?.validatorClient.get.getMegavaultWithdrawalInfo(sharesToWithdraw);
-      return encodeJson(parseToPrimitives(response));
+    return encodeJson(parseToPrimitives(response));
   } catch (e) {
     return wrappedError(e);
   }
@@ -1413,7 +1417,7 @@ export async function getMegavaultWithdrawalInfo(
 
 export async function depositToMegavault(
   subaccountNumber: number,
-  amountUsdc: number
+  amountUsdc: number,
 ): Promise<string> {
   try {
     const client = globalThis.client;
@@ -1424,12 +1428,8 @@ export async function depositToMegavault(
     if (wallet === undefined) {
       throw new UserError('wallet is not set. Call connectWallet() first');
     }
-    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
-    const tx = await client.depositToMegavault(
-      subaccount,
-      amountUsdc,
-      Method.BroadcastTxCommit,
-    );
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
+    const tx = await client.depositToMegavault(subaccount, amountUsdc, Method.BroadcastTxCommit);
     return encodeJson(parseToPrimitives(tx));
   } catch (error) {
     return wrappedError(error);
@@ -1450,7 +1450,7 @@ export async function withdrawFromMegavault(
     if (wallet === undefined) {
       throw new UserError('wallet is not set. Call connectWallet() first');
     }
-    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const subaccount = SubaccountInfo.forLocalWallet(wallet, subaccountNumber);
     const tx = await client.withdrawFromMegavault(
       subaccount,
       shares,
@@ -1461,4 +1461,4 @@ export async function withdrawFromMegavault(
   } catch (error) {
     return wrappedError(error);
   }
-}
+}

package/src/clients/subaccount.ts

@@ -1,25 +1,57 @@
+import Long from 'long';
+
 import { MAX_SUBACCOUNT_NUMBER } from './constants';
 import LocalWallet from './modules/local-wallet';
 
 export class SubaccountInfo {
-  readonly wallet: LocalWallet;
-  // TODO, change address to Wallet object when implementing validator functions
+  readonly address: string;
   readonly subaccountNumber: number;
+  readonly signingWallet: LocalWallet;
+  readonly authenticators?: Long[];
 
-  constructor(wallet: LocalWallet, subaccountNumber: number = 0) {
+  private constructor(
+    signingWallet: LocalWallet,
+    address: string,
+    subaccountNumber: number = 0,
+    authenticators?: Long[],
+  ) {
     if (subaccountNumber < 0 || subaccountNumber > MAX_SUBACCOUNT_NUMBER) {
       throw new Error(`Subaccount number must be between 0 and ${MAX_SUBACCOUNT_NUMBER}`);
     }
-    this.wallet = wallet;
+
+    this.address = address;
     this.subaccountNumber = subaccountNumber;
+    this.signingWallet = signingWallet;
+    this.authenticators = authenticators;
   }
 
-  get address(): string {
-    const address = this.wallet.address;
-    if (address !== undefined) {
-      return address;
-    } else {
-      throw new Error('Address not set');
+  static forLocalWallet(wallet: LocalWallet, subaccountNumber: number = 0): SubaccountInfo {
+    const address = wallet.address;
+    if (address === undefined) {
+      throw new Error('Address not available from wallet');
     }
+    return new SubaccountInfo(wallet, address, subaccountNumber);
+  }
+
+  static forPermissionedWallet(
+    signingWallet: LocalWallet,
+    accountAddress: string,
+    subaccountNumber: number = 0,
+    authenticators: Long[],
+  ): SubaccountInfo {
+    return new SubaccountInfo(signingWallet, accountAddress, subaccountNumber, authenticators);
+  }
+
+  get isPermissionedWallet(): boolean {
+    return this.address !== this.signingWallet.address;
+  }
+
+  cloneWithSubaccount(subaccountNumber: number): SubaccountInfo {
+    return new SubaccountInfo(
+      this.signingWallet,
+      this.address,
+      subaccountNumber,
+      this.authenticators,
+    );
   }
 }