@gearbox-protocol/ui-kit 3.14.0-next.6 → 3.14.0-next.60

package/dist/types/components/composites/tx-preview/confirm/dialog/constants.d.ts

@@ -0,0 +1,17 @@
+export declare class TransactionConfirmDialogTest {
+    static root: string;
+    static execution: string;
+    static progress: string;
+    static result: string;
+}
+/** Outer dialog card: mobile-first full width, fixed 560px from md up. */
+export declare const transactionConfirmDialogShellVariants: (props?: import('class-variance-authority/types').ClassProp | undefined) => string;
+/**
+ * Modal confirm: use available viewport height; inner preview scrolls only when
+ * content overflows (see `transactionConfirmPreviewScrollVariants`).
+ */
+export declare const transactionConfirmModalContainerVariants: (props?: import('class-variance-authority/types').ClassProp | undefined) => string;
+/** Scrollable preview column inside confirm / execute body. */
+export declare const transactionConfirmPreviewScrollVariants: (props?: import('class-variance-authority/types').ClassProp | undefined) => string;
+/** Inner shell content: fill the padded dialog container without re-applying width. */
+export declare const transactionConfirmShellContentVariants: (props?: import('class-variance-authority/types').ClassProp | undefined) => string;

package/dist/types/components/composites/tx-preview/confirm/dialog/index.d.ts

@@ -0,0 +1,8 @@
+export * from './computeTransactionConfirmDialogLayout';
+export * from './constants';
+export * from './TransactionConfirmDialogView';
+export * from './TransactionConfirmPageView';
+export * from './TransactionConfirmShell';
+export * from './TransactionConfirmShell.constants';
+export * from './transactionConfirmPhase';
+export * from './useTransactionConfirmDialog';

package/dist/types/components/composites/tx-preview/confirm/dialog/transactionConfirmPhase.d.ts

@@ -0,0 +1,4 @@
+export type TransactionConfirmPhase = "confirm" | "awaiting_receipt" | "success" | "failure";
+export interface TransactionConfirmSubmittedTx {
+    readonly hash: `0x${string}`;
+}

package/dist/types/components/composites/tx-preview/confirm/dialog/useTransactionConfirmDialog.d.ts

@@ -0,0 +1,8 @@
+export interface UseTransactionConfirmDialogReturn {
+    open: boolean;
+    openDialog: () => void;
+    closeDialog: () => void;
+    refreshNonce: number;
+    bumpRefreshNonce: () => void;
+}
+export declare function useTransactionConfirmDialog(): UseTransactionConfirmDialogReturn;

package/dist/types/components/composites/tx-preview/confirm/execution/TransactionConfirmExecuteButton.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+import { ButtonProps } from '../../../../buttons/button/button';
+export interface TransactionConfirmExecuteButtonProps extends ButtonProps {
+    readonly isLoading?: boolean;
+}
+export declare function TransactionConfirmExecuteButton({ isLoading, disabled, children, width, size, ...rest }: TransactionConfirmExecuteButtonProps): React.ReactElement;

package/dist/types/components/composites/tx-preview/confirm/execution/index.d.ts

@@ -0,0 +1 @@
+export * from './TransactionConfirmExecuteButton';

package/dist/types/components/composites/tx-preview/confirm/index.d.ts

@@ -0,0 +1,7 @@
+export * from './amounts';
+export * from './dialog';
+export * from './execution';
+export * from './preview';
+export * from './result';
+export * from './stepper';
+export * from './summary';

package/dist/types/components/composites/tx-preview/confirm/preview/OperationPreviewContent.d.ts

@@ -0,0 +1,12 @@
+import { Operation, PoolSimulationResult } from '@gearbox-protocol/sdk/preview';
+import { default as React } from 'react';
+import { Address } from 'viem';
+import { GearboxSDKLike } from '../../types';
+export interface OperationPreviewContentProps {
+    sdk: GearboxSDKLike;
+    operation: Operation;
+    simulation: PoolSimulationResult | undefined;
+    isSimulating: boolean;
+    wallet: Address;
+}
+export declare function OperationPreviewContent({ sdk, operation, simulation, isSimulating, wallet, }: OperationPreviewContentProps): React.ReactElement;

package/dist/types/components/composites/tx-preview/confirm/preview/index.d.ts

@@ -0,0 +1 @@
+export * from './OperationPreviewContent';

package/dist/types/components/composites/tx-preview/confirm/result/TransactionConfirmFailureResult.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+export interface TransactionConfirmFailureResultProps {
+    readonly title: React.ReactNode;
+    readonly description: React.ReactNode;
+    readonly footerAction?: React.ReactNode;
+    readonly iconSize?: number;
+}
+export declare function TransactionConfirmFailureResult({ title, description, footerAction, iconSize, }: TransactionConfirmFailureResultProps): React.ReactElement;

package/dist/types/components/composites/tx-preview/confirm/result/TransactionConfirmSuccessIcon.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare function TransactionConfirmSuccessIcon(): React.ReactElement;

package/dist/types/components/composites/tx-preview/confirm/result/TransactionConfirmSuccessResult.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+export interface TransactionConfirmSuccessResultProps {
+    readonly headline: React.ReactNode;
+    readonly subtitle: React.ReactNode;
+    readonly txHashRow?: React.ReactNode;
+    readonly footerAction?: React.ReactNode;
+}
+export declare function TransactionConfirmSuccessResult({ headline, subtitle, txHashRow, footerAction, }: TransactionConfirmSuccessResultProps): React.ReactElement;

package/dist/types/components/composites/tx-preview/confirm/result/TransactionConfirmTxHashRow.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+export interface TransactionConfirmTxHashRowProps {
+    readonly txHashLink: React.ReactNode;
+    readonly addToWalletLink?: React.ReactNode;
+}
+export declare function TransactionConfirmTxHashRow({ txHashLink, addToWalletLink, }: TransactionConfirmTxHashRowProps): React.ReactElement;

package/dist/types/components/composites/tx-preview/confirm/result/constants.d.ts

@@ -0,0 +1,18 @@
+export declare class TransactionConfirmSuccessResultTest {
+    static root: string;
+    static headline: string;
+    static subtitle: string;
+    static footer: string;
+}
+export declare class TransactionConfirmFailureResultTest {
+    static root: string;
+    static footer: string;
+}
+export declare class TransactionConfirmTxHashRowTest {
+    static root: string;
+    static txHashLink: string;
+    static addToWallet: string;
+}
+export declare class TransactionConfirmExecuteButtonTest {
+    static root: string;
+}

package/dist/types/components/composites/tx-preview/confirm/result/index.d.ts

@@ -0,0 +1,5 @@
+export * from './constants';
+export * from './TransactionConfirmFailureResult';
+export * from './TransactionConfirmSuccessIcon';
+export * from './TransactionConfirmSuccessResult';
+export * from './TransactionConfirmTxHashRow';

package/dist/types/components/composites/tx-preview/confirm/stepper/ProgressStepper.d.ts

@@ -0,0 +1,29 @@
+import { default as React } from 'react';
+import { StepStatus } from './transactionExecutionStepTypes';
+export interface ProgressStepperStep {
+    /** Stable identity used as the React key. */
+    readonly id: string;
+    readonly label: React.ReactNode;
+    readonly status: StepStatus;
+    /**
+     * Marker centered on the connector that precedes this step — e.g. a delay
+     * clock shown between "Request" and "Withdraw". Ignored on the first step.
+     */
+    readonly connectorMarker?: React.ReactNode;
+    /** Render the connector that precedes this step as dashed. */
+    readonly connectorDashed?: boolean;
+}
+export interface ProgressStepperProps {
+    readonly steps: ReadonlyArray<ProgressStepperStep>;
+    readonly className?: string;
+}
+/**
+ * Generic progress stepper: a row of dots + labels joined by connectors.
+ *
+ * Layout mirrors {@link TransactionProgressStepper} exactly — each connector is
+ * two half-lines living in the same row as the dot, so the lines butt directly
+ * against the 9px dots. On top of that it supports an optional per-connector
+ * `marker` (centered on the connector midpoint, e.g. a waiting clock) and a
+ * `dashed` connector style, which `TransactionProgressStepper` does not.
+ */
+export declare function ProgressStepper({ steps, className, }: ProgressStepperProps): React.ReactElement;

package/dist/types/components/composites/tx-preview/confirm/stepper/TransactionProgressStepper.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { TransactionExecutionStepView } from './transactionExecutionStepTypes';
+export interface TransactionProgressStepperProps {
+    readonly steps: ReadonlyArray<TransactionExecutionStepView>;
+    readonly renderLabel: (step: TransactionExecutionStepView) => React.ReactNode;
+}
+export declare function TransactionProgressStepper({ steps, renderLabel, }: TransactionProgressStepperProps): React.ReactElement;

package/dist/types/components/composites/tx-preview/confirm/stepper/constants.d.ts

@@ -0,0 +1,6 @@
+export declare class TransactionProgressStepperTest {
+    static root: string;
+}
+export declare class ProgressStepperTest {
+    static root: string;
+}

package/dist/types/components/composites/tx-preview/confirm/stepper/index.d.ts

@@ -0,0 +1,4 @@
+export * from './constants';
+export * from './ProgressStepper';
+export * from './TransactionProgressStepper';
+export * from './transactionExecutionStepTypes';

package/dist/types/components/composites/tx-preview/confirm/stepper/transactionExecutionStepTypes.d.ts

@@ -0,0 +1,10 @@
+export type TransactionExecutionStepId = "approve" | "auth" | "execute";
+export type TransactionExecutionPrerequisiteStepId = Exclude<TransactionExecutionStepId, "execute">;
+export type StepStatus = "completed" | "active" | "upcoming";
+export type TransactionExecutionStepLabelKey = "approve" | "approveBatch" | "auth" | "execute";
+export interface TransactionExecutionStepView {
+    id: TransactionExecutionStepId;
+    labelKey: TransactionExecutionStepLabelKey;
+    status: StepStatus;
+}
+export declare function shouldShowTransactionProgressStepper(steps: ReadonlyArray<Pick<TransactionExecutionStepView, "id">>): boolean;

package/dist/types/components/composites/tx-preview/confirm/summary/PoolOperationConfirmDetails.d.ts

@@ -0,0 +1,15 @@
+import { default as React } from 'react';
+export interface PoolOperationConfirmDetailsProps {
+    readonly apyLabel?: React.ReactNode;
+    readonly apy?: React.ReactNode;
+    readonly apyLoading?: boolean;
+    readonly poolTvlLabel: React.ReactNode;
+    readonly poolTvl: React.ReactNode;
+    readonly poolUtilizationLabel: React.ReactNode;
+    readonly poolUtilization: React.ReactNode;
+    readonly curatorLabel: React.ReactNode;
+    readonly curatorValue: React.ReactNode;
+    readonly poolLabel: React.ReactNode;
+    readonly poolContractValue: React.ReactNode;
+}
+export declare function PoolOperationConfirmDetails({ apyLabel, apy, apyLoading, poolTvlLabel, poolTvl, poolUtilizationLabel, poolUtilization, curatorLabel, curatorValue, poolLabel, poolContractValue, }: PoolOperationConfirmDetailsProps): React.ReactElement;

package/dist/types/components/composites/tx-preview/confirm/summary/constants.d.ts

@@ -0,0 +1,3 @@
+export declare class PoolOperationConfirmDetailsTest {
+    static root: string;
+}

package/dist/types/components/composites/tx-preview/confirm/summary/index.d.ts

@@ -0,0 +1,2 @@
+export * from './constants';
+export * from './PoolOperationConfirmDetails';

package/dist/types/components/composites/tx-preview/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Transaction preview + confirm flow (WIP).
+ *
+ * Intentionally NOT re-exported from the main `@gearbox-protocol/ui-kit` entry or
+ * `components/composites/index.ts`. The module is still in development; its final
+ * scope, API shape, and completion timeline are not settled yet.
+ *
+ * Consumers should import only via `@gearbox-protocol/ui-kit/tx-preview` (and documented
+ * deep subpaths). Merging into the root ui-kit barrel is a separate decision once
+ * the module is stable.
+ */
+export * from './components';
+export * from './confirm';
+export * from './operations';
+export * from './state-change';
+export * from './types';
+export * from './utils';

package/dist/types/components/composites/tx-preview/operations/OperationBody.d.ts

@@ -0,0 +1,15 @@
+import { Operation } from '@gearbox-protocol/sdk/preview';
+import { Address } from 'viem';
+import { GearboxSDKLike } from '../types';
+export interface OperationBodyProps {
+    sdk: GearboxSDKLike;
+    operation: Operation;
+    /** Wallet whose transfers are highlighted; populated after simulation. */
+    wallet: Address;
+}
+/**
+ * Renders the body of the outer operation (rows only, no card chrome).
+ * Currently handles pool deposit/redeem; credit-facade operations
+ * ({@link OuterFacadeOperation}) are a future branch.
+ */
+export declare function OperationBody({ sdk, operation, wallet }: OperationBodyProps): import("react/jsx-runtime").JSX.Element | null;

package/dist/types/components/composites/tx-preview/operations/OperationsCard.d.ts

@@ -0,0 +1,21 @@
+import { Operation } from '@gearbox-protocol/sdk/preview';
+import { Address } from 'viem';
+import { GearboxSDKLike } from '../types';
+export interface OperationsCardProps {
+    sdk: GearboxSDKLike;
+    transaction: Operation;
+    wallet: Address;
+}
+/**
+ * Whether a dedicated custom operation view exists for the parsed transaction.
+ * Drives both whether {@link OperationsCard} renders and whether the raw
+ * transaction card starts expanded. Currently only pool operations have a view.
+ */
+export declare function hasOperationView(tx: Operation): boolean;
+/**
+ * Collapsible card (open by default) for a decoded transaction. Renders the
+ * outer operation in its content. Pool operations have no inner operations, so
+ * the card body is just the operation rows; credit-facade operations will later
+ * render their {@link InnerOperation}s as nested non-collapsible cards here.
+ */
+export declare function OperationsCard({ sdk, transaction, wallet, }: OperationsCardProps): import("react/jsx-runtime").JSX.Element | null;

package/dist/types/components/composites/tx-preview/operations/PoolDepositView.d.ts

@@ -0,0 +1,11 @@
+import { PoolDepositOperation } from '@gearbox-protocol/sdk/preview';
+import { Address } from 'viem';
+import { GearboxSDKLike } from '../types';
+export interface PoolDepositViewProps {
+    sdk: GearboxSDKLike;
+    operation: PoolDepositOperation;
+    /** Wallet whose transfers are highlighted; populated after simulation. */
+    wallet: Address;
+}
+/** Human-readable body of a Gearbox pool deposit operation (rows only). */
+export declare function PoolDepositView({ sdk, operation, wallet, }: PoolDepositViewProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/composites/tx-preview/operations/PoolRow.d.ts

@@ -0,0 +1,8 @@
+import { Address } from 'viem';
+import { TokenInfo } from '../utils';
+export interface PoolRowProps {
+    pool: TokenInfo;
+    address: Address;
+}
+/** Pool row: shows the pool's human label plus the copyable pool address. */
+export declare function PoolRow({ pool, address }: PoolRowProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/composites/tx-preview/operations/PoolWithdrawView.d.ts

@@ -0,0 +1,11 @@
+import { PoolRedeemOperation } from '@gearbox-protocol/sdk/preview';
+import { Address } from 'viem';
+import { GearboxSDKLike } from '../types';
+export interface PoolWithdrawViewProps {
+    sdk: GearboxSDKLike;
+    operation: PoolRedeemOperation;
+    /** Wallet whose transfers are highlighted; populated after simulation. */
+    wallet: Address;
+}
+/** Human-readable body of a Gearbox pool withdraw (redeem) operation (rows only). */
+export declare function PoolWithdrawView({ sdk, operation, wallet, }: PoolWithdrawViewProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/composites/tx-preview/operations/index.d.ts

@@ -0,0 +1,5 @@
+export * from './OperationBody';
+export * from './OperationsCard';
+export * from './PoolDepositView';
+export * from './PoolRow';
+export * from './PoolWithdrawView';

package/dist/types/components/composites/tx-preview/state-change/BalanceChangeGroup.d.ts

@@ -0,0 +1,11 @@
+import { AddressBalanceChanges } from '@gearbox-protocol/sdk/preview';
+import { AddressLabels } from '../components';
+import { GearboxSDKLike } from '../types';
+export interface BalanceChangeGroupProps {
+    sdk: GearboxSDKLike;
+    group: AddressBalanceChanges;
+    /** Resolved labels for the involved addresses (drives the group divider). */
+    labels: AddressLabels;
+}
+/** One labeled section of balance changes for a single address. */
+export declare function BalanceChangeGroup({ sdk, group, labels, }: BalanceChangeGroupProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/composites/tx-preview/state-change/BalanceChangeRow.d.ts

@@ -0,0 +1,14 @@
+import { TokenBalanceChange } from '@gearbox-protocol/sdk/preview';
+import { GearboxSDKLike } from '../types';
+export interface BalanceChangeRowProps {
+    sdk: GearboxSDKLike;
+    change: TokenBalanceChange;
+}
+/**
+ * One token balance change as three grid cells (the parent group owns the shared
+ * grid template so columns line up across rows): the token (symbol + name,
+ * left-aligned and flexible), the struck-through before value with an arrow to
+ * the after value, and the signed diff in brackets. The whole row is colored
+ * green for a positive delta and red for a negative one.
+ */
+export declare function BalanceChangeRow({ sdk, change }: BalanceChangeRowProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/composites/tx-preview/state-change/PoolStateChangeCard.d.ts

@@ -0,0 +1,18 @@
+import { AddressBalanceChanges, PoolOperation } from '@gearbox-protocol/sdk/preview';
+import { Address } from 'viem';
+import { GearboxSDKLike } from '../types';
+export interface PoolStateChangeCardProps {
+    sdk: GearboxSDKLike;
+    /** The decoded pool deposit/redeem operation. */
+    operation: PoolOperation;
+    /** Balance changes grouped by watched address (from a successful simulation). */
+    balanceChanges: AddressBalanceChanges[];
+    /** Wallet whose balances are highlighted. */
+    wallet: Address;
+}
+/**
+ * Pool-specific state-change content: balance changes grouped by address (wallet
+ * and, when distinct, the recipient). Renders content only; the surrounding card
+ * chrome, loading, and error handling live in {@link StateChangeCard}.
+ */
+export declare function PoolStateChangeCard({ sdk, operation, balanceChanges, wallet, }: PoolStateChangeCardProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/components/composites/tx-preview/state-change/StateChangeCard.d.ts

@@ -0,0 +1,21 @@
+import { Operation, PoolSimulationResult } from '@gearbox-protocol/sdk/preview';
+import { Address } from 'viem';
+import { GearboxSDKLike } from '../types';
+export interface StateChangeCardProps {
+    sdk: GearboxSDKLike;
+    /** Parsed operation that drives which specific state-change card is shown. */
+    data: Operation;
+    /** Stage-2 simulation outcome; `undefined` while it is loading. */
+    simulation: PoolSimulationResult | undefined;
+    /** Whether the simulation is still running. */
+    isLoading: boolean;
+    /** Wallet whose balances/transfers are highlighted. */
+    wallet: Address;
+}
+/**
+ * Parent card for transaction state changes. Owns the common logic (collapsible
+ * card shell, loading skeleton, card-styled error, and no-data handling) and
+ * decides which specific state-change card to render: pool balance changes,
+ * credit account changes (not yet supported), or the decoded revert reason.
+ */
+export declare function StateChangeCard({ sdk, data, simulation, isLoading, wallet, }: StateChangeCardProps): import("react/jsx-runtime").JSX.Element | null;

package/dist/types/components/composites/tx-preview/state-change/index.d.ts

@@ -0,0 +1,4 @@
+export * from './BalanceChangeGroup';
+export * from './BalanceChangeRow';
+export * from './PoolStateChangeCard';
+export * from './StateChangeCard';

package/dist/types/components/composites/tx-preview/types.d.ts

@@ -0,0 +1,19 @@
+import { Address } from 'viem';
+/**
+ * Minimal SDK surface for tx-preview UI + hooks.
+ * Satisfied by verify OnchainSDK and client preview SDK instances.
+ */
+export interface GearboxSDKLike {
+    chainId: number;
+    tokensMeta: {
+        get(address: Address): {
+            symbol?: string;
+            decimals?: number;
+            name?: string;
+        } | undefined;
+    };
+    readonly plugins: {
+        adapters: unknown;
+    };
+    client: unknown;
+}

package/dist/types/components/composites/tx-preview/utils/addressLabels.d.ts

@@ -0,0 +1,16 @@
+import { PoolOperation } from '@gearbox-protocol/sdk/preview';
+import { Address } from 'viem';
+import { AddressLabels } from '../components';
+import { GearboxSDKLike } from '../types';
+/**
+ * Builds the UI label map for a pool deposit/redeem operation.
+ *
+ * "Our" addresses (wallet, receiver, redeem owner) are flagged `ours: true`; the
+ * pool is labeled with its name and flagged `ours: false`. When the receiver /
+ * owner coincides with the wallet, it is labeled "Your wallet".
+ *
+ * Note: the `ours` flag is a UI-only concept and is derived locally here; it is
+ * intentionally decoupled from the simulation watch set in the SDK preview
+ * `simulate` module.
+ */
+export declare function buildPoolOperationLabels(sdk: GearboxSDKLike, op: PoolOperation, wallet: Address): AddressLabels;

package/dist/types/components/composites/tx-preview/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './addressLabels';
+export * from './poolTokenInfo';

package/dist/types/components/composites/tx-preview/utils/poolTokenInfo.d.ts

@@ -0,0 +1,14 @@
+import { Address } from 'viem';
+import { GearboxSDKLike } from '../types';
+export interface TokenInfo {
+    symbol: string;
+    decimals: number;
+    /** Human-readable token/pool name, when available. */
+    name?: string;
+}
+/**
+ * Resolves a token's symbol, decimals and name from `sdk.tokensMeta`, falling
+ * back to a shortened address / 18 decimals when the token is not in the
+ * registry. For pools, the diesel-token meta carries the pool name.
+ */
+export declare function resolveToken(sdk: GearboxSDKLike, address: Address): TokenInfo;

package/dist/types/components/confirm-menu/confirm-menu.d.ts

@@ -2,8 +2,10 @@ import * as React from "react";
 export interface ConfirmMenuProps {
     /** Title text or element shown in the header */
     title: React.ReactNode;
-    /** Callback when the close button is clicked */
-    onClose: () => void;
+    /** Optional badge or addon rendered after the title (e.g. LP pill). */
+    titleAddon?: React.ReactNode;
+    /** Callback when the close button is clicked. Omit to hide the close control. */
+    onClose?: () => void;
     /** Additional CSS class applied to the root element */
     className?: string;
 }