forked from FlowwStar/FlowStar
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathuse-auto-withdraw.test.ts
More file actions
287 lines (234 loc) · 10.5 KB
/
Copy pathuse-auto-withdraw.test.ts
File metadata and controls
287 lines (234 loc) · 10.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
import { renderHook, act } from '@testing-library/react'
// ── Mocks ──────────────────────────────────────────────────────────────────
vi.mock('@/lib/contract', () => ({
withdrawFromStream: vi.fn(),
}))
vi.mock('@/components/providers/network-provider', () => ({
useNetwork: vi.fn(() => ({ network: 'testnet' })),
}))
// Mock stream-utils — keep original getWithdrawableAmount
vi.mock('@/lib/stream-utils', async (importOriginal) => {
const actual = await importOriginal<typeof import('@/lib/stream-utils')>()
return { ...actual, getWithdrawableAmount: vi.fn(() => 500n) }
})
import { withdrawFromStream } from '@/lib/contract'
import { getWithdrawableAmount } from '@/lib/stream-utils'
import { useAutoWithdraw } from '@/hooks/use-auto-withdraw'
import type { StreamData } from '@/types/stream'
// ── Fixtures ────────────────────────────────────────────────────────────────
const TOKEN = { address: 'CUSDC', symbol: 'USDC', decimals: 7 }
function makeStream(overrides: Partial<StreamData> = {}): StreamData {
return {
id: 'stream-1',
sender: 'GSENDER',
recipient: 'GRECIPIENT',
token: TOKEN,
depositedAmount: 10_000n,
withdrawnAmount: 0n,
startTime: 0n,
endTime: 9_999_999n,
cliffTime: 0n,
cliffAmount: 0n,
amountPerSecond: 1n,
linearAmount: 10_000n,
duration: 9_999_999n,
cancelled: false,
...overrides,
}
}
// ── Tests ────────────────────────────────────────────────────────────────────
describe('useAutoWithdraw', () => {
beforeEach(() => {
vi.clearAllMocks()
vi.useFakeTimers()
localStorage.clear()
vi.mocked(withdrawFromStream).mockResolvedValue('tx-hash-123')
vi.mocked(getWithdrawableAmount).mockReturnValue(500n)
})
afterEach(() => {
vi.useRealTimers()
localStorage.clear()
})
// ── initial state ──────────────────────────────────────────────────────────
it('starts with disabled auto-withdraw and default settings', () => {
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
expect(result.current.settings.enabled).toBe(false)
expect(result.current.settings.strategy).toBe('time-based')
expect(result.current.settings.intervalHours).toBe(24)
})
it('starts with empty withdrawal history', () => {
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
expect(result.current.withdrawalHistory).toHaveLength(0)
})
it('handles null stream gracefully', () => {
const { result } = renderHook(() => useAutoWithdraw(null))
expect(result.current.settings.enabled).toBe(false)
})
// ── updateSettings ─────────────────────────────────────────────────────────
it('updates settings and persists to localStorage', () => {
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
act(() => {
result.current.updateSettings({ enabled: true, intervalHours: 12 })
})
expect(result.current.settings.enabled).toBe(true)
expect(result.current.settings.intervalHours).toBe(12)
const stored = JSON.parse(localStorage.getItem('flowstar:auto-withdraw:stream-1')!)
expect(stored.enabled).toBe(true)
expect(stored.intervalHours).toBe(12)
})
it('does nothing when stream is null', () => {
const { result } = renderHook(() => useAutoWithdraw(null))
act(() => {
result.current.updateSettings({ enabled: true })
})
expect(result.current.settings.enabled).toBe(false)
})
// ── localStorage persistence ───────────────────────────────────────────────
it('loads persisted settings from localStorage on mount', () => {
localStorage.setItem(
'flowstar:auto-withdraw:stream-1',
JSON.stringify({ enabled: true, intervalHours: 6 }),
)
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
expect(result.current.settings.enabled).toBe(true)
expect(result.current.settings.intervalHours).toBe(6)
})
it('falls back to defaults when localStorage has invalid JSON', () => {
localStorage.setItem('flowstar:auto-withdraw:stream-1', 'not-json}}}')
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
expect(result.current.settings.enabled).toBe(false)
})
// ── addWithdrawalHistory ───────────────────────────────────────────────────
it('prepends new entry to withdrawal history', () => {
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
act(() => {
result.current.addWithdrawalHistory({ timestamp: 1000, amount: '500', txHash: 'tx1' })
})
expect(result.current.withdrawalHistory).toHaveLength(1)
expect(result.current.withdrawalHistory[0].txHash).toBe('tx1')
})
it('caps withdrawal history at 100 entries', () => {
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
act(() => {
for (let i = 0; i < 105; i++) {
result.current.addWithdrawalHistory({ timestamp: i, amount: '1' })
}
})
expect(result.current.withdrawalHistory.length).toBeLessThanOrEqual(100)
})
// ── auto-withdraw interval ─────────────────────────────────────────────────
it('does not call withdrawFromStream when disabled', async () => {
renderHook(() => useAutoWithdraw(makeStream()))
await act(async () => {
vi.advanceTimersByTime(25 * 60 * 60 * 1000) // 25 hours
})
expect(withdrawFromStream).not.toHaveBeenCalled()
})
it('calls withdrawFromStream after interval when enabled', async () => {
vi.mocked(withdrawFromStream).mockResolvedValue('tx-abc')
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
act(() => {
result.current.updateSettings({ enabled: true, intervalHours: 1 })
})
await act(async () => {
vi.advanceTimersByTime(60 * 60 * 1000 + 100) // 1 hour + buffer
await Promise.resolve() // flush microtasks
})
expect(withdrawFromStream).toHaveBeenCalledWith('stream-1', 500n, 'testnet')
})
it('records successful withdrawal in history', async () => {
vi.mocked(withdrawFromStream).mockResolvedValue('tx-success')
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
act(() => {
result.current.updateSettings({ enabled: true, intervalHours: 1 })
})
await act(async () => {
await vi.advanceTimersByTimeAsync(60 * 60 * 1000 + 100)
})
expect(result.current.withdrawalHistory.length).toBeGreaterThan(0)
expect(result.current.withdrawalHistory[0].txHash).toBe('tx-success')
})
it('records error in history on withdrawal failure', async () => {
vi.mocked(withdrawFromStream).mockRejectedValue(new Error('network timeout'))
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
act(() => {
result.current.updateSettings({ enabled: true, intervalHours: 1 })
})
await act(async () => {
await vi.advanceTimersByTimeAsync(60 * 60 * 1000 + 100)
})
expect(result.current.withdrawalHistory.length).toBeGreaterThan(0)
expect(result.current.withdrawalHistory[0].error).toContain('network timeout')
})
it('skips withdrawal when stream is cancelled', async () => {
renderHook(() => useAutoWithdraw(makeStream({ cancelled: true })))
await act(async () => {
vi.advanceTimersByTime(25 * 60 * 60 * 1000)
})
expect(withdrawFromStream).not.toHaveBeenCalled()
})
it('skips withdrawal when withdrawable amount is 0', async () => {
vi.mocked(getWithdrawableAmount).mockReturnValue(0n)
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
act(() => {
result.current.updateSettings({ enabled: true, intervalHours: 1 })
})
await act(async () => {
vi.advanceTimersByTime(60 * 60 * 1000 + 100)
await Promise.resolve()
})
expect(withdrawFromStream).not.toHaveBeenCalled()
})
// ── calculateWithdrawAmount strategies ────────────────────────────────────
it('threshold-based: skips withdrawal when below threshold', async () => {
// withdrawable (500n) < threshold (5000n = 50% of 10000n deposited)
vi.mocked(getWithdrawableAmount).mockReturnValue(500n)
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
act(() => {
result.current.updateSettings({
enabled: true,
intervalHours: 1,
strategy: 'threshold-based',
thresholdPercentage: 50,
})
})
await act(async () => {
vi.advanceTimersByTime(60 * 60 * 1000 + 100)
await Promise.resolve()
})
expect(withdrawFromStream).not.toHaveBeenCalled()
})
it('min-amount: skips withdrawal when below minAmountRaw', async () => {
vi.mocked(getWithdrawableAmount).mockReturnValue(100n)
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
act(() => {
result.current.updateSettings({
enabled: true,
intervalHours: 1,
minAmountRaw: '500', // require 500 minimum
})
})
await act(async () => {
vi.advanceTimersByTime(60 * 60 * 1000 + 100)
await Promise.resolve()
})
expect(withdrawFromStream).not.toHaveBeenCalled()
})
it('maxSafetyLimit caps the withdrawal amount', async () => {
vi.mocked(getWithdrawableAmount).mockReturnValue(1000n)
vi.mocked(withdrawFromStream).mockResolvedValue('tx-capped')
const { result } = renderHook(() => useAutoWithdraw(makeStream()))
act(() => {
result.current.updateSettings({
enabled: true,
intervalHours: 1,
maxSafetyLimitRaw: '200', // cap at 200
})
})
await act(async () => {
await vi.advanceTimersByTimeAsync(60 * 60 * 1000 + 100)
})
expect(withdrawFromStream).toHaveBeenCalledWith('stream-1', 200n, 'testnet')
})
})