@nadohq/engine-client 0.1.0-alpha.5 → 0.1.0-alpha.51

package/dist/types/serverQueryTypes.d.cts

@@ -1,5 +1,5 @@
 import { HealthStatus } from '@nadohq/shared';
-import { EngineServerProductType, EngineServerSpotProduct, EngineServerPerpProduct, EngineServerSpotBalance, EngineServerPerpBalance, EngineServerHealthBreakdown } from './serverQueryModelTypes.cjs';
+import { EngineServerProductType, EngineServerSpotProduct, EngineServerPerpProduct, EngineServerSpotBalance, EngineServerPerpBalance, EngineServerNlpBalance, EngineServerNlpLockedBalance, EngineServerHealthBreakdown, EngineServerOrder } from './serverQueryModelTypes.cjs';
 
 interface EngineServerNoncesParams {
     address: string;
@@ -14,6 +14,7 @@ interface EngineServerSubaccountInfoQueryParams {
             v_quote_delta: string;
         };
     }>;
+    pre_state?: string;
 }
 interface EngineServerIsolatedPositionsQueryParams {
     subaccount: string;
@@ -63,6 +64,8 @@ interface EngineServerMaxOrderSizeQueryParams {
     direction: 'long' | 'short';
     spot_leverage: string | null;
     reduce_only: string | null;
+    isolated: string | null;
+    borrow_margin: string | null;
 }
 interface EngineServerLinkedSignerParams {
     subaccount: string;
@@ -71,6 +74,12 @@ interface EngineServerMaxMintNlpQueryParams {
     sender: string;
     spot_leverage: string | null;
 }
+interface EngineServerMaxBurnNlpQueryParams {
+    sender: string;
+}
+interface EngineServerNlpLockedBalancesQueryParams {
+    subaccount: string;
+}
 interface EngineServerQueryRequestByType {
     all_products: Record<string, never>;
     contracts: Record<string, never>;
@@ -83,8 +92,11 @@ interface EngineServerQueryRequestByType {
     market_liquidity: EngineServerMarketLiquidityQueryParams;
     market_price: EngineServerMarketPriceQueryParams;
     market_prices: EngineServerMarketPricesQueryParams;
+    max_nlp_burnable: EngineServerMaxBurnNlpQueryParams;
     max_nlp_mintable: EngineServerMaxMintNlpQueryParams;
     max_order_size: EngineServerMaxOrderSizeQueryParams;
+    nlp_locked_balances: EngineServerNlpLockedBalancesQueryParams;
+    nlp_pool_info: Record<string, never>;
     max_withdrawable: EngineServerMaxWithdrawableQueryParams;
     nonces: EngineServerNoncesParams;
     order: EngineServerGetOrderQueryParams;
@@ -110,21 +122,25 @@ interface EngineServerNoncesResponse {
     order_nonce: string;
     tx_nonce: string;
 }
-interface EngineServerSubaccountInfoResponse {
+interface EngineServerSubaccountInfoResponse extends EngineServerSubaccountInfoState {
     exists: boolean;
     subaccount: string;
+    spot_count: number;
+    perp_count: number;
+    spot_products: EngineServerSpotProduct[];
+    perp_products: EngineServerPerpProduct[];
+    /** This is set if request has `pre_state` flag set to 'true' */
+    pre_state: EngineServerSubaccountInfoState | undefined;
+}
+interface EngineServerSubaccountInfoState {
     healths: [
         initial: EngineServerHealthBreakdown,
         maintenance: EngineServerHealthBreakdown,
         unweighted: EngineServerHealthBreakdown
     ];
     health_contributions: string[][];
-    spot_count: number;
-    perp_count: number;
     spot_balances: EngineServerSpotBalance[];
     perp_balances: EngineServerPerpBalance[];
-    spot_products: EngineServerSpotProduct[];
-    perp_products: EngineServerPerpProduct[];
 }
 interface EngineServerIsolatedPosition {
     subaccount: string;
@@ -150,12 +166,12 @@ interface EngineServerSymbol {
     price_increment_x18: string;
     size_increment: string;
     min_size: string;
-    min_depth_x18: string;
-    max_spread_rate_x18: string;
     maker_fee_rate_x18: string;
     taker_fee_rate_x18: string;
     long_weight_initial_x18: string;
     long_weight_maintenance_x18: string;
+    max_open_interest_x18: string | undefined;
+    isolated_only: boolean;
 }
 interface EngineServerSymbolsResponse {
     symbols: Record<string, EngineServerSymbol>;
@@ -192,6 +208,7 @@ interface EngineServerFeeRatesResponse {
     withdraw_sequencer_fees: string[];
     taker_fee_rates_x18: string[];
     maker_fee_rates_x18: string[];
+    fee_tier: number;
 }
 interface EngineServerMarketPrice {
     product_id: number;
@@ -202,19 +219,6 @@ type EngineServerMarketPriceResponse = EngineServerMarketPrice;
 interface EngineServerMarketPricesResponse {
     market_prices: EngineServerMarketPrice[];
 }
-interface EngineServerOrder {
-    product_id: number;
-    sender: string;
-    price_x18: string;
-    amount: string;
-    expiration: string;
-    nonce: string;
-    unfilled_amount: string;
-    digest: string;
-    placed_at: number;
-    order_type: string;
-    appendix: string;
-}
 type EngineServerOrderResponse = EngineServerOrder;
 interface EngineServerValidateOrderResponse {
     product_id: number;
@@ -241,9 +245,28 @@ interface EngineInsuranceResponse {
 interface EngineServerEdgeAllProductsResponse {
     edge_all_products: Record<number, EngineServerAllProductsResponse>;
 }
+interface EngineServerMaxBurnNlpResponse {
+    max_nlp_amount: string;
+}
 interface EngineServerMaxMintNlpResponse {
     max_quote_amount: string;
 }
+interface EngineServerNlpLockedBalancesResponse {
+    balance_locked: EngineServerNlpBalance;
+    balance_unlocked: EngineServerNlpBalance;
+    locked_balances: EngineServerNlpLockedBalance[];
+}
+interface EngineServerNlpPool {
+    pool_id: number;
+    subaccount: string;
+    owner: string;
+    balance_weight_x18: string;
+    subaccount_info: EngineServerSubaccountInfoResponse;
+    open_orders: EngineServerOrder[];
+}
+interface EngineServerNlpPoolInfoResponse {
+    nlp_pools: EngineServerNlpPool[];
+}
 interface EngineServerQueryResponseByType {
     all_products: EngineServerAllProductsResponse;
     contracts: EngineServerContractsResponse;
@@ -256,8 +279,11 @@ interface EngineServerQueryResponseByType {
     market_liquidity: EngineServerMarketLiquidityResponse;
     market_price: EngineServerMarketPriceResponse;
     market_prices: EngineServerMarketPricesResponse;
+    max_nlp_burnable: EngineServerMaxBurnNlpResponse;
     max_nlp_mintable: EngineServerMaxMintNlpResponse;
     max_order_size: EngineServerMaxOrderSizeResponse;
+    nlp_locked_balances: EngineServerNlpLockedBalancesResponse;
+    nlp_pool_info: EngineServerNlpPoolInfoResponse;
     max_withdrawable: EngineServerMaxWithdrawableResponse;
     nonces: EngineServerNoncesResponse;
     order: EngineServerOrderResponse;
@@ -279,4 +305,4 @@ interface EngineServerQueryFailureResponse {
 }
 type EngineServerQueryResponse<TQueryType extends keyof EngineServerQueryResponseByType = EngineServerQueryRequestType> = EngineServerQuerySuccessResponse<TQueryType> | EngineServerQueryFailureResponse;
 
-export type { 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 };
+export type { EngineInsuranceResponse, EngineServerAllProductsResponse, EngineServerContractsResponse, EngineServerEdgeAllProductsResponse, EngineServerFeeRatesResponse, EngineServerGetOrderQueryParams, EngineServerHealthGroupsResponse, EngineServerIpBlockResponse, EngineServerIsolatedPosition, EngineServerIsolatedPositionsQueryParams, EngineServerIsolatedPositionsResponse, EngineServerLinkedSignerParams, EngineServerLinkedSignerResponse, EngineServerMarketLiquidityQueryParams, EngineServerMarketLiquidityResponse, EngineServerMarketPrice, EngineServerMarketPriceQueryParams, EngineServerMarketPriceResponse, EngineServerMarketPricesQueryParams, EngineServerMarketPricesResponse, EngineServerMaxBurnNlpQueryParams, EngineServerMaxBurnNlpResponse, EngineServerMaxMintNlpQueryParams, EngineServerMaxMintNlpResponse, EngineServerMaxOrderSizeQueryParams, EngineServerMaxOrderSizeResponse, EngineServerMaxWithdrawableQueryParams, EngineServerMaxWithdrawableResponse, EngineServerNlpLockedBalancesQueryParams, EngineServerNlpLockedBalancesResponse, EngineServerNlpPool, EngineServerNlpPoolInfoResponse, EngineServerNoncesParams, EngineServerNoncesResponse, EngineServerOrderResponse, EngineServerOrdersQueryParams, EngineServerPriceTickLiquidity, EngineServerProductOrdersResponse, EngineServerQueryFailureResponse, EngineServerQueryRequest, EngineServerQueryRequestByType, EngineServerQueryRequestType, EngineServerQueryResponse, EngineServerQueryResponseByType, EngineServerQuerySuccessResponse, EngineServerStatusResponse, EngineServerSubaccountFeeRatesParams, EngineServerSubaccountInfoQueryParams, EngineServerSubaccountInfoResponse, EngineServerSubaccountInfoState, EngineServerSubaccountOrders, EngineServerSubaccountOrdersQueryParams, EngineServerSubaccountOrdersResponse, EngineServerSymbol, EngineServerSymbolsQueryParams, EngineServerSymbolsResponse, EngineServerTimeResponse, EngineServerValidateOrderQueryParams, EngineServerValidateOrderResponse };

package/dist/types/serverQueryTypes.d.ts

@@ -1,5 +1,5 @@
 import { HealthStatus } from '@nadohq/shared';
-import { EngineServerProductType, EngineServerSpotProduct, EngineServerPerpProduct, EngineServerSpotBalance, EngineServerPerpBalance, EngineServerHealthBreakdown } from './serverQueryModelTypes.js';
+import { EngineServerProductType, EngineServerSpotProduct, EngineServerPerpProduct, EngineServerSpotBalance, EngineServerPerpBalance, EngineServerNlpBalance, EngineServerNlpLockedBalance, EngineServerHealthBreakdown, EngineServerOrder } from './serverQueryModelTypes.js';
 
 interface EngineServerNoncesParams {
     address: string;
@@ -14,6 +14,7 @@ interface EngineServerSubaccountInfoQueryParams {
             v_quote_delta: string;
         };
     }>;
+    pre_state?: string;
 }
 interface EngineServerIsolatedPositionsQueryParams {
     subaccount: string;
@@ -63,6 +64,8 @@ interface EngineServerMaxOrderSizeQueryParams {
     direction: 'long' | 'short';
     spot_leverage: string | null;
     reduce_only: string | null;
+    isolated: string | null;
+    borrow_margin: string | null;
 }
 interface EngineServerLinkedSignerParams {
     subaccount: string;
@@ -71,6 +74,12 @@ interface EngineServerMaxMintNlpQueryParams {
     sender: string;
     spot_leverage: string | null;
 }
+interface EngineServerMaxBurnNlpQueryParams {
+    sender: string;
+}
+interface EngineServerNlpLockedBalancesQueryParams {
+    subaccount: string;
+}
 interface EngineServerQueryRequestByType {
     all_products: Record<string, never>;
     contracts: Record<string, never>;
@@ -83,8 +92,11 @@ interface EngineServerQueryRequestByType {
     market_liquidity: EngineServerMarketLiquidityQueryParams;
     market_price: EngineServerMarketPriceQueryParams;
     market_prices: EngineServerMarketPricesQueryParams;
+    max_nlp_burnable: EngineServerMaxBurnNlpQueryParams;
     max_nlp_mintable: EngineServerMaxMintNlpQueryParams;
     max_order_size: EngineServerMaxOrderSizeQueryParams;
+    nlp_locked_balances: EngineServerNlpLockedBalancesQueryParams;
+    nlp_pool_info: Record<string, never>;
     max_withdrawable: EngineServerMaxWithdrawableQueryParams;
     nonces: EngineServerNoncesParams;
     order: EngineServerGetOrderQueryParams;
@@ -110,21 +122,25 @@ interface EngineServerNoncesResponse {
     order_nonce: string;
     tx_nonce: string;
 }
-interface EngineServerSubaccountInfoResponse {
+interface EngineServerSubaccountInfoResponse extends EngineServerSubaccountInfoState {
     exists: boolean;
     subaccount: string;
+    spot_count: number;
+    perp_count: number;
+    spot_products: EngineServerSpotProduct[];
+    perp_products: EngineServerPerpProduct[];
+    /** This is set if request has `pre_state` flag set to 'true' */
+    pre_state: EngineServerSubaccountInfoState | undefined;
+}
+interface EngineServerSubaccountInfoState {
     healths: [
         initial: EngineServerHealthBreakdown,
         maintenance: EngineServerHealthBreakdown,
         unweighted: EngineServerHealthBreakdown
     ];
     health_contributions: string[][];
-    spot_count: number;
-    perp_count: number;
     spot_balances: EngineServerSpotBalance[];
     perp_balances: EngineServerPerpBalance[];
-    spot_products: EngineServerSpotProduct[];
-    perp_products: EngineServerPerpProduct[];
 }
 interface EngineServerIsolatedPosition {
     subaccount: string;
@@ -150,12 +166,12 @@ interface EngineServerSymbol {
     price_increment_x18: string;
     size_increment: string;
     min_size: string;
-    min_depth_x18: string;
-    max_spread_rate_x18: string;
     maker_fee_rate_x18: string;
     taker_fee_rate_x18: string;
     long_weight_initial_x18: string;
     long_weight_maintenance_x18: string;
+    max_open_interest_x18: string | undefined;
+    isolated_only: boolean;
 }
 interface EngineServerSymbolsResponse {
     symbols: Record<string, EngineServerSymbol>;
@@ -192,6 +208,7 @@ interface EngineServerFeeRatesResponse {
     withdraw_sequencer_fees: string[];
     taker_fee_rates_x18: string[];
     maker_fee_rates_x18: string[];
+    fee_tier: number;
 }
 interface EngineServerMarketPrice {
     product_id: number;
@@ -202,19 +219,6 @@ type EngineServerMarketPriceResponse = EngineServerMarketPrice;
 interface EngineServerMarketPricesResponse {
     market_prices: EngineServerMarketPrice[];
 }
-interface EngineServerOrder {
-    product_id: number;
-    sender: string;
-    price_x18: string;
-    amount: string;
-    expiration: string;
-    nonce: string;
-    unfilled_amount: string;
-    digest: string;
-    placed_at: number;
-    order_type: string;
-    appendix: string;
-}
 type EngineServerOrderResponse = EngineServerOrder;
 interface EngineServerValidateOrderResponse {
     product_id: number;
@@ -241,9 +245,28 @@ interface EngineInsuranceResponse {
 interface EngineServerEdgeAllProductsResponse {
     edge_all_products: Record<number, EngineServerAllProductsResponse>;
 }
+interface EngineServerMaxBurnNlpResponse {
+    max_nlp_amount: string;
+}
 interface EngineServerMaxMintNlpResponse {
     max_quote_amount: string;
 }
+interface EngineServerNlpLockedBalancesResponse {
+    balance_locked: EngineServerNlpBalance;
+    balance_unlocked: EngineServerNlpBalance;
+    locked_balances: EngineServerNlpLockedBalance[];
+}
+interface EngineServerNlpPool {
+    pool_id: number;
+    subaccount: string;
+    owner: string;
+    balance_weight_x18: string;
+    subaccount_info: EngineServerSubaccountInfoResponse;
+    open_orders: EngineServerOrder[];
+}
+interface EngineServerNlpPoolInfoResponse {
+    nlp_pools: EngineServerNlpPool[];
+}
 interface EngineServerQueryResponseByType {
     all_products: EngineServerAllProductsResponse;
     contracts: EngineServerContractsResponse;
@@ -256,8 +279,11 @@ interface EngineServerQueryResponseByType {
     market_liquidity: EngineServerMarketLiquidityResponse;
     market_price: EngineServerMarketPriceResponse;
     market_prices: EngineServerMarketPricesResponse;
+    max_nlp_burnable: EngineServerMaxBurnNlpResponse;
     max_nlp_mintable: EngineServerMaxMintNlpResponse;
     max_order_size: EngineServerMaxOrderSizeResponse;
+    nlp_locked_balances: EngineServerNlpLockedBalancesResponse;
+    nlp_pool_info: EngineServerNlpPoolInfoResponse;
     max_withdrawable: EngineServerMaxWithdrawableResponse;
     nonces: EngineServerNoncesResponse;
     order: EngineServerOrderResponse;
@@ -279,4 +305,4 @@ interface EngineServerQueryFailureResponse {
 }
 type EngineServerQueryResponse<TQueryType extends keyof EngineServerQueryResponseByType = EngineServerQueryRequestType> = EngineServerQuerySuccessResponse<TQueryType> | EngineServerQueryFailureResponse;
 
-export type { 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 };
+export type { EngineInsuranceResponse, EngineServerAllProductsResponse, EngineServerContractsResponse, EngineServerEdgeAllProductsResponse, EngineServerFeeRatesResponse, EngineServerGetOrderQueryParams, EngineServerHealthGroupsResponse, EngineServerIpBlockResponse, EngineServerIsolatedPosition, EngineServerIsolatedPositionsQueryParams, EngineServerIsolatedPositionsResponse, EngineServerLinkedSignerParams, EngineServerLinkedSignerResponse, EngineServerMarketLiquidityQueryParams, EngineServerMarketLiquidityResponse, EngineServerMarketPrice, EngineServerMarketPriceQueryParams, EngineServerMarketPriceResponse, EngineServerMarketPricesQueryParams, EngineServerMarketPricesResponse, EngineServerMaxBurnNlpQueryParams, EngineServerMaxBurnNlpResponse, EngineServerMaxMintNlpQueryParams, EngineServerMaxMintNlpResponse, EngineServerMaxOrderSizeQueryParams, EngineServerMaxOrderSizeResponse, EngineServerMaxWithdrawableQueryParams, EngineServerMaxWithdrawableResponse, EngineServerNlpLockedBalancesQueryParams, EngineServerNlpLockedBalancesResponse, EngineServerNlpPool, EngineServerNlpPoolInfoResponse, EngineServerNoncesParams, EngineServerNoncesResponse, EngineServerOrderResponse, EngineServerOrdersQueryParams, EngineServerPriceTickLiquidity, EngineServerProductOrdersResponse, EngineServerQueryFailureResponse, EngineServerQueryRequest, EngineServerQueryRequestByType, EngineServerQueryRequestType, EngineServerQueryResponse, EngineServerQueryResponseByType, EngineServerQuerySuccessResponse, EngineServerStatusResponse, EngineServerSubaccountFeeRatesParams, EngineServerSubaccountInfoQueryParams, EngineServerSubaccountInfoResponse, EngineServerSubaccountInfoState, EngineServerSubaccountOrders, EngineServerSubaccountOrdersQueryParams, EngineServerSubaccountOrdersResponse, EngineServerSymbol, EngineServerSymbolsQueryParams, EngineServerSymbolsResponse, EngineServerTimeResponse, EngineServerValidateOrderQueryParams, EngineServerValidateOrderResponse };

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 EngineServerSubscriptionEventType =\n    EngineServerSubscriptionEventType,\n> {\n  type: T;\n  product_id: number;\n}\n\n/**\n * Event from subscribing to a `trade` stream.\n */\nexport interface EngineServerSubscriptionTradeEvent 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 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 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 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  appendix: string;\n}\n\n/**\n * Event from subscribing to a `position_change` stream.\n */\nexport interface EngineServerSubscriptionPositionChangeEvent 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   * True if the position change was for an isolated position\n   */\n  isolated: boolean;\n}\n\n/**\n * Event from subscribing to an `order_update` stream.\n */\nexport interface EngineServerSubscriptionOrderUpdateEvent 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 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 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 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,108 @@ 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;
+    appendix: 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;
+    /**
+     * True if the position change was for an isolated position
+     */
+    isolated: boolean;
 }
 /**
- * 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 };