@agg-build/hooks 1.0.0

package/dist/deposit.d.mts

@@ -0,0 +1,184 @@
+export { U as UseDepositAddressesOptions, a as UseSyncBalancesOptions, u as useDepositAddresses, b as useSyncBalances } from './use-sync-balances-D1Jdkck9.mjs';
+import '@tanstack/react-query';
+import '@agg-build/sdk';
+
+type SupportedChain = {
+    chainId: number;
+    name: string;
+    tokens: Array<{
+        symbol: string;
+        address: string;
+        decimals: number;
+    }>;
+};
+declare function normalizeWalletError(error: unknown, supportedChains: SupportedChain[] | undefined): {
+    message: string;
+    tone: "warning" | "error";
+};
+
+interface UseWalletTokenBalanceParams {
+    isOpen?: boolean;
+    chainId: number | undefined;
+    tokenAddress: string | undefined;
+    decimals: number | undefined;
+    /**
+     * Explicit Solana wallet address (base58) fallback — used when the
+     * wallet-adapter and Phantom injected provider haven't hydrated yet.
+     */
+    svmAddress?: string;
+}
+interface UseWalletTokenBalanceResult {
+    balance: number;
+    isLoading: boolean;
+}
+/**
+ * Reads the connected wallet's on-chain balance for a given token on a given chain.
+ * Dispatches to wagmi (EVM) or @solana/web3.js (SVM) based on chainId.
+ */
+declare function useWalletTokenBalance({ isOpen, chainId, tokenAddress, decimals, svmAddress, }: UseWalletTokenBalanceParams): UseWalletTokenBalanceResult;
+
+interface UseWalletSendTokenParams {
+    chainId: number;
+    token: {
+        symbol: string;
+        address?: string;
+        decimals: number;
+    };
+    to: string;
+    amount: string;
+}
+/**
+ * Dual-chain sendToken implementation:
+ * - EVM: uses wagmi writeContract to call ERC-20 transfer
+ * - SVM: uses wallet-adapter (or injected Phantom) to submit an SPL TransferChecked tx
+ *
+ * Matches the `WalletActions.sendToken` signature so it can be passed into
+ * `AggProvider` config directly, or composed inside `useDepositFlow`.
+ */
+declare function useWalletSendToken(): (params: UseWalletSendTokenParams) => Promise<{
+    txId: string;
+}>;
+
+type WalletTransactionStatus = "submitted" | "confirming" | "settled" | "error";
+interface UseWalletTransactionStatusParams {
+    chainId: number | undefined;
+    txId: string | null;
+}
+interface UseWalletTransactionStatusResult {
+    status: WalletTransactionStatus | null;
+    gasFee: string;
+}
+declare function useWalletTransactionStatus({ chainId, txId, }: UseWalletTransactionStatusParams): UseWalletTransactionStatusResult;
+
+type CardProviderOption = {
+    id: string;
+    name: string;
+    quote: string;
+    fee: string;
+    badge?: "best" | "low-kyc";
+};
+type CardPurchaseSummary = {
+    amountReceived: string;
+    network: string;
+    fees: string;
+};
+type WalletDepositConfirmParams = {
+    address: string;
+    amount: string;
+    chainId: number;
+    token: string;
+};
+type DepositSelectOption = {
+    value: string;
+    label: string;
+};
+/**
+ * Subset of `DepositModalProps` populated by {@link useDepositFlow}. Callers
+ * spread this onto `<DepositModal>`; any prop the caller passes explicitly
+ * overrides the orchestrator. Typed loosely here so `@agg-build/hooks`
+ * doesn't take a build-time dependency on `@agg-build/ui`.
+ */
+interface UseDepositFlowResult {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    pendingCardPurchaseSummary: CardPurchaseSummary | null;
+    walletFlow: {
+        balance: number;
+        walletLabel: string;
+        walletBalance: number;
+        isWalletBalanceLoading: boolean;
+        amount: string;
+        formErrorMessage?: string;
+        formErrorTone: "warning" | "error";
+        transactionStatus: WalletTransactionStatus | undefined;
+        transactionErrorMessage?: string;
+        successSummary: {
+            fromWallet: string;
+            gasFee: string;
+        };
+    };
+    onWalletAmountChange: (amount: string) => void;
+    onWalletMax: () => void;
+    onConfirmWalletDeposit: (params: WalletDepositConfirmParams) => Promise<void>;
+    onWalletNetworkChange: (chainId: string) => void;
+    onWalletTokenChange: (tokenSymbol: string) => void;
+    initialWalletChainId: string | undefined;
+    /** External wallet kind, when only one is connected. Lets the modal filter
+     * wallet-flow network options to chains compatible with that wallet.
+     * `undefined` when neither or both are connected — modal shows all chains. */
+    connectedWalletKind?: "evm" | "solana";
+    sendCryptoConfig: {
+        minDeposit: string;
+        feeEstimate: string;
+        eta: string;
+    };
+    onDoneSendCrypto: () => void;
+    cardFlow: {
+        amount: string;
+        currency: string;
+        tokenOptions: DepositSelectOption[];
+        selectedToken: string;
+        selectedNetwork: string;
+        providers: CardProviderOption[];
+        purchaseSummary: CardPurchaseSummary;
+        minAmount: number;
+    };
+    onCardAmountChange: (amount: string) => void;
+    onCardNetworkChange: (network: string) => void;
+    onDoneCardPurchase: () => void;
+    cardRedirectUrl: string | undefined;
+    onGetCardQuotes: (params: {
+        sourceAmount: string;
+        sourceCurrencyCode: string;
+        destinationCurrencyCode: string;
+    }) => Promise<CardProviderOption[]>;
+    onCreateCardSession: (params: {
+        serviceProvider: string;
+        sourceAmount: string;
+        sourceCurrencyCode: string;
+        destinationCurrencyCode: string;
+        walletAddress: string;
+        redirectUrl?: string;
+    }) => Promise<{
+        id: string;
+        widgetUrl: string;
+        serviceProviderWidgetUrl: string;
+    }>;
+}
+interface UseDepositFlowOptions {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+}
+/**
+ * Orchestrator hook that encapsulates all wallet + card deposit state and
+ * glue previously hand-wired inside partner apps. Spread the return value
+ * onto `<DepositModal>` to get the full plug-and-play deposit experience.
+ *
+ * Requires wagmi + @solana/wallet-adapter-react providers in the React tree.
+ */
+declare function useDepositFlow(options: UseDepositFlowOptions): UseDepositFlowResult;
+
+declare const DEFAULT_SOLANA_RPC_ENDPOINT = "https://solana-rpc.publicnode.com";
+declare const SVM_CHAIN_IDS: ReadonlySet<number>;
+
+export { DEFAULT_SOLANA_RPC_ENDPOINT, SVM_CHAIN_IDS, type UseDepositFlowOptions, type UseDepositFlowResult, type UseWalletSendTokenParams, type UseWalletTokenBalanceParams, type UseWalletTokenBalanceResult, type UseWalletTransactionStatusParams, type UseWalletTransactionStatusResult, type WalletTransactionStatus, normalizeWalletError, useDepositFlow, useWalletSendToken, useWalletTokenBalance, useWalletTransactionStatus };

package/dist/deposit.d.ts

@@ -0,0 +1,184 @@
+export { U as UseDepositAddressesOptions, a as UseSyncBalancesOptions, u as useDepositAddresses, b as useSyncBalances } from './use-sync-balances-D1Jdkck9.js';
+import '@tanstack/react-query';
+import '@agg-build/sdk';
+
+type SupportedChain = {
+    chainId: number;
+    name: string;
+    tokens: Array<{
+        symbol: string;
+        address: string;
+        decimals: number;
+    }>;
+};
+declare function normalizeWalletError(error: unknown, supportedChains: SupportedChain[] | undefined): {
+    message: string;
+    tone: "warning" | "error";
+};
+
+interface UseWalletTokenBalanceParams {
+    isOpen?: boolean;
+    chainId: number | undefined;
+    tokenAddress: string | undefined;
+    decimals: number | undefined;
+    /**
+     * Explicit Solana wallet address (base58) fallback — used when the
+     * wallet-adapter and Phantom injected provider haven't hydrated yet.
+     */
+    svmAddress?: string;
+}
+interface UseWalletTokenBalanceResult {
+    balance: number;
+    isLoading: boolean;
+}
+/**
+ * Reads the connected wallet's on-chain balance for a given token on a given chain.
+ * Dispatches to wagmi (EVM) or @solana/web3.js (SVM) based on chainId.
+ */
+declare function useWalletTokenBalance({ isOpen, chainId, tokenAddress, decimals, svmAddress, }: UseWalletTokenBalanceParams): UseWalletTokenBalanceResult;
+
+interface UseWalletSendTokenParams {
+    chainId: number;
+    token: {
+        symbol: string;
+        address?: string;
+        decimals: number;
+    };
+    to: string;
+    amount: string;
+}
+/**
+ * Dual-chain sendToken implementation:
+ * - EVM: uses wagmi writeContract to call ERC-20 transfer
+ * - SVM: uses wallet-adapter (or injected Phantom) to submit an SPL TransferChecked tx
+ *
+ * Matches the `WalletActions.sendToken` signature so it can be passed into
+ * `AggProvider` config directly, or composed inside `useDepositFlow`.
+ */
+declare function useWalletSendToken(): (params: UseWalletSendTokenParams) => Promise<{
+    txId: string;
+}>;
+
+type WalletTransactionStatus = "submitted" | "confirming" | "settled" | "error";
+interface UseWalletTransactionStatusParams {
+    chainId: number | undefined;
+    txId: string | null;
+}
+interface UseWalletTransactionStatusResult {
+    status: WalletTransactionStatus | null;
+    gasFee: string;
+}
+declare function useWalletTransactionStatus({ chainId, txId, }: UseWalletTransactionStatusParams): UseWalletTransactionStatusResult;
+
+type CardProviderOption = {
+    id: string;
+    name: string;
+    quote: string;
+    fee: string;
+    badge?: "best" | "low-kyc";
+};
+type CardPurchaseSummary = {
+    amountReceived: string;
+    network: string;
+    fees: string;
+};
+type WalletDepositConfirmParams = {
+    address: string;
+    amount: string;
+    chainId: number;
+    token: string;
+};
+type DepositSelectOption = {
+    value: string;
+    label: string;
+};
+/**
+ * Subset of `DepositModalProps` populated by {@link useDepositFlow}. Callers
+ * spread this onto `<DepositModal>`; any prop the caller passes explicitly
+ * overrides the orchestrator. Typed loosely here so `@agg-build/hooks`
+ * doesn't take a build-time dependency on `@agg-build/ui`.
+ */
+interface UseDepositFlowResult {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    pendingCardPurchaseSummary: CardPurchaseSummary | null;
+    walletFlow: {
+        balance: number;
+        walletLabel: string;
+        walletBalance: number;
+        isWalletBalanceLoading: boolean;
+        amount: string;
+        formErrorMessage?: string;
+        formErrorTone: "warning" | "error";
+        transactionStatus: WalletTransactionStatus | undefined;
+        transactionErrorMessage?: string;
+        successSummary: {
+            fromWallet: string;
+            gasFee: string;
+        };
+    };
+    onWalletAmountChange: (amount: string) => void;
+    onWalletMax: () => void;
+    onConfirmWalletDeposit: (params: WalletDepositConfirmParams) => Promise<void>;
+    onWalletNetworkChange: (chainId: string) => void;
+    onWalletTokenChange: (tokenSymbol: string) => void;
+    initialWalletChainId: string | undefined;
+    /** External wallet kind, when only one is connected. Lets the modal filter
+     * wallet-flow network options to chains compatible with that wallet.
+     * `undefined` when neither or both are connected — modal shows all chains. */
+    connectedWalletKind?: "evm" | "solana";
+    sendCryptoConfig: {
+        minDeposit: string;
+        feeEstimate: string;
+        eta: string;
+    };
+    onDoneSendCrypto: () => void;
+    cardFlow: {
+        amount: string;
+        currency: string;
+        tokenOptions: DepositSelectOption[];
+        selectedToken: string;
+        selectedNetwork: string;
+        providers: CardProviderOption[];
+        purchaseSummary: CardPurchaseSummary;
+        minAmount: number;
+    };
+    onCardAmountChange: (amount: string) => void;
+    onCardNetworkChange: (network: string) => void;
+    onDoneCardPurchase: () => void;
+    cardRedirectUrl: string | undefined;
+    onGetCardQuotes: (params: {
+        sourceAmount: string;
+        sourceCurrencyCode: string;
+        destinationCurrencyCode: string;
+    }) => Promise<CardProviderOption[]>;
+    onCreateCardSession: (params: {
+        serviceProvider: string;
+        sourceAmount: string;
+        sourceCurrencyCode: string;
+        destinationCurrencyCode: string;
+        walletAddress: string;
+        redirectUrl?: string;
+    }) => Promise<{
+        id: string;
+        widgetUrl: string;
+        serviceProviderWidgetUrl: string;
+    }>;
+}
+interface UseDepositFlowOptions {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+}
+/**
+ * Orchestrator hook that encapsulates all wallet + card deposit state and
+ * glue previously hand-wired inside partner apps. Spread the return value
+ * onto `<DepositModal>` to get the full plug-and-play deposit experience.
+ *
+ * Requires wagmi + @solana/wallet-adapter-react providers in the React tree.
+ */
+declare function useDepositFlow(options: UseDepositFlowOptions): UseDepositFlowResult;
+
+declare const DEFAULT_SOLANA_RPC_ENDPOINT = "https://solana-rpc.publicnode.com";
+declare const SVM_CHAIN_IDS: ReadonlySet<number>;
+
+export { DEFAULT_SOLANA_RPC_ENDPOINT, SVM_CHAIN_IDS, type UseDepositFlowOptions, type UseDepositFlowResult, type UseWalletSendTokenParams, type UseWalletTokenBalanceParams, type UseWalletTokenBalanceResult, type UseWalletTransactionStatusParams, type UseWalletTransactionStatusResult, type WalletTransactionStatus, normalizeWalletError, useDepositFlow, useWalletSendToken, useWalletTokenBalance, useWalletTransactionStatus };