@0xmonaco/types 1.0.66 → 1.0.69

package/dist/websocket/events/conditional-order-events.d.ts

@@ -8,12 +8,32 @@ import type { ConditionalOrderConditionType, ConditionalOrderState, ConditionalO
  * alias is documentation and a narrowing aid only. Match on it with a default
  * branch; see `ConditionalOrderEventData.reason`.
  *
+ * Every transition of a conditional order sends exactly one update:
+ *
+ * - `created`: the order was placed (`ACTIVE`, or `PENDING_PARENT` while it
+ *   waits on an entry order).
+ * - `activated`: a `PENDING_PARENT` order went `ACTIVE` when its entry order
+ *   filled as a resting maker.
+ * - `triggered`: the trigger fired and placed its close; `state` is
+ *   `TRIGGERED` and `triggeredOrderId` / `triggeredAt` name that close.
+ * - `oco_cancelled`: cancelled because its linked sibling triggered.
+ * - `parent_cancelled`: a `PENDING_PARENT` order cancelled because its entry
+ *   order was cancelled, expired, replaced away or swept.
+ * - `position_closed`: cancelled because its position closed.
+ * - `cancelled`: any other cancel — a user cancel, a new full-close order
+ *   superseding it, or a trailing stop refused because its position already
+ *   has one (`failureReason` says so).
+ * - `reparented`: a `PENDING_PARENT` order moved onto the entry order's
+ *   replacement; `parentOrderId` names the replacement, `state` is unchanged.
+ * - `failed`: the trigger fired but its close could not be placed.
+ * - `expired`: the trigger found its position no longer open.
+ *
  * A `TRAILING_STOP` row adds two: `armed` when tracking begins (its
  * `activationPrice` was reached, or immediately when none was set) and
  * `ratcheted` on every move of its trigger, carrying the new `triggerPrice`
  * and the `watermarkPrice` it was derived from (0XM-2827).
  */
-export type ConditionalOrderEventReason = "created" | "activated" | "cancelled" | "parent_cancelled" | "triggered" | "failed" | "oco_cancelled" | "armed" | "ratcheted";
+export type ConditionalOrderEventReason = "created" | "activated" | "cancelled" | "parent_cancelled" | "position_closed" | "reparented" | "triggered" | "failed" | "expired" | "oco_cancelled" | "armed" | "ratcheted";
 /**
  * A conditional (TP/SL) order's current state.
  *
@@ -81,6 +101,10 @@ export interface ConditionalOrderEventData {
      */
     timeInForce?: TimeInForce | (string & {});
     state: ConditionalOrderState | (string & {});
+    /**
+     * The close order the trigger placed. Set from the `triggered` update on,
+     * together with `triggeredAt`. Wire: `triggered_order_id`.
+     */
     triggeredOrderId?: string;
     triggeredAt?: string;
     activatedAt?: string;
@@ -117,27 +141,30 @@ export interface ConditionalOrderEventData {
      * snapshot builds the same shape with `"snapshot"` instead.
      */
     reason: string;
+    /**
+     * When the conditional order was created (ISO 8601): the same string REST
+     * returns as `createdAt` for this id, on live updates and snapshot rows
+     * alike. Always present from current servers; optional so a frame from an
+     * older deployment during a rolling release still parses. Wire: `created_at`.
+     */
+    createdAt?: string;
     updatedAt: string;
     /**
      * Opaque, compare-only revision counter for this conditional order's state —
      * the sequencer step that wrote it (0XM-2440). A strictly higher value is
      * strictly newer state for that conditional order.
      *
-     * Present on REST reads and on the subscribe-time `conditional_orders`
-     * snapshot frame. **Absent on live conditional events**, by design: those are
-     * emitted from a model captured before the sequencer acted, so the only value
-     * available there is the one the row held *before* the change being
-     * announced — a client merging on `>=` would let a snapshot read at that
-     * version win the tie and undo the transition.
-     *
-     * So seed conditional state from the snapshot and REST, comparing with
-     * `snapshot.version >= local.version`, and apply live events as state without
-     * ranking them. `>=` rather than `>`: one sequencer step can write several
-     * conditional rows (a trigger writes the triggered row and cancels its OCO
-     * sibling), so equal means "same step", not identical state.
+     * Present on live updates, on the subscribe-time `conditional_orders`
+     * snapshot frame and on REST reads, always the version of the row the
+     * update describes. When both sides carry one, merge with `incoming.version
+     * >= local.version`: `>=` rather than `>`, because one step can write several
+     * conditional rows at one version (a trigger writes the triggered row and
+     * cancels its OCO sibling), so equal means "same step", not identical state.
      *
      * Absent means unknown — a row last written before the field existed — never
-     * zero. Wire: `version`.
+     * zero, so never compare it numerically (`42 >= undefined` is false). A
+     * versioned row supersedes an unversioned one; between two unversioned rows,
+     * compare `updatedAt`. Wire: `version`.
      */
     version?: number;
 }

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

@@ -150,6 +150,17 @@ export interface CommonOrderEventData {
      * Wire: `self_trade_prevention_mode`.
      */
     selfTradePreventionMode?: SelfTradePreventionMode | (string & {});
+    /**
+     * The TWAP parent of a child order: the same id REST `getOrder` returns as
+     * `parentOrderId`, so a subscriber can group a TWAP's children from the
+     * socket alone. Carried on every frame of a TWAP child: its `OrderPlaced`
+     * acknowledgement, taker fills and remainder cancels, maker fills,
+     * cancellation and expiry frames, and its `orders` snapshot row. Omitted
+     * for an order that is not a TWAP child, and by servers predating the
+     * field.
+     * Wire: `parent_order_id`.
+     */
+    parentOrderId?: string;
 }
 /**
  * OrderPlaced event - emitted when a new order is placed
@@ -197,10 +208,11 @@ export interface OrderMatchedEvent extends OrderEvent {
         /** `remainingQuantity` in RAW (integer, base-unit) precision. Wire: `remaining_quantity_raw`. */
         remainingQuantityRaw: string;
         /**
-         * Monaco fee for the fills this event covers, in normalized decimal QUOTE
-         * units (negative = maker rebate). Excludes the application taker fee, so
-         * it is smaller than the order echo's `totalTakerFees` for an application
-         * that charges one, and equal to it for one that does not. Wire: `fee`.
+         * Total fee for the fills this event covers, in normalized decimal QUOTE
+         * units (negative = maker rebate): `monacoFee + builderFee`. For a taker
+         * this is Monaco's taker fee plus the frontend's builder fee, the same
+         * total as the order echo's `totalTakerFees`; for a maker it is the maker
+         * fee. Wire: `fee`.
          */
         fee: string;
         /**
@@ -210,6 +222,22 @@ export interface OrderMatchedEvent extends OrderEvent {
          * 10^quoteDecimals, and `BigInt(feeRaw)` is safe. Wire: `fee_raw`.
          */
         feeRaw: string;
+        /**
+         * Monaco's component of `fee`, in normalized decimal QUOTE units. Optional
+         * because a server older than this field omits it. Wire: `monaco_fee`.
+         */
+        monacoFee?: string;
+        /** `monacoFee` in RAW quote-unit precision. Wire: `monaco_fee_raw`. */
+        monacoFeeRaw?: string;
+        /**
+         * The frontend's builder fee component of `fee`, in normalized decimal
+         * QUOTE units. Always `"0"` for a maker: builder fees are charged to
+         * takers only. Optional because a server older than this field omits it.
+         * Wire: `builder_fee`.
+         */
+        builderFee?: string;
+        /** `builderFee` in RAW quote-unit precision. Wire: `builder_fee_raw`. */
+        builderFeeRaw?: string;
         /** Execution timestamp of the first trade this event covers (ISO 8601). `null` when it covers none. */
         executedAt: string | null;
         /** Reference price used for slippage calculation. `null` when unset. */
@@ -289,14 +317,16 @@ export interface OrderPartiallyFilledEvent extends OrderEvent {
         /** `remainingQuantity` in RAW (integer, base-unit) precision. Wire: `remaining_quantity_raw`. */
         remainingQuantityRaw?: string;
         /**
-         * Monaco fee for the fills this event covers, in normalized decimal QUOTE
-         * units (negative = maker rebate). The wire field is `fee`, not `makerFee`;
-         * taker and maker carry the same field. A taker event aggregates every
-         * trade it covers; a maker event is one trade.
+         * Total fee for the fills this event covers, in normalized decimal QUOTE
+         * units (negative = maker rebate): `monacoFee + builderFee`. The wire
+         * field is `fee`, not `makerFee`; taker and maker carry the same field. A
+         * taker event aggregates every trade it covers; a maker event is one
+         * trade.
          *
-         * Excludes the application taker fee, so it is NOT the order echo's
-         * `totalTakerFees` (which is `fee + applicationTakerFee`). It previously
-         * held the raw integer value now exposed as `feeRaw`.
+         * For a taker this is Monaco's taker fee plus the frontend's builder fee,
+         * the same total as the order echo's `totalTakerFees`; for a maker it is
+         * the maker fee. It previously held the raw integer value now exposed as
+         * `feeRaw`, and before that Monaco's fee alone.
          */
         fee?: string;
         /**
@@ -306,6 +336,18 @@ export interface OrderPartiallyFilledEvent extends OrderEvent {
          * 10^quoteDecimals, and `BigInt(feeRaw)` is safe. Wire: `fee_raw`.
          */
         feeRaw?: string;
+        /** Monaco's component of `fee`, in normalized decimal QUOTE units. Wire: `monaco_fee`. */
+        monacoFee?: string;
+        /** `monacoFee` in RAW quote-unit precision. Wire: `monaco_fee_raw`. */
+        monacoFeeRaw?: string;
+        /**
+         * The frontend's builder fee component of `fee`, in normalized decimal
+         * QUOTE units. Always `"0"` for a maker: builder fees are charged to
+         * takers only. Wire: `builder_fee`.
+         */
+        builderFee?: string;
+        /** `builderFee` in RAW quote-unit precision. Wire: `builder_fee_raw`. */
+        builderFeeRaw?: string;
         /** Trade execution timestamp (maker orders only) */
         executedAt?: string;
         /** Role of the order in the trade (taker or maker) */
@@ -369,14 +411,16 @@ export interface OrderFilledEvent extends OrderEvent {
         /** `remainingQuantity` in RAW (integer, base-unit) precision. Wire: `remaining_quantity_raw`. */
         remainingQuantityRaw?: string;
         /**
-         * Monaco fee for the fills this event covers, in normalized decimal QUOTE
-         * units (negative = maker rebate). The wire field is `fee`, not `makerFee`;
-         * taker and maker carry the same field. A taker event aggregates every
-         * trade it covers; a maker event is one trade.
+         * Total fee for the fills this event covers, in normalized decimal QUOTE
+         * units (negative = maker rebate): `monacoFee + builderFee`. The wire
+         * field is `fee`, not `makerFee`; taker and maker carry the same field. A
+         * taker event aggregates every trade it covers; a maker event is one
+         * trade.
          *
-         * Excludes the application taker fee, so it is NOT the order echo's
-         * `totalTakerFees` (which is `fee + applicationTakerFee`). It previously
-         * held the raw integer value now exposed as `feeRaw`.
+         * For a taker this is Monaco's taker fee plus the frontend's builder fee,
+         * the same total as the order echo's `totalTakerFees`; for a maker it is
+         * the maker fee. It previously held the raw integer value now exposed as
+         * `feeRaw`, and before that Monaco's fee alone.
          */
         fee?: string;
         /**
@@ -386,6 +430,18 @@ export interface OrderFilledEvent extends OrderEvent {
          * 10^quoteDecimals, and `BigInt(feeRaw)` is safe. Wire: `fee_raw`.
          */
         feeRaw?: string;
+        /** Monaco's component of `fee`, in normalized decimal QUOTE units. Wire: `monaco_fee`. */
+        monacoFee?: string;
+        /** `monacoFee` in RAW quote-unit precision. Wire: `monaco_fee_raw`. */
+        monacoFeeRaw?: string;
+        /**
+         * The frontend's builder fee component of `fee`, in normalized decimal
+         * QUOTE units. Always `"0"` for a maker: builder fees are charged to
+         * takers only. Wire: `builder_fee`.
+         */
+        builderFee?: string;
+        /** `builderFee` in RAW quote-unit precision. Wire: `builder_fee_raw`. */
+        builderFeeRaw?: string;
         /** Trade execution timestamp (maker orders only) */
         executedAt?: string;
         /** Role of the order in the trade (taker or maker) */

package/dist/websocket/snapshots.d.ts

@@ -53,7 +53,8 @@ export type SnapshotHandler<T> = (items: T[]) => void;
  * The change-only fill metadata of an order EVENT is deliberately absent: a
  * snapshot describes resting state, not a fill, so there is no `eventType`,
  * `tradeId`, `executionPrice`, `lastFillQuantity`, `role`, `fee`, `feeRaw`,
- * `tradesCount` or slippage. The cumulative `filledQuantity` /
+ * `monacoFee`, `builderFee` (and their `Raw` twins), `tradesCount` or
+ * slippage. The cumulative `filledQuantity` /
  * `averageFillPrice` totals are present, because those are state.
  *
  * Nullability mirrors the wire exactly. Every optional field below is a Rust
@@ -130,6 +131,12 @@ export interface OrderSnapshotItem {
      * never the resolved wallet or platform default.
      */
     selfTradePreventionMode?: SelfTradePreventionMode | (string & {});
+    /**
+     * The TWAP parent of a child order: the same id REST `getOrder` returns as
+     * `parentOrderId`. Omitted — not `null` — for an order that is not a TWAP
+     * child, matching the live event payload. Wire: `parent_order_id`.
+     */
+    parentOrderId?: string;
     /**
      * Sequencer step this order's state was last written by — the SAME counter
      * the live order events and the REST endpoints carry (0XM-2440).

package/dist/whitelist/index.d.ts

@@ -1,12 +1,6 @@
 /**
- * Whitelist Types
- *
- * Types for the public whitelist (waitlist) application endpoint. Wire shapes
- * are snake_case.
- *
- * NOTE: This endpoint is **public (unauthenticated)** and creates an inactive
- * user pending manual approval — it is an onboarding/waitlist submission, not a
- * trading operation.
+ * Compatibility types for the retired public whitelist endpoint.
+ * Submissions return HTTP 403 FORBIDDEN without changing applicant data.
  */
 import type { BaseAPI } from "../api";
 /** Body for a whitelist application. */
@@ -20,7 +14,7 @@ export interface SubmitWhitelistRequest {
     /** Applicant Telegram username (5-32 chars) */
     telegramUsername?: string;
 }
-/** Response to a whitelist application. */
+/** Legacy success response, retained for compatibility; retired submissions return HTTP 403. */
 export interface SubmitWhitelistResponse {
     /** Human-readable status message */
     message: string;
@@ -32,13 +26,8 @@ export interface SubmitWhitelistResponse {
  */
 export interface WhitelistAPI extends BaseAPI {
     /**
-     * Submits a whitelist (waitlist) application.
-     *
-     * Public/unauthenticated. The server validates and de-duplicates by wallet
-     * address and email, creating an inactive user pending approval.
-     *
-     * @param body - Applicant details
-     * @returns Promise resolving to the status message and created user id
+     * @deprecated Public whitelist applications are closed. The server returns HTTP 403.
+     * @param body - Legacy applicant details; the request shape is retained for compatibility.
      */
     submit(body: SubmitWhitelistRequest): Promise<SubmitWhitelistResponse>;
 }

package/dist/whitelist/index.js

@@ -1,10 +1,4 @@
 /**
- * Whitelist Types
- *
- * Types for the public whitelist (waitlist) application endpoint. Wire shapes
- * are snake_case.
- *
- * NOTE: This endpoint is **public (unauthenticated)** and creates an inactive
- * user pending manual approval — it is an onboarding/waitlist submission, not a
- * trading operation.
+ * Compatibility types for the retired public whitelist endpoint.
+ * Submissions return HTTP 403 FORBIDDEN without changing applicant data.
  */