-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Expand file tree
/
Copy pathuseCardDelegation.test.ts
More file actions
1380 lines (1110 loc) · 42.7 KB
/
Copy pathuseCardDelegation.test.ts
File metadata and controls
1380 lines (1110 loc) · 42.7 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
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { renderHook, act } from '@testing-library/react-hooks';
import { useSelector } from 'react-redux';
import { useCardDelegation, UserCancelledError } from './useCardDelegation';
import { useCardSDK } from '../sdk';
import { useNeedsGasFaucet } from './useNeedsGasFaucet';
import { CardSDK } from '../sdk/CardSDK';
import { CardTokenAllowance, AllowanceState } from '../types';
import Engine from '../../../../core/Engine';
import Logger from '../../../../util/Logger';
import { MetaMetricsEvents } from '../../../../core/Analytics';
import { useAnalytics } from '../../../hooks/useAnalytics/useAnalytics';
import { createMockUseAnalyticsHook } from '../../../../util/test/analyticsMock';
import { toTokenMinimalUnit } from '../../../../util/number';
import { safeToChecksumAddress } from '../../../../util/address';
import { ARBITRARY_ALLOWANCE } from '../constants';
import {
TransactionType,
WalletDevice,
TransactionStatus,
} from '@metamask/transaction-controller';
import TransactionTypes from '../../../../core/TransactionTypes';
// Mock dependencies
jest.mock('react-redux', () => ({
useSelector: jest.fn(),
}));
jest.mock('../sdk', () => ({
useCardSDK: jest.fn(),
}));
jest.mock('./useNeedsGasFaucet', () => ({
useNeedsGasFaucet: jest.fn(),
}));
jest.mock('../../../hooks/useAnalytics/useAnalytics', () => ({
useAnalytics: jest.fn(),
}));
jest.mock('../../../../util/Logger', () => ({
log: jest.fn(),
error: jest.fn(),
}));
jest.mock('../../../../util/number', () => ({
toTokenMinimalUnit: jest.fn(),
}));
jest.mock('../../../../util/address', () => ({
safeToChecksumAddress: jest.fn(),
}));
jest.mock('../../../../core/Engine', () => ({
context: {
KeyringController: {
signPersonalMessage: jest.fn(),
},
TransactionController: {
addTransaction: jest.fn(),
},
NetworkController: {
findNetworkClientIdByChainId: jest.fn(),
},
},
controllerMessenger: {
subscribeOnceIf: jest.fn(),
},
}));
const mockUseSelector = useSelector as jest.MockedFunction<typeof useSelector>;
const mockUseCardSDK = useCardSDK as jest.MockedFunction<typeof useCardSDK>;
const mockUseAnalytics = jest.mocked(useAnalytics);
const mockUseNeedsGasFaucet = useNeedsGasFaucet as jest.MockedFunction<
typeof useNeedsGasFaucet
>;
const mockToTokenMinimalUnit = toTokenMinimalUnit as jest.MockedFunction<
typeof toTokenMinimalUnit
>;
const mockSafeToChecksumAddress = safeToChecksumAddress as jest.MockedFunction<
typeof safeToChecksumAddress
>;
// Helper functions
const createMockToken = (
overrides: Partial<CardTokenAllowance> = {},
): CardTokenAllowance => ({
address: '0x1234567890123456789012345678901234567890',
caipChainId: 'eip155:59144',
decimals: 18,
symbol: 'USDC',
name: 'USD Coin',
allowanceState: AllowanceState.Enabled,
allowance: '1000',
availableBalance: '500',
walletAddress: '0xwallet1',
delegationContract: '0xdelegation123',
...overrides,
});
const createMockDelegationParams = () => ({
amount: '100',
currency: 'USDC',
network: 'linea' as const,
});
describe('useCardDelegation', () => {
const mockAddress = '0xUserAddress123';
const mockSignature = '0xSignature123';
const mockDelegationJWTToken = 'jwt-token-123';
const mockNonce = 'nonce-123';
const mockTxHash = '0xTxHash123';
const mockNetworkClientId = 'network-client-123';
let mockSDK: {
generateDelegationToken: jest.Mock;
encodeApproveTransaction: jest.Mock;
completeEVMDelegation: jest.Mock;
};
let mockTrackEvent: jest.Mock;
let mockCreateEventBuilder: jest.Mock;
let mockBuild: jest.Mock;
let mockAddProperties: jest.Mock;
let mockRefetchFaucetCheck: jest.Mock;
beforeEach(() => {
jest.clearAllMocks();
// Setup useNeedsGasFaucet mock
mockRefetchFaucetCheck = jest.fn();
mockUseNeedsGasFaucet.mockReturnValue({
needsFaucet: false,
isLoading: false,
error: null,
refetch: mockRefetchFaucetCheck,
});
// Setup SDK mock
mockSDK = {
generateDelegationToken: jest.fn(),
encodeApproveTransaction: jest.fn(),
completeEVMDelegation: jest.fn(),
};
mockUseCardSDK.mockReturnValue({
...jest.requireMock('../sdk'),
sdk: mockSDK as unknown as CardSDK,
});
// Setup metrics mock
mockBuild = jest.fn().mockReturnValue({ event: 'mock-event' });
mockAddProperties = jest.fn().mockReturnValue({ build: mockBuild });
mockCreateEventBuilder = jest.fn().mockReturnValue({
addProperties: mockAddProperties,
});
mockTrackEvent = jest.fn();
mockUseAnalytics.mockReturnValue(
createMockUseAnalyticsHook({
trackEvent: mockTrackEvent,
createEventBuilder: mockCreateEventBuilder,
}),
);
// Setup selector mock - returns a function that returns account
mockUseSelector.mockReturnValue(
jest.fn().mockReturnValue({
address: mockAddress,
}),
);
// Setup Engine mocks
Engine.context.KeyringController.signPersonalMessage = jest
.fn()
.mockResolvedValue(mockSignature);
Engine.context.TransactionController.addTransaction = jest
.fn()
.mockResolvedValue({
result: Promise.resolve(mockTxHash),
transactionMeta: {
id: 'transaction-meta-id-123',
},
});
Engine.context.NetworkController.findNetworkClientIdByChainId = jest
.fn()
.mockReturnValue(mockNetworkClientId);
// Setup controllerMessenger mock to simulate transaction confirmation
Engine.controllerMessenger.subscribeOnceIf = jest
.fn()
.mockImplementation((_eventName, callback, _filter) => {
// Immediately call the callback with a confirmed transaction
setImmediate(() => {
callback({
id: 'transaction-meta-id-123',
status: TransactionStatus.confirmed,
});
});
});
// Setup utility mocks
mockToTokenMinimalUnit.mockReturnValue('100000000000000000000');
mockSafeToChecksumAddress.mockImplementation(
(address?: string) => (address as `0x${string}`) || undefined,
);
// Setup SDK method mocks
mockSDK.generateDelegationToken.mockResolvedValue({
token: mockDelegationJWTToken,
nonce: mockNonce,
});
mockSDK.encodeApproveTransaction.mockReturnValue('0xencodedData');
mockSDK.completeEVMDelegation.mockResolvedValue({});
});
afterEach(() => {
jest.restoreAllMocks();
});
describe('initial state', () => {
it('initializes with correct default values', () => {
const { result } = renderHook(() => useCardDelegation());
expect(result.current.isLoading).toBe(false);
expect(result.current.error).toBeNull();
expect(typeof result.current.submitDelegation).toBe('function');
expect(result.current.needsFaucet).toBe(false);
expect(result.current.isFaucetCheckLoading).toBe(false);
expect(typeof result.current.refetchFaucetCheck).toBe('function');
});
it('accepts token parameter', () => {
const mockToken = createMockToken();
const { result } = renderHook(() => useCardDelegation(mockToken));
expect(result.current.isLoading).toBe(false);
expect(result.current.error).toBeNull();
});
it('works with null token', () => {
const { result } = renderHook(() => useCardDelegation(null));
expect(result.current.isLoading).toBe(false);
expect(result.current.error).toBeNull();
});
});
describe('submitDelegation', () => {
it('completes delegation flow for limited allowance', async () => {
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(result.current.isLoading).toBe(false);
expect(result.current.error).toBeNull();
expect(mockSDK.generateDelegationToken).toHaveBeenCalledWith(
params.network,
mockAddress,
false, // needsFaucet
);
expect(
Engine.context.KeyringController.signPersonalMessage,
).toHaveBeenCalled();
expect(mockSDK.encodeApproveTransaction).toHaveBeenCalled();
expect(
Engine.context.TransactionController.addTransaction,
).toHaveBeenCalled();
expect(mockSDK.completeEVMDelegation).toHaveBeenCalled();
});
it('completes delegation flow for full allowance', async () => {
const mockToken = createMockToken();
const params = {
...createMockDelegationParams(),
amount: ARBITRARY_ALLOWANCE.toString(),
};
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(result.current.isLoading).toBe(false);
expect(result.current.error).toBeNull();
expect(mockTrackEvent).toHaveBeenCalledWith(
expect.objectContaining({ event: 'mock-event' }),
);
});
it('sets loading state during delegation process', async () => {
const mockToken = createMockToken();
const params = createMockDelegationParams();
let resolveGenerateDelegation: (value: {
token: string;
nonce: string;
}) => void;
const generateDelegationPromise = new Promise<{
token: string;
nonce: string;
}>((resolve) => {
resolveGenerateDelegation = resolve;
});
mockSDK.generateDelegationToken.mockReturnValue(
generateDelegationPromise,
);
const { result } = renderHook(() => useCardDelegation(mockToken));
act(() => {
result.current.submitDelegation(params);
});
expect(result.current.isLoading).toBe(true);
expect(result.current.error).toBeNull();
await act(async () => {
resolveGenerateDelegation({
token: mockDelegationJWTToken,
nonce: mockNonce,
});
// Wait for promises to resolve
await new Promise((resolve) => setImmediate(resolve));
});
expect(result.current.isLoading).toBe(false);
});
it('uses stagingTokenAddress when present', async () => {
const mockToken = createMockToken({
stagingTokenAddress: '0xStagingToken123',
});
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(
Engine.context.TransactionController.addTransaction,
).toHaveBeenCalledWith(
expect.objectContaining({
to: '0xStagingToken123',
}),
expect.any(Object),
);
});
it('uses regular address when stagingTokenAddress is not present', async () => {
const mockToken = createMockToken({
address: '0xRegularToken123',
});
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(
Engine.context.TransactionController.addTransaction,
).toHaveBeenCalledWith(
expect.objectContaining({
to: '0xRegularToken123',
}),
expect.any(Object),
);
});
it('converts amount to minimal units correctly', async () => {
const mockToken = createMockToken({ decimals: 6 });
const params = createMockDelegationParams();
mockToTokenMinimalUnit.mockReturnValue('100000000');
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(mockToTokenMinimalUnit).toHaveBeenCalledWith(params.amount, 6);
expect(mockSDK.encodeApproveTransaction).toHaveBeenCalledWith(
mockToken.delegationContract,
'100000000',
);
});
it('uses default decimals of 18 when token decimals not provided', async () => {
const mockToken = createMockToken({ decimals: undefined });
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(mockToTokenMinimalUnit).toHaveBeenCalledWith(params.amount, 18);
});
it('calls completeEVMDelegation with correct parameters', async () => {
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(mockSDK.completeEVMDelegation).toHaveBeenCalledWith({
address: mockAddress,
network: params.network,
currency: params.currency.toLowerCase(),
amount: params.amount,
txHash: mockTxHash,
sigHash: mockSignature,
sigMessage: expect.any(String),
token: mockDelegationJWTToken,
});
});
});
describe('error handling', () => {
it('throws error when SDK is not available', async () => {
mockUseCardSDK.mockReturnValue({
...jest.requireMock('../sdk'),
sdk: null,
});
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation());
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
'Card SDK not available',
);
});
expect(result.current.isLoading).toBe(false);
});
it('throws error when token configuration is missing', async () => {
const mockToken = createMockToken({ delegationContract: undefined });
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
'Missing token configuration',
);
});
expect(result.current.error).toBe('Missing token configuration');
});
it('throws error when token address is missing', async () => {
const mockToken = createMockToken({
address: undefined,
stagingTokenAddress: undefined,
});
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
'Missing token address',
);
});
expect(result.current.error).toBe('Missing token address');
});
it('throws error when no account is found', async () => {
mockUseSelector.mockReturnValue(jest.fn().mockReturnValue(null));
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
'No account found',
);
});
expect(result.current.error).toBe('No account found');
});
it('handles error during token generation', async () => {
const error = new Error('Token generation failed');
mockSDK.generateDelegationToken.mockRejectedValue(error);
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
'Token generation failed',
);
});
expect(result.current.isLoading).toBe(false);
expect(result.current.error).toBe('Token generation failed');
expect(Logger.error).toHaveBeenCalledWith(
error,
'useCardDelegation: Delegation failed',
);
});
it('handles error during signature signing', async () => {
const error = new Error('Signature failed');
Engine.context.KeyringController.signPersonalMessage = jest
.fn()
.mockRejectedValue(error);
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
'Signature failed',
);
});
expect(result.current.error).toBe('Signature failed');
});
it('handles error during transaction submission', async () => {
const error = new Error('Transaction failed');
Engine.context.TransactionController.addTransaction = jest
.fn()
.mockRejectedValue(error);
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
'Transaction failed',
);
});
expect(result.current.error).toBe('Transaction failed');
});
it('handles error during delegation completion', async () => {
const error = new Error('Delegation completion failed');
mockSDK.completeEVMDelegation.mockRejectedValue(error);
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
let thrownError;
await act(async () => {
try {
await result.current.submitDelegation(params);
} catch (err) {
thrownError = err;
}
});
expect(thrownError).toEqual(error);
expect(result.current.error).toBe('Delegation completion failed');
});
it('handles delegation completion failure after transaction confirmation', async () => {
const completionError = new Error('API delegation completion failed');
mockSDK.completeEVMDelegation.mockRejectedValue(completionError);
const mockToken = createMockToken();
const params = createMockDelegationParams();
Engine.controllerMessenger.subscribeOnceIf = jest
.fn()
.mockImplementation((_eventName, callback) => {
// Immediately call the callback with a confirmed transaction
setImmediate(() => {
callback({
id: 'transaction-meta-id-123',
status: TransactionStatus.confirmed,
});
});
});
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
'API delegation completion failed',
);
});
expect(result.current.error).toBe('API delegation completion failed');
expect(Logger.error).toHaveBeenCalledWith(
completionError,
'Failed to complete EVM delegation',
);
// Transaction was confirmed but completion failed
expect(mockSDK.completeEVMDelegation).toHaveBeenCalled();
});
it('handles non-Error objects thrown during delegation', async () => {
mockSDK.generateDelegationToken.mockRejectedValue('String error');
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
try {
await result.current.submitDelegation(params);
} catch (error) {
// Expect the error to be re-thrown as-is (a string in this case)
expect(error).toBe('String error');
}
});
expect(result.current.error).toBe('Delegation failed');
});
});
describe('user cancellation', () => {
it('throws UserCancelledError when user denies transaction', async () => {
const error = new Error('User denied transaction signature');
Engine.context.TransactionController.addTransaction = jest
.fn()
.mockRejectedValue(error);
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
UserCancelledError,
);
});
expect(result.current.error).toBe('User denied transaction signature');
});
it('throws UserCancelledError when user rejects transaction', async () => {
const error = new Error('User rejected the request');
Engine.context.TransactionController.addTransaction = jest
.fn()
.mockRejectedValue(error);
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
UserCancelledError,
);
});
});
it('throws UserCancelledError when user cancels transaction', async () => {
const error = new Error('User cancelled transaction');
Engine.context.TransactionController.addTransaction = jest
.fn()
.mockRejectedValue(error);
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
UserCancelledError,
);
});
});
it('throws UserCancelledError when user cancels with alternate spelling', async () => {
const error = new Error('User canceled the transaction');
Engine.context.TransactionController.addTransaction = jest
.fn()
.mockRejectedValue(error);
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
UserCancelledError,
);
});
});
it('throws regular error for non-cancellation errors', async () => {
const error = new Error('Network connection failed');
Engine.context.TransactionController.addTransaction = jest
.fn()
.mockRejectedValue(error);
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
'Network connection failed',
);
});
expect(result.current.error).toBe('Network connection failed');
});
});
describe('metrics tracking', () => {
it('tracks delegation process started event', async () => {
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(mockCreateEventBuilder).toHaveBeenCalledWith(
MetaMetricsEvents.CARD_DELEGATION_PROCESS_STARTED,
);
expect(mockAddProperties).toHaveBeenCalledWith({
token_symbol: params.currency,
token_chain_id: params.network,
delegation_type: 'limited',
delegation_amount: 100,
faucet: false,
});
});
it('tracks delegation process completed event', async () => {
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(mockCreateEventBuilder).toHaveBeenCalledWith(
MetaMetricsEvents.CARD_DELEGATION_PROCESS_COMPLETED,
);
});
it('tracks delegation process failed event on error', async () => {
const error = new Error('Delegation failed');
mockSDK.generateDelegationToken.mockRejectedValue(error);
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow();
});
expect(mockCreateEventBuilder).toHaveBeenCalledWith(
MetaMetricsEvents.CARD_DELEGATION_PROCESS_FAILED,
);
});
it('tracks full delegation type for arbitrary allowance', async () => {
const mockToken = createMockToken();
const params = {
...createMockDelegationParams(),
amount: (ARBITRARY_ALLOWANCE + 1).toString(),
};
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(mockAddProperties).toHaveBeenCalledWith(
expect.objectContaining({
delegation_type: 'full',
}),
);
});
it('tracks zero delegation amount for NaN values', async () => {
const mockToken = createMockToken();
const params = {
...createMockDelegationParams(),
amount: 'invalid-number',
};
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(mockAddProperties).toHaveBeenCalledWith(
expect.objectContaining({
delegation_amount: 0,
}),
);
});
it('does not track failed event when user cancels transaction', async () => {
const error = new Error('User denied transaction signature');
Engine.context.TransactionController.addTransaction = jest
.fn()
.mockRejectedValue(error);
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await expect(result.current.submitDelegation(params)).rejects.toThrow(
UserCancelledError,
);
});
expect(mockCreateEventBuilder).toHaveBeenCalledWith(
MetaMetricsEvents.CARD_DELEGATION_PROCESS_USER_CANCELED,
);
expect(mockCreateEventBuilder).not.toHaveBeenCalledWith(
MetaMetricsEvents.CARD_DELEGATION_PROCESS_FAILED,
);
expect(Logger.error).not.toHaveBeenCalled();
});
});
describe('generateSignatureMessage', () => {
it('generates SIWE message with correct format', async () => {
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
const mockSignPersonalMessage = Engine.context.KeyringController
.signPersonalMessage as jest.MockedFunction<
typeof Engine.context.KeyringController.signPersonalMessage
>;
const signCallArgs = mockSignPersonalMessage.mock.calls[0][0];
const signedMessageHex = signCallArgs.data;
const signedMessage = Buffer.from(
signedMessageHex.slice(2),
'hex',
).toString('utf8');
expect(signedMessage).toContain(`${mockAddress}`);
expect(signedMessage).toContain('Chain ID: 59144');
expect(signedMessage).toContain(`Nonce: ${mockNonce}`);
expect(signedMessage).toContain('metamask.app.link wants you to sign in');
});
it('extracts chain ID from token caipChainId', async () => {
const mockToken = createMockToken({ caipChainId: 'eip155:1' });
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
const mockSignPersonalMessage = Engine.context.KeyringController
.signPersonalMessage as jest.MockedFunction<
typeof Engine.context.KeyringController.signPersonalMessage
>;
const signCallArgs = mockSignPersonalMessage.mock.calls[0][0];
const signedMessageHex = signCallArgs.data;
const signedMessage = Buffer.from(
signedMessageHex.slice(2),
'hex',
).toString('utf8');
expect(signedMessage).toContain('Chain ID: 1');
});
it('uses default chain ID when caipChainId is not provided', async () => {
const mockToken = createMockToken({ caipChainId: undefined });
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
const mockSignPersonalMessage = Engine.context.KeyringController
.signPersonalMessage as jest.MockedFunction<
typeof Engine.context.KeyringController.signPersonalMessage
>;
const signCallArgs = mockSignPersonalMessage.mock.calls[0][0];
const signedMessageHex = signCallArgs.data;
const signedMessage = Buffer.from(
signedMessageHex.slice(2),
'hex',
).toString('utf8');
expect(signedMessage).toContain('Chain ID: 59144');
});
});
describe('transaction parameters', () => {
it('creates transaction with correct parameters', async () => {
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(
Engine.context.TransactionController.addTransaction,
).toHaveBeenCalledWith(
{
from: mockAddress,
to: mockToken.address,
data: '0xencodedData',
},
{
networkClientId: mockNetworkClientId,
origin: TransactionTypes.MMM_CARD,
type: TransactionType.tokenMethodApprove,
deviceConfirmedOn: WalletDevice.MM_MOBILE,
requireApproval: true,
},
);
});
it('finds network client by chain ID', async () => {
const mockToken = createMockToken({ caipChainId: 'eip155:137' });
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(
Engine.context.NetworkController.findNetworkClientIdByChainId,
).toHaveBeenCalled();
});
it('subscribes to transaction confirmation event', async () => {
const mockToken = createMockToken();
const params = createMockDelegationParams();
const { result } = renderHook(() => useCardDelegation(mockToken));
await act(async () => {
await result.current.submitDelegation(params);
});
expect(Engine.controllerMessenger.subscribeOnceIf).toHaveBeenCalledWith(
'TransactionController:transactionConfirmed',
expect.any(Function),
expect.any(Function),
);