@0xmonaco/types 1.0.42 → 1.0.44

package/dist/vault/index.d.ts

@@ -15,6 +15,21 @@ import type { Balance, TransactionResult, WithdrawalRetryOptions, WithdrawResult
  *   to spot — funds are never lost.
  */
 export type DepositTarget = "spot" | "margin";
+/**
+ * Options for a deposit.
+ */
+export interface DepositOptions {
+    /**
+     * Deposit the wrapped-native asset (e.g. WSEI) as its ERC20 instead of in
+     * native coin. By default the SDK deposits that asset via the payable
+     * `depositNative` (spending native coin, which the vault wraps on entry);
+     * set this when the wallet holds the wrapped ERC20 itself — the deposit then
+     * goes through the standard `approve` + `depositERC20` path and consumes an
+     * ERC20 allowance. Withdrawals still pay out native coin (the vault
+     * unwraps). Has no effect on assets that are not the wrapped-native asset.
+     */
+    asErc20?: boolean;
+}
 /**
  * Source ledger for an external withdrawal.
  * - `"spot"` (default): withdraw from the spot/main wallet.
@@ -44,9 +59,11 @@ export interface VaultAPI extends BaseAPI {
      * @param target - Destination ledger: `"spot"` (default) or `"margin"` to
      *   route the deposit into the parent margin account's collateral. Margin
      *   deposits that cannot be routed fall back to spot.
+     * @param options - Deposit options; `asErc20` deposits the wrapped-native
+     *   asset as its ERC20 via `depositERC20` instead of in native coin.
      * @returns Promise resolving to the transaction result
      */
-    deposit(assetId: string, amount: bigint, autoWait?: boolean, target?: DepositTarget): Promise<TransactionResult>;
+    deposit(assetId: string, amount: bigint, autoWait?: boolean, target?: DepositTarget, options?: DepositOptions): Promise<TransactionResult>;
     /**
      * Initiates a withdrawal and submits its `executeWithdrawal(...)` calldata
      * on-chain through the connected wallet.
@@ -99,9 +116,12 @@ export interface VaultAPI extends BaseAPI {
      * Checks if a token needs approval for an amount.
      * @param assetId - Asset identifier (UUID) to check
      * @param amount - Amount to check
+     * @param options - Deposit options the approval is for; with `asErc20` the
+     *   wrapped-native asset consumes a real ERC20 allowance, so its allowance
+     *   is read instead of short-circuiting to false.
      * @returns Promise resolving to whether approval is needed
      */
-    needsApproval(assetId: string, amount: bigint): Promise<boolean>;
+    needsApproval(assetId: string, amount: bigint, options?: DepositOptions): Promise<boolean>;
     /**
      * Gets the address of the vault.
      * @returns Promise resolving to the address of the vault

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

@@ -23,8 +23,12 @@ export interface AccountEventData {
     /** Collateral available for new margin allocation (decimal string) */
     freeCollateral: string;
     /**
-     * Maintenance margin required divided by equity; `0` when equity is zero
-     * (decimal string).
+     * Account distress ratio: maintenance margin required over equity (higher is
+     * closer to liquidation, decimal string). When equity is non-positive the
+     * quotient is undefined, so an account that still owes a maintenance
+     * requirement saturates to the max-decimal sentinel
+     * (`79228162514264337593543950335`, maximal distress) and an empty account
+     * with no requirement is `0`. Clamp the sentinel before display.
      */
     marginRatio: string;
     /** Maintenance margin required to keep the account solvent (decimal string) */

package/dist/websocket/events/index.d.ts

@@ -9,3 +9,4 @@ export * from "./orderbook-events";
 export * from "./orders-events";
 export * from "./position-events";
 export * from "./trade-events";
+export * from "./twap-order-events";

package/dist/websocket/events/index.js

@@ -9,3 +9,4 @@ export * from "./orderbook-events";
 export * from "./orders-events";
 export * from "./position-events";
 export * from "./trade-events";
+export * from "./twap-order-events";

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

@@ -5,6 +5,15 @@
  */
 import type { Candlestick, Interval } from "../../market";
 import type { TradingMode } from "../../trading";
+/**
+ * OHLCV price series selector for the optional fifth channel token.
+ *
+ * - `trade` — the trade-derived candles (the default when the token is omitted).
+ * - `mark` — the close-only mark-price series (open = high = low = close = mark,
+ *   zero volume), published on `1m` for margin pairs.
+ * - `*` — both series.
+ */
+export type OHLCVPriceType = "trade" | "mark" | "*";
 /**
  * OHLCV update event
  */
@@ -15,6 +24,12 @@ export interface OHLCVEvent {
     interval: Interval;
     /** Trading mode */
     tradingMode: TradingMode;
+    /**
+     * Price series this candle belongs to. Always a concrete series on the wire
+     * (`trade` or `mark`, never the `*` selector); lets a wildcard subscriber
+     * tell the two streams apart. Absent only on legacy frames that omit it.
+     */
+    priceType?: "trade" | "mark";
     /** OHLCV candlestick data */
     candlestick: Candlestick;
 }

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

@@ -9,7 +9,7 @@ import type { RawEventMessage } from "../base";
 /**
  * Order event types
  */
-export type OrderEventType = "OrderPlaced" | "OrderMatched" | "OrderPartiallyFilled" | "OrderFilled" | "OrderCancelled" | "OrderRejected" | "OrderExpired";
+export type OrderEventType = "OrderPlaced" | "OrderMatched" | "OrderPartiallyFilled" | "OrderFilled" | "OrderCancelled" | "OrderPartiallyCancelled" | "OrderRejected" | "OrderExpired";
 /**
  * Base order event structure
  * All order events share these common fields
@@ -320,10 +320,36 @@ export interface OrderExpiredEvent extends OrderEvent {
         reason: string;
     };
 }
+/**
+ * Partial cancel: the order was reduced IN PLACE to a smaller remaining
+ * quantity and is STILL RESTING at its original queue position. NOT a
+ * terminal event — an `OrderCancelled` (or fill) still follows eventually.
+ * `quantity` is the reduced TOTAL, so `quantity = filledQuantity +
+ * remainingQuantity` holds.
+ */
+export interface OrderPartiallyCancelledEvent extends OrderEvent {
+    eventType: "OrderPartiallyCancelled";
+    data: CommonOrderEventData & {
+        /** Order status — non-terminal (the order still rests) */
+        status: OrderStatus;
+        /** Cumulative filled quantity, unchanged by the reduction */
+        filledQuantity: string;
+        /** Cumulative filled quantity in RAW precision. Wire: `filled_quantity_raw`. */
+        filledQuantityRaw: string;
+        /** Remaining quantity after the reduction (the requested target) */
+        remainingQuantity: string;
+        /** Remaining quantity in RAW precision. Wire: `remaining_quantity_raw`. */
+        remainingQuantityRaw: string;
+        /** Caller-supplied cancel reason; explicit `null` when none was given */
+        reason: string | null;
+        /** When the reduction happened (RFC3339 `Z`). Wire: `reduced_at`. */
+        reducedAt: string;
+    };
+}
 /**
  * Union type of all possible order event data
  */
-export type OrderEventData = OrderPlacedEvent["data"] | OrderMatchedEvent["data"] | OrderPartiallyFilledEvent["data"] | OrderFilledEvent["data"] | OrderCancelledEvent["data"] | OrderRejectedEvent["data"] | OrderExpiredEvent["data"];
+export type OrderEventData = OrderPlacedEvent["data"] | OrderMatchedEvent["data"] | OrderPartiallyFilledEvent["data"] | OrderFilledEvent["data"] | OrderCancelledEvent["data"] | OrderPartiallyCancelledEvent["data"] | OrderRejectedEvent["data"] | OrderExpiredEvent["data"];
 /**
  * Subscription configuration for order events
  */

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

@@ -0,0 +1,64 @@
+import type { OrderSide, TradingMode, TwapOrderState } from "../../trading";
+/**
+ * Mutation that produced a TWAP parent-order snapshot.
+ */
+export type TwapOrderEventReason = "created" | "slice_placed" | "slice_skipped" | "cancelled" | "completed";
+/**
+ * TWAP parent-order snapshot carried by a `twap_orders` WebSocket event.
+ * The server publishes the full read model on every lifecycle transition
+ * (created, slice placed/skipped, cancelled, completed), so each event
+ * supersedes the previous one for the same `twapOrderId`.
+ *
+ * Field names mirror the backend `TwapOrderEventData` payload (snake_case on
+ * the wire, camelCased by the client); the SDK parser normalizes explicit
+ * `null` values to absent, so nullable wire fields are optional here.
+ */
+export interface TwapOrderEventData {
+    twapOrderId: string;
+    tradingPairId: string;
+    side: OrderSide;
+    tradingMode: TradingMode;
+    totalQuantity: string;
+    executedQuantity: string;
+    executedNotional: string;
+    /** Volume-weighted average fill price (executedNotional / executedQuantity); absent until the first fill */
+    averageFillPrice?: string;
+    limitPrice?: string;
+    slippageToleranceBps: number;
+    reduceOnly: boolean;
+    marginAccountId?: string;
+    /** Isolated risk bucket UUID for risk-bucket-scoped margin TWAP orders */
+    riskBucketId?: string;
+    leverage?: string;
+    useMasterBalance: boolean;
+    strategyKey?: string;
+    clientTwapId?: string;
+    randomize: boolean;
+    /** Window start (ISO 8601) */
+    startAt: string;
+    /** Window end (ISO 8601). Execution stops hard at this time. */
+    endAt: string;
+    /** Derived base slice interval in milliseconds (int64 on the wire, a JSON number) */
+    intervalMs: number;
+    plannedSlices: number;
+    /** Index of the next slice in the planned schedule */
+    nextSliceIndex: number;
+    /** Planned time of the next slice (ISO 8601); absent once the parent is terminal */
+    nextSliceAt?: string;
+    slicesPlaced: number;
+    slicesSkipped: number;
+    state: TwapOrderState;
+    /** Terminal annotation, e.g. "ended with shortfall 1.5"; absent for non-terminal parents */
+    terminalReason?: string;
+    createdAt: string;
+    updatedAt: string;
+    cancelledAt?: string;
+    completedAt?: string;
+    /** Mutation that produced this snapshot */
+    reason: TwapOrderEventReason;
+}
+export interface TwapOrderEvent {
+    eventType: "twap_order_update";
+    userId: string;
+    data: TwapOrderEventData;
+}

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 ["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", "check_trader_code_availability", "clear_trader_code", "close_position", "create_challenge", "create_delegated_session", "create_order", "create_sub_account_limit", "delete_sub_account_limit", "get_application_config", "get_application_stats", "get_available_collateral", "get_candles", "get_conditional_order", "get_faucet_info", "get_funding_state", "get_index_price", "get_margin_account_movements", "get_margin_account_summary", "get_mark_price", "get_market_metadata", "get_market_stats", "get_my_fee_tier", "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_sub_account_limits", "get_trade_by_id", "get_trader_code_info", "get_trades", "get_trading_pair_by_id", "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_conditional_orders", "list_delegated_agent_owners", "list_delegated_agents", "list_funding_history", "list_funding_payments", "list_margin_accounts", "list_pending_withdrawals", "list_position_history", "list_positions", "list_sub_accounts_with_balances", "list_trading_pairs", "mint_tokens", "refresh_session", "register_deposit_address", "replace_order", "revoke_delegated_agent", "revoke_session", "set_trader_code", "simulate_fees", "simulate_order_risk", "simulate_parent_margin_order_risk", "simulate_risk_bucket_order_risk", "submit_whitelist", "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", "verify_signature"];
+export declare const OPERATION_IDS: readonly ["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", "clear_trader_code", "close_position", "create_challenge", "create_delegated_session", "create_order", "create_sub_account_limit", "create_twap_order", "delete_sub_account_limit", "get_application_config", "get_application_stats", "get_available_collateral", "get_candles", "get_conditional_order", "get_faucet_info", "get_funding_state", "get_index_price", "get_margin_account_movements", "get_margin_account_summary", "get_mark_price", "get_market_metadata", "get_market_stats", "get_my_fee_tier", "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_sub_account_limits", "get_trade_by_id", "get_trader_code_info", "get_trades", "get_trading_pair_by_id", "get_twap_order", "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_conditional_orders", "list_delegated_agent_owners", "list_delegated_agents", "list_funding_history", "list_funding_payments", "list_margin_accounts", "list_pending_withdrawals", "list_position_history", "list_positions", "list_sub_accounts_with_balances", "list_trading_pairs", "list_twap_orders", "mint_tokens", "refresh_session", "register_deposit_address", "replace_order", "revoke_delegated_agent", "revoke_session", "set_trader_code", "simulate_fees", "simulate_order_risk", "simulate_parent_margin_order_risk", "simulate_risk_bucket_order_risk", "submit_whitelist", "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", "verify_signature"];
 /** Union of every OpenAPI operationId in the spec. */
 export type OperationId = (typeof OPERATION_IDS)[number];

package/dist/wire/operations.js

@@ -20,6 +20,7 @@ export const OPERATION_IDS = [
     "batch_replace_orders",
     "cancel_conditional_order",
     "cancel_order",
+    "cancel_twap_order",
     "check_trader_code_availability",
     "clear_trader_code",
     "close_position",
@@ -27,6 +28,7 @@ export const OPERATION_IDS = [
     "create_delegated_session",
     "create_order",
     "create_sub_account_limit",
+    "create_twap_order",
     "delete_sub_account_limit",
     "get_application_config",
     "get_application_stats",
@@ -69,6 +71,7 @@ export const OPERATION_IDS = [
     "get_trader_code_info",
     "get_trades",
     "get_trading_pair_by_id",
+    "get_twap_order",
     "get_user_balance_by_asset",
     "get_user_balances",
     "get_user_movements",
@@ -93,6 +96,7 @@ export const OPERATION_IDS = [
     "list_positions",
     "list_sub_accounts_with_balances",
     "list_trading_pairs",
+    "list_twap_orders",
     "mint_tokens",
     "refresh_session",
     "register_deposit_address",