@tuwaio/nova-transactions 0.5.3 → 0.7.0

package/dist/{TransactionsInfoModal-DQqtLb9z.d.ts → TransactionsInfoModal-B91DxCMH.d.ts}

@@ -10,6 +10,7 @@ import { MotionProps } from 'framer-motion';
  * @file This file contains the `HashLink` component, a UI element for displaying
  * blockchain hashes with copy-to-clipboard and block explorer link functionality.
  */
+/** Props of {@link HashLink}. */
 type HashLinkProps = {
     /** The full hash string to display and copy (e.g., a transaction hash or wallet address). */
     hash: string;
@@ -35,12 +36,20 @@ type HashLinkProps = {
         linkIcon?: string;
     };
 };
+/**
+ * A shortened hash with a copy button, linked to `explorerUrl` (opened in a new tab) when it is set.
+ *
+ * @param props - See {@link HashLinkProps}.
+ * @returns The hash element.
+ */
 declare function HashLink({ label, hash, explorerUrl, variant, className, classNames }: HashLinkProps): react.JSX.Element;
 
 /**
- * @file This file contains the `StatusAwareText` component, which displays different text based on a transaction's status.
+ * @file This file contains the `StatusAwareText` component, which displays different text based on a transaction's
+ * status.
  */
 
+/** Props of {@link StatusAwareText}. */
 type StatusAwareTextProps = {
     /** The current status of the transaction, used to select the correct text and color. */
     txStatus?: TransactionStatus;
@@ -61,6 +70,9 @@ type StatusAwareTextProps = {
 /**
  * A component that renders text conditionally based on a transaction's status.
  * It's designed to work with the `title` and `description` fields of a transaction object.
+ *
+ * @param props - See {@link StatusAwareTextProps}.
+ * @returns The text, or `null` when there is neither `source` nor `fallback`.
  */
 declare function StatusAwareText({ txStatus, source, fallback, variant, className, applyColor, }: StatusAwareTextProps): ReactNode;
 
@@ -213,18 +225,24 @@ type ToastValidationErrorProps = {
  * - Scrollable monospace message body
  * - One-click copy-to-clipboard with feedback
  *
+ * `useNovaTransactionsError` (from `@tuwaio/nova-transactions/providers`) shows it for you; render it yourself only for a
+ * custom toast.
+ *
+ * @param props - See {@link ToastValidationErrorProps}.
+ * @returns The toast body.
+ *
  * @example
  * ```tsx
- * toast(
- *   (props) => (
- *     <ToastValidationError
- *       {...props}
- *       message={error.message}
- *       fieldName={(error as PulsarTransactionValidationError).field}
- *     />
- *   ),
- *   { containerId: 'nova-validation-errors', type: 'error' }
- * );
+ * import { ToastValidationError } from '@tuwaio/nova-transactions';
+ * import { VALIDATION_ERROR_CONTAINER_ID } from '@tuwaio/nova-transactions/providers';
+ * import { toast } from 'react-toastify';
+ *
+ * export function showValidationError(error: Error & { field?: string }) {
+ *   toast(() => <ToastValidationError message={error.message} fieldName={error.field} />, {
+ *     containerId: VALIDATION_ERROR_CONTAINER_ID,
+ *     type: 'error',
+ *   });
+ * }
  * ```
  */
 declare function ToastValidationError({ message, rawError, fieldName, className, customization, }: ToastValidationErrorProps): JSX.Element;
@@ -240,6 +258,7 @@ declare function ToastValidationError({ message, rawError, fieldName, className,
 type NovaTransactionsLabels = {
     /** Labels for the main wallet information modal. */
     transactionsModal: {
+        /** Labels of the transaction history. */
         history: {
             /** The title for the transaction history section. */
             title: string;
@@ -281,15 +300,22 @@ type NovaTransactionsLabels = {
         gelato: string;
         /** Label for a Safe Transaction Hash. */
         safe: string;
+        /** Label for an ERC-4337 UserOperation Hash. */
+        erc4337: string;
         /** Label for the original transaction hash (before replacement). */
         original: string;
         /** Label for the new transaction hash that replaced the original. */
         replaced: string;
         /** Default label for a standard transaction hash. */
         default: string;
-        /** Special label for the most recent blockhash. This is used for the "Recent Blockhash" field in the transaction details modal. */
+        /**
+         * Special label for the most recent blockhash. This is used for the "Recent Blockhash" field in the transaction
+         * details modal.
+         */
         recentBlockhash: string;
-        /** Special label for the Solana signature. This is used for the "Signature" field in the transaction details modal. */
+        /**
+         * Special label for the Solana signature. This is used for the "Signature" field in the transaction details modal.
+         */
         solana: string;
     };
     /** Labels for the transaction information block. */
@@ -441,15 +467,17 @@ type NovaTransactionsLabels = {
         errorContext: string;
         /** Label for the Full Payload. */
         fullPayload: string;
-        /** Label for the RPC URL. */
-        rpcUrl: string;
         /** Label for the Replaced Hash. */
         replacedHash: string;
         /** Labels for the sync status indicator. */
         syncStatus: {
+            /** Badge shown while the transaction is not yet saved on the server (`syncStatus: 'pending-sync'`). */
             pending: string;
+            /** Tooltip of the `pending` badge. */
             pendingTooltip: string;
+            /** Badge shown when the transaction is saved on the server (`syncStatus: 'synced'`). */
             synced: string;
+            /** Tooltip of the `synced` badge. */
             syncedTooltip: string;
         };
     };
@@ -527,21 +555,53 @@ type NovaTransactionsProviderProps<T extends Transaction> = {
  */
 declare function NovaTransactionsProvider<T extends Transaction>({ adapter, connectedWalletAddress, connectedAdapterType, transactionsPool, initialTx, executeTxAction, closeTxTrackedModal, labels, features, customization, pagination, ...toastProps }: NovaTransactionsProviderProps<T>): react.JSX.Element;
 
+/**
+ * Props of {@link TransactionKey}.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type TransactionKeyProps<T extends Transaction> = Pick<NovaTransactionsProviderProps<T>, 'adapter'> & {
+    /** The transaction. */
     tx: T;
+    /** Layout: `'toast'` adds a top border and spacing. Defaults to `'toast'`. */
     variant?: 'toast' | 'history';
+    /** Classes of the container. */
     className?: string;
+    /**
+     * Renders each hash instead of {@link HashLink}.
+     *
+     * @param props - The props the default `HashLink` would receive.
+     * @returns The rendered hash.
+     */
     renderHashLink?: (props: HashLinkProps) => ReactNode;
+    /** Number of confirmations, shown below the hashes when it is above 0. */
     confirmations?: number;
     /** ClassNames to pass to HashLink components (default and replaced hash) */
     hashLinkClassNames?: HashLinkProps['classNames'];
     /** ClassNames for original hash link in replaced transactions (falls back to hashLinkClassNames) */
     originalHashLinkClassNames?: HashLinkProps['classNames'];
 };
+/**
+ * The identifiers of a transaction: the key of its tracker when it differs from the on-chain hash (Safe transaction
+ * hash, Gelato task ID, ERC-4337 user operation hash, Solana signature), and the on-chain hash; for a replaced
+ * transaction, the original and the replacing hash. Hashes link to the explorer URL of the adapter's
+ * `getExplorerTxUrl` when there is one.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ * @param props - See {@link TransactionKeyProps}.
+ * @returns The identifiers, or `null` when no adapter matches the transaction.
+ */
 declare function TransactionKey<T extends Transaction>({ tx, adapter, variant, className, renderHashLink, confirmations, hashLinkClassNames, originalHashLinkClassNames, }: TransactionKeyProps<T>): react.JSX.Element | null;
 
+/**
+ * Props of {@link TransactionStatusBadge}.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type TransactionStatusBadgeProps<T extends Transaction> = {
+    /** The transaction whose status is shown. */
     tx: T;
+    /** Classes of the badge. */
     className?: string;
     /** Granular class names for sub-elements */
     classNames?: {
@@ -553,26 +613,54 @@ type TransactionStatusBadgeProps<T extends Transaction> = {
         label?: string;
     };
 };
+/**
+ * A colored badge with an icon and the label of the transaction status: pending (while `tx.pending`), success, failed
+ * or replaced, or a neutral badge when the status is not set.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ * @param props - See {@link TransactionStatusBadgeProps}.
+ * @returns The badge.
+ */
 declare function TransactionStatusBadge<T extends Transaction>({ tx, className, classNames, }: TransactionStatusBadgeProps<T>): react.JSX.Element;
 
 /**
- * @file This file contains the `ToastTransaction` component, which serves as the main body for a transaction notification toast.
+ * @file This file contains the `ToastTransaction` component, which serves as the main body for a transaction
+ * notification toast.
  */
 
-type CustomActionButtonProps = {
+/** Props of an action button of {@link ToastTransaction} (speed up, cancel, open transaction). */
+type ToastTransactionActionButtonProps = {
+    /** Runs the action. */
     onClick: () => void;
+    /** The button label. */
     children: ReactNode;
+    /** Classes from `customization.classNames`. */
     className?: string;
 };
+/**
+ * Class names and replacement components for the parts of {@link ToastTransaction}.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type ToastTransactionCustomization<T extends Transaction> = {
-    /** Custom components */
+    /** Components that replace the default parts. */
     components?: {
+        /** The title and the description. */
         StatusAwareText?: ComponentType<StatusAwareTextProps>;
+        /** The hashes of the transaction. */
         TransactionKey?: ComponentType<TransactionKeyProps<T>>;
+        /** The status badge. */
         StatusBadge?: ComponentType<TransactionStatusBadgeProps<T>>;
-        TxInfoButton?: ComponentType<CustomActionButtonProps>;
-        SpeedUpButton?: ComponentType<CustomActionButtonProps>;
-        CancelButton?: ComponentType<CustomActionButtonProps>;
+        /** The button that opens the transaction in the history modal. */
+        TxInfoButton?: ComponentType<ToastTransactionActionButtonProps>;
+        /** The speed-up button. */
+        SpeedUpButton?: ComponentType<ToastTransactionActionButtonProps>;
+        /** The cancel button. */
+        CancelButton?: ComponentType<ToastTransactionActionButtonProps>;
+        /**
+         * The badge with the number of confirmations, shown when it is above 0. It also receives `required` (the required
+         * confirmations) and `isSuccess`.
+         */
         ConfirmationsBadge?: ComponentType<{
             count: number | string;
             className?: string;
@@ -626,42 +714,100 @@ type ToastTransactionCustomization<T extends Transaction> = {
         confirmationsBadge?: string;
     };
 };
+/**
+ * Props of {@link ToastTransaction}.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type ToastTransactionProps<T extends Transaction> = {
+    /** The transaction to show. */
     tx: T;
+    /**
+     * Opens the transaction history modal. The "open transaction" button is shown only when it is set and the connected
+     * wallet sent the transaction.
+     *
+     * @param txKey - Key of the transaction to open.
+     */
     openTxInfoModal?: (txKey?: string) => void;
+    /** Icon shown on the left. Defaults to the icon of the transaction's network. */
     icon?: ReactNode;
+    /** Classes of the toast body. */
     className?: string;
+    /** Class names and replacement components for the parts of the toast. */
     customization?: ToastTransactionCustomization<T>;
+    /** Accepted because `react-toastify` passes it to toast content; not used by the component. */
     closeToast?: ToastContentProps['closeToast'];
+    /** Accepted for compatibility; not used by the component. */
     toastProps?: ToastContainerProps;
 } & Pick<NovaTransactionsProviderProps<T>, 'adapter' | 'connectedWalletAddress'>;
+/**
+ * The body of a transaction toast: the network icon, the title and description (colored by status), the hashes with
+ * explorer links, the status badge and the number of confirmations. For a pending, unconfirmed EVM transaction sent
+ * with
+ * MetaMask by the connected wallet, it offers speed-up and cancel (when the adapter has `speedUpTxAction` and
+ * `cancelTxAction`); otherwise, for transactions of the connected wallet, a button that opens the transaction in the
+ * history modal. `NovaTransactionsProvider` shows one for every tracked transaction.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ * @param props - See {@link ToastTransactionProps}.
+ * @returns The toast body.
+ */
 declare function ToastTransaction<T extends Transaction>({ openTxInfoModal, tx, icon, className, customization, connectedWalletAddress, adapter, }: ToastTransactionProps<T>): JSX.Element;
 
-type CustomHeaderProps$1 = {
+/** Props of the header of {@link TrackingTxModal} (`customization.components.Header`). */
+type TrackingTxModalHeaderProps = {
+    /** Closes the modal. */
     onClose: () => void;
+    /** The title: the transaction title, or its type, colored by status. */
     title: ReactNode;
 };
-type CustomFooterProps = {
+/** Props of the footer of {@link TrackingTxModal} (`customization.components.Footer`). */
+type TrackingTxModalFooterProps = {
+    /** Closes the modal. */
     onClose: () => void;
+    /** Opens the transaction history modal. */
     onOpenAllTransactions: () => void;
+    /** Retries the failed submission; set only when retry is possible. */
     onRetry?: () => void;
+    /** Speeds up the pending transaction; set only when it can be replaced. */
     onSpeedUp?: () => void;
+    /** Cancels the pending transaction; set only when it can be replaced. */
     onCancel?: () => void;
+    /** Whether the transaction is being submitted or is pending. */
     isProcessing?: boolean;
+    /** Whether the submission or the transaction failed. */
     isFailed?: boolean;
+    /** Whether the pending transaction can be sped up or canceled. */
     canReplace?: boolean;
+    /** Address of the connected wallet. */
     connectedWalletAddress?: string;
 };
+/**
+ * Props, class names and replacement components for the parts of {@link TrackingTxModal}.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type TrackingTxModalCustomization<T extends Transaction> = {
+    /** Props passed to the dialog panel (`DialogContent` from `@tuwaio/nova-core`). */
     modalProps?: Partial<ComponentPropsWithoutRef<typeof DialogContent>>;
+    /**
+     * `framer-motion` props of the content container inside the dialog panel (for example `initial`, `animate` and
+     * `transition`). The panel itself animates with `modalAnimation` of `modalProps`.
+     */
     motionProps?: MotionProps;
-    /** Custom components to override default elements */
+    /** Components that replace the default parts. */
     components?: {
-        Header?: ComponentType<CustomHeaderProps$1>;
-        Footer?: ComponentType<CustomFooterProps>;
+        /** The header with the title and the close button. */
+        Header?: ComponentType<TrackingTxModalHeaderProps>;
+        /** The footer with the action buttons. */
+        Footer?: ComponentType<TrackingTxModalFooterProps>;
+        /** The large status icon. */
         StatusVisual?: ComponentType<TxStatusVisualProps>;
+        /** The steps of the transaction lifecycle. */
         ProgressIndicator?: ComponentType<TxProgressIndicatorProps>;
+        /** The block with the network, time and hashes of the transaction. */
         InfoBlock?: ComponentType<TxInfoBlockProps<T>>;
+        /** The error message block. */
         ErrorBlock?: ComponentType<TxErrorBlockProps>;
     };
     /** Granular classNames for all sub-elements */
@@ -717,14 +863,41 @@ type TrackingTxModalCustomization<T extends Transaction> = {
         classNames?: TxErrorBlockClassNames;
     };
 };
+/**
+ * Props of {@link TrackingTxModal}. The Pulsar values come from `NovaTransactionsProvider`.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type TrackingTxModalProps<T extends Transaction> = Pick<NovaTransactionsProviderProps<T>, 'executeTxAction' | 'initialTx' | 'transactionsPool' | 'adapter' | 'connectedWalletAddress'> & {
+    /**
+     * Closes the modal.
+     *
+     * @param txKey - Key of the shown transaction, when it is in the pool.
+     */
     onClose: (txKey?: string) => void;
+    /** Opens the transaction history modal. */
     onOpenAllTransactions: () => void;
+    /** Classes of the modal content. */
     className?: string;
+    /** Props, class names and replacement components for the parts of the modal. */
     customization?: TrackingTxModalCustomization<T>;
 };
+/**
+ * A modal that follows the latest submitted transaction step by step: it shows `initialTx` of the Pulsar store while
+ * the transaction is being submitted, then the transaction of the pool that `initialTx.lastTxKey` points to. It is
+ * open while `initialTx.withTrackedModal` is set and the transaction is not yet in the pool, and then while the
+ * transaction's `isTrackedModalOpen` is `true`. It shows the status, the lifecycle steps, the network, time and hashes,
+ * and the error, and offers speed-up and cancel (pending, unconfirmed EVM transactions sent with MetaMask, when the
+ * adapter has `speedUpTxAction` and `cancelTxAction`) and retry (after a failure, while `initialTx` has its
+ * `actionFunction`, through the adapter's `retryTxAction`). `NovaTransactionsProvider` renders it.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ * @param props - See {@link TrackingTxModalProps}.
+ * @returns The modal, or `null` when there is no transaction to show.
+ */
 declare function TrackingTxModal<T extends Transaction>({ adapter, onClose, onOpenAllTransactions, className, customization, transactionsPool, executeTxAction, initialTx, connectedWalletAddress, }: TrackingTxModalProps<T>): react.JSX.Element | null;
 
+/** Class names of the parts of {@link TxErrorBlock}. */
 type TxErrorBlockClassNames = {
     /** Classes for the container */
     container?: string;
@@ -741,8 +914,11 @@ type TxErrorBlockClassNames = {
     /** Classes for the message text */
     messageText?: string;
 };
+/** Props of {@link TxErrorBlock}. */
 type TxErrorBlockProps = {
-    /** The error to display. Can be a string or a TuwaErrorState. If undefined or empty, the component renders nothing. */
+    /**
+     * The error to display. Can be a string or a TuwaErrorState. If undefined or empty, the component renders nothing.
+     */
     error?: string | TuwaErrorState;
     /** Optional additional CSS classes for the container. */
     className?: string;
@@ -753,23 +929,41 @@ type TxErrorBlockProps = {
  * A component that displays a formatted block for a transaction error message.
  * It includes a title, an icon, the error message in a scrollable area,
  * and a button to copy the message to the clipboard.
+ *
+ * @param props - See {@link TxErrorBlockProps}.
+ * @returns The block, or `null` without an error.
  */
 declare function TxErrorBlock({ error, className, classNames }: TxErrorBlockProps): react.JSX.Element | null;
 
-type CustomInfoRowProps = {
+/** Props of a row of {@link TxInfoBlock} (`customization.components.InfoRow`). */
+type TxInfoBlockInfoRowProps = {
+    /** Label on the left. */
     label: ReactNode;
+    /** Value on the right. */
     value: ReactNode;
-    classNames?: InfoRowClassNames;
+    /** Classes of the parts of the row. */
+    classNames?: TxInfoBlockInfoRowClassNames;
 };
-type InfoRowClassNames = {
+/** Class names of a row of {@link TxInfoBlock}. */
+type TxInfoBlockInfoRowClassNames = {
+    /** The row (from `customization.classNames.row`). */
     row?: string;
+    /** The label (from `customization.classNames.rowLabel`). */
     label?: string;
+    /** The value (from `customization.classNames.rowValue`). */
     value?: string;
 };
+/**
+ * Class names and replacement parts for {@link TxInfoBlock}.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type TxInfoBlockCustomization<T extends Transaction> = {
-    /** Custom components */
+    /** Components that replace the default parts. */
     components?: {
-        InfoRow?: ComponentType<CustomInfoRowProps>;
+        /** A row with a label and a value (network, start time, slot…). */
+        InfoRow?: ComponentType<TxInfoBlockInfoRowProps>;
+        /** Renders each hash of the transaction key section (`renderHashLink` of `TransactionKey`). */
         transactionKey?: TransactionKeyProps<T>['renderHashLink'];
     };
     /** Granular classNames for sub-elements */
@@ -790,10 +984,17 @@ type TxInfoBlockCustomization<T extends Transaction> = {
         originalHashLink?: HashLinkProps['classNames'];
     };
 };
+/**
+ * Props of {@link TxInfoBlock}.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type TxInfoBlockProps<T extends Transaction> = {
     /** The transaction object to display, which can be a full transaction or an initial one. */
     tx: T | InitialTransaction;
+    /** Classes of the block. */
     className?: string;
+    /** Class names and replacement parts for the block. */
     customization?: TxInfoBlockCustomization<T>;
 } & Pick<NovaTransactionsProviderProps<T>, 'adapter'>;
 /**
@@ -802,6 +1003,7 @@ type TxInfoBlockProps<T extends Transaction> = {
  */
 declare function TxInfoBlock<T extends Transaction>({ tx, adapter, className, customization }: TxInfoBlockProps<T>): react.JSX.Element | null;
 
+/** State of a step of {@link TxProgressIndicator}, which sets its colors and icon. */
 type StepStatus = 'active' | 'completed' | 'error' | 'inactive' | 'replaced';
 /** ClassNames for step styling overrides */
 type StepClassNames = {
@@ -820,35 +1022,62 @@ type StepClassNames = {
         label?: string;
     }>>;
 };
+/** Props of a step of {@link TxProgressIndicator} (`StepComponent`). */
 type StepProps = {
+    /** State of the step. */
     status: StepStatus;
+    /** Label under the step. */
     label: string;
+    /** Whether it is the first step; the default step draws no line before it. */
     isFirst?: boolean;
+    /** Whether it is the last step (not used by the default step). */
     isLast?: boolean;
+    /** Class names of the step (`stepClassNames` of the indicator). */
     classNames?: StepClassNames;
 };
+/** Props of {@link TxProgressIndicator}. */
 interface TxProgressIndicatorProps {
+    /** Whether the transaction is being submitted or is pending. */
     isProcessing?: boolean;
+    /** Whether the transaction succeeded. */
     isSucceed?: boolean;
+    /** Whether the submission or the transaction failed. */
     isFailed?: boolean;
+    /** Whether the transaction was replaced (sped up or canceled). */
     isReplaced?: boolean;
+    /** Classes of the indicator. */
     className?: string;
+    /** Component that renders each step. */
     StepComponent?: ComponentType<StepProps>;
     /** ClassNames for step customization */
     stepClassNames?: StepClassNames;
 }
+/**
+ * Three steps of the transaction lifecycle, used by the tracking modal: "created" (always completed), "processing"
+ * (active while processing, completed after) and a final step that shows success, failure or replacement.
+ *
+ * @param props - See {@link TxProgressIndicatorProps}.
+ * @returns The indicator.
+ */
 declare function TxProgressIndicator({ isProcessing, isSucceed, isFailed, isReplaced, className, StepComponent, stepClassNames, }: TxProgressIndicatorProps): react.JSX.Element;
 
 /**
- * @file This file contains the `TxStatusVisual` component, which displays a large icon representing the transaction's status.
+ * @file This file contains the `TxStatusVisual` component, which displays a large icon representing the transaction's
+ * status.
+ */
+/**
+ * State shown by {@link TxStatusVisual}: the first that applies of succeed, failed, replaced and processing, else
+ * initializing.
  */
-type StatusKey = 'succeed' | 'failed' | 'replaced' | 'processing' | 'initializing';
+type TxStatusVisualStatusKey = 'succeed' | 'failed' | 'replaced' | 'processing' | 'initializing';
+/** Class names of the icon of {@link TxStatusVisual}. */
 type TxStatusVisualClassNames = {
     /** Base icon className applied to all statuses */
     icon?: string;
     /** Status-specific icon overrides */
-    statusOverrides?: Partial<Record<StatusKey, string>>;
+    statusOverrides?: Partial<Record<TxStatusVisualStatusKey, string>>;
 };
+/** Props of {@link TxStatusVisual}. */
 type TxStatusVisualProps = {
     /** True if the transaction is currently being processed (e.g., in the mempool). */
     isProcessing?: boolean;
@@ -866,100 +1095,179 @@ type TxStatusVisualProps = {
 /**
  * A component that renders a large, animated icon to visually represent the
  * current state of a transaction within the tracking modal.
+ *
+ * @param props - See {@link TxStatusVisualProps}.
+ * @returns The icon in its container.
  */
 declare function TxStatusVisual({ isProcessing, isSucceed, isFailed, isReplaced, className: containerClassName, iconClassNames, }: TxStatusVisualProps): react.JSX.Element;
 
-/** Props for a copyable field block */
+/** Props of a field with a copy button in {@link TransactionDetails} (hash, sender, recipient, replaced hash). */
 type CopyableFieldProps = {
+    /** Label shown above the field. */
     label: string;
+    /** Value shown in the field and copied to the clipboard by the copy button. */
     value: string;
+    /** Whether the value uses a monospace font. Defaults to `true`. */
     mono?: boolean;
+    /** Classes of the field. */
     className?: string;
+    /** Content shown instead of the value (the copy button still copies `value`); used for the explorer link. */
     children?: ReactNode;
+    /** Classes of the parts of the field. */
     classNames?: {
+        /** The label. */
         label?: string;
+        /** The row with the value and the copy button. */
         container?: string;
+        /** The value. */
         code?: string;
+        /** The copy button. */
         copyButton?: string;
     };
 };
-/** Props for a single detail item (Label + Value) */
+/** Props of a label and value pair in the execution data of {@link TransactionDetails}. */
 type DetailItemProps = {
+    /** Label shown above the value. */
     label: string;
+    /** The value. The default item renders nothing when it is `null`, `undefined` or an empty string. */
     value: string | number | null | undefined;
+    /** Whether the value uses a smaller monospace font. Defaults to `false`. */
     mono?: boolean;
+    /** Classes of the item. */
     className?: string;
+    /** Classes of the parts of the item. */
     classNames?: {
+        /** The label. */
         label?: string;
+        /** The value. */
         value?: string;
     };
 };
-/** Props for a row in the metadata section */
+/** Props of a row of the metadata section of {@link TransactionDetails} (adapter, times, tracker, connector…). */
 type MetadataRowProps = {
+    /** Icon component (a Heroicons icon by default), rendered with a `className`. */
     icon: ComponentType<{
         className?: string;
     }>;
+    /** Label shown on the left. */
     label: string;
+    /** Value shown on the right. */
     children: ReactNode;
+    /** Classes of the row. */
     className?: string;
+    /** Classes of the parts of the row. */
     classNames?: {
+        /** The icon. */
         icon?: string;
+        /** The label. */
         label?: string;
+        /** The value. */
         value?: string;
     };
 };
-/** Props for a JSON/Code block */
+/**
+ * Props of a code block with a copy button in {@link TransactionDetails} (input data, instructions, payload, error).
+ */
 type JsonBlockProps = {
+    /** Label shown above the block. */
     label: string;
+    /**
+     * Data to show: strings as they are, other values as formatted JSON. The default block renders nothing for empty
+     * values and empty objects.
+     */
     data: unknown;
+    /** Classes of the block. */
     className?: string;
+    /** Classes of the parts of the block. */
     classNames?: {
+        /** The row with the label and the copy button. */
         header?: string;
+        /** The label. */
         label?: string;
+        /** The copy button. */
         copyButton?: string;
+        /** The scrollable container of the code. */
         container?: string;
+        /** The `<pre>` element with the code. */
         pre?: string;
     };
 };
+/** Class names and replacement components for the parts of {@link TransactionDetails}. */
 type TransactionDetailsCustomization = {
-    /** Custom class names for all sub-elements */
+    /** Classes added to the parts of the view. */
     classNames?: {
+        /** The whole view. */
         container?: string;
+        /** The header row with the back button and the title. */
         header?: string;
+        /** The back button. */
         backButton?: string;
+        /** The status icon in the main card. */
         statusIconContainer?: string;
+        /** The title (the `transactionDetails.title` label). */
         title?: string;
+        /** The subtitle under the title (the `transactionDetails.subtitle` label). */
         subtitle?: string;
+        /** The headings of the metadata and execution data sections. */
         sectionHeader?: string;
+        /** The main card with the status, hash, network, sender and recipient. */
         coreInfoCard?: string;
+        /** The network badge in the main card. */
         networkBadge?: string;
+        /** The metadata section. */
         metadataSection?: string;
+        /** The execution data section. */
         executionSection?: string;
     };
-    /** Custom components to override default elements */
+    /** Components that replace the default parts. */
     components?: {
+        /** A card around a section (props: `children`, `className`). */
         SectionCard?: ComponentType<{
             children: ReactNode;
             className?: string;
         }>;
+        /** A section heading (props: `children`, `className`). */
         SectionHeading?: ComponentType<{
             children: ReactNode;
             className?: string;
         }>;
+        /** A field with a copy button. */
         CopyableField?: ComponentType<CopyableFieldProps>;
+        /** A label and value pair. */
         DetailItem?: ComponentType<DetailItemProps>;
+        /** A row of the metadata section. */
         MetadataRow?: ComponentType<MetadataRowProps>;
+        /** A code block with a copy button. */
         JsonBlock?: ComponentType<JsonBlockProps>;
     };
 };
+/**
+ * Props of {@link TransactionDetails}.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type TransactionDetailsProps<T extends Transaction> = Pick<NovaTransactionsProviderProps<T>, 'adapter'> & {
+    /** The transaction to show. */
     tx: T;
+    /** Called by the back button. */
     onBack: () => void;
+    /** Classes of the view. */
     className?: string;
+    /** Class names and replacement components for the parts of the view. */
     customization?: TransactionDetailsCustomization;
 };
 /**
- * TransactionDetails component provides a deep look into a specific transaction's metadata and execution state.
+ * A detailed view of one transaction, shown by {@link TransactionsHistory} when a transaction is selected: the status,
+ * hash (linked to the explorer URL of the adapter's `getExplorerTxUrl`, when there is one), network, sender and
+ * recipient; the metadata (adapter, submission and finish times, tracker, connector, confirmations, transaction key;
+ * the RPC URL of the transaction is not shown, since it may contain an API key); and the execution data of the chain
+ * (EVM: nonce, fees, value, replaced hash, input data; Solana: fee, slot, recent blockhash, instructions; Starknet:
+ * contract address, actual fee), the payload and the error, and whether the transaction is saved on the server of the
+ * Pulsar store (`syncStatus`). Values can be copied to the clipboard.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ * @param props - See {@link TransactionDetailsProps}.
+ * @returns The view.
  */
 declare function TransactionDetails<T extends Transaction>({ tx, onBack, adapter, className, customization, }: TransactionDetailsProps<T>): react.JSX.Element;
 
@@ -968,12 +1276,18 @@ declare function TransactionDetails<T extends Transaction>({ tx, onBack, adapter
  * in a list format for the transaction history view.
  */
 
-type CustomIconProps = {
+/** Props of the icon of {@link TransactionHistoryItem} (`customization.components.Icon`). */
+type TransactionHistoryItemIconProps = {
+    /** Chain of the transaction. */
     chainId: number | string;
+    /** Classes from `customization.classNames.icon`. */
     className?: string;
 };
-type CustomTimestampProps = {
+/** Props of the timestamp of {@link TransactionHistoryItem} (`customization.components.Timestamp`). */
+type TransactionHistoryItemTimestampProps = {
+    /** Submission time of the transaction, in seconds (`localTimestamp`). */
     timestamp?: number;
+    /** Classes from `customization.classNames.timestamp`. */
     className?: string;
 };
 /**
@@ -981,13 +1295,19 @@ type CustomTimestampProps = {
  * Allows styling of all sub-elements including icon, text, badge, and hash link.
  */
 type TransactionHistoryItemCustomization<T extends Transaction> = {
-    /** Custom components */
+    /** Components that replace the default parts. */
     components?: {
-        Icon?: ComponentType<CustomIconProps>;
+        /** The network icon. */
+        Icon?: ComponentType<TransactionHistoryItemIconProps>;
+        /** The title (the transaction title, or its type). */
         Title?: ComponentType<StatusAwareTextProps>;
+        /** The description. */
         Description?: ComponentType<StatusAwareTextProps>;
-        Timestamp?: ComponentType<CustomTimestampProps>;
+        /** The relative submission time ("5 minutes ago"). */
+        Timestamp?: ComponentType<TransactionHistoryItemTimestampProps>;
+        /** The status badge. */
         StatusBadge?: ComponentType<TransactionStatusBadgeProps<T>>;
+        /** The hashes of the transaction. */
         TransactionKey?: ComponentType<TransactionKeyProps<T>>;
     };
     /** Custom class name generators for all sub-elements */
@@ -1028,6 +1348,11 @@ type TransactionHistoryItemCustomization<T extends Transaction> = {
         originalHashCopyButton?: string;
     };
 };
+/**
+ * Props of {@link TransactionHistoryItem}.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type TransactionHistoryItemProps<T extends Transaction> = {
     /** The transaction object to display. */
     tx: T;
@@ -1040,16 +1365,31 @@ type TransactionHistoryItemProps<T extends Transaction> = {
     /** Whether transaction details can be viewed by clicking on history items. */
     canViewDetails?: boolean;
 } & Pick<NovaTransactionsProviderProps<T>, 'adapter'>;
+/**
+ * One transaction of the history list: the network icon, title, relative submission time (`dayjs` with the
+ * `relativeTime` plugin, which this module adds to `dayjs` when it is imported), description, status badge and hashes.
+ * Clicking the item (outside its links and buttons) calls `onSelectTx` when `canViewDetails` is `true`.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ * @param props - See {@link TransactionHistoryItemProps}.
+ * @returns The item.
+ */
 declare function TransactionHistoryItem<T extends Transaction>({ tx, adapter, className, customization, onSelectTx, canViewDetails, }: TransactionHistoryItemProps<T>): JSX.Element;
 
-type CustomPlaceholderProps = {
+/** Props of the placeholder of {@link TransactionsHistory} (no wallet connected, or no transactions). */
+type TransactionsHistoryPlaceholderProps = {
+    /** The placeholder title. */
     title: string;
+    /** The placeholder message. */
     message: string;
+    /** Classes of the placeholder. */
     className?: string;
 };
 /** Props exposed to a custom Loader component */
 type TransactionsHistoryLoaderProps = {
+    /** Classes from `customization.classNames.loaderContainer`. */
     className?: string;
+    /** Classes from `customization.classNames.loaderIcon`. */
     iconClassName?: string;
 };
 /**
@@ -1119,7 +1459,7 @@ type TransactionsHistoryCustomization<T extends Transaction> = {
     /** Custom components */
     components?: {
         /** Custom placeholder component */
-        Placeholder?: ComponentType<CustomPlaceholderProps>;
+        Placeholder?: ComponentType<TransactionsHistoryPlaceholderProps>;
         /** Custom history item component */
         HistoryItem?: ComponentType<TransactionHistoryItemProps<T>>;
         /** Custom loader component rendered at the bottom during pagination loading */
@@ -1128,8 +1468,15 @@ type TransactionsHistoryCustomization<T extends Transaction> = {
     /** Customization for the detailed transaction view */
     detailsCustomization?: TransactionDetailsCustomization;
 };
+/**
+ * Props of {@link TransactionsHistory}.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type TransactionsHistoryProps<T extends Transaction> = Pick<NovaTransactionsProviderProps<T>, 'adapter' | 'transactionsPool' | 'connectedWalletAddress'> & {
+    /** Classes of the list. */
     className?: string;
+    /** Class names and replacement components for the parts of the list and of the details view. */
     customization?: TransactionsHistoryCustomization<T>;
     /** Pagination state for infinite scroll. Uses TxInMemoryPagination from @tuwaio/pulsar-core. */
     pagination?: TxInMemoryPagination;
@@ -1138,12 +1485,32 @@ type TransactionsHistoryProps<T extends Transaction> = Pick<NovaTransactionsProv
     /** Whether transaction details can be viewed by clicking on history items. Defaults to true. */
     canViewDetails?: boolean;
 };
+/**
+ * The transactions of the connected wallet (`selectAllTransactionsByActiveWallet` from `@tuwaio/pulsar-core`), newest
+ * first, with a placeholder when no wallet is connected or there are no transactions. Selecting an item opens
+ * {@link TransactionDetails} (when `canViewDetails` is `true`; `initialTxKey` opens one directly). With `pagination`,
+ * it
+ * calls `pagination.fetchNextPage(connectedWalletAddress)` when the end of the list becomes visible (an
+ * `IntersectionObserver`) and shows a short error indicator when loading a page fails.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ * @param props - See {@link TransactionsHistoryProps}.
+ * @returns The list, or the details of the selected transaction.
+ */
 declare function TransactionsHistory<T extends Transaction>({ adapter, connectedWalletAddress, transactionsPool, className, customization, pagination, initialTxKey, canViewDetails, }: TransactionsHistoryProps<T>): react.JSX.Element;
 
-type CustomHeaderProps = {
+/** Props of the header of {@link TransactionsInfoModal} (`customization.components.Header`). */
+type TransactionsInfoModalHeaderProps = {
+    /** Closes the modal. */
     closeModal: () => void;
 };
+/**
+ * Props, class names and replacement components for the parts of {@link TransactionsInfoModal}.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type TransactionsInfoModalCustomization<T extends Transaction> = {
+    /** Props passed to the dialog panel (`DialogContent` from `@tuwaio/nova-core`). */
     modalProps?: Partial<ComponentPropsWithoutRef<typeof DialogContent>>;
     /** Granular classNames for modal elements */
     classNames?: {
@@ -1158,21 +1525,44 @@ type TransactionsInfoModalCustomization<T extends Transaction> = {
     };
     /** Customization for TransactionsHistory component */
     historyCustomization?: TransactionsHistoryProps<T>['customization'];
-    /** Custom components */
+    /** Components that replace the default parts. */
     components?: {
-        Header?: ComponentType<CustomHeaderProps>;
+        /** The header with the title and the close button. */
+        Header?: ComponentType<TransactionsInfoModalHeaderProps>;
+        /** The transaction list. */
         History?: ComponentType<TransactionsHistoryProps<T>>;
     };
 };
+/**
+ * Props of {@link TransactionsInfoModal}.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ */
 type TransactionsInfoModalProps<T extends Transaction> = Pick<NovaTransactionsProviderProps<T>, 'adapter' | 'connectedAdapterType' | 'connectedWalletAddress' | 'transactionsPool'> & {
+    /** Whether the modal is open. */
     isOpen?: boolean;
+    /**
+     * Opens or closes the modal.
+     *
+     * @param value - `false` when the modal is closed.
+     */
     setIsOpen: (value: boolean) => void;
+    /** Props, class names and replacement components for the parts of the modal. */
     customization?: TransactionsInfoModalCustomization<T>;
     /** Pagination state for infinite scroll, forwarded to TransactionsHistory. */
     pagination?: TxInMemoryPagination;
     /** Optional transaction key to open directly in detail view */
     selectedTxKey?: string | null;
 };
+/**
+ * A modal with the transaction history of the connected wallet ({@link TransactionsHistory}).
+ * `NovaTransactionsProvider`
+ * opens it from the toasts and the tracking modal.
+ *
+ * @typeParam T - The transaction type of the Pulsar store.
+ * @param props - See {@link TransactionsInfoModalProps}.
+ * @returns The modal.
+ */
 declare function TransactionsInfoModal<T extends Transaction>({ isOpen, setIsOpen, customization, adapter, connectedWalletAddress, transactionsPool, pagination, selectedTxKey, }: TransactionsInfoModalProps<T>): react.JSX.Element;
 
-export { type TxStatusVisualClassNames as $, type TransactionKeyProps as A, TransactionStatusBadge as B, type CopyableFieldProps as C, type DetailItemProps as D, type TransactionStatusBadgeProps as E, TransactionsHistory as F, type TransactionsHistoryCustomization as G, HashLink as H, type TransactionsHistoryLoaderProps as I, type JsonBlockProps as J, type TransactionsHistoryProps as K, TransactionsInfoModal as L, type MetadataRowProps as M, type NovaTransactionsLabels as N, type TransactionsInfoModalCustomization as O, type TransactionsInfoModalProps as P, TxErrorBlock as Q, type TxErrorBlockClassNames as R, StatusAwareText as S, ToastTransaction as T, type TxErrorBlockProps as U, TxInfoBlock as V, type TxInfoBlockCustomization as W, type TxInfoBlockProps as X, TxProgressIndicator as Y, type TxProgressIndicatorProps as Z, TxStatusVisual as _, type HashLinkProps as a, type TxStatusVisualProps as a0, NovaTransactionsProvider as a1, type NovaTransactionsProviderProps as a2, type StatusAwareTextProps as b, type StepClassNames as c, type StepProps as d, type StepStatus as e, type ToastTransactionCustomization as f, type ToastTransactionProps as g, ToastValidationError as h, type ToastValidationErrorClassNames as i, type ToastValidationErrorCopyContentProps as j, type ToastValidationErrorCustomization as k, type ToastValidationErrorFieldProps as l, type ToastValidationErrorIconProps as m, type ToastValidationErrorMessageProps as n, type ToastValidationErrorProps as o, type ToastValidationErrorTitleProps as p, TrackingTxModal as q, type TrackingTxModalCustomization as r, type TrackingTxModalProps as s, TransactionDetails as t, type TransactionDetailsCustomization as u, type TransactionDetailsProps as v, TransactionHistoryItem as w, type TransactionHistoryItemCustomization as x, type TransactionHistoryItemProps as y, TransactionKey as z };
+export { type TxErrorBlockProps as $, type TransactionHistoryItemCustomization as A, type TransactionHistoryItemIconProps as B, type CopyableFieldProps as C, type DetailItemProps as D, type TransactionHistoryItemProps as E, type TransactionHistoryItemTimestampProps as F, TransactionKey as G, HashLink as H, type TransactionKeyProps as I, type JsonBlockProps as J, TransactionStatusBadge as K, type TransactionStatusBadgeProps as L, type MetadataRowProps as M, type NovaTransactionsLabels as N, TransactionsHistory as O, type TransactionsHistoryCustomization as P, type TransactionsHistoryLoaderProps as Q, type TransactionsHistoryPlaceholderProps as R, StatusAwareText as S, ToastTransaction as T, type TransactionsHistoryProps as U, TransactionsInfoModal as V, type TransactionsInfoModalCustomization as W, type TransactionsInfoModalHeaderProps as X, type TransactionsInfoModalProps as Y, TxErrorBlock as Z, type TxErrorBlockClassNames as _, type HashLinkProps as a, TxInfoBlock as a0, type TxInfoBlockCustomization as a1, type TxInfoBlockInfoRowClassNames as a2, type TxInfoBlockInfoRowProps as a3, type TxInfoBlockProps as a4, TxProgressIndicator as a5, type TxProgressIndicatorProps as a6, TxStatusVisual as a7, type TxStatusVisualClassNames as a8, type TxStatusVisualProps as a9, type TxStatusVisualStatusKey as aa, NovaTransactionsProvider as ab, type NovaTransactionsProviderProps as ac, type StatusAwareTextProps as b, type StepClassNames as c, type StepProps as d, type StepStatus as e, type ToastTransactionActionButtonProps as f, type ToastTransactionCustomization as g, type ToastTransactionProps as h, ToastValidationError as i, type ToastValidationErrorClassNames as j, type ToastValidationErrorCopyContentProps as k, type ToastValidationErrorCustomization as l, type ToastValidationErrorFieldProps as m, type ToastValidationErrorIconProps as n, type ToastValidationErrorMessageProps as o, type ToastValidationErrorProps as p, type ToastValidationErrorTitleProps as q, TrackingTxModal as r, type TrackingTxModalCustomization as s, type TrackingTxModalFooterProps as t, type TrackingTxModalHeaderProps as u, type TrackingTxModalProps as v, TransactionDetails as w, type TransactionDetailsCustomization as x, type TransactionDetailsProps as y, TransactionHistoryItem as z };