|
| 1 | +/** |
| 2 | + * Fetching and managing pegin request data from smart contracts |
| 3 | + */ |
| 4 | + |
| 5 | +import { useState, useEffect, useCallback } from 'react'; |
| 6 | +import type { Address, Hex } from 'viem'; |
| 7 | +import { BTCVaultsManager } from '../clients/eth-contract'; |
| 8 | +import type { PeginRequest } from '../clients/eth-contract'; |
| 9 | +import { transformPeginToActivity } from '../utils/peginTransformers'; |
| 10 | +import type { VaultActivity } from '../mockData/vaultActivities'; |
| 11 | +import { CONTRACTS } from '../config/contracts'; |
| 12 | + |
| 13 | +/** |
| 14 | + * Result interface for usePeginRequests hook |
| 15 | + */ |
| 16 | +export interface UsePeginRequestsResult { |
| 17 | + /** Array of vault activities transformed from pegin requests */ |
| 18 | + activities: VaultActivity[]; |
| 19 | + /** Loading state - true while fetching data */ |
| 20 | + loading: boolean; |
| 21 | + /** Error state - contains error if fetch failed */ |
| 22 | + error: Error | null; |
| 23 | + /** Function to manually refetch data */ |
| 24 | + refetch: () => Promise<void>; |
| 25 | +} |
| 26 | + |
| 27 | +/** |
| 28 | + * Custom hook to fetch pegin requests for a connected wallet address |
| 29 | + * |
| 30 | + * Workflow: |
| 31 | + * 1. Calls getDepositorPeginRequests(address) to get array of transaction hashes |
| 32 | + * 2. For each hash, calls getPeginRequest(hash) to get detailed pegin data |
| 33 | + * 3. Transforms each PeginRequest to VaultActivity format for UI |
| 34 | + * 4. Returns activities array with loading and error states |
| 35 | + * |
| 36 | + * @param connectedAddress - Ethereum address of connected wallet (undefined if not connected) |
| 37 | + * @param onBorrowClick - Callback function when user clicks borrow action |
| 38 | + * @returns Object containing activities array, loading state, error state, and refetch function |
| 39 | + * |
| 40 | + * @example |
| 41 | + * ```tsx |
| 42 | + * function MyComponent() { |
| 43 | + * const { address } = useETHWallet(); |
| 44 | + * const { activities, loading, error, refetch } = usePeginRequests(address, handleBorrow); |
| 45 | + * |
| 46 | + * if (loading) return <Spinner />; |
| 47 | + * if (error) return <Error message={error.message} onRetry={refetch} />; |
| 48 | + * return <ActivityList activities={activities} />; |
| 49 | + * } |
| 50 | + * ``` |
| 51 | + */ |
| 52 | +export function usePeginRequests( |
| 53 | + connectedAddress: Address | undefined, |
| 54 | + onBorrowClick: (activity: VaultActivity) => void |
| 55 | +): UsePeginRequestsResult { |
| 56 | + const [activities, setActivities] = useState<VaultActivity[]>([]); |
| 57 | + const [loading, setLoading] = useState<boolean>(false); |
| 58 | + const [error, setError] = useState<Error | null>(null); |
| 59 | + |
| 60 | + /** |
| 61 | + * Fetch pegin requests from contract and transform to activities |
| 62 | + */ |
| 63 | + const fetchPeginRequests = useCallback(async () => { |
| 64 | + // Early return if no wallet connected |
| 65 | + if (!connectedAddress) { |
| 66 | + setActivities([]); |
| 67 | + setLoading(false); |
| 68 | + setError(null); |
| 69 | + return; |
| 70 | + } |
| 71 | + |
| 72 | + try { |
| 73 | + setLoading(true); |
| 74 | + setError(null); |
| 75 | + |
| 76 | + // Step 1: Get all transaction hashes for this depositor |
| 77 | + const txHashes: Hex[] = await BTCVaultsManager.getDepositorPeginRequests( |
| 78 | + CONTRACTS.BTC_VAULTS_MANAGER, |
| 79 | + connectedAddress |
| 80 | + ); |
| 81 | + |
| 82 | + // Early return if no vaults found |
| 83 | + if (txHashes.length === 0) { |
| 84 | + setActivities([]); |
| 85 | + setLoading(false); |
| 86 | + return; |
| 87 | + } |
| 88 | + |
| 89 | + // Step 2: Fetch detailed pegin request data for each transaction hash |
| 90 | + // Use Promise.all for parallel fetching to improve performance |
| 91 | + const peginRequests: Array<{ peginRequest: PeginRequest; txHash: Hex }> = await Promise.all( |
| 92 | + txHashes.map(async (txHash) => { |
| 93 | + const peginRequest = await BTCVaultsManager.getPeginRequest( |
| 94 | + CONTRACTS.BTC_VAULTS_MANAGER, |
| 95 | + txHash |
| 96 | + ); |
| 97 | + return { peginRequest, txHash }; |
| 98 | + }) |
| 99 | + ); |
| 100 | + |
| 101 | + // Step 3: Transform pegin requests to vault activities |
| 102 | + const transformedActivities = peginRequests.map(({ peginRequest, txHash }) => |
| 103 | + transformPeginToActivity(peginRequest, txHash, onBorrowClick) |
| 104 | + ); |
| 105 | + |
| 106 | + setActivities(transformedActivities); |
| 107 | + setLoading(false); |
| 108 | + } catch (err) { |
| 109 | + const errorMessage = err instanceof Error ? err : new Error('Failed to fetch pegin requests'); |
| 110 | + setError(errorMessage); |
| 111 | + setActivities([]); |
| 112 | + setLoading(false); |
| 113 | + } |
| 114 | + }, [connectedAddress, onBorrowClick]); |
| 115 | + |
| 116 | + /** |
| 117 | + * Manual refetch function exposed to component |
| 118 | + */ |
| 119 | + const refetch = useCallback(async () => { |
| 120 | + await fetchPeginRequests(); |
| 121 | + }, [fetchPeginRequests]); |
| 122 | + |
| 123 | + /** |
| 124 | + * Auto-fetch on wallet connection or address change |
| 125 | + */ |
| 126 | + useEffect(() => { |
| 127 | + fetchPeginRequests(); |
| 128 | + }, [fetchPeginRequests]); |
| 129 | + |
| 130 | + return { |
| 131 | + activities, |
| 132 | + loading, |
| 133 | + error, |
| 134 | + refetch, |
| 135 | + }; |
| 136 | +} |
0 commit comments