@dydxprotocol/v4-client-js 1.3.16 → 1.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v4-client-js",
-  "version": "1.3.16",
+  "version": "1.5.0",
   "description": "General client library for the new dYdX system (v4 decentralized)",
   "main": "build/src/index.js",
   "scripts": {
@@ -11,8 +11,8 @@
     "coverage": "npm run test -- --coverage",
     "fix": "npm run lint -- --fix",
     "lint": "eslint --ext .ts,.js .",
-    "prepublishOnly": "npm run compile && ls build/node_modules/@dydxprotocol/v4-proto",
-    "release": "semantic-release --no-ci",
+    "prepublishOnly": "npm run compile",
+    "release": "semantic-release",
     "start": "node build/src/index.js",
     "test": "NODE_ENV=test jest --testPathIgnorePatterns=__tests__/modules/client/*",
     "test:watch": "npm test -- --watch",

package/src/clients/composite-client.ts

@@ -109,6 +109,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.

package/src/clients/constants.ts

@@ -176,6 +176,11 @@ export enum TimePeriod {
   SEVEN_DAYS = 'SEVEN_DAYS',
 }
 
+export enum PnlTickInterval {
+  HOUR = "hour",
+  day = "day",
+}
+
 // ------------ API Defaults ------------
 export const DEFAULT_API_TIMEOUT: number = 3_000;
 

package/src/clients/indexer-client.ts

@@ -2,6 +2,7 @@ import { IndexerConfig, DEFAULT_API_TIMEOUT } from './constants';
 import AccountClient from './modules/account';
 import MarketsClient from './modules/markets';
 import UtilityClient from './modules/utility';
+import VaultClient from './modules/vault';
 
 /**
  * @description Client for Indexer
@@ -12,6 +13,7 @@ export class IndexerClient {
   readonly _markets: MarketsClient;
   readonly _account: AccountClient;
   readonly _utility: UtilityClient;
+  readonly _vault: VaultClient;
 
   constructor(config: IndexerConfig, apiTimeout?: number) {
     this.config = config;
@@ -20,6 +22,7 @@ export class IndexerClient {
     this._markets = new MarketsClient(config.restEndpoint);
     this._account = new AccountClient(config.restEndpoint);
     this._utility = new UtilityClient(config.restEndpoint);
+    this._vault = new VaultClient(config.restEndpoint);
   }
 
   /**
@@ -46,4 +49,13 @@ export class IndexerClient {
   get utility(): UtilityClient {
     return this._utility;
   }
+
+  /**
+   * @description Get the vault module, used for interacting with vault endpoints.
+   *
+   * @returns The vault module
+   */
+  get vault(): VaultClient {
+    return this._vault;
+  }
 }

package/src/clients/modules/account.ts

@@ -194,4 +194,23 @@ export default class AccountClient extends RestClient {
       page,
     });
   }
+
+  async getTransfersBetween(
+    sourceAddress: string,
+    sourceSubaccountNumber: string,
+    recipientAddress: string,
+    recipientSubaccountNumber: string,
+    createdBeforeOrAtHeight?: number | null,
+    createdBeforeOrAt?: string | null
+  ): Promise<Data>  {
+    const uri = '/v4/transfers/between';
+    return this.get(uri, {
+      sourceAddress,
+      sourceSubaccountNumber,
+      recipientAddress,
+      recipientSubaccountNumber,
+      createdBeforeOrAtHeight,
+      createdBeforeOrAt,
+    });
+  }
 }

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;
   }

package/src/clients/modules/vault.ts

@@ -0,0 +1,23 @@
+import { PnlTickInterval } from '../constants';
+import { Data } from '../types';
+import RestClient from './rest';
+
+/**
+ * @description REST endpoints for data unrelated to a particular address.
+ */
+export default class VaultClient extends RestClient {
+  async getMegavaultHistoricalPnl(resolution?: PnlTickInterval | null): Promise<Data> {
+    const uri = '/v4/vault/v1/megavault/historicalPnl';
+    return this.get(uri, { resolution });
+  }
+
+  async getVaultsHistoricalPnl(resolution?: PnlTickInterval | null): Promise<Data> {
+    const uri = '/v4/vault/v1/vaults/historicalPnl';
+    return this.get(uri, { resolution });
+  }
+
+  async getMegavaultPositions(): Promise<Data> {
+    const uri = '/v4/vault/v1/megavault/positions';
+    return this.get(uri);
+  }
+}

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,