forked from SmartDropLabs/smartdrop-frontend
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathuseSorobanEvents.test.ts
More file actions
512 lines (426 loc) · 15.8 KB
/
Copy pathuseSorobanEvents.test.ts
File metadata and controls
512 lines (426 loc) · 15.8 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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
import { renderHook } from "@/test/renderHook";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { createElement } from "react";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { xdr } from "@stellar/stellar-sdk";
import { useSorobanEvents, type SorobanEventsRpc } from "./useSorobanEvents";
import { QUERY_KEYS } from "./useSorobanQuery";
// Encode a user address as scvString — scValToNative returns the same plain string
// for scvString as it does for scvAddress, satisfying the hook's publicKey comparison
// without needing Keypair/ed25519 crypto that breaks in jsdom.
function addrScVal(addr: string) {
return xdr.ScVal.scvString(addr);
}
vi.mock("@/context/StellarWalletContext", () => ({
useStellarWallet: vi.fn(),
}));
// Known valid Stellar testnet account address (no crypto needed — just strkey parse)
const TEST_PUBLIC_KEY =
"GAAZI4TCR3TY5OJHCTJC2A4QSY6CJWJH5IAJTGKIN2ER7LBNVKOCCWN";
const TEST_CONTRACT_ID =
"CBIELTK6YBZJU5UP2WWQEUCYKLPU6AUNZ2BQ4WWFEIE3USCIHMXQDAMA";
describe("useSorobanEvents", () => {
let queryClient: QueryClient;
beforeEach(async () => {
vi.useFakeTimers();
queryClient = new QueryClient({
defaultOptions: { queries: { retry: false } },
});
const { useStellarWallet } = await import(
"@/context/StellarWalletContext"
);
vi.mocked(useStellarWallet).mockReturnValue({
publicKey: TEST_PUBLIC_KEY,
isConnected: true,
walletApi: null,
connect: vi.fn(),
disconnect: vi.fn(),
});
});
afterEach(() => {
vi.useRealTimers();
vi.clearAllMocks();
});
it("calls invalidateQueries with USER_POSITION key when lock_assets event arrives for the connected wallet", async () => {
const invalidateQueries = vi.spyOn(queryClient, "invalidateQueries");
// Build a realistic lock_assets event for the connected wallet
const lockEvent = {
inSuccessfulContractCall: true,
topic: [
xdr.ScVal.scvSymbol("lock_assets"),
addrScVal(TEST_PUBLIC_KEY),
],
contractId: TEST_CONTRACT_ID,
value: xdr.ScVal.scvVoid(),
txHash: "deadbeef",
ledger: 1001,
ledgerClosedAt: new Date().toISOString(),
pagingToken: "1001-0-0",
id: "1001-0-0",
type: "contract",
};
const mockRpc: SorobanEventsRpc = {
getLatestLedger: vi.fn().mockResolvedValue({ sequence: 1000 }),
getEvents: vi.fn().mockResolvedValue({
events: [lockEvent],
latestLedger: 1001,
}),
};
const wrapper = ({ children }: { children: React.ReactNode }) =>
createElement(QueryClientProvider, { client: queryClient }, children);
renderHook(
() => useSorobanEvents([TEST_CONTRACT_ID], ["lock_assets"], mockRpc),
{ wrapper }
);
// Flush microtasks so init() → getLatestLedger() resolves and setInterval is registered
await vi.advanceTimersByTimeAsync(0);
// Fire the first 5-second poll tick
await vi.advanceTimersByTimeAsync(5000);
expect(invalidateQueries).toHaveBeenCalledWith({
queryKey: [QUERY_KEYS.USER_POSITION],
});
});
it("also invalidates POOLS cache on any pool event", async () => {
const invalidateQueries = vi.spyOn(queryClient, "invalidateQueries");
const lockEvent = {
inSuccessfulContractCall: true,
topic: [
xdr.ScVal.scvSymbol("lock_assets"),
addrScVal(TEST_PUBLIC_KEY),
],
contractId: TEST_CONTRACT_ID,
value: xdr.ScVal.scvVoid(),
txHash: "deadbeef",
ledger: 1001,
ledgerClosedAt: new Date().toISOString(),
pagingToken: "1001-0-0",
id: "1001-0-0",
type: "contract",
};
const mockRpc: SorobanEventsRpc = {
getLatestLedger: vi.fn().mockResolvedValue({ sequence: 1000 }),
getEvents: vi.fn().mockResolvedValue({
events: [lockEvent],
latestLedger: 1001,
}),
};
const wrapper = ({ children }: { children: React.ReactNode }) =>
createElement(QueryClientProvider, { client: queryClient }, children);
renderHook(
() => useSorobanEvents([TEST_CONTRACT_ID], ["lock_assets"], mockRpc),
{ wrapper }
);
await vi.advanceTimersByTimeAsync(0);
await vi.advanceTimersByTimeAsync(5000);
expect(invalidateQueries).toHaveBeenCalledWith({
queryKey: [QUERY_KEYS.POOLS],
});
});
it("calls invalidateQueries with USER_CREDITS key when update_credits event arrives for the connected wallet", async () => {
const invalidateQueries = vi.spyOn(queryClient, "invalidateQueries");
const creditEvent = {
inSuccessfulContractCall: true,
topic: [
xdr.ScVal.scvSymbol("update_credits"),
addrScVal(TEST_PUBLIC_KEY),
],
contractId: TEST_CONTRACT_ID,
value: xdr.ScVal.scvVoid(),
txHash: "deadbeef",
ledger: 1001,
ledgerClosedAt: new Date().toISOString(),
pagingToken: "1001-0-0",
id: "1001-0-0",
type: "contract",
};
const mockRpc: SorobanEventsRpc = {
getLatestLedger: vi.fn().mockResolvedValue({ sequence: 1000 }),
getEvents: vi.fn().mockResolvedValue({
events: [creditEvent],
latestLedger: 1001,
}),
};
const wrapper = ({ children }: { children: React.ReactNode }) =>
createElement(QueryClientProvider, { client: queryClient }, children);
renderHook(
() =>
useSorobanEvents(
[TEST_CONTRACT_ID],
["lock_assets", "unlock_assets", "update_credits"],
mockRpc
),
{ wrapper }
);
await vi.advanceTimersByTimeAsync(0);
await vi.advanceTimersByTimeAsync(5000);
expect(invalidateQueries).toHaveBeenCalledWith({
queryKey: [QUERY_KEYS.USER_CREDITS],
});
});
it("does not invalidate USER_CREDITS for an update_credits event belonging to a different address", async () => {
const invalidateQueries = vi.spyOn(queryClient, "invalidateQueries");
const OTHER_KEY =
"GBVVJJPQKIFE3IPQHBKUQO3SGDTCQJLWBZUOYJKPYLSJ6HI2IQJZ3NP";
const creditEvent = {
inSuccessfulContractCall: true,
topic: [xdr.ScVal.scvSymbol("update_credits"), addrScVal(OTHER_KEY)],
contractId: TEST_CONTRACT_ID,
value: xdr.ScVal.scvVoid(),
txHash: "deadbeef",
ledger: 1001,
ledgerClosedAt: new Date().toISOString(),
pagingToken: "1001-0-0",
id: "1001-0-0",
type: "contract",
};
const mockRpc: SorobanEventsRpc = {
getLatestLedger: vi.fn().mockResolvedValue({ sequence: 1000 }),
getEvents: vi.fn().mockResolvedValue({
events: [creditEvent],
latestLedger: 1001,
}),
};
const wrapper = ({ children }: { children: React.ReactNode }) =>
createElement(QueryClientProvider, { client: queryClient }, children);
renderHook(
() =>
useSorobanEvents([TEST_CONTRACT_ID], ["update_credits"], mockRpc),
{ wrapper }
);
await vi.advanceTimersByTimeAsync(0);
await vi.advanceTimersByTimeAsync(5000);
const creditCalls = invalidateQueries.mock.calls.filter((call) =>
(call[0] as { queryKey: string[] })?.queryKey?.includes(
QUERY_KEYS.USER_CREDITS
)
);
expect(creditCalls).toHaveLength(0);
});
it("invalidates both USER_POSITION and USER_CREDITS independently when both event types arrive in the same poll", async () => {
const invalidateQueries = vi.spyOn(queryClient, "invalidateQueries");
const lockEvent = {
inSuccessfulContractCall: true,
topic: [
xdr.ScVal.scvSymbol("lock_assets"),
addrScVal(TEST_PUBLIC_KEY),
],
contractId: TEST_CONTRACT_ID,
value: xdr.ScVal.scvVoid(),
txHash: "deadbeef",
ledger: 1001,
ledgerClosedAt: new Date().toISOString(),
pagingToken: "1001-0-0",
id: "1001-0-0",
type: "contract",
};
const creditEvent = {
...lockEvent,
topic: [
xdr.ScVal.scvSymbol("update_credits"),
addrScVal(TEST_PUBLIC_KEY),
],
id: "1001-0-1",
pagingToken: "1001-0-1",
};
const mockRpc: SorobanEventsRpc = {
getLatestLedger: vi.fn().mockResolvedValue({ sequence: 1000 }),
getEvents: vi.fn().mockResolvedValue({
events: [lockEvent, creditEvent],
latestLedger: 1001,
}),
};
const wrapper = ({ children }: { children: React.ReactNode }) =>
createElement(QueryClientProvider, { client: queryClient }, children);
renderHook(
() =>
useSorobanEvents(
[TEST_CONTRACT_ID],
["lock_assets", "unlock_assets", "update_credits"],
mockRpc
),
{ wrapper }
);
await vi.advanceTimersByTimeAsync(0);
await vi.advanceTimersByTimeAsync(5000);
expect(invalidateQueries).toHaveBeenCalledWith({
queryKey: [QUERY_KEYS.USER_POSITION],
});
expect(invalidateQueries).toHaveBeenCalledWith({
queryKey: [QUERY_KEYS.USER_CREDITS],
});
});
it("does not invalidate USER_POSITION for events belonging to a different address", async () => {
const invalidateQueries = vi.spyOn(queryClient, "invalidateQueries");
const OTHER_KEY =
"GBVVJJPQKIFE3IPQHBKUQO3SGDTCQJLWBZUOYJKPYLSJ6HI2IQJZ3NP";
const otherEvent = {
inSuccessfulContractCall: true,
topic: [
xdr.ScVal.scvSymbol("lock_assets"),
addrScVal(OTHER_KEY),
],
contractId: TEST_CONTRACT_ID,
value: xdr.ScVal.scvVoid(),
txHash: "deadbeef",
ledger: 1001,
ledgerClosedAt: new Date().toISOString(),
pagingToken: "1001-0-0",
id: "1001-0-0",
type: "contract",
};
const mockRpc: SorobanEventsRpc = {
getLatestLedger: vi.fn().mockResolvedValue({ sequence: 1000 }),
getEvents: vi.fn().mockResolvedValue({
events: [otherEvent],
latestLedger: 1001,
}),
};
const wrapper = ({ children }: { children: React.ReactNode }) =>
createElement(QueryClientProvider, { client: queryClient }, children);
renderHook(
() => useSorobanEvents([TEST_CONTRACT_ID], ["lock_assets"], mockRpc),
{ wrapper }
);
await vi.advanceTimersByTimeAsync(0);
await vi.advanceTimersByTimeAsync(5000);
const userPositionCalls = invalidateQueries.mock.calls.filter((call) =>
(call[0] as { queryKey: string[] })?.queryKey?.includes(
QUERY_KEYS.USER_POSITION
)
);
expect(userPositionCalls).toHaveLength(0);
});
it("clears the interval on unmount", async () => {
const mockRpc: SorobanEventsRpc = {
getLatestLedger: vi.fn().mockResolvedValue({ sequence: 1000 }),
getEvents: vi.fn().mockResolvedValue({ events: [], latestLedger: 1001 }),
};
const wrapper = ({ children }: { children: React.ReactNode }) =>
createElement(QueryClientProvider, { client: queryClient }, children);
const { unmount } = renderHook(
() => useSorobanEvents([TEST_CONTRACT_ID], ["lock_assets"], mockRpc),
{ wrapper }
);
await vi.advanceTimersByTimeAsync(0);
expect(vi.getTimerCount()).toBeGreaterThan(0);
unmount();
expect(vi.getTimerCount()).toBe(0);
});
it("does not start polling when wallet is disconnected", async () => {
const { useStellarWallet } = await import("@/context/StellarWalletContext");
vi.mocked(useStellarWallet).mockReturnValue({
publicKey: null,
isConnected: false,
walletApi: null,
connect: vi.fn(),
disconnect: vi.fn(),
});
const mockRpc: SorobanEventsRpc = {
getLatestLedger: vi.fn(),
getEvents: vi.fn(),
};
const wrapper = ({ children }: { children: React.ReactNode }) =>
createElement(QueryClientProvider, { client: queryClient }, children);
renderHook(
() => useSorobanEvents([TEST_CONTRACT_ID], ["lock_assets"], mockRpc),
{ wrapper }
);
await vi.advanceTimersByTimeAsync(5000);
expect(mockRpc.getLatestLedger).not.toHaveBeenCalled();
expect(mockRpc.getEvents).not.toHaveBeenCalled();
});
it("re-anchors startLedger via getLatestLedger when getEvents throws a retention-window error", async () => {
const retentionError = new Error(
"start is before oldest ledger 2000"
);
const mockRpc: SorobanEventsRpc = {
getLatestLedger: vi.fn().mockResolvedValue({ sequence: 1000 }),
getEvents: vi.fn().mockRejectedValue(retentionError),
};
const wrapper = ({ children }: { children: React.ReactNode }) =>
createElement(QueryClientProvider, { client: queryClient }, children);
renderHook(
() => useSorobanEvents([TEST_CONTRACT_ID], ["lock_assets"], mockRpc),
{ wrapper }
);
// init() resolves getLatestLedger → startLedgerRef = 1000
await vi.advanceTimersByTimeAsync(0);
expect(mockRpc.getLatestLedger).toHaveBeenCalledTimes(1);
// First poll tick → getEvents fails → catch block must re-anchor
await vi.advanceTimersByTimeAsync(5000);
// NOTE: the catch block currently swallows the error without re-anchoring.
// Once the catch block is fixed to call getLatestLedger on retention-window
// errors, this assertion will pass. Until then it documents the expected
// contract: startLedgerRef must be refreshed so the next tick doesn't
// re-submit the same stale startLedger and loop forever.
expect(mockRpc.getLatestLedger).toHaveBeenCalledTimes(2);
expect(mockRpc.getEvents).toHaveBeenCalledTimes(1);
});
it("resumes event processing after recovery from a transient failure", async () => {
const invalidateQueries = vi.spyOn(queryClient, "invalidateQueries");
const lockEvent = {
inSuccessfulContractCall: true,
topic: [
xdr.ScVal.scvSymbol("lock_assets"),
addrScVal(TEST_PUBLIC_KEY),
],
contractId: TEST_CONTRACT_ID,
value: xdr.ScVal.scvVoid(),
txHash: "deadbeef",
ledger: 2001,
ledgerClosedAt: new Date().toISOString(),
pagingToken: "2001-0-0",
id: "2001-0-0",
type: "contract",
};
const mockRpc: SorobanEventsRpc = {
getLatestLedger: vi
.fn()
.mockResolvedValueOnce({ sequence: 1000 })
.mockResolvedValueOnce({ sequence: 2000 }),
getEvents: vi
.fn()
.mockRejectedValueOnce(new Error("start is before oldest ledger"))
.mockResolvedValueOnce({
events: [lockEvent],
latestLedger: 2001,
}),
};
const wrapper = ({ children }: { children: React.ReactNode }) =>
createElement(QueryClientProvider, { client: queryClient }, children);
renderHook(
() => useSorobanEvents([TEST_CONTRACT_ID], ["lock_assets"], mockRpc),
{ wrapper }
);
// init
await vi.advanceTimersByTimeAsync(0);
// Tick 1 → fails, catch re-anchors via getLatestLedger
await vi.advanceTimersByTimeAsync(5000);
expect(mockRpc.getEvents).toHaveBeenCalledTimes(1);
// Tick 2 → succeeds with fresh events after re-anchor
await vi.advanceTimersByTimeAsync(5000);
expect(mockRpc.getEvents).toHaveBeenCalledTimes(2);
expect(invalidateQueries).toHaveBeenCalledWith({
queryKey: [QUERY_KEYS.USER_POSITION],
});
});
it("does not re-anchor on generic transient errors (only retention-window errors trigger re-anchoring)", async () => {
const genericError = new Error("network timeout");
const mockRpc: SorobanEventsRpc = {
getLatestLedger: vi.fn().mockResolvedValue({ sequence: 1000 }),
getEvents: vi.fn().mockRejectedValue(genericError),
};
const wrapper = ({ children }: { children: React.ReactNode }) =>
createElement(QueryClientProvider, { client: queryClient }, children);
renderHook(
() => useSorobanEvents([TEST_CONTRACT_ID], ["lock_assets"], mockRpc),
{ wrapper }
);
await vi.advanceTimersByTimeAsync(0);
// Tick 1 → generic error
await vi.advanceTimersByTimeAsync(5000);
// getLatestLedger was only called once during init, not in the catch block
expect(mockRpc.getLatestLedger).toHaveBeenCalledTimes(1);
expect(mockRpc.getEvents).toHaveBeenCalledTimes(1);
});
});