-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Expand file tree
/
Copy pathLedger.test.ts
More file actions
855 lines (740 loc) · 30.7 KB
/
Ledger.test.ts
File metadata and controls
855 lines (740 loc) · 30.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
import {
closeRunningAppOnLedger,
connectLedgerHardware,
forgetLedger,
getDeviceId,
getHDPath,
getLedgerAccounts,
getLedgerAccountsByOperation,
isValidPath,
ledgerSignTypedMessage,
openEthereumAppOnLedger,
setHDPath,
unlockLedgerWalletAccount,
checkAccountNameExists,
} from './Ledger';
import Engine from '../../core/Engine';
import { SignTypedDataVersion } from '@metamask/keyring-controller';
import type BleTransport from '@ledgerhq/react-native-hw-transport-ble';
import PAGINATION_OPERATIONS from '../../constants/pagination';
import {
LEDGER_BIP44_PATH,
LEDGER_LEGACY_PATH,
LEDGER_LIVE_PATH,
} from './constants';
import { removeAccountsFromPermissions } from '../../core/Permissions';
jest.mock('../../core/Engine', () => ({
context: {
KeyringController: {
signTypedMessage: jest.fn(),
withKeyring: jest.fn(),
},
AccountsController: {
state: {
internalAccounts: {
accounts: {},
},
},
getAccountByAddress: jest.fn(),
},
},
setSelectedAddress: jest.fn(),
}));
const MockEngine = jest.mocked(Engine);
jest.mock('../../core/Permissions', () => ({
removeAccountsFromPermissions: jest.fn(),
}));
const MockRemoveAccountsFromPermissions = jest.mocked(
removeAccountsFromPermissions,
);
interface mockKeyringType {
addAccounts: jest.Mock;
getAccounts: jest.Mock;
bridge: {
getAppNameAndVersion: jest.Mock;
updateTransportMethod: jest.Mock;
openEthApp: jest.Mock;
closeApps: jest.Mock;
};
deserialize: jest.Mock;
forgetDevice: jest.Mock;
getDeviceId: jest.Mock;
getFirstPage: jest.Mock;
getNextPage: jest.Mock;
getPreviousPage: jest.Mock;
setDeviceId: jest.Mock;
setHdPath: jest.Mock;
hdPath: string;
setAccountToUnlock: jest.Mock;
}
describe('Ledger core', () => {
let ledgerKeyring: mockKeyringType;
beforeEach(() => {
jest.resetAllMocks();
// Reset AccountsController state that may have been modified by previous tests
MockEngine.context.AccountsController.state.internalAccounts.accounts = {};
const mockKeyringController = MockEngine.context.KeyringController;
ledgerKeyring = {
addAccounts: jest
.fn()
.mockResolvedValue(['0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB2']),
bridge: {
getAppNameAndVersion: jest
.fn()
.mockResolvedValue({ appName: 'appName' }),
updateTransportMethod: jest.fn(),
openEthApp: jest.fn(),
closeApps: jest.fn(),
},
deserialize: jest.fn(),
forgetDevice: jest.fn(),
getDeviceId: jest.fn().mockReturnValue('deviceId'),
getFirstPage: jest.fn().mockResolvedValue([
{
balance: '0',
address: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB2',
index: 0,
},
{
balance: '1',
address: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB3',
index: 1,
},
]),
getNextPage: jest.fn().mockResolvedValue([
{
balance: '4',
address: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB4',
index: 4,
},
{
balance: '5',
address: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB5',
index: 5,
},
]),
getPreviousPage: jest.fn().mockResolvedValue([
{
balance: '2',
address: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB6',
index: 2,
},
{
balance: '3',
address: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB7',
index: 3,
},
]),
setDeviceId: jest.fn(),
setHdPath: jest.fn(),
hdPath: LEDGER_LIVE_PATH,
setAccountToUnlock: jest.fn(),
getAccounts: jest
.fn()
.mockResolvedValue([
'0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB2',
'0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB3',
]),
};
mockKeyringController.withKeyring.mockImplementation(
(_selector, operation) =>
// @ts-expect-error The Ledger keyring is not compatible with our keyring type yet
operation({ keyring: ledgerKeyring, metadata: { id: '1234' } }),
);
mockKeyringController.signTypedMessage.mockResolvedValue('signature');
});
describe('connectLedgerHardware', () => {
const mockTransport = 'foo' as unknown as BleTransport;
it('calls keyring.setTransport', async () => {
await connectLedgerHardware(mockTransport, 'bar');
expect(ledgerKeyring.bridge.updateTransportMethod).toHaveBeenCalled();
});
it('calls keyring.getAppAndVersion', async () => {
await connectLedgerHardware(mockTransport, 'bar');
expect(ledgerKeyring.bridge.getAppNameAndVersion).toHaveBeenCalled();
});
it('returns app name correctly', async () => {
const value = await connectLedgerHardware(mockTransport, 'bar');
expect(value).toBe('appName');
});
it('calls keyring.setHdPath and keyring.setDeviceId if deviceId is different', async () => {
await connectLedgerHardware(mockTransport, 'bar');
expect(ledgerKeyring.setHdPath).toHaveBeenCalled();
expect(ledgerKeyring.setDeviceId).toHaveBeenCalled();
});
});
describe('openEthereumAppOnLedger', () => {
it('calls keyring.openEthApp', async () => {
await openEthereumAppOnLedger();
expect(ledgerKeyring.bridge.openEthApp).toHaveBeenCalled();
});
});
describe('closeRunningAppOnLedger', () => {
it('calls keyring.quitApp', async () => {
await closeRunningAppOnLedger();
expect(ledgerKeyring.bridge.closeApps).toHaveBeenCalled();
});
});
describe('forgetLedger', () => {
it('removes the accounts from existing permissions', async () => {
await forgetLedger();
expect(MockRemoveAccountsFromPermissions).toHaveBeenCalledWith([
'0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB2',
'0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB3',
]);
});
it('calls keyring.forgetDevice', async () => {
await forgetLedger();
expect(ledgerKeyring.forgetDevice).toHaveBeenCalled();
});
});
describe('getDeviceId', () => {
it('returns deviceId', async () => {
const value = await getDeviceId();
expect(value).toBe('deviceId');
});
});
describe('isValidHDPath', () => {
it('returns true for valid HD path', () => {
expect(isValidPath(LEDGER_LIVE_PATH)).toBeTruthy();
expect(isValidPath(LEDGER_BIP44_PATH)).toBeTruthy();
expect(isValidPath(LEDGER_LEGACY_PATH)).toBeTruthy();
});
it('returns false for invalid HD path', () => {
expect(isValidPath('')).toBeFalsy();
expect(isValidPath('Invalid')).toBeFalsy();
expect(isValidPath('m/44/60/0')).toBeFalsy();
});
});
describe('setHDPath', () => {
it('calls keyring.setHdPath with valid HD path', async () => {
await setHDPath(LEDGER_LIVE_PATH);
expect(ledgerKeyring.setHdPath).toHaveBeenCalledWith(LEDGER_LIVE_PATH);
});
it('calls keyring.setHdPath with LEDGER_BIP44_PATH', async () => {
await setHDPath(LEDGER_BIP44_PATH);
expect(ledgerKeyring.setHdPath).toHaveBeenCalledWith(LEDGER_BIP44_PATH);
});
it('calls keyring.setHdPath with LEDGER_LEGACY_PATH', async () => {
await setHDPath(LEDGER_LEGACY_PATH);
expect(ledgerKeyring.setHdPath).toHaveBeenCalledWith(LEDGER_LEGACY_PATH);
});
it('throws error with invalid HD path', async () => {
await expect(setHDPath('')).rejects.toThrow('HD Path is invalid: ');
});
it("throws error with path not starting with m/44'/60'", async () => {
await expect(setHDPath("m/44'/61'/0'")).rejects.toThrow(
"HD Path is invalid: m/44'/61'/0'",
);
});
it('throws error with arbitrary path even if starts correctly', async () => {
await expect(setHDPath("m/44'/60'/999'/0'/0")).rejects.toThrow(
"HD Path is invalid: m/44'/60'/999'/0'/0",
);
});
});
describe('getHDPath', () => {
it('calls keyring.getHdPath', async () => {
const path = await getHDPath();
expect(path).toBe(LEDGER_LIVE_PATH);
});
});
describe('getLedgerAccounts', () => {
it('calls keyring.getAccounts', async () => {
const accounts = await getLedgerAccounts();
expect(ledgerKeyring.getAccounts).toHaveBeenCalled();
expect(accounts).toEqual([
'0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB2',
'0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB3',
]);
});
});
describe('getLedgerAccountsByOperation', () => {
it('calls ledgerKeyring.getNextPage on ledgerKeyring', async () => {
await getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_NEXT_PAGE);
expect(ledgerKeyring.getNextPage).toHaveBeenCalled();
});
it('calls getPreviousPage on ledgerKeyring', async () => {
await getLedgerAccountsByOperation(
PAGINATION_OPERATIONS.GET_PREVIOUS_PAGE,
);
expect(ledgerKeyring.getPreviousPage).toHaveBeenCalled();
});
it('calls getFirstPage on ledgerKeyring', async () => {
await getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE);
expect(ledgerKeyring.getFirstPage).toHaveBeenCalled();
});
it('calls getFirstPage for unknown operation values', async () => {
await getLedgerAccountsByOperation(999);
expect(ledgerKeyring.getFirstPage).toHaveBeenCalled();
});
it('returns accounts with balance set to 0x0', async () => {
const accounts = await getLedgerAccountsByOperation(
PAGINATION_OPERATIONS.GET_FIRST_PAGE,
);
expect(accounts).toEqual([
{
balance: '0x0',
address: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB2',
index: 0,
},
{
balance: '0x0',
address: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB3',
index: 1,
},
]);
});
it('returns next page accounts with balance set to 0x0', async () => {
const accounts = await getLedgerAccountsByOperation(
PAGINATION_OPERATIONS.GET_NEXT_PAGE,
);
expect(accounts).toEqual([
{
balance: '0x0',
address: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB4',
index: 4,
},
{
balance: '0x0',
address: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB5',
index: 5,
},
]);
});
it('returns previous page accounts with balance set to 0x0', async () => {
const accounts = await getLedgerAccountsByOperation(
PAGINATION_OPERATIONS.GET_PREVIOUS_PAGE,
);
expect(accounts).toEqual([
{
balance: '0x0',
address: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB6',
index: 2,
},
{
balance: '0x0',
address: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB7',
index: 3,
},
]);
});
it('throws ETH app not open error when TransportStatusError with 0x6d00', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x6d00;
ledgerKeyring.getFirstPage.mockRejectedValueOnce(transportError);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws ETH app not open error when TransportStatusError with 0x6e00', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x6e00;
ledgerKeyring.getNextPage.mockRejectedValueOnce(transportError);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_NEXT_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws ETH app not open error when TransportStatusError with 0x650f', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x650f;
ledgerKeyring.getFirstPage.mockRejectedValueOnce(transportError);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws ETH app not open error when error message contains 0x650f', async () => {
const error = new Error('Ledger device: UNKNOWN_ERROR (0x650f)');
ledgerKeyring.getFirstPage.mockRejectedValueOnce(error);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws unspecified error for other errors', async () => {
ledgerKeyring.getFirstPage.mockRejectedValueOnce(
new Error('Some other error'),
);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Unspecified error when connect Ledger Hardware,');
});
it('throws ETH app not open error when TransportStatusError with 0x6e01', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x6e01;
ledgerKeyring.getFirstPage.mockRejectedValueOnce(transportError);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws ETH app not open error when TransportStatusError with 0x6511', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x6511;
ledgerKeyring.getPreviousPage.mockRejectedValueOnce(transportError);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_PREVIOUS_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws ETH app not open error when TransportStatusError with 0x6700', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x6700;
ledgerKeyring.getFirstPage.mockRejectedValueOnce(transportError);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws ETH app not open error when error message contains 0x6511', async () => {
const error = new Error('Ledger device: APP_NOT_OPEN (0x6511)');
ledgerKeyring.getFirstPage.mockRejectedValueOnce(error);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws ETH app not open error when error message contains 0x6d00', async () => {
const error = new Error('TransportError: CLA_NOT_SUPPORTED (0x6d00)');
ledgerKeyring.getNextPage.mockRejectedValueOnce(error);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_NEXT_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws ETH app not open error when error message contains 0x6e00', async () => {
const error = new Error('TransportError: INS_NOT_SUPPORTED (0x6e00)');
ledgerKeyring.getFirstPage.mockRejectedValueOnce(error);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws ETH app not open error when error message contains 0x6e01', async () => {
const error = new Error('Ledger: INS_NOT_SUPPORTED variant (0x6e01)');
ledgerKeyring.getFirstPage.mockRejectedValueOnce(error);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws ETH app not open error when error message contains 0x6700', async () => {
const error = new Error('Ledger: INCORRECT_LENGTH (0x6700)');
ledgerKeyring.getFirstPage.mockRejectedValueOnce(error);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws ETH app not open error for unknown_error pattern with 0x650f', async () => {
const error = new Error('ledger device: unknown_error (0x650f)');
ledgerKeyring.getFirstPage.mockRejectedValueOnce(error);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('throws ETH app not open error for unknown_error pattern with 0x6511', async () => {
const error = new Error('ledger device: unknown_error (0x6511)');
ledgerKeyring.getFirstPage.mockRejectedValueOnce(error);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Please open the Ethereum app on your Ledger device.');
});
it('does not throw ETH app not open error for non-matching status codes', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x1234; // Non-matching code
ledgerKeyring.getFirstPage.mockRejectedValueOnce(transportError);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Unspecified error when connect Ledger Hardware,');
});
it('does not throw ETH app not open error for non-Error objects', async () => {
ledgerKeyring.getFirstPage.mockRejectedValueOnce('string error');
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Unspecified error when connect Ledger Hardware,');
});
it('throws disconnect error for DisconnectedDevice', async () => {
const disconnectError = new Error('Disconnected during operation');
disconnectError.name = 'DisconnectedDevice';
ledgerKeyring.getFirstPage.mockRejectedValueOnce(disconnectError);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_FIRST_PAGE),
).rejects.toThrow('Your device got disconnected');
});
it('throws disconnect error for DisconnectedDeviceDuringOperation', async () => {
const disconnectError = new Error('Lost connection');
disconnectError.name = 'DisconnectedDeviceDuringOperation';
ledgerKeyring.getNextPage.mockRejectedValueOnce(disconnectError);
await expect(
getLedgerAccountsByOperation(PAGINATION_OPERATIONS.GET_NEXT_PAGE),
).rejects.toThrow('Your device got disconnected');
});
});
describe('ledgerSignTypedMessage', () => {
it('calls signTypedMessage from keyring controller and return correct signature', async () => {
const expectedArg = {
from: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB2',
data: 'data',
};
const value = await ledgerSignTypedMessage(
expectedArg,
SignTypedDataVersion.V4,
);
expect(
MockEngine.context.KeyringController.signTypedMessage,
).toHaveBeenCalledWith(expectedArg, SignTypedDataVersion.V4);
expect(value).toBe('signature');
});
it('handles Record<string, unknown> data type', async () => {
const expectedArg = {
from: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB2',
data: { message: 'test', value: 123 },
};
const value = await ledgerSignTypedMessage(
expectedArg,
SignTypedDataVersion.V4,
);
expect(
MockEngine.context.KeyringController.signTypedMessage,
).toHaveBeenCalledWith(expectedArg, SignTypedDataVersion.V4);
expect(value).toBe('signature');
});
it('handles Record<string, unknown>[] data type', async () => {
const expectedArg = {
from: '0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB2',
data: [{ type: 'string', name: 'test' }],
};
const value = await ledgerSignTypedMessage(
expectedArg,
SignTypedDataVersion.V3,
);
expect(
MockEngine.context.KeyringController.signTypedMessage,
).toHaveBeenCalledWith(expectedArg, SignTypedDataVersion.V3);
expect(value).toBe('signature');
});
});
describe('checkAccountNameExists', () => {
it('returns true when account name exists', async () => {
MockEngine.context.AccountsController.state.internalAccounts.accounts = {
'account-1': {
metadata: {
name: 'Test Account',
importTime: 0,
keyring: { type: 'Ledger' },
},
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any;
const result = await checkAccountNameExists('Test Account');
expect(result).toBe(true);
});
it('returns false when account name does not exist', async () => {
MockEngine.context.AccountsController.state.internalAccounts.accounts = {
'account-1': {
metadata: {
name: 'Test Account',
importTime: 0,
keyring: { type: 'Ledger' },
},
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any;
const result = await checkAccountNameExists('Non-existent Account');
expect(result).toBe(false);
});
it('returns false when accounts list is empty', async () => {
MockEngine.context.AccountsController.state.internalAccounts.accounts =
{};
const result = await checkAccountNameExists('Any Account');
expect(result).toBe(false);
});
});
describe(`unlockLedgerWalletAccount`, () => {
const mockAccountsController = MockEngine.context.AccountsController;
mockAccountsController.getAccountByAddress.mockReturnValue({
// @ts-expect-error: The account metadata type is hard to mock
metadata: {
name: 'Ledger 1',
},
});
it(`calls keyring.setAccountToUnlock and addAccounts`, async () => {
await unlockLedgerWalletAccount(1);
expect(ledgerKeyring.setAccountToUnlock).toHaveBeenCalled();
expect(ledgerKeyring.addAccounts).toHaveBeenCalledWith(1);
});
it('sets the newly unlocked account as selected address', async () => {
await unlockLedgerWalletAccount(1);
expect(MockEngine.setSelectedAddress).toHaveBeenCalledWith(
'0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB2',
);
});
it('calls setAccountName when account name differs from expected name', async () => {
mockAccountsController.state.internalAccounts.accounts = {};
mockAccountsController.getAccountByAddress.mockReturnValue({
id: 'account-id-123',
metadata: {
name: 'Different Name',
importTime: 0,
keyring: { type: 'Ledger' },
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any);
(
mockAccountsController as unknown as { setAccountName: jest.Mock }
).setAccountName = jest.fn();
await unlockLedgerWalletAccount(1);
expect(
(mockAccountsController as unknown as { setAccountName: jest.Mock })
.setAccountName,
).toHaveBeenCalledWith('account-id-123', 'Ledger 3');
});
it('does not call setAccountName when account name matches expected name', async () => {
mockAccountsController.state.internalAccounts.accounts = {};
mockAccountsController.getAccountByAddress.mockReturnValue({
id: 'account-id-123',
metadata: {
name: 'Ledger 3',
importTime: 0,
keyring: { type: 'Ledger' },
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any);
(
mockAccountsController as unknown as { setAccountName: jest.Mock }
).setAccountName = jest.fn();
await unlockLedgerWalletAccount(1);
expect(
(mockAccountsController as unknown as { setAccountName: jest.Mock })
.setAccountName,
).not.toHaveBeenCalled();
});
it('handles case when getAccountByAddress returns undefined', async () => {
mockAccountsController.state.internalAccounts.accounts = {};
mockAccountsController.getAccountByAddress.mockReturnValue(undefined);
(
mockAccountsController as unknown as { setAccountName: jest.Mock }
).setAccountName = jest.fn();
await unlockLedgerWalletAccount(1);
expect(
(mockAccountsController as unknown as { setAccountName: jest.Mock })
.setAccountName,
).not.toHaveBeenCalled();
expect(MockEngine.setSelectedAddress).toHaveBeenCalledWith(
'0x49b6FFd1BD9d1c64EEf400a64a1e4bBC33E2CAB2',
);
});
it(`throws an error if the account name has already exists`, async () => {
mockAccountsController.state.internalAccounts.accounts = {
'existing-account': {
metadata: {
name: 'Ledger 3',
importTime: 0,
keyring: { type: 'Ledger' },
},
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any;
await expect(unlockLedgerWalletAccount(1)).rejects.toThrow(
'Account Ledger 3 already exists',
);
});
it('throws ETH app not open error when TransportStatusError with 0x6d00', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x6d00;
ledgerKeyring.addAccounts.mockRejectedValueOnce(transportError);
await expect(unlockLedgerWalletAccount(1)).rejects.toThrow(
'Please open the Ethereum app on your Ledger device.',
);
});
it('throws ETH app not open error when TransportStatusError with 0x6e00', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x6e00;
ledgerKeyring.addAccounts.mockRejectedValueOnce(transportError);
await expect(unlockLedgerWalletAccount(1)).rejects.toThrow(
'Please open the Ethereum app on your Ledger device.',
);
});
it('throws ETH app not open error when TransportStatusError with 0x6e01', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x6e01;
ledgerKeyring.addAccounts.mockRejectedValueOnce(transportError);
await expect(unlockLedgerWalletAccount(1)).rejects.toThrow(
'Please open the Ethereum app on your Ledger device.',
);
});
it('throws ETH app not open error when TransportStatusError with 0x6511', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x6511;
ledgerKeyring.addAccounts.mockRejectedValueOnce(transportError);
await expect(unlockLedgerWalletAccount(1)).rejects.toThrow(
'Please open the Ethereum app on your Ledger device.',
);
});
it('throws ETH app not open error when TransportStatusError with 0x6700', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x6700;
ledgerKeyring.addAccounts.mockRejectedValueOnce(transportError);
await expect(unlockLedgerWalletAccount(1)).rejects.toThrow(
'Please open the Ethereum app on your Ledger device.',
);
});
it('throws ETH app not open error when TransportStatusError with 0x650f', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x650f;
ledgerKeyring.addAccounts.mockRejectedValueOnce(transportError);
await expect(unlockLedgerWalletAccount(1)).rejects.toThrow(
'Please open the Ethereum app on your Ledger device.',
);
});
it('throws ETH app not open error when error message contains 0x650f', async () => {
const error = new Error('Ledger device: UNKNOWN_ERROR (0x650f)');
ledgerKeyring.addAccounts.mockRejectedValueOnce(error);
await expect(unlockLedgerWalletAccount(1)).rejects.toThrow(
'Please open the Ethereum app on your Ledger device.',
);
});
it('throws ETH app not open error when error message contains 0x6511', async () => {
const error = new Error('Ledger device: APP_NOT_OPEN (0x6511)');
ledgerKeyring.addAccounts.mockRejectedValueOnce(error);
await expect(unlockLedgerWalletAccount(1)).rejects.toThrow(
'Please open the Ethereum app on your Ledger device.',
);
});
it('throws original error for non-ETH app not open errors', async () => {
const error = new Error('Some other error');
ledgerKeyring.addAccounts.mockRejectedValueOnce(error);
await expect(unlockLedgerWalletAccount(1)).rejects.toThrow(
'Some other error',
);
});
it('does not throw ETH app not open error for non-matching status codes', async () => {
const transportError = new Error('TransportStatusError');
transportError.name = 'TransportStatusError';
// @ts-expect-error statusCode is a custom property on TransportStatusError
transportError.statusCode = 0x1234; // Non-matching code
ledgerKeyring.addAccounts.mockRejectedValueOnce(transportError);
await expect(unlockLedgerWalletAccount(1)).rejects.toThrow(
'TransportStatusError',
);
});
});
});