Merge pull request #560 from 0xProject/refactor/contracts/structure

Update contracts structure

3 files changed, 248 insertions, 178 deletions

diff --git a/packages/contracts/test/exchange/helpers.ts b/packages/contracts/test/exchange/helpers.ts
deleted file mode 100644
index f986665ff..000000000
--- a/packages/contracts/test/exchange/helpers.ts
+++ /dev/null
@@ -1,178 +0,0 @@
-import { ZeroEx } from '0x.js';
-import { BlockchainLifecycle } from '@0xproject/dev-utils';
-import { BigNumber } from '@0xproject/utils';
-import * as chai from 'chai';
-import ethUtil = require('ethereumjs-util');
-
-import { ExchangeContract } from '../../src/contract_wrappers/generated/exchange';
-import { addressUtils } from '../../src/utils/address_utils';
-import { assetProxyUtils } from '../../src/utils/asset_proxy_utils';
-import { constants } from '../../src/utils/constants';
-import { ExchangeWrapper } from '../../src/utils/exchange_wrapper';
-import { OrderFactory } from '../../src/utils/order_factory';
-import { orderUtils } from '../../src/utils/order_utils';
-import { AssetProxyId, ContractName, SignedOrder } from '../../src/utils/types';
-import { chaiSetup } from '../utils/chai_setup';
-import { deployer } from '../utils/deployer';
-import { provider, web3Wrapper } from '../utils/web3_wrapper';
-
-chaiSetup.configure();
-const expect = chai.expect;
-
-const blockchainLifecycle = new BlockchainLifecycle(web3Wrapper);
-
-describe('Exchange helpers', () => {
-    let signedOrder: SignedOrder;
-    let exchangeWrapper: ExchangeWrapper;
-    let orderFactory: OrderFactory;
-
-    before(async () => {
-        const accounts = await web3Wrapper.getAvailableAddressesAsync();
-        const makerAddress = accounts[0];
-        const exchangeInstance = await deployer.deployAsync(ContractName.Exchange, [AssetProxyId.ERC20]);
-        const exchange = new ExchangeContract(exchangeInstance.abi, exchangeInstance.address, provider);
-        const zeroEx = new ZeroEx(provider, { networkId: constants.TESTRPC_NETWORK_ID });
-        exchangeWrapper = new ExchangeWrapper(exchange, zeroEx);
-
-        const defaultOrderParams = {
-            ...constants.STATIC_ORDER_PARAMS,
-            exchangeAddress: exchange.address,
-            makerAddress,
-            feeRecipientAddress: addressUtils.generatePseudoRandomAddress(),
-            makerAssetData: assetProxyUtils.encodeERC20ProxyData(addressUtils.generatePseudoRandomAddress()),
-            takerAssetData: assetProxyUtils.encodeERC20ProxyData(addressUtils.generatePseudoRandomAddress()),
-        };
-        const privateKey = constants.TESTRPC_PRIVATE_KEYS[accounts.indexOf(makerAddress)];
-        orderFactory = new OrderFactory(privateKey, defaultOrderParams);
-    });
-
-    beforeEach(async () => {
-        await blockchainLifecycle.startAsync();
-        signedOrder = orderFactory.newSignedOrder();
-    });
-    afterEach(async () => {
-        await blockchainLifecycle.revertAsync();
-    });
-
-    describe('getOrderHash', () => {
-        it('should output the correct orderHash', async () => {
-            const orderHashHex = await exchangeWrapper.getOrderHashAsync(signedOrder);
-            expect(orderUtils.getOrderHashHex(signedOrder)).to.be.equal(orderHashHex);
-        });
-    });
-
-    describe('isValidSignature', () => {
-        beforeEach(async () => {
-            signedOrder = orderFactory.newSignedOrder();
-        });
-
-        it('should return true with a valid signature', async () => {
-            const success = await exchangeWrapper.isValidSignatureAsync(signedOrder);
-            expect(success).to.be.true();
-        });
-
-        it('should return false with an invalid signature', async () => {
-            const invalidR = ethUtil.sha3('invalidR');
-            const invalidS = ethUtil.sha3('invalidS');
-            const invalidSigBuff = Buffer.concat([
-                ethUtil.toBuffer(signedOrder.signature.slice(0, 6)),
-                invalidR,
-                invalidS,
-            ]);
-            const invalidSigHex = `0x${invalidSigBuff.toString('hex')}`;
-            signedOrder.signature = invalidSigHex;
-            const success = await exchangeWrapper.isValidSignatureAsync(signedOrder);
-            expect(success).to.be.false();
-        });
-    });
-
-    describe('isRoundingError', () => {
-        it('should return false if there is a rounding error of 0.1%', async () => {
-            const numerator = new BigNumber(20);
-            const denominator = new BigNumber(999);
-            const target = new BigNumber(50);
-            // rounding error = ((20*50/999) - floor(20*50/999)) / (20*50/999) = 0.1%
-            const isRoundingError = await exchangeWrapper.isRoundingErrorAsync(numerator, denominator, target);
-            expect(isRoundingError).to.be.false();
-        });
-
-        it('should return false if there is a rounding of 0.09%', async () => {
-            const numerator = new BigNumber(20);
-            const denominator = new BigNumber(9991);
-            const target = new BigNumber(500);
-            // rounding error = ((20*500/9991) - floor(20*500/9991)) / (20*500/9991) = 0.09%
-            const isRoundingError = await exchangeWrapper.isRoundingErrorAsync(numerator, denominator, target);
-            expect(isRoundingError).to.be.false();
-        });
-
-        it('should return true if there is a rounding error of 0.11%', async () => {
-            const numerator = new BigNumber(20);
-            const denominator = new BigNumber(9989);
-            const target = new BigNumber(500);
-            // rounding error = ((20*500/9989) - floor(20*500/9989)) / (20*500/9989) = 0.011%
-            const isRoundingError = await exchangeWrapper.isRoundingErrorAsync(numerator, denominator, target);
-            expect(isRoundingError).to.be.true();
-        });
-
-        it('should return true if there is a rounding error > 0.1%', async () => {
-            const numerator = new BigNumber(3);
-            const denominator = new BigNumber(7);
-            const target = new BigNumber(10);
-            // rounding error = ((3*10/7) - floor(3*10/7)) / (3*10/7) = 6.67%
-            const isRoundingError = await exchangeWrapper.isRoundingErrorAsync(numerator, denominator, target);
-            expect(isRoundingError).to.be.true();
-        });
-
-        it('should return false when there is no rounding error', async () => {
-            const numerator = new BigNumber(1);
-            const denominator = new BigNumber(2);
-            const target = new BigNumber(10);
-
-            const isRoundingError = await exchangeWrapper.isRoundingErrorAsync(numerator, denominator, target);
-            expect(isRoundingError).to.be.false();
-        });
-
-        it('should return false when there is rounding error <= 0.1%', async () => {
-            // randomly generated numbers
-            const numerator = new BigNumber(76564);
-            const denominator = new BigNumber(676373677);
-            const target = new BigNumber(105762562);
-            // rounding error = ((76564*105762562/676373677) - floor(76564*105762562/676373677)) /
-            // (76564*105762562/676373677) = 0.0007%
-            const isRoundingError = await exchangeWrapper.isRoundingErrorAsync(numerator, denominator, target);
-            expect(isRoundingError).to.be.false();
-        });
-    });
-
-    describe('getPartialAmount', () => {
-        it('should return the numerator/denominator*target', async () => {
-            const numerator = new BigNumber(1);
-            const denominator = new BigNumber(2);
-            const target = new BigNumber(10);
-
-            const partialAmount = await exchangeWrapper.getPartialAmountAsync(numerator, denominator, target);
-            const expectedPartialAmount = 5;
-            expect(partialAmount).to.be.bignumber.equal(expectedPartialAmount);
-        });
-
-        it('should round down', async () => {
-            const numerator = new BigNumber(2);
-            const denominator = new BigNumber(3);
-            const target = new BigNumber(10);
-
-            const partialAmount = await exchangeWrapper.getPartialAmountAsync(numerator, denominator, target);
-            const expectedPartialAmount = 6;
-            expect(partialAmount).to.be.bignumber.equal(expectedPartialAmount);
-        });
-
-        it('should round .5 down', async () => {
-            const numerator = new BigNumber(1);
-            const denominator = new BigNumber(20);
-            const target = new BigNumber(10);
-
-            const partialAmount = await exchangeWrapper.getPartialAmountAsync(numerator, denominator, target);
-            const expectedPartialAmount = 0;
-            expect(partialAmount).to.be.bignumber.equal(expectedPartialAmount);
-        });
-    });
-});
diff --git a/packages/contracts/test/exchange/libs.ts b/packages/contracts/test/exchange/libs.ts
new file mode 100644
index 000000000..0074cdff7
--- /dev/null
+++ b/packages/contracts/test/exchange/libs.ts
@@ -0,0 +1,155 @@
+import { ZeroEx } from '0x.js';
+import { BlockchainLifecycle } from '@0xproject/dev-utils';
+import { BigNumber } from '@0xproject/utils';
+import * as chai from 'chai';
+import ethUtil = require('ethereumjs-util');
+
+import { TestLibsContract } from '../../src/contract_wrappers/generated/test_libs';
+import { addressUtils } from '../../src/utils/address_utils';
+import { assetProxyUtils } from '../../src/utils/asset_proxy_utils';
+import { constants } from '../../src/utils/constants';
+import { OrderFactory } from '../../src/utils/order_factory';
+import { orderUtils } from '../../src/utils/order_utils';
+import { ContractName, SignedOrder } from '../../src/utils/types';
+import { chaiSetup } from '../utils/chai_setup';
+import { deployer } from '../utils/deployer';
+import { provider, web3Wrapper } from '../utils/web3_wrapper';
+
+chaiSetup.configure();
+const expect = chai.expect;
+
+const blockchainLifecycle = new BlockchainLifecycle(web3Wrapper);
+
+describe('Exchange libs', () => {
+    let signedOrder: SignedOrder;
+    let orderFactory: OrderFactory;
+    let libs: TestLibsContract;
+
+    before(async () => {
+        const accounts = await web3Wrapper.getAvailableAddressesAsync();
+        const makerAddress = accounts[0];
+        const libsInstance = await deployer.deployAsync(ContractName.TestLibs);
+        libs = new TestLibsContract(libsInstance.abi, libsInstance.address, provider);
+        const zeroEx = new ZeroEx(provider, { networkId: constants.TESTRPC_NETWORK_ID });
+
+        const defaultOrderParams = {
+            ...constants.STATIC_ORDER_PARAMS,
+            exchangeAddress: libs.address,
+            makerAddress,
+            feeRecipientAddress: addressUtils.generatePseudoRandomAddress(),
+            makerAssetData: assetProxyUtils.encodeERC20ProxyData(addressUtils.generatePseudoRandomAddress()),
+            takerAssetData: assetProxyUtils.encodeERC20ProxyData(addressUtils.generatePseudoRandomAddress()),
+        };
+        const privateKey = constants.TESTRPC_PRIVATE_KEYS[accounts.indexOf(makerAddress)];
+        orderFactory = new OrderFactory(privateKey, defaultOrderParams);
+    });
+
+    beforeEach(async () => {
+        await blockchainLifecycle.startAsync();
+        signedOrder = orderFactory.newSignedOrder();
+    });
+    afterEach(async () => {
+        await blockchainLifecycle.revertAsync();
+    });
+
+    describe('LibOrder', () => {
+        describe('getOrderHash', () => {
+            it('should output the correct orderHash', async () => {
+                const orderHashHex = await libs.publicGetOrderHash.callAsync(signedOrder);
+                expect(orderUtils.getOrderHashHex(signedOrder)).to.be.equal(orderHashHex);
+            });
+        });
+    });
+
+    describe('LibMath', () => {
+        describe('isRoundingError', () => {
+            it('should return false if there is a rounding error of 0.1%', async () => {
+                const numerator = new BigNumber(20);
+                const denominator = new BigNumber(999);
+                const target = new BigNumber(50);
+                // rounding error = ((20*50/999) - floor(20*50/999)) / (20*50/999) = 0.1%
+                const isRoundingError = await libs.publicIsRoundingError.callAsync(numerator, denominator, target);
+                expect(isRoundingError).to.be.false();
+            });
+
+            it('should return false if there is a rounding of 0.09%', async () => {
+                const numerator = new BigNumber(20);
+                const denominator = new BigNumber(9991);
+                const target = new BigNumber(500);
+                // rounding error = ((20*500/9991) - floor(20*500/9991)) / (20*500/9991) = 0.09%
+                const isRoundingError = await libs.publicIsRoundingError.callAsync(numerator, denominator, target);
+                expect(isRoundingError).to.be.false();
+            });
+
+            it('should return true if there is a rounding error of 0.11%', async () => {
+                const numerator = new BigNumber(20);
+                const denominator = new BigNumber(9989);
+                const target = new BigNumber(500);
+                // rounding error = ((20*500/9989) - floor(20*500/9989)) / (20*500/9989) = 0.011%
+                const isRoundingError = await libs.publicIsRoundingError.callAsync(numerator, denominator, target);
+                expect(isRoundingError).to.be.true();
+            });
+
+            it('should return true if there is a rounding error > 0.1%', async () => {
+                const numerator = new BigNumber(3);
+                const denominator = new BigNumber(7);
+                const target = new BigNumber(10);
+                // rounding error = ((3*10/7) - floor(3*10/7)) / (3*10/7) = 6.67%
+                const isRoundingError = await libs.publicIsRoundingError.callAsync(numerator, denominator, target);
+                expect(isRoundingError).to.be.true();
+            });
+
+            it('should return false when there is no rounding error', async () => {
+                const numerator = new BigNumber(1);
+                const denominator = new BigNumber(2);
+                const target = new BigNumber(10);
+
+                const isRoundingError = await libs.publicIsRoundingError.callAsync(numerator, denominator, target);
+                expect(isRoundingError).to.be.false();
+            });
+
+            it('should return false when there is rounding error <= 0.1%', async () => {
+                // randomly generated numbers
+                const numerator = new BigNumber(76564);
+                const denominator = new BigNumber(676373677);
+                const target = new BigNumber(105762562);
+                // rounding error = ((76564*105762562/676373677) - floor(76564*105762562/676373677)) /
+                // (76564*105762562/676373677) = 0.0007%
+                const isRoundingError = await libs.publicIsRoundingError.callAsync(numerator, denominator, target);
+                expect(isRoundingError).to.be.false();
+            });
+        });
+
+        describe('getPartialAmount', () => {
+            it('should return the numerator/denominator*target', async () => {
+                const numerator = new BigNumber(1);
+                const denominator = new BigNumber(2);
+                const target = new BigNumber(10);
+
+                const partialAmount = await libs.publicGetPartialAmount.callAsync(numerator, denominator, target);
+                const expectedPartialAmount = 5;
+                expect(partialAmount).to.be.bignumber.equal(expectedPartialAmount);
+            });
+
+            it('should round down', async () => {
+                const numerator = new BigNumber(2);
+                const denominator = new BigNumber(3);
+                const target = new BigNumber(10);
+
+                const partialAmount = await libs.publicGetPartialAmount.callAsync(numerator, denominator, target);
+                const expectedPartialAmount = 6;
+                expect(partialAmount).to.be.bignumber.equal(expectedPartialAmount);
+            });
+
+            it('should round .5 down', async () => {
+                const numerator = new BigNumber(1);
+                const denominator = new BigNumber(20);
+                const target = new BigNumber(10);
+
+                const partialAmount = await libs.publicGetPartialAmount.callAsync(numerator, denominator, target);
+                const expectedPartialAmount = 0;
+                expect(partialAmount).to.be.bignumber.equal(expectedPartialAmount);
+            });
+        });
+    });
+});
diff --git a/packages/contracts/test/exchange/signature_validator.ts b/packages/contracts/test/exchange/signature_validator.ts
new file mode 100644
index 000000000..f47999bfa
--- /dev/null
+++ b/packages/contracts/test/exchange/signature_validator.ts
@@ -0,0 +1,93 @@
+import { ZeroEx } from '0x.js';
+import { BlockchainLifecycle } from '@0xproject/dev-utils';
+import { BigNumber } from '@0xproject/utils';
+import * as chai from 'chai';
+import ethUtil = require('ethereumjs-util');
+
+import { TestSignatureValidatorContract } from '../../src/contract_wrappers/generated/test_signature_validator';
+import { addressUtils } from '../../src/utils/address_utils';
+import { assetProxyUtils } from '../../src/utils/asset_proxy_utils';
+import { constants } from '../../src/utils/constants';
+import { OrderFactory } from '../../src/utils/order_factory';
+import { orderUtils } from '../../src/utils/order_utils';
+import { ContractName, SignedOrder } from '../../src/utils/types';
+import { chaiSetup } from '../utils/chai_setup';
+import { deployer } from '../utils/deployer';
+import { provider, web3Wrapper } from '../utils/web3_wrapper';
+
+chaiSetup.configure();
+const expect = chai.expect;
+
+const blockchainLifecycle = new BlockchainLifecycle(web3Wrapper);
+
+describe('MixinSignatureValidator', () => {
+    let signedOrder: SignedOrder;
+    let orderFactory: OrderFactory;
+    let signatureValidator: TestSignatureValidatorContract;
+
+    before(async () => {
+        const accounts = await web3Wrapper.getAvailableAddressesAsync();
+        const makerAddress = accounts[0];
+        const signatureValidatorInstance = await deployer.deployAsync(ContractName.TestSignatureValidator);
+        signatureValidator = new TestSignatureValidatorContract(
+            signatureValidatorInstance.abi,
+            signatureValidatorInstance.address,
+            provider,
+        );
+        const zeroEx = new ZeroEx(provider, { networkId: constants.TESTRPC_NETWORK_ID });
+
+        const defaultOrderParams = {
+            ...constants.STATIC_ORDER_PARAMS,
+            exchangeAddress: signatureValidatorInstance.address,
+            makerAddress,
+            feeRecipientAddress: addressUtils.generatePseudoRandomAddress(),
+            makerAssetData: assetProxyUtils.encodeERC20ProxyData(addressUtils.generatePseudoRandomAddress()),
+            takerAssetData: assetProxyUtils.encodeERC20ProxyData(addressUtils.generatePseudoRandomAddress()),
+        };
+        const privateKey = constants.TESTRPC_PRIVATE_KEYS[accounts.indexOf(makerAddress)];
+        orderFactory = new OrderFactory(privateKey, defaultOrderParams);
+    });
+
+    beforeEach(async () => {
+        await blockchainLifecycle.startAsync();
+        signedOrder = orderFactory.newSignedOrder();
+    });
+    afterEach(async () => {
+        await blockchainLifecycle.revertAsync();
+    });
+
+    describe('isValidSignature', () => {
+        beforeEach(async () => {
+            signedOrder = orderFactory.newSignedOrder();
+        });
+
+        it('should return true with a valid signature', async () => {
+            const orderHashHex = orderUtils.getOrderHashHex(signedOrder);
+            const success = await signatureValidator.publicIsValidSignature.callAsync(
+                orderHashHex,
+                signedOrder.makerAddress,
+                signedOrder.signature,
+            );
+            expect(success).to.be.true();
+        });
+
+        it('should return false with an invalid signature', async () => {
+            const invalidR = ethUtil.sha3('invalidR');
+            const invalidS = ethUtil.sha3('invalidS');
+            const invalidSigBuff = Buffer.concat([
+                ethUtil.toBuffer(signedOrder.signature.slice(0, 6)),
+                invalidR,
+                invalidS,
+            ]);
+            const invalidSigHex = `0x${invalidSigBuff.toString('hex')}`;
+            signedOrder.signature = invalidSigHex;
+            const orderHashHex = orderUtils.getOrderHashHex(signedOrder);
+            const success = await signatureValidator.publicIsValidSignature.callAsync(
+                orderHashHex,
+                signedOrder.makerAddress,
+                signedOrder.signature,
+            );
+            expect(success).to.be.false();
+        });
+    });
+});