Merge pull request #12575 from ethereum/gnosis-gp-v2-ext-test

External test for Gnosis Protocol v2

.circleci/config.yml

@@ -613,6 +613,13 @@ defaults:
       binary_type: native
       nodejs_version: '16'
       resource_class: large # Tests run out of memory on a smaller machine
+  - job_native_test_ext_gp2: &job_native_test_ext_gp2
+      <<: *workflow_ubuntu2004_static
+      name: t_native_test_ext_gp2
+      project: gp2
+      binary_type: native
+      # NOTE: Tests crash on nodejs 17: "Error: error:0308010C:digital envelope routines::unsupported"
+      nodejs_version: '16'
   - job_ems_test_ext_colony: &job_ems_test_ext_colony
       <<: *workflow_emscripten
       name: t_ems_test_ext_colony
@@ -1604,6 +1611,7 @@ workflows:
       - t_ems_ext: *job_native_test_ext_elementfi
       - t_ems_ext: *job_native_test_ext_brink
       - t_ems_ext: *job_native_test_ext_chainlink
+      - t_ems_ext: *job_native_test_ext_gp2
 
       - c_ext_benchmarks:
           <<: *workflow_trigger_on_tags
@@ -1623,6 +1631,7 @@ workflows:
             - t_native_test_ext_elementfi
             - t_native_test_ext_brink
             - t_native_test_ext_chainlink
+            - t_native_test_ext_gp2
 
       # Windows build and tests
       - b_win: *workflow_trigger_on_tags

test/externalTests.sh

@@ -52,3 +52,4 @@ printTask "Running external tests..."
 "${REPO_ROOT}/test/externalTests/elementfi.sh" "$@"
 "${REPO_ROOT}/test/externalTests/brink.sh" "$@"
 "${REPO_ROOT}/test/externalTests/chainlink.sh" "$@"
+"${REPO_ROOT}/test/externalTests/gp2.sh" "$@"

test/externalTests/gp2.sh

@@ -0,0 +1,106 @@
+#!/usr/bin/env bash
+
+# ------------------------------------------------------------------------------
+# This file is part of solidity.
+#
+# solidity is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# solidity is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with solidity.  If not, see <http://www.gnu.org/licenses/>
+#
+# (c) 2019 solidity contributors.
+#------------------------------------------------------------------------------
+
+set -e
+
+source scripts/common.sh
+source test/externalTests/common.sh
+
+REPO_ROOT=$(realpath "$(dirname "$0")/../..")
+
+verify_input "$@"
+BINARY_TYPE="$1"
+BINARY_PATH="$2"
+SELECTED_PRESETS="$3"
+
+function compile_fn { npm run build; }
+function test_fn { npm test; }
+
+function gp2_test
+{
+    local repo="https://github.com/gnosis/gp-v2-contracts.git"
+    local ref_type=branch
+    local ref=main
+    local config_file="hardhat.config.ts"
+    local config_var="config"
+
+    local compile_only_presets=(
+        legacy-no-optimize        # Tests doing `new GPv2VaultRelayer` fail with "Error: Transaction reverted: trying to deploy a contract whose code is too large"
+    )
+    local settings_presets=(
+        "${compile_only_presets[@]}"
+        #ir-no-optimize           # Compilation fails with "YulException: Variable var_amount_1468 is 10 slot(s) too deep inside the stack."
+        #ir-no-optimize           # Compilation fails with "YulException: Variable var_offset_3451 is 1 slot(s) too deep inside the stack."
+        ir-optimize-evm+yul
+        legacy-optimize-evm-only
+        legacy-optimize-evm+yul
+    )
+
+    [[ $SELECTED_PRESETS != "" ]] || SELECTED_PRESETS=$(circleci_select_steps_multiarg "${settings_presets[@]}")
+    print_presets_or_exit "$SELECTED_PRESETS"
+
+    setup_solc "$DIR" "$BINARY_TYPE" "$BINARY_PATH"
+    download_project "$repo" "$ref_type" "$ref" "$DIR"
+    [[ $BINARY_TYPE == native ]] && replace_global_solc "$BINARY_PATH"
+
+    neutralize_package_lock
+    neutralize_package_json_hooks
+    name_hardhat_default_export "$config_file" "$config_var"
+    force_hardhat_compiler_binary "$config_file" "$BINARY_TYPE" "$BINARY_PATH"
+    force_hardhat_compiler_settings "$config_file" "$(first_word "$SELECTED_PRESETS")" "$config_var"
+    force_hardhat_unlimited_contract_size "$config_file" "$config_var"
+    npm install
+
+    # Some dependencies come with pre-built artifacts. We want to build from scratch.
+    rm -r node_modules/@gnosis.pm/safe-contracts/build/
+
+    # FIXME: One of the E2E tests tries to import artifacts from Gnosis Safe. We should rebuild them
+    # but it's not that easy because @gnosis.pm/safe-contracts does not come with Hardhat config.
+    rm test/e2e/contractOrdersWithGnosisSafe.test.ts
+
+    # Patch contracts for 0.8.x compatibility.
+    # NOTE: I'm patching OpenZeppelin as well instead of installing OZ 4.0 because it requires less
+    # work. The project imports files that were moved to different locations in 4.0.
+    sed -i 's|uint256(-1)|type(uint256).max|g' src/contracts/GPv2Settlement.sol
+    sed -i 's|return msg\.sender;|return payable(msg.sender);|g' node_modules/@openzeppelin/contracts/utils/Context.sol
+    perl -i -0pe \
+        "s/uint256 (executedBuyAmount = \(-tokenDeltas\[trade.buyTokenIndex\]\)\n\s+.toUint256\(\);)/uint256 executedBuyAmount; unchecked \{\1\}/g" \
+        src/contracts/GPv2Settlement.sol
+
+    # This test is not supposed to work. The compiler is supposed to enforce zero padding since
+    # at least 0.5.8 (see https://github.com/ethereum/solidity/pull/5815). For some reason the
+    # test worked on 0.7.6 but no longer works on 0.8.x.
+    sed -i 's|it\(("invalid EVM transaction encoding does not change order hash"\)|it.skip\1|g' test/GPv2Signing.test.ts
+
+    # Disable tests that won't pass on the ir presets due to Hardhat heuristics. Note that this also disables
+    # them for other presets but that's fine - we want same code run for benchmarks to be comparable.
+    # TODO: Remove this when Hardhat adjusts heuristics for IR (https://github.com/nomiclabs/hardhat/issues/2115).
+    sed -i 's|it\(("should revert when encoding invalid flags"\)|it.skip\1|g' test/GPv2Trade.test.ts
+
+    replace_version_pragmas
+
+    for preset in $SELECTED_PRESETS; do
+        hardhat_run_test "$config_file" "$preset" "${compile_only_presets[*]}" compile_fn test_fn "$config_var"
+        store_benchmark_report hardhat gp2 "$repo" "$preset"
+    done
+}
+
+external_test Gnosis-Protocol-V2 gp2_test