@0xmonaco/types 1.0.91 → 1.0.92

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; // Use "staging" for public testnet or "mainnet" for production
+  network: Network; // Use "mainnet" (Sei mainnet, production API)
   seiRpcUrl: string; // RPC URL for Sei blockchain interactions
 }
 
@@ -305,7 +305,7 @@ Types for network configuration:
 ```typescript
 import { Network, NetworkEndpoints } from "@0xmonaco/types";
 
-const publicNetwork: Network = "staging";
+const publicNetwork: Network = "mainnet";
 
 interface NetworkEndpoints {
   rpcUrl: string;
@@ -313,7 +313,7 @@ interface NetworkEndpoints {
 }
 ```
 
-For public integrations, use `"staging"` or `"mainnet"`.
+For public integrations, use `"mainnet"`.
 
 ## Type Reference
 
@@ -321,7 +321,7 @@ For public integrations, use `"staging"` or `"mainnet"`.
 
 - `MonacoSDK`: Main SDK interface with all API modules
 - `SDKConfig`: Configuration options for the Monaco SDK
-- `Network`: SDK network preset type. Public integrations should use `"staging"` or `"mainnet"`.
+- `Network`: SDK network preset type. Public integrations should use `"mainnet"`.
 - `AuthState`: Authentication state information
 
 ### Vault Types

package/dist/auth/index.d.ts

@@ -164,3 +164,17 @@ export declare const INVITE_ERROR_CODES: {
     readonly INVITE_CODE_INVALID: "INVITE_CODE_INVALID";
 };
 export type InviteErrorCode = (typeof INVITE_ERROR_CODES)[keyof typeof INVITE_ERROR_CODES];
+/**
+ * Stable codes for a wallet on the OFAC sanctions list, read from
+ * `APIError.serverCode` (REST error envelope `code`, which here is also the
+ * envelope `error`; gRPC `google.rpc.ErrorInfo` reason in the
+ * `auth.0xmonaco.com` domain). Both are HTTP 403 / gRPC `PERMISSION_DENIED`,
+ * and the envelope `message` is meant to be shown to the user as-is.
+ */
+export declare const SANCTIONS_ERROR_CODES: {
+    /** Sign-in with a listed wallet, or a withdrawal to a listed destination. */
+    readonly ADDRESS_RESTRICTED: "ADDRESS_RESTRICTED";
+    /** A live session whose wallet (or delegated agent) is listed; returned on every signed request and on WebSocket authentication/revalidation. */
+    readonly ACCOUNT_RESTRICTED: "ACCOUNT_RESTRICTED";
+};
+export type SanctionsErrorCode = (typeof SANCTIONS_ERROR_CODES)[keyof typeof SANCTIONS_ERROR_CODES];

package/dist/auth/index.js

@@ -20,3 +20,16 @@ export const INVITE_ERROR_CODES = {
     /** The invite code was not accepted (wrong, already redeemed, revoked, or issued by a deactivated wallet; deliberately indistinguishable). */
     INVITE_CODE_INVALID: "INVITE_CODE_INVALID",
 };
+/**
+ * Stable codes for a wallet on the OFAC sanctions list, read from
+ * `APIError.serverCode` (REST error envelope `code`, which here is also the
+ * envelope `error`; gRPC `google.rpc.ErrorInfo` reason in the
+ * `auth.0xmonaco.com` domain). Both are HTTP 403 / gRPC `PERMISSION_DENIED`,
+ * and the envelope `message` is meant to be shown to the user as-is.
+ */
+export const SANCTIONS_ERROR_CODES = {
+    /** Sign-in with a listed wallet, or a withdrawal to a listed destination. */
+    ADDRESS_RESTRICTED: "ADDRESS_RESTRICTED",
+    /** A live session whose wallet (or delegated agent) is listed; returned on every signed request and on WebSocket authentication/revalidation. */
+    ACCOUNT_RESTRICTED: "ACCOUNT_RESTRICTED",
+};

package/dist/compliance/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Compliance Types
+ *
+ * Types for the public region status endpoint. Monaco refuses callers from a
+ * restricted jurisdiction on every other endpoint with HTTP 451 and the error
+ * code `REGION_RESTRICTED`; this endpoint answers from every region so a
+ * frontend can show a region notice instead.
+ *
+ * NOTE: This endpoint is **public (unauthenticated)**.
+ */
+import type { BaseAPI } from "../api";
+/** The caller's region status. */
+export interface GetRegionStatusResponse {
+    /** True when Monaco is not available in the caller's region. */
+    restricted: boolean;
+    /** ISO 3166-1 alpha-2 country code (`T1` Tor, `XX` unknown); empty when the request carried no location. */
+    country: string;
+}
+/**
+ * Compliance API interface. The endpoint is public (no auth required).
+ */
+export interface ComplianceAPI extends BaseAPI {
+    /**
+     * Get the caller's region status.
+     *
+     * Public/unauthenticated and always answers 200, including from restricted
+     * regions.
+     *
+     * @returns Promise resolving to the caller's region status
+     */
+    getRegionStatus(): Promise<GetRegionStatusResponse>;
+}

package/dist/compliance/index.js

@@ -0,0 +1,10 @@
+/**
+ * Compliance Types
+ *
+ * Types for the public region status endpoint. Monaco refuses callers from a
+ * restricted jurisdiction on every other endpoint with HTTP 451 and the error
+ * code `REGION_RESTRICTED`; this endpoint answers from every region so a
+ * frontend can show a region notice instead.
+ *
+ * NOTE: This endpoint is **public (unauthenticated)**.
+ */

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export * from "./api";
 export * from "./applications";
 export * from "./auth";
 export * from "./buildercodes";
+export * from "./compliance";
 export * from "./contracts";
 export * from "./copy-trading";
 export * from "./delegated-agents";

package/dist/index.js

@@ -9,6 +9,7 @@ export * from "./api";
 export * from "./applications";
 export * from "./auth";
 export * from "./buildercodes";
+export * from "./compliance";
 export * from "./contracts";
 export * from "./copy-trading";
 export * from "./delegated-agents";

package/dist/sdk/index.d.ts

@@ -2,6 +2,7 @@ import type { Address, PublicClient, TransactionReceipt, WalletClient } from "vi
 import type { ApplicationsAPI } from "../applications";
 import type { AuthAPI, AuthState } from "../auth/index";
 import type { BuildercodesAPI } from "../buildercodes";
+import type { ComplianceAPI } from "../compliance";
 import type { CopyTradingAPI } from "../copy-trading";
 import type { DelegatedAgentsAPI } from "../delegated-agents";
 import type { FaucetAPI } from "../faucet";
@@ -130,6 +131,8 @@ export interface MonacoSDK {
     profile: ProfileAPI;
     /** Public market-pulse news feed API (cached, hourly-refreshed) */
     pulse: PulseAPI;
+    /** Public region status API: whether Monaco is available in the caller's region */
+    compliance: ComplianceAPI;
     /** Orderbook REST API for fetching orderbook snapshots */
     orderbook: {
         getOrderbook: (tradingPairId: string, options?: {

package/dist/websocket/base.d.ts

@@ -106,6 +106,8 @@ export type WebSocketErrorCode =
  | "AUTH_FAILED"
 /** The account is deactivated; the connection closes and must not automatically reconnect. */
  | "ACCOUNT_DEACTIVATED"
+/** The session's wallet is on the OFAC sanctions list; the connection closes and must not automatically reconnect. */
+ | "ACCOUNT_RESTRICTED"
 /** The per-user concurrent-connection cap was reached; this connection is closed after the frame. */
  | "CONNECTION_LIMIT"
 /** The per-connection subscription-cardinality cap was reached. */
@@ -170,9 +172,10 @@ export interface WebSocketReauthenticationInfo {
     /**
      * The `Error` frame code that ended the connection: `SESSION_INVALID` (the
      * session was revoked or expired after the handshake) or `AUTH_FAILED` (the
-     * `Authenticate` handshake itself was rejected), or `ACCOUNT_DEACTIVATED`.
+     * `Authenticate` handshake itself was rejected), `ACCOUNT_DEACTIVATED`, or
+     * `ACCOUNT_RESTRICTED` (the wallet is on the OFAC sanctions list).
      */
-    code: "SESSION_INVALID" | "AUTH_FAILED" | "ACCOUNT_DEACTIVATED";
+    code: "SESSION_INVALID" | "AUTH_FAILED" | "ACCOUNT_DEACTIVATED" | "ACCOUNT_RESTRICTED";
     /** Human-readable description from the `Error` frame; for logging and display, never for branching. */
     message: string;
     /** WebSocket close code of the connection that was lost (1008 for `SESSION_INVALID`). */

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_follow_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", "cancel_twap_order", "check_trader_code_availability", "claim_buildercode_rewards", "claim_managed_market_lease", "clear_trader_code", "close_all_copy_positions", "close_follow_positions", "close_position", "close_sub_account", "create_challenge", "create_delegated_session", "create_order", "create_sub_account", "create_sub_account_limit", "create_twap_order", "delete_sub_account_limit", "get_application_config", "get_application_stats", "get_available_collateral", "get_buildercode_payout_summary", "get_buildercode_rewards_balance", "get_buildercodes_config", "get_candles", "get_conditional_order", "get_faucet_info", "get_follow", "get_funding_state", "get_index_price", "get_lead_trader", "get_liquidation_metrics", "get_margin_account_movements", "get_margin_account_pnl", "get_margin_account_summary", "get_mark_price", "get_market_metadata", "get_market_stats", "get_my_fee_tier", "get_my_lead_trader", "get_my_referral_downline", "get_my_referral_position", "get_my_referral_tree", "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_self_trade_prevention_default", "get_sub_account_limits", "get_sweeper_chains", "get_sweeper_deposit_status", "get_trade_by_id", "get_trade_flow", "get_trader_code_info", "get_trader_metrics", "get_trades", "get_trading_pair_by_id", "get_twap_order", "get_twap_order_tca", "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_builder_fee_changes", "list_buildercode_payouts", "list_conditional_orders", "list_delegated_agent_owners", "list_delegated_agents", "list_follow_leader_positions", "list_funding_history", "list_funding_payments", "list_invite_codes", "list_lead_trader_closed_trades", "list_lead_trader_open_positions", "list_lead_traders", "list_liquidation_events", "list_managed_market_assignments", "list_margin_accounts", "list_my_followers", "list_my_follows", "list_pending_withdrawals", "list_position_history", "list_positions", "list_sub_accounts_with_balances", "list_sweeper_deposits", "list_trading_pairs", "list_twap_order_slices", "list_twap_orders", "mint_tokens", "preview_follow", "refresh_managed_market_quotes", "refresh_session", "register_deposit_address", "replace_order", "request_invite_codes", "revoke_delegated_agent", "revoke_session", "set_builder_fee", "set_self_trade_prevention_default", "set_trader_code", "simulate_fees", "simulate_order_risk", "simulate_parent_margin_order_risk", "simulate_risk_bucket_order_risk", "stop_follow", "submit_whitelist", "transfer_collateral", "transfer_collateral_from_margin_account", "transfer_collateral_from_parent_margin_account", "transfer_collateral_from_sub_account", "transfer_collateral_to_margin_account", "transfer_collateral_to_parent_margin_account", "transfer_collateral_to_risk_bucket", "transfer_collateral_to_sub_account", "transfer_rewards", "update_sub_account_limit", "upsert_delegated_agent", "upsert_follow", "upsert_lead_trader", "verify_signature"];
+export declare const OPERATION_IDS: readonly ["add_follow_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", "cancel_twap_order", "check_trader_code_availability", "claim_buildercode_rewards", "claim_managed_market_lease", "clear_trader_code", "close_all_copy_positions", "close_follow_positions", "close_position", "close_sub_account", "create_challenge", "create_delegated_session", "create_order", "create_sub_account", "create_sub_account_limit", "create_twap_order", "delete_sub_account_limit", "get_application_config", "get_application_stats", "get_available_collateral", "get_buildercode_payout_summary", "get_buildercode_rewards_balance", "get_buildercodes_config", "get_candles", "get_conditional_order", "get_faucet_info", "get_follow", "get_funding_state", "get_index_price", "get_lead_trader", "get_liquidation_metrics", "get_margin_account_movements", "get_margin_account_pnl", "get_margin_account_summary", "get_mark_price", "get_market_metadata", "get_market_stats", "get_my_fee_tier", "get_my_lead_trader", "get_my_referral_downline", "get_my_referral_position", "get_my_referral_tree", "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_region_status", "get_rewards_balance", "get_screener", "get_self_trade_prevention_default", "get_sub_account_limits", "get_sweeper_chains", "get_sweeper_deposit_status", "get_trade_by_id", "get_trade_flow", "get_trader_code_info", "get_trader_metrics", "get_trades", "get_trading_pair_by_id", "get_twap_order", "get_twap_order_tca", "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_builder_fee_changes", "list_buildercode_payouts", "list_conditional_orders", "list_delegated_agent_owners", "list_delegated_agents", "list_follow_leader_positions", "list_funding_history", "list_funding_payments", "list_invite_codes", "list_lead_trader_closed_trades", "list_lead_trader_open_positions", "list_lead_traders", "list_liquidation_events", "list_managed_market_assignments", "list_margin_accounts", "list_my_followers", "list_my_follows", "list_pending_withdrawals", "list_position_history", "list_positions", "list_sub_accounts_with_balances", "list_sweeper_deposits", "list_trading_pairs", "list_twap_order_slices", "list_twap_orders", "mint_tokens", "preview_follow", "refresh_managed_market_quotes", "refresh_session", "register_deposit_address", "replace_order", "request_invite_codes", "revoke_delegated_agent", "revoke_session", "set_builder_fee", "set_self_trade_prevention_default", "set_trader_code", "simulate_fees", "simulate_order_risk", "simulate_parent_margin_order_risk", "simulate_risk_bucket_order_risk", "stop_follow", "submit_whitelist", "transfer_collateral", "transfer_collateral_from_margin_account", "transfer_collateral_from_parent_margin_account", "transfer_collateral_from_sub_account", "transfer_collateral_to_margin_account", "transfer_collateral_to_parent_margin_account", "transfer_collateral_to_risk_bucket", "transfer_collateral_to_sub_account", "transfer_rewards", "update_sub_account_limit", "upsert_delegated_agent", "upsert_follow", "upsert_lead_trader", "verify_signature"];
 /** Union of every OpenAPI operationId in the spec. */
 export type OperationId = (typeof OPERATION_IDS)[number];

package/dist/wire/operations.js

@@ -82,6 +82,7 @@ export const OPERATION_IDS = [
     "get_position_pnl_history",
     "get_position_risk",
     "get_pulse",
+    "get_region_status",
     "get_rewards_balance",
     "get_screener",
     "get_self_trade_prevention_default",

package/dist/wire/schema.d.ts

@@ -968,6 +968,37 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/compliance/region": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the caller's region status
+         * @description Get the caller's region status.
+         *
+         *      Reports whether Monaco is available in the caller's region, so a
+         *      frontend can show a region notice instead of failing on the next call.
+         *      Public endpoint — no authentication required — and always answers 200.
+         *      Over REST it answers from restricted regions too: GET on this path is
+         *      the one request the production edge lets through. Over gRPC the edge
+         *      refuses a restricted caller with HTTP 451 before it reaches this RPC,
+         *      so clients that need the notice should call the REST endpoint. Every
+         *      other endpoint refuses callers from a restricted region with 451
+         *      REGION_RESTRICTED (gRPC: PERMISSION_DENIED with a google.rpc.ErrorInfo
+         *      reason REGION_RESTRICTED).
+         */
+        get: operations["get_region_status"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/copy-trading/follows": {
         parameters: {
             query?: never;
@@ -7235,6 +7266,18 @@ export interface components {
             /** @description Pulse items, pre-sorted: watchlist order first, MARKET last, most-recent-first within each asset. Items with unverified figures are removed server-side. */
             items?: components["schemas"]["PulseItem"][] | null;
         };
+        GetRegionStatusResponse: {
+            /**
+             * @description True when Monaco is not available in the caller's region; every other endpoint then answers 451 REGION_RESTRICTED
+             * @example false
+             */
+            restricted?: boolean | null;
+            /**
+             * @description The caller's ISO 3166-1 alpha-2 country code as the edge geolocated it (T1 for Tor, XX for unknown); empty when the request carried no location
+             * @example JP
+             */
+            country?: string | null;
+        };
         GetRewardsBalanceResponse: {
             /** @description One entry per reward token that has a non-zero available balance. */
             balances?: components["schemas"]["RewardsBalanceEntry"][] | null;
@@ -13651,7 +13694,7 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Origin not allowed for this application */
+            /** @description Origin not allowed for this application; or the wallet is on the OFAC sanctions list, refused with code ADDRESS_RESTRICTED (REST error envelope error and code; gRPC google.rpc.ErrorInfo reason, domain auth.0xmonaco.com) and the message "This wallet can't be used on Monaco." */
             403: {
                 headers: {
                     [name: string]: unknown;
@@ -13814,7 +13857,7 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Origin not allowed for this application; the account or wallet is deactivated; or Mainnet Invite Mode is on and the wallet has no access grant and supplied no valid invite code. Auth refusals carry a stable code (REST error envelope code; gRPC google.rpc.ErrorInfo reason, domain auth.0xmonaco.com): ACCOUNT_DEACTIVATED for a deactivated signing account, INVITE_CODE_REQUIRED when no code was supplied, and INVITE_CODE_INVALID for a wrong, already redeemed or revoked code, or an unused code whose issuer is deactivated. No account identity or administrative deactivation reason is disclosed. Unused invites become usable again after issuer reactivation */
+            /** @description Origin not allowed for this application; the account or wallet is deactivated; or Mainnet Invite Mode is on and the wallet has no access grant and supplied no valid invite code. Auth refusals carry a stable code (REST error envelope code; gRPC google.rpc.ErrorInfo reason, domain auth.0xmonaco.com): ACCOUNT_DEACTIVATED for a deactivated signing account, INVITE_CODE_REQUIRED when no code was supplied, and INVITE_CODE_INVALID for a wrong, already redeemed or revoked code, or an unused code whose issuer is deactivated. A wallet on the OFAC sanctions list is refused with ADDRESS_RESTRICTED. No account identity or administrative deactivation reason is disclosed. Unused invites become usable again after issuer reactivation */
             403: {
                 headers: {
                     [name: string]: unknown;
@@ -14290,6 +14333,26 @@ export interface operations {
             };
         };
     };
+    get_region_status: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetRegionStatusResponse"];
+                };
+            };
+        };
+    };
     list_my_follows: {
         parameters: {
             query?: {
@@ -19909,7 +19972,7 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Caller lacks the withdraw permission */
+            /** @description Caller lacks the withdraw permission; or the destination is on the OFAC sanctions list, refused with code ADDRESS_RESTRICTED (REST error envelope error and code; gRPC google.rpc.ErrorInfo reason, domain auth.0xmonaco.com) and the message "Withdrawals to this address aren't supported." */
             403: {
                 headers: {
                     [name: string]: unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@0xmonaco/types",
-	"version": "1.0.91",
+	"version": "1.0.92",
 	"type": "module",
 	"homepage": "https://docs.0xmonaco.com/sdk/typescript",
 	"main": "./dist/index.js",
@@ -16,7 +16,7 @@
 		"lint": "biome lint ."
 	},
 	"dependencies": {
-		"@0xmonaco/contracts": "1.0.91",
+		"@0xmonaco/contracts": "1.0.92",
 		"zod": "^4.1.12"
 	},
 	"peerDependencies": {