Merge remote-tracking branch 'origin/development' into feature/utils/prettybignum

12 files changed, 415 insertions, 45 deletions

diff --git a/packages/utils/CHANGELOG.json b/packages/utils/CHANGELOG.json
index 796a99a5a..7594581d4 100644
--- a/packages/utils/CHANGELOG.json
+++ b/packages/utils/CHANGELOG.json
@@ -1,5 +1,96 @@
 [
     {
+        "timestamp": 1539871071,
+        "version": "2.0.3",
+        "changes": [
+            {
+                "note": "Dependencies updated"
+            }
+        ]
+    },
+    {
+        "timestamp": 1538693146,
+        "version": "2.0.2",
+        "changes": [
+            {
+                "note": "Dependencies updated"
+            }
+        ]
+    },
+    {
+        "timestamp": 1538475601,
+        "version": "2.0.1",
+        "changes": [
+            {
+                "note": "Dependencies updated"
+            }
+        ]
+    },
+    {
+        "version": "2.0.0",
+        "changes": [
+            {
+                "note": "Make abi_decoder compatible with ethers ^4.0.0",
+                "pr": 1069
+            }
+        ],
+        "timestamp": 1538157789
+    },
+    {
+        "timestamp": 1537907159,
+        "version": "1.0.11",
+        "changes": [
+            {
+                "note": "Dependencies updated"
+            }
+        ]
+    },
+    {
+        "timestamp": 1537875740,
+        "version": "1.0.10",
+        "changes": [
+            {
+                "note": "Dependencies updated"
+            }
+        ]
+    },
+    {
+        "timestamp": 1537541580,
+        "version": "1.0.9",
+        "changes": [
+            {
+                "note": "Dependencies updated"
+            }
+        ]
+    },
+    {
+        "timestamp": 1536142250,
+        "version": "1.0.8",
+        "changes": [
+            {
+                "note": "Dependencies updated"
+            }
+        ]
+    },
+    {
+        "timestamp": 1535377027,
+        "version": "1.0.7",
+        "changes": [
+            {
+                "note": "Dependencies updated"
+            }
+        ]
+    },
+    {
+        "timestamp": 1535133899,
+        "version": "1.0.6",
+        "changes": [
+            {
+                "note": "Dependencies updated"
+            }
+        ]
+    },
+    {
         "version": "1.0.5",
         "changes": [
             {
diff --git a/packages/utils/CHANGELOG.md b/packages/utils/CHANGELOG.md
index bdde2687d..45b2cd0c2 100644
--- a/packages/utils/CHANGELOG.md
+++ b/packages/utils/CHANGELOG.md
@@ -5,9 +5,50 @@ Edit the package's CHANGELOG.json file only.
 
 CHANGELOG
 
-## v1.0.5 - _August 13, 2018_
+## v2.0.3 - _October 18, 2018_
+
+    * Dependencies updated
+
+## v2.0.2 - _October 4, 2018_
+
+    * Dependencies updated
+
+## v2.0.1 - _October 2, 2018_
+
+    * Dependencies updated
+
+## v2.0.0 - _September 28, 2018_
+
+    * Make abi_decoder compatible with ethers ^4.0.0 (#1069)
+
+## v1.0.11 - _September 25, 2018_
+
+    * Dependencies updated
+
+## v1.0.10 - _September 25, 2018_
+
+    * Dependencies updated
+
+## v1.0.9 - _September 21, 2018_
+
+    * Dependencies updated
+
+## v1.0.8 - _September 5, 2018_
+
+    * Dependencies updated
+
+## v1.0.7 - _August 27, 2018_
+
+    * Dependencies updated
+
+## v1.0.6 - _August 24, 2018_
+
+    * Dependencies updated
+
+## v1.0.5 - _August 14, 2018_
 
     * Increased BigNumber decimal precision from 20 to 78 (#807)
+    * Store different ABIs for events with same function signature and different amount of indexed arguments (#933)
 
 ## v1.0.4 - _July 26, 2018_
 
diff --git a/packages/utils/README.md b/packages/utils/README.md
index c9a2f5846..0b15f00c5 100644
--- a/packages/utils/README.md
+++ b/packages/utils/README.md
@@ -1,25 +1,25 @@
-## @0xproject/utils
+## @0x/utils
 
 Utils to be shared across 0x projects and packages
 
 ## Installation
 
 ```bash
-yarn add @0xproject/utils
+yarn add @0x/utils
 ```
 
 If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
 
 ```json
 "compilerOptions": {
-    "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
+    "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
 }
 ```
 
 ## Usage
 
 ```javascript
-import { addressUtils, bigNumberConfigs, classUtils, intervalUtils, promisify } from '@0xproject/utils';
+import { addressUtils, bigNumberConfigs, classUtils, intervalUtils, promisify } from '@0x/utils';
 ```
 
 ## Troubleshooting
@@ -62,13 +62,13 @@ yarn install
 To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
 
 ```bash
-PKG=@0xproject/utils yarn build
+PKG=@0x/utils yarn build
 ```
 
 Or continuously rebuild on change:
 
 ```bash
-PKG=@0xproject/utils yarn watch
+PKG=@0x/utils yarn watch
 ```
 
 ### Clean
diff --git a/packages/utils/package.json b/packages/utils/package.json
index 28a967a35..4e0df9275 100644
--- a/packages/utils/package.json
+++ b/packages/utils/package.json
@@ -1,6 +1,6 @@
 {
-    "name": "@0xproject/utils",
-    "version": "1.0.5",
+    "name": "@0x/utils",
+    "version": "2.0.3",
     "engines": {
         "node": ">=6.12"
     },
@@ -8,16 +8,15 @@
     "main": "lib/src/index.js",
     "types": "lib/src/index.d.ts",
     "scripts": {
-        "watch_without_deps": "tsc -w",
-        "build": "tsc && copyfiles -u 2 './lib/monorepo_scripts/**/*' ./scripts",
-        "clean": "shx rm -rf lib scripts",
+        "build": "tsc -b",
+        "build:ci": "yarn build",
+        "clean": "shx rm -rf lib",
+        "lint": "tslint --format stylish --project .",
         "test": "yarn run_mocha",
         "test:circleci": "yarn test:coverage",
         "run_mocha": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --bail --exit",
         "test:coverage": "nyc npm run test --all && yarn coverage:report:lcov",
-        "coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info",
-        "lint": "tslint --project .",
-        "manual:postpublish": "yarn build; node ./scripts/postpublish.js"
+        "coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info"
     },
     "license": "Apache-2.0",
     "repository": {
@@ -29,12 +28,11 @@
     },
     "homepage": "https://github.com/0xProject/0x-monorepo/packages/utils/README.md",
     "devDependencies": {
-        "@0xproject/monorepo-scripts": "^1.0.5",
-        "@0xproject/tslint-config": "^1.0.5",
+        "@0x/tslint-config": "^1.0.9",
+        "@types/detect-node": "2.0.0",
         "@types/lodash": "4.14.104",
         "@types/mocha": "^2.2.42",
         "chai": "^4.0.1",
-        "copyfiles": "^2.0.0",
         "make-promises-safe": "^1.1.0",
         "mocha": "^4.1.0",
         "npm-run-all": "^4.1.2",
@@ -43,15 +41,15 @@
         "typescript": "3.0.1"
     },
     "dependencies": {
-        "@0xproject/types": "^1.0.1-rc.4",
-        "@0xproject/typescript-typings": "^1.0.4",
-        "@types/node": "^8.0.53",
+        "@0x/types": "^1.2.0",
+        "@0x/typescript-typings": "^3.0.3",
+        "@types/node": "*",
         "abortcontroller-polyfill": "^1.1.9",
         "bignumber.js": "~4.1.0",
         "detect-node": "2.0.3",
-        "ethereum-types": "^1.0.4",
+        "ethereum-types": "^1.1.1",
         "ethereumjs-util": "^5.1.1",
-        "ethers": "3.0.22",
+        "ethers": "~4.0.4",
         "isomorphic-fetch": "^2.2.1",
         "js-sha3": "^0.7.0",
         "lodash": "^4.17.5"
diff --git a/packages/utils/src/abi_decoder.ts b/packages/utils/src/abi_decoder.ts
index cc05321ab..2da46db35 100644
--- a/packages/utils/src/abi_decoder.ts
+++ b/packages/utils/src/abi_decoder.ts
@@ -15,12 +15,25 @@ import * as _ from 'lodash';
 import { addressUtils } from './address_utils';
 import { BigNumber } from './configured_bignumber';
 
+/**
+ * AbiDecoder allows you to decode event logs given a set of supplied contract ABI's. It takes the contract's event
+ * signature from the ABI and attempts to decode the logs using it.
+ */
 export class AbiDecoder {
     private readonly _methodIds: { [signatureHash: string]: { [numIndexedArgs: number]: EventAbi } } = {};
+    /**
+     * Instantiate an AbiDecoder
+     * @param abiArrays An array of contract ABI's
+     * @return AbiDecoder instance
+     */
     constructor(abiArrays: AbiDefinition[][]) {
         _.forEach(abiArrays, this.addABI.bind(this));
     }
-    // This method can only decode logs from the 0x & ERC20 smart contracts
+    /**
+     * Attempt to decode a log given the ABI's the AbiDecoder knows about.
+     * @param log The log to attempt to decode
+     * @return The decoded log if the requisite ABI was available. Otherwise the log unaltered.
+     */
     public tryToDecodeLogOrNoop<ArgsType extends DecodedLogArgs>(log: LogEntry): LogWithDecodedArgs<ArgsType> | RawLog {
         const methodId = log.topics[0];
         const numIndexedArgs = log.topics.length - 1;
@@ -28,13 +41,13 @@ export class AbiDecoder {
             return log;
         }
         const event = this._methodIds[methodId][numIndexedArgs];
-        const ethersInterface = new ethers.Interface([event]);
+        const ethersInterface = new ethers.utils.Interface([event]);
         const decodedParams: DecodedLogArgs = {};
         let topicsIndex = 1;
 
         let decodedData: any[];
         try {
-            decodedData = ethersInterface.events[event.name].parse(log.data);
+            decodedData = ethersInterface.events[event.name].decode(log.data);
         } catch (error) {
             if (error.code === ethers.errors.INVALID_ARGUMENT) {
                 // Because we index events by Method ID, and Method IDs are derived from the method
@@ -75,18 +88,24 @@ export class AbiDecoder {
             };
         }
     }
+    /**
+     * Add additional ABI definitions to the AbiDecoder
+     * @param abiArray An array of ABI definitions to add to the AbiDecoder
+     */
     public addABI(abiArray: AbiDefinition[]): void {
         if (_.isUndefined(abiArray)) {
             return;
         }
-        const ethersInterface = new ethers.Interface(abiArray);
+        const ethersInterface = new ethers.utils.Interface(abiArray);
         _.map(abiArray, (abi: AbiDefinition) => {
             if (abi.type === AbiType.Event) {
-                const topic = ethersInterface.events[abi.name].topics[0];
-                const numIndexedArgs = _.reduce(abi.inputs, (sum, input) => (input.indexed ? sum + 1 : sum), 0);
+                // tslint:disable-next-line:no-unnecessary-type-assertion
+                const eventAbi = abi as EventAbi;
+                const topic = ethersInterface.events[eventAbi.name].topic;
+                const numIndexedArgs = _.reduce(eventAbi.inputs, (sum, input) => (input.indexed ? sum + 1 : sum), 0);
                 this._methodIds[topic] = {
                     ...this._methodIds[topic],
-                    [numIndexedArgs]: abi,
+                    [numIndexedArgs]: eventAbi,
                 };
             }
         });
diff --git a/packages/utils/src/abi_utils.ts b/packages/utils/src/abi_utils.ts
index c9b70966c..598ea5fcc 100644
--- a/packages/utils/src/abi_utils.ts
+++ b/packages/utils/src/abi_utils.ts
@@ -1,14 +1,19 @@
 import { AbiDefinition, AbiType, ContractAbi, DataItem, MethodAbi } from 'ethereum-types';
-import * as ethers from 'ethers';
 import * as _ from 'lodash';
 
 import { BigNumber } from './configured_bignumber';
 
+type ParamName = null | string | NestedParamName;
+interface NestedParamName {
+    name: string | null;
+    names: ParamName[];
+}
+
 // Note(albrow): This function is unexported in ethers.js. Copying it here for
 // now.
 // Source: https://github.com/ethers-io/ethers.js/blob/884593ab76004a808bf8097e9753fb5f8dcc3067/contracts/interface.js#L30
-function parseEthersParams(params: DataItem[]): { names: ethers.ParamName[]; types: string[] } {
-    const names: ethers.ParamName[] = [];
+function parseEthersParams(params: DataItem[]): { names: ParamName[]; types: string[] } {
+    const names: ParamName[] = [];
     const types: string[] = [];
 
     params.forEach((param: DataItem) => {
@@ -37,7 +42,7 @@ function parseEthersParams(params: DataItem[]): { names: ethers.ParamName[]; typ
 // returns true if x is equal to y and false otherwise. Performs some minimal
 // type conversion and data massaging for x and y, depending on type. name and
 // type should typically be derived from parseEthersParams.
-function isAbiDataEqual(name: ethers.ParamName, type: string, x: any, y: any): boolean {
+function isAbiDataEqual(name: ParamName, type: string, x: any, y: any): boolean {
     if (_.isUndefined(x) && _.isUndefined(y)) {
         return true;
     } else if (_.isUndefined(x) && !_.isUndefined(y)) {
@@ -89,7 +94,7 @@ function isAbiDataEqual(name: ethers.ParamName, type: string, x: any, y: any): b
             //
             const nestedName = _.isString(name.names[i])
                 ? (name.names[i] as string)
-                : ((name.names[i] as ethers.NestedParamName).name as string);
+                : ((name.names[i] as NestedParamName).name as string);
             if (!isAbiDataEqual(name.names[i], types[i], x[nestedName], y[nestedName])) {
                 return false;
             }
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
index 9d01e5bc5..0723e5788 100644
--- a/packages/utils/src/index.ts
+++ b/packages/utils/src/index.ts
@@ -9,3 +9,4 @@ export { abiUtils } from './abi_utils';
 export { NULL_BYTES } from './constants';
 export { errorUtils } from './error_utils';
 export { fetchAsync } from './fetch_async';
+export { signTypedDataUtils } from './sign_typed_data_utils';
diff --git a/packages/utils/src/monorepo_scripts/postpublish.ts b/packages/utils/src/monorepo_scripts/postpublish.ts
deleted file mode 100644
index dcb99d0f7..000000000
--- a/packages/utils/src/monorepo_scripts/postpublish.ts
+++ /dev/null
@@ -1,8 +0,0 @@
-import { postpublishUtils } from '@0xproject/monorepo-scripts';
-
-import * as packageJSON from '../package.json';
-import * as tsConfigJSON from '../tsconfig.json';
-
-const cwd = `${__dirname}/..`;
-// tslint:disable-next-line:no-floating-promises
-postpublishUtils.runAsync(packageJSON, tsConfigJSON, cwd);
diff --git a/packages/utils/src/sign_typed_data_utils.ts b/packages/utils/src/sign_typed_data_utils.ts
new file mode 100644
index 000000000..6963b9084
--- /dev/null
+++ b/packages/utils/src/sign_typed_data_utils.ts
@@ -0,0 +1,82 @@
+import * as ethUtil from 'ethereumjs-util';
+import * as ethers from 'ethers';
+import * as _ from 'lodash';
+
+import { EIP712Object, EIP712ObjectValue, EIP712TypedData, EIP712Types } from '@0x/types';
+
+export const signTypedDataUtils = {
+    /**
+     * Generates the EIP712 Typed Data hash for signing
+     * @param   typedData An object that conforms to the EIP712TypedData interface
+     * @return  A Buffer containing the hash of the typed data.
+     */
+    generateTypedDataHash(typedData: EIP712TypedData): Buffer {
+        return ethUtil.sha3(
+            Buffer.concat([
+                Buffer.from('1901', 'hex'),
+                signTypedDataUtils._structHash('EIP712Domain', typedData.domain, typedData.types),
+                signTypedDataUtils._structHash(typedData.primaryType, typedData.message, typedData.types),
+            ]),
+        );
+    },
+    _findDependencies(primaryType: string, types: EIP712Types, found: string[] = []): string[] {
+        if (found.includes(primaryType) || types[primaryType] === undefined) {
+            return found;
+        }
+        found.push(primaryType);
+        for (const field of types[primaryType]) {
+            for (const dep of signTypedDataUtils._findDependencies(field.type, types, found)) {
+                if (!found.includes(dep)) {
+                    found.push(dep);
+                }
+            }
+        }
+        return found;
+    },
+    _encodeType(primaryType: string, types: EIP712Types): string {
+        let deps = signTypedDataUtils._findDependencies(primaryType, types);
+        deps = deps.filter(d => d !== primaryType);
+        deps = [primaryType].concat(deps.sort());
+        let result = '';
+        for (const dep of deps) {
+            result += `${dep}(${types[dep].map(({ name, type }) => `${type} ${name}`).join(',')})`;
+        }
+        return result;
+    },
+    _encodeData(primaryType: string, data: EIP712Object, types: EIP712Types): string {
+        const encodedTypes = ['bytes32'];
+        const encodedValues: Array<Buffer | EIP712ObjectValue> = [signTypedDataUtils._typeHash(primaryType, types)];
+        for (const field of types[primaryType]) {
+            const value = data[field.name];
+            if (field.type === 'string' || field.type === 'bytes') {
+                const hashValue = ethUtil.sha3(value as string);
+                encodedTypes.push('bytes32');
+                encodedValues.push(hashValue);
+            } else if (types[field.type] !== undefined) {
+                encodedTypes.push('bytes32');
+                const hashValue = ethUtil.sha3(
+                    // tslint:disable-next-line:no-unnecessary-type-assertion
+                    signTypedDataUtils._encodeData(field.type, value as EIP712Object, types),
+                );
+                encodedValues.push(hashValue);
+            } else if (field.type.lastIndexOf(']') === field.type.length - 1) {
+                throw new Error('Arrays currently unimplemented in encodeData');
+            } else {
+                encodedTypes.push(field.type);
+                const normalizedValue = signTypedDataUtils._normalizeValue(field.type, value);
+                encodedValues.push(normalizedValue);
+            }
+        }
+        return ethers.utils.defaultAbiCoder.encode(encodedTypes, encodedValues);
+    },
+    _normalizeValue(type: string, value: any): EIP712ObjectValue {
+        const normalizedValue = type === 'uint256' && _.isObject(value) && value.isBigNumber ? value.toString() : value;
+        return normalizedValue;
+    },
+    _typeHash(primaryType: string, types: EIP712Types): Buffer {
+        return ethUtil.sha3(signTypedDataUtils._encodeType(primaryType, types));
+    },
+    _structHash(primaryType: string, data: EIP712Object, types: EIP712Types): Buffer {
+        return ethUtil.sha3(signTypedDataUtils._encodeData(primaryType, data, types));
+    },
+};
diff --git a/packages/utils/test/sign_typed_data_utils_test.ts b/packages/utils/test/sign_typed_data_utils_test.ts
new file mode 100644
index 000000000..dcba08b04
--- /dev/null
+++ b/packages/utils/test/sign_typed_data_utils_test.ts
@@ -0,0 +1,140 @@
+import * as chai from 'chai';
+import 'mocha';
+
+import { signTypedDataUtils } from '../src/sign_typed_data_utils';
+
+const expect = chai.expect;
+
+describe('signTypedDataUtils', () => {
+    describe('signTypedDataHash', () => {
+        const simpleSignTypedDataHashHex = '0xb460d69ca60383293877cd765c0f97bd832d66bca720f7e32222ce1118832493';
+        const simpleSignTypedData = {
+            types: {
+                EIP712Domain: [
+                    {
+                        name: 'name',
+                        type: 'string',
+                    },
+                ],
+                Test: [
+                    {
+                        name: 'testAddress',
+                        type: 'address',
+                    },
+                    {
+                        name: 'testNumber',
+                        type: 'uint256',
+                    },
+                ],
+            },
+            domain: {
+                name: 'Test',
+            },
+            message: {
+                testAddress: '0x0000000000000000000000000000000000000000',
+                testNumber: '12345',
+            },
+            primaryType: 'Test',
+        };
+        const orderSignTypedDataHashHex = '0x55eaa6ec02f3224d30873577e9ddd069a288c16d6fb407210eecbc501fa76692';
+        const orderSignTypedData = {
+            types: {
+                EIP712Domain: [
+                    {
+                        name: 'name',
+                        type: 'string',
+                    },
+                    {
+                        name: 'version',
+                        type: 'string',
+                    },
+                    {
+                        name: 'verifyingContract',
+                        type: 'address',
+                    },
+                ],
+                Order: [
+                    {
+                        name: 'makerAddress',
+                        type: 'address',
+                    },
+                    {
+                        name: 'takerAddress',
+                        type: 'address',
+                    },
+                    {
+                        name: 'feeRecipientAddress',
+                        type: 'address',
+                    },
+                    {
+                        name: 'senderAddress',
+                        type: 'address',
+                    },
+                    {
+                        name: 'makerAssetAmount',
+                        type: 'uint256',
+                    },
+                    {
+                        name: 'takerAssetAmount',
+                        type: 'uint256',
+                    },
+                    {
+                        name: 'makerFee',
+                        type: 'uint256',
+                    },
+                    {
+                        name: 'takerFee',
+                        type: 'uint256',
+                    },
+                    {
+                        name: 'expirationTimeSeconds',
+                        type: 'uint256',
+                    },
+                    {
+                        name: 'salt',
+                        type: 'uint256',
+                    },
+                    {
+                        name: 'makerAssetData',
+                        type: 'bytes',
+                    },
+                    {
+                        name: 'takerAssetData',
+                        type: 'bytes',
+                    },
+                ],
+            },
+            domain: {
+                name: '0x Protocol',
+                version: '2',
+                verifyingContract: '0x0000000000000000000000000000000000000000',
+            },
+            message: {
+                makerAddress: '0x0000000000000000000000000000000000000000',
+                takerAddress: '0x0000000000000000000000000000000000000000',
+                makerAssetAmount: '1000000000000000000',
+                takerAssetAmount: '1000000000000000000',
+                expirationTimeSeconds: '12345',
+                makerFee: '0',
+                takerFee: '0',
+                feeRecipientAddress: '0x0000000000000000000000000000000000000000',
+                senderAddress: '0x0000000000000000000000000000000000000000',
+                salt: '12345',
+                makerAssetData: '0x0000000000000000000000000000000000000000',
+                takerAssetData: '0x0000000000000000000000000000000000000000',
+                exchangeAddress: '0x0000000000000000000000000000000000000000',
+            },
+            primaryType: 'Order',
+        };
+        it('creates a hash of the test sign typed data', () => {
+            const hash = signTypedDataUtils.generateTypedDataHash(simpleSignTypedData).toString('hex');
+            const hashHex = `0x${hash}`;
+            expect(hashHex).to.be.eq(simpleSignTypedDataHashHex);
+        });
+        it('creates a hash of the order sign typed data', () => {
+            const hash = signTypedDataUtils.generateTypedDataHash(orderSignTypedData).toString('hex');
+            const hashHex = `0x${hash}`;
+            expect(hashHex).to.be.eq(orderSignTypedDataHashHex);
+        });
+    });
+});
diff --git a/packages/utils/tsconfig.json b/packages/utils/tsconfig.json
index 8b4cd47a2..718e623c7 100644
--- a/packages/utils/tsconfig.json
+++ b/packages/utils/tsconfig.json
@@ -1,7 +1,8 @@
 {
     "extends": "../../tsconfig",
     "compilerOptions": {
-        "outDir": "lib"
+        "outDir": "lib",
+        "rootDir": "."
     },
     "include": ["src/**/*", "test/**/*"]
 }
diff --git a/packages/utils/tslint.json b/packages/utils/tslint.json
index ffaefe83a..dd9053357 100644
--- a/packages/utils/tslint.json
+++ b/packages/utils/tslint.json
@@ -1,3 +1,3 @@
 {
-    "extends": ["@0xproject/tslint-config"]
+    "extends": ["@0x/tslint-config"]
 }