@daimo/pay 1.8.4 → 1.8.6

package/build/index.d.ts

@@ -1,14 +1,14 @@
 import React$1, { ReactNode, ReactElement } from 'react';
 export { version } from '../package.json';
-import * as react_jsx_runtime from 'react/jsx-runtime';
 import { CreateConfigParameters } from '@wagmi/core';
 import { CreateConnectorFn } from 'wagmi';
 import { CoinbaseWalletParameters } from 'wagmi/connectors';
-import { DaimoPayOrderView, PaymentStartedEvent, PaymentCompletedEvent, PaymentBouncedEvent, ExternalPaymentOptionsString, DaimoPayUserMetadata, DaimoPayIntentStatus, DaimoPayOrderMode, DepositAddressPaymentOptionMetadata, PlatformType, ExternalPaymentOptionMetadata, WalletPaymentOption, DaimoPayOrderWithOrg, ExternalPaymentOptions, DepositAddressPaymentOptions, DepositAddressPaymentOptionData, SolanaPublicKey } from '@daimo/pay-common';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { DaimoPayOrderView, PaymentStartedEvent, PaymentCompletedEvent, PaymentBouncedEvent, ExternalPaymentOptionsString, DaimoPayUserMetadata, DaimoPayOrderWithOrg, DaimoPayHydratedOrderWithOrg, DaimoPayOrder, DaimoPayOrderID, SolanaPublicKey, DaimoPayIntentStatus, DaimoPayOrderMode, DepositAddressPaymentOptionMetadata, PlatformType, ExternalPaymentOptionMetadata, WalletPaymentOption, ExternalPaymentOptions, DepositAddressPaymentOptions, DepositAddressPaymentOptionData } from '@daimo/pay-common';
 import { Address, Hex } from 'viem';
-import { WalletName } from '@solana/wallet-adapter-base';
 import { AppRouter } from '@daimo/pay-api';
 import { CreateTRPCClient } from '@trpc/client';
+import { WalletName } from '@solana/wallet-adapter-base';
 
 type Hash = `0x${string}`;
 type CustomAvatarProps = {
@@ -69,6 +69,7 @@ type DaimoPayContextOptions = {
 type DaimoPayModalOptions = {
     closeOnSuccess?: boolean;
     resetOnSuccess?: boolean;
+    connectedWalletOnly?: boolean;
 };
 
 type types_All = All;
@@ -83,6 +84,22 @@ declare namespace types {
   export type { types_All as All, types_CustomAvatarProps as CustomAvatarProps, types_CustomTheme as CustomTheme, types_DaimoPayContextOptions as DaimoPayContextOptions, types_DaimoPayModalOptions as DaimoPayModalOptions, types_Languages as Languages, types_Mode as Mode, types_Theme as Theme };
 }
 
+type DefaultConfigProps = {
+    appName: string;
+    appIcon?: string;
+    appDescription?: string;
+    appUrl?: string;
+    /**
+     * WC 2.0 Project ID (get one here: https://cloud.walletconnect.com/sign-in),
+     * it doesn't do much besides tracking. If not provided, use Daimo's
+     * WalletConnect project ID by default. */
+    walletConnectProjectId?: string;
+    coinbaseWalletPreference?: CoinbaseWalletParameters<"4">["preference"];
+    additionalConnectors?: CreateConnectorFn[];
+} & Partial<CreateConfigParameters>;
+/** Daimo Pay recommended config, for use with wagmi's createConfig(). */
+declare const defaultConfig: ({ appName, appIcon, appDescription, appUrl, walletConnectProjectId, coinbaseWalletPreference, additionalConnectors, chains, client, ...props }: DefaultConfigProps) => CreateConfigParameters;
+
 type useConnectCallbackProps = {
     onConnect?: ({ address, connectorId, }: {
         address?: string;
@@ -112,22 +129,6 @@ type DaimoPayProviderProps = {
  */
 declare const DaimoPayProvider: (props: DaimoPayProviderProps) => react_jsx_runtime.JSX.Element;
 
-type DefaultConfigProps = {
-    appName: string;
-    appIcon?: string;
-    appDescription?: string;
-    appUrl?: string;
-    /**
-     * WC 2.0 Project ID (get one here: https://cloud.walletconnect.com/sign-in),
-     * it doesn't do much besides tracking. If not provided, use Daimo's
-     * WalletConnect project ID by default. */
-    walletConnectProjectId?: string;
-    coinbaseWalletPreference?: CoinbaseWalletParameters<"4">["preference"];
-    additionalConnectors?: CreateConnectorFn[];
-} & Partial<CreateConfigParameters>;
-/** Daimo Pay recommended config, for use with wagmi's createConfig(). */
-declare const defaultConfig: ({ appName, appIcon, appDescription, appUrl, walletConnectProjectId, coinbaseWalletPreference, additionalConnectors, chains, client, ...props }: DefaultConfigProps) => CreateConfigParameters;
-
 /** Payment details and status. */
 type DaimoPayment = DaimoPayOrderView;
 /** Props for DaimoPayButton. */
@@ -196,9 +197,7 @@ type PayButtonPaymentProps = {
 } | {
     /** The payment ID, generated via the Daimo Pay API. Replaces params above. */
     payId: string;
-    /**
-     * Payment options. By default, all are enabled.
-     */
+    /** Payment options. By default, all are enabled. */
     paymentOptions?: ExternalPaymentOptionsString[];
 };
 type PayButtonCommonProps = PayButtonPaymentProps & {
@@ -212,12 +211,15 @@ type PayButtonCommonProps = PayButtonPaymentProps & {
     onOpen?: () => void;
     /** Called when the modal is closed. */
     onClose?: () => void;
-    /** Automatically close the modal after a successful payment. */
-    closeOnSuccess?: boolean;
     /** Open the modal by default. */
     defaultOpen?: boolean;
+    /** Automatically close the modal after a successful payment. */
+    closeOnSuccess?: boolean;
     /** Reset the payment after a successful payment. */
     resetOnSuccess?: boolean;
+    /** Go directly to tokens in already-connected Ethereum and Solana wallet(s).
+     * Don't let the user pick any other payment method. Used in embedded flows.*/
+    connectedWalletOnly?: boolean;
     /** Custom message to display on confirmation page. */
     confirmationMessage?: string;
     /** Redirect URL to return to the app. E.g. after Coinbase, Binance, RampNetwork. */
@@ -254,6 +256,155 @@ declare namespace DaimoPayButtonCustom {
     var displayName: string;
 }
 
+/** Payment parameters. The payment is created only after user taps pay. */
+interface PayParams {
+    /** App ID, for authentication. */
+    appId: string;
+    /** Destination chain ID. */
+    toChain: number;
+    /** The destination token to send. */
+    toToken: Address;
+    /**
+     * The amount of the token to send.
+     * If not provided, the user will be prompted to enter an amount.
+     */
+    toUnits?: string;
+    /** The final address to transfer to or contract to call. */
+    toAddress: Address;
+    /** Calldata for final call, or empty data for transfer. */
+    toCallData?: Hex;
+    /** The intent verb, such as Pay, Deposit, or Purchase. Default: Pay */
+    intent?: string;
+    /** Payment options. By default, all are enabled. */
+    paymentOptions?: ExternalPaymentOptionsString[];
+    /** Preferred chain IDs. */
+    preferredChains?: number[];
+    /** Preferred tokens. These appear first in the token list. */
+    preferredTokens?: {
+        chain: number;
+        address: Address;
+    }[];
+    /** Only allow payments on these EVM chains. */
+    evmChains?: number[];
+    /** External ID. E.g. a correlation ID. */
+    externalId?: string;
+    /** Developer metadata. E.g. correlation ID. */
+    metadata?: DaimoPayUserMetadata;
+    /** The address to refund to if the payment bounces or a refund is requested. */
+    refundAddress?: Address;
+}
+type PaymentState$1 = {
+    type: "idle";
+} | {
+    type: "preview";
+    order: DaimoPayOrderWithOrg;
+    payParamsData: PayParamsData;
+} | {
+    type: "unhydrated";
+    order: DaimoPayOrderWithOrg;
+} | {
+    type: "payment_unpaid";
+    order: DaimoPayHydratedOrderWithOrg;
+} | {
+    type: "payment_started";
+    order: DaimoPayHydratedOrderWithOrg;
+} | {
+    type: "payment_completed";
+    order: DaimoPayHydratedOrderWithOrg;
+} | {
+    type: "payment_bounced";
+    order: DaimoPayHydratedOrderWithOrg;
+} | {
+    type: "error";
+    order: DaimoPayOrder | undefined;
+    message: string;
+};
+type PayParamsData = {
+    appId: string;
+};
+
+type DaimoPayFunctions = {
+    /**
+     * Create a new Daimo Pay order preview with the given parameters.
+     * Call this to start a new payment flow.
+     *
+     * @param params - Parameters describing the payment to be created.
+     */
+    createPreviewOrder: (params: PayParams) => Promise<Extract<PaymentState$1, {
+        type: "preview";
+    }>>;
+    /**
+     * Set the order ID to fetch and manage an existing Daimo Pay order.
+     * Useful for resuming or referencing a previously created order.
+     *
+     * @param id - The Daimo Pay order ID to set.
+     */
+    setPayId: (id: DaimoPayOrderID) => Promise<Extract<PaymentState$1, {
+        type: "unhydrated" | "payment_unpaid" | "payment_started" | "payment_completed" | "payment_bounced";
+    }>>;
+    /**
+     * Hydrate the current order, locking in the payment intent details and
+     * token swap prices.
+     */
+    hydrateOrder: (refundAddress?: Address) => Promise<Extract<PaymentState$1, {
+        type: "payment_unpaid";
+    }>>;
+    /**
+     * Register an Ethereum payment source for the current order.
+     * Call this after the user has submitted an Ethereum payment transaction.
+     *
+     * @param args - Details about the Ethereum payment transaction.
+     */
+    payEthSource: (args: {
+        paymentTxHash: Hex;
+        sourceChainId: number;
+        payerAddress: Address;
+        sourceToken: Address;
+        sourceAmount: bigint;
+    }) => void;
+    /**
+     * Register a Solana payment source for the current order.
+     * Call this after the user has submitted a Solana payment transaction.
+     *
+     * @param args - Details about the Solana payment transaction.
+     */
+    paySolanaSource: (args: {
+        paymentTxHash: string;
+        sourceToken: SolanaPublicKey;
+    }) => void;
+    /**
+     * Reset the current payment state and clear the active order.
+     * Call this to start a new payment flow.
+     */
+    reset: () => void;
+    /**
+     * Update the user's chosen amount in USD. Applies only to deposit flow.
+     *
+     * @deprecated
+     */
+    setChosenUsd: (usd: number) => void;
+};
+type DaimoPayState = {
+    [S in PaymentState$1 as S["type"]]: {
+        paymentState: S["type"];
+        order: S extends {
+            order: infer O;
+        } ? O : null;
+    };
+}[PaymentState$1["type"]];
+type UseDaimoPay = DaimoPayFunctions & DaimoPayState;
+/**
+ * React hook for interacting with Daimo Pay orders and payments. Use this hook
+ * to manage the lifecycle of a Daimo Pay payment in your application.
+ *
+ * This hook provides a simple interface to create, hydrate, pay, and reset
+ * Daimo Pay orders.
+ *
+ * @returns {UseDaimoPay} An object with current payment state and methods to
+ * manage Daimo Pay orders and payments.
+ */
+declare function useDaimoPay(): UseDaimoPay;
+
 /** Returns the current payment, or undefined if there is none.
  *
  * Status values:
@@ -269,6 +420,11 @@ declare function useDaimoPayStatus(): {
     status: DaimoPayIntentStatus;
 } | undefined;
 
+type UseDaimoPayUI = {
+    resetPayment: (payParams?: Partial<PayParams>) => Promise<void>;
+};
+declare function useDaimoPayUI(): UseDaimoPayUI;
+
 /** Icon for an EVM chain, given chain ID. No ID shows a loading spinner. */
 declare const Chain: React$1.FC<{
     id?: number;
@@ -284,8 +440,6 @@ declare const wallets: {
 
 declare const daimoPayVersion: string;
 
-type SolanaWalletName = WalletName<string>;
-
 declare enum ROUTES {
     SELECT_METHOD = "daimoPaySelectMethod",
     SELECT_TOKEN = "daimoPaySelectToken",
@@ -302,7 +456,6 @@ declare enum ROUTES {
     CONFIRMATION = "daimoPayConfirmation",
     SOLANA_CONNECT = "daimoPaySolanaConnect",
     SOLANA_CONNECTOR = "daimoPaySolanaConnector",
-    SOLANA_SELECT_TOKEN = "daimoPaySolanaSelectToken",
     SOLANA_SELECT_AMOUNT = "daimoPaySolanaSelectAmount",
     SOLANA_PAY_WITH_TOKEN = "daimoPaySolanaPayWithToken",
     ONBOARDING = "onboarding",
@@ -314,6 +467,8 @@ declare enum ROUTES {
     SWITCHNETWORKS = "switchNetworks"
 }
 
+type TrpcClient = CreateTRPCClient<AppRouter>;
+
 type WalletConfigProps = {
     name?: string;
     shortName?: string;
@@ -342,8 +497,6 @@ type WalletConfigProps = {
     isSolanaOnly?: boolean;
 };
 
-type TrpcClient = CreateTRPCClient<AppRouter>;
-
 declare function useDepositAddressOptions({ trpc, usdRequired, mode, }: {
     trpc: TrpcClient;
     usdRequired: number | undefined;
@@ -394,53 +547,14 @@ declare function useWalletPaymentOptions({ trpc, address, usdRequired, destChain
     isLoading: boolean;
 };
 
-/** Payment parameters. The payment is created only after user taps pay. */
-interface PayParams {
-    /** App ID, for authentication. */
-    appId: string;
-    /** Destination chain ID. */
-    toChain: number;
-    /** The destination token to send. */
-    toToken: Address;
-    /**
-     * The amount of the token to send.
-     * If not provided, the user will be prompted to enter an amount.
-     */
-    toUnits?: string;
-    /** The final address to transfer to or contract to call. */
-    toAddress: Address;
-    /** Calldata for final call, or empty data for transfer. */
-    toCallData?: Hex;
-    /** The intent verb, such as Pay, Deposit, or Purchase. Default: Pay */
-    intent?: string;
-    /** Payment options. By default, all are enabled. */
-    paymentOptions?: ExternalPaymentOptionsString[];
-    /** Preferred chain IDs. */
-    preferredChains?: number[];
-    /** Preferred tokens. These appear first in the token list. */
-    preferredTokens?: {
-        chain: number;
-        address: Address;
-    }[];
-    /** Only allow payments on these EVM chains. */
-    evmChains?: number[];
-    /** External ID. E.g. a correlation ID. */
-    externalId?: string;
-    /** Developer metadata. E.g. correlation ID. */
-    metadata?: DaimoPayUserMetadata;
-    /** The address to refund to if the payment bounces or a refund is requested. */
-    refundAddress?: Address;
-}
 /** Creates (or loads) a payment and manages the corresponding modal. */
 interface PaymentState {
-    generatePreviewOrder: (payParams: PayParams) => void;
-    resetOrder: () => void;
+    generatePreviewOrder: () => void;
+    resetOrder: (payParams?: Partial<PayParams>) => Promise<void>;
     buttonProps: PayButtonPaymentProps | undefined;
     setButtonProps: (props: PayButtonPaymentProps | undefined) => void;
     setPayId: (id: string | undefined) => void;
-    payParams: PayParams | undefined;
-    setPayParams: (payParams: PayParams | undefined) => void;
-    daimoPayOrder: DaimoPayOrderWithOrg | undefined;
+    setPayParams: (payParams: PayParams | undefined) => Promise<void>;
     isDepositFlow: boolean;
     paymentWaitingMessage: string | undefined;
     externalPaymentOptions: ReturnType<typeof useExternalPaymentOptions>;
@@ -456,6 +570,8 @@ interface PaymentState {
     selectedDepositAddressOption: DepositAddressPaymentOptionMetadata | undefined;
     getOrderUsdLimit: () => number;
     setPaymentWaitingMessage: (message: string | undefined) => void;
+    tokenMode: "evm" | "solana" | "all";
+    setTokenMode: (mode: "evm" | "solana" | "all") => void;
     setSelectedWallet: (wallet: WalletConfigProps | undefined) => void;
     setSelectedWalletDeepLink: (deepLink: string | undefined) => void;
     setSelectedExternalOption: (option: ExternalPaymentOptionMetadata | undefined) => void;
@@ -467,13 +583,12 @@ interface PaymentState {
     payWithExternal: (option: ExternalPaymentOptions) => Promise<string>;
     payWithDepositAddress: (option: DepositAddressPaymentOptions) => Promise<DepositAddressPaymentOptionData | null>;
     payWithSolanaToken: (inputToken: SolanaPublicKey) => Promise<string | undefined>;
-    payWithWallet: (wallet?: WalletConfigProps, amountUsd?: number) => Promise<void>;
-    refreshOrder: () => Promise<void>;
+    openInWalletBrowser: (wallet: WalletConfigProps, amountUsd?: number) => void;
     senderEnsName: string | undefined;
 }
 
-/** Daimo Pay internal context. */
-declare const usePayContext: () => PayContextValue;
+type SolanaWalletName = WalletName<string>;
+
 /** Meant for internal use. This will be non-exported in a future SDK version. */
 declare const PayContext: React$1.Context<PayContextValue | null>;
 type PayLogFn = (message: string, ...props: any[]) => void;
@@ -485,8 +600,8 @@ type PayContextValue = {
     setMode: React$1.Dispatch<React$1.SetStateAction<Mode>>;
     customTheme: CustomTheme | undefined;
     setCustomTheme: React$1.Dispatch<React$1.SetStateAction<CustomTheme | undefined>>;
-    lang: Languages$1;
-    setLang: React$1.Dispatch<React$1.SetStateAction<Languages$1>>;
+    lang: Languages;
+    setLang: React$1.Dispatch<React$1.SetStateAction<Languages>>;
     setOnOpen: (fn?: () => void) => void;
     setOnClose: (fn?: () => void) => void;
     open: boolean;
@@ -527,5 +642,8 @@ type PayContextValue = {
     setRedirectReturnUrl: React$1.Dispatch<React$1.SetStateAction<string | undefined>>;
 } & useConnectCallbackProps;
 
-export { Avatar, Chain as ChainIcon, DaimoPayButton, PayContext as DaimoPayContext, DaimoPayProvider, types as Types, daimoPayVersion, defaultConfig as getDefaultConfig, useDaimoPayStatus, usePayContext, wallets };
+/** Daimo Pay internal context. */
+declare const usePayContext: () => PayContextValue;
+
+export { Avatar, Chain as ChainIcon, DaimoPayButton, PayContext as DaimoPayContext, DaimoPayProvider, types as Types, daimoPayVersion, defaultConfig as getDefaultConfig, useDaimoPay, useDaimoPayStatus, useDaimoPayUI, usePayContext, wallets };
 export type { All, CustomAvatarProps, CustomTheme, DaimoPayButtonCustomProps, DaimoPayButtonProps, DaimoPayContextOptions, DaimoPayModalOptions, DaimoPayment, Languages, Mode, Theme };