@dydxprotocol/v4-client-js 1.6.1 → 1.8.0

package/examples/native_examples.ts

@@ -15,6 +15,9 @@ import {
   withdraw,
   withdrawToIBC,
   wrappedError,
+  getMegavaultOwnerShares,
+  depositToMegavault,
+  withdrawFromMegavault,
 } from '../src/clients/native';
 import { DYDX_TEST_ADDRESS, DYDX_TEST_MNEMONIC } from './constants';
 
@@ -47,6 +50,19 @@ async function test(): Promise<void> {
     const userStats = await getUserStats(payload);
     console.log(userStats);
 
+    const balances1 = await getAccountBalances();
+    console.log(balances1);
+
+    const vaultOwnerShares = await getMegavaultOwnerShares(payload);
+    console.log(vaultOwnerShares);
+    
+    const depositResult = await depositToMegavault(0, 2);
+    console.log(depositResult);
+
+    const withdrawResult = await withdrawFromMegavault(0, 1, 0);
+    console.log(withdrawResult);
+
+
     const sendTokenPayload = {
       subaccountNumber: 0,
       amount: '10', // Dydx Token

package/package.json

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

package/src/clients/constants.ts

@@ -23,6 +23,7 @@ export const MAINNET_CHAIN_ID = 'dydx-mainnet-1';
 // ------------ API URLs ------------
 export enum IndexerApiHost {
   TESTNET = 'https://indexer.v4testnet.dydx.exchange/',
+  STAGING = 'https://indexer.v4staging.dydx.exchange/',
   LOCAL = 'http://localhost:3002',
   // For the deployment by DYDX token holders
   MAINNET = 'https://indexer.dydx.trade',
@@ -30,6 +31,7 @@ export enum IndexerApiHost {
 
 export enum IndexerWSHost {
   TESTNET = 'wss://dydx-testnet.imperator.co/v4/ws',
+  STAGING = 'wss://indexer.v4staging.dydx.exchange/v4/ws',
   LOCAL = 'ws://localhost:3003',
   // For the deployment by DYDX token holders
   MAINNET = 'wss://indexer.dydx.trade/v4/ws',
@@ -41,6 +43,7 @@ export enum FaucetApiHost {
 
 export enum ValidatorApiHost {
   TESTNET = 'https://test-dydx.kingnodes.com',
+  STAGING = 'https://validator.v4staging.dydx.exchange',
   LOCAL = 'http://localhost:26657',
   // For the deployment by DYDX token holders
   MAINNET = 'https://dydx-ops-rpc.kingnodes.com:443',
@@ -220,6 +223,7 @@ export class ValidatorConfig {
   public denoms: DenomConfig;
   public broadcastOptions?: BroadcastOptions;
   public defaultClientMemo?: string;
+  public useTimestampNonce?: boolean;
 
   constructor(
     restEndpoint: string,
@@ -227,6 +231,7 @@ export class ValidatorConfig {
     denoms: DenomConfig,
     broadcastOptions?: BroadcastOptions,
     defaultClientMemo?: string,
+    useTimestampNonce?: boolean,
   ) {
     this.restEndpoint = restEndpoint?.endsWith('/') ? restEndpoint.slice(0, -1) : restEndpoint;
     this.chainId = chainId;
@@ -234,6 +239,7 @@ export class ValidatorConfig {
     this.denoms = denoms;
     this.broadcastOptions = broadcastOptions;
     this.defaultClientMemo = defaultClientMemo;
+    this.useTimestampNonce = useTimestampNonce;
   }
 }
 
@@ -262,6 +268,24 @@ export class Network {
     return new Network('testnet', indexerConfig, validatorConfig);
   }
 
+  static staging(): Network {
+    const indexerConfig = new IndexerConfig(IndexerApiHost.STAGING, IndexerWSHost.STAGING);
+    const validatorConfig = new ValidatorConfig(
+      ValidatorApiHost.STAGING,
+      TESTNET_CHAIN_ID,
+      {
+        CHAINTOKEN_DENOM: 'adv4tnt',
+        USDC_DENOM: 'ibc/8E27BA2D5493AF5636760E354E46004562C46AB7EC0CC4C1CA14E9E20E2545B5',
+        USDC_GAS_DENOM: 'uusdc',
+        USDC_DECIMALS: 6,
+        CHAINTOKEN_DECIMALS: 18,
+      },
+      undefined,
+      'Client Example',
+    );
+    return new Network('staging', indexerConfig, validatorConfig);
+  }
+
   static local(): Network {
     const indexerConfig = new IndexerConfig(IndexerApiHost.LOCAL, IndexerWSHost.LOCAL);
     const validatorConfig = new ValidatorConfig(

package/src/clients/modules/post.ts

@@ -55,9 +55,10 @@ export class Post {
   public readonly defaultGasPrice: GasPrice;
   public readonly defaultDydxGasPrice: GasPrice;
 
+  public useTimestampNonce: boolean = false;
   private accountNumberCache: Map<string, Account> = new Map();
 
-  constructor(get: Get, chainId: string, denoms: DenomConfig, defaultClientMemo?: string) {
+  constructor(get: Get, chainId: string, denoms: DenomConfig, defaultClientMemo?: string, useTimestampNonce?: boolean) {
     this.get = get;
     this.chainId = chainId;
     this.registry = generateRegistry();
@@ -74,6 +75,7 @@ export class Post {
           : denoms.CHAINTOKEN_DENOM
       }`,
     );
+    if (useTimestampNonce === true) this.useTimestampNonce = useTimestampNonce;
   }
 
   /**
@@ -113,14 +115,23 @@ export class Post {
     memo?: string,
     account?: () => Promise<Account>,
   ): Promise<StdFee> {
-    const msgsPromise = messaging();
-    const accountPromise = account ? await account() : this.account(wallet.address!);
-    const msgsAndAccount = await Promise.all([msgsPromise, accountPromise]);
-    const msgs = msgsAndAccount[0];
+    let msgs: EncodeObject[];
+    // protocol expects timestamp nonce in UTC milliseconds, which is the unit returned by Date.now()
+    let sequence = Date.now();
+
+    if (this.useTimestampNonce) {
+      msgs = await messaging();
+    } else {
+      const msgsPromise = messaging();
+      const accountPromise = account ? await account() : this.account(wallet.address!);
+      const msgsAndAccount = await Promise.all([msgsPromise, accountPromise]);
+      msgs = msgsAndAccount[0];
+      sequence = msgsAndAccount[1].sequence;
+    }
 
     return this.simulateTransaction(
       wallet.pubKey!,
-      msgsAndAccount[1].sequence,
+      sequence,
       msgs,
       gasPrice,
       memo,
@@ -225,16 +236,18 @@ export class Post {
     gasPrice: GasPrice = this.getGasPrice(),
     memo?: string,
   ): Promise<Uint8Array> {
+    // protocol expects timestamp nonce in UTC milliseconds, which is the unit returned by Date.now()
+    const sequence = this.useTimestampNonce ? Date.now() : account.sequence;
     // Simulate transaction if no fee is specified.
     const fee: StdFee = zeroFee
       ? {
           amount: [],
           gas: '1000000',
         }
-      : await this.simulateTransaction(wallet.pubKey!, account.sequence, messages, gasPrice, memo);
+      : await this.simulateTransaction(wallet.pubKey!, sequence, messages, gasPrice, memo);
 
     const txOptions: TransactionOptions = {
-      sequence: account.sequence,
+      sequence,
       accountNumber: account.accountNumber,
       chainId: this.chainId,
     };
@@ -246,11 +259,12 @@ export class Post {
    * @description Retrieve an account structure for transactions.
    * For short term orders, the sequence doesn't matter. Use cached if available.
    * For long term and conditional orders, a round trip to validator must be made.
+   * when timestamp nonce is supported, no need to fetch account sequence number
    */
   public async account(address: string, orderFlags?: OrderFlags): Promise<Account> {
-    if (orderFlags === OrderFlags.SHORT_TERM) {
+    if (orderFlags === OrderFlags.SHORT_TERM || this.useTimestampNonce) {
       if (this.accountNumberCache.has(address)) {
-        // For SHORT_TERM orders, the sequence doesn't matter
+        // If order is SHORT_TERM or if timestamp nonce is enabled, the sequence doesn't matter
         return this.accountNumberCache.get(address)!;
       }
     }

package/src/clients/native.ts

@@ -1352,3 +1352,92 @@ export async function setSelectedGasDenom(gasDenom: string): Promise<string> {
     return wrappedError(error);
   }
 }
+
+export async function getMegavaultOwnerShares(payload: string): Promise<string> {
+  try {
+    const client = globalThis.client;
+    if (client === undefined) {
+      throw new UserError('client is not connected. Call connectClient() first');
+    }
+    const json = JSON.parse(payload);
+    const address = json.address;
+    if (address === undefined) {
+      throw new UserError('address is not set');
+    }
+    const response =
+      await globalThis.client?.validatorClient.get.getMegavaultOwnerShares(address);
+    return encodeJson(response);
+  } catch (e) {
+    return wrappedError(e);
+  }
+}
+
+export async function getMegavaultWithdrawalInfo(
+  sharesToWithdraw: bigint
+): Promise<string> {
+  try {
+    const client = globalThis.client;
+    if (client === undefined) {
+      throw new UserError('client is not connected. Call connectClient() first');
+    }
+    const response =
+      await globalThis.client?.validatorClient.get.getMegavaultWithdrawalInfo(sharesToWithdraw);
+    return encodeJson(response);
+  } catch (e) {
+    return wrappedError(e);
+  }
+}
+
+export async function depositToMegavault(
+  subaccountNumber: number,
+  amountUsdc: number
+): Promise<string> {
+  try {
+    const client = globalThis.client;
+    if (client === undefined) {
+      throw new UserError('client is not connected. Call connectNetwork() first');
+    }
+    const wallet = globalThis.wallet;
+    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,
+    );
+    return encodeJson(tx);
+  } catch (error) {
+    return wrappedError(error);
+  }
+}
+
+export async function withdrawFromMegavault(
+  subaccountNumber: number,
+  shares: number,
+  minAmount: number,
+): Promise<string> {
+  try {
+    const client = globalThis.client;
+    if (client === undefined) {
+      throw new UserError('client is not connected. Call connectNetwork() first');
+    }
+    const wallet = globalThis.wallet;
+    if (wallet === undefined) {
+      throw new UserError('wallet is not set. Call connectWallet() first');
+    }
+    const subaccount = new SubaccountInfo(wallet, subaccountNumber);
+    const tx = await client.withdrawFromMegavault(
+      subaccount,
+      shares,
+      minAmount,
+      Method.BroadcastTxCommit,
+    );
+    return encodeJson(tx);
+  } catch (error) {
+    return wrappedError(error);
+  }
+}
+
+

package/src/clients/validator-client.ts

@@ -97,6 +97,7 @@ export class ValidatorClient {
       this.config.chainId,
       this.config.denoms,
       this.config.defaultClientMemo,
+      this.config.useTimestampNonce,
     );
   }
 }