@0xmonaco/types 0.7.5 → 0.7.7

package/dist/trading/index.d.ts

@@ -1,132 +0,0 @@
-/**
- * Trading Types
- *
- * Types for trading operations including order placement and management.
- */
-import type { BaseAPI } from "../api/index";
-import type { OrderSide, PositionSide, TimeInForce, TradingMode } from "./orders";
-import type { BatchCancelOrdersResponse, BatchCreateOrderParams, BatchCreateOrdersResponse, BatchReplaceOrderParams, BatchReplaceOrdersResponse, CancelConditionalOrderResponse, CancelOrderResponse, CreateConditionalOrderParams, CreateConditionalOrderResponse, CreateOrderResponse, GetOrderResponse, GetPaginatedOrdersParams, GetPaginatedOrdersResponse, ListConditionalOrdersParams, ListConditionalOrdersResponse, ReplaceOrderResponse } from "./responses";
-/**
- * Trading API interface.
- * Provides methods for placing and managing orders.
- * Handles order placement, cancellation, and execution.
- */
-export interface TradingAPI extends BaseAPI {
-    /**
-     * Places a limit order on the order book.
-     * @param tradingPairId - Trading pair UUID
-     * @param side - Order side ("BUY" or "SELL")
-     * @param quantity - Order quantity as string
-     * @param price - Order price as string
-     * @param options - Optional parameters for the limit order
-     * @param options.tradingMode - Trading mode (e.g., "SPOT")
-     * @param options.timeInForce - Time in force ("GTC", "IOC", or "FOK")
-     * @returns Promise resolving to the order result
-     */
-    placeLimitOrder(tradingPairId: string, side: OrderSide, quantity: string, price: string, options?: {
-        tradingMode?: TradingMode;
-        useMasterBalance?: boolean;
-        expirationDate?: string;
-        timeInForce?: TimeInForce;
-        marginAccountId?: string;
-        positionSide?: PositionSide;
-        leverage?: string;
-        reduceOnly?: boolean;
-    }): Promise<CreateOrderResponse>;
-    /**
-     * Places a market order for immediate execution.
-     * @param tradingPairId - Trading pair UUID
-     * @param side - Order side ("BUY" or "SELL")
-     * @param quantity - Order quantity as string
-     * @param options - Optional parameters for the market order
-     * @param options.tradingMode - Trading mode (e.g., "SPOT")
-     * @param options.slippageTolerance - Slippage tolerance as decimal (e.g., 0.01 for 1%, 0 for best price only, undefined for unlimited slippage)
-     * @returns Promise resolving to the order result
-     */
-    placeMarketOrder(tradingPairId: string, side: OrderSide, quantity: string, options?: {
-        tradingMode?: TradingMode;
-        slippageTolerance?: number;
-        marginAccountId?: string;
-        positionSide?: PositionSide;
-        leverage?: string;
-        reduceOnly?: boolean;
-    }): Promise<CreateOrderResponse>;
-    /**
-     * Cancels an existing order.
-     * @param orderId - ID of the order to cancel
-     * @returns Promise resolving to the cancellation result
-     */
-    cancelOrder(orderId: string): Promise<CancelOrderResponse>;
-    /**
-     * Creates a standalone conditional TP/SL order.
-     */
-    createConditionalOrder(params: CreateConditionalOrderParams): Promise<CreateConditionalOrderResponse>;
-    /**
-     * Cancels an active conditional TP/SL order.
-     */
-    cancelConditionalOrder(conditionalOrderId: string): Promise<CancelConditionalOrderResponse>;
-    /**
-     * Lists conditional TP/SL orders for the authenticated user.
-     */
-    listConditionalOrders(params?: ListConditionalOrdersParams): Promise<ListConditionalOrdersResponse>;
-    /**
-     * Batch cancels specific orders by their IDs.
-     * @param orderIds - Array of order IDs to cancel
-     * @returns Promise resolving to the batch cancellation result
-     */
-    batchCancel(orderIds: string[]): Promise<BatchCancelOrdersResponse>;
-    /**
-     * Cancels all active orders, optionally filtered by trading pair.
-     * @param tradingPairId - Optional trading pair ID to filter cancellation
-     * @returns Promise resolving to the batch cancellation result
-     */
-    batchCancelAll(tradingPairId?: string): Promise<BatchCancelOrdersResponse>;
-    /**
-     * Replaces an existing order with new parameters.
-     * Updates the order with new price, quantity, and balance settings.
-     * @param orderId - ID of the order to replace
-     * @param newOrder - New order parameters
-     * @param newOrder.price - New order price as string (optional)
-     * @param newOrder.quantity - New order quantity as string
-     * @param newOrder.useMasterBalance - Whether to use master balance (optional, defaults to false)
-     * @returns Promise resolving to a `ReplaceOrderResponse`
-     */
-    replaceOrder(orderId: string, newOrder: {
-        price?: string;
-        quantity?: string;
-        useMasterBalance?: boolean;
-    }): Promise<ReplaceOrderResponse>;
-    /**
-     * Batch creates multiple orders in a single request.
-     * Each order is validated and processed through the matching engine.
-     * @param orders - Array of order parameters to create
-     * @returns Promise resolving to the batch creation result
-     */
-    batchCreate(orders: BatchCreateOrderParams[]): Promise<BatchCreateOrdersResponse>;
-    /**
-     * Batch replaces multiple orders in a single request.
-     * Each order is canceled and re-created with new parameters.
-     * @param orders - Array of order replacement parameters
-     * @returns Promise resolving to the batch replacement result
-     */
-    batchReplace(orders: BatchReplaceOrderParams[]): Promise<BatchReplaceOrdersResponse>;
-    /**
-     * Gets paginated orders based on query parameters.
-     * @param params - Query parameters for filtering orders
-     * @param params.status - Filter by order status (optional)
-     * @param params.trading_pair_id - Filter by trading pair UUID (optional)
-     * @param params.page - Page number for pagination (optional)
-     * @param params.page_size - Number of orders per page (optional)
-     * @returns Promise resolving to the paginated orders result
-     */
-    getPaginatedOrders(params?: GetPaginatedOrdersParams): Promise<GetPaginatedOrdersResponse>;
-    /**
-     * Gets a single order by its ID.
-     * @param orderId - ID of the order to retrieve
-     * @returns Promise resolving to the order details
-     */
-    getOrder(orderId: string): Promise<GetOrderResponse>;
-}
-export type { ConditionalOrderConditionType, ConditionalOrderState, ConditionalOrderTriggerSource, Order, OrderRole, OrderSide, OrderStatus, OrderType, PositionSide, TimeInForce, TradingMode, } from "./orders";
-export { ORDER_STATUS_VALUES } from "./orders";
-export type { BatchCancelError, BatchCancelOrdersResponse, BatchCancelResult, BatchCreateOrderParams, BatchCreateOrdersResponse, BatchCreateResult, BatchError, BatchReplaceOrderParams, BatchReplaceOrdersResponse, BatchReplaceResult, CancelConditionalOrderResponse, CancelOrderResponse, ConditionalOrder, CreateConditionalOrderParams, CreateConditionalOrderResponse, CreateOrderResponse, GetOrderResponse, GetPaginatedOrdersParams, GetPaginatedOrdersResponse, ListConditionalOrdersParams, ListConditionalOrdersResponse, MatchResult, ReplaceOrderResponse, UpdatedFields, } from "./responses";

package/dist/trading/index.js

@@ -1,6 +0,0 @@
-/**
- * Trading Types
- *
- * Types for trading operations including order placement and management.
- */
-export { ORDER_STATUS_VALUES } from "./orders";

package/dist/trading/orders.d.ts

@@ -1,137 +0,0 @@
-/**
- * Trading Order Types
- *
- * Types for trading operations and order management.
- */
-/**
- * Standard order structure used across all order-related responses.
- * This represents the complete order information as returned by the API.
- *
- * @remarks
- * Order lifecycle statuses: `SUBMITTED` → (`PARTIALLY_FILLED`) → `FILLED` → `SETTLED_ON_CHAIN`
- * Legacy backends may still emit `SETTLED`.
- * Orders can transition to `CANCELLED`, `REJECTED`, or `EXPIRED` at various stages.
- * Fee fields are only populated after order fills occur.
- *
- * @example
- * To calculate remaining quantity:
- * ```typescript
- * const remaining = parseFloat(order.quantity) - parseFloat(order.filled_quantity);
- * ```
- */
-export interface Order {
-    /** Order identifier (UUID) */
-    id: string;
-    /** Trading pair ID (UUID format, e.g., "456e7890-e12b-12d3-a456-426614174000") */
-    trading_pair_id: string;
-    /** Order side (BUY or SELL) */
-    side: OrderSide;
-    /** Order type - see OrderType for all supported types */
-    order_type: OrderType;
-    /** Order status - see OrderStatus for lifecycle details */
-    status: OrderStatus;
-    /** Order price - null for market orders, required for limit orders */
-    price?: string;
-    /** Order quantity (base currency amount) */
-    quantity: string;
-    /** Filled quantity (base currency amount, "0" if unfilled) */
-    filled_quantity: string;
-    /** Average fill price - only populated after order has fills */
-    average_fill_price?: string;
-    /** Trading mode (SPOT or MARGIN) */
-    trading_mode: TradingMode;
-    /** Time in force - GTC, IOC, FOK, or GTD */
-    time_in_force?: TimeInForce;
-    /** Order creation timestamp (ISO 8601) */
-    created_at: string;
-    /** Order last update timestamp (ISO 8601) */
-    updated_at?: string;
-    /** Optional expiration date for GTD orders (ISO 8601, max 1 year) */
-    expiration_date?: string;
-    /** Application taker fee in basis points (e.g., "100" = 1%) - populated after fills */
-    application_taker_fee?: string;
-    /** Monaco protocol taker fee in basis points - populated after fills */
-    monaco_taker_fee?: string;
-    /** Monaco protocol maker rebate in basis points - populated after fills */
-    monaco_maker_rebate?: string;
-    /** Total taker fees paid in quote currency - populated after fills */
-    total_taker_fees?: string;
-    /** Total payment for taker including fees in quote currency - populated after fills */
-    taker_total_payment?: string;
-    /** Total receipt for maker after rebates in quote currency - populated after fills */
-    maker_total_receipt?: string;
-    /** Margin account ID for margin/perp orders */
-    margin_account_id?: string;
-    /** Position side for margin/perp orders */
-    position_side?: PositionSide;
-    /** Leverage used for margin/perp orders */
-    leverage?: string;
-    /** Whether the order can only reduce existing exposure */
-    reduce_only?: boolean;
-    /** Position ID linked to the order, when available */
-    position_id?: string;
-}
-/**
- * Role of the creator or order
- */
-export type OrderRole = "maker" | "taker";
-/**
- * Order side for trading operations
- */
-export type OrderSide = "BUY" | "SELL";
-/**
- * Position side for margin/perp trading
- */
-export type PositionSide = "LONG" | "SHORT" | "NONE";
-/**
- * Order type for different order strategies
- * - LIMIT: Execute only at specified price or better
- * - MARKET: Execute immediately at current market price
- * - STOP_LOSS: Stop loss order triggered at trigger price
- * - TAKE_PROFIT: Take profit order triggered at trigger price
- * - STOP_LIMIT: Stop order that becomes a limit order when triggered
- * - TRAILING_STOP: Stop order that trails the market price
- */
-export type OrderType = "LIMIT" | "MARKET";
-/**
- * Source-of-truth order status values used by runtime validation schemas.
- */
-export declare const ORDER_STATUS_VALUES: readonly ["SUBMITTED", "PARTIALLY_FILLED", "FILLED", "SETTLED_ON_CHAIN", "SETTLED", "CANCELLED", "REJECTED", "EXPIRED"];
-/**
- * Order status for different order states
- *
- * Order lifecycle progression:
- * - SUBMITTED: Order submitted to the matching engine for processing
- * - PARTIALLY_FILLED: Order has been partially executed
- * - FILLED: Order has been completely executed (pre-commit)
- * - SETTLED_ON_CHAIN: Order settlement has been finalized on-chain
- * - SETTLED: Legacy settled status from older backend versions
- * - CANCELLED: Order was canceled by user or system
- * - REJECTED: Order was rejected due to validation failure
- * - EXPIRED: Order expired based on time constraints
- */
-export type OrderStatus = (typeof ORDER_STATUS_VALUES)[number];
-/**
- * Trading mode
- */
-export type TradingMode = "SPOT" | "MARGIN";
-/**
- * Time in force for order execution
- * - GTC: Good Till Cancel - remains active until filled or canceled
- * - IOC: Immediate or Cancel - execute immediately and cancel unfilled portion
- * - FOK: Fill or Kill - execute completely or cancel entirely
- * - GTD: Good Till Date - remains active until specified expiration date
- */
-export type TimeInForce = "GTC" | "IOC" | "FOK" | "GTD";
-/**
- * Conditional TP/SL condition type.
- */
-export type ConditionalOrderConditionType = "STOP_LOSS" | "TAKE_PROFIT";
-/**
- * Conditional order trigger source. v1 supports mark-price triggers.
- */
-export type ConditionalOrderTriggerSource = "MARK_PRICE";
-/**
- * Conditional TP/SL lifecycle state.
- */
-export type ConditionalOrderState = "ACTIVE" | "TRIGGERING" | "TRIGGERED" | "CANCELLED" | "EXPIRED" | "FAILED";

package/dist/trading/orders.js

@@ -1,9 +0,0 @@
-/**
- * Trading Order Types
- *
- * Types for trading operations and order management.
- */
-/**
- * Source-of-truth order status values used by runtime validation schemas.
- */
-export const ORDER_STATUS_VALUES = ["SUBMITTED", "PARTIALLY_FILLED", "FILLED", "SETTLED_ON_CHAIN", "SETTLED", "CANCELLED", "REJECTED", "EXPIRED"];

package/dist/trading/responses.d.ts

@@ -1,347 +0,0 @@
-/**
- * Trading Response Types
- *
- * Response types for trading operations.
- */
-import type { ConditionalOrderConditionType, ConditionalOrderState, ConditionalOrderTriggerSource, Order, OrderSide, OrderStatus, OrderType, PositionSide, TimeInForce, TradingMode } from "./orders";
-/**
- * Match result information for order execution.
- * Contains detailed information about trades, fills, and execution quality.
- *
- * @remarks
- * This structure is returned after an order is processed by the matching engine,
- * providing details about how the order was executed, including fills, slippage,
- * and final order status.
- */
-export interface MatchResult {
-    /** Number of trades executed during matching */
-    trades_count: number;
-    /** Total quantity filled across all trades (in base currency) */
-    total_filled: string;
-    /** Remaining unfilled quantity after immediate matches (in base currency) */
-    remaining_quantity: string;
-    /** Average fill price across all trades (null if no fills occurred) */
-    average_fill_price: string | null;
-    /** Final order status after matching (e.g., FILLED, PARTIALLY_FILLED, etc.) */
-    status: OrderStatus;
-    /** Actual slippage experienced in basis points (positive = worse price, null if no fills) */
-    actual_slippage_bps: number | null;
-    /** Maximum slippage allowed when order was submitted in basis points (null if not set) */
-    max_slippage_bps: number | null;
-    /** Price range across executed trades (null if no fills) */
-    execution_price_range: {
-        /** Best (most favorable) execution price achieved */
-        best_price: string;
-        /** Worst (least favorable) execution price achieved */
-        worst_price: string;
-    } | null;
-}
-/**
- * Response from creating an order.
- *
- * @remarks
- * Contains the order ID, operation status, and optional match result
- * with details about immediate fills that occurred during order placement.
- */
-export interface CreateOrderResponse {
-    /** Created order identifier (UUID) */
-    order_id: string;
-    /** Operation status (SUCCESS or FAILED) */
-    status: "SUCCESS" | "FAILED";
-    /** Operation message describing the result (e.g., "Order processed with 2 trades") */
-    message: string;
-    /** Match result information if order was processed by matching engine */
-    match_result?: MatchResult;
-}
-/**
- * Response from cancelling an order.
- */
-export interface CancelOrderResponse {
-    /** Order identifier */
-    order_id: string;
-    /** Cancellation status */
-    status: "SUCCESS" | "FAILED";
-    /** Optional response message */
-    message?: string;
-}
-/**
- * Response from replacing an order.
- */
-export interface ReplaceOrderResponse {
-    /** New order identifier (after replacement) */
-    order_id: string;
-    /** Replace operation status */
-    status: "SUCCESS" | "FAILED";
-    /** Operation message */
-    message: string;
-    /** Fields that were updated */
-    updated_fields: UpdatedFields;
-    /** Original order identifier that was replaced */
-    original_order_id?: string;
-    /** Match result information for the new order */
-    match_result?: MatchResult;
-}
-/**
- * Fields that were updated in the replace operation
- */
-export interface UpdatedFields {
-    /** Updated price (if changed) */
-    price?: string;
-    /** Updated quantity (if changed) */
-    quantity?: string;
-}
-/**
- * Query parameters for getting paginated orders
- */
-export interface GetPaginatedOrdersParams {
-    /** Filter by order status */
-    status?: OrderStatus;
-    /** Filter by trading pair UUID */
-    trading_pair_id?: string;
-    /** Filter by trading mode */
-    trading_mode?: TradingMode;
-    /** Filter by margin account UUID */
-    margin_account_id?: string;
-    /** Page number for pagination (default: 1) */
-    page?: number;
-    /** Number of orders per page (default: 10, max: 100) */
-    page_size?: number;
-}
-/**
- * Response from getting paginated orders
- */
-export interface GetPaginatedOrdersResponse {
-    /** Latest orders from Redis cache (real-time, instant updates).
-     * These are the most recently created/updated orders that may not yet be in PostgreSQL.
-     * Only populated on page 1.
-     */
-    latest_orders?: Order[];
-    /** Array of historical orders from PostgreSQL (paginated) */
-    orders: Order[];
-    /** Total number of orders matching the query */
-    total: number;
-    /** Current page number */
-    page: number;
-    /** Number of orders per page */
-    page_size: number;
-    /** Total number of pages */
-    total_pages: number;
-}
-/**
- * Response from getting a single order by ID
- */
-export interface GetOrderResponse {
-    /** Order data */
-    order: Order;
-    /** Request status */
-    status: "SUCCESS" | "FAILED";
-}
-/**
- * Error details for a failed batch cancel operation on a single order
- */
-export interface BatchCancelError {
-    /** Error code */
-    code: string;
-    /** Error message */
-    message: string;
-}
-/**
- * Result of a batch cancel operation for a single order
- */
-export interface BatchCancelResult {
-    /** Order identifier */
-    order_id: string;
-    /** Timestamp when the order was canceled (ISO 8601 format) */
-    cancelled_at?: string;
-    /** Error details if the cancellation failed */
-    error?: BatchCancelError;
-}
-/**
- * Response from batch cancelling orders
- */
-export interface BatchCancelOrdersResponse {
-    /** Total number of orders requested to cancel */
-    total_requested: number;
-    /** Total number of orders successfully canceled */
-    total_cancelled: number;
-    /** Total number of orders that failed to cancel */
-    total_failed: number;
-    /** Individual results for each order */
-    results: BatchCancelResult[];
-}
-/**
- * Error details for a failed batch operation on a single order
- */
-export interface BatchError {
-    /** Error code */
-    code: string;
-    /** Error message */
-    message: string;
-}
-/**
- * Result of a batch create operation for a single order
- */
-export interface BatchCreateResult {
-    /** Order identifier (empty string if creation failed before ID assignment) */
-    order_id: string;
-    /** Match result information if the order was processed */
-    match_result?: MatchResult;
-    /** Error details if the creation failed */
-    error?: BatchError;
-}
-/**
- * Response from batch creating orders
- */
-export interface BatchCreateOrdersResponse {
-    /** Total number of orders requested to create */
-    total_requested: number;
-    /** Total number of orders successfully created */
-    total_succeeded: number;
-    /** Total number of orders that failed to create */
-    total_failed: number;
-    /** Individual results for each order */
-    results: BatchCreateResult[];
-}
-/**
- * Result of a batch replace operation for a single order
- */
-export interface BatchReplaceResult {
-    /** Original order identifier */
-    original_order_id: string;
-    /** New order identifier (if successful) */
-    new_order_id?: string;
-    /** Fields that were updated (if successful) */
-    updated_fields?: UpdatedFields;
-    /** Match result information if the new order was processed */
-    match_result?: MatchResult;
-    /** Error details if the replacement failed */
-    error?: BatchError;
-}
-/**
- * Response from batch replacing orders
- */
-export interface BatchReplaceOrdersResponse {
-    /** Total number of orders requested to replace */
-    total_requested: number;
-    /** Total number of orders successfully replaced */
-    total_succeeded: number;
-    /** Total number of orders that failed to replace */
-    total_failed: number;
-    /** Individual results for each order */
-    results: BatchReplaceResult[];
-}
-/**
- * Parameters for a single order in a batch create request
- */
-export interface BatchCreateOrderParams {
-    /** Trading pair UUID */
-    tradingPairId: string;
-    /** Order type: "LIMIT" or "MARKET" */
-    orderType: OrderType;
-    /** Order side: "BUY" or "SELL" */
-    side: OrderSide;
-    /** Order price (required for LIMIT orders) */
-    price?: string;
-    /** Order quantity */
-    quantity: string;
-    /** Trading mode (defaults to "SPOT") */
-    tradingMode?: TradingMode;
-    /** Maximum slippage for market orders as decimal (e.g., 0.01 for 1%) */
-    slippageTolerance?: number;
-    /** For sub-accounts: use master's balance */
-    useMasterBalance?: boolean;
-    /** Custom expiration date for GTC orders (ISO 8601 format) */
-    expirationDate?: string;
-    /** Time in force: "GTC", "IOC", or "FOK" */
-    timeInForce?: Extract<TimeInForce, "GTC" | "IOC" | "FOK">;
-    /** Margin account UUID for margin/perp orders */
-    marginAccountId?: string;
-    /** Position side for margin/perp orders */
-    positionSide?: PositionSide;
-    /** Leverage for margin/perp orders */
-    leverage?: string;
-    /** Whether the order can only reduce existing exposure */
-    reduceOnly?: boolean;
-}
-/**
- * Parameters for a single order in a batch replace request
- */
-export interface BatchReplaceOrderParams {
-    /** Order ID to replace */
-    orderId: string;
-    /** New order price (optional) */
-    price?: string;
-    /** New order quantity (optional) */
-    quantity?: string;
-    /** For sub-accounts: use master's balance (optional) */
-    useMasterBalance?: boolean;
-}
-/**
- * Parameters for creating a standalone conditional TP/SL order.
- */
-export interface CreateConditionalOrderParams {
-    tradingPairId: string;
-    marginAccountId: string;
-    conditionType: ConditionalOrderConditionType;
-    triggerPrice: string;
-    triggerSource?: ConditionalOrderTriggerSource;
-    side: OrderSide;
-    positionSide: Exclude<PositionSide, "NONE">;
-    orderType: OrderType;
-    limitPrice?: string;
-    quantity?: string;
-    reduceOnly?: boolean;
-    timeInForce?: Extract<TimeInForce, "GTC" | "IOC">;
-    slippageToleranceBps?: number;
-    expiresAt?: string;
-}
-export interface CreateConditionalOrderResponse {
-    conditional_order_id: string;
-    status: "SUCCESS" | "FAILED";
-    message: string;
-    state: ConditionalOrderState;
-}
-export interface CancelConditionalOrderResponse {
-    conditional_order_id: string;
-    status: "SUCCESS" | "FAILED";
-    message: string;
-}
-export interface ListConditionalOrdersParams {
-    margin_account_id?: string;
-    trading_pair_id?: string;
-    state?: ConditionalOrderState;
-    page?: number;
-    page_size?: number;
-}
-export interface ConditionalOrder {
-    conditional_order_id: string;
-    trading_pair_id: string;
-    margin_account_id: string;
-    position_id?: string;
-    linked_group_id?: string;
-    condition_type: ConditionalOrderConditionType;
-    trigger_source: ConditionalOrderTriggerSource;
-    trigger_price: string;
-    side: OrderSide;
-    position_side: PositionSide;
-    order_type: OrderType;
-    limit_price?: string;
-    quantity?: string;
-    slippage_tolerance_bps?: number;
-    reduce_only: boolean;
-    time_in_force?: TimeInForce;
-    state: ConditionalOrderState;
-    triggered_order_id?: string;
-    triggered_at?: string;
-    cancelled_at?: string;
-    expires_at?: string;
-    failure_reason?: string;
-    created_at: string;
-    updated_at: string;
-}
-export interface ListConditionalOrdersResponse {
-    orders: ConditionalOrder[];
-    total: number;
-    page: number;
-    page_size: number;
-}

package/dist/trading/responses.js

@@ -1,5 +0,0 @@
-/**
- * Trading Response Types
- *
- * Response types for trading operations.
- */