@0xmonaco/types 0.8.10 → 0.8.11

package/README.md

@@ -22,7 +22,7 @@ import { MonacoSDK, SDKConfig } from "@0xmonaco/types";
 // SDK configuration
 interface SDKConfig {
   walletClient?: WalletClient; // Wallet client for signing operations
-  network: Network; // Network preset: "local", "development", "staging", or "mainnet"
+  network: Network; // Use "staging" for public testnet or "mainnet" for production
   seiRpcUrl: string; // RPC URL for Sei blockchain interactions
 }
 
@@ -293,7 +293,7 @@ Types for network configuration:
 ```typescript
 import { Network, NetworkEndpoints } from "@0xmonaco/types";
 
-type Network = "mainnet" | "development" | "staging" | "local";
+const publicNetwork: Network = "staging";
 
 interface NetworkEndpoints {
   rpcUrl: string;
@@ -301,13 +301,15 @@ interface NetworkEndpoints {
 }
 ```
 
+For public integrations, use `"staging"` or `"mainnet"`.
+
 ## Type Reference
 
 ### SDK Types
 
 - `MonacoSDK`: Main SDK interface with all API modules
 - `SDKConfig`: Configuration options for the Monaco SDK
-- `Network`: Network type ("mainnet" | "development" | "staging" | "local")
+- `Network`: SDK network preset type. Public integrations should use `"staging"` or `"mainnet"`.
 - `AuthState`: Authentication state information
 
 ### Vault Types

package/dist/margin-accounts/index.d.ts

@@ -41,6 +41,13 @@ export interface GetAvailableCollateralResponse {
     wallet_available: string;
     wallet_locked: string;
     margin_transferable?: string;
+    /**
+     * Free collateral held in the user's parent margin account for this asset
+     * (equity minus initial margin required) — collateral already inside margin
+     * and available to open new positions or transfer back out. Absent when the
+     * user has no margin account yet.
+     */
+    margin_available_collateral?: string;
 }
 export interface TransferCollateralRequest {
     asset: string;

package/dist/market/index.d.ts

@@ -34,6 +34,8 @@ export interface TradingPair {
     quote_icon_url: string;
     /** Market type (e.g. SPOT) */
     market_type: string;
+    /** Asset-class category: crypto, equities, or commodities */
+    category: string;
     /** Whether the market is active */
     is_active: boolean;
     /** Maker fee in basis points */
@@ -126,6 +128,8 @@ export interface GetTradingPairsParams {
     quote_token?: string;
     /** Filter by active status */
     is_active?: boolean;
+    /** Filter by asset-class category (crypto, equities, commodities) */
+    category?: string;
 }
 /**
  * Response for listing trading pairs with pagination
@@ -155,6 +159,8 @@ export interface GetScreenerParams {
     market_type?: string;
     /** Filter by active status */
     is_active?: boolean;
+    /** Filter by asset-class category (crypto, equities, commodities) */
+    category?: string;
 }
 /**
  * One UTC-day bucket in a pair's 7-day screener snapshot
@@ -197,6 +203,12 @@ export interface ScreenerItem {
     price_change_percent_7d: string | null;
     /** Up to 7 UTC-day buckets (oldest first); empty when <1 day of history */
     snapshot_7d: ScreenerSnapshotPoint[];
+    /** Asset-class category: crypto, equities, or commodities */
+    category: string;
+    /** Life-to-date cumulative quote-token volume since inception ("0" if no trades yet) */
+    total_quote_volume_ltd: string;
+    /** Life-to-date cumulative number of trades since inception (0 if no trades yet) */
+    total_trade_count_ltd: number;
 }
 /**
  * Paginated screener response, sorted by quote_volume_24h desc (nulls last)
@@ -240,6 +252,21 @@ export interface MarketMetadata {
     price_change_percent_24h: string | null;
     /** Unix timestamp (ms) when market started trading (null if not available) */
     market_initialization_timestamp: number | null;
+    /** Life-to-date cumulative base-token volume since inception ("0" if no trades yet) */
+    total_base_volume_ltd: string;
+    /** Life-to-date cumulative quote-token volume since inception ("0" if no trades yet) */
+    total_quote_volume_ltd: string;
+    /** Life-to-date cumulative number of trades since inception (0 if no trades yet) */
+    total_trade_count_ltd: number;
+}
+/**
+ * Exchange-wide life-to-date cumulative statistics across all trading pairs.
+ */
+export interface MarketStats {
+    /** Life-to-date cumulative quote-token (notional) volume summed across all pairs */
+    total_quote_volume_ltd: string;
+    /** Life-to-date cumulative number of trades summed across all pairs */
+    total_trade_count_ltd: number;
 }
 export interface RiskTier {
     notional_floor: string;
@@ -364,6 +391,12 @@ export interface MarketAPI extends BaseAPI {
      * @returns Promise resolving to the paginated screener response
      */
     getScreener(params?: GetScreenerParams): Promise<GetScreenerResponse>;
+    /**
+     * Fetch exchange-wide life-to-date cumulative statistics across all trading
+     * pairs: total quote-token (notional) volume and total number of trades.
+     * @returns Promise resolving to the global market stats
+     */
+    getMarketStats(): Promise<MarketStats>;
     /**
      * Fetch historical candlestick data for a trading pair.
      *

package/dist/validation/vault.d.ts

@@ -44,6 +44,10 @@ export declare const DepositSchema: z.ZodObject<{
     assetId: z.ZodUUID;
     amount: z.ZodUnion<readonly [z.ZodString, z.ZodBigInt]>;
     autoWait: z.ZodOptional<z.ZodBoolean>;
+    target: z.ZodOptional<z.ZodEnum<{
+        spot: "spot";
+        margin: "margin";
+    }>>;
 }, z.core.$strip>;
 /**
  * Withdraw validation schema.

package/dist/validation/vault.js

@@ -57,6 +57,8 @@ export const DepositSchema = z.object({
     assetId: UUIDSchema,
     amount: PositiveBigIntStringSchema,
     autoWait: z.boolean().optional(),
+    // Destination ledger: "spot" (default) or "margin" to route into margin collateral.
+    target: z.enum(["spot", "margin"]).optional(),
 });
 /**
  * Withdraw validation schema.

package/dist/vault/index.d.ts

@@ -5,6 +5,15 @@
  */
 import type { BaseAPI } from "../api/index";
 import type { Balance, TransactionResult, WithdrawResult } from "./responses";
+/**
+ * Destination ledger for a deposit.
+ * - `"spot"` (default): credit the spot/main wallet — unchanged behavior.
+ * - `"margin"`: route the deposit straight into the parent margin account's
+ *   collateral (auto-creating the account if it does not exist yet). A deposit
+ *   that cannot be routed to margin (unsupported asset, etc.) safely falls back
+ *   to spot — funds are never lost.
+ */
+export type DepositTarget = "spot" | "margin";
 /**
  * Vault API interface.
  * Provides methods for managing token deposits and withdrawals.
@@ -24,9 +33,12 @@ export interface VaultAPI extends BaseAPI {
      * @param assetId - Asset identifier (UUID) to deposit
      * @param amount - Amount to deposit
      * @param autoWait - Whether to automatically wait for transaction confirmation (defaults to true)
+     * @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.
      * @returns Promise resolving to the transaction result
      */
-    deposit(assetId: string, amount: bigint, autoWait?: boolean): Promise<TransactionResult>;
+    deposit(assetId: string, amount: bigint, autoWait?: boolean, target?: DepositTarget): Promise<TransactionResult>;
     /**
      * Initiates a withdrawal: allocates a `withdrawalIndex` via the API Gateway,
      * receives pre-signed calldata for `executeSignedWithdrawal(...)`, and

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_position_margin", "attach_position_tp_sl", "authenticate_backend", "batch_cancel_all", "batch_cancel_all_by_pair", "batch_cancel_orders", "batch_create_orders", "batch_replace_orders", "cancel_conditional_order", "cancel_order", "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_funding_state", "get_index_price", "get_margin_account_movements", "get_margin_account_summary", "get_mark_price", "get_market_metadata", "get_open_interest", "get_order_by_id", "get_orderbook_snapshot", "get_orders", "get_perp_market_config", "get_perp_market_summary", "get_portfolio_chart", "get_portfolio_stats", "get_position", "get_position_risk", "get_screener", "get_sub_account_limits", "get_trade_by_id", "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_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_position_history", "list_positions", "list_sub_accounts_with_balances", "list_trading_pairs", "mint_tokens", "reduce_position_margin", "refresh_session", "replace_order", "revoke_delegated_agent", "revoke_session", "simulate_auto_margin_order_risk", "simulate_fees", "simulate_order_risk", "submit_whitelist", "transfer_collateral_from_margin_account", "transfer_collateral_to_auto_margin_account", "transfer_collateral_to_margin_account", "update_sub_account_limit", "upsert_delegated_agent", "verify_signature"];
+export declare const OPERATION_IDS: readonly ["add_position_margin", "attach_position_tp_sl", "authenticate_backend", "batch_cancel_all", "batch_cancel_all_by_pair", "batch_cancel_orders", "batch_create_orders", "batch_replace_orders", "cancel_conditional_order", "cancel_order", "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_funding_state", "get_index_price", "get_margin_account_movements", "get_margin_account_summary", "get_mark_price", "get_market_metadata", "get_market_stats", "get_open_interest", "get_order_by_id", "get_orderbook_snapshot", "get_orders", "get_perp_market_config", "get_perp_market_summary", "get_portfolio_chart", "get_portfolio_stats", "get_position", "get_position_risk", "get_screener", "get_sub_account_limits", "get_trade_by_id", "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_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_position_history", "list_positions", "list_sub_accounts_with_balances", "list_trading_pairs", "mint_tokens", "reduce_position_margin", "refresh_session", "replace_order", "revoke_delegated_agent", "revoke_session", "simulate_auto_margin_order_risk", "simulate_fees", "simulate_order_risk", "submit_whitelist", "transfer_collateral_from_margin_account", "transfer_collateral_to_auto_margin_account", "transfer_collateral_to_margin_account", "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

@@ -37,6 +37,7 @@ export const OPERATION_IDS = [
     "get_margin_account_summary",
     "get_mark_price",
     "get_market_metadata",
+    "get_market_stats",
     "get_open_interest",
     "get_order_by_id",
     "get_orderbook_snapshot",

package/dist/wire/schema.d.ts

@@ -1089,6 +1089,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/market/stats": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Market Stats
+         * @description Market Stats
+         *
+         *      Exchange-wide life-to-date (since-inception) cumulative totals across all
+         *      trading pairs: total quote-token volume and total number of trades. No
+         *      auth required.
+         */
+        get: operations["get_market_stats"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/orderbook/{trading_pair_id}": {
         parameters: {
             query?: never;
@@ -2788,6 +2812,13 @@ export interface components {
             wallet_available?: string | null;
             wallet_locked?: string | null;
             margin_transferable?: string | null;
+            /**
+             * @description Free collateral currently held in the user's parent margin account for this
+             *      asset (equity minus initial margin required), i.e. collateral already inside
+             *      margin and available to open new positions or transfer back out. Absent when
+             *      the user has no margin account yet.
+             */
+            margin_available_collateral?: string | null;
         };
         GetBalanceByAssetResponse: {
             /** @description Token contract address */
@@ -3024,6 +3055,34 @@ export interface components {
              * @example 95400.00
              */
             index_price?: string | null;
+            /**
+             * @description Life-to-date cumulative base-token volume (since market inception); "0" for a pair with no trades yet
+             * @example 123456.78900000
+             */
+            total_base_volume_ltd?: string | null;
+            /**
+             * @description Life-to-date cumulative quote-token volume (since market inception); "0" for a pair with no trades yet
+             * @example 9123456789.50
+             */
+            total_quote_volume_ltd?: string | null;
+            /**
+             * @description Life-to-date cumulative number of trades (since market inception); 0 for a pair with no trades yet
+             * @example 482931
+             */
+            total_trade_count_ltd?: string | null;
+        };
+        /** @description Exchange-wide life-to-date cumulative market statistics across all trading pairs. */
+        GetMarketStatsResponse: {
+            /**
+             * @description Life-to-date cumulative quote-token (notional) volume summed across all trading pairs
+             * @example 48217365920.75
+             */
+            total_quote_volume_ltd?: string | null;
+            /**
+             * @description Life-to-date cumulative number of trades summed across all trading pairs
+             * @example 19284736
+             */
+            total_trade_count_ltd?: string | null;
         };
         GetMovementsResponse: {
             movements?: components["schemas"]["LedgerMovement"][] | null;
@@ -4428,6 +4487,21 @@ export interface components {
             price_change_percent_7d?: string | null;
             /** @description Up to 7 UTC-day buckets (oldest first); empty when <1 day of history */
             snapshot_7d?: components["schemas"]["ScreenerSnapshotPoint"][] | null;
+            /**
+             * @description Asset-class category: crypto, equities, or commodities
+             * @example crypto
+             */
+            category?: string | null;
+            /**
+             * @description Life-to-date cumulative quote-token volume (since market inception); "0" for a pair with no trades yet
+             * @example 9123456789.50
+             */
+            total_quote_volume_ltd?: string | null;
+            /**
+             * @description Life-to-date cumulative number of trades (since market inception); 0 for a pair with no trades yet
+             * @example 482931
+             */
+            total_trade_count_ltd?: string | null;
         };
         /** @description One UTC-day bucket in a pair's 7-day snapshot. */
         ScreenerSnapshotPoint: {
@@ -4838,6 +4912,11 @@ export interface components {
              * @example 20
              */
             max_leverage?: string | null;
+            /**
+             * @description Asset-class category: crypto, equities, or commodities
+             * @example crypto
+             */
+            category?: string | null;
         };
         TransferCollateralFromMarginAccountRequest: {
             /** @description Margin account UUID whose current isolated bucket releases collateral. */
@@ -6908,6 +6987,7 @@ export interface operations {
                 base_token?: string;
                 quote_token?: string;
                 is_active?: boolean;
+                category?: string;
             };
             header?: never;
             path?: never;
@@ -7250,6 +7330,7 @@ export interface operations {
                 /** @description Filter by market type */
                 market_type?: "SPOT" | "MARGIN";
                 is_active?: boolean;
+                category?: string;
             };
             header?: never;
             path?: never;
@@ -7282,6 +7363,33 @@ export interface operations {
             };
         };
     };
+    get_market_stats: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetMarketStatsResponse"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     get_orderbook_snapshot: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@0xmonaco/types",
-	"version": "0.8.10",
+	"version": "0.8.11",
 	"type": "module",
 	"repository": {
 		"type": "git",
@@ -20,7 +20,7 @@
 		"lint": "biome lint ."
 	},
 	"dependencies": {
-		"@0xmonaco/contracts": "0.8.10",
+		"@0xmonaco/contracts": "0.8.11",
 		"zod": "^4.1.12"
 	},
 	"peerDependencies": {