@dydxprotocol/v4-client-js 1.4.0 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v4-client-js",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "General client library for the new dYdX system (v4 decentralized)",
   "main": "build/src/index.js",
   "scripts": {
@@ -39,7 +39,7 @@
     "@cosmjs/tendermint-rpc": "^0.32.1",
     "@cosmjs/utils": "^0.32.1",
     "@osmonauts/lcd": "^0.6.0",
-    "@dydxprotocol/v4-proto": "6.0.1",
+    "@dydxprotocol/v4-proto": "7.0.0-dev.0",
     "@scure/bip32": "^1.1.5",
     "@scure/bip39": "^1.1.1",
     "axios": "1.1.3",

package/src/clients/composite-client.ts

@@ -13,6 +13,7 @@ import { parseUnits } from 'ethers';
 import Long from 'long';
 import protobuf from 'protobufjs';
 
+import { bigIntToBytes } from '../lib/helpers';
 import { isStatefulOrder, verifyOrderFlags } from '../lib/validation';
 import { GovAddNewMarketParams, OrderFlags } from '../types';
 import {
@@ -34,6 +35,7 @@ import {
   calculateClientMetadata,
   calculateConditionType,
   calculateConditionalOrderTriggerSubticks,
+  calculateVaultQuantums,
 } from './helpers/chain-helpers';
 import { IndexerClient } from './indexer-client';
 import { UserError } from './lib/errors';
@@ -109,6 +111,11 @@ export class CompositeClient {
     this._validatorClient.setSelectedGasDenom(gasDenom);
   }
 
+  async populateAccountNumberCache(address: string): Promise<void> {
+    if (!this._validatorClient) throw new Error('Validator client not initialized');
+    await this._validatorClient.populateAccountNumberCache(address);
+  }
+
   /**
    * @description Sign a list of messages with a wallet.
    * the calling function is responsible for creating the messages.
@@ -703,35 +710,36 @@ export class CompositeClient {
   }
 
   /**
- * @description Batch cancel short term orders using marketId to clobPairId translation.
- *
- * @param subaccount The subaccount to cancel the order from
- * @param shortTermOrders The list of short term order batches to cancel with marketId
- * @param goodTilBlock The goodTilBlock of the order to cancel
- * @returns The transaction hash.
- */
-async batchCancelShortTermOrdersWithMarketId(
-  subaccount: SubaccountInfo,
-  shortTermOrders: OrderBatchWithMarketId[],
-  goodTilBlock: number,
-  broadcastMode?: BroadcastMode,
-): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
-  const orderBatches = await Promise.all(
-    shortTermOrders.map(async ({ marketId, clobPairId, clientIds }) => ({
-      clobPairId: (
-        clobPairId ??
-        (await this.indexerClient.markets.getPerpetualMarkets(marketId)).markets[marketId]
-      ).clobPairId, 
-      clientIds }))
-  );
-
-  return this.validatorClient.post.batchCancelShortTermOrders(
-    subaccount,
-    orderBatches,
-    goodTilBlock,
-    broadcastMode
-  );
-}
+   * @description Batch cancel short term orders using marketId to clobPairId translation.
+   *
+   * @param subaccount The subaccount to cancel the order from
+   * @param shortTermOrders The list of short term order batches to cancel with marketId
+   * @param goodTilBlock The goodTilBlock of the order to cancel
+   * @returns The transaction hash.
+   */
+  async batchCancelShortTermOrdersWithMarketId(
+    subaccount: SubaccountInfo,
+    shortTermOrders: OrderBatchWithMarketId[],
+    goodTilBlock: number,
+    broadcastMode?: BroadcastMode,
+  ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
+    const orderBatches = await Promise.all(
+      shortTermOrders.map(async ({ marketId, clobPairId, clientIds }) => ({
+        clobPairId: (
+          clobPairId ??
+          (await this.indexerClient.markets.getPerpetualMarkets(marketId)).markets[marketId]
+        ).clobPairId,
+        clientIds,
+      })),
+    );
+
+    return this.validatorClient.post.batchCancelShortTermOrders(
+      subaccount,
+      orderBatches,
+      goodTilBlock,
+      broadcastMode,
+    );
+  }
 
   /**
    * @description Batch cancel short term orders using clobPairId.
@@ -1051,6 +1059,55 @@ async batchCancelShortTermOrdersWithMarketId(
     return Buffer.from(signature).toString('base64');
   }
 
+  // vaults
+
+  async depositToMegavault(
+    subaccount: SubaccountInfo,
+    amountUsdc: number,
+    broadcastMode?: BroadcastMode,
+  ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
+    return this.validatorClient.post.depositToMegavault(
+      subaccount,
+      bigIntToBytes(calculateVaultQuantums(amountUsdc)),
+      broadcastMode,
+    );
+  }
+
+  depositToMegavaultMessage(subaccount: SubaccountInfo, amountUsdc: number): EncodeObject {
+    return this.validatorClient.post.depositToMegavaultMsg(
+      subaccount.address,
+      subaccount.subaccountNumber,
+      bigIntToBytes(calculateVaultQuantums(amountUsdc)),
+    );
+  }
+
+  async withdrawFromMegavault(
+    subaccount: SubaccountInfo,
+    shares: number,
+    minAmount: number,
+    broadcastMode?: BroadcastMode,
+  ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
+    return this.validatorClient.post.withdrawFromMegavault(
+      subaccount,
+      bigIntToBytes(BigInt(Math.floor(shares))),
+      bigIntToBytes(calculateVaultQuantums(minAmount)),
+      broadcastMode,
+    );
+  }
+
+  withdrawFromMegavaultMessage(
+    subaccount: SubaccountInfo,
+    shares: number,
+    minAmount: number,
+  ): EncodeObject {
+    return this.validatorClient.post.withdrawFromMegavaultMsg(
+      subaccount.address,
+      subaccount.subaccountNumber,
+      bigIntToBytes(BigInt(Math.floor(shares))),
+      bigIntToBytes(calculateVaultQuantums(minAmount)),
+    );
+  }
+
   /**
    * @description Submit a governance proposal to add a new market.
    *

package/src/clients/constants.ts

@@ -94,6 +94,10 @@ export const TYPE_URL_MSG_WITHDRAW_FROM_SUBACCOUNT =
   '/dydxprotocol.sending.MsgWithdrawFromSubaccount';
 export const TYPE_URL_MSG_DEPOSIT_TO_SUBACCOUNT = '/dydxprotocol.sending.MsgDepositToSubaccount';
 
+// x/vault
+export const TYPE_URL_MSG_DEPOSIT_TO_MEGAVAULT = '/dydxprotocol.vault.MsgDepositToMegavault';
+export const TYPE_URL_MSG_WITHDRAW_FROM_MEGAVAULT = '/dydxprotocol.vault.MsgWithdrawFromMegavault';
+
 // x/staking
 export const TYPE_URL_MSG_DELEGATE = '/cosmos.staking.v1beta1.MsgDelegate';
 export const TYPE_URL_MSG_UNDELEGATE = '/cosmos.staking.v1beta1.MsgUndelegate';
@@ -106,6 +110,7 @@ export const TYPE_URL_MSG_WITHDRAW_DELEGATOR_REWARD =
 // The following are same across different networks / deployments.
 export const GOV_MODULE_ADDRESS = 'dydx10d07y265gmmuvt4z0w9aw880jnsr700jnmapky';
 export const DELAYMSG_MODULE_ADDRESS = 'dydx1mkkvp26dngu6n8rmalaxyp3gwkjuzztq5zx6tr';
+export const MEGAVAULT_MODULE_ADDRESS = 'dydx18tkxrnrkqc2t0lr3zxr5g6a4hdvqksylxqje4r';
 
 // ------------ Market Statistic Day Types ------------
 export enum MarketStatisticDay {
@@ -177,8 +182,8 @@ export enum TimePeriod {
 }
 
 export enum PnlTickInterval {
-  HOUR = "hour",
-  day = "day",
+  HOUR = 'hour',
+  day = 'day',
 }
 
 // ------------ API Defaults ------------

package/src/clients/helpers/chain-helpers.ts

@@ -6,7 +6,11 @@ import { Order_ConditionType, Order_Side, Order_TimeInForce } from '../modules/p
 import { OrderFlags } from '../types';
 
 export function round(input: number, base: number): number {
-  return BigNumber(input).div(BigNumber(base)).integerValue(BigNumber.ROUND_FLOOR).times(BigNumber(base)).toNumber();
+  return BigNumber(input)
+    .div(BigNumber(base))
+    .integerValue(BigNumber.ROUND_FLOOR)
+    .times(BigNumber(base))
+    .toNumber();
 }
 
 export function calculateQuantums(
@@ -14,13 +18,19 @@ export function calculateQuantums(
   atomicResolution: number,
   stepBaseQuantums: number,
 ): Long {
-  const rawQuantums = BigNumber(size).times(BigNumber(10).pow(BigNumber(atomicResolution).negated()));
+  const rawQuantums = BigNumber(size).times(
+    BigNumber(10).pow(BigNumber(atomicResolution).negated()),
+  );
   const quantums = round(rawQuantums.toNumber(), stepBaseQuantums);
   // stepBaseQuantums functions as minimum order size
   const result = Math.max(quantums, stepBaseQuantums);
   return Long.fromNumber(result);
 }
 
+export function calculateVaultQuantums(size: number): bigint {
+  return BigInt(BigNumber(size).times(1_000_000).toFixed(0, BigNumber.ROUND_FLOOR));
+}
+
 export function calculateSubticks(
   price: number,
   atomicResolution: number,

package/src/clients/lib/registry.ts

@@ -15,6 +15,10 @@ import {
   MsgDepositToSubaccount,
 } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/sending/transfer';
 import { MsgCreateTransfer } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/sending/tx';
+import {
+  MsgDepositToMegavault,
+  MsgWithdrawFromMegavault,
+} from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/vault/tx';
 
 import {
   TYPE_URL_MSG_PLACE_ORDER,
@@ -28,6 +32,8 @@ import {
   TYPE_URL_MSG_WITHDRAW_FROM_SUBACCOUNT,
   TYPE_URL_MSG_DEPOSIT_TO_SUBACCOUNT,
   TYPE_URL_BATCH_CANCEL,
+  TYPE_URL_MSG_DEPOSIT_TO_MEGAVAULT,
+  TYPE_URL_MSG_WITHDRAW_FROM_MEGAVAULT,
 } from '../constants';
 
 export const registry: ReadonlyArray<[string, GeneratedType]> = [];
@@ -49,6 +55,9 @@ export function generateRegistry(): Registry {
     // prices
     [TYPE_URL_MSG_CREATE_ORACLE_MARKET, MsgCreateOracleMarket as GeneratedType],
 
+    // vaults
+    [TYPE_URL_MSG_DEPOSIT_TO_MEGAVAULT, MsgDepositToMegavault as GeneratedType],
+    [TYPE_URL_MSG_WITHDRAW_FROM_MEGAVAULT, MsgWithdrawFromMegavault as GeneratedType],
     // sending
     [TYPE_URL_MSG_CREATE_TRANSFER, MsgCreateTransfer as GeneratedType],
     [TYPE_URL_MSG_WITHDRAW_FROM_SUBACCOUNT, MsgWithdrawFromSubaccount as GeneratedType],

package/src/clients/modules/composer.ts

@@ -18,6 +18,10 @@ import { MsgDelayMessage } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol
 import { PerpetualMarketType } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/perpetuals/perpetual';
 import { MsgCreatePerpetual } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/perpetuals/tx';
 import { MsgCreateOracleMarket } from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/prices/tx';
+import {
+  MsgDepositToMegavault,
+  MsgWithdrawFromMegavault,
+} from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/vault/tx';
 import { MsgSend } from 'cosmjs-types/cosmos/bank/v1beta1/tx';
 import { Coin } from 'cosmjs-types/cosmos/base/v1beta1/coin';
 import { Any } from 'cosmjs-types/google/protobuf/any';
@@ -43,6 +47,7 @@ import {
   TYPE_URL_MSG_UNDELEGATE,
   TYPE_URL_MSG_WITHDRAW_DELEGATOR_REWARD,
   TYPE_URL_BATCH_CANCEL,
+  TYPE_URL_MSG_DEPOSIT_TO_MEGAVAULT,
 } from '../constants';
 import { DenomConfig } from '../types';
 import {
@@ -445,6 +450,51 @@ export class Composer {
     };
   }
 
+  // ------------ x/vault ------------
+  public composeMsgDepositToMegavault(
+    address: string,
+    subaccountNumber: number,
+    quoteQuantums: Uint8Array,
+  ): EncodeObject {
+    const subaccountId: SubaccountId = {
+      owner: address,
+      number: subaccountNumber,
+    };
+
+    const msg: MsgDepositToMegavault = {
+      quoteQuantums,
+      subaccountId,
+    };
+
+    return {
+      typeUrl: TYPE_URL_MSG_DEPOSIT_TO_MEGAVAULT,
+      value: msg,
+    };
+  }
+
+  public composeMsgWithdrawFromMegavault(
+    address: string,
+    subaccountNumber: number,
+    shares: Uint8Array,
+    minQuoteQuantums: Uint8Array,
+  ): EncodeObject {
+    const subaccountId: SubaccountId = {
+      owner: address,
+      number: subaccountNumber,
+    };
+
+    const msg: MsgWithdrawFromMegavault = {
+      minQuoteQuantums,
+      shares: { numShares: shares },
+      subaccountId,
+    };
+
+    return {
+      typeUrl: TYPE_URL_MSG_DEPOSIT_TO_MEGAVAULT,
+      value: msg,
+    };
+  }
+
   // ------------ x/staking ------------
   public composeMsgDelegate(delegator: string, validator: string, amount: Coin): EncodeObject {
     const msg: MsgDelegate = {

package/src/clients/modules/get.ts

@@ -13,6 +13,7 @@ import { Any } from 'cosmjs-types/google/protobuf/any';
 import Long from 'long';
 import protobuf from 'protobufjs';
 
+import { bigIntToBytes } from '../../lib/helpers';
 import { PAGE_REQUEST } from '../constants';
 import { UnexpectedClientError } from '../lib/errors';
 import {
@@ -29,6 +30,7 @@ import {
   StakingModule,
   StatsModule,
   SubaccountsModule,
+  VaultModule,
 } from './proto-includes';
 import { TendermintClient } from './tendermintClient';
 
@@ -415,8 +417,7 @@ export class Get {
     const requestData = Uint8Array.from(
       DistributionModule.QueryDelegationTotalRewardsRequest.encode({
         delegatorAddress,
-      })
-        .finish(),
+      }).finish(),
     );
 
     const data: Uint8Array = await this.sendQuery(
@@ -491,9 +492,13 @@ export class Get {
     return GovV1Module.QueryProposalsResponse.decode(data);
   }
 
-  async getWithdrawalAndTransferGatingStatus(perpetualId: number): Promise<SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoResponse> {
+  async getWithdrawalAndTransferGatingStatus(
+    perpetualId: number,
+  ): Promise<SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoResponse> {
     const requestData = Uint8Array.from(
-      SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoRequest.encode({ perpetualId }).finish(),
+      SubaccountsModule.QueryGetWithdrawalAndTransfersBlockedInfoRequest.encode({
+        perpetualId,
+      }).finish(),
     );
 
     const data = await this.sendQuery(
@@ -518,6 +523,42 @@ export class Get {
     return RateLimitModule.QueryCapacityByDenomResponse.decode(data);
   }
 
+  async getMegavaultOwnerShares(
+    address: string,
+  ): Promise<VaultModule.QueryMegavaultOwnerSharesResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      VaultModule.QueryMegavaultOwnerSharesRequest.encode({
+        address,
+      }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/dydxprotocol.vault.Query/MegavaultOwnerShares',
+      requestData,
+    );
+
+    return VaultModule.QueryMegavaultOwnerSharesResponse.decode(data);
+  }
+
+  async getMegavaultWithdrawalInfo(
+    sharesToWithdraw: bigint,
+  ): Promise<VaultModule.QueryMegavaultWithdrawalInfoResponse> {
+    const requestData: Uint8Array = Uint8Array.from(
+      VaultModule.QueryMegavaultWithdrawalInfoRequest.encode({
+        sharesToWithdraw: {
+          numShares: bigIntToBytes(sharesToWithdraw),
+        },
+      }).finish(),
+    );
+
+    const data: Uint8Array = await this.sendQuery(
+      '/dydxprotocol.vault.Query/MegavaultWithdrawalInfo',
+      requestData,
+    );
+
+    return VaultModule.QueryMegavaultWithdrawalInfoResponse.decode(data);
+  }
+
   private async sendQuery(requestUrl: string, requestData: Uint8Array): Promise<Uint8Array> {
     // eslint-disable-next-line max-len
     const resp: QueryAbciResponse = await this.stargateQueryClient.queryAbci(

package/src/clients/modules/post.ts

@@ -76,6 +76,18 @@ export class Post {
     );
   }
 
+  /**
+   * @description Retrieves the account number for the given wallet address and populates the accountNumberCache.
+   * The account number is required for txOptions when signing a transaction.
+   * Pre-populating the cache avoids a round-trip request during the first transaction creation in the session, preventing it from being a performance blocker.
+   */
+  public async populateAccountNumberCache(address: string): Promise<void> {
+    if (this.accountNumberCache.has(address)) return;
+
+    const account = await this.get.getAccount(address);
+    this.accountNumberCache.set(address, account);
+  }
+
   setSelectedGasDenom(selectedGasDenom: SelectedGasDenom): void {
     this.selectedGasDenom = selectedGasDenom;
   }
@@ -800,4 +812,59 @@ export class Post {
   withdrawDelegatorRewardMsg(delegator: string, validator: string): EncodeObject {
     return this.composer.composeMsgWithdrawDelegatorReward(delegator, validator);
   }
+
+  // vaults
+  async depositToMegavault(
+    subaccount: SubaccountInfo,
+    quoteQuantums: Uint8Array,
+    broadcastMode?: BroadcastMode,
+  ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
+    const msg = await this.depositToMegavaultMsg(
+      subaccount.address,
+      subaccount.subaccountNumber,
+      quoteQuantums,
+    );
+    return this.send(
+      subaccount.wallet,
+      () => Promise.resolve([msg]),
+      false,
+      undefined,
+      undefined,
+      broadcastMode,
+    );
+  }
+
+  depositToMegavaultMsg(
+    ...args: Parameters<Composer['composeMsgDepositToMegavault']>
+  ): EncodeObject {
+    return this.composer.composeMsgDepositToMegavault(...args);
+  }
+
+  async withdrawFromMegavault(
+    subaccount: SubaccountInfo,
+    shares: Uint8Array,
+    minQuoteQuantums: Uint8Array,
+    broadcastMode?: BroadcastMode,
+  ): Promise<BroadcastTxAsyncResponse | BroadcastTxSyncResponse | IndexedTx> {
+    const msg = await this.withdrawFromMegavaultMsg(
+      subaccount.address,
+      subaccount.subaccountNumber,
+      shares,
+      minQuoteQuantums,
+    );
+    return this.send(
+      subaccount.wallet,
+      () => Promise.resolve([msg]),
+      false,
+      undefined,
+      undefined,
+      broadcastMode,
+    );
+  }
+
+  withdrawFromMegavaultMsg(
+    ...args: Parameters<Composer['composeMsgWithdrawFromMegavault']>
+  ): EncodeObject {
+    return this.composer.composeMsgWithdrawFromMegavault(...args);
+  }
 }

package/src/clients/modules/proto-includes.ts

@@ -11,6 +11,7 @@ export * as RewardsModule from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/
 export * as StakingModule from '@dydxprotocol/v4-proto/src/codegen/cosmos/staking/v1beta1/query';
 export * as BridgeModule from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/bridge/query';
 export * as DistributionModule from '@dydxprotocol/v4-proto/src/codegen/cosmos/distribution/v1beta1/query';
+export * as VaultModule from '@dydxprotocol/v4-proto/src/codegen/dydxprotocol/vault/query';
 
 export * from '@dydxprotocol/v4-proto/src/codegen/cosmos/base/abci/v1beta1/abci';
 export * from '@dydxprotocol/v4-proto/src/codegen/cosmos/gov/v1/gov';

package/src/clients/validator-client.ts

@@ -69,6 +69,15 @@ export class ValidatorClient {
     this._post.setSelectedGasDenom(gasDenom);
   }
 
+
+  /**
+   * @description populate account number cache in the Post module for performance.
+   */
+  async populateAccountNumberCache(address: string): Promise<void> {
+    if (!this._post) throw new Error('Post module not initialized');
+    await this._post.populateAccountNumberCache(address);
+  }
+
   private async initialize(): Promise<void> {
     const tendermint37Client: Tendermint37Client = await Tendermint37Client.connect(
       this.config.restEndpoint,

package/src/lib/helpers.ts

@@ -49,6 +49,16 @@ function toBigInt(u: Uint8Array): BigInt {
   return negated ? -abs : abs;
 }
 
+export function bigIntToBytes(value: bigint): Uint8Array {
+  const absoluteValue = value < 0 ? value * BigInt(-1) : value;
+  const nonPaddedHexValue = absoluteValue.toString(16);
+  const paddedHexValue =
+    nonPaddedHexValue.length % 2 === 0 ? nonPaddedHexValue : `0${nonPaddedHexValue}`;
+  const numberBytes = Buffer.from(paddedHexValue, 'hex');
+  const signedBytes = Uint8Array.of(value < 0 ? 3 : 2, ...numberBytes);
+  return signedBytes;
+}
+
 export enum ByteArrayEncoding {
   HEX = 'hex',
   BIGINT = 'bigint',