|
| 1 | +import type { HdKeyring } from '@metamask/eth-hd-keyring'; |
| 2 | +import { KeyringTypes } from '@metamask/keyring-controller'; |
| 3 | +import type { KeyringObject } from '@metamask/keyring-controller'; |
| 4 | +import type { |
| 5 | + MessengerActions, |
| 6 | + MessengerEvents, |
| 7 | + MockAnyNamespace, |
| 8 | +} from '@metamask/messenger'; |
| 9 | +import { Messenger, MOCK_ANY_NAMESPACE } from '@metamask/messenger'; |
| 10 | + |
| 11 | +import { CashAccountService, serviceName } from './CashAccountService'; |
| 12 | +import type { CashAccountServiceMessenger } from './types'; |
| 13 | + |
| 14 | +type AllActions = MessengerActions<CashAccountServiceMessenger>; |
| 15 | +type AllEvents = MessengerEvents<CashAccountServiceMessenger>; |
| 16 | + |
| 17 | +type RootMessenger = Messenger<MockAnyNamespace, AllActions, AllEvents>; |
| 18 | + |
| 19 | +const MOCK_MNEMONIC = new Uint8Array([ |
| 20 | + 116, 101, 115, 116, 32, 116, 101, 115, 116, 32, 116, 101, 115, 116, 32, 116, |
| 21 | + 101, 115, 116, 32, 116, 101, 115, 116, 32, 116, 101, 115, 116, 32, 116, 101, |
| 22 | + 115, 116, 32, 116, 101, 115, 116, 32, 116, 101, 115, 116, 32, 116, 101, 115, |
| 23 | + 116, 32, 116, 101, 115, 116, 32, 106, 117, 110, 107, |
| 24 | +]); |
| 25 | + |
| 26 | +const MOCK_ENTROPY_SOURCE = 'mock-entropy-source-id'; |
| 27 | + |
| 28 | +const MOCK_HD_KEYRING: KeyringObject = { |
| 29 | + type: KeyringTypes.hd, |
| 30 | + accounts: ['0x1234'], |
| 31 | + metadata: { id: MOCK_ENTROPY_SOURCE, name: '' }, |
| 32 | +}; |
| 33 | + |
| 34 | +function setup(): { |
| 35 | + service: CashAccountService; |
| 36 | + rootMessenger: RootMessenger; |
| 37 | + mocks: { |
| 38 | + getState: jest.Mock; |
| 39 | + getKeyringsByType: jest.Mock; |
| 40 | + addNewKeyring: jest.Mock; |
| 41 | + }; |
| 42 | +} { |
| 43 | + const rootMessenger: RootMessenger = new Messenger({ |
| 44 | + namespace: MOCK_ANY_NAMESPACE, |
| 45 | + captureException: jest.fn(), |
| 46 | + }); |
| 47 | + |
| 48 | + const messenger: CashAccountServiceMessenger = new Messenger({ |
| 49 | + namespace: serviceName, |
| 50 | + parent: rootMessenger, |
| 51 | + }); |
| 52 | + |
| 53 | + rootMessenger.delegate({ |
| 54 | + messenger, |
| 55 | + actions: [ |
| 56 | + 'KeyringController:getState', |
| 57 | + 'KeyringController:getKeyringsByType', |
| 58 | + 'KeyringController:addNewKeyring', |
| 59 | + ], |
| 60 | + events: [], |
| 61 | + }); |
| 62 | + |
| 63 | + const mocks = { |
| 64 | + getState: jest.fn().mockReturnValue({ |
| 65 | + isUnlocked: true, |
| 66 | + keyrings: [MOCK_HD_KEYRING], |
| 67 | + }), |
| 68 | + getKeyringsByType: jest |
| 69 | + .fn() |
| 70 | + .mockReturnValue([{ mnemonic: MOCK_MNEMONIC } as unknown as HdKeyring]), |
| 71 | + addNewKeyring: jest.fn().mockResolvedValue({ |
| 72 | + id: 'new-cash-keyring-id', |
| 73 | + name: '', |
| 74 | + }), |
| 75 | + }; |
| 76 | + |
| 77 | + rootMessenger.registerActionHandler( |
| 78 | + 'KeyringController:getState', |
| 79 | + mocks.getState, |
| 80 | + ); |
| 81 | + rootMessenger.registerActionHandler( |
| 82 | + 'KeyringController:getKeyringsByType', |
| 83 | + mocks.getKeyringsByType, |
| 84 | + ); |
| 85 | + rootMessenger.registerActionHandler( |
| 86 | + 'KeyringController:addNewKeyring', |
| 87 | + mocks.addNewKeyring, |
| 88 | + ); |
| 89 | + |
| 90 | + const service = new CashAccountService({ messenger }); |
| 91 | + |
| 92 | + return { service, rootMessenger, mocks }; |
| 93 | +} |
| 94 | + |
| 95 | +describe('CashAccountService', () => { |
| 96 | + describe('createCashAccount', () => { |
| 97 | + it('creates a Cash keyring from the HD keyring mnemonic', async () => { |
| 98 | + const { service, mocks } = setup(); |
| 99 | + |
| 100 | + const result = await service.createCashAccount(MOCK_ENTROPY_SOURCE); |
| 101 | + |
| 102 | + expect(mocks.getKeyringsByType).toHaveBeenCalledWith(KeyringTypes.hd); |
| 103 | + expect(mocks.addNewKeyring).toHaveBeenCalledWith(KeyringTypes.cash, { |
| 104 | + mnemonic: MOCK_MNEMONIC, |
| 105 | + }); |
| 106 | + expect(result).toStrictEqual({ id: 'new-cash-keyring-id', name: '' }); |
| 107 | + }); |
| 108 | + |
| 109 | + it('is callable via the messenger', async () => { |
| 110 | + const { rootMessenger } = setup(); |
| 111 | + |
| 112 | + const result = await rootMessenger.call( |
| 113 | + 'CashAccountService:createCashAccount', |
| 114 | + MOCK_ENTROPY_SOURCE, |
| 115 | + ); |
| 116 | + |
| 117 | + expect(result).toStrictEqual({ id: 'new-cash-keyring-id', name: '' }); |
| 118 | + }); |
| 119 | + |
| 120 | + it('throws if no HD keyring matches the entropy source', async () => { |
| 121 | + const { service } = setup(); |
| 122 | + |
| 123 | + await expect( |
| 124 | + service.createCashAccount('nonexistent-entropy-source'), |
| 125 | + ).rejects.toThrow( |
| 126 | + 'No HD keyring found for entropy source: nonexistent-entropy-source', |
| 127 | + ); |
| 128 | + }); |
| 129 | + |
| 130 | + it('throws if the HD keyring has no mnemonic', async () => { |
| 131 | + const { service, mocks } = setup(); |
| 132 | + |
| 133 | + mocks.getKeyringsByType.mockReturnValue([ |
| 134 | + { mnemonic: null } as unknown as HdKeyring, |
| 135 | + ]); |
| 136 | + |
| 137 | + await expect( |
| 138 | + service.createCashAccount(MOCK_ENTROPY_SOURCE), |
| 139 | + ).rejects.toThrow( |
| 140 | + 'HD keyring does not have a mnemonic for the given entropy source.', |
| 141 | + ); |
| 142 | + }); |
| 143 | + }); |
| 144 | +}); |
0 commit comments