@0xmonaco/types 1.0.74 → 1.0.76

package/dist/websocket/events/market-stats-events.d.ts

@@ -13,8 +13,9 @@
  *
  * Perp-only fields (index/mark price, open interest, funding) are optional and
  * omitted on the wire for spot markets, which have no positions or funding.
- * All numeric quantities are decimal strings except `fundingTimestamp`, which
- * is a millisecond epoch number.
+ * All numeric quantities are decimal strings except `fundingTimestamp` and
+ * `lastFundingTime` (millisecond epoch numbers) and `fundingIntervalSeconds`
+ * (whole seconds).
  */
 /**
  * Market tradability label, derived from the oracle market status. Spot markets
@@ -23,6 +24,10 @@
 export type MarketStatus = "TRADABLE" | "POST_ONLY" | "HALTED" | "NOT_READY" | "UNKNOWN";
 /**
  * Full per-market statistics for the `market_stats:<tradingPairId>` channel.
+ *
+ * `marketStatus` is typed `MarketStatus | (string & {})` for the same reason as
+ * on {@link MarketStatsSummary}: an unrecognized status is passed through
+ * rather than dropping the frame. Match it with a `default` branch.
  */
 export interface MarketStatsData {
     /** Market symbol, e.g. "BTC/USDC" */
@@ -39,10 +44,24 @@ export interface MarketStatsData {
     bestBidPrice?: string;
     /** Best ask price (decimal string) */
     bestAskPrice?: string;
-    /** Open interest (decimal string). Perp-only; omitted for spot. */
+    /**
+     * Open interest (decimal string). Perp-only; omitted for spot, and omitted
+     * (never zero) until the market's open interest is known.
+     */
     openInterest?: string;
-    /** Open interest limit (decimal string). Perp-only; omitted for spot. */
+    /**
+     * The market's gross open-interest cap, in quote (USD) notional (decimal
+     * string). `openInterest` is in base units: multiply it by `markPrice` to
+     * compare. Perp-only; omitted for spot.
+     */
     openInterestLimit?: string;
+    /**
+     * What is left of `openInterestLimit` at the mark, in quote (USD) notional,
+     * never below zero (decimal string). At zero, orders that open exposure are
+     * refused until open interest or the mark falls. Perp-only; omitted for spot,
+     * when there is no mark, and until open interest is known.
+     */
+    openInterestHeadroom?: string;
     /** Last trade price (decimal string) */
     lastTradePrice?: string;
     /** 24h base-token volume (decimal string) */
@@ -71,6 +90,20 @@ export interface MarketStatsData {
     fundingClampSmall?: string;
     /** Live funding cap, upper bound (decimal string). Perp-only; omitted for spot. */
     fundingClampBig?: string;
+    /**
+     * Tradability label, the same value the all-markets summary carries for this
+     * market. Perp markets report any {@link MarketStatus}; spot markets report
+     * `TRADABLE` or `HALTED`. Always present on frames from current servers.
+     */
+    marketStatus?: MarketStatus | (string & {});
+    /** Funding settlement interval in whole seconds. Perp-only; omitted for spot. */
+    fundingIntervalSeconds?: number;
+    /**
+     * When the latest funding window settled, as a millisecond epoch number
+     * (REST `getFundingState` returns the same instant as an RFC 3339 string).
+     * Perp-only; omitted for spot and for a market that has not settled yet.
+     */
+    lastFundingTime?: number;
 }
 /**
  * Per-market statistics event on the `market_stats:<tradingPairId>` channel.
@@ -111,7 +144,10 @@ export interface MarketStatsSummary {
     dailyPriceHigh?: string;
     /** 24h low price (decimal string) */
     dailyPriceLow?: string;
-    /** Open interest (decimal string). Perp-only; omitted for spot. */
+    /**
+     * Open interest (decimal string). Perp-only; omitted for spot, and omitted
+     * (never zero) until the market's open interest is known.
+     */
     openInterest?: string;
     /** Current (last settled) funding rate (decimal string). Perp-only; omitted for spot. */
     currentFundingRate?: string;

package/dist/websocket/events/market-stats-events.js

@@ -13,6 +13,7 @@
  *
  * Perp-only fields (index/mark price, open interest, funding) are optional and
  * omitted on the wire for spot markets, which have no positions or funding.
- * All numeric quantities are decimal strings except `fundingTimestamp`, which
- * is a millisecond epoch number.
+ * All numeric quantities are decimal strings except `fundingTimestamp` and
+ * `lastFundingTime` (millisecond epoch numbers) and `fundingIntervalSeconds`
+ * (whole seconds).
  */

package/dist/websocket/events/orders-events.d.ts

@@ -227,6 +227,21 @@ export interface OrderPlacedEvent extends OrderEvent {
          * spot. Wire: `reduce_only`.
          */
         reduceOnly?: boolean;
+        /**
+         * The fill an edit carried over from the original order (decimal string).
+         * Sent only when the order is a replacement of a partly filled order; its
+         * `quantity` is then the order's total and its `status` is
+         * `PARTIALLY_FILLED`, as REST reports the edited order. Omitted on any
+         * other `OrderPlaced`. Wire: `filled_quantity`.
+         */
+        filledQuantity?: string;
+        /** `filledQuantity` in RAW (integer, base-unit) precision. Wire: `filled_quantity_raw`. */
+        filledQuantityRaw?: string;
+        /**
+         * Average fill price of the carried fill (decimal string). Sent with
+         * `filledQuantity`, omitted otherwise. Wire: `average_fill_price`.
+         */
+        averageFillPrice?: string;
     };
 }
 /**
@@ -311,7 +326,11 @@ export interface OrderMatchedEvent extends OrderEvent {
         tradesCount: number;
         /** Remaining quantity to be filled. */
         remainingQuantity: string;
-        /** Average fill price across all trades. `null` when there is none. */
+        /**
+         * The order's cumulative average fill price, across every fill — those an
+         * edit carried over from the original order included, matching REST.
+         * `null` when there is none. This match's own price is `executionPrice`.
+         */
         averageFillPrice: string | null;
         /** Order status. */
         status: OrderStatus | (string & {});
@@ -345,7 +364,11 @@ export interface OrderPartiallyFilledEvent extends OrderEvent {
         tradesCount?: number;
         /** Remaining quantity (present for both taker and maker) */
         remainingQuantity?: string;
-        /** Average fill price (taker orders only) */
+        /**
+         * The order's cumulative average fill price, on both roles: the average
+         * across every fill of the order (an edit's carried fills included), as
+         * REST reports it — not this trade's price, which is `executionPrice`.
+         */
         averageFillPrice?: string;
         /** Order status (taker orders only) */
         status?: OrderStatus | (string & {});
@@ -439,7 +462,11 @@ export interface OrderFilledEvent extends OrderEvent {
         tradesCount?: number;
         /** Remaining quantity (present for both, should be 0 for filled orders) */
         remainingQuantity?: string;
-        /** Average fill price (taker orders only) */
+        /**
+         * The order's cumulative average fill price, on both roles: the average
+         * across every fill of the order (an edit's carried fills included), as
+         * REST reports it — not this trade's price, which is `executionPrice`.
+         */
         averageFillPrice?: string;
         /** Order status (taker orders only) */
         status?: OrderStatus | (string & {});

package/dist/websocket/events/position-events.d.ts

@@ -141,6 +141,21 @@ export interface PositionEventData {
      * that window, and the frame is the fresher one.
      */
     updatedAt: string;
+    /**
+     * When the position OPENED (ISO 8601): the fill that took its exposure from
+     * zero to non-zero. It never changes for the life of `positionId`, so time
+     * held is now minus `openedAt` while open, and `updatedAt` minus `openedAt`
+     * on a terminal frame. A flip closes the position and opens a new one with
+     * a new `positionId` and its own `openedAt`.
+     *
+     * Absent when the server does not know it — never filled with the time the
+     * frame was sent. A REST read of the same position reports the same
+     * instant, normally to within one matching-engine step; after a server
+     * restart it can move by the server's own clock drift. Clamp a computed time
+     * held at zero. Not versioned: take it from the newest payload (frame or
+     * REST read) rather than skipping it on an equal `version`.
+     */
+    openedAt?: string;
     /**
      * Opaque, non-negative producer-owned row version for this position
      * (0XM-2673). Compare only within the same `positionId`; higher is newer.

package/dist/websocket/events/position-valuation-events.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Position Valuation WebSocket Event Types
+ *
+ * Periodic mark-derived valuation of one OPEN position, delivered on the same
+ * authenticated `positions` / `positions:<tradingPairId>` channel as lifecycle
+ * `position_update` frames, with `eventType: "position_valuation"`.
+ *
+ * Valuation data only: it carries no size, side, status or version, and never
+ * creates, reopens, closes or resizes a position. Apply it only to a position
+ * you already hold as `OPEN` whose `updatedAt` is earlier than the frame's
+ * `valuedAt`, and ignore it otherwise: valuations are spread over each
+ * interval, so one can arrive after a newer `position_update` (a fill, a close,
+ * a funding settlement) for the same position. `@0xmonaco/core` delivers these to the `onValuation` callback of
+ * `positions(...)`, never to its lifecycle handler.
+ */
+/**
+ * The five mark-derived figures of one open position, from the same
+ * derivation as a lifecycle frame's figures for that position.
+ */
+export interface PositionValuationEventData {
+    /** Position identifier (UUID) */
+    positionId: string;
+    /** Margin account that owns the position (UUID) */
+    marginAccountId: string;
+    /** Trading pair identifier (UUID) */
+    tradingPairId: string;
+    /** Current mark price (decimal string) */
+    markPrice: string;
+    /** Unrealized PnL at the mark price (decimal string) */
+    unrealizedPnl: string;
+    /**
+     * Liquidation price (decimal string), or `null` when the server cannot
+     * derive one for this position (for example an isolated risk bucket shared
+     * by several positions, or one whose collateral basis is not positive).
+     */
+    liquidationPrice: string | null;
+    /** Initial margin this position requires at the mark price (decimal string) */
+    initialMarginRequired: string;
+    /** Maintenance margin this position requires at the mark price (decimal string) */
+    maintenanceMarginRequired: string;
+    /**
+     * When the server read the position (RFC 3339). Not the oracle publish time
+     * and not the position's last mutation (`updatedAt` on lifecycle frames),
+     * but on the same server clock as `updatedAt`: a valuation whose `valuedAt`
+     * is not later than the held position's `updatedAt` was read before that
+     * state and is stale.
+     */
+    valuedAt: string;
+}
+/**
+ * Periodic valuation frame for one open position.
+ */
+export interface PositionValuationEvent {
+    /** Event type identifier */
+    eventType: "position_valuation";
+    /** User ID (UUID) */
+    userId: string;
+    /** Valuation data */
+    data: PositionValuationEventData;
+}

package/dist/websocket/events/position-valuation-events.js

@@ -0,0 +1,15 @@
+/**
+ * Position Valuation WebSocket Event Types
+ *
+ * Periodic mark-derived valuation of one OPEN position, delivered on the same
+ * authenticated `positions` / `positions:<tradingPairId>` channel as lifecycle
+ * `position_update` frames, with `eventType: "position_valuation"`.
+ *
+ * Valuation data only: it carries no size, side, status or version, and never
+ * creates, reopens, closes or resizes a position. Apply it only to a position
+ * you already hold as `OPEN` whose `updatedAt` is earlier than the frame's
+ * `valuedAt`, and ignore it otherwise: valuations are spread over each
+ * interval, so one can arrive after a newer `position_update` (a fill, a close,
+ * a funding settlement) for the same position. `@0xmonaco/core` delivers these to the `onValuation` callback of
+ * `positions(...)`, never to its lifecycle handler.
+ */

package/dist/wire/operations.d.ts

@@ -10,6 +10,6 @@
  * hand-written SDK surface. CI regenerates it and fails on a diff, identical to
  * the `schema.ts` wire-types tripwire (MON-1476), so it can never go stale.
  */
-export declare const OPERATION_IDS: readonly ["add_follow_position_margin", "attach_position_tp_sl", "batch_cancel_all", "batch_cancel_all_by_pair", "batch_cancel_orders", "batch_close_all_positions", "batch_create_orders", "batch_replace_orders", "cancel_conditional_order", "cancel_order", "cancel_twap_order", "check_trader_code_availability", "claim_buildercode_rewards", "claim_managed_market_lease", "clear_trader_code", "close_all_copy_positions", "close_follow_positions", "close_position", "close_sub_account", "create_challenge", "create_delegated_session", "create_order", "create_sub_account", "create_sub_account_limit", "create_twap_order", "delete_sub_account_limit", "get_application_config", "get_application_stats", "get_available_collateral", "get_buildercode_payout_summary", "get_buildercode_rewards_balance", "get_buildercodes_config", "get_candles", "get_conditional_order", "get_faucet_info", "get_follow", "get_funding_state", "get_index_price", "get_lead_trader", "get_margin_account_movements", "get_margin_account_pnl", "get_margin_account_summary", "get_mark_price", "get_market_metadata", "get_market_stats", "get_my_fee_tier", "get_my_lead_trader", "get_my_referral_downline", "get_my_referral_position", "get_my_referral_tree", "get_my_trader_code", "get_open_interest", "get_order_by_id", "get_orderbook_snapshot", "get_orders", "get_parent_margin_account_movements", "get_parent_margin_account_summary", "get_perp_market_config", "get_perp_market_summary", "get_portfolio_assets", "get_portfolio_chart", "get_portfolio_margin", "get_portfolio_performance", "get_portfolio_realized_pnl", "get_portfolio_stats", "get_portfolio_summary", "get_position", "get_position_pnl_history", "get_position_risk", "get_pulse", "get_rewards_balance", "get_screener", "get_self_trade_prevention_default", "get_sub_account_limits", "get_sweeper_chains", "get_trade_by_id", "get_trader_code_info", "get_trades", "get_trading_pair_by_id", "get_twap_order", "get_twap_order_tca", "get_user_balance_by_asset", "get_user_balances", "get_user_movements", "get_user_profile", "get_user_trades", "get_withdrawal", "health_check", "initiate_withdrawal", "list_all_funding_history", "list_application_balances", "list_application_movements", "list_application_orders", "list_application_users", "list_builder_fee_changes", "list_buildercode_payouts", "list_conditional_orders", "list_delegated_agent_owners", "list_delegated_agents", "list_follow_leader_positions", "list_funding_history", "list_funding_payments", "list_lead_trader_closed_trades", "list_lead_trader_open_positions", "list_lead_traders", "list_managed_market_assignments", "list_margin_accounts", "list_my_followers", "list_my_follows", "list_pending_withdrawals", "list_position_history", "list_positions", "list_sub_accounts_with_balances", "list_trading_pairs", "list_twap_orders", "mint_tokens", "preview_follow", "refresh_managed_market_quotes", "refresh_session", "register_deposit_address", "replace_order", "revoke_delegated_agent", "revoke_session", "set_builder_fee", "set_self_trade_prevention_default", "set_trader_code", "simulate_fees", "simulate_order_risk", "simulate_parent_margin_order_risk", "simulate_risk_bucket_order_risk", "stop_follow", "submit_whitelist", "transfer_collateral", "transfer_collateral_from_margin_account", "transfer_collateral_from_parent_margin_account", "transfer_collateral_to_margin_account", "transfer_collateral_to_parent_margin_account", "transfer_collateral_to_risk_bucket", "transfer_rewards", "update_sub_account_limit", "upsert_delegated_agent", "upsert_follow", "upsert_lead_trader", "verify_signature"];
+export declare const OPERATION_IDS: readonly ["add_follow_position_margin", "attach_position_tp_sl", "batch_cancel_all", "batch_cancel_all_by_pair", "batch_cancel_orders", "batch_close_all_positions", "batch_create_orders", "batch_replace_orders", "cancel_conditional_order", "cancel_order", "cancel_twap_order", "check_trader_code_availability", "claim_buildercode_rewards", "claim_managed_market_lease", "clear_trader_code", "close_all_copy_positions", "close_follow_positions", "close_position", "close_sub_account", "create_challenge", "create_delegated_session", "create_order", "create_sub_account", "create_sub_account_limit", "create_twap_order", "delete_sub_account_limit", "get_application_config", "get_application_stats", "get_available_collateral", "get_buildercode_payout_summary", "get_buildercode_rewards_balance", "get_buildercodes_config", "get_candles", "get_conditional_order", "get_faucet_info", "get_follow", "get_funding_state", "get_index_price", "get_lead_trader", "get_margin_account_movements", "get_margin_account_pnl", "get_margin_account_summary", "get_mark_price", "get_market_metadata", "get_market_stats", "get_my_fee_tier", "get_my_lead_trader", "get_my_referral_downline", "get_my_referral_position", "get_my_referral_tree", "get_my_trader_code", "get_open_interest", "get_order_by_id", "get_orderbook_snapshot", "get_orders", "get_parent_margin_account_movements", "get_parent_margin_account_summary", "get_perp_market_config", "get_perp_market_summary", "get_portfolio_assets", "get_portfolio_chart", "get_portfolio_margin", "get_portfolio_performance", "get_portfolio_realized_pnl", "get_portfolio_stats", "get_portfolio_summary", "get_position", "get_position_pnl_history", "get_position_risk", "get_pulse", "get_rewards_balance", "get_screener", "get_self_trade_prevention_default", "get_sub_account_limits", "get_sweeper_chains", "get_trade_by_id", "get_trader_code_info", "get_trades", "get_trading_pair_by_id", "get_twap_order", "get_twap_order_tca", "get_user_balance_by_asset", "get_user_balances", "get_user_movements", "get_user_profile", "get_user_trades", "get_withdrawal", "health_check", "initiate_withdrawal", "list_all_funding_history", "list_application_balances", "list_application_movements", "list_application_orders", "list_application_users", "list_builder_fee_changes", "list_buildercode_payouts", "list_conditional_orders", "list_delegated_agent_owners", "list_delegated_agents", "list_follow_leader_positions", "list_funding_history", "list_funding_payments", "list_lead_trader_closed_trades", "list_lead_trader_open_positions", "list_lead_traders", "list_managed_market_assignments", "list_margin_accounts", "list_my_followers", "list_my_follows", "list_pending_withdrawals", "list_position_history", "list_positions", "list_sub_accounts_with_balances", "list_trading_pairs", "list_twap_orders", "mint_tokens", "preview_follow", "refresh_managed_market_quotes", "refresh_session", "register_deposit_address", "replace_order", "revoke_delegated_agent", "revoke_session", "set_builder_fee", "set_self_trade_prevention_default", "set_trader_code", "simulate_fees", "simulate_order_risk", "simulate_parent_margin_order_risk", "simulate_risk_bucket_order_risk", "stop_follow", "submit_whitelist", "transfer_collateral", "transfer_collateral_from_margin_account", "transfer_collateral_from_parent_margin_account", "transfer_collateral_from_sub_account", "transfer_collateral_to_margin_account", "transfer_collateral_to_parent_margin_account", "transfer_collateral_to_risk_bucket", "transfer_collateral_to_sub_account", "transfer_rewards", "update_sub_account_limit", "upsert_delegated_agent", "upsert_follow", "upsert_lead_trader", "verify_signature"];
 /** Union of every OpenAPI operationId in the spec. */
 export type OperationId = (typeof OPERATION_IDS)[number];

package/dist/wire/operations.js

@@ -146,9 +146,11 @@ export const OPERATION_IDS = [
     "transfer_collateral",
     "transfer_collateral_from_margin_account",
     "transfer_collateral_from_parent_margin_account",
+    "transfer_collateral_from_sub_account",
     "transfer_collateral_to_margin_account",
     "transfer_collateral_to_parent_margin_account",
     "transfer_collateral_to_risk_bucket",
+    "transfer_collateral_to_sub_account",
     "transfer_rewards",
     "update_sub_account_limit",
     "upsert_delegated_agent",