@0x/order-utils refactors for v3: orderParsingUtils, signatureUtils, …

…orderHashUtils, RevertErrors, transactionHashUtils (#2321)

* move orderParsingUtils from order-utils to connect

* Remove many functions from signatureUtils

Removed from the exported object, that is.  All of them are used in
other existing code, so they were all moved to be as local to their
usage as possible.

* remove orderHashUtils.isValidOrderHash()

* Move all *RevertErrors from order-utils...

...into their respective @0x/contracts- packages.

* Refactor @0x/order-utils' orderHashUtils away

- Move existing routines into @0x/contracts-test-utils

- Migrate non-contract-test callers to a newly-exposed getOrderHash()
method in DevUtils.

* Move all *RevertErrors from @0x/utils...

...into their respective @0x/contracts- packages.

* rm transactionHashUtils.isValidTransactionHash()

* DevUtils.sol: Fail yarn test if too big to deploy

* Refactor @0x/order-utils transactionHashUtils away

- Move existing routines into @0x/contracts-test-utils

- Migrate non-contract-test callers to a newly-exposed
getTransactionHash() method in DevUtils.

* Consolidate `Removed export...` CHANGELOG entries

* Rm EthBalanceChecker from devutils wrapper exports

* Stop importing from '.' or '.../src'

* fix builds

* fix prettier; dangling promise

* increase max bundle size

contracts/asset-proxy/test/erc1155_proxy.ts

@@ -15,9 +15,10 @@ import {
     txDefaults,
     web3Wrapper,
 } from '@0x/contracts-test-utils';
+import { SafeMathRevertErrors } from '@0x/contracts-utils';
 import { BlockchainLifecycle } from '@0x/dev-utils';
 import { AssetProxyId, RevertReason } from '@0x/types';
-import { BigNumber, SafeMathRevertErrors } from '@0x/utils';
+import { BigNumber } from '@0x/utils';
 import * as chai from 'chai';
 import { LogWithDecodedArgs } from 'ethereum-types';
 import * as ethUtil from 'ethereumjs-util';

contracts/asset-proxy/test/erc20bridge_proxy.ts

@@ -9,8 +9,9 @@ import {
     Numberish,
     randomAddress,
 } from '@0x/contracts-test-utils';
+import { AuthorizableRevertErrors } from '@0x/contracts-utils';
 import { AssetProxyId } from '@0x/types';
-import { AbiEncoder, AuthorizableRevertErrors, BigNumber, StringRevertError } from '@0x/utils';
+import { AbiEncoder, BigNumber, StringRevertError } from '@0x/utils';
 import { DecodedLogs } from 'ethereum-types';
 import * as _ from 'lodash';
 

contracts/coordinator/CHANGELOG.json

@@ -5,6 +5,14 @@
             {
                 "note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils",
                 "pr": 2330
+            },
+            {
+                "note": "Introduced new export CoordinatorRevertErrors",
+                "pr": 2321
+            },
+            {
+                "note": "Added dependency on @0x/contracts-utils",
+                "pr": 2321
             }
         ]
     },

contracts/coordinator/package.json

@@ -81,6 +81,7 @@
     },
     "dependencies": {
         "@0x/base-contract": "^5.5.0-beta.1",
+        "@0x/contracts-utils": "^3.3.0-beta.1",
         "@0x/types": "^2.5.0-beta.1",
         "@0x/typescript-typings": "^4.4.0-beta.1",
         "@0x/utils": "^4.6.0-beta.1",

contracts/coordinator/src/approval_factory.ts

@@ -13,12 +13,16 @@ export class ApprovalFactory {
         this._verifyingContractAddress = verifyingContract;
     }
 
-    public newSignedApproval(
+    public async newSignedApprovalAsync(
         transaction: SignedZeroExTransaction,
         txOrigin: string,
         signatureType: SignatureType = SignatureType.EthSign,
-    ): SignedCoordinatorApproval {
-        const approvalHashBuff = hashUtils.getApprovalHashBuffer(transaction, this._verifyingContractAddress, txOrigin);
+    ): Promise<SignedCoordinatorApproval> {
+        const approvalHashBuff = await hashUtils.getApprovalHashBufferAsync(
+            transaction,
+            this._verifyingContractAddress,
+            txOrigin,
+        );
         const signatureBuff = signingUtils.signMessage(approvalHashBuff, this._privateKey, signatureType);
         const signedApproval = {
             txOrigin,

contracts/coordinator/src/hash_utils.ts

@@ -4,13 +4,25 @@ import { SignedZeroExTransaction } from '@0x/types';
 import { signTypedDataUtils } from '@0x/utils';
 
 export const hashUtils = {
-    getApprovalHashBuffer(transaction: SignedZeroExTransaction, verifyingContract: string, txOrigin: string): Buffer {
-        const typedData = eip712Utils.createCoordinatorApprovalTypedData(transaction, verifyingContract, txOrigin);
+    async getApprovalHashBufferAsync(
+        transaction: SignedZeroExTransaction,
+        verifyingContract: string,
+        txOrigin: string,
+    ): Promise<Buffer> {
+        const typedData = await eip712Utils.createCoordinatorApprovalTypedDataAsync(
+            transaction,
+            verifyingContract,
+            txOrigin,
+        );
         const hashBuffer = signTypedDataUtils.generateTypedDataHash(typedData);
         return hashBuffer;
     },
-    getApprovalHashHex(transaction: SignedZeroExTransaction, verifyingContract: string, txOrigin: string): string {
-        const hashHex = hexConcat(hashUtils.getApprovalHashBuffer(transaction, verifyingContract, txOrigin));
+    async getApprovalHashHexAsync(
+        transaction: SignedZeroExTransaction,
+        verifyingContract: string,
+        txOrigin: string,
+    ): Promise<string> {
+        const hashHex = hexConcat(await hashUtils.getApprovalHashBufferAsync(transaction, verifyingContract, txOrigin));
         return hashHex;
     },
 };

contracts/coordinator/src/index.ts

@@ -1,4 +1,5 @@
 export * from './artifacts';
 export * from './wrappers';
+export import CoordinatorRevertErrors = require('./revert_errors');
 export { ApprovalFactory } from './approval_factory';
 export { SignedCoordinatorApproval } from './types';

contracts/coordinator/test/libs.ts

@@ -1,5 +1,4 @@
-import { blockchainTests, constants, expect, randomAddress } from '@0x/contracts-test-utils';
-import { transactionHashUtils } from '@0x/order-utils';
+import { blockchainTests, constants, expect, randomAddress, transactionHashUtils } from '@0x/contracts-test-utils';
 import { BigNumber } from '@0x/utils';
 
 import { hashUtils } from '../src/hash_utils';
@@ -45,7 +44,11 @@ blockchainTests.resets('Libs tests', env => {
                 transactionHash: transactionHashUtils.getTransactionHashHex(signedTx),
                 transactionSignature: signedTx.signature,
             };
-            const expectedApprovalHash = hashUtils.getApprovalHashHex(signedTx, coordinatorContract.address, txOrigin);
+            const expectedApprovalHash = await hashUtils.getApprovalHashHexAsync(
+                signedTx,
+                coordinatorContract.address,
+                txOrigin,
+            );
             const approvalHash = await coordinatorContract.getCoordinatorApprovalHash(approval).callAsync();
             expect(expectedApprovalHash).to.eq(approvalHash);
         });

contracts/coordinator/test/mixins.ts

@@ -8,10 +8,13 @@ import {
     hexSlice,
     randomAddress,
     TransactionFactory,
+    transactionHashUtils,
 } from '@0x/contracts-test-utils';
-import { CoordinatorRevertErrors, transactionHashUtils } from '@0x/order-utils';
+import { LibBytesRevertErrors } from '@0x/contracts-utils';
 import { SignatureType, SignedOrder } from '@0x/types';
-import { BigNumber, LibBytesRevertErrors } from '@0x/utils';
+import { BigNumber } from '@0x/utils';
+
+import CoordinatorRevertErrors = require('../src/revert_errors');
 
 import { ApprovalFactory } from '../src/approval_factory';
 
@@ -237,7 +240,7 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [defaultOrder];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval = approvalFactory1.newSignedApproval(transaction, transactionSignerAddress);
+                const approval = await approvalFactory1.newSignedApprovalAsync(transaction, transactionSignerAddress);
                 await mixins
                     .assertValidCoordinatorApprovals(transaction, transactionSignerAddress, transaction.signature, [
                         approval.signature,
@@ -252,7 +255,7 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [order];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval = approvalFactory1.newSignedApproval(transaction, transactionSignerAddress);
+                const approval = await approvalFactory1.newSignedApprovalAsync(transaction, transactionSignerAddress);
                 await mixins
                     .assertValidCoordinatorApprovals(transaction, transactionSignerAddress, transaction.signature, [
                         approval.signature,
@@ -273,7 +276,7 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [defaultOrder];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval = approvalFactory1.newSignedApproval(transaction, transactionSignerAddress);
+                const approval = await approvalFactory1.newSignedApprovalAsync(transaction, transactionSignerAddress);
                 await mixins
                     .assertValidCoordinatorApprovals(transaction, approvalSignerAddress1, transaction.signature, [
                         approval.signature,
@@ -294,7 +297,7 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [defaultOrder];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval = approvalFactory1.newSignedApproval(transaction, transactionSignerAddress);
+                const approval = await approvalFactory1.newSignedApprovalAsync(transaction, transactionSignerAddress);
                 const signature = hexConcat(
                     hexSlice(approval.signature, 0, 2),
                     '0xFFFFFFFF',
@@ -315,7 +318,7 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [defaultOrder];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval = approvalFactory1.newSignedApproval(transaction, transactionSignerAddress);
+                const approval = await approvalFactory1.newSignedApprovalAsync(transaction, transactionSignerAddress);
 
                 const tx = mixins
                     .assertValidCoordinatorApprovals(transaction, transactionSignerAddress, transaction.signature, [
@@ -336,7 +339,7 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [defaultOrder, defaultOrder];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval = approvalFactory1.newSignedApproval(transaction, transactionSignerAddress);
+                const approval = await approvalFactory1.newSignedApprovalAsync(transaction, transactionSignerAddress);
                 await mixins
                     .assertValidCoordinatorApprovals(transaction, transactionSignerAddress, transaction.signature, [
                         approval.signature,
@@ -350,7 +353,7 @@ blockchainTests.resets('Mixins tests', env => {
                 }));
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval = approvalFactory1.newSignedApproval(transaction, transactionSignerAddress);
+                const approval = await approvalFactory1.newSignedApprovalAsync(transaction, transactionSignerAddress);
                 await mixins
                     .assertValidCoordinatorApprovals(transaction, transactionSignerAddress, transaction.signature, [
                         approval.signature,
@@ -372,7 +375,7 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [defaultOrder, { ...defaultOrder, senderAddress: constants.NULL_ADDRESS }];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval = approvalFactory1.newSignedApproval(transaction, transactionSignerAddress);
+                const approval = await approvalFactory1.newSignedApprovalAsync(transaction, transactionSignerAddress);
                 await mixins
                     .assertValidCoordinatorApprovals(transaction, transactionSignerAddress, transaction.signature, [
                         approval.signature,
@@ -383,8 +386,8 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [defaultOrder, { ...defaultOrder, feeRecipientAddress: approvalSignerAddress2 }];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval1 = approvalFactory1.newSignedApproval(transaction, transactionSignerAddress);
-                const approval2 = approvalFactory2.newSignedApproval(transaction, transactionSignerAddress);
+                const approval1 = await approvalFactory1.newSignedApprovalAsync(transaction, transactionSignerAddress);
+                const approval2 = await approvalFactory2.newSignedApprovalAsync(transaction, transactionSignerAddress);
                 await mixins
                     .assertValidCoordinatorApprovals(transaction, transactionSignerAddress, transaction.signature, [
                         approval1.signature,
@@ -404,7 +407,7 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [defaultOrder, { ...defaultOrder, feeRecipientAddress: approvalSignerAddress2 }];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval2 = approvalFactory2.newSignedApproval(transaction, transactionSignerAddress);
+                const approval2 = await approvalFactory2.newSignedApprovalAsync(transaction, transactionSignerAddress);
 
                 const tx = mixins
                     .assertValidCoordinatorApprovals(transaction, transactionSignerAddress, transaction.signature, [
@@ -430,7 +433,7 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [defaultOrder, defaultOrder];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval = approvalFactory1.newSignedApproval(transaction, transactionSignerAddress);
+                const approval = await approvalFactory1.newSignedApprovalAsync(transaction, transactionSignerAddress);
                 const signature = hexConcat(
                     hexSlice(approval.signature, 0, 2),
                     '0xFFFFFFFF',
@@ -451,8 +454,8 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [defaultOrder, { ...defaultOrder, feeRecipientAddress: approvalSignerAddress2 }];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval1 = approvalFactory1.newSignedApproval(transaction, transactionSignerAddress);
-                const approval2 = approvalFactory2.newSignedApproval(transaction, transactionSignerAddress);
+                const approval1 = await approvalFactory1.newSignedApprovalAsync(transaction, transactionSignerAddress);
+                const approval2 = await approvalFactory2.newSignedApprovalAsync(transaction, transactionSignerAddress);
                 const approvalSignature2 = hexConcat(
                     hexSlice(approval2.signature, 0, 2),
                     '0xFFFFFFFF',
@@ -474,7 +477,7 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [defaultOrder, { ...defaultOrder, feeRecipientAddress: approvalSignerAddress2 }];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval2 = approvalFactory2.newSignedApproval(transaction, transactionSignerAddress);
+                const approval2 = await approvalFactory2.newSignedApprovalAsync(transaction, transactionSignerAddress);
                 const approvalSignature2 = hexConcat(
                     hexSlice(approval2.signature, 0, 2),
                     '0xFFFFFFFF',
@@ -495,7 +498,7 @@ blockchainTests.resets('Mixins tests', env => {
                 const orders = [defaultOrder, defaultOrder];
                 const data = exchangeDataEncoder.encodeOrdersToExchangeData(fnName, orders);
                 const transaction = await transactionFactory.newSignedTransactionAsync({ data });
-                const approval1 = approvalFactory1.newSignedApproval(transaction, transactionSignerAddress);
+                const approval1 = await approvalFactory1.newSignedApprovalAsync(transaction, transactionSignerAddress);
 
                 const tx = mixins
                     .assertValidCoordinatorApprovals(transaction, transactionSignerAddress, transaction.signature, [

contracts/dev-utils/CHANGELOG.json

@@ -5,6 +5,14 @@
             {
                 "note": "Drastically reduced bundle size by adding .npmignore, only exporting specific artifacts/wrappers/utils",
                 "pr": 2330
+            },
+            {
+                "note": "Add new method getOrderHash() to DevUtils contract",
+                "pr": 2321
+            },
+            {
+                "note": "Add new method getTransactionHash() to DevUtils contract",
+                "pr": 2321
             }
         ]
     },

contracts/dev-utils/compiler.json

@@ -7,7 +7,7 @@
         "evmVersion": "constantinople",
         "optimizer": {
             "enabled": true,
-            "runs": 10000,
+            "runs": 1666,
             "details": { "yul": true, "deduplicate": true, "cse": true, "constantOptimizer": true }
         },
         "outputSelection": {

contracts/dev-utils/contracts/src/DevUtils.sol

@@ -19,6 +19,11 @@
 pragma solidity ^0.5.5;
 pragma experimental ABIEncoderV2;
 
+import "@0x/contracts-exchange-libs/contracts/src/LibEIP712ExchangeDomain.sol";
+import "@0x/contracts-exchange-libs/contracts/src/LibOrder.sol";
+import "@0x/contracts-exchange-libs/contracts/src/LibZeroExTransaction.sol";
+import "@0x/contracts-utils/contracts/src/LibEIP712.sol";
+import "@0x/contracts-utils/contracts/src/LibBytes.sol";
 import "./OrderValidationUtils.sol";
 import "./OrderTransferSimulationUtils.sol";
 import "./LibTransactionDecoder.sol";
@@ -29,12 +34,40 @@ import "./EthBalanceChecker.sol";
 contract DevUtils is
     OrderValidationUtils,
     LibTransactionDecoder,
+    LibEIP712ExchangeDomain,
     EthBalanceChecker,
     OrderTransferSimulationUtils
 {
     constructor (address _exchange)
         public
         OrderValidationUtils(_exchange)
         OrderTransferSimulationUtils(_exchange)
+        LibEIP712ExchangeDomain(uint256(0), address(0)) // null args because because we only use constants
     {}
+
+    function getOrderHash(LibOrder.Order memory order, uint256 chainId, address exchange)
+        public
+        pure
+        returns (bytes32 orderHash)
+    {
+        return LibOrder.getTypedDataHash(
+            order,
+            LibEIP712.hashEIP712Domain(_EIP712_EXCHANGE_DOMAIN_NAME, _EIP712_EXCHANGE_DOMAIN_VERSION, chainId, exchange)
+        );
+    }
+
+    function getTransactionHash(
+        LibZeroExTransaction.ZeroExTransaction memory transaction,
+        uint256 chainId,
+        address exchange
+    )
+        public
+        pure
+        returns (bytes32 transactionHash)
+    {
+        return LibZeroExTransaction.getTypedDataHash(
+            transaction,
+            LibEIP712.hashEIP712Domain(_EIP712_EXCHANGE_DOMAIN_NAME, _EIP712_EXCHANGE_DOMAIN_VERSION, chainId, exchange)
+        );
+    }
 }

contracts/dev-utils/package.json

@@ -8,7 +8,8 @@
     "main": "lib/src/index.js",
     "scripts": {
         "build": "yarn pre_build && tsc -b",
-        "test": "echo !!! Run tests in @0x/contracts-tests instead !!!",
+        "test": "yarn assert_deployable && echo !!! Tests are run via @0x/contracts-tests !!!",
+        "assert_deployable": "node -e \"const bytecodeLen = (require('./generated-artifacts/DevUtils.json').compilerOutput.evm.bytecode.object.length-2)/2; assert(bytecodeLen<=0x6000,'DevUtils contract is too big to deploy, per EIP-170. '+bytecodeLen+'>'+0x6000)\"",
         "build:ci": "yarn build",
         "pre_build": "run-s compile quantify_bytecode contracts:gen generate_contract_wrappers contracts:copy",
         "compile": "sol-compiler",