Merge branch 'development' into refactor/httpClientJsonParsing

* development: (21 commits)
  Update connect CHANGELOG
  Changes to abi-gen after code review
  Added constructor ABIs to abi-gen
  Describe #295 in a CHANGELOG
  Add #302 description to changelog
  Fix formatting
  Apply prettier config
  Install prettier
  Remove formatting esilnt rules
  sendTransactionAsync should return txHash string
  Added Event generation to abi-gen
  Publish
  Add dates to CHANGELOG entries
  Update subproviders CHANGELOG
  Support both personal_sign and eth_sign
  Fix Ledger tests given change from `personal_sign` to `eth_sign`
  Update subprovider to catch correct RPC method
  Rename guide
  Update contribution guide
  Fix broken links in the abi-gen README
  ...

4 files changed, 87 insertions, 49 deletions

diff --git a/packages/subproviders/test/integration/ledger_subprovider_test.ts b/packages/subproviders/test/integration/ledger_subprovider_test.ts
index ab4ffb19a..628b532d7 100644
--- a/packages/subproviders/test/integration/ledger_subprovider_test.ts
+++ b/packages/subproviders/test/integration/ledger_subprovider_test.ts
@@ -6,15 +6,10 @@ 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;
@@ -51,8 +46,9 @@ describe('LedgerSubprovider', () => {
                 chainId: 3,
             };
             const txHex = await ledgerSubprovider.signTransactionAsync(tx);
-            // tslint:disable-next-line:max-line-length
-            expect(txHex).to.be.equal('0xf85f8080822710940000000000000000000000000000000000000000808077a088a95ef1378487bc82be558e82c8478baf840c545d5b887536bb1da63673a98ba0019f4a4b9a107d1e6752bf7f701e275f28c13791d6e76af895b07373462cefaa');
+            expect(txHex).to.be.equal(
+                '0xf85f8080822710940000000000000000000000000000000000000000808077a088a95ef1378487bc82be558e82c8478baf840c545d5b887536bb1da63673a98ba0019f4a4b9a107d1e6752bf7f701e275f28c13791d6e76af895b07373462cefaa',
+            );
         });
     });
     describe('calls through a provider', () => {
@@ -85,7 +81,27 @@ describe('LedgerSubprovider', () => {
             });
             ledgerProvider.sendAsync(payload, callback);
         });
-        it('signs a personal message', (done: DoneCallback) => {
+        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();
diff --git a/packages/subproviders/test/unit/ledger_subprovider_test.ts b/packages/subproviders/test/unit/ledger_subprovider_test.ts
index 237090051..1c70dd3a6 100644
--- a/packages/subproviders/test/unit/ledger_subprovider_test.ts
+++ b/packages/subproviders/test/unit/ledger_subprovider_test.ts
@@ -5,16 +5,10 @@ import Web3 = require('web3');
 import Web3ProviderEngine = require('web3-provider-engine');
 import RpcSubprovider = require('web3-provider-engine/subproviders/rpc');
 
-import {
-    LedgerSubprovider,
-} from '../../src';
-import {
-    DoneCallback,
-    LedgerCommunicationClient,
-    LedgerSubproviderErrors,
-} from '../../src/types';
-import {chaiSetup} from '../chai_setup';
-import {reportCallbackErrors} from '../utils/report_callback_errors';
+import { LedgerSubprovider } from '../../src';
+import { DoneCallback, LedgerCommunicationClient, LedgerSubproviderErrors } from '../../src/types';
+import { chaiSetup } from '../chai_setup';
+import { reportCallbackErrors } from '../utils/report_callback_errors';
 
 chaiSetup.configure();
 const expect = chai.expect;
@@ -28,8 +22,8 @@ describe('LedgerSubprovider', () => {
             // tslint:disable:no-object-literal-type-assertion
             const ledgerEthClient = {
                 getAddress_async: async () => {
-                    // tslint:disable-next-line:max-line-length
-                    const publicKey = '04f428290f4c5ed6a198f71b8205f488141dbb3f0840c923bbfa798ecbee6370986c03b5575d94d506772fb48a6a44e345e4ebd4f028a6f609c44b655d6d3e71a1';
+                    const publicKey =
+                        '04f428290f4c5ed6a198f71b8205f488141dbb3f0840c923bbfa798ecbee6370986c03b5575d94d506772fb48a6a44e345e4ebd4f028a6f609c44b655d6d3e71a1';
                     const chainCode = 'ac055a5537c0c7e9e02d14a197cad6b857836da2a12043b46912a37d959b5ae8';
                     const address = '0xBa388BA5e5EEF2c6cE42d831c2B3A28D3c99bdB1';
                     return {
@@ -76,17 +70,20 @@ describe('LedgerSubprovider', () => {
             it('signs a personal message', async () => {
                 const data = ethUtils.bufferToHex(ethUtils.toBuffer('hello world'));
                 const ecSignatureHex = await ledgerSubprovider.signPersonalMessageAsync(data);
-                // tslint:disable-next-line:max-line-length
-                expect(ecSignatureHex).to.be.equal('0xa6cc284bff14b42bdf5e9286730c152be91719d478605ec46b3bebcd0ae491480652a1a7b742ceb0213d1e744316e285f41f878d8af0b8e632cbca4c279132d001');
+                expect(ecSignatureHex).to.be.equal(
+                    '0xa6cc284bff14b42bdf5e9286730c152be91719d478605ec46b3bebcd0ae491480652a1a7b742ceb0213d1e744316e285f41f878d8af0b8e632cbca4c279132d001',
+                );
             });
         });
         describe('failure cases', () => {
             it('cannot open multiple simultaneous connections to the Ledger device', async () => {
                 const data = ethUtils.bufferToHex(ethUtils.toBuffer('hello world'));
-                return expect(Promise.all([
-                    ledgerSubprovider.getAccountsAsync(),
-                    ledgerSubprovider.signPersonalMessageAsync(data),
-                ])).to.be.rejectedWith(LedgerSubproviderErrors.MultipleOpenConnectionsDisallowed);
+                return expect(
+                    Promise.all([
+                        ledgerSubprovider.getAccountsAsync(),
+                        ledgerSubprovider.signPersonalMessageAsync(data),
+                    ]),
+                ).to.be.rejectedWith(LedgerSubproviderErrors.MultipleOpenConnectionsDisallowed);
             });
         });
     });
@@ -117,7 +114,24 @@ describe('LedgerSubprovider', () => {
                 });
                 provider.sendAsync(payload, callback);
             });
-            it('signs a personal message', (done: DoneCallback) => {
+            it('signs a personal message with eth_sign', (done: DoneCallback) => {
+                const messageHex = ethUtils.bufferToHex(ethUtils.toBuffer('hello world'));
+                const payload = {
+                    jsonrpc: '2.0',
+                    method: 'eth_sign',
+                    params: ['0x0000000000000000000000000000000000000000', messageHex],
+                    id: 1,
+                };
+                const callback = reportCallbackErrors(done)((err: Error, response: Web3.JSONRPCResponsePayload) => {
+                    expect(err).to.be.a('null');
+                    expect(response.result).to.be.equal(
+                        '0xa6cc284bff14b42bdf5e9286730c152be91719d478605ec46b3bebcd0ae491480652a1a7b742ceb0213d1e744316e285f41f878d8af0b8e632cbca4c279132d001',
+                    );
+                    done();
+                });
+                provider.sendAsync(payload, callback);
+            });
+            it('signs a personal message with personal_sign', (done: DoneCallback) => {
                 const messageHex = ethUtils.bufferToHex(ethUtils.toBuffer('hello world'));
                 const payload = {
                     jsonrpc: '2.0',
@@ -127,8 +141,9 @@ describe('LedgerSubprovider', () => {
                 };
                 const callback = reportCallbackErrors(done)((err: Error, response: Web3.JSONRPCResponsePayload) => {
                     expect(err).to.be.a('null');
-                    // tslint:disable-next-line:max-line-length
-                    expect(response.result).to.be.equal('0xa6cc284bff14b42bdf5e9286730c152be91719d478605ec46b3bebcd0ae491480652a1a7b742ceb0213d1e744316e285f41f878d8af0b8e632cbca4c279132d001');
+                    expect(response.result).to.be.equal(
+                        '0xa6cc284bff14b42bdf5e9286730c152be91719d478605ec46b3bebcd0ae491480652a1a7b742ceb0213d1e744316e285f41f878d8af0b8e632cbca4c279132d001',
+                    );
                     done();
                 });
                 provider.sendAsync(payload, callback);
@@ -157,6 +172,21 @@ describe('LedgerSubprovider', () => {
             });
         });
         describe('failure cases', () => {
+            it('should throw if `data` param not hex when calling eth_sign', (done: DoneCallback) => {
+                const nonHexMessage = 'hello world';
+                const payload = {
+                    jsonrpc: '2.0',
+                    method: 'eth_sign',
+                    params: ['0x0000000000000000000000000000000000000000', nonHexMessage],
+                    id: 1,
+                };
+                const callback = reportCallbackErrors(done)((err: Error, response: Web3.JSONRPCResponsePayload) => {
+                    expect(err).to.not.be.a('null');
+                    expect(err.message).to.be.equal('Expected data to be of type HexString, encountered: hello world');
+                    done();
+                });
+                provider.sendAsync(payload, callback);
+            });
             it('should throw if `data` param not hex when calling personal_sign', (done: DoneCallback) => {
                 const nonHexMessage = 'hello world';
                 const payload = {
@@ -190,8 +220,7 @@ describe('LedgerSubprovider', () => {
                 });
                 provider.sendAsync(payload, callback);
             });
-            it('should throw if `from` param invalid address when calling eth_sendTransaction',
-               (done: DoneCallback) => {
+            it('should throw if `from` param invalid address when calling eth_sendTransaction', (done: DoneCallback) => {
                 const tx = {
                     to: '0xafa3f8684e54059998bc3a7b0d2b0da075154d66',
                     from: '0xIncorrectEthereumAddress',
diff --git a/packages/subproviders/test/unit/redundant_rpc_subprovider_test.ts b/packages/subproviders/test/unit/redundant_rpc_subprovider_test.ts
index 2f1676915..c3170745c 100644
--- a/packages/subproviders/test/unit/redundant_rpc_subprovider_test.ts
+++ b/packages/subproviders/test/unit/redundant_rpc_subprovider_test.ts
@@ -3,12 +3,10 @@ import * as _ from 'lodash';
 import Web3 = require('web3');
 import Web3ProviderEngine = require('web3-provider-engine');
 
-import {RedundantRPCSubprovider} from '../../src';
-import {
-    DoneCallback,
-} from '../../src/types';
-import {chaiSetup} from '../chai_setup';
-import {reportCallbackErrors} from '../utils/report_callback_errors';
+import { RedundantRPCSubprovider } from '../../src';
+import { DoneCallback } from '../../src/types';
+import { chaiSetup } from '../chai_setup';
+import { reportCallbackErrors } from '../utils/report_callback_errors';
 
 const expect = chai.expect;
 chaiSetup.configure();
@@ -17,9 +15,7 @@ describe('RedundantRpcSubprovider', () => {
     let provider: Web3ProviderEngine;
     it('succeeds when supplied a healthy endpoint', (done: DoneCallback) => {
         provider = new Web3ProviderEngine();
-        const endpoints = [
-            'http://localhost:8545',
-        ];
+        const endpoints = ['http://localhost:8545'];
         const redundantSubprovider = new RedundantRPCSubprovider(endpoints);
         provider.addProvider(redundantSubprovider);
         provider.start();
@@ -39,10 +35,7 @@ describe('RedundantRpcSubprovider', () => {
     });
     it('succeeds when supplied at least one healthy endpoint', (done: DoneCallback) => {
         provider = new Web3ProviderEngine();
-        const endpoints = [
-            'http://does-not-exist:3000',
-            'http://localhost:8545',
-        ];
+        const endpoints = ['http://does-not-exist:3000', 'http://localhost:8545'];
         const redundantSubprovider = new RedundantRPCSubprovider(endpoints);
         provider.addProvider(redundantSubprovider);
         provider.start();
diff --git a/packages/subproviders/test/utils/report_callback_errors.ts b/packages/subproviders/test/utils/report_callback_errors.ts
index 0aaef3f05..8a8f4d966 100644
--- a/packages/subproviders/test/utils/report_callback_errors.ts
+++ b/packages/subproviders/test/utils/report_callback_errors.ts
@@ -1,4 +1,4 @@
-import {DoneCallback} from '../../src/types';
+import { DoneCallback } from '../../src/types';
 
 export const reportCallbackErrors = (done: DoneCallback) => {
     return (f: (...args: any[]) => void) => {