@nadohq/indexer-client 0.1.0-alpha.4 → 0.1.0-alpha.40

package/src/types/clientTypes.ts

@@ -1,4 +1,5 @@
 import {
+  BigDecimal,
   EIP712OrderValues,
   Market,
   OrderAppendix,
@@ -9,8 +10,7 @@ import {
   SpotMarket,
   Subaccount,
 } from '@nadohq/shared';
-import { BigDecimal } from '@nadohq/shared';
-import { Hex } from 'viem';
+import { Address, Hex } from 'viem';
 import { CandlestickPeriod } from './CandlestickPeriod';
 import { IndexerEventType } from './IndexerEventType';
 import { IndexerLeaderboardRankType } from './IndexerLeaderboardType';
@@ -18,6 +18,7 @@ import { NadoTx, NadoWithdrawCollateralTx } from './NadoTx';
 import {
   IndexerServerFastWithdrawalSignatureParams,
   IndexerServerListSubaccountsParams,
+  IndexerServerTriggerTypeFilter,
 } from './serverTypes';
 
 /**
@@ -53,6 +54,7 @@ export interface IndexerBalanceTrackedVars {
   netFundingCumulative: BigDecimal;
   netEntryUnrealized: BigDecimal;
   netEntryCumulative: BigDecimal;
+  quoteVolumeCumulative: BigDecimal;
 }
 
 export interface IndexerEvent<
@@ -86,6 +88,9 @@ export type ListIndexerSubaccountsParams = IndexerServerListSubaccountsParams;
 
 export type ListIndexerSubaccountsResponse = ({
   hexId: string;
+  // Unix timestamp in seconds
+  createdAt: number;
+  isolated: boolean;
 } & Subaccount)[];
 
 /**
@@ -313,7 +318,7 @@ export type GetIndexerEventsLimitType = 'events' | 'txs';
 export interface GetIndexerEventsParams {
   // Max submission index, inclusive
   startCursor?: string;
-  subaccount?: Subaccount;
+  subaccounts?: Subaccount[];
   productIds?: number[];
   // If not given, will return both isolated & non-iso events
   isolated?: boolean;
@@ -336,11 +341,12 @@ export type GetIndexerEventsResponse = IndexerEventWithTx[];
 export interface GetIndexerOrdersParams {
   // Max submission index, inclusive
   startCursor?: string;
-  subaccount?: Subaccount;
+  subaccounts?: Subaccount[];
   minTimestampInclusive?: number;
   maxTimestampInclusive?: number;
   limit?: number;
   productIds?: number[];
+  triggerTypes?: IndexerServerTriggerTypeFilter[];
   // If not given, will return both isolated & non-iso orders
   isolated?: boolean;
   digests?: string[];
@@ -349,7 +355,6 @@ export interface GetIndexerOrdersParams {
 export interface IndexerOrder {
   digest: string;
   subaccount: string;
-  isolated: boolean;
   productId: number;
   submissionIndex: string;
   amount: BigDecimal;
@@ -376,7 +381,7 @@ export type GetIndexerOrdersResponse = IndexerOrder[];
 
 export interface GetIndexerMatchEventsParams {
   // When not given, will return all maker events
-  subaccount?: Subaccount;
+  subaccounts?: Subaccount[];
   productIds?: number[];
   // If not given, will return both isolated & non-iso events
   isolated?: boolean;
@@ -407,6 +412,7 @@ export interface IndexerMatchEvent extends Subaccount {
   cumulativeFee: BigDecimal;
   submissionIndex: string;
   timestamp: BigDecimal;
+  isTaker: boolean;
   // Tracked vars for the balance BEFORE this match event occurred
   preEventTrackedVars: Pick<
     IndexerBalanceTrackedVars,
@@ -649,8 +655,8 @@ export interface IndexerNlpSnapshot {
   // Total volume traded by the NLP, in terms of the primary quote
   cumulativeVolume: BigDecimal;
   cumulativeTrades: BigDecimal;
-  cumulativeMintAmountUsdc: BigDecimal;
-  cumulativeBurnAmountUsdc: BigDecimal;
+  cumulativeMintAmountQuote: BigDecimal;
+  cumulativeBurnAmountQuote: BigDecimal;
   cumulativePnl: BigDecimal;
   tvl: BigDecimal;
   oraclePrice: BigDecimal;
@@ -676,8 +682,67 @@ export interface GetIndexerBacklogResponse {
   txsPerSecond: BigDecimal | null;
 }
 
-export type GetIndexerSubaccountDDAParams = Subaccount;
+export interface GetIndexerSubaccountDDAParams {
+  subaccount: Subaccount;
+}
 
 export interface GetIndexerSubaccountDDAResponse {
-  address: string;
+  address: Address;
 }
+
+/**
+ * V2 Tickers
+ */
+
+/**
+ * Market type for ticker filtering
+ */
+export type TickerMarketType = 'spot' | 'perp';
+
+/**
+ * Parameters for querying v2 tickers endpoint
+ */
+export interface GetIndexerV2TickersParams {
+  /**
+   * Filter tickers by market type (spot or perp)
+   * @example 'spot'
+   * @example 'perp'
+   */
+  market?: TickerMarketType;
+  /**
+   * Whether to include edge products
+   * @default false
+   */
+  edge?: boolean;
+}
+
+/**
+ * Individual ticker data from v2 endpoint
+ */
+export interface IndexerV2TickerResponse {
+  /** Unique product identifier */
+  productId: number;
+  /** Unique ticker identifier */
+  tickerId: string;
+  /** Base currency symbol */
+  baseCurrency: string;
+  /** Quote currency symbol */
+  quoteCurrency: string;
+  /** Last traded price */
+  lastPrice: number;
+  /** 24h trading volume in base currency */
+  baseVolume: number;
+  /** 24h trading volume in quote currency */
+  quoteVolume: number;
+  /** 24h price change percentage */
+  priceChangePercent24h: number;
+}
+
+/**
+ * Response from v2 tickers endpoint
+ * Maps ticker IDs to their respective ticker data
+ */
+export type GetIndexerV2TickersResponse = Record<
+  string,
+  IndexerV2TickerResponse
+>;

package/src/types/index.ts

@@ -1,9 +1,9 @@
-export * from './clientTypes';
-export * from './paginatedEventsTypes';
-export * from './serverTypes';
-export * from './serverModelTypes';
 export * from './CandlestickPeriod';
+export * from './clientTypes';
+export * from './collateralEventType';
 export * from './IndexerEventType';
 export * from './IndexerLeaderboardType';
-export * from './collateralEventType';
 export * from './NadoTx';
+export * from './paginatedEventsTypes';
+export * from './serverModelTypes';
+export * from './serverTypes';

package/src/types/paginatedEventsTypes.ts

@@ -103,7 +103,7 @@ export type GetIndexerSubaccountMatchEventsResponse =
  */
 
 export type GetIndexerPaginatedOrdersParams = BaseSubaccountPaginationParams &
-  Pick<GetIndexerOrdersParams, 'productIds' | 'isolated'>;
+  Pick<GetIndexerOrdersParams, 'productIds' | 'triggerTypes' | 'isolated'>;
 
 export interface GetIndexerPaginatedOrdersResponse {
   orders: IndexerOrder[];

package/src/types/serverModelTypes.ts

@@ -1,10 +1,10 @@
-import { EIP712OrderValues } from '@nadohq/shared';
 import {
   EngineServerPerpBalance,
   EngineServerPerpProduct,
   EngineServerSpotBalance,
   EngineServerSpotProduct,
 } from '@nadohq/engine-client';
+import { EIP712OrderValues } from '@nadohq/shared';
 import { IndexerEventType } from './IndexerEventType';
 import { NadoTx } from './NadoTx';
 
@@ -78,6 +78,10 @@ export interface IndexerServerEvent {
   net_funding_cumulative: string;
   net_entry_unrealized: string;
   net_entry_cumulative: string;
+  /**
+   * Total traded volume in terms of the primary quote (i.e in terms of USDT) for this product
+   */
+  quote_volume_cumulative: string;
 }
 
 export interface IndexerServerTx {
@@ -92,7 +96,6 @@ export interface IndexerServerTx {
 
 export interface IndexerServerOrder {
   digest: string;
-  isolated: boolean;
   subaccount: string;
   product_id: number;
   submission_idx: string;
@@ -130,6 +133,7 @@ export interface IndexerServerMatchEvent {
   net_entry_cumulative: string;
   pre_balance: IndexerServerMatchEventBalances;
   post_balance: IndexerServerMatchEventBalances;
+  is_taker: boolean;
 }
 
 export interface IndexerServerMatchEventBalances {
@@ -259,8 +263,8 @@ export interface IndexerServerLeaderboardRegistration {
  */
 
 export interface IndexerServerNlpSnapshot {
-  cumulative_burn_usdc: string;
-  cumulative_mint_usdc: string;
+  cumulative_burn_quote: string;
+  cumulative_mint_quote: string;
   cumulative_pnl: string;
   cumulative_trades: string;
   cumulative_volume: string;

package/src/types/serverTypes.ts

@@ -15,13 +15,13 @@ import {
   IndexerServerMarketSnapshot,
   IndexerServerMarketSnapshotInterval,
   IndexerServerMatchEvent,
+  IndexerServerNlpSnapshot,
   IndexerServerOraclePrice,
   IndexerServerOrder,
   IndexerServerProductPayment,
   IndexerServerProductSnapshot,
   IndexerServerSnapshotsInterval,
   IndexerServerTx,
-  IndexerServerNlpSnapshot,
 } from './serverModelTypes';
 
 /**
@@ -93,7 +93,7 @@ export interface IndexerServerMultiProductsParams {
 }
 
 export interface IndexerServerEventsParams {
-  subaccount?: string;
+  subaccounts?: string[];
   product_ids?: number[];
   // If not given, will return both isolated & non-iso events
   isolated?: boolean;
@@ -112,9 +112,15 @@ export interface IndexerServerEventsParams {
       };
 }
 
+export type IndexerServerTriggerTypeFilter =
+  | 'none'
+  | 'price_trigger'
+  | 'time_trigger';
+
 export interface IndexerServerOrdersParams {
-  subaccount?: string;
+  subaccounts?: string[];
   product_ids?: number[];
+  trigger_types?: IndexerServerTriggerTypeFilter[];
   digests?: string[];
   max_time?: number;
   limit?: number;
@@ -125,7 +131,7 @@ export interface IndexerServerOrdersParams {
 }
 
 export interface IndexerServerMatchEventsParams {
-  subaccount?: string;
+  subaccounts?: string[];
   product_ids?: number[];
   // If not given, will return both isolated & non-iso events
   isolated?: boolean;
@@ -230,7 +236,7 @@ export interface IndexerServerQueryRequestByType {
   products: IndexerServerProductsParams;
   referral_code: IndexerServerReferralCodeParams;
   subaccounts: IndexerServerListSubaccountsParams;
-  usdc_price: Record<string, never>;
+  quote_price: Record<string, never>;
   nlp_snapshots: IndexerServerNlpSnapshotsParams;
 }
 
@@ -246,6 +252,9 @@ export interface IndexerServerListSubaccountsResponse {
     id: string;
     // Hex of subaccount bytes
     subaccount: string;
+    // UNIX timestamp in seconds
+    created_at: string;
+    isolated: boolean;
   }[];
 }
 
@@ -323,7 +332,7 @@ export interface IndexerServerMatchEventsResponse {
   txs: IndexerServerTx[];
 }
 
-export interface IndexerServerUsdcPriceResponse {
+export interface IndexerServerQuotePriceResponse {
   price_x18: string;
 }
 
@@ -432,6 +441,33 @@ export interface IndexerServerQueryResponseByType {
   products: IndexerServerProductsResponse;
   referral_code: IndexerServerReferralCodeResponse;
   subaccounts: IndexerServerListSubaccountsResponse;
-  usdc_price: IndexerServerUsdcPriceResponse;
+  quote_price: IndexerServerQuotePriceResponse;
   nlp_snapshots: IndexerServerNlpSnapshotsResponse;
 }
+
+/**
+ * V2 API Types
+ */
+
+/**
+ * Individual ticker data from v2 indexer endpoint (server format)
+ */
+export interface IndexerServerV2TickerResponse {
+  product_id: number;
+  ticker_id: string;
+  base_currency: string;
+  quote_currency: string;
+  last_price: number;
+  base_volume: number;
+  quote_volume: number;
+  price_change_percent_24h: number;
+}
+
+/**
+ * Response from v2 tickers endpoint (server format)
+ * Maps ticker IDs to their respective ticker data
+ */
+export type IndexerServerV2TickersResponse = Record<
+  string,
+  IndexerServerV2TickerResponse
+>;