|
| 1 | +'use client'; |
| 2 | + |
| 3 | +/** |
| 4 | + * useOptimisticClaims |
| 5 | + * |
| 6 | + * Manages optimistic state for claim filing and vote submission. |
| 7 | + * |
| 8 | + * After a transaction is submitted the hook: |
| 9 | + * 1. Immediately marks the claim row as "pending". |
| 10 | + * 2. Polls /api/claims/:id with exponential backoff until the indexer |
| 11 | + * reflects the expected status change. |
| 12 | + * 3. Rolls back on timeout or hard error. |
| 13 | + * |
| 14 | + * Optimistic state is session-only (React state) — never persisted to storage. |
| 15 | + */ |
| 16 | + |
| 17 | +import { useCallback, useEffect } from 'react'; |
| 18 | +import { useOptimisticState, useConfirmationPoller } from '@/lib/optimistic'; |
| 19 | +import type { ClaimBoard } from '@/lib/schemas/claims-board'; |
| 20 | + |
| 21 | +// --------------------------------------------------------------------------- |
| 22 | +// Confirmation check |
| 23 | +// --------------------------------------------------------------------------- |
| 24 | + |
| 25 | +async function checkClaimStatus( |
| 26 | + claimId: string, |
| 27 | + expectedStatus: string, |
| 28 | + signal: AbortSignal, |
| 29 | +): Promise<boolean> { |
| 30 | + const res = await fetch(`/api/claims/${encodeURIComponent(claimId)}`, { |
| 31 | + signal, |
| 32 | + cache: 'no-store', |
| 33 | + }); |
| 34 | + if (!res.ok) throw new Error(`HTTP ${res.status}`); |
| 35 | + const data = (await res.json()) as { status?: string }; |
| 36 | + return data.status === expectedStatus; |
| 37 | +} |
| 38 | + |
| 39 | +// --------------------------------------------------------------------------- |
| 40 | +// Hook |
| 41 | +// --------------------------------------------------------------------------- |
| 42 | + |
| 43 | +export interface UseOptimisticClaimsReturn { |
| 44 | + /** Apply an optimistic "Processing" state after claim filing. */ |
| 45 | + applyOptimisticClaim: (claim: ClaimBoard, txHash?: string) => void; |
| 46 | + /** Apply an optimistic vote count update after vote submission. */ |
| 47 | + applyOptimisticVote: ( |
| 48 | + claim: ClaimBoard, |
| 49 | + vote: 'Approve' | 'Reject', |
| 50 | + txHash?: string, |
| 51 | + ) => void; |
| 52 | + /** Merge server claims with optimistic overrides. */ |
| 53 | + mergeWithOptimistic: (serverClaims: ClaimBoard[]) => ClaimBoard[]; |
| 54 | + /** Get the optimistic status for a single claim (for badge rendering). */ |
| 55 | + getOptimisticStatus: (claimId: string) => { status: 'pending' | 'confirmed' | 'failed'; error?: string } | undefined; |
| 56 | +} |
| 57 | + |
| 58 | +export function useOptimisticClaims(): UseOptimisticClaimsReturn { |
| 59 | + const optimistic = useOptimisticState<ClaimBoard>(); |
| 60 | + |
| 61 | + // Confirm entries whose expected status is now reflected by the server. |
| 62 | + // Called by mergeWithOptimistic so the effect runs on every server refresh. |
| 63 | + const syncWithServer = useCallback( |
| 64 | + (serverClaims: ClaimBoard[]) => { |
| 65 | + optimistic.entries.forEach((entry, key) => { |
| 66 | + if (entry.status !== 'pending') return; |
| 67 | + const serverClaim = serverClaims.find((c) => c.claim_id === key); |
| 68 | + if (!serverClaim) return; |
| 69 | + const expectedStatus = entry.optimisticData.status; |
| 70 | + if (serverClaim.status === expectedStatus) { |
| 71 | + optimistic.confirm(key); |
| 72 | + setTimeout(() => optimistic.remove(key), 2_000); |
| 73 | + } |
| 74 | + }); |
| 75 | + }, |
| 76 | + // eslint-disable-next-line react-hooks/exhaustive-deps |
| 77 | + [], |
| 78 | + ); |
| 79 | + |
| 80 | + const applyOptimisticClaim = useCallback( |
| 81 | + (claim: ClaimBoard, txHash?: string) => { |
| 82 | + const optimisticClaim: ClaimBoard = { ...claim, status: 'Processing' }; |
| 83 | + optimistic.apply(claim.claim_id, 'claim_filing', optimisticClaim, claim, txHash); |
| 84 | + }, |
| 85 | + // eslint-disable-next-line react-hooks/exhaustive-deps |
| 86 | + [], |
| 87 | + ); |
| 88 | + |
| 89 | + const applyOptimisticVote = useCallback( |
| 90 | + (claim: ClaimBoard, vote: 'Approve' | 'Reject', txHash?: string) => { |
| 91 | + const optimisticClaim: ClaimBoard = { |
| 92 | + ...claim, |
| 93 | + approve_votes: vote === 'Approve' ? claim.approve_votes + 1 : claim.approve_votes, |
| 94 | + reject_votes: vote === 'Reject' ? claim.reject_votes + 1 : claim.reject_votes, |
| 95 | + }; |
| 96 | + optimistic.apply(claim.claim_id, 'vote_submission', optimisticClaim, claim, txHash); |
| 97 | + }, |
| 98 | + // eslint-disable-next-line react-hooks/exhaustive-deps |
| 99 | + [], |
| 100 | + ); |
| 101 | + |
| 102 | + const mergeWithOptimistic = useCallback( |
| 103 | + (serverClaims: ClaimBoard[]): ClaimBoard[] => { |
| 104 | + syncWithServer(serverClaims); |
| 105 | + return serverClaims.map((c) => { |
| 106 | + const entry = optimistic.get(c.claim_id); |
| 107 | + if (!entry || entry.status === 'confirmed') return c; |
| 108 | + return entry.status === 'failed' ? entry.previousData : entry.optimisticData; |
| 109 | + }); |
| 110 | + }, |
| 111 | + // eslint-disable-next-line react-hooks/exhaustive-deps |
| 112 | + [optimistic.entries], |
| 113 | + ); |
| 114 | + |
| 115 | + const getOptimisticStatus = useCallback( |
| 116 | + (claimId: string) => { |
| 117 | + const entry = optimistic.get(claimId); |
| 118 | + if (!entry) return undefined; |
| 119 | + return { status: entry.status, error: entry.error }; |
| 120 | + }, |
| 121 | + // eslint-disable-next-line react-hooks/exhaustive-deps |
| 122 | + [optimistic.entries], |
| 123 | + ); |
| 124 | + |
| 125 | + return { applyOptimisticClaim, applyOptimisticVote, mergeWithOptimistic, getOptimisticStatus }; |
| 126 | +} |
| 127 | + |
| 128 | +// --------------------------------------------------------------------------- |
| 129 | +// Per-entry poller (headless component) |
| 130 | +// --------------------------------------------------------------------------- |
| 131 | + |
| 132 | +export interface ClaimConfirmationPollerProps { |
| 133 | + claimId: string; |
| 134 | + expectedStatus: string; |
| 135 | + createdAt: number; |
| 136 | + enabled: boolean; |
| 137 | + onConfirmed: (key: string) => void; |
| 138 | + onRollback: (key: string, error: string) => void; |
| 139 | +} |
| 140 | + |
| 141 | +export function ClaimConfirmationPoller({ |
| 142 | + claimId, |
| 143 | + expectedStatus, |
| 144 | + createdAt, |
| 145 | + enabled, |
| 146 | + onConfirmed, |
| 147 | + onRollback, |
| 148 | +}: ClaimConfirmationPollerProps) { |
| 149 | + useConfirmationPoller({ |
| 150 | + key: claimId, |
| 151 | + enabled, |
| 152 | + createdAt, |
| 153 | + check: (signal) => checkClaimStatus(claimId, expectedStatus, signal), |
| 154 | + onConfirmed, |
| 155 | + onRollback, |
| 156 | + }); |
| 157 | + return null; |
| 158 | +} |
0 commit comments