Merge pull request #47 from 0xProject/is-valid-signature-contract

Refactor isValidSignature

5 files changed, 33 insertions, 129 deletions

diff --git a/package.json b/package.json
index 26ae8a504..9d774ed7b 100644
--- a/package.json
+++ b/package.json
@@ -55,7 +55,7 @@
     "bignumber.js": "^4.0.2",
     "chai": "^4.0.1",
     "chai-as-promised": "^6.0.0",
-    "chai-as-promised-typescript-typings": "0.0.2",
+    "chai-as-promised-typescript-typings": "0.0.3",
     "chai-bignumber": "git+ssh://git@github.com:0xProject/chai-bignumber.git",
     "chai-typescript-typings": "^0.0.0",
     "copyfiles": "^1.2.0",
diff --git a/src/contract_wrappers/exchange_wrapper.ts b/src/contract_wrappers/exchange_wrapper.ts
index 2e1f887d8..72ae0d07e 100644
--- a/src/contract_wrappers/exchange_wrapper.ts
+++ b/src/contract_wrappers/exchange_wrapper.ts
@@ -71,8 +71,8 @@ export class ExchangeWrapper extends ContractWrapper {
         await this.stopWatchingExchangeLogEventsAsync();
         delete this.exchangeContractIfExists;
     }
-    public async isValidSignatureAsync(dataHex: string, ecSignature: ECSignature,
-                                       signerAddressHex: string): Promise<boolean> {
+    private async isValidSignatureUsingContractCallAsync(dataHex: string, ecSignature: ECSignature,
+                                                         signerAddressHex: string): Promise<boolean> {
         assert.isHexString('dataHex', dataHex);
         assert.doesConformToSchema('ecSignature', ecSignature, ecSignatureSchema);
         assert.isETHAddressHex('signerAddressHex', signerAddressHex);
diff --git a/test/0x.js_test.ts b/test/0x.js_test.ts
index 58f259a11..d41cbefd7 100644
--- a/test/0x.js_test.ts
+++ b/test/0x.js_test.ts
@@ -6,8 +6,9 @@ import * as BigNumber from 'bignumber.js';
 import * as Sinon from 'sinon';
 import {ZeroEx} from '../src/0x.js';
 import {constants} from './utils/constants';
-import {web3Factory} from './utils/web3_factory';
 import {Order} from '../src/types';
+import {ECSignature} from '../src/types';
+import {web3Factory} from './utils/web3_factory';
 
 chaiSetup.configure();
 const expect = chai.expect;
@@ -51,60 +52,33 @@ describe('ZeroEx library', () => {
             s: '0x2d887fd3b17bfdce3481f10bea41f45ba9f709d39ce8325427b57afcfc994cee',
         };
         const address = '0x9b2055d370f73ec7d8a03e965129118dc8f5bf83';
-        describe('should throw if passed a malformed signature', () => {
-            it('malformed v', () => {
-                const malformedSignature = {
-                    v: 34,
-                    r: signature.r,
-                    s: signature.s,
-                };
-                expect(() => ZeroEx.isValidSignature(data, malformedSignature, address)).to.throw();
-            });
-            it('r lacks 0x prefix', () => {
-                const malformedR = signature.r.replace('0x', '');
-                const malformedSignature = {
-                    v: signature.v,
-                    r: malformedR,
-                    s: signature.s,
-                };
-                expect(() => ZeroEx.isValidSignature(data, malformedSignature, address)).to.throw();
-            });
-            it('r is too short', () => {
-                const malformedR = signature.r.substr(10);
-                const malformedSignature = {
-                    v: signature.v,
-                    r: malformedR,
-                    s: signature.s.replace('0', 'z'),
-                };
-                expect(() => ZeroEx.isValidSignature(data, malformedSignature, address)).to.throw();
-            });
-            it('s is not hex', () => {
-                const malformedS = signature.s.replace('0', 'z');
-                const malformedSignature = {
-                    v: signature.v,
-                    r: signature.r,
-                    s: malformedS,
-                };
-                expect(() => ZeroEx.isValidSignature(data, malformedSignature, address)).to.throw();
-            });
-        });
-        it('should return false if the data doesn\'t pertain to the signature & address', () => {
-            const isValid = ZeroEx.isValidSignature('0x0', signature, address);
-            expect(isValid).to.be.false();
+        const web3 = web3Factory.create();
+        const zeroEx = new ZeroEx(web3);
+        it('should return false if the data doesn\'t pertain to the signature & address', async () => {
+            expect(ZeroEx.isValidSignature('0x0', signature, address)).to.be.false();
+            return expect(
+                (zeroEx.exchange as any).isValidSignatureUsingContractCallAsync('0x0', signature, address),
+            ).to.become(false);
         });
-        it('should return false if the address doesn\'t pertain to the signature & data', () => {
+        it('should return false if the address doesn\'t pertain to the signature & data', async () => {
             const validUnrelatedAddress = '0x8b0292B11a196601eD2ce54B665CaFEca0347D42';
-            const isValid = ZeroEx.isValidSignature(data, signature, validUnrelatedAddress);
-            expect(isValid).to.be.false();
+            expect(ZeroEx.isValidSignature(data, signature, validUnrelatedAddress)).to.be.false();
+            return expect(
+                (zeroEx.exchange as any).isValidSignatureUsingContractCallAsync(data, signature, validUnrelatedAddress),
+            ).to.become(false);
         });
-        it('should return false if the signature doesn\'t pertain to the data & address', () => {
+        it('should return false if the signature doesn\'t pertain to the data & address', async () => {
             const wrongSignature = _.assign({}, signature, {v: 28});
-            const isValid = ZeroEx.isValidSignature(data, wrongSignature, address);
-            expect(isValid).to.be.false();
-        });
-        it('should return true if the signature does pertain to the data & address', () => {
-            const isValid = ZeroEx.isValidSignature(data, signature, address);
-            expect(isValid).to.be.true();
+            expect(ZeroEx.isValidSignature(data, wrongSignature, address)).to.be.false();
+            return expect(
+                (zeroEx.exchange as any).isValidSignatureUsingContractCallAsync(data, wrongSignature, address),
+            ).to.become(false);
+        });
+        it('should return true if the signature does pertain to the data & address', async () => {
+            expect(ZeroEx.isValidSignature(data, signature, address)).to.be.true();
+            return expect(
+                (zeroEx.exchange as any).isValidSignatureUsingContractCallAsync(data, signature, address),
+            ).to.become(true);
         });
     });
     describe('#generateSalt', () => {
diff --git a/test/exchange_wrapper_test.ts b/test/exchange_wrapper_test.ts
index 097fafa46..e3d8be1c0 100644
--- a/test/exchange_wrapper_test.ts
+++ b/test/exchange_wrapper_test.ts
@@ -52,76 +52,6 @@ describe('ExchangeWrapper', () => {
     afterEach(async () => {
         await blockchainLifecycle.revertAsync();
     });
-    describe('#isValidSignatureAsync', () => {
-        // The Exchange smart contract `isValidSignature` method only validates orderHashes and assumes
-        // the length of the data is exactly 32 bytes. Thus for these tests, we use data of this size.
-        const dataHex = '0x6927e990021d23b1eb7b8789f6a6feaf98fe104bb0cf8259421b79f9a34222b0';
-        const signature = {
-            v: 27,
-            r: '0x61a3ed31b43c8780e905a260a35faefcc527be7516aa11c0256729b5b351bc33',
-            s: '0x40349190569279751135161d22529dc25add4f6069af05be04cacbda2ace2254',
-        };
-        const address = '0x5409ed021d9299bf6814279a6a1411a7e866a631';
-        describe('should throw if passed a malformed signature', () => {
-            it('malformed v', async () => {
-                const malformedSignature = {
-                    v: 34,
-                    r: signature.r,
-                    s: signature.s,
-                };
-                return expect(zeroEx.exchange.isValidSignatureAsync(dataHex, malformedSignature, address))
-                    .to.be.rejected();
-            });
-            it('r lacks 0x prefix', async () => {
-                const malformedR = signature.r.replace('0x', '');
-                const malformedSignature = {
-                    v: signature.v,
-                    r: malformedR,
-                    s: signature.s,
-                };
-                return expect(zeroEx.exchange.isValidSignatureAsync(dataHex, malformedSignature, address))
-                    .to.be.rejected();
-            });
-            it('r is too short', async () => {
-                const malformedR = signature.r.substr(10);
-                const malformedSignature = {
-                    v: signature.v,
-                    r: malformedR,
-                    s: signature.s.replace('0', 'z'),
-                };
-                return expect(zeroEx.exchange.isValidSignatureAsync(dataHex, malformedSignature, address))
-                    .to.be.rejected();
-            });
-            it('s is not hex', async () => {
-                const malformedS = signature.s.replace('0', 'z');
-                const malformedSignature = {
-                    v: signature.v,
-                    r: signature.r,
-                    s: malformedS,
-                };
-                return expect(zeroEx.exchange.isValidSignatureAsync(dataHex, malformedSignature, address))
-                    .to.be.rejected();
-            });
-        });
-        it('should return false if the data doesn\'t pertain to the signature & address', async () => {
-            const isValid = await zeroEx.exchange.isValidSignatureAsync('0x0', signature, address);
-            expect(isValid).to.be.false();
-        });
-        it('should return false if the address doesn\'t pertain to the signature & dataHex', async () => {
-            const validUnrelatedAddress = '0x8b0292B11a196601eD2ce54B665CaFEca0347D42';
-            const isValid = await zeroEx.exchange.isValidSignatureAsync(dataHex, signature, validUnrelatedAddress);
-            expect(isValid).to.be.false();
-        });
-        it('should return false if the signature doesn\'t pertain to the dataHex & address', async () => {
-            const wrongSignature = {...signature, v: 28};
-            const isValid = await zeroEx.exchange.isValidSignatureAsync(dataHex, wrongSignature, address);
-            expect(isValid).to.be.false();
-        });
-        it('should return true if the signature does pertain to the dataHex & address', async () => {
-            const isValid = await zeroEx.exchange.isValidSignatureAsync(dataHex, signature, address);
-            expect(isValid).to.be.true();
-        });
-    });
     describe('#fillOrKillOrderAsync', () => {
         let makerTokenAddress: string;
         let takerTokenAddress: string;
diff --git a/yarn.lock b/yarn.lock
index 24104702b..abe7ca550 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -902,9 +902,9 @@ center-align@^0.1.1:
     align-text "^0.1.3"
     lazy-cache "^1.0.3"
 
-chai-as-promised-typescript-typings@0.0.2:
-  version "0.0.2"
-  resolved "https://registry.yarnpkg.com/chai-as-promised-typescript-typings/-/chai-as-promised-typescript-typings-0.0.2.tgz#5df99c418917a78eb314e5f83f306cb95ae846cb"
+chai-as-promised-typescript-typings@0.0.3:
+  version "0.0.3"
+  resolved "https://registry.yarnpkg.com/chai-as-promised-typescript-typings/-/chai-as-promised-typescript-typings-0.0.3.tgz#8694287ebe2dd6c18a96667c38151d714d6ecbb6"
   dependencies:
     chai-typescript-typings "^0.0.0"
 
@@ -1169,13 +1169,13 @@ debug-log@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/debug-log/-/debug-log-1.0.1.tgz#2307632d4c04382b8df8a32f70b895046d52745f"
 
-debug@2.6.0, debug@^2.1.1, debug@^2.2.0:
+debug@2.6.0:
   version "2.6.0"
   resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.0.tgz#bc596bcabe7617f11d9fa15361eded5608b8499b"
   dependencies:
     ms "0.7.2"
 
-debug@^2.6.3:
+debug@^2.1.1, debug@^2.2.0, debug@^2.6.3:
   version "2.6.8"
   resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.8.tgz#e731531ca2ede27d188222427da17821d68ff4fc"
   dependencies: