From b6a133cc641617bd1099ec00c62a749f548316b7 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Tue, 27 Feb 2018 13:51:12 -0800 Subject: Improve an error message when an inorrect number of constructor params is passed --- packages/contracts/test/exchange/core.ts | 8 ++++---- packages/contracts/test/exchange/helpers.ts | 6 +++--- packages/contracts/test/exchange/wrapper.ts | 6 +++--- .../contracts/test/token_transfer_proxy/transfer_from.ts | 2 +- packages/contracts/test/unlimited_allowance_token.ts | 2 +- packages/contracts/util/constants.ts | 6 ++++++ packages/deployer/CHANGELOG.md | 3 ++- packages/deployer/src/deployer.ts | 14 +++++++++++++- 8 files changed, 33 insertions(+), 14 deletions(-) (limited to 'packages') diff --git a/packages/contracts/test/exchange/core.ts b/packages/contracts/test/exchange/core.ts index 303d745aa..ad5b3a083 100644 --- a/packages/contracts/test/exchange/core.ts +++ b/packages/contracts/test/exchange/core.ts @@ -56,9 +56,9 @@ describe('Exchange', () => { maker = accounts[0]; [tokenOwner, taker, feeRecipient] = accounts; const [repInstance, dgdInstance, zrxInstance] = await Promise.all([ - deployer.deployAsync(ContractName.DummyToken), - deployer.deployAsync(ContractName.DummyToken), - deployer.deployAsync(ContractName.DummyToken), + deployer.deployAsync(ContractName.DummyToken, []), + deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS), + deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS), ]); rep = new DummyTokenContract(web3Wrapper, repInstance.abi, repInstance.address); dgd = new DummyTokenContract(web3Wrapper, dgdInstance.abi, dgdInstance.address); @@ -128,7 +128,7 @@ describe('Exchange', () => { await blockchainLifecycle.revertAsync(); }); describe('internal functions', () => { - it('should include transferViaTokenTransferProxy', () => { + it.only('should include transferViaTokenTransferProxy', () => { expect((exchange as any).transferViaTokenTransferProxy).to.be.undefined(); }); diff --git a/packages/contracts/test/exchange/helpers.ts b/packages/contracts/test/exchange/helpers.ts index 9869c2155..625234729 100644 --- a/packages/contracts/test/exchange/helpers.ts +++ b/packages/contracts/test/exchange/helpers.ts @@ -39,9 +39,9 @@ describe('Exchange', () => { const tokenRegistry = await deployer.deployAsync(ContractName.TokenRegistry); const tokenTransferProxy = await deployer.deployAsync(ContractName.TokenTransferProxy); const [rep, dgd, zrx] = await Promise.all([ - deployer.deployAsync(ContractName.DummyToken), - deployer.deployAsync(ContractName.DummyToken), - deployer.deployAsync(ContractName.DummyToken), + deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS), + deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS), + deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS), ]); const exchangeInstance = await deployer.deployAsync(ContractName.Exchange, [ zrx.address, diff --git a/packages/contracts/test/exchange/wrapper.ts b/packages/contracts/test/exchange/wrapper.ts index 4ea40cb59..239f13a4f 100644 --- a/packages/contracts/test/exchange/wrapper.ts +++ b/packages/contracts/test/exchange/wrapper.ts @@ -56,9 +56,9 @@ describe('Exchange', () => { tokenOwner = accounts[0]; [maker, taker, feeRecipient] = accounts; const [repInstance, dgdInstance, zrxInstance] = await Promise.all([ - deployer.deployAsync(ContractName.DummyToken), - deployer.deployAsync(ContractName.DummyToken), - deployer.deployAsync(ContractName.DummyToken), + deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS), + deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS), + deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS), ]); rep = new DummyTokenContract(web3Wrapper, repInstance.abi, repInstance.address); dgd = new DummyTokenContract(web3Wrapper, dgdInstance.abi, dgdInstance.address); diff --git a/packages/contracts/test/token_transfer_proxy/transfer_from.ts b/packages/contracts/test/token_transfer_proxy/transfer_from.ts index 6b86a0e97..a77590288 100644 --- a/packages/contracts/test/token_transfer_proxy/transfer_from.ts +++ b/packages/contracts/test/token_transfer_proxy/transfer_from.ts @@ -38,7 +38,7 @@ describe('TokenTransferProxy', () => { tokenTransferProxyInstance.abi, tokenTransferProxyInstance.address, ); - const repInstance = await deployer.deployAsync(ContractName.DummyToken); + const repInstance = await deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS); rep = new DummyTokenContract(web3Wrapper, repInstance.abi, repInstance.address); dmyBalances = new Balances([rep], [accounts[0], accounts[1]]); diff --git a/packages/contracts/test/unlimited_allowance_token.ts b/packages/contracts/test/unlimited_allowance_token.ts index 03eb581ad..553178d80 100644 --- a/packages/contracts/test/unlimited_allowance_token.ts +++ b/packages/contracts/test/unlimited_allowance_token.ts @@ -34,7 +34,7 @@ describe('UnlimitedAllowanceToken', () => { const accounts = await web3Wrapper.getAvailableAddressesAsync(); owner = accounts[0]; spender = accounts[1]; - const tokenInstance = await deployer.deployAsync(ContractName.DummyToken); + const tokenInstance = await deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS); token = new DummyTokenContract(web3Wrapper, tokenInstance.abi, tokenInstance.address); await token.mint.sendTransactionAsync(MAX_MINT_VALUE, { from: owner }); tokenAddress = token.address; diff --git a/packages/contracts/util/constants.ts b/packages/contracts/util/constants.ts index e61b2f802..9bb090a2a 100644 --- a/packages/contracts/util/constants.ts +++ b/packages/contracts/util/constants.ts @@ -1,3 +1,8 @@ +const DUMMY_TOKEN_NAME = ''; +const DUMMY_TOKEN_SYMBOL = ''; +const DUMMY_TOKEN_DECIMALS = 18; +const DUMMY_TOKEN_TOTAL_SUPPLY = 0; + export const constants = { NULL_BYTES: '0x', INVALID_OPCODE: 'invalid opcode', @@ -6,4 +11,5 @@ export const constants = { MAX_ETHERTOKEN_WITHDRAW_GAS: 43000, MAX_TOKEN_TRANSFERFROM_GAS: 80000, MAX_TOKEN_APPROVE_GAS: 60000, + DUMMY_TOKEN_ARGS: [DUMMY_TOKEN_NAME, DUMMY_TOKEN_SYMBOL, DUMMY_TOKEN_DECIMALS, DUMMY_TOKEN_TOTAL_SUPPLY], }; diff --git a/packages/deployer/CHANGELOG.md b/packages/deployer/CHANGELOG.md index a63d9cf3b..d8bbbbf89 100644 --- a/packages/deployer/CHANGELOG.md +++ b/packages/deployer/CHANGELOG.md @@ -2,7 +2,8 @@ ## v0.2.0 - _TBD, 2018_ - * Check dependencies when determining if contracts should be recompiled (#408). + * Check dependencies when determining if contracts should be recompiled (#408) + * Improve an error message for when deployer is supplied with an incorrect number of constructor arguments (#TBD) ## v0.1.0 - _February 16, 2018_ diff --git a/packages/deployer/src/deployer.ts b/packages/deployer/src/deployer.ts index 6710bcc85..e87d2ab0e 100644 --- a/packages/deployer/src/deployer.ts +++ b/packages/deployer/src/deployer.ts @@ -1,4 +1,4 @@ -import { TxData } from '@0xproject/types'; +import { AbiType, TxData } from '@0xproject/types'; import { Web3Wrapper } from '@0xproject/web3-wrapper'; import * as _ from 'lodash'; import * as Web3 from 'web3'; @@ -49,6 +49,18 @@ export class Deployer { gas, }; const abi = contractNetworkDataIfExists.abi; + const constructorAbi = _.find(abi, { type: AbiType.Constructor }) as Web3.ConstructorAbi; + const constructorArgs = _.isUndefined(constructorAbi) ? [] : constructorAbi.inputs; + if (constructorArgs.length !== args.length) { + const constructorSignature = `constructor(${_.map(constructorArgs, arg => `${arg.type} ${arg.name}`).join( + ', ', + )})`; + throw new Error( + `${contractName} expects ${constructorArgs.length} constructor params: ${constructorSignature}. Got ${ + args.length + }`, + ); + } const web3ContractInstance = await this._deployFromAbiAsync(abi, args, txData); utils.consoleLog(`${contractName}.sol successfully deployed at ${web3ContractInstance.address}`); const contractInstance = new Contract(web3ContractInstance, this._defaults); -- cgit v1.2.3 From 90236b87de573bf4ed95f13b5a799d71a9f87f8d Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Tue, 27 Feb 2018 14:29:55 -0800 Subject: Add PR name --- packages/deployer/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages') diff --git a/packages/deployer/CHANGELOG.md b/packages/deployer/CHANGELOG.md index d8bbbbf89..a1929ba25 100644 --- a/packages/deployer/CHANGELOG.md +++ b/packages/deployer/CHANGELOG.md @@ -3,7 +3,7 @@ ## v0.2.0 - _TBD, 2018_ * Check dependencies when determining if contracts should be recompiled (#408) - * Improve an error message for when deployer is supplied with an incorrect number of constructor arguments (#TBD) + * Improve an error message for when deployer is supplied with an incorrect number of constructor arguments (#419) ## v0.1.0 - _February 16, 2018_ -- cgit v1.2.3 From 8b6cc95c1b69fe8372f25168714a5fd683dd2e26 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Tue, 27 Feb 2018 14:42:39 -0800 Subject: Fix a typo --- packages/contracts/test/exchange/core.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages') diff --git a/packages/contracts/test/exchange/core.ts b/packages/contracts/test/exchange/core.ts index ad5b3a083..09f796663 100644 --- a/packages/contracts/test/exchange/core.ts +++ b/packages/contracts/test/exchange/core.ts @@ -56,7 +56,7 @@ describe('Exchange', () => { maker = accounts[0]; [tokenOwner, taker, feeRecipient] = accounts; const [repInstance, dgdInstance, zrxInstance] = await Promise.all([ - deployer.deployAsync(ContractName.DummyToken, []), + deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS), deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS), deployer.deployAsync(ContractName.DummyToken, constants.DUMMY_TOKEN_ARGS), ]); -- cgit v1.2.3 From bab8c1eeff287a5dd90754c3391fd702d974d9d6 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Tue, 27 Feb 2018 14:43:29 -0800 Subject: Remove only --- packages/contracts/test/exchange/core.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages') diff --git a/packages/contracts/test/exchange/core.ts b/packages/contracts/test/exchange/core.ts index 09f796663..710d6fe94 100644 --- a/packages/contracts/test/exchange/core.ts +++ b/packages/contracts/test/exchange/core.ts @@ -128,7 +128,7 @@ describe('Exchange', () => { await blockchainLifecycle.revertAsync(); }); describe('internal functions', () => { - it.only('should include transferViaTokenTransferProxy', () => { + it('should include transferViaTokenTransferProxy', () => { expect((exchange as any).transferViaTokenTransferProxy).to.be.undefined(); }); -- cgit v1.2.3 From 8521775389b2e7ddefec20f1d06331e4bc3d0540 Mon Sep 17 00:00:00 2001 From: Jacob Evans Date: Mon, 5 Mar 2018 21:05:30 -0500 Subject: Update ledgerco packages --- packages/subproviders/package.json | 4 ++- packages/subproviders/src/globals.d.ts | 22 ++++++++++++ packages/subproviders/src/index.ts | 30 ++++++++-------- packages/subproviders/src/subproviders/ledger.ts | 8 ++--- packages/subproviders/src/types.ts | 44 +++++++++++++++++------- 5 files changed, 76 insertions(+), 32 deletions(-) (limited to 'packages') diff --git a/packages/subproviders/package.json b/packages/subproviders/package.json index ec0642bce..7c02b5745 100644 --- a/packages/subproviders/package.json +++ b/packages/subproviders/package.json @@ -21,12 +21,14 @@ "@0xproject/assert": "^0.1.0", "@0xproject/types": "^0.3.0", "@0xproject/utils": "^0.4.0", + "@ledgerhq/hw-app-eth": "^4.3.0", + "@ledgerhq/hw-transport": "^4.3.0", + "@ledgerhq/hw-transport-u2f": "^4.3.0", "bn.js": "^4.11.8", "es6-promisify": "^5.0.0", "ethereumjs-tx": "^1.3.3", "ethereumjs-util": "^5.1.1", "hdkey": "^0.7.1", - "ledgerco": "0xProject/ledger-node-js-api", "lodash": "^4.17.4", "semaphore-async-await": "^1.5.1", "web3": "^0.20.0", diff --git a/packages/subproviders/src/globals.d.ts b/packages/subproviders/src/globals.d.ts index 6f344dcd3..0c8b3fed3 100644 --- a/packages/subproviders/src/globals.d.ts +++ b/packages/subproviders/src/globals.d.ts @@ -32,6 +32,28 @@ interface ECSignature { r: string; s: string; } + +interface LedgerTransport { + close(): Promise +} + +declare module '@ledgerhq/hw-app-eth' { + export class Eth { + constructor(transport: LedgerTransport); + public getAddress(path: string, boolDisplay?: boolean, boolChaincode?: boolean): Promise<{ publicKey: string; address: string; chainCode: string }>; + public signTransaction(path: string, rawTxHex: string): Promise; + public getAppConfiguration(): Promise<{ arbitraryDataEnabled: number; version: string; }>; + public signPersonalMessage(path: string, messageHex: string): Promise; + transport: LedgerTransport; + } +} +declare module '@ledgerhq/hw-transport-u2f' { + export class TransportU2F implements LedgerTransport { + public static create(): Promise; + public close(): Promise; + } +} + declare module 'ledgerco' { interface comm { close_async(): Promise; diff --git a/packages/subproviders/src/index.ts b/packages/subproviders/src/index.ts index 4da405ec0..566743fd0 100644 --- a/packages/subproviders/src/index.ts +++ b/packages/subproviders/src/index.ts @@ -1,8 +1,10 @@ import { - comm_node as LedgerNodeCommunication, - comm_u2f as LedgerBrowserCommunication, - eth as LedgerEthereumClientFn, -} from 'ledgerco'; + Eth as LedgerEthereumClientFn, +} from '@ledgerhq/hw-app-eth'; + +import { + TransportU2F as LedgerBrowserCommunication, +} from '@ledgerhq/hw-transport-u2f'; import { LedgerEthereumClient } from './types'; @@ -19,17 +21,17 @@ export { ECSignature, LedgerWalletSubprovider, LedgerCommunicationClient, NonceS * @return LedgerEthereumClient A browser client */ export async function ledgerEthereumBrowserClientFactoryAsync(): Promise { - const ledgerConnection = await LedgerBrowserCommunication.create_async(); + const ledgerConnection = await LedgerBrowserCommunication.create(); const ledgerEthClient = new LedgerEthereumClientFn(ledgerConnection); return ledgerEthClient; } -/** - * A factory for creating a LedgerEthereumClient usable in a Node.js context. - * @return LedgerEthereumClient A Node.js client - */ -export async function ledgerEthereumNodeJsClientFactoryAsync(): Promise { - const ledgerConnection = await LedgerNodeCommunication.create_async(); - const ledgerEthClient = new LedgerEthereumClientFn(ledgerConnection); - return ledgerEthClient; -} +// /** +// * A factory for creating a LedgerEthereumClient usable in a Node.js context. +// * @return LedgerEthereumClient A Node.js client +// */ +// export async function ledgerEthereumNodeJsClientFactoryAsync(): Promise { +// const ledgerConnection = await LedgerNodeCommunication.create_async(); +// const ledgerEthClient = new LedgerEthereumClientFn(ledgerConnection); +// return ledgerEthClient; +// } diff --git a/packages/subproviders/src/subproviders/ledger.ts b/packages/subproviders/src/subproviders/ledger.ts index 85cdf0efc..0a84caae3 100644 --- a/packages/subproviders/src/subproviders/ledger.ts +++ b/packages/subproviders/src/subproviders/ledger.ts @@ -134,7 +134,7 @@ export class LedgerSubprovider extends Subprovider { let ledgerResponse; try { - ledgerResponse = await this._ledgerClientIfExists.getAddress_async( + ledgerResponse = await this._ledgerClientIfExists.getAddress( this._derivationPath, this._shouldAlwaysAskForConfirmation, SHOULD_GET_CHAIN_CODE, @@ -173,7 +173,7 @@ export class LedgerSubprovider extends Subprovider { const txHex = tx.serialize().toString('hex'); try { const derivationPath = this._getDerivationPath(); - const result = await this._ledgerClientIfExists.signTransaction_async(derivationPath, txHex); + const result = await this._ledgerClientIfExists.signTransaction(derivationPath, txHex); // Store signature in transaction tx.r = Buffer.from(result.r, 'hex'); tx.s = Buffer.from(result.s, 'hex'); @@ -199,7 +199,7 @@ export class LedgerSubprovider extends Subprovider { this._ledgerClientIfExists = await this._createLedgerClientAsync(); try { const derivationPath = this._getDerivationPath(); - const result = await this._ledgerClientIfExists.signPersonalMessage_async( + const result = await this._ledgerClientIfExists.signPersonalMessage( derivationPath, ethUtil.stripHexPrefix(data), ); @@ -236,7 +236,7 @@ export class LedgerSubprovider extends Subprovider { this._connectionLock.signal(); return; } - await this._ledgerClientIfExists.comm.close_async(); + await this._ledgerClientIfExists.transport.close(); this._ledgerClientIfExists = undefined; this._connectionLock.signal(); } diff --git a/packages/subproviders/src/types.ts b/packages/subproviders/src/types.ts index 65b7f6c8f..785547a22 100644 --- a/packages/subproviders/src/types.ts +++ b/packages/subproviders/src/types.ts @@ -1,7 +1,25 @@ import * as _ from 'lodash'; +declare class LedgerTransport { + // tslint:disable-next-line:async-suffix + public static create(): Promise; + // tslint:disable-next-line:async-suffix + public static close(): Promise; +} + export interface LedgerCommunicationClient { - close_async: () => Promise; + close: () => Promise; +} + +export interface LedgerEthereumClient { + getAddress: ( + derivationPath: string, + askForDeviceConfirmation?: boolean, + shouldGetChainCode?: boolean, + ) => Promise<{ publicKey: string; address: string; chainCode: string }>; + signTransaction: (derivationPath: string, rawTxHex: string) => Promise; + signPersonalMessage: (derivationPath: string, messageHex: string) => Promise; + transport: LedgerCommunicationClient; } /* @@ -9,18 +27,18 @@ export interface LedgerCommunicationClient { * It uses an internal LedgerCommunicationClient to relay these requests. Currently * NodeJs and Browser communication are supported. */ -export interface LedgerEthereumClient { - // shouldGetChainCode is defined as `true` instead of `boolean` because other types rely on the assumption - // that we get back the chain code and we don't have dependent types to express it properly - getAddress_async: ( - derivationPath: string, - askForDeviceConfirmation: boolean, - shouldGetChainCode: true, - ) => Promise; - signPersonalMessage_async: (derivationPath: string, messageHex: string) => Promise; - signTransaction_async: (derivationPath: string, txHex: string) => Promise; - comm: LedgerCommunicationClient; -} +// export interface LedgerEthereumClient { +// // shouldGetChainCode is defined as `true` instead of `boolean` because other types rely on the assumption +// // that we get back the chain code and we don't have dependent types to express it properly +// getAddress_async: ( +// derivationPath: string, +// askForDeviceConfirmation: boolean, +// shouldGetChainCode: true, +// ) => Promise; +// signPersonalMessage_async: (derivationPath: string, messageHex: string) => Promise; +// signTransaction_async: (derivationPath: string, txHex: string) => Promise; +// comm: LedgerCommunicationClient; +// } export interface ECSignatureString { v: string; -- cgit v1.2.3 From 71e7e9c9c3ed89c1c25f46085c0968a62099cb5a Mon Sep 17 00:00:00 2001 From: Jacob Evans Date: Mon, 5 Mar 2018 21:07:07 -0500 Subject: Remove old ledger --- packages/subproviders/src/globals.d.ts | 29 ----------------------------- packages/subproviders/src/index.ts | 10 ---------- 2 files changed, 39 deletions(-) (limited to 'packages') diff --git a/packages/subproviders/src/globals.d.ts b/packages/subproviders/src/globals.d.ts index 0c8b3fed3..1a9b2ad61 100644 --- a/packages/subproviders/src/globals.d.ts +++ b/packages/subproviders/src/globals.d.ts @@ -54,35 +54,6 @@ declare module '@ledgerhq/hw-transport-u2f' { } } -declare module 'ledgerco' { - interface comm { - close_async(): Promise; - } - export class comm_node implements comm { - public static create_async(timeoutMilliseconds?: number): Promise; - public close_async(): Promise; - } - export class comm_u2f implements comm { - public static create_async(): Promise; - public close_async(): Promise; - } - export class eth { - public comm: comm; - constructor(comm: comm); - public getAddress_async( - path: string, - display?: boolean, - chaincode?: boolean, - ): Promise<{ publicKey: string; address: string; chainCode: string }>; - public signTransaction_async(path: string, rawTxHex: string): Promise; - public getAppConfiguration_async(): Promise<{ - arbitraryDataEnabled: number; - version: string; - }>; - public signPersonalMessage_async(path: string, messageHex: string): Promise; - } -} - // Semaphore-async-await declarations declare module 'semaphore-async-await' { class Semaphore { diff --git a/packages/subproviders/src/index.ts b/packages/subproviders/src/index.ts index 566743fd0..d296c7be6 100644 --- a/packages/subproviders/src/index.ts +++ b/packages/subproviders/src/index.ts @@ -25,13 +25,3 @@ export async function ledgerEthereumBrowserClientFactoryAsync(): Promise { -// const ledgerConnection = await LedgerNodeCommunication.create_async(); -// const ledgerEthClient = new LedgerEthereumClientFn(ledgerConnection); -// return ledgerEthClient; -// } -- cgit v1.2.3 From 7bfc499ec8e50778dd33183646dd19ef66496052 Mon Sep 17 00:00:00 2001 From: Jacob Evans Date: Mon, 5 Mar 2018 22:14:00 -0500 Subject: Nuke tests for now --- packages/subproviders/package.json | 1 - packages/subproviders/src/globals.d.ts | 17 +- packages/subproviders/src/index.ts | 13 +- packages/subproviders/src/types.ts | 32 +- .../test/integration/ledger_subprovider_test.ts | 366 ++++++++++----------- .../test/unit/ledger_subprovider_test.ts | 10 +- 6 files changed, 209 insertions(+), 230 deletions(-) (limited to 'packages') diff --git a/packages/subproviders/package.json b/packages/subproviders/package.json index 7c02b5745..9e18f95e1 100644 --- a/packages/subproviders/package.json +++ b/packages/subproviders/package.json @@ -22,7 +22,6 @@ "@0xproject/types": "^0.3.0", "@0xproject/utils": "^0.4.0", "@ledgerhq/hw-app-eth": "^4.3.0", - "@ledgerhq/hw-transport": "^4.3.0", "@ledgerhq/hw-transport-u2f": "^4.3.0", "bn.js": "^4.11.8", "es6-promisify": "^5.0.0", diff --git a/packages/subproviders/src/globals.d.ts b/packages/subproviders/src/globals.d.ts index 1a9b2ad61..238d9be78 100644 --- a/packages/subproviders/src/globals.d.ts +++ b/packages/subproviders/src/globals.d.ts @@ -34,22 +34,27 @@ interface ECSignature { } interface LedgerTransport { - close(): Promise + close(): Promise; } declare module '@ledgerhq/hw-app-eth' { - export class Eth { + class Eth { constructor(transport: LedgerTransport); - public getAddress(path: string, boolDisplay?: boolean, boolChaincode?: boolean): Promise<{ publicKey: string; address: string; chainCode: string }>; + public getAddress( + path: string, + boolDisplay?: boolean, + boolChaincode?: boolean, + ): Promise<{ publicKey: string; address: string; chainCode: string }>; public signTransaction(path: string, rawTxHex: string): Promise; - public getAppConfiguration(): Promise<{ arbitraryDataEnabled: number; version: string; }>; + public getAppConfiguration(): Promise<{ arbitraryDataEnabled: number; version: string }>; public signPersonalMessage(path: string, messageHex: string): Promise; transport: LedgerTransport; } + export default Eth; } declare module '@ledgerhq/hw-transport-u2f' { - export class TransportU2F implements LedgerTransport { - public static create(): Promise; + export default class TransportU2F { + public static create(): Promise; public close(): Promise; } } diff --git a/packages/subproviders/src/index.ts b/packages/subproviders/src/index.ts index d296c7be6..e22b6f5f3 100644 --- a/packages/subproviders/src/index.ts +++ b/packages/subproviders/src/index.ts @@ -1,10 +1,5 @@ -import { - Eth as LedgerEthereumClientFn, -} from '@ledgerhq/hw-app-eth'; - -import { - TransportU2F as LedgerBrowserCommunication, -} from '@ledgerhq/hw-transport-u2f'; +import Eth from '@ledgerhq/hw-app-eth'; +import TransportU2F from '@ledgerhq/hw-transport-u2f'; import { LedgerEthereumClient } from './types'; @@ -21,7 +16,7 @@ export { ECSignature, LedgerWalletSubprovider, LedgerCommunicationClient, NonceS * @return LedgerEthereumClient A browser client */ export async function ledgerEthereumBrowserClientFactoryAsync(): Promise { - const ledgerConnection = await LedgerBrowserCommunication.create(); - const ledgerEthClient = new LedgerEthereumClientFn(ledgerConnection); + const ledgerConnection = await TransportU2F.create(); + const ledgerEthClient = new Eth(ledgerConnection); return ledgerEthClient; } diff --git a/packages/subproviders/src/types.ts b/packages/subproviders/src/types.ts index 785547a22..11a178f69 100644 --- a/packages/subproviders/src/types.ts +++ b/packages/subproviders/src/types.ts @@ -1,45 +1,25 @@ import * as _ from 'lodash'; -declare class LedgerTransport { - // tslint:disable-next-line:async-suffix - public static create(): Promise; - // tslint:disable-next-line:async-suffix - public static close(): Promise; -} - export interface LedgerCommunicationClient { close: () => Promise; } +/* + * The LedgerEthereumClient sends Ethereum-specific requests to the Ledger Nano S + * It uses an internal LedgerCommunicationClient to relay these requests. Currently + * NodeJs and Browser communication are supported. + */ export interface LedgerEthereumClient { getAddress: ( derivationPath: string, askForDeviceConfirmation?: boolean, shouldGetChainCode?: boolean, - ) => Promise<{ publicKey: string; address: string; chainCode: string }>; + ) => Promise; signTransaction: (derivationPath: string, rawTxHex: string) => Promise; signPersonalMessage: (derivationPath: string, messageHex: string) => Promise; transport: LedgerCommunicationClient; } -/* - * The LedgerEthereumClient sends Ethereum-specific requests to the Ledger Nano S - * It uses an internal LedgerCommunicationClient to relay these requests. Currently - * NodeJs and Browser communication are supported. - */ -// export interface LedgerEthereumClient { -// // shouldGetChainCode is defined as `true` instead of `boolean` because other types rely on the assumption -// // that we get back the chain code and we don't have dependent types to express it properly -// getAddress_async: ( -// derivationPath: string, -// askForDeviceConfirmation: boolean, -// shouldGetChainCode: true, -// ) => Promise; -// signPersonalMessage_async: (derivationPath: string, messageHex: string) => Promise; -// signTransaction_async: (derivationPath: string, txHex: string) => Promise; -// comm: LedgerCommunicationClient; -// } - export interface ECSignatureString { v: string; r: string; diff --git a/packages/subproviders/test/integration/ledger_subprovider_test.ts b/packages/subproviders/test/integration/ledger_subprovider_test.ts index b052a76d2..979215bbe 100644 --- a/packages/subproviders/test/integration/ledger_subprovider_test.ts +++ b/packages/subproviders/test/integration/ledger_subprovider_test.ts @@ -1,190 +1,190 @@ -import * as chai from 'chai'; -import promisify = require('es6-promisify'); -import * as ethUtils from 'ethereumjs-util'; -import * as _ from 'lodash'; -import Web3 = require('web3'); -import Web3ProviderEngine = require('web3-provider-engine'); -import RpcSubprovider = require('web3-provider-engine/subproviders/rpc'); +// import * as chai from 'chai'; +// import promisify = require('es6-promisify'); +// import * as ethUtils from 'ethereumjs-util'; +// import * as _ from 'lodash'; +// import Web3 = require('web3'); +// import Web3ProviderEngine = require('web3-provider-engine'); +// import RpcSubprovider = require('web3-provider-engine/subproviders/rpc'); -import { ledgerEthereumNodeJsClientFactoryAsync, LedgerSubprovider } from '../../src'; -import { DoneCallback } from '../../src/types'; -import { chaiSetup } from '../chai_setup'; -import { reportCallbackErrors } from '../utils/report_callback_errors'; +// import { ledgerEthereumNodeJsClientFactoryAsync, LedgerSubprovider } from '../../src'; +// import { DoneCallback } from '../../src/types'; +// import { chaiSetup } from '../chai_setup'; +// import { reportCallbackErrors } from '../utils/report_callback_errors'; -chaiSetup.configure(); -const expect = chai.expect; +// chaiSetup.configure(); +// const expect = chai.expect; -const TEST_RPC_ACCOUNT_0 = '0x5409ed021d9299bf6814279a6a1411a7e866a631'; +// const TEST_RPC_ACCOUNT_0 = '0x5409ed021d9299bf6814279a6a1411a7e866a631'; -describe('LedgerSubprovider', () => { - let ledgerSubprovider: LedgerSubprovider; - const networkId: number = 42; - before(async () => { - ledgerSubprovider = new LedgerSubprovider({ - networkId, - ledgerEthereumClientFactoryAsync: ledgerEthereumNodeJsClientFactoryAsync, - }); - }); - 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(10); - }); - 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('hello world')); - const ecSignatureHex = await ledgerSubprovider.signPersonalMessageAsync(data); - expect(ecSignatureHex.length).to.be.equal(132); - expect(ecSignatureHex.substr(0, 2)).to.be.equal('0x'); - }); - it('signs a transaction', async () => { - const tx = { - nonce: '0x00', - gas: '0x2710', - to: '0x0000000000000000000000000000000000000000', - value: '0x00', - chainId: 3, - }; - const txHex = await ledgerSubprovider.signTransactionAsync(tx); - expect(txHex).to.be.equal( - '0xf85f8080822710940000000000000000000000000000000000000000808077a088a95ef1378487bc82be558e82c8478baf840c545d5b887536bb1da63673a98ba0019f4a4b9a107d1e6752bf7f701e275f28c13791d6e76af895b07373462cefaa', - ); - }); - }); - 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(); +// describe('LedgerSubprovider', () => { +// let ledgerSubprovider: LedgerSubprovider; +// const networkId: number = 42; +// before(async () => { +// ledgerSubprovider = new LedgerSubprovider({ +// networkId, +// ledgerEthereumClientFactoryAsync: ledgerEthereumNodeJsClientFactoryAsync, +// }); +// }); +// 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(10); +// }); +// 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('hello world')); +// const ecSignatureHex = await ledgerSubprovider.signPersonalMessageAsync(data); +// expect(ecSignatureHex.length).to.be.equal(132); +// expect(ecSignatureHex.substr(0, 2)).to.be.equal('0x'); +// }); +// it('signs a transaction', async () => { +// const tx = { +// nonce: '0x00', +// gas: '0x2710', +// to: '0x0000000000000000000000000000000000000000', +// value: '0x00', +// chainId: 3, +// }; +// const txHex = await ledgerSubprovider.signTransactionAsync(tx); +// expect(txHex).to.be.equal( +// '0xf85f8080822710940000000000000000000000000000000000000000808077a088a95ef1378487bc82be558e82c8478baf840c545d5b887536bb1da63673a98ba0019f4a4b9a107d1e6752bf7f701e275f28c13791d6e76af895b07373462cefaa', +// ); +// }); +// }); +// 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: Web3.JSONRPCResponsePayload) => { - expect(err).to.be.a('null'); - expect(response.result.length).to.be.equal(10); - 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: Web3.JSONRPCResponsePayload) => { - expect(err).to.be.a('null'); - expect(response.result.length).to.be.equal(132); - 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: Web3.JSONRPCResponsePayload) => { - expect(err).to.be.a('null'); - expect(response.result.length).to.be.equal(132); - expect(response.result.substr(0, 2)).to.be.equal('0x'); - done(); - }); - ledgerProvider.sendAsync(payload, callback); - })().catch(done); - }); - it('signs a transaction', (done: DoneCallback) => { - const tx = { - to: '0xafa3f8684e54059998bc3a7b0d2b0da075154d66', - value: '0x00', - }; - const payload = { - jsonrpc: '2.0', - method: 'eth_signTransaction', - params: [tx], - id: 1, - }; - const callback = reportCallbackErrors(done)((err: Error, response: Web3.JSONRPCResponsePayload) => { - expect(err).to.be.a('null'); - expect(response.result.raw.length).to.be.equal(206); - expect(response.result.raw.substr(0, 2)).to.be.equal('0x'); - done(); - }); - ledgerProvider.sendAsync(payload, callback); - }); - it('signs and sends a transaction', (done: DoneCallback) => { - (async () => { - const accounts = await ledgerSubprovider.getAccountsAsync(); +// 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: Web3.JSONRPCResponsePayload) => { +// expect(err).to.be.a('null'); +// expect(response.result.length).to.be.equal(10); +// 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: Web3.JSONRPCResponsePayload) => { +// expect(err).to.be.a('null'); +// expect(response.result.length).to.be.equal(132); +// 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: Web3.JSONRPCResponsePayload) => { +// expect(err).to.be.a('null'); +// expect(response.result.length).to.be.equal(132); +// expect(response.result.substr(0, 2)).to.be.equal('0x'); +// done(); +// }); +// ledgerProvider.sendAsync(payload, callback); +// })().catch(done); +// }); +// it('signs a transaction', (done: DoneCallback) => { +// const tx = { +// to: '0xafa3f8684e54059998bc3a7b0d2b0da075154d66', +// value: '0x00', +// }; +// const payload = { +// jsonrpc: '2.0', +// method: 'eth_signTransaction', +// params: [tx], +// id: 1, +// }; +// const callback = reportCallbackErrors(done)((err: Error, response: Web3.JSONRPCResponsePayload) => { +// expect(err).to.be.a('null'); +// expect(response.result.raw.length).to.be.equal(206); +// expect(response.result.raw.substr(0, 2)).to.be.equal('0x'); +// 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: 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); +// // Give first account on Ledger sufficient ETH to complete tx send +// let tx = { +// to: accounts[0], +// from: 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: Web3.JSONRPCResponsePayload) => { - expect(err).to.be.a('null'); - const result = response.result; - expect(result.length).to.be.equal(66); - expect(result.substr(0, 2)).to.be.equal('0x'); - done(); - }); - ledgerProvider.sendAsync(payload, callback); - })().catch(done); - }); - }); -}); +// // 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: Web3.JSONRPCResponsePayload) => { +// expect(err).to.be.a('null'); +// const result = response.result; +// expect(result.length).to.be.equal(66); +// expect(result.substr(0, 2)).to.be.equal('0x'); +// done(); +// }); +// ledgerProvider.sendAsync(payload, callback); +// })().catch(done); +// }); +// }); +// }); diff --git a/packages/subproviders/test/unit/ledger_subprovider_test.ts b/packages/subproviders/test/unit/ledger_subprovider_test.ts index 0d301bce9..4c0803a29 100644 --- a/packages/subproviders/test/unit/ledger_subprovider_test.ts +++ b/packages/subproviders/test/unit/ledger_subprovider_test.ts @@ -21,7 +21,7 @@ describe('LedgerSubprovider', () => { const ledgerEthereumClientFactoryAsync = async () => { // tslint:disable:no-object-literal-type-assertion const ledgerEthClient = { - getAddress_async: async () => { + getAddress: async () => { const publicKey = '04f428290f4c5ed6a198f71b8205f488141dbb3f0840c923bbfa798ecbee6370986c03b5575d94d506772fb48a6a44e345e4ebd4f028a6f609c44b655d6d3e71a1'; const chainCode = 'ac055a5537c0c7e9e02d14a197cad6b857836da2a12043b46912a37d959b5ae8'; @@ -32,7 +32,7 @@ describe('LedgerSubprovider', () => { chainCode, }; }, - signPersonalMessage_async: async () => { + signPersonalMessage: async () => { const ecSignature = { v: 28, r: 'a6cc284bff14b42bdf5e9286730c152be91719d478605ec46b3bebcd0ae49148', @@ -40,7 +40,7 @@ describe('LedgerSubprovider', () => { }; return ecSignature; }, - signTransaction_async: async (derivationPath: string, txHex: string) => { + signTransaction: async (derivationPath: string, txHex: string) => { const ecSignature = { v: '77', r: '88a95ef1378487bc82be558e82c8478baf840c545d5b887536bb1da63673a98b', @@ -48,8 +48,8 @@ describe('LedgerSubprovider', () => { }; return ecSignature; }, - comm: { - close_async: _.noop, + transport: { + close: _.noop, } as LedgerCommunicationClient, }; // tslint:enable:no-object-literal-type-assertion -- cgit v1.2.3 From f3026e33fd439bbd550e1814b5f067c36290638b Mon Sep 17 00:00:00 2001 From: Jacob Evans Date: Tue, 6 Mar 2018 08:57:54 -0500 Subject: Force shouldGetChainCode to true in types --- packages/subproviders/src/types.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'packages') diff --git a/packages/subproviders/src/types.ts b/packages/subproviders/src/types.ts index 11a178f69..f49ac6107 100644 --- a/packages/subproviders/src/types.ts +++ b/packages/subproviders/src/types.ts @@ -10,10 +10,12 @@ export interface LedgerCommunicationClient { * NodeJs and Browser communication are supported. */ export interface LedgerEthereumClient { + // shouldGetChainCode is defined as `true` instead of `boolean` because other types rely on the assumption + // that we get back the chain code and we don't have dependent types to express it properly getAddress: ( derivationPath: string, - askForDeviceConfirmation?: boolean, - shouldGetChainCode?: boolean, + askForDeviceConfirmation: boolean, + shouldGetChainCode: true, ) => Promise; signTransaction: (derivationPath: string, rawTxHex: string) => Promise; signPersonalMessage: (derivationPath: string, messageHex: string) => Promise; -- cgit v1.2.3 From d7373a5c0455ef81a5a1852123136e4724f13e36 Mon Sep 17 00:00:00 2001 From: Jacob Evans Date: Tue, 6 Mar 2018 20:25:21 -0500 Subject: Add ledger-node package as optional dependency --- packages/subproviders/CHANGELOG.md | 4 + packages/subproviders/package.json | 3 + packages/subproviders/src/globals.d.ts | 10 +- .../test/integration/ledger_subprovider_test.ts | 375 +++++++++++---------- 4 files changed, 208 insertions(+), 184 deletions(-) (limited to 'packages') diff --git a/packages/subproviders/CHANGELOG.md b/packages/subproviders/CHANGELOG.md index 7e1e006e3..b7247748e 100644 --- a/packages/subproviders/CHANGELOG.md +++ b/packages/subproviders/CHANGELOG.md @@ -1,5 +1,9 @@ # CHANGELOG +## v0.7.0 - _March 6, 2018_ + + * Updated legerco packages. Removed node-hid packages as a dependency. (#437) + ## v0.6.0 - _March 4, 2018_ * Move web3 types from being a devDep to a dep since one cannot use this package without it (#429) diff --git a/packages/subproviders/package.json b/packages/subproviders/package.json index 9e18f95e1..a3e865d24 100644 --- a/packages/subproviders/package.json +++ b/packages/subproviders/package.json @@ -54,5 +54,8 @@ "types-ethereumjs-util": "0xProject/types-ethereumjs-util", "typescript": "2.7.1", "webpack": "^3.1.0" + }, + "optionalDependencies": { + "@ledgerhq/hw-transport-node-hid": "^4.3.0" } } diff --git a/packages/subproviders/src/globals.d.ts b/packages/subproviders/src/globals.d.ts index 238d9be78..e258ef947 100644 --- a/packages/subproviders/src/globals.d.ts +++ b/packages/subproviders/src/globals.d.ts @@ -39,6 +39,7 @@ interface LedgerTransport { declare module '@ledgerhq/hw-app-eth' { class Eth { + public transport: LedgerTransport; constructor(transport: LedgerTransport); public getAddress( path: string, @@ -48,10 +49,10 @@ declare module '@ledgerhq/hw-app-eth' { public signTransaction(path: string, rawTxHex: string): Promise; public getAppConfiguration(): Promise<{ arbitraryDataEnabled: number; version: string }>; public signPersonalMessage(path: string, messageHex: string): Promise; - transport: LedgerTransport; } export default Eth; } + declare module '@ledgerhq/hw-transport-u2f' { export default class TransportU2F { public static create(): Promise; @@ -59,6 +60,13 @@ declare module '@ledgerhq/hw-transport-u2f' { } } +declare module '@ledgerhq/hw-transport-node-hid' { + export default class TransportNodeHid { + public static create(): Promise; + public close(): Promise; + } +} + // Semaphore-async-await declarations declare module 'semaphore-async-await' { class Semaphore { diff --git a/packages/subproviders/test/integration/ledger_subprovider_test.ts b/packages/subproviders/test/integration/ledger_subprovider_test.ts index 979215bbe..86faebbd3 100644 --- a/packages/subproviders/test/integration/ledger_subprovider_test.ts +++ b/packages/subproviders/test/integration/ledger_subprovider_test.ts @@ -1,190 +1,199 @@ -// import * as chai from 'chai'; -// import promisify = require('es6-promisify'); -// import * as ethUtils from 'ethereumjs-util'; -// import * as _ from 'lodash'; -// import Web3 = require('web3'); -// import Web3ProviderEngine = require('web3-provider-engine'); -// import RpcSubprovider = require('web3-provider-engine/subproviders/rpc'); +import Eth from '@ledgerhq/hw-app-eth'; +// tslint:disable-next-line:no-implicit-dependencies +import TransportNodeHid from '@ledgerhq/hw-transport-node-hid'; +import * as chai from 'chai'; +import promisify = require('es6-promisify'); +import * as ethUtils from 'ethereumjs-util'; +import * as _ from 'lodash'; +import Web3 = require('web3'); +import Web3ProviderEngine = require('web3-provider-engine'); +import RpcSubprovider = require('web3-provider-engine/subproviders/rpc'); -// import { ledgerEthereumNodeJsClientFactoryAsync, LedgerSubprovider } from '../../src'; -// import { DoneCallback } from '../../src/types'; -// import { chaiSetup } from '../chai_setup'; -// import { reportCallbackErrors } from '../utils/report_callback_errors'; +import { LedgerSubprovider } from '../../src'; +import { DoneCallback, LedgerEthereumClient } from '../../src/types'; +import { chaiSetup } from '../chai_setup'; +import { reportCallbackErrors } from '../utils/report_callback_errors'; -// chaiSetup.configure(); -// const expect = chai.expect; +chaiSetup.configure(); +const expect = chai.expect; -// const TEST_RPC_ACCOUNT_0 = '0x5409ed021d9299bf6814279a6a1411a7e866a631'; +async function ledgerEthereumNodeJsClientFactoryAsync(): Promise { + const ledgerConnection = await TransportNodeHid.create(); + const ledgerEthClient = new Eth(ledgerConnection); + return ledgerEthClient; +} -// describe('LedgerSubprovider', () => { -// let ledgerSubprovider: LedgerSubprovider; -// const networkId: number = 42; -// before(async () => { -// ledgerSubprovider = new LedgerSubprovider({ -// networkId, -// ledgerEthereumClientFactoryAsync: ledgerEthereumNodeJsClientFactoryAsync, -// }); -// }); -// 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(10); -// }); -// 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('hello world')); -// const ecSignatureHex = await ledgerSubprovider.signPersonalMessageAsync(data); -// expect(ecSignatureHex.length).to.be.equal(132); -// expect(ecSignatureHex.substr(0, 2)).to.be.equal('0x'); -// }); -// it('signs a transaction', async () => { -// const tx = { -// nonce: '0x00', -// gas: '0x2710', -// to: '0x0000000000000000000000000000000000000000', -// value: '0x00', -// chainId: 3, -// }; -// const txHex = await ledgerSubprovider.signTransactionAsync(tx); -// expect(txHex).to.be.equal( -// '0xf85f8080822710940000000000000000000000000000000000000000808077a088a95ef1378487bc82be558e82c8478baf840c545d5b887536bb1da63673a98ba0019f4a4b9a107d1e6752bf7f701e275f28c13791d6e76af895b07373462cefaa', -// ); -// }); -// }); -// 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(); +const TEST_RPC_ACCOUNT_0 = '0x5409ed021d9299bf6814279a6a1411a7e866a631'; -// 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: Web3.JSONRPCResponsePayload) => { -// expect(err).to.be.a('null'); -// expect(response.result.length).to.be.equal(10); -// 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: Web3.JSONRPCResponsePayload) => { -// expect(err).to.be.a('null'); -// expect(response.result.length).to.be.equal(132); -// 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: Web3.JSONRPCResponsePayload) => { -// expect(err).to.be.a('null'); -// expect(response.result.length).to.be.equal(132); -// expect(response.result.substr(0, 2)).to.be.equal('0x'); -// done(); -// }); -// ledgerProvider.sendAsync(payload, callback); -// })().catch(done); -// }); -// it('signs a transaction', (done: DoneCallback) => { -// const tx = { -// to: '0xafa3f8684e54059998bc3a7b0d2b0da075154d66', -// value: '0x00', -// }; -// const payload = { -// jsonrpc: '2.0', -// method: 'eth_signTransaction', -// params: [tx], -// id: 1, -// }; -// const callback = reportCallbackErrors(done)((err: Error, response: Web3.JSONRPCResponsePayload) => { -// expect(err).to.be.a('null'); -// expect(response.result.raw.length).to.be.equal(206); -// expect(response.result.raw.substr(0, 2)).to.be.equal('0x'); -// done(); -// }); -// ledgerProvider.sendAsync(payload, callback); -// }); -// it('signs and sends a transaction', (done: DoneCallback) => { -// (async () => { -// const accounts = await ledgerSubprovider.getAccountsAsync(); +describe('LedgerSubprovider', () => { + let ledgerSubprovider: LedgerSubprovider; + const networkId: number = 42; + before(async () => { + ledgerSubprovider = new LedgerSubprovider({ + networkId, + ledgerEthereumClientFactoryAsync: ledgerEthereumNodeJsClientFactoryAsync, + }); + }); + 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(10); + }); + 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('hello world')); + const ecSignatureHex = await ledgerSubprovider.signPersonalMessageAsync(data); + expect(ecSignatureHex.length).to.be.equal(132); + expect(ecSignatureHex.substr(0, 2)).to.be.equal('0x'); + }); + it('signs a transaction', async () => { + const tx = { + nonce: '0x00', + gas: '0x2710', + to: '0x0000000000000000000000000000000000000000', + value: '0x00', + chainId: 3, + }; + const txHex = await ledgerSubprovider.signTransactionAsync(tx); + expect(txHex).to.be.equal( + '0xf85f8080822710940000000000000000000000000000000000000000808077a088a95ef1378487bc82be558e82c8478baf840c545d5b887536bb1da63673a98ba0019f4a4b9a107d1e6752bf7f701e275f28c13791d6e76af895b07373462cefaa', + ); + }); + }); + 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(); -// // Give first account on Ledger sufficient ETH to complete tx send -// let tx = { -// to: accounts[0], -// from: 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); + 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: Web3.JSONRPCResponsePayload) => { + expect(err).to.be.a('null'); + expect(response.result.length).to.be.equal(10); + 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: Web3.JSONRPCResponsePayload) => { + expect(err).to.be.a('null'); + expect(response.result.length).to.be.equal(132); + 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: Web3.JSONRPCResponsePayload) => { + expect(err).to.be.a('null'); + expect(response.result.length).to.be.equal(132); + expect(response.result.substr(0, 2)).to.be.equal('0x'); + done(); + }); + ledgerProvider.sendAsync(payload, callback); + })().catch(done); + }); + it('signs a transaction', (done: DoneCallback) => { + const tx = { + to: '0xafa3f8684e54059998bc3a7b0d2b0da075154d66', + value: '0x00', + }; + const payload = { + jsonrpc: '2.0', + method: 'eth_signTransaction', + params: [tx], + id: 1, + }; + const callback = reportCallbackErrors(done)((err: Error, response: Web3.JSONRPCResponsePayload) => { + expect(err).to.be.a('null'); + expect(response.result.raw.length).to.be.equal(206); + expect(response.result.raw.substr(0, 2)).to.be.equal('0x'); + done(); + }); + ledgerProvider.sendAsync(payload, callback); + }); + it('signs and sends a transaction', (done: DoneCallback) => { + (async () => { + const accounts = await ledgerSubprovider.getAccountsAsync(); -// // 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: Web3.JSONRPCResponsePayload) => { -// expect(err).to.be.a('null'); -// const result = response.result; -// expect(result.length).to.be.equal(66); -// expect(result.substr(0, 2)).to.be.equal('0x'); -// done(); -// }); -// ledgerProvider.sendAsync(payload, callback); -// })().catch(done); -// }); -// }); -// }); + // Give first account on Ledger sufficient ETH to complete tx send + let tx = { + to: accounts[0], + from: 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: Web3.JSONRPCResponsePayload) => { + expect(err).to.be.a('null'); + const result = response.result; + expect(result.length).to.be.equal(66); + expect(result.substr(0, 2)).to.be.equal('0x'); + done(); + }); + ledgerProvider.sendAsync(payload, callback); + })().catch(done); + }); + }); +}); -- cgit v1.2.3 From a941f0ffb6c4c011160e04522613318a3da9c5b5 Mon Sep 17 00:00:00 2001 From: Jacob Evans Date: Tue, 6 Mar 2018 20:49:05 -0500 Subject: README --- packages/subproviders/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'packages') diff --git a/packages/subproviders/README.md b/packages/subproviders/README.md index 67a6a92d2..52ad3388e 100644 --- a/packages/subproviders/README.md +++ b/packages/subproviders/README.md @@ -42,6 +42,26 @@ const accounts = await ledgerSubprovider.getAccountsAsync(); A subprovider that enables your dApp to send signing requests to a user's Ledger Nano S hardware wallet. These can be requests to sign transactions or messages. +##### Ledger Nano S + Node-hid (usb) + +By default, node-hid transport support is an optional dependency. This is due to the requirement of native usb developer packages on the host system. If these aren't installed the entire `npm install` fails. We also no longer export node-hid transport client factories. To re-create this see our integration tests or follow the example below: + +```typescript +import Eth from '@ledgerhq/hw-app-eth'; +import TransportNodeHid from '@ledgerhq/hw-transport-node-hid'; +async function ledgerEthereumNodeJsClientFactoryAsync(): Promise { + const ledgerConnection = await TransportNodeHid.create(); + const ledgerEthClient = new Eth(ledgerConnection); + return ledgerEthClient; +} + +// Create a LedgerSubprovider with the node-hid transport +ledgerSubprovider = new LedgerSubprovider({ + networkId, + ledgerEthereumClientFactoryAsync: ledgerEthereumNodeJsClientFactoryAsync, +}); +``` + #### Redundant RPC subprovider A subprovider which attempts to send an RPC call to a list of RPC endpoints sequentially, until one of them returns a successful response. -- cgit v1.2.3 From 5b9c5d27906dc2a3b4462599a1a67e43a4210ebd Mon Sep 17 00:00:00 2001 From: Jacob Evans Date: Wed, 7 Mar 2018 11:59:09 -0500 Subject: Use our dev seed derivation path. Ensuring our signer address is 0x5409ed021d9299bf6814279a6a1411a7e866a631 --- packages/subproviders/test/integration/ledger_subprovider_test.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'packages') diff --git a/packages/subproviders/test/integration/ledger_subprovider_test.ts b/packages/subproviders/test/integration/ledger_subprovider_test.ts index 86faebbd3..a9f538038 100644 --- a/packages/subproviders/test/integration/ledger_subprovider_test.ts +++ b/packages/subproviders/test/integration/ledger_subprovider_test.ts @@ -23,6 +23,7 @@ async function ledgerEthereumNodeJsClientFactoryAsync(): Promise { @@ -32,6 +33,7 @@ describe('LedgerSubprovider', () => { ledgerSubprovider = new LedgerSubprovider({ networkId, ledgerEthereumClientFactoryAsync: ledgerEthereumNodeJsClientFactoryAsync, + derivationPath: DEFAULT_DERIVATION_PATH, }); }); describe('direct method calls', () => { @@ -62,7 +64,7 @@ describe('LedgerSubprovider', () => { }; const txHex = await ledgerSubprovider.signTransactionAsync(tx); expect(txHex).to.be.equal( - '0xf85f8080822710940000000000000000000000000000000000000000808077a088a95ef1378487bc82be558e82c8478baf840c545d5b887536bb1da63673a98ba0019f4a4b9a107d1e6752bf7f701e275f28c13791d6e76af895b07373462cefaa', + '0xf85f8080822710940000000000000000000000000000000000000000808078a0712854c73c69445cc1b22a7c3d7312ff9a97fe4ffba35fd636e8236b211b6e7ca0647cee031615e52d916c7c707025bc64ad525d8f1b9876c3435a863b42743178', ); }); }); -- cgit v1.2.3 From e2e6ae937d2d38210442f493c24d492e3b477907 Mon Sep 17 00:00:00 2001 From: Jacob Evans Date: Wed, 7 Mar 2018 12:30:27 -0500 Subject: README on derivation path --- packages/subproviders/README.md | 8 ++++++++ packages/subproviders/test/integration/ledger_subprovider_test.ts | 5 +++++ 2 files changed, 13 insertions(+) (limited to 'packages') diff --git a/packages/subproviders/README.md b/packages/subproviders/README.md index 52ad3388e..f3e3bd0ae 100644 --- a/packages/subproviders/README.md +++ b/packages/subproviders/README.md @@ -42,6 +42,8 @@ const accounts = await ledgerSubprovider.getAccountsAsync(); A subprovider that enables your dApp to send signing requests to a user's Ledger Nano S hardware wallet. These can be requests to sign transactions or messages. +Ledger Nano (and this library) by default uses a derivation path of `44'/60'/0'`. This is different to TestRPC which by default uses `m/44'/60'/0'/0`. This is a configuration option in the Ledger Subprovider package. + ##### Ledger Nano S + Node-hid (usb) By default, node-hid transport support is an optional dependency. This is due to the requirement of native usb developer packages on the host system. If these aren't installed the entire `npm install` fails. We also no longer export node-hid transport client factories. To re-create this see our integration tests or follow the example below: @@ -62,6 +64,12 @@ ledgerSubprovider = new LedgerSubprovider({ }); ``` +##### Testing Subprovider + Ledger integration + +To run our integration tests you need a ledger configured with our development mnemonic seed. +This is available in the top level package.json under `mnemonic`. +Configure your ledger and run the integration tests. We assume a derivation path of `m/44'/60'/0'/0` and this is configured in the tests. To this setup and derivation path, your first account should be `0x5409ed021d9299bf6814279a6a1411a7e866a631`, exactly like TestRPC. + #### Redundant RPC subprovider A subprovider which attempts to send an RPC call to a list of RPC endpoints sequentially, until one of them returns a successful response. diff --git a/packages/subproviders/test/integration/ledger_subprovider_test.ts b/packages/subproviders/test/integration/ledger_subprovider_test.ts index a9f538038..8ed69edaf 100644 --- a/packages/subproviders/test/integration/ledger_subprovider_test.ts +++ b/packages/subproviders/test/integration/ledger_subprovider_test.ts @@ -42,6 +42,10 @@ describe('LedgerSubprovider', () => { expect(accounts[0]).to.not.be.an('undefined'); expect(accounts.length).to.be.equal(10); }); + it('returns the expected account', async () => { + const accounts = await ledgerSubprovider.getAccountsAsync(); + expect(accounts[0]).to.be.equal(TEST_RPC_ACCOUNT_0); + }); it('returns requested number of accounts', async () => { const numberOfAccounts = 20; const accounts = await ledgerSubprovider.getAccountsAsync(numberOfAccounts); @@ -61,6 +65,7 @@ describe('LedgerSubprovider', () => { to: '0x0000000000000000000000000000000000000000', value: '0x00', chainId: 3, + from: TEST_RPC_ACCOUNT_0, }; const txHex = await ledgerSubprovider.signTransactionAsync(tx); expect(txHex).to.be.equal( -- cgit v1.2.3 From 1a6c2e2baca33ce377b86f30abe0c16619a3577c Mon Sep 17 00:00:00 2001 From: Jacob Evans Date: Wed, 7 Mar 2018 15:20:06 -0500 Subject: Feedback --- packages/subproviders/CHANGELOG.md | 4 ++-- packages/subproviders/README.md | 4 ++-- packages/subproviders/src/globals.d.ts | 4 ++-- packages/subproviders/test/integration/ledger_subprovider_test.ts | 7 ++++--- 4 files changed, 10 insertions(+), 9 deletions(-) (limited to 'packages') diff --git a/packages/subproviders/CHANGELOG.md b/packages/subproviders/CHANGELOG.md index b7247748e..8e7321d4a 100644 --- a/packages/subproviders/CHANGELOG.md +++ b/packages/subproviders/CHANGELOG.md @@ -1,8 +1,8 @@ # CHANGELOG -## v0.7.0 - _March 6, 2018_ +## v0.7.0 - _TBD_ - * Updated legerco packages. Removed node-hid packages as a dependency. (#437) + * Updated legerco packages. Removed node-hid package as a dependency and make it an optional dependency. It is still used in integration tests but is causing problems for users on Linux distros. (#437) ## v0.6.0 - _March 4, 2018_ diff --git a/packages/subproviders/README.md b/packages/subproviders/README.md index f3e3bd0ae..53fbb2348 100644 --- a/packages/subproviders/README.md +++ b/packages/subproviders/README.md @@ -67,8 +67,8 @@ ledgerSubprovider = new LedgerSubprovider({ ##### Testing Subprovider + Ledger integration To run our integration tests you need a ledger configured with our development mnemonic seed. -This is available in the top level package.json under `mnemonic`. -Configure your ledger and run the integration tests. We assume a derivation path of `m/44'/60'/0'/0` and this is configured in the tests. To this setup and derivation path, your first account should be `0x5409ed021d9299bf6814279a6a1411a7e866a631`, exactly like TestRPC. +Our development mnemonic is `concert load couple harbor equip island argue ramp clarify fence smart topic`. +Configure your ledger and run the integration tests. We assume a derivation path of `m/44'/60'/0'/0` and this is configured in the tests. With this setup and derivation path, your first account should be `0x5409ed021d9299bf6814279a6a1411a7e866a631`, exactly like TestRPC. #### Redundant RPC subprovider diff --git a/packages/subproviders/src/globals.d.ts b/packages/subproviders/src/globals.d.ts index e258ef947..d59ee9e67 100644 --- a/packages/subproviders/src/globals.d.ts +++ b/packages/subproviders/src/globals.d.ts @@ -54,14 +54,14 @@ declare module '@ledgerhq/hw-app-eth' { } declare module '@ledgerhq/hw-transport-u2f' { - export default class TransportU2F { + export default class TransportU2F implements LedgerTransport { public static create(): Promise; public close(): Promise; } } declare module '@ledgerhq/hw-transport-node-hid' { - export default class TransportNodeHid { + export default class TransportNodeHid implements LedgerTransport { public static create(): Promise; public close(): Promise; } diff --git a/packages/subproviders/test/integration/ledger_subprovider_test.ts b/packages/subproviders/test/integration/ledger_subprovider_test.ts index 8ed69edaf..a94cfbe3a 100644 --- a/packages/subproviders/test/integration/ledger_subprovider_test.ts +++ b/packages/subproviders/test/integration/ledger_subprovider_test.ts @@ -1,4 +1,5 @@ import Eth from '@ledgerhq/hw-app-eth'; +// HACK: This depdency is optional and tslint skips optional depdencies // tslint:disable-next-line:no-implicit-dependencies import TransportNodeHid from '@ledgerhq/hw-transport-node-hid'; import * as chai from 'chai'; @@ -23,7 +24,7 @@ async function ledgerEthereumNodeJsClientFactoryAsync(): Promise { @@ -33,7 +34,7 @@ describe('LedgerSubprovider', () => { ledgerSubprovider = new LedgerSubprovider({ networkId, ledgerEthereumClientFactoryAsync: ledgerEthereumNodeJsClientFactoryAsync, - derivationPath: DEFAULT_DERIVATION_PATH, + derivationPath: TESTRPC_DERIVATION_PATH, }); }); describe('direct method calls', () => { @@ -42,7 +43,7 @@ describe('LedgerSubprovider', () => { expect(accounts[0]).to.not.be.an('undefined'); expect(accounts.length).to.be.equal(10); }); - it('returns the expected account', async () => { + it('returns the expected first account from a ledger set up with the test mnemonic', async () => { const accounts = await ledgerSubprovider.getAccountsAsync(); expect(accounts[0]).to.be.equal(TEST_RPC_ACCOUNT_0); }); -- cgit v1.2.3 From bd8b8abfea725dbf0826af407ca1f409a88701bf Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Wed, 7 Mar 2018 21:44:11 +0100 Subject: Improve README --- packages/subproviders/README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) (limited to 'packages') diff --git a/packages/subproviders/README.md b/packages/subproviders/README.md index 53fbb2348..4614342b2 100644 --- a/packages/subproviders/README.md +++ b/packages/subproviders/README.md @@ -64,12 +64,6 @@ ledgerSubprovider = new LedgerSubprovider({ }); ``` -##### Testing Subprovider + Ledger integration - -To run our integration tests you need a ledger configured with our development mnemonic seed. -Our development mnemonic is `concert load couple harbor equip island argue ramp clarify fence smart topic`. -Configure your ledger and run the integration tests. We assume a derivation path of `m/44'/60'/0'/0` and this is configured in the tests. With this setup and derivation path, your first account should be `0x5409ed021d9299bf6814279a6a1411a7e866a631`, exactly like TestRPC. - #### Redundant RPC subprovider A subprovider which attempts to send an RPC call to a list of RPC endpoints sequentially, until one of them returns a successful response. @@ -132,10 +126,12 @@ yarn run test:unit In order to run the integration tests, make sure you have a Ledger Nano S available. +* Setup your Ledger with the development mnemonic seed: `concert load couple harbor equip island argue ramp clarify fence smart topic` * Plug it into your computer * Unlock the device * Open the on-device Ethereum app -* Make sure "browser support" is disabled +* Make sure "browser support" and "contract data" are disabled +* Start [TestRPC](https://github.com/trufflesuite/ganache-cli) locally at port `8545` Then run: @@ -143,6 +139,8 @@ Then run: yarn test:integration ``` +**Note:** We assume a derivation path of `m/44'/60'/0'/0` which is already configured in the tests. With this setup and derivation path, your first account should be `0x5409ed021d9299bf6814279a6a1411a7e866a631`, exactly like TestRPC. + #### All tests ```bash -- cgit v1.2.3