@nadohq/engine-client 0.1.0-alpha.6 → 0.1.0-alpha.7

package/dist/index.d.cts

@@ -3,8 +3,8 @@ export { EngineBurnNlpParams, EngineCancelAndPlaceParams, EngineCancelOrdersPara
 export { EngineInsuranceResponse, EngineServerAllProductsResponse, EngineServerContractsResponse, EngineServerEdgeAllProductsResponse, EngineServerFeeRatesResponse, EngineServerGetOrderQueryParams, EngineServerHealthGroupsResponse, EngineServerIpBlockResponse, EngineServerIsolatedPosition, EngineServerIsolatedPositionsQueryParams, EngineServerIsolatedPositionsResponse, EngineServerLinkedSignerParams, EngineServerLinkedSignerResponse, EngineServerMarketLiquidityQueryParams, EngineServerMarketLiquidityResponse, EngineServerMarketPrice, EngineServerMarketPriceQueryParams, EngineServerMarketPriceResponse, EngineServerMarketPricesQueryParams, EngineServerMarketPricesResponse, EngineServerMaxMintNlpQueryParams, EngineServerMaxMintNlpResponse, EngineServerMaxOrderSizeQueryParams, EngineServerMaxOrderSizeResponse, EngineServerMaxWithdrawableQueryParams, EngineServerMaxWithdrawableResponse, EngineServerNoncesParams, EngineServerNoncesResponse, EngineServerOrder, EngineServerOrderResponse, EngineServerOrdersQueryParams, EngineServerPriceTickLiquidity, EngineServerProductOrdersResponse, EngineServerQueryFailureResponse, EngineServerQueryRequest, EngineServerQueryRequestByType, EngineServerQueryRequestType, EngineServerQueryResponse, EngineServerQueryResponseByType, EngineServerQuerySuccessResponse, EngineServerStatusResponse, EngineServerSubaccountFeeRatesParams, EngineServerSubaccountInfoQueryParams, EngineServerSubaccountInfoResponse, EngineServerSubaccountOrders, EngineServerSubaccountOrdersQueryParams, EngineServerSubaccountOrdersResponse, EngineServerSymbol, EngineServerSymbolsQueryParams, EngineServerSymbolsResponse, EngineServerTimeResponse, EngineServerValidateOrderQueryParams, EngineServerValidateOrderResponse } from './types/serverQueryTypes.cjs';
 export { EngineServerBookInfo, EngineServerHealthBreakdown, EngineServerPerpBalance, EngineServerPerpBalanceData, EngineServerPerpProduct, EngineServerPerpState, EngineServerProductType, EngineServerRisk, EngineServerSpotBalance, EngineServerSpotBalanceData, EngineServerSpotConfig, EngineServerSpotProduct, EngineServerSpotState } from './types/serverQueryModelTypes.cjs';
 export { EngineServerCancelOrdersParams, EngineServerCancelOrdersResponse, EngineServerExecuteFailureResult, EngineServerExecutePlaceOrderPayload, EngineServerExecuteRequestByType, EngineServerExecuteRequestType, EngineServerExecuteResponseDataByType, EngineServerExecuteResult, EngineServerExecuteSuccessResult, EngineServerPlaceOrderParams, EngineServerPlaceOrderResponse, EngineServerPlaceOrdersResponse, EngineServiceCancelAndPlaceParams } from './types/serverExecuteTypes.cjs';
-export { EngineServerBestBidOfferStreamParams, EngineServerBookDepthStreamParams, EngineServerFillStreamParams, EngineServerOrderUpdateStreamParams, EngineServerPositionChangeStreamParams, EngineServerSubscriptionParams, EngineServerSubscriptionRequest, EngineServerSubscriptionRequestByType, EngineServerSubscriptionRequestType, EngineServerSubscriptionStream, EngineServerSubscriptionStreamParamsByType, EngineServerSubscriptionStreamParamsType, EngineServerTradeStreamParams } from './types/serverSubscriptionTypes.cjs';
-export { EngineServerSubscriptionBestBidOfferEvent, EngineServerSubscriptionBookDepthEvent, EngineServerSubscriptionFillEvent, EngineServerSubscriptionOrderUpdateEvent, EngineServerSubscriptionPositionChangeEvent, EngineServerSubscriptionTradeEvent } from './types/serverSubscriptionEventTypes.cjs';
+export { EngineServerBestBidOfferStreamParams, EngineServerBookDepthStreamParams, EngineServerFillStreamParams, EngineServerFundingPaymentStreamParams, EngineServerLatestCandlestickStreamParams, EngineServerLiquidationStreamParams, EngineServerOrderUpdateStreamParams, EngineServerPositionChangeStreamParams, EngineServerSubscriptionParams, EngineServerSubscriptionRequest, EngineServerSubscriptionRequestByType, EngineServerSubscriptionRequestType, EngineServerSubscriptionStream, EngineServerSubscriptionStreamParamsByType, EngineServerSubscriptionStreamParamsType, EngineServerTradeStreamParams } from './types/serverSubscriptionTypes.cjs';
+export { EngineServerSubscriptionBaseEvent, EngineServerSubscriptionBestBidOfferEvent, EngineServerSubscriptionBookDepthEvent, EngineServerSubscriptionEvent, EngineServerSubscriptionEventType, EngineServerSubscriptionFillEvent, EngineServerSubscriptionFundingPaymentEvent, EngineServerSubscriptionLatestCandlestickEvent, EngineServerSubscriptionLiquidationEvent, EngineServerSubscriptionOrderUpdateEvent, EngineServerSubscriptionPositionChangeEvent, EngineServerSubscriptionTradeEvent, OrderUpdateReason, PositionChangeReason } from './types/serverSubscriptionEventTypes.cjs';
 export { EngineServerFailureError } from './types/EngineServerFailureError.cjs';
 export { EngineClient } from './EngineClient.cjs';
 export { ENGINE_CLIENT_ENDPOINTS, ENGINE_WS_CLIENT_ENDPOINTS, ENGINE_WS_SUBSCRIPTION_CLIENT_ENDPOINTS } from './endpoints.cjs';

package/dist/index.d.ts

@@ -3,8 +3,8 @@ export { EngineBurnNlpParams, EngineCancelAndPlaceParams, EngineCancelOrdersPara
 export { EngineInsuranceResponse, EngineServerAllProductsResponse, EngineServerContractsResponse, EngineServerEdgeAllProductsResponse, EngineServerFeeRatesResponse, EngineServerGetOrderQueryParams, EngineServerHealthGroupsResponse, EngineServerIpBlockResponse, EngineServerIsolatedPosition, EngineServerIsolatedPositionsQueryParams, EngineServerIsolatedPositionsResponse, EngineServerLinkedSignerParams, EngineServerLinkedSignerResponse, EngineServerMarketLiquidityQueryParams, EngineServerMarketLiquidityResponse, EngineServerMarketPrice, EngineServerMarketPriceQueryParams, EngineServerMarketPriceResponse, EngineServerMarketPricesQueryParams, EngineServerMarketPricesResponse, EngineServerMaxMintNlpQueryParams, EngineServerMaxMintNlpResponse, EngineServerMaxOrderSizeQueryParams, EngineServerMaxOrderSizeResponse, EngineServerMaxWithdrawableQueryParams, EngineServerMaxWithdrawableResponse, EngineServerNoncesParams, EngineServerNoncesResponse, EngineServerOrder, EngineServerOrderResponse, EngineServerOrdersQueryParams, EngineServerPriceTickLiquidity, EngineServerProductOrdersResponse, EngineServerQueryFailureResponse, EngineServerQueryRequest, EngineServerQueryRequestByType, EngineServerQueryRequestType, EngineServerQueryResponse, EngineServerQueryResponseByType, EngineServerQuerySuccessResponse, EngineServerStatusResponse, EngineServerSubaccountFeeRatesParams, EngineServerSubaccountInfoQueryParams, EngineServerSubaccountInfoResponse, EngineServerSubaccountOrders, EngineServerSubaccountOrdersQueryParams, EngineServerSubaccountOrdersResponse, EngineServerSymbol, EngineServerSymbolsQueryParams, EngineServerSymbolsResponse, EngineServerTimeResponse, EngineServerValidateOrderQueryParams, EngineServerValidateOrderResponse } from './types/serverQueryTypes.js';
 export { EngineServerBookInfo, EngineServerHealthBreakdown, EngineServerPerpBalance, EngineServerPerpBalanceData, EngineServerPerpProduct, EngineServerPerpState, EngineServerProductType, EngineServerRisk, EngineServerSpotBalance, EngineServerSpotBalanceData, EngineServerSpotConfig, EngineServerSpotProduct, EngineServerSpotState } from './types/serverQueryModelTypes.js';
 export { EngineServerCancelOrdersParams, EngineServerCancelOrdersResponse, EngineServerExecuteFailureResult, EngineServerExecutePlaceOrderPayload, EngineServerExecuteRequestByType, EngineServerExecuteRequestType, EngineServerExecuteResponseDataByType, EngineServerExecuteResult, EngineServerExecuteSuccessResult, EngineServerPlaceOrderParams, EngineServerPlaceOrderResponse, EngineServerPlaceOrdersResponse, EngineServiceCancelAndPlaceParams } from './types/serverExecuteTypes.js';
-export { EngineServerBestBidOfferStreamParams, EngineServerBookDepthStreamParams, EngineServerFillStreamParams, EngineServerOrderUpdateStreamParams, EngineServerPositionChangeStreamParams, EngineServerSubscriptionParams, EngineServerSubscriptionRequest, EngineServerSubscriptionRequestByType, EngineServerSubscriptionRequestType, EngineServerSubscriptionStream, EngineServerSubscriptionStreamParamsByType, EngineServerSubscriptionStreamParamsType, EngineServerTradeStreamParams } from './types/serverSubscriptionTypes.js';
-export { EngineServerSubscriptionBestBidOfferEvent, EngineServerSubscriptionBookDepthEvent, EngineServerSubscriptionFillEvent, EngineServerSubscriptionOrderUpdateEvent, EngineServerSubscriptionPositionChangeEvent, EngineServerSubscriptionTradeEvent } from './types/serverSubscriptionEventTypes.js';
+export { EngineServerBestBidOfferStreamParams, EngineServerBookDepthStreamParams, EngineServerFillStreamParams, EngineServerFundingPaymentStreamParams, EngineServerLatestCandlestickStreamParams, EngineServerLiquidationStreamParams, EngineServerOrderUpdateStreamParams, EngineServerPositionChangeStreamParams, EngineServerSubscriptionParams, EngineServerSubscriptionRequest, EngineServerSubscriptionRequestByType, EngineServerSubscriptionRequestType, EngineServerSubscriptionStream, EngineServerSubscriptionStreamParamsByType, EngineServerSubscriptionStreamParamsType, EngineServerTradeStreamParams } from './types/serverSubscriptionTypes.js';
+export { EngineServerSubscriptionBaseEvent, EngineServerSubscriptionBestBidOfferEvent, EngineServerSubscriptionBookDepthEvent, EngineServerSubscriptionEvent, EngineServerSubscriptionEventType, EngineServerSubscriptionFillEvent, EngineServerSubscriptionFundingPaymentEvent, EngineServerSubscriptionLatestCandlestickEvent, EngineServerSubscriptionLiquidationEvent, EngineServerSubscriptionOrderUpdateEvent, EngineServerSubscriptionPositionChangeEvent, EngineServerSubscriptionTradeEvent, OrderUpdateReason, PositionChangeReason } from './types/serverSubscriptionEventTypes.js';
 export { EngineServerFailureError } from './types/EngineServerFailureError.js';
 export { EngineClient } from './EngineClient.js';
 export { ENGINE_CLIENT_ENDPOINTS, ENGINE_WS_CLIENT_ENDPOINTS, ENGINE_WS_SUBSCRIPTION_CLIENT_ENDPOINTS } from './endpoints.js';

package/dist/types/index.d.cts

@@ -3,7 +3,7 @@ export { EngineBurnNlpParams, EngineCancelAndPlaceParams, EngineCancelOrdersPara
 export { EngineInsuranceResponse, EngineServerAllProductsResponse, EngineServerContractsResponse, EngineServerEdgeAllProductsResponse, EngineServerFeeRatesResponse, EngineServerGetOrderQueryParams, EngineServerHealthGroupsResponse, EngineServerIpBlockResponse, EngineServerIsolatedPosition, EngineServerIsolatedPositionsQueryParams, EngineServerIsolatedPositionsResponse, EngineServerLinkedSignerParams, EngineServerLinkedSignerResponse, EngineServerMarketLiquidityQueryParams, EngineServerMarketLiquidityResponse, EngineServerMarketPrice, EngineServerMarketPriceQueryParams, EngineServerMarketPriceResponse, EngineServerMarketPricesQueryParams, EngineServerMarketPricesResponse, EngineServerMaxMintNlpQueryParams, EngineServerMaxMintNlpResponse, EngineServerMaxOrderSizeQueryParams, EngineServerMaxOrderSizeResponse, EngineServerMaxWithdrawableQueryParams, EngineServerMaxWithdrawableResponse, EngineServerNoncesParams, EngineServerNoncesResponse, EngineServerOrder, EngineServerOrderResponse, EngineServerOrdersQueryParams, EngineServerPriceTickLiquidity, EngineServerProductOrdersResponse, EngineServerQueryFailureResponse, EngineServerQueryRequest, EngineServerQueryRequestByType, EngineServerQueryRequestType, EngineServerQueryResponse, EngineServerQueryResponseByType, EngineServerQuerySuccessResponse, EngineServerStatusResponse, EngineServerSubaccountFeeRatesParams, EngineServerSubaccountInfoQueryParams, EngineServerSubaccountInfoResponse, EngineServerSubaccountOrders, EngineServerSubaccountOrdersQueryParams, EngineServerSubaccountOrdersResponse, EngineServerSymbol, EngineServerSymbolsQueryParams, EngineServerSymbolsResponse, EngineServerTimeResponse, EngineServerValidateOrderQueryParams, EngineServerValidateOrderResponse } from './serverQueryTypes.cjs';
 export { EngineServerBookInfo, EngineServerHealthBreakdown, EngineServerPerpBalance, EngineServerPerpBalanceData, EngineServerPerpProduct, EngineServerPerpState, EngineServerProductType, EngineServerRisk, EngineServerSpotBalance, EngineServerSpotBalanceData, EngineServerSpotConfig, EngineServerSpotProduct, EngineServerSpotState } from './serverQueryModelTypes.cjs';
 export { EngineServerCancelOrdersParams, EngineServerCancelOrdersResponse, EngineServerExecuteFailureResult, EngineServerExecutePlaceOrderPayload, EngineServerExecuteRequestByType, EngineServerExecuteRequestType, EngineServerExecuteResponseDataByType, EngineServerExecuteResult, EngineServerExecuteSuccessResult, EngineServerPlaceOrderParams, EngineServerPlaceOrderResponse, EngineServerPlaceOrdersResponse, EngineServiceCancelAndPlaceParams } from './serverExecuteTypes.cjs';
-export { EngineServerBestBidOfferStreamParams, EngineServerBookDepthStreamParams, EngineServerFillStreamParams, EngineServerOrderUpdateStreamParams, EngineServerPositionChangeStreamParams, EngineServerSubscriptionParams, EngineServerSubscriptionRequest, EngineServerSubscriptionRequestByType, EngineServerSubscriptionRequestType, EngineServerSubscriptionStream, EngineServerSubscriptionStreamParamsByType, EngineServerSubscriptionStreamParamsType, EngineServerTradeStreamParams } from './serverSubscriptionTypes.cjs';
-export { EngineServerSubscriptionBestBidOfferEvent, EngineServerSubscriptionBookDepthEvent, EngineServerSubscriptionFillEvent, EngineServerSubscriptionOrderUpdateEvent, EngineServerSubscriptionPositionChangeEvent, EngineServerSubscriptionTradeEvent } from './serverSubscriptionEventTypes.cjs';
+export { EngineServerBestBidOfferStreamParams, EngineServerBookDepthStreamParams, EngineServerFillStreamParams, EngineServerFundingPaymentStreamParams, EngineServerLatestCandlestickStreamParams, EngineServerLiquidationStreamParams, EngineServerOrderUpdateStreamParams, EngineServerPositionChangeStreamParams, EngineServerSubscriptionParams, EngineServerSubscriptionRequest, EngineServerSubscriptionRequestByType, EngineServerSubscriptionRequestType, EngineServerSubscriptionStream, EngineServerSubscriptionStreamParamsByType, EngineServerSubscriptionStreamParamsType, EngineServerTradeStreamParams } from './serverSubscriptionTypes.cjs';
+export { EngineServerSubscriptionBaseEvent, EngineServerSubscriptionBestBidOfferEvent, EngineServerSubscriptionBookDepthEvent, EngineServerSubscriptionEvent, EngineServerSubscriptionEventType, EngineServerSubscriptionFillEvent, EngineServerSubscriptionFundingPaymentEvent, EngineServerSubscriptionLatestCandlestickEvent, EngineServerSubscriptionLiquidationEvent, EngineServerSubscriptionOrderUpdateEvent, EngineServerSubscriptionPositionChangeEvent, EngineServerSubscriptionTradeEvent, OrderUpdateReason, PositionChangeReason } from './serverSubscriptionEventTypes.cjs';
 export { EngineServerFailureError } from './EngineServerFailureError.cjs';
 import '@nadohq/shared';

package/dist/types/index.d.ts

@@ -3,7 +3,7 @@ export { EngineBurnNlpParams, EngineCancelAndPlaceParams, EngineCancelOrdersPara
 export { EngineInsuranceResponse, EngineServerAllProductsResponse, EngineServerContractsResponse, EngineServerEdgeAllProductsResponse, EngineServerFeeRatesResponse, EngineServerGetOrderQueryParams, EngineServerHealthGroupsResponse, EngineServerIpBlockResponse, EngineServerIsolatedPosition, EngineServerIsolatedPositionsQueryParams, EngineServerIsolatedPositionsResponse, EngineServerLinkedSignerParams, EngineServerLinkedSignerResponse, EngineServerMarketLiquidityQueryParams, EngineServerMarketLiquidityResponse, EngineServerMarketPrice, EngineServerMarketPriceQueryParams, EngineServerMarketPriceResponse, EngineServerMarketPricesQueryParams, EngineServerMarketPricesResponse, EngineServerMaxMintNlpQueryParams, EngineServerMaxMintNlpResponse, EngineServerMaxOrderSizeQueryParams, EngineServerMaxOrderSizeResponse, EngineServerMaxWithdrawableQueryParams, EngineServerMaxWithdrawableResponse, EngineServerNoncesParams, EngineServerNoncesResponse, EngineServerOrder, EngineServerOrderResponse, EngineServerOrdersQueryParams, EngineServerPriceTickLiquidity, EngineServerProductOrdersResponse, EngineServerQueryFailureResponse, EngineServerQueryRequest, EngineServerQueryRequestByType, EngineServerQueryRequestType, EngineServerQueryResponse, EngineServerQueryResponseByType, EngineServerQuerySuccessResponse, EngineServerStatusResponse, EngineServerSubaccountFeeRatesParams, EngineServerSubaccountInfoQueryParams, EngineServerSubaccountInfoResponse, EngineServerSubaccountOrders, EngineServerSubaccountOrdersQueryParams, EngineServerSubaccountOrdersResponse, EngineServerSymbol, EngineServerSymbolsQueryParams, EngineServerSymbolsResponse, EngineServerTimeResponse, EngineServerValidateOrderQueryParams, EngineServerValidateOrderResponse } from './serverQueryTypes.js';
 export { EngineServerBookInfo, EngineServerHealthBreakdown, EngineServerPerpBalance, EngineServerPerpBalanceData, EngineServerPerpProduct, EngineServerPerpState, EngineServerProductType, EngineServerRisk, EngineServerSpotBalance, EngineServerSpotBalanceData, EngineServerSpotConfig, EngineServerSpotProduct, EngineServerSpotState } from './serverQueryModelTypes.js';
 export { EngineServerCancelOrdersParams, EngineServerCancelOrdersResponse, EngineServerExecuteFailureResult, EngineServerExecutePlaceOrderPayload, EngineServerExecuteRequestByType, EngineServerExecuteRequestType, EngineServerExecuteResponseDataByType, EngineServerExecuteResult, EngineServerExecuteSuccessResult, EngineServerPlaceOrderParams, EngineServerPlaceOrderResponse, EngineServerPlaceOrdersResponse, EngineServiceCancelAndPlaceParams } from './serverExecuteTypes.js';
-export { EngineServerBestBidOfferStreamParams, EngineServerBookDepthStreamParams, EngineServerFillStreamParams, EngineServerOrderUpdateStreamParams, EngineServerPositionChangeStreamParams, EngineServerSubscriptionParams, EngineServerSubscriptionRequest, EngineServerSubscriptionRequestByType, EngineServerSubscriptionRequestType, EngineServerSubscriptionStream, EngineServerSubscriptionStreamParamsByType, EngineServerSubscriptionStreamParamsType, EngineServerTradeStreamParams } from './serverSubscriptionTypes.js';
-export { EngineServerSubscriptionBestBidOfferEvent, EngineServerSubscriptionBookDepthEvent, EngineServerSubscriptionFillEvent, EngineServerSubscriptionOrderUpdateEvent, EngineServerSubscriptionPositionChangeEvent, EngineServerSubscriptionTradeEvent } from './serverSubscriptionEventTypes.js';
+export { EngineServerBestBidOfferStreamParams, EngineServerBookDepthStreamParams, EngineServerFillStreamParams, EngineServerFundingPaymentStreamParams, EngineServerLatestCandlestickStreamParams, EngineServerLiquidationStreamParams, EngineServerOrderUpdateStreamParams, EngineServerPositionChangeStreamParams, EngineServerSubscriptionParams, EngineServerSubscriptionRequest, EngineServerSubscriptionRequestByType, EngineServerSubscriptionRequestType, EngineServerSubscriptionStream, EngineServerSubscriptionStreamParamsByType, EngineServerSubscriptionStreamParamsType, EngineServerTradeStreamParams } from './serverSubscriptionTypes.js';
+export { EngineServerSubscriptionBaseEvent, EngineServerSubscriptionBestBidOfferEvent, EngineServerSubscriptionBookDepthEvent, EngineServerSubscriptionEvent, EngineServerSubscriptionEventType, EngineServerSubscriptionFillEvent, EngineServerSubscriptionFundingPaymentEvent, EngineServerSubscriptionLatestCandlestickEvent, EngineServerSubscriptionLiquidationEvent, EngineServerSubscriptionOrderUpdateEvent, EngineServerSubscriptionPositionChangeEvent, EngineServerSubscriptionTradeEvent, OrderUpdateReason, PositionChangeReason } from './serverSubscriptionEventTypes.js';
 export { EngineServerFailureError } from './EngineServerFailureError.js';
 import '@nadohq/shared';

package/dist/types/serverSubscriptionEventTypes.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/serverSubscriptionEventTypes.ts"],"sourcesContent":["import { EngineServerPriceTickLiquidity } from './serverQueryTypes';\n\n/**\n * Event from subscribing to a `order_update` stream.\n */\nexport interface EngineServerSubscriptionOrderUpdateEvent {\n  timestamp: string;\n  product_id: number;\n  digest: string;\n  amount: string;\n  reason: string;\n}\n\n/**\n * Event from subscribing to a `trade` stream.\n */\nexport interface EngineServerSubscriptionTradeEvent {\n  timestamp: string;\n  product_id: number;\n  price: string;\n  taker_qty: string;\n  maker_qty: string;\n  is_taker_buyer: boolean;\n}\n\n/**\n * Event from subscribing to a `best_bid_offer` stream.\n */\nexport interface EngineServerSubscriptionBestBidOfferEvent {\n  timestamp: string;\n  product_id: number;\n  bid_price: string;\n  bid_qty: string;\n  ask_price: string;\n  ask_qty: string;\n}\n\n/**\n * Event from subscribing to a `fill` stream.\n */\nexport interface EngineServerSubscriptionFillEvent {\n  // NOTE: `id` is excluded from the response to avoid parsing issues.\n  // type of `id` on the backend is `u64` which can overflow until we introduce proper parsing on the SDK.\n  timestamp: string;\n  product_id: number;\n  subaccount: string;\n  order_digest: string;\n  filled_qty: string;\n  remaining_qty: string;\n  price: string;\n  is_taker: boolean;\n}\n\n/**\n * Event from subscribing to a `position_change` stream.\n */\nexport interface EngineServerSubscriptionPositionChangeEvent {\n  timestamp: string;\n  product_id: number;\n  subaccount: string;\n  amount: string;\n  v_quote_amount: string;\n}\n\n/**\n * Event from subscribing to a `book_depth` stream.\n */\nexport interface EngineServerSubscriptionBookDepthEvent {\n  min_timestamp: string;\n  max_timestamp: string;\n  product_id: number;\n  bids: EngineServerPriceTickLiquidity[];\n  asks: EngineServerPriceTickLiquidity[];\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/types/serverSubscriptionEventTypes.ts"],"sourcesContent":["import { EngineServerPriceTickLiquidity } from './serverQueryTypes';\n\n/**\n * Reasons that can trigger position change events.\n */\nexport type PositionChangeReason =\n  | 'deposit_collateral'\n  | 'match_orders'\n  | 'withdraw_collateral'\n  | 'transfer_quote'\n  | 'settle_pnl'\n  | 'mint_nlp'\n  | 'burn_nlp'\n  | 'liquidate_subaccount';\n\n/**\n * Possible reasons for order updates.\n */\nexport type OrderUpdateReason = 'cancelled' | 'filled' | 'placed';\n\nexport type EngineServerSubscriptionEventType =\n  | 'trade'\n  | 'best_bid_offer'\n  | 'book_depth'\n  | 'fill'\n  | 'position_change'\n  | 'order_update'\n  | 'liquidation'\n  | 'latest_candlestick'\n  | 'funding_payment';\n\nexport interface EngineServerSubscriptionBaseEvent<\n  T extends\n    EngineServerSubscriptionEventType = EngineServerSubscriptionEventType,\n> {\n  type: T;\n  product_id: number;\n}\n\n/**\n * Event from subscribing to a `trade` stream.\n */\nexport interface EngineServerSubscriptionTradeEvent\n  extends EngineServerSubscriptionBaseEvent<'trade'> {\n  timestamp: string;\n  price: string;\n  taker_qty: string;\n  maker_qty: string;\n  is_taker_buyer: boolean;\n}\n\n/**\n * Event from subscribing to a `best_bid_offer` stream.\n */\nexport interface EngineServerSubscriptionBestBidOfferEvent\n  extends EngineServerSubscriptionBaseEvent<'best_bid_offer'> {\n  timestamp: string;\n  bid_price: string;\n  bid_qty: string;\n  ask_price: string;\n  ask_qty: string;\n}\n\n/**\n * Event from subscribing to a `book_depth` stream.\n */\nexport interface EngineServerSubscriptionBookDepthEvent\n  extends EngineServerSubscriptionBaseEvent<'book_depth'> {\n  last_max_timestamp: string;\n  min_timestamp: string;\n  max_timestamp: string;\n  bids: EngineServerPriceTickLiquidity[];\n  asks: EngineServerPriceTickLiquidity[];\n}\n\n/**\n * Event from subscribing to a `fill` stream.\n */\nexport interface EngineServerSubscriptionFillEvent\n  extends EngineServerSubscriptionBaseEvent<'fill'> {\n  // NOTE: `id` is excluded from the response to avoid parsing issues.\n  // type of `id` on the backend is `u64` which can overflow until we introduce proper parsing on the SDK.\n  timestamp: string;\n  subaccount: string;\n  order_digest: string;\n  filled_qty: string;\n  remaining_qty: string;\n  original_qty: string;\n  price: string;\n  is_taker: boolean;\n  is_bid: boolean;\n  fee: string;\n  submission_idx: string;\n}\n\n/**\n * Event from subscribing to a `position_change` stream.\n */\nexport interface EngineServerSubscriptionPositionChangeEvent\n  extends EngineServerSubscriptionBaseEvent<'position_change'> {\n  timestamp: string;\n  subaccount: string;\n  amount: string;\n  /** Zero for everything except perps */\n  v_quote_amount: string;\n  reason: PositionChangeReason;\n}\n\n/**\n * Event from subscribing to an `order_update` stream.\n */\nexport interface EngineServerSubscriptionOrderUpdateEvent\n  extends EngineServerSubscriptionBaseEvent<'order_update'> {\n  timestamp: string;\n  digest: string;\n  amount: string;\n  reason: OrderUpdateReason;\n}\n\n/**\n * Event from subscribing to a `liquidation` stream.\n */\nexport interface EngineServerSubscriptionLiquidationEvent\n  extends EngineServerSubscriptionBaseEvent<'liquidation'> {\n  timestamp: string;\n  /** Single element for regular liquidations, two elements for spread liquidations [spotId, perpId] */\n  product_ids: number[];\n  liquidator: string;\n  liquidatee: string;\n  /** Amount liquidated (positive for long, negative for short) */\n  amount: string;\n  /** Price at which liquidation occurred */\n  price: string;\n}\n\n/**\n * Event from subscribing to a `latest_candlestick` stream.\n */\nexport interface EngineServerSubscriptionLatestCandlestickEvent\n  extends EngineServerSubscriptionBaseEvent<'latest_candlestick'> {\n  timestamp: string;\n  granularity: number;\n  open_x18: string;\n  high_x18: string;\n  low_x18: string;\n  close_x18: string;\n  volume: string;\n}\n\n/**\n * Event from subscribing to a `funding_payment` stream.\n */\nexport interface EngineServerSubscriptionFundingPaymentEvent\n  extends EngineServerSubscriptionBaseEvent<'funding_payment'> {\n  timestamp: string;\n  /** Funding payment amount (positive = receive, negative = pay) */\n  payment_amount: string;\n  /** Open interest at time of funding */\n  open_interest: string;\n  /** Current cumulative funding values */\n  cumulative_funding_long_x18: string;\n  cumulative_funding_short_x18: string;\n  /** Time delta over which the funding payment was calculated */\n  dt: string;\n}\n\n/**\n * Union type for all engine server subscription events.\n */\nexport type EngineServerSubscriptionEvent =\n  | EngineServerSubscriptionTradeEvent\n  | EngineServerSubscriptionBestBidOfferEvent\n  | EngineServerSubscriptionBookDepthEvent\n  | EngineServerSubscriptionFillEvent\n  | EngineServerSubscriptionPositionChangeEvent\n  | EngineServerSubscriptionOrderUpdateEvent\n  | EngineServerSubscriptionLiquidationEvent\n  | EngineServerSubscriptionLatestCandlestickEvent\n  | EngineServerSubscriptionFundingPaymentEvent;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/serverSubscriptionEventTypes.d.cts

@@ -3,21 +3,23 @@ import '@nadohq/shared';
 import './serverQueryModelTypes.cjs';
 
 /**
- * Event from subscribing to a `order_update` stream.
+ * Reasons that can trigger position change events.
  */
-interface EngineServerSubscriptionOrderUpdateEvent {
-    timestamp: string;
+type PositionChangeReason = 'deposit_collateral' | 'match_orders' | 'withdraw_collateral' | 'transfer_quote' | 'settle_pnl' | 'mint_nlp' | 'burn_nlp' | 'liquidate_subaccount';
+/**
+ * Possible reasons for order updates.
+ */
+type OrderUpdateReason = 'cancelled' | 'filled' | 'placed';
+type EngineServerSubscriptionEventType = 'trade' | 'best_bid_offer' | 'book_depth' | 'fill' | 'position_change' | 'order_update' | 'liquidation' | 'latest_candlestick' | 'funding_payment';
+interface EngineServerSubscriptionBaseEvent<T extends EngineServerSubscriptionEventType = EngineServerSubscriptionEventType> {
+    type: T;
     product_id: number;
-    digest: string;
-    amount: string;
-    reason: string;
 }
 /**
  * Event from subscribing to a `trade` stream.
  */
-interface EngineServerSubscriptionTradeEvent {
+interface EngineServerSubscriptionTradeEvent extends EngineServerSubscriptionBaseEvent<'trade'> {
     timestamp: string;
-    product_id: number;
     price: string;
     taker_qty: string;
     maker_qty: string;
@@ -26,46 +28,103 @@ interface EngineServerSubscriptionTradeEvent {
 /**
  * Event from subscribing to a `best_bid_offer` stream.
  */
-interface EngineServerSubscriptionBestBidOfferEvent {
+interface EngineServerSubscriptionBestBidOfferEvent extends EngineServerSubscriptionBaseEvent<'best_bid_offer'> {
     timestamp: string;
-    product_id: number;
     bid_price: string;
     bid_qty: string;
     ask_price: string;
     ask_qty: string;
 }
+/**
+ * Event from subscribing to a `book_depth` stream.
+ */
+interface EngineServerSubscriptionBookDepthEvent extends EngineServerSubscriptionBaseEvent<'book_depth'> {
+    last_max_timestamp: string;
+    min_timestamp: string;
+    max_timestamp: string;
+    bids: EngineServerPriceTickLiquidity[];
+    asks: EngineServerPriceTickLiquidity[];
+}
 /**
  * Event from subscribing to a `fill` stream.
  */
-interface EngineServerSubscriptionFillEvent {
+interface EngineServerSubscriptionFillEvent extends EngineServerSubscriptionBaseEvent<'fill'> {
     timestamp: string;
-    product_id: number;
     subaccount: string;
     order_digest: string;
     filled_qty: string;
     remaining_qty: string;
+    original_qty: string;
     price: string;
     is_taker: boolean;
+    is_bid: boolean;
+    fee: string;
+    submission_idx: string;
 }
 /**
  * Event from subscribing to a `position_change` stream.
  */
-interface EngineServerSubscriptionPositionChangeEvent {
+interface EngineServerSubscriptionPositionChangeEvent extends EngineServerSubscriptionBaseEvent<'position_change'> {
     timestamp: string;
-    product_id: number;
     subaccount: string;
     amount: string;
+    /** Zero for everything except perps */
     v_quote_amount: string;
+    reason: PositionChangeReason;
 }
 /**
- * Event from subscribing to a `book_depth` stream.
+ * Event from subscribing to an `order_update` stream.
  */
-interface EngineServerSubscriptionBookDepthEvent {
-    min_timestamp: string;
-    max_timestamp: string;
-    product_id: number;
-    bids: EngineServerPriceTickLiquidity[];
-    asks: EngineServerPriceTickLiquidity[];
+interface EngineServerSubscriptionOrderUpdateEvent extends EngineServerSubscriptionBaseEvent<'order_update'> {
+    timestamp: string;
+    digest: string;
+    amount: string;
+    reason: OrderUpdateReason;
+}
+/**
+ * Event from subscribing to a `liquidation` stream.
+ */
+interface EngineServerSubscriptionLiquidationEvent extends EngineServerSubscriptionBaseEvent<'liquidation'> {
+    timestamp: string;
+    /** Single element for regular liquidations, two elements for spread liquidations [spotId, perpId] */
+    product_ids: number[];
+    liquidator: string;
+    liquidatee: string;
+    /** Amount liquidated (positive for long, negative for short) */
+    amount: string;
+    /** Price at which liquidation occurred */
+    price: string;
 }
+/**
+ * Event from subscribing to a `latest_candlestick` stream.
+ */
+interface EngineServerSubscriptionLatestCandlestickEvent extends EngineServerSubscriptionBaseEvent<'latest_candlestick'> {
+    timestamp: string;
+    granularity: number;
+    open_x18: string;
+    high_x18: string;
+    low_x18: string;
+    close_x18: string;
+    volume: string;
+}
+/**
+ * Event from subscribing to a `funding_payment` stream.
+ */
+interface EngineServerSubscriptionFundingPaymentEvent extends EngineServerSubscriptionBaseEvent<'funding_payment'> {
+    timestamp: string;
+    /** Funding payment amount (positive = receive, negative = pay) */
+    payment_amount: string;
+    /** Open interest at time of funding */
+    open_interest: string;
+    /** Current cumulative funding values */
+    cumulative_funding_long_x18: string;
+    cumulative_funding_short_x18: string;
+    /** Time delta over which the funding payment was calculated */
+    dt: string;
+}
+/**
+ * Union type for all engine server subscription events.
+ */
+type EngineServerSubscriptionEvent = EngineServerSubscriptionTradeEvent | EngineServerSubscriptionBestBidOfferEvent | EngineServerSubscriptionBookDepthEvent | EngineServerSubscriptionFillEvent | EngineServerSubscriptionPositionChangeEvent | EngineServerSubscriptionOrderUpdateEvent | EngineServerSubscriptionLiquidationEvent | EngineServerSubscriptionLatestCandlestickEvent | EngineServerSubscriptionFundingPaymentEvent;
 
-export type { EngineServerSubscriptionBestBidOfferEvent, EngineServerSubscriptionBookDepthEvent, EngineServerSubscriptionFillEvent, EngineServerSubscriptionOrderUpdateEvent, EngineServerSubscriptionPositionChangeEvent, EngineServerSubscriptionTradeEvent };
+export type { EngineServerSubscriptionBaseEvent, EngineServerSubscriptionBestBidOfferEvent, EngineServerSubscriptionBookDepthEvent, EngineServerSubscriptionEvent, EngineServerSubscriptionEventType, EngineServerSubscriptionFillEvent, EngineServerSubscriptionFundingPaymentEvent, EngineServerSubscriptionLatestCandlestickEvent, EngineServerSubscriptionLiquidationEvent, EngineServerSubscriptionOrderUpdateEvent, EngineServerSubscriptionPositionChangeEvent, EngineServerSubscriptionTradeEvent, OrderUpdateReason, PositionChangeReason };

package/dist/types/serverSubscriptionEventTypes.d.ts

@@ -3,21 +3,23 @@ import '@nadohq/shared';
 import './serverQueryModelTypes.js';
 
 /**
- * Event from subscribing to a `order_update` stream.
+ * Reasons that can trigger position change events.
  */
-interface EngineServerSubscriptionOrderUpdateEvent {
-    timestamp: string;
+type PositionChangeReason = 'deposit_collateral' | 'match_orders' | 'withdraw_collateral' | 'transfer_quote' | 'settle_pnl' | 'mint_nlp' | 'burn_nlp' | 'liquidate_subaccount';
+/**
+ * Possible reasons for order updates.
+ */
+type OrderUpdateReason = 'cancelled' | 'filled' | 'placed';
+type EngineServerSubscriptionEventType = 'trade' | 'best_bid_offer' | 'book_depth' | 'fill' | 'position_change' | 'order_update' | 'liquidation' | 'latest_candlestick' | 'funding_payment';
+interface EngineServerSubscriptionBaseEvent<T extends EngineServerSubscriptionEventType = EngineServerSubscriptionEventType> {
+    type: T;
     product_id: number;
-    digest: string;
-    amount: string;
-    reason: string;
 }
 /**
  * Event from subscribing to a `trade` stream.
  */
-interface EngineServerSubscriptionTradeEvent {
+interface EngineServerSubscriptionTradeEvent extends EngineServerSubscriptionBaseEvent<'trade'> {
     timestamp: string;
-    product_id: number;
     price: string;
     taker_qty: string;
     maker_qty: string;
@@ -26,46 +28,103 @@ interface EngineServerSubscriptionTradeEvent {
 /**
  * Event from subscribing to a `best_bid_offer` stream.
  */
-interface EngineServerSubscriptionBestBidOfferEvent {
+interface EngineServerSubscriptionBestBidOfferEvent extends EngineServerSubscriptionBaseEvent<'best_bid_offer'> {
     timestamp: string;
-    product_id: number;
     bid_price: string;
     bid_qty: string;
     ask_price: string;
     ask_qty: string;
 }
+/**
+ * Event from subscribing to a `book_depth` stream.
+ */
+interface EngineServerSubscriptionBookDepthEvent extends EngineServerSubscriptionBaseEvent<'book_depth'> {
+    last_max_timestamp: string;
+    min_timestamp: string;
+    max_timestamp: string;
+    bids: EngineServerPriceTickLiquidity[];
+    asks: EngineServerPriceTickLiquidity[];
+}
 /**
  * Event from subscribing to a `fill` stream.
  */
-interface EngineServerSubscriptionFillEvent {
+interface EngineServerSubscriptionFillEvent extends EngineServerSubscriptionBaseEvent<'fill'> {
     timestamp: string;
-    product_id: number;
     subaccount: string;
     order_digest: string;
     filled_qty: string;
     remaining_qty: string;
+    original_qty: string;
     price: string;
     is_taker: boolean;
+    is_bid: boolean;
+    fee: string;
+    submission_idx: string;
 }
 /**
  * Event from subscribing to a `position_change` stream.
  */
-interface EngineServerSubscriptionPositionChangeEvent {
+interface EngineServerSubscriptionPositionChangeEvent extends EngineServerSubscriptionBaseEvent<'position_change'> {
     timestamp: string;
-    product_id: number;
     subaccount: string;
     amount: string;
+    /** Zero for everything except perps */
     v_quote_amount: string;
+    reason: PositionChangeReason;
 }
 /**
- * Event from subscribing to a `book_depth` stream.
+ * Event from subscribing to an `order_update` stream.
  */
-interface EngineServerSubscriptionBookDepthEvent {
-    min_timestamp: string;
-    max_timestamp: string;
-    product_id: number;
-    bids: EngineServerPriceTickLiquidity[];
-    asks: EngineServerPriceTickLiquidity[];
+interface EngineServerSubscriptionOrderUpdateEvent extends EngineServerSubscriptionBaseEvent<'order_update'> {
+    timestamp: string;
+    digest: string;
+    amount: string;
+    reason: OrderUpdateReason;
+}
+/**
+ * Event from subscribing to a `liquidation` stream.
+ */
+interface EngineServerSubscriptionLiquidationEvent extends EngineServerSubscriptionBaseEvent<'liquidation'> {
+    timestamp: string;
+    /** Single element for regular liquidations, two elements for spread liquidations [spotId, perpId] */
+    product_ids: number[];
+    liquidator: string;
+    liquidatee: string;
+    /** Amount liquidated (positive for long, negative for short) */
+    amount: string;
+    /** Price at which liquidation occurred */
+    price: string;
 }
+/**
+ * Event from subscribing to a `latest_candlestick` stream.
+ */
+interface EngineServerSubscriptionLatestCandlestickEvent extends EngineServerSubscriptionBaseEvent<'latest_candlestick'> {
+    timestamp: string;
+    granularity: number;
+    open_x18: string;
+    high_x18: string;
+    low_x18: string;
+    close_x18: string;
+    volume: string;
+}
+/**
+ * Event from subscribing to a `funding_payment` stream.
+ */
+interface EngineServerSubscriptionFundingPaymentEvent extends EngineServerSubscriptionBaseEvent<'funding_payment'> {
+    timestamp: string;
+    /** Funding payment amount (positive = receive, negative = pay) */
+    payment_amount: string;
+    /** Open interest at time of funding */
+    open_interest: string;
+    /** Current cumulative funding values */
+    cumulative_funding_long_x18: string;
+    cumulative_funding_short_x18: string;
+    /** Time delta over which the funding payment was calculated */
+    dt: string;
+}
+/**
+ * Union type for all engine server subscription events.
+ */
+type EngineServerSubscriptionEvent = EngineServerSubscriptionTradeEvent | EngineServerSubscriptionBestBidOfferEvent | EngineServerSubscriptionBookDepthEvent | EngineServerSubscriptionFillEvent | EngineServerSubscriptionPositionChangeEvent | EngineServerSubscriptionOrderUpdateEvent | EngineServerSubscriptionLiquidationEvent | EngineServerSubscriptionLatestCandlestickEvent | EngineServerSubscriptionFundingPaymentEvent;
 
-export type { EngineServerSubscriptionBestBidOfferEvent, EngineServerSubscriptionBookDepthEvent, EngineServerSubscriptionFillEvent, EngineServerSubscriptionOrderUpdateEvent, EngineServerSubscriptionPositionChangeEvent, EngineServerSubscriptionTradeEvent };
+export type { EngineServerSubscriptionBaseEvent, EngineServerSubscriptionBestBidOfferEvent, EngineServerSubscriptionBookDepthEvent, EngineServerSubscriptionEvent, EngineServerSubscriptionEventType, EngineServerSubscriptionFillEvent, EngineServerSubscriptionFundingPaymentEvent, EngineServerSubscriptionLatestCandlestickEvent, EngineServerSubscriptionLiquidationEvent, EngineServerSubscriptionOrderUpdateEvent, EngineServerSubscriptionPositionChangeEvent, EngineServerSubscriptionTradeEvent, OrderUpdateReason, PositionChangeReason };

package/dist/types/serverSubscriptionTypes.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/types/serverSubscriptionTypes.ts"],"sourcesContent":["export interface EngineServerOrderUpdateStreamParams {\n  product_id: number;\n  subaccount: string;\n}\n\nexport interface EngineServerTradeStreamParams {\n  product_id: number;\n}\n\nexport interface EngineServerBestBidOfferStreamParams {\n  product_id: number;\n}\n\nexport interface EngineServerFillStreamParams {\n  product_id: number;\n  subaccount: string;\n}\n\nexport interface EngineServerPositionChangeStreamParams {\n  product_id: number;\n  subaccount: string;\n}\n\nexport interface EngineServerBookDepthStreamParams {\n  product_id: number;\n}\n\n/**\n * Available subscription streams\n */\nexport interface EngineServerSubscriptionStreamParamsByType {\n  order_update: EngineServerOrderUpdateStreamParams;\n  trade: EngineServerTradeStreamParams;\n  best_bid_offer: EngineServerBestBidOfferStreamParams;\n  fill: EngineServerFillStreamParams;\n  position_change: EngineServerPositionChangeStreamParams;\n  book_depth: EngineServerBookDepthStreamParams;\n}\n\nexport type EngineServerSubscriptionStreamParamsType =\n  keyof EngineServerSubscriptionStreamParamsByType;\n\n/**\n * Describes a stream that can be subscribed to.\n */\nexport type EngineServerSubscriptionStream<\n  TStreamType extends EngineServerSubscriptionStreamParamsType,\n> = {\n  type: TStreamType;\n} & EngineServerSubscriptionStreamParamsByType[TStreamType];\n\n/**\n * Params to provide to a `subscribe` / `unsubscribe` action.\n */\nexport interface EngineServerSubscriptionParams {\n  stream: EngineServerSubscriptionStream<EngineServerSubscriptionStreamParamsType>;\n}\n\n/**\n * Available actions on the subscription API.\n */\nexport interface EngineServerSubscriptionRequestByType {\n  subscribe: EngineServerSubscriptionParams;\n  unsubscribe: EngineServerSubscriptionParams;\n  list: Record<string, never>;\n}\n\nexport type EngineServerSubscriptionRequestType =\n  keyof EngineServerSubscriptionRequestByType;\n\n/**\n * Top level request to send to the server.\n */\nexport type EngineServerSubscriptionRequest<\n  TRequestType extends EngineServerSubscriptionRequestType,\n> = {\n  id: number;\n  method: TRequestType;\n} & EngineServerSubscriptionRequestByType[TRequestType];\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/types/serverSubscriptionTypes.ts"],"sourcesContent":["export interface EngineServerOrderUpdateStreamParams {\n  product_id: number;\n  subaccount: string;\n}\n\nexport interface EngineServerTradeStreamParams {\n  product_id: number;\n}\n\nexport interface EngineServerBestBidOfferStreamParams {\n  product_id: number;\n}\n\nexport interface EngineServerFillStreamParams {\n  product_id: number;\n  subaccount: string;\n}\n\nexport interface EngineServerPositionChangeStreamParams {\n  /** when not provided, subscribes to all products */\n  product_id?: number;\n  subaccount: string;\n}\n\nexport interface EngineServerBookDepthStreamParams {\n  product_id: number;\n}\n\nexport interface EngineServerLatestCandlestickStreamParams {\n  product_id: number;\n  granularity: number;\n}\n\nexport interface EngineServerLiquidationStreamParams {\n  /** when not provided, subscribes to all products */\n  product_id?: number;\n}\n\nexport interface EngineServerFundingPaymentStreamParams {\n  product_id: number;\n}\n\n/**\n * Available subscription streams\n */\nexport interface EngineServerSubscriptionStreamParamsByType {\n  order_update: EngineServerOrderUpdateStreamParams;\n  trade: EngineServerTradeStreamParams;\n  best_bid_offer: EngineServerBestBidOfferStreamParams;\n  fill: EngineServerFillStreamParams;\n  position_change: EngineServerPositionChangeStreamParams;\n  book_depth: EngineServerBookDepthStreamParams;\n  liquidation: EngineServerLiquidationStreamParams;\n  latest_candlestick: EngineServerLatestCandlestickStreamParams;\n  funding_payment: EngineServerFundingPaymentStreamParams;\n}\n\nexport type EngineServerSubscriptionStreamParamsType =\n  keyof EngineServerSubscriptionStreamParamsByType;\n\n/**\n * Describes a stream that can be subscribed to.\n */\nexport type EngineServerSubscriptionStream<\n  TStreamType extends EngineServerSubscriptionStreamParamsType,\n> = {\n  type: TStreamType;\n} & EngineServerSubscriptionStreamParamsByType[TStreamType];\n\n/**\n * Params to provide to a `subscribe` / `unsubscribe` action.\n */\nexport interface EngineServerSubscriptionParams {\n  stream: EngineServerSubscriptionStream<EngineServerSubscriptionStreamParamsType>;\n}\n\n/**\n * Available actions on the subscription API.\n */\nexport interface EngineServerSubscriptionRequestByType {\n  subscribe: EngineServerSubscriptionParams;\n  unsubscribe: EngineServerSubscriptionParams;\n  list: Record<string, never>;\n}\n\nexport type EngineServerSubscriptionRequestType =\n  keyof EngineServerSubscriptionRequestByType;\n\n/**\n * Top level request to send to the server.\n */\nexport type EngineServerSubscriptionRequest<\n  TRequestType extends EngineServerSubscriptionRequestType,\n> = {\n  id: number;\n  method: TRequestType;\n} & EngineServerSubscriptionRequestByType[TRequestType];\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/serverSubscriptionTypes.d.cts

@@ -13,12 +13,24 @@ interface EngineServerFillStreamParams {
     subaccount: string;
 }
 interface EngineServerPositionChangeStreamParams {
-    product_id: number;
+    /** when not provided, subscribes to all products */
+    product_id?: number;
     subaccount: string;
 }
 interface EngineServerBookDepthStreamParams {
     product_id: number;
 }
+interface EngineServerLatestCandlestickStreamParams {
+    product_id: number;
+    granularity: number;
+}
+interface EngineServerLiquidationStreamParams {
+    /** when not provided, subscribes to all products */
+    product_id?: number;
+}
+interface EngineServerFundingPaymentStreamParams {
+    product_id: number;
+}
 /**
  * Available subscription streams
  */
@@ -29,6 +41,9 @@ interface EngineServerSubscriptionStreamParamsByType {
     fill: EngineServerFillStreamParams;
     position_change: EngineServerPositionChangeStreamParams;
     book_depth: EngineServerBookDepthStreamParams;
+    liquidation: EngineServerLiquidationStreamParams;
+    latest_candlestick: EngineServerLatestCandlestickStreamParams;
+    funding_payment: EngineServerFundingPaymentStreamParams;
 }
 type EngineServerSubscriptionStreamParamsType = keyof EngineServerSubscriptionStreamParamsByType;
 /**
@@ -60,4 +75,4 @@ type EngineServerSubscriptionRequest<TRequestType extends EngineServerSubscripti
     method: TRequestType;
 } & EngineServerSubscriptionRequestByType[TRequestType];
 
-export type { EngineServerBestBidOfferStreamParams, EngineServerBookDepthStreamParams, EngineServerFillStreamParams, EngineServerOrderUpdateStreamParams, EngineServerPositionChangeStreamParams, EngineServerSubscriptionParams, EngineServerSubscriptionRequest, EngineServerSubscriptionRequestByType, EngineServerSubscriptionRequestType, EngineServerSubscriptionStream, EngineServerSubscriptionStreamParamsByType, EngineServerSubscriptionStreamParamsType, EngineServerTradeStreamParams };
+export type { EngineServerBestBidOfferStreamParams, EngineServerBookDepthStreamParams, EngineServerFillStreamParams, EngineServerFundingPaymentStreamParams, EngineServerLatestCandlestickStreamParams, EngineServerLiquidationStreamParams, EngineServerOrderUpdateStreamParams, EngineServerPositionChangeStreamParams, EngineServerSubscriptionParams, EngineServerSubscriptionRequest, EngineServerSubscriptionRequestByType, EngineServerSubscriptionRequestType, EngineServerSubscriptionStream, EngineServerSubscriptionStreamParamsByType, EngineServerSubscriptionStreamParamsType, EngineServerTradeStreamParams };

package/dist/types/serverSubscriptionTypes.d.ts

@@ -13,12 +13,24 @@ interface EngineServerFillStreamParams {
     subaccount: string;
 }
 interface EngineServerPositionChangeStreamParams {
-    product_id: number;
+    /** when not provided, subscribes to all products */
+    product_id?: number;
     subaccount: string;
 }
 interface EngineServerBookDepthStreamParams {
     product_id: number;
 }
+interface EngineServerLatestCandlestickStreamParams {
+    product_id: number;
+    granularity: number;
+}
+interface EngineServerLiquidationStreamParams {
+    /** when not provided, subscribes to all products */
+    product_id?: number;
+}
+interface EngineServerFundingPaymentStreamParams {
+    product_id: number;
+}
 /**
  * Available subscription streams
  */
@@ -29,6 +41,9 @@ interface EngineServerSubscriptionStreamParamsByType {
     fill: EngineServerFillStreamParams;
     position_change: EngineServerPositionChangeStreamParams;
     book_depth: EngineServerBookDepthStreamParams;
+    liquidation: EngineServerLiquidationStreamParams;
+    latest_candlestick: EngineServerLatestCandlestickStreamParams;
+    funding_payment: EngineServerFundingPaymentStreamParams;
 }
 type EngineServerSubscriptionStreamParamsType = keyof EngineServerSubscriptionStreamParamsByType;
 /**
@@ -60,4 +75,4 @@ type EngineServerSubscriptionRequest<TRequestType extends EngineServerSubscripti
     method: TRequestType;
 } & EngineServerSubscriptionRequestByType[TRequestType];
 
-export type { EngineServerBestBidOfferStreamParams, EngineServerBookDepthStreamParams, EngineServerFillStreamParams, EngineServerOrderUpdateStreamParams, EngineServerPositionChangeStreamParams, EngineServerSubscriptionParams, EngineServerSubscriptionRequest, EngineServerSubscriptionRequestByType, EngineServerSubscriptionRequestType, EngineServerSubscriptionStream, EngineServerSubscriptionStreamParamsByType, EngineServerSubscriptionStreamParamsType, EngineServerTradeStreamParams };
+export type { EngineServerBestBidOfferStreamParams, EngineServerBookDepthStreamParams, EngineServerFillStreamParams, EngineServerFundingPaymentStreamParams, EngineServerLatestCandlestickStreamParams, EngineServerLiquidationStreamParams, EngineServerOrderUpdateStreamParams, EngineServerPositionChangeStreamParams, EngineServerSubscriptionParams, EngineServerSubscriptionRequest, EngineServerSubscriptionRequestByType, EngineServerSubscriptionRequestType, EngineServerSubscriptionStream, EngineServerSubscriptionStreamParamsByType, EngineServerSubscriptionStreamParamsType, EngineServerTradeStreamParams };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nadohq/engine-client",
-  "version": "0.1.0-alpha.6",
+  "version": "0.1.0-alpha.7",
   "type": "module",
   "sideEffects": false,
   "description": "> TODO: description",
@@ -37,7 +37,7 @@
     }
   },
   "dependencies": {
-    "@nadohq/shared": "^0.1.0-alpha.6",
+    "@nadohq/shared": "^0.1.0-alpha.7",
     "axios": "*",
     "ts-mixer": "*"
   },
@@ -47,5 +47,5 @@
   "devDependencies": {
     "viem": "*"
   },
-  "gitHead": "660de2d7026b3ebacd2f17115196f94438bcc8bb"
+  "gitHead": "c6f20e82e8d20e2c7a427b54a1728b6ab8adf058"
 }

package/src/types/serverSubscriptionEventTypes.ts

@@ -1,22 +1,48 @@
 import { EngineServerPriceTickLiquidity } from './serverQueryTypes';
 
 /**
- * Event from subscribing to a `order_update` stream.
+ * Reasons that can trigger position change events.
  */
-export interface EngineServerSubscriptionOrderUpdateEvent {
-  timestamp: string;
+export type PositionChangeReason =
+  | 'deposit_collateral'
+  | 'match_orders'
+  | 'withdraw_collateral'
+  | 'transfer_quote'
+  | 'settle_pnl'
+  | 'mint_nlp'
+  | 'burn_nlp'
+  | 'liquidate_subaccount';
+
+/**
+ * Possible reasons for order updates.
+ */
+export type OrderUpdateReason = 'cancelled' | 'filled' | 'placed';
+
+export type EngineServerSubscriptionEventType =
+  | 'trade'
+  | 'best_bid_offer'
+  | 'book_depth'
+  | 'fill'
+  | 'position_change'
+  | 'order_update'
+  | 'liquidation'
+  | 'latest_candlestick'
+  | 'funding_payment';
+
+export interface EngineServerSubscriptionBaseEvent<
+  T extends
+    EngineServerSubscriptionEventType = EngineServerSubscriptionEventType,
+> {
+  type: T;
   product_id: number;
-  digest: string;
-  amount: string;
-  reason: string;
 }
 
 /**
  * Event from subscribing to a `trade` stream.
  */
-export interface EngineServerSubscriptionTradeEvent {
+export interface EngineServerSubscriptionTradeEvent
+  extends EngineServerSubscriptionBaseEvent<'trade'> {
   timestamp: string;
-  product_id: number;
   price: string;
   taker_qty: string;
   maker_qty: string;
@@ -26,49 +52,128 @@ export interface EngineServerSubscriptionTradeEvent {
 /**
  * Event from subscribing to a `best_bid_offer` stream.
  */
-export interface EngineServerSubscriptionBestBidOfferEvent {
+export interface EngineServerSubscriptionBestBidOfferEvent
+  extends EngineServerSubscriptionBaseEvent<'best_bid_offer'> {
   timestamp: string;
-  product_id: number;
   bid_price: string;
   bid_qty: string;
   ask_price: string;
   ask_qty: string;
 }
 
+/**
+ * Event from subscribing to a `book_depth` stream.
+ */
+export interface EngineServerSubscriptionBookDepthEvent
+  extends EngineServerSubscriptionBaseEvent<'book_depth'> {
+  last_max_timestamp: string;
+  min_timestamp: string;
+  max_timestamp: string;
+  bids: EngineServerPriceTickLiquidity[];
+  asks: EngineServerPriceTickLiquidity[];
+}
+
 /**
  * Event from subscribing to a `fill` stream.
  */
-export interface EngineServerSubscriptionFillEvent {
+export interface EngineServerSubscriptionFillEvent
+  extends EngineServerSubscriptionBaseEvent<'fill'> {
   // NOTE: `id` is excluded from the response to avoid parsing issues.
   // type of `id` on the backend is `u64` which can overflow until we introduce proper parsing on the SDK.
   timestamp: string;
-  product_id: number;
   subaccount: string;
   order_digest: string;
   filled_qty: string;
   remaining_qty: string;
+  original_qty: string;
   price: string;
   is_taker: boolean;
+  is_bid: boolean;
+  fee: string;
+  submission_idx: string;
 }
 
 /**
  * Event from subscribing to a `position_change` stream.
  */
-export interface EngineServerSubscriptionPositionChangeEvent {
+export interface EngineServerSubscriptionPositionChangeEvent
+  extends EngineServerSubscriptionBaseEvent<'position_change'> {
   timestamp: string;
-  product_id: number;
   subaccount: string;
   amount: string;
+  /** Zero for everything except perps */
   v_quote_amount: string;
+  reason: PositionChangeReason;
 }
 
 /**
- * Event from subscribing to a `book_depth` stream.
+ * Event from subscribing to an `order_update` stream.
  */
-export interface EngineServerSubscriptionBookDepthEvent {
-  min_timestamp: string;
-  max_timestamp: string;
-  product_id: number;
-  bids: EngineServerPriceTickLiquidity[];
-  asks: EngineServerPriceTickLiquidity[];
+export interface EngineServerSubscriptionOrderUpdateEvent
+  extends EngineServerSubscriptionBaseEvent<'order_update'> {
+  timestamp: string;
+  digest: string;
+  amount: string;
+  reason: OrderUpdateReason;
 }
+
+/**
+ * Event from subscribing to a `liquidation` stream.
+ */
+export interface EngineServerSubscriptionLiquidationEvent
+  extends EngineServerSubscriptionBaseEvent<'liquidation'> {
+  timestamp: string;
+  /** Single element for regular liquidations, two elements for spread liquidations [spotId, perpId] */
+  product_ids: number[];
+  liquidator: string;
+  liquidatee: string;
+  /** Amount liquidated (positive for long, negative for short) */
+  amount: string;
+  /** Price at which liquidation occurred */
+  price: string;
+}
+
+/**
+ * Event from subscribing to a `latest_candlestick` stream.
+ */
+export interface EngineServerSubscriptionLatestCandlestickEvent
+  extends EngineServerSubscriptionBaseEvent<'latest_candlestick'> {
+  timestamp: string;
+  granularity: number;
+  open_x18: string;
+  high_x18: string;
+  low_x18: string;
+  close_x18: string;
+  volume: string;
+}
+
+/**
+ * Event from subscribing to a `funding_payment` stream.
+ */
+export interface EngineServerSubscriptionFundingPaymentEvent
+  extends EngineServerSubscriptionBaseEvent<'funding_payment'> {
+  timestamp: string;
+  /** Funding payment amount (positive = receive, negative = pay) */
+  payment_amount: string;
+  /** Open interest at time of funding */
+  open_interest: string;
+  /** Current cumulative funding values */
+  cumulative_funding_long_x18: string;
+  cumulative_funding_short_x18: string;
+  /** Time delta over which the funding payment was calculated */
+  dt: string;
+}
+
+/**
+ * Union type for all engine server subscription events.
+ */
+export type EngineServerSubscriptionEvent =
+  | EngineServerSubscriptionTradeEvent
+  | EngineServerSubscriptionBestBidOfferEvent
+  | EngineServerSubscriptionBookDepthEvent
+  | EngineServerSubscriptionFillEvent
+  | EngineServerSubscriptionPositionChangeEvent
+  | EngineServerSubscriptionOrderUpdateEvent
+  | EngineServerSubscriptionLiquidationEvent
+  | EngineServerSubscriptionLatestCandlestickEvent
+  | EngineServerSubscriptionFundingPaymentEvent;

package/src/types/serverSubscriptionTypes.ts

@@ -17,7 +17,8 @@ export interface EngineServerFillStreamParams {
 }
 
 export interface EngineServerPositionChangeStreamParams {
-  product_id: number;
+  /** when not provided, subscribes to all products */
+  product_id?: number;
   subaccount: string;
 }
 
@@ -25,6 +26,20 @@ export interface EngineServerBookDepthStreamParams {
   product_id: number;
 }
 
+export interface EngineServerLatestCandlestickStreamParams {
+  product_id: number;
+  granularity: number;
+}
+
+export interface EngineServerLiquidationStreamParams {
+  /** when not provided, subscribes to all products */
+  product_id?: number;
+}
+
+export interface EngineServerFundingPaymentStreamParams {
+  product_id: number;
+}
+
 /**
  * Available subscription streams
  */
@@ -35,6 +50,9 @@ export interface EngineServerSubscriptionStreamParamsByType {
   fill: EngineServerFillStreamParams;
   position_change: EngineServerPositionChangeStreamParams;
   book_depth: EngineServerBookDepthStreamParams;
+  liquidation: EngineServerLiquidationStreamParams;
+  latest_candlestick: EngineServerLatestCandlestickStreamParams;
+  funding_payment: EngineServerFundingPaymentStreamParams;
 }
 
 export type EngineServerSubscriptionStreamParamsType =