Merge development

packages/order-utils/test/signature_utils_test.ts

@@ -1,3 +1,4 @@
+import { SignerType } from '@0xproject/types';
 import { BigNumber } from '@0xproject/utils';
 import * as chai from 'chai';
 import { JSONRPCErrorCallback, JSONRPCRequestPayload } from 'ethereum-types';
@@ -5,8 +6,8 @@ import * as _ from 'lodash';
 import 'mocha';
 import * as Sinon from 'sinon';
 
-import { generatePseudoRandomSalt, MessagePrefixType } from '../src';
-import { signatureUtils } from '../src/signature_utils';
+import { signatureUtils, generatePseudoRandomSalt } from '../src';
+import { convertECSignatureToSignatureHex, isValidSignatureAsync } from '../src/signature_utils';
 
 import { chaiSetup } from './utils/chai_setup';
 import { provider, web3Wrapper } from './utils/web3_wrapper';
@@ -22,8 +23,9 @@ describe('Signature utils', () => {
         let address = '0x5409ed021d9299bf6814279a6a1411a7e866a631';
 
         it("should return false if the data doesn't pertain to the signature & address", async () => {
+            const bytes32Zeros = '0x0000000000000000000000000000000000000000000000000000000000000000';
             expect(
-                await signatureUtils.isValidSignatureAsync(provider, '0x0', ethSignSignature, address),
+                await signatureUtils.isValidSignatureAsync(provider, bytes32Zeros, ethSignSignature, address),
             ).to.be.false();
         });
         it("should return false if the address doesn't pertain to the signature & data", async () => {
@@ -139,37 +141,28 @@ describe('Signature utils', () => {
             _.each(stubs, s => s.restore());
             stubs = [];
         });
-        it('Should return the correct ECSignature', async () => {
+        it('Should return the correct Signature', async () => {
             const orderHash = '0x6927e990021d23b1eb7b8789f6a6feaf98fe104bb0cf8259421b79f9a34222b0';
-            const expectedECSignature = {
-                v: 27,
-                r: '0x61a3ed31b43c8780e905a260a35faefcc527be7516aa11c0256729b5b351bc33',
-                s: '0x40349190569279751135161d22529dc25add4f6069af05be04cacbda2ace2254',
-            };
-            const messagePrefixOpts = {
-                prefixType: MessagePrefixType.EthSign,
-                shouldAddPrefixBeforeCallingEthSign: false,
-            };
+            const expectedSignature =
+                '0x1b61a3ed31b43c8780e905a260a35faefcc527be7516aa11c0256729b5b351bc3340349190569279751135161d22529dc25add4f6069af05be04cacbda2ace225403';
             const ecSignature = await signatureUtils.ecSignOrderHashAsync(
                 provider,
                 orderHash,
                 makerAddress,
-                messagePrefixOpts,
+                SignerType.Default,
             );
-            expect(ecSignature).to.deep.equal(expectedECSignature);
+            expect(ecSignature).to.equal(expectedSignature);
         });
-        it('should return the correct ECSignature for signatureHex concatenated as R + S + V', async () => {
+        it('should return the correct Signature for signatureHex concatenated as R + S + V', async () => {
             const orderHash = '0x34decbedc118904df65f379a175bb39ca18209d6ce41d5ed549d54e6e0a95004';
-            const expectedECSignature = {
-                v: 27,
-                r: '0x117902c86dfb95fe0d1badd983ee166ad259b27acb220174cbb4460d87287113',
-                s: '0x7feabdfe76e05924b484789f79af4ee7fa29ec006cedce1bbf369320d034e10b',
-            };
+            const expectedSignature =
+                '0x1b117902c86dfb95fe0d1badd983ee166ad259b27acb220174cbb4460d872871137feabdfe76e05924b484789f79af4ee7fa29ec006cedce1bbf369320d034e10b03';
 
             const fakeProvider = {
                 async sendAsync(payload: JSONRPCRequestPayload, callback: JSONRPCErrorCallback): Promise<void> {
                     if (payload.method === 'eth_sign') {
                         const [address, message] = payload.params;
+                        expect(message).to.equal(orderHash);
                         const signature = await web3Wrapper.signMessageAsync(address, message);
                         // tslint:disable-next-line:custom-no-magic-numbers
                         const rsvHex = `0x${signature.substr(130)}${signature.substr(2, 128)}`;
@@ -183,26 +176,18 @@ describe('Signature utils', () => {
                     }
                 },
             };
-
-            const messagePrefixOpts = {
-                prefixType: MessagePrefixType.EthSign,
-                shouldAddPrefixBeforeCallingEthSign: false,
-            };
             const ecSignature = await signatureUtils.ecSignOrderHashAsync(
                 fakeProvider,
                 orderHash,
                 makerAddress,
-                messagePrefixOpts,
+                SignerType.Default,
             );
-            expect(ecSignature).to.deep.equal(expectedECSignature);
+            expect(ecSignature).to.equal(expectedSignature);
         });
-        it('should return the correct ECSignature for signatureHex concatenated as V + R + S', async () => {
+        it('should return the correct Signature for signatureHex concatenated as V + R + S', async () => {
             const orderHash = '0x34decbedc118904df65f379a175bb39ca18209d6ce41d5ed549d54e6e0a95004';
-            const expectedECSignature = {
-                v: 27,
-                r: '0x117902c86dfb95fe0d1badd983ee166ad259b27acb220174cbb4460d87287113',
-                s: '0x7feabdfe76e05924b484789f79af4ee7fa29ec006cedce1bbf369320d034e10b',
-            };
+            const expectedSignature =
+                '0x1b117902c86dfb95fe0d1badd983ee166ad259b27acb220174cbb4460d872871137feabdfe76e05924b484789f79af4ee7fa29ec006cedce1bbf369320d034e10b03';
             const fakeProvider = {
                 async sendAsync(payload: JSONRPCRequestPayload, callback: JSONRPCErrorCallback): Promise<void> {
                     if (payload.method === 'eth_sign') {
@@ -219,17 +204,96 @@ describe('Signature utils', () => {
                 },
             };
 
-            const messagePrefixOpts = {
-                prefixType: MessagePrefixType.EthSign,
-                shouldAddPrefixBeforeCallingEthSign: false,
-            };
             const ecSignature = await signatureUtils.ecSignOrderHashAsync(
                 fakeProvider,
                 orderHash,
                 makerAddress,
-                messagePrefixOpts,
+                SignerType.Default,
+            );
+            expect(ecSignature).to.equal(expectedSignature);
+        });
+        // Note this is due to a bug in Metamask where it does not prefix before signing, this is a known issue and is to be fixed in the future
+        // Source: https://github.com/MetaMask/metamask-extension/commit/a9d36860bec424dcee8db043d3e7da6a5ff5672e
+        it('should receive a payload modified with a prefix when Metamask is SignerType', async () => {
+            const orderHash = '0x34decbedc118904df65f379a175bb39ca18209d6ce41d5ed549d54e6e0a95004';
+            const orderHashPrefixed = '0xae70f31d26096291aa681b26cb7574563956221d0b4213631e1ef9df675d4cba';
+            const expectedSignature =
+                '0x1b117902c86dfb95fe0d1badd983ee166ad259b27acb220174cbb4460d872871137feabdfe76e05924b484789f79af4ee7fa29ec006cedce1bbf369320d034e10b03';
+            // Generated from a MM eth_sign request from 0x5409ed021d9299bf6814279a6a1411a7e866a631 signing 0xae70f31d26096291aa681b26cb7574563956221d0b4213631e1ef9df675d4cba
+            const metamaskSignature =
+                '0x117902c86dfb95fe0d1badd983ee166ad259b27acb220174cbb4460d872871137feabdfe76e05924b484789f79af4ee7fa29ec006cedce1bbf369320d034e10b1b';
+            const fakeProvider = {
+                async sendAsync(payload: JSONRPCRequestPayload, callback: JSONRPCErrorCallback): Promise<void> {
+                    if (payload.method === 'eth_sign') {
+                        const [, message] = payload.params;
+                        expect(message).to.equal(orderHashPrefixed);
+                        callback(null, {
+                            id: 42,
+                            jsonrpc: '2.0',
+                            result: metamaskSignature,
+                        });
+                    } else {
+                        callback(null, { id: 42, jsonrpc: '2.0', result: [makerAddress] });
+                    }
+                },
+            };
+
+            const ecSignature = await signatureUtils.ecSignOrderHashAsync(
+                fakeProvider,
+                orderHash,
+                makerAddress,
+                SignerType.Metamask,
+            );
+            expect(ecSignature).to.equal(expectedSignature);
+        });
+        it('should return a valid signature', async () => {
+            const orderHash = '0x34decbedc118904df65f379a175bb39ca18209d6ce41d5ed549d54e6e0a95004';
+            const ecSignature = await signatureUtils.ecSignOrderHashAsync(
+                provider,
+                orderHash,
+                makerAddress,
+                SignerType.Default,
+            );
+
+            const isValidSignature = await isValidSignatureAsync(provider, orderHash, ecSignature, makerAddress);
+            expect(isValidSignature).to.be.true();
+        });
+    });
+    describe('#convertECSignatureToSignatureHex', () => {
+        const ecSignature: ECSignature = {
+            v: 27,
+            r: '0xaca7da997ad177f040240cdccf6905b71ab16b74434388c3a72f34fd25d64393',
+            s: '0x46b2bac274ff29b48b3ea6e2d04c1336eaceafda3c53ab483fc3ff12fac3ebf2',
+        };
+        it('should concatenate v,r,s and append the Trezor signature type', async () => {
+            const expectedSignatureWithSignatureType =
+                '0x1baca7da997ad177f040240cdccf6905b71ab16b74434388c3a72f34fd25d6439346b2bac274ff29b48b3ea6e2d04c1336eaceafda3c53ab483fc3ff12fac3ebf208';
+            const signatureWithSignatureType = convertECSignatureToSignatureHex(ecSignature, SignerType.Trezor);
+            expect(signatureWithSignatureType).to.equal(expectedSignatureWithSignatureType);
+        });
+        it('should concatenate v,r,s and append the EthSign signature type when SignerType is Default', async () => {
+            const expectedSignatureWithSignatureType =
+                '0x1baca7da997ad177f040240cdccf6905b71ab16b74434388c3a72f34fd25d6439346b2bac274ff29b48b3ea6e2d04c1336eaceafda3c53ab483fc3ff12fac3ebf203';
+            const signatureWithSignatureType = convertECSignatureToSignatureHex(ecSignature, SignerType.Default);
+            expect(signatureWithSignatureType).to.equal(expectedSignatureWithSignatureType);
+        });
+        it('should concatenate v,r,s and append the EthSign signature type when SignerType is Ledger', async () => {
+            const expectedSignatureWithSignatureType =
+                '0x1baca7da997ad177f040240cdccf6905b71ab16b74434388c3a72f34fd25d6439346b2bac274ff29b48b3ea6e2d04c1336eaceafda3c53ab483fc3ff12fac3ebf203';
+            const signatureWithSignatureType = convertECSignatureToSignatureHex(ecSignature, SignerType.Ledger);
+            expect(signatureWithSignatureType).to.equal(expectedSignatureWithSignatureType);
+        });
+        it('should concatenate v,r,s and append the EthSign signature type when SignerType is Metamask', async () => {
+            const expectedSignatureWithSignatureType =
+                '0x1baca7da997ad177f040240cdccf6905b71ab16b74434388c3a72f34fd25d6439346b2bac274ff29b48b3ea6e2d04c1336eaceafda3c53ab483fc3ff12fac3ebf203';
+            const signatureWithSignatureType = convertECSignatureToSignatureHex(ecSignature, SignerType.Metamask);
+            expect(signatureWithSignatureType).to.equal(expectedSignatureWithSignatureType);
+        });
+        it('should throw if the SignerType is invalid', async () => {
+            const expectedMessage = 'Unrecognized SignerType: INVALID_SIGNER';
+            expect(() => convertECSignatureToSignatureHex(ecSignature, 'INVALID_SIGNER' as SignerType)).to.throw(
+                expectedMessage,
             );
-            expect(ecSignature).to.deep.equal(expectedECSignature);
         });
     });
 });