aboutsummaryrefslogtreecommitdiffstats
path: root/packages/subproviders/test/integration/ledger_subprovider_test.ts
blob: 196cecf3293969d7bf28bd0965a11145a09646f7 (plain) (blame)
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
import { DoneCallback } from '@0xproject/types';
import { promisify } from '@0xproject/utils';
import Eth from '@ledgerhq/hw-app-eth';
// HACK: This dependency is optional and tslint skips optional dependencies
// tslint:disable-next-line:no-implicit-dependencies
import TransportNodeHid from '@ledgerhq/hw-transport-node-hid';
import * as chai from 'chai';
import { JSONRPCResponsePayload } from 'ethereum-types';
import * as ethUtils from 'ethereumjs-util';
import Web3ProviderEngine = require('web3-provider-engine');
import RpcSubprovider = require('web3-provider-engine/subproviders/rpc');

import { LedgerSubprovider } from '../../src';
import { LedgerEthereumClient } from '../../src/types';
import { chaiSetup } from '../chai_setup';
import { fixtureData } from '../utils/fixture_data';
import { reportCallbackErrors } from '../utils/report_callback_errors';

chaiSetup.configure();
const expect = chai.expect;
const DEFAULT_NUM_ACCOUNTS = 10;
const EXPECTED_SIGNATURE_LENGTH = 132;

async function ledgerEthereumNodeJsClientFactoryAsync(): Promise<LedgerEthereumClient> {
    const ledgerConnection = await TransportNodeHid.create();
    const ledgerEthClient = new Eth(ledgerConnection);
    return ledgerEthClient;
}

describe('LedgerSubprovider', () => {
    let ledgerSubprovider: LedgerSubprovider;
    const networkId: number = fixtureData.NETWORK_ID;
    before(async () => {
        ledgerSubprovider = new LedgerSubprovider({
            networkId,
            ledgerEthereumClientFactoryAsync: ledgerEthereumNodeJsClientFactoryAsync,
            baseDerivationPath: fixtureData.TESTRPC_BASE_DERIVATION_PATH,
        });
    });
    describe('direct method calls', () => {
        it('returns default number of accounts', async () => {
            const accounts = await ledgerSubprovider.getAccountsAsync();
            expect(accounts[0]).to.not.be.an('undefined');
            expect(accounts.length).to.be.equal(DEFAULT_NUM_ACCOUNTS);
        });
        it('returns the expected accounts from a ledger set up with the test mnemonic', async () => {
            const accounts = await ledgerSubprovider.getAccountsAsync();
            expect(accounts[0]).to.be.equal(fixtureData.TEST_RPC_ACCOUNT_0);
            expect(accounts[1]).to.be.equal(fixtureData.TEST_RPC_ACCOUNT_1);
        });
        it('returns requested number of accounts', async () => {
            const numberOfAccounts = 20;
            const accounts = await ledgerSubprovider.getAccountsAsync(numberOfAccounts);
            expect(accounts[0]).to.not.be.an('undefined');
            expect(accounts.length).to.be.equal(numberOfAccounts);
        });
        it('signs a personal message', async () => {
            const data = ethUtils.bufferToHex(ethUtils.toBuffer(fixtureData.PERSONAL_MESSAGE_STRING));
            const ecSignatureHex = await ledgerSubprovider.signPersonalMessageAsync(
                data,
                fixtureData.TEST_RPC_ACCOUNT_0,
            );
            expect(ecSignatureHex).to.be.equal(fixtureData.PERSONAL_MESSAGE_SIGNED_RESULT);
        });
        it('signs a personal message with second address', async () => {
            const data = ethUtils.bufferToHex(ethUtils.toBuffer(fixtureData.PERSONAL_MESSAGE_STRING));
            const ecSignatureHex = await ledgerSubprovider.signPersonalMessageAsync(
                data,
                fixtureData.TEST_RPC_ACCOUNT_1,
            );
            expect(ecSignatureHex).to.be.equal(fixtureData.PERSONAL_MESSAGE_ACCOUNT_1_SIGNED_RESULT);
        });
        it('signs a transaction', async () => {
            const txHex = await ledgerSubprovider.signTransactionAsync(fixtureData.TX_DATA);
            expect(txHex).to.be.equal(fixtureData.TX_DATA_SIGNED_RESULT);
        });
        it('signs a transaction with the second address', async () => {
            const txData = { ...fixtureData.TX_DATA, from: fixtureData.TEST_RPC_ACCOUNT_1 };
            const txHex = await ledgerSubprovider.signTransactionAsync(txData);
            expect(txHex).to.be.equal(fixtureData.TX_DATA_ACCOUNT_1_SIGNED_RESULT);
        });
    });
    describe('calls through a provider', () => {
        let defaultProvider: Web3ProviderEngine;
        let ledgerProvider: Web3ProviderEngine;
        before(() => {
            ledgerProvider = new Web3ProviderEngine();
            ledgerProvider.addProvider(ledgerSubprovider);
            const httpProvider = new RpcSubprovider({
                rpcUrl: 'http://localhost:8545',
            });
            ledgerProvider.addProvider(httpProvider);
            ledgerProvider.start();

            defaultProvider = new Web3ProviderEngine();
            defaultProvider.addProvider(httpProvider);
            defaultProvider.start();
        });
        it('returns a list of accounts', (done: DoneCallback) => {
            const payload = {
                jsonrpc: '2.0',
                method: 'eth_accounts',
                params: [],
                id: 1,
            };
            const callback = reportCallbackErrors(done)((err: Error, response: JSONRPCResponsePayload) => {
                expect(err).to.be.a('null');
                expect(response.result.length).to.be.equal(DEFAULT_NUM_ACCOUNTS);
                done();
            });
            ledgerProvider.sendAsync(payload, callback);
        });
        it('signs a personal message with eth_sign', (done: DoneCallback) => {
            (async () => {
                const messageHex = ethUtils.bufferToHex(ethUtils.toBuffer('hello world'));
                const accounts = await ledgerSubprovider.getAccountsAsync();
                const signer = accounts[0];
                const payload = {
                    jsonrpc: '2.0',
                    method: 'eth_sign',
                    params: [signer, messageHex],
                    id: 1,
                };
                const callback = reportCallbackErrors(done)((err: Error, response: JSONRPCResponsePayload) => {
                    expect(err).to.be.a('null');
                    expect(response.result.length).to.be.equal(EXPECTED_SIGNATURE_LENGTH);
                    expect(response.result.substr(0, 2)).to.be.equal('0x');
                    done();
                });
                ledgerProvider.sendAsync(payload, callback);
            })().catch(done);
        });
        it('signs a personal message with personal_sign', (done: DoneCallback) => {
            (async () => {
                const messageHex = ethUtils.bufferToHex(ethUtils.toBuffer('hello world'));
                const accounts = await ledgerSubprovider.getAccountsAsync();
                const signer = accounts[0];
                const payload = {
                    jsonrpc: '2.0',
                    method: 'personal_sign',
                    params: [messageHex, signer],
                    id: 1,
                };
                const callback = reportCallbackErrors(done)((err: Error, response: JSONRPCResponsePayload) => {
                    expect(err).to.be.a('null');
                    expect(response.result.length).to.be.equal(EXPECTED_SIGNATURE_LENGTH);
                    expect(response.result.substr(0, 2)).to.be.equal('0x');
                    done();
                });
                ledgerProvider.sendAsync(payload, callback);
            })().catch(done);
        });
        it('signs a transaction', (done: DoneCallback) => {
            const payload = {
                jsonrpc: '2.0',
                method: 'eth_signTransaction',
                params: [fixtureData.TX_DATA],
                id: 1,
            };
            const callback = reportCallbackErrors(done)((err: Error, response: JSONRPCResponsePayload) => {
                expect(err).to.be.a('null');
                expect(response.result.raw).to.be.equal(fixtureData.TX_DATA_SIGNED_RESULT);
                done();
            });
            ledgerProvider.sendAsync(payload, callback);
        });
        it('signs and sends a transaction', (done: DoneCallback) => {
            (async () => {
                const accounts = await ledgerSubprovider.getAccountsAsync();

                // Give first account on Ledger sufficient ETH to complete tx send
                let tx = {
                    to: accounts[0],
                    from: fixtureData.TEST_RPC_ACCOUNT_0,
                    value: '0x8ac7230489e80000', // 10 ETH
                };
                let payload = {
                    jsonrpc: '2.0',
                    method: 'eth_sendTransaction',
                    params: [tx],
                    id: 1,
                };
                await promisify(defaultProvider.sendAsync, defaultProvider)(payload);

                // Send transaction from Ledger
                tx = {
                    to: '0xafa3f8684e54059998bc3a7b0d2b0da075154d66',
                    from: accounts[0],
                    value: '0xde0b6b3a7640000',
                };
                payload = {
                    jsonrpc: '2.0',
                    method: 'eth_sendTransaction',
                    params: [tx],
                    id: 1,
                };
                const callback = reportCallbackErrors(done)((err: Error, response: JSONRPCResponsePayload) => {
                    expect(err).to.be.a('null');
                    const result = response.result;
                    const signedTxLength = 66;
                    expect(result.length).to.be.equal(signedTxLength);
                    expect(result.substr(0, 2)).to.be.equal('0x');
                    done();
                });
                ledgerProvider.sendAsync(payload, callback);
            })().catch(done);
        });
    });
});