@aori/mega-swap-widget 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,555 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React, { ReactNode } from 'react';
+import * as wagmi from 'wagmi';
+import { useWriteContract } from 'wagmi';
+import * as viem from 'viem';
+import { WalletClient } from 'viem';
+import { Chain } from 'wagmi/chains';
+import * as zustand from 'zustand';
+import * as _tanstack_react_query from '@tanstack/react-query';
+
+interface Asset {
+    symbol: string;
+    address: string;
+    logoURI?: string;
+    name: string;
+    decimals?: number;
+    chainId: SupportedChainId;
+    price?: number;
+    vol24h?: number;
+    change24h?: number;
+    marketCap?: number;
+}
+interface TokenRegistryAsset {
+    symbol: string;
+    address: string;
+    chainId: SupportedChainId;
+    chainKey: string;
+    name: string;
+    decimals: number;
+    price: number;
+    icon: string;
+    marketCap?: number;
+}
+declare const Categories: readonly ["all", "favorites", "popular", "stables", "defi"];
+type TokenSelectCategory = (typeof Categories)[number];
+declare const ReviewOrderSteps: readonly ["chain", "signingOrder", "submittingOrder", "sendingTx", "success", "cancelled", "unwrapping", "wrapping", "wrapSuccess", "trackingTx"];
+type ReviewOrderStep = (typeof ReviewOrderSteps)[number];
+type SupportedChainId = number;
+
+interface EnrichedBalance {
+    address: string;
+    chainId: number;
+    balance: string;
+    formatted: string;
+    decimals: number;
+    lastUpdated: number;
+    assetInfo: Asset | null;
+}
+
+interface WidgetTheme {
+    background: string;
+    foreground: string;
+    card: string;
+    'card-foreground': string;
+    popover: string;
+    'popover-foreground': string;
+    primary: string;
+    'primary-foreground': string;
+    secondary: string;
+    'secondary-foreground': string;
+    muted: string;
+    'muted-foreground': string;
+    accent: string;
+    'accent-foreground': string;
+    destructive: string;
+    'destructive-foreground': string;
+    border: string;
+    input: string;
+    ring: string;
+    radius: string;
+    'border-style'?: string;
+    'font-sans'?: string;
+    'font-mono'?: string;
+    'shadow-color'?: string;
+    'shadow-opacity'?: string;
+    'shadow-blur'?: string;
+    'shadow-spread'?: string;
+    'shadow-offset-x'?: string;
+    'shadow-offset-y'?: string;
+    'letter-spacing'?: string;
+    'status-pending'?: string;
+    'status-received'?: string;
+    'status-completed'?: string;
+    'status-failed'?: string;
+}
+declare const defaultLightTheme: WidgetTheme;
+declare const defaultDarkTheme: WidgetTheme;
+declare function themeToCSS(theme: WidgetTheme): Record<string, string>;
+
+interface AoriSwapWidgetConfig {
+    apiKey?: string;
+    vtApiBaseUrl?: string;
+    walletConnectProjectId?: string;
+    rpcOverrides?: Partial<Record<number, string | string[]>>;
+    theme: {
+        mode: 'light' | 'dark';
+        light?: WidgetTheme;
+        dark?: WidgetTheme;
+    };
+    tokens?: {
+        defaultBase?: {
+            chainId: number;
+            address: string;
+        };
+        defaultQuote?: {
+            chainId: number;
+            address: string;
+        };
+        lockBase?: boolean;
+        lockQuote?: boolean;
+        enabledChains?: number[];
+        disableInverting?: boolean;
+        supportedInputTokens?: Array<{
+            chainId: number;
+            address: string;
+        }>;
+        supportedOutputTokens?: Array<{
+            chainId: number;
+            address: string;
+        }>;
+        supportedInputChains?: number[];
+        supportedOutputChains?: number[];
+        inputSelectionSearch?: boolean;
+        outputSelectionSearch?: boolean;
+        showInputSelectionTokenBalances?: boolean;
+        showOutputSelectionTokenBalances?: boolean;
+    };
+    appearance?: {
+        widgetType?: 'default' | 'compact' | 'horizontal' | 'split';
+        tokenDisplay?: 'default' | 'pill' | 'ghost';
+        tokenBadgeOrientation?: 'left' | 'right';
+        assetMenuVariant?: 'default' | 'split';
+        amountInputVariant?: 'default' | 'normal';
+        hideAmountInputSymbol?: boolean;
+        swapButtonVariant?: 'default' | 'outline' | 'ghost';
+        swapHeaderVariant?: 'default' | 'none';
+        quoteLoaderVariant?: 'default' | 'expanded' | 'none';
+        fillContainer?: boolean;
+        hideBorder?: boolean;
+        walletButtonEnabled?: boolean;
+    };
+    settings?: {
+        defaultSlippage?: number;
+    };
+    integrator?: {
+        id?: number;
+        feeRecipient?: string;
+        feeAmount?: number;
+    };
+}
+
+interface SwapWidgetProps {
+    config: AoriSwapWidgetConfig;
+    className?: string;
+    onSwapComplete?: (orderHash: string) => void;
+    onBaseTokenChange?: (token: Asset) => void;
+    onQuoteTokenChange?: (token: Asset) => void;
+    onRequestConnect?: () => void;
+    onRequestAccount?: () => void;
+    customWalletUI?: 'builtin' | 'none' | 'provider';
+}
+declare function SwapWidget({ config, className, onSwapComplete, onBaseTokenChange, onQuoteTokenChange, onRequestConnect, onRequestAccount, customWalletUI, }: SwapWidgetProps): react_jsx_runtime.JSX.Element;
+
+declare function ConnectButton(): react_jsx_runtime.JSX.Element;
+
+interface WalletModalContextValue {
+    openConnectModal: () => void;
+    openAccountModal?: () => void;
+}
+declare const useWalletModal: () => WalletModalContextValue;
+
+declare const useTransactionRegistry: () => {
+    registerTransaction: (hash: string, description: string) => void;
+    enabled: boolean;
+};
+
+interface WidgetThemeProviderProps {
+    theme: WidgetTheme;
+    children: ReactNode;
+}
+declare function WidgetThemeProvider({ theme, children }: WidgetThemeProviderProps): react_jsx_runtime.JSX.Element;
+declare function useWidgetTheme(): WidgetTheme;
+
+declare function buildTransports(rpcOverrides?: Partial<Record<number, string | string[]>>): {
+    [k: string]: viem.HttpTransport<undefined, false> | viem.FallbackTransport<wagmi.Transport[]>;
+};
+declare const wagmiChains: [Chain, ...Chain[]];
+
+interface VtOrderStatus {
+    status: string;
+    srcTxHash?: string;
+    dstTxHash?: string;
+    explorerUrl?: string;
+}
+interface PollOrderStatusOptions {
+    onStatusChange?: (status: VtOrderStatus) => void;
+    onComplete?: (status: VtOrderStatus) => void;
+    onError?: (error: Error) => void;
+    interval?: number;
+    timeout?: number;
+    txHash?: string;
+    signal?: AbortSignal;
+}
+declare function pollOrderStatus(quoteId: string, baseUrl: string, options?: PollOrderStatusOptions): Promise<VtOrderStatus>;
+
+declare function useWalletState(): {
+    mounted: boolean;
+    address: `0x${string}` | undefined;
+    isConnected: boolean;
+    isLoading: boolean;
+};
+
+interface VtTypedData {
+    domain: Record<string, unknown>;
+    types: Record<string, unknown>;
+    primaryType: string;
+    message: Record<string, unknown>;
+}
+interface VtUserStep {
+    type: 'TRANSACTION' | 'SIGNATURE';
+    chainKey?: string;
+    chainType?: string;
+    description?: string;
+    signerAddress?: string;
+    transaction?: {
+        encoded?: {
+            chainId?: number;
+            to?: string;
+            data?: string;
+            value?: string;
+            from?: string;
+        };
+    };
+    to?: string;
+    data?: string;
+    value?: string;
+    signature?: {
+        type: string;
+        typedData: VtTypedData;
+    };
+}
+interface VtRouteStep {
+    type: string;
+    srcChainKey?: string;
+}
+interface VtQuote {
+    id: string;
+    srcChainKey: string;
+    dstChainKey: string;
+    srcToken: {
+        address: string;
+        decimals: number;
+        symbol: string;
+        name?: string;
+    };
+    dstToken: {
+        address: string;
+        decimals: number;
+        symbol: string;
+        name?: string;
+    };
+    srcAmount: string;
+    dstAmount: string;
+    srcAmountUsd?: string;
+    dstAmountUsd?: string;
+    feeUsd?: string;
+    feePercent?: string;
+    routeSteps?: VtRouteStep[];
+    userSteps: VtUserStep[];
+    duration?: {
+        estimated?: string;
+    };
+    /** Synthetic timestamp set when we receive the quote */
+    _receivedAt: number;
+}
+type RfqStatus = 'idle' | 'polling' | 'fresh' | 'stale' | 'refreshing';
+type InputState = 'idle' | 'typing' | 'settled';
+interface PollingParams {
+    inputToken: Asset;
+    outputToken: Asset;
+    inputAmount: string;
+    setOutputAmount?: (amount: number | null) => void;
+}
+interface InputChangeParams {
+    amount: number | null;
+    inputToken: Asset;
+    outputToken: Asset;
+    setOutputAmount: (amount: number | null) => void;
+}
+interface RfqContextType {
+    status: RfqStatus;
+    inputState: InputState;
+    rfqQuote: VtQuote | null;
+    error: string | null;
+    liquidityError: boolean;
+    routingError: boolean;
+    sizeCapError: boolean;
+    ensureForParams: (params: PollingParams) => void;
+    stop: () => void;
+    refresh: () => void;
+    clear: () => void;
+    handleInputChange: (params: InputChangeParams) => void;
+}
+interface RfqProviderProps {
+    children: React.ReactNode;
+    recipient?: string | null;
+}
+declare const RfqProvider: React.FC<RfqProviderProps>;
+declare const useRfq: () => RfqContextType;
+
+interface SwapFormProviderProps {
+    children: ReactNode;
+    defaultBaseToken?: {
+        chainId: number;
+        address: string;
+    };
+    defaultQuoteToken?: {
+        chainId: number;
+        address: string;
+    };
+    onBaseTokenChange?: (token: Asset) => void;
+    onQuoteTokenChange?: (token: Asset) => void;
+}
+declare const SwapFormProvider: ({ children, defaultBaseToken, defaultQuoteToken, onBaseTokenChange, onQuoteTokenChange }: SwapFormProviderProps) => react_jsx_runtime.JSX.Element;
+declare const useSwapFormContext: () => {
+    baseToken: Asset | null;
+    baseAmount: number | null;
+    quoteToken: Asset | null;
+    quoteAmount: number | null;
+    isBaseGasToken: boolean;
+    isQuoteGasToken: boolean;
+    isWrappingPair: boolean;
+    isUnwrappingPair: boolean;
+    baseBalance: {
+        raw: string;
+        formatted: string;
+    };
+    quoteBalance: {
+        raw: string;
+        formatted: string;
+    };
+    baseAmountRaw: string | null;
+    quoteAmountRaw: string | null;
+    isBaseBalanceLoading: boolean;
+    isQuoteBalanceLoading: boolean;
+    isRegistryLoading: boolean;
+    setBaseToken: (asset: Asset) => Promise<void>;
+    setQuoteToken: (asset: Asset) => Promise<void>;
+    setBaseAmount: (value: number | null) => void;
+    setQuoteAmount: (value: number | null) => void;
+    swapTokens: () => void;
+    clearForm: () => void;
+};
+
+type ToastStatus = 'pending' | 'received' | 'completed' | 'failed' | 'cancelled';
+type WidgetView = 'swap' | 'wallet' | 'baseSelection' | 'quoteSelection' | 'baseChainSelection' | 'quoteChainSelection';
+type TransitionType = 'navigation' | 'tokenSelection' | 'chainSelection';
+interface WidgetSwapUIState {
+    view: WidgetView;
+    isTransitioning: boolean;
+    transitionType: TransitionType;
+    selectedChainFilter: {
+        chainId: SupportedChainId;
+        side: 'base' | 'quote';
+    } | null;
+    hoveredChainName: string | null;
+    isRecipientInputOpen: boolean;
+    recipient: string | null;
+    baseAmount: number | null;
+    quoteAmount: number | null;
+    hasAllowanceError: boolean;
+    isTrackingTx: boolean;
+    trackingOrderHash: string | null;
+    txStatus: ToastStatus;
+    walletTab: 'wallet' | 'activity';
+    assetSelectionSearch: string;
+    assetSelectionChain: SupportedChainId | 'all';
+    assetSelectionCategory: TokenSelectCategory;
+    assetSelectionAddressInput: string;
+    recentChainIds: SupportedChainId[];
+    setView: (view: WidgetView) => void;
+    setWalletTab: (tab: 'wallet' | 'activity') => void;
+    setIsTransitioning: (isTransitioning: boolean) => void;
+    transitionToView: (view: WidgetView, type?: TransitionType) => void;
+    setChainFilter: (filter: {
+        chainId: SupportedChainId;
+        side: 'base' | 'quote';
+    } | null) => void;
+    setHoveredChainName: (name: string | null) => void;
+    toggleRecipientInput: () => void;
+    setRecipient: (recipient: string | null) => void;
+    setHasAllowanceError: (hasError: boolean) => void;
+    setBaseAmount: (amount: number | null) => void;
+    setQuoteAmount: (amount: number | null) => void;
+    clearAmounts: () => void;
+    setIsTrackingTx: (isTracking: boolean) => void;
+    setTrackingOrderHash: (orderHash: string | null) => void;
+    setTxStatus: (status: ToastStatus) => void;
+    startTracking: (orderHash: string) => void;
+    stopTracking: () => void;
+    setAssetSelectionSearch: (query: string) => void;
+    setAssetSelectionChain: (chain: SupportedChainId | 'all') => void;
+    setAssetSelectionCategory: (category: TokenSelectCategory) => void;
+    setAssetSelectionAddressInput: (input: string) => void;
+    pushRecentChain: (chainId: SupportedChainId) => void;
+    resetAssetSelection: () => void;
+    resetUI: () => void;
+}
+declare const useWidgetSwapUIStore: zustand.UseBoundStore<zustand.StoreApi<WidgetSwapUIState>>;
+
+interface TokenSelectionState {
+    baseToken: Asset | null;
+    quoteToken: Asset | null;
+    setBaseTokenDirect: (token: Asset | null) => void;
+    setQuoteTokenDirect: (token: Asset | null) => void;
+    swapTokensDirect: () => void;
+}
+declare const useTokenSelectionStore: zustand.UseBoundStore<zustand.StoreApi<TokenSelectionState>>;
+interface UseTokenSelectionOptions {
+    defaultBaseToken?: {
+        chainId: number;
+        address: string;
+    };
+    defaultQuoteToken?: {
+        chainId: number;
+        address: string;
+    };
+}
+declare function useTokenSelection(options?: UseTokenSelectionOptions): {
+    baseToken: Asset | null;
+    quoteToken: Asset | null;
+    setBaseToken: (token: Asset | null) => void;
+    setQuoteToken: (token: Asset | null) => void;
+    swapTokens: () => void;
+    isLoading: boolean;
+};
+
+declare const useSwapForm: (defaultBaseToken?: {
+    chainId: number;
+    address: string;
+}, defaultQuoteToken?: {
+    chainId: number;
+    address: string;
+}, onBaseTokenChange?: (token: Asset) => void, onQuoteTokenChange?: (token: Asset) => void) => {
+    baseToken: Asset | null;
+    baseAmount: number | null;
+    quoteToken: Asset | null;
+    quoteAmount: number | null;
+    isBaseGasToken: boolean;
+    isQuoteGasToken: boolean;
+    isWrappingPair: boolean;
+    isUnwrappingPair: boolean;
+    baseBalance: {
+        raw: string;
+        formatted: string;
+    };
+    quoteBalance: {
+        raw: string;
+        formatted: string;
+    };
+    baseAmountRaw: string | null;
+    quoteAmountRaw: string | null;
+    isBaseBalanceLoading: boolean;
+    isQuoteBalanceLoading: boolean;
+    isRegistryLoading: boolean;
+    setBaseToken: (asset: Asset) => Promise<void>;
+    setQuoteToken: (asset: Asset) => Promise<void>;
+    setBaseAmount: (value: number | null) => void;
+    setQuoteAmount: (value: number | null) => void;
+    swapTokens: () => void;
+    clearForm: () => void;
+};
+
+interface OrderMetadata {
+    baseToken?: Asset;
+    quoteToken?: Asset;
+}
+declare const useOrderStatusPolling: (onStatusUpdate?: (quoteId: string, status: ToastStatus) => void) => {
+    startPolling: (quoteId: string, metadata?: OrderMetadata) => void;
+    stopPolling: (quoteId: string) => void;
+    stopAllPolling: () => void;
+    isPolling: (quoteId: string) => boolean;
+};
+
+interface BalanceUpdateEvent {
+    type: 'swap' | 'wrap' | 'unwrap';
+    tokens: Array<{
+        asset: Asset;
+        userAddress: string;
+    }>;
+}
+declare const useBalanceEventListener: () => {
+    triggerBalanceUpdate: (event: BalanceUpdateEvent) => void;
+};
+declare const useEmitBalanceEvent: () => (event: BalanceUpdateEvent) => void;
+declare const useBalanceEventSubscription: () => void;
+
+declare const useTokensForChain: (chainId: number) => {
+    tokens: Asset[];
+    isLoading: boolean;
+    error: Error | null;
+};
+declare const useIsTokenSupported: (address: string, chainId: number) => boolean;
+declare const useTokenByAddress: (address: string, chainId: number) => Asset | undefined;
+
+type SwapWalletClient = WalletClient & {
+    switchChain?: (args: {
+        id: number;
+    }) => Promise<void>;
+    send?: (method: string, params: unknown[]) => Promise<unknown>;
+    getChainId?: () => number | Promise<number>;
+};
+declare const ChainSwitch: (walletClient: SwapWalletClient, requiredChainId: number) => Promise<boolean>;
+interface ISignSwapParams {
+    quote: VtQuote;
+    signatureStep: VtUserStep;
+    userAddress: string;
+    walletClient: SwapWalletClient;
+}
+declare const SignSwap: (params: ISignSwapParams) => Promise<{
+    quoteId: string;
+    signature: string;
+}>;
+
+declare const isQuoteFresh: (createdAt: string | number) => boolean;
+declare const canSubmitOrder: (quoteId: string, createdAt: string | number) => {
+    canSubmit: boolean;
+    reason?: string;
+};
+declare const markOrderAsSubmitted: (quoteId: string, createdAt: string | number) => void;
+declare const cleanupOldSubmissions: () => void;
+
+interface WrapTokenParams {
+    chainId: SupportedChainId;
+    accountAddress: `0x${string}`;
+    amountRaw: bigint;
+    writeContractAsync: ReturnType<typeof useWriteContract>['writeContractAsync'];
+}
+declare function useWrapToken(): _tanstack_react_query.UseMutationResult<{
+    success: boolean;
+    hash: `0x${string}`;
+}, Error, WrapTokenParams, unknown>;
+
+interface UnwrapTokenParams {
+    chainId: SupportedChainId;
+    accountAddress: `0x${string}`;
+    amountRaw: bigint;
+    writeContractAsync: ReturnType<typeof useWriteContract>['writeContractAsync'];
+}
+declare function useUnwrapToken(): _tanstack_react_query.UseMutationResult<{
+    success: boolean;
+    hash: `0x${string}`;
+}, Error, UnwrapTokenParams, unknown>;
+
+export { type AoriSwapWidgetConfig, type Asset, ChainSwitch, ConnectButton, type EnrichedBalance, type PollOrderStatusOptions, type ReviewOrderStep, RfqProvider, SignSwap, type SupportedChainId, SwapFormProvider, SwapWidget, type SwapWidgetProps, type ToastStatus, type TokenRegistryAsset, type TransitionType, type WidgetTheme, WidgetThemeProvider, type WidgetView, buildTransports, canSubmitOrder, cleanupOldSubmissions, defaultDarkTheme, defaultLightTheme, isQuoteFresh, markOrderAsSubmitted, pollOrderStatus, themeToCSS, useBalanceEventListener, useBalanceEventSubscription, useEmitBalanceEvent, useIsTokenSupported, useOrderStatusPolling, useRfq, useSwapForm, useSwapFormContext, useTokenByAddress, useTokenSelection, useTokenSelectionStore, useTokensForChain, useTransactionRegistry, useUnwrapToken, useWalletModal, useWalletState, useWidgetSwapUIStore, useWidgetTheme, useWrapToken, wagmiChains };