@0xmonaco/types 0.7.3 → 0.7.4

package/dist/validation/vault.d.ts

@@ -46,11 +46,16 @@ export declare const DepositSchema: z.ZodObject<{
     autoWait: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 /**
- * Withdraw validation schema
+ * Withdraw validation schema.
+ *
+ * The SDK calls the gateway to allocate the `withdrawalIndex` and obtain
+ * pre-signed calldata, then submits that calldata via the connected wallet.
+ * `autoWait` controls whether the SDK awaits on-chain confirmation.
  */
 export declare const WithdrawSchema: z.ZodObject<{
     assetId: z.ZodUUID;
     amount: z.ZodUnion<readonly [z.ZodString, z.ZodBigInt]>;
+    destination: z.ZodString;
     autoWait: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 /**

package/dist/validation/vault.js

@@ -59,11 +59,16 @@ export const DepositSchema = z.object({
     autoWait: z.boolean().optional(),
 });
 /**
- * Withdraw validation schema
+ * Withdraw validation schema.
+ *
+ * The SDK calls the gateway to allocate the `withdrawalIndex` and obtain
+ * pre-signed calldata, then submits that calldata via the connected wallet.
+ * `autoWait` controls whether the SDK awaits on-chain confirmation.
  */
 export const WithdrawSchema = z.object({
     assetId: UUIDSchema,
     amount: PositiveBigIntStringSchema,
+    destination: z.string().regex(/^0x[a-fA-F0-9]{40}$/, "destination must be a 0x-prefixed 20-byte hex address"),
     autoWait: z.boolean().optional(),
 });
 /**

package/dist/vault/index.d.ts

@@ -4,7 +4,7 @@
  * Types for vault operations including deposits, withdrawals, and balance management.
  */
 import type { BaseAPI } from "../api/index";
-import type { Balance, TransactionResult } from "./responses";
+import type { Balance, TransactionResult, WithdrawResult } from "./responses";
 /**
  * Vault API interface.
  * Provides methods for managing token deposits and withdrawals.
@@ -28,13 +28,27 @@ export interface VaultAPI extends BaseAPI {
      */
     deposit(assetId: string, amount: bigint, autoWait?: boolean): Promise<TransactionResult>;
     /**
-     * Withdraws tokens from the vault.
+     * Initiates a withdrawal: allocates a `withdrawalIndex` via the API Gateway,
+     * receives pre-signed calldata for `executeSignedWithdrawal(...)`, and
+     * submits it on-chain through the connected wallet.
+     *
      * @param assetId - Asset identifier (UUID) to withdraw
-     * @param amount - Amount to withdraw
-     * @param autoWait - Whether to automatically wait for transaction confirmation (defaults to true)
-     * @returns Promise resolving to the transaction result
+     * @param amount - Raw token amount (smallest unit, as bigint)
+     * @param autoWait - Whether to await on-chain confirmation (defaults to true)
+     * @returns Promise resolving to `{ withdrawalIndex, transaction }`
+     */
+    withdraw(assetId: string, amount: bigint, autoWait?: boolean): Promise<WithdrawResult>;
+    /**
+     * Retries a previously-initiated withdrawal whose on-chain submission never
+     * landed (wallet rejected, page reloaded before receipt, stuck mempool).
+     * Re-fetches the same signed calldata and resubmits via the connected wallet
+     * — does NOT initiate a new withdrawal.
+     *
+     * @param withdrawalIndex - Index returned by the original `withdraw()` call
+     * @param autoWait - Whether to await on-chain confirmation (defaults to true)
+     * @returns Promise resolving to `{ withdrawalIndex, ...transaction }`
      */
-    withdraw(assetId: string, amount: bigint, autoWait?: boolean): Promise<TransactionResult>;
+    retryWithdrawal(withdrawalIndex: number, autoWait?: boolean): Promise<WithdrawResult>;
     /**
      * Gets the balance of a token in the vault.
      * @param assetId - Asset identifier (UUID) to check
@@ -67,4 +81,4 @@ export interface VaultAPI extends BaseAPI {
      */
     setWalletClient(walletClient: unknown): void;
 }
-export type { Balance, TransactionResult } from "./responses";
+export type { Balance, TransactionResult, WithdrawResult } from "./responses";

package/dist/vault/responses.d.ts

@@ -16,6 +16,24 @@ export interface TransactionResult {
     /** Transaction receipt (only available when autoWait is enabled) */
     receipt?: import("viem").TransactionReceipt;
 }
+/**
+ * Result of initiating a withdrawal.
+ *
+ * The API gateway allocates a `withdrawalIndex` via the matching engine and
+ * returns pre-signed calldata for the vault contract's
+ * `executeSignedWithdrawal(...)` function. The SDK submits that calldata on
+ * behalf of the connected wallet — the user is the on-chain caller, but the
+ * `WITHDRAWAL_SIGNER` signature embedded in the calldata is what the contract
+ * authenticates against.
+ *
+ * Extends [`TransactionResult`] so callers can read `hash`, `status`, `nonce`
+ * (and `receipt` when `autoWait` is true) directly off the result, just like
+ * `approve` / `deposit`.
+ */
+export interface WithdrawResult extends TransactionResult {
+    /** Allocated withdrawal index — matches `executeSignedWithdrawal.index`. */
+    withdrawalIndex: number;
+}
 /**
  * Token balance information.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@0xmonaco/types",
-	"version": "0.7.3",
+	"version": "0.7.4",
 	"type": "module",
 	"repository": {
 		"type": "git",