Merge pull request #924 from 0xProject/wrap-typedoc

Improved Docs & Removed monorepo-scripts from packages

4 files changed, 97 insertions, 30 deletions

diff --git a/packages/order-utils/test/market_utils_test.ts b/packages/order-utils/test/market_utils_test.ts
index 109420a02..cce97e0e4 100644
--- a/packages/order-utils/test/market_utils_test.ts
+++ b/packages/order-utils/test/market_utils_test.ts
@@ -2,7 +2,8 @@ import { BigNumber } from '@0xproject/utils';
 import * as chai from 'chai';
 import 'mocha';
 
-import { constants, marketUtils } from '../src';
+import { marketUtils } from '../src';
+import { constants } from '../src/constants';
 
 import { chaiSetup } from './utils/chai_setup';
 import { testOrderFactory } from './utils/test_order_factory';
diff --git a/packages/order-utils/test/order_hash_test.ts b/packages/order-utils/test/order_hash_test.ts
index 0a6be83d0..3fdbbad21 100644
--- a/packages/order-utils/test/order_hash_test.ts
+++ b/packages/order-utils/test/order_hash_test.ts
@@ -3,7 +3,9 @@ import { BigNumber } from '@0xproject/utils';
 import * as chai from 'chai';
 import 'mocha';
 
-import { constants, orderHashUtils } from '../src';
+import { orderHashUtils } from '../src';
+
+import { constants } from '../src/constants';
 
 import { chaiSetup } from './utils/chai_setup';
 
diff --git a/packages/order-utils/test/signature_utils_test.ts b/packages/order-utils/test/signature_utils_test.ts
index a25d2afd6..4ce99a1c7 100644
--- a/packages/order-utils/test/signature_utils_test.ts
+++ b/packages/order-utils/test/signature_utils_test.ts
@@ -6,8 +6,8 @@ import * as _ from 'lodash';
 import 'mocha';
 import * as Sinon from 'sinon';
 
-import { ecSignOrderHashAsync, generatePseudoRandomSalt } from '../src';
-import { convertECSignatureToSignatureHex, isValidECSignature, isValidSignatureAsync } from '../src/signature_utils';
+import { generatePseudoRandomSalt } from '../src';
+import { signatureUtils } from '../src/signature_utils';
 
 import { chaiSetup } from './utils/chai_setup';
 import { provider, web3Wrapper } from './utils/web3_wrapper';
@@ -16,7 +16,7 @@ chaiSetup.configure();
 const expect = chai.expect;
 
 describe('Signature utils', () => {
-    describe('#isValidSignature', () => {
+    describe('#isValidSignatureAsync', () => {
         let dataHex = '0x6927e990021d23b1eb7b8789f6a6feaf98fe104bb0cf8259421b79f9a34222b0';
         const ethSignSignature =
             '0x1B61a3ed31b43c8780e905a260a35faefcc527be7516aa11c0256729b5b351bc3340349190569279751135161d22529dc25add4f6069af05be04cacbda2ace225403';
@@ -24,12 +24,14 @@ describe('Signature utils', () => {
 
         it("should return false if the data doesn't pertain to the signature & address", async () => {
             const bytes32Zeros = '0x0000000000000000000000000000000000000000000000000000000000000000';
-            expect(await isValidSignatureAsync(provider, bytes32Zeros, ethSignSignature, address)).to.be.false();
+            expect(
+                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 () => {
             const validUnrelatedAddress = '0x8b0292b11a196601ed2ce54b665cafeca0347d42';
             expect(
-                await isValidSignatureAsync(provider, dataHex, ethSignSignature, validUnrelatedAddress),
+                await signatureUtils.isValidSignatureAsync(provider, dataHex, ethSignSignature, validUnrelatedAddress),
             ).to.be.false();
         });
         it("should return false if the signature doesn't pertain to the dataHex & address", async () => {
@@ -37,18 +39,27 @@ describe('Signature utils', () => {
             // tslint:disable-next-line:custom-no-magic-numbers
             signatureArray[5] = 'C'; // V = 28, instead of 27
             const wrongSignature = signatureArray.join('');
-            expect(await isValidSignatureAsync(provider, dataHex, wrongSignature, address)).to.be.false();
+            expect(
+                await signatureUtils.isValidSignatureAsync(provider, dataHex, wrongSignature, address),
+            ).to.be.false();
         });
 
         it('should throw if signatureType is invalid', () => {
             const signatureArray = ethSignSignature.split('');
             signatureArray[3] = '9'; // SignatureType w/ index 9 doesn't exist
             const signatureWithInvalidType = signatureArray.join('');
-            expect(isValidSignatureAsync(provider, dataHex, signatureWithInvalidType, address)).to.be.rejected();
+            expect(
+                signatureUtils.isValidSignatureAsync(provider, dataHex, signatureWithInvalidType, address),
+            ).to.be.rejected();
         });
 
         it('should return true for a valid Ecrecover (EthSign) signature', async () => {
-            const isValidSignatureLocal = await isValidSignatureAsync(provider, dataHex, ethSignSignature, address);
+            const isValidSignatureLocal = await signatureUtils.isValidSignatureAsync(
+                provider,
+                dataHex,
+                ethSignSignature,
+                address,
+            );
             expect(isValidSignatureLocal).to.be.true();
         });
 
@@ -57,7 +68,12 @@ describe('Signature utils', () => {
             address = '0x6ecbe1db9ef729cbe972c83fb886247691fb6beb';
             const eip712Signature =
                 '0x1bdde07aac4bf12c12ddbb155919c43eba4146a2cfcf904a862950dbebe332554c6674975603eb5a4eaf8fd7f2e06350267e5b36cda9851a89f8bb49fe2fc9afe202';
-            const isValidSignatureLocal = await isValidSignatureAsync(provider, dataHex, eip712Signature, address);
+            const isValidSignatureLocal = await signatureUtils.isValidSignatureAsync(
+                provider,
+                dataHex,
+                eip712Signature,
+                address,
+            );
             expect(isValidSignatureLocal).to.be.true();
         });
 
@@ -66,7 +82,12 @@ describe('Signature utils', () => {
             address = '0x6ecbe1db9ef729cbe972c83fb886247691fb6beb';
             const trezorSignature =
                 '0x1ce4760660e6495b5ae6723087bea073b3a99ce98ea81fdf00c240279c010e63d05b87bc34c4d67d4776e8d5aeb023a67484f4eaf0fd353b40893e5101e845cd9908';
-            const isValidSignatureLocal = await isValidSignatureAsync(provider, dataHex, trezorSignature, address);
+            const isValidSignatureLocal = await signatureUtils.isValidSignatureAsync(
+                provider,
+                dataHex,
+                trezorSignature,
+                address,
+            );
             expect(isValidSignatureLocal).to.be.true();
         });
     });
@@ -80,18 +101,18 @@ describe('Signature utils', () => {
         const address = '0x0e5cb767cce09a7f3ca594df118aa519be5e2b5a';
 
         it("should return false if the data doesn't pertain to the signature & address", async () => {
-            expect(isValidECSignature('0x0', signature, address)).to.be.false();
+            expect(signatureUtils.isValidECSignature('0x0', signature, address)).to.be.false();
         });
         it("should return false if the address doesn't pertain to the signature & data", async () => {
             const validUnrelatedAddress = '0x8b0292b11a196601ed2ce54b665cafeca0347d42';
-            expect(isValidECSignature(data, signature, validUnrelatedAddress)).to.be.false();
+            expect(signatureUtils.isValidECSignature(data, signature, validUnrelatedAddress)).to.be.false();
         });
         it("should return false if the signature doesn't pertain to the data & address", async () => {
             const wrongSignature = _.assign({}, signature, { v: 28 });
-            expect(isValidECSignature(data, wrongSignature, address)).to.be.false();
+            expect(signatureUtils.isValidECSignature(data, wrongSignature, address)).to.be.false();
         });
         it('should return true if the signature does pertain to the data & address', async () => {
-            const isValidSignatureLocal = isValidECSignature(data, signature, address);
+            const isValidSignatureLocal = signatureUtils.isValidECSignature(data, signature, address);
             expect(isValidSignatureLocal).to.be.true();
         });
     });
@@ -124,7 +145,12 @@ describe('Signature utils', () => {
             const orderHash = '0x6927e990021d23b1eb7b8789f6a6feaf98fe104bb0cf8259421b79f9a34222b0';
             const expectedSignature =
                 '0x1b61a3ed31b43c8780e905a260a35faefcc527be7516aa11c0256729b5b351bc3340349190569279751135161d22529dc25add4f6069af05be04cacbda2ace225403';
-            const ecSignature = await ecSignOrderHashAsync(provider, orderHash, makerAddress, SignerType.Default);
+            const ecSignature = await signatureUtils.ecSignOrderHashAsync(
+                provider,
+                orderHash,
+                makerAddress,
+                SignerType.Default,
+            );
             expect(ecSignature).to.equal(expectedSignature);
         });
         it('should return the correct Signature for signatureHex concatenated as R + S + V', async () => {
@@ -150,7 +176,12 @@ describe('Signature utils', () => {
                     }
                 },
             };
-            const ecSignature = await ecSignOrderHashAsync(fakeProvider, orderHash, makerAddress, SignerType.Default);
+            const ecSignature = await signatureUtils.ecSignOrderHashAsync(
+                fakeProvider,
+                orderHash,
+                makerAddress,
+                SignerType.Default,
+            );
             expect(ecSignature).to.equal(expectedSignature);
         });
         it('should return the correct Signature for signatureHex concatenated as V + R + S', async () => {
@@ -173,7 +204,12 @@ describe('Signature utils', () => {
                 },
             };
 
-            const ecSignature = await ecSignOrderHashAsync(fakeProvider, orderHash, makerAddress, SignerType.Default);
+            const ecSignature = await signatureUtils.ecSignOrderHashAsync(
+                fakeProvider,
+                orderHash,
+                makerAddress,
+                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
@@ -202,14 +238,29 @@ describe('Signature utils', () => {
                 },
             };
 
-            const ecSignature = await ecSignOrderHashAsync(fakeProvider, orderHash, makerAddress, SignerType.Metamask);
+            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 ecSignOrderHashAsync(provider, orderHash, makerAddress, SignerType.Default);
+            const ecSignature = await signatureUtils.ecSignOrderHashAsync(
+                provider,
+                orderHash,
+                makerAddress,
+                SignerType.Default,
+            );
 
-            const isValidSignature = await isValidSignatureAsync(provider, orderHash, ecSignature, makerAddress);
+            const isValidSignature = await signatureUtils.isValidSignatureAsync(
+                provider,
+                orderHash,
+                ecSignature,
+                makerAddress,
+            );
             expect(isValidSignature).to.be.true();
         });
     });
@@ -222,32 +273,44 @@ describe('Signature utils', () => {
         it('should concatenate v,r,s and append the Trezor signature type', async () => {
             const expectedSignatureWithSignatureType =
                 '0x1baca7da997ad177f040240cdccf6905b71ab16b74434388c3a72f34fd25d6439346b2bac274ff29b48b3ea6e2d04c1336eaceafda3c53ab483fc3ff12fac3ebf208';
-            const signatureWithSignatureType = convertECSignatureToSignatureHex(ecSignature, SignerType.Trezor);
+            const signatureWithSignatureType = signatureUtils.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);
+            const signatureWithSignatureType = signatureUtils.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);
+            const signatureWithSignatureType = signatureUtils.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);
+            const signatureWithSignatureType = signatureUtils.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(() =>
+                signatureUtils.convertECSignatureToSignatureHex(ecSignature, 'INVALID_SIGNER' as SignerType),
+            ).to.throw(expectedMessage);
         });
     });
 });
diff --git a/packages/order-utils/test/utils/test_order_factory.ts b/packages/order-utils/test/utils/test_order_factory.ts
index 75dc6f1f2..69184f129 100644
--- a/packages/order-utils/test/utils/test_order_factory.ts
+++ b/packages/order-utils/test/utils/test_order_factory.ts
@@ -1,7 +1,8 @@
 import { Order, SignedOrder } from '@0xproject/types';
 import * as _ from 'lodash';
 
-import { constants, orderFactory } from '../../src';
+import { constants } from '../../src/constants';
+import { orderFactory } from '../../src/order_factory';
 
 const BASE_TEST_ORDER: Order = orderFactory.createOrder(
     constants.NULL_ADDRESS,