@rhinestone/deposit-modal 0.12.2 → 0.14.0

package/dist/types-BO4iP6fG.d.cts

@@ -1,612 +0,0 @@
-import { TypedDataDefinition, Address, Hex, WalletClient, PublicClient, Chain } from 'viem';
-import { T as TargetChain } from './caip-D8aRWdEY.cjs';
-
-/**
- * Public config shape exposed on DepositModalProps. Each provider defaults to
- * off — clients must explicitly opt in.
- *
- * A key controls VISIBILITY only. A provider that is enabled but has no
- * implementation yet renders as a disabled "Coming soon" row; one that is not
- * enabled is not shown at all.
- */
-interface AssetMigrationsConfig {
-    polymarket?: boolean;
-    hyperliquid?: boolean;
-    aave?: boolean;
-    morpho?: boolean;
-}
-
-declare const RECOVER_TYPES: {
-    readonly RecoverDeposit: readonly [{
-        readonly name: "depositId";
-        readonly type: "uint256";
-    }, {
-        readonly name: "destination";
-        readonly type: "address";
-    }];
-};
-/** What `signRecovery` is handed. */
-interface SignRecoveryPayload {
-    /**
-     * Sign this exactly. Pass it to `signTypedData` on the wallet that owns
-     * `signer` — or to your account SDK, if `signer` is a smart account.
-     */
-    typedData: TypedDataDefinition<typeof RECOVER_TYPES, "RecoverDeposit">;
-    /**
-     * The address whose signature the processor will verify: the deposit's
-     * `recipient`. Whatever you return must be a signature this address's own
-     * verifier accepts.
-     */
-    signer: Address;
-    /** Deposit being recovered, for your own logging or confirmation UI. */
-    depositId: string;
-    /** Where the funds will go. Covered by the signature. */
-    destination: Address;
-}
-/**
- * Produces a signature the recipient's verifier accepts.
- *
- * - **embedded EOA** (Privy, Turnkey, Dynamic): `signTypedData` and return the raw
- *   65-byte result.
- * - **deployed smart account**: return a signature valid under its ERC-1271
- *   `isValidSignature`. A raw owner signature is usually *not* enough — a Safe, for
- *   instance, expects its own message wrapping — so go through your account SDK.
- * - **undeployed smart account**: wrap it per ERC-6492 so the processor can verify
- *   counterfactually. `ox/erc6492`'s `SignatureErc6492.wrap` does this, and ships
- *   with viem already.
- */
-type SignRecovery = (payload: SignRecoveryPayload) => Promise<Hex>;
-/** Structured code from the processor; drives copy and whether a retry helps. */
-type RecoveryErrorCode = "DEPOSIT_NOT_RECOVERABLE" | "RECOVERY_UNSUPPORTED" | "SIGNATURE_INVALID" | "VERIFICATION_UNAVAILABLE" | "REFUND_RECONCILIATION_REQUIRED" | "REFUND_FAILED";
-
-/**
- * Consumer-supplied RPC URL overrides, scoped to a single modal instance (see
- * {@link RpcUrlsProvider}). Threaded into every client the modal builds — EVM
- * public clients (`public-client.ts`), the wallet adapter's transports
- * (`reown.tsx`), and the Solana connection (`solana.ts`).
- *
- * Keyed by the same `number | "solana"` chain identifier the rest of the modal
- * uses (see `core/constants.ts`), so a single `rpcUrls` prop covers every
- * chain — EVM mainnets, Polygon (137, also feeds Polymarket reads), HyperEVM
- * (999), and Solana.
- */
-type ChainKey = number | "solana";
-type RpcUrlMap = Partial<Record<ChainKey, string>>;
-
-type Caip2ChainId = `eip155:${number}` | `solana:${string}`;
-type ChainId = number | "solana" | "hypercore" | Caip2ChainId;
-interface DepositModalTheme {
-    mode?: "light" | "dark";
-    radius?: "none" | "sm" | "md" | "lg" | "full";
-    fontColor?: string;
-    iconColor?: string;
-    ctaColor?: string;
-    ctaHoverColor?: string;
-    borderColor?: string;
-    backgroundColor?: string;
-}
-interface DepositModalUIConfig {
-    showBackButton?: boolean;
-    maxDepositUsd?: number;
-    minDepositUsd?: number;
-    /**
-     * When true the network/protocol fee is sponsored — the Review / Processing /
-     * Success / Failure screens render the fee line-through and surface a
-     * tooltip on the info icon explaining the sponsorship.
-     */
-    feeSponsored?: boolean;
-    /**
-     * Custom tooltip copy for the fee info icon. Defaults to a generic
-     * "Fees are sponsored" / "Fees apply" message based on `feeSponsored`.
-     */
-    feeTooltip?: string;
-}
-interface ConnectedEventData {
-    address: Address;
-    smartAccount: Address;
-}
-interface DepositSubmittedEventData {
-    txHash: string;
-    sourceChain: ChainId | "unknown";
-    amount: string;
-}
-interface DepositCompleteEventData {
-    txHash: string;
-    destinationTxHash?: string;
-    amount: string;
-    sourceChain: ChainId | "unknown";
-    sourceToken?: string;
-    targetChain: TargetChain;
-    targetToken: string;
-}
-interface DepositFailedEventData {
-    txHash: string;
-    error?: string;
-}
-interface WithdrawSubmittedEventData {
-    txHash: Hex;
-    sourceChain: number;
-    amount: string;
-    accountAddress: Address;
-}
-interface WithdrawCompleteEventData {
-    txHash: Hex;
-    destinationTxHash?: Hex;
-    amount: string;
-    sourceChain: number;
-    sourceToken: Address;
-    targetChain: number;
-    targetToken: Address;
-}
-interface WithdrawFailedEventData {
-    txHash: Hex;
-    error?: string;
-}
-interface ErrorEventData {
-    message: string;
-    code?: string;
-    /**
-     * The underlying wallet/RPC error, verbatim. `message` is written for the
-     * end user and drops the detail a bug report needs — log this instead. Never
-     * render it: it is unsanitized and can carry RPC URLs.
-     */
-    cause?: string;
-}
-interface OutputTokenRule {
-    match: {
-        chain?: string;
-        token?: string;
-        symbol?: string;
-    };
-    outputToken: string;
-}
-/**
- * Which Swapped payment groups the fiat on-ramp offers. Keys are Swapped
- * `payment_group` values; omit the object to offer all of them.
- *
- * Deliberately booleans rather than a list of row descriptors: the label,
- * sublabel and icon belong to the modal, so subsetting cannot drift from — or
- * freeze a stale copy of — Swapped's own limits and naming.
- */
-interface FiatMethodsConfig {
-    creditcard?: boolean;
-    "bank-transfer"?: boolean;
-    "apple-pay"?: boolean;
-}
-interface DepositModalProps {
-    /**
-     * A wallet the host app already has connected. Pass this to reuse the user's
-     * existing session — the modal reads the address off `.account`, so it cannot
-     * disagree with what your app thinks the user is. Also what lets the modal
-     * skip its own connect step when the wallet is the only funding feature.
-     *
-     * Omit it and pass `reownAppId` instead to have the modal connect a wallet
-     * itself.
-     */
-    walletClient?: WalletClient | null;
-    /** Read client paired with `walletClient`. Defaults to the modal's own. */
-    publicClient?: PublicClient | null;
-    targetChain: Chain | TargetChain;
-    targetToken: Address | string;
-    isOpen: boolean;
-    onClose: () => void;
-    inline?: boolean;
-    closeOnOverlayClick?: boolean;
-    sourceChain?: Chain | number;
-    sourceToken?: Address;
-    /**
-     * Pre-fills the deposit amount. Either a USD-denominated number string
-     * (e.g. "25") or the case-insensitive sentinel `"max"`, which fills the
-     * full available balance once it loads (same as the Max preset).
-     */
-    defaultAmount?: string;
-    recipient: Address | string;
-    /**
-     * The user's current in-app balance, in USD, as the consuming app displays
-     * it. When provided, the amount screen shows a "Balance after deposit" row
-     * (`appBalanceUsd + amount`) so the user sees their post-deposit app
-     * balance. The row is hidden when this is omitted.
-     */
-    appBalanceUsd?: number;
-    outputTokenRules?: OutputTokenRule[];
-    rejectUnmapped?: boolean;
-    backendUrl: string;
-    /**
-     * Per-chain RPC URL overrides, keyed by EVM chain id plus the literal
-     * `"solana"` key. Applied everywhere the modal reads chain state — EVM
-     * public clients, the connected wallet's transports (avoiding the
-     * rate-limited public defaults), Polygon/Polymarket reads, HyperEVM (999),
-     * and the Solana connection. Chains left unset use their default RPC.
-     */
-    rpcUrls?: RpcUrlMap;
-    forceRegister?: boolean;
-    reownAppId?: string;
-    /**
-     * Enable importing balances from third-party dapps. Each dapp defaults to
-     * off — clients must explicitly opt in. When a dapp is enabled and the
-     * connected wallet has a balance there, a new row appears on the deposit
-     * entry screen.
-     */
-    assetMigrations?: AssetMigrationsConfig;
-    /**
-     * Open the modal pre-routed into a dapp-import provider, skipping the
-     * deposit-method home screen. Must name an enabled `assetMigrations` key
-     * (e.g. "polymarket"); disabled/unknown values are a no-op. While the
-     * provider's balances are checked the modal shows a loading skeleton;
-     * if the flow turns out to be unreachable (no account, no balance, no
-     * wallet) it falls back to the home screen.
-     */
-    initialAssetMigration?: keyof AssetMigrationsConfig;
-    /** Show fiat on-ramp option(s) that embed Swapped's iframe. Default: false. */
-    /**
-     * Offer the connected wallet as a funding source. Default: true. Turn off to
-     * present a wallet-free flow (QR / fiat / exchange only) even when a wallet
-     * client or `reownAppId` is supplied.
-     */
-    enableWallet?: boolean;
-    enableFiatOnramp?: boolean;
-    /** Show the Transfer Crypto / QR row. Default: true. */
-    enableQrTransfer?: boolean;
-    /**
-     * Restrict Cash to an exact subset of the standard payment groups. Providing
-     * the map opts this modal instance out of regional personalization; omit it
-     * to use backend-resolved methods with the built-in global fallback.
-     * An empty or all-false map disables Cash.
-     */
-    fiatMethods?: FiatMethodsConfig;
-    /**
-     * Show a "Connect exchange" row that opens Swapped Connect — the user
-     * picks their CEX (Coinbase, Binance, Kraken…) or wallet inside the iframe
-     * and Swapped pulls the crypto on-chain to the smart account. Default: false.
-     */
-    enableExchangeConnect?: boolean;
-    onRequestConnect?: () => void;
-    theme?: DepositModalTheme;
-    uiConfig?: DepositModalUIConfig;
-    className?: string;
-    onReady?: () => void;
-    /** Discriminated stream of deposit lifecycle transitions. */
-    onLifecycle?: (event: DepositLifecycleEvent) => void;
-    onEvent?: (event: DepositAnalyticsEvent) => void;
-    onError?: (data: ErrorEventData) => void;
-    debug?: boolean;
-}
-/**
- * One transfer the host app must execute to fund a withdrawal.
- *
- * `to` is authoritative: it is the Rhinestone deposit account the processor
- * watches, except on a same-route withdrawal (source chain+token identical to
- * the target) where the modal skips the bridge and `to` is the end recipient.
- * Either way the app's job is identical — move `amount` of `token` to `to` on
- * `chainId` — so it must never substitute an address of its own.
- */
-interface WithdrawTransferRequest {
-    /** Source chain to send from. */
-    chainId: number;
-    /** Source token; `NATIVE_TOKEN_ADDRESS` for the chain's native asset. */
-    token: Address;
-    /** Amount in the token's base units. */
-    amount: bigint;
-    /** Destination for this transfer. Send here. */
-    to: Address;
-}
-interface WithdrawModalProps {
-    /**
-     * Account holding the funds being withdrawn. Used to read the withdrawable
-     * balance and to keep the user from sending to themselves; the modal never
-     * transacts from it — `onSendTransaction` does.
-     */
-    accountAddress: Address;
-    sourceChain: Chain | number;
-    sourceToken: Address;
-    /**
-     * Initial destination, not a constraint. The withdraw form lets the user pick
-     * any supported chain/token/recipient, so these only seed the fields — pass
-     * them to open on a particular destination, omit them to let the user choose.
-     */
-    targetChain?: Chain | number;
-    targetToken?: Address;
-    recipient?: Address;
-    defaultAmount?: string;
-    isOpen: boolean;
-    onClose: () => void;
-    inline?: boolean;
-    closeOnOverlayClick?: boolean;
-    backendUrl: string;
-    /**
-     * Per-chain RPC URL overrides, keyed by EVM chain id plus the literal
-     * `"solana"` key. Applied to every chain read (EVM public clients and the
-     * connected wallet's transports). Chains left unset use their default RPC.
-     */
-    rpcUrls?: RpcUrlMap;
-    forceRegister?: boolean;
-    /**
-     * Executes the transfer that funds the withdrawal, using whatever account
-     * model the host app has (EOA, smart account, in-app wallet, relayer).
-     *
-     * Must resolve with the **on-chain transaction hash** — not a userOp hash or
-     * bundler id. Progress is tracked by looking the deposit up by that hash, so
-     * anything else leaves the modal waiting on a withdrawal that already
-     * succeeded. Reject to surface a failure in the modal.
-     */
-    onSendTransaction: (request: WithdrawTransferRequest) => Promise<{
-        txHash: Hex;
-    }>;
-    theme?: DepositModalTheme;
-    uiConfig?: DepositModalUIConfig;
-    className?: string;
-    onReady?: () => void;
-    /** Discriminated stream of withdraw lifecycle transitions. */
-    onLifecycle?: (event: WithdrawLifecycleEvent) => void;
-    onEvent?: (event: WithdrawAnalyticsEvent) => void;
-    onError?: (data: ErrorEventData) => void;
-    debug?: boolean;
-}
-/**
- * Self-service recovery modal. Returns a failed or rejected deposit's
- * source-chain funds to an address the user names. The deposit is looked up by
- * transaction hash.
- *
- * The user's own wallet authorizes it: the deposit's `recipient` — the in-app
- * wallet the funds were headed to — signs an EIP-712 struct naming the deposit and
- * the destination, and the processor verifies that signature against the same
- * `recipient` before moving anything. Your app needs no backend and no shared
- * secret; the request goes from the browser through your `deposit-widget-proxy`,
- * which adds only the project API key.
- *
- * Note the signer is the recipient, not the deposit account — deposit accounts are
- * service-owned and cannot sign for themselves.
- */
-interface ClaimModalProps {
-    /**
-     * Signs the recovery authorization. Called with the exact typed data to sign and
-     * the `signer` address whose signature the processor will verify — the deposit's
-     * `recipient`.
-     *
-     * Return whatever that address's own verifier accepts:
-     * - **embedded EOA** (Privy, Turnkey, Dynamic) — `signTypedData`, raw 65-byte
-     *   result.
-     * - **deployed smart account** — a signature valid under its ERC-1271
-     *   `isValidSignature`. A raw owner signature is usually not enough; a Safe, for
-     *   one, expects its own message wrapping, so go through your account SDK.
-     * - **undeployed smart account** — wrap per ERC-6492 so it can be verified
-     *   counterfactually. `SignatureErc6492.wrap` from `ox/erc6492` does this and
-     *   ships with viem already.
-     *
-     * Throwing (or returning nothing) is treated as the user declining, which is
-     * retryable.
-     *
-     * If your users can't sign — a lost embedded wallet, or a recipient your app
-     * controls rather than the user — use `createRefundHandler` from
-     * `@rhinestone/deposit-modal/server` against your own backend instead, and drive
-     * your own UI. That path authorizes on your say-so rather than a signature.
-     */
-    signRecovery: SignRecovery;
-    isOpen: boolean;
-    onClose: () => void;
-    inline?: boolean;
-    closeOnOverlayClick?: boolean;
-    backendUrl: string;
-    rpcUrls?: RpcUrlMap;
-    /** Optional prefills for the lookup form and destination. */
-    defaultTxHash?: string;
-    /**
-     * Prefills the refund destination. Left empty otherwise — the modal
-     * deliberately does NOT default to the deposit's sender, because returning
-     * funds to an exchange's hot wallet can lose them.
-     *
-     * Matches `refundDestination` on `RefundAuthorization` in `./server`, which
-     * is the authoritative version: this one only seeds the field and the user can
-     * edit it. Not related to the deposit's `recipient`.
-     */
-    defaultRefundDestination?: Address;
-    theme?: DepositModalTheme;
-    uiConfig?: DepositModalUIConfig;
-    className?: string;
-    onReady?: () => void;
-    onLifecycle?: (event: ClaimLifecycleEvent) => void;
-    onEvent?: (event: ClaimAnalyticsEvent) => void;
-    onError?: (data: ErrorEventData) => void;
-    debug?: boolean;
-}
-interface AssetOption {
-    id: string;
-    chainId: number;
-    token: Address;
-    symbol: string;
-    name: string;
-    decimals: number;
-    balance?: string;
-    balanceUsd?: number;
-}
-/**
- * Discriminated union covering every deposit flow state transition the
- * consumer can observe. Consumers handle additions in a single switch; the
- * modal can add new event variants without changing the prop surface.
- */
-type DepositLifecycleEvent = {
-    type: "connected";
-    address: Address;
-    smartAccount: Address;
-} | {
-    type: "submitted";
-    txHash: string;
-    sourceChain: ChainId | "unknown";
-    /** Source-token base units (e.g. "1100000" for 1.10 USDC). */
-    amount: string;
-    /**
-     * Decimals of the source token, for converting `amount` to a
-     * human-readable value. Omitted when the token is not recognised
-     * (e.g. a QR deposit of an unlisted token).
-     */
-    sourceDecimals?: number;
-    /**
-     * USD equivalent of the deposit as entered in the modal (token units
-     * for unpriced non-stablecoins). Omitted for flows without an amount
-     * input (QR transfer, fiat onramp, exchange connect).
-     */
-    amountUsd?: string;
-} | {
-    type: "complete";
-    txHash: string;
-    destinationTxHash?: string;
-    /** Source-token base units (e.g. "1100000" for 1.10 USDC). */
-    amount: string;
-    sourceChain: ChainId | "unknown";
-    sourceToken?: string;
-    /**
-     * Decimals of the source token, for converting `amount` to a
-     * human-readable value. Omitted when the token is not recognised
-     * (e.g. a QR deposit of an unlisted token).
-     */
-    sourceDecimals?: number;
-    /**
-     * USD equivalent of the deposit as entered in the modal (token units
-     * for unpriced non-stablecoins). Omitted for flows without an amount
-     * input (QR transfer, fiat onramp, exchange connect).
-     */
-    amountUsd?: string;
-    targetChain: TargetChain;
-    targetToken: string;
-} | {
-    type: "failed";
-    txHash: string;
-    error?: string;
-} | {
-    type: "balance-changed";
-    totalUsd: number;
-} | {
-    type: "smart-account-changed";
-    evm: Address | null;
-    solana: string | null;
-};
-type WithdrawLifecycleEvent = 
-/** The deposit account for the chosen target is registered and fundable. */
-{
-    type: "connected";
-    address: Address;
-    smartAccount: Address;
-} | {
-    type: "submitted";
-    txHash: Hex;
-    sourceChain: number;
-    amount: string;
-    accountAddress: Address;
-} | {
-    type: "complete";
-    txHash: Hex;
-    destinationTxHash?: Hex;
-    amount: string;
-    sourceChain: number;
-    sourceToken: Address;
-    targetChain: number;
-    targetToken: Address;
-} | {
-    type: "failed";
-    txHash: Hex;
-    error?: string;
-};
-type ClaimLifecycleEvent = {
-    type: "lookup";
-    txHash: string;
-    matches: number;
-} | {
-    type: "refund_requested";
-    account: Address;
-    /** Where the funds were asked to go, on the source chain. */
-    destination: Address;
-    chain: number;
-} | {
-    type: "complete";
-    txHash: string;
-    account: Address;
-    destination: Address;
-    chain: number;
-    token: string;
-    amount: string;
-} | {
-    type: "failed";
-    /** HTTP status from the refund endpoint; 0 if it was unreachable. */
-    status?: number;
-    error?: string;
-};
-/**
- * Telemetry events fired when screens open or CTAs are clicked.
- * Distinct from {@link DepositLifecycleEvent}, which tracks transaction state.
- */
-type DepositAnalyticsEvent = {
-    type: "deposit_modal_fiat_methods_rendered";
-    country: string | null;
-    payment_methods: string[];
-    source: "personalized" | "fallback" | "configured";
-} | {
-    type: "deposit_modal_fiat_method_click";
-    country: string | null;
-    payment_method: string;
-    source: "personalized" | "fallback" | "configured";
-} | {
-    type: "deposit_modal_connected_wallet_select_source_open";
-    total_balance_in_external_wallet: number | null;
-    pred_balance: number | null;
-} | {
-    type: "deposit_modal_connected_wallet_select_source_cta_click";
-    total_balance_in_external_wallet: number | null;
-    pred_balance: number | null;
-    cta_name: "token_selected";
-    token_name: string;
-    token_balance: string;
-} | {
-    type: "deposit_modal_transfer_crypto_open";
-    default_chain: string;
-    default_token: string;
-    pred_balance: number | null;
-} | {
-    type: "deposit_modal_transfer_crypto_cta_click";
-    default_chain: string;
-    default_token: string;
-    pred_balance: number | null;
-    cta_name: "copy";
-} | {
-    type: "deposit_modal_connected_wallet_enter_value_open";
-    send_token: string;
-    receive_token: string;
-    pred_balance: number | null;
-} | {
-    type: "deposit_modal_connected_wallet_enter_value_cta_click";
-    send_token: string;
-    receive_token: string;
-    pred_balance: number | null;
-    cta_name: "continue" | "25%" | "50%" | "75%" | "Max";
-};
-type WithdrawAnalyticsEvent = {
-    type: "withdraw_modal_select_amount_open";
-    pred_balance: number | null;
-    default_token: string;
-    default_chain: string;
-} | {
-    type: "withdraw_modal_select_amount_cta_click";
-    pred_balance: number | null;
-    selected_token: string;
-    selected_chain: string;
-    amount: string;
-    cta_name: "withdraw";
-};
-type ClaimAnalyticsEvent = {
-    type: "claim_modal_open";
-} | {
-    type: "claim_modal_lookup";
-    matches: number;
-} | {
-    type: "claim_modal_refund_click";
-    chain: string;
-} | {
-    type: "claim_modal_complete";
-    chain: string;
-} | {
-    type: "claim_modal_failed";
-    chain: string;
-    status?: number;
-};
-type ModalAnalyticsEvent = DepositAnalyticsEvent | WithdrawAnalyticsEvent | ClaimAnalyticsEvent;
-
-export type { AssetMigrationsConfig as A, ChainId as C, DepositAnalyticsEvent as D, ErrorEventData as E, FiatMethodsConfig as F, ModalAnalyticsEvent as M, OutputTokenRule as O, RpcUrlMap as R, SignRecovery as S, WithdrawAnalyticsEvent as W, AssetOption as a, ClaimAnalyticsEvent as b, ClaimLifecycleEvent as c, ClaimModalProps as d, ConnectedEventData as e, DepositCompleteEventData as f, DepositFailedEventData as g, DepositLifecycleEvent as h, DepositModalProps as i, DepositModalTheme as j, DepositModalUIConfig as k, DepositSubmittedEventData as l, WithdrawCompleteEventData as m, WithdrawFailedEventData as n, WithdrawLifecycleEvent as o, WithdrawModalProps as p, WithdrawSubmittedEventData as q, WithdrawTransferRequest as r, RecoveryErrorCode as s, SignRecoveryPayload as t };