@coinbase/cdp-react 0.0.98 → 0.0.100

package/dist/components/ExportWallet/index.d.ts

@@ -1,32 +1,195 @@
 import { ElementType, HTMLAttributes, ReactNode } from 'react';
 import { CopyAddressProps } from '../CopyAddress';
 import { CopyEvmKeyButtonProps } from '../CopyEvmKeyButton';
+/**
+ * The props for the ExportWalletTitle component.
+ *
+ * @see {@link ExportWalletTitle}
+ */
 interface ExportWalletTitleProps extends HTMLAttributes<HTMLElement> {
+    /** The element type to render the title as. */
     as?: ElementType;
 }
+/**
+ * The props for the ExportWallet component.
+ *
+ * @see {@link ExportWallet}
+ */
 interface ExportWalletProps extends Omit<HTMLAttributes<HTMLDivElement>, "children"> {
+    /** The children to render. If a function is provided, it will be called with the address type and isSessionExpired as props. */
     children?: ReactNode | ((props: {
         type: ExportWalletContext["type"];
         isSessionExpired: ExportWalletContext["isSessionExpired"];
     }) => ReactNode);
+    /** The address of the account to export. */
     address: string;
+    /** A function to call when the iframe UI is ready. */
     onIframeReady?: () => void;
+    /** A function to call when the key is copied successfully. */
     onCopySuccess?: () => void;
+    /** A function to call when there is an error in the secure iframe */
     onIframeError?: (error?: string) => void;
+    /** A function to call when the iframe session has expired. */
     onIframeSessionExpired?: () => void;
+    /**
+     * Skip the MFA verification flow. Set to true if you want to handle MFA
+     * verification separately or if you're using your own MFA UI.
+     *
+     * @default false
+     */
     skipMfa?: boolean;
 }
+/**
+ * The context for the ExportWallet component.
+ */
 interface ExportWalletContext extends Pick<ExportWalletProps, "address" | "onIframeReady" | "onCopySuccess" | "onIframeError" | "onIframeSessionExpired"> {
+    /** The type of account to be exported. */
     type: "evm-eoa" | "evm-smart" | "solana";
+    /** Whether the iframe session has expired. */
     isSessionExpired: boolean;
 }
+/**
+ * The props for the ExportWalletCopyAddress component.
+ *
+ * @see {@link ExportWalletCopyAddress}
+ * @see {@link CopyAddressProps}
+ */
 type ExportWalletCopyAddressProps = Omit<CopyAddressProps, "address">;
+/**
+ * The props for the ExportWalletCopyKeyButton component.
+ *
+ * @see {@link ExportWalletCopyKeyButton}
+ * @see {@link CopyEvmKeyButtonProps}
+ */
 type ExportWalletCopyKeyButtonProps = Omit<CopyEvmKeyButtonProps, "address" | "onError" | "onReady" | "onSuccess">;
 declare const ExportWalletContext: import('react').Context<ExportWalletContext>;
+/**
+ * A title for the ExportWalletTitle component.
+ *
+ * @param {ExportWalletTitleProps} props - The props for the ExportWalletTitle component.
+ * @returns {JSX.Element} The rendered component.
+ *
+ * @group Components
+ *
+ * @see {@link ExportWallet}
+ */
 declare const ExportWalletTitle: ({ children, className, as: Component, ...props }: ExportWalletTitleProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * A warning message for the ExportWalletWarning component.
+ *
+ * @param {HTMLAttributes<HTMLDivElement>} props - The props for the ExportWalletWarning component.
+ * @returns {JSX.Element} The rendered component.
+ *
+ * @group Components
+ *
+ * @see {@link ExportWallet}
+ */
 declare const ExportWalletWarning: (props: HTMLAttributes<HTMLDivElement>) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Displays a truncated address with a copy button.
+ *
+ * @param {ExportWalletCopyAddressProps} props - The props for the ExportWalletCopyAddress component.
+ * @returns {JSX.Element} The rendered component.
+ *
+ * @group Components
+ *
+ * @see {@link ExportWallet}
+ * @see {@link CopyAddress}
+ *
+ * @example
+ * ```tsx lines
+ * // Render the ExportWalletCopyAddress component with a custom label
+ * function ExportWalletCopyKeyButtonExample() {
+ *   const { evmAddress } = useEvmAddress();
+ *   if (!evmAddress) return null;
+ *   return (
+ *     <ExportWallet address={evmAddress}>
+ *       <ExportWalletCopyAddress label="My wallet address" />
+ *     </ExportWallet>
+ *   );
+ * }
+ * ```
+ */
 declare const ExportWalletCopyAddress: ({ label, ...props }: ExportWalletCopyAddressProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * A button that copies the private key of an EVM or Solana account.
+ *
+ * Note that an EVM smart account's private key cannot be exported. If a smart account address is provided, the button will not be rendered.
+ *
+ * @param {ExportWalletCopyKeyButtonProps} props - The props for the ExportWalletCopyKeyButton component.
+ * @returns {JSX.Element} The rendered component.
+ *
+ * @group Components
+ *
+ * @see {@link ExportWallet}
+ * @see {@link CopyEvmKeyButton}
+ * @see {@link CopySolanaKeyButton}
+ *
+ * @example
+ * ```tsx lines
+ * // Render the ExportWalletCopyKeyButton component with custom labels
+ * function ExportWalletCopyKeyButtonExample() {
+ *   const { evmAddress } = useEvmAddress();
+ *   if (!evmAddress) return null;
+ *   return (
+ *     <ExportWallet address={evmAddress}>
+ *       <ExportWalletCopyKeyButton label="Copy private key" copiedLabel="Private key copied" />
+ *     </ExportWallet>
+ *   );
+ * }
+ * ```
+ */
 declare const ExportWalletCopyKeyButton: ({ fullWidth, ...props }: ExportWalletCopyKeyButtonProps) => import("react/jsx-runtime").JSX.Element | null;
+/**
+ * A footer for the key export component.
+ *
+ * @param {HTMLAttributes<HTMLDivElement>} props - The props for the component.
+ * @returns {JSX.Element} The key export footer.
+ *
+ * @group Components
+ *
+ * @see {@link ExportWallet}
+ */
 declare const ExportWalletFooter: (props: HTMLAttributes<HTMLDivElement>) => import("react/jsx-runtime").JSX.Element;
+/**
+ * The ExportWallet component is used to export the private key of an EVM or Solana account.
+ *
+ * Note that an EVM smart account's private key cannot be exported. If a smart account address is provided, a warning message will be displayed explaining that the private key cannot be copied, and the copy key button will not be rendered.
+ *
+ * @param {ExportWalletProps} props - The props for the ExportWallet component.
+ * @returns {JSX.Element} The rendered component.
+ *
+ * @see {@link ExportWalletTitle}
+ * @see {@link ExportWalletWarning}
+ * @see {@link ExportWalletCopyAddress}
+ * @see {@link ExportWalletCopyKeyButton}
+ * @see {@link ExportWalletFooter}
+ *
+ * @group Components
+ *
+ * @document ./README.md
+ *
+ * @example
+ * ```tsx lines
+ * // Render the ExportWallet component with an EVM address
+ * function ExportWalletExample() {
+ *   const { evmAddress } = useEvmAddress();
+ *   return (
+ *     <ExportWallet address={evmAddress} />
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx lines
+ * // Render the ExportWallet component with a Solana address
+ * function ExportWalletExample() {
+ *   const { solanaAddress } = useSolanaAddress();
+ *   return (
+ *     <ExportWallet address={solanaAddress} />
+ *   );
+ * }
+ * ```
+ */
 declare const ExportWallet: ({ address, children, className, onIframeError, onIframeReady, onIframeSessionExpired, onCopySuccess, skipMfa, ...props }: ExportWalletProps) => import("react/jsx-runtime").JSX.Element;
 export { ExportWallet, ExportWalletCopyAddress, ExportWalletCopyKeyButton, ExportWalletFooter, ExportWalletTitle, ExportWalletWarning, type ExportWalletProps, type ExportWalletCopyAddressProps, type ExportWalletCopyKeyButtonProps, type ExportWalletTitleProps, };

package/dist/components/ExportWalletModal/index.d.ts

@@ -2,26 +2,199 @@ import { ReactNode } from 'react';
 import { ExportWalletProps, ExportWalletTitleProps } from '../ExportWallet';
 import { ButtonProps } from '../ui/Button';
 import { ModalContentProps } from '../ui/Modal';
+/**
+ * Props for the export wallet modal trigger button
+ *
+ * @see {@link ExportWalletModalTrigger}
+ */
 interface ExportWalletModalTriggerProps extends Partial<Pick<ButtonProps, "className" | "fullWidth" | "size" | "style" | "variant">> {
+    /** If provided, will render the children instead of the default trigger button. */
     children?: ReactNode;
+    /** The label to display on the trigger button. */
     label?: ReactNode;
 }
+/**
+ * Props for the export wallet modal content.
+ *
+ * @augments ModalContentProps
+ *
+ * @see {@link ExportWalletModalContent}
+ */
 type ExportWalletModalContentProps = Omit<ModalContentProps, "children"> & Pick<ExportWalletProps, "children"> & {
+    /** A title for the dialog element */
     title?: ReactNode;
 };
+/**
+ * Props for the export wallet modal title.
+ *
+ * @see {@link ExportWalletModalTitle}
+ */
 type ExportWalletModalTitleProps = ExportWalletTitleProps;
+/**
+ * Props for the export wallet modal close button.
+ *
+ * @see {@link ExportWalletModalClose}
+ */
 interface ExportWalletModalCloseProps {
+    /** If provided, will render the children instead of the default close button. */
     children?: ReactNode;
 }
+/**
+ * Props for the ExportWalletModal component.
+ *
+ * @see {@link ExportWalletModal}
+ */
 interface ExportWalletModalProps extends Pick<ExportWalletProps, "address" | "onIframeReady" | "onCopySuccess" | "onIframeError" | "onIframeSessionExpired"> {
+    /** If provided, will render the children instead of the default trigger button. */
     children?: ReactNode;
+    /** Whether the modal is open. Note: if you set this, you must also set `setIsOpen`. */
     open?: boolean;
+    /** A function to set the modal's open state. Note: if you set this, you must also set `open`. */
     setIsOpen?: (value: boolean) => void;
+    /** Whether to skip the MFA verification flow. */
     skipMfa?: boolean;
 }
+/**
+ * A trigger button that opens the export wallet modal.
+ *
+ * @param {ExportWalletModalTriggerProps} props - The props for the ExportWalletModalTrigger component.
+ * @param {ReactNode} [props.children] - The children to render inside the trigger button.
+ * @param {ReactNode} [props.label] - The label to display on the trigger button.
+ * @returns {JSX.Element} The ExportWalletModalTrigger component.
+ *
+ * @see {@link ExportWalletModal}
+ *
+ * @group Components
+ */
 declare const ExportWalletModalTrigger: ({ children, className, label, ...props }: ExportWalletModalTriggerProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * The export wallet modal title.
+ *
+ * @augments ModalContentProps
+ * @param {ExportWalletModalContentProps} props - The props for the ExportWalletModalContent component.
+ * @returns {JSX.Element} The ExportWalletModalContent component.
+ *
+ * @see {@link ExportWalletModal}
+ *
+ * @group Components
+ */
 declare const ExportWalletModalTitle: ({ children, as: Component, className, ...props }: ExportWalletModalTitleProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * The export wallet modal close button.
+ *
+ * @param {ExportWalletModalCloseProps} props - The props for the ExportWalletModalClose component.
+ * @returns {JSX.Element} The ExportWalletModalClose component.
+ *
+ * @see {@link ExportWalletModal}
+ *
+ * @group Components
+ */
 declare const ExportWalletModalClose: ({ children }: ExportWalletModalCloseProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * The export wallet modal content.
+ *
+ * @augments ModalContentProps
+ * @param {ExportWalletModalContentProps} props - The props for the ExportWalletModalContent component.
+ * @returns {JSX.Element} The ExportWalletModalContent component.
+ *
+ * @see {@link ExportWalletModal}
+ *
+ * @group Components
+ */
 declare const ExportWalletModalContent: ({ children, className, title, ...props }: ExportWalletModalContentProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * A export wallet modal component that wraps the {@link ExportWallet} component.
+ *
+ * @param {ExportWalletModalProps} props - The props for the ExportWalletModal component.
+ * @param {ReactNode} [props.children] - The children to render inside the modal.
+ * @param {boolean} [props.open] - Whether the modal is open.
+ * @param {() => void} [props.setIsOpen] - A function to set the modal's open state.
+ * @returns {JSX.Element} The ExportWalletModal component.
+ *
+ * @see {@link ExportWalletModalClose} for the modal close button.
+ * @see {@link ExportWalletModalContent} for the modal content.
+ * @see {@link ExportWalletModalTitle} for the modal title.
+ * @see {@link ExportWalletModalTrigger} for the trigger button.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Render the ExportWalletModal component with an EVM address
+ * function ExportWalletModalExample() {
+ *   const { evmAddress } = useEvmAddress();
+ *   return (
+ *     <ExportWalletModal address={evmAddress} />
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx lines
+ * // Render the ExportWalletModal component with a Solana address
+ * function ExportWalletModalExample() {
+ *   const { solanaAddress } = useSolanaAddress();
+ *   return (
+ *     <ExportWalletModal address={solanaAddress} />
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx lines
+ * // Render the ExportWalletModal component with a custom label for the trigger button
+ * function ExportWalletModalExample() {
+ *   const { solanaAddress } = useSolanaAddress();
+ *   return (
+ *     <ExportWalletModal address={solanaAddress}>
+ *       <ExportWalletModalTrigger label="Export Solana wallet" />
+ *     </ExportWalletModal>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx lines
+ * // Render the ExportWalletModal component with a custom button as the trigger
+ * function ExportWalletModalExample() {
+ *   const { solanaAddress } = useSolanaAddress();
+ *   return (
+ *     <ExportWalletModal address={solanaAddress}>
+ *       <button type="button">Export Solana wallet</button>
+ *     </ExportWalletModal>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx lines
+ * // Render the ExportWalletModal component with customized content
+ * function ExportWalletModalExample() {
+ *   const { solanaAddress } = useSolanaAddress();
+ *   return (
+ *     <ExportWalletModal address={solanaAddress}>
+ *       <ExportWalletModalTrigger />
+ *       <ExportWalletModalContent>
+ *         <ExportWallet address={solanaAddress}>
+ *           <div className="header">
+ *             <ExportWalletModalTitle />
+ *             <ExportWalletModalClose />
+ *           </div>
+ *           <div className="content">
+ *             <ExportWalletWarning />
+ *             <ExportWalletCopyAddress />
+ *             <ExportWalletCopyKeyButton />
+ *             <p className="help-text">
+ *               Your private key gives full control of your wallet.
+ *               Store it safely and never share it with anyone.
+ *             </p>
+ *           </div>
+ *         </ExportWallet>
+ *       </ExportWalletModalContent>
+ *     </ExportWalletModal>
+ *   );
+ * }
+ * ```
+ */
 declare const ExportWalletModal: ({ address, children, onIframeReady, onCopySuccess, onIframeError, onIframeSessionExpired, open, setIsOpen, skipMfa, }: ExportWalletModalProps) => import("react/jsx-runtime").JSX.Element;
 export { ExportWalletModal, ExportWalletModalClose, ExportWalletModalContent, ExportWalletModalTitle, ExportWalletModalTrigger, type ExportWalletModalProps, type ExportWalletModalCloseProps, type ExportWalletModalContentProps, type ExportWalletModalTitleProps, type ExportWalletModalTriggerProps, };

package/dist/components/Fund/FundForm.d.ts

@@ -1,7 +1,10 @@
 import { FormHTMLAttributes, ReactNode } from 'react';
 import { FundProps } from './types';
+/** The views that the FundForm component can render. */
 export declare const VIEWS: readonly ["form", "error", "transaction-status"];
+/** Type for the views that the FundForm component can render. */
 export type View = (typeof VIEWS)[number];
+/** The props for the FundForm component. */
 export interface FundFormProps extends Omit<FormHTMLAttributes<HTMLFormElement>, "children"> {
     children?: (params: {
         view: View;
@@ -15,4 +18,19 @@ export interface FundFormProps extends Omit<FormHTMLAttributes<HTMLFormElement>,
     unmountOnTransactionSuccess?: boolean;
     unmount?: () => void;
 }
+/**
+ * The FundForm component is a form that allows the user to fund their wallet.
+ *
+ * @param {FundFormProps} props - The props for the FundForm component.
+ * @param {() => void} [props.onPopupClose] - The function to call when the popup is closed.
+ * @param {() => void} [props.onPopupOpen] - The function to call when the popup is opened.
+ * @param {FundProps["openIn"]} [props.openIn] - The type of popup to open.
+ * @param {ReactNode} [props.submitLabel] - The label for the submit button.
+ * @param {boolean} [props.unmountOnTransactionError] - Whether to unmount the form when a transaction error occurs.
+ * @param {boolean} [props.unmountOnTransactionSuccess] - Whether to unmount the form when the transaction is successful.
+ * @param {() => void} [props.unmount] - The function to call when the form is unmounted.
+ * @returns {JSX.Element} The FundForm component.
+ *
+ * @group Components
+ */
 export declare const FundForm: ({ className, children, onPopupClose, onPopupOpen, onSubmit, openIn, submitLabel, unmountOnTransactionError, unmountOnTransactionSuccess, unmount, ...props }: FundFormProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/Fund/FundProvider.d.ts

@@ -1,6 +1,23 @@
 import { ReactNode } from 'react';
 import { FundContextType, FundProps } from './types';
+/**
+ * A provider for the FundContext.
+ *
+ * @param {FundProps} props - The props for the FundProvider.
+ * @param {ReactNode} props.children - The children of the FundProvider.
+ * @param {GetBuyOptions} props.fetchBuyOptions - The function that handles interacting with the Buy Options API.
+ * @param {GetBuyQuote} props.fetchBuyQuote - The function that handles interacting with the Buy Quote API.
+ * @param {string} props.inputType - The input type for the FundProvider.
+ * @returns {JSX.Element} - The rendered component.
+ */
 export declare const FundProvider: ({ children, fetchBuyOptions, fetchBuyQuote, inputType, onError, onStatus, onSuccess, ...props }: Omit<FundProps, "children"> & {
     children: ReactNode;
 }) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Get the value of the FundContext.
+ *
+ * @returns {FundContextType} - The value of the FundContext.
+ *
+ * @group Hooks
+ */
 export declare const useFundContext: () => FundContextType;

package/dist/components/Fund/FundTitle.d.ts

@@ -1,5 +1,17 @@
 import { ElementType, HTMLAttributes } from 'react';
+/**
+ * The props for the FundTitle component.
+ */
 export interface FundTitleProps extends HTMLAttributes<HTMLDivElement> {
     as?: ElementType;
 }
+/**
+ * The FundTitle component is a component that displays the title of the Fund component.
+ *
+ * @param {FundTitleProps} props - The props for the FundTitle component.
+ * @param {ElementType} [props.as] - The element type of the FundTitle component.
+ * @returns {JSX.Element} The FundTitle component.
+ *
+ * @group Components
+ */
 export declare const FundTitle: ({ children, as: Component, className, ...props }: FundTitleProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/Fund/components/FundAmountInput.d.ts

@@ -1,5 +1,18 @@
 import { InputHTMLAttributes } from 'react';
+/**
+ * The props for the FundAmountInput component.
+ */
 export interface FundAmountInputProps extends Omit<InputHTMLAttributes<HTMLInputElement>, "min" | "max" | "value"> {
     error?: string;
 }
+/**
+ * The FundAmountInput component includes an input for the user to enter an amount in crypto or fiat.
+ * It displays the output value below the input, calculated from the provided exchange rate.
+ * There is also a toggle button to switch between crypto and fiat input.
+ * Regardless of which input is selected, the user will receive the crypto amount.
+ *
+ * @param {FundAmountInputProps} props - The props of the FundAmountInput component.
+ * @param {ElementType} [props.as] - The component to render. Defaults to "div".
+ * @returns {JSX.Element} The FundAmountInput component.
+ */
 export declare const FundAmountInput: import('react').ForwardRefExoticComponent<FundAmountInputProps & import('react').RefAttributes<HTMLInputElement>>;

package/dist/components/Fund/components/FundErrorScreen.d.ts

@@ -2,5 +2,12 @@ import { FundStateError } from '../types';
 interface FundErrorScreenProps {
     error: FundStateError | null;
 }
+/**
+ * The FundTransactionStatus component
+ *
+ * @param {FundErrorScreenProps} props - The props for the FundErrorScreen component.
+ * @param {FundErrorScreenProps["error"]} props.error - The error to display.
+ * @returns {JSX.Element} The FundTransactionStatus component.
+ */
 export declare const FundErrorScreen: ({ error }: FundErrorScreenProps) => import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/components/Fund/components/FundPaymentMethods.d.ts

@@ -2,5 +2,12 @@ import { ElementType, HTMLAttributes } from 'react';
 interface FundPaymentMethodsProps extends Omit<HTMLAttributes<HTMLElement>, "children"> {
     as?: ElementType;
 }
+/**
+ * A select list of payment methods.
+ *
+ * @param {FundPaymentMethodsProps} props - The props of the FundPaymentMethods component.
+ * @param {ElementType} [props.as] - The component to render. Note it must not have a Fragment as the root element. Defaults to "div".
+ * @returns {JSX.Element} The FundPaymentMethods component.
+ */
 export declare const FundPaymentMethods: ({ as: Component, ...props }: FundPaymentMethodsProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/Fund/components/FundPresetAmountInputs.d.ts

@@ -2,5 +2,12 @@ import { ElementType, HTMLAttributes } from 'react';
 interface FundPresetAmountInputsProps extends Omit<HTMLAttributes<HTMLElement>, "children"> {
     as?: ElementType;
 }
+/**
+ * A select list of payment methods.
+ *
+ * @param {FundPaymentMethodsProps} props - The props of the FundPaymentMethods component.
+ * @param {ElementType} [props.as] - The component to render. Note it must not have a Fragment as the root element. Defaults to "div".
+ * @returns {JSX.Element} The FundPaymentMethods component.
+ */
 export declare const FundPresetAmountInputs: ({ as: Component, className, ...props }: FundPresetAmountInputsProps) => import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/components/Fund/components/FundTransactionStatus.d.ts

@@ -4,5 +4,11 @@ type StatusComponentProps = {
     unmountOnSuccess?: boolean;
     unmountOnError?: boolean;
 };
+/**
+ * The FundTransactionStatus component
+ *
+ * @param {StatusComponentProps} props - The props for the FundTransactionStatus component.
+ * @returns {JSX.Element} The FundTransactionStatus component.
+ */
 export declare const FundTransactionStatus: (props: StatusComponentProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/Fund/hooks/useBuyUrl.d.ts

@@ -1,14 +1,37 @@
 import { OnrampError, FundProps, FundState } from '../types';
+/**
+ * The params for the useBuyUrl hook.
+ */
 export type UseBuyUrlParams = Pick<FundState, "country" | "cryptoCurrency" | "fiatCurrency" | "network" | "subdivision" | "destinationAddress"> & {
     fetchBuyQuote: FundProps["fetchBuyQuote"];
     onError?: (e: OnrampError | undefined) => void;
     redirectUrl?: string;
 };
+/**
+ * The params for the fetchBuyUrl function.
+ */
 export interface FetchBuyUrlParams {
     paymentMethod: NonNullable<FundState["selectedPaymentMethod"]>["id"];
     paymentAmount: number;
 }
+/**
+ * The return type for the useExchangeRate hook.
+ */
 export type UseBuyUrlReturn = {
     fetchBuyUrl: (params: FetchBuyUrlParams) => Promise<string>;
 };
+/**
+ * The useExchangeRate hook is used to fetch the exchange rate for a given fiat to crypto pair.
+ *
+ * @param {UseBuyUrlParams} params - The params for the useExchangeRate hook.
+ * @param {string} params.country - The country the user is in.
+ * @param {string} params.cryptoCurrency - The crypto currency.
+ * @param {GetBuyQuote} params.fetchBuyQuote - The function that handles interacting with the Buy Quote API.
+ * @param {string} params.fiatCurrency - The fiat currency.
+ * @param {(e: OnrampError | undefined) => void} params.onError - A function that handles the error.
+ * @param {(exchangeRate: number) => void} params.setExchangeRate - A function that sets the exchange rate.
+ * @param {(loading: boolean) => void} params.setIsExchangeRatePending - A function that sets the pending state.
+ * @param {string} params.subdivision - The subdivision of the country the user is in (e.g. state, province, etc.).
+ * @returns {UseBuyUrlReturn} - A function to fetch the exchange rate.
+ */
 export declare const useBuyUrl: ({ country, cryptoCurrency, destinationAddress, fetchBuyQuote, fiatCurrency, network, onError: onErrorProp, redirectUrl, subdivision, }: UseBuyUrlParams) => UseBuyUrlReturn;

package/dist/components/Fund/hooks/useEmitLifecycleStatus.d.ts

@@ -1,5 +1,17 @@
 import { FundLifecycleEvents, FundLifecycleStatus } from '../types';
+/**
+ * The props for the useEmitLifecycleStatus hook.
+ */
 export type UseEmitLifecycleStatusProps = FundLifecycleEvents & {
     lifecycleStatus: FundLifecycleStatus;
 };
+/**
+ * A hook that emits lifecycle statuses.
+ *
+ * @param {UseEmitLifecycleStatusProps} params - The params for the useEmitLifecycleStatus hook.
+ * @param {LifecycleStatus} params.lifecycleStatus - The lifecycle status to emit.
+ * @param {LifecycleEvents["onError"]} params.onError - A function to call when an error occurs.
+ * @param {LifecycleEvents["onSuccess"]} params.onSuccess - A function to call when a success event occurs.
+ * @param {LifecycleEvents["onStatus"]} params.onStatus - A function to call when a status event occurs.
+ */
 export declare const useEmitLifecycleStatus: ({ lifecycleStatus, onError, onSuccess, onStatus, }: UseEmitLifecycleStatusProps) => void;

package/dist/components/Fund/hooks/useExchangeRate.d.ts

@@ -4,8 +4,25 @@ type UseExchangeRateParams = Pick<FundProps, "country" | "fetchBuyQuote" | "cryp
     dispatch: Dispatch<FundAction>;
     onError?: (e: OnrampError | undefined) => void;
 };
+/**
+ * The return type for the useExchangeRate hook.
+ */
 type UseExchangeRateReturn = {
     fetchExchangeRate: () => Promise<void>;
 };
+/**
+ * The useExchangeRate hook is used to fetch the exchange rate for a given fiat to crypto pair.
+ *
+ * @param {UseExchangeRateParams} params - The params for the useExchangeRate hook.
+ * @param {string} params.country - The country the user is in.
+ * @param {string} params.cryptoCurrency - The crypto currency.
+ * @param {GetBuyQuote} params.fetchBuyQuote - The function that handles interacting with the Buy Quote API.
+ * @param {string} params.fiatCurrency - The fiat currency.
+ * @param {(e: OnrampError | undefined) => void} params.onError - A function that handles the error.
+ * @param {(exchangeRate: number) => void} params.setExchangeRate - A function that sets the exchange rate.
+ * @param {(loading: boolean) => void} params.setIsExchangeRatePending - A function that sets the pending state.
+ * @param {string} params.subdivision - The subdivision of the country the user is in (e.g. state, province, etc.).
+ * @returns {UseExchangeRateReturn} - A function to fetch the exchange rate.
+ */
 export declare const useExchangeRate: ({ country, cryptoCurrency, fetchBuyQuote, fiatCurrency, network, onError, dispatch, subdivision, }: UseExchangeRateParams) => UseExchangeRateReturn;
 export {};

package/dist/components/Fund/hooks/usePaymentMethods.d.ts

@@ -4,8 +4,24 @@ type UsePaymentMethodsParams = Pick<FundProps, "country" | "cryptoCurrency" | "f
     dispatch: Dispatch<FundAction>;
     onError?: (e: OnrampError | undefined) => void;
 };
+/**
+ * The return type for the usePaymentMethods hook.
+ */
 type UsePaymentMethodsReturn = {
     fetchPaymentMethods: () => Promise<void>;
 };
+/**
+ * The usePaymentMethods hook is used to fetch and prepare the payment methods for the given country and currency.
+ *
+ * @param {UsePaymentMethodsParams} params - The params for the usePaymentMethods hook.
+ * @param {string} params.country - The country.
+ * @param {GetBuyOptions} params.fetchBuyOptions - The function that handles interacting with the Buy Options API.
+ * @param {string} params.fiatCurrency - The fiat currency.
+ * @param {string} params.subdivision - The subdivision.
+ * @param {(paymentMethods: PaymentMethod[]) => void} params.setPaymentMethods - The function that sets the payment methods.
+ * @param {(loading: boolean) => void} params.setIsPaymentMethodsPending - The function that sets the pending state.
+ * @param {(e: OnrampError | undefined) => void} params.onError - The function that handles errors.
+ * @returns {UsePaymentMethodsReturn} A function to fetch the payment methods.
+ */
 export declare const usePaymentMethods: ({ country, cryptoCurrency, fetchBuyOptions, fiatCurrency, network, subdivision, dispatch, onError, }: UsePaymentMethodsParams) => UsePaymentMethodsReturn;
 export {};

package/dist/components/Fund/hooks/usePopupMonitor.d.ts

@@ -1,3 +1,12 @@
+/**
+ * This code was copied and adapted from Coinbase Onchainkit (buy/hooks/usePopupMonitor.ts)
+ */
+/**
+ * Monitor a popup window and call a callback when it closes
+ *
+ * @param {() => void} [onClose] - Callback to call when the popup window closes
+ * @returns {{ startPopupMonitor: (popupWindow: Window) => void }} An object with a startPopupMonitor function
+ */
 export declare const usePopupMonitor: (onClose?: () => void) => {
     startPopupMonitor: (popupWindow: Window) => void;
 };