@0xmonaco/types 0.8.22-develop.efb9dc9 → 1.0.2

package/dist/wire/schema.d.ts

@@ -1910,7 +1910,10 @@ export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
         AccountBalance: {
-            /** @description Token contract address */
+            /**
+             * @description Token contract address
+             * @example 0x6a86da986797d59a839d136db490292cd560c131
+             */
             token?: string | null;
             /**
              * @description Token symbol
@@ -1980,7 +1983,10 @@ export interface components {
              * @example 123e4567-e89b-12d3-a456-426614174000
              */
             id?: string | null;
-            /** @description Wallet address */
+            /**
+             * @description Wallet address
+             * @example 0x742d35Cc6634C0532925a3b8D4060f31E2C3d8B5
+             */
             address?: string | null;
             /**
              * @description Display username
@@ -2617,7 +2623,10 @@ export interface components {
             message?: string | null;
         };
         Candle: {
-            /** @description Unix timestamp for the start of the candle period in milliseconds */
+            /**
+             * @description Unix timestamp for the start of the candle period in milliseconds
+             * @example 1699800000000
+             */
             timestamp?: string | null;
             /**
              * @description Opening price
@@ -2655,18 +2664,27 @@ export interface components {
              * @example 342
              */
             tradeCount?: number | null;
-            /** @description Unix timestamp for the end of the candle period in milliseconds */
+            /**
+             * @description Unix timestamp for the end of the candle period in milliseconds
+             * @example 1699800059999
+             */
             closeTimestampMs?: string | null;
         };
         ChallengeRequest: {
-            /** @description Ethereum wallet address */
+            /**
+             * @description Ethereum wallet address
+             * @example 0x742d35Cc6634C0532925a3b8D4060f31E2C3d8B5
+             */
             address: string;
             /**
              * @description Optional application identifier
              * @example monaco-frontend
              */
             clientId?: string | null;
-            /** @description Optional chain ID supplied by SDK clients */
+            /**
+             * @description Optional chain ID supplied by SDK clients
+             * @example 1328
+             */
             chainId?: string | null;
             /**
              * @description Lowercase hex (64 chars) ed25519 public key generated locally by the SDK. The returned challenge message will embed this key so the wallet's signature binds it; the same value must be submitted to /api/v1/auth/verify.
@@ -2759,7 +2777,10 @@ export interface components {
             sessionPublicKey?: string | null;
         };
         CreateDelegatedSessionResponse: {
-            /** @description Session expiry as a Unix timestamp (seconds) */
+            /**
+             * @description Session expiry as a Unix timestamp (seconds)
+             * @example 1735689599
+             */
             expiresAt?: string | null;
             /**
              * Format: uuid
@@ -2959,7 +2980,10 @@ export interface components {
              * @description Owner account UUID the agent acts on behalf of
              */
             ownerUserId?: string | null;
-            /** @description Agent wallet address (EVM) */
+            /**
+             * @description Agent wallet address (EVM)
+             * @example 0x742d35cc6634c0532925a3b8d4060f31e2c3d8b5
+             */
             agentAddress?: string | null;
             /** @description Human-friendly label for the agent */
             name?: string | null;
@@ -3164,7 +3188,10 @@ export interface components {
              * @example 5.67
              */
             applicationTakerFee?: string | null;
-            /** @description Total number of trades */
+            /**
+             * @description Total number of trades
+             * @example 42
+             */
             tradeCount?: string | null;
         };
         GetAvailableCollateralResponse: {
@@ -3181,7 +3208,10 @@ export interface components {
             marginAvailableCollateral?: string | null;
         };
         GetBalanceByAssetResponse: {
-            /** @description Token contract address */
+            /**
+             * @description Token contract address
+             * @example 0x6a86da986797d59a839d136db490292cd560c131
+             */
             token?: string | null;
             /**
              * @description Token symbol
@@ -3277,7 +3307,10 @@ export interface components {
             allowedOrigins?: string[] | null;
             /** @description Webhook URL for notifications */
             webhookUrl?: string | null;
-            /** @description Vault contract address for this application */
+            /**
+             * @description Vault contract address for this application
+             * @example 0xA393B04EA77354570Ace35869F5EbB1e380DC232
+             */
             vaultContractAddress?: string | null;
             /**
              * @description Application client ID, embedded in on-chain deposit calls
@@ -3861,9 +3894,15 @@ export interface components {
              * @example 231.81
              */
             volume?: string | null;
-            /** @description Number of trades in period */
+            /**
+             * @description Number of trades in period
+             * @example 42
+             */
             totalTrades?: string | null;
-            /** @description Number of orders in period */
+            /**
+             * @description Number of orders in period
+             * @example 56
+             */
             totalOrders?: string | null;
             /**
              * @description Total fees paid by user
@@ -3987,7 +4026,10 @@ export interface components {
              * @example 123e4567-e89b-12d3-a456-426614174000
              */
             id?: string | null;
-            /** @description Wallet address */
+            /**
+             * @description Wallet address
+             * @example 0x742d35Cc6634C0532925a3b8D4060f31E2C3d8B5
+             */
             address?: string | null;
             /**
              * @description Display username
@@ -4087,7 +4129,10 @@ export interface components {
             tradingMode?: string | null;
         };
         GetTraderCodeInfoResponse: {
-            /** @description The resolved TraderCode (normalized wallet address) */
+            /**
+             * @description The resolved TraderCode (normalized wallet address)
+             * @example 0x0000000000000000000000000000000000000002
+             */
             code?: string | null;
         };
         /** @description Recent trades for a trading pair. */
@@ -4112,13 +4157,25 @@ export interface components {
         };
         GetUserTradesResponse: {
             trades?: components["schemas"]["UserTrade"][] | null;
-            /** @description Current page number */
+            /**
+             * @description Current page number
+             * @example 1
+             */
             page?: string | null;
-            /** @description Items per page */
+            /**
+             * @description Items per page
+             * @example 20
+             */
             pageSize?: string | null;
-            /** @description Total number of trades */
+            /**
+             * @description Total number of trades
+             * @example 150
+             */
             total?: string | null;
-            /** @description Total number of pages */
+            /**
+             * @description Total number of pages
+             * @example 8
+             */
             totalPages?: string | null;
         };
         IndexComponent: {
@@ -4139,7 +4196,10 @@ export interface components {
              * @example 1000000000000000000
              */
             amount?: string | null;
-            /** @description On-chain address that will receive the withdrawal (EVM, 42 chars including 0x) */
+            /**
+             * @description On-chain address that will receive the withdrawal (EVM, 42 chars including 0x)
+             * @example 0x742d35cc6634c0532925a3b8d4060f31e2c3d8b5
+             */
             destination?: string | null;
             /**
              * @description Source ledger to withdraw from: "spot" (default) debits spot balance; "margin" directly debits withdrawable collateral from the parent margin account
@@ -4169,7 +4229,10 @@ export interface components {
              * @example 100.50
              */
             amount?: string | null;
-            /** @description Token contract address */
+            /**
+             * @description Token contract address
+             * @example 0x6a86da986797d59a839d136db490292cd560c131
+             */
             token?: string | null;
             /**
              * @description Available balance before this movement
@@ -4206,9 +4269,15 @@ export interface components {
              * @example USDC deposit
              */
             description?: string | null;
-            /** @description On-chain transaction hash (if applicable) */
+            /**
+             * @description On-chain transaction hash (if applicable)
+             * @example 0xabc123...
+             */
             txHash?: string | null;
-            /** @description Block number of the on-chain transaction */
+            /**
+             * @description Block number of the on-chain transaction
+             * @example 18500000
+             */
             blockNumber?: string | null;
             /**
              * @description Movement timestamp (ISO 8601)
@@ -4649,7 +4718,10 @@ export interface components {
              * @example 10000.00
              */
             amount?: string | null;
-            /** @description On-chain transaction hash */
+            /**
+             * @description On-chain transaction hash
+             * @example 0xabc123def456...
+             */
             txHash?: string | null;
         };
         OrderbookData: {
@@ -4716,7 +4788,10 @@ export interface components {
          *      is confirmed on-chain; fetch it from GetWithdrawal once it becomes ready).
          */
         PendingWithdrawal: {
-            /** @description Allocated withdrawal index — matches executeWithdrawal.index on-chain */
+            /**
+             * @description Allocated withdrawal index — matches executeWithdrawal.index on-chain
+             * @example 42
+             */
             withdrawalIndex?: string | null;
             /**
              * Format: uuid
@@ -4734,7 +4809,10 @@ export interface components {
              * @example 1000000000000000000
              */
             amount?: string | null;
-            /** @description On-chain address that will receive the withdrawal (EVM, 42 chars including 0x) */
+            /**
+             * @description On-chain address that will receive the withdrawal (EVM, 42 chars including 0x)
+             * @example 0x742d35cc6634c0532925a3b8d4060f31e2c3d8b5
+             */
             destination?: string | null;
             /**
              * @description Withdrawal lifecycle status; always "pending" for entries in this response
@@ -5035,7 +5113,10 @@ export interface components {
             message?: string | null;
         };
         RewardsBalanceEntry: {
-            /** @description Reward token contract address (0x-prefixed). */
+            /**
+             * @description Reward token contract address (0x-prefixed).
+             * @example 0x0000000000000000000000000000000000000002
+             */
             token?: string | null;
             /**
              * @description Available rewards balance in RAW atomic units of the token.
@@ -5298,7 +5379,10 @@ export interface components {
              * @example 123e4567-e89b-12d3-a456-426614174000
              */
             id?: string | null;
-            /** @description Sub-account wallet address */
+            /**
+             * @description Sub-account wallet address
+             * @example 0x742d35Cc6634C0532925a3b8D1B9d7c2bd34e8Dc
+             */
             address?: string | null;
             /**
              * @description Sub-account display username
@@ -5330,7 +5414,10 @@ export interface components {
              * @example 123e4567-e89b-12d3-a456-426614174000
              */
             subAccountId?: string | null;
-            /** @description Token contract address */
+            /**
+             * @description Token contract address
+             * @example 0x6a86da986797d59a839d136db490292cd560c131
+             */
             token?: string | null;
             /**
              * @description Maximum daily spending limit in token units
@@ -5375,7 +5462,10 @@ export interface components {
             isActive?: boolean | null;
         };
         SubmitWhitelistRequest: {
-            /** @description Applicant wallet address */
+            /**
+             * @description Applicant wallet address
+             * @example 0x742d35Cc6634C0532925a3b8D4060f31E2C3d8B5
+             */
             walletAddress: string;
             /**
              * Format: email
@@ -5452,7 +5542,10 @@ export interface components {
             tradeId?: string | null;
         };
         TraderCodeResponse: {
-            /** @description Your TraderCode — your normalized wallet address (clients render it `Monaco - <address>`). */
+            /**
+             * @description Your TraderCode — your normalized wallet address (clients render it `Monaco - <address>`).
+             * @example 0x0000000000000000000000000000000000000002
+             */
             code?: string | null;
             /**
              * @description RFC 3339 timestamp when the code row was first derived
@@ -5484,7 +5577,10 @@ export interface components {
              * @example BTC
              */
             baseToken?: string | null;
-            /** @description Base token contract address */
+            /**
+             * @description Base token contract address
+             * @example 0x1234567890abcdef1234567890abcdef12345678
+             */
             baseTokenContract?: string | null;
             /**
              * Format: uuid
@@ -5540,7 +5636,10 @@ export interface components {
              * @example USDC
              */
             quoteToken?: string | null;
-            /** @description Quote token contract address */
+            /**
+             * @description Quote token contract address
+             * @example 0x6a86da986797d59a839d136db490292cd560c131
+             */
             quoteTokenContract?: string | null;
             /**
              * @description Trading pair symbol
@@ -5661,7 +5760,10 @@ export interface components {
             selectedTradingPairIds?: string[] | null;
         };
         TransferRewardsRequest: {
-            /** @description Reward token contract address (0x-prefixed) to transfer. */
+            /**
+             * @description Reward token contract address (0x-prefixed) to transfer.
+             * @example 0x0000000000000000000000000000000000000002
+             */
             token: string;
             /**
              * @description Amount to transfer, in RAW atomic units of the token.
@@ -5726,7 +5828,10 @@ export interface components {
             quantity?: string | null;
         };
         UpsertDelegatedAgentRequest: {
-            /** @description Agent wallet address (EVM, 42 chars including 0x) */
+            /**
+             * @description Agent wallet address (EVM, 42 chars including 0x)
+             * @example 0x742d35cc6634c0532925a3b8d4060f31e2c3d8b5
+             */
             agentAddress?: string | null;
             /**
              * @description Optional human-friendly label for the agent
@@ -5788,7 +5893,10 @@ export interface components {
              * @example 123e4567-e89b-12d3-a456-426614174000
              */
             id?: string | null;
-            /** @description Wallet address */
+            /**
+             * @description Wallet address
+             * @example 0x742d35Cc6634C0532925a3b8D4060f31E2C3d8B5
+             */
             address?: string | null;
             /**
              * @description Display username
@@ -5812,9 +5920,15 @@ export interface components {
             timestamp?: string | null;
         };
         VerifyRequest: {
-            /** @description Ethereum wallet address */
+            /**
+             * @description Ethereum wallet address
+             * @example 0x742d35Cc6634C0532925a3b8D4060f31E2C3d8B5
+             */
             address: string;
-            /** @description Wallet signature over the challenge message */
+            /**
+             * @description Wallet signature over the challenge message
+             * @example 0x1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0
+             */
             signature: string;
             /**
              * @description Challenge nonce
@@ -5826,14 +5940,20 @@ export interface components {
              * @example monaco-frontend
              */
             clientId?: string | null;
-            /** @description Optional chain ID supplied by SDK clients */
+            /**
+             * @description Optional chain ID supplied by SDK clients
+             * @example 1328
+             */
             chainId?: string | null;
             /**
              * @description Lowercase hex (64 chars) ed25519 public key generated locally by the SDK. Subsequent authenticated requests are signed with the matching private key. The wallet's signature on the challenge message proves the user authorized this specific public key.
              * @example 3b6a27bcceb6a42d62a3a8d02a6f0d73653215771de243a63ac048a18b59da29
              */
             sessionPublicKey: string;
-            /** @description Optional PitPass TraderCode captured at signup (e.g. from a `?ref=CODE` link). When a user verifies for the very first time with a valid code, a referral relationship is recorded atomically. Ignored for users who already exist, and silently ignored if the code is unknown — a bad code never blocks sign-in. */
+            /**
+             * @description Optional PitPass TraderCode captured at signup (e.g. from a `?ref=CODE` link). When a user verifies for the very first time with a valid code, a referral relationship is recorded atomically. Ignored for users who already exist, and silently ignored if the code is unknown — a bad code never blocks sign-in.
+             * @example 0x1234567890abcdef1234567890abcdef12345678
+             */
             referralCode?: string | null;
         };
         VerifyResponse: {
@@ -5846,9 +5966,15 @@ export interface components {
             user?: components["schemas"]["UserInfo"];
         };
         Withdrawal: {
-            /** @description Allocated withdrawal index — matches executeWithdrawal.index on-chain */
+            /**
+             * @description Allocated withdrawal index — matches executeWithdrawal.index on-chain
+             * @example 42
+             */
             withdrawalIndex?: string | null;
-            /** @description 0x-prefixed lowercase address of the vault contract the calldata is submitted to */
+            /**
+             * @description 0x-prefixed lowercase address of the vault contract the calldata is submitted to
+             * @example 0x5fbdb2315678afecb367f032d93f642f64180aa3
+             */
             vaultAddress?: string | null;
             /** @description 0x-prefixed ABI-encoded executeWithdrawal(...) calldata; submit as tx.data to the vault. Empty on InitiateWithdrawal (the merkle proof is not available until the withdrawal root is confirmed on-chain) — fetch it from GetWithdrawal once ready */
             calldata?: string | null;

package/package.json

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