@dydxprotocol/v4-client-js 1.14.0 → 1.15.0

package/package.json

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

package/src/clients/constants.ts

@@ -86,7 +86,8 @@ export const TYPE_URL_MSG_UPDATE_CLOB_PAIR = '/dydxprotocol.clob.MsgUpdateClobPa
 export const TYPE_URL_MSG_DELAY_MESSAGE = '/dydxprotocol.delaymsg.MsgDelayMessage';
 
 // x/listing
-export const TYPE_URL_MSG_CREATE_MARKET_PERMISSIONLESS = '/dydxprotocol.listing.MsgCreateMarketPermissionless';
+export const TYPE_URL_MSG_CREATE_MARKET_PERMISSIONLESS =
+  '/dydxprotocol.listing.MsgCreateMarketPermissionless';
 
 // x/perpetuals
 export const TYPE_URL_MSG_CREATE_PERPETUAL = '/dydxprotocol.perpetuals.MsgCreatePerpetual';
@@ -195,6 +196,12 @@ export enum PnlTickInterval {
   day = 'day',
 }
 
+export enum TradingRewardAggregationPeriod {
+  DAILY = 'DAILY',
+  WEEKLY = 'WEEKLY',
+  MONTHLY = 'MONTHLY',
+}
+
 // ------------ API Defaults ------------
 export const DEFAULT_API_TIMEOUT: number = 3_000;
 

package/src/clients/modules/account.ts

@@ -1,4 +1,11 @@
-import { OrderSide, OrderStatus, OrderType, PositionStatus, TickerType } from '../constants';
+import {
+  OrderSide,
+  OrderStatus,
+  OrderType,
+  PositionStatus,
+  TickerType,
+  TradingRewardAggregationPeriod,
+} from '../constants';
 import { Data } from '../types';
 import RestClient from './rest';
 
@@ -6,6 +13,8 @@ import RestClient from './rest';
  * @description REST endpoints for data related to a particular address.
  */
 export default class AccountClient extends RestClient {
+  // ------ Subaccount ------ //
+
   async getSubaccounts(address: string, limit?: number): Promise<Data> {
     const uri = `/v4/addresses/${address}`;
     return this.get(uri, { limit });
@@ -16,6 +25,13 @@ export default class AccountClient extends RestClient {
     return this.get(uri);
   }
 
+  async getParentSubaccount(address: string, parentSubaccountNumber: number): Promise<Data> {
+    const uri = `/v4/addresses/${address}/subaccountNumber/${parentSubaccountNumber}`;
+    return this.get(uri);
+  }
+
+  // ------ Positions ------ //
+
   async getSubaccountPerpetualPositions(
     address: string,
     subaccountNumber: number,
@@ -54,6 +70,27 @@ export default class AccountClient extends RestClient {
     });
   }
 
+  // ------ Transfers ------ //
+
+  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,
+    });
+  }
+
   async getSubaccountTransfers(
     address: string,
     subaccountNumber: number,
@@ -92,6 +129,8 @@ export default class AccountClient extends RestClient {
     });
   }
 
+  // ------ Orders ------ //
+
   async getSubaccountOrders(
     address: string,
     subaccountNumber: number,
@@ -121,11 +160,40 @@ export default class AccountClient extends RestClient {
     });
   }
 
+  async getParentSubaccountNumberOrders(
+    address: string,
+    parentSubaccountNumber: number,
+    ticker?: string | null,
+    side?: OrderSide | null,
+    status?: OrderStatus | null,
+    type?: OrderType | null,
+    limit?: number | null,
+    goodTilBlockBeforeOrAt?: number | null,
+    goodTilBlockTimeBeforeOrAt?: string | null,
+    returnLatestOrders?: boolean | null,
+  ): Promise<Data> {
+    const uri = '/v4/orders/parentSubaccountNumber';
+    return this.get(uri, {
+      address,
+      parentSubaccountNumber,
+      ticker,
+      side,
+      status,
+      type,
+      limit,
+      goodTilBlockBeforeOrAt,
+      goodTilBlockTimeBeforeOrAt,
+      returnLatestOrders,
+    });
+  }
+
   async getOrder(orderId: string): Promise<Data> {
     const uri = `/v4/orders/${orderId}`;
     return this.get(uri);
   }
 
+  // ------ Fills ------ //
+
   async getSubaccountFills(
     address: string,
     subaccountNumber: number,
@@ -172,6 +240,8 @@ export default class AccountClient extends RestClient {
     });
   }
 
+  // ------ Pnl ------ //
+
   async getSubaccountHistoricalPNLs(
     address: string,
     subaccountNumber: number,
@@ -195,22 +265,39 @@ export default class AccountClient extends RestClient {
     });
   }
 
-  async getTransfersBetween(
-    sourceAddress: string,
-    sourceSubaccountNumber: string,
-    recipientAddress: string,
-    recipientSubaccountNumber: string,
+  async getParentSubaccountNumberHistoricalPNLs(
+    address: string,
+    parentSubaccountNumber: number,
     createdBeforeOrAtHeight?: number | null,
-    createdBeforeOrAt?: string | null
-  ): Promise<Data>  {
-    const uri = '/v4/transfers/between';
+    createdBeforeOrAt?: string | null,
+    createdOnOrAfterHeight?: number | null,
+    createdOnOrAfter?: string | null,
+    limit?: number | null,
+    page?: number | null,
+  ): Promise<Data> {
+    const uri = '/v4//historical-pnl/parentSubaccount';
     return this.get(uri, {
-      sourceAddress,
-      sourceSubaccountNumber,
-      recipientAddress,
-      recipientSubaccountNumber,
+      address,
+      parentSubaccountNumber,
       createdBeforeOrAtHeight,
       createdBeforeOrAt,
+      createdOnOrAfterHeight,
+      createdOnOrAfter,
+      limit,
+      page,
     });
   }
+
+  // ------ Rewards ------ //
+
+  async getHistoricalTradingRewardsAggregations(
+    address: string,
+    period: TradingRewardAggregationPeriod,
+    limit?: number,
+    startingBeforeOrAt?: string,
+    startingBeforeOrAtHeight?: string,
+  ): Promise<Data> {
+    const uri = `/v4/historicalTradingRewardAggregations/${address}`;
+    return this.get(uri, { period, limit, startingBeforeOrAt, startingBeforeOrAtHeight });
+  }
 }