Merge pull request #1102 from 0xProject/feature/0x.js/eip712-sign-typed-data

[0x.js][order-utils][web3-wrapper] Expose eth_signTypedData functionality for order signing

4 files changed, 47 insertions, 1 deletions

diff --git a/packages/web3-wrapper/CHANGELOG.json b/packages/web3-wrapper/CHANGELOG.json
index 47f054300..be5c1fef6 100644
--- a/packages/web3-wrapper/CHANGELOG.json
+++ b/packages/web3-wrapper/CHANGELOG.json
@@ -1,5 +1,19 @@
 [
     {
+        "version": "3.1.0",
+        "changes": [
+            {
+                "note": "Add `signTypedData` to perform EIP712 `eth_signTypedData`.",
+                "pr": 1102
+            },
+            {
+                "note":
+                    "Web3Wrapper now throws when an RPC request contains an error field in the response. Previously errors could be swallowed and undefined returned.",
+                "pr": 1102
+            }
+        ]
+    },
+    {
         "version": "3.0.3",
         "changes": [
             {
diff --git a/packages/web3-wrapper/src/index.ts b/packages/web3-wrapper/src/index.ts
index 7cdd25e55..9bef06fd4 100644
--- a/packages/web3-wrapper/src/index.ts
+++ b/packages/web3-wrapper/src/index.ts
@@ -30,6 +30,7 @@ export {
     OpCode,
     TxDataPayable,
     JSONRPCResponsePayload,
+    JSONRPCResponseError,
     RawLogEntry,
     DecodedLogEntryEvent,
     LogWithDecodedArgs,
diff --git a/packages/web3-wrapper/src/web3_wrapper.ts b/packages/web3-wrapper/src/web3_wrapper.ts
index d52c1cb6e..726246f1a 100644
--- a/packages/web3-wrapper/src/web3_wrapper.ts
+++ b/packages/web3-wrapper/src/web3_wrapper.ts
@@ -315,6 +315,21 @@ export class Web3Wrapper {
         return signData;
     }
     /**
+     * Sign an EIP712 typed data message with a specific address's private key (`eth_signTypedData`)
+     * @param address Address of signer
+     * @param typedData Typed data message to sign
+     * @returns Signature string (as RSV)
+     */
+    public async signTypedDataAsync(address: string, typedData: any): Promise<string> {
+        assert.isETHAddressHex('address', address);
+        assert.doesConformToSchema('typedData', typedData, schemas.eip712TypedDataSchema);
+        const signData = await this.sendRawPayloadAsync<string>({
+            method: 'eth_signTypedData',
+            params: [address, typedData],
+        });
+        return signData;
+    }
+    /**
      * Fetches the latest block number
      * @returns Block number
      */
@@ -654,6 +669,9 @@ export class Web3Wrapper {
             ...payload,
         };
         const response = await promisify<JSONRPCResponsePayload>(sendAsync)(payloadWithDefaults);
+        if (response.error) {
+            throw new Error(response.error.message);
+        }
         const result = response.result;
         return result;
     }
diff --git a/packages/web3-wrapper/test/web3_wrapper_test.ts b/packages/web3-wrapper/test/web3_wrapper_test.ts
index 385c469bf..164253777 100644
--- a/packages/web3-wrapper/test/web3_wrapper_test.ts
+++ b/packages/web3-wrapper/test/web3_wrapper_test.ts
@@ -1,5 +1,5 @@
 import * as chai from 'chai';
-import { BlockParamLiteral } from 'ethereum-types';
+import { BlockParamLiteral, JSONRPCErrorCallback, JSONRPCRequestPayload } from 'ethereum-types';
 import * as Ganache from 'ganache-core';
 import * as _ from 'lodash';
 import 'mocha';
@@ -78,6 +78,19 @@ describe('Web3Wrapper tests', () => {
             const signatureLength = 132;
             expect(signature.length).to.be.equal(signatureLength);
         });
+        it('should throw if the provider returns an error', async () => {
+            const message = '0xdeadbeef';
+            const signer = addresses[1];
+            const fakeProvider = {
+                async sendAsync(payload: JSONRPCRequestPayload, callback: JSONRPCErrorCallback): Promise<void> {
+                    callback(new Error('User denied message signature'));
+                },
+            };
+            const errorWeb3Wrapper = new Web3Wrapper(fakeProvider);
+            expect(errorWeb3Wrapper.signMessageAsync(signer, message)).to.be.rejectedWith(
+                'User denied message signature',
+            );
+        });
     });
     describe('#getBlockNumberAsync', () => {
         it('get block number', async () => {