Merge pull request #1790 from 0xProject/feature/3.0/contracts/exchang…

…e/rich-revert-decoder [3.0] Add LibExchangeRichErrorDecoder to exchange package
0xProject · Apr 30, 2019 · 39790f2 · 39790f2
2 parents 02f6cb8 + 9384848
commit 39790f2
Show file tree

Hide file tree

Showing 34 changed files with 895 additions and 149 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -550,9 +550,10 @@ workflows:
             - test-contracts-ganache:
                   requires:
                       - build-3.0
-            - test-contracts-geth:
-                  requires:
-                      - build-3.0
+            # Disabled until geth docker image is fixed.
+            # - test-contracts-geth:
+            #       requires:
+            #           - build-3.0
             # Disabled for 3.0
             # - test-pipeline:
             #       requires:

diff --git a/contracts/asset-proxy/compiler.json b/contracts/asset-proxy/compiler.json
@@ -1,7 +1,7 @@
 {
     "artifactsDir": "./generated-artifacts",
     "contractsDir": "./contracts",
-    "useDockerisedSolc": true,
+    "useDockerisedSolc": false,
     "isOfflineMode": false,
     "compilerSettings": {
         "evmVersion": "constantinople",

diff --git a/contracts/coordinator/compiler.json b/contracts/coordinator/compiler.json
@@ -1,7 +1,7 @@
 {
     "artifactsDir": "./generated-artifacts",
     "contractsDir": "./contracts",
-    "useDockerisedSolc": true,
+    "useDockerisedSolc": false,
     "compilerSettings": {
         "evmVersion": "constantinople",
         "optimizer": {

diff --git a/contracts/erc1155/compiler.json b/contracts/erc1155/compiler.json
@@ -1,7 +1,7 @@
 {
     "artifactsDir": "generated-artifacts",
     "contractsDir": "contracts",
-    "useDockerisedSolc": true,
+    "useDockerisedSolc": false,
     "compilerSettings": {
         "evmVersion": "constantinople",
         "optimizer": { "enabled": true, "runs": 1000000 },

diff --git a/contracts/erc20/compiler.json b/contracts/erc20/compiler.json
@@ -1,7 +1,7 @@
 {
     "artifactsDir": "./generated-artifacts",
     "contractsDir": "./contracts",
-    "useDockerisedSolc": true,
+    "useDockerisedSolc": false,
     "isOfflineMode": false,
     "compilerSettings": {
         "evmVersion": "constantinople",

diff --git a/contracts/erc721/compiler.json b/contracts/erc721/compiler.json
@@ -1,7 +1,7 @@
 {
     "artifactsDir": "./generated-artifacts",
     "contractsDir": "./contracts",
-    "useDockerisedSolc": true,
+    "useDockerisedSolc": false,
     "isOfflineMode": false,
     "compilerSettings": {
         "evmVersion": "constantinople",

diff --git a/contracts/exchange-forwarder/compiler.json b/contracts/exchange-forwarder/compiler.json
@@ -1,7 +1,7 @@
 {
     "artifactsDir": "./generated-artifacts",
     "contractsDir": "./contracts",
-    "useDockerisedSolc": true,
+    "useDockerisedSolc": false,
     "isOfflineMode": false,
     "compilerSettings": {
         "evmVersion": "constantinople",

diff --git a/contracts/exchange-libs/CHANGELOG.json b/contracts/exchange-libs/CHANGELOG.json
@@ -25,6 +25,18 @@
             {
                 "note": "Remove LibEIP712ExchangeDomainConstants and LibEIP712 contracts",
                 "pr": 1753
+            },
+            {
+                "note": "Add `LibExchangeRichErrorDecoder` contract.",
+                "pr": 1790
+            },
+            {
+                "note": "Break out types/interaces from `MExchangeRichErrors` into `MExchangeRichErrorTypes`.",
+                "pr": 1790
+            },
+            {
+                "note": "Reorder some revert error parameters for consistency",
+                "pr": 1790
             }
         ]
     },

diff --git a/contracts/exchange-libs/compiler.json b/contracts/exchange-libs/compiler.json
@@ -1,7 +1,7 @@
 {
     "artifactsDir": "./generated-artifacts",
     "contractsDir": "./contracts",
-    "useDockerisedSolc": true,
+    "useDockerisedSolc": false,
     "isOfflineMode": false,
     "compilerSettings": {
         "evmVersion": "constantinople",

diff --git a/contracts/exchange/compiler.json b/contracts/exchange/compiler.json
@@ -1,7 +1,7 @@
 {
     "artifactsDir": "./generated-artifacts",
     "contractsDir": "./contracts",
-    "useDockerisedSolc": true,
+    "useDockerisedSolc": false,
     "isOfflineMode": false,
     "compilerSettings": {
         "evmVersion": "constantinople",
@@ -41,6 +41,7 @@
         "test/ReentrantERC20Token.sol",
         "test/TestAssetProxyDispatcher.sol",
         "test/TestExchangeInternals.sol",
+        "test/TestLibExchangeRichErrorDecoder.sol",
         "test/TestRevertReceiver.sol",
         "test/TestSignatureValidator.sol",
         "test/TestStaticCallReceiver.sol"

diff --git a/contracts/exchange/contracts/src/MixinExchangeCore.sol b/contracts/exchange/contracts/src/MixinExchangeCore.sol
@@ -331,8 +331,8 @@ contract MixinExchangeCore is
         // An order can only be filled if its status is FILLABLE.
         if (orderInfo.orderStatus != uint8(OrderStatus.FILLABLE)) {
             rrevert(OrderStatusError(
-                OrderStatus(orderInfo.orderStatus),
-                orderInfo.orderHash
+                orderInfo.orderHash,
+                OrderStatus(orderInfo.orderStatus)
             ));
         }
 
@@ -441,7 +441,10 @@ contract MixinExchangeCore is
         // Ensure order is valid
         // An order can only be cancelled if its status is FILLABLE.
         if (orderInfo.orderStatus != uint8(OrderStatus.FILLABLE)) {
-            rrevert(OrderStatusError(OrderStatus(orderInfo.orderStatus), orderInfo.orderHash));
+            rrevert(OrderStatusError(
+                orderInfo.orderHash,
+                OrderStatus(orderInfo.orderStatus)
+            ));
         }
 
         // Validate sender is allowed to cancel this order

diff --git a/contracts/exchange/contracts/src/MixinExchangeRichErrors.sol b/contracts/exchange/contracts/src/MixinExchangeRichErrors.sol
@@ -29,8 +29,8 @@ contract MixinExchangeRichErrors is
 {
     // solhint-disable func-name-mixedcase
     function SignatureError(
-        SignatureErrorCodes error,
-        bytes32 orderHash,
+        SignatureErrorCodes errorCode,
+        bytes32 hash,
         address signer,
         bytes memory signature
     )
@@ -40,15 +40,15 @@ contract MixinExchangeRichErrors is
     {
         return abi.encodeWithSelector(
             SIGNATURE_ERROR_SELECTOR,
-            error,
-            orderHash,
+            errorCode,
+            hash,
             signer,
             signature
         );
     }
 
     function SignatureValidatorError(
-        bytes32 orderHash,
+        bytes32 hash,
         address signer,
         bytes memory signature,
         bytes memory errorData
@@ -59,15 +59,15 @@ contract MixinExchangeRichErrors is
     {
         return abi.encodeWithSelector(
             SIGNATURE_VALIDATOR_ERROR_SELECTOR,
-            orderHash,
+            hash,
             signer,
             signature,
             errorData
         );
     }
 
     function SignatureWalletError(
-        bytes32 orderHash,
+        bytes32 hash,
         address signer,
         bytes memory signature,
         bytes memory errorData
@@ -78,7 +78,7 @@ contract MixinExchangeRichErrors is
     {
         return abi.encodeWithSelector(
             SIGNATURE_WALLET_ERROR_SELECTOR,
-            orderHash,
+            hash,
             signer,
             signature,
             errorData
@@ -124,17 +124,17 @@ contract MixinExchangeRichErrors is
     }
 
     function OrderStatusError(
-        LibOrder.OrderStatus orderStatus,
-        bytes32 orderHash
+        bytes32 orderHash,
+        LibOrder.OrderStatus orderStatus
     )
         internal
         pure
         returns (bytes memory)
     {
         return abi.encodeWithSelector(
             ORDER_STATUS_ERROR_SELECTOR,
-            orderStatus,
-            orderHash
+            orderHash,
+            orderStatus
         );
     }
 
@@ -169,7 +169,7 @@ contract MixinExchangeRichErrors is
     }
 
     function FillError(
-        FillErrorCodes error,
+        FillErrorCodes errorCode,
         bytes32 orderHash
     )
         internal
@@ -178,7 +178,7 @@ contract MixinExchangeRichErrors is
     {
         return abi.encodeWithSelector(
             FILL_ERROR_SELECTOR,
-            error,
+            errorCode,
             orderHash
         );
     }
@@ -229,7 +229,7 @@ contract MixinExchangeRichErrors is
     }
 
     function AssetProxyDispatchError(
-        AssetProxyDispatchErrorCodes error,
+        AssetProxyDispatchErrorCodes errorCode,
         bytes32 orderHash,
         bytes memory assetData
     )
@@ -239,7 +239,7 @@ contract MixinExchangeRichErrors is
     {
         return abi.encodeWithSelector(
             ASSET_PROXY_DISPATCH_ERROR_SELECTOR,
-            error,
+            errorCode,
             orderHash,
             assetData
         );
@@ -278,7 +278,7 @@ contract MixinExchangeRichErrors is
     }
 
     function TransactionError(
-        TransactionErrorCodes error,
+        TransactionErrorCodes errorCode,
         bytes32 transactionHash
     )
         internal
@@ -287,7 +287,7 @@ contract MixinExchangeRichErrors is
     {
         return abi.encodeWithSelector(
             TRANSACTION_ERROR_SELECTOR,
-            error,
+            errorCode,
             transactionHash
         );
     }