@nadohq/indexer-client 0.1.0-alpha.1 → 0.1.0-alpha.2

package/dist/types/serverTypes.d.ts

@@ -2,7 +2,7 @@ import { SignedTx, EIP712LeaderboardAuthenticationValues } from '@nadohq/contrac
 import { IndexerEventType } from './IndexerEventType.js';
 import { IndexerLeaderboardRankType } from './IndexerLeaderboardType.js';
 import { NadoWithdrawCollateralTx } from './NadoTx.js';
-import { IndexerServerMarketSnapshotInterval, IndexerServerSnapshotsInterval, IndexerServerEvent, IndexerServerCandlestick, IndexerServerMarketSnapshot, IndexerServerTx, IndexerServerProductPayment, IndexerServerLeaderboardPosition, IndexerServerLeaderboardContest, IndexerServerLeaderboardRegistration, IndexerServerMaker, IndexerServerMatchEvent, IndexerServerOraclePrice, IndexerServerOrder, IndexerServerProductSnapshot, IndexerServerVlpSnapshot } from './serverModelTypes.js';
+import { IndexerServerMarketSnapshotInterval, IndexerServerSnapshotsInterval, IndexerServerEvent, IndexerServerCandlestick, IndexerServerMarketSnapshot, IndexerServerTx, IndexerServerProductPayment, IndexerServerLeaderboardPosition, IndexerServerLeaderboardContest, IndexerServerLeaderboardRegistration, IndexerServerMaker, IndexerServerMatchEvent, IndexerServerOraclePrice, IndexerServerOrder, IndexerServerProductSnapshot, IndexerServerNlpSnapshot } from './serverModelTypes.js';
 import '@nadohq/engine-client';
 
 /**
@@ -130,7 +130,7 @@ interface IndexerServerFastWithdrawalSignatureParams {
      */
     idx: number | string;
 }
-interface IndexerServerVlpSnapshotsParams {
+interface IndexerServerNlpSnapshotsParams {
     interval: IndexerServerSnapshotsInterval;
 }
 interface IndexerServerQueryRequestByType {
@@ -161,7 +161,7 @@ interface IndexerServerQueryRequestByType {
     referral_code: IndexerServerReferralCodeParams;
     subaccounts: IndexerServerListSubaccountsParams;
     usdc_price: Record<string, never>;
-    vlp_snapshots: IndexerServerVlpSnapshotsParams;
+    nlp_snapshots: IndexerServerNlpSnapshotsParams;
 }
 type IndexerServerQueryRequestType = keyof IndexerServerQueryRequestByType;
 /**
@@ -259,8 +259,8 @@ interface IndexerServerFastWithdrawalSignatureResponse {
     tx_bytes: string;
     signatures: string[];
 }
-interface IndexerServerVlpSnapshotsResponse {
-    snapshots: IndexerServerVlpSnapshot[];
+interface IndexerServerNlpSnapshotsResponse {
+    snapshots: IndexerServerNlpSnapshot[];
 }
 interface IndexerServerBacklogResponse {
     total_txs: string;
@@ -298,7 +298,7 @@ interface IndexerServerQueryResponseByType {
     referral_code: IndexerServerReferralCodeResponse;
     subaccounts: IndexerServerListSubaccountsResponse;
     usdc_price: IndexerServerUsdcPriceResponse;
-    vlp_snapshots: IndexerServerVlpSnapshotsResponse;
+    nlp_snapshots: IndexerServerNlpSnapshotsResponse;
 }
 
-export type { IndexerEdgeServerCandlesticksParams, IndexerEdgeServerCandlesticksResponse, IndexerEdgeServerMarketSnapshotsParams, IndexerEdgeServerMarketSnapshotsResponse, IndexerServerBacklogResponse, IndexerServerCandlesticksParams, IndexerServerCandlesticksResponse, IndexerServerEventsParams, IndexerServerEventsResponse, IndexerServerFastWithdrawalSignatureParams, IndexerServerFastWithdrawalSignatureResponse, IndexerServerFundingRate, IndexerServerFundingRateParams, IndexerServerFundingRateResponse, IndexerServerFundingRatesParams, IndexerServerFundingRatesResponse, IndexerServerInterestFundingParams, IndexerServerInterestFundingResponse, IndexerServerLeaderboardContestsParams, IndexerServerLeaderboardContestsResponse, IndexerServerLeaderboardParams, IndexerServerLeaderboardRankParams, IndexerServerLeaderboardRankResponse, IndexerServerLeaderboardRegistrationParams, IndexerServerLeaderboardRegistrationResponse, IndexerServerLeaderboardResponse, IndexerServerLinkedSignerParams, IndexerServerLinkedSignerResponse, IndexerServerListSubaccountsParams, IndexerServerListSubaccountsResponse, IndexerServerMakerStatisticsParams, IndexerServerMakerStatisticsResponse, IndexerServerMarketSnapshotsParams, IndexerServerMarketSnapshotsResponse, IndexerServerMatchEventsParams, IndexerServerMatchEventsResponse, IndexerServerMultiProductsParams, IndexerServerMultiProductsResponse, IndexerServerMultiSubaccountSnapshotsParams, IndexerServerMultiSubaccountSnapshotsResponse, IndexerServerOraclePricesParams, IndexerServerOraclePricesResponse, IndexerServerOrdersParams, IndexerServerOrdersResponse, IndexerServerPerpPrices, IndexerServerPerpPricesParams, IndexerServerPerpPricesResponse, IndexerServerPriceParams, IndexerServerPriceResponse, IndexerServerProductsParams, IndexerServerProductsResponse, IndexerServerQueryRequestByType, IndexerServerQueryRequestType, IndexerServerQueryResponseByType, IndexerServerReferralCodeParams, IndexerServerReferralCodeResponse, IndexerServerUsdcPriceResponse, IndexerServerVlpSnapshotsParams, IndexerServerVlpSnapshotsResponse };
+export type { IndexerEdgeServerCandlesticksParams, IndexerEdgeServerCandlesticksResponse, IndexerEdgeServerMarketSnapshotsParams, IndexerEdgeServerMarketSnapshotsResponse, IndexerServerBacklogResponse, IndexerServerCandlesticksParams, IndexerServerCandlesticksResponse, IndexerServerEventsParams, IndexerServerEventsResponse, IndexerServerFastWithdrawalSignatureParams, IndexerServerFastWithdrawalSignatureResponse, IndexerServerFundingRate, IndexerServerFundingRateParams, IndexerServerFundingRateResponse, IndexerServerFundingRatesParams, IndexerServerFundingRatesResponse, IndexerServerInterestFundingParams, IndexerServerInterestFundingResponse, IndexerServerLeaderboardContestsParams, IndexerServerLeaderboardContestsResponse, IndexerServerLeaderboardParams, IndexerServerLeaderboardRankParams, IndexerServerLeaderboardRankResponse, IndexerServerLeaderboardRegistrationParams, IndexerServerLeaderboardRegistrationResponse, IndexerServerLeaderboardResponse, IndexerServerLinkedSignerParams, IndexerServerLinkedSignerResponse, IndexerServerListSubaccountsParams, IndexerServerListSubaccountsResponse, IndexerServerMakerStatisticsParams, IndexerServerMakerStatisticsResponse, IndexerServerMarketSnapshotsParams, IndexerServerMarketSnapshotsResponse, IndexerServerMatchEventsParams, IndexerServerMatchEventsResponse, IndexerServerMultiProductsParams, IndexerServerMultiProductsResponse, IndexerServerMultiSubaccountSnapshotsParams, IndexerServerMultiSubaccountSnapshotsResponse, IndexerServerNlpSnapshotsParams, IndexerServerNlpSnapshotsResponse, IndexerServerOraclePricesParams, IndexerServerOraclePricesResponse, IndexerServerOrdersParams, IndexerServerOrdersResponse, IndexerServerPerpPrices, IndexerServerPerpPricesParams, IndexerServerPerpPricesResponse, IndexerServerPriceParams, IndexerServerPriceResponse, IndexerServerProductsParams, IndexerServerProductsResponse, IndexerServerQueryRequestByType, IndexerServerQueryRequestType, IndexerServerQueryResponseByType, IndexerServerReferralCodeParams, IndexerServerReferralCodeResponse, IndexerServerUsdcPriceResponse };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nadohq/indexer-client",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.2",
   "type": "module",
   "sideEffects": false,
   "description": "> TODO: description",
@@ -37,9 +37,9 @@
     }
   },
   "dependencies": {
-    "@nadohq/contracts": "^0.1.0-alpha.1",
-    "@nadohq/engine-client": "^0.1.0-alpha.1",
-    "@nadohq/utils": "^0.1.0-alpha.1",
+    "@nadohq/contracts": "^0.1.0-alpha.2",
+    "@nadohq/engine-client": "^0.1.0-alpha.2",
+    "@nadohq/utils": "^0.1.0-alpha.2",
     "axios": "*",
     "ts-mixer": "*"
   },
@@ -49,5 +49,5 @@
   "devDependencies": {
     "viem": "*"
   },
-  "gitHead": "80100d38c43806d1bb57c9139d9577329467d5db"
+  "gitHead": "7ec8ff9383dc6734bb64511b87b0687438d01618"
 }

package/src/IndexerBaseClient.ts

@@ -37,7 +37,7 @@ import {
   mapIndexerPerpPrices,
   mapIndexerProductPayment,
   mapIndexerServerProduct,
-  mapIndexerVlpSnapshot,
+  mapIndexerNlpSnapshot,
   mapSnapshotsIntervalToServerParams,
 } from './dataMappers';
 import {
@@ -91,8 +91,8 @@ import {
   GetIndexerQuotePriceResponse,
   GetIndexerReferralCodeParams,
   GetIndexerReferralCodeResponse,
-  GetIndexerVlpSnapshotsParams,
-  GetIndexerVlpSnapshotsResponse,
+  GetIndexerNlpSnapshotsParams,
+  GetIndexerNlpSnapshotsResponse,
   IndexerEventWithTx,
   IndexerMatchEvent,
   IndexerOraclePrice,
@@ -769,10 +769,10 @@ export class IndexerBaseClient {
     };
   }
 
-  async getVlpSnapshots(
-    params: GetIndexerVlpSnapshotsParams,
-  ): Promise<GetIndexerVlpSnapshotsResponse> {
-    const baseResponse = await this.query('vlp_snapshots', {
+  async getNlpSnapshots(
+    params: GetIndexerNlpSnapshotsParams,
+  ): Promise<GetIndexerNlpSnapshotsResponse> {
+    const baseResponse = await this.query('nlp_snapshots', {
       interval: {
         count: params.limit,
         max_time: params.maxTimeInclusive
@@ -783,7 +783,7 @@ export class IndexerBaseClient {
     });
 
     return {
-      snapshots: baseResponse.snapshots.map(mapIndexerVlpSnapshot),
+      snapshots: baseResponse.snapshots.map(mapIndexerNlpSnapshot),
     };
   }
 

package/src/IndexerClient.ts

@@ -2,7 +2,7 @@ import {
   ProductEngineType,
   QUOTE_PRODUCT_ID,
   subaccountFromHex,
-  VLP_PRODUCT_ID,
+  NLP_PRODUCT_ID,
 } from '@nadohq/contracts';
 import { toBigDecimal, toIntegerString } from '@nadohq/utils';
 
@@ -24,15 +24,15 @@ import {
   GetIndexerSubaccountMatchEventsResponse,
   GetIndexerSubaccountSettlementEventsParams,
   GetIndexerSubaccountSettlementEventsResponse,
-  GetIndexerSubaccountVlpEventsParams,
-  GetIndexerSubaccountVlpEventsResponse,
+  GetIndexerSubaccountNlpEventsParams,
+  GetIndexerSubaccountNlpEventsResponse,
   IndexerCollateralEvent,
   IndexerEventPerpStateSnapshot,
   IndexerEventSpotStateSnapshot,
   IndexerEventWithTx,
   IndexerLiquidationEvent,
   IndexerSettlementEvent,
-  IndexerVlpEvent,
+  IndexerNlpEvent,
   PaginatedIndexerEventsResponse,
 } from './types';
 
@@ -66,9 +66,9 @@ export class IndexerClient extends IndexerBaseClient {
     return this.getPaginationEventsResponse(events, requestedLimit);
   }
 
-  async getPaginatedSubaccountVlpEvents(
-    params: GetIndexerSubaccountVlpEventsParams,
-  ): Promise<GetIndexerSubaccountVlpEventsResponse> {
+  async getPaginatedSubaccountNlpEvents(
+    params: GetIndexerSubaccountNlpEventsParams,
+  ): Promise<GetIndexerSubaccountNlpEventsResponse> {
     const {
       startCursor,
       maxTimestampInclusive,
@@ -77,12 +77,12 @@ export class IndexerClient extends IndexerBaseClient {
       subaccountOwner,
     } = params;
 
-    // There are 2 events per mint/burn for spot - one associated with the VLP product & the other with the primary quote
+    // There are 2 events per mint/burn for spot - one associated with the NLP product & the other with the primary quote
     const limit = requestedLimit + 1;
     const baseResponse = await this.getEvents({
       startCursor,
       maxTimestampInclusive,
-      eventTypes: ['mint_vlp', 'burn_vlp'],
+      eventTypes: ['mint_nlp', 'burn_nlp'],
       limit: {
         type: 'txs',
         value: limit,
@@ -91,7 +91,7 @@ export class IndexerClient extends IndexerBaseClient {
     });
 
     // Now aggregate results by the submission index, use map to maintain insertion order
-    const eventsBySubmissionIdx = new Map<string, IndexerVlpEvent>();
+    const eventsBySubmissionIdx = new Map<string, IndexerNlpEvent>();
 
     baseResponse.forEach((event) => {
       const mappedEvent = (() => {
@@ -100,8 +100,8 @@ export class IndexerClient extends IndexerBaseClient {
           return existingEvent;
         }
 
-        const newEvent: IndexerVlpEvent = {
-          vlpDelta: toBigDecimal(0),
+        const newEvent: IndexerNlpEvent = {
+          nlpDelta: toBigDecimal(0),
           primaryQuoteDelta: toBigDecimal(0),
           timestamp: event.timestamp,
           submissionIndex: event.submissionIndex,
@@ -120,10 +120,10 @@ export class IndexerClient extends IndexerBaseClient {
       const productId = event.state.market.productId;
       if (productId === QUOTE_PRODUCT_ID) {
         mappedEvent.primaryQuoteDelta = balanceDelta;
-      } else if (productId === VLP_PRODUCT_ID) {
-        mappedEvent.vlpDelta = balanceDelta;
+      } else if (productId === NLP_PRODUCT_ID) {
+        mappedEvent.nlpDelta = balanceDelta;
       } else {
-        throw Error(`Invalid product ID for VLP event ${productId}`);
+        throw Error(`Invalid product ID for NLP event ${productId}`);
       }
     });
 

package/src/dataMappers.ts

@@ -48,10 +48,10 @@ import {
   IndexerServerProductPayment,
   IndexerServerSnapshotsInterval,
   IndexerServerTx,
-  IndexerServerVlpSnapshot,
+  IndexerServerNlpSnapshot,
   IndexerSnapshotsIntervalParams,
   IndexerSpotBalance,
-  IndexerVlpSnapshot,
+  IndexerNlpSnapshot,
 } from './types';
 
 export function mapSnapshotsIntervalToServerParams(
@@ -344,9 +344,9 @@ export function mapIndexerMarketSnapshot(
   };
 }
 
-export function mapIndexerVlpSnapshot(
-  snapshot: IndexerServerVlpSnapshot,
-): IndexerVlpSnapshot {
+export function mapIndexerNlpSnapshot(
+  snapshot: IndexerServerNlpSnapshot,
+): IndexerNlpSnapshot {
   return {
     submissionIndex: snapshot.submission_idx,
     timestamp: toBigDecimal(snapshot.timestamp),

package/src/types/IndexerEventType.ts

@@ -5,5 +5,5 @@ export type IndexerEventType =
   | 'settle_pnl'
   | 'match_orders'
   | 'transfer_quote'
-  | 'mint_vlp'
-  | 'burn_vlp';
+  | 'mint_nlp'
+  | 'burn_nlp';

package/src/types/NadoTx.ts

@@ -60,4 +60,4 @@ export type NadoTx =
   | {
       // TODO: Populate all types
       [key: string]: never;
-    };
+    };

package/src/types/clientTypes.ts

@@ -640,15 +640,15 @@ export interface GetIndexerFastWithdrawalSignatureResponse {
 }
 
 /**
- * VLP
+ * NLP
  */
 
-export type GetIndexerVlpSnapshotsParams = IndexerSnapshotsIntervalParams;
+export type GetIndexerNlpSnapshotsParams = IndexerSnapshotsIntervalParams;
 
-export interface IndexerVlpSnapshot {
+export interface IndexerNlpSnapshot {
   submissionIndex: string;
   timestamp: BigDecimal;
-  // Total volume traded by the VLP, in terms of the primary quote
+  // Total volume traded by the NLP, in terms of the primary quote
   cumulativeVolume: BigDecimal;
   cumulativeTrades: BigDecimal;
   cumulativeMintAmountUsdc: BigDecimal;
@@ -659,8 +659,8 @@ export interface IndexerVlpSnapshot {
   depositors: BigDecimal;
 }
 
-export interface GetIndexerVlpSnapshotsResponse {
-  snapshots: IndexerVlpSnapshot[];
+export interface GetIndexerNlpSnapshotsResponse {
+  snapshots: IndexerNlpSnapshot[];
 }
 
 export interface GetIndexerBacklogResponse {

package/src/types/paginatedEventsTypes.ts

@@ -75,18 +75,18 @@ export type GetIndexerSubaccountCollateralEventsResponse =
   PaginatedIndexerEventsResponse<IndexerCollateralEvent>;
 
 /**
- * VLP
+ * NLP
  */
-export type GetIndexerSubaccountVlpEventsParams =
+export type GetIndexerSubaccountNlpEventsParams =
   BaseSubaccountPaginationParams;
 
-export interface IndexerVlpEvent extends BaseIndexerPaginatedEvent {
-  vlpDelta: BigDecimal;
+export interface IndexerNlpEvent extends BaseIndexerPaginatedEvent {
+  nlpDelta: BigDecimal;
   primaryQuoteDelta: BigDecimal;
 }
 
-export type GetIndexerSubaccountVlpEventsResponse =
-  PaginatedIndexerEventsResponse<IndexerVlpEvent>;
+export type GetIndexerSubaccountNlpEventsResponse =
+  PaginatedIndexerEventsResponse<IndexerNlpEvent>;
 
 /**
  * Match events

package/src/types/serverModelTypes.ts

@@ -254,10 +254,10 @@ export interface IndexerServerLeaderboardRegistration {
 }
 
 /**
- * VLP
+ * NLP
  */
 
-export interface IndexerServerVlpSnapshot {
+export interface IndexerServerNlpSnapshot {
   cumulative_burn_usdc: string;
   cumulative_mint_usdc: string;
   cumulative_pnl: string;

package/src/types/serverTypes.ts

@@ -21,7 +21,7 @@ import {
   IndexerServerProductSnapshot,
   IndexerServerSnapshotsInterval,
   IndexerServerTx,
-  IndexerServerVlpSnapshot,
+  IndexerServerNlpSnapshot,
 } from './serverModelTypes';
 
 /**
@@ -193,7 +193,7 @@ export interface IndexerServerFastWithdrawalSignatureParams {
   idx: number | string;
 }
 
-export interface IndexerServerVlpSnapshotsParams {
+export interface IndexerServerNlpSnapshotsParams {
   interval: IndexerServerSnapshotsInterval;
 }
 
@@ -226,7 +226,7 @@ export interface IndexerServerQueryRequestByType {
   referral_code: IndexerServerReferralCodeParams;
   subaccounts: IndexerServerListSubaccountsParams;
   usdc_price: Record<string, never>;
-  vlp_snapshots: IndexerServerVlpSnapshotsParams;
+  nlp_snapshots: IndexerServerNlpSnapshotsParams;
 }
 
 export type IndexerServerQueryRequestType =
@@ -375,8 +375,8 @@ export interface IndexerServerFastWithdrawalSignatureResponse {
   signatures: string[];
 }
 
-export interface IndexerServerVlpSnapshotsResponse {
-  snapshots: IndexerServerVlpSnapshot[];
+export interface IndexerServerNlpSnapshotsResponse {
+  snapshots: IndexerServerNlpSnapshot[];
 }
 
 export interface IndexerServerBacklogResponse {
@@ -423,5 +423,5 @@ export interface IndexerServerQueryResponseByType {
   referral_code: IndexerServerReferralCodeResponse;
   subaccounts: IndexerServerListSubaccountsResponse;
   usdc_price: IndexerServerUsdcPriceResponse;
-  vlp_snapshots: IndexerServerVlpSnapshotsResponse;
+  nlp_snapshots: IndexerServerNlpSnapshotsResponse;
 }