@unlink-xyz/sdk 0.0.2-canary.0

package/dist/index.d.ts

@@ -0,0 +1,1998 @@
+import * as openapi_fetch from 'openapi-fetch';
+import { Client } from 'openapi-fetch';
+import { Address, LocalAccount } from 'viem';
+
+declare function poseidon(inputs: bigint[]): bigint;
+
+interface EdDSASignature {
+    R8: [bigint, bigint];
+    S: bigint;
+}
+declare function eddsaPublicKey(privateKey: bigint): Promise<[bigint, bigint]>;
+declare function eddsaSign(privateKey: bigint, message: bigint): Promise<EdDSASignature>;
+declare function eddsaVerify(message: bigint, signature: EdDSASignature, publicKey: [bigint, bigint]): Promise<boolean>;
+
+declare function viewingPublicKey(privateKey: Uint8Array): Uint8Array;
+declare function viewingPublicKeyFromHex(hexPrivateKey: string): Uint8Array;
+
+declare const P = 21888242871839275222246405745257275088548364400416034343698204186575808495617n;
+declare function mod(n: bigint): bigint;
+declare function fromDecimal(s: string): bigint;
+declare function toBytesBE(n: bigint): Uint8Array;
+declare function fromBytesBE(bytes: Uint8Array): bigint;
+declare function fromHex(hex: string): bigint;
+declare function toDecimal(n: bigint): string;
+
+interface AccountKeys {
+    spendingPrivateKey: bigint;
+    spendingPublicKey: [bigint, bigint];
+    viewingPrivateKey: Uint8Array;
+    viewingPublicKey: Uint8Array;
+    nullifyingKey: bigint;
+    masterPublicKey: bigint;
+    address: string;
+}
+
+declare function deriveAccountKeys(seed: Uint8Array, index?: number): Promise<AccountKeys>;
+
+declare function encodeAddress(mpk: bigint, viewingPubKey: Uint8Array): string;
+declare function decodeAddress(address: string): {
+    version: number;
+    masterPublicKey: bigint;
+    viewingPublicKey: Uint8Array;
+};
+
+interface AccountExportPayload {
+    version: 1;
+    spendingPrivateKey: string;
+    viewingPrivateKey: string;
+}
+
+interface UnlinkAccountProvider {
+    getAccountKeys(): Promise<AccountKeys>;
+}
+interface UnlinkAccountSeedOptions {
+    seed: Uint8Array;
+    accountIndex?: number;
+}
+interface UnlinkAccountMnemonicOptions {
+    mnemonic: string;
+    accountIndex?: number;
+}
+declare const unlinkAccount: {
+    fromKeys(keys: AccountKeys): UnlinkAccountProvider;
+    fromSeed(options: UnlinkAccountSeedOptions): UnlinkAccountProvider;
+    fromMnemonic(options: UnlinkAccountMnemonicOptions): UnlinkAccountProvider;
+    export(keys: AccountKeys): AccountExportPayload;
+    import(input: unknown): Promise<AccountKeys>;
+};
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/health": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Health check */
+        get: operations["getHealth"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/info/environment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Active environment */
+        get: operations["getEnvironment"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/info/permit2/nonces/{owner}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Permit2 nonce bitmap
+         * @description Reads a single window of Permit2 nonce bitmap words for the given owner from on-chain state. Returns any available nonce found within the requested window, plus a cursor to continue when not found.
+         */
+        get: operations["getPermit2Nonces"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/users": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List users */
+        get: operations["listUsers"];
+        put?: never;
+        /** Create user */
+        post: operations["createUser"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/users/{address}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get user details */
+        get: operations["getUser"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/users/{address}/balances": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get user balances */
+        get: operations["getUserBalances"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/users/{address}/transactions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get user transaction history */
+        get: operations["getUserTransactions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/transactions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List all transactions */
+        get: operations["listTransactions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/transactions/deposit": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create deposit (deprecated)
+         * @deprecated
+         * @description Deprecated. Use POST /transactions/deposit/prepare + POST /transactions/deposit/{tx_id}/submit.
+         *     Returns 400 — deposits now require a Permit2 witness signature bound to notes_hash.
+         */
+        post: operations["createDeposit"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/transactions/deposit/prepare": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Prepare deposit
+         * @description Builds note/ciphertext artifacts and returns a notes_hash for the SDK to sign
+         *     via Permit2 witness. Call `/transactions/deposit/{tx_id}/submit` with the Permit2 signature.
+         */
+        post: operations["prepareDeposit"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/transactions/deposit/{tx_id}/submit": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Submit deposit Permit2 signature
+         * @description Submit the Permit2 witness signature for a prepared deposit.
+         */
+        post: operations["submitDeposit"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/transactions/prepare/transfer": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Prepare transfer
+         * @description Returns a signing request. Call `/transactions/{tx_id}/submit` with the EdDSA signature.
+         */
+        post: operations["prepareTransfer"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/transactions/prepare/execute": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Prepare execute (adapter)
+         * @description Prepares an adapter transaction that withdraws tokens from the user's private balance,
+         *     executes arbitrary external calls (e.g. DeFi swaps), and deposits the results back.
+         *     Returns a signing request. Call `/transactions/{tx_id}/submit` with the EdDSA signature.
+         */
+        post: operations["prepareExecute"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/transactions/prepare/withdraw": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Prepare withdraw
+         * @description Returns a signing request. Call `/transactions/{tx_id}/submit` with the EdDSA signature.
+         */
+        post: operations["prepareWithdraw"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/transactions/{tx_id}/submit": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Submit EdDSA signature
+         * @description Submit the EdDSA signature for a prepared transfer, withdraw, or execute.
+         */
+        post: operations["submitTransaction"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/transactions/{tx_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get transaction status */
+        get: operations["getTransaction"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/burner/create": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create burner account
+         * @description Creates a burner account and prepares a withdrawal to fund it.
+         *     The client generates an ephemeral keypair and sends the burner address.
+         *     Returns a signing request — call `/transactions/{tx_id}/submit` with the EdDSA signature.
+         *     After the withdrawal confirms on-chain, the relayer sends ETH to the burner for gas.
+         */
+        post: operations["createBurner"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/burner/{burner_address}/status": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get burner account status */
+        get: operations["getBurnerStatus"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/burner/{burner_address}/dispose": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Dispose burner account
+         * @description Mark a burner account as disposed after depositing tokens back to the pool.
+         */
+        post: operations["disposeBurner"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/burner/info": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Burner configuration info
+         * @description Returns chain configuration the SDK needs for burner operations.
+         */
+        get: operations["getBurnerInfo"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+type webhooks = Record<string, never>;
+interface components {
+    schemas: {
+        ErrorResponse: {
+            error: {
+                /** @description Error code (e.g. INTERNAL_ERROR) */
+                code: string;
+                message: string;
+            };
+        };
+        /** @description Bech32m-encoded Unlink address */
+        Bech32mAddress: string;
+        /** @description EVM address (checksummed or lowercase) */
+        EvmAddress: string;
+        HealthData: {
+            status: string;
+        };
+        EnvironmentInfo: {
+            /** @description Environment identifier (e.g. "base-mainnet") */
+            name: string;
+            chain_id: number;
+            /** @description UnlinkPool contract address */
+            pool_address: components["schemas"]["EvmAddress"];
+            /** @description Permit2 contract address */
+            permit2_address: components["schemas"]["EvmAddress"];
+        };
+        BitmapWord: {
+            /** @description Permit2 bitmap word index */
+            word_position: number;
+            /** @description Hex-encoded uint256 bitmap value */
+            bitmap: string;
+        };
+        Permit2NoncesData: {
+            owner: components["schemas"]["EvmAddress"];
+            environment: string;
+            /** @description Bitmap words returned for the requested window */
+            bitmap_words: components["schemas"]["BitmapWord"][];
+            /** @description First available (unset) nonce within the returned bitmap words. Omitted when none is found. */
+            next_available_nonce?: number;
+            /** @description Word position to request next when the current window contains no available nonce */
+            next_word_position?: number;
+        };
+        CreateUserRequest: {
+            /** @description Hex-encoded Ed25519 viewing private key */
+            viewing_private_key: string;
+            /** @description Poseidon hash as decimal string */
+            nullifying_key: string;
+            /** @description BabyJubJub spending public key [x, y] as decimal strings */
+            public_key: string[];
+        };
+        CreateUserResponse: {
+            address: components["schemas"]["Bech32mAddress"];
+            /** @description Key derivation index */
+            index: number;
+        };
+        User: {
+            address: components["schemas"]["Bech32mAddress"];
+            /** @description BabyJubJub x coordinate as decimal string */
+            public_key_x: string;
+            /** @description BabyJubJub y coordinate as decimal string */
+            public_key_y: string;
+            /** Format: date-time */
+            created_at: string;
+            /** Format: date-time */
+            updated_at: string;
+        };
+        UserListData: {
+            users: components["schemas"]["User"][];
+            /** @description Opaque cursor for next page. Omitted when no more results. */
+            next_cursor?: string;
+        };
+        Balance: {
+            /** @description ERC-20 contract address */
+            token: components["schemas"]["EvmAddress"];
+            /** @description Token amount as string (large numbers) */
+            amount: string;
+        };
+        BalancesData: {
+            balances: components["schemas"]["Balance"][];
+        };
+        /** @enum {string} */
+        TransactionType: "deposit" | "transfer" | "withdraw" | "execute";
+        /** @enum {string} */
+        TransactionStatus: "accepted" | "prepared" | "proving" | "proved" | "broadcasting" | "relayed" | "processed" | "failed";
+        Transaction: {
+            /** Format: uuid */
+            id: string;
+            user_address: components["schemas"]["Bech32mAddress"];
+            type: components["schemas"]["TransactionType"];
+            status: components["schemas"]["TransactionStatus"];
+            environment: string;
+            /** @description On-chain transaction hash, set once relayed */
+            tx_hash?: string | null;
+            /** Format: date-time */
+            created_at: string;
+            /** Format: date-time */
+            updated_at: string;
+        };
+        TransactionListData: {
+            transactions: components["schemas"]["Transaction"][];
+            /** @description Opaque cursor for next page. Omitted when no more results. */
+            next_cursor?: string;
+        };
+        DepositRequest: {
+            /** @description Recipient Unlink address */
+            unlink_address: components["schemas"]["Bech32mAddress"];
+            /** @description ERC-20 token address */
+            token: components["schemas"]["EvmAddress"];
+            /** @description Token amount as string */
+            amount: string;
+            /** @description Target environment (e.g. "base-mainnet") */
+            environment: string;
+            /** @description Depositor EOA address */
+            evm_address: components["schemas"]["EvmAddress"];
+            /** @description EIP-712 Permit2 signature */
+            permit2_signature: string;
+            /** @description Permit2 nonce */
+            permit2_nonce: string;
+            /** @description Permit2 deadline (Unix timestamp) */
+            permit2_deadline: number;
+        };
+        DepositResponse: {
+            /** Format: uuid */
+            tx_id: string;
+            status: components["schemas"]["TransactionStatus"];
+        };
+        PrepareDepositRequest: {
+            /** @description Recipient Unlink address */
+            unlink_address: components["schemas"]["Bech32mAddress"];
+            /** @description ERC-20 token address */
+            token: components["schemas"]["EvmAddress"];
+            /** @description Token amount as string */
+            amount: string;
+            /** @description Target environment (e.g. "base-mainnet") */
+            environment: string;
+            /** @description Depositor EOA address */
+            evm_address: components["schemas"]["EvmAddress"];
+        };
+        PrepareDepositResponse: {
+            /** Format: uuid */
+            tx_id: string;
+            /** @description keccak256(abi.encode(notes, ciphertexts)) — sign this in the Permit2 witness */
+            notes_hash: string;
+        };
+        SubmitDepositRequest: {
+            /** @description EIP-712 Permit2 witness signature */
+            permit2_signature: string;
+            /** @description Permit2 nonce */
+            permit2_nonce: string;
+            /** @description Permit2 deadline (Unix timestamp) */
+            permit2_deadline: number;
+        };
+        TransferItem: {
+            /** @description Recipient Unlink address */
+            unlink_address: components["schemas"]["Bech32mAddress"];
+            /** @description ERC-20 token address */
+            token: components["schemas"]["EvmAddress"];
+            /** @description Token amount as string */
+            amount: string;
+        };
+        TransferRequest: {
+            /** @description Sender Unlink address */
+            unlink_address: components["schemas"]["Bech32mAddress"];
+            transfers: components["schemas"]["TransferItem"][];
+            environment: string;
+        };
+        WithdrawRequest: {
+            /** @description Sender Unlink address */
+            unlink_address: components["schemas"]["Bech32mAddress"];
+            /** @description Destination EVM address */
+            evm_address: components["schemas"]["EvmAddress"];
+            /** @description ERC-20 token address */
+            token: components["schemas"]["EvmAddress"];
+            /** @description Token amount as string */
+            amount: string;
+            environment: string;
+        };
+        ExecuteWithdrawal: {
+            /** @description ERC-20 token address to withdraw from private balance */
+            token: components["schemas"]["EvmAddress"];
+            /** @description Token amount as string */
+            amount: string;
+        };
+        ExecuteCall: {
+            /** @description Target contract address */
+            to: components["schemas"]["EvmAddress"];
+            /** @description Hex-encoded calldata */
+            data: string;
+            /** @description ETH value in wei (use "0" for non-payable calls) */
+            value: string;
+        };
+        ExecuteOutput: {
+            /** @description Nullifier public key of the recipient (decimal string) */
+            npk: string;
+            /** @description ERC-20 token address of expected output */
+            token: components["schemas"]["EvmAddress"];
+            /** @description Minimum acceptable output amount (slippage protection) */
+            min_amount: string;
+        };
+        PrepareExecuteRequest: {
+            /** @description Sender Unlink address */
+            unlink_address: components["schemas"]["Bech32mAddress"];
+            /** @description Target environment (e.g. "base-mainnet") */
+            environment: string;
+            /** @description Tokens to withdraw from private balance into the adapter */
+            withdrawals: components["schemas"]["ExecuteWithdrawal"][];
+            /** @description Arbitrary external calls the adapter will execute */
+            calls: components["schemas"]["ExecuteCall"][];
+            /** @description Expected outputs to deposit back into private balance */
+            outputs: components["schemas"]["ExecuteOutput"][];
+            /** @description Unix timestamp after which the transaction reverts */
+            deadline: number;
+        };
+        PrepareExecuteResponse: {
+            /** Format: uuid */
+            tx_id: string;
+            status: components["schemas"]["TransactionStatus"];
+            signing_request: components["schemas"]["SigningRequest"];
+            /** @description keccak256(abi.encode(calls, outputs, inputTokens, deadline, chainId)) % SNARK_FIELD — committed to in the circuit proof */
+            adapter_data_hash: string;
+        };
+        SigningRequest: {
+            /** @description Poseidon hash to sign (decimal string) */
+            message_hash: string;
+            public_inputs: components["schemas"]["PublicInputs"];
+            selected_notes: components["schemas"]["SelectedNote"][];
+            /** @description JoinSplit circuit variant identifier */
+            circuit_variant: string;
+        };
+        PublicInputs: {
+            /** @description Merkle tree root (decimal string) */
+            merkle_root: string;
+            /** @description Bound parameters hash (decimal string) */
+            bound_params_hash: string;
+            /** @description Input nullifiers (decimal strings) */
+            nullifiers: string[];
+            /** @description Output commitments (decimal strings) */
+            all_commitments_out: string[];
+        };
+        SelectedNote: {
+            /** @description Merkle tree leaf index */
+            leaf_index: number;
+            /** @description Note amount as string */
+            amount: string;
+        };
+        PrepareResponse: {
+            /** Format: uuid */
+            tx_id: string;
+            status: components["schemas"]["TransactionStatus"];
+            signing_request: components["schemas"]["SigningRequest"];
+        };
+        SubmitRequest: {
+            /** @description EdDSA signature [R8x, R8y, S] as decimal strings */
+            signature: string[];
+        };
+        SubmitResponse: {
+            /** Format: uuid */
+            tx_id: string;
+            status: components["schemas"]["TransactionStatus"];
+        };
+        BurnerCreateRequest: {
+            /** @description Sender Unlink address (whose private notes to spend) */
+            unlink_address: components["schemas"]["Bech32mAddress"];
+            /** @description Client-generated burner EOA address */
+            burner_address: components["schemas"]["EvmAddress"];
+            /** @description ERC-20 token address */
+            token: components["schemas"]["EvmAddress"];
+            /** @description Token amount as string */
+            amount: string;
+            /** @description Target environment (e.g. "base-mainnet") */
+            environment: string;
+        };
+        /** @enum {string} */
+        BurnerStatus: "pending" | "gas_pending" | "funded" | "disposed" | "gas_funding_failed";
+        BurnerStatusResponse: {
+            evm_address: components["schemas"]["EvmAddress"];
+            status: components["schemas"]["BurnerStatus"];
+            /** Format: uuid */
+            withdraw_tx_id: string;
+            token: components["schemas"]["EvmAddress"];
+            token_amount: string;
+            gas_funding_wei: string;
+            gas_funding_tx_hash?: string | null;
+            /** Format: uuid */
+            deposit_back_tx_id?: string | null;
+            /** Format: date-time */
+            created_at: string;
+            /** Format: date-time */
+            disposed_at?: string | null;
+        };
+        BurnerDisposeRequest: {
+            /**
+             * Format: uuid
+             * @description Transaction ID of the deposit-back, if any
+             */
+            deposit_back_tx_id?: string;
+        };
+        BurnerDisposeResponse: {
+            status: components["schemas"]["BurnerStatus"];
+        };
+        BurnerInfoResponse: {
+            pool_address: components["schemas"]["EvmAddress"];
+            permit2_address: components["schemas"]["EvmAddress"];
+            chain_id: number;
+            /** @description ETH amount (in wei) the relayer sends for gas funding */
+            gas_funding_wei: string;
+        };
+    };
+    responses: {
+        /** @description Invalid request */
+        BadRequest: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description Authentication required or invalid */
+        Unauthorized: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description Resource not found */
+        NotFound: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description Request conflicts with current transaction state */
+        Conflict: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description Rate limited — per-key tier quota exceeded or proving capacity exhausted */
+        RateLimited: {
+            headers: {
+                /** @description Seconds until the rate limit resets */
+                "Retry-After"?: number;
+                /** @description Maximum requests allowed in the current window for this tier */
+                "X-RateLimit-Limit"?: number;
+                /** @description Remaining requests in the current window for this tier */
+                "X-RateLimit-Remaining"?: number;
+                /** @description Unix epoch seconds when the current window resets */
+                "X-RateLimit-Reset"?: number;
+                /** @description Rate limit tier applied to this request (reads, writes, or heavy) */
+                "X-RateLimit-Policy"?: "reads" | "writes" | "heavy";
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+    };
+    parameters: {
+        /** @description Maximum number of items to return */
+        limit: number;
+        /** @description Opaque pagination cursor from a previous response */
+        cursor: string;
+        /** @description Environment name (e.g. "base-mainnet") */
+        environmentQuery: string;
+        /** @description ERC-20 token address to filter by */
+        tokenQuery: string;
+        /** @description Filter by transaction status */
+        statusQuery: components["schemas"]["TransactionStatus"];
+        /** @description Filter by transaction type */
+        typeQuery: components["schemas"]["TransactionType"];
+        /** @description User Unlink address */
+        address: components["schemas"]["Bech32mAddress"];
+        /** @description Transaction ID */
+        tx_id: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+type $defs = Record<string, never>;
+interface operations {
+    getHealth: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description System health status */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["HealthData"];
+                    };
+                };
+            };
+            /** @description System health is degraded */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["HealthData"];
+                    };
+                };
+            };
+        };
+    };
+    getEnvironment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Active environment */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["EnvironmentInfo"];
+                    };
+                };
+            };
+        };
+    };
+    getPermit2Nonces: {
+        parameters: {
+            query?: {
+                /** @description Permit2 bitmap word index to start reading from. Defaults to 0. */
+                start_word?: number;
+                /** @description Number of bitmap words to read. Defaults to 3. */
+                word_count?: number;
+            };
+            header?: never;
+            path: {
+                owner: components["schemas"]["EvmAddress"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Permit2 nonce bitmap */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["Permit2NoncesData"];
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            /** @description Chain RPC unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    listUsers: {
+        parameters: {
+            query?: {
+                /** @description Maximum number of items to return */
+                limit?: components["parameters"]["limit"];
+                /** @description Opaque pagination cursor from a previous response */
+                cursor?: components["parameters"]["cursor"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Paginated user list */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["UserListData"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    createUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateUserRequest"];
+            };
+        };
+        responses: {
+            /** @description User created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["CreateUserResponse"];
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    getUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description User Unlink address */
+                address: components["parameters"]["address"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description User details */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["User"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    getUserBalances: {
+        parameters: {
+            query?: {
+                /** @description ERC-20 token address to filter by */
+                token?: components["parameters"]["tokenQuery"];
+            };
+            header?: never;
+            path: {
+                /** @description User Unlink address */
+                address: components["parameters"]["address"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description User balances */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["BalancesData"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    getUserTransactions: {
+        parameters: {
+            query?: {
+                /** @description Environment name (e.g. "base-mainnet") */
+                environment?: components["parameters"]["environmentQuery"];
+                /** @description Filter by transaction status */
+                status?: components["parameters"]["statusQuery"];
+                /** @description Filter by transaction type */
+                type?: components["parameters"]["typeQuery"];
+                /** @description Maximum number of items to return */
+                limit?: components["parameters"]["limit"];
+                /** @description Opaque pagination cursor from a previous response */
+                cursor?: components["parameters"]["cursor"];
+            };
+            header?: never;
+            path: {
+                /** @description User Unlink address */
+                address: components["parameters"]["address"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Paginated transaction list */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["TransactionListData"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    listTransactions: {
+        parameters: {
+            query?: {
+                /** @description Environment name (e.g. "base-mainnet") */
+                environment?: components["parameters"]["environmentQuery"];
+                /** @description Filter by transaction status */
+                status?: components["parameters"]["statusQuery"];
+                /** @description Filter by transaction type */
+                type?: components["parameters"]["typeQuery"];
+                /** @description Maximum number of items to return */
+                limit?: components["parameters"]["limit"];
+                /** @description Opaque pagination cursor from a previous response */
+                cursor?: components["parameters"]["cursor"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Paginated transaction list */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["TransactionListData"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    createDeposit: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DepositRequest"];
+            };
+        };
+        responses: {
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    prepareDeposit: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PrepareDepositRequest"];
+            };
+        };
+        responses: {
+            /** @description Deposit prepared, awaiting Permit2 witness signature */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["PrepareDepositResponse"];
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    submitDeposit: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Transaction ID */
+                tx_id: components["parameters"]["tx_id"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SubmitDepositRequest"];
+            };
+        };
+        responses: {
+            /** @description Deposit accepted */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["DepositResponse"];
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            /** @description Duplicate deposit (Permit2 nonce reuse) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Prepared deposit expired */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    prepareTransfer: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["TransferRequest"];
+            };
+        };
+        responses: {
+            /** @description Transfer prepared, awaiting signature */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["PrepareResponse"];
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    prepareExecute: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PrepareExecuteRequest"];
+            };
+        };
+        responses: {
+            /** @description Execute prepared, awaiting signature */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["PrepareExecuteResponse"];
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    prepareWithdraw: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["WithdrawRequest"];
+            };
+        };
+        responses: {
+            /** @description Withdraw prepared, awaiting signature */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["PrepareResponse"];
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    submitTransaction: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Transaction ID */
+                tx_id: components["parameters"]["tx_id"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SubmitRequest"];
+            };
+        };
+        responses: {
+            /** @description Signature accepted */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["SubmitResponse"];
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            409: components["responses"]["Conflict"];
+            /** @description Transaction expired (5 min TTL) */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    getTransaction: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Transaction ID */
+                tx_id: components["parameters"]["tx_id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Transaction details */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["Transaction"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    createBurner: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["BurnerCreateRequest"];
+            };
+        };
+        responses: {
+            /** @description Burner created, withdrawal prepared, awaiting signature */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["PrepareResponse"];
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    getBurnerStatus: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                burner_address: components["schemas"]["EvmAddress"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Burner account status */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["BurnerStatusResponse"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    disposeBurner: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                burner_address: components["schemas"]["EvmAddress"];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["BurnerDisposeRequest"];
+            };
+        };
+        responses: {
+            /** @description Burner disposed */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["BurnerDisposeResponse"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+    getBurnerInfo: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Burner configuration */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["BurnerInfoResponse"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            429: components["responses"]["RateLimited"];
+        };
+    };
+}
+
+interface ClientOptions {
+    /** Maximum number of retries on 429 responses. Default: 3. Set to 0 to disable. */
+    maxRetries?: number;
+    /** Custom fetch implementation. */
+    customFetch?: typeof globalThis.fetch;
+}
+/**
+ * Create an Unlink API client with automatic retry on rate-limit (429) responses.
+ *
+ * The third argument accepts either a `ClientOptions` object or a bare `fetch`
+ * function for backward compatibility.
+ */
+declare const createUnlinkClient: (baseUrl: string, apiKey: string, options?: ClientOptions | typeof globalThis.fetch) => openapi_fetch.Client<paths, `${string}/${string}`>;
+
+/** EIP-712 typed data for Permit2 PermitTransferFrom */
+interface Permit2TypedData {
+    domain: {
+        name: string;
+        chainId: number;
+        verifyingContract: string;
+    };
+    types: {
+        PermitTransferFrom: Array<{
+            name: string;
+            type: string;
+        }>;
+        TokenPermissions: Array<{
+            name: string;
+            type: string;
+        }>;
+    };
+    primaryType: "PermitTransferFrom";
+    value: {
+        permitted: {
+            token: string;
+            amount: string;
+        };
+        spender: string;
+        nonce: string;
+        deadline: string;
+    };
+}
+/** EIP-712 typed data for Permit2 PermitWitnessTransferFrom (with deposit witness). */
+interface Permit2WitnessTypedData {
+    domain: {
+        name: string;
+        chainId: number;
+        verifyingContract: string;
+    };
+    types: {
+        PermitWitnessTransferFrom: Array<{
+            name: string;
+            type: string;
+        }>;
+        TokenPermissions: Array<{
+            name: string;
+            type: string;
+        }>;
+        DepositWitness: Array<{
+            name: string;
+            type: string;
+        }>;
+    };
+    primaryType: "PermitWitnessTransferFrom";
+    value: {
+        permitted: {
+            token: string;
+            amount: string;
+        };
+        spender: string;
+        nonce: string;
+        deadline: string;
+        witness: {
+            notesHash: string;
+        };
+    };
+}
+/** Callback to sign EIP-712 typed data with an EVM wallet. Returns hex-encoded signature. */
+type SignTypedDataFn = (typedData: Permit2TypedData | Permit2WitnessTypedData) => Promise<string>;
+interface TransactionResult {
+    txId: string;
+    status: string;
+}
+interface TransferInstruction {
+    recipientAddress: string;
+    token: string;
+    amount: string;
+}
+
+interface UnlinkEvmTransactionRequest {
+    to: string;
+    data: string;
+    value?: bigint;
+}
+interface UnlinkEvmProvider {
+    getAddress(): Promise<string>;
+    signTypedData(typedData: Permit2TypedData | Permit2WitnessTypedData): Promise<string>;
+    getErc20Allowance?(params: {
+        token: string;
+        owner: string;
+        spender: string;
+    }): Promise<bigint | string>;
+    sendTransaction?(tx: UnlinkEvmTransactionRequest): Promise<string>;
+}
+interface UnlinkSignerProviderOptions {
+    address: string;
+    signTypedData(typedData: Permit2TypedData | Permit2WitnessTypedData): Promise<string>;
+    getErc20Allowance?(params: {
+        token: string;
+        owner: string;
+        spender: string;
+    }): Promise<bigint | string>;
+    sendTransaction?(tx: UnlinkEvmTransactionRequest): Promise<string>;
+}
+interface ViemWalletClientLike {
+    account?: {
+        address: string;
+    } | string;
+    signTypedData(params: unknown): Promise<string>;
+    sendTransaction?(params: unknown): Promise<string>;
+}
+interface ViemPublicClientLike {
+    readContract(params: unknown): Promise<unknown>;
+}
+interface UnlinkViemProviderOptions {
+    walletClient: ViemWalletClientLike;
+    publicClient?: ViemPublicClientLike;
+    address?: string;
+}
+interface EthersProviderLike {
+    call(tx: {
+        to: string;
+        data: string;
+    }): Promise<string>;
+}
+interface EthersSignerLike {
+    provider?: EthersProviderLike | null;
+    getAddress(): Promise<string>;
+    signTypedData(domain: Permit2TypedData["domain"] | Permit2WitnessTypedData["domain"], types: Permit2TypedData["types"] | Permit2WitnessTypedData["types"], value: Permit2TypedData["value"] | Permit2WitnessTypedData["value"]): Promise<string>;
+    sendTransaction?(tx: {
+        to: string;
+        data: string;
+        value?: bigint;
+    }): Promise<{
+        hash: string;
+    }>;
+}
+interface UnlinkEthersProviderOptions {
+    signer: EthersSignerLike;
+    provider?: EthersProviderLike;
+}
+declare const unlinkEvm: {
+    fromSigner(options: UnlinkSignerProviderOptions): UnlinkEvmProvider;
+    fromViem(options: UnlinkViemProviderOptions): UnlinkEvmProvider;
+    fromEthers(options: UnlinkEthersProviderOptions): UnlinkEvmProvider;
+};
+
+interface ApprovalState {
+    token: string;
+    owner: string;
+    spender: string;
+    amount: string;
+    allowance: string;
+    isApproved: boolean;
+}
+interface GetApprovalStateParams {
+    evm: {
+        getErc20Allowance: NonNullable<UnlinkEvmProvider["getErc20Allowance"]>;
+    };
+    token: string;
+    owner: string;
+    spender: string;
+    amount: bigint | string;
+}
+interface BuildApprovalTxParams {
+    token: string;
+    spender: string;
+    amount: bigint | string;
+}
+interface EnsureErc20ApprovalParams extends GetApprovalStateParams {
+    evm: {
+        getErc20Allowance: NonNullable<UnlinkEvmProvider["getErc20Allowance"]>;
+        sendTransaction?: NonNullable<UnlinkEvmProvider["sendTransaction"]>;
+    };
+}
+type EnsureErc20ApprovalResult = {
+    status: "already-approved";
+    state: ApprovalState;
+} | {
+    status: "submitted";
+    state: ApprovalState;
+    txHash: string;
+    transaction: UnlinkEvmTransactionRequest;
+};
+declare function getApprovalState(params: GetApprovalStateParams): Promise<ApprovalState>;
+declare function buildApprovalTx(params: BuildApprovalTxParams): UnlinkEvmTransactionRequest;
+declare function ensureErc20Approval(params: EnsureErc20ApprovalParams): Promise<EnsureErc20ApprovalResult>;
+
+type BalancesData = components["schemas"]["BalancesData"];
+type TransactionListData$1 = components["schemas"]["TransactionListData"];
+type TransactionStatus = components["schemas"]["TransactionStatus"];
+type TransactionType = components["schemas"]["TransactionType"];
+interface CreateUnlinkOptions {
+    engineUrl: string;
+    apiKey: string;
+    account: UnlinkAccountProvider;
+    evm?: UnlinkEvmProvider;
+    customFetch?: typeof globalThis.fetch;
+}
+interface UnlinkDepositParams {
+    token: string;
+    amount: string;
+    deadline?: number;
+    nonce?: string;
+    evm?: UnlinkEvmProvider;
+}
+interface UnlinkSingleTransferParams {
+    token: string;
+    amount: string;
+    recipientAddress: string;
+    transfers?: never;
+}
+interface UnlinkMultiTransferParams {
+    token: string;
+    amount?: never;
+    recipientAddress?: never;
+    transfers: Array<{
+        recipientAddress: string;
+        amount: string;
+    }>;
+}
+type UnlinkTransferParams = UnlinkSingleTransferParams | UnlinkMultiTransferParams;
+interface UnlinkWithdrawParams {
+    recipientEvmAddress: string;
+    token: string;
+    amount: string;
+}
+interface UnlinkPollOptions {
+    intervalMs?: number;
+    timeoutMs?: number;
+}
+interface UnlinkGetBalancesParams {
+    token?: string;
+}
+interface UnlinkGetTransactionsParams {
+    environment?: string;
+    status?: TransactionStatus;
+    type?: TransactionType;
+    limit?: number;
+    cursor?: string;
+}
+interface UnlinkApprovalParams {
+    token: string;
+    amount: string;
+    evm?: UnlinkEvmProvider;
+}
+interface UnlinkClient {
+    getAddress(): Promise<string>;
+    getPublicKey(): Promise<[bigint, bigint]>;
+    ensureRegistered(): Promise<void>;
+    deposit(params: UnlinkDepositParams): Promise<TransactionResult>;
+    transfer(params: UnlinkTransferParams): Promise<TransactionResult>;
+    withdraw(params: UnlinkWithdrawParams): Promise<TransactionResult>;
+    getBalances(params?: UnlinkGetBalancesParams): Promise<BalancesData>;
+    getTransactions(params?: UnlinkGetTransactionsParams): Promise<TransactionListData$1>;
+    pollTransactionStatus(txId: string, options?: UnlinkPollOptions): Promise<TransactionResult>;
+    getApprovalState(params: UnlinkApprovalParams): Promise<ApprovalState>;
+    buildApprovalTx(params: UnlinkApprovalParams): Promise<UnlinkEvmTransactionRequest>;
+    ensureErc20Approval(params: UnlinkApprovalParams): Promise<EnsureErc20ApprovalResult>;
+}
+declare function createUnlink(options: CreateUnlinkOptions): UnlinkClient;
+
+declare class UnlinkApiError extends Error {
+    readonly operation: string;
+    readonly code: string;
+    readonly detail: string;
+    constructor(operation: string, error: unknown);
+}
+declare class UnlinkCapabilityError extends Error {
+    constructor(message: string);
+}
+
+type CreateUserResponse = components["schemas"]["CreateUserResponse"];
+type User = components["schemas"]["User"];
+declare function createUser(client: Client<paths>, keys: Pick<AccountKeys, "spendingPublicKey" | "viewingPrivateKey" | "nullifyingKey">): Promise<CreateUserResponse>;
+declare function getUser(client: Client<paths>, address: string): Promise<User>;
+
+type EnvironmentInfo = components["schemas"]["EnvironmentInfo"];
+type Transaction = components["schemas"]["Transaction"];
+type TransactionListData = components["schemas"]["TransactionListData"];
+declare function getEnvironment(client: Client<paths>): Promise<EnvironmentInfo>;
+declare function getTransaction(client: Client<paths>, txId: string): Promise<Transaction>;
+declare function getUserTransactions(client: Client<paths>, address: string, options?: {
+    environment?: string;
+    status?: Transaction["status"];
+    type?: Transaction["type"];
+    limit?: number;
+    cursor?: string;
+}): Promise<TransactionListData>;
+
+declare class Permit2NonceManager {
+    private client;
+    private cache;
+    private locks;
+    private startWordFn;
+    constructor(client: Client<paths>, startWordFn?: () => number);
+    getNextNonce(owner: string): Promise<string>;
+    commitNonce(_owner: string, _nonce: string): void;
+    releaseNonce(owner: string, nonce: string): void;
+    invalidate(owner?: string): void;
+    private allocateNonce;
+    private scanForUnsetBit;
+    private fetchWindow;
+}
+
+/**
+ * Execute a deposit into the Unlink pool using the two-phase prepare/submit flow.
+ *
+ * 1. POST /transactions/deposit/prepare → {tx_id, notes_hash}
+ * 2. Sign Permit2 witness typed data (binds notes_hash into signature)
+ * 3. POST /transactions/deposit/{tx_id}/submit → {tx_id, status}
+ *
+ * @param client - Unlink API client from createUnlinkClient
+ * @param params.unlinkAddress - Recipient's unlink1... address
+ * @param params.evmAddress - Depositor's 0x... address
+ * @param params.token - ERC-20 token address
+ * @param params.amount - Amount as decimal string
+ * @param params.environment - Target environment (e.g. "base-sepolia")
+ * @param params.nonce - Permit2 nonce as decimal string. Optional if nonceManager is provided.
+ * @param params.deadline - Permit2 deadline as unix timestamp
+ * @param params.chainId - Chain ID (from GET /info/environment)
+ * @param params.permit2Address - Permit2 contract address (from GET /info/environment)
+ * @param params.poolAddress - UnlinkPool contract address (from GET /info/environment)
+ * @param params.signTypedData - Callback to sign EIP-712 typed data with EVM wallet
+ * @param params.nonceManager - Optional Permit2NonceManager for automatic nonce selection
+ */
+declare function deposit(client: Client<paths>, params: {
+    unlinkAddress: string;
+    evmAddress: string;
+    token: string;
+    amount: string;
+    environment: string;
+    nonce?: string;
+    deadline: number;
+    chainId: number;
+    permit2Address: string;
+    poolAddress: string;
+    signTypedData: SignTypedDataFn;
+    nonceManager?: Permit2NonceManager;
+}): Promise<TransactionResult>;
+
+/**
+ * Execute a private transfer: prepare → sign → submit.
+ *
+ * 1. Calls POST /transactions/prepare/transfer to get a message_hash
+ * 2. Signs the message_hash with the sender's EdDSA spending key
+ * 3. Calls POST /transactions/{tx_id}/submit with the signature
+ *
+ * @param client - Unlink API client from createUnlinkClient
+ * @param params.senderKeys - Sender's account keys (from deriveAccountKeys)
+ * @param params.transfers - Array of transfer instructions (recipient, token, amount)
+ * @param params.environment - Target environment (e.g. "base-sepolia")
+ */
+declare function transfer(client: Client<paths>, params: {
+    senderKeys: AccountKeys;
+    transfers: TransferInstruction[];
+    environment: string;
+}): Promise<TransactionResult>;
+
+/**
+ * Execute a private withdrawal: prepare → sign → submit.
+ *
+ * 1. Calls POST /transactions/prepare/withdraw to get a message_hash
+ * 2. Signs the message_hash with the sender's EdDSA spending key
+ * 3. Calls POST /transactions/{tx_id}/submit with the signature
+ *
+ * @param client - Unlink API client from createUnlinkClient
+ * @param params.senderKeys - Sender's account keys (from deriveAccountKeys)
+ * @param params.recipientEvmAddress - Destination 0x... EVM address
+ * @param params.token - ERC-20 token address
+ * @param params.amount - Amount as decimal string
+ * @param params.environment - Target environment (e.g. "base-sepolia")
+ */
+declare function withdraw(client: Client<paths>, params: {
+    senderKeys: AccountKeys;
+    recipientEvmAddress: string;
+    token: string;
+    amount: string;
+    environment: string;
+}): Promise<TransactionResult>;
+
+/**
+ * Build EIP-712 typed data for Permit2 PermitTransferFrom.
+ *
+ * The integrator signs the returned object with their EVM wallet
+ * (e.g. viem's `signTypedData`, ethers' `signTypedData`).
+ *
+ * @param params.token - ERC-20 token address
+ * @param params.amount - amount as decimal string
+ * @param params.spender - UnlinkPool contract address (from GET /info/environment)
+ * @param params.nonce - Permit2 nonce as decimal string
+ * @param params.deadline - Unix timestamp as decimal string
+ * @param params.chainId - Chain ID (from GET /info/environment)
+ * @param params.permit2Address - Permit2 contract address (from GET /info/environment)
+ */
+declare function buildPermit2TypedData(params: {
+    token: string;
+    amount: string;
+    spender: string;
+    nonce: string;
+    deadline: string;
+    chainId: number;
+    permit2Address: string;
+}): Permit2TypedData;
+/**
+ * Get the next available Permit2 nonce for the given owner.
+ *
+ * Wraps GET /info/permit2/nonces/{owner}. Paginates through bitmap words
+ * using `start_word` until a free nonce is found.
+ *
+ * For concurrent deposit workflows, use {@link Permit2NonceManager} instead.
+ *
+ * @throws If no available nonce is found after scanning all windows or the request fails.
+ */
+declare function getPermit2Nonce(client: Client<paths>, owner: string): Promise<string>;
+
+/** Pluggable storage for burner key persistence. */
+interface BurnerStorage {
+    save(address: string, privateKey: string): Promise<void>;
+    load(address: string): Promise<string | null>;
+    delete(address: string): Promise<void>;
+}
+/** Burner account status returned by the backend. */
+type BurnerStatus = components["schemas"]["BurnerStatusResponse"];
+/** Chain configuration for burner operations. */
+type BurnerInfo = components["schemas"]["BurnerInfoResponse"];
+/**
+ * BurnerWallet — a disposable EOA that holds tokens outside the privacy pool
+ * for arbitrary DeFi interactions, then deposits them back.
+ *
+ * Lifecycle: create → fund from pool → do DeFi → deposit back → dispose
+ *
+ * Key generation happens client-side; only the public address is sent to the
+ * backend. The private key is stored via a pluggable `BurnerStorage`.
+ */
+declare class BurnerWallet {
+    readonly address: Address;
+    private readonly account;
+    private readonly storage;
+    private constructor();
+    /** Generate a new burner with a fresh keypair. */
+    static create(storage?: BurnerStorage): Promise<BurnerWallet>;
+    /** Restore a burner from storage by address. Returns null if not found. */
+    static restore(address: Address, storage: BurnerStorage): Promise<BurnerWallet | null>;
+    /** Return a viem-compatible Account for use with WalletClient. */
+    toViemAccount(): LocalAccount;
+    /**
+     * Fund this burner by withdrawing from the Unlink pool.
+     *
+     * Calls POST /burner/create, signs the withdrawal with EdDSA, and submits.
+     * After the withdrawal confirms on-chain, the relayer sends ETH for gas.
+     */
+    fundFromPool(client: Client<paths>, params: {
+        senderKeys: AccountKeys;
+        token: string;
+        amount: string;
+        environment: string;
+    }): Promise<TransactionResult>;
+    /**
+     * Deposit tokens back to the Unlink pool from this burner.
+     *
+     * The caller must ensure the burner has approved Permit2 for the token
+     * before calling this method. This uses the standard deposit flow with
+     * the burner signing the Permit2 typed data.
+     */
+    depositToPool(client: Client<paths>, params: {
+        unlinkAddress: string;
+        token: string;
+        amount: string;
+        environment: string;
+        chainId: number;
+        permit2Address: string;
+        poolAddress: string;
+        nonceManager?: Permit2NonceManager;
+        nonce?: string;
+        deadline: number;
+    }): Promise<TransactionResult>;
+    /** Check the burner's lifecycle status. */
+    getStatus(client: Client<paths>): Promise<BurnerStatus>;
+    /** Mark this burner as disposed, optionally linking a deposit-back tx. */
+    dispose(client: Client<paths>, depositBackTxId?: string): Promise<void>;
+    /** Delete the burner key from storage. Call after dispose. */
+    deleteKey(): Promise<void>;
+    /** Get chain configuration for burner operations. */
+    static getInfo(client: Client<paths>): Promise<BurnerInfo>;
+}
+
+export { type $defs, type AccountExportPayload, type AccountKeys, type ApprovalState, P as BN254_FIELD_ORDER, type BuildApprovalTxParams, type BurnerInfo, type BurnerStatus, type BurnerStorage, BurnerWallet, type ClientOptions, type CreateUnlinkOptions, type EdDSASignature, type EnsureErc20ApprovalParams, type EnsureErc20ApprovalResult, type EthersProviderLike, type EthersSignerLike, type GetApprovalStateParams, Permit2NonceManager, type Permit2TypedData, type Permit2WitnessTypedData, type SignTypedDataFn, type TransactionResult, type TransferInstruction, type UnlinkAccountMnemonicOptions, type UnlinkAccountProvider, type UnlinkAccountSeedOptions, UnlinkApiError, type UnlinkApprovalParams, UnlinkCapabilityError, type UnlinkClient, type UnlinkDepositParams, type UnlinkEthersProviderOptions, type UnlinkEvmProvider, type UnlinkEvmTransactionRequest, type UnlinkGetBalancesParams, type UnlinkGetTransactionsParams, type UnlinkPollOptions, type UnlinkSignerProviderOptions, type UnlinkTransferParams, type UnlinkViemProviderOptions, type UnlinkWithdrawParams, type ViemPublicClientLike, type ViemWalletClientLike, buildApprovalTx, buildPermit2TypedData, type components, createUnlink, createUnlinkClient, createUser, decodeAddress, deposit, deriveAccountKeys, eddsaPublicKey, eddsaSign, eddsaVerify, encodeAddress, ensureErc20Approval, fromBytesBE, fromDecimal, fromHex, getApprovalState, getEnvironment, getPermit2Nonce, getTransaction, getUser, getUserTransactions, mod, type operations, type paths, poseidon, toBytesBE, toDecimal, transfer, unlinkAccount, unlinkEvm, viewingPublicKey, viewingPublicKeyFromHex, type webhooks, withdraw };