@0xmonaco/types 1.0.34 → 1.0.36

package/dist/index.d.ts

@@ -20,6 +20,7 @@ export * from "./profile";
 export * from "./pulse";
 export * from "./sdk";
 export * from "./sub-accounts";
+export * from "./sweeper";
 export * from "./trading";
 export * from "./validation";
 export * from "./vault";

package/dist/index.js

@@ -21,6 +21,7 @@ export * from "./profile";
 export * from "./pulse";
 export * from "./sdk";
 export * from "./sub-accounts";
+export * from "./sweeper";
 export * from "./trading";
 export * from "./validation";
 export * from "./vault";

package/dist/market/index.d.ts

@@ -16,8 +16,16 @@ export interface TradingPair {
     symbol: string;
     /** Base token symbol */
     baseToken: string;
+    /**
+     * Human-readable base asset display name (e.g. "Robinhood Markets" for
+     * HOOD). Sourced from the asset registry; use it to match markets by
+     * company or asset name in search, not just by ticker.
+     */
+    baseAssetName: string;
     /** Quote token symbol */
     quoteToken: string;
+    /** Human-readable quote asset display name (e.g. "USDC") */
+    quoteAssetName: string;
     /** Base asset ID (UUID) */
     baseAssetId: string;
     /** Quote asset ID (UUID) */

package/dist/sdk/index.d.ts

@@ -12,6 +12,7 @@ import type { PositionsAPI } from "../positions";
 import type { ProfileAPI } from "../profile";
 import type { PulseAPI } from "../pulse";
 import type { SubAccountsAPI } from "../sub-accounts";
+import type { SweeperAPI } from "../sweeper";
 import type { TradingAPI, TradingMode } from "../trading";
 import type { VaultAPI } from "../vault";
 import type { ConditionalOrderEvent, OHLCVEvent, OrderbookEvent, OrderbookQuotationMode, OrderEvent, TradeEvent, UserBalanceEvent, UserMovementEvent } from "../websocket";
@@ -98,6 +99,8 @@ export interface MonacoSDK {
     pitpass: PitpassAPI;
     /** Testnet faucet API */
     faucet: FaucetAPI;
+    /** Public deposit-address registration (sweeper) API */
+    sweeper: SweeperAPI;
     /** Public whitelist (waitlist) submission API */
     whitelist: WhitelistAPI;
     /** Profile operations API */

package/dist/sweeper/index.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Sweeper Types
+ *
+ * Types for the public deposit-address registration endpoint. Wire shapes are
+ * snake_case; these are the camelCase ergonomic forms.
+ *
+ * NOTE: This endpoint is **public (unauthenticated)**. The deposit address is
+ * derived from the (application, user) pair and its destination is fixed in the
+ * contract's own bytecode, so a caller can only ever route funds to the user
+ * they already belong to. Abuse is bounded by a per-client rate limit and an
+ * active-application check instead of authentication.
+ */
+import type { BaseAPI } from "../api";
+/**
+ * What happened to the registration.
+ *
+ * - `registered` — the pair was added; its deposit address is now monitored.
+ * - `already_registered` — the pair was known before this call; nothing was
+ *   re-triggered.
+ */
+export type RegisterSweeperStatus = "registered" | "already_registered";
+/** Body for a deposit-address registration. */
+export interface RegisterSweeperRequest {
+    /**
+     * The application's client id — the same identifier rollup deposits carry
+     * and `login` takes. The deposit address is derived from these exact bytes
+     * and the application lookup is an exact string match, so the spelling must
+     * match the registered application precisely.
+     */
+    clientId: string;
+    /** Address credited on the rollup, and half of the deposit-address derivation */
+    userAddress: string;
+}
+/** Result of a deposit-address registration. */
+export interface RegisterSweeperResponse {
+    /** Whether this call added the pair or it was known before */
+    status: RegisterSweeperStatus;
+    /**
+     * The pair's deposit address. Stable, and valid to publish and fund before
+     * any contract exists there.
+     */
+    sweeperAddress: string;
+    /**
+     * Whether the one-time registration balance check has completed. `false`
+     * right after a fresh registration; it runs in the background and flips
+     * once every pre-existing balance has been swept.
+     */
+    initialSweepCheck: boolean;
+}
+/**
+ * Sweeper API interface. The register endpoint is public (no auth required).
+ */
+export interface SweeperAPI extends BaseAPI {
+    /**
+     * Registers an (application, user) pair so its deterministic deposit
+     * address is monitored and every ERC20 deposit is swept into the rollup
+     * automatically.
+     *
+     * Returns immediately with the derived deposit address; the one-time
+     * initial balance check runs in the background. Idempotent and safe to
+     * retry: re-registering answers `already_registered` with the same address
+     * and never re-triggers the initial check. An unknown client id — any
+     * respelling of a real one included, the lookup is exact — throws (404),
+     * and registrations are lightly rate-limited per client (429).
+     */
+    register(body: RegisterSweeperRequest): Promise<RegisterSweeperResponse>;
+}

package/dist/sweeper/index.js

@@ -0,0 +1,12 @@
+/**
+ * Sweeper Types
+ *
+ * Types for the public deposit-address registration endpoint. Wire shapes are
+ * snake_case; these are the camelCase ergonomic forms.
+ *
+ * NOTE: This endpoint is **public (unauthenticated)**. The deposit address is
+ * derived from the (application, user) pair and its destination is fixed in the
+ * contract's own bytecode, so a caller can only ever route funds to the user
+ * they already belong to. Abuse is bounded by a per-client rate limit and an
+ * active-application check instead of authentication.
+ */

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", "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", "reduce_position_margin", "refresh_session", "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 ["add_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", "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", "reduce_position_margin", "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

@@ -97,6 +97,7 @@ export const OPERATION_IDS = [
     "mint_tokens",
     "reduce_position_margin",
     "refresh_session",
+    "register_deposit_address",
     "replace_order",
     "revoke_delegated_agent",
     "revoke_session",

package/dist/wire/schema.d.ts

@@ -1973,6 +1973,44 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/sweeper/register": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Register a deposit address for monitoring
+         * @description Register a deposit address for monitoring.
+         *
+         *      Every (application, user) pair has a deterministic deposit address. This
+         *      registers the pair so the sweeper service watches that address and
+         *      automatically forwards every ERC20 deposit into the rollup, crediting the
+         *      user under the application.
+         *
+         *      Registration also runs a one-time initial check in the background: any
+         *      balance already sitting on the address is swept without waiting for a new
+         *      transfer. The response returns immediately with the derived address; it
+         *      does not wait for that check.
+         *
+         *      Idempotent and safe to retry: re-registering an existing pair returns
+         *      `already_registered` with the same address and never re-triggers the
+         *      initial check.
+         *
+         *      Lightly rate-limited per client, and the client id must name an existing
+         *      application — the lookup is an exact string match, which is what pins the
+         *      one spelling the deposit address is derived from.
+         */
+        post: operations["register_deposit_address"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/trades/by-id/{tradeId}": {
         parameters: {
             query?: never;
@@ -5832,6 +5870,36 @@ export interface components {
              */
             expiresAt?: number | null;
         };
+        RegisterRequest: {
+            /**
+             * @description The application's client id — the same identifier rollup deposits carry and `login` takes. The deposit address is derived from these exact bytes and the application lookup is an exact string match, so the spelling must match the registered application precisely.
+             * @example 60eb377aab9f4ea18dcdf4747204c792
+             */
+            clientId: string;
+            /**
+             * @description Address credited on the rollup, and half of the deposit address derivation
+             * @example 0x742d35Cc6634C0532925a3b8D4060f31E2C3d8B5
+             */
+            userAddress: string;
+        };
+        RegisterResponse: {
+            /**
+             * @description `registered` when the pair was added, `already_registered` when it was known before this call
+             * @example registered
+             * @enum {string|null}
+             */
+            status?: "registered" | "already_registered" | null;
+            /**
+             * @description The pair's deposit address. Stable, and valid to publish and fund before any contract exists there.
+             * @example 0xcf1eF339798914EF7Ee4984Ed45BD141D63a65C9
+             */
+            sweeperAddress?: string | null;
+            /**
+             * @description Whether the one-time registration balance check has completed. `false` right after a fresh registration; it runs in the background and flips once every pre-existing balance has been swept.
+             * @example false
+             */
+            initialSweepCheck?: boolean | null;
+        };
         ReplaceOrderRequest: {
             /**
              * @description Use master account balance for sub-account orders
@@ -6530,6 +6598,16 @@ export interface components {
              * @example 0.00001
              */
             quantityStepSize?: string | null;
+            /**
+             * @description Human-readable base asset display name, from the asset registry. Lets clients match markets by company or asset name, e.g. a search for Robinhood finds HOOD
+             * @example Robinhood Markets
+             */
+            baseAssetName?: string | null;
+            /**
+             * @description Human-readable quote asset display name, from the asset registry
+             * @example USDC
+             */
+            quoteAssetName?: string | null;
         };
         TransferCollateralFromMarginAccountRequest: {
             /** @description Parent margin account UUID that releases collateral. */
@@ -10861,6 +10939,65 @@ export interface operations {
             };
         };
     };
+    register_deposit_address: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RegisterRequest"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RegisterResponse"];
+                };
+            };
+            /** @description Invalid request parameters */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Application not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Registration rate-limit exceeded */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Sweeper unavailable (not configured or resolver down); nothing was registered, safe to retry */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     get_trade_by_id: {
         parameters: {
             query?: never;

package/package.json

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