@0xmonaco/types 0.8.11 → 0.8.15

package/dist/withdrawals/index.d.ts

@@ -1,9 +1,11 @@
+import type { Address } from "viem";
 import type { BaseAPI } from "../api";
 /**
  * Request body for `POST /api/v1/withdrawals`.
  *
  * Initiating a withdrawal debits the caller's balance via the matching engine
- * and returns pre-signed `executeSignedWithdrawal` calldata. Master accounts
+ * and allocates a `withdrawalIndex`. The executable calldata is fetched
+ * separately once the withdrawal root is confirmed on-chain. Master accounts
  * with the withdraw permission only.
  */
 export interface InitiateWithdrawalRequest {
@@ -16,28 +18,97 @@ export interface InitiateWithdrawalRequest {
     amount: string;
     /** On-chain address that will receive the withdrawal (EVM, 0x-prefixed). */
     destination: string;
+    /**
+     * Source ledger for the withdrawal. Defaults to `"spot"` when omitted.
+     * `"margin"` directly debits withdrawable collateral from the parent margin
+     * account.
+     */
+    source?: "spot" | "margin";
 }
 /**
  * Response shape shared by `POST /api/v1/withdrawals` and
- * `GET /api/v1/withdrawals/{withdrawalIndex}`. Field names match the wire
- * (snake_case) form returned by the gateway.
+ * `GET /api/v1/withdrawals/{withdrawalIndex}`. Field names match the camelCase
+ * wire form returned by the gateway.
  */
 export interface WithdrawalResponse {
-    /** Allocated withdrawal index — matches `executeSignedWithdrawal.index` on-chain. */
-    withdrawal_index: number;
+    /** Allocated withdrawal index — matches `executeWithdrawal.index` on-chain. */
+    withdrawalIndex: number;
     /** 0x-prefixed lowercase address of the vault contract the calldata is submitted to. */
-    vault_address: string;
-    /** 0x-prefixed ABI-encoded, signed `executeSignedWithdrawal(...)` calldata; submit as `tx.data`. */
+    vaultAddress: Address;
+    /**
+     * 0x-prefixed ABI-encoded `executeWithdrawal(...)` calldata; submit as
+     * `tx.data`. Empty from `initiateWithdrawal` (the merkle proof is not
+     * available until the withdrawal root is confirmed on-chain) — fetch it from
+     * `getWithdrawal` once ready.
+     */
     calldata: string;
 }
 /**
- * Low-level withdrawals API: allocate a withdrawal and fetch its signed
- * calldata. Does not submit on-chain — see the vault API for the high-level
- * flow that also broadcasts the transaction.
+ * Low-level withdrawals API: allocate a withdrawal and fetch its
+ * `executeWithdrawal` calldata. Does not submit on-chain — see the vault API
+ * for the high-level flow that polls for the calldata and broadcasts the
+ * transaction.
  */
 export interface WithdrawalsAPI extends BaseAPI {
-    /** Initiate a withdrawal and return the signed calldata. Authenticated. */
+    /** Initiate a withdrawal and return its index. Authenticated. */
     initiateWithdrawal(request: InitiateWithdrawalRequest): Promise<WithdrawalResponse>;
-    /** Re-fetch a previously-initiated withdrawal's signed calldata. Public — no auth. */
+    /**
+     * Fetch a withdrawal's `executeWithdrawal` calldata by index. Public — no
+     * auth. Throws an `APIError` (404 not-persisted-yet / 409 not-confirmed-yet)
+     * while the proof is not yet available.
+     */
     getWithdrawal(withdrawalIndex: number): Promise<WithdrawalResponse>;
+    /**
+     * List the caller's pending withdrawals (those still awaiting on-chain root
+     * confirmation). Authenticated and scoped to the caller. Newest first, paged.
+     */
+    listPendingWithdrawals(params?: ListPendingWithdrawalsParams): Promise<ListPendingWithdrawalsResponse>;
+}
+/** Query parameters for {@link WithdrawalsAPI.listPendingWithdrawals}. */
+export interface ListPendingWithdrawalsParams {
+    /** Page number, 1-based. Defaults to 1. */
+    page?: number;
+    /** Items per page (1–100). Defaults to 20. */
+    pageSize?: number;
+}
+/**
+ * A single pending withdrawal in a {@link ListPendingWithdrawalsResponse}. A
+ * lightweight summary — the executable calldata is not included (it does not
+ * exist until the withdrawal is confirmed on-chain; fetch it via
+ * {@link WithdrawalsAPI.getWithdrawal} once ready).
+ */
+export interface PendingWithdrawal {
+    /** Allocated withdrawal index — matches `executeWithdrawal.index` on-chain. */
+    withdrawalIndex: number;
+    /** UUID of the withdrawn asset. */
+    assetId: string;
+    /** Ticker symbol of the withdrawn asset. */
+    assetSymbol: string;
+    /**
+     * Raw token amount in the smallest unit (e.g. wei) as a stringified positive
+     * integer.
+     */
+    amount: string;
+    /** On-chain address that will receive the withdrawal. */
+    destination: Address;
+    /** Withdrawal lifecycle status; always `"pending"` for entries in this list. */
+    status: string;
+    /** RFC 3339 timestamp of when the withdrawal was initiated. */
+    createdAt: string;
+}
+/**
+ * Response for `GET /api/v1/withdrawals` — a page of the caller's pending
+ * withdrawals plus pagination metadata.
+ */
+export interface ListPendingWithdrawalsResponse {
+    /** The page of pending withdrawals, newest first. */
+    withdrawals: PendingWithdrawal[];
+    /** Total number of pending withdrawals for the caller. */
+    total: number;
+    /** Current page number. */
+    page: number;
+    /** Items per page. */
+    pageSize: number;
+    /** Total number of pages. */
+    totalPages: number;
 }

package/package.json

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