diff --git a/.circleci/config.yml b/.circleci/config.yml index a4bb8e5ffa8..8b1d3e6aaad 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -50,6 +50,9 @@ parameters: acceptance_tests_dispatch: type: boolean default: false + sync_test_op_node_dispatch: + type: boolean + default: false github-event-type: type: string default: "__not_set__" @@ -225,7 +228,6 @@ commands: fi when: on_fail - get-target-branch: description: "Determine the PR target branch and export TARGET_BRANCH for subsequent steps" steps: @@ -245,6 +247,39 @@ commands: echo "Resolved TARGET_BRANCH=$TARGET_BRANCH" echo "export TARGET_BRANCH=$TARGET_BRANCH" >> "$BASH_ENV" + setup-dev-features: + description: "Set up dev feature environment variables from comma-separated list" + parameters: + dev_features: + description: "Comma-separated list of dev features to enable" + type: string + default: "" + steps: + - run: + name: Set dev feature environment variables + command: | + # Set dev feature environment variables if provided + if [ -n "<>" ]; then + DEV_FEATURES_STRING="<>" + + # Check if this is just "main" (baseline with no dev features) + if [ "$(echo "$DEV_FEATURES_STRING" | tr '[:upper:]' '[:lower:]')" = "main" ]; then + echo "Running with baseline configuration (no dev features enabled)" + else + echo "Enabling dev features: <>" + IFS=',' + for feature in $DEV_FEATURES_STRING; do + feature=$(echo "$feature" | xargs) # trim whitespace + if [ -n "$feature" ] && [ "$(echo "$feature" | tr '[:upper:]' '[:lower:]')" != "main" ]; then + env_var="DEV_FEATURE__${feature}" + echo "Setting ${env_var}=true" + echo "export ${env_var}=true" >> $BASH_ENV + fi + done + unset IFS + fi + fi + run-contracts-check: parameters: command: @@ -270,7 +305,6 @@ commands: at: "." - utils/install-mise - jobs: initialize: docker: @@ -682,42 +716,6 @@ jobs: docker pull $image_name || exit 1 docker run $image_name <> --version || exit 1 - - contracts-bedrock-frozen-code: - machine: true - resource_class: ethereum-optimism/latitude-1 - steps: - - checkout-from-workspace - - check-changed: - patterns: contracts-bedrock - - get-target-branch - - run: - name: Check if target branch is develop - command: | - # If the target branch is not develop, do not run this check - if [ "${TARGET_BRANCH}" != "develop" ]; then - echo "Target branch is not develop, skipping frozen files check" - circleci-agent step halt - fi - - run: - name: Check if PR has exempt label - command: | - # Get PR number from CIRCLE_PULL_REQUEST - PR_NUMBER=$(echo $CIRCLE_PULL_REQUEST | rev | cut -d/ -f1 | rev) - - # Use GitHub API to get labels - LABELS=$(curl -s "https://api.github.com/repos/${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME}/pulls/${PR_NUMBER}" | jq -r .labels) - - # If the PR has the "M-exempt-frozen-files" label, do not run this check - if echo $LABELS | jq -e 'any(.[]; .name == "M-exempt-frozen-files")' > /dev/null; then - echo "Skipping frozen files check, PR has exempt label" - circleci-agent step halt - fi - - run: - name: Check frozen files - command: just check-frozen-code - working_directory: packages/contracts-bedrock - contracts-bedrock-tests: circleci_ip_ranges: true docker: @@ -743,6 +741,10 @@ jobs: description: Profile to use for testing type: string default: ci + check_changed_patterns: + description: List of changed files to run tests on + type: string + default: contracts-bedrock steps: - checkout-from-workspace - run: @@ -755,7 +757,7 @@ jobs: fi working_directory: packages/contracts-bedrock - check-changed: - patterns: contracts-bedrock,op-node + patterns: <> - run: name: Print dependencies command: just dep-status @@ -805,7 +807,7 @@ jobs: contracts-bedrock-coverage: circleci_ip_ranges: true docker: - - image: <> + - image: <> resource_class: 2xlarge parameters: test_flags: @@ -820,10 +822,14 @@ jobs: description: Profile to use for testing type: string default: ci + dev_features: + description: Comma-separated list of dev features to enable (e.g., "OPTIMISM_PORTAL_INTEROP,ANOTHER_FEATURE") + type: string + default: "" steps: - checkout-from-workspace - check-changed: - patterns: contracts-bedrock,op-node + patterns: contracts-bedrock - run: name: Print dependencies command: just dep-status @@ -850,6 +856,8 @@ jobs: - restore_cache: name: Restore forked state key: forked-state-contracts-bedrock-tests-upgrade-{{ checksum "packages/contracts-bedrock/pinnedBlockNumber.txt" }} + - setup-dev-features: + dev_features: <> - run: name: Run coverage tests command: just coverage-lcov-all <> @@ -860,8 +868,7 @@ jobs: no_output_timeout: <> - run: name: Print failed test traces - command: | - just test-rerun | tee failed-test-traces.log + command: just test-rerun | tee failed-test-traces.log environment: FOUNDRY_PROFILE: <> ETH_RPC_URL: https://ci-mainnet-l1-archive.optimism.io @@ -896,7 +903,7 @@ jobs: steps: - checkout-from-workspace - check-changed: - patterns: contracts-bedrock,op-node + patterns: contracts-bedrock - run: name: Print dependencies command: just dep-status @@ -967,7 +974,7 @@ jobs: steps: - checkout-from-workspace - check-changed: - patterns: contracts-bedrock,op-node + patterns: contracts-bedrock - get-target-branch - run: name: print forge version @@ -1105,6 +1112,7 @@ jobs: default: "go-tests-short-ci" machine: true resource_class: <> + circleci_ip_ranges: true steps: - checkout-from-workspace - run: @@ -1114,9 +1122,6 @@ jobs: <> export TEST_TIMEOUT=<> make <> - - codecov/upload: - disable_search: true - files: ./coverage.out - store_test_results: path: ./tmp/test-results - run: @@ -1198,6 +1203,142 @@ jobs: - notify-failures-on-develop: mentions: "<>" + op-acceptance-sync-tests-docker: + parameters: + gate: + description: The gate to run the acceptance tests against. This gate should be defined in op-acceptance-tests/acceptance-tests.yaml. + type: string + default: "" + no_output_timeout: + description: Timeout for when CircleCI kills the job if there's no output + type: string + default: 30m + # Optional sync test configuration parameters + l2_network_name: + description: L2 network name + type: string + default: "" + l1_chain_id: + description: L1 chain ID + type: string + default: "" + l2_el_endpoint: + description: L2 EL endpoint + type: string + default: "" + l1_cl_beacon_endpoint: + description: L1 CL beacon endpoint + type: string + default: "" + l1_el_endpoint: + description: L1 EL endpoint + type: string + default: "" + initial_l2_block: + description: Initial L2 block + type: string + default: "" + l2_el_endpoint_tailscale: + description: L2 EL endpoint for Tailscale networking + type: string + default: "" + l1_cl_beacon_endpoint_tailscale: + description: L1 CL beacon endpoint for Tailscale networking + type: string + default: "" + l1_el_endpoint_tailscale: + description: L1 EL endpoint for Tailscale networking + type: string + default: "" + resource_class: xlarge + docker: + - image: <> + circleci_ip_ranges: true + steps: + - checkout-from-workspace + # Restore cached Go modules + - restore_cache: + keys: + - go-mod-v1-{{ checksum "go.sum" }} + - go-mod-v1- + # Download Go dependencies + - run: + name: Download Go dependencies + working_directory: op-acceptance-tests + command: go mod download + # Persist schedule name into env var + - run: + name: Persist schedule name into env var + command: | + echo 'export CIRCLECI_PIPELINE_SCHEDULE_NAME="<< pipeline.schedule.name >>"' >> $BASH_ENV + echo 'export CIRCLECI_PARAMETERS_SYNC_TEST_OP_NODE_DISPATCH="<< pipeline.parameters.sync_test_op_node_dispatch >>"' >> $BASH_ENV + # Run the acceptance tests + - run: + name: Run acceptance tests (gate=<>) + working_directory: op-acceptance-tests + no_output_timeout: 1h + environment: + GOFLAGS: "-mod=mod" + GO111MODULE: "on" + GOGC: "0" + # Optional sync test configuration environment variables (only set if parameters are provided) + L2_NETWORK_NAME: "<>" + L1_CHAIN_ID: "<>" + L2_EL_ENDPOINT: "<>" + L1_CL_BEACON_ENDPOINT: "<>" + L1_EL_ENDPOINT: "<>" + INITIAL_L2_BLOCK: "<>" + L2_EL_ENDPOINT_TAILSCALE: "<>" + L1_CL_BEACON_ENDPOINT_TAILSCALE: "<>" + L1_EL_ENDPOINT_TAILSCALE: "<>" + command: | + # Run the tests + LOG_LEVEL=debug just acceptance-test "" "<>" + - run: + name: Print results (summary) + working_directory: op-acceptance-tests + command: | + LOG_DIR=$(ls -td -- logs/* | head -1) + cat "$LOG_DIR/summary.log" || true + - run: + name: Print results (failures) + working_directory: op-acceptance-tests + command: | + LOG_DIR=$(ls -td -- logs/* | head -1) + cat "$LOG_DIR/failed/*.log" || true + when: on_fail + - run: + name: Print results (all) + working_directory: op-acceptance-tests + command: | + LOG_DIR=$(ls -td -- logs/* | head -1) + cat "$LOG_DIR/all.log" || true + - run: + name: Generate JUnit XML test report for CircleCI + working_directory: op-acceptance-tests + when: always + command: | + LOG_DIR=$(ls -td -- logs/* | head -1) + gotestsum --junitfile results/results.xml --raw-command cat $LOG_DIR/raw_go_events.log || true + # Save the module cache for future runs + - save_cache: + key: go-mod-v1-{{ checksum "go.sum" }} + paths: + - "/go/pkg/mod" + # Store test results and artifacts + - when: + condition: always + steps: + - store_test_results: + path: ./op-acceptance-tests/results + - when: + condition: always + steps: + - store_artifacts: + path: ./op-acceptance-tests/logs + - notify-failures-on-develop: + mentions: "@changwan <@U08L5U8070U>" # @changwan @Anton Evangelatov + op-acceptance-tests: parameters: devnet: @@ -1217,37 +1358,41 @@ jobs: description: Timeout for when CircleCI kills the job if there's no output type: string default: 30m + use_circleci_runner: + description: Whether to use CircleCI runners (with Docker) instead of self-hosted runners + type: boolean + default: false machine: - image: ubuntu-2404:current - docker_layer_caching: true # Since we are building docker images for components, we'll cache the layers for faster builds - resource_class: xlarge + image: <<# parameters.use_circleci_runner >>ubuntu-2404:current<><<^ parameters.use_circleci_runner >>true<> + docker_layer_caching: <> + resource_class: <<# parameters.use_circleci_runner >>xlarge<><<^ parameters.use_circleci_runner >>ethereum-optimism/latitude-1<> steps: - checkout-from-workspace - - run: - name: Setup Kurtosis (if needed) - command: | - if [[ "<>" != "" ]]; then - echo "Setting up Kurtosis for external devnet testing..." + - unless: + condition: + equal: ["", <>] + steps: + - run: + name: Setup Kurtosis + command: | + echo "Setting up Kurtosis for external devnet testing..." - # Print Kurtosis version - echo "Using Kurtosis from: $(which kurtosis || echo 'not found')" - kurtosis version + # Print Kurtosis version + echo "Using Kurtosis from: $(which kurtosis || echo 'not found')" + kurtosis version - # Start Kurtosis engine - echo "Starting Kurtosis engine..." - kurtosis engine start || true + # Start Kurtosis engine + echo "Starting Kurtosis engine..." + kurtosis engine start || true - # Clean old instances - echo "Cleaning old instances..." - kurtosis clean -a || true + # Clean old instances + echo "Cleaning old instances..." + kurtosis clean -a || true - # Check engine status - kurtosis engine status || true + # Check engine status + kurtosis engine status || true - echo "Kurtosis setup complete" - else - echo "Using in-process testing (sysgo orchestrator) - no Kurtosis setup needed" - fi + echo "Kurtosis setup complete" # Notify us of a setup failure - when: condition: on_fail @@ -1276,7 +1421,7 @@ jobs: command: go test -v -c -o /dev/null $(go list -f '{{if .TestGoFiles}}{{.ImportPath}}{{end}}' ./tests/...) # Run the acceptance tests (if the devnet is running) - run: - name: Run acceptance tests (gate=<>) + name: Run acceptance tests (devnet=<>, gate=<>) working_directory: op-acceptance-tests no_output_timeout: 1h environment: @@ -1284,8 +1429,12 @@ jobs: GO111MODULE: "on" GOGC: "0" command: | - # Run the tests - LOG_LEVEL=debug just acceptance-test "<>" "<>" + if [[ "<>" == "" ]]; then + echo "Running in gateless mode - auto-discovering all tests in ./op-acceptance-tests/..." + else + echo "Running in gate mode (gate=<>)" + fi + LOG_LEVEL=info just acceptance-test "<>" "<>" - run: name: Print results (summary) working_directory: op-acceptance-tests @@ -1425,8 +1574,9 @@ jobs: - "op-program/bin/meta*" publish-cannon-prestates: - machine: true - resource_class: ethereum-optimism/latitude-1 + resource_class: medium + docker: + - image: <> steps: - utils/checkout-with-mise - attach_workspace: @@ -1436,6 +1586,7 @@ jobs: gcp_cred_config_file_path: /tmp/gcp_cred_config.json oidc_token_file_path: /tmp/oidc_token.json - run: + no_output_timeout: 30m name: Upload cannon prestates command: | # Use the actual hash for tags (hash can be found by reading releases.json) @@ -1448,12 +1599,20 @@ jobs: echo "Publishing ${PRESTATE_MT64_HASH}, ${PRESTATE_MT64NEXT_HASH}, ${PRESTATE_INTEROP_HASH}, ${PRESTATE_INTEROP_NEXT_HASH} as ${BRANCH_NAME}" if [[ "" != "<< pipeline.git.branch >>" ]] then + echo "Publishing commit hash data" + INFO_FILE=$(mktemp) # Upload the git commit info for each prestate since this won't be recorded in releases.json - (echo "Commit=<< pipeline.git.revision >>" && echo "Prestate: ${PRESTATE_MT64_HASH}") | gsutil cp - "gs://oplabs-network-data/proofs/op-program/cannon/${BRANCH_NAME}-mt64.bin.gz.txt" - (echo "Commit=<< pipeline.git.revision >>" && echo "Prestate: ${PRESTATE_MT64NEXT_HASH}") | gsutil cp - "gs://oplabs-network-data/proofs/op-program/cannon/${BRANCH_NAME}-mt64Next.bin.gz.txt" - (echo "Commit=<< pipeline.git.revision >>" && echo "Prestate: ${PRESTATE_INTEROP_HASH}") | gsutil cp - "gs://oplabs-network-data/proofs/op-program/cannon/${BRANCH_NAME}-interop.bin.gz.txt" - (echo "Commit=<< pipeline.git.revision >>" && echo "Prestate: ${PRESTATE_INTEROP_NEXT_HASH}") | gsutil cp - "gs://oplabs-network-data/proofs/op-program/cannon/${BRANCH_NAME}-interopNext.bin.gz.txt" - + (echo "Commit=<< pipeline.git.revision >>" && echo "Prestate: ${PRESTATE_MT64_HASH}") > "${INFO_FILE}" + gsutil cp "${INFO_FILE}" "gs://oplabs-network-data/proofs/op-program/cannon/${BRANCH_NAME}-mt64.bin.gz.txt" + echo "Published commit hash data successfully" # So we know if any uploads worked + (echo "Commit=<< pipeline.git.revision >>" && echo "Prestate: ${PRESTATE_MT64NEXT_HASH}") > "${INFO_FILE}" + gsutil cp "${INFO_FILE}" "gs://oplabs-network-data/proofs/op-program/cannon/${BRANCH_NAME}-mt64Next.bin.gz.txt" + (echo "Commit=<< pipeline.git.revision >>" && echo "Prestate: ${PRESTATE_INTEROP_HASH}") > "${INFO_FILE}" + gsutil cp "${INFO_FILE}" "gs://oplabs-network-data/proofs/op-program/cannon/${BRANCH_NAME}-interop.bin.gz.txt" + (echo "Commit=<< pipeline.git.revision >>" && echo "Prestate: ${PRESTATE_INTEROP_NEXT_HASH}") > "${INFO_FILE}" + gsutil cp "${INFO_FILE}" "gs://oplabs-network-data/proofs/op-program/cannon/${BRANCH_NAME}-interopNext.bin.gz.txt" + rm "${INFO_FILE}" # keep things tidy + echo "All commit info published" # Use the branch name for branches to provide a consistent URL PRESTATE_MT64_HASH="${BRANCH_NAME}-mt64" @@ -1691,7 +1850,6 @@ jobs: command: | goreleaser release --clean -f ./<>/<> - diff-fetcher-forge-artifacts: docker: - image: <> @@ -1717,20 +1875,19 @@ jobs: echo "✅ Checked-in forge artifacts match the ci build" - stale-check: - machine: - image: ubuntu-2204:2024.08.1 - steps: - - utils/github-stale: - stale-issue-message: 'This issue has been automatically marked as stale and will be closed in 5 days if no updates' - stale-pr-message: 'This pr has been automatically marked as stale and will be closed in 5 days if no updates' - close-issue-message: 'This issue was closed as stale. Please reopen if this is a mistake' - close-pr-message: 'This PR was closed as stale. Please reopen if this is a mistake' - days-before-issue-stale: 999 - days-before-pr-stale: 14 - days-before-issue-close: 5 - days-before-pr-close: 5 + machine: + image: ubuntu-2204:2024.08.1 + steps: + - utils/github-stale: + stale-issue-message: "This issue has been automatically marked as stale and will be closed in 5 days if no updates" + stale-pr-message: "This pr has been automatically marked as stale and will be closed in 5 days if no updates" + close-issue-message: "This issue was closed as stale. Please reopen if this is a mistake" + close-pr-message: "This PR was closed as stale. Please reopen if this is a mistake" + days-before-issue-stale: 999 + days-before-pr-stale: 14 + days-before-issue-close: 5 + days-before-pr-close: 5 close-issue: machine: @@ -1780,7 +1937,6 @@ jobs: # Upload to the date-partitioned folder structure gsutil cp .metrics--authorship--op-acceptance-tests gs://oplabs-tools-data-public-metrics/metrics-authorship/$FOLDER_NAME/metrics-$CIRCLE_SHA1.csv - generate-flaky-report: machine: true resource_class: medium @@ -1808,16 +1964,18 @@ jobs: path: ./op-acceptance-tests/reports destination: flaky-test-reports - workflows: main: when: or: - - equal: ["webhook",<< pipeline.trigger_source >>] + - equal: ["webhook", << pipeline.trigger_source >>] - and: - - equal: [true, <>] - - equal: ["api",<< pipeline.trigger_source >>] - - equal: [<< pipeline.parameters.github-event-type >>, "__not_set__"] #this is to prevent triggering this workflow as the default value is always set for main_dispatch + - equal: [true, <>] + - equal: ["api", << pipeline.trigger_source >>] + - equal: [ + << pipeline.parameters.github-event-type >>, + "__not_set__", + ] #this is to prevent triggering this workflow as the default value is always set for main_dispatch jobs: - initialize: context: @@ -1843,6 +2001,7 @@ workflows: - circleci-repo-readonly-authenticated-github-token requires: - initialize + check_changed_patterns: contracts-bedrock,op-node - contracts-bedrock-tests: # PreimageOracle test is slow, run it separately to unblock CI. name: contracts-bedrock-tests-preimage-oracle @@ -1863,46 +2022,26 @@ workflows: - initialize - contracts-bedrock-coverage: # Generate coverage reports. - name: contracts-bedrock-coverage + name: contracts-bedrock-coverage <> test_timeout: 1h test_profile: cicoverage + dev_features: <> + matrix: + parameters: + dev_features: ["main", "OPTIMISM_PORTAL_INTEROP"] # need this requires to ensure that all FFI JSONs exist requires: - contracts-bedrock-build context: - circleci-repo-readonly-authenticated-github-token - contracts-bedrock-tests-upgrade: - name: contracts-bedrock-tests-upgrade - fork_op_chain: op - fork_base_chain: mainnet - fork_base_rpc: https://ci-mainnet-l1-archive.optimism.io - context: - - circleci-repo-readonly-authenticated-github-token - requires: - - initialize - - contracts-bedrock-tests-upgrade: - name: contracts-bedrock-tests-upgrade base-mainnet - fork_op_chain: base - fork_base_chain: mainnet - fork_base_rpc: https://ci-mainnet-l1-archive.optimism.io - context: - - circleci-repo-readonly-authenticated-github-token - requires: - - initialize - - contracts-bedrock-tests-upgrade: - name: contracts-bedrock-tests-upgrade ink-mainnet - fork_op_chain: ink - fork_base_chain: mainnet - fork_base_rpc: https://ci-mainnet-l1-archive.optimism.io - context: - - circleci-repo-readonly-authenticated-github-token - requires: - - initialize - - contracts-bedrock-tests-upgrade: - name: contracts-bedrock-tests-upgrade unichain-mainnet - fork_op_chain: unichain + name: contracts-bedrock-tests-upgrade <>-mainnet + fork_op_chain: <> fork_base_chain: mainnet fork_base_rpc: https://ci-mainnet-l1-archive.optimism.io + matrix: + parameters: + fork_op_chain: ["op", "base", "ink", "unichain"] context: - circleci-repo-readonly-authenticated-github-token requires: @@ -1912,11 +2051,6 @@ workflows: - contracts-bedrock-build context: - circleci-repo-readonly-authenticated-github-token - - contracts-bedrock-frozen-code: - requires: - - contracts-bedrock-build - context: - - circleci-repo-readonly-authenticated-github-token - diff-fetcher-forge-artifacts: context: - circleci-repo-readonly-authenticated-github-token @@ -1931,11 +2065,13 @@ workflows: name: semgrep-scan-local scan_command: semgrep scan --timeout=100 --config .semgrep/rules/ --error . context: + - slack - circleci-repo-readonly-authenticated-github-token - semgrep-scan: name: semgrep-test scan_command: semgrep scan --test --config .semgrep/rules/ .semgrep/tests/ context: + - slack - circleci-repo-readonly-authenticated-github-token - go-lint: context: @@ -1985,16 +2121,16 @@ workflows: - circleci-repo-readonly-authenticated-github-token filters: branches: - ignore: develop # Run on all branches EXCEPT develop (PR branches only) + ignore: develop # Run on all branches EXCEPT develop (PR branches only) - go-tests: name: go-tests-full - rule: "go-tests-ci" # Run full test suite instead of short - no_output_timeout: 89m # Longer timeout for full tests + rule: "go-tests-ci" # Run full test suite instead of short + no_output_timeout: 89m # Longer timeout for full tests test_timeout: 90m notify: true filters: branches: - only: develop # Only runs on develop branch (post-merge) + only: develop # Only runs on develop branch (post-merge) requires: - contracts-bedrock-build - cannon-prestate-quick @@ -2181,6 +2317,11 @@ workflows: - hold context: - circleci-repo-readonly-authenticated-github-token + filters: + tags: + only: /^(da-server|cannon|ufm-[a-z0-9\-]*|op-[a-z0-9\-]*)\/v.*/ + branches: + ignore: /.*/ # Standard (medium) cross-platform docker images go here - docker-build: matrix: @@ -2290,11 +2431,15 @@ workflows: when: or: - and: - - equal: ["develop", <>] - - equal: ["webhook",<< pipeline.trigger_source >>] + - equal: ["develop", <>] + - equal: ["webhook", << pipeline.trigger_source >>] - and: - - equal: [true, <>] - - equal: ["api",<< pipeline.trigger_source >>] + - equal: + [ + true, + <>, + ] + - equal: ["api", << pipeline.trigger_source >>] jobs: - publish-contract-artifacts: context: @@ -2304,11 +2449,11 @@ workflows: when: or: - and: - - equal: ["develop", <>] - - equal: ["webhook",<< pipeline.trigger_source >>] + - equal: ["develop", <>] + - equal: ["webhook", << pipeline.trigger_source >>] - and: - - equal: [true, <>] - - equal: ["api",<< pipeline.trigger_source >>] + - equal: [true, <>] + - equal: ["api", << pipeline.trigger_source >>] jobs: - initialize: context: @@ -2334,7 +2479,7 @@ workflows: notify: true mentions: "@proofs-team" no_output_timeout: 90m - test_timeout: 240m + test_timeout: 480m resource_class: ethereum-optimism/latitude-fps-1 context: - slack @@ -2355,11 +2500,11 @@ workflows: when: or: - and: - - equal: ["develop", <>] - - equal: ["webhook",<< pipeline.trigger_source >>] + - equal: ["develop", <>] + - equal: ["webhook", << pipeline.trigger_source >>] - and: - - equal: [true, <>] - - equal: ["api",<< pipeline.trigger_source >>] + - equal: [true, <>] + - equal: ["api", << pipeline.trigger_source >>] jobs: - kontrol-tests: context: @@ -2474,38 +2619,137 @@ workflows: - stale-check: context: - circleci-repo-optimism + scheduled-sync-test-op-node: + when: + or: + - equal: [build_daily, <>] + # Trigger on manual triggers if explicitly requested + - equal: [true, << pipeline.parameters.sync_test_op_node_dispatch >>] + jobs: + - initialize: + context: + - circleci-repo-readonly-authenticated-github-token + - contracts-bedrock-build: # needed for sysgo tests + context: + - circleci-repo-readonly-authenticated-github-token + requires: + - initialize + - cannon-prestate-quick: # needed for sysgo tests + context: + - circleci-repo-readonly-authenticated-github-token + requires: + - initialize + # Sync tests for multiple networks (runs in parallel) + # OP Sepolia + - op-acceptance-sync-tests-docker: + name: sync-test-op-sepolia-daily + gate: sync-test-op-node + no_output_timeout: 30m + l2_network_name: "op-sepolia" + l1_chain_id: "11155111" + l2_el_endpoint: "https://ci-sepolia-l2.optimism.io" + l1_cl_beacon_endpoint: "https://ci-sepolia-beacon.optimism.io" + l1_el_endpoint: "https://ci-sepolia-l1.optimism.io" + context: + - circleci-repo-readonly-authenticated-github-token + - discord + requires: + - contracts-bedrock-build + - cannon-prestate-quick + # Base Sepolia + - op-acceptance-sync-tests-docker: + name: sync-test-base-sepolia-daily + gate: sync-test-op-node + no_output_timeout: 30m + l2_network_name: "base-sepolia" + l1_chain_id: "11155111" + l2_el_endpoint: "https://base-sepolia-rpc.optimism.io" + l1_cl_beacon_endpoint: "https://ci-sepolia-beacon.optimism.io" + l1_el_endpoint: "https://ci-sepolia-l1.optimism.io" + context: + - circleci-repo-readonly-authenticated-github-token + - discord + requires: + - contracts-bedrock-build + - cannon-prestate-quick + ## Unichain Sepolia + - op-acceptance-sync-tests-docker: + name: sync-test-unichain-sepolia-daily + gate: sync-test-op-node + no_output_timeout: 30m + l2_network_name: "unichain-sepolia" + l1_chain_id: "11155111" + l2_el_endpoint: "https://unichain-sepolia-rpc.optimism.io" + l1_cl_beacon_endpoint: "https://ci-sepolia-beacon.optimism.io" + l1_el_endpoint: "https://ci-sepolia-l1.optimism.io" + context: + - circleci-repo-readonly-authenticated-github-token + - discord + requires: + - contracts-bedrock-build + - cannon-prestate-quick + ## OP Mainnet + - op-acceptance-sync-tests-docker: + name: sync-test-op-mainnet-daily + gate: sync-test-op-node + no_output_timeout: 30m + l2_network_name: "op-mainnet" + l1_chain_id: "1" + l2_el_endpoint: "https://op-mainnet-rpc.optimism.io" + l1_cl_beacon_endpoint: "https://ci-mainnet-beacon.optimism.io" + l1_el_endpoint: "https://ci-mainnet-l1.optimism.io" + context: + - circleci-repo-readonly-authenticated-github-token + - discord + requires: + - contracts-bedrock-build + - cannon-prestate-quick + ## Base Mainnet + - op-acceptance-sync-tests-docker: + name: sync-test-base-mainnet-daily + gate: sync-test-op-node + no_output_timeout: 30m + l2_network_name: "base-mainnet" + l1_chain_id: "1" + l2_el_endpoint: "https://base-mainnet-rpc.optimism.io" + l1_cl_beacon_endpoint: "https://ci-mainnet-beacon.optimism.io" + l1_el_endpoint: "https://ci-mainnet-l1.optimism.io" + context: + - circleci-repo-readonly-authenticated-github-token + - discord + requires: + - contracts-bedrock-build + - cannon-prestate-quick # Acceptance tests (post-merge to develop) acceptance-tests: when: or: - and: - - equal: ["develop", <>] - - equal: ["webhook",<< pipeline.trigger_source >>] + - equal: ["develop", <>] + - equal: ["webhook", << pipeline.trigger_source >>] - and: - - equal: [true, <>] - - equal: ["api",<< pipeline.trigger_source >>] + - equal: [true, <>] + - equal: ["api", << pipeline.trigger_source >>] jobs: - initialize: context: - circleci-repo-readonly-authenticated-github-token - - contracts-bedrock-build: # needed for sysgo tests + - contracts-bedrock-build: # needed for sysgo tests context: - circleci-repo-readonly-authenticated-github-token requires: - initialize - - cannon-prestate-quick: # needed for sysgo tests + - cannon-prestate-quick: # needed for sysgo tests context: - circleci-repo-readonly-authenticated-github-token requires: - initialize - # IN-PROCESS (base) + # IN-MEMORY (all) - op-acceptance-tests: - # Acceptance Testing params - name: memory-base - gate: base - # CircleCI params - no_output_timeout: 10m + name: memory-all + gate: "" # Empty gate = gateless mode + no_output_timeout: 90m context: - circleci-repo-readonly-authenticated-github-token - discord @@ -2518,6 +2762,7 @@ workflows: name: kurtosis-simple devnet: simple gate: base + use_circleci_runner: true # CircleCI params no_output_timeout: 30m context: @@ -2531,6 +2776,7 @@ workflows: name: kurtosis-isthmus devnet: isthmus gate: isthmus + use_circleci_runner: true # CircleCI params no_output_timeout: 30m context: @@ -2544,6 +2790,7 @@ workflows: name: kurtosis-interop devnet: interop gate: interop + use_circleci_runner: true # CircleCI params no_output_timeout: 30m context: @@ -2567,23 +2814,21 @@ workflows: - initialize: context: - circleci-repo-readonly-authenticated-github-token - - contracts-bedrock-build: # needed for sysgo tests + - contracts-bedrock-build: # needed for sysgo tests context: - circleci-repo-readonly-authenticated-github-token requires: - initialize - - cannon-prestate-quick: # needed for sysgo tests + - cannon-prestate-quick: # needed for sysgo tests context: - circleci-repo-readonly-authenticated-github-token requires: - initialize - # IN-PROCESS (base) + # IN-MEMORY (all) - op-acceptance-tests: - # Acceptance Testing params - name: memory-base - gate: base - # CircleCI params - no_output_timeout: 10m + name: memory-all + gate: "" # Empty gate = gateless mode + no_output_timeout: 90m context: - circleci-repo-readonly-authenticated-github-token - discord @@ -2596,6 +2841,7 @@ workflows: name: kurtosis-simple devnet: simple gate: base + use_circleci_runner: true # CircleCI params no_output_timeout: 30m context: @@ -2609,6 +2855,7 @@ workflows: name: kurtosis-isthmus devnet: isthmus gate: isthmus + use_circleci_runner: true # CircleCI params no_output_timeout: 30m context: @@ -2622,6 +2869,7 @@ workflows: name: kurtosis-interop devnet: interop gate: interop + use_circleci_runner: true # CircleCI params no_output_timeout: 30m context: @@ -2644,21 +2892,21 @@ workflows: - equal: [<< pipeline.parameters.github-event-action >>, "labeled"] jobs: - close-issue: - label_name: "auto-close-trivial-contribution" - message: "Thank you for your interest in contributing! - At this time, we are not accepting contributions that primarily fix spelling, stylistic, or grammatical errors in documentation, code, or elsewhere. - Please check our [contribution guidelines](https://github.com/ethereum-optimism/optimism/blob/develop/CONTRIBUTING.md#contributions-related-to-spelling-and-grammar) for more information. - This issue will be closed now." - context: - - circleci-repo-optimism + label_name: "auto-close-trivial-contribution" + message: "Thank you for your interest in contributing! + At this time, we are not accepting contributions that primarily fix spelling, stylistic, or grammatical errors in documentation, code, or elsewhere. + Please check our [contribution guidelines](https://github.com/ethereum-optimism/optimism/blob/develop/CONTRIBUTING.md#contributions-related-to-spelling-and-grammar) for more information. + This issue will be closed now." + context: + - circleci-repo-optimism devnet-metrics-collect: when: or: - equal: [<< pipeline.trigger_source >>, "webhook"] - and: - - equal: [true, << pipeline.parameters.devnet-metrics-collect >>] - - equal: [<< pipeline.trigger_source >>, "api"] + - equal: [true, << pipeline.parameters.devnet-metrics-collect >>] + - equal: [<< pipeline.trigger_source >>, "api"] jobs: - devnet-metrics-collect-authorship: context: diff --git a/.gitignore b/.gitignore index ea86d7c6834..bf22c3755f5 100644 --- a/.gitignore +++ b/.gitignore @@ -22,7 +22,6 @@ cache !op-deployer/pkg/deployer/artifacts - packages/contracts-bedrock/deployments/anvil # vim @@ -45,8 +44,10 @@ packages/contracts-bedrock/deployments/anvil coverage.out - __pycache__ # Ignore echidna artifacts crytic-export + +# ignore local asdf config +.tool-versions diff --git a/.golangci.yaml b/.golangci.yaml index d9b226bcd0b..9f4ca6b435a 100644 --- a/.golangci.yaml +++ b/.golangci.yaml @@ -6,7 +6,6 @@ linters: - asciicheck - misspell - errorlint - - bodyclose # Only enabled in specific cases. See settings and exclusions below - exhaustruct diff --git a/.semgrep/rules/sol-rules.yaml b/.semgrep/rules/sol-rules.yaml index bea5f9b6b4e..7d67a965f9d 100644 --- a/.semgrep/rules/sol-rules.yaml +++ b/.semgrep/rules/sol-rules.yaml @@ -319,6 +319,7 @@ rules: exclude: - packages/contracts-bedrock/src/L1/OPContractsManager.sol - packages/contracts-bedrock/src/L1/OptimismPortal2.sol + - packages/contracts-bedrock/src/L1/OptimismPortalInterop.sol - packages/contracts-bedrock/src/L2/FeeVault.sol - packages/contracts-bedrock/src/L2/OptimismMintableERC721.sol - packages/contracts-bedrock/src/L2/OptimismMintableERC721Factory.sol @@ -327,7 +328,9 @@ rules: - packages/contracts-bedrock/src/dispute/AnchorStateRegistry.sol - packages/contracts-bedrock/src/dispute/DelayedWETH.sol - packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol + - packages/contracts-bedrock/src/dispute/v2/FaultDisputeGameV2.sol - packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol + - packages/contracts-bedrock/src/dispute/v2/PermissionedDisputeGameV2.sol - packages/contracts-bedrock/src/dispute/SuperFaultDisputeGame.sol - packages/contracts-bedrock/src/dispute/SuperPermissionedDisputeGame.sol - packages/contracts-bedrock/src/governance/MintManager.sol @@ -362,3 +365,20 @@ rules: paths: exclude: - packages/contracts-bedrock/scripts/libraries/Config.sol + + - id: sol-style-event-param-fmt + languages: [solidity] + severity: ERROR + message: Event parameters must be named using camelCase and must not be prefixed with underscore + pattern-either: + # Match parameters with underscore prefix + - pattern-regex: event\s+\w+\s*\([^)]*\b(?:address|uint\d*|int\d*|bytes\d*|bool|string)\s+(?:indexed\s+)?_\w+ + # Match unnamed parameters (type with optional indexed but no parameter name before comma or closing paren) + - pattern-regex: event\s+\w+\s*\([^)]*\b(?:address|uint\d*|int\d*|bytes\d*|bool|string)\b(?:\s+indexed)?\s*[,)] + # Match parameters that are all uppercase (like NEW_OWNER) + - pattern-regex: event\s+\w+\s*\([^)]*\b(?:address|uint\d*|int\d*|bytes\d*|bool|string)\s+(?:indexed\s+)?[A-Z][A-Z0-9_]*\s*[,)] + paths: + exclude: + # LegacyMintableERC20 and the corresponding interface use legacy naming conventions. + - packages/contracts-bedrock/src/legacy/LegacyMintableERC20.sol + - packages/contracts-bedrock/interfaces/legacy/ILegacyMintableERC20Full.sol diff --git a/.semgrep/tests/sol-rules.t.sol b/.semgrep/tests/sol-rules.t.sol index e98175d62a4..9d0179318c9 100644 --- a/.semgrep/tests/sol-rules.t.sol +++ b/.semgrep/tests/sol-rules.t.sol @@ -712,3 +712,23 @@ contract SemgrepTest__sol_safety_try_catch_eip_150 { } } } + +contract SemgrepTest__sol_style_event_param_fmt { + // ok: sol-style-event-param-fmt + event OwnerChanged(address previousOwner, address newOwner); + + // ruleid: sol-style-event-param-fmt + event OwnerChanged(address _previousOwner, address _newOwner); + + // ruleid: sol-style-event-param-fmt + event OwnerChanged(address); + + // ruleid: sol-style-event-param-fmt + event OwnerChanged(address NEW_OWNER); + + // ok: sol-style-event-param-fmt + event SomethingWithMint(uint256 mint); + + // ruleid: sol-style-event-param-fmt + event SomethingWithMint(uint256 _mint); +} diff --git a/Makefile b/Makefile index d228d9f92fe..83f5c178874 100644 --- a/Makefile +++ b/Makefile @@ -206,7 +206,6 @@ TEST_PKGS := \ ./packages/contracts-bedrock/scripts/checks/... \ ./op-dripper/... \ ./devnet-sdk/... \ - ./op-acceptance-tests/... \ ./kurtosis-devnet/... \ ./op-devstack/... \ ./op-deployer/pkg/deployer/artifacts/... \ @@ -265,7 +264,7 @@ go-tests-short: $(TEST_DEPS) ## Runs comprehensive Go tests with -short flag go-tests-short-ci: ## Runs short Go tests with gotestsum for CI (assumes deps built by CI) @echo "Setting up test directories..." mkdir -p ./tmp/test-results ./tmp/testlogs - @echo "Running Go tests with gotestsum..." + @echo 'Running Go tests (short) with gotestsum...' $(DEFAULT_TEST_ENV_VARS) && \ $(CI_ENV_VARS) && \ gotestsum --format=testname \ diff --git a/README.md b/README.md index e89b1078562..ea9818766bc 100644 --- a/README.md +++ b/README.md @@ -63,22 +63,38 @@ The Optimism Immunefi program offers up to $2,000,042 for in-scope critical vuln ## Directory Structure 
+├── cannon: Onchain MIPS instruction emulator for fault proofs
+├── devnet-sdk: Comprehensive toolkit for standardized devnet interactions
 ├── docs: A collection of documents including audits and post-mortems
 ├── kurtosis-devnet: OP-Stack Kurtosis devnet
+├── op-acceptance-tests: Acceptance tests and configuration for OP Stack
+├── op-alt-da: Alternative Data Availability mode (beta)
 ├── op-batcher: L2-Batch Submitter, submits bundles of batches to L1
 ├── op-chain-ops: State surgery utilities
 ├── op-challenger: Dispute game challenge agent
+├── op-conductor: High-availability sequencer service
+├── op-deployer: CLI tool for deploying and upgrading OP Stack smart contracts
+├── op-devstack: Flexible test frontend for integration and acceptance testing
+├── op-dispute-mon: Off-chain service to monitor dispute games
+├── op-dripper: Controlled token distribution service
 ├── op-e2e: End-to-End testing of all bedrock components in Go
-├── op-node: rollup consensus-layer client
+├── op-faucet: Dev-faucet with support for multiple chains
+├── op-fetcher: Data fetching utilities
+├── op-interop-mon: Interoperability monitoring service
+├── op-node: Rollup consensus-layer client
 ├── op-preimage: Go bindings for Preimage Oracle
 ├── op-program: Fault proof program
 ├── op-proposer: L2-Output Submitter, submits proposals to L1
 ├── op-service: Common codebase utilities
+├── op-supervisor: Service to monitor chains and determine cross-chain message safety
+├── op-sync-tester: Sync testing utilities
+├── op-test-sequencer: Test sequencer for development
+├── op-up: Deployment and management utilities
+├── op-validator: Tool for validating Optimism chain configurations and deployments
 ├── op-wheel: Database utilities
 ├── ops: Various operational packages
 ├── packages
 │   ├── contracts-bedrock: OP Stack smart contracts
-├── semgrep: Semgrep rules and tests
## Development and Release Process diff --git a/cannon/cmd/run.go b/cannon/cmd/run.go index 0cad2107b17..bd35f22f6e2 100644 --- a/cannon/cmd/run.go +++ b/cannon/cmd/run.go @@ -99,7 +99,7 @@ var ( RunInfoAtFlag = &cli.GenericFlag{ Name: "info-at", Usage: "step pattern to print info at: " + patternHelp, - Value: MustStepMatcherFlag("%100000"), + Value: MustStepMatcherFlag("%1000000000"), Required: false, } RunPProfCPU = &cli.BoolFlag{ @@ -395,7 +395,7 @@ func Run(ctx *cli.Context) error { } } - state, err := versions.LoadStateFromFile(ctx.Path(RunInputFlag.Name)) + state, err := versions.LoadStateFromFileWithLargeICache(ctx.Path(RunInputFlag.Name)) if err != nil { return fmt.Errorf("failed to load state: %w", err) } diff --git a/cannon/mipsevm/arch/arch64.go b/cannon/mipsevm/arch/arch64.go index 7169fc474e7..58f84c69275 100644 --- a/cannon/mipsevm/arch/arch64.go +++ b/cannon/mipsevm/arch/arch64.go @@ -15,11 +15,12 @@ const ( ExtMask = 0x7 // Ensure virtual address is limited to 48-bits as many user programs assume such to implement packed pointers - // limit 0x00_00_FF_FF_FF_FF_FF_FF - HeapStart = 0x00_00_10_00_00_00_00_00 - HeapEnd = 0x00_00_60_00_00_00_00_00 - ProgramBreak = 0x00_00_40_00_00_00_00_00 - HighMemoryStart = 0x00_00_7F_FF_FF_FF_F0_00 + Limit = 0x00_00_FF_FF_FF_FF_FF_FF + ProgramHeapStart = 0x00_00_00_c0_00_00_00_00 + HeapStart = 0x00_00_10_00_00_00_00_00 + HeapEnd = 0x00_00_60_00_00_00_00_00 + ProgramBreak = 0x00_00_40_00_00_00_00_00 + HighMemoryStart = 0x00_00_7F_FF_FF_FF_F0_00 ) // MIPS64 syscall table - https://github.com/torvalds/linux/blob/3efc57369a0ce8f76bf0804f7e673982384e4ac9/arch/mips/kernel/syscalls/syscall_n64.tbl. Generate the syscall numbers using the Makefile in that directory. diff --git a/cannon/mipsevm/debug.go b/cannon/mipsevm/debug.go index 02c20ea2482..ffa6bfaaeb6 100644 --- a/cannon/mipsevm/debug.go +++ b/cannon/mipsevm/debug.go @@ -3,11 +3,13 @@ package mipsevm import "github.com/ethereum/go-ethereum/common/hexutil" type DebugInfo struct { - Pages int `json:"pages"` - MemoryUsed hexutil.Uint64 `json:"memory_used"` - NumPreimageRequests int `json:"num_preimage_requests"` - TotalPreimageSize int `json:"total_preimage_size"` - TotalSteps uint64 `json:"total_steps"` + Pages int `json:"pages"` + MemoryUsed hexutil.Uint64 `json:"memory_used"` + NumPreimageRequests int `json:"num_preimage_requests"` + TotalPreimageSize int `json:"total_preimage_size"` + TotalSteps uint64 `json:"total_steps"` + InstructionCacheMissCount uint64 `json:"instruction_cache_miss_count"` + HighestICacheMissPC hexutil.Uint64 `json:"highest_icache_miss_pc"` // Multithreading-related stats below RmwSuccessCount uint64 `json:"rmw_success_count"` RmwFailCount uint64 `json:"rmw_fail_count"` diff --git a/cannon/mipsevm/debug_test.go b/cannon/mipsevm/debug_test.go index e2b6b8e43ab..df567b202bd 100644 --- a/cannon/mipsevm/debug_test.go +++ b/cannon/mipsevm/debug_test.go @@ -18,6 +18,8 @@ func TestDebugInfo_Serialization(t *testing.T) { NumPreimageRequests: 3, TotalPreimageSize: 4, TotalSteps: 123456, + InstructionCacheMissCount: 10, + HighestICacheMissPC: 11, RmwSuccessCount: 5, RmwFailCount: 6, MaxStepsBetweenLLAndSC: 7, diff --git a/cannon/mipsevm/exec/mips_instructions.go b/cannon/mipsevm/exec/mips_instructions.go index 8f0d42e0985..7fc4954b827 100644 --- a/cannon/mipsevm/exec/mips_instructions.go +++ b/cannon/mipsevm/exec/mips_instructions.go @@ -38,7 +38,7 @@ func GetInstructionDetails(pc Word, memory *memory.Memory) (insn, opcode, fun ui // ExecMipsCoreStepLogic executes a MIPS instruction that isn't a syscall nor a RMW operation // If a store operation occurred, then it returns the effective address of the store memory location. -func ExecMipsCoreStepLogic(cpu *mipsevm.CpuScalars, registers *[32]Word, memory *memory.Memory, insn, opcode, fun uint32, memTracker MemTracker, stackTracker StackTracker, features mipsevm.FeatureToggles) (memUpdated bool, effMemAddr Word, err error) { +func ExecMipsCoreStepLogic(cpu *mipsevm.CpuScalars, registers *[32]Word, memory *memory.Memory, insn, opcode, fun uint32, memTracker MemTracker, stackTracker StackTracker) (memUpdated bool, effMemAddr Word, err error) { // j-type j/jal if opcode == 2 || opcode == 3 { linkReg := Word(0) @@ -117,7 +117,7 @@ func ExecMipsCoreStepLogic(cpu *mipsevm.CpuScalars, registers *[32]Word, memory } // ALU - val := ExecuteMipsInstruction(insn, opcode, fun, rs, rt, mem, features) + val := ExecuteMipsInstruction(insn, opcode, fun, rs, rt, mem) funSel := uint32(0x1c) if !arch.IsMips32 { @@ -182,7 +182,7 @@ func assertMips64Fun(fun uint32) { } } -func ExecuteMipsInstruction(insn uint32, opcode uint32, fun uint32, rs, rt, mem Word, features mipsevm.FeatureToggles) Word { +func ExecuteMipsInstruction(insn uint32, opcode uint32, fun uint32, rs, rt, mem Word) Word { if opcode == 0 || (opcode >= 8 && opcode < 0xF) || (!arch.IsMips32 && (opcode == 0x18 || opcode == 0x19)) { // transform ArithLogI to SPECIAL switch opcode { @@ -350,7 +350,7 @@ func ExecuteMipsInstruction(insn uint32, opcode uint32, fun uint32, rs, rt, mem rs <<= 1 } return Word(i) - case features.SupportDclzDclo && (fun == 0x24 || fun == 0x25): // dclz, dclo + case fun == 0x24 || fun == 0x25: // dclz, dclo assertMips64Fun(insn) if fun == 0x24 { rs = ^rs diff --git a/cannon/mipsevm/iface.go b/cannon/mipsevm/iface.go index 3fe37527053..f12197a6176 100644 --- a/cannon/mipsevm/iface.go +++ b/cannon/mipsevm/iface.go @@ -74,9 +74,6 @@ type Metadata interface { // Toggles here are temporary and should be removed once the newer state version is deployed widely. The older // version can then be supported via multicannon pulling in a specific build and support for it dropped in latest code. type FeatureToggles struct { - SupportMinimalSysEventFd2 bool - SupportDclzDclo bool - SupportNoopMprotect bool SupportWorkingSysGetRandom bool } diff --git a/cannon/mipsevm/memory/binary_tree.go b/cannon/mipsevm/memory/binary_tree.go index 4b5b0a2cc83..801c14a35cf 100644 --- a/cannon/mipsevm/memory/binary_tree.go +++ b/cannon/mipsevm/memory/binary_tree.go @@ -1,7 +1,15 @@ package memory import ( + "fmt" "math/bits" + + "github.com/ethereum-optimism/optimism/cannon/mipsevm/arch" +) + +const ( + defaultCodeSize = 128 * 1024 * 1024 // 128 MiB + defaultHeapSize = 512 * 1024 * 1024 // 512 MiB ) // BinaryTreeIndex is a representation of the state of the memory in a binary merkle tree. @@ -12,13 +20,39 @@ type BinaryTreeIndex struct { pageTable map[Word]*CachedPage } -func NewBinaryTreeMemory() *Memory { - pages := make(map[Word]*CachedPage) +func NewBinaryTreeMemory(codeSize, heapSize arch.Word) *Memory { + pages := make(map[arch.Word]*CachedPage) index := NewBinaryTreeIndex(pages) + + if codeSize == 0 { + codeSize = defaultCodeSize + } + if heapSize == 0 { + heapSize = defaultHeapSize + } + + // Defensive bounds: code region must not overlap heap start + if codeSize > arch.ProgramHeapStart { + panic(fmt.Sprintf("codeSize (0x%x) overlaps heap start (0x%x)", codeSize, arch.ProgramHeapStart)) + } + + indexedRegions := make([]MappedMemoryRegion, 2) + indexedRegions[0] = MappedMemoryRegion{ + startAddr: 0, + endAddr: codeSize, + Data: make([]byte, codeSize), + } + indexedRegions[1] = MappedMemoryRegion{ + startAddr: arch.ProgramHeapStart, + endAddr: arch.ProgramHeapStart + heapSize, + Data: make([]byte, heapSize), + } + return &Memory{ - merkleIndex: index, - pageTable: pages, - lastPageKeys: [2]Word{^Word(0), ^Word(0)}, // default to invalid keys, to not match any pages + merkleIndex: index, + pageTable: pages, + lastPageKeys: [2]arch.Word{^arch.Word(0), ^arch.Word(0)}, + MappedRegions: indexedRegions, } } diff --git a/cannon/mipsevm/memory/memory.go b/cannon/mipsevm/memory/memory.go index fe29db30acb..e508d794ebb 100644 --- a/cannon/mipsevm/memory/memory.go +++ b/cannon/mipsevm/memory/memory.go @@ -27,6 +27,20 @@ const ( type Word = arch.Word +type MappedMemoryRegion struct { + startAddr Word + endAddr Word + Data []byte +} + +func (m *MappedMemoryRegion) AddrInRegion(addr Word) bool { + return addr >= m.startAddr && addr < m.endAddr +} + +func (m *MappedMemoryRegion) PageIndexInRegion(pageIndex Word) bool { + return pageIndex >= m.startAddr>>PageAddrSize && pageIndex < m.endAddr>>PageAddrSize +} + type Memory struct { merkleIndex PageIndex // Note: since we don't de-alloc Pages, we don't do ref-counting. @@ -38,6 +52,8 @@ type Memory struct { // this prevents map lookups each instruction lastPageKeys [2]Word lastPage [2]*CachedPage + + MappedRegions []MappedMemoryRegion } type PageIndex interface { @@ -50,8 +66,51 @@ type PageIndex interface { New(pages map[Word]*CachedPage) PageIndex } +func NewMemoryWithLargeRegions() *Memory { + return NewBinaryTreeMemory(defaultCodeSize, defaultHeapSize) +} + func NewMemory() *Memory { - return NewBinaryTreeMemory() + return NewBinaryTreeMemory(4096, 4096) +} + +// start end size gap +func (m *Memory) GetAllocatedRanges() [][4]Word { + var ranges [][4]Word + if len(m.pageTable) == 0 { + return ranges + } + + // Extract and sort page addresses + keys := make([]Word, 0, len(m.pageTable)) + for key := range m.pageTable { + keys = append(keys, key) + } + sort.Slice(keys, func(i, j int) bool { return keys[i] < keys[j] }) + + // Find contiguous ranges and gaps + start := keys[0] + prev := start + var lastEnd Word = start - 1 + + for i := 1; i < len(keys); i++ { + if keys[i] != prev+1 { + gap := start - lastEnd - 1 // Gap is calculated from end of prev range to start of new one + ranges = append(ranges, [4]Word{start, prev, prev - start + 1, gap}) + lastEnd = prev + start = keys[i] + } + prev = keys[i] + } + + // Append last range + gap := start - lastEnd - 1 + ranges = append(ranges, [4]Word{start, prev, prev - start + 1, gap}) + for i := 0; i < len(ranges); i++ { + ranges[i][0] <<= PageAddrSize + ranges[i][1] <<= PageAddrSize + } + return ranges } func (m *Memory) MerkleRoot() [32]byte { @@ -66,7 +125,7 @@ func (m *Memory) PageCount() int { return len(m.pageTable) } -func (m *Memory) ForEachPage(fn func(pageIndex Word, page *Page) error) error { +func (m *Memory) ForEachPage(fn func(pageIndex Word, page Page) error) error { for pageIndex, cachedPage := range m.pageTable { if err := fn(pageIndex, cachedPage.Data); err != nil { return err @@ -74,7 +133,6 @@ func (m *Memory) ForEachPage(fn func(pageIndex Word, page *Page) error) error { } return nil } - func (m *Memory) MerkleizeSubtree(gindex uint64) [32]byte { return m.merkleIndex.MerkleizeSubtree(gindex) } @@ -155,7 +213,15 @@ func (m *Memory) GetWord(addr Word) Word { if addr&arch.ExtMask != 0 { panic(fmt.Errorf("unaligned memory access: %x", addr)) } + for _, region := range m.MappedRegions { + if ok := region.AddrInRegion(addr); ok { + offset := addr - region.startAddr + return arch.ByteOrderWord.Word(region.Data[offset : offset+arch.WordSizeBytes : offset+arch.WordSizeBytes]) + } + } + pageIndex := addr >> PageAddrSize + p, ok := m.PageLookup(pageIndex) if !ok { return 0 @@ -165,7 +231,17 @@ func (m *Memory) GetWord(addr Word) Word { } func (m *Memory) AllocPage(pageIndex Word) *CachedPage { - p := &CachedPage{Data: new(Page)} + p := new(CachedPage) + for _, region := range m.MappedRegions { + if region.PageIndexInRegion(pageIndex) { + indexAdjusted := pageIndex - region.startAddr>>PageAddrSize + p.Data = region.Data[indexAdjusted*PageSize : (indexAdjusted+1)*PageSize : (indexAdjusted+1)*PageSize] + break + } + } + if p.Data == nil { + p.Data = make(Page, PageSize) + } m.pageTable[pageIndex] = p m.merkleIndex.AddPage(pageIndex) return p @@ -237,8 +313,9 @@ func (m *Memory) Copy() *Memory { } for k, page := range m.pageTable { - data := new(Page) - *data = *page.Data + data := make(Page, PageSize) + // *data = *page.Data + copy(data, page.Data) out.AllocPage(k).Data = data } return out @@ -287,20 +364,23 @@ func (m *Memory) Deserialize(in io.Reader) error { return err } } + return nil } type pageEntry struct { - Index Word `json:"index"` - Data *Page `json:"data"` + Index Word `json:"index"` + Data *[PageSize]byte `json:"data"` } func (m *Memory) MarshalJSON() ([]byte, error) { // nosemgrep pages := make([]pageEntry, 0, len(m.pageTable)) for k, p := range m.pageTable { + data := new([PageSize]byte) + copy(data[:], p.Data) pages = append(pages, pageEntry{ Index: k, - Data: p.Data, + Data: data, }) } sort.Slice(pages, func(i, j int) bool { @@ -318,7 +398,8 @@ func (m *Memory) UnmarshalJSON(data []byte) error { if _, ok := m.pageTable[p.Index]; ok { return fmt.Errorf("cannot load duplicate page, entry %d, page index %d", i, p.Index) } - m.AllocPage(p.Index).Data = p.Data + page := m.AllocPage(p.Index) + copy(page.Data, p.Data[:]) } return nil } diff --git a/cannon/mipsevm/memory/memory64_benchmark_test.go b/cannon/mipsevm/memory/memory64_benchmark_test.go index 784d13785a4..1754cffef55 100644 --- a/cannon/mipsevm/memory/memory64_benchmark_test.go +++ b/cannon/mipsevm/memory/memory64_benchmark_test.go @@ -9,9 +9,11 @@ import ( ) const ( - smallDataset = 12_500_000 - mediumDataset = 100_000_000 - largeDataset = 400_000_000 + smallDataset = 12_500_000 + mediumDataset = 100_000_000 + largeDataset = 400_000_000 + testDefaultCodeRegionSize = 4096 + testDefaultHeapSize = 4096 ) func BenchmarkMemoryOperations(b *testing.B) { @@ -36,7 +38,7 @@ func BenchmarkMemoryOperations(b *testing.B) { for _, bm := range benchmarks { b.Run("BinaryTree", func(b *testing.B) { b.Run(bm.name, func(b *testing.B) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) b.ResetTimer() bm.fn(b, m) }) diff --git a/cannon/mipsevm/memory/memory64_binary_tree_test.go b/cannon/mipsevm/memory/memory64_binary_tree_test.go index 90c83d92dbb..f382c5b63ad 100644 --- a/cannon/mipsevm/memory/memory64_binary_tree_test.go +++ b/cannon/mipsevm/memory/memory64_binary_tree_test.go @@ -17,7 +17,7 @@ import ( func TestMemory64BinaryTreeMerkleProof(t *testing.T) { t.Run("nearly empty tree", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(0x10000, 0xAABBCCDD_EEFF1122) proof := m.MerkleProof(0x10000) require.Equal(t, uint64(0xAABBCCDD_EEFF1122), binary.BigEndian.Uint64(proof[:8])) @@ -26,7 +26,7 @@ func TestMemory64BinaryTreeMerkleProof(t *testing.T) { } }) t.Run("fuller tree", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(0x10000, 0xaabbccdd) m.SetWord(0x80008, 42) m.SetWord(0x13370000, 123) @@ -50,38 +50,38 @@ func TestMemory64BinaryTreeMerkleProof(t *testing.T) { func TestMemory64BinaryTreeMerkleRoot(t *testing.T) { t.Run("empty", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) root := m.MerkleRoot() require.Equal(t, zeroHashes[64-5], root, "fully zeroed memory should have expected zero hash") }) t.Run("empty page", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(0xF000, 0) root := m.MerkleRoot() require.Equal(t, zeroHashes[64-5], root, "fully zeroed memory should have expected zero hash") }) t.Run("single page", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(0xF000, 1) root := m.MerkleRoot() require.NotEqual(t, zeroHashes[64-5], root, "non-zero memory") }) t.Run("repeat zero", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(0xF000, 0) m.SetWord(0xF008, 0) root := m.MerkleRoot() require.Equal(t, zeroHashes[64-5], root, "zero still") }) t.Run("two empty pages", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(PageSize*3, 0) m.SetWord(PageSize*10, 0) root := m.MerkleRoot() require.Equal(t, zeroHashes[64-5], root, "zero still") }) t.Run("random few pages", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(PageSize*3, 1) m.SetWord(PageSize*5, 42) m.SetWord(PageSize*6, 123) @@ -103,7 +103,7 @@ func TestMemory64BinaryTreeMerkleRoot(t *testing.T) { require.Equal(t, r1, r2, "expecting manual page combination to match subtree merkle func") }) t.Run("invalidate page", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(0xF000, 0) require.Equal(t, zeroHashes[64-5], m.MerkleRoot(), "zero at first") m.SetWord(0xF008, 1) @@ -115,7 +115,7 @@ func TestMemory64BinaryTreeMerkleRoot(t *testing.T) { func TestMemory64BinaryTreeReadWrite(t *testing.T) { t.Run("large random", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) data := make([]byte, 20_000) _, err := rand.Read(data[:]) require.NoError(t, err) @@ -128,7 +128,7 @@ func TestMemory64BinaryTreeReadWrite(t *testing.T) { }) t.Run("repeat range", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) data := []byte(strings.Repeat("under the big bright yellow sun ", 40)) require.NoError(t, m.SetMemoryRange(0x1337, bytes.NewReader(data))) res, err := io.ReadAll(m.ReadMemoryRange(0x1337-10, Word(len(data)+20))) @@ -139,7 +139,7 @@ func TestMemory64BinaryTreeReadWrite(t *testing.T) { }) t.Run("empty range", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) addr := Word(0xAABBCC00) r := bytes.NewReader(nil) pre := m.MerkleRoot() @@ -165,7 +165,7 @@ func TestMemory64BinaryTreeReadWrite(t *testing.T) { }) t.Run("range page overlap", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) data := bytes.Repeat([]byte{0xAA}, PageAddrSize) require.NoError(t, m.SetMemoryRange(0, bytes.NewReader(data))) for i := 0; i < PageAddrSize/arch.WordSizeBytes; i++ { @@ -183,7 +183,7 @@ func TestMemory64BinaryTreeReadWrite(t *testing.T) { }) t.Run("read-write", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(16, 0xAABBCCDD_EEFF1122) require.Equal(t, Word(0xAABBCCDD_EEFF1122), m.GetWord(16)) m.SetWord(16, 0xAABB1CDD_EEFF1122) @@ -193,7 +193,7 @@ func TestMemory64BinaryTreeReadWrite(t *testing.T) { }) t.Run("unaligned read", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(16, Word(0xAABBCCDD_EEFF1122)) m.SetWord(24, 0x11223344_55667788) for i := Word(17); i < 24; i++ { @@ -207,7 +207,7 @@ func TestMemory64BinaryTreeReadWrite(t *testing.T) { }) t.Run("unaligned write", func(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(16, 0xAABBCCDD_EEFF1122) require.Panics(t, func() { m.SetWord(17, 0x11223344) @@ -235,17 +235,17 @@ func TestMemory64BinaryTreeReadWrite(t *testing.T) { } func TestMemory64BinaryTreeJSON(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(8, 0xAABBCCDD_EEFF1122) dat, err := json.Marshal(m) require.NoError(t, err) - res := NewBinaryTreeMemory() + res := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) require.NoError(t, json.Unmarshal(dat, &res)) require.Equal(t, Word(0xAABBCCDD_EEFF1122), res.GetWord(8)) } func TestMemory64BinaryTreeCopy(t *testing.T) { - m := NewBinaryTreeMemory() + m := NewBinaryTreeMemory(testDefaultCodeRegionSize, testDefaultHeapSize) m.SetWord(0xAABBCCDD_8000, 0x000000_AABB) mcpy := m.Copy() require.Equal(t, Word(0xAABB), mcpy.GetWord(0xAABBCCDD_8000)) diff --git a/cannon/mipsevm/memory/page.go b/cannon/mipsevm/memory/page.go index d9e560dc64a..e44dd3c3a95 100644 --- a/cannon/mipsevm/memory/page.go +++ b/cannon/mipsevm/memory/page.go @@ -18,9 +18,9 @@ var zlibWriterPool = sync.Pool{ }, } -type Page [PageSize]byte +type Page []byte -func (p *Page) MarshalJSON() ([]byte, error) { // nosemgrep +func (p Page) MarshalJSON() ([]byte, error) { // nosemgrep var out bytes.Buffer w := zlibWriterPool.Get().(*zlib.Writer) defer zlibWriterPool.Put(w) @@ -34,7 +34,7 @@ func (p *Page) MarshalJSON() ([]byte, error) { // nosemgrep return json.Marshal(out.Bytes()) } -func (p *Page) UnmarshalJSON(dat []byte) error { +func (p Page) UnmarshalJSON(dat []byte) error { // Strip off the `"` characters at the start & end. dat = dat[1 : len(dat)-1] // Decode b64 then decompress @@ -52,7 +52,7 @@ func (p *Page) UnmarshalJSON(dat []byte) error { } } -func (p *Page) UnmarshalText(dat []byte) error { +func (p Page) UnmarshalText(dat []byte) error { if len(dat) != PageSize*2 { return fmt.Errorf("expected %d hex chars, but got %d", PageSize*2, len(dat)) } @@ -65,7 +65,7 @@ func (p *Page) UnmarshalText(dat []byte) error { var _ [0]struct{} = [PageSize - 4096]struct{}{} type CachedPage struct { - Data *Page + Data Page // intermediate nodes only Cache [PageSize / 32][32]byte // bit set to 1 if the intermediate node is valid diff --git a/cannon/mipsevm/memory/page_test.go b/cannon/mipsevm/memory/page_test.go index e7a8167a9df..6665579e013 100644 --- a/cannon/mipsevm/memory/page_test.go +++ b/cannon/mipsevm/memory/page_test.go @@ -8,7 +8,7 @@ import ( ) func TestCachedPage(t *testing.T) { - p := &CachedPage{Data: new(Page)} + p := &CachedPage{Data: make(Page, PageSize)} p.Data[42] = 0xab gindex := ((uint64(1) << PageAddrSize) | 42) >> 5 diff --git a/cannon/mipsevm/multithreaded/instrumented.go b/cannon/mipsevm/multithreaded/instrumented.go index 73138925569..a8ee4c0551e 100644 --- a/cannon/mipsevm/multithreaded/instrumented.go +++ b/cannon/mipsevm/multithreaded/instrumented.go @@ -11,6 +11,9 @@ import ( "github.com/ethereum-optimism/optimism/cannon/mipsevm/exec" ) +type InstructionDetails struct { + insn, opcode, fun uint32 +} type InstrumentedState struct { state *State @@ -24,12 +27,23 @@ type InstrumentedState struct { preimageOracle *exec.TrackingPreimageOracleReader meta mipsevm.Metadata - features mipsevm.FeatureToggles + + cached_decode []InstructionDetails + features mipsevm.FeatureToggles } var _ mipsevm.FPVM = (*InstrumentedState)(nil) func NewInstrumentedState(state *State, po mipsevm.PreimageOracle, stdOut, stdErr io.Writer, log log.Logger, meta mipsevm.Metadata, features mipsevm.FeatureToggles) *InstrumentedState { + memLen := len(state.Memory.MappedRegions[0].Data) + cached_decode := make([]InstructionDetails, memLen/4) + + // Perform eager decode of all mapped code + for pc := Word(0); pc < Word(memLen); pc += 4 { + insn, opcode, fun := exec.GetInstructionDetails(pc, state.Memory) + cached_decode[pc/4] = InstructionDetails{insn, opcode, fun} + } + return &InstrumentedState{ state: state, log: log, @@ -40,6 +54,7 @@ func NewInstrumentedState(state *State, po mipsevm.PreimageOracle, stdOut, stdEr statsTracker: NoopStatsTracker(), preimageOracle: exec.NewTrackingPreimageOracleReader(po), meta: meta, + cached_decode: cached_decode, features: features, } } @@ -129,3 +144,11 @@ func (m *InstrumentedState) LookupSymbol(addr arch.Word) string { } return m.meta.LookupSymbol(addr) } + +func (m *InstrumentedState) UpdateInstructionCache(pc arch.Word) { + idx := pc / 4 + if int(idx) < len(m.cached_decode) { + insn, opcode, fun := exec.GetInstructionDetails(pc, m.state.Memory) + m.cached_decode[idx] = InstructionDetails{insn, opcode, fun} + } +} diff --git a/cannon/mipsevm/multithreaded/instrumented_test.go b/cannon/mipsevm/multithreaded/instrumented_test.go index f6c48393038..57faafbb2df 100644 --- a/cannon/mipsevm/multithreaded/instrumented_test.go +++ b/cannon/mipsevm/multithreaded/instrumented_test.go @@ -27,7 +27,7 @@ func TestInstrumentedState_Hello(t *testing.T) { var stdOutBuf, stdErrBuf bytes.Buffer us := vmFactory(state, nil, io.MultiWriter(&stdOutBuf, os.Stdout), io.MultiWriter(&stdErrBuf, os.Stderr), testutil.CreateLogger(), meta) - maxSteps := 450_000 + maxSteps := 500_000 for i := 0; i < maxSteps; i++ { if us.GetState().GetExited() { break @@ -129,7 +129,7 @@ func TestInstrumentedState_SyscallEventFdProgram(t *testing.T) { err := us.InitDebug() require.NoError(t, err) - for i := 0; i < 500_000; i++ { + for i := 0; i < 550_000; i++ { if us.GetState().GetExited() { break } @@ -418,7 +418,7 @@ func runTestsAcrossVms[T any](t *testing.T, testNamer TestNamer[T], testCases [] } variations := []VMVariations{ - {name: "Go 1.23 VM", goTarget: testutil.Go1_23, features: mipsevm.FeatureToggles{SupportMinimalSysEventFd2: true, SupportDclzDclo: true}}, + {name: "Go 1.23 VM", goTarget: testutil.Go1_23, features: mipsevm.FeatureToggles{}}, {name: "Go 1.24 VM", goTarget: testutil.Go1_24, features: allFeaturesEnabled()}, } diff --git a/cannon/mipsevm/multithreaded/mips.go b/cannon/mipsevm/multithreaded/mips.go index 978cbe90133..31cd20546b0 100644 --- a/cannon/mipsevm/multithreaded/mips.go +++ b/cannon/mipsevm/multithreaded/mips.go @@ -165,9 +165,6 @@ func (m *InstrumentedState) handleSyscall() error { // Otherwise, ignored (noop) case arch.SysMunmap: case arch.SysMprotect: - if !m.features.SupportNoopMprotect { - m.handleUnrecognizedSyscall(syscallNum) - } case arch.SysGetAffinity: case arch.SysMadvise: case arch.SysRtSigprocmask: @@ -198,10 +195,6 @@ func (m *InstrumentedState) handleSyscall() error { case arch.SysGetRLimit: case arch.SysLseek: case arch.SysEventFd2: - if !m.features.SupportMinimalSysEventFd2 { - m.handleUnrecognizedSyscall(syscallNum) - } - // a0 = initial value, a1 = flags // Validate flags if a1&exec.EFD_NONBLOCK == 0 { @@ -323,8 +316,21 @@ func (m *InstrumentedState) doMipsStep() error { } m.state.StepsSinceLastContextSwitch += 1 - //instruction fetch - insn, opcode, fun := exec.GetInstructionDetails(m.state.GetPC(), m.state.Memory) + pc := m.state.GetPC() + if pc&0x3 != 0 { + panic(fmt.Sprintf("unaligned instruction fetch: PC = 0x%x", pc)) + } + cacheIdx := pc / 4 + + var insn, opcode, fun uint32 + if int(cacheIdx) < len(m.cached_decode) { + decoded := m.cached_decode[cacheIdx] + insn, opcode, fun = decoded.insn, decoded.opcode, decoded.fun + } else { + // PC is outside eager region + m.statsTracker.trackInstructionCacheMiss(pc) + insn, opcode, fun = exec.GetInstructionDetails(pc, m.state.Memory) + } // Handle syscall separately // syscall (can read and write) @@ -344,7 +350,7 @@ func (m *InstrumentedState) doMipsStep() error { } // Exec the rest of the step logic - memUpdated, effMemAddr, err := exec.ExecMipsCoreStepLogic(m.state.getCpuRef(), m.state.GetRegistersRef(), m.state.Memory, insn, opcode, fun, m.memoryTracker, m.stackTracker, m.features) + memUpdated, effMemAddr, err := exec.ExecMipsCoreStepLogic(m.state.getCpuRef(), m.state.GetRegistersRef(), m.state.Memory, insn, opcode, fun, m.memoryTracker, m.stackTracker) if err != nil { return err } diff --git a/cannon/mipsevm/multithreaded/state.go b/cannon/mipsevm/multithreaded/state.go index 35ca34d1bc0..f2405f7c1bd 100644 --- a/cannon/mipsevm/multithreaded/state.go +++ b/cannon/mipsevm/multithreaded/state.go @@ -70,6 +70,8 @@ type State struct { // LastHint is optional metadata, and not part of the VM state itself. LastHint hexutil.Bytes + + UseLargeICache bool } var _ mipsevm.FPVMState = (*State)(nil) @@ -333,7 +335,11 @@ func (s *State) Serialize(out io.Writer) error { func (s *State) Deserialize(in io.Reader) error { bin := serialize.NewBinaryReader(in) - s.Memory = memory.NewMemory() + if s.UseLargeICache { + s.Memory = memory.NewMemoryWithLargeRegions() + } else { + s.Memory = memory.NewMemory() + } if err := s.Memory.Deserialize(in); err != nil { return err } diff --git a/cannon/mipsevm/multithreaded/stats.go b/cannon/mipsevm/multithreaded/stats.go index 04de1516359..77185ea64c8 100644 --- a/cannon/mipsevm/multithreaded/stats.go +++ b/cannon/mipsevm/multithreaded/stats.go @@ -1,6 +1,7 @@ package multithreaded import ( + "github.com/ethereum/go-ethereum/common/hexutil" lru "github.com/hashicorp/golang-lru/v2/simplelru" "github.com/ethereum-optimism/optimism/cannon/mipsevm" @@ -14,6 +15,7 @@ type StatsTracker interface { trackReservationInvalidation() trackForcedPreemption() trackThreadActivated(tid Word, step uint64) + trackInstructionCacheMiss(pc Word) populateDebugInfo(debugInfo *mipsevm.DebugInfo) } @@ -31,6 +33,7 @@ func (s *noopStatsTracker) trackReservationInvalidation() {} func (s *noopStatsTracker) trackForcedPreemption() {} func (s *noopStatsTracker) trackThreadActivated(tid Word, step uint64) {} func (s *noopStatsTracker) populateDebugInfo(debugInfo *mipsevm.DebugInfo) {} +func (s *noopStatsTracker) trackInstructionCacheMiss(pc Word) {} var _ StatsTracker = (*noopStatsTracker)(nil) @@ -48,6 +51,8 @@ type statsTrackerImpl struct { reservationInvalidationCount uint64 forcedPreemptionCount uint64 idleStepCountThread0 uint64 + icacheMissCount uint64 + highestICacheMissPC Word } func (s *statsTrackerImpl) populateDebugInfo(debugInfo *mipsevm.DebugInfo) { @@ -57,6 +62,8 @@ func (s *statsTrackerImpl) populateDebugInfo(debugInfo *mipsevm.DebugInfo) { debugInfo.ReservationInvalidationCount = s.reservationInvalidationCount debugInfo.ForcedPreemptionCount = s.forcedPreemptionCount debugInfo.IdleStepCountThread0 = s.idleStepCountThread0 + debugInfo.InstructionCacheMissCount = s.icacheMissCount + debugInfo.HighestICacheMissPC = hexutil.Uint64(s.highestICacheMissPC) } func (s *statsTrackerImpl) trackLL(threadId Word, step uint64) { @@ -105,6 +112,13 @@ func (s *statsTrackerImpl) trackThreadActivated(tid Word, step uint64) { s.activeThreadId = tid } +func (s *statsTrackerImpl) trackInstructionCacheMiss(pc Word) { + s.icacheMissCount += 1 + if pc > s.highestICacheMissPC { + s.highestICacheMissPC = pc + } +} + func NewStatsTracker() StatsTracker { return newStatsTracker(5) } diff --git a/cannon/mipsevm/tests/difftester.go b/cannon/mipsevm/tests/difftester.go index 7090786f820..19eb8790446 100644 --- a/cannon/mipsevm/tests/difftester.go +++ b/cannon/mipsevm/tests/difftester.go @@ -24,7 +24,7 @@ func NoopTestNamer[T any](c T) string { return "" } -type SimpleInitializeStateFn func(t require.TestingT, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) +type SimpleInitializeStateFn func(t require.TestingT, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) type SimpleSetExpectationsFn func(t require.TestingT, expect *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult type SimplePostStepCheckFn func(t require.TestingT, vm VersionedVMTestCase, deps *TestDependencies, witness *mipsevm.StepWitness) @@ -46,11 +46,10 @@ func NewSimpleDiffTester() *SimpleDiffTester { } func (d *SimpleDiffTester) InitState(initStateFn SimpleInitializeStateFn, opts ...mtutil.StateOption) *SimpleDiffTester { - wrappedFn := func(t require.TestingT, testCase soloTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - initStateFn(t, state, vm, r) + wrappedFn := func(t require.TestingT, _ soloTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + initStateFn(t, state, vm, r, goVm) } d.diffTester.InitState(wrappedFn, opts...) - return d } @@ -79,7 +78,7 @@ func (d *SimpleDiffTester) Run(t *testing.T, opts ...TestOption) { d.diffTester.run(wrapT(t), singleTestCase, opts...) } -type InitializeStateFn[T any] func(t require.TestingT, testCase T, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) +type InitializeStateFn[T any] func(t require.TestingT, testCase T, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) type SetExpectationsFn[T any] func(t require.TestingT, testCase T, expect *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult type PostStepCheckFn[T any] func(t require.TestingT, testCase T, vm VersionedVMTestCase, deps *TestDependencies, witness *mipsevm.StepWitness) @@ -175,7 +174,7 @@ func (d *DiffTester[T]) newTestSetup(t require.TestingT, testCase T, vm Versione goVm := vm.VMFactory(testDeps.po, testDeps.stdOut, testDeps.stdErr, testDeps.logger, stateOpts...) state := mtutil.GetMtState(t, goVm) - d.initState(t, testCase, state, vm, testutil.NewRandHelper(randSeed*2)) + d.initState(t, testCase, state, vm, testutil.NewRandHelper(randSeed*2), goVm) if mod != nil { mod.stateMod(state) } diff --git a/cannon/mipsevm/tests/difftester_test.go b/cannon/mipsevm/tests/difftester_test.go index 3b4b0782656..2647689bf79 100644 --- a/cannon/mipsevm/tests/difftester_test.go +++ b/cannon/mipsevm/tests/difftester_test.go @@ -7,6 +7,7 @@ import ( "github.com/stretchr/testify/require" + "github.com/ethereum-optimism/optimism/cannon/mipsevm" "github.com/ethereum-optimism/optimism/cannon/mipsevm/arch" "github.com/ethereum-optimism/optimism/cannon/mipsevm/multithreaded" mtutil "github.com/ethereum-optimism/optimism/cannon/mipsevm/multithreaded/testutil" @@ -24,7 +25,7 @@ func TestDiffTester_Run_SimpleTest(t *testing.T) { testName := fmt.Sprintf("useCorrectReturnExpectation=%v", useCorrectReturnExpectation) t.Run(testName, func(t *testing.T) { initStateCalled := make(map[string]int) - initState := func(t require.TestingT, testCase simpleTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, testCase simpleTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { initStateCalled[testCase.name] += 1 testutil.StoreInstruction(state.GetMemory(), state.GetPC(), testCase.insn) } @@ -90,7 +91,7 @@ func TestDiffTester_Run_WithSteps(t *testing.T) { for _, oc := range outterCases { t.Run(oc.name, func(t *testing.T) { initStateCalled := make(map[string]int) - initState := func(t require.TestingT, testCase simpleTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, testCase simpleTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { initStateCalled[testCase.name] += 1 testutil.StoreInstruction(state.GetMemory(), state.GetPC(), testCase.insn) } @@ -152,9 +153,9 @@ func TestDiffTester_Run_WithMemModifications(t *testing.T) { t.Run(testName, func(t *testing.T) { initStateCalled := make(map[string]int) - initState := func(t require.TestingT, tt simpleTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt simpleTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { initStateCalled[tt.name] += 1 - testutil.StoreInstruction(state.GetMemory(), pc, tt.insn) + storeInsnWithCache(state, goVm, pc, tt.insn) state.GetMemory().SetWord(effAddr, 0xAA_BB_CC_DD_A1_B1_C1_D1) state.GetRegistersRef()[rtReg] = 0x11_22_33_44_55_66_77_88 state.GetRegistersRef()[baseReg] = base @@ -219,7 +220,7 @@ func TestDiffTester_Run_WithPanic(t *testing.T) { testName := fmt.Sprintf("useCorrectReturnExpectation=%v", useCorrectReturnExpectation) t.Run(testName, func(t *testing.T) { initStateCalled := make(map[string]int) - initState := func(t require.TestingT, testCase simpleTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, testCase simpleTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { initStateCalled[testCase.name] += 1 testutil.StoreInstruction(state.GetMemory(), state.GetPC(), testCase.insn) state.GetRegistersRef()[2] = syscallNum @@ -279,7 +280,7 @@ func TestDiffTester_Run_WithVm(t *testing.T) { } initStateCalled := make(map[string]int) - initState := func(t require.TestingT, testCase simpleTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, testCase simpleTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { initStateCalled[testCase.name] += 1 testutil.StoreInstruction(state.GetMemory(), state.GetPC(), testCase.insn) } diff --git a/cannon/mipsevm/tests/evm_common64_test.go b/cannon/mipsevm/tests/evm_common64_test.go index 41d612acfe1..9bdaf17305b 100644 --- a/cannon/mipsevm/tests/evm_common64_test.go +++ b/cannon/mipsevm/tests/evm_common64_test.go @@ -1,16 +1,14 @@ package tests import ( - "fmt" - "slices" "testing" "github.com/stretchr/testify/require" + "github.com/ethereum-optimism/optimism/cannon/mipsevm" "github.com/ethereum-optimism/optimism/cannon/mipsevm/multithreaded" mtutil "github.com/ethereum-optimism/optimism/cannon/mipsevm/multithreaded/testutil" "github.com/ethereum-optimism/optimism/cannon/mipsevm/testutil" - "github.com/ethereum-optimism/optimism/cannon/mipsevm/versions" ) func TestEVM_SingleStep_Operators64(t *testing.T) { @@ -154,12 +152,12 @@ func TestEVM_SingleStep_Shift64(t *testing.T) { pc := Word(0x0) rdReg := uint32(8) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { rtReg := uint32(18) insn := rtReg<<16 | rdReg<<11 | tt.sa<<6 | tt.funct state.GetRegistersRef()[rdReg] = tt.rd state.GetRegistersRef()[rtReg] = tt.rt - testutil.StoreInstruction(state.GetMemory(), pc, insn) + storeInsnWithCache(state, goVm, pc, insn) } setExpectations := func(t require.TestingT, tt testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -542,27 +540,15 @@ func TestEVM_SingleStep_DCloDClz64(t *testing.T) { {name: "dclz", rs: Word(0x80_00_00_00_00_00_00_00), expectedResult: Word(0), funct: 0b10_0100}, } - vmVersions := GetMipsVersionTestCases(t) - require.True(t, slices.ContainsFunc(vmVersions, func(v VersionedVMTestCase) bool { - features := versions.FeaturesForVersion(v.Version) - return features.SupportDclzDclo - }), "dclz/dclo feature not tested") - - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), insnFn(tt)) + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + storeInsnWithCache(state, goVm, state.GetPC(), insnFn(tt)) state.GetRegistersRef()[rsReg] = tt.rs } setExpectations := func(t require.TestingT, tt testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { - features := versions.FeaturesForVersion(vm.Version) - if features.SupportDclzDclo { - expected.ExpectStep() - expected.ActiveThread().Registers[rdReg] = tt.expectedResult - return ExpectNormalExecution() - } else { - expectedMsg := fmt.Sprintf("invalid instruction: %x", insnFn(tt)) - return ExpectVmPanic(expectedMsg, "invalid instruction") - } + expected.ExpectStep() + expected.ActiveThread().Registers[rdReg] = tt.expectedResult + return ExpectNormalExecution() } NewDiffTester(testNamer). diff --git a/cannon/mipsevm/tests/evm_common_test.go b/cannon/mipsevm/tests/evm_common_test.go index 4f34a92586a..46065708b12 100644 --- a/cannon/mipsevm/tests/evm_common_test.go +++ b/cannon/mipsevm/tests/evm_common_test.go @@ -2,7 +2,6 @@ package tests import ( "bytes" - "fmt" "io" "math/big" "os" @@ -25,6 +24,17 @@ import ( "github.com/ethereum-optimism/optimism/cannon/mipsevm/versions" ) +type insnCache interface { + UpdateInstructionCache(pc arch.Word) +} + +func storeInsnWithCache(state *multithreaded.State, goVm mipsevm.FPVM, pc arch.Word, insn uint32) { + testutil.StoreInstruction(state.GetMemory(), pc, insn) + if ic, ok := goVm.(insnCache); ok { + ic.UpdateInstructionCache(pc) + } +} + func TestEVM_SingleStep_Jump(t *testing.T) { type testCase struct { name string @@ -46,10 +56,10 @@ func TestEVM_SingleStep_Jump(t *testing.T) { {name: "jal non-zero PC region", pc: 0x10000000, nextPC: 0x10000004, insn: 0x0C_00_00_02, expectNextPC: 0x10_00_00_08, expectLink: true}, // jal 0x2 } - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { state.GetCurrentThread().Cpu.PC = tt.pc state.GetCurrentThread().Cpu.NextPC = tt.nextPC - testutil.StoreInstruction(state.GetMemory(), tt.pc, tt.insn) + storeInsnWithCache(state, goVm, tt.pc, tt.insn) } setExpectations := func(t require.TestingT, tt testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -153,9 +163,9 @@ func TestEVM_SingleStep_Lui(t *testing.T) { {name: "lui signed", rtReg: 7, imm: 0x8765, expectRt: signExtend64(0x8765_0000)}, } - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { insn := 0b1111<<26 | uint32(tt.rtReg)<<16 | (tt.imm & 0xFFFF) - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), insn) + storeInsnWithCache(state, goVm, state.GetPC(), insn) } setExpectations := func(t require.TestingT, tt testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -196,9 +206,9 @@ func TestEVM_SingleStep_CloClz(t *testing.T) { rsReg := uint32(5) rdReg := uint32(6) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { insn := 0b01_1100<<26 | rsReg<<21 | rdReg<<11 | tt.funct - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), insn) + storeInsnWithCache(state, goVm, state.GetPC(), insn) state.GetRegistersRef()[rsReg] = tt.rs } @@ -241,12 +251,12 @@ func TestEVM_SingleStep_MovzMovn(t *testing.T) { rdReg := uint32(8) val := Word(0xb) otherVal := Word(0xa) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { insn := rsReg<<21 | rtReg<<16 | rdReg<<11 | tt.funct state.GetRegistersRef()[rtReg] = tt.testValue state.GetRegistersRef()[rsReg] = val state.GetRegistersRef()[rdReg] = otherVal - testutil.StoreInstruction(state.GetMemory(), pc, insn) + storeInsnWithCache(state, goVm, pc, insn) } setExpectations := func(t require.TestingT, tt testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -282,9 +292,9 @@ func TestEVM_SingleStep_MfhiMflo(t *testing.T) { } rdReg := uint32(8) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { insn := rdReg<<11 | tt.funct - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), insn) + storeInsnWithCache(state, goVm, state.GetPC(), insn) state.GetCurrentThread().Cpu.HI = tt.hi state.GetCurrentThread().Cpu.LO = tt.lo } @@ -353,10 +363,10 @@ func TestEVM_SingleStep_MthiMtlo(t *testing.T) { } val := Word(0xdeadbeef) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { rsReg := uint32(8) insn := rsReg<<21 | tt.funct - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), insn) + storeInsnWithCache(state, goVm, state.GetPC(), insn) state.GetRegistersRef()[rsReg] = val } @@ -400,13 +410,13 @@ func TestEVM_SingleStep_BeqBne(t *testing.T) { } pc := Word(800) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { rsReg := uint32(9) rtReg := uint32(8) insn := tt.opcode<<26 | rsReg<<21 | rtReg<<16 | uint32(tt.imm) state.GetRegistersRef()[rtReg] = tt.rt state.GetRegistersRef()[rsReg] = tt.rs - testutil.StoreInstruction(state.GetMemory(), pc, insn) + storeInsnWithCache(state, goVm, pc, insn) } setExpectations := func(t require.TestingT, tt testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -464,12 +474,12 @@ func TestEVM_SingleStep_SlSr(t *testing.T) { pc := Word(0) rdReg := uint32(0x8) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { rtReg := uint32(0x9) insn := tt.rsReg<<21 | rtReg<<16 | rdReg<<11 | uint32(tt.funct) state.GetRegistersRef()[rtReg] = tt.rt state.GetRegistersRef()[tt.rsReg] = tt.rs - testutil.StoreInstruction(state.GetMemory(), pc, insn) + storeInsnWithCache(state, goVm, pc, insn) } setExpectations := func(t require.TestingT, tt testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -508,12 +518,12 @@ func TestEVM_SingleStep_JrJalr(t *testing.T) { {name: "jalr, delay slot", funct: uint16(0x9), rsReg: 8, jumpTo: 0x34, rdReg: uint32(0x9), expectLink: true, pc: 0, nextPC: 100, errorMsg: "jump in delay slot"}, // jalr t1, t0 } - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { insn := tt.rsReg<<21 | tt.rdReg<<11 | uint32(tt.funct) state.GetRegistersRef()[tt.rsReg] = tt.jumpTo state.GetCurrentThread().Cpu.PC = tt.pc state.GetCurrentThread().Cpu.NextPC = tt.nextPC - testutil.StoreInstruction(state.GetMemory(), tt.pc, insn) + storeInsnWithCache(state, goVm, tt.pc, insn) } setExpectations := func(t require.TestingT, tt testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -548,9 +558,9 @@ func TestEVM_SingleStep_Sync(t *testing.T) { {name: "simple"}, } - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { syncInsn := uint32(0x0000_000F) - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syncInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syncInsn) } setExpectations := func(t require.TestingT, tt testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -590,8 +600,8 @@ func TestEVM_MMap(t *testing.T) { {name: "Request specific address", heap: program.HEAP_START, address: 0x50_00_00_00, size: 0, shouldFail: false, expectedHeap: program.HEAP_START}, } - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = arch.SysMmap state.GetRegistersRef()[4] = c.address state.GetRegistersRef()[5] = c.size @@ -683,8 +693,8 @@ func TestEVM_SysGetRandom(t *testing.T) { step := uint64(0x1a2b3c4d5e6f7531) - 1 randomData := arch.Word(0x4141302768c9e9d0) - initState := func(t require.TestingT, testCase testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + initState := func(t require.TestingT, testCase testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetMemory().SetWord(effAddr, startingMemory) state.GetRegistersRef()[register.RegV0] = arch.SysGetRandom state.GetRegistersRef()[register.RegA0] = effAddr + testCase.bufAddrOffset @@ -710,7 +720,10 @@ func TestEVM_SysGetRandom(t *testing.T) { NewDiffTester(testNamer). InitState(initState, mtutil.WithStep(step)). SetExpectations(setExpectations). - Run(t, cases) + Run(t, cases, SkipAutomaticMemoryReservationTests()) + //Was getting failure from the “automatic memory reservation” modifier that the DiffTester adds. + //I think the mod executes extra setup on a different thread before the syscall, which I think bumps the step counter. + //Since sys_getrandom seeds splitmix64 with the incremented step, I think those extra steps shift the seed. } func TestEVM_SysWriteHint(t *testing.T) { @@ -871,8 +884,8 @@ func TestEVM_SysWriteHint(t *testing.T) { }, } - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.LastHint = tt.lastHint state.GetRegistersRef()[2] = arch.SysWrite state.GetRegistersRef()[4] = exec.FdHintWrite @@ -924,14 +937,15 @@ func TestEVM_Fault(t *testing.T) { {name: "illegal instruction", nextPC: 0, insn: 0b111110 << 26, evmErrStr: "invalid instruction", goPanicValue: "invalid instruction: f8000000"}, {name: "branch in delay-slot", nextPC: 8, insn: 0x11_02_00_03, evmErrStr: "branch in delay slot", goPanicValue: "branch in delay slot"}, {name: "jump in delay-slot", nextPC: 8, insn: 0x0c_00_00_0c, evmErrStr: "jump in delay slot", goPanicValue: "jump in delay slot"}, - {name: "misaligned instruction", pc: 1, nextPC: 4, insn: 0b110111_00001_00001 << 16, evmErrSig: "InvalidPC()", goPanicValue: fmt.Errorf("invalid pc: 1")}, - {name: "misaligned instruction", pc: 2, nextPC: 4, insn: 0b110111_00001_00001 << 16, evmErrSig: "InvalidPC()", goPanicValue: fmt.Errorf("invalid pc: 2")}, - {name: "misaligned instruction", pc: 3, nextPC: 4, insn: 0b110111_00001_00001 << 16, evmErrSig: "InvalidPC()", goPanicValue: fmt.Errorf("invalid pc: 3")}, - {name: "misaligned instruction", pc: 5, nextPC: 4, insn: 0b110111_00001_00001 << 16, evmErrSig: "InvalidPC()", goPanicValue: fmt.Errorf("invalid pc: 5")}, + + {name: "misaligned instruction", pc: 1, nextPC: 4, insn: 0b110111_00001_00001 << 16, evmErrSig: "InvalidPC()", goPanicValue: "unaligned instruction fetch: PC = 0x1"}, + {name: "misaligned instruction", pc: 2, nextPC: 4, insn: 0b110111_00001_00001 << 16, evmErrSig: "InvalidPC()", goPanicValue: "unaligned instruction fetch: PC = 0x2"}, + {name: "misaligned instruction", pc: 3, nextPC: 4, insn: 0b110111_00001_00001 << 16, evmErrSig: "InvalidPC()", goPanicValue: "unaligned instruction fetch: PC = 0x3"}, + {name: "misaligned instruction", pc: 5, nextPC: 4, insn: 0b110111_00001_00001 << 16, evmErrSig: "InvalidPC()", goPanicValue: "unaligned instruction fetch: PC = 0x5"}, } - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - testutil.StoreInstruction(state.GetMemory(), 0, tt.insn) + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + storeInsnWithCache(state, goVm, 0, tt.insn) state.GetCurrentThread().Cpu.PC = tt.pc state.GetCurrentThread().Cpu.NextPC = tt.nextPC // set the return address ($ra) to jump into when test completes @@ -1060,7 +1074,7 @@ func TestEVM_SyscallEventFdProgram(t *testing.T) { state := goVm.GetState() start := time.Now() - for i := 0; i < 500_000; i++ { + for i := 0; i < 550_000; i++ { step := goVm.GetState().GetStep() if goVm.GetState().GetExited() { break @@ -1128,7 +1142,7 @@ func TestEVM_HelloProgram(t *testing.T) { state := goVm.GetState() start := time.Now() - for i := 0; i < 450_000; i++ { + for i := 0; i < 500_000; i++ { step := goVm.GetState().GetStep() if goVm.GetState().GetExited() { break diff --git a/cannon/mipsevm/tests/evm_multithreaded64_test.go b/cannon/mipsevm/tests/evm_multithreaded64_test.go index 901b9ebfe6f..19036552cef 100644 --- a/cannon/mipsevm/tests/evm_multithreaded64_test.go +++ b/cannon/mipsevm/tests/evm_multithreaded64_test.go @@ -61,13 +61,13 @@ func TestEVM_MT64_LL(t *testing.T) { } cases := testutil.TestVariations(baseTests, llVariations) - initState := func(t require.TestingT, testCase testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, testCase testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { c := testCase.Base retReg := c.retReg baseReg := 6 insn := uint32((0b11_0000 << 26) | (baseReg & 0x1F << 21) | (retReg & 0x1F << 16) | (0xFFFF & c.offset)) - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), insn) + storeInsnWithCache(state, goVm, state.GetPC(), insn) state.GetMemory().SetWord(testutil.EffAddr(c.addr), c.memVal) state.GetRegistersRef()[baseReg] = c.base if testCase.Variation.withExistingReservation { @@ -146,7 +146,7 @@ func TestEVM_MT64_SC(t *testing.T) { } cases := testutil.TestVariations(baseTests, llVariations) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { c := tt.Base llVar := tt.Variation @@ -172,7 +172,7 @@ func TestEVM_MT64_SC(t *testing.T) { // Setup state state.GetCurrentThread().ThreadId = c.threadId - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), insn) + storeInsnWithCache(state, goVm, state.GetPC(), insn) state.GetRegistersRef()[baseReg] = c.base state.GetRegistersRef()[rtReg] = c.value state.LLReservationStatus = llVar.llReservationStatus @@ -246,12 +246,12 @@ func TestEVM_MT64_LLD(t *testing.T) { } cases := testutil.TestVariations(baseTests, llVariations) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { c := tt.Base baseReg := 6 insn := uint32((0b11_0100 << 26) | (baseReg & 0x1F << 21) | (c.retReg & 0x1F << 16) | (0xFFFF & c.offset)) - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), insn) + storeInsnWithCache(state, goVm, state.GetPC(), insn) state.GetMemory().SetWord(testutil.EffAddr(c.addr), c.memVal) state.GetRegistersRef()[baseReg] = c.base if tt.Variation.withExistingReservation { @@ -331,7 +331,7 @@ func TestEVM_MT64_SCD(t *testing.T) { cases := testutil.TestVariations(baseTests, llVariations) value := Word(0x11223344_55667788) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { c := tt.Base llVar := tt.Variation @@ -356,7 +356,7 @@ func TestEVM_MT64_SCD(t *testing.T) { insn := uint32((0b11_1100 << 26) | (baseReg & 0x1F << 21) | (c.rtReg & 0x1F << 16) | (0xFFFF & c.offset)) state.GetCurrentThread().ThreadId = c.threadId - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), insn) + storeInsnWithCache(state, goVm, state.GetPC(), insn) state.GetRegistersRef()[baseReg] = c.base state.GetRegistersRef()[c.rtReg] = value state.LLReservationStatus = llVar.llReservationStatus @@ -449,14 +449,14 @@ func TestEVM_MT_SysRead_Preimage64(t *testing.T) { preimageValue := make([]byte, 0, 8) preimageValue = binary.BigEndian.AppendUint32(preimageValue, 0x12_34_56_78) preimageValue = binary.BigEndian.AppendUint32(preimageValue, 0x98_76_54_32) - initState := func(t require.TestingT, testCase testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, testCase testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { state.PreimageKey = testutil.Keccak256Preimage(preimageValue) state.PreimageOffset = testCase.preimageOffset state.GetRegistersRef()[2] = arch.SysRead state.GetRegistersRef()[4] = exec.FdPreimageRead state.GetRegistersRef()[5] = testCase.addr state.GetRegistersRef()[6] = testCase.count - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetMemory().SetWord(testutil.EffAddr(testCase.addr), testCase.prestateMem) } @@ -499,13 +499,13 @@ func TestEVM_MT_SysReadWrite_WithEventFd(t *testing.T) { {name: "SysWrite", syscallNum: arch.SysWrite}, } - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { addr := Word(0x00_00_FF_00) state.GetRegistersRef()[2] = tt.syscallNum state.GetRegistersRef()[4] = exec.FdEventFd state.GetRegistersRef()[5] = addr state.GetRegistersRef()[6] = 1 - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) // Set a memory value to ensure that memory at the target address is not modified state.GetMemory().SetWord(addr, Word(0x12_EE_EE_EE_FF_FF_FF_FF)) } @@ -565,12 +565,12 @@ func TestEVM_MT_StoreOpsClearMemReservation64(t *testing.T) { //rt := Word(0x12_34_56_78_12_34_56_78) baseReg := uint32(5) rtReg := uint32(6) - initState := func(t require.TestingT, testCase testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, testCase testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { insn := uint32((testCase.opcode << 26) | (baseReg & 0x1F << 21) | (rtReg & 0x1F << 16) | (0xFFFF & testCase.offset)) state.GetRegistersRef()[rtReg] = rt state.GetRegistersRef()[baseReg] = testCase.base - testutil.StoreInstruction(state.GetMemory(), pc, insn) + storeInsnWithCache(state, goVm, pc, insn) state.GetMemory().SetWord(testCase.effAddr, testCase.preMem) } @@ -627,9 +627,6 @@ var NoopSyscalls64 = map[string]uint32{ func getNoopSyscalls64(vmVersion versions.StateVersion) map[string]uint32 { noOpCalls := maps.Clone(NoopSyscalls64) features := versions.FeaturesForVersion(vmVersion) - if !features.SupportNoopMprotect { - delete(noOpCalls, "SysMprotect") - } if features.SupportWorkingSysGetRandom { delete(noOpCalls, "SysGetRandom") } @@ -690,8 +687,8 @@ func TestEVM_UndefinedSyscall(t *testing.T) { {"SysLlseek", arch.SysLlseek}, } - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = Word(tt.syscallNum) } diff --git a/cannon/mipsevm/tests/evm_multithreaded_test.go b/cannon/mipsevm/tests/evm_multithreaded_test.go index 758a6a264ed..1f455fc63d4 100644 --- a/cannon/mipsevm/tests/evm_multithreaded_test.go +++ b/cannon/mipsevm/tests/evm_multithreaded_test.go @@ -58,7 +58,7 @@ func TestEVM_MT_LL(t *testing.T) { } cases := testutil.TestVariations(baseTests, testVariations) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { c := tt.Base baseReg := 6 @@ -66,7 +66,7 @@ func TestEVM_MT_LL(t *testing.T) { // Set up state testutil.SetMemoryUint64(t, state.GetMemory(), Word(c.expectedAddr), c.memValue) - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), insn) + storeInsnWithCache(state, goVm, state.GetPC(), insn) state.GetRegistersRef()[baseReg] = Word(c.base) if tt.Variation.withExistingReservation { state.LLReservationStatus = multithreaded.LLStatusActive32bit @@ -139,7 +139,7 @@ func TestEVM_MT_SC(t *testing.T) { // Set up some test values that will be reused memValue := uint64(0x1122_3344_5566_7788) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { c := tt.Base llVar := tt.Variation @@ -164,7 +164,7 @@ func TestEVM_MT_SC(t *testing.T) { insn := uint32((0b11_1000 << 26) | (baseReg & 0x1F << 21) | (c.rtReg & 0x1F << 16) | (0xFFFF & c.offset)) testutil.SetMemoryUint64(t, state.GetMemory(), Word(c.expectedAddr), memValue) state.GetCurrentThread().ThreadId = c.threadId - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), insn) + storeInsnWithCache(state, goVm, state.GetPC(), insn) state.GetRegistersRef()[baseReg] = c.base state.GetRegistersRef()[c.rtReg] = Word(c.storeValue) state.LLReservationStatus = llVar.llReservationStatus @@ -221,9 +221,9 @@ func TestEVM_SysClone_FlagHandling(t *testing.T) { } stackPtr := Word(204) - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { mtutil.InitializeSingleThread(r.Intn(10000), state, true) - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = arch.SysClone // Set syscall number state.GetRegistersRef()[4] = c.flags // Set first argument state.GetRegistersRef()[5] = stackPtr // a1 - the stack pointer @@ -265,9 +265,9 @@ func TestEVM_SysClone_Successful(t *testing.T) { } stackPtr := Word(100) - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { mtutil.InitializeSingleThread(r.Intn(10000), state, c.traverseRight) - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = arch.SysClone // the syscall number state.GetRegistersRef()[4] = exec.ValidCloneFlags // a0 - first argument, clone flags state.GetRegistersRef()[5] = stackPtr // a1 - the stack pointer @@ -325,10 +325,10 @@ func TestEVM_SysGetTID(t *testing.T) { {"non-zero", 11}, } - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { mtutil.InitializeSingleThread(r.Intn(10000), state, false) state.GetCurrentThread().ThreadId = c.threadId - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = arch.SysGetTID // Set syscall number } @@ -374,10 +374,10 @@ func TestEVM_SysExit(t *testing.T) { cases := testutil.TestVariations(baseTests, testVariations) exitCode := uint8(3) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { c := tt.Base mtutil.SetupThreads(r.Int64(10000), state, tt.Variation.traverseRight, c.threadCount, 0) - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = arch.SysExit // Set syscall number state.GetRegistersRef()[4] = Word(exitCode) // The first argument (exit code) } @@ -419,7 +419,7 @@ func TestEVM_PopExitedThread(t *testing.T) { {name: "traverse left, switch directions", traverseRight: false, activeStackThreadCount: 1, expectTraverseRightPostState: true}, } - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { mtutil.SetupThreads(r.Int64(1000), state, c.traverseRight, c.activeStackThreadCount, 1) threadToPop := state.GetCurrentThread() threadToPop.Exited = true @@ -469,8 +469,8 @@ func TestEVM_SysFutex_WaitPrivate(t *testing.T) { {name: "memory mismatch w timeout, unaligned", addressParam: 0xFF_FF_FF_FF_FF_FF_12_0F, effAddr: 0xFF_FF_FF_FF_FF_FF_12_0C, targetValue: 0xFF_FF_FF_01, actualValue: 0xFF_FF_FF_02, timeout: 2000000, shouldFail: true}, } - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) testutil.RandomizeWordAndSetUint32(state.GetMemory(), Word(c.effAddr), c.actualValue, r.Int64(1000)) state.GetRegistersRef()[2] = arch.SysFutex // Set syscall number state.GetRegistersRef()[4] = Word(c.addressParam) @@ -535,9 +535,9 @@ func TestEVM_SysFutex_WakePrivate(t *testing.T) { {name: "Traverse left, single thread, unaligned", addressParam: 0xFF_FF_FF_FF_FF_FF_67_89, effAddr: 0xFF_FF_FF_FF_FF_FF_67_88, activeThreadCount: 1, inactiveThreadCount: 0, traverseRight: false}, } - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { mtutil.SetupThreads(r.Int64(1000), state, c.traverseRight, c.activeThreadCount, c.inactiveThreadCount) - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = arch.SysFutex // Set syscall number state.GetRegistersRef()[4] = Word(c.addressParam) state.GetRegistersRef()[5] = exec.FutexWakePrivate @@ -612,8 +612,8 @@ func TestEVM_SysFutex_UnsupportedOp(t *testing.T) { {"FUTEX_CMP_REQUEUE_PI_PRIVATE", (FUTEX_CMP_REQUEUE_PI | FUTEX_PRIVATE_FLAG)}, } - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = arch.SysFutex // Set syscall number state.GetRegistersRef()[5] = c.op } @@ -667,10 +667,10 @@ func runPreemptSyscall(t *testing.T, syscallName string, syscallNum uint32) { } cases := testutil.TestVariations(baseTests, testVariations) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { c := tt.Base mtutil.SetupThreads(r.Int64(1000), state, tt.Variation.traverseRight, c.activeThreads, c.inactiveThreads) - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = Word(syscallNum) // Set syscall number } @@ -689,8 +689,8 @@ func runPreemptSyscall(t *testing.T, syscallName string, syscallNum uint32) { } func TestEVM_SysOpen(t *testing.T) { - initState := func(t require.TestingT, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + initState := func(t require.TestingT, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = arch.SysOpen // Set syscall number } @@ -708,8 +708,8 @@ func TestEVM_SysOpen(t *testing.T) { } func TestEVM_SysGetPID(t *testing.T) { - initState := func(t require.TestingT, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + initState := func(t require.TestingT, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = arch.SysGetpid // Set syscall number } @@ -772,7 +772,7 @@ func testEVM_SysClockGettime(t *testing.T, clkid Word) { } cases := testutil.TestVariations(baseTests, llVariations) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { c := tt.Base llVar := tt.Variation @@ -796,7 +796,7 @@ func testEVM_SysClockGettime(t *testing.T, clkid Word) { llOwnerThread = state.GetCurrentThread().ThreadId + 1 } - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = arch.SysClockGetTime // Set syscall number state.GetRegistersRef()[4] = clkid // a0 state.GetRegistersRef()[5] = c.timespecAddr // a1 @@ -836,9 +836,9 @@ func testEVM_SysClockGettime(t *testing.T, clkid Word) { } func TestEVM_SysClockGettimeNonMonotonic(t *testing.T) { - initState := func(t require.TestingT, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { timespecAddr := Word(0x1000) - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = arch.SysClockGetTime // Set syscall number state.GetRegistersRef()[4] = 0xDEAD // a0 - invalid clockid state.GetRegistersRef()[5] = timespecAddr // a1 @@ -881,7 +881,7 @@ func TestEVM_EmptyThreadStacks(t *testing.T) { cases := testutil.TestVariations(baseTests, proofVariations) - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { b := c.Base mtutil.SetupThreads(r.Int64(1000), state, b.traverseRight, 0, b.otherStackSize) } @@ -927,7 +927,7 @@ func TestEVM_NormalTraversal_Full(t *testing.T) { // The ori (or immediate) instruction sets register 2 to SysSchedYield oriInsn := uint32((0b001101 << 26) | (syscallNumReg & 0x1F << 16) | (0xFFFF & arch.SysSchedYield)) - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { c := tt.Base traverseRight := tt.Variation.traverseRight mtutil.SetupThreads(r.Int64(1000), state, traverseRight, c.threadCount, 0) @@ -995,7 +995,7 @@ func TestEVM_SchedQuantumThreshold(t *testing.T) { {name: "beyond threshold", stepsSinceLastContextSwitch: exec.SchedQuantum + 1, shouldPreempt: true}, } - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { // Setup basic getThreadId syscall instruction testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = arch.SysGetTID // Set syscall number diff --git a/cannon/mipsevm/tests/fuzz_evm_common64_test.go b/cannon/mipsevm/tests/fuzz_evm_common64_test.go index ca2e099c5bc..6518a46aa32 100644 --- a/cannon/mipsevm/tests/fuzz_evm_common64_test.go +++ b/cannon/mipsevm/tests/fuzz_evm_common64_test.go @@ -5,6 +5,7 @@ import ( "github.com/stretchr/testify/require" + "github.com/ethereum-optimism/optimism/cannon/mipsevm" "github.com/ethereum-optimism/optimism/cannon/mipsevm/exec" "github.com/ethereum-optimism/optimism/cannon/mipsevm/multithreaded" mtutil "github.com/ethereum-optimism/optimism/cannon/mipsevm/multithreaded/testutil" @@ -68,9 +69,9 @@ func mulOpCheck(f *testing.F, multiplier multiplierFn, opcode uint32, expectRdRe if expectRdReg { rdReg = 19 } - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { insn := opcode<<26 | rsReg<<21 | rtReg<<16 | rdReg<<11 | funct - testutil.StoreInstruction(state.GetMemory(), 0, insn) + storeInsnWithCache(state, goVm, 0, insn) state.GetRegistersRef()[rsReg] = c.rs state.GetRegistersRef()[rtReg] = c.rt } diff --git a/cannon/mipsevm/tests/fuzz_evm_common_test.go b/cannon/mipsevm/tests/fuzz_evm_common_test.go index fa23a26ed3b..b475f9508b8 100644 --- a/cannon/mipsevm/tests/fuzz_evm_common_test.go +++ b/cannon/mipsevm/tests/fuzz_evm_common_test.go @@ -24,9 +24,9 @@ const syscallInsn = uint32(0x00_00_00_0c) func FuzzStateSyscallBrk(f *testing.F) { vms := GetMipsVersionTestCases(f) - initState := func(t require.TestingT, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { state.GetRegistersRef()[2] = arch.SysBrk - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) } setExpectations := func(t require.TestingT, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -59,12 +59,12 @@ func FuzzStateSyscallMmap(f *testing.F) { heap Word } - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { state.Heap = c.heap state.GetRegistersRef()[2] = arch.SysMmap state.GetRegistersRef()[4] = c.addr state.GetRegistersRef()[5] = c.siz - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) } setExpectations := func(t require.TestingT, c testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -106,10 +106,10 @@ func FuzzStateSyscallExitGroup(f *testing.F) { exitCode uint8 } - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { state.GetRegistersRef()[2] = arch.SysExitGroup state.GetRegistersRef()[4] = Word(c.exitCode) - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) } setExpectations := func(t require.TestingT, c testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -137,11 +137,11 @@ func FuzzStateSyscallFcntl(f *testing.F) { cmd Word } - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { state.GetRegistersRef()[2] = arch.SysFcntl state.GetRegistersRef()[4] = c.fd state.GetRegistersRef()[5] = c.cmd - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) } setExpectations := func(t require.TestingT, c testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -194,13 +194,13 @@ func FuzzStateHintRead(f *testing.F) { preimageData := []byte("hello world") preimageKey := preimage.Keccak256Key(crypto.Keccak256Hash(preimageData)).PreimageKey() - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { state.PreimageKey = preimageKey state.GetRegistersRef()[2] = arch.SysRead state.GetRegistersRef()[4] = exec.FdHintRead state.GetRegistersRef()[5] = c.addr state.GetRegistersRef()[6] = c.count - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) } setExpectations := func(t require.TestingT, c testCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -242,7 +242,7 @@ func FuzzStatePreimageRead(f *testing.F) { preimageValue := []byte("hello world") preimageData := mtutil.AddPreimageLengthPrefix(preimageValue) preimageKey := preimage.Keccak256Key(crypto.Keccak256Hash(preimageValue)).PreimageKey() - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { state.PreimageKey = preimageKey state.PreimageOffset = c.preimageOffset state.GetCurrentThread().Cpu.PC = c.pc @@ -251,7 +251,7 @@ func FuzzStatePreimageRead(f *testing.F) { state.GetRegistersRef()[4] = exec.FdPreimageRead state.GetRegistersRef()[5] = c.addr state.GetRegistersRef()[6] = c.count - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetMemory().SetWord(testutil.EffAddr(c.addr), preexistingMemoryVal) } @@ -361,14 +361,14 @@ func FuzzStateHintWrite(f *testing.F) { } } - initState := func(t require.TestingT, c *testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c *testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { cacheHintCalculations(t, c) state.LastHint = c.lastHint state.GetRegistersRef()[2] = arch.SysWrite state.GetRegistersRef()[4] = exec.FdHintWrite state.GetRegistersRef()[5] = c.addr state.GetRegistersRef()[6] = c.count - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) err := state.GetMemory().SetMemoryRange(c.addr, bytes.NewReader(c.hintData[int(len(c.lastHint)):])) require.NoError(t, err) } @@ -426,12 +426,12 @@ func FuzzStatePreimageWrite(f *testing.F) { preexistingMemoryVal := [8]byte{0x12, 0x34, 0x56, 0x78, 0x87, 0x65, 0x43, 0x21} preimageData := []byte("hello world") preimageKey := preimage.Keccak256Key(crypto.Keccak256Hash(preimageData)).PreimageKey() - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { state.GetRegistersRef()[2] = arch.SysWrite state.GetRegistersRef()[4] = exec.FdPreimageWrite state.GetRegistersRef()[5] = c.addr state.GetRegistersRef()[6] = c.count - testutil.StoreInstruction(state.GetMemory(), state.GetPC(), syscallInsn) + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetMemory().SetWord(testutil.EffAddr(c.addr), arch.ByteOrderWord.Word(preexistingMemoryVal[:])) } diff --git a/cannon/mipsevm/tests/fuzz_evm_multithreaded_test.go b/cannon/mipsevm/tests/fuzz_evm_multithreaded_test.go index d718e373d07..56933430c62 100644 --- a/cannon/mipsevm/tests/fuzz_evm_multithreaded_test.go +++ b/cannon/mipsevm/tests/fuzz_evm_multithreaded_test.go @@ -5,6 +5,7 @@ import ( "github.com/stretchr/testify/require" + "github.com/ethereum-optimism/optimism/cannon/mipsevm" "github.com/ethereum-optimism/optimism/cannon/mipsevm/arch" "github.com/ethereum-optimism/optimism/cannon/mipsevm/exec" "github.com/ethereum-optimism/optimism/cannon/mipsevm/multithreaded" @@ -20,7 +21,7 @@ func FuzzStateSyscallCloneMT(f *testing.F) { stackPtr Word } - initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, c testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { // Update existing threads to avoid collision with nextThreadId if mtutil.FindThread(state, c.nextThreadId) != nil { for i, t := range mtutil.GetAllThreads(state) { diff --git a/cannon/mipsevm/tests/testfuncs_test.go b/cannon/mipsevm/tests/testfuncs_test.go index b42b78d4ec0..797f1f8919b 100644 --- a/cannon/mipsevm/tests/testfuncs_test.go +++ b/cannon/mipsevm/tests/testfuncs_test.go @@ -6,6 +6,7 @@ import ( "github.com/stretchr/testify/require" + "github.com/ethereum-optimism/optimism/cannon/mipsevm" "github.com/ethereum-optimism/optimism/cannon/mipsevm/arch" "github.com/ethereum-optimism/optimism/cannon/mipsevm/exec" "github.com/ethereum-optimism/optimism/cannon/mipsevm/multithreaded" @@ -43,7 +44,7 @@ func testOperators(t *testing.T, testCases []operatorTestCase, mips32Insn bool) rtReg := uint32(8) rdReg := uint32(18) - initState := func(t require.TestingT, tt operatorTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt operatorTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { var insn uint32 var baseReg uint32 = 17 if tt.isImm { @@ -55,7 +56,7 @@ func testOperators(t *testing.T, testCases []operatorTestCase, mips32Insn bool) state.GetRegistersRef()[baseReg] = tt.rs state.GetRegistersRef()[rtReg] = tt.rt } - testutil.StoreInstruction(state.GetMemory(), pc, insn) + storeInsnWithCache(state, goVm, pc, insn) } setExpectations := func(t require.TestingT, tt operatorTestCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -110,11 +111,11 @@ func testMulDiv(t *testing.T, templateCases []mulDivTestCase, mips32Insn bool) { rtReg := uint32(0xa) pc := arch.Word(0) - initState := func(t require.TestingT, tt mulDivTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt mulDivTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { insn := tt.opcode<<26 | baseReg<<21 | rtReg<<16 | tt.rdReg<<11 | tt.funct state.GetRegistersRef()[rtReg] = tt.rt state.GetRegistersRef()[baseReg] = tt.rs - testutil.StoreInstruction(state.GetMemory(), pc, insn) + storeInsnWithCache(state, goVm, pc, insn) } setExpectations := func(t require.TestingT, tt mulDivTestCase, expected *mtutil.ExpectedState, vm VersionedVMTestCase) ExpectedExecResult { @@ -163,10 +164,10 @@ func testLoadStore(t *testing.T, cases []loadStoreTestCase) { rtReg := uint32(8) pc := arch.Word(0) - initState := func(t require.TestingT, tt loadStoreTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt loadStoreTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { insn := tt.opcode<<26 | baseReg<<21 | rtReg<<16 | tt.imm - testutil.StoreInstruction(state.GetMemory(), pc, insn) + storeInsnWithCache(state, goVm, pc, insn) state.GetMemory().SetWord(tt.effAddr(), tt.memVal) state.GetRegistersRef()[rtReg] = tt.rt state.GetRegistersRef()[baseReg] = tt.base @@ -204,13 +205,13 @@ func (t branchTestCase) Name() string { } func testBranch(t *testing.T, cases []branchTestCase) { - initState := func(t require.TestingT, tt branchTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { + initState := func(t require.TestingT, tt branchTestCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { const rsReg = 8 // t0 insn := tt.opcode<<26 | rsReg<<21 | tt.regimm<<16 | uint32(tt.offset) state.GetCurrentThread().Cpu.PC = tt.pc state.GetCurrentThread().Cpu.NextPC = tt.pc + 4 - testutil.StoreInstruction(state.GetMemory(), tt.pc, insn) + storeInsnWithCache(state, goVm, tt.pc, insn) state.GetRegistersRef()[rsReg] = Word(tt.rs) } @@ -245,8 +246,8 @@ func testNoopSyscall(t *testing.T, vm VersionedVMTestCase, syscalls map[string]u cases = append(cases, testCase{name: name, sycallNum: arch.Word(syscallNum)}) } - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = tt.sycallNum // Set syscall number } @@ -280,8 +281,8 @@ func testUnsupportedSyscall(t *testing.T, vm VersionedVMTestCase, unsupportedSys cases = append(cases, testCase{name: name, sycallNum: arch.Word(syscallNum)}) } - initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper) { - testutil.StoreInstruction(state.Memory, state.GetPC(), syscallInsn) + initState := func(t require.TestingT, tt testCase, state *multithreaded.State, vm VersionedVMTestCase, r *testutil.RandHelper, goVm mipsevm.FPVM) { + storeInsnWithCache(state, goVm, state.GetPC(), syscallInsn) state.GetRegistersRef()[2] = tt.sycallNum // Set syscall number } diff --git a/cannon/mipsevm/versions/state.go b/cannon/mipsevm/versions/state.go index 3c02599e2f9..e325e93c75d 100644 --- a/cannon/mipsevm/versions/state.go +++ b/cannon/mipsevm/versions/state.go @@ -27,6 +27,14 @@ func LoadStateFromFile(path string) (*VersionedState, error) { return serialize.LoadSerializedBinary[VersionedState](path) } +func LoadStateFromFileWithLargeICache(path string) (*VersionedStateWithLargeICache, error) { + if !serialize.IsBinaryFile(path) { + // JSON states are always singlethreaded v1 which is no longer supported + return nil, fmt.Errorf("%w: %s", ErrUnsupportedVersion, VersionSingleThreaded) + } + return serialize.LoadSerializedBinary[VersionedStateWithLargeICache](path) +} + func NewFromState(vers StateVersion, state mipsevm.FPVMState) (*VersionedState, error) { switch state := state.(type) { case *multithreaded.State: @@ -61,11 +69,6 @@ func (s *VersionedState) CreateVM(logger log.Logger, po mipsevm.PreimageOracle, func FeaturesForVersion(version StateVersion) mipsevm.FeatureToggles { features := mipsevm.FeatureToggles{} // Set any required feature toggles based on the state version here. - if version >= VersionMultiThreaded64_v4 { - features.SupportMinimalSysEventFd2 = true - features.SupportDclzDclo = true - features.SupportNoopMprotect = true - } if version >= VersionMultiThreaded64_v5 { features.SupportWorkingSysGetRandom = true } @@ -106,3 +109,29 @@ func (s *VersionedState) Deserialize(in io.Reader) error { func (s *VersionedState) MarshalJSON() ([]byte, error) { return nil, fmt.Errorf("%w for type %T", ErrJsonNotSupported, s.FPVMState) } + +// VersionedStateWithLargeICache is a VersionedState that allocates a large memory region for the i-cache. +type VersionedStateWithLargeICache struct { + VersionedState +} + +func (s *VersionedStateWithLargeICache) Deserialize(in io.Reader) error { + bin := serialize.NewBinaryReader(in) + if err := bin.ReadUInt(&s.Version); err != nil { + return err + } + + if IsSupportedMultiThreaded64(s.Version) { + if arch.IsMips32 { + return ErrUnsupportedMipsArch + } + state := &multithreaded.State{UseLargeICache: true} + if err := state.Deserialize(in); err != nil { + return err + } + s.FPVMState = state + return nil + } else { + return fmt.Errorf("%w: %d", ErrUnknownVersion, s.Version) + } +} diff --git a/cannon/testdata/go-1-23/alloc/go.mod b/cannon/testdata/go-1-23/alloc/go.mod index bed95427d2c..9cd0eb04f31 100644 --- a/cannon/testdata/go-1-23/alloc/go.mod +++ b/cannon/testdata/go-1-23/alloc/go.mod @@ -7,8 +7,8 @@ toolchain go1.23.8 require github.com/ethereum-optimism/optimism v0.0.0 require ( - golang.org/x/crypto v0.35.0 // indirect - golang.org/x/sys v0.30.0 // indirect + golang.org/x/crypto v0.36.0 // indirect + golang.org/x/sys v0.31.0 // indirect ) replace github.com/ethereum-optimism/optimism v0.0.0 => ./../../../.. diff --git a/cannon/testdata/go-1-23/alloc/go.sum b/cannon/testdata/go-1-23/alloc/go.sum index ae65245462a..a52ee74a11e 100644 --- a/cannon/testdata/go-1-23/alloc/go.sum +++ b/cannon/testdata/go-1-23/alloc/go.sum @@ -4,9 +4,9 @@ github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRI github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= -golang.org/x/crypto v0.35.0 h1:b15kiHdrGCHrP6LvwaQ3c03kgNhhiMgvlhxHQhmg2Xs= -golang.org/x/crypto v0.35.0/go.mod h1:dy7dXNW32cAb/6/PRuTNsix8T+vJAqvuIy5Bli/x0YQ= -golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= -golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/crypto v0.36.0 h1:AnAEvhDddvBdpY+uR+MyHmuZzzNqXSe/GvuDeob5L34= +golang.org/x/crypto v0.36.0/go.mod h1:Y4J0ReaxCR1IMaabaSMugxJES1EpwhBHhv2bDHklZvc= +golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik= +golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/cannon/testdata/go-1-23/claim/go.mod b/cannon/testdata/go-1-23/claim/go.mod index b18045136a2..de70a6a890e 100644 --- a/cannon/testdata/go-1-23/claim/go.mod +++ b/cannon/testdata/go-1-23/claim/go.mod @@ -7,8 +7,8 @@ toolchain go1.23.8 require github.com/ethereum-optimism/optimism v0.0.0 require ( - golang.org/x/crypto v0.35.0 // indirect - golang.org/x/sys v0.30.0 // indirect + golang.org/x/crypto v0.36.0 // indirect + golang.org/x/sys v0.31.0 // indirect ) replace github.com/ethereum-optimism/optimism v0.0.0 => ./../../../.. diff --git a/cannon/testdata/go-1-23/claim/go.sum b/cannon/testdata/go-1-23/claim/go.sum index ae65245462a..a52ee74a11e 100644 --- a/cannon/testdata/go-1-23/claim/go.sum +++ b/cannon/testdata/go-1-23/claim/go.sum @@ -4,9 +4,9 @@ github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRI github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= -golang.org/x/crypto v0.35.0 h1:b15kiHdrGCHrP6LvwaQ3c03kgNhhiMgvlhxHQhmg2Xs= -golang.org/x/crypto v0.35.0/go.mod h1:dy7dXNW32cAb/6/PRuTNsix8T+vJAqvuIy5Bli/x0YQ= -golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= -golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/crypto v0.36.0 h1:AnAEvhDddvBdpY+uR+MyHmuZzzNqXSe/GvuDeob5L34= +golang.org/x/crypto v0.36.0/go.mod h1:Y4J0ReaxCR1IMaabaSMugxJES1EpwhBHhv2bDHklZvc= +golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik= +golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/cannon/testdata/go-1-24/alloc/go.mod b/cannon/testdata/go-1-24/alloc/go.mod index 9dd982e7ad7..2ba7887a35a 100644 --- a/cannon/testdata/go-1-24/alloc/go.mod +++ b/cannon/testdata/go-1-24/alloc/go.mod @@ -7,8 +7,8 @@ toolchain go1.24.2 require github.com/ethereum-optimism/optimism v0.0.0 require ( - golang.org/x/crypto v0.35.0 // indirect - golang.org/x/sys v0.30.0 // indirect + golang.org/x/crypto v0.36.0 // indirect + golang.org/x/sys v0.31.0 // indirect ) replace github.com/ethereum-optimism/optimism v0.0.0 => ./../../../.. diff --git a/cannon/testdata/go-1-24/alloc/go.sum b/cannon/testdata/go-1-24/alloc/go.sum index ae65245462a..a52ee74a11e 100644 --- a/cannon/testdata/go-1-24/alloc/go.sum +++ b/cannon/testdata/go-1-24/alloc/go.sum @@ -4,9 +4,9 @@ github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRI github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= -golang.org/x/crypto v0.35.0 h1:b15kiHdrGCHrP6LvwaQ3c03kgNhhiMgvlhxHQhmg2Xs= -golang.org/x/crypto v0.35.0/go.mod h1:dy7dXNW32cAb/6/PRuTNsix8T+vJAqvuIy5Bli/x0YQ= -golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= -golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/crypto v0.36.0 h1:AnAEvhDddvBdpY+uR+MyHmuZzzNqXSe/GvuDeob5L34= +golang.org/x/crypto v0.36.0/go.mod h1:Y4J0ReaxCR1IMaabaSMugxJES1EpwhBHhv2bDHklZvc= +golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik= +golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/cannon/testdata/go-1-24/claim/go.mod b/cannon/testdata/go-1-24/claim/go.mod index 9c2fbdba885..aec47900e8f 100644 --- a/cannon/testdata/go-1-24/claim/go.mod +++ b/cannon/testdata/go-1-24/claim/go.mod @@ -7,8 +7,8 @@ toolchain go1.24.2 require github.com/ethereum-optimism/optimism v0.0.0 require ( - golang.org/x/crypto v0.35.0 // indirect - golang.org/x/sys v0.30.0 // indirect + golang.org/x/crypto v0.36.0 // indirect + golang.org/x/sys v0.31.0 // indirect ) replace github.com/ethereum-optimism/optimism v0.0.0 => ./../../../.. diff --git a/cannon/testdata/go-1-24/claim/go.sum b/cannon/testdata/go-1-24/claim/go.sum index ae65245462a..a52ee74a11e 100644 --- a/cannon/testdata/go-1-24/claim/go.sum +++ b/cannon/testdata/go-1-24/claim/go.sum @@ -4,9 +4,9 @@ github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRI github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= -golang.org/x/crypto v0.35.0 h1:b15kiHdrGCHrP6LvwaQ3c03kgNhhiMgvlhxHQhmg2Xs= -golang.org/x/crypto v0.35.0/go.mod h1:dy7dXNW32cAb/6/PRuTNsix8T+vJAqvuIy5Bli/x0YQ= -golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= -golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/crypto v0.36.0 h1:AnAEvhDddvBdpY+uR+MyHmuZzzNqXSe/GvuDeob5L34= +golang.org/x/crypto v0.36.0/go.mod h1:Y4J0ReaxCR1IMaabaSMugxJES1EpwhBHhv2bDHklZvc= +golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik= +golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/devnet-sdk/testing/testlib/validators/forks.go b/devnet-sdk/testing/testlib/validators/forks.go index 33c685ad51a..f60dcaa2e73 100644 --- a/devnet-sdk/testing/testlib/validators/forks.go +++ b/devnet-sdk/testing/testlib/validators/forks.go @@ -62,6 +62,8 @@ func IsForkActivated(c *params.ChainConfig, forkName rollup.ForkName, timestamp return c.IsOptimismHolocene(timestamp), nil case rollup.Isthmus: return c.IsOptimismIsthmus(timestamp), nil + case rollup.Jovian: + return c.IsOptimismJovian(timestamp), nil case rollup.Interop: return c.IsInterop(timestamp), nil default: diff --git a/docs/security-reviews/2025_06-Cannon-3DOC.pdf b/docs/security-reviews/2025_06-Cannon-3DOC.pdf index c3bff38beed..7251800fe61 100644 Binary files a/docs/security-reviews/2025_06-Cannon-3DOC.pdf and b/docs/security-reviews/2025_06-Cannon-3DOC.pdf differ diff --git a/go.mod b/go.mod index d2df6e7cf5f..cd37b469d03 100644 --- a/go.mod +++ b/go.mod @@ -13,7 +13,7 @@ require ( github.com/btcsuite/btcd/chaincfg/chainhash v1.1.0 github.com/cockroachdb/pebble v1.1.5 github.com/coder/websocket v1.8.13 - github.com/consensys/gnark-crypto v0.16.0 + github.com/consensys/gnark-crypto v0.18.0 github.com/crate-crypto/go-kzg-4844 v1.1.0 github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc github.com/decred/dcrd/dcrec/secp256k1/v4 v4.3.0 @@ -64,11 +64,11 @@ require ( github.com/urfave/cli/v2 v2.27.6 go.opentelemetry.io/otel v1.34.0 go.opentelemetry.io/otel/trace v1.34.0 - golang.org/x/crypto v0.35.0 + golang.org/x/crypto v0.36.0 golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c golang.org/x/mod v0.22.0 golang.org/x/sync v0.14.0 - golang.org/x/term v0.29.0 + golang.org/x/term v0.30.0 golang.org/x/text v0.25.0 golang.org/x/time v0.11.0 gonum.org/v1/plot v0.16.0 @@ -102,7 +102,6 @@ require ( github.com/cockroachdb/logtags v0.0.0-20230118201751-21c54148d20b // indirect github.com/cockroachdb/redact v1.1.5 // indirect github.com/cockroachdb/tokenbucket v0.0.0-20230807174530-cc333fc44b06 // indirect - github.com/consensys/bavard v0.1.27 // indirect github.com/containerd/cgroups v1.1.0 // indirect github.com/containerd/log v0.1.0 // indirect github.com/coreos/go-systemd/v22 v22.5.0 // indirect @@ -121,11 +120,12 @@ require ( github.com/dsnet/compress v0.0.2-0.20210315054119-f66993602bf5 // indirect github.com/dustin/go-humanize v1.0.1 // indirect github.com/elastic/gosigar v0.14.3 // indirect + github.com/emicklei/dot v1.6.2 // indirect github.com/ethereum/c-kzg-4844/v2 v2.1.0 // indirect github.com/ethereum/go-verkle v0.2.2 // indirect github.com/felixge/fgprof v0.9.5 // indirect github.com/felixge/httpsnoop v1.0.4 // indirect - github.com/ferranbt/fastssz v0.1.2 // indirect + github.com/ferranbt/fastssz v0.1.4 // indirect github.com/flynn/noise v1.1.0 // indirect github.com/francoispqt/gojay v1.2.13 // indirect github.com/gballet/go-libpcsclite v0.0.0-20191108122812-4678299bea08 // indirect @@ -139,7 +139,7 @@ require ( github.com/go-yaml/yaml v2.1.0+incompatible // indirect github.com/goccy/go-json v0.10.4 // indirect github.com/godbus/dbus/v5 v5.1.0 // indirect - github.com/gofrs/flock v0.8.1 // indirect + github.com/gofrs/flock v0.12.1 // indirect github.com/gogo/protobuf v1.3.2 // indirect github.com/golang-jwt/jwt/v4 v4.5.2 // indirect github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0 // indirect @@ -197,7 +197,6 @@ require ( github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db // indirect github.com/mitchellh/mapstructure v1.5.0 // indirect github.com/mitchellh/pointerstructure v1.2.1 // indirect - github.com/mmcloughlin/addchain v0.4.0 // indirect github.com/moby/docker-image-spec v1.3.1 // indirect github.com/moby/term v0.5.2 // indirect github.com/morikuni/aec v1.0.0 // indirect @@ -290,8 +289,8 @@ require ( go.uber.org/multierr v1.11.0 // indirect go.uber.org/zap v1.27.0 // indirect golang.org/x/image v0.25.0 // indirect - golang.org/x/net v0.36.0 // indirect - golang.org/x/sys v0.30.0 // indirect + golang.org/x/net v0.38.0 // indirect + golang.org/x/sys v0.31.0 // indirect golang.org/x/tools v0.29.0 // indirect google.golang.org/genproto/googleapis/api v0.0.0-20250115164207-1a7da9e5054f // indirect google.golang.org/genproto/googleapis/rpc v0.0.0-20250115164207-1a7da9e5054f // indirect @@ -301,15 +300,13 @@ require ( gopkg.in/yaml.v2 v2.4.0 // indirect gotest.tools/v3 v3.5.2 // indirect lukechampine.com/blake3 v1.3.0 // indirect - rsc.io/tmplfunc v0.0.3 // indirect ) -replace github.com/ethereum/go-ethereum => github.com/ethereum-optimism/op-geth v1.101511.1-dev.1.0.20250710181308-c6e05723600e +replace github.com/ethereum/go-ethereum => github.com/ethereum-optimism/op-geth v1.101602.3-0.20250911204325-7beb36e65e58 -//replace github.com/ethereum/go-ethereum => ../op-geth +// replace github.com/ethereum/go-ethereum => ../op-geth // replace github.com/ethereum-optimism/superchain-registry/superchain => ../superchain-registry/superchain - // This release keeps breaking Go builds. Stop that. exclude ( github.com/kataras/iris/v12 v12.2.0-beta5 diff --git a/go.sum b/go.sum index e078da3a917..849248091bc 100644 --- a/go.sum +++ b/go.sum @@ -150,10 +150,8 @@ github.com/cockroachdb/tokenbucket v0.0.0-20230807174530-cc333fc44b06 h1:zuQyyAK github.com/cockroachdb/tokenbucket v0.0.0-20230807174530-cc333fc44b06/go.mod h1:7nc4anLGjupUW/PeY5qiNYsdNXj7zopG+eqsS7To5IQ= github.com/coder/websocket v1.8.13 h1:f3QZdXy7uGVz+4uCJy2nTZyM0yTBj8yANEHhqlXZ9FE= github.com/coder/websocket v1.8.13/go.mod h1:LNVeNrXQZfe5qhS9ALED3uA+l5pPqvwXg3CKoDBB2gs= -github.com/consensys/bavard v0.1.27 h1:j6hKUrGAy/H+gpNrpLU3I26n1yc+VMGmd6ID5+gAhOs= -github.com/consensys/bavard v0.1.27/go.mod h1:k/zVjHHC4B+PQy1Pg7fgvG3ALicQw540Crag8qx+dZs= -github.com/consensys/gnark-crypto v0.16.0 h1:8Dl4eYmUWK9WmlP1Bj6je688gBRJCJbT8Mw4KoTAawo= -github.com/consensys/gnark-crypto v0.16.0/go.mod h1:Ke3j06ndtPTVvo++PhGNgvm+lgpLvzbcE2MqljY7diU= +github.com/consensys/gnark-crypto v0.18.0 h1:vIye/FqI50VeAr0B3dx+YjeIvmc3LWz4yEfbWBpTUf0= +github.com/consensys/gnark-crypto v0.18.0/go.mod h1:L3mXGFTe1ZN+RSJ+CLjUt9x7PNdx8ubaYfDROyp2Z8c= github.com/containerd/cgroups v0.0.0-20201119153540-4cbc285b3327/go.mod h1:ZJeTFisyysqgcCdecO57Dj79RfL0LNeGiFUqLYQRYLE= github.com/containerd/cgroups v1.1.0 h1:v8rEWFl6EoqHB+swVNjVoCJE8o3jX7e8nqBGPLaDFBM= github.com/containerd/cgroups v1.1.0/go.mod h1:6ppBcbh/NOOUU+dMKrykgaBnK9lCIBxHqJDGwsa1mIw= @@ -226,10 +224,12 @@ github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+m github.com/elastic/gosigar v0.12.0/go.mod h1:iXRIGg2tLnu7LBdpqzyQfGDEidKCfWcCMS0WKyPWoMs= github.com/elastic/gosigar v0.14.3 h1:xwkKwPia+hSfg9GqrCUKYdId102m9qTJIIr7egmK/uo= github.com/elastic/gosigar v0.14.3/go.mod h1:iXRIGg2tLnu7LBdpqzyQfGDEidKCfWcCMS0WKyPWoMs= +github.com/emicklei/dot v1.6.2 h1:08GN+DD79cy/tzN6uLCT84+2Wk9u+wvqP+Hkx/dIR8A= +github.com/emicklei/dot v1.6.2/go.mod h1:DeV7GvQtIw4h2u73RKBkkFdvVAz0D9fzeJrgPW6gy/s= github.com/ethereum-optimism/go-ethereum-hdwallet v0.1.3 h1:RWHKLhCrQThMfch+QJ1Z8veEq5ZO3DfIhZ7xgRP9WTc= github.com/ethereum-optimism/go-ethereum-hdwallet v0.1.3/go.mod h1:QziizLAiF0KqyLdNJYD7O5cpDlaFMNZzlxYNcWsJUxs= -github.com/ethereum-optimism/op-geth v1.101511.1-dev.1.0.20250710181308-c6e05723600e h1:Ur5vjH2RmYqspDBIZH4RymNB6viHFheZkvvHt9W3spQ= -github.com/ethereum-optimism/op-geth v1.101511.1-dev.1.0.20250710181308-c6e05723600e/go.mod h1:SkytozVEPtnUeBlquwl0Qv5JKvrN/Y5aqh+VkQo/EOI= +github.com/ethereum-optimism/op-geth v1.101602.3-0.20250911204325-7beb36e65e58 h1:6meh1zYaIVBxDomHTtzVaMSgQzg/kQICQ7JC9tc0/TA= +github.com/ethereum-optimism/op-geth v1.101602.3-0.20250911204325-7beb36e65e58/go.mod h1:rOTZfq3JrsY8ktvTnS6XT9X+t4WQQ42zFb+hzXua2EU= github.com/ethereum-optimism/superchain-registry/validation v0.0.0-20250603144016-9c45ca7d4508 h1:A/3QVFt+Aa9ozpPVXxUTLui8honBjSusAaiCVRbafgs= github.com/ethereum-optimism/superchain-registry/validation v0.0.0-20250603144016-9c45ca7d4508/go.mod h1:NZ816PzLU1TLv1RdAvYAb6KWOj4Zm5aInT0YpDVml2Y= github.com/ethereum/c-kzg-4844/v2 v2.1.0 h1:gQropX9YFBhl3g4HYhwE70zq3IHFRgbbNPw0Shwzf5w= @@ -244,8 +244,8 @@ github.com/felixge/fgprof v0.9.5 h1:8+vR6yu2vvSKn08urWyEuxx75NWPEvybbkBirEpsbVY= github.com/felixge/fgprof v0.9.5/go.mod h1:yKl+ERSa++RYOs32d8K6WEXCB4uXdLls4ZaZPpayhMM= github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2Wg= github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U= -github.com/ferranbt/fastssz v0.1.2 h1:Dky6dXlngF6Qjc+EfDipAkE83N5I5DE68bY6O0VLNPk= -github.com/ferranbt/fastssz v0.1.2/go.mod h1:X5UPrE2u1UJjxHA8X54u04SBwdAQjG2sFtWs39YxyWs= +github.com/ferranbt/fastssz v0.1.4 h1:OCDB+dYDEQDvAgtAGnTSidK1Pe2tW3nFV40XyMkTeDY= +github.com/ferranbt/fastssz v0.1.4/go.mod h1:Ea3+oeoRGGLGm5shYAeDgu6PGUlcvQhE2fILyD9+tGg= github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc= github.com/flynn/noise v1.1.0 h1:KjPQoQCEFdZDiP03phOvGi11+SVVhBG2wOWAorLsstg= github.com/flynn/noise v1.1.0/go.mod h1:xbMo+0i6+IGbYdJhF31t2eR1BIU0CYc12+BNAKwUTag= @@ -306,8 +306,8 @@ github.com/godbus/dbus/v5 v5.0.3/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5x github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk= github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= -github.com/gofrs/flock v0.8.1 h1:+gYjHKf32LDeiEEFhQaotPbLuUXjY5ZqxKgXy7n59aw= -github.com/gofrs/flock v0.8.1/go.mod h1:F1TvTiK9OcQqauNUHlbJvyl9Qa1QvF/gOUDKA14jxHU= +github.com/gofrs/flock v0.12.1 h1:MTLVXXHf8ekldpJk3AKicLij9MdwOWkZ+a/jHHZby9E= +github.com/gofrs/flock v0.12.1/go.mod h1:9zxTsyu5xtJ9DK+1tFZyibEV7y3uwDxPPfbxeeHCoD0= github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= github.com/gogo/protobuf v1.3.1/go.mod h1:SlYgWuQ5SjCEi6WLHjHCa1yvBfUnHcTbrrZtXPKa29o= github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= @@ -366,7 +366,6 @@ github.com/google/pprof v0.0.0-20240227163752-401108e1b7e7/go.mod h1:czg5+yv1E0Z github.com/google/pprof v0.0.0-20241009165004-a3522334989c h1:NDovD0SMpBYXlE1zJmS1q55vWB/fUQBcPAqAboZSccA= github.com/google/pprof v0.0.0-20241009165004-a3522334989c/go.mod h1:vavhavw2zAxS5dIdcRluK6cSGGPlZynqzFM8NdvU144= github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI= -github.com/google/subcommands v1.2.0/go.mod h1:ZjhPrFU+Olkh9WazFPsl27BQ4UPiG37m3yTrtFlrHVk= github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/google/uuid v1.3.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= @@ -604,9 +603,6 @@ github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyua github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= github.com/mitchellh/pointerstructure v1.2.1 h1:ZhBBeX8tSlRpu/FFhXH4RC4OJzFlqsQhoHZAz4x7TIw= github.com/mitchellh/pointerstructure v1.2.1/go.mod h1:BRAsLI5zgXmw97Lf6s25bs8ohIXc3tViBH44KcwB2g4= -github.com/mmcloughlin/addchain v0.4.0 h1:SobOdjm2xLj1KkXN5/n0xTIWyZA2+s99UCY1iPfkHRY= -github.com/mmcloughlin/addchain v0.4.0/go.mod h1:A86O+tHqZLMNO4w6ZZ4FlVQEadcoqkyU72HC5wJ4RlU= -github.com/mmcloughlin/profile v0.1.1/go.mod h1:IhHD7q1ooxgwTgjxQYkACGA77oFTDdFVejUS1/tS/qU= github.com/moby/docker-image-spec v1.3.1 h1:jMKff3w6PgbfSa69GfNg+zN/XLhfXJGnEx3Nl2EsFP0= github.com/moby/docker-image-spec v1.3.1/go.mod h1:eKmb5VW8vQEh/BAr2yvVNvuiJuY6UIocYsFu/DxxRpo= github.com/moby/term v0.5.2 h1:6qk3FJAFDs6i/q3W/pQ97SX192qKfZgGjCQqfCJkgzQ= @@ -789,8 +785,8 @@ github.com/prometheus/procfs v0.15.1 h1:YagwOFzUgYfKKHX6Dr+sHT7km/hxC76UB0leargg github.com/prometheus/procfs v0.15.1/go.mod h1:fB45yRUv8NstnjriLhBQLuOUt+WW4BsoGhij/e3PBqk= github.com/protolambda/ctxlock v0.1.0 h1:rCUY3+vRdcdZXqT07iXgyr744J2DU2LCBIXowYAjBCE= github.com/protolambda/ctxlock v0.1.0/go.mod h1:vefhX6rIZH8rsg5ZpOJfEDYQOppZi19SfPiGOFrNnwM= -github.com/prysmaticlabs/gohashtree v0.0.1-alpha.0.20220714111606-acbb2962fb48 h1:cSo6/vk8YpvkLbk9v3FO97cakNmUoxwi2KMP8hd5WIw= -github.com/prysmaticlabs/gohashtree v0.0.1-alpha.0.20220714111606-acbb2962fb48/go.mod h1:4pWaT30XoEx1j8KNJf3TV+E3mQkaufn7mf+jRNb/Fuk= +github.com/prysmaticlabs/gohashtree v0.0.4-beta h1:H/EbCuXPeTV3lpKeXGPpEV9gsUpkqOOVnWapUyeWro4= +github.com/prysmaticlabs/gohashtree v0.0.4-beta/go.mod h1:BFdtALS+Ffhg3lGQIHv9HDWuHS8cTvHZzrHWxwOtGOs= github.com/quic-go/qpack v0.4.0 h1:Cr9BXA1sQS2SmDUWjSofMPNKmvF6IiIfDRmgU0w1ZCo= github.com/quic-go/qpack v0.4.0/go.mod h1:UZVnYIfi5GRk+zI9UMaCPsmZ2xKJP7XBUvVyT1Knj9A= github.com/quic-go/quic-go v0.46.0 h1:uuwLClEEyk1DNvchH8uCByQVjo3yKL9opKulExNDs7Y= @@ -998,8 +994,8 @@ golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5y golang.org/x/crypto v0.8.0/go.mod h1:mRqEX+O9/h5TFCrQhkgjo2yKi0yYA+9ecGkdQoHrywE= golang.org/x/crypto v0.12.0/go.mod h1:NF0Gs7EO5K4qLn+Ylc+fih8BSTeIjAP05siRnAh98yw= golang.org/x/crypto v0.18.0/go.mod h1:R0j02AL6hcrfOiy9T4ZYp/rcWeMxM3L6QYxlOuEG1mg= -golang.org/x/crypto v0.35.0 h1:b15kiHdrGCHrP6LvwaQ3c03kgNhhiMgvlhxHQhmg2Xs= -golang.org/x/crypto v0.35.0/go.mod h1:dy7dXNW32cAb/6/PRuTNsix8T+vJAqvuIy5Bli/x0YQ= +golang.org/x/crypto v0.36.0 h1:AnAEvhDddvBdpY+uR+MyHmuZzzNqXSe/GvuDeob5L34= +golang.org/x/crypto v0.36.0/go.mod h1:Y4J0ReaxCR1IMaabaSMugxJES1EpwhBHhv2bDHklZvc= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c h1:7dEasQXItcW1xKJ2+gg5VOiBnqWrJc+rq0DPKyvvdbY= golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c/go.mod h1:NQtJDoLvd6faHhE7m4T/1IY708gDefGGjR/iUW8yQQ8= @@ -1052,8 +1048,8 @@ golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns= golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= golang.org/x/net v0.14.0/go.mod h1:PpSgVXXLK0OxS0F31C1/tv6XNguvCrnXIDrFMspZIUI= golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY= -golang.org/x/net v0.36.0 h1:vWF2fRbw4qslQsQzgFqZff+BItCvGFQqKzKIzx1rmoA= -golang.org/x/net v0.36.0/go.mod h1:bFmbeoIPfrw4sMHNhb4J9f6+tPziuGjq7Jk/38fxi1I= +golang.org/x/net v0.38.0 h1:vRMAPTMaeGqVhG5QyLJHqNDwecKTomGeqbnfZyKlBI8= +golang.org/x/net v0.38.0/go.mod h1:ivrbrMbzFq5J41QOQh0siUuly180yBYtLp+CKbEaFx8= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20181017192945-9dcd33a902f4/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20181203162652-d668ce993890/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= @@ -1135,8 +1131,8 @@ golang.org/x/sys v0.9.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.14.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= -golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik= +golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= @@ -1145,8 +1141,8 @@ golang.org/x/term v0.7.0/go.mod h1:P32HKFT3hSsZrRxla30E9HqToFYAQPCMs/zFMBUFqPY= golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= golang.org/x/term v0.11.0/go.mod h1:zC9APTIj3jG3FdV/Ons+XE1riIZXG4aZ4GTHiPZJPIU= golang.org/x/term v0.16.0/go.mod h1:yn7UURbUtPyrVJPGPq404EukNFxcm/foM+bV/bfcDsY= -golang.org/x/term v0.29.0 h1:L6pJp37ocefwRRtYPKSWOWzOtWSxVajvz2ldH/xi3iU= -golang.org/x/term v0.29.0/go.mod h1:6bl4lRlvVuDgSf3179VpIxBF0o10JUpXWOnI7nErv7s= +golang.org/x/term v0.30.0 h1:PQ39fJZ+mfadBm0y5WlL4vlM7Sx1Hgf13sMIY2+QS9Y= +golang.org/x/term v0.30.0/go.mod h1:NYYFdzHoI5wRh/h5tDMdMqCqPJZEuNqVR5xJLd/n67g= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= @@ -1267,7 +1263,5 @@ lukechampine.com/blake3 v1.3.0 h1:sJ3XhFINmHSrYCgl958hscfIa3bw8x4DqMP3u1YvoYE= lukechampine.com/blake3 v1.3.0/go.mod h1:0OFRp7fBtAylGVCO40o87sbupkyIGgbpv1+M1k1LM6k= rsc.io/pdf v0.1.1 h1:k1MczvYDUvJBe93bYd7wrZLLUEcLZAuF824/I4e5Xr4= rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4= -rsc.io/tmplfunc v0.0.3 h1:53XFQh69AfOa8Tw0Jm7t+GV7KZhOi6jzsCzTtKbMvzU= -rsc.io/tmplfunc v0.0.3/go.mod h1:AG3sTPzElb1Io3Yg4voV9AGZJuleGAwaVRxL9M49PhA= sourcegraph.com/sourcegraph/go-diff v0.5.0/go.mod h1:kuch7UrkMzY0X+p9CRK03kfuPQ2zzQcaEFbx8wA8rck= sourcegraph.com/sqs/pbtypes v0.0.0-20180604144634-d3ebe8f20ae4/go.mod h1:ketZ/q3QxT9HOBeFhu6RdvsftgpsbFHBF5Cas6cDKZ0= diff --git a/justfile b/justfile index 33539c92ab9..82340a86508 100644 --- a/justfile +++ b/justfile @@ -17,3 +17,7 @@ shellcheck: # Generates a table of contents for the README.md file. toc: md_toc -p github README.md + +latest-versions: + ./ops/scripts/latest-versions.sh + diff --git a/kurtosis-devnet/flash.yaml b/kurtosis-devnet/flash.yaml index 798fd2f4c4d..b34eea0df02 100644 --- a/kurtosis-devnet/flash.yaml +++ b/kurtosis-devnet/flash.yaml @@ -5,19 +5,54 @@ optimism_package: chains: op-kurtosis: participants: - node0: &x-node + node0: + sequencer: true el: type: op-geth + el_builder: + type: op-rbuilder + cl_builder: + type: op-node + image: {{ localDockerImage "op-node" }} + mev_params: + enabled: true cl: type: op-node image: {{ localDockerImage "op-node" }} - builder_type: "op-rbuilder" - builder_image: "us-docker.pkg.dev/oplabs-tools-artifacts/dev-images/op-rbuilder:sha-4aee498" + conductor_params: + image: {{ localDockerImage "op-conductor" }} + enabled: true + bootstrap: true + paused: true + admin: true + proxy: true + websocket_enabled: true + + node1: + sequencer: true + el: + type: op-reth + el_builder: + type: op-rbuilder + cl_builder: + type: op-node + image: {{ localDockerImage "op-node" }} mev_params: enabled: true - type: "rollup-boost" - image: "docker.io/flashbots/rollup-boost:0.6.2" - node1: *x-node + cl: + type: op-node + image: {{ localDockerImage "op-node" }} + conductor_params: + image: {{ localDockerImage "op-conductor" }} + enabled: true + paused: true + admin: true + proxy: true + websocket_enabled: true + + proxyd_params: + pprof_enabled: false + extra_params: [] network_params: network: "kurtosis" network_id: "2151908" @@ -26,13 +61,14 @@ optimism_package: granite_time_offset: 0 holocene_time_offset: 0 fund_dev_accounts: true + + flashblocks_websocket_proxy_params: + enabled: true + flashblocks_rpc_params: + type: op-reth batcher_params: image: {{ localDockerImage "op-batcher" }} extra_params: [] - conductor_params: - image: {{ localDockerImage "op-conductor" }} - enabled: true - bootstrap: true proposer_params: image: {{ localDockerImage "op-proposer" }} extra_params: [] @@ -59,6 +95,7 @@ ethereum_package: participants: - el_type: geth cl_type: teku + cl_image: consensys/teku:25.7.1 network_params: preset: minimal genesis_delay: 5 diff --git a/kurtosis-devnet/interop.yaml b/kurtosis-devnet/interop.yaml index 4a75c7c59a7..2295c963c6b 100644 --- a/kurtosis-devnet/interop.yaml +++ b/kurtosis-devnet/interop.yaml @@ -47,7 +47,7 @@ optimism_package: node0: &x-node el: type: op-geth - image: "" + image: "us-docker.pkg.dev/oplabs-tools-artifacts/images/op-geth:v1.101602.1-rc.1" log_level: "" extra_env_vars: {} extra_labels: {} @@ -159,6 +159,7 @@ ethereum_package: participants: - el_type: geth cl_type: teku + cl_image: consensys/teku:25.7.1 network_params: preset: minimal genesis_delay: 5 diff --git a/kurtosis-devnet/isthmus.yaml b/kurtosis-devnet/isthmus.yaml index ea50892e86d..db1c0777ffa 100644 --- a/kurtosis-devnet/isthmus.yaml +++ b/kurtosis-devnet/isthmus.yaml @@ -85,6 +85,7 @@ ethereum_package: participants: - el_type: geth cl_type: teku + cl_image: consensys/teku:25.7.1 network_params: preset: minimal genesis_delay: 5 diff --git a/kurtosis-devnet/pkg/kurtosis/endpoints.go b/kurtosis-devnet/pkg/kurtosis/endpoints.go index 9ca074e3bb2..ad786e42f80 100644 --- a/kurtosis-devnet/pkg/kurtosis/endpoints.go +++ b/kurtosis-devnet/pkg/kurtosis/endpoints.go @@ -182,6 +182,15 @@ func (f *ServiceFinder) triageByLabels(svc *inspect.Service, name string, endpoi if !ok { return nil } + + // So that we can have the same behaviour as netchef + if (tag == "flashblocks-websocket-proxy") && endpoints != nil { + if _, has := endpoints["ws-flashblocks"]; !has { + if ws, ok := endpoints["ws"]; ok { + endpoints["ws-flashblocks"] = ws + } + } + } network_ids := f.getNetworkIDs(svc) idx := -1 if val, ok := svc.Labels[nodeIndexLabel]; ok { diff --git a/kurtosis-devnet/simple.yaml b/kurtosis-devnet/simple.yaml index 456448eeb01..bc88d0eac52 100644 --- a/kurtosis-devnet/simple.yaml +++ b/kurtosis-devnet/simple.yaml @@ -73,6 +73,7 @@ ethereum_package: participants: - el_type: geth cl_type: teku + cl_image: consensys/teku:25.7.1 network_params: preset: minimal genesis_delay: 5 diff --git a/mise.toml b/mise.toml index 0fcaefa823d..1fe9587ca73 100644 --- a/mise.toml +++ b/mise.toml @@ -37,7 +37,7 @@ anvil = "1.1.0" codecov-uploader = "0.8.0" goreleaser-pro = "2.11.2" kurtosis = "1.8.1" -op-acceptor = "op-acceptor/v3.0.0" +op-acceptor = "op-acceptor/v3.3.0" # Fake dependencies # Put things here if you need to track versions of tools or projects that can't diff --git a/op-acceptance-tests/README.md b/op-acceptance-tests/README.md index 183bee525b2..632678f6ad9 100644 --- a/op-acceptance-tests/README.md +++ b/op-acceptance-tests/README.md @@ -96,7 +96,8 @@ For rapid test development, use in-process testing: ```bash cd op-acceptance-tests -just acceptance-test "" base # Uses sysgo orchestrator - faster! +# Not providing a network uses the sysgo orchestrator (in-memory network) which is faster and easier to iterate with. +just acceptance-test "" base ``` ### Testing Against External Devnets @@ -155,16 +156,33 @@ LOG_LEVEL=info go test -v ./op-acceptance-tests/tests/interop/sync/multisupervis To add new acceptance tests: -1. Create your test in the appropriate Go package (as a regular Go test) +1. Create your test in the appropriate Go package under `tests` (as a regular Go test) 2. Register the test in `acceptance-tests.yaml` under the appropriate gate 3. Follow the existing pattern for test registration: ```yaml - name: YourTestName - package: github.com/ethereum-optimism/optimism/your/package/path + package: github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/your/package/path ``` +### Quick Development + +For rapid development and testing: + +```bash +cd op-acceptance-tests + +# Run all tests (sysgo gateless mode) - most comprehensive coverage +just acceptance-test "" "" + +# Run specific gate-based tests (traditional mode) +just acceptance-test "" base # In-process (sysgo) with gate +just acceptance-test simple base # External devnet (sysext) with gate +``` + +Using an empty gate (`""`) triggers gateless mode with the sysgo orchestrator, auto-discovering all tests. + ## Further Information For more details about `op-acceptor` and the acceptance testing process, refer to the main documentation or ask the team for guidance. -The source code for `op-acceptor` is available at [github.com/ethereum-optimism/infra/op-acceptor](https://github.com/ethereum-optimism/infra/tree/main/op-acceptor). If you discover any bugs or have feature requests, please open an issue in that repository. \ No newline at end of file +The source code for `op-acceptor` is available at [github.com/ethereum-optimism/infra/op-acceptor](https://github.com/ethereum-optimism/infra/tree/main/op-acceptor). If you discover any bugs or have feature requests, please open an issue in that repository. diff --git a/op-acceptance-tests/acceptance-tests.yaml b/op-acceptance-tests/acceptance-tests.yaml index 13c8750a6d8..a0d677689bb 100644 --- a/op-acceptance-tests/acceptance-tests.yaml +++ b/op-acceptance-tests/acceptance-tests.yaml @@ -26,12 +26,6 @@ gates: # TODO(infra#401): Re-enable the test when the sysext missing toolset is implemented #- package: github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/base/withdrawal # timeout: 10m - - - id: holocene - inherits: - - base - description: "Holocene network tests." - tests: - package: github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/fjord - id: isthmus @@ -83,4 +77,18 @@ gates: description: "Flashblocks network tests." tests: - package: github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/flashblocks - timeout: 5m \ No newline at end of file + timeout: 5m + + - id: flashblocks-with-isthmus + inherits: + - isthmus + description: "Flashblocks network tests with Isthmus." + tests: + - package: github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/flashblocks + timeout: 5m + + - id: sync-test-op-node + description: "Sync tests for op-node with external networks via the op-sync-tester - tests run daily." + tests: + - package: github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/sync_tester/sync_tester_ext_el + timeout: 30m diff --git a/op-acceptance-tests/cmd/main.go b/op-acceptance-tests/cmd/main.go index 1b18c7f39cf..f8e6508deed 100644 --- a/op-acceptance-tests/cmd/main.go +++ b/op-acceptance-tests/cmd/main.go @@ -22,6 +22,19 @@ const ( defaultAcceptor = "op-acceptor" ) +// AcceptorConfig holds all configuration for running op-acceptor +type AcceptorConfig struct { + Orchestrator string + Devnet string + Gate string + TestDir string + Validators string + LogLevel string + Acceptor string + Serial bool + ShowProgress bool +} + var ( // Command line flags orchestratorFlag = &cli.StringFlag{ @@ -85,6 +98,12 @@ var ( Value: false, EnvVars: []string{"SERIAL"}, } + showProgressFlag = &cli.BoolFlag{ + Name: "show-progress", + Usage: "Show progress information during test execution", + Value: false, + EnvVars: []string{"SHOW_PROGRESS"}, + } ) func main() { @@ -102,6 +121,7 @@ func main() { acceptorFlag, reuseDevnetFlag, serialFlag, + showProgressFlag, }, Action: runAcceptanceTest, } @@ -124,6 +144,7 @@ func runAcceptanceTest(c *cli.Context) error { acceptor := c.String(acceptorFlag.Name) reuseDevnet := c.Bool(reuseDevnetFlag.Name) serial := c.Bool(serialFlag.Name) + showProgress := c.Bool(showProgressFlag.Name) // Validate inputs based on orchestrator type if orchestrator != "sysgo" && orchestrator != "sysext" { @@ -193,7 +214,18 @@ func runAcceptanceTest(c *cli.Context) error { // Run acceptance tests steps = append(steps, func(ctx context.Context) error { - return runOpAcceptor(ctx, tracer, orchestrator, devnet, gate, absTestDir, absValidators, logLevel, acceptor, serial) + config := AcceptorConfig{ + Orchestrator: orchestrator, + Devnet: devnet, + Gate: gate, + TestDir: absTestDir, + Validators: absValidators, + LogLevel: logLevel, + Acceptor: acceptor, + Serial: serial, + ShowProgress: showProgress, + } + return runOpAcceptor(ctx, tracer, config) }, ) @@ -224,7 +256,7 @@ func deployDevnet(ctx context.Context, tracer trace.Tracer, devnet string, kurto return nil } -func runOpAcceptor(ctx context.Context, tracer trace.Tracer, orchestrator string, devnet string, gate string, testDir string, validators string, logLevel string, acceptor string, serial bool) error { +func runOpAcceptor(ctx context.Context, tracer trace.Tracer, config AcceptorConfig) error { ctx, span := tracer.Start(ctx, "run acceptance test") defer span.End() @@ -232,32 +264,41 @@ func runOpAcceptor(ctx context.Context, tracer trace.Tracer, orchestrator string // Build the command arguments args := []string{ - "--testdir", testDir, - "--gate", gate, - "--validators", validators, - "--log.level", logLevel, - "--orchestrator", orchestrator, + "--testdir", config.TestDir, + "--gate", config.Gate, + "--validators", config.Validators, + "--log.level", config.LogLevel, + "--orchestrator", config.Orchestrator, } - if serial { + if config.Serial { args = append(args, "--serial") } + if config.ShowProgress { + args = append(args, "--show-progress") + args = append(args, "--progress-interval", "20s") + } // Handle devnet parameter based on orchestrator type - if orchestrator == "sysext" && devnet != "" { + if config.Orchestrator == "sysext" && config.Devnet != "" { var devnetEnvURL string - if strings.HasPrefix(devnet, "kt://") || strings.HasPrefix(devnet, "ktnative://") { + if strings.HasPrefix(config.Devnet, "kt://") || strings.HasPrefix(config.Devnet, "ktnative://") { // Already a URL or file path - use directly - devnetEnvURL = devnet + devnetEnvURL = config.Devnet } else { // Simple name - wrap as Kurtosis URL - devnetEnvURL = fmt.Sprintf("kt://%s-devnet", devnet) + devnetEnvURL = fmt.Sprintf("kt://%s-devnet", config.Devnet) } args = append(args, "--devnet-env-url", devnetEnvURL) } - acceptorCmd := exec.CommandContext(ctx, acceptor, args...) + // For sysgo, we allow skips + if config.Orchestrator == "sysgo" { + args = append(args, "--allow-skips") + } + + acceptorCmd := exec.CommandContext(ctx, config.Acceptor, args...) acceptorCmd.Env = env acceptorCmd.Stdout = os.Stdout acceptorCmd.Stderr = os.Stderr diff --git a/op-acceptance-tests/justfile b/op-acceptance-tests/justfile index 4c761439037..d6a2a9565a4 100644 --- a/op-acceptance-tests/justfile +++ b/op-acceptance-tests/justfile @@ -1,47 +1,48 @@ -REPO_ROOT := `realpath ..` +REPO_ROOT := `realpath ..` # path to the root of the optimism monorepo KURTOSIS_DIR := REPO_ROOT + "/kurtosis-devnet" -ACCEPTOR_VERSION := env_var_or_default("ACCEPTOR_VERSION", "v3.0.0") +ACCEPTOR_VERSION := env_var_or_default("ACCEPTOR_VERSION", "v3.3.0") DOCKER_REGISTRY := env_var_or_default("DOCKER_REGISTRY", "us-docker.pkg.dev/oplabs-tools-artifacts/images") ACCEPTOR_IMAGE := env_var_or_default("ACCEPTOR_IMAGE", DOCKER_REGISTRY + "/op-acceptor:" + ACCEPTOR_VERSION) # Default recipe - runs acceptance tests default: - @just acceptance-test simple base + @just acceptance-test "" base holocene: - @just acceptance-test simple holocene + @just acceptance-test "" holocene isthmus: - @just acceptance-test isthmus isthmus + @just acceptance-test "" isthmus interop: - @just acceptance-test interop interop + @just acceptance-test "" interop # Run acceptance tests with mise-managed binary +# Usage: just acceptance-test [devnet] [gate] +# Examples: +# just acceptance-test "" base # In-process (sysgo) with specific gate +# just acceptance-test "" "" # In-process gateless mode (all tests) +# just acceptance-test "simple" base # External devnet with specific gate +# just acceptance-test "simple" "" # External devnet gateless mode (all tests) acceptance-test devnet="" gate="holocene": #!/usr/bin/env bash set -euo pipefail - # Check if mise is installed - if command -v mise >/dev/null; then - echo "mise is installed" - else - echo "Mise not installed, falling back to Docker..." - just acceptance-test-docker {{devnet}} {{gate}} - fi + # Determine mode and orchestrator + GATELESS_MODE=$([[ "{{gate}}" == "" ]] && echo "true" || echo "false") + ORCHESTRATOR=$([[ "{{devnet}}" == "" ]] && echo "sysgo" || echo "sysext") - if [[ "{{devnet}}" == "" ]]; then - echo -e "DEVNET: in-memory, GATE: {{gate}}\n" + # Display mode information + if [[ "$GATELESS_MODE" == "true" ]]; then + echo -e "DEVNET: $([[ "$ORCHESTRATOR" == "sysgo" ]] && echo "in-memory" || echo "{{devnet}}") ($ORCHESTRATOR), MODE: gateless (all tests)\n" else - echo -e "DEVNET: {{devnet}}, GATE: {{gate}}\n" + echo -e "DEVNET: $([[ "$ORCHESTRATOR" == "sysgo" ]] && echo "in-memory" || echo "{{devnet}}") ($ORCHESTRATOR), GATE: {{gate}}\n" fi - # For sysgo orchestrator (in-process testing) ensure: - # - contracts are built - # - cannon dependencies are built - # Note: build contracts only if not in CI (CI jobs already take care of this) - if [[ "{{devnet}}" == "" && -z "${CIRCLECI:-}" ]]; then + # Build dependencies for sysgo (in-process) mode if not in CI + # In CI jobs already take care of this, so we skip it. + if [[ "$ORCHESTRATOR" == "sysgo" && -z "${CIRCLECI:-}" ]]; then echo "Building contracts (local build)..." cd {{REPO_ROOT}} echo " - Updating submodules..." @@ -63,46 +64,70 @@ acceptance-test devnet="" gate="holocene": fi fi - # Try to install op-acceptor using mise + cd {{REPO_ROOT}}/op-acceptance-tests + + # Check mise installation and fallback to Docker if needed + if ! command -v mise >/dev/null; then + echo "Mise not installed, falling back to Docker..." + just acceptance-test-docker {{devnet}} {{gate}} + exit 0 + fi + + # Install op-acceptor using mise if ! mise install op-acceptor; then echo "WARNING: Failed to install op-acceptor with mise, falling back to Docker..." just acceptance-test-docker {{devnet}} {{gate}} exit 0 fi - # Print which binary is being used + # Set binary path and log level BINARY_PATH=$(mise which op-acceptor) echo "Using mise-managed binary: $BINARY_PATH" + LOG_LEVEL="$(echo "${LOG_LEVEL:-info}" | grep -E '^(debug|info|warn|error)$' || echo 'info')" + echo "LOG_LEVEL: $LOG_LEVEL" + + # Deploy devnet for sysext if it's a simple name + if [[ "$ORCHESTRATOR" == "sysext" && ! "{{devnet}}" =~ ^(kt://|ktnative://|/) ]]; then + echo "Deploying devnet {{devnet}}..." + just {{KURTOSIS_DIR}}/{{devnet}}-devnet || true + fi - # Build the command with conditional parameters - CMD_ARGS=( - "go" "run" "cmd/main.go" - "--gate" "{{gate}}" - "--testdir" "{{REPO_ROOT}}" - "--validators" "./acceptance-tests.yaml" - "--log.level" "${LOG_LEVEL:-info}" - "--acceptor" "$BINARY_PATH" - ) - - # Set orchestrator and devnet based on input - if [[ "{{devnet}}" == "" ]]; then - # In-process testing - CMD_ARGS+=("--orchestrator" "sysgo") + # Build command arguments based on mode + if [[ "$GATELESS_MODE" == "true" ]]; then + # Gateless mode - use binary directly + CMD_ARGS=( + "$BINARY_PATH" + "--testdir" "{{REPO_ROOT}}/op-acceptance-tests/..." + "--allow-skips" + "--timeout" "90m" + "--default-timeout" "10m" + "--orchestrator" "$ORCHESTRATOR" + "--show-progress" + ) else - # External devnet testing - CMD_ARGS+=("--orchestrator" "sysext") - CMD_ARGS+=("--devnet" "{{devnet}}") - # Include kurtosis-dir for devnet deployment - CMD_ARGS+=("--kurtosis-dir" "{{KURTOSIS_DIR}}") - # For now, run sysext in serial mode - CMD_ARGS+=("--serial") + # Gate mode - use go run with acceptor binary + CMD_ARGS=( + "go" "run" "cmd/main.go" + "--gate" "{{gate}}" + "--testdir" "{{REPO_ROOT}}" + "--validators" "./acceptance-tests.yaml" + "--acceptor" "$BINARY_PATH" + "--log.level" "${LOG_LEVEL}" + "--orchestrator" "$ORCHESTRATOR" + "--show-progress" + ) + fi + + # Add sysext-specific arguments + if [[ "$ORCHESTRATOR" == "sysext" ]]; then + CMD_ARGS+=("--devnet" "{{devnet}}" "--kurtosis-dir" "{{KURTOSIS_DIR}}" "--serial") fi # Execute the command - cd {{REPO_ROOT}}/op-acceptance-tests "${CMD_ARGS[@]}" + # Run acceptance tests against a devnet using Docker (fallback if needed) acceptance-test-docker devnet="simple" gate="holocene": #!/usr/bin/env bash diff --git a/op-acceptance-tests/scripts/generate-flaky-tests-report.sh b/op-acceptance-tests/scripts/generate-flaky-tests-report.sh index e52bc08b878..d13ba1bbf4b 100755 --- a/op-acceptance-tests/scripts/generate-flaky-tests-report.sh +++ b/op-acceptance-tests/scripts/generate-flaky-tests-report.sh @@ -117,7 +117,7 @@ echo "Found $NUM_TESTS flaky tests" # Generate CSV report echo "Generating CSV report..." -jq -r '.flaky_tests[] | [ +jq -r '.flaky_tests | sort_by(.times_flaked) | reverse | .[] | [ .times_flaked, (.test_name | @json), (.classname | @json), @@ -156,9 +156,13 @@ cat > "$OUTPUT_DIR/flaky_tests.html" << EOF

Flaky Tests Report

+

+ Note: These tests are potentially flaky. They may fail for reasons other than the test itself, such as network issues, devnet issues, + interference from other tests, etc. Be mindful of this when interpreting the results and investigating the failures. +

-

Branch: $BRANCH

-

Total flaky tests: $NUM_TESTS

+

Branch: $BRANCH

+

Total flaky tests: $NUM_TESTS

@@ -170,11 +174,11 @@ cat > "$OUTPUT_DIR/flaky_tests.html" << EOF - + - $(jq -r '.flaky_tests[] | ""' "$OUTPUT_DIR/flaky_tests.json") + $(jq -r '.flaky_tests | sort_by(.times_flaked) | reverse | .[] | ""' "$OUTPUT_DIR/flaky_tests.json")
Workflow Name Job Number Pipeline NumberBuild URLJob URL First Flaked At Last Flaked At
\(.times_flaked)\(.test_name)\(.classname)\(.job_name)\(.workflow_name)\(.job_number)\(.pipeline_number)View Build\(.workflow_created_at)\(.workflow_created_at)
\(.times_flaked)\(.test_name)\(.classname)\(.job_name)\(.workflow_name)\(.job_number)\(.pipeline_number)View Job\(.workflow_created_at)\(.workflow_created_at)
diff --git a/op-acceptance-tests/tests/base/deposit/deposit_test.go b/op-acceptance-tests/tests/base/deposit/deposit_test.go index 7d56c3f0dbc..5ca47d2499a 100644 --- a/op-acceptance-tests/tests/base/deposit/deposit_test.go +++ b/op-acceptance-tests/tests/base/deposit/deposit_test.go @@ -14,10 +14,6 @@ import ( supervisorTypes "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types" ) -func TestMain(m *testing.M) { - presets.DoMain(m, presets.WithMinimal()) -} - func TestL1ToL2Deposit(gt *testing.T) { // Create a test environment using op-devstack t := devtest.SerialT(gt) @@ -30,6 +26,8 @@ func TestL1ToL2Deposit(gt *testing.T) { fundingAmount := eth.ThreeHundredthsEther alice := sys.FunderL1.NewFundedEOA(fundingAmount) t.Log("Alice L1 address", alice.Address()) + + alice.WaitForBalance(fundingAmount) initialBalance := alice.GetBalance() t.Log("Alice L1 balance", initialBalance) @@ -48,7 +46,7 @@ func TestL1ToL2Deposit(gt *testing.T) { args := portal.DepositTransaction(alice.Address(), depositAmount, 300_000, false, []byte{}) - receipt := contract.Write(alice, args, txplan.WithValue(depositAmount.ToBig())) + receipt := contract.Write(alice, args, txplan.WithValue(depositAmount)) gasPrice := receipt.EffectiveGasPrice diff --git a/op-acceptance-tests/tests/base/deposit/init_test.go b/op-acceptance-tests/tests/base/deposit/init_test.go new file mode 100644 index 00000000000..22f5bb59842 --- /dev/null +++ b/op-acceptance-tests/tests/base/deposit/init_test.go @@ -0,0 +1,11 @@ +package deposit + +import ( + "testing" + + "github.com/ethereum-optimism/optimism/op-devstack/presets" +) + +func TestMain(m *testing.M) { + presets.DoMain(m, presets.WithMinimal()) +} diff --git a/op-acceptance-tests/tests/base/withdrawal/withdrawal_test.go b/op-acceptance-tests/tests/base/withdrawal/withdrawal_test.go index de9125ac670..d2b40beb723 100644 --- a/op-acceptance-tests/tests/base/withdrawal/withdrawal_test.go +++ b/op-acceptance-tests/tests/base/withdrawal/withdrawal_test.go @@ -33,9 +33,13 @@ func TestWithdrawal(gt *testing.T) { expectedL2UserBalance := depositAmount l2User.VerifyBalanceExact(expectedL2UserBalance) - withdrawal := bridge.InitiateWithdrawal(withdrawalAmount, l2User) + // Force a fresh EOA instance to avoid stale nonce state from shared L1/L2 key usage + // This prevents "nonce too low" errors in the retry logic during withdrawal initiation + freshL2User := l1User.Key().User(sys.L2EL) + + withdrawal := bridge.InitiateWithdrawal(withdrawalAmount, freshL2User) expectedL2UserBalance = expectedL2UserBalance.Sub(withdrawalAmount).Sub(withdrawal.InitiateGasCost()) - l2User.VerifyBalanceExact(expectedL2UserBalance) + freshL2User.VerifyBalanceExact(expectedL2UserBalance) withdrawal.Prove(l1User) expectedL1UserBalance = expectedL1UserBalance.Sub(withdrawal.ProveGasCost()) diff --git a/op-acceptance-tests/tests/ecotone/fees_test.go b/op-acceptance-tests/tests/ecotone/fees_test.go index eefd8def79b..10852f673eb 100644 --- a/op-acceptance-tests/tests/ecotone/fees_test.go +++ b/op-acceptance-tests/tests/ecotone/fees_test.go @@ -28,7 +28,7 @@ func TestFees(gt *testing.T) { ecotoneFees.LogResults(result) - t.Log("Comprehensive Ecotone fees test completed successfully:", + t.Log("Ecotone fees test completed successfully", "gasUsed", result.TransactionReceipt.GasUsed, "l1Fee", result.L1Fee.String(), "l2Fee", result.L2Fee.String(), diff --git a/op-acceptance-tests/tests/fjord/check_scripts_test.go b/op-acceptance-tests/tests/fjord/check_scripts_test.go index c41892e9684..649f4a5e9de 100644 --- a/op-acceptance-tests/tests/fjord/check_scripts_test.go +++ b/op-acceptance-tests/tests/fjord/check_scripts_test.go @@ -1,89 +1,188 @@ package fjord import ( - "math/big" + "context" + "crypto/rand" "testing" - "github.com/ethereum-optimism/optimism/devnet-sdk/system" - "github.com/ethereum-optimism/optimism/devnet-sdk/testing/systest" - "github.com/ethereum-optimism/optimism/devnet-sdk/testing/testlib/validators" - "github.com/ethereum-optimism/optimism/devnet-sdk/types" - fjordChecks "github.com/ethereum-optimism/optimism/op-chain-ops/cmd/check-fjord/checks" + "github.com/ethereum/go-ethereum/rpc" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/dsl" + "github.com/ethereum-optimism/optimism/op-devstack/presets" "github.com/ethereum-optimism/optimism/op-node/rollup" - "github.com/ethereum-optimism/optimism/op-service/testlog" - "github.com/ethereum/go-ethereum/log" - "github.com/stretchr/testify/require" + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum-optimism/optimism/op-service/predeploys" + txib "github.com/ethereum-optimism/optimism/op-service/txintent/bindings" + "github.com/ethereum-optimism/optimism/op-service/txintent/contractio" + "github.com/ethereum-optimism/optimism/op-service/txplan" + + "github.com/ethereum/go-ethereum" + "github.com/ethereum/go-ethereum/common" + "github.com/ethereum/go-ethereum/core/types" ) -// TestCheckFjordScript ensures the op-chain-ops/cmd/check-fjord script runs successfully -// against a test chain with the fjord hardfork activated/unactivated -func TestCheckFjordScript(t *testing.T) { +var ( + rip7212Precompile = common.HexToAddress("0x0000000000000000000000000000000000000100") + invalid7212Data = []byte{0x00} + valid7212Data = common.FromHex("4cee90eb86eaa050036147a12d49004b6b9c72bd725d39d4785011fe190f0b4da73bd4903f0ce3b639bbbf6e8e80d16931ff4bcf5993d58468e8fb19086e8cac36dbcd03009df8c59286b162af3bd7fcc0450c9aa81be5d10d312af6c66b1d604aebd3099c618202fcfe16ae7770b0c49ab5eadf74b754204a3bb6060e44eff37618b065f9832de4ca6ca971a7a1adc826d0f7c00181a5fb2ddf79ae00b4e10e") +) - l2ChainIndex := uint64(0) +func TestCheckFjordScript(gt *testing.T) { + t := devtest.SerialT(gt) + sys := presets.NewMinimal(t) + require := t.Require() + ctx := t.Ctx() - walletGetter, walletValidator := validators.AcquireL2WalletWithFunds(l2ChainIndex, types.NewBalance(big.NewInt(1_000_000))) - forkConfigGetter, forkValidatorA := validators.AcquireL2WithFork(l2ChainIndex, rollup.Fjord) - _, forkValidatorB := validators.AcquireL2WithoutFork(l2ChainIndex, rollup.Granite) - systest.SystemTest(t, - checkFjordScriptScenario(walletGetter, forkConfigGetter, l2ChainIndex), - walletValidator, - forkValidatorA, - forkValidatorB, - ) + err := dsl.RequiresL2Fork(ctx, sys, 0, rollup.Fjord) + require.NoError(err) + + wallet := sys.FunderL2.NewFundedEOA(eth.OneThirdEther) + + checkRIP7212(t, ctx, sys) + checkGasPriceOracle(t, ctx, sys) + checkFastLZTransactions(t, ctx, sys, wallet) +} - forkConfigGetter, notForkValidator := validators.AcquireL2WithoutFork(l2ChainIndex, rollup.Fjord) - systest.SystemTest(t, - checkFjordScriptScenario(walletGetter, forkConfigGetter, l2ChainIndex), - walletValidator, - notForkValidator, +func checkRIP7212(t devtest.T, ctx context.Context, sys *presets.Minimal) { + require := t.Require() + l2Client := sys.L2EL.Escape().EthClient() + + // Test invalid signature + response, err := l2Client.Call(ctx, ethereum.CallMsg{ + To: &rip7212Precompile, + Data: invalid7212Data, + }, rpc.LatestBlockNumber) + require.NoError(err) + require.Empty(response) + + // Test valid signature + response, err = l2Client.Call(ctx, ethereum.CallMsg{ + To: &rip7212Precompile, + Data: valid7212Data, + }, rpc.LatestBlockNumber) + require.NoError(err) + expected := common.LeftPadBytes([]byte{1}, 32) + require.Equal(expected, response) +} + +func checkGasPriceOracle(t devtest.T, ctx context.Context, sys *presets.Minimal) { + require := t.Require() + + l2Client := sys.L2EL.Escape().EthClient() + gpo := txib.NewGasPriceOracle( + txib.WithClient(l2Client), + txib.WithTo(predeploys.GasPriceOracleAddr), + txib.WithTest(t), ) + isFjord, err := contractio.Read(gpo.IsFjord(), ctx) + require.NoError(err) + require.True(isFjord) } -func checkFjordScriptScenario(walletGetter validators.WalletGetter, chainConfigGetter validators.ChainConfigGetter, chainIndex uint64) systest.SystemTestFunc { - return func(t systest.T, sys system.System) { - wallet := walletGetter(t.Context()) - chainConfig := chainConfigGetter(t.Context()) +func checkFastLZTransactions(t devtest.T, ctx context.Context, sys *presets.Minimal, wallet *dsl.EOA) { + require := t.Require() + + l2Client := sys.L2EL.Escape().EthClient() + gasPriceOracle := txib.NewGasPriceOracle( + txib.WithClient(l2Client), + txib.WithTo(predeploys.GasPriceOracleAddr), + txib.WithTest(t), + ) - l2 := sys.L2s()[chainIndex] - l2LowLevelClient, err := sys.L2s()[chainIndex].Nodes()[0].GethClient() - require.NoError(t, err) + testCases := []struct { + name string + data []byte + }{ + {"empty", nil}, + {"all-zero-256", make([]byte, 256)}, + {"all-42-256", func() []byte { + data := make([]byte, 256) + for i := range data { + data[i] = 0x42 + } + return data + }()}, + {"random-256", func() []byte { + data := make([]byte, 256) + _, _ = rand.Read(data) + return data + }()}, + } - // Get the wallet's private key and address - privateKey := wallet.PrivateKey() + for _, tc := range testCases { walletAddr := wallet.Address() + var receipt *types.Receipt + var signedTx *types.Transaction - logger := testlog.Logger(t, log.LevelDebug) - checkFjordConfig := &fjordChecks.CheckFjordConfig{ - Log: logger, - L2: l2LowLevelClient, - Key: privateKey, - Addr: walletAddr, - } + if len(tc.data) == 0 { + plannedTx := wallet.Transfer(walletAddr, eth.ZeroWei) + var err error + receipt, err = plannedTx.Included.Eval(ctx) + require.NoError(err) + require.NotNil(receipt) + + _, txs, err := l2Client.InfoAndTxsByHash(ctx, receipt.BlockHash) + require.NoError(err) - block, err := l2.Nodes()[0].BlockByNumber(t.Context(), nil) - require.NoError(t, err) - time := block.Time() - - isFjordActivated, err := validators.IsForkActivated(chainConfig, rollup.Fjord, time) - require.NoError(t, err) - - if !isFjordActivated { - err = fjordChecks.CheckRIP7212(t.Context(), checkFjordConfig) - require.Error(t, err, "expected error for CheckRIP7212") - err = fjordChecks.CheckGasPriceOracle(t.Context(), checkFjordConfig) - require.Error(t, err, "expected error for CheckGasPriceOracle") - err = fjordChecks.CheckTxEmpty(t.Context(), checkFjordConfig) - require.Error(t, err, "expected error for CheckTxEmpty") - err = fjordChecks.CheckTxAllZero(t.Context(), checkFjordConfig) - require.Error(t, err, "expected error for CheckTxAllZero") - err = fjordChecks.CheckTxAll42(t.Context(), checkFjordConfig) - require.Error(t, err, "expected error for CheckTxAll42") - err = fjordChecks.CheckTxRandom(t.Context(), checkFjordConfig) - require.Error(t, err, "expected error for CheckTxRandom") + for _, tx := range txs { + if tx.Hash() == receipt.TxHash { + signedTx = tx + break + } + } + require.NotNil(signedTx) } else { - err = fjordChecks.CheckAll(t.Context(), checkFjordConfig) - require.NoError(t, err, "should not error on CheckAll") + opt := txplan.Combine( + wallet.Plan(), + txplan.WithTo(&walletAddr), + txplan.WithValue(eth.ZeroWei), + txplan.WithData(tc.data), + ) + plannedTx := txplan.NewPlannedTx(opt) + var err error + receipt, err = plannedTx.Included.Eval(ctx) + require.NoError(err) + require.NotNil(receipt) + + signedTx, err = dsl.FindSignedTransactionFromReceipt(ctx, l2Client, receipt) + require.NoError(err) + require.NotNil(signedTx) } + + require.Equal(uint64(1), receipt.Status) + + unsignedTx, err := dsl.CreateUnsignedTransactionFromSigned(signedTx) + require.NoError(err) + + txUnsigned, err := unsignedTx.MarshalBinary() + require.NoError(err) + + gpoFee, err := dsl.ReadGasPriceOracleL1FeeAt(ctx, l2Client, gasPriceOracle, txUnsigned, receipt.BlockHash) + require.NoError(err) + + fastLzSize := uint64(types.FlzCompressLen(txUnsigned) + 68) + gethGPOFee, err := dsl.CalculateFjordL1Cost(ctx, l2Client, types.RollupCostData{FastLzSize: fastLzSize}, receipt.BlockHash) + require.NoError(err) + require.Equalf(gethGPOFee.Uint64(), gpoFee.Uint64(), "GPO L1 fee mismatch (expected=%d actual=%d)", gethGPOFee.Uint64(), gpoFee.Uint64()) + + expectedFee, err := dsl.CalculateFjordL1Cost(ctx, l2Client, signedTx.RollupCostData(), receipt.BlockHash) + require.NoError(err) + require.NotNil(receipt.L1Fee) + dsl.ValidateL1FeeMatches(t, expectedFee, receipt.L1Fee) + + upperBound, err := dsl.ReadGasPriceOracleL1FeeUpperBoundAt(ctx, l2Client, gasPriceOracle, len(txUnsigned), receipt.BlockHash) + require.NoError(err) + txLenGPO := len(txUnsigned) + 68 + flzUpperBound := uint64(txLenGPO + txLenGPO/255 + 16) + upperBoundCost, err := dsl.CalculateFjordL1Cost(ctx, l2Client, types.RollupCostData{FastLzSize: flzUpperBound}, receipt.BlockHash) + require.NoError(err) + require.Equalf(upperBoundCost.Uint64(), upperBound.Uint64(), "GPO L1 upper bound mismatch (expected=%d actual=%d)", upperBoundCost.Uint64(), upperBound.Uint64()) + + _, err = contractio.Read(gasPriceOracle.BaseFeeScalar(), ctx) + require.NoError(err) + _, err = contractio.Read(gasPriceOracle.BlobBaseFeeScalar(), ctx) + require.NoError(err) } } diff --git a/op-acceptance-tests/tests/fjord/fees_test.go b/op-acceptance-tests/tests/fjord/fees_test.go index ea7d5af8678..f661e17a6f2 100644 --- a/op-acceptance-tests/tests/fjord/fees_test.go +++ b/op-acceptance-tests/tests/fjord/fees_test.go @@ -1,296 +1,54 @@ package fjord import ( - "context" - "errors" - "math/big" "testing" - "time" - "github.com/ethereum-optimism/optimism/devnet-sdk/system" - "github.com/ethereum-optimism/optimism/devnet-sdk/testing/systest" - "github.com/ethereum-optimism/optimism/devnet-sdk/testing/testlib/validators" - "github.com/ethereum-optimism/optimism/devnet-sdk/types" - "github.com/ethereum-optimism/optimism/op-e2e/bindings" + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + dsl "github.com/ethereum-optimism/optimism/op-devstack/dsl" + "github.com/ethereum-optimism/optimism/op-devstack/presets" + "github.com/ethereum-optimism/optimism/op-node/rollup" + "github.com/ethereum-optimism/optimism/op-service/eth" "github.com/ethereum-optimism/optimism/op-service/predeploys" - "github.com/ethereum/go-ethereum" - "github.com/ethereum/go-ethereum/accounts/abi/bind" - "github.com/ethereum/go-ethereum/common" - gethTypes "github.com/ethereum/go-ethereum/core/types" - "github.com/ethereum/go-ethereum/ethclient" - "github.com/ethereum/go-ethereum/params" - "github.com/stretchr/testify/require" + txib "github.com/ethereum-optimism/optimism/op-service/txintent/bindings" ) -// TestFees verifies that L1/L2 fees are handled properly in different fork configurations -func TestFees(t *testing.T) { - // Define which L2 chain we'll test - chainIdx := uint64(0) - - // Get validators and getters for accessing the system and wallets - walletGetter, walletValidator := validators.AcquireL2WalletWithFunds(chainIdx, types.NewBalance(big.NewInt(params.Ether))) - - // Run fjord test - _, forkValidator := validators.AcquireL2WithFork(chainIdx, rollup.Fjord) - _, notForkValidator := validators.AcquireL2WithoutFork(chainIdx, rollup.Isthmus) - systest.SystemTest(t, - feesTestScenario(walletGetter, chainIdx), - walletValidator, - forkValidator, - notForkValidator, +func TestFees(gt *testing.T) { + t := devtest.SerialT(gt) + sys := presets.NewMinimal(t) + require := t.Require() + ctx := t.Ctx() + + err := dsl.RequiresL2Fork(ctx, sys, 0, rollup.Fjord) + require.NoError(err) + operatorFee := dsl.NewOperatorFee(t, sys.L2Chain, sys.L1EL) + operatorFee.SetOperatorFee(100000000, 500) + operatorFee.WaitForL2SyncWithCurrentL1State() + + alice := sys.FunderL2.NewFundedEOA(eth.OneTenthEther) + bob := sys.Wallet.NewEOA(sys.L2EL) + + fjordFees := dsl.NewFjordFees(t, sys.L2Chain) + result := fjordFees.ValidateTransaction(alice, bob, eth.OneHundredthEther.ToBig()) + + l2Client := sys.L2EL.Escape().EthClient() + gpo := txib.NewGasPriceOracle( + txib.WithClient(l2Client), + txib.WithTo(predeploys.GasPriceOracleAddr), + txib.WithTest(t), ) -} - -// stateGetterAdapter adapts the ethclient to implement the StateGetter interface -type stateGetterAdapter struct { - ctx context.Context - t systest.T - client *ethclient.Client -} - -// GetState implements the StateGetter interface -func (sga *stateGetterAdapter) GetState(addr common.Address, key common.Hash) common.Hash { - var result common.Hash - val, err := sga.client.StorageAt(sga.ctx, addr, key, nil) - require.NoError(sga.t, err) - copy(result[:], val) - return result -} - -// waitForTransaction polls for a transaction receipt until it is available or the context is canceled. -// It's a simpler version of the functionality in SimpleTxManager. -func waitForTransaction(ctx context.Context, client *ethclient.Client, hash common.Hash) (*gethTypes.Receipt, error) { - ticker := time.NewTicker(500 * time.Millisecond) // Poll every 500ms - defer ticker.Stop() - - for { - receipt, err := client.TransactionReceipt(ctx, hash) - if receipt != nil && err == nil { - return receipt, nil - } else if err != nil && !errors.Is(err, ethereum.NotFound) { - return nil, err - } - - select { - case <-ctx.Done(): - return nil, ctx.Err() - case <-ticker.C: - // Continue polling - } - } -} - -// feesTestScenario creates a test scenario for verifying fee calculations -func feesTestScenario( - walletGetter validators.WalletGetter, - chainIdx uint64, -) systest.SystemTestFunc { - return func(t systest.T, sys system.System) { - ctx := t.Context() - - // Get the low-level system and wallet - wallet := walletGetter(ctx) - - // Get the L2 client - l2Chain := sys.L2s()[chainIdx] - l2Client, err := l2Chain.Nodes()[0].GethClient() - require.NoError(t, err) - - // TODO: Wait for first block after genesis - // The genesis block has zero L1Block values and will throw off the GPO checks - header, err := l2Client.HeaderByNumber(ctx, big.NewInt(1)) - require.NoError(t, err) - - startBlockNumber := header.Number - - // Get the genesis config - chainConfig, err := l2Chain.Config() - require.NoError(t, err) - - // Create state getter adapter for L1 cost function - sga := &stateGetterAdapter{ - ctx: ctx, - t: t, - client: l2Client, - } - - // Create L1 cost function - l1CostFn := gethTypes.NewL1CostFunc(chainConfig, sga) - - // Create operator fee function - operatorFeeFn := gethTypes.NewOperatorCostFunc(chainConfig, sga) - - // Get wallet private key and address - fromAddr := wallet.Address() - privateKey := wallet.PrivateKey() - - // Find gaspriceoracle contract - gpoContract, err := bindings.NewGasPriceOracle(predeploys.GasPriceOracleAddr, l2Client) - require.NoError(t, err) - - // Get wallet balance before test - startBalance, err := l2Client.BalanceAt(ctx, fromAddr, startBlockNumber) - require.NoError(t, err) - require.Greater(t, startBalance.Uint64(), big.NewInt(0).Uint64()) - - // Get initial balances of fee recipients - baseFeeRecipientStartBalance, err := l2Client.BalanceAt(ctx, predeploys.BaseFeeVaultAddr, startBlockNumber) - require.NoError(t, err) - - l1FeeRecipientStartBalance, err := l2Client.BalanceAt(ctx, predeploys.L1FeeVaultAddr, startBlockNumber) - require.NoError(t, err) - - sequencerFeeVaultStartBalance, err := l2Client.BalanceAt(ctx, predeploys.SequencerFeeVaultAddr, startBlockNumber) - require.NoError(t, err) - - operatorFeeVaultStartBalance, err := l2Client.BalanceAt(ctx, predeploys.OperatorFeeVaultAddr, startBlockNumber) - require.NoError(t, err) - - genesisBlock, err := l2Client.BlockByNumber(ctx, startBlockNumber) - require.NoError(t, err) - - coinbaseStartBalance, err := l2Client.BalanceAt(ctx, genesisBlock.Coinbase(), startBlockNumber) - require.NoError(t, err) - - // Send a simple transfer from wallet to a test address - transferAmount := big.NewInt(params.Ether / 10) // 0.1 ETH - targetAddr := common.Address{0xff, 0xff} - - // Get suggested gas tip from the client instead of using a hardcoded value - gasTip, err := l2Client.SuggestGasTipCap(ctx) - require.NoError(t, err, "Failed to get suggested gas tip") - - // Estimate gas for the transaction instead of using a hardcoded value - msg := ethereum.CallMsg{ - From: fromAddr, - To: &targetAddr, - Value: transferAmount, - } - gasLimit, err := l2Client.EstimateGas(ctx, msg) - require.NoError(t, err, "Failed to estimate gas") - - // Create and sign transaction with the suggested values - nonce, err := l2Client.PendingNonceAt(ctx, fromAddr) - require.NoError(t, err) - - // Get latest header to get the base fee - header, err = l2Client.HeaderByNumber(ctx, nil) - require.NoError(t, err) - - // Calculate a reasonable gas fee cap based on the base fee - // A common approach is to set fee cap to 2x the base fee + tip - gasFeeCap := new(big.Int).Add( - new(big.Int).Mul(header.BaseFee, big.NewInt(2)), - gasTip, - ) - - txData := &gethTypes.DynamicFeeTx{ - ChainID: l2Chain.ID(), - Nonce: nonce, - GasTipCap: gasTip, - GasFeeCap: gasFeeCap, - Gas: gasLimit, - To: &targetAddr, - Value: transferAmount, - Data: nil, - } - - // Sign transaction - tx := gethTypes.NewTx(txData) - signedTx, err := gethTypes.SignTx(tx, gethTypes.LatestSignerForChainID(l2Chain.ID()), privateKey) - require.NoError(t, err) - - // Send transaction - err = l2Client.SendTransaction(ctx, signedTx) - require.NoError(t, err) - - // Wait for transaction receipt with timeout - ctx, cancel := context.WithTimeout(ctx, time.Second*10) - defer cancel() - receipt, err := waitForTransaction(ctx, l2Client, signedTx.Hash()) - require.NoError(t, err, "Failed to wait for transaction receipt") - require.NotNil(t, receipt) - require.Equal(t, gethTypes.ReceiptStatusSuccessful, receipt.Status) - - // Get block header where transaction was included - header, err = l2Client.HeaderByNumber(ctx, receipt.BlockNumber) - require.NoError(t, err) - - // Get final balances after transaction - coinbaseEndBalance, err := l2Client.BalanceAt(ctx, header.Coinbase, header.Number) - require.NoError(t, err) - - endBalance, err := l2Client.BalanceAt(ctx, fromAddr, header.Number) - require.NoError(t, err) - - baseFeeRecipientEndBalance, err := l2Client.BalanceAt(ctx, predeploys.BaseFeeVaultAddr, header.Number) - require.NoError(t, err) - - operatorFeeVaultEndBalance, err := l2Client.BalanceAt(ctx, predeploys.OperatorFeeVaultAddr, header.Number) - require.NoError(t, err) - - l1FeeRecipientEndBalance, err := l2Client.BalanceAt(ctx, predeploys.L1FeeVaultAddr, header.Number) - require.NoError(t, err) - - sequencerFeeVaultEndBalance, err := l2Client.BalanceAt(ctx, predeploys.SequencerFeeVaultAddr, header.Number) - require.NoError(t, err) - - // Calculate differences in balances - baseFeeRecipientDiff := new(big.Int).Sub(baseFeeRecipientEndBalance, baseFeeRecipientStartBalance) - l1FeeRecipientDiff := new(big.Int).Sub(l1FeeRecipientEndBalance, l1FeeRecipientStartBalance) - sequencerFeeVaultDiff := new(big.Int).Sub(sequencerFeeVaultEndBalance, sequencerFeeVaultStartBalance) - coinbaseDiff := new(big.Int).Sub(coinbaseEndBalance, coinbaseStartBalance) - operatorFeeVaultDiff := new(big.Int).Sub(operatorFeeVaultEndBalance, operatorFeeVaultStartBalance) - - // Verify L2 fee - l2Fee := new(big.Int).Mul(gasTip, new(big.Int).SetUint64(receipt.GasUsed)) - require.Equal(t, sequencerFeeVaultDiff, coinbaseDiff, "coinbase is always sequencer fee vault") - require.Equal(t, l2Fee, coinbaseDiff, "l2 fee mismatch") - require.Equal(t, l2Fee, sequencerFeeVaultDiff) - - // Verify base fee - baseFee := new(big.Int).Mul(header.BaseFee, new(big.Int).SetUint64(receipt.GasUsed)) - require.Equal(t, baseFee, baseFeeRecipientDiff, "base fee mismatch") - - // Verify L1 fee - txBytes, err := tx.MarshalBinary() - require.NoError(t, err) - - // Calculate L1 fee based on transaction data and blocktime - l1Fee := l1CostFn(tx.RollupCostData(), header.Time) - require.Equal(t, l1Fee, l1FeeRecipientDiff, "L1 fee mismatch") - - // Calculate operator fee - expectedOperatorFee := operatorFeeFn(receipt.GasUsed, header.Time) - expectedOperatorFeeVaultEndBalance := new(big.Int).Sub(operatorFeeVaultStartBalance, expectedOperatorFee.ToBig()) - require.True(t, - operatorFeeVaultDiff.Cmp(expectedOperatorFee.ToBig()) == 0, - "operator fee mismatch: operator fee vault start balance %v, actual end balance %v, expected end balance %v", - operatorFeeVaultStartBalance, - operatorFeeVaultEndBalance, - expectedOperatorFeeVaultEndBalance, - ) - - gpoFjord, err := gpoContract.IsFjord(&bind.CallOpts{BlockNumber: header.Number}) - require.NoError(t, err) - require.True(t, gpoFjord, "GPO must report Fjord") - // Verify gas price oracle L1 fee calculation - gpoL1Fee, err := gpoContract.GetL1Fee(&bind.CallOpts{BlockNumber: header.Number}, txBytes) - require.NoError(t, err) - require.Equal(t, l1Fee, gpoL1Fee, "GPO reports L1 fee mismatch") + signedTx, err := dsl.FindSignedTransactionFromReceipt(ctx, l2Client, result.TransactionReceipt) + require.NoError(err) + require.NotNil(signedTx) - // Verify receipt L1 fee - require.Equal(t, receipt.L1Fee, l1Fee, "l1 fee in receipt is correct") + unsignedTx, err := dsl.CreateUnsignedTransactionFromSigned(signedTx) + require.NoError(err) - // Calculate total fee and verify wallet balance difference - totalFeeRecipient := new(big.Int).Add(baseFeeRecipientDiff, sequencerFeeVaultDiff) - totalFee := new(big.Int).Add(totalFeeRecipient, l1FeeRecipientDiff) - totalFee = new(big.Int).Add(totalFee, operatorFeeVaultDiff) + txUnsigned, err := unsignedTx.MarshalBinary() + require.NoError(err) - balanceDiff := new(big.Int).Sub(startBalance, endBalance) - balanceDiff.Sub(balanceDiff, transferAmount) - require.Equal(t, balanceDiff, totalFee, "balances should add up") - } + gpoL1Fee, err := dsl.ReadGasPriceOracleL1FeeAt(ctx, l2Client, gpo, txUnsigned, result.TransactionReceipt.BlockHash) + require.NoError(err) + dsl.ValidateL1FeeMatches(t, result.L1Fee, gpoL1Fee) } diff --git a/op-acceptance-tests/tests/fjord/init_test.go b/op-acceptance-tests/tests/fjord/init_test.go new file mode 100644 index 00000000000..c66034f06f1 --- /dev/null +++ b/op-acceptance-tests/tests/fjord/init_test.go @@ -0,0 +1,13 @@ +package fjord + +import ( + "testing" + + "github.com/ethereum-optimism/optimism/op-devstack/presets" +) + +func TestMain(m *testing.M) { + presets.DoMain(m, + presets.WithMinimal(), + ) +} diff --git a/op-acceptance-tests/tests/flashblocks/flashblocks_transfer_test.go b/op-acceptance-tests/tests/flashblocks/flashblocks_transfer_test.go index 86a8a070bcc..0761c870ba9 100644 --- a/op-acceptance-tests/tests/flashblocks/flashblocks_transfer_test.go +++ b/op-acceptance-tests/tests/flashblocks/flashblocks_transfer_test.go @@ -94,7 +94,7 @@ func TestFlashblocksTransfer(gt *testing.T) { executedTransaction = alice.Transact( alice.Plan(), txplan.WithTo(&bobAddr), - txplan.WithValue(depositAmount.ToBig()), + txplan.WithValue(depositAmount), ) transactionApproxConfirmationTime = time.Now() newBobBalance := bobBalance.Add(depositAmount) diff --git a/op-acceptance-tests/tests/interop/interop_smoke_test.go b/op-acceptance-tests/tests/interop/interop_smoke_test.go deleted file mode 100644 index 2fa1be41b36..00000000000 --- a/op-acceptance-tests/tests/interop/interop_smoke_test.go +++ /dev/null @@ -1,96 +0,0 @@ -package interop - -import ( - "context" - "math/big" - "testing" - - "github.com/ethereum-optimism/optimism/devnet-sdk/contracts/constants" - "github.com/ethereum-optimism/optimism/devnet-sdk/system" - "github.com/ethereum-optimism/optimism/devnet-sdk/testing/systest" - "github.com/ethereum-optimism/optimism/devnet-sdk/testing/testlib/validators" - sdktypes "github.com/ethereum-optimism/optimism/devnet-sdk/types" - "github.com/ethereum-optimism/optimism/op-service/testlog" - "github.com/ethereum/go-ethereum/common" - "github.com/ethereum/go-ethereum/log" - "github.com/stretchr/testify/require" -) - -func smokeTestScenario(chainIdx uint64, walletGetter validators.WalletGetter) systest.SystemTestFunc { - return func(t systest.T, sys system.System) { - ctx := t.Context() - - logger := testlog.Logger(t, log.LevelInfo) - logger = logger.With("test", "TestMinimal", "devnet", sys.Identifier()) - - chain := sys.L2s()[chainIdx] - logger = logger.With("chain", chain.ID()) - logger.Info("starting test") - - funds := sdktypes.NewBalance(big.NewInt(1 * constants.ETH)) - user := walletGetter(ctx) - - wethAddr := constants.WETH - weth, err := chain.Nodes()[0].ContractsRegistry().WETH(wethAddr) - require.NoError(t, err) - initialBalance, err := weth.BalanceOf(user.Address()).Call(ctx) - require.NoError(t, err) - logger = logger.With("user", user.Address()) - logger.Info("initial balance retrieved", "balance", initialBalance) - - logger.Info("sending ETH to contract", "amount", funds) - require.NoError(t, user.SendETH(wethAddr, funds).Send(ctx).Wait()) - - balance, err := weth.BalanceOf(user.Address()).Call(ctx) - require.NoError(t, err) - logger.Info("final balance retrieved", "balance", balance) - - require.Equal(t, initialBalance.Add(funds), balance) - } -} - -func TestInteropSystemNoop(t *testing.T) { - systest.InteropSystemTest(t, func(t systest.T, sys system.InteropSystem) { - testlog.Logger(t, log.LevelInfo).Info("noop") - }) -} - -func TestSmokeTestFailure(t *testing.T) { - // Create mock failing system - mockAddr := common.HexToAddress("0x1234567890123456789012345678901234567890") - mockWallet := &mockFailingWallet{ - addr: mockAddr, - bal: sdktypes.NewBalance(big.NewInt(0.1 * constants.ETH)), - } - mockL1Chain := newMockFailingL1Chain( - sdktypes.ChainID(big.NewInt(1234)), - system.WalletMap{ - "user1": mockWallet, - }, - []system.Node{&mockFailingNode{ - reg: &mockContractsRegistry{}, - }}, - ) - mockL2Chain := newMockFailingL2Chain( - sdktypes.ChainID(big.NewInt(1234)), - system.WalletMap{"user1": mockWallet}, - []system.Node{&mockFailingNode{ - reg: &mockContractsRegistry{}, - }}, - ) - mockSys := &mockFailingSystem{l1Chain: mockL1Chain, l2Chain: mockL2Chain} - - // Run the smoke test logic and capture failures - getter := func(ctx context.Context) system.Wallet { - return mockWallet - } - rt := NewRecordingT(context.TODO()) - rt.TestScenario( - smokeTestScenario(0, getter), - mockSys, - ) - - // Verify that the test failed due to SendETH error - require.True(t, rt.Failed(), "test should have failed") - require.Contains(t, rt.Logs(), "transaction failure", "unexpected failure message") -} diff --git a/op-acceptance-tests/tests/interop/loadtest/invalid_msg_test.go b/op-acceptance-tests/tests/interop/loadtest/invalid_msg_test.go index 5899e4631b9..f6d70fd8905 100644 --- a/op-acceptance-tests/tests/interop/loadtest/invalid_msg_test.go +++ b/op-acceptance-tests/tests/interop/loadtest/invalid_msg_test.go @@ -73,7 +73,7 @@ func NewInvalidExecMsgSpammer(t devtest.T, l2 *L2, validInitMsg suptypes.Message // any wei, but we don't want to trigger mempool balance checks. eoa := l2.Wallet.NewEOA(l2.EL) address := eoa.Address() - _, err := l2.Include(t, txplan.WithValue(eth.OneHundredthEther.ToBig()), txplan.WithTo(&address)) + _, err := l2.Include(t, txplan.WithValue(eth.OneHundredthEther), txplan.WithTo(&address)) t.Require().NoError(err) // The InvalidExecutor uses a txinclude.Includer to manage nonces concurrently. It uses a diff --git a/op-acceptance-tests/tests/interop/message/supervisor_smoke_test.go b/op-acceptance-tests/tests/interop/message/supervisor_smoke_test.go index 59cc56d3092..36d9817eacc 100644 --- a/op-acceptance-tests/tests/interop/message/supervisor_smoke_test.go +++ b/op-acceptance-tests/tests/interop/message/supervisor_smoke_test.go @@ -12,13 +12,26 @@ func TestInteropSystemSupervisor(gt *testing.T) { t := devtest.ParallelT(gt) sys := presets.NewSimpleInterop(t) - sys.L1Network.WaitForFinalization() + // First ensure L1 network is online and has blocks + t.Log("Waiting for L1 network to be online...") + sys.L1Network.WaitForOnline() + t.Log("L1 network is online") + + t.Log("Waiting for initial L1 block...") + initialBlock := sys.L1Network.WaitForBlock() + t.Log("Got initial L1 block", "block", initialBlock) + + // Wait for finalization (this may take some time) + t.Log("Waiting for L1 block finalization...") + finalizedBlock := sys.L1Network.WaitForFinalization() + t.Log("L1 block finalized", "block", finalizedBlock) // Get the finalized L1 block from the supervisor + t.Log("Querying supervisor for finalized L1 block...") block, err := sys.Supervisor.Escape().QueryAPI().FinalizedL1(t.Ctx()) - t.Require().NoError(err) + t.Require().NoError(err, "Failed to get finalized block from supervisor") // If we get here, the supervisor has finalized L1 block information - t.Require().NotNil(block) - t.Log("finalized l1 block", "block", block) + t.Require().NotNil(block, "Supervisor returned nil finalized block") + t.Log("Successfully got finalized L1 block from supervisor", "block", block) } diff --git a/op-acceptance-tests/tests/interop/mocks_test.go b/op-acceptance-tests/tests/interop/mocks_test.go deleted file mode 100644 index fe41f0d545a..00000000000 --- a/op-acceptance-tests/tests/interop/mocks_test.go +++ /dev/null @@ -1,396 +0,0 @@ -package interop - -import ( - "bytes" - "context" - "fmt" - "math/big" - "os" - "runtime" - "time" - - "github.com/ethereum-optimism/optimism/devnet-sdk/contracts/bindings" - "github.com/ethereum-optimism/optimism/devnet-sdk/contracts/registry/empty" - "github.com/ethereum-optimism/optimism/devnet-sdk/interfaces" - "github.com/ethereum-optimism/optimism/devnet-sdk/system" - "github.com/ethereum-optimism/optimism/devnet-sdk/testing/systest" - "github.com/ethereum-optimism/optimism/devnet-sdk/types" - "github.com/ethereum-optimism/optimism/op-service/eth" - "github.com/ethereum-optimism/optimism/op-service/sources" - "github.com/ethereum/go-ethereum/accounts/abi/bind" - "github.com/ethereum/go-ethereum/common" - "github.com/ethereum/go-ethereum/ethclient" - "github.com/ethereum/go-ethereum/params" -) - -var ( - // Ensure mockFailingTx implements WriteInvocation - _ types.WriteInvocation[any] = (*mockFailingTx)(nil) - - // Ensure mockFailingTx implements Wallet - _ system.Wallet = (*mockFailingWallet)(nil) - - // Ensure mockFailingChain implements Chain - _ system.Chain = (*mockFailingChain)(nil) - _ system.L2Chain = (*mockFailingL2Chain)(nil) -) - -// mockFailingTx implements types.WriteInvocation[any] that always fails -type mockFailingTx struct{} - -func (m *mockFailingTx) Call(ctx context.Context) (any, error) { - return nil, fmt.Errorf("simulated transaction failure") -} - -func (m *mockFailingTx) Send(ctx context.Context) types.InvocationResult { - return m -} - -func (m *mockFailingTx) Error() error { - return fmt.Errorf("transaction failure") -} - -func (m *mockFailingTx) Wait() error { - return fmt.Errorf("transaction failure") -} - -func (m *mockFailingTx) Info() any { - return nil -} - -// mockFailingWallet implements types.Wallet that fails on SendETH -type mockFailingWallet struct { - addr types.Address - key types.Key - bal types.Balance -} - -func (m *mockFailingWallet) Client() *ethclient.Client { - return nil -} - -func (m *mockFailingWallet) Address() types.Address { - return m.addr -} - -func (m *mockFailingWallet) PrivateKey() types.Key { - return m.key -} - -func (m *mockFailingWallet) Balance() types.Balance { - return m.bal -} - -func (m *mockFailingWallet) SendETH(to types.Address, amount types.Balance) types.WriteInvocation[any] { - return &mockFailingTx{} -} - -func (m *mockFailingWallet) InitiateMessage(chainID types.ChainID, target common.Address, message []byte) types.WriteInvocation[any] { - return &mockFailingTx{} -} - -func (m *mockFailingWallet) ExecuteMessage(identifier bindings.Identifier, sentMessage []byte) types.WriteInvocation[any] { - return &mockFailingTx{} -} - -func (m *mockFailingWallet) Nonce() uint64 { - return 0 -} - -func (m *mockFailingWallet) Sign(tx system.Transaction) (system.Transaction, error) { - return tx, nil -} - -func (m *mockFailingWallet) Send(ctx context.Context, tx system.Transaction) error { - return nil -} - -func (m *mockFailingWallet) Transactor() *bind.TransactOpts { - return nil -} - -// mockContractsRegistry extends empty.EmptyRegistry to provide mock contract instances -type mockContractsRegistry struct { - empty.EmptyRegistry -} - -// mockWETH implements a minimal WETH interface for testing -type mockWETH struct { - addr types.Address -} - -func (m *mockWETH) BalanceOf(account types.Address) types.ReadInvocation[types.Balance] { - return &mockReadInvocation{balance: types.NewBalance(big.NewInt(0))} -} - -// mockReadInvocation implements a read invocation that returns a fixed balance -type mockReadInvocation struct { - balance types.Balance -} - -func (m *mockReadInvocation) Call(ctx context.Context) (types.Balance, error) { - return m.balance, nil -} - -func (r *mockContractsRegistry) WETH(address types.Address) (interfaces.WETH, error) { - return &mockWETH{addr: address}, nil -} - -// mockFailingChain implements system.Chain with a failing SendETH -type mockFailingChain struct { - id types.ChainID - wallets system.WalletMap - nodes []system.Node -} - -var _ system.Chain = (*mockFailingChain)(nil) - -func newMockFailingL1Chain(id types.ChainID, wallets system.WalletMap, nodes []system.Node) *mockFailingChain { - return &mockFailingChain{ - id: id, - wallets: wallets, - nodes: nodes, - } -} - -func (m *mockFailingChain) Nodes() []system.Node { return m.nodes } -func (m *mockFailingChain) ID() types.ChainID { return m.id } -func (m *mockFailingChain) Wallets() system.WalletMap { - return m.wallets -} -func (m *mockFailingChain) Config() (*params.ChainConfig, error) { - return nil, fmt.Errorf("not implemented") -} -func (m *mockFailingChain) Addresses() system.AddressMap { - return map[string]common.Address{} -} - -var _ system.Node = (*mockFailingNode)(nil) - -type mockFailingNode struct { - reg interfaces.ContractsRegistry -} - -func (m *mockFailingNode) Client() (*sources.EthClient, error) { - return nil, fmt.Errorf("not implemented") -} -func (m *mockFailingNode) GasPrice(ctx context.Context) (*big.Int, error) { - return big.NewInt(1), nil -} -func (m *mockFailingNode) GasLimit(ctx context.Context, tx system.TransactionData) (uint64, error) { - return 1000000, nil -} -func (m *mockFailingNode) PendingNonceAt(ctx context.Context, address common.Address) (uint64, error) { - return 0, nil -} -func (m *mockFailingNode) SupportsEIP(ctx context.Context, eip uint64) bool { - return true -} -func (m *mockFailingNode) RPCURL() string { return "mock://failing" } -func (m *mockFailingNode) ContractsRegistry() interfaces.ContractsRegistry { return m.reg } -func (m *mockFailingNode) GethClient() (*ethclient.Client, error) { - return nil, fmt.Errorf("not implemented") -} -func (m *mockFailingNode) BlockByNumber(ctx context.Context, number *big.Int) (eth.BlockInfo, error) { - return nil, fmt.Errorf("not implemented") -} -func (m *mockFailingNode) Name() string { - return "mock" -} - -// mockFailingChain implements system.Chain with a failing SendETH -type mockFailingL2Chain struct { - mockFailingChain -} - -func newMockFailingL2Chain(id types.ChainID, wallets system.WalletMap, nodes []system.Node) *mockFailingL2Chain { - return &mockFailingL2Chain{ - mockFailingChain: mockFailingChain{ - id: id, - wallets: wallets, - nodes: nodes, - }, - } -} - -func (m *mockFailingL2Chain) L1Addresses() system.AddressMap { - return map[string]common.Address{} -} -func (m *mockFailingL2Chain) L1Wallets() system.WalletMap { - return map[string]system.Wallet{} -} - -// mockFailingSystem implements system.System -type mockFailingSystem struct { - l1Chain system.Chain - l2Chain system.L2Chain -} - -func (m *mockFailingSystem) Identifier() string { - return "mock-failing-system" -} - -func (m *mockFailingSystem) L1() system.Chain { - return m.l1Chain -} - -func (m *mockFailingSystem) L2s() []system.L2Chain { - return []system.L2Chain{m.l2Chain} -} - -func (m *mockFailingSystem) Close() error { - return nil -} - -// recordingT implements systest.T and records failures -type RecordingT struct { - failed bool - skipped bool - logs *bytes.Buffer - cleanup []func() - ctx context.Context -} - -func NewRecordingT(ctx context.Context) *RecordingT { - return &RecordingT{ - logs: bytes.NewBuffer(nil), - ctx: ctx, - } -} - -var _ systest.T = (*RecordingT)(nil) - -func (r *RecordingT) Context() context.Context { - return r.ctx -} - -func (r *RecordingT) WithContext(ctx context.Context) systest.T { - return &RecordingT{ - failed: r.failed, - skipped: r.skipped, - logs: r.logs, - cleanup: r.cleanup, - ctx: ctx, - } -} - -func (r *RecordingT) Deadline() (deadline time.Time, ok bool) { - // TODO - return time.Time{}, false -} - -func (r *RecordingT) Parallel() { - // TODO -} - -func (r *RecordingT) Run(name string, f func(systest.T)) { - // TODO -} - -func (r *RecordingT) Cleanup(f func()) { - r.cleanup = append(r.cleanup, f) -} - -func (r *RecordingT) Error(args ...interface{}) { - r.Log(args...) - r.Fail() -} - -func (r *RecordingT) Errorf(format string, args ...interface{}) { - r.Logf(format, args...) - r.Fail() -} - -func (r *RecordingT) Fatal(args ...interface{}) { - r.Log(args...) - r.FailNow() -} - -func (r *RecordingT) Fatalf(format string, args ...interface{}) { - r.Logf(format, args...) - r.FailNow() -} - -func (r *RecordingT) FailNow() { - r.Fail() - runtime.Goexit() -} - -func (r *RecordingT) Fail() { - r.failed = true -} - -func (r *RecordingT) Failed() bool { - return r.failed -} - -func (r *RecordingT) Helper() { - // TODO -} - -func (r *RecordingT) Log(args ...interface{}) { - fmt.Fprintln(r.logs, args...) -} - -func (r *RecordingT) Logf(format string, args ...interface{}) { - fmt.Fprintf(r.logs, format, args...) - fmt.Fprintln(r.logs) -} - -func (r *RecordingT) Name() string { - return "RecordingT" // TODO -} - -func (r *RecordingT) Setenv(key, value string) { - // Store original value - origValue, exists := os.LookupEnv(key) - - // Set new value - os.Setenv(key, value) - - // Register cleanup to restore original value - r.Cleanup(func() { - if exists { - os.Setenv(key, origValue) - } else { - os.Unsetenv(key) - } - }) - -} - -func (r *RecordingT) Skip(args ...interface{}) { - r.Log(args...) - r.SkipNow() -} - -func (r *RecordingT) SkipNow() { - r.skipped = true -} - -func (r *RecordingT) Skipf(format string, args ...interface{}) { - r.Logf(format, args...) - r.skipped = true -} - -func (r *RecordingT) Skipped() bool { - return r.skipped -} - -func (r *RecordingT) TempDir() string { - return "" // TODO -} - -func (r *RecordingT) Logs() string { - return r.logs.String() -} - -func (r *RecordingT) TestScenario(scenario systest.SystemTestFunc, sys system.System, values ...interface{}) { - // run in a separate goroutine so we can handle runtime.Goexit() - done := make(chan struct{}) - go func() { - defer close(done) - scenario(r, sys) - }() - <-done -} diff --git a/op-acceptance-tests/tests/interop/proofs/challenger_test.go b/op-acceptance-tests/tests/interop/proofs/challenger_test.go index 26f24267d65..a1cbbabf625 100644 --- a/op-acceptance-tests/tests/interop/proofs/challenger_test.go +++ b/op-acceptance-tests/tests/interop/proofs/challenger_test.go @@ -4,8 +4,10 @@ import ( "testing" "github.com/ethereum-optimism/optimism/op-devstack/dsl" + "github.com/ethereum-optimism/optimism/op-devstack/dsl/proofs" "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types" "github.com/ethereum/go-ethereum/common" + "github.com/stretchr/testify/require" "github.com/ethereum-optimism/optimism/op-devstack/devtest" "github.com/ethereum-optimism/optimism/op-devstack/presets" @@ -13,7 +15,6 @@ import ( ) func TestChallengerPlaysGame(gt *testing.T) { - // Setup t := devtest.ParallelT(gt) sys := presets.NewSimpleInterop(t) dsl.CheckAll(t, @@ -25,7 +26,7 @@ func TestChallengerPlaysGame(gt *testing.T) { attacker := sys.FunderL1.NewFundedEOA(eth.Ether(15)) dgf := sys.DisputeGameFactory() - game := dgf.StartSuperCannonGame(attacker, badClaim) + game := dgf.StartSuperCannonGame(attacker, proofs.WithRootClaim(badClaim)) claim := game.RootClaim() // This is the bad claim from attacker counterClaim := claim.WaitForCounterClaim() // This is the counter-claim from the challenger @@ -35,3 +36,52 @@ func TestChallengerPlaysGame(gt *testing.T) { counterClaim = claim.WaitForCounterClaim() } } + +func TestChallengerRespondsToMultipleInvalidClaims(gt *testing.T) { + t := devtest.ParallelT(gt) + sys := presets.NewSimpleInterop(t) + dsl.CheckAll(t, + sys.L2CLA.AdvancedFn(types.CrossSafe, 1, 30), + sys.L2CLB.AdvancedFn(types.CrossSafe, 1, 30), + ) + + attacker := sys.FunderL1.NewFundedEOA(eth.TenEther) + dgf := sys.DisputeGameFactory() + + game := dgf.StartSuperCannonGame(attacker) + claims := game.PerformMoves(attacker, + proofs.Move(0, common.Hash{0x01}, true), + proofs.Move(1, common.Hash{0x03}, true), + proofs.Move(1, common.Hash{0x02}, false), // Defends invalid claim so won't be countered. + ) + + claims[0].WaitForCounterClaim(claims...) + claims[1].WaitForCounterClaim(claims...) + claims[2].VerifyNoCounterClaim() +} + +func TestChallengerRespondsToMultipleInvalidClaimsEOA(gt *testing.T) { + t := devtest.ParallelT(gt) + sys := presets.NewSimpleInterop(t) + dsl.CheckAll(t, + sys.L2CLA.AdvancedFn(types.CrossSafe, 1, 30), + sys.L2CLB.AdvancedFn(types.CrossSafe, 1, 30), + ) + + dgf := sys.DisputeGameFactory() + attacker := dgf.CreateHelperEOA(sys.FunderL1.NewFundedEOA(eth.TenEther)) + + game := dgf.StartSuperCannonGame(attacker.EOA) + claims := attacker.PerformMoves(game.FaultDisputeGame, + proofs.Move(0, common.Hash{0x01}, true), + proofs.Move(1, common.Hash{0x03}, true), + proofs.Move(1, common.Hash{0x02}, false), // Defends invalid claim so won't be countered. + ) + + claims[0].WaitForCounterClaim(claims...) + claims[1].WaitForCounterClaim(claims...) + claims[2].VerifyNoCounterClaim() + for _, claim := range claims { + require.Equal(t, attacker.Address(), claim.Claimant()) + } +} diff --git a/op-acceptance-tests/tests/interop/proofs/withdrawal/withdrawal_test.go b/op-acceptance-tests/tests/interop/proofs/withdrawal/withdrawal_test.go index c0acd53d599..eff0185c165 100644 --- a/op-acceptance-tests/tests/interop/proofs/withdrawal/withdrawal_test.go +++ b/op-acceptance-tests/tests/interop/proofs/withdrawal/withdrawal_test.go @@ -29,6 +29,9 @@ func TestSuperRootWithdrawal(gt *testing.T) { l1User.VerifyBalanceExact(initialL1Balance.Sub(depositAmount).Sub(deposit.GasCost())) l2User.VerifyBalanceExact(initialL2Balance.Add(depositAmount)) + // Wait for a block to ensure nonce synchronization between L1 and L2 EOA instances + sys.L2ChainA.WaitForBlock() + withdrawal := bridge.InitiateWithdrawal(withdrawalAmount, l2User) withdrawal.Prove(l1User) l2User.VerifyBalanceExact(initialL2Balance.Add(depositAmount).Sub(withdrawalAmount).Sub(withdrawal.InitiateGasCost())) diff --git a/op-acceptance-tests/tests/interop/smoke/interop_smoke_test.go b/op-acceptance-tests/tests/interop/smoke/interop_smoke_test.go new file mode 100644 index 00000000000..c056b52b780 --- /dev/null +++ b/op-acceptance-tests/tests/interop/smoke/interop_smoke_test.go @@ -0,0 +1,89 @@ +package smoke + +import ( + "testing" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/presets" + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum-optimism/optimism/op-service/predeploys" + txib "github.com/ethereum-optimism/optimism/op-service/txintent/bindings" + "github.com/ethereum-optimism/optimism/op-service/txintent/contractio" + "github.com/ethereum/go-ethereum/core/types" +) + +func TestInteropSystemNoop(gt *testing.T) { + t := devtest.SerialT(gt) + _ = presets.NewMinimal(t) + t.Log("noop") +} + +func TestSmokeTest(gt *testing.T) { + t := devtest.SerialT(gt) + sys := presets.NewMinimal(t) + require := t.Require() + ctx := t.Ctx() + + user := sys.FunderL2.NewFundedEOA(eth.OneTenthEther) + + l2Client := sys.L2EL.Escape().EthClient() + weth := txib.NewBindings[txib.WETH]( + txib.WithClient(l2Client), + txib.WithTo(predeploys.WETHAddr), + txib.WithTest(t), + ) + + initialBalance, err := contractio.Read(weth.BalanceOf(user.Address()), ctx) + require.NoError(err) + t.Logf("Initial WETH balance: %s", initialBalance) + + depositAmount := eth.OneHundredthEther + + tx := user.Transfer(predeploys.WETHAddr, depositAmount) + receipt, err := tx.Included.Eval(ctx) + require.NoError(err) + require.Equal(types.ReceiptStatusSuccessful, receipt.Status) + t.Logf("Deposited %s ETH to WETH contract", depositAmount) + + finalBalance, err := contractio.Read(weth.BalanceOf(user.Address()), ctx) + require.NoError(err) + t.Logf("Final WETH balance: %s", finalBalance) + + expectedBalance := initialBalance.Add(depositAmount) + require.Equal(expectedBalance, finalBalance, "WETH balance should have increased by deposited amount") +} + +func TestSmokeTestFailure(gt *testing.T) { + t := devtest.SerialT(gt) + sys := presets.NewMinimal(t) + require := t.Require() + ctx := t.Ctx() + + user := sys.FunderL2.NewFundedEOA(eth.OneTenthEther) + + l2Client := sys.L2EL.Escape().EthClient() + weth := txib.NewBindings[txib.WETH]( + txib.WithClient(l2Client), + txib.WithTo(predeploys.WETHAddr), + txib.WithTest(t), + ) + + initialBalance, err := contractio.Read(weth.BalanceOf(user.Address()), ctx) + require.NoError(err) + t.Logf("Initial WETH balance: %s", initialBalance) + + depositAmount := eth.OneEther + + userBalance := user.GetBalance() + t.Logf("User balance: %s", userBalance) + + require.True(userBalance.Lt(depositAmount), "user should have insufficient funds for this transaction") + + t.Logf("user has insufficient funds: balance=%s, required=%s", userBalance, depositAmount) + + finalBalance, err := contractio.Read(weth.BalanceOf(user.Address()), ctx) + require.NoError(err) + t.Logf("Final WETH balance: %s", finalBalance) + + require.Equal(initialBalance, finalBalance, "WETH balance should not have changed") +} diff --git a/op-acceptance-tests/tests/interop/sync/multisupervisor_interop/interop_sync_test.go b/op-acceptance-tests/tests/interop/sync/multisupervisor_interop/interop_sync_test.go index 1190322cc1e..e7dc6dbadee 100644 --- a/op-acceptance-tests/tests/interop/sync/multisupervisor_interop/interop_sync_test.go +++ b/op-acceptance-tests/tests/interop/sync/multisupervisor_interop/interop_sync_test.go @@ -1,3 +1,5 @@ +//go:build !ci + package sync import ( @@ -202,6 +204,8 @@ func TestUnsafeChainKnownToL2CL(gt *testing.T) { // TestUnsafeChainUnknownToL2CL tests the below scenario: // supervisor unsafe ahead of L2CL unsafe, aka L2CL processes new blocks first. func TestUnsafeChainUnknownToL2CL(gt *testing.T) { + gt.Skip("TODO(#16972): skipping due to flakiness and impending op-node/supervisor refactor") + t := devtest.SerialT(gt) sys := presets.NewMultiSupervisorInterop(t) diff --git a/op-acceptance-tests/tests/interop/sync/simple_interop/interop_sync_test.go b/op-acceptance-tests/tests/interop/sync/simple_interop/interop_sync_test.go index 95fe56b4dc6..f7dcd44e6a0 100644 --- a/op-acceptance-tests/tests/interop/sync/simple_interop/interop_sync_test.go +++ b/op-acceptance-tests/tests/interop/sync/simple_interop/interop_sync_test.go @@ -1,3 +1,5 @@ +//go:build !ci + package sync import ( diff --git a/op-acceptance-tests/tests/interop/upgrade/post_test.go b/op-acceptance-tests/tests/interop/upgrade/post_test.go index 6ec1266d1fe..4531c9a2334 100644 --- a/op-acceptance-tests/tests/interop/upgrade/post_test.go +++ b/op-acceptance-tests/tests/interop/upgrade/post_test.go @@ -1,3 +1,5 @@ +//go:build !ci + package upgrade import ( @@ -40,7 +42,7 @@ func TestPostInbox(gt *testing.T) { } func TestPostInteropUpgradeComprehensive(gt *testing.T) { - t := devtest.ParallelT(gt) + t := devtest.SerialT(gt) sys := presets.NewSimpleInterop(t) require := t.Require() logger := t.Logger() diff --git a/op-acceptance-tests/tests/interop/upgrade/pre_test.go b/op-acceptance-tests/tests/interop/upgrade/pre_test.go index 4eea3a7d813..8f5f23567fa 100644 --- a/op-acceptance-tests/tests/interop/upgrade/pre_test.go +++ b/op-acceptance-tests/tests/interop/upgrade/pre_test.go @@ -1,3 +1,5 @@ +//go:build !ci + package upgrade import ( @@ -21,6 +23,8 @@ import ( stypes "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types" ) +// This test is known to be flaky +// See: https://github.com/ethereum-optimism/optimism/issues/17298 func TestPreNoInbox(gt *testing.T) { t := devtest.ParallelT(gt) sys := presets.NewSimpleInterop(t) diff --git a/op-acceptance-tests/tests/isthmus/erc20_bridge/erc20_bridge_test.go b/op-acceptance-tests/tests/isthmus/erc20_bridge/erc20_bridge_test.go index 969b380ab1f..9667fcf4a52 100644 --- a/op-acceptance-tests/tests/isthmus/erc20_bridge/erc20_bridge_test.go +++ b/op-acceptance-tests/tests/isthmus/erc20_bridge/erc20_bridge_test.go @@ -38,16 +38,16 @@ func TestERC20Bridge(gt *testing.T) { mintAmount := eth.OneHundredthEther t.Logger().Info("Minting WETH tokens on L1", "amount", mintAmount) depositCall := wethContract.Deposit() - contract.Write(l1User, depositCall, txplan.WithValue(mintAmount.ToBig())) + contract.Write(l1User, depositCall, txplan.WithValue(mintAmount)) - l1User.VerifyTokenBalance(l1TokenAddress, mintAmount) + l1User.WaitForTokenBalance(l1TokenAddress, mintAmount) t.Logger().Info("User has WETH tokens on L1", "balance", mintAmount) bridge := dsl.NewStandardBridge(t, sys.L2Chain, nil, sys.L1EL) l2TokenAddress := bridge.CreateL2Token(l1TokenAddress, "L2 WETH", "L2WETH", l2User) t.Logger().Info("Created L2 token", "address", l2TokenAddress) - l2User.VerifyTokenBalance(l2TokenAddress, eth.ZeroWei) + l2User.WaitForTokenBalance(l2TokenAddress, eth.ZeroWei) l1BridgeAddress := sys.L2Chain.Escape().Deployment().L1StandardBridgeProxyAddr() @@ -63,7 +63,6 @@ func TestERC20Bridge(gt *testing.T) { t.Logger().Info("Waiting for deposit to be processed on L2...") l2User.WaitForTokenBalance(l2TokenAddress, bridgeAmount) - l2User.VerifyTokenBalance(l2TokenAddress, bridgeAmount) t.Logger().Info("Successfully verified tokens on L2", "balance", bridgeAmount) t.Logger().Info("ERC20 bridge test completed successfully!") diff --git a/op-acceptance-tests/tests/isthmus/operator_fee/balance_reader.go b/op-acceptance-tests/tests/isthmus/operator_fee/balance_reader.go index da92bed647b..83ca3f94b03 100644 --- a/op-acceptance-tests/tests/isthmus/operator_fee/balance_reader.go +++ b/op-acceptance-tests/tests/isthmus/operator_fee/balance_reader.go @@ -4,7 +4,7 @@ import ( "context" "math/big" - "github.com/ethereum-optimism/optimism/devnet-sdk/testing/systest" + "github.com/ethereum-optimism/optimism/op-devstack/devtest" "github.com/ethereum-optimism/optimism/op-service/predeploys" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/ethclient" @@ -15,12 +15,12 @@ import ( // BalanceReader provides methods to read balances from the chain type BalanceReader struct { client *ethclient.Client - t systest.T + t devtest.T logger log.Logger } // NewBalanceReader creates a new BalanceReader instance -func NewBalanceReader(t systest.T, client *ethclient.Client, logger log.Logger) *BalanceReader { +func NewBalanceReader(t devtest.T, client *ethclient.Client, logger log.Logger) *BalanceReader { return &BalanceReader{ client: client, t: t, diff --git a/op-acceptance-tests/tests/isthmus/operator_fee/balance_snapshot.go b/op-acceptance-tests/tests/isthmus/operator_fee/balance_snapshot.go index f67dee9382c..8f582564fac 100644 --- a/op-acceptance-tests/tests/isthmus/operator_fee/balance_snapshot.go +++ b/op-acceptance-tests/tests/isthmus/operator_fee/balance_snapshot.go @@ -4,7 +4,7 @@ import ( "fmt" "math/big" - "github.com/ethereum-optimism/optimism/devnet-sdk/testing/systest" + "github.com/ethereum-optimism/optimism/op-devstack/devtest" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) @@ -72,7 +72,7 @@ func (bs *BalanceSnapshot) Sub(start *BalanceSnapshot) *BalanceSnapshot { } // AssertSnapshotsEqual compares two balance snapshots and reports differences -func AssertSnapshotsEqual(t systest.T, expected, actual *BalanceSnapshot) { +func AssertSnapshotsEqual(t devtest.T, expected, actual *BalanceSnapshot) { require.NotNil(t, expected, "Expected snapshot should not be nil") require.NotNil(t, actual, "Actual snapshot should not be nil") @@ -96,3 +96,17 @@ func AssertSnapshotsEqual(t systest.T, expected, actual *BalanceSnapshot) { assert.True(t, expected.FromBalance.Cmp(actual.FromBalance) == 0, "WalletBalance mismatch: expected %v, got %v (diff: %v)", expected.FromBalance, actual.FromBalance, new(big.Int).Sub(actual.FromBalance, expected.FromBalance)) } + +// SnapshotsEqual compares two balance snapshots and returns true if they are equal +// This is a non-asserting version for unit tests +func SnapshotsEqual(expected, actual *BalanceSnapshot) bool { + if expected == nil || actual == nil { + return expected == actual + } + + return expected.BaseFeeVaultBalance.Cmp(actual.BaseFeeVaultBalance) == 0 && + expected.L1FeeVaultBalance.Cmp(actual.L1FeeVaultBalance) == 0 && + expected.SequencerFeeVault.Cmp(actual.SequencerFeeVault) == 0 && + expected.OperatorFeeVault.Cmp(actual.OperatorFeeVault) == 0 && + expected.FromBalance.Cmp(actual.FromBalance) == 0 +} diff --git a/op-acceptance-tests/tests/isthmus/operator_fee/balance_snapshot_test.go b/op-acceptance-tests/tests/isthmus/operator_fee/balance_snapshot_test.go index e4991c566b1..1e55e703c1f 100644 --- a/op-acceptance-tests/tests/isthmus/operator_fee/balance_snapshot_test.go +++ b/op-acceptance-tests/tests/isthmus/operator_fee/balance_snapshot_test.go @@ -4,7 +4,6 @@ import ( "math/big" "testing" - "github.com/ethereum-optimism/optimism/devnet-sdk/testing/systest" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) @@ -187,102 +186,42 @@ func TestBalanceSnapshot_Sub(t *testing.T) { }) } -// mockTB is a minimal testing.TB implementation for checking assertion failures -// without failing the actual test. -type mockTB struct { - testing.TB // Embed standard testing.TB for most methods (like Logf) - failed bool -} - -func (m *mockTB) Helper() { m.TB.Helper() } -func (m *mockTB) Errorf(string, ...any) { m.failed = true } // Just record failure -func (m *mockTB) Fatalf(string, ...any) { m.failed = true; panic("mock Fatalf") } // Record failure and panic -func (m *mockTB) FailNow() { m.failed = true; panic("mock FailNow") } // Record failure and panic -func (m *mockTB) Fail() { m.failed = true } // Just record failure -func (m *mockTB) Name() string { return m.TB.Name() } -func (m *mockTB) Logf(format string, args ...any) { m.TB.Logf(format, args...) } - -// Add other testing.TB methods if needed by systest.NewT or AssertSnapshotsEqual -func (m *mockTB) Cleanup(f func()) { m.TB.Cleanup(f) } -func (m *mockTB) Error(args ...any) { m.failed = true } -func (m *mockTB) Failed() bool { return m.failed } // Reflect our recorded state -func (m *mockTB) Fatal(args ...any) { m.failed = true; panic("mock Fatal") } -func (m *mockTB) Log(args ...any) { m.TB.Log(args...) } -func (m *mockTB) Setenv(key, value string) { m.TB.Setenv(key, value) } -func (m *mockTB) Skip(args ...any) { m.TB.Skip(args...) } -func (m *mockTB) SkipNow() { m.TB.SkipNow() } -func (m *mockTB) Skipf(format string, args ...any) { m.TB.Skipf(format, args...) } -func (m *mockTB) Skipped() bool { return m.TB.Skipped() } -func (m *mockTB) TempDir() string { return m.TB.TempDir() } - -func TestAssertSnapshotsEqual(t *testing.T) { +func TestSnapshotsEqual(t *testing.T) { snap1 := newTestSnapshot(big.NewInt(1), big.NewInt(10), big.NewInt(20), big.NewInt(30), big.NewInt(40), big.NewInt(50)) snap2 := newTestSnapshot(big.NewInt(1), big.NewInt(10), big.NewInt(20), big.NewInt(30), big.NewInt(40), big.NewInt(50)) t.Run("EqualSnapshots", func(t *testing.T) { - mockT := &mockTB{TB: t} // Use the mock TB - systestT := systest.NewT(mockT) - AssertSnapshotsEqual(systestT, snap1, snap2) - assert.False(t, mockT.failed, "AssertSnapshotsEqual should not fail for equal snapshots") + assert.True(t, SnapshotsEqual(snap1, snap2), "Equal snapshots should return true") }) t.Run("DifferentBaseFee", func(t *testing.T) { - mockT := &mockTB{TB: t} - systestT := systest.NewT(mockT) diffSnap := newTestSnapshot(big.NewInt(1), big.NewInt(99), big.NewInt(20), big.NewInt(30), big.NewInt(40), big.NewInt(50)) - AssertSnapshotsEqual(systestT, snap1, diffSnap) - assert.True(t, mockT.failed, "AssertSnapshotsEqual should fail for different BaseFeeVaultBalance") + assert.False(t, SnapshotsEqual(snap1, diffSnap), "Different BaseFeeVaultBalance should return false") }) t.Run("DifferentL1Fee", func(t *testing.T) { - mockT := &mockTB{TB: t} - systestT := systest.NewT(mockT) diffSnap := newTestSnapshot(big.NewInt(1), big.NewInt(10), big.NewInt(99), big.NewInt(30), big.NewInt(40), big.NewInt(50)) - AssertSnapshotsEqual(systestT, snap1, diffSnap) - assert.True(t, mockT.failed, "AssertSnapshotsEqual should fail for different L1FeeVaultBalance") + assert.False(t, SnapshotsEqual(snap1, diffSnap), "Different L1FeeVaultBalance should return false") }) t.Run("DifferentSequencerFee", func(t *testing.T) { - mockT := &mockTB{TB: t} - systestT := systest.NewT(mockT) diffSnap := newTestSnapshot(big.NewInt(1), big.NewInt(10), big.NewInt(20), big.NewInt(99), big.NewInt(40), big.NewInt(50)) - AssertSnapshotsEqual(systestT, snap1, diffSnap) - assert.True(t, mockT.failed, "AssertSnapshotsEqual should fail for different SequencerFeeVault") + assert.False(t, SnapshotsEqual(snap1, diffSnap), "Different SequencerFeeVault should return false") }) t.Run("DifferentOperatorFee", func(t *testing.T) { - mockT := &mockTB{TB: t} - systestT := systest.NewT(mockT) diffSnap := newTestSnapshot(big.NewInt(1), big.NewInt(10), big.NewInt(20), big.NewInt(30), big.NewInt(99), big.NewInt(50)) - AssertSnapshotsEqual(systestT, snap1, diffSnap) - assert.True(t, mockT.failed, "AssertSnapshotsEqual should fail for different OperatorFeeVault") + assert.False(t, SnapshotsEqual(snap1, diffSnap), "Different OperatorFeeVault should return false") }) t.Run("DifferentFromBalance", func(t *testing.T) { - mockT := &mockTB{TB: t} - systestT := systest.NewT(mockT) diffSnap := newTestSnapshot(big.NewInt(1), big.NewInt(10), big.NewInt(20), big.NewInt(30), big.NewInt(40), big.NewInt(99)) - AssertSnapshotsEqual(systestT, snap1, diffSnap) - assert.True(t, mockT.failed, "AssertSnapshotsEqual should fail for different FromBalance") - }) - - // Test require.NotNil checks within AssertSnapshotsEqual (which call FailNow) - t.Run("NilExpected", func(t *testing.T) { - mockT := &mockTB{TB: t} - systestT := systest.NewT(mockT) - // Use assert.Panics because require.NotNil calls t.FailNow() which our mock makes panic - assert.Panics(t, func() { - AssertSnapshotsEqual(systestT, nil, snap2) - }, "AssertSnapshotsEqual should panic via FailNow when expected is nil") - assert.True(t, mockT.failed) // Check if FailNow was triggered + assert.False(t, SnapshotsEqual(snap1, diffSnap), "Different FromBalance should return false") }) - t.Run("NilActual", func(t *testing.T) { - mockT := &mockTB{TB: t} - systestT := systest.NewT(mockT) - assert.Panics(t, func() { - AssertSnapshotsEqual(systestT, snap1, nil) - }, "AssertSnapshotsEqual should panic via FailNow when actual is nil") - assert.True(t, mockT.failed) // Check if FailNow was triggered + t.Run("NilSnapshots", func(t *testing.T) { + assert.True(t, SnapshotsEqual(nil, nil), "Both nil should return true") + assert.False(t, SnapshotsEqual(snap1, nil), "One nil should return false") + assert.False(t, SnapshotsEqual(nil, snap1), "One nil should return false") }) } diff --git a/op-acceptance-tests/tests/isthmus/operator_fee/fee_checker.go b/op-acceptance-tests/tests/isthmus/operator_fee/fee_checker.go index d805660b91f..296460cc082 100644 --- a/op-acceptance-tests/tests/isthmus/operator_fee/fee_checker.go +++ b/op-acceptance-tests/tests/isthmus/operator_fee/fee_checker.go @@ -4,7 +4,7 @@ import ( "context" "math/big" - "github.com/ethereum-optimism/optimism/devnet-sdk/testing/systest" + "github.com/ethereum-optimism/optimism/op-devstack/devtest" "github.com/ethereum/go-ethereum/common" gethTypes "github.com/ethereum/go-ethereum/core/types" "github.com/ethereum/go-ethereum/ethclient" @@ -14,13 +14,13 @@ import ( ) type stateGetterAdapterFactory struct { - t systest.T + t devtest.T client *ethclient.Client } // stateGetterAdapter adapts the ethclient to implement the StateGetter interface type stateGetterAdapter struct { - t systest.T + t devtest.T client *ethclient.Client ctx context.Context blockNumber *big.Int @@ -30,7 +30,7 @@ func (f *stateGetterAdapterFactory) NewStateGetterAdapter(blockNumber *big.Int) return &stateGetterAdapter{ t: f.t, client: f.client, - ctx: f.t.Context(), + ctx: f.t.Ctx(), blockNumber: blockNumber, } } @@ -52,7 +52,7 @@ type FeeChecker struct { } // NewFeeChecker creates a new FeeChecker instance -func NewFeeChecker(t systest.T, client *ethclient.Client, chainConfig *params.ChainConfig, logger log.Logger) *FeeChecker { +func NewFeeChecker(t devtest.T, client *ethclient.Client, chainConfig *params.ChainConfig, logger log.Logger) *FeeChecker { logger.Debug("Creating fee checker", "chainID", chainConfig.ChainID) // Create state getter adapter factory diff --git a/op-acceptance-tests/tests/isthmus/operator_fee/operator_fee_test.go b/op-acceptance-tests/tests/isthmus/operator_fee/operator_fee_test.go index 5bbbb24a861..e9a3f192b16 100644 --- a/op-acceptance-tests/tests/isthmus/operator_fee/operator_fee_test.go +++ b/op-acceptance-tests/tests/isthmus/operator_fee/operator_fee_test.go @@ -11,7 +11,7 @@ import ( "github.com/ethereum-optimism/optimism/op-service/eth" ) -func TestOperatorFeeDevstack(gt *testing.T) { +func TestOperatorFee(gt *testing.T) { t := devtest.SerialT(gt) sys := presets.NewMinimal(t) require := t.Require() @@ -19,14 +19,17 @@ func TestOperatorFeeDevstack(gt *testing.T) { err := dsl.RequiresL2Fork(t.Ctx(), sys, 0, rollup.Isthmus) require.NoError(err, "Isthmus fork must be active for this test") - alice := sys.FunderL2.NewFundedEOA(eth.OneTenthEther) + fundAmount := eth.OneTenthEther + alice := sys.FunderL2.NewFundedEOA(fundAmount) + + alice.WaitForBalance(fundAmount) bob := sys.Wallet.NewEOA(sys.L2EL) operatorFee := dsl.NewOperatorFee(t, sys.L2Chain, sys.L1EL) operatorFee.CheckCompatibility() systemOwner := operatorFee.GetSystemOwner() - sys.FunderL1.FundAtLeast(systemOwner, eth.OneTenthEther) + sys.FunderL1.FundAtLeast(systemOwner, fundAmount) // First, ensure L2 is synced with current L1 state before starting tests t.Log("Ensuring L2 is synced with current L1 state...") diff --git a/op-acceptance-tests/tests/isthmus/operator_fee/system_config_contract_utils.go b/op-acceptance-tests/tests/isthmus/operator_fee/system_config_contract_utils.go index 2f205a40568..bb5c54780a6 100644 --- a/op-acceptance-tests/tests/isthmus/operator_fee/system_config_contract_utils.go +++ b/op-acceptance-tests/tests/isthmus/operator_fee/system_config_contract_utils.go @@ -1,22 +1,18 @@ package operatorfee +// NOTE: These utility functions have been converted from devnet-sdk to op-devstack types +// but are currently unused by tests. They would need implementation updates if used. + import ( "fmt" - "time" - "github.com/ethereum-optimism/optimism/devnet-sdk/system" - "github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/isthmus" + "github.com/ethereum-optimism/optimism/op-devstack/dsl" "github.com/ethereum-optimism/optimism/op-e2e/bindings" - "github.com/ethereum-optimism/optimism/op-service/txplan" "github.com/ethereum/go-ethereum/accounts/abi/bind" "github.com/ethereum/go-ethereum/common" gethTypes "github.com/ethereum/go-ethereum/core/types" - "github.com/lmittmann/w3" ) -var l1ConfigSyncPollInterval = 30 * time.Second -var l1ConfigSyncMaxWaitTime = 4 * time.Minute - type TestParams struct { ID string OperatorFeeScalar uint32 @@ -25,7 +21,7 @@ type TestParams struct { L1BlobBaseFeeScalar uint32 } -func GetFeeParamsL1(systemConfig *bindings.SystemConfig, systemConfigAddress common.Address, l2L1BlockContract *bindings.L1Block, wallet system.WalletV2) (tc TestParams, err error) { +func GetFeeParamsL1(systemConfig *bindings.SystemConfig, systemConfigAddress common.Address, l2L1BlockContract *bindings.L1Block, wallet *dsl.EOA) (tc TestParams, err error) { operatorFeeConstant, err := systemConfig.OperatorFeeConstant(&bind.CallOpts{BlockNumber: nil}) if err != nil { return TestParams{}, fmt.Errorf("failed to get operator fee constant: %w", err) @@ -50,7 +46,7 @@ func GetFeeParamsL1(systemConfig *bindings.SystemConfig, systemConfigAddress com }, nil } -func GetFeeParamsL2(l2L1BlockContract *bindings.L1Block, wallet system.WalletV2) (tc TestParams, err error) { +func GetFeeParamsL2(l2L1BlockContract *bindings.L1Block, wallet *dsl.EOA) (tc TestParams, err error) { operatorFeeConstant, err := l2L1BlockContract.OperatorFeeConstant(&bind.CallOpts{BlockNumber: nil}) if err != nil { return TestParams{}, fmt.Errorf("failed to get operator fee constant: %w", err) @@ -75,7 +71,7 @@ func GetFeeParamsL2(l2L1BlockContract *bindings.L1Block, wallet system.WalletV2) }, nil } -func EnsureFeeParams(systemConfig *bindings.SystemConfig, systemConfigAddress common.Address, l2L1BlockContract *bindings.L1Block, wallet system.WalletV2, tc TestParams) (err error, reset func() error) { +func EnsureFeeParams(systemConfig *bindings.SystemConfig, systemConfigAddress common.Address, l2L1BlockContract *bindings.L1Block, wallet *dsl.EOA, tc TestParams) (err error, reset func() error) { preFeeParams, err := GetFeeParamsL1(systemConfig, systemConfigAddress, l2L1BlockContract, wallet) if err != nil { return fmt.Errorf("failed to get L1 fee parameters: %w", err), nil @@ -92,141 +88,16 @@ func EnsureFeeParams(systemConfig *bindings.SystemConfig, systemConfigAddress co } } -func UpdateFeeParams(systemConfig *bindings.SystemConfig, systemConfigAddress common.Address, l2L1BlockContract *bindings.L1Block, wallet system.WalletV2, tc TestParams) (err error) { - - _, err = UpdateOperatorFeeParams(systemConfig, systemConfigAddress, l2L1BlockContract, wallet, tc.OperatorFeeConstant, tc.OperatorFeeScalar) - if err != nil { - return fmt.Errorf("failed to update operator fee parameters: %w", err) - } - - _, err = UpdateL1FeeParams(systemConfig, systemConfigAddress, l2L1BlockContract, wallet, tc.L1BaseFeeScalar, tc.L1BlobBaseFeeScalar) - if err != nil { - return fmt.Errorf("failed to update L1 fee parameters: %w", err) - } - - // Wait for L2 nodes to sync with L1 origin where fee parameters were set - deadline := time.Now().Add(l1ConfigSyncMaxWaitTime) - - for time.Now().Before(deadline) { - - l2FeeParams, err := GetFeeParamsL2(l2L1BlockContract, wallet) - if err != nil { - return fmt.Errorf("failed to get L2 fee parameters: %w", err) - } - l2FeeParams.ID = tc.ID - - // Check if all values match expected values - if l2FeeParams == tc { - break - } - - // Use context-aware sleep - select { - case <-time.After(l1ConfigSyncPollInterval): - // Continue with next iteration - case <-wallet.Ctx().Done(): - return fmt.Errorf("context canceled while waiting for L2 nodes to sync: %w", wallet.Ctx().Err()) - } - - // Check if context is canceled - if wallet.Ctx().Err() != nil { - return fmt.Errorf("context canceled while waiting for L2 nodes to sync: %w", wallet.Ctx().Err()) - } - } - return nil +func UpdateFeeParams(systemConfig *bindings.SystemConfig, systemConfigAddress common.Address, l2L1BlockContract *bindings.L1Block, wallet *dsl.EOA, tc TestParams) (err error) { + return fmt.Errorf("not implemented for op-devstack - utility function not used by tests") } // UpdateOperatorFeeParams updates the operator fee parameters in the SystemConfig contract. // It constructs and sends a transaction using txplan and returns the signed transaction, the receipt, or an error. -func UpdateOperatorFeeParams(systemConfig *bindings.SystemConfig, systemConfigAddress common.Address, l2L1BlockContract *bindings.L1Block, wallet system.WalletV2, operatorFeeConstant uint64, operatorFeeScalar uint32) (receipt *gethTypes.Receipt, err error) { - // Construct call input - funcSetOperatorFeeScalars := w3.MustNewFunc(`setOperatorFeeScalars(uint32, uint64)`, "") - args, err := funcSetOperatorFeeScalars.EncodeArgs( - operatorFeeScalar, - operatorFeeConstant, - ) - if err != nil { - return nil, fmt.Errorf("failed to encode arguments for setOperatorFeeScalars: %w", err) - } - - // Create a transaction using txplan - opts := isthmus.DefaultTxOpts(wallet) - ptx := txplan.NewPlannedTx( - opts, - txplan.WithTo(&systemConfigAddress), - txplan.WithData(args), - ) - - _, err = ptx.Success.Eval(wallet.Ctx()) - if err != nil { - return nil, fmt.Errorf("tx failed: %w", err) - } - - // Execute the transaction and wait for inclusion - receipt = ptx.Included.Value() - - actualOperatorFeeConstant, err := systemConfig.OperatorFeeConstant(&bind.CallOpts{BlockNumber: receipt.BlockNumber}) - if err != nil { - return nil, fmt.Errorf("failed to get operator fee constant: %w", err) - } - if operatorFeeConstant != actualOperatorFeeConstant { - return nil, fmt.Errorf("operator fee constant mismatch: got %d, expected %d", actualOperatorFeeConstant, operatorFeeConstant) - } - - actualOperatorFeeScalar, err := systemConfig.OperatorFeeScalar(&bind.CallOpts{BlockNumber: receipt.BlockNumber}) - if err != nil { - return nil, fmt.Errorf("failed to get operator fee scalar: %w", err) - } - if operatorFeeScalar != actualOperatorFeeScalar { - return nil, fmt.Errorf("operator fee scalar mismatch: got %d, expected %d", actualOperatorFeeScalar, operatorFeeScalar) - } - - return receipt, nil +func UpdateOperatorFeeParams(systemConfig *bindings.SystemConfig, systemConfigAddress common.Address, l2L1BlockContract *bindings.L1Block, wallet *dsl.EOA, operatorFeeConstant uint64, operatorFeeScalar uint32) (receipt *gethTypes.Receipt, err error) { + return nil, fmt.Errorf("not implemented for op-devstack - utility function not used by tests") } -func UpdateL1FeeParams(systemConfig *bindings.SystemConfig, systemConfigAddress common.Address, l2L1BlockContract *bindings.L1Block, wallet system.WalletV2, l1BaseFeeScalar uint32, l1BlobBaseFeeScalar uint32) (receipt *gethTypes.Receipt, err error) { - // Construct call input - funcSetGasConfigEcotone := w3.MustNewFunc(`setGasConfigEcotone(uint32 _basefeeScalar, uint32 _blobbasefeeScalar)`, "") - args, err := funcSetGasConfigEcotone.EncodeArgs( - l1BaseFeeScalar, - l1BlobBaseFeeScalar, - ) - if err != nil { - return nil, fmt.Errorf("failed to encode arguments for setGasConfigEcotone: %w", err) - } - - // Create a transaction using txplan - opts := isthmus.DefaultTxOpts(wallet) - ptx := txplan.NewPlannedTx( - opts, - txplan.WithTo(&systemConfigAddress), - txplan.WithData(args), - ) - - _, err = ptx.Success.Eval(wallet.Ctx()) - if err != nil { - return nil, fmt.Errorf("tx failed: %w", err) - } - - // Execute the transaction and wait for inclusion - receipt = ptx.Included.Value() - - // Verify the L1 fee parameters were set correctly - l1BaseFeeScalarActual, err := systemConfig.BasefeeScalar(&bind.CallOpts{BlockNumber: receipt.BlockNumber}) - if err != nil { - return nil, fmt.Errorf("failed to get l1 base fee scalar: %w", err) - } - if l1BaseFeeScalarActual != l1BaseFeeScalar { - return nil, fmt.Errorf("l1 base fee scalar mismatch: got %d, expected %d", l1BaseFeeScalarActual, l1BaseFeeScalar) - } - - blobBaseFeeScalar, err := systemConfig.BlobbasefeeScalar(&bind.CallOpts{BlockNumber: receipt.BlockNumber}) - if err != nil { - return nil, fmt.Errorf("failed to get l1 blob base fee scalar: %w", err) - } - if blobBaseFeeScalar != l1BlobBaseFeeScalar { - return nil, fmt.Errorf("l1 blob base fee scalar mismatch: got %d, expected %d", blobBaseFeeScalar, l1BlobBaseFeeScalar) - } - - return receipt, nil +func UpdateL1FeeParams(systemConfig *bindings.SystemConfig, systemConfigAddress common.Address, l2L1BlockContract *bindings.L1Block, wallet *dsl.EOA, l1BaseFeeScalar uint32, l1BlobBaseFeeScalar uint32) (receipt *gethTypes.Receipt, err error) { + return nil, fmt.Errorf("not implemented for op-devstack - utility function not used by tests") } diff --git a/op-acceptance-tests/tests/isthmus/operator_fee/tx_utils.go b/op-acceptance-tests/tests/isthmus/operator_fee/tx_utils.go index d60b9aa11e6..2763596cc9c 100644 --- a/op-acceptance-tests/tests/isthmus/operator_fee/tx_utils.go +++ b/op-acceptance-tests/tests/isthmus/operator_fee/tx_utils.go @@ -1,158 +1,30 @@ package operatorfee +// NOTE: These utility functions have been converted from devnet-sdk to op-devstack types +// but are currently unused by tests. They would need implementation updates if used. + import ( "context" - "crypto/ecdsa" - "encoding/hex" "fmt" - "math/big" - "github.com/ethereum-optimism/optimism/devnet-sdk/system" - "github.com/ethereum-optimism/optimism/devnet-sdk/types" - "github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/isthmus" - "github.com/ethereum-optimism/optimism/op-service/txplan" + "github.com/ethereum-optimism/optimism/op-devstack/dsl" + "github.com/ethereum-optimism/optimism/op-service/eth" "github.com/ethereum/go-ethereum/common" gethTypes "github.com/ethereum/go-ethereum/core/types" - "github.com/ethereum/go-ethereum/crypto" ) -func EnsureSufficientBalance(wallet system.WalletV2, to common.Address, value *big.Int) (err error) { - balance, err := wallet.Client().BalanceAt(wallet.Ctx(), to, nil) - if err != nil { - return fmt.Errorf("failed to get balance: %w", err) - } - if balance.Cmp(value) < 0 { - tx, receipt, err := SendValueTx(wallet, to, value) - if err != nil { - return fmt.Errorf("failed to send value tx: %w", err) - } - if receipt.Status != gethTypes.ReceiptStatusSuccessful { - return fmt.Errorf("tx %s failed with status %d", tx.Hash().Hex(), receipt.Status) - } - } - return nil +func EnsureSufficientBalance(wallet *dsl.EOA, to common.Address, value eth.ETH) (err error) { + return fmt.Errorf("not implemented for op-devstack - utility function not used by tests") } -func SendValueTx(wallet system.WalletV2, to common.Address, value *big.Int) (tx *gethTypes.Transaction, receipt *gethTypes.Receipt, err error) { - // ensure wallet is not the same as to address - if wallet.Address() == to { - return nil, nil, fmt.Errorf("wallet address is the same as the to address") - } - - walletPreBalance, err := wallet.Client().BalanceAt(wallet.Ctx(), wallet.Address(), nil) - if err != nil { - return nil, nil, fmt.Errorf("failed to get balance for from address: %w", err) - } - receiverPreBalance, err := wallet.Client().BalanceAt(wallet.Ctx(), to, nil) - if err != nil { - return nil, nil, fmt.Errorf("failed to get balance for to address: %w", err) - } - if walletPreBalance.Cmp(value) < 0 { - return nil, nil, fmt.Errorf("sender (%s) balance (%s) is less than the value (%s) attempting to send", wallet.Address(), walletPreBalance.String(), value.String()) - } - - opts := isthmus.DefaultTxOpts(wallet) - deployTx := txplan.NewPlannedTx(opts, - txplan.WithValue(value), - txplan.WithTo(&to), - ) - - signedTx, err := deployTx.Signed.Eval(wallet.Ctx()) - if err != nil { - return nil, nil, fmt.Errorf("failed to sign tx: %w", err) - } - - _, err = deployTx.Submitted.Eval(wallet.Ctx()) - if err != nil { - return nil, nil, fmt.Errorf("failed to submit tx: %w", err) - } - - _, err = deployTx.Success.Eval(wallet.Ctx()) - if err != nil { - return nil, nil, fmt.Errorf("failed to check tx success: %w", err) - } - - receipt = deployTx.Included.Value() - - // verify balance of wallet - blockNumber := new(big.Int).SetUint64(receipt.BlockNumber.Uint64()) - receiverPostBalance, err := wallet.Client().BalanceAt(wallet.Ctx(), to, blockNumber) - if err != nil { - return nil, nil, fmt.Errorf("failed to get to post-balance: %w", err) - } - if new(big.Int).Sub(receiverPostBalance, receiverPreBalance).Cmp(value) != 0 { - return nil, nil, fmt.Errorf("wallet balance was not updated successfully, expected %s, got %s", new(big.Int).Add(receiverPreBalance, value).String(), receiverPostBalance.String()) - } - - return signedTx, receipt, nil +func SendValueTx(wallet *dsl.EOA, to common.Address, value eth.ETH) (tx *gethTypes.Transaction, receipt *gethTypes.Receipt, err error) { + return nil, nil, fmt.Errorf("not implemented for op-devstack - utility function not used by tests") } -func ReturnRemainingFunds(wallet system.WalletV2, to common.Address) (receipt *gethTypes.Receipt, err error) { - balance, err := wallet.Client().BalanceAt(wallet.Ctx(), wallet.Address(), nil) - if err != nil { - return nil, fmt.Errorf("failed to get balance: %w", err) - } - - opts := isthmus.DefaultTxOpts(wallet) - txPlan := txplan.NewPlannedTx(opts, - txplan.WithTo(&to), - ) - innerTx, err := txPlan.Unsigned.Eval(wallet.Ctx()) - if err != nil { - return nil, fmt.Errorf("failed to get inner tx: %w", err) - } - - dynInnerTx, ok := innerTx.(*gethTypes.DynamicFeeTx) - if !ok { - return nil, fmt.Errorf("inner tx is not a dynamic fee tx") - } - - gasLimit := dynInnerTx.Gas - gasFeeCap := dynInnerTx.GasFeeCap - gasCost := new(big.Int).Mul(big.NewInt(int64(gasLimit)), gasFeeCap) - - value := new(big.Int).Sub(balance, gasCost) - - if value.Sign() < 0 { - // insufficient balance, so we don't need to send a tx - return nil, nil - } - - dynInnerTx.Value = value - - opts = isthmus.DefaultTxOpts(wallet) - txPlan = txplan.NewPlannedTx(opts, - txplan.WithUnsigned(dynInnerTx), - ) - - _, err = txPlan.Success.Eval(wallet.Ctx()) - if err != nil { - return nil, fmt.Errorf("return remaining funds tx %s failed: %w", txPlan.Signed.Value().Hash().Hex(), err) - } - - receipt = txPlan.Included.Value() - - return receipt, nil +func ReturnRemainingFunds(wallet *dsl.EOA, to common.Address) (receipt *gethTypes.Receipt, err error) { + return nil, fmt.Errorf("not implemented for op-devstack - utility function not used by tests") } -func NewTestWallet(ctx context.Context, chain system.Chain) (system.Wallet, error) { - // create new test wallet - testWalletPrivateKey, err := crypto.GenerateKey() - if err != nil { - return nil, err - } - testWalletPrivateKeyBytes := crypto.FromECDSA(testWalletPrivateKey) - testWalletPrivateKeyHex := hex.EncodeToString(testWalletPrivateKeyBytes) - testWalletPublicKey := testWalletPrivateKey.Public() - testWalletPublicKeyECDSA, ok := testWalletPublicKey.(*ecdsa.PublicKey) - if !ok { - return nil, fmt.Errorf("Failed to assert type: publicKey is not of type *ecdsa.PublicKey") - } - testWalletAddress := crypto.PubkeyToAddress(*testWalletPublicKeyECDSA) - testWallet, err := system.NewWallet( - testWalletPrivateKeyHex, - types.Address(testWalletAddress), - chain, - ) - return testWallet, err +func NewTestWallet(ctx context.Context, el dsl.ELNode) (*dsl.EOA, error) { + return nil, fmt.Errorf("not implemented for op-devstack - utility function not used by tests") } diff --git a/op-acceptance-tests/tests/isthmus/preinterop/challenger_test.go b/op-acceptance-tests/tests/isthmus/preinterop/challenger_test.go index 6fc0f832ea2..a80985e37bb 100644 --- a/op-acceptance-tests/tests/isthmus/preinterop/challenger_test.go +++ b/op-acceptance-tests/tests/isthmus/preinterop/challenger_test.go @@ -4,6 +4,7 @@ import ( "testing" "github.com/ethereum-optimism/optimism/op-devstack/dsl" + "github.com/ethereum-optimism/optimism/op-devstack/dsl/proofs" "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types" "github.com/ethereum/go-ethereum/common" @@ -25,7 +26,7 @@ func TestChallengerPlaysGame(gt *testing.T) { attacker := sys.FunderL1.NewFundedEOA(eth.Ether(15)) dgf := sys.DisputeGameFactory() - game := dgf.StartSuperCannonGame(attacker, badClaim) + game := dgf.StartSuperCannonGame(attacker, proofs.WithRootClaim(badClaim)) claim := game.RootClaim() // This is the bad claim from attacker counterClaim := claim.WaitForCounterClaim() // This is the counter-claim from the challenger diff --git a/op-acceptance-tests/tests/isthmus/preinterop/interop_readiness_test.go b/op-acceptance-tests/tests/isthmus/preinterop/interop_readiness_test.go index 32ffd4048be..5120ade1c46 100644 --- a/op-acceptance-tests/tests/isthmus/preinterop/interop_readiness_test.go +++ b/op-acceptance-tests/tests/isthmus/preinterop/interop_readiness_test.go @@ -6,17 +6,13 @@ import ( "fmt" "testing" - "github.com/ethereum-optimism/optimism/devnet-sdk/system" - "github.com/ethereum-optimism/optimism/devnet-sdk/testing/systest" - "github.com/ethereum-optimism/optimism/op-e2e/bindings" + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/dsl" + "github.com/ethereum-optimism/optimism/op-devstack/presets" "github.com/ethereum-optimism/optimism/op-service/sources/batching" "github.com/ethereum-optimism/optimism/op-service/sources/batching/rpcblock" - "github.com/ethereum-optimism/optimism/op-service/testlog" "github.com/ethereum/go-ethereum/accounts/abi" "github.com/ethereum/go-ethereum/common" - "github.com/ethereum/go-ethereum/ethclient" - "github.com/ethereum/go-ethereum/log" - "github.com/stretchr/testify/require" ) var portalABIString = ` @@ -50,7 +46,33 @@ var portalABIString = ` ] ` +var disputeGameFactoryABIString = ` +[ + { + "inputs": [{"name": "gameType", "type": "uint32"}], + "name": "gameImpls", + "outputs": [{"name": "", "type": "address"}], + "stateMutability": "view", + "type": "function" + } +] +` + +var faultDisputeGameABIString = ` +[ + { + "inputs": [], + "name": "absolutePrestate", + "outputs": [{"name": "", "type": "bytes32"}], + "stateMutability": "view", + "type": "function" + } +] +` + var portalABI *abi.ABI +var disputeGameFactoryABI *abi.ABI +var faultDisputeGameABI *abi.ABI func init() { if parsed, err := abi.JSON(bytes.NewReader([]byte(portalABIString))); err != nil { @@ -58,113 +80,119 @@ func init() { } else { portalABI = &parsed } -} -func TestInteropReadiness(t *testing.T) { - systest.SystemTest(t, interopReadinessTestScenario()) + if parsed, err := abi.JSON(bytes.NewReader([]byte(disputeGameFactoryABIString))); err != nil { + panic(fmt.Sprintf("failed to parse dispute game factory abi: %s", err)) + } else { + disputeGameFactoryABI = &parsed + } + + if parsed, err := abi.JSON(bytes.NewReader([]byte(faultDisputeGameABIString))); err != nil { + panic(fmt.Sprintf("failed to parse fault dispute game abi: %s", err)) + } else { + faultDisputeGameABI = &parsed + } } -func interopReadinessTestScenario() systest.SystemTestFunc { - return func(t systest.T, sys system.System) { - logger := testlog.Logger(t, log.LevelInfo) - logger.Info("Started test") +func TestInteropReadiness(gt *testing.T) { + t := devtest.ParallelT(gt) + sys := presets.NewSimpleInterop(t) - l1Client, err := sys.L1().Nodes()[0].GethClient() - require.NoError(t, err) - l1Caller := batching.NewMultiCaller(l1Client.Client(), batching.DefaultBatchSize) + t.Logger().Info("Started test") - checkAbsolutePrestate(t, sys, l1Client) - checkL1PAO(t, sys, l1Caller) - checkSuperchainConfig(t, sys, l1Caller) - checkPermissionless(t, sys, l1Caller) - } + l1EL := sys.L1EL + l1Client := l1EL.EthClient() + l1Caller := l1Client.NewMultiCaller(batching.DefaultBatchSize) + + checkAbsolutePrestate(t, sys, l1Caller) + checkL1PAO(t, sys, l1Caller) + checkSuperchainConfig(t, sys, l1Caller) + checkPermissionless(t, sys, l1Caller) } -func checkAbsolutePrestate(t systest.T, sys system.System, l1Client *ethclient.Client) { +func checkAbsolutePrestate(t devtest.T, sys *presets.SimpleInterop, l1Caller *batching.MultiCaller) { var prestate *[32]byte - for _, chain := range sys.L2s() { - p := getPrestate(t, l1Client, chain) + chains := []*dsl.L2Network{sys.L2ChainA, sys.L2ChainB} + for _, chain := range chains { + p := getPrestate(t, l1Caller, chain) if prestate == nil { prestate = &p } else { - require.Equal(t, *prestate, p) + t.Require().Equal(*prestate, p) } } - require.NotNil(t, prestate) + t.Require().NotNil(prestate) } -func checkL1PAO(t systest.T, sys system.System, l1Caller *batching.MultiCaller) { +func checkL1PAO(t devtest.T, sys *presets.SimpleInterop, l1Caller *batching.MultiCaller) { var l1PAO common.Address - for _, chain := range sys.L2s() { + chains := []*dsl.L2Network{sys.L2ChainA, sys.L2ChainB} + for _, chain := range chains { owner := getL1PAO(t, l1Caller, chain) if l1PAO == (common.Address{}) { l1PAO = owner } else { - require.Equal(t, l1PAO, owner) + t.Require().Equal(l1PAO, owner) } } - require.NotNil(t, l1PAO) + t.Require().NotEqual(common.Address{}, l1PAO) } -func checkSuperchainConfig(t systest.T, sys system.System, l1Caller *batching.MultiCaller) { +func checkSuperchainConfig(t devtest.T, sys *presets.SimpleInterop, l1Caller *batching.MultiCaller) { var superchainConfig common.Address - for _, chain := range sys.L2s() { + chains := []*dsl.L2Network{sys.L2ChainA, sys.L2ChainB} + for _, chain := range chains { address := getSuperchainConfigFromPortal(t, l1Caller, chain) if superchainConfig == (common.Address{}) { superchainConfig = address } else { - require.Equal(t, superchainConfig, address) + t.Require().Equal(superchainConfig, address) } } - require.NotNil(t, superchainConfig) + t.Require().NotEqual(common.Address{}, superchainConfig) } -func checkPermissionless(t systest.T, sys system.System, l1Caller *batching.MultiCaller) { - for _, chain := range sys.L2s() { +func checkPermissionless(t devtest.T, sys *presets.SimpleInterop, l1Caller *batching.MultiCaller) { + chains := []*dsl.L2Network{sys.L2ChainA, sys.L2ChainB} + for _, chain := range chains { gameType := getRespectedGameType(t, l1Caller, chain) - require.Equal(t, uint32(0), gameType, "chain is not permissionless") + t.Require().Equal(uint32(0), gameType, "chain is not permissionless") } } -func getL1PAO(t systest.T, l1Caller *batching.MultiCaller, l2Chain system.L2Chain) common.Address { - portalAddress, ok := l2Chain.L1Addresses()["OptimismPortalProxy"] - require.True(t, ok, "OptimismPortalProxy not found") +func getL1PAO(t devtest.T, l1Caller *batching.MultiCaller, l2Chain *dsl.L2Network) common.Address { + portalAddress := l2Chain.DepositContractAddr() contract := batching.NewBoundContract(portalABI, portalAddress) results, err := l1Caller.SingleCall(context.Background(), rpcblock.Latest, contract.Call("proxyAdminOwner")) - require.NoError(t, err) + t.Require().NoError(err) return results.GetAddress(0) } -func getSuperchainConfigFromPortal(t systest.T, l1Caller *batching.MultiCaller, l2Chain system.L2Chain) common.Address { - portalAddress, ok := l2Chain.L1Addresses()["OptimismPortalProxy"] - require.True(t, ok, "OptimismPortalProxy not found") +func getSuperchainConfigFromPortal(t devtest.T, l1Caller *batching.MultiCaller, l2Chain *dsl.L2Network) common.Address { + portalAddress := l2Chain.DepositContractAddr() contract := batching.NewBoundContract(portalABI, portalAddress) results, err := l1Caller.SingleCall(context.Background(), rpcblock.Latest, contract.Call("superchainConfig")) - require.NoError(t, err) + t.Require().NoError(err) return results.GetAddress(0) } -func getPrestate(t systest.T, l1Client *ethclient.Client, l2Chain system.L2Chain) [32]byte { - dgf, ok := l2Chain.L1Addresses()["DisputeGameFactoryProxy"] - require.True(t, ok, "DisputeGameFactoryProxy not found") - dgfContract, err := bindings.NewDisputeGameFactory(dgf, l1Client) - require.NoError(t, err) - - gameImpl, err := dgfContract.GameImpls(nil, 0) - require.NoError(t, err) - fdgContract, err := bindings.NewFaultDisputeGame(gameImpl, l1Client) - require.NoError(t, err) - - prestate, err := fdgContract.AbsolutePrestate(nil) - require.NoError(t, err) - return prestate +func getPrestate(t devtest.T, l1Caller *batching.MultiCaller, l2Chain *dsl.L2Network) [32]byte { + dgf := l2Chain.DisputeGameFactoryProxyAddr() + dgfContract := batching.NewBoundContract(disputeGameFactoryABI, dgf) + results, err := l1Caller.SingleCall(context.Background(), rpcblock.Latest, dgfContract.Call("gameImpls", uint32(0))) + t.Require().NoError(err) + gameImpl := results.GetAddress(0) + + fdgContract := batching.NewBoundContract(faultDisputeGameABI, gameImpl) + prestateResults, err := l1Caller.SingleCall(context.Background(), rpcblock.Latest, fdgContract.Call("absolutePrestate")) + t.Require().NoError(err) + return prestateResults.GetHash(0) } -func getRespectedGameType(t systest.T, l1Caller *batching.MultiCaller, l2Chain system.L2Chain) uint32 { - portalAddress, ok := l2Chain.L1Addresses()["OptimismPortalProxy"] - require.True(t, ok, "OptimismPortalProxy not found") +func getRespectedGameType(t devtest.T, l1Caller *batching.MultiCaller, l2Chain *dsl.L2Network) uint32 { + portalAddress := l2Chain.DepositContractAddr() contract := batching.NewBoundContract(portalABI, portalAddress) results, err := l1Caller.SingleCall(context.Background(), rpcblock.Latest, contract.Call("respectedGameType")) - require.NoError(t, err) + t.Require().NoError(err) return results.GetUint32(0) } diff --git a/op-acceptance-tests/tests/safeheaddb_elsync/safeheaddb_test.go b/op-acceptance-tests/tests/safeheaddb_elsync/safeheaddb_test.go index e112246395f..5bb992e5319 100644 --- a/op-acceptance-tests/tests/safeheaddb_elsync/safeheaddb_test.go +++ b/op-acceptance-tests/tests/safeheaddb_elsync/safeheaddb_test.go @@ -42,14 +42,13 @@ func TestNotTruncateDatabaseOnRestartWithExistingDatabase(gt *testing.T) { t := devtest.SerialT(gt) sys := presets.NewSingleChainMultiNode(t) - startSafeBlock := sys.L2CLB.SafeL2BlockRef().Number - dsl.CheckAll(t, sys.L2CL.AdvancedFn(types.LocalSafe, 1, 30), sys.L2CLB.AdvancedFn(types.LocalSafe, 1, 30)) - sys.L2CLB.Matched(sys.L2CL, types.LocalSafe, 30) - sys.L2CLB.VerifySafeHeadDatabaseMatches(sys.L2CL) + + preRestartSafeBlock := sys.L2CLB.SafeL2BlockRef().Number + sys.L2CLB.VerifySafeHeadDatabaseMatches(sys.L2CL, dsl.WithMinRequiredL2Block(preRestartSafeBlock)) // Restart the verifier op-node, but not the EL so the existing chain data is not deleted. sys.L2CLB.Stop() @@ -61,5 +60,5 @@ func TestNotTruncateDatabaseOnRestartWithExistingDatabase(gt *testing.T) { sys.L2CLB.Matched(sys.L2CL, types.LocalSafe, 30) sys.L2CLB.Advanced(types.LocalSafe, 1, 30) // At least one safe head db update after resync - sys.L2CLB.VerifySafeHeadDatabaseMatches(sys.L2CL, dsl.WithMinRequiredL2Block(startSafeBlock)) + sys.L2CLB.VerifySafeHeadDatabaseMatches(sys.L2CL, dsl.WithMinRequiredL2Block(preRestartSafeBlock)) } diff --git a/op-acceptance-tests/tests/sync_tester/hardforks_ext/hardforks_ext.go b/op-acceptance-tests/tests/sync_tester/hardforks_ext/hardforks_ext.go new file mode 100644 index 00000000000..8f3bf3c3d4a --- /dev/null +++ b/op-acceptance-tests/tests/sync_tester/hardforks_ext/hardforks_ext.go @@ -0,0 +1,186 @@ +package hardforks_ext + +import ( + "context" + "os" + "strconv" + "testing" + + "github.com/ethereum/go-ethereum/log" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/dsl" + "github.com/ethereum-optimism/optimism/op-devstack/shim" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-devstack/stack/match" + "github.com/ethereum-optimism/optimism/op-devstack/sysgo" + "github.com/ethereum-optimism/optimism/op-node/rollup" + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum-optimism/optimism/op-service/testlog" + "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types" +) + +// Configuration defaults for op-sepolia +const ( + DefaultL2NetworkName = "op-sepolia" + DefaultL1ChainID = 11155111 + DefaultL2ELEndpoint = "https://ci-sepolia-l2.optimism.io" + DefaultL1CLBeaconEndpoint = "https://ci-sepolia-beacon.optimism.io" + DefaultL1ELEndpoint = "https://ci-sepolia-l1.optimism.io" + + // Tailscale networking endpoints + DefaultL2ELEndpointTailscale = "https://proxyd-l2-sepolia.primary.client.dev.oplabs.cloud" + DefaultL1CLBeaconEndpointTailscale = "https://beacon-api-proxy-sepolia.primary.client.dev.oplabs.cloud" + DefaultL1ELEndpointTailscale = "https://proxyd-l1-sepolia.primary.client.dev.oplabs.cloud" +) + +var ( + // Network upgrade block numbers for op-sepolia + networkUpgradeBlocks = map[rollup.ForkName]uint64{ + rollup.Canyon: 4089330, + rollup.Delta: 5700330, + rollup.Ecotone: 8366130, + rollup.Fjord: 12597930, + rollup.Granite: 15837930, + rollup.Holocene: 20415330, + rollup.Isthmus: 26551530, + } + + // Load configuration from environment variables with defaults + L2NetworkName = getEnvOrDefault("L2_NETWORK_NAME", DefaultL2NetworkName) + L1ChainID = eth.ChainIDFromUInt64(getEnvUint64OrDefault("L1_CHAIN_ID", DefaultL1ChainID)) + + // Default endpoints + L2ELEndpoint = getEnvOrDefault("L2_EL_ENDPOINT", DefaultL2ELEndpoint) + L1CLBeaconEndpoint = getEnvOrDefault("L1_CL_BEACON_ENDPOINT", DefaultL1CLBeaconEndpoint) + L1ELEndpoint = getEnvOrDefault("L1_EL_ENDPOINT", DefaultL1ELEndpoint) +) + +// getEnvOrDefault returns the environment variable value or the default if not set +func getEnvOrDefault(envVar, defaultValue string) string { + if value := os.Getenv(envVar); value != "" { + return value + } + return defaultValue +} + +// getEnvUint64OrDefault returns the environment variable value as uint64 or the default if not set +func getEnvUint64OrDefault(envVar string, defaultValue uint64) uint64 { + if value := os.Getenv(envVar); value != "" { + if parsed, err := strconv.ParseUint(value, 10, 64); err == nil { + return parsed + } + } + return defaultValue +} + +// setupOrchestrator initializes and configures the orchestrator for the test +func setupOrchestrator(gt *testing.T, t devtest.T, blk uint64) *sysgo.Orchestrator { + l := t.Logger() + + // Override configuration with Tailscale endpoints if Tailscale networking is enabled + l2ELEndpoint := L2ELEndpoint + l1CLBeaconEndpoint := L1CLBeaconEndpoint + l1ELEndpoint := L1ELEndpoint + + if os.Getenv("TAILSCALE_NETWORKING") == "true" { + l2ELEndpoint = getEnvOrDefault("L2_EL_ENDPOINT_TAILSCALE", DefaultL2ELEndpointTailscale) + l1CLBeaconEndpoint = getEnvOrDefault("L1_CL_BEACON_ENDPOINT_TAILSCALE", DefaultL1CLBeaconEndpointTailscale) + l1ELEndpoint = getEnvOrDefault("L1_EL_ENDPOINT_TAILSCALE", DefaultL1ELEndpointTailscale) + } + + // Setup orchestrator directly without TestMain + logger := testlog.Logger(gt, log.LevelInfo) + onFail := func(now bool) { + if now { + gt.FailNow() + } else { + gt.Fail() + } + } + onSkipNow := func() { + gt.SkipNow() + } + p := devtest.NewP(context.Background(), logger, onFail, onSkipNow) + gt.Cleanup(p.Close) + + // Runtime configuration values + l.Info("Runtime configuration values for TestSyncTesterExtEL") + l.Info("L2_NETWORK_NAME", "value", L2NetworkName) + l.Info("L1_CHAIN_ID", "value", L1ChainID) + l.Info("L2_EL_ENDPOINT", "value", l2ELEndpoint) + l.Info("L1_CL_BEACON_ENDPOINT", "value", l1CLBeaconEndpoint) + l.Info("L1_EL_ENDPOINT", "value", l1ELEndpoint) + l.Info("TAILSCALE_NETWORKING", "value", os.Getenv("TAILSCALE_NETWORKING")) + + // Create orchestrator with the same configuration that was in TestMain + opt := sysgo.DefaultMinimalExternalELSystemWithEndpointAndSuperchainRegistry(&sysgo.DefaultMinimalExternalELSystemIDs{}, l1CLBeaconEndpoint, l1ELEndpoint, l2ELEndpoint, L1ChainID, L2NetworkName, eth.FCUState{ + Latest: blk, + Safe: blk, + Finalized: blk, + }) + + orch := sysgo.NewOrchestrator(p, stack.SystemHook(opt)) + stack.ApplyOptionLifecycle[*sysgo.Orchestrator](opt, orch) + + return orch +} + +func SyncTesterHFSExt(gt *testing.T, upgradeName rollup.ForkName) { + t := devtest.SerialT(gt) + l := t.Logger() + + // Initial block number to sync from before the upgrade + blk := networkUpgradeBlocks[upgradeName] - 5 + + // Initialize orchestrator + orch := setupOrchestrator(gt, t, blk) + system := shim.NewSystem(t) + orch.Hydrate(system) + + l2 := system.L2Network(match.L2ChainA) + verifierCL := l2.L2CLNode(match.FirstL2CL) + syncTester := l2.SyncTester(match.FirstSyncTester) + + sys := &struct { + L2CL *dsl.L2CLNode + L2EL *dsl.L2ELNode + SyncTester *dsl.SyncTester + L2 *dsl.L2Network + }{ + L2CL: dsl.NewL2CLNode(verifierCL, orch.ControlPlane()), + L2EL: dsl.NewL2ELNode(l2.L2ELNode(match.FirstL2EL), orch.ControlPlane()), + SyncTester: dsl.NewSyncTester(syncTester), + L2: dsl.NewL2Network(l2, orch.ControlPlane()), + } + require := t.Require() + + l2CLSyncStatus := sys.L2CL.WaitForNonZeroUnsafeTime(t.Ctx()) + + ft := sys.L2.Escape().RollupConfig().ActivationTimeFor(upgradeName) + require.Less(l2CLSyncStatus.UnsafeL2.Time, *ft, "L2CL unsafe time should be less than fork timestamp before upgrade") + + blocksToSync := uint64(10) + targetBlock := blk + blocksToSync + sys.L2CL.Reached(types.LocalUnsafe, targetBlock, 1000) + l.Info("L2CL unsafe reached", "targetBlock", targetBlock, "upgrade_name", upgradeName) + sys.L2CL.Reached(types.LocalSafe, targetBlock, 1000) + l.Info("L2CL safe reached", "targetBlock", targetBlock, "upgrade_name", upgradeName) + + l2CLSyncStatus = sys.L2CL.SyncStatus() + require.NotNil(l2CLSyncStatus, "L2CL should have sync status") + require.Greater(l2CLSyncStatus.UnsafeL2.Time, *ft, "L2CL unsafe time should be greater than fork timestamp after upgrade") + + unsafeL2Ref := l2CLSyncStatus.UnsafeL2 + ref := sys.L2EL.BlockRefByNumber(unsafeL2Ref.Number) + require.Equal(unsafeL2Ref.Hash, ref.Hash, "L2EL should be on the same block as L2CL") + + stSessions := sys.SyncTester.ListSessions() + require.Equal(len(stSessions), 1, "expect exactly one session") + + stSession := sys.SyncTester.GetSession(stSessions[0]) + require.GreaterOrEqualf(stSession.CurrentState.Latest, stSession.InitialState.Latest+blocksToSync, "SyncTester session CurrentState.Latest only advanced %d", stSession.CurrentState.Latest-stSession.InitialState.Latest) + require.GreaterOrEqualf(stSession.CurrentState.Safe, stSession.InitialState.Safe+blocksToSync, "SyncTester session CurrentState.Safe only advanced %d", stSession.CurrentState.Safe-stSession.InitialState.Safe) + + l.Info("SyncTester HFS Ext test completed successfully", "l2cl_chain_id", sys.L2CL.ID().ChainID(), "l2cl_sync_status", l2CLSyncStatus, "upgrade_name", upgradeName) +} diff --git a/op-acceptance-tests/tests/sync_tester/sync_test.go b/op-acceptance-tests/tests/sync_tester/sync_test.go deleted file mode 100644 index 026fcc3fe3f..00000000000 --- a/op-acceptance-tests/tests/sync_tester/sync_test.go +++ /dev/null @@ -1,25 +0,0 @@ -package sync_tester - -import ( - "testing" - - "github.com/ethereum-optimism/optimism/op-devstack/devtest" - "github.com/ethereum-optimism/optimism/op-devstack/dsl" - "github.com/ethereum-optimism/optimism/op-devstack/presets" - "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types" -) - -func TestSyncTester(gt *testing.T) { - t := devtest.SerialT(gt) - sys := presets.NewMinimalWithSyncTester(t) - require := t.Require() - - dsl.CheckAll(t, sys.L2CL.AdvancedFn(types.LocalUnsafe, 5, 30)) - - syncTester := sys.SyncTester.Escape() - - chainID, err := syncTester.API().ChainID(t.Ctx()) - require.NoError(err) - - require.Equal(chainID, sys.L2EL.ChainID()) -} diff --git a/op-acceptance-tests/tests/sync_tester/init_test.go b/op-acceptance-tests/tests/sync_tester/sync_tester_e2e/init_test.go similarity index 53% rename from op-acceptance-tests/tests/sync_tester/init_test.go rename to op-acceptance-tests/tests/sync_tester/sync_tester_e2e/init_test.go index 24c18ff47dc..c237eeae4ba 100644 --- a/op-acceptance-tests/tests/sync_tester/init_test.go +++ b/op-acceptance-tests/tests/sync_tester/sync_tester_e2e/init_test.go @@ -1,14 +1,19 @@ -package sync_tester +package sync_tester_e2e import ( "testing" "github.com/ethereum-optimism/optimism/op-devstack/compat" "github.com/ethereum-optimism/optimism/op-devstack/presets" + "github.com/ethereum-optimism/optimism/op-service/eth" ) func TestMain(m *testing.M) { - presets.DoMain(m, presets.WithMinimalWithSyncTester(), + presets.DoMain(m, presets.WithSimpleWithSyncTester(eth.FCUState{ + Latest: 0, + Safe: 0, + Finalized: 0, + }), presets.WithCompatibleTypes(compat.SysGo), ) } diff --git a/op-acceptance-tests/tests/sync_tester/sync_tester_e2e/sync_tester_e2e_test.go b/op-acceptance-tests/tests/sync_tester/sync_tester_e2e/sync_tester_e2e_test.go new file mode 100644 index 00000000000..f3e493e77e7 --- /dev/null +++ b/op-acceptance-tests/tests/sync_tester/sync_tester_e2e/sync_tester_e2e_test.go @@ -0,0 +1,90 @@ +package sync_tester_e2e + +import ( + "testing" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/dsl" + "github.com/ethereum-optimism/optimism/op-devstack/presets" + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types" +) + +func TestSyncTesterE2E(gt *testing.T) { + t := devtest.SerialT(gt) + // This test uses DefaultSimpleSystemWithSyncTester which includes: + // - Minimal setup with L1EL, L1CL, L2EL, L2CL (sequencer) + // - Additional L2CL2 (verifier) that connects to SyncTester instead of L2EL + sys := presets.NewSimpleWithSyncTester(t) + require := t.Require() + logger := t.Logger() + ctx := t.Ctx() + + // Test that we can get chain IDs from both L2CL nodes + l2CLChainID := sys.L2CL.ID().ChainID() + require.Equal(eth.ChainIDFromUInt64(901), l2CLChainID, "first L2CL should be on chain 901") + + l2CL2ChainID := sys.L2CL2.ID().ChainID() + require.Equal(eth.ChainIDFromUInt64(901), l2CL2ChainID, "second L2CL should be on chain 901") + + // Test that the network started successfully + require.NotNil(sys.L1EL, "L1 EL node should be available") + require.NotNil(sys.L2EL, "L2 EL node should be available") + require.NotNil(sys.L2CL, "L2 CL node should be available") + require.NotNil(sys.SyncTester, "SyncTester should be available") + require.NotNil(sys.L2CL2, "Second L2 CL node should be available") + require.NotNil(sys.SyncTesterL2EL, "SyncTester L2 EL node should be available") + + sessionIDs := sys.SyncTester.ListSessions() + require.GreaterOrEqual(len(sessionIDs), 1, "at least one session") + + sessionID := sessionIDs[0] + logger.Info("SyncTester EL", "sessionID", sessionID) + + session := sys.SyncTester.GetSession(sessionID) + + require.Equal(eth.FCUState{Latest: 0, Safe: 0, Finalized: 0}, session.InitialState) + + target := uint64(5) + dsl.CheckAll(t, + sys.L2CL.AdvancedFn(types.LocalUnsafe, target, 30), + sys.L2CL2.AdvancedFn(types.LocalUnsafe, target, 30), + ) + + // Test that we can get chain ID from SyncTester + syncTesterChainID := sys.SyncTester.ChainID(sessionID) + require.Equal(eth.ChainIDFromUInt64(901), syncTesterChainID, "SyncTester should be on chain 901") + + // Test that both L2CL nodes and SyncTester are on the same chain + require.Equal(l2CLChainID, l2CL2ChainID, "both L2CL nodes should be on the same chain") + require.Equal(l2CLChainID, syncTesterChainID, "L2CL nodes and SyncTester should be on the same chain") + + // Test that we can get sync status from L2CL nodes + l2CLSyncStatus := sys.L2CL.SyncStatus() + require.NotNil(l2CLSyncStatus, "first L2CL should have sync status") + + l2CL2SyncStatus := sys.L2CL2.SyncStatus() + require.NotNil(l2CL2SyncStatus, "second L2CL should have sync status") + + t.Logger().Info("SyncTester E2E test completed successfully", + "l2cl_chain_id", l2CLChainID, + "l2cl2_chain_id", l2CL2ChainID, + "sync_tester_chain_id", syncTesterChainID, + "l2cl_sync_status", l2CLSyncStatus, + "l2cl2_sync_status", l2CL2SyncStatus) + + unsafeNum := sys.SyncTesterL2EL.BlockRefByLabel(eth.Unsafe).Number + require.True(unsafeNum >= target, unsafeNum) + + session = sys.SyncTester.GetSession(sessionID) + require.GreaterOrEqual(session.CurrentState.Latest, target) + + sys.SyncTester.DeleteSession(sessionID) + + syncTesterClient := sys.SyncTester.Escape().APIWithSession(sessionID) + + require.ErrorContains(syncTesterClient.DeleteSession(ctx), "already deleted") + + _, err := syncTesterClient.GetSession(ctx) + require.ErrorContains(err, "already deleted") +} diff --git a/op-acceptance-tests/tests/sync_tester/sync_tester_ext_el/sync_tester_ext_el_test.go b/op-acceptance-tests/tests/sync_tester/sync_tester_ext_el/sync_tester_ext_el_test.go new file mode 100644 index 00000000000..264fda949eb --- /dev/null +++ b/op-acceptance-tests/tests/sync_tester/sync_tester_ext_el/sync_tester_ext_el_test.go @@ -0,0 +1,184 @@ +package sync_tester_ext_el + +import ( + "os" + "strconv" + "testing" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/dsl" + "github.com/ethereum-optimism/optimism/op-devstack/presets" + "github.com/ethereum-optimism/optimism/op-devstack/shim" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-devstack/stack/match" + "github.com/ethereum-optimism/optimism/op-devstack/sysgo" + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum-optimism/optimism/op-service/testlog" + + "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types" + "github.com/ethereum/go-ethereum/ethclient" + "github.com/ethereum/go-ethereum/log" +) + +// Configuration defaults for op-sepolia +const ( + DefaultL2NetworkName = "op-sepolia" + DefaultL1ChainID = 11155111 + DefaultL2ELEndpoint = "https://ci-sepolia-l2.optimism.io" + DefaultL1CLBeaconEndpoint = "https://ci-sepolia-beacon.optimism.io" + DefaultL1ELEndpoint = "https://ci-sepolia-l1.optimism.io" + + // Tailscale networking endpoints + DefaultL2ELEndpointTailscale = "https://proxyd-l2-sepolia.primary.client.dev.oplabs.cloud" + DefaultL1CLBeaconEndpointTailscale = "https://beacon-api-proxy-sepolia.primary.client.dev.oplabs.cloud" + DefaultL1ELEndpointTailscale = "https://proxyd-l1-sepolia.primary.client.dev.oplabs.cloud" +) + +var ( + // Load configuration from environment variables with defaults + L2NetworkName = getEnvOrDefault("L2_NETWORK_NAME", DefaultL2NetworkName) + L1ChainID = eth.ChainIDFromUInt64(getEnvUint64OrDefault("L1_CHAIN_ID", DefaultL1ChainID)) + + // Default endpoints + L2ELEndpoint = getEnvOrDefault("L2_EL_ENDPOINT", DefaultL2ELEndpoint) + L1CLBeaconEndpoint = getEnvOrDefault("L1_CL_BEACON_ENDPOINT", DefaultL1CLBeaconEndpoint) + L1ELEndpoint = getEnvOrDefault("L1_EL_ENDPOINT", DefaultL1ELEndpoint) +) + +func TestSyncTesterExtEL(gt *testing.T) { + t := devtest.SerialT(gt) + + if os.Getenv("CIRCLECI_PIPELINE_SCHEDULE_NAME") != "build_daily" && os.Getenv("CIRCLECI_PARAMETERS_SYNC_TEST_OP_NODE_DISPATCH") != "true" { + t.Skipf("TestSyncTesterExtEL only runs on daily scheduled pipeline jobs: schedule=%s dispatch=%s", os.Getenv("CIRCLECI_PIPELINE_SCHEDULE_NAME"), os.Getenv("CIRCLECI_PARAMETERS_SYNC_TEST_OP_NODE_DISPATCH")) + } + + l := t.Logger() + require := t.Require() + sys, initial := setupSystem(gt, t) + + // Test that we can get sync status from L2CL node + l2CLSyncStatus := sys.L2CL.SyncStatus() + require.NotNil(l2CLSyncStatus, "L2CL should have sync status") + + blocksToSync := uint64(20) + sys.L2CL.Reached(types.LocalUnsafe, initial+blocksToSync, 500) + + l2CLSyncStatus = sys.L2CL.SyncStatus() + require.NotNil(l2CLSyncStatus, "L2CL should have sync status") + + unsafeL2Ref := l2CLSyncStatus.UnsafeL2 + blk := sys.L2EL.BlockRefByNumber(unsafeL2Ref.Number) + require.Equal(unsafeL2Ref.Hash, blk.Hash, "L2EL should be on the same block as L2CL") + + stSessions := sys.SyncTester.ListSessions() + require.Equal(len(stSessions), 1, "expect exactly one session") + + stSession := sys.SyncTester.GetSession(stSessions[0]) + require.GreaterOrEqual(stSession.CurrentState.Latest, stSession.InitialState.Latest+blocksToSync, "SyncTester session Latest should be on the same block as L2CL") + require.GreaterOrEqual(stSession.CurrentState.Safe, stSession.InitialState.Safe+blocksToSync, "SyncTester session Safe should be on the same block as L2CL") + + l.Info("SyncTester ExtEL test completed successfully", "l2cl_chain_id", sys.L2CL.ID().ChainID(), "l2cl_sync_status", l2CLSyncStatus) +} + +// setupSystem initializes the system for the test and returns the system and the initial block number of the session +func setupSystem(gt *testing.T, t devtest.T) (*presets.MinimalExternalEL, uint64) { + // Initialize orchestrator + orch, initial := setupOrchestrator(gt, t) + system := shim.NewSystem(t) + orch.Hydrate(system) + + // Extract the system components + l2 := system.L2Network(match.L2ChainA) + verifierCL := l2.L2CLNode(match.FirstL2CL) + syncTester := l2.SyncTester(match.FirstSyncTester) + + sys := &presets.MinimalExternalEL{ + Log: t.Logger(), + T: t, + ControlPlane: orch.ControlPlane(), + L1Network: dsl.NewL1Network(system.L1Network(match.FirstL1Network)), + L1EL: dsl.NewL1ELNode(system.L1Network(match.FirstL1Network).L1ELNode(match.FirstL1EL)), + L2Chain: dsl.NewL2Network(l2, orch.ControlPlane()), + L2CL: dsl.NewL2CLNode(verifierCL, orch.ControlPlane()), + L2EL: dsl.NewL2ELNode(l2.L2ELNode(match.FirstL2EL), orch.ControlPlane()), + SyncTester: dsl.NewSyncTester(syncTester), + } + + return sys, initial +} + +// setupOrchestrator initializes and configures the orchestrator for the test and returns the orchestrator and the initial block number of the session +func setupOrchestrator(gt *testing.T, t devtest.T) (*sysgo.Orchestrator, uint64) { + l := t.Logger() + ctx := t.Ctx() + require := t.Require() + + // Override configuration with Tailscale endpoints if Tailscale networking is enabled + if os.Getenv("TAILSCALE_NETWORKING") == "true" { + L2ELEndpoint = getEnvOrDefault("L2_EL_ENDPOINT_TAILSCALE", DefaultL2ELEndpointTailscale) + L1CLBeaconEndpoint = getEnvOrDefault("L1_CL_BEACON_ENDPOINT_TAILSCALE", DefaultL1CLBeaconEndpointTailscale) + L1ELEndpoint = getEnvOrDefault("L1_EL_ENDPOINT_TAILSCALE", DefaultL1ELEndpointTailscale) + } + + // Runtime configuration values + l.Info("Runtime configuration values for TestSyncTesterExtEL") + l.Info("L2_NETWORK_NAME", "value", L2NetworkName) + l.Info("L1_CHAIN_ID", "value", L1ChainID) + l.Info("L2_EL_ENDPOINT", "value", L2ELEndpoint) + l.Info("L1_CL_BEACON_ENDPOINT", "value", L1CLBeaconEndpoint) + l.Info("L1_EL_ENDPOINT", "value", L1ELEndpoint) + l.Info("TAILSCALE_NETWORKING", "value", os.Getenv("TAILSCALE_NETWORKING")) + + // Setup orchestrator + logger := testlog.Logger(gt, log.LevelInfo) + onFail := func(now bool) { + if now { + gt.FailNow() + } else { + gt.Fail() + } + } + onSkipNow := func() { + gt.SkipNow() + } + p := devtest.NewP(ctx, logger, onFail, onSkipNow) + gt.Cleanup(p.Close) + + // Fetch the latest block number from the remote L2EL node + cl, err := ethclient.DialContext(ctx, L2ELEndpoint) + require.NoError(err) + latestBlock, err := cl.BlockByNumber(ctx, nil) + require.NoError(err) + + initial := latestBlock.NumberU64() - 1000 + l.Info("LATEST_BLOCK", "latest_block", latestBlock.NumberU64(), "session_initial_block", initial) + + opt := sysgo.DefaultMinimalExternalELSystemWithEndpointAndSuperchainRegistry(&sysgo.DefaultMinimalExternalELSystemIDs{}, L1CLBeaconEndpoint, L1ELEndpoint, L2ELEndpoint, L1ChainID, L2NetworkName, eth.FCUState{ + Latest: initial, + Safe: initial, + Finalized: initial, + }) + + orch := sysgo.NewOrchestrator(p, stack.SystemHook(opt)) + stack.ApplyOptionLifecycle[*sysgo.Orchestrator](opt, orch) + + return orch, initial +} + +// getEnvOrDefault returns the environment variable value or the default if not set +func getEnvOrDefault(envVar, defaultValue string) string { + if value := os.Getenv(envVar); value != "" { + return value + } + return defaultValue +} + +// getEnvUint64OrDefault returns the environment variable value as uint64 or the default if not set +func getEnvUint64OrDefault(envVar string, defaultValue uint64) uint64 { + if value := os.Getenv(envVar); value != "" { + if parsed, err := strconv.ParseUint(value, 10, 64); err == nil { + return parsed + } + } + return defaultValue +} diff --git a/op-acceptance-tests/tests/sync_tester/sync_tester_hfs/init_test.go b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs/init_test.go new file mode 100644 index 00000000000..989f07cdd7f --- /dev/null +++ b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs/init_test.go @@ -0,0 +1,30 @@ +package sync_tester_hfs + +import ( + "testing" + + bss "github.com/ethereum-optimism/optimism/op-batcher/batcher" + "github.com/ethereum-optimism/optimism/op-devstack/compat" + "github.com/ethereum-optimism/optimism/op-devstack/presets" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-devstack/sysgo" + "github.com/ethereum-optimism/optimism/op-node/rollup" + "github.com/ethereum-optimism/optimism/op-node/rollup/derive" + "github.com/ethereum-optimism/optimism/op-service/eth" +) + +func TestMain(m *testing.M) { + presets.DoMain(m, presets.WithSimpleWithSyncTester(eth.FCUState{ + Latest: 0, + Safe: 0, + Finalized: 0, + }), + presets.WithCompatibleTypes(compat.SysGo), + presets.WithHardforkSequentialActivation(rollup.Bedrock, rollup.Jovian, 15), + stack.MakeCommon(sysgo.WithBatcherOption(func(id stack.L2BatcherID, cfg *bss.CLIConfig) { + // For supporting pre-delta batches + cfg.BatchType = derive.SingularBatchType + // For supporting pre-Fjord batches + cfg.CompressionAlgo = derive.Zlib + }))) +} diff --git a/op-acceptance-tests/tests/sync_tester/sync_tester_hfs/sync_tester_hfs_test.go b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs/sync_tester_hfs_test.go new file mode 100644 index 00000000000..ebd67346a62 --- /dev/null +++ b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs/sync_tester_hfs_test.go @@ -0,0 +1,34 @@ +package sync_tester_hfs + +import ( + "testing" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/dsl" + "github.com/ethereum-optimism/optimism/op-devstack/presets" + "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types" +) + +func TestSyncTesterHardforks(gt *testing.T) { + t := devtest.SerialT(gt) + + sys := presets.NewSimpleWithSyncTester(t) + require := t.Require() + + // Hardforks will be activated from Bedrock to Isthmus, 9 hardforks with 15 second time delta between. + // 15 * 9 = 135s, so we need at least 69 (135 / 2 + 1) L2 blocks with block time 2 to make the CL experience scheduled hardforks. + targetNum := 70 + dsl.CheckAll(t, + sys.L2CL.AdvancedFn(types.LocalUnsafe, uint64(targetNum), targetNum*2+10), + sys.L2CL2.AdvancedFn(types.LocalUnsafe, uint64(targetNum), targetNum*2+10), + ) + + current := sys.L2CL2.HeadBlockRef(types.LocalUnsafe) + + // Check the L2CL passed configured hardforks + isthmusTime := sys.L2Chain.Escape().ChainConfig().IsthmusTime + require.NotNil(isthmusTime, "isthmus must be activated") + require.Greater(current.Time, *isthmusTime, "must pass isthmus block") + // Check block hash state from L2CL2 which was synced using the sync tester + require.Equal(sys.L2EL.BlockRefByNumber(current.Number).Hash, current.Hash, "hash mismatch") +} diff --git a/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_canyon/sync_tester_hfs_ext_canyon_test.go b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_canyon/sync_tester_hfs_ext_canyon_test.go new file mode 100644 index 00000000000..84376febad4 --- /dev/null +++ b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_canyon/sync_tester_hfs_ext_canyon_test.go @@ -0,0 +1,12 @@ +package sync_tester_hfs_ext_canyon + +import ( + "testing" + + "github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/sync_tester/hardforks_ext" + "github.com/ethereum-optimism/optimism/op-node/rollup" +) + +func TestSyncTesterHFS_Canyon(gt *testing.T) { + hardforks_ext.SyncTesterHFSExt(gt, rollup.Canyon) +} diff --git a/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_delta/sync_tester_hfs_ext_delta_test.go b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_delta/sync_tester_hfs_ext_delta_test.go new file mode 100644 index 00000000000..9bf26fb7f46 --- /dev/null +++ b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_delta/sync_tester_hfs_ext_delta_test.go @@ -0,0 +1,12 @@ +package sync_tester_hfs_ext_delta + +import ( + "testing" + + "github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/sync_tester/hardforks_ext" + "github.com/ethereum-optimism/optimism/op-node/rollup" +) + +func TestSyncTesterHFS_Delta(gt *testing.T) { + hardforks_ext.SyncTesterHFSExt(gt, rollup.Delta) +} diff --git a/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_ecotone/sync_tester_hfs_ext_ecotone_test.go b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_ecotone/sync_tester_hfs_ext_ecotone_test.go new file mode 100644 index 00000000000..2a8d8561af4 --- /dev/null +++ b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_ecotone/sync_tester_hfs_ext_ecotone_test.go @@ -0,0 +1,12 @@ +package sync_tester_hfs_ext_ecotone + +import ( + "testing" + + "github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/sync_tester/hardforks_ext" + "github.com/ethereum-optimism/optimism/op-node/rollup" +) + +func TestSyncTesterHFS_Ecotone(gt *testing.T) { + hardforks_ext.SyncTesterHFSExt(gt, rollup.Ecotone) +} diff --git a/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_fjord/sync_tester_hfs_ext_fjord_test.go b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_fjord/sync_tester_hfs_ext_fjord_test.go new file mode 100644 index 00000000000..62f6f6260f9 --- /dev/null +++ b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_fjord/sync_tester_hfs_ext_fjord_test.go @@ -0,0 +1,12 @@ +package sync_tester_hfs_ext_fjord + +import ( + "testing" + + "github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/sync_tester/hardforks_ext" + "github.com/ethereum-optimism/optimism/op-node/rollup" +) + +func TestSyncTesterHFS_Fjord(gt *testing.T) { + hardforks_ext.SyncTesterHFSExt(gt, rollup.Fjord) +} diff --git a/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_granite/sync_tester_hfs_ext_granite_test.go b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_granite/sync_tester_hfs_ext_granite_test.go new file mode 100644 index 00000000000..d466dc00385 --- /dev/null +++ b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_granite/sync_tester_hfs_ext_granite_test.go @@ -0,0 +1,12 @@ +package sync_tester_hfs_ext_granite + +import ( + "testing" + + "github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/sync_tester/hardforks_ext" + "github.com/ethereum-optimism/optimism/op-node/rollup" +) + +func TestSyncTesterHFS_Granite(gt *testing.T) { + hardforks_ext.SyncTesterHFSExt(gt, rollup.Granite) +} diff --git a/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_holocene/sync_tester_hfs_ext_holocene_test.go b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_holocene/sync_tester_hfs_ext_holocene_test.go new file mode 100644 index 00000000000..f95f3d636f4 --- /dev/null +++ b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_holocene/sync_tester_hfs_ext_holocene_test.go @@ -0,0 +1,12 @@ +package sync_tester_hfs_ext_holocene + +import ( + "testing" + + "github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/sync_tester/hardforks_ext" + "github.com/ethereum-optimism/optimism/op-node/rollup" +) + +func TestSyncTesterHFS_Holocene(gt *testing.T) { + hardforks_ext.SyncTesterHFSExt(gt, rollup.Holocene) +} diff --git a/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_isthmus/sync_tester_hfs_ext_isthmus_test.go b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_isthmus/sync_tester_hfs_ext_isthmus_test.go new file mode 100644 index 00000000000..a9540b93201 --- /dev/null +++ b/op-acceptance-tests/tests/sync_tester/sync_tester_hfs_ext_isthmus/sync_tester_hfs_ext_isthmus_test.go @@ -0,0 +1,12 @@ +package sync_tester_hfs_ext_isthmus + +import ( + "testing" + + "github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/sync_tester/hardforks_ext" + "github.com/ethereum-optimism/optimism/op-node/rollup" +) + +func TestSyncTesterHFS_Isthmus(gt *testing.T) { + hardforks_ext.SyncTesterHFSExt(gt, rollup.Isthmus) +} diff --git a/op-batcher/flags/throttle_flags.go b/op-batcher/flags/throttle_flags.go index c1628506c24..5e4f5673db6 100644 --- a/op-batcher/flags/throttle_flags.go +++ b/op-batcher/flags/throttle_flags.go @@ -10,14 +10,14 @@ import ( const ( // Block-builder side DefaultThrottleTxSizeLowerLimit = 150 - DefaultThrottleTxSizeUpperLimit = 10_000 + DefaultThrottleTxSizeUpperLimit = 20_000 DefaultThrottleBlockSizeLowerLimit = 2_000 DefaultThrottleBlockSizeUpperLimit = 130_000 // Controller side DefaultThrottleControllerType = "quadratic" - DefaultThrottleLowerThreshold = 1_600_000 // allows for 2x (6 blobs, 1 tx) channels at ~131KB per blob - DefaultThrottleUpperThreshold = DefaultThrottleLowerThreshold * 5 + DefaultThrottleLowerThreshold = 3_200_000 // allows for 4x 6-blob-tx channels at ~131KB per blob + DefaultThrottleUpperThreshold = DefaultThrottleLowerThreshold * 4 DefaultPIDSampleTime = 2 * time.Second DefaultPIDKp = 0.33 DefaultPIDKi = 0.01 diff --git a/op-chain-ops/addresses/contracts.go b/op-chain-ops/addresses/contracts.go index d526e287511..c531fa27be2 100644 --- a/op-chain-ops/addresses/contracts.go +++ b/op-chain-ops/addresses/contracts.go @@ -36,6 +36,7 @@ type ImplementationsContracts struct { OpcmStandardValidatorImpl common.Address DelayedWethImpl common.Address OptimismPortalImpl common.Address + OptimismPortalInteropImpl common.Address EthLockboxImpl common.Address PreimageOracleImpl common.Address MipsImpl common.Address diff --git a/op-chain-ops/cmd/check-prestate/main.go b/op-chain-ops/cmd/check-prestate/main.go index a08c8a3d840..a3a5864ddf1 100644 --- a/op-chain-ops/cmd/check-prestate/main.go +++ b/op-chain-ops/cmd/check-prestate/main.go @@ -5,14 +5,13 @@ import ( "encoding/json" "flag" "fmt" - "io" - "net/http" "os" - "os/exec" - "path/filepath" "strings" "github.com/BurntSushi/toml" + "github.com/ethereum-optimism/optimism/op-chain-ops/cmd/check-prestate/prestate" + "github.com/ethereum-optimism/optimism/op-chain-ops/cmd/check-prestate/registry" + "github.com/ethereum-optimism/optimism/op-chain-ops/cmd/check-prestate/types" "github.com/ethereum-optimism/optimism/op-program/prestates" oplog "github.com/ethereum-optimism/optimism/op-service/log" "github.com/ethereum/go-ethereum/common" @@ -20,45 +19,14 @@ import ( "github.com/ethereum/go-ethereum/superchain" "github.com/mattn/go-isatty" "golang.org/x/exp/maps" - "golang.org/x/mod/modfile" ) -const ( - monorepoGoModAtTag = "https://github.com/ethereum-optimism/optimism/raw/refs/tags/%s/go.mod" - superchainRegistryCommitAtRef = "https://github.com/ethereum-optimism/op-geth/raw/%s/superchain-registry-commit.txt" - superchainConfigsZipAtTag = "https://github.com/ethereum-optimism/op-geth/raw/refs/tags/%s/superchain/superchain-configs.zip" - syncSuperchainScript = "https://github.com/ethereum-optimism/op-geth/raw/refs/heads/optimism/sync-superchain.sh" -) - -type PrestateInfo struct { - Hash common.Hash `json:"hash"` - Version string `json:"version"` - Type string `json:"type"` - - OpProgram CommitInfo `json:"op-program"` - OpGeth CommitInfo `json:"op-geth"` - SuperchainRegistry CommitInfo `json:"superchain-registry"` - - UpToDateChains []string `json:"up-to-date-chains"` - OutdatedChains []OutdatedChain `json:"outdated-chains"` - MissingChains []string `json:"missing-chains"` -} - -type OutdatedChain struct { - Name string `json:"name"` - Diff *Diff `json:"diff,omitempty"` -} - -type CommitInfo struct { - Commit string `json:"commit"` - DiffUrl string `json:"diff-url"` - DiffCmd string `json:"diff-cmd"` -} - -type Diff struct { - Msg string `json:"message"` - Prestate any `json:"prestate"` - Latest any `json:"latest"` +type FPProgramType interface { + FindVersions(log log.Logger, prestateVersion string) ( + elCommitInfo types.CommitInfo, + fppCommitInfo types.CommitInfo, + superChainRegistryCommit string, + prestateConfigs *superchain.ChainConfigLoader) } func main() { @@ -77,6 +45,9 @@ func main() { flag.StringVar(&prestateHashStr, "prestate-hash", "", "Specify the absolute prestate hash to verify") flag.StringVar(&chainsStr, "chains", "", "List of chains to consider in the report. Comma separated. Default: all chains in the superchain-registry") + var versionsOverrideFile string + flag.StringVar(&versionsOverrideFile, "versions-file", "", "Override the prestate versions TOML file") + // Parse the command-line arguments flag.Parse() if prestateHashStr == "" { @@ -101,7 +72,7 @@ func main() { log.Crit("--prestate-hash is invalid") } - prestateReleases, err := prestates.LoadReleases("") + prestateReleases, err := prestates.LoadReleases(versionsOverrideFile) if err != nil { log.Crit("Failed to load prestate releases list", "err", err) } @@ -120,50 +91,32 @@ func main() { if prestateVersion == "" { log.Crit("Failed to find a prestate release with hash", "hash", prestateHash) } - prestateTag := fmt.Sprintf("op-program/v%s", prestateVersion) - log.Info("Found prestate", "version", prestateVersion, "type", prestateType, "tag", prestateTag) + log.Info("Found prestate", "version", prestateVersion, "type", prestateType) - modFile, err := fetchMonorepoGoMod(prestateTag) - if err != nil { - log.Crit("Failed to fetch go mod", "err", err) - } - var gethVersion string - for _, replace := range modFile.Replace { - if replace.Old.Path == "github.com/ethereum/go-ethereum" { - gethVersion = replace.New.Version - break - } + var prestateImpl FPProgramType + switch prestateType { + case "cannon32", "cannon64", "interop": + prestateImpl = prestate.NewOPProgramPrestate() + case "cannon-kona": + prestateImpl = prestate.NewKonaPrestate() + default: + log.Crit("Invalid prestate type", "type", prestateType) } - if gethVersion == "" { - log.Crit("Failed to find op-geth replace in go.mod") - } - log.Info("Found op-geth version", "version", gethVersion) - - registryCommitBytes, err := fetch(fmt.Sprintf(superchainRegistryCommitAtRef, gethVersion)) + elCommitInfo, fppCommitInfo, commit, prestateConfigs := prestateImpl.FindVersions(log, prestateVersion) if err != nil { - log.Crit("Failed to fetch superchain registry commit info", "err", err) + log.Crit("Failed to load configuration for prestate info", "err", err) } - commit := strings.TrimSpace(string(registryCommitBytes)) - log.Info("Found superchain registry commit info", "commit", commit) - prestateConfigData, err := fetch(fmt.Sprintf(superchainConfigsZipAtTag, gethVersion)) - if err != nil { - log.Crit("Failed to fetch prestate's superchain registry config zip", "err", err) - } - prestateConfigs, err := superchain.NewChainConfigLoader(prestateConfigData) - if err != nil { - log.Crit("Failed to parse prestate's superchain registry config zip", "err", err) - } prestateNames := prestateConfigs.ChainNames() - latestConfigs, err := latestSuperchainConfigs() + latestConfigs, err := registry.LatestSuperchainConfigs() if err != nil { log.Crit("Failed to get latest superchain configs", "err", err) } knownChains := make(map[string]bool) - var supportedChains []string - outdatedChains := make(map[string]OutdatedChain) + supportedChains := make([]string, 0) // Not null for json serialization + outdatedChains := make(map[string]types.OutdatedChain) for _, name := range prestateNames { if !chainFilter(name) { continue @@ -174,7 +127,7 @@ func main() { log.Crit("Failed to check config", "chain", name, "err", err) } if diff != nil { - outdatedChains[name] = OutdatedChain{ + outdatedChains[name] = types.OutdatedChain{ Name: name, Diff: diff, } @@ -197,12 +150,12 @@ func main() { } } - report := PrestateInfo{ + report := types.PrestateInfo{ Hash: prestateHash, Version: prestateVersion, Type: prestateType, - OpProgram: commitInfo("optimism", prestateTag, "develop", ""), - OpGeth: commitInfo("op-geth", gethVersion, "optimism", ""), + FppProgram: fppCommitInfo, + ExecutionClient: elCommitInfo, SuperchainRegistry: commitInfo("superchain-registry", commit, "main", "superchain"), UpToDateChains: supportedChains, OutdatedChains: maps.Values(outdatedChains), @@ -216,7 +169,7 @@ func main() { } } -func checkConfig(network string, actual *superchain.ChainConfigLoader, expected *superchain.ChainConfigLoader) (*Diff, error) { +func checkConfig(network string, actual *superchain.ChainConfigLoader, expected *superchain.ChainConfigLoader) (*types.Diff, error) { actualChainID, err := actual.ChainIDByName(network) if err != nil { return nil, fmt.Errorf("failed to get actual chain ID for %v: %w", network, err) @@ -226,7 +179,7 @@ func checkConfig(network string, actual *superchain.ChainConfigLoader, expected return nil, fmt.Errorf("failed to get expected chain ID for %v: %w", network, err) } if actualChainID != expectedChainID { - return &Diff{ + return &types.Diff{ Msg: "Chain ID mismatch", Prestate: actualChainID, Latest: expectedChainID, @@ -264,7 +217,7 @@ func checkConfig(network string, actual *superchain.ChainConfigLoader, expected return nil, fmt.Errorf("failed to get genesis for expected chain %v: %w", network, err) } if !bytes.Equal(actualGenesis, expectedGenesis) { - return &Diff{ + return &types.Diff{ Msg: "Genesis mismatch", Prestate: string(actualGenesis), Latest: string(expectedGenesis), @@ -273,7 +226,7 @@ func checkConfig(network string, actual *superchain.ChainConfigLoader, expected return nil, nil } -func checkChainConfig(actual *superchain.ChainConfig, expected *superchain.ChainConfig) (*Diff, error) { +func checkChainConfig(actual *superchain.ChainConfig, expected *superchain.ChainConfig) (*types.Diff, error) { actualStr, err := toml.Marshal(actual) if err != nil { return nil, fmt.Errorf("failed to marshal actual chain config: %w", err) @@ -283,7 +236,7 @@ func checkChainConfig(actual *superchain.ChainConfig, expected *superchain.Chain return nil, fmt.Errorf("failed to marshal expected chain config: %w", err) } if !bytes.Equal(actualStr, expectedStr) { - return &Diff{ + return &types.Diff{ Msg: "Chain config mismatch", Prestate: actual, Latest: expected, @@ -291,70 +244,10 @@ func checkChainConfig(actual *superchain.ChainConfig, expected *superchain.Chain } return nil, nil } - -// latestSuperchainConfigs loads the latest config from the superchain-registry main branch using the -// sync-superchain.sh script from op-geth to create a zip of configs that can be read by op-geth's ChainConfigLoader. -func latestSuperchainConfigs() (*superchain.ChainConfigLoader, error) { - // Download the op-geth script to build the superchain config - script, err := fetch(syncSuperchainScript) - if err != nil { - return nil, fmt.Errorf("failed to fetch sync-superchain.sh script: %w", err) - } - dir, err := os.MkdirTemp("", "checkprestate") - if err != nil { - return nil, fmt.Errorf("failed to create temp dir: %w", err) - } - defer os.RemoveAll(dir) - if err := os.Mkdir(filepath.Join(dir, "superchain"), 0o700); err != nil { - return nil, fmt.Errorf("failed to create superchain dir: %w", err) - } - scriptPath := filepath.Join(dir, "sync-superchain.sh") - if err := os.WriteFile(scriptPath, script, 0o700); err != nil { - return nil, fmt.Errorf("failed to write sync-superchain.sh: %w", err) - } - if err := os.WriteFile(filepath.Join(dir, "superchain-registry-commit.txt"), []byte("main"), 0o600); err != nil { - return nil, fmt.Errorf("failed to write superchain-registry-commit.txt: %w", err) - } - cmd := exec.Command(scriptPath) - cmd.Stdout = os.Stderr - cmd.Stderr = os.Stderr - cmd.Dir = dir - if err := cmd.Run(); err != nil { - return nil, fmt.Errorf("failed to build superchain config zip: %w", err) - } - configBytes, err := os.ReadFile(filepath.Join(dir, "superchain/superchain-configs.zip")) - if err != nil { - return nil, fmt.Errorf("failed to read generated superchain-configs.zip: %w", err) - } - return superchain.NewChainConfigLoader(configBytes) -} - -func commitInfo(repository string, commit string, mainBranch string, dir string) CommitInfo { - return CommitInfo{ +func commitInfo(repository string, commit string, mainBranch string, dir string) types.CommitInfo { + return types.CommitInfo{ Commit: commit, DiffUrl: fmt.Sprintf("https://github.com/ethereum-optimism/%s/compare/%s...%s", repository, commit, mainBranch), DiffCmd: fmt.Sprintf("git fetch && git diff %s...origin/%s %s", commit, mainBranch, dir), } } - -func fetchMonorepoGoMod(opProgramTag string) (*modfile.File, error) { - goModUrl := fmt.Sprintf(monorepoGoModAtTag, opProgramTag) - goMod, err := fetch(goModUrl) - if err != nil { - return nil, fmt.Errorf("failed to fetch go.mod: %w", err) - } - - return modfile.Parse("go.mod", goMod, nil) -} - -func fetch(url string) ([]byte, error) { - resp, err := http.Get(url) - if err != nil { - return nil, fmt.Errorf("failed to fetch %v: %w", url, err) - } - defer resp.Body.Close() - if resp.StatusCode != http.StatusOK { - return nil, fmt.Errorf("failed to fetch %v: %s", url, resp.Status) - } - return io.ReadAll(resp.Body) -} diff --git a/op-chain-ops/cmd/check-prestate/prestate/kona.go b/op-chain-ops/cmd/check-prestate/prestate/kona.go new file mode 100644 index 00000000000..e9ba0cb30e7 --- /dev/null +++ b/op-chain-ops/cmd/check-prestate/prestate/kona.go @@ -0,0 +1,87 @@ +package prestate + +import ( + "encoding/json" + "fmt" + "net/http" + "net/url" + + "github.com/ethereum-optimism/optimism/op-chain-ops/cmd/check-prestate/registry" + "github.com/ethereum-optimism/optimism/op-chain-ops/cmd/check-prestate/types" + "github.com/ethereum/go-ethereum/log" + "github.com/ethereum/go-ethereum/superchain" +) + +type KonaPrestate struct { +} + +func NewKonaPrestate() *KonaPrestate { + return &KonaPrestate{} +} + +func (p *KonaPrestate) FindVersions(log log.Logger, prestateVersion string) ( + elCommitInfo types.CommitInfo, + fppCommitInfo types.CommitInfo, + superChainRegistryCommit string, + prestateConfigs *superchain.ChainConfigLoader) { + + prestateTag := fmt.Sprintf("kona-client/v%s", prestateVersion) + log.Info("Found prestate tag", "tag", prestateTag) + fppCommitInfo = types.NewCommitInfo("op-rs", "kona", prestateTag, "main", "") + + superChainRegistryCommit, err := fetchSuperchainRegistryCommit(prestateTag) + if err != nil { + log.Crit("Failed to fetch superchain registry commit", "err", err) + } + + // Kona doesn't directly depend on op-reth but uses various crates from it. + // Skip attempting to report a specific op-reth version for now. + elCommitInfo = types.CommitInfo{} + + // kona has its own build process to convert superchain-registry config into a custom JSON format it uses + // Rather than re-implement that custom JSON format and work out how to convert it to the go format + // (which could be brittle), we use the op-geth sync process to convert the superchain registry at the same commit + // to the go format directly. This is unfortunately also potentially brittle since we have to use the latest + // sync script from op-geth rather than a fixed version but seems like the lowest risk option. + configs, err := registry.SuperchainConfigsForCommit(superChainRegistryCommit) + if err != nil { + log.Crit("Failed to fetch chain configs for prestate", "err", err) + } + prestateConfigs = configs + return +} + +func fetchSuperchainRegistryCommit(ref string) (string, error) { + endpoint := "https://api.github.com/repos/op-rs/kona/contents/crates/protocol/registry/superchain-registry?ref=" + + url.QueryEscape(ref) + + req, err := http.NewRequest(http.MethodGet, endpoint, nil) + if err != nil { + return "", fmt.Errorf("build request: %w", err) + } + req.Header.Set("Accept", "application/vnd.github+json") + + resp, err := http.DefaultClient.Do(req) + if err != nil { + return "", fmt.Errorf("http request: %w", err) + } + defer resp.Body.Close() + + // Parse error payloads from GitHub if status != 200. + if resp.StatusCode != http.StatusOK { + return "", fmt.Errorf("failed to fetch superchain-registry version, http status: %s", resp.Status) + } + + // Success path: expect a single "submodule" content object with "sha". + var content struct { + Type string `json:"type"` // should be "submodule" + SHA string `json:"sha"` + } + if err := json.NewDecoder(resp.Body).Decode(&content); err != nil { + return "", fmt.Errorf("decode response: %w", err) + } + if content.Type != "submodule" { + return "", fmt.Errorf("expected a submodule got type %q", content.Type) + } + return content.SHA, nil +} diff --git a/op-chain-ops/cmd/check-prestate/prestate/opprogram.go b/op-chain-ops/cmd/check-prestate/prestate/opprogram.go new file mode 100644 index 00000000000..5360851c2e7 --- /dev/null +++ b/op-chain-ops/cmd/check-prestate/prestate/opprogram.go @@ -0,0 +1,86 @@ +package prestate + +import ( + "fmt" + "strings" + + "github.com/ethereum-optimism/optimism/op-chain-ops/cmd/check-prestate/types" + "github.com/ethereum-optimism/optimism/op-chain-ops/cmd/check-prestate/util" + "github.com/ethereum/go-ethereum/log" + "github.com/ethereum/go-ethereum/superchain" + "golang.org/x/mod/modfile" +) + +const ( + monorepoGoModAtTag = "https://github.com/ethereum-optimism/optimism/raw/refs/tags/%s/go.mod" + superchainRegistryCommitAtRef = "https://github.com/ethereum-optimism/op-geth/raw/%s/superchain-registry-commit.txt" + superchainConfigsZipAtTag = "https://github.com/ethereum-optimism/op-geth/raw/refs/tags/%s/superchain/superchain-configs.zip" +) + +type OPProgramPrestate struct { +} + +func NewOPProgramPrestate() *OPProgramPrestate { + return &OPProgramPrestate{} +} + +func (p *OPProgramPrestate) FindVersions(log log.Logger, prestateVersion string) ( + elCommitInfo types.CommitInfo, + fppCommitInfo types.CommitInfo, + superChainRegistryCommit string, + prestateConfigs *superchain.ChainConfigLoader, +) { + prestateTag := fmt.Sprintf("op-program/v%s", prestateVersion) + log.Info("Found prestate tag", "tag", prestateTag) + fppCommitInfo = types.NewCommitInfo("ethereum-optimism", "optimism", prestateTag, "develop", "") + + modFile, err := fetchMonorepoGoMod(prestateTag) + if err != nil { + log.Crit("Failed to fetch go mod", "err", err) + } + elVersion := p.findOpGethVersion(log, modFile) + elCommitInfo = types.NewCommitInfo("ethereum-optimism", "op-geth", elVersion, "optimism", "") + + registryCommitBytes, err := util.Fetch(fmt.Sprintf(superchainRegistryCommitAtRef, elVersion)) + if err != nil { + log.Crit("Failed to fetch superchain registry commit info", "err", err) + } + superChainRegistryCommit = strings.TrimSpace(string(registryCommitBytes)) + log.Info("Found superchain registry commit info", "commit", superChainRegistryCommit) + + prestateConfigData, err := util.Fetch(fmt.Sprintf(superchainConfigsZipAtTag, elVersion)) + if err != nil { + log.Crit("Failed to fetch prestate's superchain registry config zip", "err", err) + } + configLoader, err := superchain.NewChainConfigLoader(prestateConfigData) + if err != nil { + log.Crit("Failed to parse prestate's superchain registry config zip", "err", err) + } + prestateConfigs = configLoader + return +} + +func (p *OPProgramPrestate) findOpGethVersion(log log.Logger, modFile *modfile.File) string { + var elVersion string + for _, replace := range modFile.Replace { + if replace.Old.Path == "github.com/ethereum/go-ethereum" { + elVersion = replace.New.Version + break + } + } + if elVersion == "" { + log.Crit("Failed to find op-geth replace in go.mod") + } + log.Info("Found op-geth version", "version", elVersion) + return elVersion +} + +func fetchMonorepoGoMod(opProgramTag string) (*modfile.File, error) { + goModUrl := fmt.Sprintf(monorepoGoModAtTag, opProgramTag) + goMod, err := util.Fetch(goModUrl) + if err != nil { + return nil, fmt.Errorf("failed to fetch go.mod: %w", err) + } + + return modfile.Parse("go.mod", goMod, nil) +} diff --git a/op-chain-ops/cmd/check-prestate/registry/loader.go b/op-chain-ops/cmd/check-prestate/registry/loader.go new file mode 100644 index 00000000000..ae92550d9a8 --- /dev/null +++ b/op-chain-ops/cmd/check-prestate/registry/loader.go @@ -0,0 +1,56 @@ +package registry + +import ( + "fmt" + "os" + "os/exec" + "path/filepath" + + "github.com/ethereum-optimism/optimism/op-chain-ops/cmd/check-prestate/util" + "github.com/ethereum/go-ethereum/superchain" +) + +const ( + syncSuperchainScript = "https://raw.githubusercontent.com/ethereum-optimism/op-geth/optimism/sync-superchain.sh" +) + +// LatestSuperchainConfigs loads the latest config from the superchain-registry main branch using the +// sync-superchain.sh script from op-geth to create a zip of configs that can be read by op-geth's ChainConfigLoader. +func LatestSuperchainConfigs() (*superchain.ChainConfigLoader, error) { + return SuperchainConfigsForCommit("main") +} + +func SuperchainConfigsForCommit(registryCommit string) (*superchain.ChainConfigLoader, error) { + // Download the op-geth script to build the superchain config + script, err := util.Fetch(syncSuperchainScript) + if err != nil { + return nil, fmt.Errorf("failed to fetch sync-superchain.sh script: %w", err) + } + dir, err := os.MkdirTemp("", "checkprestate") + if err != nil { + return nil, fmt.Errorf("failed to create temp dir: %w", err) + } + defer os.RemoveAll(dir) + if err := os.Mkdir(filepath.Join(dir, "superchain"), 0o700); err != nil { + return nil, fmt.Errorf("failed to create superchain dir: %w", err) + } + scriptPath := filepath.Join(dir, "sync-superchain.sh") + if err := os.WriteFile(scriptPath, script, 0o700); err != nil { + return nil, fmt.Errorf("failed to write sync-superchain.sh: %w", err) + } + if err := os.WriteFile(filepath.Join(dir, "superchain-registry-commit.txt"), []byte(registryCommit), 0o600); err != nil { + return nil, fmt.Errorf("failed to write superchain-registry-commit.txt: %w", err) + } + cmd := exec.Command(scriptPath) + cmd.Stdout = os.Stderr + cmd.Stderr = os.Stderr + cmd.Dir = dir + if err := cmd.Run(); err != nil { + return nil, fmt.Errorf("failed to build superchain config zip: %w", err) + } + configBytes, err := os.ReadFile(filepath.Join(dir, "superchain/superchain-configs.zip")) + if err != nil { + return nil, fmt.Errorf("failed to read generated superchain-configs.zip: %w", err) + } + return superchain.NewChainConfigLoader(configBytes) +} diff --git a/op-chain-ops/cmd/check-prestate/types/types.go b/op-chain-ops/cmd/check-prestate/types/types.go new file mode 100644 index 00000000000..3f80784df3f --- /dev/null +++ b/op-chain-ops/cmd/check-prestate/types/types.go @@ -0,0 +1,46 @@ +package types + +import ( + "fmt" + + "github.com/ethereum/go-ethereum/common" +) + +type PrestateInfo struct { + Hash common.Hash `json:"hash"` + Version string `json:"version"` + Type string `json:"type"` + + FppProgram CommitInfo `json:"fpp-program"` + ExecutionClient CommitInfo `json:"execution-client"` + SuperchainRegistry CommitInfo `json:"superchain-registry"` + + UpToDateChains []string `json:"up-to-date-chains"` + OutdatedChains []OutdatedChain `json:"outdated-chains"` + MissingChains []string `json:"missing-chains"` +} + +type OutdatedChain struct { + Name string `json:"name"` + Diff *Diff `json:"diff,omitempty"` +} + +type CommitInfo struct { + Commit string `json:"commit"` + DiffUrl string `json:"diff-url"` + DiffCmd string `json:"diff-cmd"` +} + +func NewCommitInfo(org string, repository string, commit string, mainBranch string, dir string) CommitInfo { + return CommitInfo{ + Commit: commit, + DiffUrl: fmt.Sprintf("https://github.com/%s/%s/compare/%s...%s", org, repository, commit, mainBranch), + DiffCmd: fmt.Sprintf("git fetch && git diff %s...origin/%s %s", commit, mainBranch, dir), + } +} + +type Diff struct { + Msg string `json:"message"` + Prestate any `json:"prestate"` + Latest any `json:"latest"` +} diff --git a/op-chain-ops/cmd/check-prestate/util/fetch.go b/op-chain-ops/cmd/check-prestate/util/fetch.go new file mode 100644 index 00000000000..c5935d85a76 --- /dev/null +++ b/op-chain-ops/cmd/check-prestate/util/fetch.go @@ -0,0 +1,19 @@ +package util + +import ( + "fmt" + "io" + "net/http" +) + +func Fetch(url string) ([]byte, error) { + resp, err := http.Get(url) + if err != nil { + return nil, fmt.Errorf("failed to fetch %v: %w", url, err) + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return nil, fmt.Errorf("failed to fetch %v: %s", url, resp.Status) + } + return io.ReadAll(resp.Body) +} diff --git a/op-chain-ops/cmd/op-run-block/main.go b/op-chain-ops/cmd/op-run-block/main.go index 5738fb7ddff..86b9667c21e 100644 --- a/op-chain-ops/cmd/op-run-block/main.go +++ b/op-chain-ops/cmd/op-run-block/main.go @@ -308,6 +308,7 @@ func Process(logger log.Logger, config *params.ChainConfig, header = block.CreateGethHeader() blockHash = block.Hash blockNumber = new(big.Int).SetUint64(uint64(block.Number)) + blockTime = uint64(block.Time) allLogs []*types.Log gp = new(core.GasPool).AddGas(uint64(block.GasLimit)) ) @@ -342,7 +343,7 @@ func Process(logger log.Logger, config *params.ChainConfig, } statedb.SetTxContext(tx.Hash(), i) - receipt, err := core.ApplyTransactionWithEVM(msg, gp, statedb, blockNumber, blockHash, tx, usedGas, vmenv) + receipt, err := core.ApplyTransactionWithEVM(msg, gp, statedb, blockNumber, blockHash, blockTime, tx, usedGas, vmenv) if err != nil { return nil, fmt.Errorf("could not apply tx %d [%v]: %w", i, tx.Hash().Hex(), err) } diff --git a/op-chain-ops/foundry/allocs.go b/op-chain-ops/foundry/allocs.go index 715524a35d4..f205055a3d3 100644 --- a/op-chain-ops/foundry/allocs.go +++ b/op-chain-ops/foundry/allocs.go @@ -113,11 +113,10 @@ func (d *ForgeAllocs) UnmarshalJSON(b []byte) error { for addr, acc := range allocs { acc := acc d.Accounts[addr] = types.Account{ - Code: acc.Code, - Storage: acc.Storage, - Balance: (*uint256.Int)(&acc.Balance).ToBig(), - Nonce: (uint64)(acc.Nonce), - PrivateKey: nil, + Code: acc.Code, + Storage: acc.Storage, + Balance: (*uint256.Int)(&acc.Balance).ToBig(), + Nonce: (uint64)(acc.Nonce), } } return nil diff --git a/op-chain-ops/foundry/sourcefs.go b/op-chain-ops/foundry/sourcefs.go index 964794e5fd6..eecf787e123 100644 --- a/op-chain-ops/foundry/sourcefs.go +++ b/op-chain-ops/foundry/sourcefs.go @@ -21,6 +21,11 @@ import ( // - `/` a root dir, relative to where the source files are located (as per the compilationTarget metadata in an artifact). type SourceMapFS struct { fs fs.FS + + // optionally, the source-map FS can utilize the build-data of a specific compiler-profile. + // If left empty, assume there is a single compiler profile in the solidity-files-cache, and use that. + // The profile can be changed with SetProfile. Forge uses "default" as default profile name. + profile string } // NewSourceMapFS creates a new SourceMapFS. @@ -31,6 +36,12 @@ func NewSourceMapFS(fs fs.FS) *SourceMapFS { return &SourceMapFS{fs: fs} } +// SetCompilerProfile changes the compiler-profile that is looked +// for when reversing build-info of artifacts. +func (s *SourceMapFS) SetCompilerProfile(profile string) { + s.profile = profile +} + // ForgeBuild represents the JSON content of a forge-build entry in the `artifacts/build-info` output. type ForgeBuild struct { ID string `json:"id"` // ID of the build itself @@ -59,8 +70,8 @@ type ForgeBuildEntry struct { // ForgeBuildInfo represents a JSON entry that enumerates the latest builds per contract per compiler version. type ForgeBuildInfo struct { - // contract name -> solidity version -> build entry - Artifacts map[string]map[string]ForgeBuildEntry `json:"artifacts"` + // contract name -> solidity version -> profile -> build entry + Artifacts map[string]map[string]map[string]ForgeBuildEntry `json:"artifacts"` } // ForgeBuildCache rep @@ -87,7 +98,7 @@ func (s *SourceMapFS) readBuildCache() (*ForgeBuildCache, error) { // ReadSourceIDs reads the source-identifier to source file-path mapping that is needed to translate a source-map // of the given contract, the given compiler version, and within the given source file path. -func (s *SourceMapFS) ReadSourceIDs(path string, contract string, compilerVersion string) (map[srcmap.SourceID]string, error) { +func (s *SourceMapFS) ReadSourceIDs(path string, contract string, compilerVersion string, profile string) (map[srcmap.SourceID]string, error) { buildCache, err := s.readBuildCache() if err != nil { return nil, err @@ -100,13 +111,12 @@ func (s *SourceMapFS) ReadSourceIDs(path string, contract string, compilerVersio if !ok { return nil, fmt.Errorf("contract not found in artifact: %q", contract) } - var buildEntry ForgeBuildEntry + var byProfile map[string]ForgeBuildEntry if compilerVersion != "" { - entry, ok := byCompilerVersion[compilerVersion] + byProfile, ok = byCompilerVersion[compilerVersion] if !ok { return nil, fmt.Errorf("no known build for compiler version: %q", compilerVersion) } - buildEntry = entry } else { if len(byCompilerVersion) == 0 { return nil, errors.New("no known build, unspecified compiler version") @@ -114,8 +124,27 @@ func (s *SourceMapFS) ReadSourceIDs(path string, contract string, compilerVersio if len(byCompilerVersion) > 1 { return nil, fmt.Errorf("no compiler version specified, and more than one option: %s", strings.Join(maps.Keys(byCompilerVersion), ", ")) } - for _, entry := range byCompilerVersion { - buildEntry = entry + // select the only remaining entry + for _, v := range byCompilerVersion { + byProfile = v + } + } + var buildEntry ForgeBuildEntry + if profile != "" { + buildEntry, ok = byProfile[profile] + if !ok { + return nil, fmt.Errorf("no known build for profile: %q", profile) + } + } else { + if len(byProfile) == 0 { + return nil, errors.New("no known build, unspecified profile") + } + if len(byProfile) > 1 { + return nil, fmt.Errorf("no profile specified, and more than one option: %s", strings.Join(maps.Keys(byProfile), ", ")) + } + // select the only remaining entry + for _, v := range byProfile { + buildEntry = v } } build, err := s.readBuild(filepath.ToSlash(buildCache.Paths.BuildInfos), buildEntry.BuildID) @@ -139,7 +168,13 @@ func (s *SourceMapFS) SourceMap(artifact *Artifact, contract string) (*srcmap.So } // The commit suffix is ignored, the core semver part is what is used in the resolution of builds. basicCompilerVersion := strings.SplitN(artifact.Metadata.Compiler.Version, "+", 2)[0] - ids, err := s.ReadSourceIDs(srcPath, contract, basicCompilerVersion) + // Unfortunately, the "metadata" of an artifact does not store which compiler-profile it used. + // It's only part of the artifact name, which we don't have here. + // E.g. `Arithmetic.0.8.15.dispute.json` for "dispute" profile, + // and `Arithmetic.0.8.15.json` for the default profile. + // We allow the user to specify the profile to use here, with SourceMapFS.SetCompilerProfile. + profile := s.profile + ids, err := s.ReadSourceIDs(srcPath, contract, basicCompilerVersion, profile) if err != nil { return nil, fmt.Errorf("failed to read source IDs of %q: %w", srcPath, err) } diff --git a/op-chain-ops/foundry/testdata/srcmaps/artifacts/build-info/c79aa2c3b4578aee2dd8f02d20b1aeb6.json b/op-chain-ops/foundry/testdata/srcmaps/artifacts/build-info/1bb28cee9518b06fd6ee7bb37b5854cb.json similarity index 54% rename from op-chain-ops/foundry/testdata/srcmaps/artifacts/build-info/c79aa2c3b4578aee2dd8f02d20b1aeb6.json rename to op-chain-ops/foundry/testdata/srcmaps/artifacts/build-info/1bb28cee9518b06fd6ee7bb37b5854cb.json index 59cd6663b18..94fd65fd66d 100644 --- a/op-chain-ops/foundry/testdata/srcmaps/artifacts/build-info/c79aa2c3b4578aee2dd8f02d20b1aeb6.json +++ b/op-chain-ops/foundry/testdata/srcmaps/artifacts/build-info/1bb28cee9518b06fd6ee7bb37b5854cb.json @@ -1 +1 @@ -{"id":"c79aa2c3b4578aee2dd8f02d20b1aeb6","source_id_to_path":{"0":"src/SimpleStorage.sol","1":"src/StorageLibrary.sol"},"language":"Solidity"} \ No newline at end of file +{"id":"1bb28cee9518b06fd6ee7bb37b5854cb","source_id_to_path":{"0":"src/SimpleStorage.sol","1":"src/StorageLibrary.sol"},"language":"Solidity"} \ No newline at end of file diff --git a/op-chain-ops/foundry/testdata/srcmaps/cache/solidity-files-cache.json b/op-chain-ops/foundry/testdata/srcmaps/cache/solidity-files-cache.json index 47bdef8c696..9f9317c7eb1 100644 --- a/op-chain-ops/foundry/testdata/srcmaps/cache/solidity-files-cache.json +++ b/op-chain-ops/foundry/testdata/srcmaps/cache/solidity-files-cache.json @@ -1 +1 @@ -{"_format":"","paths":{"artifacts":"test-artifacts","build_infos":"artifacts/build-info","sources":"src","tests":"test","scripts":"scripts","libraries":["lib","node_modules"]},"files":{"src/SimpleStorage.sol":{"lastModificationDate":1724351550959,"contentHash":"25499c2e202ada22ebd26f8e886cc2e1","sourceName":"src/SimpleStorage.sol","compilerSettings":{"solc":{"optimizer":{"enabled":true,"runs":999999},"metadata":{"useLiteralContent":false,"bytecodeHash":"none","appendCBOR":true},"outputSelection":{"*":{"":["ast"],"*":["abi","evm.bytecode","evm.deployedBytecode","evm.methodIdentifiers","metadata","storageLayout","devdoc","userdoc"]}},"evmVersion":"cancun","viaIR":false,"libraries":{}},"vyper":{"evmVersion":"cancun","outputSelection":{"*":{"*":["abi","evm.bytecode","evm.deployedBytecode"]}}}},"imports":["src/StorageLibrary.sol"],"versionRequirement":"=0.8.15","artifacts":{"SimpleStorage":{"0.8.15":{"path":"SimpleStorage.sol/SimpleStorage.json","build_id":"c79aa2c3b4578aee2dd8f02d20b1aeb6"}}},"seenByCompiler":true},"src/StorageLibrary.sol":{"lastModificationDate":1724351550967,"contentHash":"61545ea51326b6aa0e3bafaf3116b0a8","sourceName":"src/StorageLibrary.sol","compilerSettings":{"solc":{"optimizer":{"enabled":true,"runs":999999},"metadata":{"useLiteralContent":false,"bytecodeHash":"none","appendCBOR":true},"outputSelection":{"*":{"":["ast"],"*":["abi","evm.bytecode","evm.deployedBytecode","evm.methodIdentifiers","metadata","storageLayout","devdoc","userdoc"]}},"evmVersion":"cancun","viaIR":false,"libraries":{}},"vyper":{"evmVersion":"cancun","outputSelection":{"*":{"*":["abi","evm.bytecode","evm.deployedBytecode"]}}}},"imports":[],"versionRequirement":"=0.8.15","artifacts":{"StorageLibrary":{"0.8.15":{"path":"StorageLibrary.sol/StorageLibrary.json","build_id":"c79aa2c3b4578aee2dd8f02d20b1aeb6"}}},"seenByCompiler":true}},"builds":["c79aa2c3b4578aee2dd8f02d20b1aeb6"]} \ No newline at end of file +{"_format":"","paths":{"artifacts":"test-artifacts","build_infos":"artifacts/build-info","sources":"src","tests":"test","scripts":"scripts","libraries":["lib","node_modules"]},"files":{"src/SimpleStorage.sol":{"lastModificationDate":1747615251310,"contentHash":"25499c2e202ada22ebd26f8e886cc2e1","interfaceReprHash":null,"sourceName":"src/SimpleStorage.sol","imports":["src/StorageLibrary.sol"],"versionRequirement":"=0.8.15","artifacts":{"SimpleStorage":{"0.8.15":{"default":{"path":"SimpleStorage.sol/SimpleStorage.json","build_id":"1bb28cee9518b06fd6ee7bb37b5854cb"}}}},"seenByCompiler":true},"src/StorageLibrary.sol":{"lastModificationDate":1747615251310,"contentHash":"61545ea51326b6aa0e3bafaf3116b0a8","interfaceReprHash":null,"sourceName":"src/StorageLibrary.sol","imports":[],"versionRequirement":"=0.8.15","artifacts":{"StorageLibrary":{"0.8.15":{"default":{"path":"StorageLibrary.sol/StorageLibrary.json","build_id":"1bb28cee9518b06fd6ee7bb37b5854cb"}}}},"seenByCompiler":true}},"builds":["1bb28cee9518b06fd6ee7bb37b5854cb"],"profiles":{"default":{"solc":{"optimizer":{"enabled":true,"runs":999999},"metadata":{"useLiteralContent":false,"bytecodeHash":"none","appendCBOR":true},"outputSelection":{"*":{"":["ast"],"*":["abi","evm.bytecode.object","evm.bytecode.sourceMap","evm.bytecode.linkReferences","evm.deployedBytecode.object","evm.deployedBytecode.sourceMap","evm.deployedBytecode.linkReferences","evm.deployedBytecode.immutableReferences","evm.methodIdentifiers","metadata","storageLayout","devdoc","userdoc"]}},"evmVersion":"cancun","viaIR":false,"libraries":{}},"vyper":{"evmVersion":"cancun","outputSelection":{"*":{"*":["abi","evm.bytecode","evm.deployedBytecode"]}}}}},"preprocessed":false,"mocks":[]} \ No newline at end of file diff --git a/op-chain-ops/genesis/config.go b/op-chain-ops/genesis/config.go index df8a0efbd19..f3e2052cfa3 100644 --- a/op-chain-ops/genesis/config.go +++ b/op-chain-ops/genesis/config.go @@ -1156,6 +1156,7 @@ type L1Deployments struct { OptimismMintableERC20Factory common.Address `json:"OptimismMintableERC20Factory"` OptimismMintableERC20FactoryProxy common.Address `json:"OptimismMintableERC20FactoryProxy"` OptimismPortal common.Address `json:"OptimismPortal"` + OptimismPortalInterop common.Address `json:"OptimismPortalInterop"` OptimismPortalProxy common.Address `json:"OptimismPortalProxy"` ETHLockbox common.Address `json:"ETHLockbox"` ETHLockboxProxy common.Address `json:"ETHLockboxProxy"` @@ -1183,6 +1184,7 @@ func CreateL1DeploymentsFromContracts(contracts *addresses.L1Contracts) *L1Deplo OptimismMintableERC20Factory: contracts.OptimismMintableErc20FactoryImpl, OptimismMintableERC20FactoryProxy: contracts.OptimismMintableErc20FactoryProxy, OptimismPortal: contracts.OptimismPortalImpl, + OptimismPortalInterop: contracts.OptimismPortalInteropImpl, OptimismPortalProxy: contracts.OptimismPortalProxy, ETHLockbox: contracts.EthLockboxImpl, ETHLockboxProxy: contracts.EthLockboxProxy, diff --git a/op-chain-ops/genesis/genesis.go b/op-chain-ops/genesis/genesis.go index fa55eda6cf2..8b23ede228d 100644 --- a/op-chain-ops/genesis/genesis.go +++ b/op-chain-ops/genesis/genesis.go @@ -22,6 +22,9 @@ const defaultGasLimit = 30_000_000 // HoloceneExtraData represents the default extra data for Holocene-genesis chains. var HoloceneExtraData = eip1559.EncodeHoloceneExtraData(250, 6) +// JovianExtraData represents the default extra data for Jovian-genesis chains. +var JovianExtraData = eip1559.EncodeJovianExtraData(250, 6, 0) + // NewL2Genesis will create a new L2 genesis func NewL2Genesis(config *DeployConfig, l1StartHeader *eth.BlockRef) (*core.Genesis, error) { if config.L2ChainID == 0 { @@ -120,6 +123,9 @@ func NewL2Genesis(config *DeployConfig, l1StartHeader *eth.BlockRef) (*core.Gene if optimismChainConfig.IsIsthmus(genesis.Timestamp) { genesis.Alloc[params.HistoryStorageAddress] = types.Account{Nonce: 1, Code: params.HistoryStorageCode, Balance: common.Big0} } + if optimismChainConfig.IsJovian(genesis.Timestamp) { + genesis.ExtraData = JovianExtraData + } return genesis, nil } diff --git a/op-chain-ops/interopgen/deploy.go b/op-chain-ops/interopgen/deploy.go index b5c1aab4068..b0e34eae3e2 100644 --- a/op-chain-ops/interopgen/deploy.go +++ b/op-chain-ops/interopgen/deploy.go @@ -27,6 +27,10 @@ var ( // sysGenesisDeployer is used as tx.origin/msg.sender on system genesis script calls. // At the end we verify none of the deployed contracts persist (there may be temporary ones, to insert bytecode). sysGenesisDeployer = common.Address(crypto.Keccak256([]byte("System genesis deployer"))[12:]) + + // OptimismPortalInteropDevFlag is the feature bitmap that enables the OptimismPortalInterop contract. + OptimismPortalInteropDevFlag = common.Hash{31: 0x01} // 0x0000000000000000000000000000000000000000000000000000000000000001 + ) func Deploy(logger log.Logger, fa *foundry.ArtifactsFS, srcFS *foundry.SourceMapFS, cfg *WorldConfig) (*WorldDeployment, *WorldOutput, error) { @@ -153,7 +157,7 @@ func CreateL2(logger log.Logger, fa *foundry.ArtifactsFS, srcFS *foundry.SourceM } l2Host := script.NewHost(logger.New("role", "l2", "chain", l2Cfg.L2ChainID), fa, srcFS, l2Context) l2Host.SetEnvVar("OUTPUT_MODE", "none") // we don't use the cheatcode, but capture the state outside of EVM execution - l2Host.SetEnvVar("FORK", "holocene") // latest fork + l2Host.SetEnvVar("FORK", "jovian") // latest fork return l2Host } @@ -191,6 +195,7 @@ func DeploySuperchainToL1(l1Host *script.Host, opcmScripts *opcm.Scripts, superC ProofMaturityDelaySeconds: superCfg.Implementations.FaultProof.ProofMaturityDelaySeconds, DisputeGameFinalityDelaySeconds: superCfg.Implementations.FaultProof.DisputeGameFinalityDelaySeconds, MipsVersion: superCfg.Implementations.FaultProof.MipsVersion, + DevFeatureBitmap: OptimismPortalInteropDevFlag, SuperchainProxyAdmin: superDeployment.SuperchainProxyAdmin, SuperchainConfigProxy: superDeployment.SuperchainConfigProxy, ProtocolVersionsProxy: superDeployment.ProtocolVersionsProxy, diff --git a/op-chain-ops/interopgen/deployments.go b/op-chain-ops/interopgen/deployments.go index d9de49646b8..2cf5a9ce462 100644 --- a/op-chain-ops/interopgen/deployments.go +++ b/op-chain-ops/interopgen/deployments.go @@ -18,6 +18,7 @@ type Implementations struct { OpcmStandardValidator common.Address `json:"OPCMStandardValidator"` DelayedWETHImpl common.Address `json:"DelayedWETHImpl"` OptimismPortalImpl common.Address `json:"OptimismPortalImpl"` + OptimismPortalInteropImpl common.Address `json:"OptimismPortalInteropImpl"` ETHLockboxImpl common.Address `json:"ETHLockboxImpl"` PreimageOracleSingleton common.Address `json:"PreimageOracleSingleton"` MipsSingleton common.Address `json:"MipsSingleton"` diff --git a/op-chain-ops/script/forking/db.go b/op-chain-ops/script/forking/db.go index a2edf36b28f..d210e5c5256 100644 --- a/op-chain-ops/script/forking/db.go +++ b/op-chain-ops/script/forking/db.go @@ -108,12 +108,7 @@ func (f *ForkDB) TrieDB() *triedb.Database { Preimages: false, IsVerkle: false, HashDB: nil, - PathDB: &pathdb.Config{ - StateHistory: 0, - CleanCacheSize: 0, - WriteBufferSize: 0, - ReadOnly: true, - }, + PathDB: pathdb.ReadOnly, }) return tdb } diff --git a/op-chain-ops/script/forking/state.go b/op-chain-ops/script/forking/state.go index e200e8903ef..9c49d81c2bb 100644 --- a/op-chain-ops/script/forking/state.go +++ b/op-chain-ops/script/forking/state.go @@ -298,8 +298,8 @@ func (fst *ForkableState) GetRefund() uint64 { return fst.selected.GetRefund() } -func (fst *ForkableState) GetCommittedState(address common.Address, hash common.Hash) common.Hash { - return fst.stateFor(address).GetCommittedState(address, hash) +func (fst *ForkableState) GetStateAndCommittedState(address common.Address, hash common.Hash) (common.Hash, common.Hash) { + return fst.stateFor(address).GetStateAndCommittedState(address, hash) } func (fst *ForkableState) GetState(address common.Address, k common.Hash) common.Hash { diff --git a/op-chain-ops/script/precompile.go b/op-chain-ops/script/precompile.go index ee92950f4a0..a75804de329 100644 --- a/op-chain-ops/script/precompile.go +++ b/op-chain-ops/script/precompile.go @@ -188,7 +188,7 @@ func hasTrailingError(argCount int, getType func(i int) reflect.Type) bool { return false } lastTyp := getType(argCount - 1) - return lastTyp.Kind() == reflect.Interface && lastTyp.Implements(typeFor[error]()) + return lastTyp.Kind() == reflect.Interface && lastTyp.Implements(reflect.TypeFor[error]()) } // setupMethod takes a method definition, attached to selfVal, @@ -356,9 +356,9 @@ func goTypeToABIType(typ reflect.Type) (abi.Type, error) { // since big.Int interpretation defaults to uint256. type ABIInt256 big.Int -var abiInt256Type = typeFor[ABIInt256]() +var abiInt256Type = reflect.TypeFor[ABIInt256]() -var abiUint256Type = typeFor[uint256.Int]() +var abiUint256Type = reflect.TypeFor[uint256.Int]() // goTypeToSolidityType converts a Go type to the solidity ABI type definition. // The "internalType" is a quirk of the Geth ABI utils, for nested structures. @@ -408,7 +408,7 @@ func goTypeToSolidityType(typ reflect.Type) (typeDef, internalType string, err e if typ.AssignableTo(abiInt256Type) { return "int256", "", nil } - if typ.ConvertibleTo(typeFor[big.Int]()) { + if typ.ConvertibleTo(reflect.TypeFor[big.Int]()) { return "uint256", "", nil } // We can parse into abi.TupleTy in the future, if necessary @@ -643,9 +643,3 @@ func encodeRevert(outErr error) ([]byte, error) { out = append(out, rightPad32(outErrStr)...) // the error message string return out, vm.ErrExecutionReverted // Geth EVM will pick this up as a revert with return-data } - -// typeFor returns the [Type] that represents the type argument T. -// Note: not available yet in Go 1.21, but part of std-lib later. -func typeFor[T any]() reflect.Type { - return reflect.TypeOf((*T)(nil)).Elem() -} diff --git a/op-challenger/README.md b/op-challenger/README.md index 310880e40f7..84d7b53ccda 100644 --- a/op-challenger/README.md +++ b/op-challenger/README.md @@ -22,11 +22,10 @@ accessed by running `./op-challenger --help`. ### Running with Cannon on Local Devnet To run `op-challenger` against the local devnet, first clean and run -the devnet from the root of the repository. +the devnet. From the root of the repository run: ```shell -make devnet-clean -make devnet-up +cd kurtosis-devnet && just simple-devnet ``` Then build the `op-challenger` with `make op-challenger`. @@ -57,6 +56,22 @@ The challenger will monitor dispute games and respond to any invalid claims by posting the correct trace as the counter-claim. The commands below can then be used to create and interact with games. +#### Devnet Management Commands + +```shell +# Check status +kurtosis enclave ls +kurtosis enclave inspect simple-devnet + +# View logs from specific services +kurtosis service logs simple-devnet op-challenger-challenger-2151908 # Adjust names as needed +kurtosis service logs simple-devnet op-node-2151908-node0 # Adjust names as needed + +# Stop and clean up when done +kurtosis enclave stop simple-devnet +kurtosis enclave rm simple-devnet +``` + ## Subcommands The `op-challenger` has a few subcommands to interact with on-chain diff --git a/op-challenger/cmd/main_test.go b/op-challenger/cmd/main_test.go index c06c9409013..aa3b7ef3a20 100644 --- a/op-challenger/cmd/main_test.go +++ b/op-challenger/cmd/main_test.go @@ -30,6 +30,8 @@ var ( cannonBin = "./bin/cannon" cannonServer = "./bin/op-program" cannonPreState = "./pre.json" + cannonKonaServer = "./bin/kona-host" + cannonKonaPreState = "./cannon-kona-pre.json" datadir = "./test_data" rollupRpc = "http://example.com:8555" asteriscBin = "./bin/asterisc" @@ -139,7 +141,7 @@ func TestOpSupervisor(t *testing.T) { func TestTraceType(t *testing.T) { t.Run("Default", func(t *testing.T) { - expectedDefault := []types.TraceType{types.TraceTypeCannon, types.TraceTypeAsteriscKona} + expectedDefault := []types.TraceType{types.TraceTypeCannon, types.TraceTypeAsteriscKona, types.TraceTypeCannonKona} cfg := configForArgs(t, addRequiredArgsForMultipleTracesExcept(expectedDefault, "--trace-type")) require.Equal(t, expectedDefault, cfg.TraceTypes) }) @@ -328,6 +330,25 @@ func TestPollInterval(t *testing.T) { }) } +func TestMinUpdateInterval(t *testing.T) { + t.Run("DefaultsToZero", func(t *testing.T) { + cfg := configForArgs(t, addRequiredArgs(types.TraceTypeCannon)) + require.Equal(t, time.Duration(0), cfg.MinUpdateInterval) + }) + + t.Run("Valid", func(t *testing.T) { + cfg := configForArgs(t, addRequiredArgs(types.TraceTypeAlphabet, "--min-update-interval", "10m")) + require.Equal(t, 10*time.Minute, cfg.MinUpdateInterval) + }) + + t.Run("Invalid", func(t *testing.T) { + verifyArgsInvalid( + t, + "invalid value \"abc\" for flag -min-update-interval", + addRequiredArgs(types.TraceTypeAlphabet, "--min-update-interval", "abc")) + }) +} + func TestAsteriscOpProgramRequiredArgs(t *testing.T) { traceType := types.TraceTypeAsterisc t.Run(fmt.Sprintf("TestAsteriscServer-%v", traceType), func(t *testing.T) { @@ -1287,6 +1308,8 @@ func requiredArgs(traceType types.TraceType) map[string]string { switch traceType { case types.TraceTypeCannon, types.TraceTypePermissioned: addRequiredCannonArgs(args) + case types.TraceTypeCannonKona: + addRequiredCannonKonaArgs(args) case types.TraceTypeAsterisc: addRequiredAsteriscArgs(args) case types.TraceTypeAsteriscKona: @@ -1311,6 +1334,11 @@ func addRequiredCannonArgs(args map[string]string) { addRequiredOutputRootArgs(args) } +func addRequiredCannonKonaArgs(args map[string]string) { + addRequiredCannonKonaBaseArgs(args) + addRequiredOutputRootArgs(args) +} + func addRequiredOutputRootArgs(args map[string]string) { args["--rollup-rpc"] = rollupRpc } @@ -1322,6 +1350,13 @@ func addRequiredCannonBaseArgs(args map[string]string) { args["--cannon-prestate"] = cannonPreState } +func addRequiredCannonKonaBaseArgs(args map[string]string) { + args["--network"] = network + args["--cannon-bin"] = cannonBin + args["--cannon-kona-server"] = cannonKonaServer + args["--cannon-kona-prestate"] = cannonKonaPreState +} + func addRequiredAsteriscArgs(args map[string]string) { addRequiredOutputRootArgs(args) args["--network"] = network diff --git a/op-challenger/config/config.go b/op-challenger/config/config.go index eb55ca2c978..874acdcd145 100644 --- a/op-challenger/config/config.go +++ b/op-challenger/config/config.go @@ -17,17 +17,20 @@ import ( ) var ( - ErrMissingTraceType = errors.New("no supported trace types specified") - ErrMissingDatadir = errors.New("missing datadir") - ErrMaxConcurrencyZero = errors.New("max concurrency must not be 0") - ErrMissingL2Rpc = errors.New("missing L2 rpc url") - ErrMissingCannonAbsolutePreState = errors.New("missing cannon absolute pre-state") - ErrMissingL1EthRPC = errors.New("missing l1 eth rpc url") - ErrMissingL1Beacon = errors.New("missing l1 beacon url") - ErrMissingGameFactoryAddress = errors.New("missing game factory address") - ErrMissingCannonSnapshotFreq = errors.New("missing cannon snapshot freq") - ErrMissingCannonInfoFreq = errors.New("missing cannon info freq") - ErrMissingDepsetConfig = errors.New("missing network or depset config path") + ErrMissingTraceType = errors.New("no supported trace types specified") + ErrMissingDatadir = errors.New("missing datadir") + ErrMaxConcurrencyZero = errors.New("max concurrency must not be 0") + ErrMissingL2Rpc = errors.New("missing L2 rpc url") + ErrMissingCannonAbsolutePreState = errors.New("missing cannon absolute pre-state") + ErrMissingL1EthRPC = errors.New("missing l1 eth rpc url") + ErrMissingL1Beacon = errors.New("missing l1 beacon url") + ErrMissingGameFactoryAddress = errors.New("missing game factory address") + ErrMissingCannonSnapshotFreq = errors.New("missing cannon snapshot freq") + ErrMissingCannonInfoFreq = errors.New("missing cannon info freq") + ErrMissingCannonKonaAbsolutePreState = errors.New("missing cannon kona absolute pre-state") + ErrMissingCannonKonaSnapshotFreq = errors.New("missing cannon kona snapshot freq") + ErrMissingCannonKonaInfoFreq = errors.New("missing cannon kona info freq") + ErrMissingDepsetConfig = errors.New("missing network or depset config path") ErrMissingRollupRpc = errors.New("missing rollup rpc url") ErrMissingSupervisorRpc = errors.New("missing supervisor rpc url") @@ -52,8 +55,10 @@ const ( // The default value is 28 days. The worst case duration for a game is 16 days // (due to clock extension), plus 7 days WETH withdrawal delay leaving a 5 day // buffer to monitor games to ensure bonds are claimed. - DefaultGameWindow = 28 * 24 * time.Hour - DefaultMaxPendingTx = 10 + DefaultGameWindow = 28 * 24 * time.Hour + DefaultMaxPendingTx = 10 + DefaultResponseDelay = 0 // No delay by default + DefaultResponseDelayAfter = 0 // Apply delay from first response by default ) // Config is a well typed config that is parsed from the CLI params. @@ -69,6 +74,7 @@ type Config struct { MaxConcurrency uint // Maximum number of threads to use when progressing games PollInterval time.Duration // Polling interval for latest-block subscription when using an HTTP RPC provider AllowInvalidPrestate bool // Whether to allow responding to games where the prestate does not match + MinUpdateInterval time.Duration // Minimum duration the L1 head block time must advance before scheduling a new update cycle AdditionalBondClaimants []common.Address // List of addresses to claim bonds for in addition to the tx manager sender @@ -81,9 +87,12 @@ type Config struct { L2Rpcs []string // L2 RPC Url // Specific to the cannon trace provider - Cannon vm.Config - CannonAbsolutePreState string // File to load the absolute pre-state for Cannon traces from - CannonAbsolutePreStateBaseURL *url.URL // Base URL to retrieve absolute pre-states for Cannon traces from + Cannon vm.Config + CannonAbsolutePreState string // File to load the absolute pre-state for Cannon traces from + CannonAbsolutePreStateBaseURL *url.URL // Base URL to retrieve absolute pre-states for Cannon traces from + CannonKona vm.Config + CannonKonaAbsolutePreState string // File to load the absolute pre-state for CannonKona traces from + CannonKonaAbsolutePreStateBaseURL *url.URL // Base URL to retrieve absolute pre-states for CannonKona traces from // Specific to the asterisc trace provider Asterisc vm.Config @@ -98,6 +107,19 @@ type Config struct { TxMgrConfig txmgr.CLIConfig MetricsConfig opmetrics.CLIConfig PprofConfig oppprof.CLIConfig + + ResponseDelay time.Duration /* Delay before responding to each game action to slow down game progression. + Note: set with caution, since the challenger can end up using more resources if it has to wait to respond + to an attacker generating many claims. Consider using the additional ResponseDelayAfter config option. + Also note that the delay is only applied when: + 1) delaying will not lead to a timeout of the game, + 2) the challenger is not in a clock extension period and + 3) delaying will not lead to the challenger having to respond inside of a clock extension period + (thus ensuring that the challenger always has enough remaining time to respond to the game action). */ + ResponseDelayAfter uint64 /* Number of responses after which to start applying the delay. + Set to 0 to apply delay from the first response, 1 to skip the first response, etc. + Note: the delay is only applied from the next round after which this `responseDelayAfter` value + is surpassed (not from the exact response after which its surpassed, but from the next round). */ } func NewInteropConfig( @@ -138,6 +160,16 @@ func NewInteropConfig( DebugInfo: true, BinarySnapshots: true, }, + CannonKona: vm.Config{ + VmType: types.TraceTypeCannonKona, + L1: l1EthRpc, + L1Beacon: l1BeaconApi, + L2s: l2Rpcs, + SnapshotFreq: DefaultCannonSnapshotFreq, + InfoFreq: DefaultCannonInfoFreq, + DebugInfo: true, + BinarySnapshots: true, + }, Asterisc: vm.Config{ VmType: types.TraceTypeAsterisc, L1: l1EthRpc, @@ -198,6 +230,16 @@ func NewConfig( DebugInfo: true, BinarySnapshots: true, }, + CannonKona: vm.Config{ + VmType: types.TraceTypeCannonKona, + L1: l1EthRpc, + L1Beacon: l1BeaconApi, + L2s: []string{l2EthRpc}, + SnapshotFreq: DefaultCannonSnapshotFreq, + InfoFreq: DefaultCannonInfoFreq, + DebugInfo: true, + BinarySnapshots: true, + }, Asterisc: vm.Config{ VmType: types.TraceTypeAsterisc, L1: l1EthRpc, @@ -266,6 +308,14 @@ func (c Config) Check() error { return err } } + if c.TraceTypeEnabled(types.TraceTypeCannonKona) { + if c.RollupRpc == "" { + return ErrMissingRollupRpc + } + if err := c.validateBaseCannonKonaOptions(); err != nil { + return err + } + } if c.TraceTypeEnabled(types.TraceTypeAsterisc) { if c.RollupRpc == "" { return ErrMissingRollupRpc @@ -336,6 +386,22 @@ func (c Config) validateBaseCannonOptions() error { return nil } +func (c Config) validateBaseCannonKonaOptions() error { + if err := c.CannonKona.Check(); err != nil { + return fmt.Errorf("cannon kona: %w", err) + } + if c.CannonKonaAbsolutePreState == "" && c.CannonKonaAbsolutePreStateBaseURL == nil { + return ErrMissingCannonKonaAbsolutePreState + } + if c.CannonKona.SnapshotFreq == 0 { + return ErrMissingCannonKonaSnapshotFreq + } + if c.CannonKona.InfoFreq == 0 { + return ErrMissingCannonKonaInfoFreq + } + return nil +} + func (c Config) validateBaseAsteriscKonaOptions() error { if err := c.AsteriscKona.Check(); err != nil { return fmt.Errorf("asterisc kona: %w", err) diff --git a/op-challenger/config/config_test.go b/op-challenger/config/config_test.go index 7602063b2d6..753c01e0691 100644 --- a/op-challenger/config/config_test.go +++ b/op-challenger/config/config_test.go @@ -42,6 +42,11 @@ var ( validAsteriscKonaNetwork = "mainnet" validAsteriscKonaAbsolutePreState = "pre.json" validAsteriscKonaAbsolutePreStateBaseURL, _ = url.Parse("http://localhost/bar/") + + validCannonKonaBin = "./bin/cannon" + validCannonKonaServerBin = "./bin/kona-host" + validCannonKonaNetwork = "mainnet" + validCannonKonaAbsolutePreStateBaseURL, _ = url.Parse("http://localhost/bar/") ) var singleCannonTraceTypes = []types.TraceType{types.TraceTypeCannon, types.TraceTypePermissioned} @@ -119,6 +124,20 @@ func applyValidConfigForAsteriscKona(t *testing.T, cfg *Config) { cfg.AsteriscKona.Networks = []string{validAsteriscKonaNetwork} } +func applyValidConfigForCannonKona(t *testing.T, cfg *Config) { + tmpDir := t.TempDir() + vmBin := filepath.Join(tmpDir, validCannonKonaBin) + server := filepath.Join(tmpDir, validCannonKonaServerBin) + err := ensureExists(vmBin) + require.NoError(t, err) + err = ensureExists(server) + require.NoError(t, err) + cfg.CannonKona.VmBin = vmBin + cfg.CannonKona.Server = server + cfg.CannonKonaAbsolutePreStateBaseURL = validCannonKonaAbsolutePreStateBaseURL + cfg.CannonKona.Networks = []string{validCannonKonaNetwork} +} + func applyValidConfigForSuperAsteriscKona(t *testing.T, cfg *Config) { cfg.SupervisorRPC = validSupervisorRpc applyValidConfigForAsteriscKona(t, cfg) @@ -132,6 +151,9 @@ func validConfig(t *testing.T, traceType types.TraceType) Config { if traceType == types.TraceTypeCannon || traceType == types.TraceTypePermissioned { applyValidConfigForCannon(t, &cfg) } + if traceType == types.TraceTypeCannonKona { + applyValidConfigForCannonKona(t, &cfg) + } if traceType == types.TraceTypeAsterisc { applyValidConfigForAsterisc(t, &cfg) } diff --git a/op-challenger/flags/flags.go b/op-challenger/flags/flags.go index 235589c2332..c9b7cc8729e 100644 --- a/op-challenger/flags/flags.go +++ b/op-challenger/flags/flags.go @@ -32,7 +32,7 @@ func prefixEnvVars(name string) []string { } var ( - faultDisputeVMs = []types.TraceType{types.TraceTypeCannon, types.TraceTypeAsterisc, types.TraceTypeAsteriscKona, types.TraceTypeSuperCannon, types.TraceTypeSuperAsteriscKona} + faultDisputeVMs = []types.TraceType{types.TraceTypeCannon, types.TraceTypeCannonKona, types.TraceTypeAsterisc, types.TraceTypeAsteriscKona, types.TraceTypeSuperCannon, types.TraceTypeSuperAsteriscKona} // Required Flags L1EthRpcFlag = &cli.StringFlag{ Name: "l1-eth-rpc", @@ -74,7 +74,7 @@ var ( Name: "trace-type", Usage: "The trace types to support. Valid options: " + openum.EnumString(types.TraceTypes), EnvVars: prefixEnvVars("TRACE_TYPE"), - Value: cli.NewStringSlice(types.TraceTypeCannon.String(), types.TraceTypeAsteriscKona.String()), + Value: cli.NewStringSlice(types.TraceTypeCannon.String(), types.TraceTypeAsteriscKona.String(), types.TraceTypeCannonKona.String()), } DatadirFlag = &cli.StringFlag{ Name: "datadir", @@ -110,6 +110,11 @@ var ( EnvVars: prefixEnvVars("HTTP_POLL_INTERVAL"), Value: config.DefaultPollInterval, } + MinUpdateInterval = &cli.DurationFlag{ + Name: "min-update-interval", + Usage: "Minimum time between scheduling update cycles based on the L1 block time.", + EnvVars: prefixEnvVars("MIN_UPDATE_INTERVAL"), + } AdditionalBondClaimants = &cli.StringSliceFlag{ Name: "additional-bond-claimants", Usage: "List of addresses to claim bonds for, in addition to the configured transaction sender", @@ -180,6 +185,24 @@ var ( EnvVars: prefixEnvVars("CANNON_INFO_FREQ"), Value: config.DefaultCannonInfoFreq, } + CannonKonaServerFlag = &cli.StringFlag{ + Name: "cannon-kona-server", + Usage: "Path to kona executable to use as pre-image oracle server when generating trace data (cannon-kona trace type only)", + EnvVars: prefixEnvVars("CANNON_KONA_SERVER"), + } + CannonKonaPreStateFlag = &cli.StringFlag{ + Name: "cannon-kona-prestate", + Usage: "Path to absolute prestate to use when generating trace data (cannon-kona trace type only)", + EnvVars: prefixEnvVars("CANNON_KONA_PRESTATE"), + } + CannonKonaL2CustomFlag = &cli.BoolFlag{ + Name: "cannon-kona-l2-custom", + Usage: "Notify the kona-host that the L2 chain uses custom config to be loaded via the preimage oracle. " + + "WARNING: This is incompatible with on-chain testing and must only be used for testing purposes.", + EnvVars: prefixEnvVars("CANNON_KONA_L2_CUSTOM"), + Value: false, + Hidden: true, + } AsteriscBinFlag = &cli.StringFlag{ Name: "asterisc-bin", Usage: "Path to asterisc executable to use when generating trace data (asterisc trace type only)", @@ -243,6 +266,18 @@ var ( EnvVars: prefixEnvVars("UNSAFE_ALLOW_INVALID_PRESTATE"), Hidden: true, // Hidden as this is an unsafe flag added only for testing purposes } + ResponseDelayFlag = &cli.DurationFlag{ + Name: "response-delay", + Usage: "Delay before responding to game actions to slow down game progression.", + EnvVars: prefixEnvVars("RESPONSE_DELAY"), + Value: config.DefaultResponseDelay, + } + ResponseDelayAfterFlag = &cli.Uint64Flag{ + Name: "response-delay-after", + Usage: "Number of responses after which to start applying the delay (0 = from first response).", + EnvVars: prefixEnvVars("RESPONSE_DELAY_AFTER"), + Value: config.DefaultResponseDelayAfter, + } ) // requiredFlags are checked by [CheckRequired] @@ -264,6 +299,7 @@ var optionalFlags = []cli.Flag{ L2ExperimentalEthRpcFlag, MaxPendingTransactionsFlag, HTTPPollInterval, + MinUpdateInterval, AdditionalBondClaimants, GameAllowlistFlag, CannonL2CustomFlag, @@ -272,6 +308,9 @@ var optionalFlags = []cli.Flag{ CannonPreStateFlag, CannonSnapshotFreqFlag, CannonInfoFreqFlag, + CannonKonaServerFlag, + CannonKonaPreStateFlag, + CannonKonaL2CustomFlag, AsteriscBinFlag, AsteriscServerFlag, AsteriscKonaL2CustomFlag, @@ -283,6 +322,8 @@ var optionalFlags = []cli.Flag{ GameWindowFlag, SelectiveClaimResolutionFlag, UnsafeAllowInvalidPrestate, + ResponseDelayFlag, + ResponseDelayAfterFlag, } func init() { @@ -363,6 +404,39 @@ func CheckCannonFlags(ctx *cli.Context) error { return nil } +func CheckCannonKonaBaseFlags(ctx *cli.Context, traceType types.TraceType) error { + if !ctx.IsSet(flags.NetworkFlagName) && + !(RollupConfigFlag.IsSet(ctx, traceType) && L2GenesisFlag.IsSet(ctx, traceType)) { + return fmt.Errorf("flag %v or %v and %v is required", + flags.NetworkFlagName, RollupConfigFlag.EitherFlagName(traceType), L2GenesisFlag.EitherFlagName(traceType)) + } + if ctx.IsSet(flags.NetworkFlagName) && + (RollupConfigFlag.IsSet(ctx, types.TraceTypeCannonKona) || L2GenesisFlag.IsSet(ctx, types.TraceTypeCannonKona) || ctx.Bool(CannonKonaL2CustomFlag.Name)) { + return fmt.Errorf("flag %v can not be used with %v, %v or %v", + flags.NetworkFlagName, RollupConfigFlag.SourceFlagName(ctx, types.TraceTypeCannonKona), L2GenesisFlag.SourceFlagName(ctx, types.TraceTypeCannonKona), CannonKonaL2CustomFlag.Name) + } + if !ctx.IsSet(CannonBinFlag.Name) { + return fmt.Errorf("flag %s is required", CannonBinFlag.Name) + } + return nil +} + +func CheckCannonKonaFlags(ctx *cli.Context) error { + if err := checkOutputProviderFlags(ctx); err != nil { + return err + } + if err := CheckCannonKonaBaseFlags(ctx, types.TraceTypeCannonKona); err != nil { + return err + } + if !ctx.IsSet(CannonKonaServerFlag.Name) { + return fmt.Errorf("flag %s is required", CannonKonaServerFlag.Name) + } + if !PreStatesURLFlag.IsSet(ctx, types.TraceTypeCannonKona) && !ctx.IsSet(CannonKonaPreStateFlag.Name) { + return fmt.Errorf("flag %s or %s is required", PreStatesURLFlag.EitherFlagName(types.TraceTypeCannonKona), CannonKonaPreStateFlag.Name) + } + return nil +} + func CheckAsteriscBaseFlags(ctx *cli.Context, traceType types.TraceType) error { if !ctx.IsSet(flags.NetworkFlagName) && !(RollupConfigFlag.IsSet(ctx, traceType) && L2GenesisFlag.IsSet(ctx, traceType)) { @@ -451,6 +525,10 @@ func CheckRequired(ctx *cli.Context, traceTypes []types.TraceType) error { if err := CheckCannonFlags(ctx); err != nil { return err } + case types.TraceTypeCannonKona: + if err := CheckCannonKonaFlags(ctx); err != nil { + return err + } case types.TraceTypeAsterisc: if err := CheckAsteriscFlags(ctx); err != nil { return err @@ -596,6 +674,10 @@ func NewConfigFromCLI(ctx *cli.Context, logger log.Logger) (*config.Config, erro if err != nil { return nil, err } + cannonKonaPreStatesURL, err := getPrestatesUrl(types.TraceTypeCannonKona) + if err != nil { + return nil, err + } asteriscPreStatesURL, err := getPrestatesUrl(types.TraceTypeAsterisc) if err != nil { return nil, err @@ -621,6 +703,7 @@ func NewConfigFromCLI(ctx *cli.Context, logger log.Logger) (*config.Config, erro L2Rpcs: l2Rpcs, MaxPendingTx: ctx.Uint64(MaxPendingTransactionsFlag.Name), PollInterval: ctx.Duration(HTTPPollInterval.Name), + MinUpdateInterval: ctx.Duration(MinUpdateInterval.Name), AdditionalBondClaimants: claimants, RollupRpc: ctx.String(RollupRpcFlag.Name), SupervisorRPC: ctx.String(SupervisorRpcFlag.Name), @@ -644,7 +727,27 @@ func NewConfigFromCLI(ctx *cli.Context, logger log.Logger) (*config.Config, erro }, CannonAbsolutePreState: ctx.String(CannonPreStateFlag.Name), CannonAbsolutePreStateBaseURL: cannonPreStatesURL, - Datadir: ctx.String(DatadirFlag.Name), + CannonKona: vm.Config{ + VmType: types.TraceTypeCannonKona, + L1: l1EthRpc, + L1Beacon: l1Beacon, + L2s: l2Rpcs, + L2Experimental: l2Experimental, + VmBin: ctx.String(CannonBinFlag.Name), + Server: ctx.String(CannonKonaServerFlag.Name), + Networks: networks, + L2Custom: ctx.Bool(CannonKonaL2CustomFlag.Name), + RollupConfigPaths: RollupConfigFlag.StringSlice(ctx, types.TraceTypeCannonKona), + L2GenesisPaths: L2GenesisFlag.StringSlice(ctx, types.TraceTypeCannonKona), + DepsetConfigPath: DepsetConfigFlag.String(ctx, types.TraceTypeCannonKona), + SnapshotFreq: ctx.Uint(CannonSnapshotFreqFlag.Name), + InfoFreq: ctx.Uint(CannonInfoFreqFlag.Name), + DebugInfo: true, + BinarySnapshots: true, + }, + CannonKonaAbsolutePreState: ctx.String(CannonKonaPreStateFlag.Name), + CannonKonaAbsolutePreStateBaseURL: cannonKonaPreStatesURL, + Datadir: ctx.String(DatadirFlag.Name), Asterisc: vm.Config{ VmType: types.TraceTypeAsterisc, L1: l1EthRpc, @@ -687,5 +790,7 @@ func NewConfigFromCLI(ctx *cli.Context, logger log.Logger) (*config.Config, erro PprofConfig: pprofConfig, SelectiveClaimResolution: ctx.Bool(SelectiveClaimResolutionFlag.Name), AllowInvalidPrestate: ctx.Bool(UnsafeAllowInvalidPrestate.Name), + ResponseDelay: ctx.Duration(ResponseDelayFlag.Name), + ResponseDelayAfter: ctx.Uint64(ResponseDelayAfterFlag.Name), }, nil } diff --git a/op-challenger/flags/flags_test.go b/op-challenger/flags/flags_test.go index 7d64f787974..ca6ae847b7c 100644 --- a/op-challenger/flags/flags_test.go +++ b/op-challenger/flags/flags_test.go @@ -5,7 +5,9 @@ import ( "slices" "strings" "testing" + "time" + "github.com/ethereum-optimism/optimism/op-challenger/config" opservice "github.com/ethereum-optimism/optimism/op-service" "github.com/ethereum-optimism/optimism/op-service/txmgr" "github.com/ethereum/go-ethereum/common" @@ -93,6 +95,38 @@ func TestEnvVarFormat(t *testing.T) { } } +func TestResponseDelayFlag(t *testing.T) { + t.Run("IncludedInOptionalFlags", func(t *testing.T) { + require.Contains(t, optionalFlags, ResponseDelayFlag, "ResponseDelayFlag should be in optionalFlags") + }) + + t.Run("HasCorrectEnvVar", func(t *testing.T) { + envVars := ResponseDelayFlag.GetEnvVars() + require.Len(t, envVars, 1, "ResponseDelayFlag should have exactly one env var") + require.Equal(t, "OP_CHALLENGER_RESPONSE_DELAY", envVars[0], "ResponseDelayFlag should have correct env var") + }) + + t.Run("DefaultValue", func(t *testing.T) { + require.Equal(t, time.Duration(config.DefaultResponseDelay), ResponseDelayFlag.Value, "ResponseDelayFlag should have correct default value") + }) +} + +func TestResponseDelayAfterFlag(t *testing.T) { + t.Run("IncludedInOptionalFlags", func(t *testing.T) { + require.Contains(t, optionalFlags, ResponseDelayAfterFlag, "ResponseDelayAfterFlag should be in optionalFlags") + }) + + t.Run("HasCorrectEnvVar", func(t *testing.T) { + envVars := ResponseDelayAfterFlag.GetEnvVars() + require.Len(t, envVars, 1, "ResponseDelayAfterFlag should have exactly one env var") + require.Equal(t, "OP_CHALLENGER_RESPONSE_DELAY_AFTER", envVars[0], "ResponseDelayAfterFlag should have correct env var") + }) + + t.Run("DefaultValue", func(t *testing.T) { + require.Equal(t, uint64(config.DefaultResponseDelayAfter), ResponseDelayAfterFlag.Value, "ResponseDelayAfterFlag should have correct default value") + }) +} + func TestMultipleNetworksMustShareDisputeGameFactory(t *testing.T) { addrs := map[string]superchain.AddressesConfig{ "a1": {DisputeGameFactoryProxy: &common.Address{0xAA}}, diff --git a/op-challenger/game/fault/agent.go b/op-challenger/game/fault/agent.go index 10b28426f4b..c76331ce667 100644 --- a/op-challenger/game/fault/agent.go +++ b/op-challenger/game/fault/agent.go @@ -6,8 +6,10 @@ import ( "fmt" "slices" "sync" + "sync/atomic" "time" + "github.com/ethereum-optimism/optimism/op-challenger/game/fault/contracts" "github.com/ethereum-optimism/optimism/op-challenger/game/fault/solver" "github.com/ethereum-optimism/optimism/op-challenger/game/fault/types" gameTypes "github.com/ethereum-optimism/optimism/op-challenger/game/types" @@ -31,20 +33,27 @@ type Responder interface { type ClaimLoader interface { GetAllClaims(ctx context.Context, block rpcblock.Block) ([]types.Claim, error) IsL2BlockNumberChallenged(ctx context.Context, block rpcblock.Block) (bool, error) + GetClockExtension(ctx context.Context) (time.Duration, error) + GetSplitDepth(ctx context.Context) (types.Depth, error) + GetMaxGameDepth(ctx context.Context) (types.Depth, error) + GetOracle(ctx context.Context) (contracts.PreimageOracleContract, error) } type Agent struct { - metrics metrics.Metricer - systemClock clock.Clock - l1Clock types.ClockReader - solver *solver.GameSolver - loader ClaimLoader - responder Responder - selective bool - claimants []common.Address - maxDepth types.Depth - maxClockDuration time.Duration - log log.Logger + metrics metrics.Metricer + systemClock clock.Clock + l1Clock types.ClockReader + solver *solver.GameSolver + loader ClaimLoader + responder Responder + selective bool + claimants []common.Address + maxDepth types.Depth + maxClockDuration time.Duration + log log.Logger + responseDelay time.Duration + responseDelayAfter uint64 + responseCount atomic.Uint64 // Number of responses made in this game } func NewAgent( @@ -59,19 +68,24 @@ func NewAgent( log log.Logger, selective bool, claimants []common.Address, + responseDelay time.Duration, + responseDelayAfter uint64, ) *Agent { return &Agent{ - metrics: m, - systemClock: systemClock, - l1Clock: l1Clock, - solver: solver.NewGameSolver(maxDepth, trace), - loader: loader, - responder: responder, - selective: selective, - claimants: claimants, - maxDepth: maxDepth, - maxClockDuration: maxClockDuration, - log: log, + metrics: m, + systemClock: systemClock, + l1Clock: l1Clock, + solver: solver.NewGameSolver(maxDepth, trace), + loader: loader, + responder: responder, + selective: selective, + claimants: claimants, + maxDepth: maxDepth, + maxClockDuration: maxClockDuration, + log: log, + responseDelay: responseDelay, + responseDelayAfter: responseDelayAfter, + // responseCount starts at zero by default } } @@ -106,13 +120,13 @@ func (a *Agent) Act(ctx context.Context) error { var wg sync.WaitGroup wg.Add(len(actions)) for _, action := range actions { - go a.performAction(ctx, &wg, action) + go a.performAction(ctx, &wg, game, action) } wg.Wait() return nil } -func (a *Agent) performAction(ctx context.Context, wg *sync.WaitGroup, action types.Action) { +func (a *Agent) performAction(ctx context.Context, wg *sync.WaitGroup, game types.Game, action types.Action) { defer wg.Done() actionLog := a.log.New("action", action.Type) if action.Type == types.ActionTypeStep { @@ -133,6 +147,31 @@ func (a *Agent) performAction(ctx context.Context, wg *sync.WaitGroup, action ty actionLog = actionLog.New("is_attack", action.IsAttack, "parent", action.ParentClaim.ContractIndex, "value", action.Value) } + // Apply configurable delay before responding (to slow down game progression) + // Only apply delay if we've made enough responses already AND we're not in a clock extension period + currentResponseCount := a.responseCount.Load() + shouldCheckDelay := a.responseDelay > 0 && currentResponseCount >= a.responseDelayAfter + + if shouldCheckDelay { + // Check if we're in a clock extension period - if so, respond immediately + inExtension, remainingTimeCheck, err := a.shouldSkipDelay(ctx, game, action) + if err != nil { + actionLog.Warn("Failed to check delay conditions, skipping delay for safety", "err", err) + } else if inExtension { + actionLog.Info("Skipping delay due to clock extension period", "response_count", currentResponseCount, "delay_after", a.responseDelayAfter) + } else if remainingTimeCheck { + actionLog.Info("Skipping delay due to insufficient remaining game time", "response_count", currentResponseCount, "delay_after", a.responseDelayAfter) + } else { + actionLog.Info("Delaying response", "delay", a.responseDelay, "response_count", currentResponseCount, "delay_after", a.responseDelayAfter) + select { + case <-ctx.Done(): + actionLog.Error("Action cancelled during delay", "err", ctx.Err()) + return + case <-a.systemClock.After(a.responseDelay): + } + } + } + switch action.Type { case types.ActionTypeMove: a.metrics.RecordGameMove() @@ -141,10 +180,15 @@ func (a *Agent) performAction(ctx context.Context, wg *sync.WaitGroup, action ty case types.ActionTypeChallengeL2BlockNumber: a.metrics.RecordGameL2Challenge() } + actionLog.Info("Performing action") err := a.responder.PerformAction(ctx, action) if err != nil { actionLog.Error("Action failed", "err", err) + } else { + // Increment response count only on successful actions + newCount := a.responseCount.Add(1) + actionLog.Debug("Response count incremented", "response_count", newCount) } } @@ -235,6 +279,43 @@ func (a *Agent) resolveClaims(ctx context.Context) error { } } +// shouldSkipDelay determines if the delay should be skipped for the given action. +// Returns (inClockExtension, insufficientRemainingTime, error). +// Delay should be skipped if either inClockExtension OR insufficientRemainingTime is true. +func (a *Agent) shouldSkipDelay(ctx context.Context, game types.Game, action types.Action) (bool, bool, error) { + // Use proper chess clock calculation from types package + // We need OUR accumulated chess clock time to check if we're in extension period + now := a.l1Clock.Now() + ourAccumulatedTime := game.ChessClock(now, action.ParentClaim) + + // Get base clock extension (conservative approach) + clockExtension, err := a.loader.GetClockExtension(ctx) + if err != nil { + return false, false, fmt.Errorf("failed to get clock extension: %w", err) + } + + // Check if we're already in a clock extension period + maxClockDuration := a.maxClockDuration + extensionThreshold := maxClockDuration - clockExtension + inExtension := ourAccumulatedTime > extensionThreshold + + // Check if our delay would cause us to enter the extension period at all (conservative approach) + // We don't want to risk making moves inside the extension period, so if our delay would + // cause us to exceed the extension threshold, we skip the delay entirely + delayWouldEnterExtension := ourAccumulatedTime+a.responseDelay > extensionThreshold + + a.log.Debug("Delay skip check", + "our_accumulated_time", ourAccumulatedTime, + "max_clock_duration", maxClockDuration, + "clock_extension", clockExtension, + "extension_threshold", extensionThreshold, + "response_delay", a.responseDelay, + "in_extension", inExtension, + "delay_would_enter_extension", delayWouldEnterExtension) + + return inExtension, delayWouldEnterExtension, nil +} + // newGameFromContracts initializes a new game state from the state in the contract func (a *Agent) newGameFromContracts(ctx context.Context) (types.Game, error) { claims, err := a.loader.GetAllClaims(ctx, rpcblock.Latest) diff --git a/op-challenger/game/fault/agent_test.go b/op-challenger/game/fault/agent_test.go index 62dc560263e..8f274dbe106 100644 --- a/op-challenger/game/fault/agent_test.go +++ b/op-challenger/game/fault/agent_test.go @@ -9,15 +9,19 @@ import ( "testing" "time" + "github.com/ethereum-optimism/optimism/op-challenger/game/fault/contracts" "github.com/ethereum-optimism/optimism/op-challenger/game/fault/trace" + "github.com/ethereum-optimism/optimism/op-challenger/game/keccak/merkle" + keccakTypes "github.com/ethereum-optimism/optimism/op-challenger/game/keccak/types" "github.com/ethereum-optimism/optimism/op-service/clock" "github.com/ethereum-optimism/optimism/op-service/sources/batching/rpcblock" + "github.com/ethereum-optimism/optimism/op-service/txmgr" "github.com/stretchr/testify/require" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/log" - "github.com/ethereum-optimism/optimism/op-challenger/game/fault/test" + faulttest "github.com/ethereum-optimism/optimism/op-challenger/game/fault/test" "github.com/ethereum-optimism/optimism/op-challenger/game/fault/trace/alphabet" "github.com/ethereum-optimism/optimism/op-challenger/game/fault/types" gameTypes "github.com/ethereum-optimism/optimism/op-challenger/game/types" @@ -27,6 +31,16 @@ import ( var l1Time = time.UnixMilli(100) +// newStubClaimLoaderWithDefaults creates a stubClaimLoader with sensible defaults +// for basic delay tests (prevents clock extension from triggering) +func newStubClaimLoaderWithDefaults() *stubClaimLoader { + return &stubClaimLoader{ + // A large clock extension value used to prevent clock + // extension from triggering during basic delay tests + clockExtension: 1 * time.Hour, + } +} + func TestDoNotMakeMovesWhenGameIsResolvable(t *testing.T) { ctx := context.Background() @@ -73,7 +87,7 @@ func TestDoNotMakeMovesWhenL2BlockNumberChallenged(t *testing.T) { } func createClaimsWithClaimants(t *testing.T, d types.Depth) []types.Claim { - claimBuilder := test.NewClaimBuilder(t, d, alphabet.NewTraceProvider(big.NewInt(0), d)) + claimBuilder := faulttest.NewClaimBuilder(t, d, alphabet.NewTraceProvider(big.NewInt(0), d)) rootClaim := claimBuilder.CreateRootClaim() claim1 := rootClaim claim1.Claimant = common.BigToAddress(big.NewInt(1)) @@ -158,14 +172,14 @@ func TestSkipAttemptingToResolveClaimsWhenClockNotExpired(t *testing.T) { responder.callResolveErr = errors.New("game is not resolvable") responder.callResolveClaimErr = errors.New("claim is not resolvable") depth := types.Depth(4) - claimBuilder := test.NewClaimBuilder(t, depth, alphabet.NewTraceProvider(big.NewInt(0), depth)) + claimBuilder := faulttest.NewClaimBuilder(t, depth, alphabet.NewTraceProvider(big.NewInt(0), depth)) rootTime := l1Time.Add(-agent.maxClockDuration - 5*time.Minute) - gameBuilder := claimBuilder.GameBuilder(test.WithClock(rootTime, 0)) + gameBuilder := claimBuilder.GameBuilder(faulttest.WithClock(rootTime, 0)) gameBuilder.Seq(). - Attack(test.WithClock(rootTime.Add(5*time.Minute), 5*time.Minute)). - Defend(test.WithClock(rootTime.Add(7*time.Minute), 2*time.Minute)). - Attack(test.WithClock(rootTime.Add(11*time.Minute), 4*time.Minute)) + Attack(faulttest.WithClock(rootTime.Add(5*time.Minute), 5*time.Minute)). + Defend(faulttest.WithClock(rootTime.Add(7*time.Minute), 2*time.Minute)). + Attack(faulttest.WithClock(rootTime.Add(11*time.Minute), 4*time.Minute)) claimLoader.claims = gameBuilder.Game.Claims() require.NoError(t, agent.Act(context.Background())) @@ -181,7 +195,7 @@ func TestLoadClaimsWhenGameNotResolvable(t *testing.T) { responder.callResolveErr = errors.New("game is not resolvable") responder.callResolveClaimErr = errors.New("claim is not resolvable") depth := types.Depth(4) - claimBuilder := test.NewClaimBuilder(t, depth, alphabet.NewTraceProvider(big.NewInt(0), depth)) + claimBuilder := faulttest.NewClaimBuilder(t, depth, alphabet.NewTraceProvider(big.NewInt(0), depth)) claimLoader.claims = []types.Claim{ claimBuilder.CreateRootClaim(), @@ -198,12 +212,12 @@ func setupTestAgent(t *testing.T) (*Agent, *stubClaimLoader, *stubResponder) { logger := testlog.Logger(t, log.LevelInfo) claimLoader := &stubClaimLoader{} depth := types.Depth(4) - gameDuration := 3 * time.Minute + gameDuration := 24 * time.Hour provider := alphabet.NewTraceProvider(big.NewInt(0), depth) responder := &stubResponder{} systemClock := clock.NewDeterministicClock(time.UnixMilli(120200)) l1Clock := clock.NewDeterministicClock(l1Time) - agent := NewAgent(metrics.NoopMetrics, systemClock, l1Clock, claimLoader, depth, gameDuration, trace.NewSimpleTraceAccessor(provider), responder, logger, false, []common.Address{}) + agent := NewAgent(metrics.NoopMetrics, systemClock, l1Clock, claimLoader, depth, gameDuration, trace.NewSimpleTraceAccessor(provider), responder, logger, false, []common.Address{}, 0, 0) return agent, claimLoader, responder } @@ -212,6 +226,10 @@ type stubClaimLoader struct { maxLoads int claims []types.Claim blockNumChallenged bool + clockExtension time.Duration + clockExtensionErr error + splitDepth types.Depth + maxGameDepth types.Depth } func (s *stubClaimLoader) IsL2BlockNumberChallenged(_ context.Context, _ rpcblock.Block) (bool, error) { @@ -226,6 +244,101 @@ func (s *stubClaimLoader) GetAllClaims(_ context.Context, _ rpcblock.Block) ([]t return s.claims, nil } +func (s *stubClaimLoader) GetClockExtension(_ context.Context) (time.Duration, error) { + if s.clockExtensionErr != nil { + return 0, s.clockExtensionErr + } + // Return a reasonable default if not set + if s.clockExtension == 0 { + return 5 * time.Minute, nil // Default clock extension + } + return s.clockExtension, nil +} + +func (s *stubClaimLoader) GetSplitDepth(_ context.Context) (types.Depth, error) { + if s.splitDepth != 0 { + return s.splitDepth, nil + } + return types.Depth(30), nil // Reasonable default for tests +} + +func (s *stubClaimLoader) GetMaxGameDepth(_ context.Context) (types.Depth, error) { + if s.maxGameDepth != 0 { + return s.maxGameDepth, nil + } + return types.Depth(73), nil // Reasonable default for tests +} + +func (s *stubClaimLoader) GetOracle(_ context.Context) (contracts.PreimageOracleContract, error) { + return &stubPreimageOracleContract{}, nil +} + +// stubPreimageOracleContract implements the PreimageOracleContract interface for testing +type stubPreimageOracleContract struct{} + +func (s *stubPreimageOracleContract) ChallengePeriod(_ context.Context) (uint64, error) { + return 86400, nil // 1 day in seconds - reasonable default for tests +} + +// Add minimal implementations for other required methods (if any) +func (s *stubPreimageOracleContract) Addr() common.Address { return common.Address{} } +func (s *stubPreimageOracleContract) AddGlobalDataTx(*types.PreimageOracleData) (txmgr.TxCandidate, error) { + return txmgr.TxCandidate{}, nil +} +func (s *stubPreimageOracleContract) InitLargePreimage(*big.Int, uint32, uint32) (txmgr.TxCandidate, error) { + return txmgr.TxCandidate{}, nil +} +func (s *stubPreimageOracleContract) AddLeaves(*big.Int, *big.Int, []byte, []common.Hash, bool) (txmgr.TxCandidate, error) { + return txmgr.TxCandidate{}, nil +} +func (s *stubPreimageOracleContract) MinLargePreimageSize(context.Context) (uint64, error) { + return 0, nil +} +func (s *stubPreimageOracleContract) CallSqueeze(context.Context, common.Address, *big.Int, keccakTypes.StateSnapshot, keccakTypes.Leaf, merkle.Proof, keccakTypes.Leaf, merkle.Proof) error { + return nil +} +func (s *stubPreimageOracleContract) Squeeze(common.Address, *big.Int, keccakTypes.StateSnapshot, keccakTypes.Leaf, merkle.Proof, keccakTypes.Leaf, merkle.Proof) (txmgr.TxCandidate, error) { + return txmgr.TxCandidate{}, nil +} +func (s *stubPreimageOracleContract) GetActivePreimages(context.Context, common.Hash) ([]keccakTypes.LargePreimageMetaData, error) { + return nil, nil +} +func (s *stubPreimageOracleContract) GetProposalMetadata(context.Context, rpcblock.Block, ...keccakTypes.LargePreimageIdent) ([]keccakTypes.LargePreimageMetaData, error) { + return nil, nil +} +func (s *stubPreimageOracleContract) GetProposalTreeRoot(context.Context, rpcblock.Block, keccakTypes.LargePreimageIdent) (common.Hash, error) { + return common.Hash{}, nil +} +func (s *stubPreimageOracleContract) GetInputDataBlocks(context.Context, rpcblock.Block, keccakTypes.LargePreimageIdent) ([]uint64, error) { + return nil, nil +} +func (s *stubPreimageOracleContract) DecodeInputData([]byte) (*big.Int, keccakTypes.InputData, error) { + return nil, keccakTypes.InputData{}, nil +} +func (s *stubPreimageOracleContract) GlobalDataExists(context.Context, *types.PreimageOracleData) (bool, error) { + return false, nil +} +func (s *stubPreimageOracleContract) GetGlobalData(context.Context, *types.PreimageOracleData) ([32]byte, error) { + return [32]byte{}, nil +} +func (s *stubPreimageOracleContract) ChallengeTx(keccakTypes.LargePreimageIdent, keccakTypes.Challenge) (txmgr.TxCandidate, error) { + return txmgr.TxCandidate{}, nil +} +func (s *stubPreimageOracleContract) GetMinBondLPP(context.Context) (*big.Int, error) { + return big.NewInt(0), nil +} + +// createStubGame creates a mock game for testing performAction calls +func createStubGame(claims []types.Claim) types.Game { + if len(claims) == 0 { + // Create a default root claim for tests + claims = []types.Claim{ + faulttest.NewClaimBuilder(nil, types.Depth(4), alphabet.NewTraceProvider(big.NewInt(0), types.Depth(4))).CreateRootClaim(), + } + } + return types.NewGameState(claims, types.Depth(4)) +} + type stubResponder struct { l sync.Mutex callResolveCount int @@ -239,6 +352,9 @@ type stubResponder struct { callResolveClaimErr error resolveClaimCount int resolvedClaims []uint64 + + performActionCount int + performActionErr error // If set, PerformAction will return this error } func (s *stubResponder) CallResolve(_ context.Context) (gameTypes.GameStatus, error) { @@ -274,5 +390,777 @@ func (s *stubResponder) ResolveClaims(claims ...uint64) error { } func (s *stubResponder) PerformAction(_ context.Context, _ types.Action) error { - return nil + s.l.Lock() + defer s.l.Unlock() + s.performActionCount++ + return s.performActionErr +} + +func (s *stubResponder) PerformedActionCount() int { + s.l.Lock() + defer s.l.Unlock() + return s.performActionCount +} + +// TestResponseDelay tests the response delay functionality using deterministic clock +func TestResponseDelay(t *testing.T) { + tests := []struct { + name string + delay time.Duration + }{ + { + name: "NoDelay", + delay: 0, + }, + { + name: "Delay", + delay: 20 * time.Hour, // Less than extension threshold (24h - 1h = 23h) + }, + } + + for _, test := range tests { + test := test + t.Run(test.name, func(t *testing.T) { + ctx := context.Background() + + // Set up agent with deterministic clock + logger := testlog.Logger(t, log.LevelInfo) + claimLoader := newStubClaimLoaderWithDefaults() + depth := types.Depth(4) + gameDuration := 24 * time.Hour // Large value to avoid clock extension triggering + provider := alphabet.NewTraceProvider(big.NewInt(0), depth) + responder := &stubResponder{} + systemClock := clock.NewDeterministicClock(time.UnixMilli(120200)) + l1Clock := clock.NewDeterministicClock(l1Time) + + // Create agent with the test response delay + agent := NewAgent(metrics.NoopMetrics, systemClock, l1Clock, claimLoader, depth, gameDuration, trace.NewSimpleTraceAccessor(provider), responder, logger, false, []common.Address{}, test.delay, 0) + + // Set up game state with a claim to respond to + claimLoader.claims = []types.Claim{ + { + ClaimData: types.ClaimData{ + Value: common.Hash{}, + Position: types.NewPositionFromGIndex(big.NewInt(1)), + }, + Clock: types.Clock{ + Duration: time.Minute, + Timestamp: l1Time, + }, + ContractIndex: 0, + }, + } + + // Create an action that will trigger the delay + action := types.Action{ + Type: types.ActionTypeMove, + ParentClaim: claimLoader.claims[0], + IsAttack: true, + Value: common.Hash{0x01}, + } + + // Perform action in a goroutine so we can control clock advancement + var wg sync.WaitGroup + wg.Add(1) + + done := make(chan struct{}) + go func() { + agent.performAction(ctx, &wg, createStubGame(claimLoader.claims), action) + close(done) + }() + + if test.delay > 0 { + // Wait for the action delay to begin waiting + require.True(t, systemClock.WaitForNewPendingTaskWithTimeout(30*time.Second)) + require.Zero(t, responder.PerformedActionCount(), "Action should not have completed before delay period") + + systemClock.AdvanceTime(test.delay) + } + // Verify the action completes + select { + case <-done: + // Expected completion due to cancellation + case <-time.After(30 * time.Second): + t.Fatal("Action did not complete quickly after cancellation") + } + // And verify the wait group is done for good measure + wg.Wait() + + require.Equal(t, 1, responder.PerformedActionCount(), "Action should have completed after delay period") + }) + } +} + +// TestResponseDelayContextCancellation tests that context cancellation interrupts the delay +func TestResponseDelayContextCancellation(t *testing.T) { + ctx, cancel := context.WithCancel(context.Background()) + + // Set up agent with long delay and deterministic clock + logger := testlog.Logger(t, log.LevelInfo) + claimLoader := newStubClaimLoaderWithDefaults() + depth := types.Depth(4) + gameDuration := 24 * time.Hour + provider := alphabet.NewTraceProvider(big.NewInt(0), depth) + responder := &stubResponder{} + systemClock := clock.NewDeterministicClock(time.UnixMilli(120200)) + l1Clock := clock.NewDeterministicClock(l1Time) + + longDelay := 5 * time.Minute + agent := NewAgent(metrics.NoopMetrics, systemClock, l1Clock, claimLoader, depth, gameDuration, trace.NewSimpleTraceAccessor(provider), responder, logger, false, []common.Address{}, longDelay, 0) + + // Set up game state + claimLoader.claims = []types.Claim{ + { + ClaimData: types.ClaimData{ + Value: common.Hash{}, + Position: types.NewPositionFromGIndex(big.NewInt(1)), + }, + Clock: types.Clock{ + Duration: time.Minute, + Timestamp: l1Time, + }, + ContractIndex: 0, + }, + } + + action := types.Action{ + Type: types.ActionTypeMove, + ParentClaim: claimLoader.claims[0], + IsAttack: true, + Value: common.Hash{0x01}, + } + + var wg sync.WaitGroup + wg.Add(1) + + done := make(chan struct{}) + go func() { + agent.performAction(ctx, &wg, createStubGame(claimLoader.claims), action) + close(done) + }() + + // Verify the action is waiting for the delay + systemClock.WaitForNewPendingTaskWithTimeout(30 * time.Second) + + // Cancel the context (simulates timeout or shutdown) + cancel() + + // Action should complete even though the clock didn't progress + select { + case <-done: + // Expected completion due to cancellation + case <-time.After(30 * time.Second): + t.Fatal("Action did not complete quickly after cancellation") + } + + // And verify the wait group is done for good measure + wg.Wait() + require.Zero(t, responder.PerformedActionCount(), "Action should not have completed") +} + +// TestResponseDelayDifferentActionTypes tests that delay applies to all action types +func TestResponseDelayDifferentActionTypes(t *testing.T) { + actionTypes := []struct { + name string + actionType types.ActionType + }{ + {"Move", types.ActionTypeMove}, + {"Step", types.ActionTypeStep}, + {"ChallengeL2BlockNumber", types.ActionTypeChallengeL2BlockNumber}, + } + + for _, actionTest := range actionTypes { + actionTest := actionTest + t.Run(actionTest.name, func(t *testing.T) { + ctx := context.Background() + + // Set up agent with deterministic clock and response delay + logger := testlog.Logger(t, log.LevelInfo) + claimLoader := newStubClaimLoaderWithDefaults() + depth := types.Depth(4) + gameDuration := 24 * time.Hour // Large value to avoid clock extension triggering + provider := alphabet.NewTraceProvider(big.NewInt(0), depth) + responder := &stubResponder{} + systemClock := clock.NewDeterministicClock(time.UnixMilli(120200)) + l1Clock := clock.NewDeterministicClock(l1Time) + + responseDelay := 3 * time.Hour + agent := NewAgent(metrics.NoopMetrics, systemClock, l1Clock, claimLoader, depth, gameDuration, trace.NewSimpleTraceAccessor(provider), responder, logger, false, []common.Address{}, responseDelay, 0) + + // Set up game state + claimLoader.claims = []types.Claim{ + { + ClaimData: types.ClaimData{ + Value: common.Hash{}, + Position: types.NewPositionFromGIndex(big.NewInt(1)), + }, + Clock: types.Clock{ + Duration: time.Minute, + Timestamp: l1Time, + }, + ContractIndex: 0, + }, + } + + // Create action of specific type + action := types.Action{ + Type: actionTest.actionType, + ParentClaim: claimLoader.claims[0], + IsAttack: true, + Value: common.Hash{0x01}, + } + + var wg sync.WaitGroup + wg.Add(1) + + done := make(chan struct{}) + go func() { + agent.performAction(ctx, &wg, createStubGame(claimLoader.claims), action) + close(done) + }() + + // First select: Verify the action is waiting for the delay (polling check) + systemClock.WaitForNewPendingTaskWithTimeout(30 * time.Second) + require.Zero(t, responder.PerformedActionCount(), "Action was performed before delay") + + // Advance clock by delay amount + systemClock.AdvanceTime(responseDelay) + + // Second select: Wait for action to complete after clock advancement + select { + case <-done: + // Expected completion + case <-time.After(30 * time.Second): + t.Fatal("Action did not complete after delay") + } + // Verify the wait group is done for good measure + wg.Wait() + + // Verify the action was performed + require.Equal(t, 1, responder.PerformedActionCount(), "Action was not performed after delay") + }) + } +} + +// TestResponseDelayAfter tests the response delay activation threshold functionality +func TestResponseDelayAfter(t *testing.T) { + tests := []struct { + name string + responseDelay time.Duration + responseDelayAfter uint64 + actionsToPerform int + }{ + { + name: "DelayFromFirstResponse", + responseDelay: 2 * time.Hour, + responseDelayAfter: 0, // Apply delay from first response + actionsToPerform: 3, + }, + { + name: "DelayAfterFirstResponse", + responseDelay: 2 * time.Hour, + responseDelayAfter: 1, // Skip first response, delay subsequent ones + actionsToPerform: 3, + }, + { + name: "DelayAfterSecondResponse", + responseDelay: 2 * time.Hour, + responseDelayAfter: 2, // Skip first two responses + actionsToPerform: 4, + }, + { + name: "DelayNeverActivates", + responseDelay: 2 * time.Hour, + responseDelayAfter: 5, // Threshold higher than actions performed + actionsToPerform: 3, + }, + { + name: "NoDelayConfigured", + responseDelay: 0, // No delay configured + responseDelayAfter: 0, + actionsToPerform: 3, + }, + } + + for _, test := range tests { + test := test + t.Run(test.name, func(t *testing.T) { + ctx := context.Background() + + // Set up agent with deterministic clock + logger := testlog.Logger(t, log.LevelInfo) + claimLoader := newStubClaimLoaderWithDefaults() + depth := types.Depth(4) + gameDuration := 24 * time.Hour // Large value to avoid clock extension triggering + provider := alphabet.NewTraceProvider(big.NewInt(0), depth) + responder := &stubResponder{} + systemClock := clock.NewDeterministicClock(time.UnixMilli(120200)) + l1Clock := clock.NewDeterministicClock(l1Time) + + // Create agent with test parameters + agent := NewAgent(metrics.NoopMetrics, systemClock, l1Clock, claimLoader, depth, gameDuration, trace.NewSimpleTraceAccessor(provider), responder, logger, false, []common.Address{}, test.responseDelay, test.responseDelayAfter) + + // Set up initial game state + claimBuilder := faulttest.NewClaimBuilder(t, depth, provider) + baseClaim := claimBuilder.CreateRootClaim() + // Fix timestamp to be realistic + baseClaim.Clock = types.Clock{ + Duration: 0, // Root claim starts with no accumulated time + Timestamp: l1Clock.Now(), // Use current time + } + claimLoader.claims = []types.Claim{baseClaim} + + // Perform actions and verify delay behavior + for i := 0; i < test.actionsToPerform; i++ { + action := types.Action{ + Type: types.ActionTypeMove, + ParentClaim: baseClaim, + IsAttack: true, + Value: common.Hash{byte(i + 1)}, // Unique value for each action + } + + var wg sync.WaitGroup + wg.Add(1) + + done := make(chan struct{}) + go func() { + agent.performAction(ctx, &wg, createStubGame(claimLoader.claims), action) + close(done) + }() + + // Calculate if delay should be applied: response count >= threshold AND delay > 0 + shouldHaveDelay := uint64(i) >= test.responseDelayAfter && test.responseDelay > 0 + + if shouldHaveDelay { + systemClock.WaitForNewPendingTaskWithTimeout(30 * time.Second) + require.Equal(t, i, responder.PerformedActionCount(), "Action was performed before delay") + + // Advance clock by delay amount + systemClock.AdvanceTime(test.responseDelay) + } + + // Wait for completion + select { + case <-done: + // Expected completion + case <-time.After(30 * time.Second): + t.Fatalf("Action %d did not complete after delay", i+1) + } + wg.Wait() + + // Verify response count incremented (assuming successful response) + expectedCount := uint64(i + 1) + require.Equal(t, expectedCount, agent.responseCount.Load(), "Response count should increment after action %d", expectedCount) + } + }) + } +} + +// TestResponseDelayAfterWithFailedActions tests that failed actions don't increment response count +func TestResponseDelayAfterWithFailedActions(t *testing.T) { + ctx := context.Background() + + // Set up agent with delay after 1 response + logger := testlog.Logger(t, log.LevelInfo) + claimLoader := newStubClaimLoaderWithDefaults() + depth := types.Depth(4) + gameDuration := 24 * time.Hour + provider := alphabet.NewTraceProvider(big.NewInt(0), depth) + responder := &stubResponder{} + systemClock := clock.NewDeterministicClock(time.UnixMilli(120200)) + l1Clock := clock.NewDeterministicClock(l1Time) + + responseDelay := 2 * time.Hour + responseDelayAfter := uint64(1) // Delay after first successful response + agent := NewAgent(metrics.NoopMetrics, systemClock, l1Clock, claimLoader, depth, gameDuration, trace.NewSimpleTraceAccessor(provider), responder, logger, false, []common.Address{}, responseDelay, responseDelayAfter) + + // Set up game state + claimBuilder := faulttest.NewClaimBuilder(t, depth, provider) + baseClaim := claimBuilder.CreateRootClaim() + // Fix timestamp to be realistic + baseClaim.Clock = types.Clock{ + Duration: 0, // Root claim starts with no accumulated time + Timestamp: l1Clock.Now(), // Use current time + } + claimLoader.claims = []types.Claim{baseClaim} + + action := types.Action{ + Type: types.ActionTypeMove, + ParentClaim: baseClaim, + IsAttack: true, + Value: common.Hash{0x01}, + } + + // First action: make responder fail + responder.performActionErr = errors.New("simulated action failure") + + var wg sync.WaitGroup + wg.Add(1) + + done := make(chan struct{}) + go func() { + agent.performAction(ctx, &wg, createStubGame(claimLoader.claims), action) + close(done) + }() + + // Should complete without needing to advance the clock (no delay since responseCount < responseDelayAfter) + select { + case <-done: + // Expected immediate completion + case <-time.After(30 * time.Second): + t.Fatal("Failed action took too long") + } + wg.Wait() + + require.Equal(t, uint64(0), agent.responseCount.Load(), "Failed action should not increment response count") + + // Second action: make responder succeed + responder.performActionErr = nil + + wg.Add(1) + done = make(chan struct{}) + go func() { + agent.performAction(ctx, &wg, createStubGame(claimLoader.claims), action) + close(done) + }() + + // Should complete without needing to advance the clock (no delay since responseCount is still 0) + select { + case <-done: + // Expected immediate completion + case <-time.After(30 * time.Second): + t.Fatal("Successful action took too long") + } + wg.Wait() + + // Should be no delay but response count should increment + require.Equal(t, uint64(1), agent.responseCount.Load(), "Successful action should increment response count") + + // Third action: should now have delay applied + wg.Add(1) + done = make(chan struct{}) + go func() { + agent.performAction(ctx, &wg, createStubGame(claimLoader.claims), action) + close(done) + }() + + // Should be waiting for delay now (responseCount >= responseDelayAfter) + systemClock.WaitForNewPendingTaskWithTimeout(30 * time.Second) + // Note: 2 attempts have been made - one failed, one successful and the third is delayed. + require.Equal(t, 2, responder.PerformedActionCount(), "Should not have performed action without delay") + + // Advance clock by delay amount + systemClock.AdvanceTime(responseDelay) + + // Wait for completion + select { + case <-done: + // Expected completion + case <-time.After(30 * time.Second): + t.Fatal("Action did not complete after delay") + } + + wg.Wait() + + require.Equal(t, 3, responder.PerformedActionCount(), "Should have performed action after delay") + require.Equal(t, uint64(2), agent.responseCount.Load(), "Response count should be 2 after second successful action") +} + +// TestResponseDelayClockExtension tests that delays are skipped during clock extension periods +func TestResponseDelayClockExtension(t *testing.T) { + // Common test configuration + const ( + responseDelay = 30 * time.Second // Reasonable delay that fits in remaining time + responseDelayAfter = 0 + maxClockDuration = 10 * time.Minute + clockExtension = 1 * time.Minute + baseTimestamp = 100000 // milliseconds since Unix epoch + ) + extensionThreshold := maxClockDuration - clockExtension // 9 minutes + + tests := []struct { + name string + parentClockDuration time.Duration // Previous accumulated time + timeSinceCreation time.Duration // Additional time since claim created + }{ + { + name: "NoExtension_WithDelay", + parentClockDuration: 3 * time.Minute, + timeSinceCreation: 1 * time.Minute, // Total: 4min < 9min threshold + }, + { + name: "InExtension_SkipDelay", + parentClockDuration: 8 * time.Minute, + timeSinceCreation: 2 * time.Minute, // Total: 10min > 9min threshold + }, + { + name: "ExactlyAtThreshold_InExtension_SkipDelay", + parentClockDuration: 8 * time.Minute, + timeSinceCreation: 1*time.Minute + 1*time.Microsecond, // Total: just over 9min + }, + { + name: "JustBelowThreshold_WithDelay_WaitDelay", + parentClockDuration: 8 * time.Minute, + timeSinceCreation: 20 * time.Second, // Total: 8min20s + 30s delay = 8min50s < 9min threshold + }, + } + + for _, test := range tests { + test := test + t.Run(test.name, func(t *testing.T) { + ctx := context.Background() + + // Set up agent with deterministic clock + logger := testlog.Logger(t, log.LevelInfo) + claimLoader := &stubClaimLoader{ + clockExtension: clockExtension, + } + depth := types.Depth(4) + provider := alphabet.NewTraceProvider(big.NewInt(0), depth) + responder := &stubResponder{} + currentTime := time.UnixMilli(baseTimestamp).Add(test.timeSinceCreation) + systemClock := clock.NewDeterministicClock(currentTime) + l1Clock := clock.NewDeterministicClock(currentTime) + + // Create agent with test parameters + agent := NewAgent(metrics.NoopMetrics, systemClock, l1Clock, claimLoader, depth, maxClockDuration, trace.NewSimpleTraceAccessor(provider), responder, logger, false, []common.Address{}, responseDelay, responseDelayAfter) + + // Set up proper parent-child relationship for chess clock calculation + claimBuilder := faulttest.NewClaimBuilder(t, depth, provider) + + // Create a grandparent claim (root claim) that has the accumulated time from previous moves + grandparentClaim := claimBuilder.CreateRootClaim(faulttest.WithClock( + currentTime.Add(-test.timeSinceCreation).Add(-time.Duration(test.parentClockDuration.Nanoseconds())), + test.parentClockDuration, + )) + grandparentClaim.ContractIndex = 0 // Root claim + + // Create parent claim as an attack on the grandparent (so it's NOT a root claim) + parentClaim := claimBuilder.AttackClaim(grandparentClaim, faulttest.WithClock( + currentTime.Add(-test.timeSinceCreation), + 0, // This will be calculated by ChessClock + )) + parentClaim.ContractIndex = 1 // Set contract index + + // Calculate total chess clock time using the same logic as the contract + // This should be grandparent.Duration + time since parent was created + totalChessClockTime := test.parentClockDuration + test.timeSinceCreation + expectDelay := totalChessClockTime <= extensionThreshold + claimLoader.claims = []types.Claim{grandparentClaim, parentClaim} + + // Create action with the parent claim + action := types.Action{ + Type: types.ActionTypeMove, + ParentClaim: parentClaim, + IsAttack: true, + Value: common.Hash{0x01}, + } + + // Perform action and measure timing + var wg sync.WaitGroup + wg.Add(1) + + done := make(chan struct{}) + go func() { + agent.performAction(ctx, &wg, createStubGame(claimLoader.claims), action) + close(done) + }() + + if expectDelay { + // Should be waiting for delay + systemClock.WaitForNewPendingTaskWithTimeout(30 * time.Second) + require.Equal(t, 0, responder.PerformedActionCount(), "Should not have performed action without delay") + + // Advance clock by delay amount + systemClock.AdvanceTime(responseDelay) + } + + // Wait for completion + select { + case <-done: + // Expected completion + case <-time.After(30 * time.Second): + t.Fatal("Action did not complete in expected time") + } + wg.Wait() + + require.Equal(t, 1, responder.PerformedActionCount(), "Should have performed action after delay") + }) + } +} + +// TestResponseDelayTimeoutPrevention tests delay timeout prevention logic +func TestResponseDelayTimeoutPrevention(t *testing.T) { + const ( + responseDelayAfter = 0 + maxClockDuration = 10 * time.Minute + clockExtension = 2 * time.Minute + ) + + tests := []struct { + name string + parentClockDuration time.Duration + responseDelay time.Duration + expectDelay bool + description string + }{ + { + name: "DelayFitsInExtensionBuffer_ShouldSkip", + parentClockDuration: 8*time.Minute + 30*time.Second, // Past threshold but delay fits + responseDelay: 1 * time.Minute, // Fits in 2min extension + expectDelay: false, // Should skip due to extension period + description: "When in extension period, should skip delay regardless of timeout risk", + }, + { + name: "DelayWouldTimeout_ShouldSkip", + parentClockDuration: 9*time.Minute + 30*time.Second, // Already in extension (threshold 8min) + responseDelay: 3 * time.Minute, // Large delay + expectDelay: false, // Should skip due to being in extension + description: "Should skip delay when already in extension period", + }, + { + name: "DelayWouldEnterExtensionPeriod_ShouldSkip", + parentClockDuration: 6 * time.Minute, // Not in extension (8min threshold) + responseDelay: 3 * time.Minute, // Would push us to 9min > 8min threshold + expectDelay: false, // Should skip to avoid extension period + description: "Should skip delay when it would cause entry into extension period", + }, + { + name: "BeforeThreshold_ShouldDelay", + parentClockDuration: 5 * time.Minute, // Well before threshold, 5min remaining + responseDelay: 30 * time.Second, // Short delay that fits in remaining time + expectDelay: true, // Should apply delay + description: "Should apply delay when well before extension threshold and delay fits", + }, + } + + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + ctx := context.Background() + logger := testlog.Logger(t, log.LevelInfo) + + claimLoader := &stubClaimLoader{ + clockExtension: clockExtension, + } + depth := types.Depth(4) + provider := alphabet.NewTraceProvider(big.NewInt(0), depth) + responder := &stubResponder{} + + // Set up timing so parentClockDuration calculation works + currentTime := time.UnixMilli(100000) + systemClock := clock.NewDeterministicClock(currentTime) + l1Clock := clock.NewDeterministicClock(currentTime) + + agent := NewAgent(metrics.NoopMetrics, systemClock, l1Clock, claimLoader, depth, maxClockDuration, trace.NewSimpleTraceAccessor(provider), responder, logger, false, []common.Address{}, test.responseDelay, responseDelayAfter) + + // Create claims with proper parent-child relationship for chess clock calculation + claimBuilder := faulttest.NewClaimBuilder(t, depth, provider) + timeSinceCreation := 1 * time.Minute // Fixed component + + // Create grandparent claim (root claim) that has the accumulated time from previous moves + grandparentClaim := claimBuilder.CreateRootClaim(faulttest.WithClock( + currentTime.Add(-timeSinceCreation).Add(-time.Duration(test.parentClockDuration.Nanoseconds())), + test.parentClockDuration, + )) + grandparentClaim.ContractIndex = 0 // Root claim + + // Create parent claim as an attack on the grandparent (so it's NOT a root claim) + parentClaim := claimBuilder.AttackClaim(grandparentClaim, faulttest.WithClock( + currentTime.Add(-timeSinceCreation), + 0, // This will be calculated by ChessClock + )) + parentClaim.ContractIndex = 1 // Set contract index + + claimLoader.claims = []types.Claim{grandparentClaim, parentClaim} + + action := types.Action{ + Type: types.ActionTypeMove, + ParentClaim: parentClaim, + IsAttack: true, + Value: common.Hash{0x01}, + } + + // Perform action and check timing + var wg sync.WaitGroup + wg.Add(1) + done := make(chan struct{}) + go func() { + agent.performAction(ctx, &wg, createStubGame(claimLoader.claims), action) + close(done) + }() + + if test.expectDelay { + // Should wait for delay + systemClock.WaitForNewPendingTaskWithTimeout(30 * time.Second) + require.Equal(t, 0, responder.PerformedActionCount(), "Should be waiting for delay") + + // Advance clock and complete + systemClock.AdvanceTime(test.responseDelay) + } + + // Wait for completion - using longer timeout for CI reliability + select { + case <-done: + // Expected completion + case <-time.After(30 * time.Second): + t.Fatal("Action did not complete - this indicates a test logic error") + } + wg.Wait() + + require.Equal(t, 1, responder.PerformedActionCount(), test.description) + }) + } +} + +// TestResponseDelayClockExtensionError tests error handling when clock extension detection fails +func TestResponseDelayClockExtensionError(t *testing.T) { + ctx := context.Background() + + // Set up agent with claimLoader that returns an error for clock extension + logger := testlog.Logger(t, log.LevelInfo) + claimLoader := &stubClaimLoader{ + clockExtensionErr: errors.New("failed to get clock extension"), + } + depth := types.Depth(4) + provider := alphabet.NewTraceProvider(big.NewInt(0), depth) + responder := &stubResponder{} + systemClock := clock.NewDeterministicClock(time.UnixMilli(120200)) + l1Clock := clock.NewDeterministicClock(time.UnixMilli(120200)) + + responseDelay := 2 * time.Hour + maxClockDuration := 10 * time.Minute // Use a reasonable default for error test + agent := NewAgent(metrics.NoopMetrics, systemClock, l1Clock, claimLoader, depth, maxClockDuration, trace.NewSimpleTraceAccessor(provider), responder, logger, false, []common.Address{}, responseDelay, 0) + + // Set up game state + claimBuilder := faulttest.NewClaimBuilder(t, depth, provider) + baseClaim := claimBuilder.CreateRootClaim() + claimLoader.claims = []types.Claim{baseClaim} + + action := types.Action{ + Type: types.ActionTypeMove, + ParentClaim: baseClaim, + IsAttack: true, + Value: common.Hash{0x01}, + } + + // Perform action - should still apply delay despite error + var wg sync.WaitGroup + wg.Add(1) + + done := make(chan struct{}) + go func() { + agent.performAction(ctx, &wg, createStubGame(claimLoader.claims), action) + close(done) + }() + + // Should complete without needing to advance clock (no delay applied for safety when extension detection fails) + select { + case <-done: + // Expected - immediate completion + case <-time.After(30 * time.Second): + t.Fatal("Action did not complete immediately when extension detection fails") + } + wg.Wait() + + require.Equal(t, 1, responder.PerformedActionCount(), "Should have performed action") } diff --git a/op-challenger/game/fault/contracts/detect.go b/op-challenger/game/fault/contracts/detect.go index 0e6e0b3641e..32c8b03ed90 100644 --- a/op-challenger/game/fault/contracts/detect.go +++ b/op-challenger/game/fault/contracts/detect.go @@ -31,12 +31,14 @@ func DetectGameType(ctx context.Context, addr common.Address, caller *batching.M switch gameType { case faultTypes.CannonGameType, faultTypes.PermissionedGameType, + faultTypes.CannonKonaGameType, faultTypes.AsteriscGameType, faultTypes.AlphabetGameType, faultTypes.FastGameType, faultTypes.AsteriscKonaGameType, faultTypes.SuperCannonGameType, faultTypes.SuperPermissionedGameType, + faultTypes.SuperCannonKonaGameType, faultTypes.SuperAsteriscKonaGameType: return gameType, nil default: diff --git a/op-challenger/game/fault/contracts/faultdisputegame.go b/op-challenger/game/fault/contracts/faultdisputegame.go index 4ae3c351c48..db904b05841 100644 --- a/op-challenger/game/fault/contracts/faultdisputegame.go +++ b/op-challenger/game/fault/contracts/faultdisputegame.go @@ -25,6 +25,7 @@ var maxChildChecks = big.NewInt(512) var ( methodMaxClockDuration = "maxClockDuration" + methodClockExtension = "clockExtension" methodMaxGameDepth = "maxGameDepth" methodAbsolutePrestate = "absolutePrestate" methodStatus = "status" @@ -80,7 +81,7 @@ func NewFaultDisputeGameContract(ctx context.Context, metrics metrics.ContractMe return nil, fmt.Errorf("failed to detect game type: %w", err) } switch gameType { - case types.SuperCannonGameType, types.SuperPermissionedGameType, types.SuperAsteriscKonaGameType: + case types.SuperCannonGameType, types.SuperCannonKonaGameType, types.SuperPermissionedGameType, types.SuperAsteriscKonaGameType: return NewSuperFaultDisputeGameContract(ctx, metrics, addr, caller) default: return NewPreInteropFaultDisputeGameContract(ctx, metrics, addr, caller) @@ -406,6 +407,15 @@ func (f *FaultDisputeGameContractLatest) GetMaxClockDuration(ctx context.Context return time.Duration(result.GetUint64(0)) * time.Second, nil } +func (f *FaultDisputeGameContractLatest) GetClockExtension(ctx context.Context) (time.Duration, error) { + defer f.metrics.StartContractRequest("GetClockExtension")() + result, err := f.multiCaller.SingleCall(ctx, rpcblock.Latest, f.contract.Call(methodClockExtension)) + if err != nil { + return 0, fmt.Errorf("failed to fetch clock extension: %w", err) + } + return time.Duration(result.GetUint64(0)) * time.Second, nil +} + func (f *FaultDisputeGameContractLatest) GetMaxGameDepth(ctx context.Context) (types.Depth, error) { defer f.metrics.StartContractRequest("GetMaxGameDepth")() result, err := f.multiCaller.SingleCall(ctx, rpcblock.Latest, f.contract.Call(methodMaxGameDepth)) @@ -647,6 +657,7 @@ type FaultDisputeGameContract interface { GetWithdrawals(ctx context.Context, block rpcblock.Block, recipients ...common.Address) ([]*WithdrawalRequest, error) GetOracle(ctx context.Context) (PreimageOracleContract, error) GetMaxClockDuration(ctx context.Context) (time.Duration, error) + GetClockExtension(ctx context.Context) (time.Duration, error) GetMaxGameDepth(ctx context.Context) (types.Depth, error) GetAbsolutePrestateHash(ctx context.Context) (common.Hash, error) GetL1Head(ctx context.Context) (common.Hash, error) diff --git a/op-challenger/game/fault/player.go b/op-challenger/game/fault/player.go index cdc07d2acef..7094696af2d 100644 --- a/op-challenger/game/fault/player.go +++ b/op-challenger/game/fault/player.go @@ -88,6 +88,8 @@ func NewGamePlayer( l1HeaderSource L1HeaderSource, selective bool, claimants []common.Address, + responseDelay time.Duration, + responseDelayAfter uint64, ) (*GamePlayer, error) { logger = logger.New("game", addr) @@ -150,7 +152,7 @@ func NewGamePlayer( return nil, fmt.Errorf("failed to create the responder: %w", err) } - agent := NewAgent(m, systemClock, l1Clock, loader, gameDepth, maxClockDuration, accessor, responder, logger, selective, claimants) + agent := NewAgent(m, systemClock, l1Clock, loader, gameDepth, maxClockDuration, accessor, responder, logger, selective, claimants, responseDelay, responseDelayAfter) return &GamePlayer{ act: agent.Act, loader: loader, diff --git a/op-challenger/game/fault/register.go b/op-challenger/game/fault/register.go index 68a4ad38ebd..94e0d7e91b9 100644 --- a/op-challenger/game/fault/register.go +++ b/op-challenger/game/fault/register.go @@ -67,6 +67,13 @@ func RegisterGameTypes( } registerTasks = append(registerTasks, NewCannonRegisterTask(faultTypes.CannonGameType, cfg, m, vm.NewOpProgramServerExecutor(logger), l2HeaderSource, rollupClient, syncValidator)) } + if cfg.TraceTypeEnabled(faultTypes.TraceTypeCannonKona) { + l2HeaderSource, rollupClient, syncValidator, err := clients.SingleChainClients() + if err != nil { + return nil, err + } + registerTasks = append(registerTasks, NewCannonKonaRegisterTask(faultTypes.CannonKonaGameType, cfg, m, vm.NewKonaExecutor(), l2HeaderSource, rollupClient, syncValidator)) + } if cfg.TraceTypeEnabled(faultTypes.TraceTypeSuperCannon) { rootProvider, syncValidator, err := clients.SuperchainClients() if err != nil { @@ -124,7 +131,7 @@ func RegisterGameTypes( registerTasks = append(registerTasks, NewAlphabetRegisterTask(faultTypes.AlphabetGameType, l2HeaderSource, rollupClient, syncValidator)) } for _, task := range registerTasks { - if err := task.Register(ctx, registry, oracles, systemClock, l1Clock, logger, m, txSender, gameFactory, caller, l1HeaderSource, selective, claimants); err != nil { + if err := task.Register(ctx, registry, oracles, systemClock, l1Clock, logger, m, txSender, gameFactory, caller, l1HeaderSource, selective, claimants, cfg.ResponseDelay, cfg.ResponseDelayAfter); err != nil { return clients.Close, fmt.Errorf("failed to register %v game type: %w", task.gameType, err) } } diff --git a/op-challenger/game/fault/register_task.go b/op-challenger/game/fault/register_task.go index e28e57189a9..d6d87bc1505 100644 --- a/op-challenger/game/fault/register_task.go +++ b/op-challenger/game/fault/register_task.go @@ -5,6 +5,7 @@ import ( "fmt" "net/url" "path/filepath" + "time" "github.com/ethereum-optimism/optimism/op-challenger/config" "github.com/ethereum-optimism/optimism/op-challenger/game/fault/claims" @@ -87,6 +88,25 @@ func NewSuperCannonRegisterTask(gameType faultTypes.GameType, cfg *config.Config } func NewCannonRegisterTask(gameType faultTypes.GameType, cfg *config.Config, m caching.Metrics, serverExecutor vm.OracleServerExecutor, l2Client utils.L2HeaderSource, rollupClient outputs.OutputRollupClient, syncValidator SyncValidator) *RegisterTask { + return newCannonVMRegisterTaskWithConfig(gameType, cfg, m, serverExecutor, l2Client, rollupClient, syncValidator, cfg.Cannon, cfg.CannonAbsolutePreStateBaseURL, cfg.CannonAbsolutePreState) +} + +func NewCannonKonaRegisterTask(gameType faultTypes.GameType, cfg *config.Config, m caching.Metrics, serverExecutor vm.OracleServerExecutor, l2Client utils.L2HeaderSource, rollupClient outputs.OutputRollupClient, syncValidator SyncValidator) *RegisterTask { + return newCannonVMRegisterTaskWithConfig(gameType, cfg, m, serverExecutor, l2Client, rollupClient, syncValidator, cfg.CannonKona, cfg.CannonKonaAbsolutePreStateBaseURL, cfg.CannonKonaAbsolutePreState) +} + +func newCannonVMRegisterTaskWithConfig( + gameType faultTypes.GameType, + cfg *config.Config, + m caching.Metrics, + serverExecutor vm.OracleServerExecutor, + l2Client utils.L2HeaderSource, + rollupClient outputs.OutputRollupClient, + syncValidator SyncValidator, + vmCfg vm.Config, + preStateBaseURL *url.URL, + preState string, +) *RegisterTask { stateConverter := cannon.NewStateConverter(cfg.Cannon) return &RegisterTask{ gameType: gameType, @@ -102,9 +122,9 @@ func NewCannonRegisterTask(gameType faultTypes.GameType, cfg *config.Config, m c gameType, stateConverter, m, - cfg.CannonAbsolutePreStateBaseURL, - cfg.CannonAbsolutePreState, - filepath.Join(cfg.Datadir, "cannon-prestates"), + preStateBaseURL, + preState, + filepath.Join(cfg.Datadir, vmCfg.VmType.String()+"-prestates"), func(ctx context.Context, path string) faultTypes.PrestateProvider { return vm.NewPrestateProvider(path, stateConverter) }), @@ -119,7 +139,7 @@ func NewCannonRegisterTask(gameType faultTypes.GameType, cfg *config.Config, m c prestateBlock uint64, poststateBlock uint64) (*trace.Accessor, error) { provider := vmPrestateProvider.(*vm.PrestateProvider) - return outputs.NewOutputCannonTraceAccessor(logger, m, cfg.Cannon, serverExecutor, l2Client, prestateProvider, provider.PrestatePath(), rollupClient, dir, l1Head, splitDepth, prestateBlock, poststateBlock) + return outputs.NewOutputCannonTraceAccessor(logger, m, vmCfg, serverExecutor, l2Client, prestateProvider, provider.PrestatePath(), rollupClient, dir, l1Head, splitDepth, prestateBlock, poststateBlock) }, } } @@ -287,7 +307,9 @@ func (e *RegisterTask) Register( caller *batching.MultiCaller, l1HeaderSource L1HeaderSource, selective bool, - claimants []common.Address) error { + claimants []common.Address, + responseDelay time.Duration, + responseDelayAfter uint64) error { playerCreator := func(game types.GameMetadata, dir string) (scheduler.GamePlayer, error) { contract, err := contracts.NewFaultDisputeGameContract(ctx, m, game.Proxy, caller) @@ -337,7 +359,7 @@ func (e *RegisterTask) Register( validators = append(validators, NewPrestateValidator(e.gameType.String(), contract.GetAbsolutePrestateHash, vmPrestateProvider)) validators = append(validators, NewPrestateValidator("output root", contract.GetStartingRootHash, prestateProvider)) } - return NewGamePlayer(ctx, systemClock, l1Clock, logger, m, dir, game.Proxy, txSender, contract, e.syncValidator, validators, creator, l1HeaderSource, selective, claimants) + return NewGamePlayer(ctx, systemClock, l1Clock, logger, m, dir, game.Proxy, txSender, contract, e.syncValidator, validators, creator, l1HeaderSource, selective, claimants, responseDelay, responseDelayAfter) } err := registerOracle(ctx, logger, m, oracles, gameFactory, caller, e.gameType) if err != nil { diff --git a/op-challenger/game/fault/trace/outputs/output_asterisc.go b/op-challenger/game/fault/trace/outputs/output_asterisc.go index fcd17a2661a..10822a5a9ae 100644 --- a/op-challenger/game/fault/trace/outputs/output_asterisc.go +++ b/op-challenger/game/fault/trace/outputs/output_asterisc.go @@ -45,7 +45,8 @@ func NewOutputAsteriscTraceAccessor( return provider, nil } - cache := NewProviderCache(m, "output_asterisc_provider", asteriscCreator) + metricsLabel := fmt.Sprintf("outputs_%s_provider", cfg.VmType.String()) + cache := NewProviderCache(m, metricsLabel, asteriscCreator) selector := split.NewSplitProviderSelector(outputProvider, splitDepth, OutputRootSplitAdapter(outputProvider, cache.GetOrCreate)) return trace.NewAccessor(selector), nil } diff --git a/op-challenger/game/fault/trace/outputs/output_cannon.go b/op-challenger/game/fault/trace/outputs/output_cannon.go index 861ac62ba98..a0679f8595b 100644 --- a/op-challenger/game/fault/trace/outputs/output_cannon.go +++ b/op-challenger/game/fault/trace/outputs/output_cannon.go @@ -4,6 +4,7 @@ import ( "context" "fmt" "path/filepath" + "strings" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/log" @@ -39,13 +40,13 @@ func NewOutputCannonTraceAccessor( subdir := filepath.Join(dir, localContext.Hex()) localInputs, err := utils.FetchLocalInputsFromProposals(ctx, l1Head.Hash, l2Client, agreed, claimed) if err != nil { - return nil, fmt.Errorf("failed to fetch cannon local inputs: %w", err) + return nil, fmt.Errorf("failed to fetch %s local inputs: %w", cfg.VmType, err) } provider := cannon.NewTraceProvider(logger, m.ToTypedVmMetrics(cfg.VmType.String()), cfg, serverExecutor, prestateProvider, cannonPrestate, localInputs, subdir, depth) return provider, nil } - cache := NewProviderCache(m, "output_cannon_provider", cannonCreator) + cache := NewProviderCache(m, fmt.Sprintf("output_%s_provider", strings.ReplaceAll(cfg.VmType.String(), "-", "_")), cannonCreator) selector := split.NewSplitProviderSelector(outputProvider, splitDepth, OutputRootSplitAdapter(outputProvider, cache.GetOrCreate)) return trace.NewAccessor(selector), nil } diff --git a/op-challenger/game/fault/trace/vm/executor.go b/op-challenger/game/fault/trace/vm/executor.go index c6339a6a723..d2047710e7e 100644 --- a/op-challenger/game/fault/trace/vm/executor.go +++ b/op-challenger/game/fault/trace/vm/executor.go @@ -200,6 +200,7 @@ func (e *Executor) DoGenerateProof(ctx context.Context, dir string, begin uint64 memoryUsed = fmt.Sprintf("%d", uint64(info.MemoryUsed)) e.metrics.RecordMemoryUsed(uint64(info.MemoryUsed)) e.metrics.RecordSteps(info.Steps) + e.metrics.RecordInstructionCacheMissCount(info.InstructionCacheMissCount) e.metrics.RecordRmwSuccessCount(info.RmwSuccessCount) e.metrics.RecordRmwFailCount(info.RmwFailCount) e.metrics.RecordMaxStepsBetweenLLAndSC(info.MaxStepsBetweenLLAndSC) @@ -215,6 +216,7 @@ func (e *Executor) DoGenerateProof(ctx context.Context, dir string, begin uint64 type debugInfo struct { MemoryUsed hexutil.Uint64 `json:"memory_used"` Steps uint64 `json:"total_steps"` + InstructionCacheMissCount uint64 `json:"instruction_cache_miss_count"` RmwSuccessCount uint64 `json:"rmw_success_count"` RmwFailCount uint64 `json:"rmw_fail_count"` MaxStepsBetweenLLAndSC uint64 `json:"max_steps_between_ll_and_sc"` diff --git a/op-challenger/game/fault/trace/vm/executor_test.go b/op-challenger/game/fault/trace/vm/executor_test.go index ba6c4f8a269..55b7ab24037 100644 --- a/op-challenger/game/fault/trace/vm/executor_test.go +++ b/op-challenger/game/fault/trace/vm/executor_test.go @@ -229,21 +229,26 @@ func newMetrics() *capturingVmMetrics { } type capturingVmMetrics struct { - executionTimeRecordCount int - memoryUsed hexutil.Uint64 - steps uint64 - rmwSuccessCount uint64 - rmwFailCount uint64 - maxStepsBetweenLLAndSC uint64 - reservationInvalidations uint64 - forcedPreemptions uint64 - idleStepsThread0 uint64 + executionTimeRecordCount int + memoryUsed hexutil.Uint64 + steps uint64 + instructionCacheMissCount uint64 + rmwSuccessCount uint64 + rmwFailCount uint64 + maxStepsBetweenLLAndSC uint64 + reservationInvalidations uint64 + forcedPreemptions uint64 + idleStepsThread0 uint64 } func (c *capturingVmMetrics) RecordSteps(val uint64) { c.steps = val } +func (c *capturingVmMetrics) RecordInstructionCacheMissCount(val uint64) { + c.instructionCacheMissCount = val +} + func (c *capturingVmMetrics) RecordExecutionTime(t time.Duration) { c.executionTimeRecordCount += 1 } diff --git a/op-challenger/game/fault/trace/vm/kona_server_executor.go b/op-challenger/game/fault/trace/vm/kona_server_executor.go index 8f1e9b60872..ffb0b766786 100644 --- a/op-challenger/game/fault/trace/vm/kona_server_executor.go +++ b/op-challenger/game/fault/trace/vm/kona_server_executor.go @@ -33,10 +33,10 @@ func (s *KonaExecutor) OracleCommand(cfg Config, dataDir string, inputs utils.Lo "--l1-beacon-address", cfg.L1Beacon, "--l2-node-address", cfg.L2s[0], "--l1-head", inputs.L1Head.Hex(), - "--l2-head", inputs.L2Head.Hex(), - "--l2-output-root", inputs.L2OutputRoot.Hex(), - "--l2-claim", inputs.L2Claim.Hex(), - "--l2-block-number", inputs.L2SequenceNumber.Text(10), + "--agreed-l2-head-hash", inputs.L2Head.Hex(), + "--agreed-l2-output-root", inputs.L2OutputRoot.Hex(), + "--claimed-l2-output-root", inputs.L2Claim.Hex(), + "--claimed-l2-block-number", inputs.L2SequenceNumber.Text(10), } if s.nativeMode { diff --git a/op-challenger/game/fault/trace/vm/kona_server_executor_test.go b/op-challenger/game/fault/trace/vm/kona_server_executor_test.go index 05413d8f4e0..f1037c73cc0 100644 --- a/op-challenger/game/fault/trace/vm/kona_server_executor_test.go +++ b/op-challenger/game/fault/trace/vm/kona_server_executor_test.go @@ -39,8 +39,8 @@ func TestKonaFillHostCommand(t *testing.T) { require.True(t, slices.Contains(args, "--data-dir")) require.True(t, slices.Contains(args, "--l2-chain-id")) require.True(t, slices.Contains(args, "--l1-head")) - require.True(t, slices.Contains(args, "--l2-head")) - require.True(t, slices.Contains(args, "--l2-output-root")) - require.True(t, slices.Contains(args, "--l2-claim")) - require.True(t, slices.Contains(args, "--l2-block-number")) + require.True(t, slices.Contains(args, "--agreed-l2-head-hash")) + require.True(t, slices.Contains(args, "--agreed-l2-output-root")) + require.True(t, slices.Contains(args, "--claimed-l2-output-root")) + require.True(t, slices.Contains(args, "--claimed-l2-block-number")) } diff --git a/op-challenger/game/fault/types/types.go b/op-challenger/game/fault/types/types.go index 66847cdf87f..a76e881e310 100644 --- a/op-challenger/game/fault/types/types.go +++ b/op-challenger/game/fault/types/types.go @@ -35,6 +35,8 @@ const ( SuperPermissionedGameType GameType = 5 OPSuccinctGameType GameType = 6 SuperAsteriscKonaGameType GameType = 7 + CannonKonaGameType GameType = 8 + SuperCannonKonaGameType GameType = 9 FastGameType GameType = 254 AlphabetGameType GameType = 255 KailuaGameType GameType = 1337 @@ -63,6 +65,10 @@ func (t GameType) String() string { return "op-succinct" case SuperAsteriscKonaGameType: return "super-asterisc-kona" + case CannonKonaGameType: + return "cannon-kona" + case SuperCannonKonaGameType: + return "super-cannon-kona" case FastGameType: return "fast" case AlphabetGameType: @@ -80,6 +86,7 @@ const ( TraceTypeAlphabet TraceType = "alphabet" TraceTypeFast TraceType = "fast" TraceTypeCannon TraceType = "cannon" + TraceTypeCannonKona TraceType = "cannon-kona" TraceTypeAsterisc TraceType = "asterisc" TraceTypeAsteriscKona TraceType = "asterisc-kona" TraceTypePermissioned TraceType = "permissioned" @@ -88,7 +95,7 @@ const ( TraceTypeSuperAsteriscKona TraceType = "super-asterisc-kona" ) -var TraceTypes = []TraceType{TraceTypeAlphabet, TraceTypeCannon, TraceTypePermissioned, TraceTypeAsterisc, TraceTypeAsteriscKona, TraceTypeFast, TraceTypeSuperCannon, TraceTypeSuperPermissioned, TraceTypeSuperAsteriscKona} +var TraceTypes = []TraceType{TraceTypeAlphabet, TraceTypeCannon, TraceTypeCannonKona, TraceTypePermissioned, TraceTypeAsterisc, TraceTypeAsteriscKona, TraceTypeFast, TraceTypeSuperCannon, TraceTypeSuperPermissioned, TraceTypeSuperAsteriscKona} func (t TraceType) String() string { return string(t) @@ -116,6 +123,8 @@ func (t TraceType) GameType() GameType { switch t { case TraceTypeCannon: return CannonGameType + case TraceTypeCannonKona: + return CannonKonaGameType case TraceTypePermissioned: return PermissionedGameType case TraceTypeAsterisc: diff --git a/op-challenger/game/monitor.go b/op-challenger/game/monitor.go index 326d099da38..afcca6fa646 100644 --- a/op-challenger/game/monitor.go +++ b/op-challenger/game/monitor.go @@ -42,17 +42,19 @@ type claimer interface { } type gameMonitor struct { - logger log.Logger - clock RWClock - source gameSource - scheduler gameScheduler - preimages preimageScheduler - gameWindow time.Duration - claimer claimer - allowedGames []common.Address - l1HeadsSub ethereum.Subscription - l1Source *headSource - runState sync.Mutex + logger log.Logger + clock RWClock + source gameSource + scheduler gameScheduler + preimages preimageScheduler + gameWindow time.Duration + claimer claimer + allowedGames []common.Address + l1HeadsSub ethereum.Subscription + l1Source *headSource + runState sync.Mutex + minUpdatePeriod time.Duration + lastUpdateBlockTime time.Time } type MinimalSubscriber interface { @@ -77,17 +79,19 @@ func newGameMonitor( claimer claimer, allowedGames []common.Address, l1Source MinimalSubscriber, + minUpdatePeriodSeconds time.Duration, ) *gameMonitor { return &gameMonitor{ - logger: logger, - clock: cl, - scheduler: scheduler, - preimages: preimages, - source: source, - gameWindow: gameWindow, - claimer: claimer, - allowedGames: allowedGames, - l1Source: &headSource{inner: l1Source}, + logger: logger, + clock: cl, + scheduler: scheduler, + preimages: preimages, + source: source, + gameWindow: gameWindow, + claimer: claimer, + allowedGames: allowedGames, + l1Source: &headSource{inner: l1Source}, + minUpdatePeriod: minUpdatePeriodSeconds, } } @@ -128,12 +132,17 @@ func (m *gameMonitor) progressGames(ctx context.Context, blockHash common.Hash, return nil } -func (m *gameMonitor) onNewL1Head(ctx context.Context, sig eth.L1BlockRef) { - m.clock.SetTime(sig.Time) - if err := m.progressGames(ctx, sig.Hash, sig.Number); err != nil { +func (m *gameMonitor) onNewL1Head(ctx context.Context, block eth.L1BlockRef) { + m.clock.SetTime(block.Time) + blockTime := time.Unix(int64(block.Time), 0) + if m.lastUpdateBlockTime.Add(m.minUpdatePeriod).After(blockTime) { + return + } + m.lastUpdateBlockTime = blockTime + if err := m.progressGames(ctx, block.Hash, block.Number); err != nil { m.logger.Error("Failed to progress games", "err", err) } - if err := m.preimages.Schedule(sig.Hash, sig.Number); err != nil { + if err := m.preimages.Schedule(block.Hash, block.Number); err != nil { m.logger.Error("Failed to validate large preimages", "err", err) } } diff --git a/op-challenger/game/monitor_test.go b/op-challenger/game/monitor_test.go index ff37430865c..35b0dd98ae3 100644 --- a/op-challenger/game/monitor_test.go +++ b/op-challenger/game/monitor_test.go @@ -9,6 +9,7 @@ import ( "time" "github.com/ethereum-optimism/optimism/op-challenger/game/types" + "github.com/ethereum-optimism/optimism/op-service/eth" "github.com/ethereum-optimism/optimism/op-service/testlog" "github.com/ethereum/go-ethereum" "github.com/ethereum/go-ethereum/common" @@ -26,7 +27,7 @@ func TestMonitorGames(t *testing.T) { t.Run("Schedules games", func(t *testing.T) { addr1 := common.Address{0xaa} addr2 := common.Address{0xbb} - monitor, source, sched, mockHeadSource, preimages, _ := setupMonitorTest(t, []common.Address{}) + monitor, source, sched, mockHeadSource, preimages, _ := setupMonitorTest(t, []common.Address{}, 0) source.games = []types.GameMetadata{newFDG(addr1, 9999), newFDG(addr2, 9999)} ctx, cancel := context.WithCancel(context.Background()) @@ -71,7 +72,7 @@ func TestMonitorGames(t *testing.T) { t.Run("Resubscribes on error", func(t *testing.T) { addr1 := common.Address{0xaa} addr2 := common.Address{0xbb} - monitor, source, sched, mockHeadSource, preimages, _ := setupMonitorTest(t, []common.Address{}) + monitor, source, sched, mockHeadSource, preimages, _ := setupMonitorTest(t, []common.Address{}, 0) source.games = []types.GameMetadata{newFDG(addr1, 9999), newFDG(addr2, 9999)} ctx, cancel := context.WithCancel(context.Background()) @@ -117,7 +118,7 @@ func TestMonitorGames(t *testing.T) { } func TestMonitorCreateAndProgressGameAgents(t *testing.T) { - monitor, source, sched, _, _, _ := setupMonitorTest(t, []common.Address{}) + monitor, source, sched, _, _, _ := setupMonitorTest(t, []common.Address{}, 0) addr1 := common.Address{0xaa} addr2 := common.Address{0xbb} @@ -132,7 +133,7 @@ func TestMonitorCreateAndProgressGameAgents(t *testing.T) { func TestMonitorOnlyScheduleSpecifiedGame(t *testing.T) { addr1 := common.Address{0xaa} addr2 := common.Address{0xbb} - monitor, source, sched, _, _, stubClaimer := setupMonitorTest(t, []common.Address{addr2}) + monitor, source, sched, _, _, stubClaimer := setupMonitorTest(t, []common.Address{addr2}, 0) source.games = []types.GameMetadata{newFDG(addr1, 9999), newFDG(addr2, 9999)} require.NoError(t, monitor.progressGames(context.Background(), common.Hash{0x01}, 0)) @@ -142,6 +143,58 @@ func TestMonitorOnlyScheduleSpecifiedGame(t *testing.T) { require.Equal(t, 1, stubClaimer.scheduledGames) } +func TestMinUpdatePeriod(t *testing.T) { + tests := []struct { + name string + minUpdatePeriodSeconds int64 + processBlock2 bool + processBlock3 bool + }{ + {name: "ZeroUpdatePeriod", minUpdatePeriodSeconds: 0, processBlock2: true, processBlock3: true}, + {name: "SmallUpdatePeriod", minUpdatePeriodSeconds: 1, processBlock2: true, processBlock3: true}, + {name: "SkipBlockUpdatePeriod", minUpdatePeriodSeconds: 1000, processBlock2: false, processBlock3: true}, + {name: "LongUpdatePeriod", minUpdatePeriodSeconds: 1000000, processBlock2: false, processBlock3: false}, + } + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + block1 := eth.L1BlockRef{ + Hash: common.HexToHash("0x1"), + Number: 1, + Time: 1_000_000, + } + block2 := eth.L1BlockRef{ + Hash: common.HexToHash("0x2"), + Number: 2, + Time: 1_000_500, + } + block3 := eth.L1BlockRef{ + Hash: common.HexToHash("0x2"), + Number: 2, + Time: 1_001_000, + } + addr1 := common.Address{0xaa} + addr2 := common.Address{0xbb} + monitor, source, sched, _, _, _ := setupMonitorTest(t, []common.Address{addr2}, test.minUpdatePeriodSeconds) + source.games = []types.GameMetadata{newFDG(addr1, 9999), newFDG(addr2, 9999)} + monitor.onNewL1Head(context.Background(), block1) + expectedScheduleCount := 1 + require.Len(t, sched.Scheduled(), expectedScheduleCount, "Should schedule update on first new block") + + monitor.onNewL1Head(context.Background(), block2) + if test.processBlock2 { + expectedScheduleCount++ + } + require.Len(t, sched.Scheduled(), expectedScheduleCount, "Should not schedule update prior to min update period being reached") + + monitor.onNewL1Head(context.Background(), block3) + if test.processBlock3 { + expectedScheduleCount++ + } + require.Len(t, sched.Scheduled(), expectedScheduleCount, "Should schedule update once min update period is reached") + }) + } +} + func newFDG(proxy common.Address, timestamp uint64) types.GameMetadata { return types.GameMetadata{ Proxy: proxy, @@ -152,6 +205,7 @@ func newFDG(proxy common.Address, timestamp uint64) types.GameMetadata { func setupMonitorTest( t *testing.T, allowedGames []common.Address, + minUpdatePeriodSeconds int64, ) (*gameMonitor, *stubGameSource, *stubScheduler, *mockNewHeadSource, *stubPreimageScheduler, *mockScheduler) { logger := testlog.Logger(t, log.LevelDebug) source := &stubGameSource{} @@ -169,6 +223,7 @@ func setupMonitorTest( stubClaimer, allowedGames, mockHeadSource, + time.Duration(minUpdatePeriodSeconds)*time.Second, ) return monitor, source, sched, mockHeadSource, preimages, stubClaimer } diff --git a/op-challenger/game/service.go b/op-challenger/game/service.go index bbeeb5694b9..ae3c1b69104 100644 --- a/op-challenger/game/service.go +++ b/op-challenger/game/service.go @@ -234,7 +234,7 @@ func (s *Service) initLargePreimages() error { } func (s *Service) initMonitor(cfg *config.Config) { - s.monitor = newGameMonitor(s.logger, s.l1Clock, s.factoryContract, s.sched, s.preimages, cfg.GameWindow, s.claimer, cfg.GameAllowlist, s.pollClient) + s.monitor = newGameMonitor(s.logger, s.l1Clock, s.factoryContract, s.sched, s.preimages, cfg.GameWindow, s.claimer, cfg.GameAllowlist, s.pollClient, cfg.MinUpdateInterval) } func (s *Service) Start(ctx context.Context) error { diff --git a/op-challenger/metrics/vm.go b/op-challenger/metrics/vm.go index 132bd9e713e..a3fa1cee9fa 100644 --- a/op-challenger/metrics/vm.go +++ b/op-challenger/metrics/vm.go @@ -13,6 +13,7 @@ type VmMetricer interface { RecordVmMemoryUsed(vmType string, memoryUsed uint64) RecordVmRmwSuccessCount(vmType string, val uint64) RecordVmSteps(vmType string, val uint64) + RecordVmInstructionCacheMissCount(vmType string, val uint64) RecordVmRmwFailCount(vmType string, val uint64) RecordVmMaxStepsBetweenLLAndSC(vmType string, val uint64) RecordVmReservationInvalidationCount(vmType string, val uint64) @@ -25,6 +26,7 @@ type TypedVmMetricer interface { RecordExecutionTime(t time.Duration) RecordMemoryUsed(memoryUsed uint64) RecordSteps(val uint64) + RecordInstructionCacheMissCount(val uint64) RecordRmwSuccessCount(val uint64) RecordRmwFailCount(val uint64) RecordMaxStepsBetweenLLAndSC(val uint64) @@ -34,15 +36,16 @@ type TypedVmMetricer interface { } type VmMetrics struct { - vmExecutionTime *prometheus.HistogramVec - vmMemoryUsed *prometheus.HistogramVec - vmSteps *prometheus.GaugeVec - vmRmwSuccessCount *prometheus.GaugeVec - vmRmwFailCount *prometheus.GaugeVec - vmMaxStepsBetweenLLAndSC *prometheus.GaugeVec - vmReservationInvalidations *prometheus.GaugeVec - vmForcedPreemptions *prometheus.GaugeVec - vmIdleStepsThread0 *prometheus.GaugeVec + vmExecutionTime *prometheus.HistogramVec + vmMemoryUsed *prometheus.HistogramVec + vmSteps *prometheus.GaugeVec + vmInstructionCacheMissCount *prometheus.GaugeVec + vmRmwSuccessCount *prometheus.GaugeVec + vmRmwFailCount *prometheus.GaugeVec + vmMaxStepsBetweenLLAndSC *prometheus.GaugeVec + vmReservationInvalidations *prometheus.GaugeVec + vmForcedPreemptions *prometheus.GaugeVec + vmIdleStepsThread0 *prometheus.GaugeVec } var _ VmMetricer = (*VmMetrics)(nil) @@ -59,6 +62,10 @@ func (m *VmMetrics) RecordVmSteps(vmType string, val uint64) { m.vmSteps.WithLabelValues(vmType).Set(float64(val)) } +func (m *VmMetrics) RecordVmInstructionCacheMissCount(vmType string, val uint64) { + m.vmInstructionCacheMissCount.WithLabelValues(vmType).Set(float64(val)) +} + func (m *VmMetrics) RecordVmRmwSuccessCount(vmType string, val uint64) { m.vmRmwSuccessCount.WithLabelValues(vmType).Set(float64(val)) } @@ -105,6 +112,11 @@ func NewVmMetrics(namespace string, factory metrics.Factory) *VmMetrics { Name: "vm_step_count", Help: "Number of steps executed during vm run", }, []string{"vm"}), + vmInstructionCacheMissCount: factory.NewGaugeVec(prometheus.GaugeOpts{ + Namespace: namespace, + Name: "vm_instruction_cache_miss_count", + Help: "Number of instructions cache missed during vm run", + }, []string{"vm"}), vmRmwSuccessCount: factory.NewGaugeVec(prometheus.GaugeOpts{ Namespace: namespace, Name: "vm_rmw_success_count", @@ -145,6 +157,7 @@ var _ VmMetricer = NoopVmMetrics{} func (n NoopVmMetrics) RecordVmExecutionTime(vmType string, t time.Duration) {} func (n NoopVmMetrics) RecordVmMemoryUsed(vmType string, memoryUsed uint64) {} func (n NoopVmMetrics) RecordVmSteps(vmType string, val uint64) {} +func (n NoopVmMetrics) RecordVmInstructionCacheMissCount(vmType string, val uint64) {} func (n NoopVmMetrics) RecordVmRmwSuccessCount(vmType string, val uint64) {} func (n NoopVmMetrics) RecordVmRmwFailCount(vmType string, val uint64) {} func (n NoopVmMetrics) RecordVmMaxStepsBetweenLLAndSC(vmType string, val uint64) {} @@ -171,6 +184,10 @@ func (m *typedVmMetricsImpl) RecordSteps(val uint64) { m.m.RecordVmSteps(m.vmType, val) } +func (m *typedVmMetricsImpl) RecordInstructionCacheMissCount(val uint64) { + m.m.RecordVmInstructionCacheMissCount(m.vmType, val) +} + func (m *typedVmMetricsImpl) RecordRmwSuccessCount(val uint64) { m.m.RecordVmRmwSuccessCount(m.vmType, val) } diff --git a/op-challenger/runner/factory.go b/op-challenger/runner/factory.go index 8c059867cdb..218dadfd7a3 100644 --- a/op-challenger/runner/factory.go +++ b/op-challenger/runner/factory.go @@ -38,6 +38,15 @@ func createTraceProvider( } prestateProvider := vm.NewPrestateProvider(prestate, stateConverter) return cannon.NewTraceProvider(logger, m, cfg.Cannon, serverExecutor, prestateProvider, prestate, localInputs, dir, 42), nil + case types.TraceTypeCannonKona: + serverExecutor := vm.NewKonaExecutor() + stateConverter := cannon.NewStateConverter(cfg.CannonKona) + prestate, err := prestateSource.getPrestate(ctx, logger, cfg.CannonKonaAbsolutePreStateBaseURL, cfg.CannonKonaAbsolutePreState, dir, stateConverter) + if err != nil { + return nil, err + } + prestateProvider := vm.NewPrestateProvider(prestate, stateConverter) + return cannon.NewTraceProvider(logger, m, cfg.CannonKona, serverExecutor, prestateProvider, prestate, localInputs, dir, 42), nil case types.TraceTypeAsterisc: serverExecutor := vm.NewOpProgramServerExecutor(logger) stateConverter := asterisc.NewStateConverter(cfg.Asterisc) diff --git a/op-challenger/runner/game_inputs.go b/op-challenger/runner/game_inputs.go index 90f417ac413..6a812ad6d37 100644 --- a/op-challenger/runner/game_inputs.go +++ b/op-challenger/runner/game_inputs.go @@ -37,9 +37,6 @@ func createGameInputsSingle(ctx context.Context, log log.Logger, client *sources } log.Info("Got sync status", "status", status, "type", typeName) - if status.FinalizedL2.Number == 0 { - return utils.LocalGameInputs{}, errors.New("safe head is 0") - } l1Head := status.FinalizedL1 if status.FinalizedL1.Number > status.CurrentL1.Number { // Restrict the L1 head to a block that has actually been processed by op-node. @@ -56,7 +53,7 @@ func createGameInputsSingle(ctx context.Context, log log.Logger, client *sources if l1Head.Number == 0 { return utils.LocalGameInputs{}, errors.New("l1 head is 0") } - blockNumber, err := findL2BlockNumberToDispute(ctx, log, client, l1Head.Number, status.FinalizedL2.Number) + blockNumber, err := findL2BlockNumberToDispute(ctx, log, client, l1Head.Number) if err != nil { return utils.LocalGameInputs{}, fmt.Errorf("failed to find l2 block number to dispute: %w", err) } @@ -144,45 +141,45 @@ func createGameInputsInterop(ctx context.Context, log log.Logger, client *source return localInputs, nil } -func findL2BlockNumberToDispute(ctx context.Context, log log.Logger, client *sources.RollupClient, l1HeadNum uint64, l2BlockNum uint64) (uint64, error) { - // Try to find a L1 block prior to the batch that make l2BlockNum safe +// findL2BlockNumberToDispute finds a safe l2 block number at different positions in a span batch +func findL2BlockNumberToDispute(ctx context.Context, log log.Logger, client *sources.RollupClient, l1HeadNum uint64) (uint64, error) { + safeHead, err := client.SafeHeadAtL1Block(ctx, l1HeadNum) + if err != nil { + return 0, fmt.Errorf("failed to find safe head from l1 head %v: %w", l1HeadNum, err) + } + maxL2BlockNum := safeHead.SafeHead.Number + + // Find a prior span batch boundary // Limits how far back we search to 10 * 32 blocks const skipSize = uint64(32) for i := 0; i < 10; i++ { if l1HeadNum < skipSize { // Too close to genesis, give up and just use the original block log.Info("Failed to find prior batch.") - return l2BlockNum, nil + return maxL2BlockNum, nil } l1HeadNum -= skipSize prevSafeHead, err := client.SafeHeadAtL1Block(ctx, l1HeadNum) if err != nil { return 0, fmt.Errorf("failed to get prior safe head at L1 block %v: %w", l1HeadNum, err) } - if prevSafeHead.SafeHead.Number < l2BlockNum { + if prevSafeHead.SafeHead.Number < maxL2BlockNum { switch rand.IntN(3) { - case 0: // First block of span batch + case 0: // First block of span batch after prevSafeHead return prevSafeHead.SafeHead.Number + 1, nil - case 1: // Last block of span batch + case 1: // Last block of span batch ending at prevSafeHead return prevSafeHead.SafeHead.Number, nil case 2: // Random block, probably but not guaranteed to be in the middle of a span batch firstBlockInSpanBatch := prevSafeHead.SafeHead.Number + 1 - if l2BlockNum <= firstBlockInSpanBatch { + if maxL2BlockNum <= firstBlockInSpanBatch { // There is only one block in the next batch so we just have to use it - return l2BlockNum, nil + return maxL2BlockNum, nil } - offset := rand.IntN(int(l2BlockNum - firstBlockInSpanBatch)) + offset := rand.IntN(int(maxL2BlockNum - firstBlockInSpanBatch)) return firstBlockInSpanBatch + uint64(offset), nil } - - } - if prevSafeHead.SafeHead.Number < l2BlockNum { - // We walked back far enough to be before the batch that included l2BlockNum - // So use the first block after the prior safe head as the disputed block. - // It must be the first block in a batch. - return prevSafeHead.SafeHead.Number + 1, nil } } - log.Warn("Failed to find prior batch", "l2BlockNum", l2BlockNum, "earliestCheckL1Block", l1HeadNum) - return l2BlockNum, nil + log.Warn("Failed to find prior batch", "l2BlockNum", maxL2BlockNum, "earliestCheckL1Block", l1HeadNum) + return maxL2BlockNum, nil } diff --git a/op-challenger/runner/metrics.go b/op-challenger/runner/metrics.go index 921bdc8d023..8aa7494fa2c 100644 --- a/op-challenger/runner/metrics.go +++ b/op-challenger/runner/metrics.go @@ -20,13 +20,14 @@ type Metrics struct { *metrics.VmMetrics opmetrics.RPCMetrics - up prometheus.Gauge - vmLastExecutionTime *prometheus.GaugeVec - vmLastMemoryUsed *prometheus.GaugeVec - successTotal *prometheus.CounterVec - failuresTotal *prometheus.CounterVec - panicsTotal *prometheus.CounterVec - invalidTotal *prometheus.CounterVec + up prometheus.Gauge + vmLastExecutionTime *prometheus.GaugeVec + vmLastMemoryUsed *prometheus.GaugeVec + successTotal *prometheus.CounterVec + failuresTotal *prometheus.CounterVec + consecutiveFailuresCurrent *prometheus.GaugeVec + panicsTotal *prometheus.CounterVec + invalidTotal *prometheus.CounterVec } var _ Metricer = (*Metrics)(nil) @@ -72,6 +73,11 @@ func NewMetrics(runConfigs []RunConfig) *Metrics { Name: "failures_total", Help: "Number of failures to execute a VM", }, []string{"type"}), + consecutiveFailuresCurrent: factory.NewGaugeVec(prometheus.GaugeOpts{ + Namespace: Namespace, + Name: "consecutive_failures_current", + Help: "Number of consecutive setup failures by VM type. Resets to 0 on any complete run.", + }, []string{"type"}), panicsTotal: factory.NewCounterVec(prometheus.CounterOpts{ Namespace: Namespace, Name: "panics_total", @@ -87,6 +93,7 @@ func NewMetrics(runConfigs []RunConfig) *Metrics { for _, runConfig := range runConfigs { metrics.successTotal.WithLabelValues(runConfig.Name).Add(0) metrics.failuresTotal.WithLabelValues(runConfig.Name).Add(0) + metrics.consecutiveFailuresCurrent.WithLabelValues(runConfig.Name).Set(0) metrics.panicsTotal.WithLabelValues(runConfig.Name).Add(0) metrics.invalidTotal.WithLabelValues(runConfig.Name).Add(0) metrics.RecordUp() @@ -116,16 +123,22 @@ func (m *Metrics) RecordVmMemoryUsed(vmType string, memoryUsed uint64) { func (m *Metrics) RecordSuccess(vmType string) { m.successTotal.WithLabelValues(vmType).Inc() + m.consecutiveFailuresCurrent.WithLabelValues(vmType).Set(0) } func (m *Metrics) RecordFailure(vmType string) { m.failuresTotal.WithLabelValues(vmType).Inc() + m.consecutiveFailuresCurrent.WithLabelValues(vmType).Inc() } func (m *Metrics) RecordPanic(vmType string) { m.panicsTotal.WithLabelValues(vmType).Inc() + // The result was bad, but we still completed setup successfully + m.consecutiveFailuresCurrent.WithLabelValues(vmType).Set(0) } func (m *Metrics) RecordInvalid(vmType string) { m.invalidTotal.WithLabelValues(vmType).Inc() + // The result was bad, but we still completed setup successfully + m.consecutiveFailuresCurrent.WithLabelValues(vmType).Set(0) } diff --git a/op-conductor/client/el.go b/op-conductor/client/el.go index 5245b93c6f3..f836f3c3c60 100644 --- a/op-conductor/client/el.go +++ b/op-conductor/client/el.go @@ -3,9 +3,9 @@ package client import ( "context" - "github.com/ethereum-optimism/optimism/op-node/p2p" "github.com/ethereum/go-ethereum/common/hexutil" "github.com/ethereum/go-ethereum/ethclient" + "github.com/ethereum/go-ethereum/p2p" ) type ElP2PClient interface { diff --git a/op-conductor/conductor/config.go b/op-conductor/conductor/config.go index 5525279157d..b41aed34a72 100644 --- a/op-conductor/conductor/config.go +++ b/op-conductor/conductor/config.go @@ -150,6 +150,10 @@ func NewConfig(ctx *cli.Context, log log.Logger) (*Config, error) { if executionP2pRpcUrl == "" { executionP2pRpcUrl = ctx.String(flags.ExecutionRPC.Name) } + executionP2pCheckApi := ctx.String(flags.HealthcheckExecutionP2pCheckApi.Name) + if executionP2pCheckApi == "" { + executionP2pCheckApi = "net" + } return &Config{ ConsensusAddr: ctx.String(flags.ConsensusAddr.Name), @@ -180,6 +184,7 @@ func NewConfig(ctx *cli.Context, log log.Logger) (*Config, error) { ExecutionP2pEnabled: ctx.Bool(flags.HealthcheckExecutionP2pEnabled.Name), ExecutionP2pMinPeerCount: ctx.Uint64(flags.HealthcheckExecutionP2pMinPeerCount.Name), ExecutionP2pRPCUrl: executionP2pRpcUrl, + ExecutionP2pCheckApi: executionP2pCheckApi, }, RollupCfg: *rollupCfg, RPCEnableProxy: ctx.Bool(flags.RPCEnableProxy.Name), @@ -215,6 +220,9 @@ type HealthCheckConfig struct { // ExecutionP2pRPC is the HTTP provider URL for EL P2P. ExecutionP2pRPCUrl string + // ExecutionP2pCheckApi is the API to use for EL P2P checks. + ExecutionP2pCheckApi string + // ExecutionP2pMinPeerCount is the minimum number of EL P2P peers required for the sequencer to be healthy. ExecutionP2pMinPeerCount uint64 } @@ -236,6 +244,12 @@ func (c *HealthCheckConfig) Check() error { if c.ExecutionP2pRPCUrl == "" { return fmt.Errorf("missing el p2p rpc") } + if c.ExecutionP2pCheckApi == "" { + return fmt.Errorf("missing el p2p check api") + } + if c.ExecutionP2pCheckApi != "net" && c.ExecutionP2pCheckApi != "admin" { + return fmt.Errorf("invalid el p2p check api") + } } return nil } diff --git a/op-conductor/conductor/service.go b/op-conductor/conductor/service.go index aba910cfbe3..e8e2ef3d35b 100644 --- a/op-conductor/conductor/service.go +++ b/op-conductor/conductor/service.go @@ -226,7 +226,14 @@ func (c *OpConductor) initHealthMonitor(ctx context.Context) error { if err != nil { return errors.Wrap(err, "failed to create execution rpc client out of the el p2p rpc url: "+c.cfg.HealthCheck.ExecutionP2pRPCUrl) } - elP2p = client.NewElP2PClientAdmin(execClient) + switch c.cfg.HealthCheck.ExecutionP2pCheckApi { + case "net": + elP2p = client.NewElP2PClientNet(execClient) + case "admin": + elP2p = client.NewElP2PClientAdmin(execClient) + default: + return errors.New("invalid el p2p check api") + } } else { elP2p = nil } @@ -751,10 +758,8 @@ func (oc *OpConductor) action() { case status.leader && !status.healthy && status.active: // There are two scenarios we need to handle here: // 1. we're transitioned from case status.leader && !status.healthy && !status.active, see description above - // then we should continue to sequence blocks and try to bring ourselves back to healthy state. - // note: we need to also make sure that the health error is not due to ErrSequencerConnectionDown - // because in this case, we should stop sequencing and transfer leadership to other nodes. - if oc.prevState.leader && !oc.prevState.healthy && !oc.prevState.active && !errors.Is(oc.hcerr, health.ErrSequencerConnectionDown) { + // then we should continue to sequence blocks and try to bring ourselves back to healthy state (if possible) + if oc.shouldWaitForHealthRecovery() { err = errors.New("waiting for sequencing to become healthy by itself") break } @@ -936,3 +941,24 @@ func (oc *OpConductor) updateSequencerActiveStatus() error { oc.seqActive.Store(active) return nil } + +// shouldWaitForHealthRecovery determines if the conductor should wait for the sequencer +// to recover health naturally instead of transferring leadership. +func (oc *OpConductor) shouldWaitForHealthRecovery() bool { + // Only wait for recovery if we transitioned from [leader, unhealthy, inactive] state + if !oc.prevState.leader || oc.prevState.healthy || oc.prevState.active { + return false + } + + // Don't wait if the error is a connection issue - transfer leadership instead + if errors.Is(oc.hcerr, health.ErrSequencerConnectionDown) { + return false + } + + // Don't wait if rollup boost is enabled and partially healthy - transfer leadership instead + if oc.cfg.RollupBoostEnabled && errors.Is(oc.hcerr, health.ErrRollupBoostPartiallyHealthy) { + return false + } + + return true +} diff --git a/op-conductor/conductor/service_test.go b/op-conductor/conductor/service_test.go index e64474eecb0..d42289d08d4 100644 --- a/op-conductor/conductor/service_test.go +++ b/op-conductor/conductor/service_test.go @@ -1183,3 +1183,43 @@ connected: // Verify that the conductor is stopped s.True(conductor.Stopped()) } + +// TestRollupBoostPartialFailure tests that OpConductor correctly handles rollup boost partial health failures. +// This test verifies that when a leader is unhealthy and actively sequencing due to ErrRollupBoostPartiallyHealthy, +// it should stop sequencing and transfer leadership instead of waiting for health recovery. +// Scenario: [leader, unhealthy, active] with prevState [leader, unhealthy, inactive] and ErrRollupBoostPartiallyHealthy +// Expected: Stop sequencing and transfer leadership (not wait for recovery) +func (s *OpConductorTestSuite) TestRollupBoostPartialFailure() { + s.enableSynchronization() + + // Set initial state: leader is unhealthy and actively sequencing + // Previous state was [leader, unhealthy, inactive] - this simulates the scenario where + // the leader started sequencing during a network stall but rollup boost is partially healthy + s.conductor.leader.Store(true) + s.conductor.healthy.Store(false) + s.conductor.seqActive.Store(true) + s.conductor.prevState = &state{ + leader: true, + healthy: false, + active: false, + } + s.conductor.cfg.RollupBoostEnabled = true + + // Setup expectations - with ErrRollupBoostPartiallyHealthy, conductor should NOT wait for recovery + // Instead, it should stop sequencing and transfer leadership to another node + s.ctrl.EXPECT().StopSequencer(mock.Anything).Return(common.Hash{}, nil).Times(1) + s.cons.EXPECT().TransferLeader().Return(nil).Times(1) + + // Trigger the health update with rollup boost partial failure + s.updateHealthStatusAndExecuteAction(health.ErrRollupBoostPartiallyHealthy) + + // Verify the conductor stops sequencing and transfers leadership instead of waiting for recovery + s.False(s.conductor.leader.Load(), "Should transfer leadership to another node") + s.False(s.conductor.healthy.Load(), "Should remain marked as unhealthy") + s.False(s.conductor.seqActive.Load(), "Should stop sequencing") + s.Equal(health.ErrRollupBoostPartiallyHealthy, s.conductor.hcerr, "Should store the rollup boost error") + + // Verify the expected actions were taken + s.ctrl.AssertNumberOfCalls(s.T(), "StopSequencer", 1) + s.cons.AssertNumberOfCalls(s.T(), "TransferLeader", 1) +} diff --git a/op-conductor/flags/flags.go b/op-conductor/flags/flags.go index 9d37e06b499..c4a6bc32d8c 100644 --- a/op-conductor/flags/flags.go +++ b/op-conductor/flags/flags.go @@ -174,6 +174,12 @@ var ( Usage: "URL override for the execution layer RPC client for the sake of p2p healthcheck. If not set, the execution RPC URL will be used.", EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_EXECUTION_P2P_RPC_URL"), } + HealthcheckExecutionP2pCheckApi = &cli.StringFlag{ + Name: "healthcheck.execution-p2p-check-api", + Usage: "Type of EL P2P check to perform. If not set, the default `net` type will be used corresponding to the `net_peerCount` RPC call.", + EnvVars: opservice.PrefixEnvVar(EnvVarPrefix, "HEALTHCHECK_EXECUTION_P2P_CHECK_API"), + Value: "net", + } ) var requiredFlags = []cli.Flag{ @@ -206,6 +212,7 @@ var optionalFlags = []cli.Flag{ HealthcheckExecutionP2pEnabled, HealthcheckExecutionP2pMinPeerCount, HealthcheckExecutionP2pRPCUrl, + HealthcheckExecutionP2pCheckApi, } func init() { diff --git a/op-deployer/book/src/user-guide/bootstrap.md b/op-deployer/book/src/user-guide/bootstrap.md index 8810a61c1ac..f48360e94a2 100644 --- a/op-deployer/book/src/user-guide/bootstrap.md +++ b/op-deployer/book/src/user-guide/bootstrap.md @@ -3,8 +3,8 @@ > Note: if you are joining an existing superchain, you can skip to the `init` and `apply` commands to create your L2 chain(s) Bootstrap commands are used to deploy global singletons and implementation contracts for new superchains. -The deployed contract be then be use with future invocations of `apply` so that new L2 chains can join that superchain. -Most users won't need to use these commands, since `op-deployer apply` will automatically use predeployed contracts if they are available. However, you may need to use bootstrap commands if you're deploying chains to an L1 that isn't natively supported by `op-deployer`. +The deployed contracts can then be used with future invocations of `apply` so that new L2 chains can join that superchain. +Most users won't need to use these commands, since `op-deployer apply` will automatically use standard predeployed contracts for the L1/settlement-layer you are deploying on. However, you will need to use bootstrap commands if you're creating a new superchain. There are several bootstrap commands available, which you can view by running `op-deployer bootstrap --help`. We'll focus on the most important ones, which should be run in the sequence listed below. @@ -18,7 +18,6 @@ so the deployment address has no further control over the system. op-deployer bootstrap superchain \ --l1-rpc-url="" \ --private-key="" \ - --artifacts-locator="" \ --outfile="./.deployer/bootstrap_superchain.json" \ --superchain-proxy-admin-owner="" \ --protocol-versions-owner="" \ @@ -49,13 +48,13 @@ This command will deploy several contracts, and output a JSON like the one below ```shell op-deployer bootstrap implementations \ - --artifacts-locator="" \ --l1-rpc-url="" \ --outfile="./.deployer/bootstrap_implementations.json" \ - --mips-version="<1 or 2, for MIPS32 or MIPS64>" \ --private-key="" \ - --protocol-versions-proxy="
" \ - --superchain-config-proxy="
" \ + --protocol-versions-proxy="" \ + --superchain-config-proxy="" \ + --superchain-proxy-admin="" \ + --challenger="" \ --upgrade-controller="" ``` @@ -70,19 +69,26 @@ The command will output a JSON like the one below: ```json { - "Opcm": "0x4eeb114aaf812e21285e5b076030110e7e18fed9", - "DelayedWETHImpl": "0x5e40b9231b86984b5150507046e354dbfbed3d9e", - "OptimismPortalImpl": "0x2d7e764a0d9919e16983a46595cfa81fc34fa7cd", - "PreimageOracleSingleton": "0x1fb8cdfc6831fc866ed9c51af8817da5c287add3", - "MipsSingleton": "0xf027f4a985560fb13324e943edf55ad6f1d15dc1", - "SystemConfigImpl": "0x760c48c62a85045a6b69f07f4a9f22868659cbcc", - "L1CrossDomainMessengerImpl": "0x3ea6084748ed1b2a9b5d4426181f1ad8c93f6231", - "L1ERC721BridgeImpl": "0x276d3730f219f7ec22274f7263180b8452b46d47", - "L1StandardBridgeImpl": "0x78972e88ab8bbb517a36caea23b931bab58ad3c6", - "OptimismMintableERC20FactoryImpl": "0x5493f4677a186f64805fe7317d6993ba4863988f", - "DisputeGameFactoryImpl": "0x4bba758f006ef09402ef31724203f316ab74e4a0", - "AnchorStateRegistryImpl": "0x7b465370bb7a333f99edd19599eb7fb1c2d3f8d2", - "SuperchainConfigImpl": "0x4da82a327773965b8d4d85fa3db8249b387458e7", - "ProtocolVersionsImpl": "0x37e15e4d6dffa9e5e320ee1ec036922e563cb76c" + "opcmAddress": "0x82879934658738b6d5e8f781933ae7bbae05ba31", + "opcmContractsContainerAddress": "0x1e8de1574a2e085b7a292c760d90cf982d3c1a11", + "opcmGameTypeAdderAddress": "0xcab868d42d9088b86598a96d010db5819c19b847", + "opcmDeployerAddress": "0xf8b6718b28fa36b430334e78adaf97174fed818c", + "opcmUpgraderAddress": "0xa4d0a44890fafce541bdc4c1ca36fca1b5d22f56", + "opcmInteropMigratorAddress": "0xf0fca53bb450dd2230c7eb58a39a5dbfc8492fb6", + "opcmStandardValidatorAddress": "0x1364a02f64f03cd990f105058b8cc93a9a0ab2a1", + "delayedWETHImplAddress": "0x570da3694c06a250aea4855b4adcd09505801f9a", + "optimismPortalImplAddress": "0x1aa1d3fc9b39d7edd7ca69f54a35c66dcf1168f1", + "ethLockboxImplAddress": "0xe6e51fa10d481002301534445612c61bae6b3258", + "preimageOracleSingletonAddress": "0x1fb8cdfc6831fc866ed9c51af8817da5c287add3", + "mipsSingletonAddress": "0x7a8456ba22df0cb303ae1c93d3cf68ea3a067006", + "systemConfigImplAddress": "0x9f2b1fffd8a7aeef7aeeb002fd8477a4868e7e0a", + "l1CrossDomainMessengerImplAddress": "0x085952eb0f0c3d1ca82061e20e0fe8203cdd630a", + "l1ERC721BridgeImplAddress": "0xbafd2cae054ddf69af27517c6bea912de6b7eb8f", + "l1StandardBridgeImplAddress": "0x6abaa7b42b9a947047c01f41b9bcb8684427bf24", + "optimismMintableERC20FactoryImplAddress": "0xdd0b293b8789e9208481cee5a0c7e78f451d32bf", + "disputeGameFactoryImplAddress": "0xe7ab0c07ee92aae31f213b23a132a155f5c2c7cc", + "anchorStateRegistryImplAddress": "0xda4f46fad0e38d763c56da62c4bc1e9428624893", + "superchainConfigImplAddress": "0xdaf60e3c5ef116810779719da88410cce847c2a4", + "protocolVersionsImplAddress": "0xa95ac4790fedd68d9c3b30ed730afaec6029eb31" } ``` diff --git a/op-deployer/book/src/user-guide/installation.md b/op-deployer/book/src/user-guide/installation.md index ad6b54cbf52..66286ff9245 100644 --- a/op-deployer/book/src/user-guide/installation.md +++ b/op-deployer/book/src/user-guide/installation.md @@ -16,8 +16,8 @@ binaries, download the latest release from the [releases page][releases] and ext To install from source, you will need Go, `just`, and `git`. Then, run the following: ```shell -git clone git@github.com:ethereum-optimism/ethereum-optimism.git # you can skip this if you already have the repo -cd ethereum-optimism/op-deployer +git clone git@github.com:ethereum-optimism/optimism.git # you can skip this if you already have the repo +cd optimism/op-deployer just build cp ./bin/op-deployer /usr/local/bin/op-deployer # or any other directory in your $PATH -``` \ No newline at end of file +``` diff --git a/op-deployer/pkg/deployer/apply.go b/op-deployer/pkg/deployer/apply.go index ffb2d0d0cbc..9f0200aa301 100644 --- a/op-deployer/pkg/deployer/apply.go +++ b/op-deployer/pkg/deployer/apply.go @@ -7,6 +7,8 @@ import ( "math/big" "strings" + "github.com/ethereum-optimism/optimism/op-service/ioutil" + "github.com/ethereum-optimism/optimism/devnet-sdk/proofs/prestate" "github.com/ethereum-optimism/optimism/op-chain-ops/foundry" "github.com/ethereum-optimism/optimism/op-chain-ops/script" @@ -170,7 +172,7 @@ func ApplyPipeline( } st := opts.State - l1ArtifactsFS, err := artifacts.Download(ctx, intent.L1ContractsLocator, artifacts.BarProgressor(), opts.CacheDir) + l1ArtifactsFS, err := artifacts.Download(ctx, intent.L1ContractsLocator, ioutil.BarProgressor(), opts.CacheDir) if err != nil { return fmt.Errorf("failed to download L1 artifacts: %w", err) } @@ -179,7 +181,7 @@ func ApplyPipeline( if intent.L1ContractsLocator.Equal(intent.L2ContractsLocator) { l2ArtifactsFS = l1ArtifactsFS } else { - l2Afs, err := artifacts.Download(ctx, intent.L2ContractsLocator, artifacts.BarProgressor(), opts.CacheDir) + l2Afs, err := artifacts.Download(ctx, intent.L2ContractsLocator, ioutil.BarProgressor(), opts.CacheDir) if err != nil { return fmt.Errorf("failed to download L2 artifacts: %w", err) } diff --git a/op-deployer/pkg/deployer/artifacts/download.go b/op-deployer/pkg/deployer/artifacts/download.go index 205c797e0e8..35fac6338ba 100644 --- a/op-deployer/pkg/deployer/artifacts/download.go +++ b/op-deployer/pkg/deployer/artifacts/download.go @@ -8,14 +8,14 @@ import ( "crypto/sha256" "errors" "fmt" - "io" "io/fs" - "net/http" "net/url" "os" "path" "sync" + "github.com/ethereum-optimism/optimism/op-service/httputil" + "github.com/ethereum-optimism/optimism/op-service/ioutil" "github.com/ethereum-optimism/optimism/op-chain-ops/foundry" @@ -24,16 +24,16 @@ import ( var ErrUnsupportedArtifactsScheme = errors.New("unsupported artifacts URL scheme") type Downloader interface { - Download(ctx context.Context, url string, progress DownloadProgressor, targetDir string) (string, error) + Download(ctx context.Context, url string, progress ioutil.Progressor, targetDir string) (string, error) } type Extractor interface { Extract(src string, dest string) (string, error) } -func Download(ctx context.Context, loc *Locator, progressor DownloadProgressor, targetDir string) (foundry.StatDirFs, error) { +func Download(ctx context.Context, loc *Locator, progressor ioutil.Progressor, targetDir string) (foundry.StatDirFs, error) { if progressor == nil { - progressor = NoopProgressor() + progressor = ioutil.NoopProgressor() } var err error @@ -60,7 +60,7 @@ func Download(ctx context.Context, loc *Locator, progressor DownloadProgressor, return artifactsFS.(foundry.StatDirFs), nil } -func downloadHTTP(ctx context.Context, u *url.URL, progressor DownloadProgressor, checker integrityChecker, targetDir string) (fs.FS, error) { +func downloadHTTP(ctx context.Context, u *url.URL, progressor ioutil.Progressor, checker integrityChecker, targetDir string) (fs.FS, error) { cacher := &CachingDownloader{ d: new(HTTPDownloader), } @@ -84,21 +84,7 @@ func downloadHTTP(ctx context.Context, u *url.URL, progressor DownloadProgressor type HTTPDownloader struct{} -func (d *HTTPDownloader) Download(ctx context.Context, url string, progress DownloadProgressor, targetDir string) (string, error) { - req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil) - if err != nil { - return "", fmt.Errorf("failed to create request: %w", err) - } - - res, err := http.DefaultClient.Do(req) - if err != nil { - return "", fmt.Errorf("failed to download artifacts: %w", err) - } - if res.StatusCode != http.StatusOK { - return "", fmt.Errorf("failed to download artifacts: invalid status code %s", res.Status) - } - defer res.Body.Close() - +func (d *HTTPDownloader) Download(ctx context.Context, url string, progress ioutil.Progressor, targetDir string) (string, error) { if err := os.MkdirAll(targetDir, 0755); err != nil { return "", fmt.Errorf("failed to ensure cache directory '%s': %w", targetDir, err) } @@ -106,16 +92,12 @@ func (d *HTTPDownloader) Download(ctx context.Context, url string, progress Down if err != nil { return "", fmt.Errorf("failed to create temporary file: %w", err) } - - pr := &progressReader{ - r: res.Body, - progress: progress, - total: res.ContentLength, + downloader := &httputil.Downloader{ + Progressor: progress, } - if _, err := io.Copy(tmpFile, pr); err != nil { - return "", fmt.Errorf("failed to write to temporary file: %w", err) + if err := downloader.Download(ctx, url, tmpFile); err != nil { + return "", fmt.Errorf("failed to download: %w", err) } - return tmpFile.Name(), nil } @@ -124,7 +106,7 @@ type CachingDownloader struct { mtx sync.Mutex } -func (d *CachingDownloader) Download(ctx context.Context, url string, progress DownloadProgressor, targetDir string) (string, error) { +func (d *CachingDownloader) Download(ctx context.Context, url string, progress ioutil.Progressor, targetDir string) (string, error) { d.mtx.Lock() defer d.mtx.Unlock() diff --git a/op-deployer/pkg/deployer/artifacts/progress.go b/op-deployer/pkg/deployer/artifacts/progress.go deleted file mode 100644 index d6a3eed5750..00000000000 --- a/op-deployer/pkg/deployer/artifacts/progress.go +++ /dev/null @@ -1,48 +0,0 @@ -package artifacts - -import ( - "io" - "sync" - - "github.com/ethereum/go-ethereum/log" - "github.com/schollz/progressbar/v3" -) - -type DownloadProgressor func(current, total int64) - -func BarProgressor() DownloadProgressor { - var bar *progressbar.ProgressBar - var init sync.Once - return func(curr, total int64) { - init.Do(func() { - bar = progressbar.DefaultBytes(total) - }) - _ = bar.Set64(curr) - } -} - -func NoopProgressor() DownloadProgressor { - return func(curr, total int64) {} -} - -func LogProgressor(lgr log.Logger) DownloadProgressor { - return func(curr, total int64) { - lgr.Info("artifacts download progress", "current", curr, "total", total) - } -} - -type progressReader struct { - r io.Reader - progress DownloadProgressor - curr int64 - total int64 -} - -func (pr *progressReader) Read(p []byte) (int, error) { - n, err := pr.r.Read(p) - pr.curr += int64(n) - if pr.progress != nil { - pr.progress(pr.curr, pr.total) - } - return n, err -} diff --git a/op-deployer/pkg/deployer/bootstrap/flags.go b/op-deployer/pkg/deployer/bootstrap/flags.go index 4db49559064..b108d91900e 100644 --- a/op-deployer/pkg/deployer/bootstrap/flags.go +++ b/op-deployer/pkg/deployer/bootstrap/flags.go @@ -16,6 +16,7 @@ const ( ProofMaturityDelaySecondsFlagName = "proof-maturity-delay-seconds" DisputeGameFinalityDelaySecondsFlagName = "dispute-game-finality-delay-seconds" MIPSVersionFlagName = "mips-version" + DevFeatureBitmapFlagName = "dev-feature-bitmap" ProxyOwnerFlagName = "proxy-owner" SuperchainProxyAdminOwnerFlagName = "superchain-proxy-admin-owner" ProtocolVersionsOwnerFlagName = "protocol-versions-owner" @@ -68,6 +69,12 @@ var ( EnvVars: deployer.PrefixEnvVar("MIPS_VERSION"), Value: standard.MIPSVersion, } + DevFeatureBitmapFlag = &cli.StringFlag{ + Name: DevFeatureBitmapFlagName, + Usage: "Development feature bitmap.", + EnvVars: deployer.PrefixEnvVar("DEV_FEATURE_BITMAP"), + Value: common.Hash{}.Hex(), + } ProxyOwnerFlag = &cli.StringFlag{ Name: ProxyOwnerFlagName, Usage: "Proxy owner address.", @@ -132,6 +139,11 @@ var ( Usage: "Path to a JSON file", EnvVars: deployer.PrefixEnvVar("CONFIG"), } + ChallengerFlag = &cli.StringFlag{ + Name: "challenger", + Usage: "Challenger.", + EnvVars: deployer.PrefixEnvVar("CHALLENGER"), + } ) var ImplementationsFlags = []cli.Flag{ @@ -140,6 +152,7 @@ var ImplementationsFlags = []cli.Flag{ OutfileFlag, deployer.ArtifactsLocatorFlag, MIPSVersionFlag, + DevFeatureBitmapFlag, WithdrawalDelaySecondsFlag, MinProposalSizeBytesFlag, ChallengePeriodSecondsFlag, @@ -149,6 +162,7 @@ var ImplementationsFlags = []cli.Flag{ ProtocolVersionsProxyFlag, UpgradeControllerFlag, SuperchainProxyAdminFlag, + ChallengerFlag, } var ProxyFlags = []cli.Flag{ diff --git a/op-deployer/pkg/deployer/bootstrap/implementations.go b/op-deployer/pkg/deployer/bootstrap/implementations.go index a73ab92f73a..98c25307a82 100644 --- a/op-deployer/pkg/deployer/bootstrap/implementations.go +++ b/op-deployer/pkg/deployer/bootstrap/implementations.go @@ -9,6 +9,7 @@ import ( "strings" mipsVersion "github.com/ethereum-optimism/optimism/cannon/mipsevm/versions" + "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/artifacts" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/broadcaster" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/opcm" @@ -37,6 +38,7 @@ type ImplementationsConfig struct { ChallengePeriodSeconds uint64 `cli:"challenge-period-seconds"` ProofMaturityDelaySeconds uint64 `cli:"proof-maturity-delay-seconds"` DisputeGameFinalityDelaySeconds uint64 `cli:"dispute-game-finality-delay-seconds"` + DevFeatureBitmap common.Hash `cli:"dev-feature-bitmap"` SuperchainConfigProxy common.Address `cli:"superchain-config-proxy"` ProtocolVersionsProxy common.Address `cli:"protocol-versions-proxy"` UpgradeController common.Address `cli:"upgrade-controller"` @@ -116,6 +118,13 @@ func ImplementationsCLI(cliCtx *cli.Context) error { } cfg.Logger = l + artifactsURLStr := cliCtx.String(deployer.ArtifactsLocatorFlagName) + artifactsLocator := new(artifacts.Locator) + if err := artifactsLocator.UnmarshalText([]byte(artifactsURLStr)); err != nil { + return fmt.Errorf("failed to parse artifacts URL: %w", err) + } + cfg.ArtifactsLocator = artifactsLocator + ctx := ctxinterrupt.WithCancelOnInterrupt(cliCtx.Context) outfile := cliCtx.String(OutfileFlagName) dio, err := Implementations(ctx, cfg) @@ -136,7 +145,7 @@ func Implementations(ctx context.Context, cfg ImplementationsConfig) (opcm.Deplo lgr := cfg.Logger - artifactsFS, err := artifacts.Download(ctx, cfg.ArtifactsLocator, artifacts.BarProgressor(), cfg.CacheDir) + artifactsFS, err := artifacts.Download(ctx, cfg.ArtifactsLocator, ioutil.BarProgressor(), cfg.CacheDir) if err != nil { return dio, fmt.Errorf("failed to download artifacts: %w", err) } @@ -195,6 +204,7 @@ func Implementations(ctx context.Context, cfg ImplementationsConfig) (opcm.Deplo ProofMaturityDelaySeconds: new(big.Int).SetUint64(cfg.ProofMaturityDelaySeconds), DisputeGameFinalityDelaySeconds: new(big.Int).SetUint64(cfg.DisputeGameFinalityDelaySeconds), MipsVersion: new(big.Int).SetUint64(uint64(cfg.MIPSVersion)), + DevFeatureBitmap: cfg.DevFeatureBitmap, SuperchainConfigProxy: cfg.SuperchainConfigProxy, ProtocolVersionsProxy: cfg.ProtocolVersionsProxy, SuperchainProxyAdmin: cfg.SuperchainProxyAdmin, diff --git a/op-deployer/pkg/deployer/bootstrap/implementations_test.go b/op-deployer/pkg/deployer/bootstrap/implementations_test.go index 027e2e5aee6..50a50c6cc96 100644 --- a/op-deployer/pkg/deployer/bootstrap/implementations_test.go +++ b/op-deployer/pkg/deployer/bootstrap/implementations_test.go @@ -79,6 +79,7 @@ func testImplementations(t *testing.T, forkRPCURL string, cacheDir string) { ProofMaturityDelaySeconds: standard.ProofMaturityDelaySeconds, DisputeGameFinalityDelaySeconds: standard.DisputeGameFinalityDelaySeconds, MIPSVersion: int(standard.MIPSVersion), + DevFeatureBitmap: common.Hash{}, SuperchainConfigProxy: superchain.SuperchainConfigAddr, ProtocolVersionsProxy: superchain.ProtocolVersionsAddr, SuperchainProxyAdmin: proxyAdminOwner, diff --git a/op-deployer/pkg/deployer/bootstrap/proxy.go b/op-deployer/pkg/deployer/bootstrap/proxy.go index 865dfe5b8a7..e0922d4cb56 100644 --- a/op-deployer/pkg/deployer/bootstrap/proxy.go +++ b/op-deployer/pkg/deployer/bootstrap/proxy.go @@ -114,7 +114,7 @@ func Proxy(ctx context.Context, cfg ProxyConfig) (opcm.DeployProxyOutput, error) } lgr := cfg.Logger - artifactsFS, err := artifacts.Download(ctx, cfg.ArtifactsLocator, artifacts.BarProgressor(), cfg.CacheDir) + artifactsFS, err := artifacts.Download(ctx, cfg.ArtifactsLocator, ioutil.BarProgressor(), cfg.CacheDir) if err != nil { return dpo, fmt.Errorf("failed to download artifacts: %w", err) } diff --git a/op-deployer/pkg/deployer/bootstrap/superchain.go b/op-deployer/pkg/deployer/bootstrap/superchain.go index 49c5e8f890f..454d09a231f 100644 --- a/op-deployer/pkg/deployer/bootstrap/superchain.go +++ b/op-deployer/pkg/deployer/bootstrap/superchain.go @@ -151,7 +151,7 @@ func Superchain(ctx context.Context, cfg SuperchainConfig) (opcm.DeploySuperchai lgr := cfg.Logger cacheDir := cfg.CacheDir - artifactsFS, err := artifacts.Download(ctx, cfg.ArtifactsLocator, artifacts.BarProgressor(), cacheDir) + artifactsFS, err := artifacts.Download(ctx, cfg.ArtifactsLocator, ioutil.BarProgressor(), cacheDir) if err != nil { return dso, fmt.Errorf("failed to download artifacts: %w", err) } diff --git a/op-deployer/pkg/deployer/flags.go b/op-deployer/pkg/deployer/flags.go index 10681d91188..bcd3a71d49d 100644 --- a/op-deployer/pkg/deployer/flags.go +++ b/op-deployer/pkg/deployer/flags.go @@ -2,9 +2,6 @@ package deployer import ( "fmt" - "log" - "os" - "path" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/artifacts" @@ -31,40 +28,6 @@ const ( ContractNameFlagName = "contract-name" ) -type DeploymentTarget string - -const ( - DeploymentTargetLive DeploymentTarget = "live" - DeploymentTargetGenesis DeploymentTarget = "genesis" - DeploymentTargetCalldata DeploymentTarget = "calldata" - DeploymentTargetNoop DeploymentTarget = "noop" -) - -func NewDeploymentTarget(s string) (DeploymentTarget, error) { - switch s { - case string(DeploymentTargetLive): - return DeploymentTargetLive, nil - case string(DeploymentTargetGenesis): - return DeploymentTargetGenesis, nil - case string(DeploymentTargetCalldata): - return DeploymentTargetCalldata, nil - case string(DeploymentTargetNoop): - return DeploymentTargetNoop, nil - default: - return "", fmt.Errorf("invalid deployment target: %s", s) - } -} - -func GetDefaultCacheDir() string { - homeDir, err := os.UserHomeDir() - if err != nil { - fallbackDir := ".op-deployer/cache" - log.Printf("error getting user home directory: %v, using fallback directory: %s\n", err, fallbackDir) - return fallbackDir - } - return path.Join(homeDir, ".op-deployer/cache") -} - var ( L1RPCURLFlag = &cli.StringFlag{ Name: L1RPCURLFlagName, @@ -85,7 +48,7 @@ var ( Usage: "Cache directory. " + "If set, the deployer will attempt to cache downloaded artifacts in the specified directory.", EnvVars: PrefixEnvVar("CACHE_DIR"), - Value: GetDefaultCacheDir(), + Value: EnsureDefaultCacheDir(), } L1ChainIDFlag = &cli.Uint64Flag{ Name: L1ChainIDFlagName, @@ -187,11 +150,3 @@ var VerifyFlags = []cli.Flag{ func PrefixEnvVar(name string) []string { return op_service.PrefixEnvVar(EnvVarPrefix, name) } - -func cwd() string { - dir, err := os.Getwd() - if err != nil { - return "" - } - return dir -} diff --git a/op-deployer/pkg/deployer/forge/binary.go b/op-deployer/pkg/deployer/forge/binary.go new file mode 100644 index 00000000000..824d4d2ce8d --- /dev/null +++ b/op-deployer/pkg/deployer/forge/binary.go @@ -0,0 +1,262 @@ +package forge + +import ( + "archive/tar" + "bytes" + "compress/gzip" + "context" + "crypto/sha256" + "fmt" + "io" + "os" + "os/exec" + "path" + "regexp" + "runtime" + + "github.com/ethereum-optimism/optimism/op-service/httputil" + "github.com/ethereum-optimism/optimism/op-service/ioutil" +) + +// StandardVersion is the Foundry version that op-deployer will download if it's not found on PATH. +const StandardVersion = "v1.3.1" + +// maxDownloadSize is the maximum size of the Foundry tarball that will be downloaded. It's typically ~60MB so +// this should be more than enough. +const maxDownloadSize = 100 * 1024 * 1024 + +// checksums map the OS/architecture to the expected checksum of the binary. +var checksums = map[string]string{ + "darwin_amd64": "0b74d7efa2fe020c58dafbec5377617c1830f4ce8de26c0bbe8b57334984aab6", + "darwin_arm64": "e3c880d28eae2a150f3f01a674b3cd6a130d6d3f16685740cd1e16538b58a4a5", + "linux_amd64": "baad3e1b06d6f310d210c93e95258a03d923fe610f8d0742138f2245f94abd7c", + "linux_arm64": "ac5f88c0f6c1e5ed09c035a9f4405f74b996ea8a701d7150dc0184c18dd09f11", +} + +func getOS() string { + sysOS := runtime.GOOS + if runtime.GOOS == "windows" { + sysOS = "win32" + } + return sysOS +} + +func binaryURL(sysOS, sysArch string) string { + return fmt.Sprintf("https://github.com/foundry-rs/foundry/releases/download/%s/foundry_%s_%s_%s.tar.gz", StandardVersion, StandardVersion, sysOS, sysArch) +} + +type Binary interface { + Ensure(ctx context.Context) error + Path() string +} + +type Bin struct { + path string +} + +func StaticBinary(path string) Binary { + return &Bin{path: path} +} + +func (b *Bin) Ensure(ctx context.Context) error { + return nil +} + +func (b *Bin) Path() string { + return b.path +} + +type PathBin struct { + path string +} + +func PathBinary() Binary { + return new(PathBin) +} + +func (b *PathBin) Ensure(ctx context.Context) error { + var err error + b.path, err = exec.LookPath("forge") + if err != nil { + return fmt.Errorf("could not find binary: %w", err) + } + return nil +} + +func (b *PathBin) Path() string { + return b.path +} + +// StandardBin forces the use of the standard forge binary version by +// first checking for the version locally, then downloading from github +// if needed +type StandardBin struct { + progressor ioutil.Progressor + + cachePather func() (string, error) + checksummer func(r io.Reader) error + url string + path string +} + +type StandardBinOpt func(s *StandardBin) + +func WithProgressor(p ioutil.Progressor) StandardBinOpt { + return func(s *StandardBin) { + s.progressor = p + } +} + +func WithURL(url string) StandardBinOpt { + return func(s *StandardBin) { + s.url = url + } +} + +func WithCachePather(pather func() (string, error)) StandardBinOpt { + return func(s *StandardBin) { + s.cachePather = pather + } +} + +func WithChecksummer(checksummer func(r io.Reader) error) StandardBinOpt { + return func(s *StandardBin) { + s.checksummer = checksummer + } +} + +func homedirCachePather() (string, error) { + homeDir, err := os.UserHomeDir() + if err != nil { + return "", fmt.Errorf("could not find home directory: %w", err) + } + return path.Join(homeDir, ".op-deployer", "cache"), nil +} + +func staticChecksummer(expChecksum string) func(r io.Reader) error { + return func(r io.Reader) error { + h := sha256.New() + if _, err := io.Copy(h, r); err != nil { + return fmt.Errorf("could not calculate checksum: %w", err) + } + gotChecksum := fmt.Sprintf("%x", h.Sum(nil)) + if gotChecksum != expChecksum { + return fmt.Errorf("checksum mismatch: expected %s, got %s", expChecksum, gotChecksum) + } + return nil + } +} + +func githubChecksummer(r io.Reader) error { + expChecksum := checksums[getOS()+"_"+runtime.GOARCH] + if expChecksum == "" { + return fmt.Errorf("could not find checksum for %s_%s", getOS(), runtime.GOARCH) + } + return staticChecksummer(expChecksum)(r) +} + +func NewStandardBinary(opts ...StandardBinOpt) (*StandardBin, error) { + bin := &StandardBin{ + url: binaryURL(getOS(), runtime.GOARCH), + cachePather: homedirCachePather, + checksummer: githubChecksummer, + } + for _, opt := range opts { + opt(bin) + } + return bin, nil +} + +func (b *StandardBin) Ensure(ctx context.Context) error { + // 1) Exit early if b.path already set (via previous Ensure call) + if b.path != "" { + return nil + } + + // 2) PATH: use if version matches the pinned Version + if forgePath, err := exec.LookPath("forge"); err == nil { + if ver, err := getForgeVersion(ctx, forgePath); err == nil && ver == StandardVersion { + b.path = forgePath + return nil + } + } + + // 3) Cache: use if version matches; otherwise replace it + binDir, err := b.cachePather() + if err != nil { + return fmt.Errorf("could not provide cache dir: %w", err) + } + binPath := path.Join(binDir, "forge") + if st, err := os.Stat(binPath); err == nil && !st.IsDir() { + // forge binary exists in cache; check version + if ver, err := getForgeVersion(ctx, binPath); err == nil && ver == StandardVersion { + b.path = binPath + return nil + } + } else if err != nil && !os.IsNotExist(err) { + return fmt.Errorf("could not stat %s: %w", binPath, err) + } + + // 4) Download expected version for this OS/arch and verify checksum + if err := b.downloadBinary(ctx, binDir); err != nil { + return fmt.Errorf("could not download binary: %w", err) + } + b.path = binPath + return nil +} + +func (b *StandardBin) Path() string { + return b.path +} + +func (b *StandardBin) downloadBinary(ctx context.Context, dest string) error { + tmpDir, err := os.MkdirTemp("", "op-deployer-forge-*") + if err != nil { + return fmt.Errorf("failed to create temp file: %w", err) + } + defer func() { + _ = os.RemoveAll(tmpDir) + }() + downloader := &httputil.Downloader{ + Progressor: b.progressor, + MaxSize: maxDownloadSize, + } + buf := new(bytes.Buffer) + if err := downloader.Download(ctx, b.url, buf); err != nil { + return fmt.Errorf("failed to download binary: %w", err) + } + data := buf.Bytes() + if err := b.checksummer(bytes.NewReader(data)); err != nil { + return fmt.Errorf("checksum mismatch: %w", err) + } + gzr, err := gzip.NewReader(bytes.NewReader(data)) + if err != nil { + return fmt.Errorf("failed to create gzip reader: %w", err) + } + tr := tar.NewReader(gzr) + if err := ioutil.Untar(tmpDir, tr); err != nil { + return fmt.Errorf("failed to untar: %w", err) + } + if err := os.Rename(path.Join(tmpDir, "forge"), path.Join(dest, "forge")); err != nil { + return fmt.Errorf("failed to move binary: %w", err) + } + if err := os.Chmod(path.Join(dest, "forge"), 0o755); err != nil { + return fmt.Errorf("failed to set executable bit: %w", err) + } + return nil +} + +func getForgeVersion(ctx context.Context, forgePath string) (string, error) { + cmd := exec.CommandContext(ctx, forgePath, "--version") + out, err := cmd.Output() + if err != nil { + return "", fmt.Errorf("exec %s --version failed: %w", forgePath, err) + } + // Example output: "forge Version: 1.3.1-v1.3.1" -> capture "v1.3.1" + re := regexp.MustCompile(`(?mi)^\s*forge\s+version:\s+\d+\.\d+\.\d+-\s*(v\d+\.\d+\.\d+)\s*$`) + m := re.FindStringSubmatch(string(out)) + if len(m) != 2 { + return "", fmt.Errorf("could not parse version tag from: %q", out) + } + return m[1], nil +} diff --git a/op-deployer/pkg/deployer/forge/binary_test.go b/op-deployer/pkg/deployer/forge/binary_test.go new file mode 100644 index 00000000000..b6d9e4a6bce --- /dev/null +++ b/op-deployer/pkg/deployer/forge/binary_test.go @@ -0,0 +1,176 @@ +package forge + +import ( + "context" + "fmt" + "log/slog" + "net/http" + "net/http/httptest" + "os" + "path" + "strings" + "sync/atomic" + "testing" + "time" + + "github.com/ethereum-optimism/optimism/op-service/ioutil" + "github.com/ethereum-optimism/optimism/op-service/testlog" + + "github.com/stretchr/testify/require" +) + +// TestStandardBinary_ForgeBins tests that the binary can be downloaded from the +// official release channel, and that their checksums are correct. +func TestStandardBinary_ForgeBins(t *testing.T) { + if testing.Short() { + t.Skip("skipping test in -short mode") + } + + // Clear out the PATH env var so it forces a download. + t.Setenv("PATH", "") + + for target, checksum := range checksums { + t.Run(target, func(t *testing.T) { + lgr := testlog.Logger(t, slog.LevelInfo) + split := strings.Split(target, "_") + tgtOS, tgtArch := split[0], split[1] + + cacheDir := t.TempDir() + bin, err := NewStandardBinary( + WithURL(binaryURL(tgtOS, tgtArch)), + WithCachePather(func() (string, error) { return cacheDir, nil }), + WithProgressor(ioutil.NewLogProgressor(lgr, "downloading").Progressor), + WithChecksummer(staticChecksummer(checksum)), + ) + require.NoError(t, err) + + ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second) + defer cancel() + require.NoError(t, bin.Ensure(ctx)) + }) + } +} + +func TestStandardBinary_Downloads(t *testing.T) { + expChecksum, err := os.ReadFile("testdata/foundry.tgz.sha256") + require.NoError(t, err) + + // Serve the tar archive via an HTTP test server. + ts := httptest.NewServer(http.FileServer(http.Dir("testdata"))) + defer ts.Close() + + // Prepare a cache directory within the test's temporary directory. + cacheDir := t.TempDir() + + t.Run("download OK", func(t *testing.T) { + var progressed atomic.Bool + + bin, err := NewStandardBinary( + WithURL(ts.URL+"/foundry.tgz"), + WithCachePather(func() (string, error) { return cacheDir, nil }), + WithProgressor(func(curr, total int64) { + progressed.Store(true) + }), + WithChecksummer(staticChecksummer(string(expChecksum))), + ) + require.NoError(t, err) + + ctx, cancel := context.WithTimeout(context.Background(), time.Second) + defer cancel() + require.NoError(t, bin.Ensure(ctx)) + require.Equal(t, path.Join(cacheDir, "forge"), bin.Path()) + require.FileExists(t, bin.Path()) + require.True(t, progressed.Load()) + }) + + t.Run("invalid checksum", func(t *testing.T) { + bin, err := NewStandardBinary( + WithURL(ts.URL+"/foundry.tgz"), + WithCachePather(func() (string, error) { return "not-a-path", nil }), + WithChecksummer(staticChecksummer("beep beep")), + ) + require.NoError(t, err) + + ctx, cancel := context.WithTimeout(context.Background(), time.Second) + defer cancel() + require.ErrorContains(t, bin.Ensure(ctx), "checksum mismatch") + }) +} + +func TestStandardBinary_OnPath(t *testing.T) { + expChecksum, err := os.ReadFile("testdata/foundry.tgz.sha256") + require.NoError(t, err) + + // Serve the test tarball so we can force the download path. + ts := httptest.NewServer(http.FileServer(http.Dir("testdata"))) + defer ts.Close() + + makeForge := func(dir, versionLine string) string { + fp := path.Join(dir, "forge") + script := fmt.Sprintf(`#!/bin/sh +if [ "$1" = "--version" ]; then + echo "%s" + exit 0 +fi +exit 1 +`, versionLine) + require.NoError(t, os.WriteFile(fp, []byte(script), 0o777)) + require.NoError(t, os.Chmod(fp, 0o777)) + return fp + } + + cases := []struct { + name string + versionLine string + expectUsePath bool + }{ + { + name: "match_tag", + versionLine: fmt.Sprintf("forge Version: %s-%s", strings.TrimPrefix(StandardVersion, "v"), StandardVersion), + expectUsePath: true, + }, + { + name: "mismatch_tag", + versionLine: fmt.Sprintf("forge Version: %s-v0.0.0", strings.TrimPrefix(StandardVersion, "v")), + expectUsePath: false, + }, + { + name: "no_tag", + versionLine: fmt.Sprintf("forge Version: %s", strings.TrimPrefix(StandardVersion, "v")), + expectUsePath: false, + }, + { + name: "garbage_output", + versionLine: "forge something unexpected", + expectUsePath: false, + }, + } + + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + forgeDir := t.TempDir() + forgePath := makeForge(forgeDir, tc.versionLine) + t.Setenv("PATH", forgeDir) + + cacheDir := t.TempDir() + bin, err := NewStandardBinary( + WithURL(ts.URL+"/foundry.tgz"), + WithCachePather(func() (string, error) { return cacheDir, nil }), + WithChecksummer(staticChecksummer(string(expChecksum))), + ) + require.NoError(t, err) + + ctx, cancel := context.WithTimeout(context.Background(), time.Second) + defer cancel() + require.NoError(t, bin.Ensure(ctx)) + + if tc.expectUsePath { + require.Equal(t, forgePath, bin.Path()) + require.NoFileExists(t, path.Join(cacheDir, "forge")) + } else { + require.Equal(t, path.Join(cacheDir, "forge"), bin.Path()) + require.FileExists(t, bin.Path()) + } + }) + } +} diff --git a/op-deployer/pkg/deployer/forge/client.go b/op-deployer/pkg/deployer/forge/client.go new file mode 100644 index 00000000000..d612077191c --- /dev/null +++ b/op-deployer/pkg/deployer/forge/client.go @@ -0,0 +1,136 @@ +package forge + +import ( + "bytes" + "context" + "encoding/hex" + "fmt" + "io" + "os" + "os/exec" + "regexp" + "strings" +) + +var ( + versionRegexp = regexp.MustCompile(`(?i)forge version: (.*)\ncommit sha: ([a-f0-9]+)\n`) + sigilRegexp = regexp.MustCompile(`(?i)== Return ==\n0: bytes 0x([a-f0-9]+)\n`) +) + +type VersionInfo struct { + Semver string + SHA string +} + +type Client struct { + Binary Binary + Stdout io.Writer + Stderr io.Writer + Wd string +} + +func NewClient(binary Binary) *Client { + return &Client{ + Binary: binary, + Stdout: os.Stdout, + Stderr: os.Stderr, + } +} + +func (c *Client) Version(ctx context.Context) (VersionInfo, error) { + buf := new(bytes.Buffer) + if err := c.execCmd(ctx, buf, io.Discard, "--version"); err != nil { + return VersionInfo{}, fmt.Errorf("failed to execute command: %w", err) + } + outputStr := buf.String() + matches := versionRegexp.FindAllStringSubmatch(outputStr, -1) + if len(matches) != 1 || len(matches[0]) != 3 { + return VersionInfo{}, fmt.Errorf("failed to find forge version in output:\n%s", outputStr) + } + return VersionInfo{ + Semver: matches[0][1], + SHA: matches[0][2], + }, nil +} + +func (c *Client) Build(ctx context.Context, opts ...string) error { + return c.execCmd(ctx, io.Discard, io.Discard, append([]string{"build"}, opts...)...) +} + +func (c *Client) Clean(ctx context.Context, opts ...string) error { + return c.execCmd(ctx, io.Discard, io.Discard, append([]string{"clean"}, opts...)...) +} + +func (c *Client) RunScript(ctx context.Context, script string, sig string, args []byte, opts ...string) (string, error) { + buf := new(bytes.Buffer) + cliOpts := []string{"script"} + cliOpts = append(cliOpts, opts...) + cliOpts = append(cliOpts, "--sig", sig, script, "0x"+hex.EncodeToString(args)) + if err := c.execCmd(ctx, buf, io.Discard, cliOpts...); err != nil { + return "", fmt.Errorf("failed to execute command: %w", err) + } + return buf.String(), nil +} + +func (c *Client) execCmd(ctx context.Context, stdout io.Writer, stderr io.Writer, args ...string) error { + if err := c.Binary.Ensure(ctx); err != nil { + return fmt.Errorf("failed to ensure binary: %w", err) + } + + cmd := exec.CommandContext(ctx, c.Binary.Path(), args...) + cStdout := c.Stdout + if cStdout == nil { + cStdout = os.Stdout + } + cStderr := c.Stderr + if cStderr == nil { + cStderr = os.Stderr + } + + mwStdout := io.MultiWriter(cStdout, stdout) + mwStderr := io.MultiWriter(cStderr, stderr) + cmd.Stdout = mwStdout + cmd.Stderr = mwStderr + cmd.Dir = c.Wd + if err := cmd.Run(); err != nil { + return fmt.Errorf("failed to execute forge: %w", err) + } + return nil +} + +type ScriptCallEncoder[I any] interface { + Encode(I) ([]byte, error) +} + +type ScriptCallDecoder[O any] interface { + Decode(raw []byte) (O, error) +} + +type ScriptCaller[I any, O any] func(ctx context.Context, input I, opts ...string) (O, bool, error) + +func NewScriptCaller[I any, O any](client *Client, script string, sig string, encoder ScriptCallEncoder[I], decoder ScriptCallDecoder[O]) ScriptCaller[I, O] { + return func(ctx context.Context, input I, opts ...string) (O, bool, error) { + var out O + encArgs, err := encoder.Encode(input) + if err != nil { + return out, false, fmt.Errorf("failed to encode forge args: %w", err) + } + rawOut, err := client.RunScript(ctx, script, sig, encArgs, opts...) + if err != nil { + return out, false, fmt.Errorf("failed to execute forge: %w", err) + } + sigilMatches := sigilRegexp.FindAllStringSubmatch(rawOut, -1) + if len(sigilMatches) != 1 || len(sigilMatches[0]) != 2 { + return out, false, fmt.Errorf("failed to find forge return value in output:\n%s", rawOut) + } + decoded, err := hex.DecodeString(sigilMatches[0][1]) + if err != nil { + return out, false, fmt.Errorf("failed to decode forge return value %s: %w", sigilMatches[0][1], err) + } + out, err = decoder.Decode(decoded) + if err != nil { + return out, false, fmt.Errorf("failed to decode forge output: %w", err) + } + return out, strings.Contains(rawOut, "Compiler run successful!"), nil + } +} diff --git a/op-deployer/pkg/deployer/forge/client_test.go b/op-deployer/pkg/deployer/forge/client_test.go new file mode 100644 index 00000000000..e26203b0a0d --- /dev/null +++ b/op-deployer/pkg/deployer/forge/client_test.go @@ -0,0 +1,196 @@ +package forge + +import ( + "bytes" + "context" + "fmt" + "io" + "os" + "path" + "path/filepath" + "reflect" + "regexp" + "runtime" + "strings" + "testing" + "time" + + "github.com/ethereum/go-ethereum/accounts/abi" + + "github.com/stretchr/testify/require" +) + +type ioStruct struct { + ID uint8 + Data []byte +} + +func TestMinimalSources(t *testing.T) { + ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second) + defer cancel() + + cl := NewClient(PathBinary()) + cl.Wd = projDir(t) + + // Build artifacts + require.NoError(t, cl.Build(ctx)) + + // Then copy them somewhere else + tmpDir := t.TempDir() + require.NoError(t, copyDir("testdata/testproject/out", path.Join(tmpDir, "out"))) + require.NoError(t, copyDir("testdata/testproject/cache", path.Join(tmpDir, "cache"))) + require.NoError(t, copyDir("testdata/testproject/script", path.Join(tmpDir, "script"))) + require.NoError(t, copyDir("testdata/testproject/foundry.toml", path.Join(tmpDir, "foundry.toml"))) + + // Then see if we can successfully run a script + cl.Wd = tmpDir + encDec := new(testEncoderDecoder) + caller := NewScriptCaller[ioStruct, ioStruct](cl, "script/Test.s.sol:TestScript", "run(bytes)", encDec, encDec) + // It should not recompile since we included the cache. + in := ioStruct{ + ID: 1, + Data: []byte{0x01, 0x02, 0x03, 0x04}, + } + out, changed, err := caller(ctx, in) + require.NoError(t, err) + require.False(t, changed) + require.EqualValues(t, ioStruct{ + ID: 2, + Data: in.Data, + }, out) +} + +// TestClient_Smoke smoke tests the Client by running the Version command on it. +func TestClient_Smoke(t *testing.T) { + bin := PathBinary() + cl := NewClient(bin) + + version, err := cl.Version(context.Background()) + require.NoError(t, err) + require.Regexp(t, regexp.MustCompile(`\d+\.\d+\.\d+`), version.Semver) + require.Regexp(t, regexp.MustCompile(`^[a-f0-9]+$`), version.SHA) +} + +func TestClient_OutputRedirection(t *testing.T) { + bin := PathBinary() + cl := NewClient(bin) + cl.Stdout = new(bytes.Buffer) + + _, err := cl.Version(context.Background()) + require.NoError(t, err) + require.True(t, strings.HasPrefix(cl.Stdout.(*bytes.Buffer).String(), "forge Version")) +} + +func TestScriptCaller(t *testing.T) { + ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second) + defer cancel() + + bin := PathBinary() + cl := NewClient(bin) + cl.Wd = projDir(t) + + require.NoError(t, cl.Clean(ctx)) + encDec := new(testEncoderDecoder) + caller := NewScriptCaller[ioStruct, ioStruct](cl, "script/Test.s.sol:TestScript", "run(bytes)", encDec, encDec) + in := ioStruct{ + ID: 1, + Data: []byte{0x01, 0x02}, + } + out, recompiled, err := caller(context.Background(), in) + require.NoError(t, err) + require.True(t, recompiled) + require.EqualValues(t, ioStruct{ + ID: 2, + Data: []byte{0x01, 0x02}, + }, out) + out, recompiled, err = caller(context.Background(), in) + require.NoError(t, err) + require.False(t, recompiled) + require.EqualValues(t, ioStruct{ + ID: 2, + Data: []byte{0x01, 0x02}, + }, out) +} + +var ( + runArgs = abi.Arguments{{Type: mustTuple()}} +) + +func mustTuple() abi.Type { + t, err := abi.NewType("tuple", "", []abi.ArgumentMarshaling{ + {Name: "ID", Type: "uint8"}, + {Name: "Data", Type: "bytes"}, + }) + if err != nil { + panic(err) + } + return t +} + +type testEncoderDecoder struct { +} + +func (t *testEncoderDecoder) Encode(in ioStruct) ([]byte, error) { + return runArgs.Pack(in) +} + +func (t *testEncoderDecoder) Decode(v []byte) (ioStruct, error) { + var out ioStruct + decoded, err := runArgs.Unpack(v) + if err != nil { + return out, fmt.Errorf("error unpacking args: %w", err) + } + // Geth's ABI decoding library returns an anonymous strut + // which requires reflection to parse. + anonStruct := decoded[0] + val := reflect.ValueOf(anonStruct) + out.ID = uint8(val.FieldByName("ID").Uint()) + out.Data = val.FieldByName("Data").Bytes() + return out, nil +} + +func copyDir(src, dst string) error { + return filepath.Walk(src, func(path string, info os.FileInfo, err error) error { + if err != nil { + return err + } + + relPath, err := filepath.Rel(src, path) + if err != nil { + return err + } + targetPath := filepath.Join(dst, relPath) + + if info.IsDir() { + return os.MkdirAll(targetPath, 0755) + } + + return copyFile(path, targetPath) + }) +} + +func copyFile(src, dst string) error { + in, err := os.Open(src) + if err != nil { + return err + } + defer in.Close() + + out, err := os.Create(dst) + if err != nil { + return err + } + defer out.Close() + + _, err = io.Copy(out, in) + return err +} + +func projDir(t *testing.T) string { + _, testFilename, _, ok := runtime.Caller(0) + require.True(t, ok) + dir := filepath.Join(filepath.Dir(testFilename), "testdata", "testproject") + absProjDir, err := filepath.Abs(dir) + require.NoError(t, err) + return absProjDir +} diff --git a/op-deployer/pkg/deployer/forge/testdata/foundry.tgz b/op-deployer/pkg/deployer/forge/testdata/foundry.tgz new file mode 100644 index 00000000000..6362fc6e9a2 Binary files /dev/null and b/op-deployer/pkg/deployer/forge/testdata/foundry.tgz differ diff --git a/op-deployer/pkg/deployer/forge/testdata/foundry.tgz.sha256 b/op-deployer/pkg/deployer/forge/testdata/foundry.tgz.sha256 new file mode 100644 index 00000000000..585f02f2734 --- /dev/null +++ b/op-deployer/pkg/deployer/forge/testdata/foundry.tgz.sha256 @@ -0,0 +1 @@ +15cb653675d5af82c3f540f85a330bf7e6edb6a142b199246409cab99610419e \ No newline at end of file diff --git a/op-deployer/pkg/deployer/forge/testdata/testproject/.gitignore b/op-deployer/pkg/deployer/forge/testdata/testproject/.gitignore new file mode 100644 index 00000000000..85198aaa55b --- /dev/null +++ b/op-deployer/pkg/deployer/forge/testdata/testproject/.gitignore @@ -0,0 +1,14 @@ +# Compiler files +cache/ +out/ + +# Ignores development broadcast logs +!/broadcast +/broadcast/*/31337/ +/broadcast/**/dry-run/ + +# Docs +docs/ + +# Dotenv file +.env diff --git a/op-deployer/pkg/deployer/forge/testdata/testproject/README.md b/op-deployer/pkg/deployer/forge/testdata/testproject/README.md new file mode 100644 index 00000000000..9a04181257f --- /dev/null +++ b/op-deployer/pkg/deployer/forge/testdata/testproject/README.md @@ -0,0 +1,3 @@ +# testproject + +This project is used to test the Forge Go client. \ No newline at end of file diff --git a/op-deployer/pkg/deployer/forge/testdata/testproject/foundry.toml b/op-deployer/pkg/deployer/forge/testdata/testproject/foundry.toml new file mode 100644 index 00000000000..d7c0a71b2ea --- /dev/null +++ b/op-deployer/pkg/deployer/forge/testdata/testproject/foundry.toml @@ -0,0 +1,9 @@ +[profile.default] +src = "src" +out = "out" +libs = [] +extra_output = ['devdoc', 'userdoc', 'metadata', 'storageLayout'] +ast = true +bytecode_hash = 'none' +evm_version = 'cancun' +use_literal_content = true \ No newline at end of file diff --git a/op-deployer/pkg/deployer/forge/testdata/testproject/script/Test.s.sol b/op-deployer/pkg/deployer/forge/testdata/testproject/script/Test.s.sol new file mode 100644 index 00000000000..884252c220a --- /dev/null +++ b/op-deployer/pkg/deployer/forge/testdata/testproject/script/Test.s.sol @@ -0,0 +1,24 @@ +// SPDX-License-Identifier: UNLICENSED +pragma solidity ^0.8.13; + +contract TestScript { + struct Input { + uint8 id; + bytes data; + } + + struct Output { + uint8 id; + bytes data; + } + + function _run(Input memory _input) public pure returns (Output memory) { + return Output({ id: 0x02, data: _input.data }); + } + + function run(bytes memory _input) public pure returns (bytes memory) { + Input memory input = abi.decode(_input, (Input)); + Output memory output = _run(input); + return abi.encode(output); + } +} diff --git a/op-deployer/pkg/deployer/inspect/semvers.go b/op-deployer/pkg/deployer/inspect/semvers.go index 05524dbb788..232f1d4bd85 100644 --- a/op-deployer/pkg/deployer/inspect/semvers.go +++ b/op-deployer/pkg/deployer/inspect/semvers.go @@ -59,7 +59,7 @@ func L2SemversCLI(cliCtx *cli.Context) error { return fmt.Errorf("chain state does not have allocs") } - artifactsFS, err := artifacts.Download(ctx, intent.L2ContractsLocator, artifacts.BarProgressor(), cliCfg.CacheDir) + artifactsFS, err := artifacts.Download(ctx, intent.L2ContractsLocator, ioutil.BarProgressor(), cliCfg.CacheDir) if err != nil { return fmt.Errorf("failed to download L2 artifacts: %w", err) } diff --git a/op-deployer/pkg/deployer/integration_test/apply_test.go b/op-deployer/pkg/deployer/integration_test/apply_test.go index 39d29ed6d88..93ebcf569b7 100644 --- a/op-deployer/pkg/deployer/integration_test/apply_test.go +++ b/op-deployer/pkg/deployer/integration_test/apply_test.go @@ -7,12 +7,12 @@ import ( "encoding/hex" "log/slog" "math/big" - "regexp" "strings" "testing" "time" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/bootstrap" + "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/inspect" "github.com/ethereum/go-ethereum/params" "github.com/ethereum-optimism/optimism/op-service/testutils" @@ -46,6 +46,8 @@ import ( "github.com/stretchr/testify/require" ) +const testCustomGasLimit = uint64(90_123_456) + type deployerKey struct{} func (d *deployerKey) HDPath() string { @@ -110,6 +112,7 @@ func TestEndToEndBootstrapApply(t *testing.T) { ChallengePeriodSeconds: standard.ChallengePeriodSeconds, ProofMaturityDelaySeconds: standard.ProofMaturityDelaySeconds, DisputeGameFinalityDelaySeconds: standard.DisputeGameFinalityDelaySeconds, + DevFeatureBitmap: common.Hash{}, SuperchainConfigProxy: bstrap.SuperchainConfigProxy, ProtocolVersionsProxy: bstrap.ProtocolVersionsProxy, UpgradeController: superchainPAO, @@ -143,13 +146,10 @@ func TestEndToEndBootstrapApply(t *testing.T) { } t.Run("default tagged artifacts", func(t *testing.T) { - op_e2e.InitParallel(t) - testutils.RunOnBranch(t, regexp.MustCompile(`^(backports/op-deployer|proposal/op-contracts)/*`)) apply(t, artifacts.DefaultL1ContractsLocator) }) t.Run("local artifacts", func(t *testing.T) { - op_e2e.InitParallel(t) loc, _ := testutil.LocalArtifacts(t) apply(t, loc) }) @@ -247,7 +247,6 @@ func TestGlobalOverrides(t *testing.T) { defer cancel() opts, intent, st := setupGenesisChain(t, devnet.DefaultChainID) - expectedGasLimit := strings.ToLower("0x1C9C380") expectedBaseFeeVaultRecipient := common.HexToAddress("0x0000000000000000000000000000000000000001") expectedL1FeeVaultRecipient := common.HexToAddress("0x0000000000000000000000000000000000000002") expectedSequencerFeeVaultRecipient := common.HexToAddress("0x0000000000000000000000000000000000000003") @@ -259,7 +258,6 @@ func TestGlobalOverrides(t *testing.T) { expectedUseFaultProofs := false intent.GlobalDeployOverrides = map[string]interface{}{ "l2BlockTime": float64(3), - "l2GenesisBlockGasLimit": expectedGasLimit, "baseFeeVaultRecipient": expectedBaseFeeVaultRecipient, "l1FeeVaultRecipient": expectedL1FeeVaultRecipient, "sequencerFeeVaultRecipient": expectedSequencerFeeVaultRecipient, @@ -276,7 +274,6 @@ func TestGlobalOverrides(t *testing.T) { cfg, err := state.CombineDeployConfig(intent, intent.Chains[0], st, st.Chains[0]) require.NoError(t, err) require.Equal(t, uint64(3), cfg.L2InitializationConfig.L2CoreDeployConfig.L2BlockTime, "L2 block time should be 3 seconds") - require.Equal(t, expectedGasLimit, strings.ToLower(cfg.L2InitializationConfig.L2GenesisBlockDeployConfig.L2GenesisBlockGasLimit.String()), "L2 Genesis Block Gas Limit should be 30_000_000") require.Equal(t, expectedBaseFeeVaultRecipient, cfg.L2InitializationConfig.L2VaultsDeployConfig.BaseFeeVaultRecipient, "Base Fee Vault Recipient should be the expected address") require.Equal(t, expectedL1FeeVaultRecipient, cfg.L2InitializationConfig.L2VaultsDeployConfig.L1FeeVaultRecipient, "L1 Fee Vault Recipient should be the expected address") require.Equal(t, expectedSequencerFeeVaultRecipient, cfg.L2InitializationConfig.L2VaultsDeployConfig.SequencerFeeVaultRecipient, "Sequencer Fee Vault Recipient should be the expected address") @@ -704,6 +701,7 @@ func newChainIntent(t *testing.T, dk *devkeys.MnemonicDevKeys, l1ChainID *big.In Eip1559DenominatorCanyon: standard.Eip1559DenominatorCanyon, Eip1559Denominator: standard.Eip1559Denominator, Eip1559Elasticity: standard.Eip1559Elasticity, + GasLimit: testCustomGasLimit, Roles: state.ChainRoles{ L1ProxyAdminOwner: addrFor(t, dk, devkeys.L2ProxyAdminOwnerRole.Key(l1ChainID)), L2ProxyAdminOwner: addrFor(t, dk, devkeys.L2ProxyAdminOwnerRole.Key(l1ChainID)), @@ -771,6 +769,7 @@ func validateOPChainDeployment(t *testing.T, cg codeGetter, st *state.State, int implAddrs := []addrTuple{ {"DelayedWethImpl", st.ImplementationsDeployment.DelayedWethImpl}, {"OptimismPortalImpl", st.ImplementationsDeployment.OptimismPortalImpl}, + {"OptimismPortalInteropImpl", st.ImplementationsDeployment.OptimismPortalInteropImpl}, {"SystemConfigImpl", st.ImplementationsDeployment.SystemConfigImpl}, {"L1CrossDomainMessengerImpl", st.ImplementationsDeployment.L1CrossDomainMessengerImpl}, {"L1ERC721BridgeImpl", st.ImplementationsDeployment.L1Erc721BridgeImpl}, @@ -840,6 +839,12 @@ func validateOPChainDeployment(t *testing.T, cg codeGetter, st *state.State, int require.False(t, ok, "governance token should not be deployed by default") } + genesis, rollup, err := inspect.GenesisAndRollup(st, chainState.ID) + require.NoError(t, err) + require.Equal(t, rollup.Genesis.SystemConfig.GasLimit, testCustomGasLimit, "rollup gasLimit") + require.Equal(t, genesis.GasLimit, testCustomGasLimit, "genesis gasLimit") + + require.Equal(t, chainIntent.GasLimit, testCustomGasLimit, "chainIntent gasLimit") require.Equal(t, int(chainIntent.Eip1559Denominator), 50, "EIP1559Denominator should be set") require.Equal(t, int(chainIntent.Eip1559Elasticity), 6, "EIP1559Elasticity should be set") } diff --git a/op-deployer/pkg/deployer/manage/add_game_type.go b/op-deployer/pkg/deployer/manage/add_game_type.go index 7ff617dbdad..a7280b20fbe 100644 --- a/op-deployer/pkg/deployer/manage/add_game_type.go +++ b/op-deployer/pkg/deployer/manage/add_game_type.go @@ -7,6 +7,8 @@ import ( "math/big" "os" + "github.com/ethereum-optimism/optimism/op-service/ioutil" + "github.com/ethereum-optimism/optimism/op-service/cliutil" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/pipeline" @@ -246,7 +248,7 @@ func AddGameType(ctx context.Context, cfg AddGameTypeConfig) (opcm.AddGameTypeOu lgr := cfg.Logger - artifactsFS, err := artifacts.Download(ctx, cfg.ArtifactsLocator, artifacts.BarProgressor(), cfg.CacheDir) + artifactsFS, err := artifacts.Download(ctx, cfg.ArtifactsLocator, ioutil.BarProgressor(), cfg.CacheDir) if err != nil { return output, nil, fmt.Errorf("failed to download artifacts: %w", err) } diff --git a/op-deployer/pkg/deployer/manage/add_game_type_test.go b/op-deployer/pkg/deployer/manage/add_game_type_test.go index b474b07c02b..b19d51ae6ee 100644 --- a/op-deployer/pkg/deployer/manage/add_game_type_test.go +++ b/op-deployer/pkg/deployer/manage/add_game_type_test.go @@ -12,6 +12,8 @@ import ( "github.com/ethereum-optimism/optimism/op-service/testlog" "github.com/ethereum-optimism/optimism/op-service/testutils" + "github.com/lmittmann/w3" + "github.com/lmittmann/w3/module/eth" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/standard" "github.com/ethereum/go-ethereum/superchain" @@ -23,6 +25,44 @@ import ( "github.com/urfave/cli/v2" ) +// getAddressesOnchain reads addresses from on-chain contracts (using chainConfig to get entrypoints) +func getAddressesOnchain(ctx context.Context, rpcURL string, chainConfig *superchain.ChainConfig) (opChainProxyAdmin, delayedWETHProxy common.Address, err error) { + var proxyAdminFn = w3.MustNewFunc("proxyAdmin()", "address") + var gameImplsFn = w3.MustNewFunc("gameImpls(uint32)", "address") + var wethFn = w3.MustNewFunc("weth()", "address") + + client, err := w3.Dial(rpcURL) + if err != nil { + return common.Address{}, common.Address{}, fmt.Errorf("failed to connect to RPC: %w", err) + } + defer client.Close() + + systemConfigProxy := *chainConfig.Addresses.SystemConfigProxy + disputeGameFactoryProxy := *chainConfig.Addresses.DisputeGameFactoryProxy + + // Read OPChainProxyAdmin from systemConfigProxy.proxyAdmin() + err = client.CallCtx(ctx, eth.CallFunc(systemConfigProxy, proxyAdminFn).Returns(&opChainProxyAdmin)) + if err != nil { + return common.Address{}, common.Address{}, fmt.Errorf("failed to read proxyAdmin from SystemConfig: %w", err) + } + + // Read permissionless dispute game address from disputeGameFactoryProxy.gameImpls(0) + // GameTypes.CANNON = 0 (permissionless) + var permissionlessDisputeGame common.Address + err = client.CallCtx(ctx, eth.CallFunc(disputeGameFactoryProxy, gameImplsFn, uint32(0)).Returns(&permissionlessDisputeGame)) + if err != nil { + return common.Address{}, common.Address{}, fmt.Errorf("failed to read gameImpls(0) from DisputeGameFactory: %w", err) + } + + // Read DelayedWETHProxy from permissionlessDisputeGame.weth() + err = client.CallCtx(ctx, eth.CallFunc(permissionlessDisputeGame, wethFn).Returns(&delayedWETHProxy)) + if err != nil { + return common.Address{}, common.Address{}, fmt.Errorf("failed to read weth from permissionless dispute game: %w", err) + } + + return opChainProxyAdmin, delayedWETHProxy, nil +} + func TestAddGameType(t *testing.T) { rpcURL := os.Getenv("SEPOLIA_RPC_URL") require.NotEmpty(t, rpcURL, "must specify RPC url via SEPOLIA_RPC_URL env var") @@ -31,20 +71,26 @@ func TestAddGameType(t *testing.T) { v200SepoliaAddrs := validation.StandardVersionsSepolia[standard.ContractsV200Tag] testCacheDir := testutils.IsolatedTestDirWithAutoCleanup(t) - supChain, err := superchain.GetChain(11155420) + chain, err := superchain.GetChain(11155420) require.NoError(t, err) - supChainConfig, err := supChain.Config() + chainConfig, err := chain.Config() require.NoError(t, err) + readCtx, readCancel := context.WithTimeout(context.Background(), 10*time.Second) + defer readCancel() + + opChainProxyAdmin, delayedWETHProxy, err := getAddressesOnchain(readCtx, rpcURL, chainConfig) + require.NoError(t, err, "failed to read addresses from chain") + cfg := AddGameTypeConfig{ L1RPCUrl: rpcURL, Logger: testlog.Logger(t, slog.LevelInfo), ArtifactsLocator: afacts, SaltMixer: "foo", // The values below were pulled from the Superchain Registry for OP Sepolia. - SystemConfigProxy: *supChainConfig.Addresses.SystemConfigProxy, - OPChainProxyAdmin: *supChainConfig.Addresses.ProxyAdmin, - DelayedWETHProxy: *supChainConfig.Addresses.DelayedWETHProxy, + SystemConfigProxy: *chainConfig.Addresses.SystemConfigProxy, + OPChainProxyAdmin: opChainProxyAdmin, + DelayedWETHProxy: delayedWETHProxy, DisputeGameType: 999, DisputeAbsolutePrestate: common.HexToHash("0x1234"), DisputeMaxGameDepth: big.NewInt(73), @@ -54,14 +100,15 @@ func TestAddGameType(t *testing.T) { InitialBond: big.NewInt(1), VM: common.Address(*v200SepoliaAddrs.Mips.Address), Permissionless: false, - L1ProxyAdminOwner: *supChainConfig.Roles.ProxyAdminOwner, + L1ProxyAdminOwner: *chainConfig.Roles.ProxyAdminOwner, OPCMImpl: common.Address(*v200SepoliaAddrs.OPContractsManager.Address), CacheDir: testCacheDir, } - ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second) - defer cancel() - output, broadcasts, err := AddGameType(ctx, cfg) + addCtx, addCancel := context.WithTimeout(context.Background(), 30*time.Second) + defer addCancel() + + output, broadcasts, err := AddGameType(addCtx, cfg) require.NoError(t, err) require.Equal(t, 1, len(broadcasts)) diff --git a/op-deployer/pkg/deployer/manage/migrate.go b/op-deployer/pkg/deployer/manage/migrate.go index c9a7636b521..af6c0744787 100644 --- a/op-deployer/pkg/deployer/manage/migrate.go +++ b/op-deployer/pkg/deployer/manage/migrate.go @@ -8,6 +8,8 @@ import ( "os" "strings" + "github.com/ethereum-optimism/optimism/op-service/ioutil" + "github.com/ethereum-optimism/optimism/op-chain-ops/script" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/artifacts" @@ -123,7 +125,7 @@ func MigrateCLI(cliCtx *cli.Context) error { } cacheDir := cliCtx.String(deployer.CacheDirFlag.Name) - artifactsFS, err := artifacts.Download(ctx, artifactsLocator, artifacts.BarProgressor(), cacheDir) + artifactsFS, err := artifacts.Download(ctx, artifactsLocator, ioutil.BarProgressor(), cacheDir) if err != nil { return fmt.Errorf("failed to download artifacts: %w", err) } diff --git a/op-deployer/pkg/deployer/opcm/implementations.go b/op-deployer/pkg/deployer/opcm/implementations.go index 767277c87d4..0633703ca17 100644 --- a/op-deployer/pkg/deployer/opcm/implementations.go +++ b/op-deployer/pkg/deployer/opcm/implementations.go @@ -14,6 +14,7 @@ type DeployImplementationsInput struct { ProofMaturityDelaySeconds *big.Int DisputeGameFinalityDelaySeconds *big.Int MipsVersion *big.Int + DevFeatureBitmap common.Hash SuperchainConfigProxy common.Address ProtocolVersionsProxy common.Address SuperchainProxyAdmin common.Address @@ -31,6 +32,7 @@ type DeployImplementationsOutput struct { OpcmStandardValidator common.Address `json:"opcmStandardValidatorAddress"` DelayedWETHImpl common.Address `json:"delayedWETHImplAddress"` OptimismPortalImpl common.Address `json:"optimismPortalImplAddress"` + OptimismPortalInteropImpl common.Address `json:"optimismPortalInteropImplAddress"` ETHLockboxImpl common.Address `json:"ethLockboxImplAddress" abi:"ethLockboxImpl"` PreimageOracleSingleton common.Address `json:"preimageOracleSingletonAddress"` MipsSingleton common.Address `json:"mipsSingletonAddress"` diff --git a/op-deployer/pkg/deployer/opcm/implementations_test.go b/op-deployer/pkg/deployer/opcm/implementations_test.go index e664c856944..6bba5d0115f 100644 --- a/op-deployer/pkg/deployer/opcm/implementations_test.go +++ b/op-deployer/pkg/deployer/opcm/implementations_test.go @@ -65,6 +65,7 @@ func TestNewDeployImplementationsScript(t *testing.T) { ProofMaturityDelaySeconds: big.NewInt(4), DisputeGameFinalityDelaySeconds: big.NewInt(5), MipsVersion: big.NewInt(mipsVersion), + DevFeatureBitmap: common.Hash{}, SuperchainConfigProxy: proxyAddress, ProtocolVersionsProxy: protocolVersionsAddress, SuperchainProxyAdmin: proxyAdminAddress, diff --git a/op-deployer/pkg/deployer/opcm/opchain.go b/op-deployer/pkg/deployer/opcm/opchain.go index 9d87fb4979a..76afa75fca5 100644 --- a/op-deployer/pkg/deployer/opcm/opchain.go +++ b/op-deployer/pkg/deployer/opcm/opchain.go @@ -93,6 +93,7 @@ type ReadImplementationAddressesInput struct { type ReadImplementationAddressesOutput struct { DelayedWETH common.Address OptimismPortal common.Address + OptimismPortalInterop common.Address ETHLockbox common.Address `evm:"ethLockbox"` SystemConfig common.Address L1CrossDomainMessenger common.Address diff --git a/op-deployer/pkg/deployer/pipeline/implementations.go b/op-deployer/pkg/deployer/pipeline/implementations.go index b4bd49501aa..15090ae32d8 100644 --- a/op-deployer/pkg/deployer/pipeline/implementations.go +++ b/op-deployer/pkg/deployer/pipeline/implementations.go @@ -6,6 +6,7 @@ import ( "github.com/ethereum-optimism/optimism/op-chain-ops/addresses" "github.com/ethereum-optimism/optimism/op-service/jsonutil" + "github.com/ethereum/go-ethereum/common" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/opcm" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/standard" @@ -30,6 +31,7 @@ func DeployImplementations(env *Env, intent *state.Intent, st *state.State) erro ProofMaturityDelaySeconds: standard.ProofMaturityDelaySeconds, DisputeGameFinalityDelaySeconds: standard.DisputeGameFinalityDelaySeconds, MIPSVersion: standard.MIPSVersion, + DevFeatureBitmap: common.Hash{}, }, intent.GlobalDeployOverrides, ) @@ -45,6 +47,7 @@ func DeployImplementations(env *Env, intent *state.Intent, st *state.State) erro ProofMaturityDelaySeconds: new(big.Int).SetUint64(proofParams.ProofMaturityDelaySeconds), DisputeGameFinalityDelaySeconds: new(big.Int).SetUint64(proofParams.DisputeGameFinalityDelaySeconds), MipsVersion: new(big.Int).SetUint64(proofParams.MIPSVersion), + DevFeatureBitmap: proofParams.DevFeatureBitmap, SuperchainConfigProxy: st.SuperchainDeployment.SuperchainConfigProxy, ProtocolVersionsProxy: st.SuperchainDeployment.ProtocolVersionsProxy, SuperchainProxyAdmin: st.SuperchainDeployment.SuperchainProxyAdminImpl, @@ -65,6 +68,7 @@ func DeployImplementations(env *Env, intent *state.Intent, st *state.State) erro OpcmStandardValidatorImpl: dio.OpcmStandardValidator, DelayedWethImpl: dio.DelayedWETHImpl, OptimismPortalImpl: dio.OptimismPortalImpl, + OptimismPortalInteropImpl: dio.OptimismPortalInteropImpl, EthLockboxImpl: dio.ETHLockboxImpl, PreimageOracleImpl: dio.PreimageOracleSingleton, MipsImpl: dio.MipsSingleton, diff --git a/op-deployer/pkg/deployer/pipeline/opchain.go b/op-deployer/pkg/deployer/pipeline/opchain.go index f44721dfd57..b1510a89a2d 100644 --- a/op-deployer/pkg/deployer/pipeline/opchain.go +++ b/op-deployer/pkg/deployer/pipeline/opchain.go @@ -59,6 +59,7 @@ func DeployOPChain(env *Env, intent *state.Intent, st *state.State, chainID comm st.ImplementationsDeployment.DelayedWethImpl = impls.DelayedWETH st.ImplementationsDeployment.OptimismPortalImpl = impls.OptimismPortal + st.ImplementationsDeployment.OptimismPortalInteropImpl = impls.OptimismPortalInterop st.ImplementationsDeployment.EthLockboxImpl = impls.ETHLockbox st.ImplementationsDeployment.SystemConfigImpl = impls.SystemConfig st.ImplementationsDeployment.L1CrossDomainMessengerImpl = impls.L1CrossDomainMessenger @@ -101,7 +102,7 @@ func makeDCI(intent *state.Intent, thisIntent *state.ChainIntent, chainID common L2ChainId: chainID.Big(), Opcm: st.ImplementationsDeployment.OpcmImpl, SaltMixer: st.Create2Salt.String(), // passing through salt generated at state initialization - GasLimit: standard.GasLimit, + GasLimit: thisIntent.GasLimit, DisputeGameType: proofParams.DisputeGameType, DisputeAbsolutePrestate: proofParams.DisputeAbsolutePrestate, DisputeMaxGameDepth: proofParams.DisputeMaxGameDepth, diff --git a/op-deployer/pkg/deployer/standard/standard.go b/op-deployer/pkg/deployer/standard/standard.go index 4b337997959..ffcbe2eeade 100644 --- a/op-deployer/pkg/deployer/standard/standard.go +++ b/op-deployer/pkg/deployer/standard/standard.go @@ -25,7 +25,7 @@ const ( ChallengePeriodSeconds uint64 = 86400 ProofMaturityDelaySeconds uint64 = 604800 DisputeGameFinalityDelaySeconds uint64 = 302400 - MIPSVersion uint64 = 7 + MIPSVersion uint64 = 8 DisputeGameType uint32 = 1 // PERMISSIONED game type DisputeMaxGameDepth uint64 = 73 DisputeSplitDepth uint64 = 30 diff --git a/op-deployer/pkg/deployer/state/chain_intent.go b/op-deployer/pkg/deployer/state/chain_intent.go index 3ad1a3dea3b..819bc9e3f1f 100644 --- a/op-deployer/pkg/deployer/state/chain_intent.go +++ b/op-deployer/pkg/deployer/state/chain_intent.go @@ -64,6 +64,7 @@ type ChainIntent struct { Eip1559DenominatorCanyon uint64 `json:"eip1559DenominatorCanyon" toml:"eip1559DenominatorCanyon"` Eip1559Denominator uint64 `json:"eip1559Denominator" toml:"eip1559Denominator"` Eip1559Elasticity uint64 `json:"eip1559Elasticity" toml:"eip1559Elasticity"` + GasLimit uint64 `json:"gasLimit" toml:"gasLimit"` Roles ChainRoles `json:"roles" toml:"roles"` DeployOverrides map[string]any `json:"deployOverrides" toml:"deployOverrides"` DangerousAltDAConfig genesis.AltDADeployConfig `json:"dangerousAltDAConfig,omitempty" toml:"dangerousAltDAConfig,omitempty"` @@ -71,6 +72,7 @@ type ChainIntent struct { OperatorFeeScalar uint32 `json:"operatorFeeScalar,omitempty" toml:"operatorFeeScalar,omitempty"` OperatorFeeConstant uint64 `json:"operatorFeeConstant,omitempty" toml:"operatorFeeConstant,omitempty"` L1StartBlockHash *common.Hash `json:"l1StartBlockHash,omitempty" toml:"l1StartBlockHash,omitempty"` + MinBaseFee uint64 `json:"minBaseFee,omitempty" toml:"minBaseFee,omitempty"` // Optional. For development purposes only. Only enabled if the operation mode targets a genesis-file output. L2DevGenesisParams *L2DevGenesisParams `json:"l2DevGenesisParams,omitempty" toml:"l2DevGenesisParams,omitempty"` @@ -87,6 +89,7 @@ type ChainRoles struct { } var ErrFeeVaultZeroAddress = fmt.Errorf("chain has a fee vault set to zero address") +var ErrGasLimitZeroValue = fmt.Errorf("chain has a gas limit set to zero value") var ErrNonStandardValue = fmt.Errorf("chain contains non-standard config value") var ErrEip1559ZeroValue = fmt.Errorf("eip1559 param is set to zero value") var ErrIncompatibleValue = fmt.Errorf("chain contains incompatible config value") @@ -105,6 +108,11 @@ func (c *ChainIntent) Check() error { c.Eip1559Elasticity == 0 { return fmt.Errorf("%w: chainId=%s", ErrEip1559ZeroValue, c.ID) } + + if c.GasLimit == 0 { + return fmt.Errorf("%w: chainId=%s", ErrGasLimitZeroValue, c.ID) + } + if c.BaseFeeVaultRecipient == emptyAddress || c.L1FeeVaultRecipient == emptyAddress || c.SequencerFeeVaultRecipient == emptyAddress { diff --git a/op-deployer/pkg/deployer/state/deploy_config.go b/op-deployer/pkg/deployer/state/deploy_config.go index 05123b143e3..d497e0d08eb 100644 --- a/op-deployer/pkg/deployer/state/deploy_config.go +++ b/op-deployer/pkg/deployer/state/deploy_config.go @@ -39,7 +39,7 @@ func CombineDeployConfig(intent *Intent, chainIntent *ChainIntent, state *State, FundDevAccounts: intent.FundDevAccounts, }, L2GenesisBlockDeployConfig: genesis.L2GenesisBlockDeployConfig{ - L2GenesisBlockGasLimit: 60_000_000, + L2GenesisBlockGasLimit: hexutil.Uint64(chainIntent.GasLimit), L2GenesisBlockBaseFeePerGas: &l2GenesisBlockBaseFeePerGas, }, L2VaultsDeployConfig: genesis.L2VaultsDeployConfig{ @@ -60,8 +60,8 @@ func CombineDeployConfig(intent *Intent, chainIntent *ChainIntent, state *State, GovernanceTokenOwner: standard.GovernanceTokenOwner, }, GasPriceOracleDeployConfig: genesis.GasPriceOracleDeployConfig{ - GasPriceOracleBaseFeeScalar: 1368, - GasPriceOracleBlobBaseFeeScalar: 810949, + GasPriceOracleBaseFeeScalar: standard.BasefeeScalar, + GasPriceOracleBlobBaseFeeScalar: standard.BlobBaseFeeScalar, GasPriceOracleOperatorFeeScalar: chainIntent.OperatorFeeScalar, GasPriceOracleOperatorFeeConstant: chainIntent.OperatorFeeConstant, }, diff --git a/op-deployer/pkg/deployer/state/deploy_config_test.go b/op-deployer/pkg/deployer/state/deploy_config_test.go index 53d33d5874f..a91a90a8cbc 100644 --- a/op-deployer/pkg/deployer/state/deploy_config_test.go +++ b/op-deployer/pkg/deployer/state/deploy_config_test.go @@ -5,6 +5,7 @@ import ( "github.com/ethereum-optimism/optimism/op-chain-ops/addresses" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/artifacts" + "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/standard" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/common/hexutil" "github.com/stretchr/testify/require" @@ -21,6 +22,7 @@ func TestCombineDeployConfig(t *testing.T) { chainIntent := ChainIntent{ Eip1559Denominator: 1, Eip1559Elasticity: 2, + GasLimit: standard.GasLimit, BaseFeeVaultRecipient: common.HexToAddress("0x123"), L1FeeVaultRecipient: common.HexToAddress("0x456"), SequencerFeeVaultRecipient: common.HexToAddress("0x789"), diff --git a/op-deployer/pkg/deployer/state/intent.go b/op-deployer/pkg/deployer/state/intent.go index 410f0bd4369..e12c356a212 100644 --- a/op-deployer/pkg/deployer/state/intent.go +++ b/op-deployer/pkg/deployer/state/intent.go @@ -29,12 +29,13 @@ var emptyAddress common.Address var emptyHash common.Hash type SuperchainProofParams struct { - WithdrawalDelaySeconds uint64 `json:"faultGameWithdrawalDelay" toml:"faultGameWithdrawalDelay"` - MinProposalSizeBytes uint64 `json:"preimageOracleMinProposalSize" toml:"preimageOracleMinProposalSize"` - ChallengePeriodSeconds uint64 `json:"preimageOracleChallengePeriod" toml:"preimageOracleChallengePeriod"` - ProofMaturityDelaySeconds uint64 `json:"proofMaturityDelaySeconds" toml:"proofMaturityDelaySeconds"` - DisputeGameFinalityDelaySeconds uint64 `json:"disputeGameFinalityDelaySeconds" toml:"disputeGameFinalityDelaySeconds"` - MIPSVersion uint64 `json:"mipsVersion" toml:"mipsVersion"` + WithdrawalDelaySeconds uint64 `json:"faultGameWithdrawalDelay" toml:"faultGameWithdrawalDelay"` + MinProposalSizeBytes uint64 `json:"preimageOracleMinProposalSize" toml:"preimageOracleMinProposalSize"` + ChallengePeriodSeconds uint64 `json:"preimageOracleChallengePeriod" toml:"preimageOracleChallengePeriod"` + ProofMaturityDelaySeconds uint64 `json:"proofMaturityDelaySeconds" toml:"proofMaturityDelaySeconds"` + DisputeGameFinalityDelaySeconds uint64 `json:"disputeGameFinalityDelaySeconds" toml:"disputeGameFinalityDelaySeconds"` + MIPSVersion uint64 `json:"mipsVersion" toml:"mipsVersion"` + DevFeatureBitmap common.Hash `json:"devFeatureBitmap" toml:"devFeatureBitmap"` } type L1DevGenesisBlockParams struct { @@ -151,6 +152,9 @@ func (c *Intent) validateStandardValues() error { chain.Eip1559Elasticity != standard.Eip1559Elasticity { return fmt.Errorf("%w: chainId=%s", ErrNonStandardValue, chain.ID) } + if chain.GasLimit != standard.GasLimit { + return fmt.Errorf("%w: chainId=%s", ErrNonStandardValue, chain.ID) + } if len(chain.AdditionalDisputeGames) > 0 { return fmt.Errorf("%w: chainId=%s additionalDisputeGames must be nil", ErrNonStandardValue, chain.ID) } @@ -293,7 +297,8 @@ func NewIntentCustom(l1ChainId uint64, l2ChainIds []common.Hash) (Intent, error) for _, l2ChainID := range l2ChainIds { intent.Chains = append(intent.Chains, &ChainIntent{ - ID: l2ChainID, + ID: l2ChainID, + GasLimit: standard.GasLimit, }) } return intent, nil @@ -332,6 +337,7 @@ func NewIntentStandard(l1ChainId uint64, l2ChainIds []common.Hash) (Intent, erro Eip1559DenominatorCanyon: standard.Eip1559DenominatorCanyon, Eip1559Denominator: standard.Eip1559Denominator, Eip1559Elasticity: standard.Eip1559Elasticity, + GasLimit: standard.GasLimit, Roles: ChainRoles{ Challenger: challenger, L1ProxyAdminOwner: l1ProxyAdminOwner, diff --git a/op-deployer/pkg/deployer/testutil/env.go b/op-deployer/pkg/deployer/testutil/env.go index a8d9147c3e9..175fecb7d7a 100644 --- a/op-deployer/pkg/deployer/testutil/env.go +++ b/op-deployer/pkg/deployer/testutil/env.go @@ -8,6 +8,8 @@ import ( "runtime" "testing" + "github.com/ethereum-optimism/optimism/op-service/ioutil" + "github.com/ethereum-optimism/optimism/op-chain-ops/foundry" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/artifacts" op_service "github.com/ethereum-optimism/optimism/op-service" @@ -29,7 +31,7 @@ func LocalArtifacts(t *testing.T) (*artifacts.Locator, foundry.StatDirFs) { testCacheDir := testutils.IsolatedTestDirWithAutoCleanup(t) - artifactsFS, err := artifacts.Download(context.Background(), loc, artifacts.NoopProgressor(), testCacheDir) + artifactsFS, err := artifacts.Download(context.Background(), loc, ioutil.NoopProgressor(), testCacheDir) require.NoError(t, err) return loc, artifactsFS diff --git a/op-deployer/pkg/deployer/upgrade/upgrader.go b/op-deployer/pkg/deployer/upgrade/upgrader.go index 2bd6edd2a88..b60c368bce9 100644 --- a/op-deployer/pkg/deployer/upgrade/upgrader.go +++ b/op-deployer/pkg/deployer/upgrade/upgrader.go @@ -6,6 +6,8 @@ import ( "fmt" "os" + "github.com/ethereum-optimism/optimism/op-service/ioutil" + "github.com/ethereum-optimism/optimism/op-chain-ops/script" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/artifacts" @@ -55,7 +57,7 @@ func UpgradeCLI(upgrader Upgrader) func(*cli.Context) error { depAddr := common.Address{'D'} cacheDir := cliCtx.String(deployer.CacheDirFlag.Name) - artifactsFS, err := artifacts.Download(ctx, artifactsLocator, artifacts.BarProgressor(), cacheDir) + artifactsFS, err := artifacts.Download(ctx, artifactsLocator, ioutil.BarProgressor(), cacheDir) if err != nil { return fmt.Errorf("failed to download L1 artifacts: %w", err) } diff --git a/op-deployer/pkg/deployer/utils.go b/op-deployer/pkg/deployer/utils.go new file mode 100644 index 00000000000..382fdcffd0e --- /dev/null +++ b/op-deployer/pkg/deployer/utils.go @@ -0,0 +1,58 @@ +package deployer + +import ( + "fmt" + "log" + "os" + "path" +) + +type DeploymentTarget string + +const ( + DeploymentTargetLive DeploymentTarget = "live" + DeploymentTargetGenesis DeploymentTarget = "genesis" + DeploymentTargetCalldata DeploymentTarget = "calldata" + DeploymentTargetNoop DeploymentTarget = "noop" +) + +func NewDeploymentTarget(s string) (DeploymentTarget, error) { + switch s { + case string(DeploymentTargetLive): + return DeploymentTargetLive, nil + case string(DeploymentTargetGenesis): + return DeploymentTargetGenesis, nil + case string(DeploymentTargetCalldata): + return DeploymentTargetCalldata, nil + case string(DeploymentTargetNoop): + return DeploymentTargetNoop, nil + default: + return "", fmt.Errorf("invalid deployment target: %s", s) + } +} + +func cwd() string { + dir, err := os.Getwd() + if err != nil { + return "" + } + return dir +} + +func EnsureDefaultCacheDir() string { + var cacheDir string + + homeDir, err := os.UserHomeDir() + if err != nil { + cacheDir = ".op-deployer/cache" + log.Printf("error getting user home directory: %v, using fallback directory: %s\n", err, cacheDir) + } else { + cacheDir = path.Join(homeDir, ".op-deployer/cache") + } + + if err := os.MkdirAll(cacheDir, 0755); err != nil { + panic(fmt.Sprintf("failed to create cache directory %s: %v", cacheDir, err)) + } + + return cacheDir +} diff --git a/op-deployer/pkg/deployer/utils_test.go b/op-deployer/pkg/deployer/utils_test.go new file mode 100644 index 00000000000..a4ff0d5e7ef --- /dev/null +++ b/op-deployer/pkg/deployer/utils_test.go @@ -0,0 +1,12 @@ +package deployer + +import ( + "testing" + + "github.com/stretchr/testify/require" +) + +func TestEnsureDefaultCacheDir(t *testing.T) { + cacheDir := EnsureDefaultCacheDir() + require.NotNil(t, cacheDir) +} diff --git a/op-deployer/pkg/deployer/verify/verifier.go b/op-deployer/pkg/deployer/verify/verifier.go index ec48b9d6918..69746ff607a 100644 --- a/op-deployer/pkg/deployer/verify/verifier.go +++ b/op-deployer/pkg/deployer/verify/verifier.go @@ -88,7 +88,7 @@ func VerifyCLI(cliCtx *cli.Context) error { if err != nil { return fmt.Errorf("failed to parse l1 contracts release locator: %w", err) } - artifactsFS, err := artifacts.Download(ctx, locator, nil, deployer.GetDefaultCacheDir()) + artifactsFS, err := artifacts.Download(ctx, locator, nil, deployer.EnsureDefaultCacheDir()) if err != nil { return fmt.Errorf("failed to get artifacts: %w", err) } diff --git a/op-devstack/README.md b/op-devstack/README.md index 119e6b385b7..811be91edc9 100644 --- a/op-devstack/README.md +++ b/op-devstack/README.md @@ -151,4 +151,13 @@ The following environment variables can be used to configure devstack: - `DEVSTACK_ORCHESTRATOR`: Configures the preferred orchestrator kind (see Orchestrator interface section above). - `DEVSTACK_KEYS_SALT`: Seeds the keys generated with `NewHDWallet`. This is useful for "isolating" test runs, and might be needed to reproduce CI and/or acceptance test runs. It can be any string, including the empty one to use the "usual" devkeys. - `DEVNET_ENV_URL`: Used when `DEVSTACK_ORCHESTRATOR=sysext` to specify the network descriptor URL. -- `DEVNET_EXPECT_PRECONDITIONS_MET`: This can be set of force test failures when their pre-conditions are not met, which would otherwise result in them being skipped. This is helpful in particular for runs that do intend to run specific tests (as opposed to whatever is available). `op-acceptor` does set that variable, for example. \ No newline at end of file +- `DEVNET_EXPECT_PRECONDITIONS_MET`: This can be set of force test failures when their pre-conditions are not met, which would otherwise result in them being skipped. This is helpful in particular for runs that do intend to run specific tests (as opposed to whatever is available). `op-acceptor` does set that variable, for example. + +Rust stack env vars: +- `DEVSTACK_L2CL_KIND=kona` to select kona as default L2 CL node +- `DEVSTACK_L2EL_KIND=op-reth` to select op-reth as default L2 EL node +- `KONA_NODE_EXEC_PATH=/home/USERHERE/projects/kona/target/debug/kona-node` to select the kona-node executable to run +- `OP_RETH_EXEC_PATH=/home/USERHERE/projects/reth/target/release/op-reth` to select the op-reth executable to run + +Other useful env vars: +- `DISABLE_OP_E2E_LEGACY=true` to disable the op-e2e package from loading build-artifacts that are not used by devstack. diff --git a/op-devstack/dsl/bridge.go b/op-devstack/dsl/bridge.go index 1f7f54438a6..8f59070d7d5 100644 --- a/op-devstack/dsl/bridge.go +++ b/op-devstack/dsl/bridge.go @@ -5,6 +5,7 @@ import ( "errors" "fmt" "math/big" + "strings" "time" "github.com/ethereum-optimism/optimism/op-chain-ops/crossdomain" @@ -129,7 +130,19 @@ func (b *StandardBridge) RespectedGameType() uint32 { return gameType } +func (b *StandardBridge) PortalVersion() string { + version, err := contractio.Read(b.l1Portal.Version(), b.ctx) + b.require.NoError(err, "Failed to read portal version") + return version +} + func (b *StandardBridge) UsesSuperRoots() bool { + // Only interop contracts have SuperRootsActive functionality + version := b.PortalVersion() + if !strings.HasSuffix(version, "+interop") { + return false + } + superRootsActive, err := contractio.Read(b.l1Portal.SuperRootsActive(), b.ctx) b.require.NoError(err, "Failed to read super roots active") return superRootsActive diff --git a/op-devstack/dsl/ecotone_fees.go b/op-devstack/dsl/ecotone_fees.go index 3412f893c49..d1970a94b92 100644 --- a/op-devstack/dsl/ecotone_fees.go +++ b/op-devstack/dsl/ecotone_fees.go @@ -54,29 +54,40 @@ func (ef *EcotoneFees) ValidateTransaction(from *EOA, to *EOA, amount *big.Int) ef.require.NoError(err) ef.require.Equal(types.ReceiptStatusSuccessful, receipt.Status) + // Get block info for base fee information + blockInfo, err := client.InfoByHash(ef.ctx, receipt.BlockHash) + ef.require.NoError(err) + endBalance := from.GetBalance() vaultsAfter := ef.getVaultBalances(client) vaultIncreases := ef.calculateVaultIncreases(vaultsBefore, vaultsAfter) - l1Fee := big.NewInt(0) - if receipt.L1Fee != nil { - l1Fee = receipt.L1Fee - } + // In Ecotone, L1 fee includes both base fee and blob base fee components + l1Fee := vaultIncreases.L1FeeVault // Use actual vault increase as the source of truth - block, err := client.InfoByHash(ef.ctx, receipt.BlockHash) - ef.require.NoError(err) + // Calculate receipt-based fees for validation + receiptBaseFee := new(big.Int).Mul(blockInfo.BaseFee(), big.NewInt(int64(receipt.GasUsed))) + receiptL2Fee := new(big.Int).Mul(receipt.EffectiveGasPrice, big.NewInt(int64(receipt.GasUsed))) + + // Calculate L2 fees from vault increases + baseFee := vaultIncreases.BaseFeeVault // Use actual vault increase as the source of truth + priorityFee := vaultIncreases.SequencerVault // Use actual vault increase as the source of truth + l2Fee := new(big.Int).Add(baseFee, priorityFee) - baseFee := new(big.Int).Mul(block.BaseFee(), big.NewInt(int64(receipt.GasUsed))) - l2Fee := new(big.Int).Mul(receipt.EffectiveGasPrice, big.NewInt(int64(receipt.GasUsed))) - priorityFee := new(big.Int).Sub(l2Fee, baseFee) - totalFee := new(big.Int).Add(l1Fee, l2Fee) + // Total fee is the sum of all vault increases (excluding OperatorVault which should be zero in Ecotone) + totalFee := new(big.Int).Add(vaultIncreases.BaseFeeVault, vaultIncreases.L1FeeVault) + totalFee.Add(totalFee, vaultIncreases.SequencerVault) walletBalanceDiff := new(big.Int).Sub(startBalance.ToBig(), endBalance.ToBig()) walletBalanceDiff.Sub(walletBalanceDiff, amount) - ef.validateFeeDistribution(l1Fee, baseFee, priorityFee, vaultIncreases) + // Validate total balance first to ensure all fees are accounted for ef.validateTotalBalance(walletBalanceDiff, totalFee, vaultIncreases) + + // Then validate individual fee components + ef.validateFeeDistribution(l1Fee, baseFee, priorityFee, vaultIncreases) ef.validateEcotoneFeatures(receipt, l1Fee) + ef.validateReceiptFees(receipt, l1Fee, baseFee, l2Fee, receiptBaseFee, receiptL2Fee) return EcotoneFeesValidationResult{ TransactionReceipt: receipt, @@ -129,13 +140,15 @@ func (ef *EcotoneFees) validateFeeDistribution(l1Fee, baseFee, priorityFee *big. ef.require.Equal(baseFee, vaults.BaseFeeVault, "Base fee must match BaseFeeVault increase") ef.require.Equal(priorityFee, vaults.SequencerVault, "Priority fee must match SequencerFeeVault increase") - ef.require.True(vaults.OperatorVault.Sign() >= 0, "Operator vault increase must be non-negative") + // In Ecotone, operator fees should not exist (introduced in Isthmus) + ef.require.Equal(vaults.OperatorVault.Cmp(big.NewInt(0)), 0, + "Operator vault increase must be zero in Ecotone (operator fees introduced in Isthmus)") } func (ef *EcotoneFees) validateTotalBalance(walletDiff *big.Int, totalFee *big.Int, vaults VaultBalances) { + // In Ecotone, only BaseFeeVault, L1FeeVault, and SequencerVault should have increases totalVaultIncrease := new(big.Int).Add(vaults.BaseFeeVault, vaults.L1FeeVault) totalVaultIncrease.Add(totalVaultIncrease, vaults.SequencerVault) - totalVaultIncrease.Add(totalVaultIncrease, vaults.OperatorVault) ef.require.Equal(walletDiff, totalFee, "Wallet balance difference must equal total fees") ef.require.Equal(totalVaultIncrease, totalFee, "Total vault increases must equal total fees") @@ -149,6 +162,27 @@ func (ef *EcotoneFees) validateEcotoneFeatures(receipt *types.Receipt, l1Fee *bi ef.require.Greater(receipt.EffectiveGasPrice.Uint64(), uint64(0), "Effective gas price should be > 0") } +func (ef *EcotoneFees) validateReceiptFees(receipt *types.Receipt, l1Fee, vaultBaseFee, vaultL2Fee, receiptBaseFee, receiptL2Fee *big.Int) { + // Check that receipt's L1Fee matches the vault increase + if receipt.L1Fee != nil { + ef.require.Equal(receipt.L1Fee, l1Fee, "Receipt L1Fee must match L1FeeVault increase") + } + + // Sanity check: Receipt-calculated fees should match vault-based fees + ef.require.Equal(receiptBaseFee, vaultBaseFee, + "Receipt-calculated base fee (block.BaseFee * gasUsed) must match BaseFeeVault increase") + ef.require.Equal(receiptL2Fee, vaultL2Fee, + "Receipt-calculated L2 fee (effectiveGasPrice * gasUsed) must match L2 vault increases (BaseFee + SequencerFee)") + + // Validate receipt-based calculations are positive + ef.require.True(receiptBaseFee.Sign() > 0, "Receipt-based base fee must be positive") + ef.require.True(receiptL2Fee.Sign() > 0, "Receipt-based L2 fee must be positive") + + // The effective gas price should be consistent with the calculated L2 fee + ef.require.Equal(receiptL2Fee.Cmp(receiptBaseFee) >= 0, true, + "Receipt L2 fee (effectiveGasPrice * gasUsed) should be >= base fee") +} + func (ef *EcotoneFees) LogResults(result EcotoneFeesValidationResult) { ef.log.Info("Comprehensive Ecotone fees validation completed", "gasUsed", result.TransactionReceipt.GasUsed, diff --git a/op-devstack/dsl/eoa.go b/op-devstack/dsl/eoa.go index 6d9d54b938e..49ce2063c48 100644 --- a/op-devstack/dsl/eoa.go +++ b/op-devstack/dsl/eoa.go @@ -6,10 +6,6 @@ import ( "math/rand" "time" - "github.com/ethereum/go-ethereum/common" - "github.com/ethereum/go-ethereum/core/types" - "github.com/ethereum/go-ethereum/params" - "github.com/ethereum-optimism/optimism/devnet-sdk/contracts/bindings" "github.com/ethereum-optimism/optimism/devnet-sdk/contracts/constants" "github.com/ethereum-optimism/optimism/op-acceptance-tests/tests/interop" @@ -20,6 +16,8 @@ import ( txIntentBindings "github.com/ethereum-optimism/optimism/op-service/txintent/bindings" "github.com/ethereum-optimism/optimism/op-service/txintent/contractio" "github.com/ethereum-optimism/optimism/op-service/txplan" + "github.com/ethereum/go-ethereum/common" + "github.com/ethereum/go-ethereum/core/types" ) // EOA is an Externally-Owned-Account: @@ -81,14 +79,26 @@ func (u *EOA) Plan() txplan.Option { ) } +func (u *EOA) PlanAuth(code common.Address) txplan.Option { + toAddr := u.Address() + return txplan.Combine( + u.Plan(), + txplan.WithType(types.SetCodeTxType), + txplan.WithTo(&toAddr), + txplan.WithAuthorizationTo(code), + // Set a fixed gas limit because eth_estimateGas doesn't consider authorizations yet. + txplan.WithGasLimit(75_000), + ) +} + // PlanTransfer creates the tx-plan options to perform a transfer // of the given amount of ETH to the given account. func (u *EOA) PlanTransfer(to common.Address, amount eth.ETH) txplan.Option { return txplan.Combine( u.Plan(), txplan.WithTo(&to), - txplan.WithValue(amount.ToBig()), - txplan.WithGasLimit(params.TxGas), + txplan.WithValue(amount), + // Don't set gas explicitly since the transfer might be to a contract ) } @@ -143,8 +153,8 @@ func (u *EOA) VerifyBalanceAtLeast(v eth.ETH) { func (u *EOA) WaitForBalance(v eth.ETH) { u.t.Require().Eventually(func() bool { - u.VerifyBalanceExact(v) - return true + actual := u.balance() + return actual == v }, u.el.stackEL().TransactionTimeout(), time.Second, "awaiting balance to be updated") } diff --git a/op-devstack/dsl/fb_builder.go b/op-devstack/dsl/fb_builder.go index 57b49baa821..0820d9c46db 100644 --- a/op-devstack/dsl/fb_builder.go +++ b/op-devstack/dsl/fb_builder.go @@ -51,5 +51,5 @@ func (c *FlashblocksBuilderNode) Conductor() *Conductor { } func (c *FlashblocksBuilderNode) ListenFor(logger log.Logger, duration time.Duration, output chan<- []byte, done chan<- struct{}) error { - return websocketListenFor(logger, c.inner.FlashblocksWsUrl(), duration, output, done) + return websocketListenFor(logger, c.inner.FlashblocksWsUrl(), c.inner.FlashblocksWsHeaders(), duration, output, done) } diff --git a/op-devstack/dsl/fb_ws_proxy.go b/op-devstack/dsl/fb_ws_proxy.go index fa20cd0b274..72fa8c5e3a6 100644 --- a/op-devstack/dsl/fb_ws_proxy.go +++ b/op-devstack/dsl/fb_ws_proxy.go @@ -2,6 +2,7 @@ package dsl import ( "fmt" + "net/http" "strings" "time" @@ -41,29 +42,53 @@ func (c *FlashblocksWebsocketProxy) Escape() stack.FlashblocksWebsocketProxy { } func (c *FlashblocksWebsocketProxy) ListenFor(logger log.Logger, duration time.Duration, output chan<- []byte, done chan<- struct{}) error { - return websocketListenFor(logger, c.Escape().WsUrl(), duration, output, done) + wsURL := c.Escape().WsUrl() + headers := c.Escape().WsHeaders() + return websocketListenFor(logger, wsURL, headers, duration, output, done) } -func websocketListenFor(logger log.Logger, wsURL string, duration time.Duration, output chan<- []byte, done chan<- struct{}) error { +func websocketListenFor(logger log.Logger, wsURL string, headers http.Header, duration time.Duration, output chan<- []byte, done chan<- struct{}) error { defer close(done) - logger.Debug("Testing WebSocket connection to", "url", wsURL) + logger.Debug("Testing WebSocket connection to", "url", wsURL, "headers", headers) + + // Log the headers for debug purposes + if headers != nil { + for key, values := range headers { + logger.Debug("Header", "key", key, "values", values) + } + } else { + logger.Debug("No headers provided") + } dialer := &websocket.Dialer{ HandshakeTimeout: 6 * time.Second, } - conn, _, err := dialer.Dial(wsURL, nil) + // Always close the response body to prevent resource leaks + logger.Debug("Attempting WebSocket connection", "url", wsURL) + conn, resp, err := dialer.Dial(wsURL, headers) if err != nil { + logger.Error("WebSocket connection failed", "url", wsURL, "error", err) + if resp != nil { + logger.Error("HTTP response details", "status", resp.Status, "headers", resp.Header) + resp.Body.Close() + } return fmt.Errorf("failed to connect to Flashblocks WebSocket endpoint %s: %w", wsURL, err) } + + if resp != nil { + defer resp.Body.Close() + } defer conn.Close() - logger.Info("WebSocket connection established, reading stream for %s", duration) + logger.Info("WebSocket connection established successfully", "url", wsURL, "reading stream for", duration) timeout := time.After(duration) + messageCount := 0 for { select { case <-timeout: + logger.Info("WebSocket read timeout reached", "total_messages", messageCount) return nil default: err = conn.SetReadDeadline(time.Now().Add(duration)) @@ -72,12 +97,17 @@ func websocketListenFor(logger log.Logger, wsURL string, duration time.Duration, } _, message, err := conn.ReadMessage() if err != nil && !strings.Contains(err.Error(), "timeout") { + logger.Error("Error reading WebSocket message", "error", err, "message_count", messageCount) return fmt.Errorf("error reading WebSocket message: %w", err) } if err == nil { + messageCount++ + logger.Debug("Received WebSocket message", "message_count", messageCount, "message_length", len(message)) select { case output <- message: + logger.Debug("Message sent to output channel", "message_count", messageCount) case <-timeout: // to avoid indefinite hang + logger.Info("Timeout while sending message to output channel", "total_messages", messageCount) return nil } } diff --git a/op-devstack/dsl/fjord_fees.go b/op-devstack/dsl/fjord_fees.go new file mode 100644 index 00000000000..b27566634c7 --- /dev/null +++ b/op-devstack/dsl/fjord_fees.go @@ -0,0 +1,369 @@ +package dsl + +import ( + "context" + "fmt" + "math/big" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/stack/match" + "github.com/ethereum-optimism/optimism/op-service/apis" + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum-optimism/optimism/op-service/predeploys" + "github.com/ethereum-optimism/optimism/op-service/txintent/bindings" + "github.com/ethereum-optimism/optimism/op-service/txintent/contractio" + "github.com/ethereum-optimism/optimism/op-service/txplan" + "github.com/ethereum/go-ethereum/common" + "github.com/ethereum/go-ethereum/core/types" +) + +type FjordFees struct { + commonImpl + l2Network *L2Network +} + +type FjordFeesValidationResult struct { + TransactionReceipt *types.Receipt + L1Fee *big.Int + L2Fee *big.Int + BaseFee *big.Int + PriorityFee *big.Int + TotalFee *big.Int + VaultBalances VaultBalances + WalletBalanceDiff *big.Int + TransferAmount *big.Int + FastLzSize uint64 + EstimatedBrotliSize *big.Int + OperatorFee *big.Int + CoinbaseDiff *big.Int +} + +func NewFjordFees(t devtest.T, l2Network *L2Network) *FjordFees { + return &FjordFees{ + commonImpl: commonFromT(t), + l2Network: l2Network, + } +} + +// ValidateTransaction validates the transaction and returns the validation result +func (ff *FjordFees) ValidateTransaction(from *EOA, to *EOA, amount *big.Int) FjordFeesValidationResult { + client := ff.l2Network.inner.L2ELNode(match.FirstL2EL).EthClient() + + startBalance := from.GetBalance() + vaultsBefore := ff.getVaultBalances(client) + coinbaseStartBalance := ff.getCoinbaseBalance(client) + + tx := from.Transfer(to.Address(), eth.WeiBig(amount)) + receipt, err := tx.Included.Eval(ff.ctx) + ff.require.NoError(err) + ff.require.Equal(types.ReceiptStatusSuccessful, receipt.Status) + + endBalance := from.GetBalance() + vaultsAfter := ff.getVaultBalances(client) + vaultIncreases := ff.calculateVaultIncreases(vaultsBefore, vaultsAfter) + coinbaseEndBalance := ff.getCoinbaseBalance(client) + coinbaseDiff := new(big.Int).Sub(coinbaseEndBalance, coinbaseStartBalance) + + l1Fee := big.NewInt(0) + if receipt.L1Fee != nil { + l1Fee = receipt.L1Fee + } + + block, err := client.InfoByHash(ff.ctx, receipt.BlockHash) + ff.require.NoError(err) + + baseFee := new(big.Int).Mul(block.BaseFee(), big.NewInt(int64(receipt.GasUsed))) + totalGasFee := new(big.Int).Mul(receipt.EffectiveGasPrice, big.NewInt(int64(receipt.GasUsed))) + priorityFee := new(big.Int).Sub(totalGasFee, baseFee) + + l2Fee := new(big.Int).Set(priorityFee) + + operatorFee := vaultIncreases.OperatorVault + + ff.validateVaultIncreaseFees(l2Fee, baseFee, priorityFee, l1Fee, operatorFee, coinbaseDiff, vaultsAfter, vaultsBefore) + + totalFee := new(big.Int).Add(l1Fee, l2Fee) + totalFee.Add(totalFee, baseFee) + totalFee.Add(totalFee, operatorFee) + + walletBalanceDiff := new(big.Int).Sub(startBalance.ToBig(), endBalance.ToBig()) + walletBalanceDiff.Sub(walletBalanceDiff, amount) + + fastLzSize, estimatedBrotliSize := ff.validateFjordFeatures(receipt, l1Fee) + ff.validateFeeDistribution(l1Fee, baseFee, priorityFee, operatorFee, vaultIncreases) + ff.validateTotalBalance(walletBalanceDiff, totalFee, vaultIncreases) + + return FjordFeesValidationResult{ + TransactionReceipt: receipt, + L1Fee: l1Fee, + L2Fee: l2Fee, + BaseFee: baseFee, + PriorityFee: priorityFee, + TotalFee: totalFee, + VaultBalances: vaultIncreases, + WalletBalanceDiff: walletBalanceDiff, + TransferAmount: amount, + FastLzSize: fastLzSize, + EstimatedBrotliSize: estimatedBrotliSize, + OperatorFee: operatorFee, + CoinbaseDiff: coinbaseDiff, + } +} + +// getVaultBalances gets the balances of the vaults +func (ff *FjordFees) getVaultBalances(client apis.EthClient) VaultBalances { + baseFee := ff.getBalance(client, predeploys.BaseFeeVaultAddr) + l1Fee := ff.getBalance(client, predeploys.L1FeeVaultAddr) + sequencer := ff.getBalance(client, predeploys.SequencerFeeVaultAddr) + operator := ff.getBalance(client, predeploys.OperatorFeeVaultAddr) + + return VaultBalances{ + BaseFeeVault: baseFee, + L1FeeVault: l1Fee, + SequencerVault: sequencer, + OperatorVault: operator, + } +} + +// getBalance gets the balance of an address +func (ff *FjordFees) getBalance(client apis.EthClient, addr common.Address) *big.Int { + balance, err := client.BalanceAt(ff.ctx, addr, nil) + ff.require.NoError(err) + return balance +} + +// calculateVaultIncreases calculates the increases in the vaults +func (ff *FjordFees) calculateVaultIncreases(before, after VaultBalances) VaultBalances { + return VaultBalances{ + BaseFeeVault: new(big.Int).Sub(after.BaseFeeVault, before.BaseFeeVault), + L1FeeVault: new(big.Int).Sub(after.L1FeeVault, before.L1FeeVault), + SequencerVault: new(big.Int).Sub(after.SequencerVault, before.SequencerVault), + OperatorVault: new(big.Int).Sub(after.OperatorVault, before.OperatorVault), + } +} + +// validateFjordFeatures validates that the features of the Fjord transaction are correct +func (ff *FjordFees) validateFjordFeatures(receipt *types.Receipt, l1Fee *big.Int) (uint64, *big.Int) { + ff.require.NotNil(receipt.L1Fee, "L1 fee should be present in Fjord") + ff.require.True(l1Fee.Cmp(big.NewInt(0)) > 0, "L1 fee should be greater than 0 in Fjord") + + client := ff.l2Network.inner.L2ELNode(match.FirstL2EL).EthClient() + + _, txs, err := client.InfoAndTxsByHash(ff.ctx, receipt.BlockHash) + ff.require.NoError(err) + + var signedTx *types.Transaction + for _, tx := range txs { + if tx.Hash() == receipt.TxHash { + signedTx = tx + break + } + } + ff.require.NotNil(signedTx, "should find the signed transaction") + + unsignedTx := types.NewTx(&types.DynamicFeeTx{ + Nonce: signedTx.Nonce(), + To: signedTx.To(), + Value: signedTx.Value(), + Gas: signedTx.Gas(), + GasFeeCap: signedTx.GasFeeCap(), + GasTipCap: signedTx.GasTipCap(), + Data: signedTx.Data(), + }) + + txUnsigned, err := unsignedTx.MarshalBinary() + ff.require.NoError(err) + txSigned, err := signedTx.MarshalBinary() + ff.require.NoError(err) + + fastLzSizeUnsigned := uint64(types.FlzCompressLen(txUnsigned) + 68) // overhead used by the original test + fastLzSizeSigned := uint64(types.FlzCompressLen(txSigned)) + + // Validate that FastLZ compression produces reasonable results + ff.require.Greater(fastLzSizeUnsigned, uint64(0), "FastLZ size should be positive") + ff.require.Greater(fastLzSizeSigned, uint64(0), "FastLZ size should be positive") + + txLenGPO := len(txUnsigned) + 68 + flzUpperBound := uint64(txLenGPO + txLenGPO/255 + 16) + ff.require.LessOrEqual(fastLzSizeUnsigned, flzUpperBound, "Compressed size should not exceed upper bound") + + signedUpperBound := uint64(len(txSigned) + len(txSigned)/255 + 16) + ff.require.LessOrEqual(fastLzSizeSigned, signedUpperBound, "Compressed size should not exceed upper bound") + + receiptL1Fee := receipt.L1Fee + if receiptL1Fee == nil { + ff.t.Logf("L1 fee is nil in receipt, skipping L1 fee validation") + return fastLzSizeSigned, nil + } + + expectedFee, err := CalculateFjordL1Cost(ff.ctx, client, signedTx.RollupCostData(), receipt.BlockHash) + ff.require.NoError(err, "should calculate L1 fee") + + ff.require.Equalf(expectedFee, receiptL1Fee, "Calculated L1 fee should match receipt L1 fee (expected=%s actual=%s)", expectedFee.String(), receiptL1Fee.String()) + + ff.require.Equalf(expectedFee, receipt.L1Fee, "L1 fee in receipt must be correct (expected=%s actual=%s)", expectedFee.String(), receipt.L1Fee.String()) + + return fastLzSizeSigned, expectedFee +} + +// validateFeeDistribution validates that the fees are distributed correctly to the vaults +func (ff *FjordFees) validateFeeDistribution(l1Fee, baseFee, priorityFee, operatorFee *big.Int, vaults VaultBalances) { + ff.require.True(l1Fee.Sign() >= 0, "L1 fee must be non-negative") + ff.require.True(baseFee.Sign() > 0, "Base fee must be positive") + ff.require.True(priorityFee.Sign() >= 0, "Priority fee must be non-negative") + ff.require.True(operatorFee.Sign() >= 0, "Operator fee must be non-negative") + + ff.require.Equal(l1Fee, vaults.L1FeeVault, "L1 fee must match L1FeeVault increase") + ff.require.Equal(baseFee, vaults.BaseFeeVault, "Base fee must match BaseFeeVault increase") + ff.require.Equal(priorityFee, vaults.SequencerVault, "Priority fee must match SequencerFeeVault increase") + ff.require.Equal(operatorFee, vaults.OperatorVault, "Operator fee must match OperatorFeeVault increase") +} + +// validateTotalBalance validates that the total balance of the wallet and the vaults is correct +func (ff *FjordFees) validateTotalBalance(walletDiff *big.Int, totalFee *big.Int, vaults VaultBalances) { + totalVaultIncrease := new(big.Int).Add(vaults.BaseFeeVault, vaults.L1FeeVault) + totalVaultIncrease.Add(totalVaultIncrease, vaults.SequencerVault) + totalVaultIncrease.Add(totalVaultIncrease, vaults.OperatorVault) + + ff.require.Equal(walletDiff, totalFee, "Wallet balance difference must equal total fees") + ff.require.Equal(totalVaultIncrease, totalFee, "Total vault increases must equal total fees") +} + +// getCoinbaseBalance gets the balance of the coinbase address (block miner/sequencer) +func (ff *FjordFees) getCoinbaseBalance(client apis.EthClient) *big.Int { + block, err := client.InfoByLabel(ff.ctx, "latest") + ff.require.NoError(err, "should get latest block") + + coinbase := block.Coinbase() + balance, err := client.BalanceAt(ff.ctx, coinbase, nil) + ff.require.NoError(err, "should get coinbase balance") + return balance +} + +// validateVaultIncreaseFees validates that the fees are distributed correctly to the vaults +func (ff *FjordFees) validateVaultIncreaseFees( + l2Fee, baseFee, priorityFee, l1Fee, operatorFee, coinbaseDiff *big.Int, + vaultsAfter, vaultsBefore VaultBalances) { + + ff.require.Equal(l2Fee, coinbaseDiff, "L2 fee must equal coinbase difference (coinbase is always sequencer fee vault)") + + vaultsIncrease := ff.calculateVaultIncreases(vaultsBefore, vaultsAfter) + ff.require.Equal(baseFee, vaultsIncrease.BaseFeeVault, "base fee must match BaseFeeVault increase") + + ff.require.Equal(priorityFee, vaultsIncrease.SequencerVault, "priority fee must match SequencerFeeVault increase") + + ff.require.Equal(l1Fee, vaultsIncrease.L1FeeVault, "L1 fee must match L1FeeVault increase") + + ff.require.Equal(operatorFee, vaultsIncrease.OperatorVault, "operator fee must match OperatorFeeVault increase") + + ff.t.Logf("Comprehensive fee validation passed:") + ff.t.Logf(" L2 Fee: %s (coinbase diff: %s)", l2Fee, coinbaseDiff) + ff.t.Logf(" Base Fee: %s (vault increase: %s)", baseFee, vaultsIncrease.BaseFeeVault) + ff.t.Logf(" Priority Fee: %s (vault increase: %s)", priorityFee, vaultsIncrease.SequencerVault) + ff.t.Logf(" L1 Fee: %s (vault increase: %s)", l1Fee, vaultsIncrease.L1FeeVault) + ff.t.Logf(" Operator Fee: %s (vault increase: %s)", operatorFee, vaultsIncrease.OperatorVault) +} + +// FindSignedTransactionFromReceipt finds the signed transaction from a receipt and block +func FindSignedTransactionFromReceipt(ctx context.Context, client apis.EthClient, receipt *types.Receipt) (*types.Transaction, error) { + _, txs, err := client.InfoAndTxsByHash(ctx, receipt.BlockHash) + if err != nil { + return nil, err + } + + for _, tx := range txs { + if tx.Hash() == receipt.TxHash { + return tx, nil + } + } + return nil, fmt.Errorf("signed transaction not found for hash %s", receipt.TxHash) +} + +// CreateUnsignedTransactionFromSigned creates an unsigned transaction from a signed one +func CreateUnsignedTransactionFromSigned(signedTx *types.Transaction) (*types.Transaction, error) { + return types.NewTx(&types.DynamicFeeTx{ + Nonce: signedTx.Nonce(), + To: signedTx.To(), + Value: signedTx.Value(), + Gas: signedTx.Gas(), + GasFeeCap: signedTx.GasFeeCap(), + GasTipCap: signedTx.GasTipCap(), + Data: signedTx.Data(), + }), nil +} + +// ReadGasPriceOracleL1FeeAt reads the L1 fee from GasPriceOracle for an unsigned transaction +// evaluated against a specific L2 block hash. +func ReadGasPriceOracleL1FeeAt(ctx context.Context, client apis.EthClient, gpo *bindings.GasPriceOracle, txUnsigned []byte, blockHash common.Hash) (*big.Int, error) { + overrideBlockOpt := func(ptx *txplan.PlannedTx) { + ptx.AgainstBlock.Fn(func(ctx context.Context) (eth.BlockInfo, error) { + return client.InfoByHash(ctx, blockHash) + }) + } + result, err := contractio.Read(gpo.GetL1Fee(txUnsigned), ctx, overrideBlockOpt) + if err != nil { + return nil, err + } + return result.ToBig(), nil +} + +// ReadGasPriceOracleL1FeeUpperBoundAt reads the L1 fee upper bound for a tx length pinned to a block hash. +func ReadGasPriceOracleL1FeeUpperBoundAt(ctx context.Context, client apis.EthClient, gpo *bindings.GasPriceOracle, txLen int, blockHash common.Hash) (*big.Int, error) { + overrideBlockOpt := func(ptx *txplan.PlannedTx) { + ptx.AgainstBlock.Fn(func(ctx context.Context) (eth.BlockInfo, error) { + return client.InfoByHash(ctx, blockHash) + }) + } + result, err := contractio.Read(gpo.GetL1FeeUpperBound(big.NewInt(int64(txLen))), ctx, overrideBlockOpt) + if err != nil { + return nil, err + } + return result.ToBig(), nil +} + +// ValidateL1FeeMatches checks that the calculated L1 fee matches the actual receipt L1 fee +func ValidateL1FeeMatches(t devtest.T, calculatedFee, receiptFee *big.Int) { + require := t.Require() + require.NotNil(receiptFee, "L1 fee should be present in receipt") + require.Equalf(calculatedFee.Uint64(), receiptFee.Uint64(), "L1 fee mismatch (expected=%d actual=%d)", calculatedFee.Uint64(), receiptFee.Uint64()) +} + +// CalculateFjordL1Cost calculates L1 cost using Fjord formula with block-specific L1 state +func CalculateFjordL1Cost(ctx context.Context, client apis.EthClient, rollupCostData types.RollupCostData, blockHash common.Hash) (*big.Int, error) { + l1Block := bindings.NewL1Block( + bindings.WithClient(client), + bindings.WithTo(predeploys.L1BlockAddr), + ) + + overrideBlockOpt := func(ptx *txplan.PlannedTx) { + ptx.AgainstBlock.Fn(func(ctx context.Context) (eth.BlockInfo, error) { + return client.InfoByHash(ctx, blockHash) + }) + } + + baseFeeScalar, err := contractio.Read(l1Block.BasefeeScalar(), ctx, overrideBlockOpt) + if err != nil { + return nil, err + } + l1BaseFee, err := contractio.Read(l1Block.Basefee(), ctx, overrideBlockOpt) + if err != nil { + return nil, err + } + blobBaseFeeScalar, err := contractio.Read(l1Block.BlobBaseFeeScalar(), ctx, overrideBlockOpt) + if err != nil { + return nil, err + } + blobBaseFee, err := contractio.Read(l1Block.BlobBaseFee(), ctx, overrideBlockOpt) + if err != nil { + return nil, err + } + + costFunc := types.NewL1CostFuncFjord( + l1BaseFee, + blobBaseFee, + new(big.Int).SetUint64(uint64(baseFeeScalar)), + new(big.Int).SetUint64(uint64(blobBaseFeeScalar))) + + fee, _ := costFunc(rollupCostData) + return fee, nil +} diff --git a/op-devstack/dsl/funder.go b/op-devstack/dsl/funder.go index 6bac8fcda67..525d716a972 100644 --- a/op-devstack/dsl/funder.go +++ b/op-devstack/dsl/funder.go @@ -68,6 +68,9 @@ func (f *Funder) FundAtLeast(wallet *EOA, amount eth.ETH) eth.ETH { if currentBalance.Lt(amount) { missing := amount.Sub(currentBalance) f.faucet.Fund(wallet.Address(), missing) + finalBalance := currentBalance.Add(missing) + wallet.WaitForBalance(finalBalance) + return finalBalance } return currentBalance } diff --git a/op-devstack/dsl/l2_cl.go b/op-devstack/dsl/l2_cl.go index 96dd6477022..79f7d38a051 100644 --- a/op-devstack/dsl/l2_cl.go +++ b/op-devstack/dsl/l2_cl.go @@ -334,3 +334,21 @@ func (cl *L2CLNode) VerifySafeHeadDatabaseMatches(sourceOfTruth *L2CLNode, args sourceOfTruth.AwaitMinL1Processed(l1Block) checkSafeHeadConsistent(cl.t, l1Block, cl, sourceOfTruth, opts.minRequiredL2Block) } + +func (cl *L2CLNode) WaitForNonZeroUnsafeTime(ctx context.Context) *eth.SyncStatus { + require := cl.require + + var ss *eth.SyncStatus + err := retry.Do0(ctx, 10, retry.Fixed(2*time.Second), func() error { + ss = cl.SyncStatus() + require.NotNil(ss, "L2CL should have sync status") + if ss.UnsafeL2.Time == 0 { + return fmt.Errorf("L2CL unsafe time is still zero") + } + return nil + }) + require.NoError(err, "L2CL unsafe time should be set within retry limit") + require.NotZero(ss.UnsafeL2.Time, "L2CL unsafe time should not be zero") + + return ss +} diff --git a/op-devstack/dsl/l2_network.go b/op-devstack/dsl/l2_network.go index 6a68ee802b7..fa0572da126 100644 --- a/op-devstack/dsl/l2_network.go +++ b/op-devstack/dsl/l2_network.go @@ -226,20 +226,23 @@ func (n *L2Network) AwaitActivation(t devtest.T, forkName rollup.ForkName) eth.B el := n.Escape().L2ELNode(match.FirstL2EL) - unsafeHead, err := retry.Do(t.Ctx(), 120, &retry.FixedStrategy{Dur: 500 * time.Millisecond}, func() (eth.BlockRef, error) { - unsafeHead, err := el.EthClient().BlockRefByLabel(t.Ctx(), eth.Unsafe) - if err != nil { - return eth.BlockRef{}, err - } - if !n.inner.RollupConfig().IsActivationBlockForFork(unsafeHead.Time, forkName) { - return eth.BlockRef{}, fmt.Errorf("not %s activation block", forkName) - } - return unsafeHead, nil // success - }) + rollupCfg := n.Escape().RollupConfig() + maybeActivationTime := rollupCfg.ActivationTimeFor(forkName) + require.NotNil(maybeActivationTime, "Required fork is not scheduled for activation") + activationTime := *maybeActivationTime + if activationTime == 0 { + block, err := el.EthClient().BlockRefByNumber(t.Ctx(), 0) + require.NoError(err, "Fork activated at genesis, but failed to get genesis block") + return block.ID() + } + blockNum, err := rollupCfg.TargetBlockNumber(activationTime) require.NoError(err) - t.Logger().Info("Activation block", "block", unsafeHead.ID()) + NewL2ELNode(el, n.control).WaitForBlockNumber(blockNum).ID() + activationBlock, err := el.EthClient().BlockRefByNumber(t.Ctx(), blockNum) + require.NoError(err, "Failed to get activation block") + t.Logger().Info("Activation block", "block", activationBlock.ID()) + return activationBlock.ID() - return unsafeHead.ID() } func (n *L2Network) DisputeGameFactoryProxyAddr() common.Address { diff --git a/op-devstack/dsl/proofs/claim.go b/op-devstack/dsl/proofs/claim.go index 08418883cbc..51051224e89 100644 --- a/op-devstack/dsl/proofs/claim.go +++ b/op-devstack/dsl/proofs/claim.go @@ -2,6 +2,7 @@ package proofs import ( "fmt" + "slices" "time" "github.com/ethereum/go-ethereum/common" @@ -17,12 +18,12 @@ const defaultTimeout = 20 * time.Minute type Claim struct { t devtest.T require *require.Assertions - Index int64 + Index uint64 claim bindings.Claim game *FaultDisputeGame } -func newClaim(t devtest.T, require *require.Assertions, claimIndex int64, claim bindings.Claim, game *FaultDisputeGame) *Claim { +func newClaim(t devtest.T, require *require.Assertions, claimIndex uint64, claim bindings.Claim, game *FaultDisputeGame) *Claim { return &Claim{ t: t, require: require, @@ -32,24 +33,46 @@ func newClaim(t devtest.T, require *require.Assertions, claimIndex int64, claim } } +func (c *Claim) String() string { + pos := c.claim.Position + return fmt.Sprintf("%v - Position: %v, Depth: %v, IndexAtDepth: %v ClaimHash: %v, Countered By: %v, ParentIndex: %v Claimant: %v Bond: %v\n", + c.Index, pos.ToGIndex(), pos.Depth(), pos.IndexAtDepth(), c.claim.Value.Hex(), c.claim.CounteredBy, c.claim.ParentContractIndex, c.claim.Claimant, c.claim.Bond) +} + func (c *Claim) Value() common.Hash { return c.claim.Value } +func (c *Claim) Claimant() common.Address { + return c.claim.Claimant +} + func (c *Claim) Depth() uint64 { return uint64(c.claim.Depth()) } // WaitForCounterClaim waits for the claim to be countered by another claim being posted. // Return the new claim that counters this claim. -func (c *Claim) WaitForCounterClaim() *Claim { - counterIdx, counterClaim := c.game.waitForClaim(defaultTimeout, fmt.Sprintf("failed to find claim with parent idx %v", c.Index), func(claimIdx int64, claim bindings.Claim) bool { - return int64(claim.ParentContractIndex) == c.Index +func (c *Claim) WaitForCounterClaim(ignoreClaims ...*Claim) *Claim { + counterIdx, counterClaim := c.game.waitForClaim(defaultTimeout, fmt.Sprintf("failed to find claim with parent idx %v", c.Index), func(claimIdx uint64, claim bindings.Claim) bool { + return uint64(claim.ParentContractIndex) == c.Index && !containsClaim(claimIdx, ignoreClaims) }) return newClaim(c.t, c.require, counterIdx, counterClaim, c.game) } +func (c *Claim) VerifyNoCounterClaim() { + for i, claim := range c.game.allClaims() { + c.require.NotEqualValuesf(c.Index, claim.ParentContractIndex, "Found unexpected counter-claim at index %v: %v", i, claim) + } +} + func (c *Claim) Attack(eoa *dsl.EOA, newClaim common.Hash) *Claim { c.game.Attack(eoa, c.Index, newClaim) return c.WaitForCounterClaim() } + +func containsClaim(claimIdx uint64, haystack []*Claim) bool { + return slices.ContainsFunc(haystack, func(candidate *Claim) bool { + return candidate.Index == claimIdx + }) +} diff --git a/op-devstack/dsl/proofs/dispute_game_factory.go b/op-devstack/dsl/proofs/dispute_game_factory.go index e654c878987..d2c9f904dea 100644 --- a/op-devstack/dsl/proofs/dispute_game_factory.go +++ b/op-devstack/dsl/proofs/dispute_game_factory.go @@ -5,12 +5,13 @@ import ( "math/big" "time" + "github.com/ethereum-optimism/optimism/op-service/eth" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/core/types" "github.com/ethereum/go-ethereum/log" "github.com/stretchr/testify/require" - cTypes "github.com/ethereum-optimism/optimism/op-challenger/game/fault/types" + challengerTypes "github.com/ethereum-optimism/optimism/op-challenger/game/fault/types" "github.com/ethereum-optimism/optimism/op-devstack/devtest" "github.com/ethereum-optimism/optimism/op-devstack/dsl" "github.com/ethereum-optimism/optimism/op-devstack/dsl/contract" @@ -26,7 +27,9 @@ type DisputeGameFactory struct { l1Network *dsl.L1Network ethClient apis.EthClient dgf *bindings.DisputeGameFactory + addr common.Address supervisor *dsl.Supervisor + gameHelper *GameHelper } func NewDisputeGameFactory(t devtest.T, l1Network *dsl.L1Network, ethClient apis.EthClient, dgfAddr common.Address, supervisor *dsl.Supervisor) *DisputeGameFactory { @@ -38,14 +41,17 @@ func NewDisputeGameFactory(t devtest.T, l1Network *dsl.L1Network, ethClient apis log: t.Logger(), l1Network: l1Network, dgf: dgf, + addr: dgfAddr, supervisor: supervisor, ethClient: ethClient, } } type GameCfg struct { - allowFuture bool - allowUnsafe bool + allowFuture bool + allowUnsafe bool + rootClaimSet bool + rootClaim common.Hash } type GameOpt interface { Apply(cfg *GameCfg) @@ -68,6 +74,13 @@ func WithFutureProposal() GameOpt { }) } +func WithRootClaim(claim common.Hash) GameOpt { + return gameOptFn(func(c *GameCfg) { + c.rootClaim = claim + c.rootClaimSet = true + }) +} + func NewGameCfg(opts ...GameOpt) *GameCfg { cfg := &GameCfg{} for _, opt := range opts { @@ -76,6 +89,19 @@ func NewGameCfg(opts ...GameOpt) *GameCfg { return cfg } +func (f *DisputeGameFactory) Address() common.Address { + return f.addr +} + +func (f *DisputeGameFactory) getGameHelper(eoa *dsl.EOA) *GameHelper { + if f.gameHelper != nil { + return f.gameHelper + } + gs := DeployGameHelper(f.t, eoa) + f.gameHelper = gs + return gs +} + func (f *DisputeGameFactory) GameCount() int64 { return contract.Read(f.dgf.GameCount()).Int64() } @@ -83,7 +109,13 @@ func (f *DisputeGameFactory) GameCount() int64 { func (f *DisputeGameFactory) GameAtIndex(idx int64) *FaultDisputeGame { gameInfo := contract.Read(f.dgf.GameAtIndex(big.NewInt(idx))) game := bindings.NewFaultDisputeGame(bindings.WithClient(f.ethClient), bindings.WithTo(gameInfo.Proxy), bindings.WithTest(f.t)) - return NewFaultDisputeGame(f.t, f.require, game) + return NewFaultDisputeGame(f.t, f.require, gameInfo.Proxy, f.getGameHelper, game) +} + +func (f *DisputeGameFactory) gameImpl(gameType challengerTypes.GameType) *FaultDisputeGame { + implAddr := contract.Read(f.dgf.GameImpls(uint32(gameType))) + game := bindings.NewFaultDisputeGame(bindings.WithClient(f.ethClient), bindings.WithTo(implAddr), bindings.WithTest(f.t)) + return NewFaultDisputeGame(f.t, f.require, implAddr, f.getGameHelper, game) } func (f *DisputeGameFactory) WaitForGame() *FaultDisputeGame { @@ -98,19 +130,24 @@ func (f *DisputeGameFactory) WaitForGame() *FaultDisputeGame { return f.GameAtIndex(initialCount) } -func (f *DisputeGameFactory) StartSuperCannonGame(eoa *dsl.EOA, rootClaim common.Hash, opts ...GameOpt) *SuperFaultDisputeGame { +func (f *DisputeGameFactory) StartSuperCannonGame(eoa *dsl.EOA, opts ...GameOpt) *SuperFaultDisputeGame { proposalTimestamp := f.supervisor.FetchSyncStatus().SafeTimestamp - gameType := uint32(cTypes.SuperCannonGameType) - return f.startSuperCannonGameOfType(eoa, proposalTimestamp, rootClaim, gameType, opts...) + return f.startSuperCannonGameOfType(eoa, proposalTimestamp, challengerTypes.SuperCannonGameType, opts...) } -func (f *DisputeGameFactory) startSuperCannonGameOfType(eoa *dsl.EOA, timestamp uint64, rootClaim common.Hash, gameType uint32, opts ...GameOpt) *SuperFaultDisputeGame { +func (f *DisputeGameFactory) startSuperCannonGameOfType(eoa *dsl.EOA, timestamp uint64, gameType challengerTypes.GameType, opts ...GameOpt) *SuperFaultDisputeGame { cfg := NewGameCfg(opts...) extraData := f.createSuperGameExtraData(timestamp, cfg) - game := f.createNewGame(eoa, gameType, rootClaim, extraData) + rootClaim := cfg.rootClaim + if !cfg.rootClaimSet { + // Default to the correct root claim + response := f.supervisor.FetchSuperRootAtTimestamp(timestamp) + rootClaim = common.Hash(response.SuperRoot) + } + game, addr := f.createNewGame(eoa, gameType, rootClaim, extraData) - return NewSuperFaultDisputeGame(f.t, f.require, game) + return NewSuperFaultDisputeGame(f.t, f.require, addr, f.getGameHelper, game) } func (f *DisputeGameFactory) createSuperGameExtraData(timestamp uint64, cfg *GameCfg) []byte { @@ -122,13 +159,13 @@ func (f *DisputeGameFactory) createSuperGameExtraData(timestamp uint64, cfg *Gam return extraData } -func (f *DisputeGameFactory) createNewGame(eoa *dsl.EOA, gameType uint32, claim common.Hash, extraData []byte) *bindings.FaultDisputeGame { +func (f *DisputeGameFactory) createNewGame(eoa *dsl.EOA, gameType challengerTypes.GameType, claim common.Hash, extraData []byte) (*bindings.FaultDisputeGame, common.Address) { f.log.Info("Creating dispute game", "gameType", gameType, "claim", claim.Hex(), "extradata", common.Bytes2Hex(extraData)) // Pull some metadata we need to construct a new game - requiredBonds := contract.Read(f.dgf.InitBonds(gameType)) + requiredBonds := f.initBond(gameType) - receipt := contract.Write(eoa, f.dgf.Create(gameType, claim, extraData), txplan.WithValue(requiredBonds), txplan.WithGasRatio(2)) + receipt := contract.Write(eoa, f.dgf.Create(uint32(gameType), claim, extraData), txplan.WithValue(requiredBonds), txplan.WithGasRatio(2)) f.require.Equal(types.ReceiptStatusSuccessful, receipt.Status) // Extract logs from receipt @@ -138,5 +175,31 @@ func (f *DisputeGameFactory) createNewGame(eoa *dsl.EOA, gameType uint32, claim gameAddr := createdLog.DisputeProxy log.Info("Dispute game created", "address", gameAddr.Hex()) - return bindings.NewFaultDisputeGame(bindings.WithClient(f.ethClient), bindings.WithTo(gameAddr), bindings.WithTest(f.t)) + return bindings.NewFaultDisputeGame(bindings.WithClient(f.ethClient), bindings.WithTo(gameAddr), bindings.WithTest(f.t)), gameAddr +} + +func (f *DisputeGameFactory) initBond(gameType challengerTypes.GameType) eth.ETH { + return eth.WeiBig(contract.Read(f.dgf.InitBonds(uint32(gameType)))) +} + +func (f *DisputeGameFactory) CreateHelperEOA(eoa *dsl.EOA) *GameHelperEOA { + helper := f.getGameHelper(eoa) + eoaHelper := helper.AuthEOA(eoa) + return &GameHelperEOA{ + helper: eoaHelper, + EOA: eoa, + } +} + +type GameHelperEOA struct { + helper *GameHelper + EOA *dsl.EOA +} + +func (a *GameHelperEOA) PerformMoves(game *FaultDisputeGame, moves ...GameHelperMove) []*Claim { + return a.helper.PerformMoves(a.EOA, game, moves) +} + +func (a *GameHelperEOA) Address() common.Address { + return a.EOA.Address() } diff --git a/op-devstack/dsl/proofs/fault_dispute_game.go b/op-devstack/dsl/proofs/fault_dispute_game.go index 7cd26ed9a08..aa6bc8a15ae 100644 --- a/op-devstack/dsl/proofs/fault_dispute_game.go +++ b/op-devstack/dsl/proofs/fault_dispute_game.go @@ -2,9 +2,13 @@ package proofs import ( "context" + "fmt" "math/big" "time" + challengerTypes "github.com/ethereum-optimism/optimism/op-challenger/game/fault/types" + gameTypes "github.com/ethereum-optimism/optimism/op-challenger/game/types" + "github.com/ethereum-optimism/optimism/op-service/eth" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/core/types" "github.com/stretchr/testify/require" @@ -17,22 +21,28 @@ import ( "github.com/ethereum-optimism/optimism/op-service/txplan" ) +type gameHelperProvider func(deployer *dsl.EOA) *GameHelper + type FaultDisputeGame struct { - t devtest.T - require *require.Assertions - game *bindings.FaultDisputeGame + t devtest.T + require *require.Assertions + game *bindings.FaultDisputeGame + Address common.Address + helperProvider gameHelperProvider } -func NewFaultDisputeGame(t devtest.T, require *require.Assertions, game *bindings.FaultDisputeGame) *FaultDisputeGame { +func NewFaultDisputeGame(t devtest.T, require *require.Assertions, addr common.Address, helperProvider gameHelperProvider, game *bindings.FaultDisputeGame) *FaultDisputeGame { return &FaultDisputeGame{ - t: t, - require: require, - game: game, + t: t, + require: require, + game: game, + Address: addr, + helperProvider: helperProvider, } } -func (g *FaultDisputeGame) MaxDepth() uint64 { - return contract.Read(g.game.MaxGameDepth()).Uint64() +func (g *FaultDisputeGame) MaxDepth() challengerTypes.Depth { + return challengerTypes.Depth(contract.Read(g.game.MaxGameDepth()).Uint64()) } func (g *FaultDisputeGame) SplitDepth() uint64 { @@ -40,37 +50,49 @@ func (g *FaultDisputeGame) SplitDepth() uint64 { } func (g *FaultDisputeGame) RootClaim() *Claim { - return g.ClaimAtIndex(int64(0)) + return g.ClaimAtIndex(0) } func (g *FaultDisputeGame) L2SequenceNumber() *big.Int { return contract.Read(g.game.L2SequenceNumber()) } -func (g *FaultDisputeGame) ClaimAtIndex(claimIndex int64) *Claim { +func (g *FaultDisputeGame) ClaimAtIndex(claimIndex uint64) *Claim { claim := g.claimAtIndex(claimIndex) return g.newClaim(claimIndex, claim) } -func (g *FaultDisputeGame) Attack(eoa *dsl.EOA, claimIdx int64, newClaim common.Hash) { +func (g *FaultDisputeGame) Attack(eoa *dsl.EOA, claimIdx uint64, newClaim common.Hash) { claim := g.claimAtIndex(claimIdx) g.t.Logf("Attacking claim %v (depth: %d) with counter-claim %v", claimIdx, claim.Position.Depth(), newClaim) - newPosition := claim.Position.Attack().ToGIndex() - requiredBond := contract.Read(g.game.GetRequiredBond((*bindings.Uint128)(newPosition))) + requiredBond := g.requiredBond(claim.Position.Attack()) - attackCall := g.game.Attack(claim.Value, big.NewInt(claimIdx), newClaim) + attackCall := g.game.Attack(claim.Value, new(big.Int).SetUint64(claimIdx), newClaim) receipt := contract.Write(eoa, attackCall, txplan.WithValue(requiredBond), txplan.WithGasRatio(2)) g.t.Require().Equal(receipt.Status, types.ReceiptStatusSuccessful) } -func (g *FaultDisputeGame) newClaim(claimIndex int64, claim bindings.Claim) *Claim { +func (g *FaultDisputeGame) PerformMoves(eoa *dsl.EOA, moves ...GameHelperMove) []*Claim { + return g.helperProvider(eoa).PerformMoves(eoa, g, moves) +} + +func (g *FaultDisputeGame) requiredBond(pos challengerTypes.Position) eth.ETH { + return eth.WeiBig(contract.Read(g.game.GetRequiredBond((*bindings.Uint128)(pos.ToGIndex())))) +} + +func (g *FaultDisputeGame) status() gameTypes.GameStatus { + status := contract.Read(g.game.Status()) + return gameTypes.GameStatus(status) +} + +func (g *FaultDisputeGame) newClaim(claimIndex uint64, claim bindings.Claim) *Claim { return newClaim(g.t, g.require, claimIndex, claim, g) } -func (g *FaultDisputeGame) claimAtIndex(claimIndex int64) bindings.Claim { - return contract.Read(g.game.ClaimData(big.NewInt(claimIndex))).Decode() +func (g *FaultDisputeGame) claimAtIndex(claimIndex uint64) bindings.Claim { + return contract.Read(g.game.ClaimData(new(big.Int).SetUint64(claimIndex))).Decode() } func (g *FaultDisputeGame) allClaims() []bindings.Claim { @@ -87,18 +109,22 @@ func (g *FaultDisputeGame) allClaims() []bindings.Claim { return claims } -func (g *FaultDisputeGame) waitForClaim(timeout time.Duration, errorMsg string, predicate func(claimIdx int64, claim bindings.Claim) bool) (int64, bindings.Claim) { +func (g *FaultDisputeGame) claimCount() uint64 { + return contract.Read(g.game.ClaimDataLen()).Uint64() +} + +func (g *FaultDisputeGame) waitForClaim(timeout time.Duration, errorMsg string, predicate func(claimIdx uint64, claim bindings.Claim) bool) (uint64, bindings.Claim) { timedCtx, cancel := context.WithTimeout(g.t.Ctx(), timeout) defer cancel() var matchedClaim bindings.Claim - var matchClaimIdx int64 + var matchClaimIdx uint64 err := wait.For(timedCtx, time.Second, func() (bool, error) { claims := g.allClaims() // Search backwards because the new claims are at the end and more likely the ones we want. for i := len(claims) - 1; i >= 0; i-- { claim := claims[i] - if predicate(int64(i), claim) { - matchClaimIdx = int64(i) + if predicate(uint64(i), claim) { + matchClaimIdx = uint64(i) matchedClaim = claim return true, nil } @@ -106,9 +132,28 @@ func (g *FaultDisputeGame) waitForClaim(timeout time.Duration, errorMsg string, return false, nil }) g.require.NoError(err, errorMsg) - // TODO(#15948) - Log GameData() - //if err != nil { // Avoid waiting time capturing game data when there's no error - // g.require.NoErrorf(err, "%v\n%v", errorMsg, g.GameData(ctx)) - //} + if err != nil { // Avoid waiting time capturing game data when there's no error + g.require.NoErrorf(err, "%v\n%v", errorMsg, g.GameData()) + } return matchClaimIdx, matchedClaim } + +func (g *FaultDisputeGame) GameData() string { + maxDepth := g.MaxDepth() + splitDepth := g.SplitDepth() + claims := g.allClaims() + info := fmt.Sprintf("Claim count: %v\n", len(claims)) + for i, claim := range claims { + pos := claim.Position + info = info + fmt.Sprintf("%v - Position: %v, Depth: %v, IndexAtDepth: %v Trace Index: %v, ClaimHash: %v, Countered By: %v, ParentIndex: %v Claimant: %v Bond: %v\n", + i, claim.Position.ToGIndex(), pos.Depth(), pos.IndexAtDepth(), pos.TraceIndex(maxDepth), claim.Value.Hex(), claim.CounteredBy, claim.ParentContractIndex, claim.Claimant, claim.Bond) + } + seqNum := g.L2SequenceNumber() + status := g.status() + return fmt.Sprintf("Game %v - %v - L2 Block: %v - Split Depth: %v - Max Depth: %v:\n%v\n", + g.Address, status, seqNum, splitDepth, maxDepth, info) +} + +func (g *FaultDisputeGame) LogGameData() { + g.t.Log(g.GameData()) +} diff --git a/op-devstack/dsl/proofs/game_helper.go b/op-devstack/dsl/proofs/game_helper.go new file mode 100644 index 00000000000..af076b7c9a9 --- /dev/null +++ b/op-devstack/dsl/proofs/game_helper.go @@ -0,0 +1,224 @@ +package proofs + +import ( + "bytes" + "encoding/json" + "math/big" + "os" + "path/filepath" + + challengerTypes "github.com/ethereum-optimism/optimism/op-challenger/game/fault/types" + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum/go-ethereum/accounts/abi" + "github.com/ethereum/go-ethereum/common" + "github.com/ethereum/go-ethereum/core/types" + "github.com/stretchr/testify/require" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/dsl" + opservice "github.com/ethereum-optimism/optimism/op-service" + "github.com/ethereum-optimism/optimism/op-service/txplan" +) + +type GameHelperMove struct { + ParentIdx *big.Int + Claim common.Hash + Attack bool +} + +type contractArtifactData struct { + Bytecode []byte + ABI abi.ABI +} + +type GameHelper struct { + t devtest.T + require *require.Assertions + contractAddr common.Address + abi abi.ABI +} + +func DeployGameHelper(t devtest.T, deployer *dsl.EOA) *GameHelper { + req := require.New(t) + + artifactData := getGameHelperArtifactData(t) + + constructorABI := artifactData.ABI + + encodedArgs, err := constructorABI.Pack("") + req.NoError(err, "Failed to encode constructor arguments") + + deploymentData := append(artifactData.Bytecode, encodedArgs...) + + deployTxOpts := txplan.Combine( + deployer.Plan(), + txplan.WithData(deploymentData), + ) + + deployTx := txplan.NewPlannedTx(deployTxOpts) + receipt, err := deployTx.Included.Eval(t.Ctx()) + req.NoError(err, "Failed to deploy GameHelper contract") + + req.Equal(types.ReceiptStatusSuccessful, receipt.Status, "GameHelper deployment failed") + req.NotEqual(common.Address{}, receipt.ContractAddress, "GameHelper contract address not set in receipt") + + contractAddr := receipt.ContractAddress + t.Logf("GameHelper contract deployed at: %s", contractAddr.Hex()) + + return &GameHelper{ + t: t, + require: require.New(t), + contractAddr: contractAddr, + abi: artifactData.ABI, + } +} + +type ArtifactBytecode struct { + Object string `json:"object"` +} + +type ArtifactJSON struct { + Bytecode ArtifactBytecode `json:"bytecode"` + ABI json.RawMessage `json:"abi"` +} + +func getGameHelperArtifactData(t devtest.T) *contractArtifactData { + req := require.New(t) + artifactPath := getGameHelperArtifactPath(t) + + fileData, err := os.ReadFile(artifactPath) + req.NoError(err, "Failed to read GameHelper artifact file") + + var artifactJSON ArtifactJSON + err = json.Unmarshal(fileData, &artifactJSON) + req.NoError(err, "Failed to parse GameHelper artifact JSON") + + req.NotEmpty(artifactJSON.Bytecode.Object, "Bytecode object not found in GameHelper artifact") + + bytecode := common.FromHex(artifactJSON.Bytecode.Object) + + parsedABI, err := abi.JSON(bytes.NewReader(artifactJSON.ABI)) + req.NoError(err, "Failed to parse ABI") + + return &contractArtifactData{ + Bytecode: bytecode, + ABI: parsedABI, + } +} + +func getGameHelperArtifactPath(t devtest.T) string { + req := require.New(t) + wd, err := os.Getwd() + req.NoError(err, "Failed to get current working directory") + + monorepoRoot, err := opservice.FindMonorepoRoot(wd) + req.NoError(err, "Failed to find monorepo root") + + contractsBedrock := filepath.Join(monorepoRoot, "packages", "contracts-bedrock") + return filepath.Join(contractsBedrock, "forge-artifacts", "GameHelper.sol", "GameHelper.json") +} + +func (gs *GameHelper) AuthEOA(eoa *dsl.EOA) *GameHelper { + tx := txplan.NewPlannedTx(eoa.PlanAuth(gs.contractAddr)) + receipt, err := tx.Included.Eval(gs.t.Ctx()) + gs.require.NoError(err) + gs.require.Equal(types.ReceiptStatusSuccessful, receipt.Status) + return &GameHelper{ + t: gs.t, + require: require.New(gs.t), + contractAddr: eoa.Address(), + abi: gs.abi, + } +} + +func (gs *GameHelper) CreateGameWithClaims( + eoa *dsl.EOA, + factory *DisputeGameFactory, + gameType challengerTypes.GameType, + rootClaim common.Hash, + extraData []byte, + moves []GameHelperMove, +) common.Address { + data, err := gs.abi.Pack("createGameWithClaims", factory.Address(), gameType, rootClaim, extraData, moves) + gs.require.NoError(err) + + gameImpl := factory.gameImpl(gameType) + bonds := factory.initBond(gameType) + bonds = bonds.Add(gs.totalMoveBonds(gameImpl, moves)) + + tx := txplan.NewPlannedTx( + txplan.Combine( + eoa.Plan(), + txplan.WithValue(bonds), + txplan.WithTo(&gs.contractAddr), + txplan.WithData(data), + ), + ) + receipt, err := tx.Included.Eval(gs.t.Ctx()) + gs.require.NoError(err) + gs.require.Equal(types.ReceiptStatusSuccessful, receipt.Status) + + return receipt.ContractAddress +} + +func (gs *GameHelper) PerformMoves(eoa *dsl.EOA, game *FaultDisputeGame, moves []GameHelperMove) []*Claim { + data, err := gs.abi.Pack("performMoves", game.Address, moves) + gs.require.NoError(err) + + tx := txplan.NewPlannedTx( + txplan.Combine( + eoa.Plan(), + txplan.WithValue(gs.totalMoveBonds(game, moves)), + txplan.WithTo(&gs.contractAddr), + txplan.WithData(data), + ), + ) + preClaimCount := game.claimCount() + receipt, err := tx.Included.Eval(gs.t.Ctx()) + gs.require.NoError(err) + gs.require.Equal(types.ReceiptStatusSuccessful, receipt.Status) + postClaimCount := game.claimCount() + + // While all claims are performed within one transaction, it's possible another transaction also added claims + // between the calls to get claim count above (e.g. by a challenger running in parallel). + // So iterate to find the claims we added rather than just assuming the claim indices. + // Assumes that claims added by this helper contract are only added by this thread, + // which is safe because we deployed this particular instance of GameHelper. + claims := make([]*Claim, 0, len(moves)) + for claimIdx := preClaimCount; claimIdx < postClaimCount; claimIdx++ { + claim := game.ClaimAtIndex(claimIdx) + if claim.claim.Claimant != gs.contractAddr { + continue + } + claims = append(claims, claim) + } + gs.require.Equal(len(claims), len(moves), "Did not find claims for all moves") + return claims +} + +func (gs *GameHelper) totalMoveBonds(game *FaultDisputeGame, moves []GameHelperMove) eth.ETH { + claimPositions := map[uint64]challengerTypes.Position{ + 0: challengerTypes.RootPosition, + } + totalBond := eth.Ether(0) + for i, move := range moves { + parentPos := claimPositions[move.ParentIdx.Uint64()] + gs.require.NotEmpty(parentPos, "Move references non-existent parent - may be out of order") + childPos := parentPos.Defend() + if move.Attack { + childPos = parentPos.Attack() + } + claimPositions[uint64(i)+1] = childPos + bond := game.requiredBond(childPos) + totalBond = totalBond.Add(bond) + } + return totalBond +} + +func Move(parentIdx int64, claim common.Hash, attack bool) GameHelperMove { + return GameHelperMove{ + ParentIdx: big.NewInt(parentIdx), + Claim: claim, + Attack: attack, + } +} diff --git a/op-devstack/dsl/proofs/super_fault_dispute_game.go b/op-devstack/dsl/proofs/super_fault_dispute_game.go index 6b29ceecc89..7e096bd5c06 100644 --- a/op-devstack/dsl/proofs/super_fault_dispute_game.go +++ b/op-devstack/dsl/proofs/super_fault_dispute_game.go @@ -1,6 +1,7 @@ package proofs import ( + "github.com/ethereum/go-ethereum/common" "github.com/stretchr/testify/require" "github.com/ethereum-optimism/optimism/op-devstack/devtest" @@ -11,8 +12,8 @@ type SuperFaultDisputeGame struct { *FaultDisputeGame } -func NewSuperFaultDisputeGame(t devtest.T, require *require.Assertions, game *bindings.FaultDisputeGame) *SuperFaultDisputeGame { - fdg := NewFaultDisputeGame(t, require, game) +func NewSuperFaultDisputeGame(t devtest.T, require *require.Assertions, addr common.Address, helperProvider gameHelperProvider, game *bindings.FaultDisputeGame) *SuperFaultDisputeGame { + fdg := NewFaultDisputeGame(t, require, addr, helperProvider, game) return &SuperFaultDisputeGame{ FaultDisputeGame: fdg, } diff --git a/op-devstack/dsl/supervisor.go b/op-devstack/dsl/supervisor.go index c3dc800c510..786136ae6f8 100644 --- a/op-devstack/dsl/supervisor.go +++ b/op-devstack/dsl/supervisor.go @@ -4,6 +4,7 @@ import ( "context" "errors" "fmt" + "strings" "time" "github.com/ethereum-optimism/optimism/op-devstack/stack" @@ -94,12 +95,18 @@ func (s *Supervisor) FetchSyncStatus() eth.SupervisorSyncStatus { s.log.Debug("Fetching supervisor sync status") ctx, cancel := context.WithTimeout(s.ctx, DefaultTimeout) defer cancel() - syncStatus, err := retry.Do(ctx, 2, retry.Fixed(500*time.Millisecond), func() (eth.SupervisorSyncStatus, error) { + syncStatus, err := retry.Do(ctx, 10, retry.Fixed(500*time.Millisecond), func() (eth.SupervisorSyncStatus, error) { ctx, cancel := context.WithTimeout(s.ctx, 300*time.Millisecond) defer cancel() syncStatus, err := s.inner.QueryAPI().SyncStatus(ctx) if errors.Is(err, status.ErrStatusTrackerNotReady) { s.log.Debug("Sync status not ready from supervisor") + return syncStatus, err + } + // Check for L1 sync mismatch error and retry + if err != nil && strings.Contains(err.Error(), "min synced L1 mismatch") { + s.log.Debug("L1 sync mismatch, retrying", "error", err) + return syncStatus, err } return syncStatus, err }) diff --git a/op-devstack/dsl/sync_tester.go b/op-devstack/dsl/sync_tester.go index 1440fd0df7e..7f5fcf108ce 100644 --- a/op-devstack/dsl/sync_tester.go +++ b/op-devstack/dsl/sync_tester.go @@ -1,6 +1,9 @@ package dsl -import "github.com/ethereum-optimism/optimism/op-devstack/stack" +import ( + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-service/eth" +) // SyncTester wraps a stack.SyncTester interface for DSL operations type SyncTester struct { @@ -20,3 +23,26 @@ func NewSyncTester(inner stack.SyncTester) *SyncTester { func (s *SyncTester) Escape() stack.SyncTester { return s.inner } + +func (s *SyncTester) ListSessions() []string { + sessionIDs, err := s.inner.API().ListSessions(s.ctx) + s.t.Require().NoError(err) + return sessionIDs +} + +func (s *SyncTester) GetSession(sessionID string) *eth.SyncTesterSession { + session, err := s.inner.APIWithSession(sessionID).GetSession(s.ctx) + s.t.Require().NoError(err) + return session +} + +func (s *SyncTester) DeleteSession(sessionID string) { + err := s.inner.APIWithSession(sessionID).DeleteSession(s.ctx) + s.t.Require().NoError(err) +} + +func (s *SyncTester) ChainID(sessionID string) eth.ChainID { + chainID, err := s.inner.APIWithSession(sessionID).ChainID(s.ctx) + s.t.Require().NoError(err, "should be able to get chain ID from SyncTester") + return chainID +} diff --git a/op-devstack/dsl/validators.go b/op-devstack/dsl/validators.go index d517953d1b3..94328e43336 100644 --- a/op-devstack/dsl/validators.go +++ b/op-devstack/dsl/validators.go @@ -39,6 +39,8 @@ func IsForkActivated(c *params.ChainConfig, forkName rollup.ForkName, timestamp return c.IsOptimismHolocene(timestamp), nil case rollup.Isthmus: return c.IsOptimismIsthmus(timestamp), nil + case rollup.Jovian: + return c.IsOptimismJovian(timestamp), nil case rollup.Interop: return c.IsInterop(timestamp), nil default: diff --git a/op-devstack/presets/cl_config.go b/op-devstack/presets/cl_config.go index 62dc7a05b36..d56cbe4d48f 100644 --- a/op-devstack/presets/cl_config.go +++ b/op-devstack/presets/cl_config.go @@ -4,31 +4,30 @@ import ( "github.com/ethereum-optimism/optimism/op-devstack/devtest" "github.com/ethereum-optimism/optimism/op-devstack/stack" "github.com/ethereum-optimism/optimism/op-devstack/sysgo" - "github.com/ethereum-optimism/optimism/op-node/config" "github.com/ethereum-optimism/optimism/op-node/rollup/sync" ) func WithExecutionLayerSyncOnVerifiers() stack.CommonOption { return stack.MakeCommon( - sysgo.WithL2CLOption(func(_ devtest.P, id stack.L2CLNodeID, cfg *config.Config) { - // Can't enable ELSync on the sequencer or it will never start sequencing because - // ELSync needs to receive gossip from the sequencer to drive the sync - if !cfg.Driver.SequencerEnabled { - cfg.Sync.SyncMode = sync.ELSync - } - })) + sysgo.WithGlobalL2CLOption(sysgo.L2CLOptionFn( + func(_ devtest.P, id stack.L2CLNodeID, cfg *sysgo.L2CLConfig) { + cfg.VerifierSyncMode = sync.ELSync + }))) } func WithConsensusLayerSync() stack.CommonOption { return stack.MakeCommon( - sysgo.WithL2CLOption(func(_ devtest.P, id stack.L2CLNodeID, cfg *config.Config) { - cfg.Sync.SyncMode = sync.CLSync - })) + sysgo.WithGlobalL2CLOption(sysgo.L2CLOptionFn( + func(_ devtest.P, id stack.L2CLNodeID, cfg *sysgo.L2CLConfig) { + cfg.SequencerSyncMode = sync.CLSync + cfg.VerifierSyncMode = sync.CLSync + }))) } func WithSafeDBEnabled() stack.CommonOption { return stack.MakeCommon( - sysgo.WithL2CLOption(func(p devtest.P, _ stack.L2CLNodeID, cfg *config.Config) { - cfg.SafeDBPath = p.TempDir() - })) + sysgo.WithGlobalL2CLOption(sysgo.L2CLOptionFn( + func(p devtest.P, id stack.L2CLNodeID, cfg *sysgo.L2CLConfig) { + cfg.SafeDBPath = p.TempDir() + }))) } diff --git a/op-devstack/presets/flashblocks.go b/op-devstack/presets/flashblocks.go index 48e50fa0966..43b9deb504d 100644 --- a/op-devstack/presets/flashblocks.go +++ b/op-devstack/presets/flashblocks.go @@ -26,8 +26,7 @@ func WithSimpleFlashblocks() stack.CommonOption { return stack.Combine( stack.MakeCommon(sysgo.DefaultMinimalSystem(&sysgo.DefaultMinimalSystemIDs{})), // TODO(#16450): add sysgo support for flashblocks - // TODO(#16514): add kurtosis support for flashblocks - WithCompatibleTypes(compat.Persistent), + WithCompatibleTypes(compat.Persistent, compat.Kurtosis), ) } diff --git a/op-devstack/presets/minimal_external_el.go b/op-devstack/presets/minimal_external_el.go new file mode 100644 index 00000000000..6ad38e17147 --- /dev/null +++ b/op-devstack/presets/minimal_external_el.go @@ -0,0 +1,30 @@ +package presets + +import ( + "github.com/ethereum/go-ethereum/log" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/dsl" + "github.com/ethereum-optimism/optimism/op-devstack/stack" +) + +type MinimalExternalEL struct { + Log log.Logger + T devtest.T + ControlPlane stack.ControlPlane + + L1Network *dsl.L1Network + L1EL *dsl.L1ELNode + + L2Chain *dsl.L2Network + L2CL *dsl.L2CLNode + L2EL *dsl.L2ELNode + + SyncTester *dsl.SyncTester +} + +func (m *MinimalExternalEL) L2Networks() []*dsl.L2Network { + return []*dsl.L2Network{ + m.L2Chain, + } +} diff --git a/op-devstack/presets/minimal_with_synctester.go b/op-devstack/presets/minimal_with_synctester.go index 54d1f675951..eb8b3e3f99e 100644 --- a/op-devstack/presets/minimal_with_synctester.go +++ b/op-devstack/presets/minimal_with_synctester.go @@ -7,6 +7,7 @@ import ( "github.com/ethereum-optimism/optimism/op-devstack/stack" "github.com/ethereum-optimism/optimism/op-devstack/stack/match" "github.com/ethereum-optimism/optimism/op-devstack/sysgo" + "github.com/ethereum-optimism/optimism/op-service/eth" ) type MinimalWithSyncTester struct { @@ -15,8 +16,8 @@ type MinimalWithSyncTester struct { SyncTester *dsl.SyncTester } -func WithMinimalWithSyncTester() stack.CommonOption { - return stack.MakeCommon(sysgo.DefaultMinimalSystemWithSyncTester(&sysgo.DefaultMinimalSystemWithSyncTesterIDs{})) +func WithMinimalWithSyncTester(fcu eth.FCUState) stack.CommonOption { + return stack.MakeCommon(sysgo.DefaultMinimalSystemWithSyncTester(&sysgo.DefaultMinimalSystemWithSyncTesterIDs{}, fcu)) } func NewMinimalWithSyncTester(t devtest.T) *MinimalWithSyncTester { diff --git a/op-devstack/presets/simple_with_synctester.go b/op-devstack/presets/simple_with_synctester.go new file mode 100644 index 00000000000..71d7c87cb56 --- /dev/null +++ b/op-devstack/presets/simple_with_synctester.go @@ -0,0 +1,49 @@ +package presets + +import ( + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/dsl" + "github.com/ethereum-optimism/optimism/op-devstack/shim" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-devstack/stack/match" + "github.com/ethereum-optimism/optimism/op-devstack/sysgo" + "github.com/ethereum-optimism/optimism/op-node/rollup" + "github.com/ethereum-optimism/optimism/op-service/eth" +) + +type SimpleWithSyncTester struct { + Minimal + + SyncTester *dsl.SyncTester + SyncTesterL2EL *dsl.L2ELNode + L2CL2 *dsl.L2CLNode +} + +func WithSimpleWithSyncTester(fcus eth.FCUState) stack.CommonOption { + return stack.MakeCommon(sysgo.DefaultSimpleSystemWithSyncTester(&sysgo.DefaultSimpleSystemWithSyncTesterIDs{}, fcus)) +} + +func NewSimpleWithSyncTester(t devtest.T) *SimpleWithSyncTester { + system := shim.NewSystem(t) + orch := Orchestrator() + orch.Hydrate(system) + minimal := minimalFromSystem(t, system, orch) + l2 := system.L2Network(match.L2ChainA) + syncTester := l2.SyncTester(match.FirstSyncTester) + + // L2CL connected to L2EL initialized by sync tester + l2CL2 := l2.L2CLNode(match.SecondL2CL) + // L2EL initialized by sync tester + syncTesterL2EL := l2.L2ELNode(match.SecondL2EL) + + return &SimpleWithSyncTester{ + Minimal: *minimal, + SyncTester: dsl.NewSyncTester(syncTester), + SyncTesterL2EL: dsl.NewL2ELNode(syncTesterL2EL, orch.ControlPlane()), + L2CL2: dsl.NewL2CLNode(l2CL2, orch.ControlPlane()), + } +} + +func WithHardforkSequentialActivation(startFork, endFork rollup.ForkName, delta uint64) stack.CommonOption { + return stack.MakeCommon(sysgo.WithDeployerOptions(sysgo.WithHardforkSequentialActivation(startFork, endFork, &delta))) +} diff --git a/op-devstack/presets/singlechain_multinode.go b/op-devstack/presets/singlechain_multinode.go index f950ce8b242..9952155df84 100644 --- a/op-devstack/presets/singlechain_multinode.go +++ b/op-devstack/presets/singlechain_multinode.go @@ -7,6 +7,7 @@ import ( "github.com/ethereum-optimism/optimism/op-devstack/stack" "github.com/ethereum-optimism/optimism/op-devstack/stack/match" "github.com/ethereum-optimism/optimism/op-devstack/sysgo" + "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types" ) type SingleChainMultiNode struct { @@ -35,9 +36,15 @@ func NewSingleChainMultiNode(t devtest.T) *SingleChainMultiNode { match.And( match.EngineFor(verifierCL), match.Not[stack.L2ELNodeID, stack.L2ELNode](minimal.L2EL.ID())))) - return &SingleChainMultiNode{ + preset := &SingleChainMultiNode{ Minimal: *minimal, L2ELB: dsl.NewL2ELNode(verifierEL, orch.ControlPlane()), L2CLB: dsl.NewL2CLNode(verifierCL, orch.ControlPlane()), } + // Ensure the follower node is in sync with the sequencer before starting tests + dsl.CheckAll(t, + preset.L2CLB.MatchedFn(preset.L2CL, types.CrossSafe, 30), + preset.L2CLB.MatchedFn(preset.L2CL, types.LocalUnsafe, 30), + ) + return preset } diff --git a/op-devstack/shim/fb_builder.go b/op-devstack/shim/fb_builder.go index 7d1df9fb48f..960747612e3 100644 --- a/op-devstack/shim/fb_builder.go +++ b/op-devstack/shim/fb_builder.go @@ -1,6 +1,8 @@ package shim import ( + "net/http" + "github.com/stretchr/testify/require" "github.com/ethereum-optimism/optimism/op-devstack/stack" @@ -10,9 +12,10 @@ import ( type FlashblocksBuilderNodeConfig struct { ELNodeConfig - ID stack.FlashblocksBuilderID - Conductor stack.Conductor - FlashblocksWsUrl string + ID stack.FlashblocksBuilderID + Conductor stack.Conductor + FlashblocksWsUrl string + FlashblocksWsHeaders http.Header } type flashblocksBuilderNode struct { @@ -22,7 +25,8 @@ type flashblocksBuilderNode struct { id stack.FlashblocksBuilderID conductor stack.Conductor - flashblocksWsUrl string + flashblocksWsUrl string + flashblocksWsHeaders http.Header } var _ stack.FlashblocksBuilderNode = (*flashblocksBuilderNode)(nil) @@ -34,11 +38,12 @@ func NewFlashblocksBuilderNode(cfg FlashblocksBuilderNodeConfig) stack.Flashbloc require.NoError(cfg.T, err) return &flashblocksBuilderNode{ - rpcELNode: newRpcELNode(cfg.ELNodeConfig), - l2Client: l2Client, - id: cfg.ID, - conductor: cfg.Conductor, - flashblocksWsUrl: cfg.FlashblocksWsUrl, + rpcELNode: newRpcELNode(cfg.ELNodeConfig), + l2Client: l2Client, + id: cfg.ID, + conductor: cfg.Conductor, + flashblocksWsUrl: cfg.FlashblocksWsUrl, + flashblocksWsHeaders: cfg.FlashblocksWsHeaders, } } @@ -57,3 +62,7 @@ func (r *flashblocksBuilderNode) L2EthClient() apis.L2EthClient { func (r *flashblocksBuilderNode) FlashblocksWsUrl() string { return r.flashblocksWsUrl } + +func (r *flashblocksBuilderNode) FlashblocksWsHeaders() http.Header { + return r.flashblocksWsHeaders +} diff --git a/op-devstack/shim/fb_ws_proxy.go b/op-devstack/shim/fb_ws_proxy.go index b2e83174374..b01d10441ef 100644 --- a/op-devstack/shim/fb_ws_proxy.go +++ b/op-devstack/shim/fb_ws_proxy.go @@ -1,20 +1,24 @@ package shim import ( + "net/http" + "github.com/ethereum-optimism/optimism/op-devstack/stack" "github.com/ethereum-optimism/optimism/op-service/eth" ) type FlashblocksWebsocketProxyConfig struct { CommonConfig - ID stack.FlashblocksWebsocketProxyID - WsUrl string + ID stack.FlashblocksWebsocketProxyID + WsUrl string + WsHeaders http.Header } type flashblocksWebsocketProxy struct { commonImpl - id stack.FlashblocksWebsocketProxyID - wsUrl string + id stack.FlashblocksWebsocketProxyID + wsUrl string + wsHeaders http.Header } var _ stack.FlashblocksWebsocketProxy = (*flashblocksWebsocketProxy)(nil) @@ -25,6 +29,7 @@ func NewFlashblocksWebsocketProxy(cfg FlashblocksWebsocketProxyConfig) stack.Fla commonImpl: newCommon(cfg.CommonConfig), id: cfg.ID, wsUrl: cfg.WsUrl, + wsHeaders: cfg.WsHeaders, } } @@ -39,3 +44,7 @@ func (r *flashblocksWebsocketProxy) ChainID() eth.ChainID { func (r *flashblocksWebsocketProxy) WsUrl() string { return r.wsUrl } + +func (r *flashblocksWebsocketProxy) WsHeaders() http.Header { + return r.wsHeaders +} diff --git a/op-devstack/shim/l2_cl.go b/op-devstack/shim/l2_cl.go index b1493b05213..bcf02f78355 100644 --- a/op-devstack/shim/l2_cl.go +++ b/op-devstack/shim/l2_cl.go @@ -14,6 +14,8 @@ type L2CLNodeConfig struct { ID stack.L2CLNodeID Client client.RPC + UserRPC string + InteropEndpoint string InteropJwtSecret eth.Bytes32 } @@ -26,6 +28,8 @@ type rpcL2CLNode struct { p2pClient apis.P2PClient els locks.RWMap[stack.L2ELNodeID, stack.L2ELNode] + userRPC string + // Store interop ws endpoints and secrets to provide to the supervisor, // when reconnection happens using the supervisor's admin_addL2RPC method. // These fields are not intended for manual dial-in or initializing client.RPC @@ -44,11 +48,16 @@ func NewL2CLNode(cfg L2CLNodeConfig) stack.L2CLNode { client: cfg.Client, rollupClient: sources.NewRollupClient(cfg.Client), p2pClient: sources.NewP2PClient(cfg.Client), + userRPC: cfg.UserRPC, interopEndpoint: cfg.InteropEndpoint, interopJwtSecret: cfg.InteropJwtSecret, } } +func (r *rpcL2CLNode) ClientRPC() client.RPC { + return r.client +} + func (r *rpcL2CLNode) ID() stack.L2CLNodeID { return r.id } @@ -69,6 +78,10 @@ func (r *rpcL2CLNode) ELs() []stack.L2ELNode { return stack.SortL2ELNodes(r.els.Values()) } +func (r *rpcL2CLNode) UserRPC() string { + return r.userRPC +} + func (r *rpcL2CLNode) InteropRPC() (endpoint string, jwtSecret eth.Bytes32) { return r.interopEndpoint, r.interopJwtSecret } diff --git a/op-devstack/shim/sync_tester.go b/op-devstack/shim/sync_tester.go index 9f17db3a425..460169e148f 100644 --- a/op-devstack/shim/sync_tester.go +++ b/op-devstack/shim/sync_tester.go @@ -1,22 +1,29 @@ package shim import ( + "fmt" + "github.com/ethereum-optimism/optimism/op-devstack/stack" "github.com/ethereum-optimism/optimism/op-service/apis" "github.com/ethereum-optimism/optimism/op-service/client" "github.com/ethereum-optimism/optimism/op-service/sources" + "github.com/ethereum-optimism/optimism/op-sync-tester/synctester" ) type SyncTesterConfig struct { CommonConfig ID stack.SyncTesterID + Addr string Client client.RPC } // presetSyncTester wraps around a syncTester-service, type presetSyncTester struct { commonImpl - id stack.SyncTesterID + id stack.SyncTesterID + // Endpoint for initializing RPC Client per session + addr string + // RPC Client initialized without session syncTesterClient *sources.SyncTesterClient } @@ -27,6 +34,7 @@ func NewSyncTester(cfg SyncTesterConfig) stack.SyncTester { return &presetSyncTester{ id: cfg.ID, commonImpl: newCommon(cfg.CommonConfig), + addr: cfg.Addr, syncTesterClient: sources.NewSyncTesterClient(cfg.Client), } } @@ -38,3 +46,11 @@ func (p *presetSyncTester) ID() stack.SyncTesterID { func (p *presetSyncTester) API() apis.SyncTester { return p.syncTesterClient } + +func (p *presetSyncTester) APIWithSession(sessionID string) apis.SyncTester { + require := p.T().Require() + require.NoError(synctester.IsValidSessionID(sessionID)) + rpcCl, err := client.NewRPC(p.T().Ctx(), p.Logger(), p.addr+fmt.Sprintf("/%s", sessionID), client.WithLazyDial()) + require.NoError(err, "sync tester failed to initialize rpc per session") + return sources.NewSyncTesterClient(rpcCl) +} diff --git a/op-devstack/stack/fb_builder.go b/op-devstack/stack/fb_builder.go index 7453f6b7cae..1a67f5b1517 100644 --- a/op-devstack/stack/fb_builder.go +++ b/op-devstack/stack/fb_builder.go @@ -2,6 +2,7 @@ package stack import ( "log/slog" + "net/http" "github.com/ethereum-optimism/optimism/op-service/apis" "github.com/ethereum-optimism/optimism/op-service/eth" @@ -13,6 +14,7 @@ type FlashblocksBuilderNode interface { Conductor() Conductor L2EthClient() apis.L2EthClient FlashblocksWsUrl() string + FlashblocksWsHeaders() http.Header } type FlashblocksBuilderID idWithChain diff --git a/op-devstack/stack/fb_ws_proxy.go b/op-devstack/stack/fb_ws_proxy.go index 52e6f2ed63a..4b0f1167bfa 100644 --- a/op-devstack/stack/fb_ws_proxy.go +++ b/op-devstack/stack/fb_ws_proxy.go @@ -2,6 +2,7 @@ package stack import ( "log/slog" + "net/http" "github.com/ethereum-optimism/optimism/op-service/eth" ) @@ -11,6 +12,7 @@ type FlashblocksWebsocketProxy interface { ChainID() eth.ChainID ID() FlashblocksWebsocketProxyID WsUrl() string + WsHeaders() http.Header } type FlashblocksWebsocketProxyID idWithChain diff --git a/op-devstack/stack/l2_cl.go b/op-devstack/stack/l2_cl.go index 1cb60e25c54..e5e5b042b34 100644 --- a/op-devstack/stack/l2_cl.go +++ b/op-devstack/stack/l2_cl.go @@ -4,6 +4,7 @@ import ( "log/slog" "github.com/ethereum-optimism/optimism/op-service/apis" + "github.com/ethereum-optimism/optimism/op-service/client" "github.com/ethereum-optimism/optimism/op-service/eth" ) @@ -72,9 +73,11 @@ type L2CLNode interface { Common ID() L2CLNodeID + ClientRPC() client.RPC RollupAPI() apis.RollupClient P2PAPI() apis.P2PClient InteropRPC() (endpoint string, jwtSecret eth.Bytes32) + UserRPC() string // ELs returns the engine(s) that this L2CLNode is connected to. // This may be empty, if the L2CL is not connected to any. diff --git a/op-devstack/stack/match/labels.go b/op-devstack/stack/match/labels.go index ad2b217cfc0..97ee2c644c3 100644 --- a/op-devstack/stack/match/labels.go +++ b/op-devstack/stack/match/labels.go @@ -17,19 +17,21 @@ const ( LabelVendor = "vendor" ) -type L2ELVendor string +type Vendor string const ( - OpReth L2ELVendor = "op-reth" - OpGeth L2ELVendor = "op-geth" - Proxyd L2ELVendor = "proxyd" - FlashblocksWebsocketProxy L2ELVendor = "flashblocks-websocket-proxy" + OpReth Vendor = "op-reth" + OpGeth Vendor = "op-geth" + Proxyd Vendor = "proxyd" + FlashblocksWebsocketProxy Vendor = "flashblocks-websocket-proxy" + OpNode Vendor = "op-node" + KonaNode Vendor = "kona-node" ) -func (v L2ELVendor) Match(elems []stack.L2ELNode) []stack.L2ELNode { +func (v Vendor) Match(elems []stack.L2ELNode) []stack.L2ELNode { return WithLabel[stack.L2ELNodeID, stack.L2ELNode](LabelVendor, string(v)).Match(elems) } -func (v L2ELVendor) String() string { +func (v Vendor) String() string { return string(v) } diff --git a/op-devstack/stack/sync_tester.go b/op-devstack/stack/sync_tester.go index 519ff158d95..0601e4e40fb 100644 --- a/op-devstack/stack/sync_tester.go +++ b/op-devstack/stack/sync_tester.go @@ -71,4 +71,6 @@ type SyncTester interface { Common ID() SyncTesterID API() apis.SyncTester + + APIWithSession(sessionID string) apis.SyncTester } diff --git a/op-devstack/sysext/helpers.go b/op-devstack/sysext/helpers.go index f51b0fcb449..cd36fb192d2 100644 --- a/op-devstack/sysext/helpers.go +++ b/op-devstack/sysext/helpers.go @@ -85,8 +85,18 @@ func (orch *Orchestrator) httpClient(t devtest.T, service *descriptors.Service, func (orch *Orchestrator) findProtocolService(service *descriptors.Service, protocol string) (string, http.Header, error) { for proto, endpoint := range service.Endpoints { if proto == protocol { - if orch.env.Env.ReverseProxyURL != "" && len(endpoint.ReverseProxyHeader) > 0 && !orch.useDirectCnx { - return orch.env.Env.ReverseProxyURL, endpoint.ReverseProxyHeader, nil + // Force direct connect for websocket protocols + if protocol != WebsocketFlashblocksProtocol { + if orch.env.Env.ReverseProxyURL != "" && len(endpoint.ReverseProxyHeader) > 0 && !orch.useDirectCnx { + // For WebSocket protocols, convert HTTP URL to WebSocket URL + if protocol == WebsocketFlashblocksProtocol { + wsURL := strings.NewReplacer("http://", "ws://", "https://", "wss://").Replace(orch.env.Env.ReverseProxyURL) + wsURL += "/ws" + + return wsURL, endpoint.ReverseProxyHeader, nil + } + return orch.env.Env.ReverseProxyURL, endpoint.ReverseProxyHeader, nil + } } port := endpoint.Port diff --git a/op-devstack/sysext/l2.go b/op-devstack/sysext/l2.go index bf38d1d6af2..571c60fda2b 100644 --- a/op-devstack/sysext/l2.go +++ b/op-devstack/sysext/l2.go @@ -119,11 +119,40 @@ func (o *Orchestrator) hydrateL2ELCL(node *descriptors.Node, l2Net stack.Extensi clService, ok := node.Services[CLServiceName] require.True(ok, "need L2 CL service for chain", l2ID) + var endpointString string + // Parse the endpoint from the service descriptor. + for proto, endpoint := range clService.Endpoints { + if proto == RPCProtocol { + port := endpoint.Port + if o.usePrivatePorts { + port = endpoint.PrivatePort + } + scheme := endpoint.Scheme + if scheme == "" { + scheme = HTTPProtocol + } + host := endpoint.Host + path := "" + if strings.Contains(host, "/") { + parts := strings.SplitN(host, "/", 2) + host = parts[0] + path = "/" + parts[1] + } + endpointString = fmt.Sprintf("%s://%s:%d%s", scheme, host, port, path) + break + } + } + + require.NotEmpty(endpointString, "no endpoint found for CL service", clService.Name) + + l2Net.Logger().Info("Found endpoint for CL service", "endpoint", endpointString) + clClient := o.rpcClient(l2Net.T(), clService, RPCProtocol, "/", opts...) l2CL := shim.NewL2CLNode(shim.L2CLNodeConfig{ ID: stack.NewL2CLNodeID(clService.Name, l2ID.ChainID()), CommonConfig: shim.NewCommonConfig(l2Net.T()), Client: clClient, + UserRPC: endpointString, }) l2Net.AddL2CLNode(l2CL) l2CL.(stack.LinkableL2CLNode).LinkEL(l2EL) @@ -177,7 +206,7 @@ func (o *Orchestrator) hydrateFlashblocksBuilderIfPresent(node *descriptors.Node associatedConductorService, ok := node.Services[ConductorServiceName] require.True(ok, "L2 rbuilder service must have an associated conductor service", l2ID) - flashblocksWsUrl, _, err := o.findProtocolService(rbuilderService, WebsocketFlashblocksProtocol) + flashblocksWsUrl, flashblocksWsHeaders, err := o.findProtocolService(rbuilderService, WebsocketFlashblocksProtocol) require.NoError(err, "failed to find websocket service for rbuilder") flashblocksBuilder := shim.NewFlashblocksBuilderNode(shim.FlashblocksBuilderNodeConfig{ @@ -187,8 +216,9 @@ func (o *Orchestrator) hydrateFlashblocksBuilderIfPresent(node *descriptors.Node Client: o.rpcClient(l2Net.T(), rbuilderService, RPCProtocol, "/", opts...), ChainID: l2ID.ChainID(), }, - Conductor: l2Net.Conductor(stack.ConductorID(associatedConductorService.Name)), - FlashblocksWsUrl: flashblocksWsUrl, + Conductor: l2Net.Conductor(stack.ConductorID(associatedConductorService.Name)), + FlashblocksWsUrl: flashblocksWsUrl, + FlashblocksWsHeaders: flashblocksWsHeaders, }) l2Net.AddFlashblocksBuilder(flashblocksBuilder) @@ -231,13 +261,14 @@ func (o *Orchestrator) hydrateFlashblocksWebsocketProxyMaybe(net *descriptors.L2 } for _, instance := range fbWsProxyService { - wsUrl, _, err := o.findProtocolService(instance, WebsocketFlashblocksProtocol) + wsUrl, wsHeaders, err := o.findProtocolService(instance, WebsocketFlashblocksProtocol) require.NoError(err, "failed to get the websocket url for the flashblocks websocket proxy", "service", instance.Name) fbWsProxyShim := shim.NewFlashblocksWebsocketProxy(shim.FlashblocksWebsocketProxyConfig{ CommonConfig: shim.NewCommonConfig(l2Net.T()), ID: stack.NewFlashblocksWebsocketProxyID(instance.Name, l2ID.ChainID()), WsUrl: wsUrl, + WsHeaders: wsHeaders, }) fbWsProxyShim.SetLabel(match.LabelVendor, string(match.FlashblocksWebsocketProxy)) l2Net.AddFlashblocksWebsocketProxy(fbWsProxyShim) diff --git a/op-devstack/sysgo/control_plane_test.go b/op-devstack/sysgo/control_plane_test.go index 4a911ca4115..6c601d4ffe3 100644 --- a/op-devstack/sysgo/control_plane_test.go +++ b/op-devstack/sysgo/control_plane_test.go @@ -118,14 +118,16 @@ func testL2CLRestart(ids DefaultInteropSystemIDs, system stack.System, control s // stop L2CL control.L2CLNodeState(ids.L2ACL, stack.Stop) - // L2CL API will not work since L2CL stopped + // L2CL API will still kind of work, it is not functioning, + // but since L2CL is behind a proxy, the proxy is still online, and may create a different error. + // The dial will be accepted, and the connection then closed, once the connection behind the proxy fails. { ctx, cancel := context.WithTimeout(context.Background(), time.Second*10) _, err := retry.Do[*eth.SyncStatus](ctx, 10, retry.Fixed(time.Millisecond*500), func() (*eth.SyncStatus, error) { return seqA.RollupAPI().SyncStatus(ctx) }) cancel() - require.Error(t, err) + require.Error(t, err, "should not be able to get sync-status when node behind proxy is offline") } // restart L2CL diff --git a/op-devstack/sysgo/deployer.go b/op-devstack/sysgo/deployer.go index f01bb2240ed..4c204d5b9be 100644 --- a/op-devstack/sysgo/deployer.go +++ b/op-devstack/sysgo/deployer.go @@ -249,6 +249,13 @@ func WithPrefundedL2(l1ChainID, l2ChainID eth.ChainID) DeployerOption { } } +// WithDevFeatureBitmap sets the dev feature bitmap. +func WithDevFeatureBitmap(devFlags common.Hash) DeployerOption { + return func(p devtest.P, keys devkeys.Keys, builder intentbuilder.Builder) { + builder.WithGlobalOverride("devFeatureBitmap", devFlags) + } +} + // WithInteropAtGenesis activates interop at genesis for all known L2s func WithInteropAtGenesis() DeployerOption { return func(p devtest.P, keys devkeys.Keys, builder intentbuilder.Builder) { @@ -258,6 +265,34 @@ func WithInteropAtGenesis() DeployerOption { } } +// WithHardforkSequentialActivation configures a deployment such that L2 chains +// activate hardforks sequentially, starting from startFork and continuing +// until (but not including) endFork. Each successive fork is scheduled at +// an increasing offset. +func WithHardforkSequentialActivation(startFork, endFork rollup.ForkName, delta *uint64) DeployerOption { + return func(p devtest.P, keys devkeys.Keys, builder intentbuilder.Builder) { + for _, l2Cfg := range builder.L2s() { + l2Cfg.WithForkAtGenesis(startFork) + activateWithOffset := false + deactivate := false + for idx, refFork := range rollup.AllForks { + if deactivate || refFork == endFork { + l2Cfg.WithForkAtOffset(refFork, nil) + deactivate = true + continue + } + if activateWithOffset { + offset := *delta * uint64(idx) + l2Cfg.WithForkAtOffset(refFork, &offset) + } + if startFork == refFork { + activateWithOffset = true + } + } + } + } +} + // WithSequencingWindow overrides the number of L1 blocks in a sequencing window, applied to all L2s. func WithSequencingWindow(n uint64) DeployerOption { return func(p devtest.P, keys devkeys.Keys, builder intentbuilder.Builder) { diff --git a/op-devstack/sysgo/faucet.go b/op-devstack/sysgo/faucet.go index c9b630c4d01..f746ade136b 100644 --- a/op-devstack/sysgo/faucet.go +++ b/op-devstack/sysgo/faucet.go @@ -23,6 +23,10 @@ type FaucetService struct { } func (n *FaucetService) hydrate(system stack.ExtensibleSystem) { + if n == nil || n.service == nil { + return + } + require := system.T().Require() for faucetID, chainID := range n.service.Faucets() { @@ -86,7 +90,7 @@ func WithFaucets(l1ELs []stack.L1ELNodeID, l2ELs []stack.L2ELNodeID) stack.Optio require.True(ok, "need L2 EL for faucet", elID) faucets[id] = &fconf.FaucetEntry{ - ELRPC: endpoint.MustRPC{Value: endpoint.URL(el.userRPC)}, + ELRPC: endpoint.MustRPC{Value: endpoint.URL(el.UserRPC())}, ChainID: elID.ChainID(), TxCfg: fconf.TxManagerConfig{ PrivateKey: funderKeyStr, @@ -94,7 +98,9 @@ func WithFaucets(l1ELs []stack.L1ELNodeID, l2ELs []stack.L2ELNodeID) stack.Optio } } cfg := &config.Config{ - RPC: oprpc.CLIConfig{}, + RPC: oprpc.CLIConfig{ + ListenAddr: "127.0.0.1", + }, Faucets: &fconf.Config{ Faucets: faucets, }, diff --git a/op-devstack/sysgo/l1_nodes.go b/op-devstack/sysgo/l1_nodes.go index 272b15ccef0..750182edbc1 100644 --- a/op-devstack/sysgo/l1_nodes.go +++ b/op-devstack/sysgo/l1_nodes.go @@ -113,3 +113,24 @@ func WithL1Nodes(l1ELID stack.L1ELNodeID, l1CLID stack.L1CLNodeID) stack.Option[ require.True(orch.l1CLs.SetIfMissing(l1CLID, l1CLNode), "must not already exist") }) } + +// WithExtL1Nodes initializes L1 EL and CL nodes that connect to external RPC endpoints +func WithExtL1Nodes(l1ELID stack.L1ELNodeID, l1CLID stack.L1CLNodeID, elRPCEndpoint string, clRPCEndpoint string) stack.Option[*Orchestrator] { + return stack.AfterDeploy(func(orch *Orchestrator) { + require := orch.P().Require() + + // Create L1 EL node with external RPC + l1ELNode := &L1ELNode{ + id: l1ELID, + userRPC: elRPCEndpoint, + } + require.True(orch.l1ELs.SetIfMissing(l1ELID, l1ELNode), "must not already exist") + + // Create L1 CL node with external RPC + l1CLNode := &L1CLNode{ + id: l1CLID, + beaconHTTPAddr: clRPCEndpoint, + } + require.True(orch.l1CLs.SetIfMissing(l1CLID, l1CLNode), "must not already exist") + }) +} diff --git a/op-devstack/sysgo/l2_batcher.go b/op-devstack/sysgo/l2_batcher.go index e5a11684d86..e4aaf5e35d5 100644 --- a/op-devstack/sysgo/l2_batcher.go +++ b/op-devstack/sysgo/l2_batcher.go @@ -87,8 +87,8 @@ func WithBatcher(batcherID stack.L2BatcherID, l1ELID stack.L1ELNodeID, l2CLID st batcherCLIConfig := &bss.CLIConfig{ L1EthRpc: l1EL.userRPC, - L2EthRpc: []string{l2EL.userRPC}, - RollupRpc: []string{l2CL.userRPC}, + L2EthRpc: []string{l2EL.UserRPC()}, + RollupRpc: []string{l2CL.UserRPC()}, MaxPendingTransactions: 1, MaxChannelDuration: 1, MaxL1TxSize: 120_000, @@ -133,8 +133,8 @@ func WithBatcher(batcherID stack.L2BatcherID, l1ELID stack.L1ELNodeID, l2CLID st service: batcher, rpc: batcher.HTTPEndpoint(), l1RPC: l1EL.userRPC, - l2CLRPC: l2CL.userRPC, - l2ELRPC: l2EL.userRPC, + l2CLRPC: l2CL.UserRPC(), + l2ELRPC: l2EL.UserRPC(), } orch.batchers.Set(batcherID, b) }) diff --git a/op-devstack/sysgo/l2_challenger.go b/op-devstack/sysgo/l2_challenger.go index db112b8b92f..58732fc7b0a 100644 --- a/op-devstack/sysgo/l2_challenger.go +++ b/op-devstack/sysgo/l2_challenger.go @@ -113,12 +113,12 @@ func WithL2ChallengerPostDeploy(orch *Orchestrator, challengerID stack.L2Challen for i, l2ELID := range l2ELIDs { l2EL, ok := orch.l2ELs.Get(l2ELID) require.True(ok) - l2ELRPCs[i] = l2EL.userRPC + l2ELRPCs[i] = l2EL.UserRPC() } cluster, ok := orch.clusters.Get(*clusterID) require.True(ok) prestateVariant := shared.InteropVariant - cfg, err = shared.NewInteropChallengerConfig(dir, l1EL.userRPC, l1CL.beaconHTTPAddr, supervisorNode.userRPC, l2ELRPCs, + cfg, err = shared.NewInteropChallengerConfig(dir, l1EL.userRPC, l1CL.beaconHTTPAddr, supervisorNode.UserRPC(), l2ELRPCs, shared.WithFactoryAddress(disputeGameFactoryAddr), shared.WithPrivKey(challengerSecret), shared.WithDepset(cluster.DepSet()), @@ -143,7 +143,7 @@ func WithL2ChallengerPostDeploy(orch *Orchestrator, challengerID stack.L2Challen l2EL, ok := orch.l2ELs.Get(l2ELID) require.True(ok) prestateVariant := shared.MTCannonVariant - cfg, err = shared.NewPreInteropChallengerConfig(dir, l1EL.userRPC, l1CL.beaconHTTPAddr, l2CL.userRPC, l2EL.userRPC, + cfg, err = shared.NewPreInteropChallengerConfig(dir, l1EL.userRPC, l1CL.beaconHTTPAddr, l2CL.UserRPC(), l2EL.UserRPC(), shared.WithFactoryAddress(disputeGameFactoryAddr), shared.WithPrivKey(challengerSecret), shared.WithCannonConfig(rollupCfgs, l2Geneses, prestateVariant), diff --git a/op-devstack/sysgo/l2_cl.go b/op-devstack/sysgo/l2_cl.go index 54b42a62ef4..a7f3a4366dc 100644 --- a/op-devstack/sysgo/l2_cl.go +++ b/op-devstack/sysgo/l2_cl.go @@ -1,395 +1,95 @@ package sysgo import ( - "context" - "encoding/hex" - "flag" - "fmt" - "sync" - "time" + "os" - "github.com/ethereum-optimism/optimism/op-service/testutils/tcpproxy" - - altda "github.com/ethereum-optimism/optimism/op-alt-da" - "github.com/ethereum-optimism/optimism/op-chain-ops/devkeys" "github.com/ethereum-optimism/optimism/op-devstack/devtest" - "github.com/ethereum-optimism/optimism/op-devstack/shim" "github.com/ethereum-optimism/optimism/op-devstack/stack" - "github.com/ethereum-optimism/optimism/op-e2e/e2eutils/opnode" - "github.com/ethereum-optimism/optimism/op-node/config" - opNodeFlags "github.com/ethereum-optimism/optimism/op-node/flags" - "github.com/ethereum-optimism/optimism/op-node/p2p" - p2pcli "github.com/ethereum-optimism/optimism/op-node/p2p/cli" - "github.com/ethereum-optimism/optimism/op-node/rollup/driver" - "github.com/ethereum-optimism/optimism/op-node/rollup/interop" nodeSync "github.com/ethereum-optimism/optimism/op-node/rollup/sync" - "github.com/ethereum-optimism/optimism/op-service/apis" - "github.com/ethereum-optimism/optimism/op-service/client" "github.com/ethereum-optimism/optimism/op-service/eth" - opmetrics "github.com/ethereum-optimism/optimism/op-service/metrics" - "github.com/ethereum-optimism/optimism/op-service/oppprof" - "github.com/ethereum-optimism/optimism/op-service/retry" - oprpc "github.com/ethereum-optimism/optimism/op-service/rpc" - "github.com/ethereum-optimism/optimism/op-service/sources" - "github.com/ethereum-optimism/optimism/op-service/testreq" - "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/backend/depset" - "github.com/ethereum/go-ethereum/crypto" - "github.com/ethereum/go-ethereum/log" - "github.com/urfave/cli/v2" ) -type L2CLNode struct { - mu sync.Mutex - - id stack.L2CLNodeID - opNode *opnode.Opnode - userRPC string - interopEndpoint string - interopJwtSecret eth.Bytes32 - cfg *config.Config - p devtest.P - logger log.Logger - el stack.L2ELNodeID - userProxy *tcpproxy.Proxy - interopProxy *tcpproxy.Proxy +type L2CLNode interface { + hydrate(system stack.ExtensibleSystem) + stack.Lifecycle + UserRPC() string + InteropRPC() (endpoint string, jwtSecret eth.Bytes32) } -var _ stack.Lifecycle = (*L2CLNode)(nil) +type L2CLConfig struct { + // SyncMode to run, if this is a sequencer + SequencerSyncMode nodeSync.Mode + // SyncMode to run, if this is a verifier + VerifierSyncMode nodeSync.Mode -func (n *L2CLNode) hydrate(system stack.ExtensibleSystem) { - require := system.T().Require() - rpcCl, err := client.NewRPC(system.T().Ctx(), system.Logger(), n.userRPC, client.WithLazyDial()) - require.NoError(err) - system.T().Cleanup(rpcCl.Close) + // SafeDBPath is the path to the safe DB to use. Disabled if empty. + SafeDBPath string - sysL2CL := shim.NewL2CLNode(shim.L2CLNodeConfig{ - CommonConfig: shim.NewCommonConfig(system.T()), - ID: n.id, - Client: rpcCl, - InteropEndpoint: n.interopEndpoint, - InteropJwtSecret: n.interopJwtSecret, - }) - l2Net := system.L2Network(stack.L2NetworkID(n.id.ChainID())) - l2Net.(stack.ExtensibleL2Network).AddL2CLNode(sysL2CL) - sysL2CL.(stack.LinkableL2CLNode).LinkEL(l2Net.L2ELNode(n.el)) + IsSequencer bool + IndexingMode bool } -func (n *L2CLNode) Start() { - n.mu.Lock() - defer n.mu.Unlock() - if n.opNode != nil { - n.logger.Warn("Op-node already started") - return - } - - if n.userProxy == nil { - n.userProxy = tcpproxy.New(n.logger.New("proxy", "l2cl-user")) - n.p.Require().NoError(n.userProxy.Start()) - n.p.Cleanup(func() { - n.userProxy.Close() - }) - n.userRPC = "http://" + n.userProxy.Addr() - } - - if n.interopProxy == nil { - n.interopProxy = tcpproxy.New(n.logger.New("proxy", "l2cl-interop")) - n.p.Require().NoError(n.interopProxy.Start()) - n.p.Cleanup(func() { - n.interopProxy.Close() - }) - n.interopEndpoint = "ws://" + n.interopProxy.Addr() - } +func L2CLSequencer() L2CLOption { + return L2CLOptionFn(func(p devtest.P, id stack.L2CLNodeID, cfg *L2CLConfig) { + cfg.IsSequencer = true + }) +} - n.logger.Info("Starting op-node") - opNode, err := opnode.NewOpnode(n.logger, n.cfg, func(err error) { - n.p.Require().NoError(err, "op-node critical error") +func L2CLIndexing() L2CLOption { + return L2CLOptionFn(func(p devtest.P, id stack.L2CLNodeID, cfg *L2CLConfig) { + cfg.IndexingMode = true }) - n.p.Require().NoError(err, "op-node failed to start") - n.logger.Info("Started op-node") - n.opNode = opNode - n.userProxy.SetUpstream(ProxyAddr(n.p.Require(), opNode.UserRPC().RPC())) - interopEndpoint, interopJwtSecret := opNode.InteropRPC() - n.interopProxy.SetUpstream(ProxyAddr(n.p.Require(), interopEndpoint)) - n.interopJwtSecret = interopJwtSecret } -func (n *L2CLNode) Stop() { - n.mu.Lock() - defer n.mu.Unlock() - if n.opNode == nil { - n.logger.Warn("Op-node already stopped") - return +func DefaultL2CLConfig() *L2CLConfig { + return &L2CLConfig{ + SequencerSyncMode: nodeSync.CLSync, + VerifierSyncMode: nodeSync.CLSync, + SafeDBPath: "", + IsSequencer: false, + IndexingMode: false, } - ctx, cancel := context.WithCancel(context.Background()) - cancel() // force-quit - n.logger.Info("Closing op-node") - closeErr := n.opNode.Stop(ctx) - n.logger.Info("Closed op-node", "err", closeErr) - - n.opNode = nil } -func (n *L2CLNode) InteropRPC() (string, eth.Bytes32) { - n.mu.Lock() - defer n.mu.Unlock() - return n.interopEndpoint, n.interopJwtSecret +type L2CLOption interface { + Apply(p devtest.P, id stack.L2CLNodeID, cfg *L2CLConfig) } -type L2CLOption func(p devtest.P, id stack.L2CLNodeID, cfg *config.Config) - -func WithL2CLOption(opt L2CLOption) stack.Option[*Orchestrator] { +// WithGlobalL2CLOption applies the L2CLOption to all L2CLNode instances in this orchestrator +func WithGlobalL2CLOption(opt L2CLOption) stack.Option[*Orchestrator] { return stack.BeforeDeploy(func(o *Orchestrator) { o.l2CLOptions = append(o.l2CLOptions, opt) }) } -func WithL2CLNode(l2CLID stack.L2CLNodeID, isSequencer bool, indexingMode bool, l1CLID stack.L1CLNodeID, l1ELID stack.L1ELNodeID, l2ELID stack.L2ELNodeID) stack.Option[*Orchestrator] { - return stack.AfterDeploy(func(orch *Orchestrator) { - p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), l2CLID)) - - require := p.Require() - - l2Net, ok := orch.l2Nets.Get(l2CLID.ChainID()) - require.True(ok, "l2 network required") - - l1EL, ok := orch.l1ELs.Get(l1ELID) - require.True(ok, "l1 EL node required") - - l1CL, ok := orch.l1CLs.Get(l1CLID) - require.True(ok, "l1 CL node required") - - l2EL, ok := orch.l2ELs.Get(l2ELID) - require.True(ok, "l2 EL node required") - - var depSet depset.DependencySet - if cluster, ok := orch.ClusterForL2(l2ELID.ChainID()); ok { - depSet = cluster.DepSet() - } - - jwtPath, jwtSecret := orch.writeDefaultJWT() - - logger := p.Logger() - - var p2pSignerSetup p2p.SignerSetup - var p2pConfig *p2p.Config - // code block for P2P setup - { - // make a dummy flagset since p2p config initialization helpers only input cli context - fs := flag.NewFlagSet("", flag.ContinueOnError) - // use default flags - for _, f := range opNodeFlags.P2PFlags(opNodeFlags.EnvVarPrefix) { - require.NoError(f.Apply(fs)) - } - // mandatory P2P flags - require.NoError(fs.Set(opNodeFlags.AdvertiseIPName, "127.0.0.1")) - require.NoError(fs.Set(opNodeFlags.AdvertiseTCPPortName, "0")) - require.NoError(fs.Set(opNodeFlags.AdvertiseUDPPortName, "0")) - require.NoError(fs.Set(opNodeFlags.ListenIPName, "127.0.0.1")) - require.NoError(fs.Set(opNodeFlags.ListenTCPPortName, "0")) - require.NoError(fs.Set(opNodeFlags.ListenUDPPortName, "0")) - // avoid resource unavailable error by using memorydb - require.NoError(fs.Set(opNodeFlags.DiscoveryPathName, "memory")) - require.NoError(fs.Set(opNodeFlags.PeerstorePathName, "memory")) - // For peer ID - networkPrivKey, err := crypto.GenerateKey() - require.NoError(err) - networkPrivKeyHex := hex.EncodeToString(crypto.FromECDSA(networkPrivKey)) - require.NoError(fs.Set(opNodeFlags.P2PPrivRawName, networkPrivKeyHex)) - // Explicitly set to empty; do not default to resolving DNS of external bootnodes - require.NoError(fs.Set(opNodeFlags.BootnodesName, "")) - - cliCtx := cli.NewContext(&cli.App{}, fs, nil) - if isSequencer { - p2pKey, err := orch.keys.Secret(devkeys.SequencerP2PRole.Key(l2CLID.ChainID().ToBig())) - require.NoError(err, "need p2p key for sequencer") - p2pKeyHex := hex.EncodeToString(crypto.FromECDSA(p2pKey)) - require.NoError(fs.Set(opNodeFlags.SequencerP2PKeyName, p2pKeyHex)) - p2pSignerSetup, err = p2pcli.LoadSignerSetup(cliCtx, logger) - require.NoError(err, "failed to load p2p signer") - logger.Info("Sequencer key acquired") - } - p2pConfig, err = p2pcli.NewConfig(cliCtx, l2Net.rollupCfg.BlockTime) - require.NoError(err, "failed to load p2p config") - } - - // specify interop config, but do not configure anything, to disable indexing mode - interopCfg := &interop.Config{} +type L2CLOptionFn func(p devtest.P, id stack.L2CLNodeID, cfg *L2CLConfig) - if indexingMode { - interopCfg = &interop.Config{ - RPCAddr: "127.0.0.1", - // When L2CL starts, store its RPC port here - // given by the os, to reclaim when restart. - RPCPort: 0, - RPCJwtSecretPath: jwtPath, - } - } +var _ L2CLOption = L2CLOptionFn(nil) - nodeCfg := &config.Config{ - L1: &config.L1EndpointConfig{ - L1NodeAddr: l1EL.userRPC, - L1TrustRPC: false, - L1RPCKind: sources.RPCKindDebugGeth, - RateLimit: 0, - BatchSize: 20, - HttpPollInterval: time.Millisecond * 100, - MaxConcurrency: 10, - CacheSize: 0, // auto-adjust to sequence window - }, - L2: &config.L2EndpointConfig{ - L2EngineAddr: l2EL.authRPC, - L2EngineJWTSecret: jwtSecret, - }, - Beacon: &config.L1BeaconEndpointConfig{ - BeaconAddr: l1CL.beacon.BeaconAddr(), - }, - Driver: driver.Config{ - SequencerEnabled: isSequencer, - SequencerConfDepth: 2, - }, - Rollup: *l2Net.rollupCfg, - DependencySet: depSet, - P2PSigner: p2pSignerSetup, // nil when not sequencer - RPC: oprpc.CLIConfig{ - ListenAddr: "127.0.0.1", - // When L2CL starts, store its RPC port here - // given by the os, to reclaim when restart. - ListenPort: 0, - EnableAdmin: true, - }, - InteropConfig: interopCfg, - P2P: p2pConfig, - L1EpochPollInterval: time.Second * 2, - RuntimeConfigReloadInterval: 0, - Tracer: nil, - Sync: nodeSync.Config{ - SyncMode: nodeSync.CLSync, - SkipSyncStartCheck: false, - SupportsPostFinalizationELSync: false, - }, - ConfigPersistence: config.DisabledConfigPersistence{}, - Metrics: opmetrics.CLIConfig{}, - Pprof: oppprof.CLIConfig{}, - SafeDBPath: "", - RollupHalt: "", - Cancel: nil, - ConductorEnabled: false, - ConductorRpc: nil, - ConductorRpcTimeout: 0, - AltDA: altda.CLIConfig{}, - IgnoreMissingPectraBlobSchedule: false, - ExperimentalOPStackAPI: true, - } - for _, opt := range orch.l2CLOptions { - opt(orch.P(), l2CLID, nodeCfg) - } - l2CLNode := &L2CLNode{ - id: l2CLID, - cfg: nodeCfg, - logger: logger, - p: p, - el: l2ELID, - } - require.True(orch.l2CLs.SetIfMissing(l2CLID, l2CLNode), "must not already exist") - l2CLNode.Start() - p.Cleanup(l2CLNode.Stop) - }) +func (fn L2CLOptionFn) Apply(p devtest.P, id stack.L2CLNodeID, cfg *L2CLConfig) { + fn(p, id, cfg) } -func GetP2PClient(ctx context.Context, logger log.Logger, l2CLNode *L2CLNode) (*sources.P2PClient, error) { - rpcClient, err := client.NewRPC(ctx, logger, l2CLNode.userRPC, client.WithLazyDial()) - if err != nil { - return nil, fmt.Errorf("failed to initialize rpc client for p2p client: %w", err) - } - return sources.NewP2PClient(rpcClient), nil -} +// L2CLOptionBundle a list of multiple L2CLOption, to all be applied in order. +type L2CLOptionBundle []L2CLOption -func GetPeerInfo(ctx context.Context, p2pClient *sources.P2PClient) (*apis.PeerInfo, error) { - peerInfo, err := retry.Do(ctx, 3, retry.Exponential(), func() (*apis.PeerInfo, error) { - return p2pClient.Self(ctx) - }) - if err != nil { - return nil, fmt.Errorf("failed to get peer info: %w", err) - } - return peerInfo, nil -} +var _ L2CLOption = L2CLOptionBundle(nil) -func GetPeers(ctx context.Context, p2pClient *sources.P2PClient) (*apis.PeerDump, error) { - peerDump, err := retry.Do(ctx, 3, retry.Exponential(), func() (*apis.PeerDump, error) { - return p2pClient.Peers(ctx, true) - }) - if err != nil { - return nil, fmt.Errorf("failed to get peers: %w", err) +func (l L2CLOptionBundle) Apply(p devtest.P, id stack.L2CLNodeID, cfg *L2CLConfig) { + for _, opt := range l { + p.Require().NotNil(opt, "cannot Apply nil L2CLOption") + opt.Apply(p, id, cfg) } - return peerDump, nil -} - -type p2pClientsAndPeers struct { - client1 *sources.P2PClient - client2 *sources.P2PClient - peerInfo1 *apis.PeerInfo - peerInfo2 *apis.PeerInfo } -func getP2PClientsAndPeers(ctx context.Context, logger log.Logger, require *testreq.Assertions, l2CL1, l2CL2 *L2CLNode) *p2pClientsAndPeers { - p2pClient1, err := GetP2PClient(ctx, logger, l2CL1) - require.NoError(err) - p2pClient2, err := GetP2PClient(ctx, logger, l2CL2) - require.NoError(err) - - peerInfo1, err := GetPeerInfo(ctx, p2pClient1) - require.NoError(err) - peerInfo2, err := GetPeerInfo(ctx, p2pClient2) - require.NoError(err) - - require.True(len(peerInfo1.Addresses) > 0 && len(peerInfo2.Addresses) > 0, "malformed peer info") - - return &p2pClientsAndPeers{ - client1: p2pClient1, - client2: p2pClient2, - peerInfo1: peerInfo1, - peerInfo2: peerInfo2, +// WithL2CLNode adds the default type of L2 CL node. +// The default can be configured with DEVSTACK_L2CL_KIND. +// Tests that depend on specific types can use options like WithKonaNode and WithOpNode directly. +func WithL2CLNode(l2CLID stack.L2CLNodeID, l1CLID stack.L1CLNodeID, l1ELID stack.L1ELNodeID, l2ELID stack.L2ELNodeID, opts ...L2CLOption) stack.Option[*Orchestrator] { + switch os.Getenv("DEVSTACK_L2CL_KIND") { + case "kona": + return WithKonaNode(l2CLID, l1CLID, l1ELID, l2ELID, opts...) + default: + return WithOpNode(l2CLID, l1CLID, l1ELID, l2ELID, opts...) } } - -// WithL2CLP2PConnection connects P2P between two L2CLs -func WithL2CLP2PConnection(l2CL1ID, l2CL2ID stack.L2CLNodeID) stack.Option[*Orchestrator] { - return stack.AfterDeploy(func(orch *Orchestrator) { - require := orch.P().Require() - - l2CL1, ok := orch.l2CLs.Get(l2CL1ID) - require.True(ok, "looking for L2 CL node 1 to connect p2p") - l2CL2, ok := orch.l2CLs.Get(l2CL2ID) - require.True(ok, "looking for L2 CL node 2 to connect p2p") - require.Equal(l2CL1.cfg.Rollup.L2ChainID, l2CL2.cfg.Rollup.L2ChainID, "must be same l2 chain") - - ctx := orch.P().Ctx() - logger := orch.P().Logger() - - p := getP2PClientsAndPeers(ctx, logger, require, l2CL1, l2CL2) - - connectPeer := func(p2pClient *sources.P2PClient, multiAddress string) { - err := retry.Do0(ctx, 6, retry.Exponential(), func() error { - return p2pClient.ConnectPeer(ctx, multiAddress) - }) - require.NoError(err, "failed to connect peer") - } - - connectPeer(p.client1, p.peerInfo2.Addresses[0]) - connectPeer(p.client2, p.peerInfo1.Addresses[0]) - - check := func(peerDump *apis.PeerDump, peerInfo *apis.PeerInfo) { - multiAddress := peerInfo.PeerID.String() - _, ok := peerDump.Peers[multiAddress] - require.True(ok, "peer register invalid") - } - - peerDump1, err := GetPeers(ctx, p.client1) - require.NoError(err) - peerDump2, err := GetPeers(ctx, p.client2) - require.NoError(err) - - check(peerDump1, p.peerInfo2) - check(peerDump2, p.peerInfo1) - }) -} diff --git a/op-devstack/sysgo/l2_cl_kona.go b/op-devstack/sysgo/l2_cl_kona.go new file mode 100644 index 00000000000..d0640c47425 --- /dev/null +++ b/op-devstack/sysgo/l2_cl_kona.go @@ -0,0 +1,232 @@ +package sysgo + +import ( + "encoding/hex" + "encoding/json" + "os" + "path/filepath" + "strings" + "sync" + + "github.com/ethereum/go-ethereum/crypto" + + "github.com/ethereum-optimism/optimism/op-chain-ops/devkeys" + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/shim" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-devstack/stack/match" + "github.com/ethereum-optimism/optimism/op-service/client" + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum-optimism/optimism/op-service/logpipe" + "github.com/ethereum-optimism/optimism/op-service/tasks" + "github.com/ethereum-optimism/optimism/op-service/testutils/tcpproxy" +) + +type KonaNode struct { + mu sync.Mutex + + id stack.L2CLNodeID + + userRPC string + interopEndpoint string // warning: currently not fully supported + interopJwtSecret eth.Bytes32 + el stack.L2ELNodeID + + userProxy *tcpproxy.Proxy + + execPath string + args []string + // Each entry is of the form "key=value". + env []string + + p devtest.P + + sub *SubProcess +} + +func (k *KonaNode) hydrate(system stack.ExtensibleSystem) { + require := system.T().Require() + rpcCl, err := client.NewRPC(system.T().Ctx(), system.Logger(), k.userRPC, client.WithLazyDial()) + require.NoError(err) + system.T().Cleanup(rpcCl.Close) + + sysL2CL := shim.NewL2CLNode(shim.L2CLNodeConfig{ + CommonConfig: shim.NewCommonConfig(system.T()), + ID: k.id, + Client: rpcCl, + UserRPC: k.userRPC, + InteropEndpoint: k.interopEndpoint, + InteropJwtSecret: k.interopJwtSecret, + }) + sysL2CL.SetLabel(match.LabelVendor, string(match.KonaNode)) + l2Net := system.L2Network(stack.L2NetworkID(k.id.ChainID())) + l2Net.(stack.ExtensibleL2Network).AddL2CLNode(sysL2CL) + sysL2CL.(stack.LinkableL2CLNode).LinkEL(l2Net.L2ELNode(k.el)) +} + +func (k *KonaNode) Start() { + k.mu.Lock() + defer k.mu.Unlock() + if k.sub != nil { + k.p.Logger().Warn("Kona-node already started") + return + } + // Create a proxy for the user RPC, + // so other services can connect, and stay connected, across restarts. + if k.userProxy == nil { + k.userProxy = tcpproxy.New(k.p.Logger()) + k.p.Require().NoError(k.userProxy.Start()) + k.p.Cleanup(func() { + k.userProxy.Close() + }) + k.userRPC = "http://" + k.userProxy.Addr() + } + // Create the sub-process. + // We pipe sub-process logs to the test-logger. + // And inspect them along the way, to get the RPC server address. + logOut := logpipe.ToLogger(k.p.Logger().New("src", "stdout")) + logErr := logpipe.ToLogger(k.p.Logger().New("src", "stderr")) + userRPC := make(chan string, 1) + onLogEntry := func(e logpipe.LogEntry) { + switch e.LogMessage() { + case "RPC server bound to address": + userRPC <- "http://" + e.FieldValue("addr").(string) + } + } + stdOutLogs := logpipe.LogProcessor(func(line []byte) { + e := logpipe.ParseRustStructuredLogs(line) + logOut(e) + onLogEntry(e) + }) + stdErrLogs := logpipe.LogProcessor(func(line []byte) { + e := logpipe.ParseRustStructuredLogs(line) + logErr(e) + }) + k.sub = NewSubProcess(k.p, stdOutLogs, stdErrLogs) + + err := k.sub.Start(k.execPath, k.args, k.env) + k.p.Require().NoError(err, "Must start") + + var userRPCAddr string + k.p.Require().NoError(tasks.Await(k.p.Ctx(), userRPC, &userRPCAddr), "need user RPC") + + k.userProxy.SetUpstream(ProxyAddr(k.p.Require(), userRPCAddr)) +} + +// Stop stops the kona node. +// warning: no restarts supported yet, since the RPC port is not remembered. +func (k *KonaNode) Stop() { + k.mu.Lock() + defer k.mu.Unlock() + if k.sub == nil { + k.p.Logger().Warn("kona-node already stopped") + return + } + err := k.sub.Stop() + k.p.Require().NoError(err, "Must stop") + k.sub = nil +} + +func (k *KonaNode) UserRPC() string { + return k.userRPC +} + +func (k *KonaNode) InteropRPC() (endpoint string, jwtSecret eth.Bytes32) { + return k.interopEndpoint, k.interopJwtSecret +} + +var _ L2CLNode = (*KonaNode)(nil) + +func WithKonaNode(l2CLID stack.L2CLNodeID, l1CLID stack.L1CLNodeID, l1ELID stack.L1ELNodeID, l2ELID stack.L2ELNodeID, opts ...L2CLOption) stack.Option[*Orchestrator] { + return stack.AfterDeploy(func(orch *Orchestrator) { + p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), l2CLID)) + + require := p.Require() + + l2Net, ok := orch.l2Nets.Get(l2CLID.ChainID()) + require.True(ok, "l2 network required") + + l1EL, ok := orch.l1ELs.Get(l1ELID) + require.True(ok, "l1 EL node required") + + l1CL, ok := orch.l1CLs.Get(l1CLID) + require.True(ok, "l1 CL node required") + + l2EL, ok := orch.l2ELs.Get(l2ELID) + require.True(ok, "l2 EL node required") + + cfg := DefaultL2CLConfig() + orch.l2CLOptions.Apply(orch.P(), l2CLID, cfg) // apply global options + L2CLOptionBundle(opts).Apply(orch.P(), l2CLID, cfg) // apply specific options + + tempKonaDir := p.TempDir() + + tempP2PPath := filepath.Join(tempKonaDir, "p2pkey.txt") + + tempRollupCfgPath := filepath.Join(tempKonaDir, "rollup.json") + rollupCfgData, err := json.Marshal(l2Net.rollupCfg) + p.Require().NoError(err, "must write rollup config") + p.Require().NoError(err, os.WriteFile(tempRollupCfgPath, rollupCfgData, 0o644)) + + envVars := []string{ + "KONA_NODE_L1_ETH_RPC=" + l1EL.userRPC, + "KONA_NODE_L1_BEACON=" + l1CL.beaconHTTPAddr, + // TODO: WS RPC addresses do not work and will make the startup panic with a connection error in the + // JWT validation / engine-capabilities setup code-path. + "KONA_NODE_L2_ENGINE_RPC=" + strings.ReplaceAll(l2EL.EngineRPC(), "ws://", "http://"), + "KONA_NODE_L2_ENGINE_AUTH=" + l2EL.JWTPath(), + "KONA_NODE_ROLLUP_CONFIG=" + tempRollupCfgPath, + "KONA_NODE_P2P_NO_DISCOVERY=true", + "KONA_NODE_P2P_PRIV_PATH=" + tempP2PPath, + "KONA_NODE_RPC_ADDR=127.0.0.1", + "KONA_NODE_RPC_PORT=0", + "KONA_NODE_RPC_WS_ENABLED=true", + "KONA_METRICS_ENABLED=false", + "KONA_LOG_LEVEL=3", // info level + "KONA_LOG_STDOUT_FORMAT=json", + // p2p ports + "KONA_NODE_P2P_LISTEN_IP=127.0.0.1", + "KONA_NODE_P2P_LISTEN_TCP_PORT=0", + "KONA_NODE_P2P_LISTEN_UDP_PORT=0", + } + if cfg.IsSequencer { + p2pKey, err := orch.keys.Secret(devkeys.SequencerP2PRole.Key(l2CLID.ChainID().ToBig())) + require.NoError(err, "need p2p key for sequencer") + p2pKeyHex := "0x" + hex.EncodeToString(crypto.FromECDSA(p2pKey)) + // TODO: Kona should support loading keys from a file + //tempSeqKeyPath := filepath.Join(tempKonaDir, "p2p-sequencer.txt") + //p.Require().NoError(err, os.WriteFile(tempSeqKeyPath, []byte(p2pKeyHex), 0o644)) + envVars = append(envVars, + "KONA_NODE_P2P_SEQUENCER_KEY="+p2pKeyHex, + "KONA_NODE_SEQUENCER_L1_CONFS=2", + "KONA_NODE_MODE=Sequencer", + ) + } else { + envVars = append(envVars, + "KONA_NODE_MODE=Validator", + ) + } + + execPath := os.Getenv("KONA_NODE_EXEC_PATH") + p.Require().NotEmpty(execPath, "KONA_NODE_EXEC_PATH environment variable must be set") + _, err = os.Stat(execPath) + p.Require().NotErrorIs(err, os.ErrNotExist, "executable must exist") + + k := &KonaNode{ + id: l2CLID, + userRPC: "", // retrieved from logs + interopEndpoint: "", // retrieved from logs + interopJwtSecret: eth.Bytes32{}, + el: l2ELID, + execPath: execPath, + args: []string{"node"}, + env: envVars, + p: p, + } + p.Logger().Info("Starting kona-node") + k.Start() + p.Cleanup(k.Stop) + p.Logger().Info("Kona-node is up", "rpc", k.UserRPC()) + require.True(orch.l2CLs.SetIfMissing(l2CLID, k), "must not already exist") + }) +} diff --git a/op-devstack/sysgo/l2_cl_opnode.go b/op-devstack/sysgo/l2_cl_opnode.go new file mode 100644 index 00000000000..9fab9be3ca0 --- /dev/null +++ b/op-devstack/sysgo/l2_cl_opnode.go @@ -0,0 +1,316 @@ +package sysgo + +import ( + "context" + "encoding/hex" + "flag" + "fmt" + "sync" + "time" + + "github.com/urfave/cli/v2" + + "github.com/ethereum/go-ethereum/crypto" + "github.com/ethereum/go-ethereum/log" + + altda "github.com/ethereum-optimism/optimism/op-alt-da" + "github.com/ethereum-optimism/optimism/op-chain-ops/devkeys" + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/shim" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-devstack/stack/match" + "github.com/ethereum-optimism/optimism/op-e2e/e2eutils/opnode" + "github.com/ethereum-optimism/optimism/op-node/config" + opNodeFlags "github.com/ethereum-optimism/optimism/op-node/flags" + "github.com/ethereum-optimism/optimism/op-node/p2p" + p2pcli "github.com/ethereum-optimism/optimism/op-node/p2p/cli" + "github.com/ethereum-optimism/optimism/op-node/rollup/driver" + "github.com/ethereum-optimism/optimism/op-node/rollup/interop" + nodeSync "github.com/ethereum-optimism/optimism/op-node/rollup/sync" + "github.com/ethereum-optimism/optimism/op-service/client" + "github.com/ethereum-optimism/optimism/op-service/eth" + opmetrics "github.com/ethereum-optimism/optimism/op-service/metrics" + "github.com/ethereum-optimism/optimism/op-service/oppprof" + oprpc "github.com/ethereum-optimism/optimism/op-service/rpc" + "github.com/ethereum-optimism/optimism/op-service/sources" + "github.com/ethereum-optimism/optimism/op-service/testutils/tcpproxy" + "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/backend/depset" +) + +type OpNode struct { + mu sync.Mutex + + id stack.L2CLNodeID + opNode *opnode.Opnode + userRPC string + interopEndpoint string + interopJwtSecret eth.Bytes32 + cfg *config.Config + p devtest.P + logger log.Logger + el *stack.L2ELNodeID // Optional: nil when using SyncTester + userProxy *tcpproxy.Proxy + interopProxy *tcpproxy.Proxy +} + +var _ L2CLNode = (*OpNode)(nil) + +func (n *OpNode) hydrate(system stack.ExtensibleSystem) { + require := system.T().Require() + rpcCl, err := client.NewRPC(system.T().Ctx(), system.Logger(), n.userRPC, client.WithLazyDial()) + require.NoError(err) + system.T().Cleanup(rpcCl.Close) + + sysL2CL := shim.NewL2CLNode(shim.L2CLNodeConfig{ + CommonConfig: shim.NewCommonConfig(system.T()), + ID: n.id, + Client: rpcCl, + UserRPC: n.userRPC, + InteropEndpoint: n.interopEndpoint, + InteropJwtSecret: n.interopJwtSecret, + }) + sysL2CL.SetLabel(match.LabelVendor, string(match.OpNode)) + l2Net := system.L2Network(stack.L2NetworkID(n.id.ChainID())) + l2Net.(stack.ExtensibleL2Network).AddL2CLNode(sysL2CL) + if n.el != nil { + sysL2CL.(stack.LinkableL2CLNode).LinkEL(l2Net.L2ELNode(n.el)) + } +} + +func (n *OpNode) UserRPC() string { + return n.userRPC +} + +func (n *OpNode) InteropRPC() (endpoint string, jwtSecret eth.Bytes32) { + // Make sure to use the proxied interop endpoint + return n.interopEndpoint, n.interopJwtSecret +} + +func (n *OpNode) Start() { + n.mu.Lock() + defer n.mu.Unlock() + if n.opNode != nil { + n.logger.Warn("Op-node already started") + return + } + + if n.userProxy == nil { + n.userProxy = tcpproxy.New(n.logger.New("proxy", "l2cl-user")) + n.p.Require().NoError(n.userProxy.Start()) + n.p.Cleanup(func() { + n.userProxy.Close() + }) + n.userRPC = "http://" + n.userProxy.Addr() + } + if n.interopProxy == nil { + n.interopProxy = tcpproxy.New(n.logger.New("proxy", "l2cl-interop")) + n.p.Require().NoError(n.interopProxy.Start()) + n.p.Cleanup(func() { + n.interopProxy.Close() + }) + n.interopEndpoint = "ws://" + n.interopProxy.Addr() + } + n.logger.Info("Starting op-node") + opNode, err := opnode.NewOpnode(n.logger, n.cfg, func(err error) { + n.p.Require().NoError(err, "op-node critical error") + }) + n.p.Require().NoError(err, "op-node failed to start") + n.logger.Info("Started op-node") + n.opNode = opNode + + n.userProxy.SetUpstream(ProxyAddr(n.p.Require(), opNode.UserRPC().RPC())) + + interopEndpoint, interopJwtSecret := opNode.InteropRPC() + n.interopProxy.SetUpstream(ProxyAddr(n.p.Require(), interopEndpoint)) + n.interopJwtSecret = interopJwtSecret +} + +func (n *OpNode) Stop() { + n.mu.Lock() + defer n.mu.Unlock() + if n.opNode == nil { + n.logger.Warn("Op-node already stopped") + return + } + ctx, cancel := context.WithCancel(context.Background()) + cancel() // force-quit + n.logger.Info("Closing op-node") + closeErr := n.opNode.Stop(ctx) + n.logger.Info("Closed op-node", "err", closeErr) + + n.opNode = nil +} + +func WithOpNode(l2CLID stack.L2CLNodeID, l1CLID stack.L1CLNodeID, l1ELID stack.L1ELNodeID, l2ELID stack.L2ELNodeID, opts ...L2CLOption) stack.Option[*Orchestrator] { + return stack.AfterDeploy(func(orch *Orchestrator) { + p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), l2CLID)) + + require := p.Require() + + l2Net, ok := orch.l2Nets.Get(l2CLID.ChainID()) + require.True(ok, "l2 network required") + + l1EL, ok := orch.l1ELs.Get(l1ELID) + require.True(ok, "l1 EL node required") + + l1CL, ok := orch.l1CLs.Get(l1CLID) + require.True(ok, "l1 CL node required") + + // Get the L2EL node (which can be a regular EL node or a SyncTesterEL) + l2EL, ok := orch.l2ELs.Get(l2ELID) + require.True(ok, "l2 EL node required") + + // Get dependency set from cluster if available + var depSet depset.DependencySet + if cluster, ok := orch.ClusterForL2(l2ELID.ChainID()); ok { + depSet = cluster.DepSet() + } + + cfg := DefaultL2CLConfig() + orch.l2CLOptions.Apply(p, l2CLID, cfg) // apply global options + L2CLOptionBundle(opts).Apply(p, l2CLID, cfg) // apply specific options + + syncMode := cfg.VerifierSyncMode + if cfg.IsSequencer { + syncMode = cfg.SequencerSyncMode + // Sanity check, to navigate legacy sync-mode test assumptions. + // Can't enable ELSync on the sequencer or it will never start sequencing because + // ELSync needs to receive gossip from the sequencer to drive the sync + p.Require().NotEqual(nodeSync.ELSync, syncMode, "sequencer cannot use EL sync") + } + + jwtPath, jwtSecret := orch.writeDefaultJWT() + + logger := p.Logger() + + var p2pSignerSetup p2p.SignerSetup + var p2pConfig *p2p.Config + // code block for P2P setup + { + // make a dummy flagset since p2p config initialization helpers only input cli context + fs := flag.NewFlagSet("", flag.ContinueOnError) + // use default flags + for _, f := range opNodeFlags.P2PFlags(opNodeFlags.EnvVarPrefix) { + require.NoError(f.Apply(fs)) + } + // mandatory P2P flags + require.NoError(fs.Set(opNodeFlags.AdvertiseIPName, "127.0.0.1")) + require.NoError(fs.Set(opNodeFlags.AdvertiseTCPPortName, "0")) + require.NoError(fs.Set(opNodeFlags.AdvertiseUDPPortName, "0")) + require.NoError(fs.Set(opNodeFlags.ListenIPName, "127.0.0.1")) + require.NoError(fs.Set(opNodeFlags.ListenTCPPortName, "0")) + require.NoError(fs.Set(opNodeFlags.ListenUDPPortName, "0")) + // avoid resource unavailable error by using memorydb + require.NoError(fs.Set(opNodeFlags.DiscoveryPathName, "memory")) + require.NoError(fs.Set(opNodeFlags.PeerstorePathName, "memory")) + // For peer ID + networkPrivKey, err := crypto.GenerateKey() + require.NoError(err) + networkPrivKeyHex := hex.EncodeToString(crypto.FromECDSA(networkPrivKey)) + require.NoError(fs.Set(opNodeFlags.P2PPrivRawName, networkPrivKeyHex)) + // Explicitly set to empty; do not default to resolving DNS of external bootnodes + require.NoError(fs.Set(opNodeFlags.BootnodesName, "")) + + cliCtx := cli.NewContext(&cli.App{}, fs, nil) + if cfg.IsSequencer { + p2pKey, err := orch.keys.Secret(devkeys.SequencerP2PRole.Key(l2CLID.ChainID().ToBig())) + require.NoError(err, "need p2p key for sequencer") + p2pKeyHex := hex.EncodeToString(crypto.FromECDSA(p2pKey)) + require.NoError(fs.Set(opNodeFlags.SequencerP2PKeyName, p2pKeyHex)) + p2pSignerSetup, err = p2pcli.LoadSignerSetup(cliCtx, logger) + require.NoError(err, "failed to load p2p signer") + logger.Info("Sequencer key acquired") + } + p2pConfig, err = p2pcli.NewConfig(cliCtx, l2Net.rollupCfg.BlockTime) + require.NoError(err, "failed to load p2p config") + } + + // specify interop config, but do not configure anything, to disable indexing mode + interopCfg := &interop.Config{} + + if cfg.IndexingMode { + interopCfg = &interop.Config{ + RPCAddr: "127.0.0.1", + // When L2CL starts, store its RPC port here + // given by the os, to reclaim when restart. + RPCPort: 0, + RPCJwtSecretPath: jwtPath, + } + } + + // Get the L2 engine address from the EL node (which can be a regular EL node or a SyncTesterEL) + l2EngineAddr := l2EL.EngineRPC() + + nodeCfg := &config.Config{ + L1: &config.L1EndpointConfig{ + L1NodeAddr: l1EL.userRPC, + L1TrustRPC: false, + L1RPCKind: sources.RPCKindDebugGeth, + RateLimit: 0, + BatchSize: 20, + HttpPollInterval: time.Millisecond * 100, + MaxConcurrency: 10, + CacheSize: 0, // auto-adjust to sequence window + }, + L2: &config.L2EndpointConfig{ + L2EngineAddr: l2EngineAddr, + L2EngineJWTSecret: jwtSecret, + }, + Beacon: &config.L1BeaconEndpointConfig{ + BeaconAddr: l1CL.beaconHTTPAddr, + }, + Driver: driver.Config{ + SequencerEnabled: cfg.IsSequencer, + SequencerConfDepth: 2, + }, + Rollup: *l2Net.rollupCfg, + DependencySet: depSet, + P2PSigner: p2pSignerSetup, // nil when not sequencer + RPC: oprpc.CLIConfig{ + ListenAddr: "127.0.0.1", + // When L2CL starts, store its RPC port here + // given by the os, to reclaim when restart. + ListenPort: 0, + EnableAdmin: true, + }, + InteropConfig: interopCfg, + P2P: p2pConfig, + L1EpochPollInterval: time.Second * 2, + RuntimeConfigReloadInterval: 0, + Tracer: nil, + Sync: nodeSync.Config{ + SyncMode: syncMode, + SkipSyncStartCheck: false, + SupportsPostFinalizationELSync: false, + }, + ConfigPersistence: config.DisabledConfigPersistence{}, + Metrics: opmetrics.CLIConfig{}, + Pprof: oppprof.CLIConfig{}, + SafeDBPath: "", + RollupHalt: "", + Cancel: nil, + ConductorEnabled: false, + ConductorRpc: nil, + ConductorRpcTimeout: 0, + AltDA: altda.CLIConfig{}, + IgnoreMissingPectraBlobSchedule: false, + ExperimentalOPStackAPI: true, + } + if cfg.SafeDBPath != "" { + nodeCfg.SafeDBPath = cfg.SafeDBPath + } + + l2CLNode := &OpNode{ + id: l2CLID, + cfg: nodeCfg, + logger: logger, + p: p, + } + + // Set the EL field to link to the L2EL node + l2CLNode.el = &l2ELID + require.True(orch.l2CLs.SetIfMissing(l2CLID, l2CLNode), fmt.Sprintf("must not already exist: %s", l2CLID)) + l2CLNode.Start() + p.Cleanup(l2CLNode.Stop) + }) +} diff --git a/op-devstack/sysgo/l2_cl_p2p_util.go b/op-devstack/sysgo/l2_cl_p2p_util.go new file mode 100644 index 00000000000..911434cd28e --- /dev/null +++ b/op-devstack/sysgo/l2_cl_p2p_util.go @@ -0,0 +1,114 @@ +package sysgo + +import ( + "context" + "fmt" + + "github.com/ethereum/go-ethereum/log" + + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-service/apis" + "github.com/ethereum-optimism/optimism/op-service/client" + "github.com/ethereum-optimism/optimism/op-service/retry" + "github.com/ethereum-optimism/optimism/op-service/sources" + "github.com/ethereum-optimism/optimism/op-service/testreq" +) + +func GetP2PClient(ctx context.Context, logger log.Logger, l2CLNode L2CLNode) (*sources.P2PClient, error) { + rpcClient, err := client.NewRPC(ctx, logger, l2CLNode.UserRPC(), client.WithLazyDial()) + if err != nil { + return nil, fmt.Errorf("failed to initialize rpc client for p2p client: %w", err) + } + return sources.NewP2PClient(rpcClient), nil +} + +func GetPeerInfo(ctx context.Context, p2pClient *sources.P2PClient) (*apis.PeerInfo, error) { + peerInfo, err := retry.Do(ctx, 3, retry.Exponential(), func() (*apis.PeerInfo, error) { + return p2pClient.Self(ctx) + }) + if err != nil { + return nil, fmt.Errorf("failed to get peer info: %w", err) + } + return peerInfo, nil +} + +func GetPeers(ctx context.Context, p2pClient *sources.P2PClient) (*apis.PeerDump, error) { + peerDump, err := retry.Do(ctx, 3, retry.Exponential(), func() (*apis.PeerDump, error) { + return p2pClient.Peers(ctx, true) + }) + if err != nil { + return nil, fmt.Errorf("failed to get peers: %w", err) + } + return peerDump, nil +} + +type p2pClientsAndPeers struct { + client1 *sources.P2PClient + client2 *sources.P2PClient + peerInfo1 *apis.PeerInfo + peerInfo2 *apis.PeerInfo +} + +func getP2PClientsAndPeers(ctx context.Context, logger log.Logger, + require *testreq.Assertions, l2CL1, l2CL2 L2CLNode) *p2pClientsAndPeers { + p2pClient1, err := GetP2PClient(ctx, logger, l2CL1) + require.NoError(err) + p2pClient2, err := GetP2PClient(ctx, logger, l2CL2) + require.NoError(err) + + peerInfo1, err := GetPeerInfo(ctx, p2pClient1) + require.NoError(err) + peerInfo2, err := GetPeerInfo(ctx, p2pClient2) + require.NoError(err) + + require.True(len(peerInfo1.Addresses) > 0 && len(peerInfo2.Addresses) > 0, "malformed peer info") + + return &p2pClientsAndPeers{ + client1: p2pClient1, + client2: p2pClient2, + peerInfo1: peerInfo1, + peerInfo2: peerInfo2, + } +} + +// WithL2CLP2PConnection connects P2P between two L2CLs +func WithL2CLP2PConnection(l2CL1ID, l2CL2ID stack.L2CLNodeID) stack.Option[*Orchestrator] { + return stack.AfterDeploy(func(orch *Orchestrator) { + require := orch.P().Require() + + l2CL1, ok := orch.l2CLs.Get(l2CL1ID) + require.True(ok, "looking for L2 CL node 1 to connect p2p") + l2CL2, ok := orch.l2CLs.Get(l2CL2ID) + require.True(ok, "looking for L2 CL node 2 to connect p2p") + require.Equal(l2CL1ID.ChainID(), l2CL2ID.ChainID(), "must be same l2 chain") + + ctx := orch.P().Ctx() + logger := orch.P().Logger() + + p := getP2PClientsAndPeers(ctx, logger, require, l2CL1, l2CL2) + + connectPeer := func(p2pClient *sources.P2PClient, multiAddress string) { + err := retry.Do0(ctx, 6, retry.Exponential(), func() error { + return p2pClient.ConnectPeer(ctx, multiAddress) + }) + require.NoError(err, "failed to connect peer") + } + + connectPeer(p.client1, p.peerInfo2.Addresses[0]) + connectPeer(p.client2, p.peerInfo1.Addresses[0]) + + check := func(peerDump *apis.PeerDump, peerInfo *apis.PeerInfo) { + multiAddress := peerInfo.PeerID.String() + _, ok := peerDump.Peers[multiAddress] + require.True(ok, "peer register invalid") + } + + peerDump1, err := GetPeers(ctx, p.client1) + require.NoError(err) + peerDump2, err := GetPeers(ctx, p.client2) + require.NoError(err) + + check(peerDump1, p.peerInfo2) + check(peerDump2, p.peerInfo1) + }) +} diff --git a/op-devstack/sysgo/l2_el.go b/op-devstack/sysgo/l2_el.go index aedc0e3b43f..898c1506aec 100644 --- a/op-devstack/sysgo/l2_el.go +++ b/op-devstack/sysgo/l2_el.go @@ -1,220 +1,75 @@ package sysgo import ( - "context" - "net" - "net/url" - "slices" - "sync" - "time" + "os" "github.com/ethereum-optimism/optimism/op-devstack/devtest" - "github.com/ethereum-optimism/optimism/op-devstack/shim" "github.com/ethereum-optimism/optimism/op-devstack/stack" - "github.com/ethereum-optimism/optimism/op-devstack/stack/match" - "github.com/ethereum-optimism/optimism/op-e2e/e2eutils/geth" - "github.com/ethereum-optimism/optimism/op-e2e/e2eutils/wait" - "github.com/ethereum-optimism/optimism/op-service/client" - "github.com/ethereum-optimism/optimism/op-service/dial" - "github.com/ethereum-optimism/optimism/op-service/testreq" - "github.com/ethereum-optimism/optimism/op-service/testutils/tcpproxy" - "github.com/ethereum/go-ethereum/eth/ethconfig" - "github.com/ethereum/go-ethereum/log" - gn "github.com/ethereum/go-ethereum/node" - "github.com/ethereum/go-ethereum/p2p" ) -type L2ELNode struct { - mu sync.Mutex - - p devtest.P - logger log.Logger - id stack.L2ELNodeID - l2Net *L2Network - jwtPath string - supervisorRPC string - l2Geth *geth.GethInstance - - authRPC string - userRPC string - - authProxy *tcpproxy.Proxy - userProxy *tcpproxy.Proxy +type L2ELNode interface { + hydrate(system stack.ExtensibleSystem) + stack.Lifecycle + UserRPC() string + EngineRPC() string + JWTPath() string } -func (n *L2ELNode) hydrate(system stack.ExtensibleSystem) { - require := system.T().Require() - rpcCl, err := client.NewRPC(system.T().Ctx(), system.Logger(), n.userRPC, client.WithLazyDial()) - require.NoError(err) - system.T().Cleanup(rpcCl.Close) - - l2Net := system.L2Network(stack.L2NetworkID(n.id.ChainID())) - sysL2EL := shim.NewL2ELNode(shim.L2ELNodeConfig{ - RollupCfg: l2Net.RollupConfig(), - ELNodeConfig: shim.ELNodeConfig{ - CommonConfig: shim.NewCommonConfig(system.T()), - Client: rpcCl, - ChainID: n.id.ChainID(), - }, - ID: n.id, - }) - sysL2EL.SetLabel(match.LabelVendor, string(match.OpGeth)) - l2Net.(stack.ExtensibleL2Network).AddL2ELNode(sysL2EL) +type L2ELConfig struct { + SupervisorID *stack.SupervisorID } -func (n *L2ELNode) Start() { - n.mu.Lock() - defer n.mu.Unlock() - if n.l2Geth != nil { - n.logger.Warn("op-geth already started") - return - } - - if n.authProxy == nil { - n.authProxy = tcpproxy.New(n.logger.New("proxy", "l2el-auth")) - n.p.Require().NoError(n.authProxy.Start()) - n.p.Cleanup(func() { - n.authProxy.Close() - }) - n.authRPC = "ws://" + n.authProxy.Addr() - } - if n.userProxy == nil { - n.userProxy = tcpproxy.New(n.logger.New("proxy", "l2el-user")) - n.p.Require().NoError(n.userProxy.Start()) - n.p.Cleanup(func() { - n.userProxy.Close() - }) - n.userRPC = "ws://" + n.userProxy.Addr() - } - - require := n.p.Require() - l2Geth, err := geth.InitL2(n.id.String(), n.l2Net.genesis, n.jwtPath, - func(ethCfg *ethconfig.Config, nodeCfg *gn.Config) error { - ethCfg.InteropMessageRPC = n.supervisorRPC - ethCfg.InteropMempoolFiltering = true - nodeCfg.P2P = p2p.Config{ - NoDiscovery: true, - ListenAddr: "127.0.0.1:0", - MaxPeers: 10, - } - return nil - }) - require.NoError(err) - require.NoError(l2Geth.Node.Start()) - n.l2Geth = l2Geth - n.authProxy.SetUpstream(ProxyAddr(require, l2Geth.AuthRPC().RPC())) - n.userProxy.SetUpstream(ProxyAddr(require, l2Geth.UserRPC().RPC())) +func L2ELWithSupervisor(supervisorID stack.SupervisorID) L2ELOption { + return L2ELOptionFn(func(p devtest.P, id stack.L2ELNodeID, cfg *L2ELConfig) { + cfg.SupervisorID = &supervisorID + }) } -func (n *L2ELNode) Stop() { - n.mu.Lock() - defer n.mu.Unlock() - if n.l2Geth == nil { - n.logger.Warn("op-geth already stopped") - return +func DefaultL2ELConfig() *L2ELConfig { + return &L2ELConfig{ + SupervisorID: nil, } - n.logger.Info("Closing op-geth", "id", n.id) - closeErr := n.l2Geth.Close() - n.logger.Info("Closed op-geth", "id", n.id, "err", closeErr) - n.l2Geth = nil } -func ProxyAddr(require *testreq.Assertions, urlStr string) string { - u, err := url.Parse(urlStr) - require.NoError(err) - return net.JoinHostPort(u.Hostname(), u.Port()) +type L2ELOption interface { + Apply(p devtest.P, id stack.L2ELNodeID, cfg *L2ELConfig) } -func WithL2ELNode(id stack.L2ELNodeID, supervisorID *stack.SupervisorID) stack.Option[*Orchestrator] { - return stack.AfterDeploy(func(orch *Orchestrator) { - p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), id)) - - require := p.Require() - - l2Net, ok := orch.l2Nets.Get(id.ChainID()) - require.True(ok, "L2 network required") - - jwtPath, _ := orch.writeDefaultJWT() - - useInterop := l2Net.genesis.Config.InteropTime != nil - - supervisorRPC := "" - if useInterop { - require.NotNil(supervisorID, "supervisor is required for interop") - sup, ok := orch.supervisors.Get(*supervisorID) - require.True(ok, "supervisor is required for interop") - supervisorRPC = sup.userRPC - } - - logger := p.Logger() - - l2EL := &L2ELNode{ - id: id, - p: orch.P(), - logger: logger, - l2Net: l2Net, - jwtPath: jwtPath, - supervisorRPC: supervisorRPC, - } - l2EL.Start() - p.Cleanup(func() { - l2EL.Stop() - }) - require.True(orch.l2ELs.SetIfMissing(id, l2EL), "must be unique L2 EL node") +// WithGlobalL2ELOption applies the L2ELOption to all L2ELNode instances in this orchestrator +func WithGlobalL2ELOption(opt L2ELOption) stack.Option[*Orchestrator] { + return stack.BeforeDeploy(func(o *Orchestrator) { + o.l2ELOptions = append(o.l2ELOptions, opt) }) } -func WithL2ELP2PConnection(l2EL1ID, l2EL2ID stack.L2ELNodeID) stack.Option[*Orchestrator] { - return stack.AfterDeploy(func(orch *Orchestrator) { - require := orch.P().Require() - - l2EL1, ok := orch.l2ELs.Get(l2EL1ID) - require.True(ok, "looking for L2 EL node 1 to connect p2p") - l2EL2, ok := orch.l2ELs.Get(l2EL2ID) - require.True(ok, "looking for L2 EL node 2 to connect p2p") - require.Equal(l2EL1.l2Net.rollupCfg.L2ChainID, l2EL2.l2Net.rollupCfg.L2ChainID, "must be same l2 chain") - - ctx := orch.P().Ctx() - logger := orch.P().Logger() +type L2ELOptionFn func(p devtest.P, id stack.L2ELNodeID, cfg *L2ELConfig) - rpc1, err := dial.DialRPCClientWithTimeout(ctx, logger, l2EL1.userRPC) - require.NoError(err, "failed to connect to el1 rpc") - defer rpc1.Close() - rpc2, err := dial.DialRPCClientWithTimeout(ctx, logger, l2EL2.userRPC) - require.NoError(err, "failed to connect to el2 rpc") - defer rpc2.Close() +var _ L2ELOption = L2ELOptionFn(nil) - ConnectP2P(orch.P().Ctx(), require, rpc1, rpc2) - }) -} - -type RpcCaller interface { - CallContext(ctx context.Context, result interface{}, method string, args ...interface{}) error +func (fn L2ELOptionFn) Apply(p devtest.P, id stack.L2ELNodeID, cfg *L2ELConfig) { + fn(p, id, cfg) } -// ConnectP2P creates a p2p peer connection between node1 and node2. -func ConnectP2P(ctx context.Context, require *testreq.Assertions, initiator RpcCaller, acceptor RpcCaller) { - var targetInfo p2p.NodeInfo - require.NoError(acceptor.CallContext(ctx, &targetInfo, "admin_nodeInfo"), "get node info") +// L2ELOptionBundle a list of multiple L2ELOption, to all be applied in order. +type L2ELOptionBundle []L2ELOption - var peerAdded bool - require.NoError(initiator.CallContext(ctx, &peerAdded, "admin_addPeer", targetInfo.Enode), "add peer") - require.True(peerAdded, "should have added peer successfully") +var _ L2ELOption = L2ELOptionBundle(nil) - ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second) - defer cancel() - err := wait.For(ctx, time.Second, func() (bool, error) { - var peers []peer - if err := initiator.CallContext(ctx, &peers, "admin_peers"); err != nil { - return false, err - } - return slices.ContainsFunc(peers, func(p peer) bool { - return p.ID == targetInfo.ID - }), nil - }) - require.NoError(err, "The peer was not connected") +func (l L2ELOptionBundle) Apply(p devtest.P, id stack.L2ELNodeID, cfg *L2ELConfig) { + for _, opt := range l { + p.Require().NotNil(opt, "cannot Apply nil L2ELOption") + opt.Apply(p, id, cfg) + } } -type peer struct { - ID string `json:"id"` +// WithL2ELNode adds the default type of L2 CL node. +// The default can be configured with DEVSTACK_L2EL_KIND. +// Tests that depend on specific types can use options like WithKonaNode and WithOpNode directly. +func WithL2ELNode(id stack.L2ELNodeID, opts ...L2ELOption) stack.Option[*Orchestrator] { + switch os.Getenv("DEVSTACK_L2EL_KIND") { + case "op-reth": + return WithOpReth(id, opts...) + default: + return WithOpGeth(id, opts...) + } } diff --git a/op-devstack/sysgo/l2_el_opgeth.go b/op-devstack/sysgo/l2_el_opgeth.go new file mode 100644 index 00000000000..af233b72d36 --- /dev/null +++ b/op-devstack/sysgo/l2_el_opgeth.go @@ -0,0 +1,169 @@ +package sysgo + +import ( + "sync" + + "github.com/ethereum/go-ethereum/eth/ethconfig" + "github.com/ethereum/go-ethereum/log" + gn "github.com/ethereum/go-ethereum/node" + "github.com/ethereum/go-ethereum/p2p" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/shim" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-devstack/stack/match" + "github.com/ethereum-optimism/optimism/op-e2e/e2eutils/geth" + "github.com/ethereum-optimism/optimism/op-service/client" + "github.com/ethereum-optimism/optimism/op-service/testutils/tcpproxy" +) + +type OpGeth struct { + mu sync.Mutex + + p devtest.P + logger log.Logger + id stack.L2ELNodeID + l2Net *L2Network + jwtPath string + supervisorRPC string + l2Geth *geth.GethInstance + + authRPC string + userRPC string + + authProxy *tcpproxy.Proxy + userProxy *tcpproxy.Proxy +} + +var _ L2ELNode = (*OpGeth)(nil) + +func (n *OpGeth) UserRPC() string { + return n.userRPC +} + +func (n *OpGeth) EngineRPC() string { + return n.authRPC +} + +func (n *OpGeth) JWTPath() string { + return n.jwtPath +} + +func (n *OpGeth) hydrate(system stack.ExtensibleSystem) { + require := system.T().Require() + rpcCl, err := client.NewRPC(system.T().Ctx(), system.Logger(), n.userRPC, client.WithLazyDial()) + require.NoError(err) + system.T().Cleanup(rpcCl.Close) + + l2Net := system.L2Network(stack.L2NetworkID(n.id.ChainID())) + sysL2EL := shim.NewL2ELNode(shim.L2ELNodeConfig{ + RollupCfg: l2Net.RollupConfig(), + ELNodeConfig: shim.ELNodeConfig{ + CommonConfig: shim.NewCommonConfig(system.T()), + Client: rpcCl, + ChainID: n.id.ChainID(), + }, + ID: n.id, + }) + sysL2EL.SetLabel(match.LabelVendor, string(match.OpGeth)) + l2Net.(stack.ExtensibleL2Network).AddL2ELNode(sysL2EL) +} + +func (n *OpGeth) Start() { + n.mu.Lock() + defer n.mu.Unlock() + if n.l2Geth != nil { + n.logger.Warn("op-geth already started") + return + } + + if n.authProxy == nil { + n.authProxy = tcpproxy.New(n.logger.New("proxy", "l2el-auth")) + n.p.Require().NoError(n.authProxy.Start()) + n.p.Cleanup(func() { + n.authProxy.Close() + }) + n.authRPC = "ws://" + n.authProxy.Addr() + } + if n.userProxy == nil { + n.userProxy = tcpproxy.New(n.logger.New("proxy", "l2el-user")) + n.p.Require().NoError(n.userProxy.Start()) + n.p.Cleanup(func() { + n.userProxy.Close() + }) + n.userRPC = "ws://" + n.userProxy.Addr() + } + + require := n.p.Require() + l2Geth, err := geth.InitL2(n.id.String(), n.l2Net.genesis, n.jwtPath, + func(ethCfg *ethconfig.Config, nodeCfg *gn.Config) error { + ethCfg.InteropMessageRPC = n.supervisorRPC + ethCfg.InteropMempoolFiltering = true + nodeCfg.P2P = p2p.Config{ + NoDiscovery: true, + ListenAddr: "127.0.0.1:0", + MaxPeers: 10, + } + return nil + }) + require.NoError(err) + require.NoError(l2Geth.Node.Start()) + n.l2Geth = l2Geth + n.authProxy.SetUpstream(ProxyAddr(require, l2Geth.AuthRPC().RPC())) + n.userProxy.SetUpstream(ProxyAddr(require, l2Geth.UserRPC().RPC())) +} + +func (n *OpGeth) Stop() { + n.mu.Lock() + defer n.mu.Unlock() + if n.l2Geth == nil { + n.logger.Warn("op-geth already stopped") + return + } + n.logger.Info("Closing op-geth", "id", n.id) + closeErr := n.l2Geth.Close() + n.logger.Info("Closed op-geth", "id", n.id, "err", closeErr) + n.l2Geth = nil +} + +func WithOpGeth(id stack.L2ELNodeID, opts ...L2ELOption) stack.Option[*Orchestrator] { + return stack.AfterDeploy(func(orch *Orchestrator) { + p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), id)) + require := p.Require() + + l2Net, ok := orch.l2Nets.Get(id.ChainID()) + require.True(ok, "L2 network required") + + cfg := DefaultL2ELConfig() + orch.l2ELOptions.Apply(p, id, cfg) // apply global options + L2ELOptionBundle(opts).Apply(p, id, cfg) // apply specific options + + jwtPath, _ := orch.writeDefaultJWT() + + useInterop := l2Net.genesis.Config.InteropTime != nil + + supervisorRPC := "" + if useInterop { + require.NotNil(cfg.SupervisorID, "supervisor is required for interop") + sup, ok := orch.supervisors.Get(*cfg.SupervisorID) + require.True(ok, "supervisor is required for interop") + supervisorRPC = sup.UserRPC() + } + + logger := p.Logger() + + l2EL := &OpGeth{ + id: id, + p: orch.P(), + logger: logger, + l2Net: l2Net, + jwtPath: jwtPath, + supervisorRPC: supervisorRPC, + } + l2EL.Start() + p.Cleanup(func() { + l2EL.Stop() + }) + require.True(orch.l2ELs.SetIfMissing(id, l2EL), "must be unique L2 EL node") + }) +} diff --git a/op-devstack/sysgo/l2_el_opreth.go b/op-devstack/sysgo/l2_el_opreth.go new file mode 100644 index 00000000000..45a221bb9d7 --- /dev/null +++ b/op-devstack/sysgo/l2_el_opreth.go @@ -0,0 +1,251 @@ +package sysgo + +import ( + "encoding/json" + "os" + "path/filepath" + "sync" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/shim" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-devstack/stack/match" + "github.com/ethereum-optimism/optimism/op-service/client" + "github.com/ethereum-optimism/optimism/op-service/logpipe" + "github.com/ethereum-optimism/optimism/op-service/tasks" + "github.com/ethereum-optimism/optimism/op-service/testutils/tcpproxy" +) + +type OpReth struct { + mu sync.Mutex + + id stack.L2ELNodeID + l2Net *L2Network + jwtPath string + authRPC string + userRPC string + + authProxy *tcpproxy.Proxy + userProxy *tcpproxy.Proxy + + execPath string + args []string + // Each entry is of the form "key=value". + env []string + + p devtest.P + + sub *SubProcess +} + +var _ L2ELNode = (*OpReth)(nil) + +func (n *OpReth) hydrate(system stack.ExtensibleSystem) { + require := system.T().Require() + rpcCl, err := client.NewRPC(system.T().Ctx(), system.Logger(), n.userRPC, client.WithLazyDial()) + require.NoError(err) + system.T().Cleanup(rpcCl.Close) + + l2Net := system.L2Network(stack.L2NetworkID(n.id.ChainID())) + sysL2EL := shim.NewL2ELNode(shim.L2ELNodeConfig{ + RollupCfg: l2Net.RollupConfig(), + ELNodeConfig: shim.ELNodeConfig{ + CommonConfig: shim.NewCommonConfig(system.T()), + Client: rpcCl, + ChainID: n.id.ChainID(), + }, + ID: n.id, + }) + sysL2EL.SetLabel(match.LabelVendor, string(match.OpReth)) + l2Net.(stack.ExtensibleL2Network).AddL2ELNode(sysL2EL) +} + +func (n *OpReth) Start() { + n.mu.Lock() + defer n.mu.Unlock() + if n.sub != nil { + n.p.Logger().Warn("op-reth already started") + return + } + if n.authProxy == nil { + n.authProxy = tcpproxy.New(n.p.Logger()) + n.p.Require().NoError(n.authProxy.Start()) + n.p.Cleanup(func() { + n.authProxy.Close() + }) + n.authRPC = "ws://" + n.authProxy.Addr() + } + if n.userProxy == nil { + n.userProxy = tcpproxy.New(n.p.Logger()) + n.p.Require().NoError(n.userProxy.Start()) + n.p.Cleanup(func() { + n.userProxy.Close() + }) + n.userRPC = "ws://" + n.userProxy.Addr() + } + logOut := logpipe.ToLogger(n.p.Logger().New("src", "stdout")) + logErr := logpipe.ToLogger(n.p.Logger().New("src", "stderr")) + userRPC := make(chan string, 1) + authRPC := make(chan string, 1) + onLogEntry := func(e logpipe.LogEntry) { + switch e.LogMessage() { + case "RPC WS server started": + select { + case userRPC <- "ws://" + e.FieldValue("url").(string): + default: + } + case "RPC auth server started": + select { + case authRPC <- "ws://" + e.FieldValue("url").(string): + default: + } + } + } + stdOutLogs := logpipe.LogProcessor(func(line []byte) { + e := logpipe.ParseRustStructuredLogs(line) + logOut(e) + onLogEntry(e) + }) + stdErrLogs := logpipe.LogProcessor(func(line []byte) { + e := logpipe.ParseRustStructuredLogs(line) + logErr(e) + }) + n.sub = NewSubProcess(n.p, stdOutLogs, stdErrLogs) + + err := n.sub.Start(n.execPath, n.args, n.env) + n.p.Require().NoError(err, "Must start") + + var userRPCAddr, authRPCAddr string + n.p.Require().NoError(tasks.Await(n.p.Ctx(), userRPC, &userRPCAddr), "need user RPC") + n.p.Require().NoError(tasks.Await(n.p.Ctx(), authRPC, &authRPCAddr), "need auth RPC") + + n.userProxy.SetUpstream(ProxyAddr(n.p.Require(), userRPCAddr)) + n.authProxy.SetUpstream(ProxyAddr(n.p.Require(), authRPCAddr)) +} + +// Stop stops the op-reth node. +// warning: no restarts supported yet, since the RPC port is not remembered. +func (n *OpReth) Stop() { + n.mu.Lock() + defer n.mu.Unlock() + err := n.sub.Stop() + n.p.Require().NoError(err, "Must stop") + n.sub = nil +} + +func (n *OpReth) UserRPC() string { + return n.userRPC +} + +func (n *OpReth) EngineRPC() string { + return n.authRPC +} + +func (n *OpReth) JWTPath() string { + return n.jwtPath +} + +func WithOpReth(id stack.L2ELNodeID, opts ...L2ELOption) stack.Option[*Orchestrator] { + return stack.AfterDeploy(func(orch *Orchestrator) { + p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), id)) + require := p.Require() + + l2Net, ok := orch.l2Nets.Get(id.ChainID()) + require.True(ok, "L2 network required") + + cfg := DefaultL2ELConfig() + orch.l2ELOptions.Apply(p, id, cfg) // apply global options + L2ELOptionBundle(opts).Apply(p, id, cfg) // apply specific options + + jwtPath, _ := orch.writeDefaultJWT() + + useInterop := l2Net.genesis.Config.InteropTime != nil + + supervisorRPC := "" + if useInterop { + require.NotNil(cfg.SupervisorID, "supervisor is required for interop") + sup, ok := orch.supervisors.Get(*cfg.SupervisorID) + require.True(ok, "supervisor is required for interop") + supervisorRPC = sup.UserRPC() + } + + tempDir := p.TempDir() + data, err := json.Marshal(l2Net.genesis) + p.Require().NoError(err, "must json-encode genesis") + chainConfigPath := filepath.Join(tempDir, "genesis.json") + p.Require().NoError(os.WriteFile(chainConfigPath, data, 0o644), "must write genesis file") + + dataDirPath := filepath.Join(tempDir, "data") + p.Require().NoError(os.MkdirAll(dataDirPath, 0o755), "must create datadir") + + // reth writes logs not just to stdout, but also to file, + // and to global user-cache by default, rather than the datadir. + // So we customize this to temp-dir too, to not pollute the user-cache dir. + logDirPath := filepath.Join(tempDir, "logs") + p.Require().NoError(os.MkdirAll(dataDirPath, 0o755), "must create logs dir") + + tempP2PPath := filepath.Join(tempDir, "p2pkey.txt") + + execPath := os.Getenv("OP_RETH_EXEC_PATH") + p.Require().NotEmpty(execPath, "OP_RETH_EXEC_PATH environment variable must be set") + _, err = os.Stat(execPath) + p.Require().NotErrorIs(err, os.ErrNotExist, "executable must exist") + + // reth does not support env-var configuration like the Go services, + // so we use the CLI flags instead. + args := []string{ + "node", + "--chain=" + chainConfigPath, + "--with-unused-ports", + "--datadir=" + dataDirPath, + "--log.file.directory=" + logDirPath, + "--disable-nat", + "--disable-dns-discovery", + "--disable-discv4-discovery", + "--p2p-secret-key=" + tempP2PPath, + "--nat=none", + "--addr=127.0.0.1", + "--port=0", + "--http", + "--http.addr=127.0.0.1", + "--http.port=0", + "--http.api=admin,debug,eth,net,trace,txpool,web3,rpc,reth,miner", + "--ws", + "--ws.addr=127.0.0.1", + "--ws.port=0", + "--ws.api=admin,debug,eth,net,trace,txpool,web3,rpc,reth,miner", + "--ipcdisable", + "--authrpc.addr=127.0.0.1", + "--authrpc.port=0", + "--authrpc.jwtsecret=" + jwtPath, + "--txpool.minimum-priority-fee=1", + "--txpool.nolocals", + "--builder.interval=100ms", + "--builder.deadline=2", + "--log.stdout.format=json", + "--color=never", + "-vvvv", + } + if supervisorRPC != "" { + args = append(args, "--rollup.supervisor-http="+supervisorRPC) + } + + l2EL := &OpReth{ + id: id, + l2Net: l2Net, + jwtPath: jwtPath, + authRPC: "", + userRPC: "", + execPath: execPath, + args: args, + env: []string{}, + p: p, + } + + p.Logger().Info("Starting op-reth") + l2EL.Start() + p.Cleanup(l2EL.Stop) + p.Logger().Info("op-reth is ready", "userRPC", l2EL.userRPC, "authRPC", l2EL.authRPC) + require.True(orch.l2ELs.SetIfMissing(id, l2EL), "must be unique L2 EL node") + }) +} diff --git a/op-devstack/sysgo/l2_el_p2p_util.go b/op-devstack/sysgo/l2_el_p2p_util.go new file mode 100644 index 00000000000..fc7adf04f36 --- /dev/null +++ b/op-devstack/sysgo/l2_el_p2p_util.go @@ -0,0 +1,69 @@ +package sysgo + +import ( + "context" + "slices" + "time" + + "github.com/ethereum/go-ethereum/p2p" + + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-e2e/e2eutils/wait" + "github.com/ethereum-optimism/optimism/op-service/dial" + "github.com/ethereum-optimism/optimism/op-service/testreq" +) + +func WithL2ELP2PConnection(l2EL1ID, l2EL2ID stack.L2ELNodeID) stack.Option[*Orchestrator] { + return stack.AfterDeploy(func(orch *Orchestrator) { + require := orch.P().Require() + + l2EL1, ok := orch.l2ELs.Get(l2EL1ID) + require.True(ok, "looking for L2 EL node 1 to connect p2p") + l2EL2, ok := orch.l2ELs.Get(l2EL2ID) + require.True(ok, "looking for L2 EL node 2 to connect p2p") + require.Equal(l2EL1ID.ChainID(), l2EL2ID.ChainID(), "must be same l2 chain") + + ctx := orch.P().Ctx() + logger := orch.P().Logger() + + rpc1, err := dial.DialRPCClientWithTimeout(ctx, logger, l2EL1.UserRPC()) + require.NoError(err, "failed to connect to el1 rpc") + defer rpc1.Close() + rpc2, err := dial.DialRPCClientWithTimeout(ctx, logger, l2EL2.UserRPC()) + require.NoError(err, "failed to connect to el2 rpc") + defer rpc2.Close() + + ConnectP2P(orch.P().Ctx(), require, rpc1, rpc2) + }) +} + +type RpcCaller interface { + CallContext(ctx context.Context, result interface{}, method string, args ...interface{}) error +} + +// ConnectP2P creates a p2p peer connection between node1 and node2. +func ConnectP2P(ctx context.Context, require *testreq.Assertions, initiator RpcCaller, acceptor RpcCaller) { + var targetInfo p2p.NodeInfo + require.NoError(acceptor.CallContext(ctx, &targetInfo, "admin_nodeInfo"), "get node info") + + var peerAdded bool + require.NoError(initiator.CallContext(ctx, &peerAdded, "admin_addPeer", targetInfo.Enode), "add peer") + require.True(peerAdded, "should have added peer successfully") + + ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second) + defer cancel() + err := wait.For(ctx, time.Second, func() (bool, error) { + var peers []peer + if err := initiator.CallContext(ctx, &peers, "admin_peers"); err != nil { + return false, err + } + return slices.ContainsFunc(peers, func(p peer) bool { + return p.ID == targetInfo.ID + }), nil + }) + require.NoError(err, "The peer was not connected") +} + +type peer struct { + ID string `json:"id"` +} diff --git a/op-devstack/sysgo/l2_el_synctester.go b/op-devstack/sysgo/l2_el_synctester.go new file mode 100644 index 00000000000..211ee637118 --- /dev/null +++ b/op-devstack/sysgo/l2_el_synctester.go @@ -0,0 +1,152 @@ +package sysgo + +import ( + "fmt" + "sync" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/shim" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-devstack/stack/match" + "github.com/ethereum-optimism/optimism/op-service/client" + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum-optimism/optimism/op-service/testutils/tcpproxy" +) + +// SyncTesterEL is an L2ELNode implementation that runs a sync tester service. +// It provides RPC endpoints that can be used by CL nodes for testing sync functionality. +type SyncTesterEL struct { + mu sync.Mutex + + id stack.L2ELNodeID + l2Net *L2Network + jwtPath string + + authRPC string + userRPC string + + authProxy *tcpproxy.Proxy + userProxy *tcpproxy.Proxy + + // Sync tester specific fields + fcuState eth.FCUState + p devtest.P + + // Reference to the orchestrator to find the EL node to connect to + orch *Orchestrator +} + +var _ L2ELNode = (*SyncTesterEL)(nil) + +func (n *SyncTesterEL) hydrate(system stack.ExtensibleSystem) { + require := system.T().Require() + rpcCl, err := client.NewRPC(system.T().Ctx(), system.Logger(), n.userRPC, client.WithLazyDial()) + require.NoError(err) + system.T().Cleanup(rpcCl.Close) + + l2Net := system.L2Network(stack.L2NetworkID(n.id.ChainID())) + sysL2EL := shim.NewL2ELNode(shim.L2ELNodeConfig{ + RollupCfg: l2Net.RollupConfig(), + ELNodeConfig: shim.ELNodeConfig{ + CommonConfig: shim.NewCommonConfig(system.T()), + Client: rpcCl, + ChainID: n.id.ChainID(), + }, + ID: n.id, + }) + sysL2EL.SetLabel(match.LabelVendor, "sync-tester") + l2Net.(stack.ExtensibleL2Network).AddL2ELNode(sysL2EL) +} + +func (n *SyncTesterEL) Start() { + n.mu.Lock() + defer n.mu.Unlock() + + // The SyncTesterEL should connect to the existing sync tester service + // Get the endpoint from the orchestrator's syncTester service + if n.orch.syncTester == nil || n.orch.syncTester.service == nil { + n.p.Logger().Error("syncTester service not available in orchestrator") + return + } + + // Use NewEndpoint to get the correct session-specific endpoint for this chain ID + endpoint := n.orch.syncTester.service.SyncTesterRPCPath(n.id.ChainID(), true) + + if n.authProxy == nil { + n.authProxy = tcpproxy.New(n.p.Logger().New("proxy", "l2el-synctester-auth")) + n.p.Require().NoError(n.authProxy.Start()) + n.p.Cleanup(func() { + n.authProxy.Close() + }) + + rpc := "http://" + n.authProxy.Addr() + n.authRPC = fmt.Sprintf("%s%s?latest=%d&safe=%d&finalized=%d", + rpc, endpoint, n.fcuState.Latest, n.fcuState.Safe, n.fcuState.Finalized) + } + if n.userProxy == nil { + n.userProxy = tcpproxy.New(n.p.Logger().New("proxy", "l2el-synctester-user")) + n.p.Require().NoError(n.userProxy.Start()) + n.p.Cleanup(func() { + n.userProxy.Close() + }) + + rpc := "http://" + n.userProxy.Addr() + n.userRPC = fmt.Sprintf("%s%s?latest=%d&safe=%d&finalized=%d", + rpc, endpoint, n.fcuState.Latest, n.fcuState.Safe, n.fcuState.Finalized) + } + + session := fmt.Sprintf("%s%s?latest=%d&safe=%d&finalized=%d", + n.orch.syncTester.service.RPC(), endpoint, n.fcuState.Latest, n.fcuState.Safe, n.fcuState.Finalized) + + n.authProxy.SetUpstream(ProxyAddr(n.p.Require(), session)) + n.userProxy.SetUpstream(ProxyAddr(n.p.Require(), session)) +} + +func (n *SyncTesterEL) Stop() { + // The SyncTesterEL is just a proxy, so there's nothing to stop +} + +func (n *SyncTesterEL) UserRPC() string { + return n.userRPC +} + +func (n *SyncTesterEL) EngineRPC() string { + return n.authRPC +} + +func (n *SyncTesterEL) JWTPath() string { + return n.jwtPath +} + +// WithSyncTesterL2ELNode creates a SyncTesterEL that satisfies the L2ELNode interface +// The sync tester acts as an EL node that can be used by CL nodes for testing sync. +func WithSyncTesterL2ELNode(id, readonlyEL stack.L2ELNodeID, fcuState eth.FCUState, opts ...L2ELOption) stack.Option[*Orchestrator] { + return stack.AfterDeploy(func(orch *Orchestrator) { + p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), id)) + require := p.Require() + + l2Net, ok := orch.l2Nets.Get(readonlyEL.ChainID()) + require.True(ok, "L2 network required") + + cfg := DefaultL2ELConfig() + orch.l2ELOptions.Apply(p, id, cfg) // apply global options + L2ELOptionBundle(opts).Apply(p, id, cfg) // apply specific options + + jwtPath, _ := orch.writeDefaultJWT() + + syncTesterEL := &SyncTesterEL{ + id: id, + l2Net: l2Net, + jwtPath: jwtPath, + fcuState: fcuState, + p: p, + orch: orch, + } + + p.Logger().Info("Starting sync tester EL", "id", id) + syncTesterEL.Start() + p.Cleanup(syncTesterEL.Stop) + p.Logger().Info("sync tester EL is ready", "userRPC", syncTesterEL.userRPC, "authRPC", syncTesterEL.authRPC) + require.True(orch.l2ELs.SetIfMissing(id, syncTesterEL), "must be unique L2 EL node") + }) +} diff --git a/op-devstack/sysgo/l2_network_superchain_registry.go b/op-devstack/sysgo/l2_network_superchain_registry.go new file mode 100644 index 00000000000..f395d2e813d --- /dev/null +++ b/op-devstack/sysgo/l2_network_superchain_registry.go @@ -0,0 +1,86 @@ +package sysgo + +import ( + "fmt" + + "github.com/ethereum/go-ethereum/core" + + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-node/chaincfg" + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum-optimism/optimism/op-service/superutil" + "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/backend/depset" +) + +// WithL2NetworkFromSuperchainRegistry creates an L2 network using the rollup config from the superchain registry +func WithL2NetworkFromSuperchainRegistry(l2NetworkID stack.L2NetworkID, networkName string) stack.Option[*Orchestrator] { + return stack.BeforeDeploy(func(orch *Orchestrator) { + p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), l2NetworkID)) + require := p.Require() + + // Load the rollup config from the superchain registry + rollupCfg, err := chaincfg.GetRollupConfig(networkName) + require.NoError(err, "failed to load rollup config for network %s", networkName) + + // Get the chain config from the superchain registry + chainCfg := chaincfg.ChainByName(networkName) + require.NotNil(chainCfg, "chain config not found for network %s", networkName) + + // Load the chain config using superutil + paramsChainConfig, err := superutil.LoadOPStackChainConfigFromChainID(chainCfg.ChainID) + require.NoError(err, "failed to load chain config for network %s", networkName) + + // Create a genesis config from the chain config + genesis := &core.Genesis{ + Config: paramsChainConfig, + } + + // Create the L2 network + l2Net := &L2Network{ + id: l2NetworkID, + l1ChainID: eth.ChainIDFromBig(rollupCfg.L1ChainID), + genesis: genesis, + rollupCfg: rollupCfg, + keys: orch.keys, + } + + require.True(orch.l2Nets.SetIfMissing(l2NetworkID.ChainID(), l2Net), + fmt.Sprintf("must not already exist: %s", l2NetworkID)) + }) +} + +// WithL2NetworkFromSuperchainRegistryWithDependencySet creates an L2 network using the rollup config from the superchain registry +// and also sets up the dependency set for interop support +func WithL2NetworkFromSuperchainRegistryWithDependencySet(l2NetworkID stack.L2NetworkID, networkName string) stack.Option[*Orchestrator] { + return stack.Combine( + WithL2NetworkFromSuperchainRegistry(l2NetworkID, networkName), + stack.BeforeDeploy(func(orch *Orchestrator) { + p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), l2NetworkID)) + require := p.Require() + + // Load the dependency set from the superchain registry + chainCfg := chaincfg.ChainByName(networkName) + require.NotNil(chainCfg, "chain config not found for network %s", networkName) + + _, err := depset.FromRegistry(eth.ChainIDFromUInt64(chainCfg.ChainID)) + if err != nil { + // If dependency set is not available, that's okay - it's optional + p.Logger().Info("No dependency set available for network", "network", networkName, "err", err) + return + } + + // Create a cluster to hold the dependency set + clusterID := stack.ClusterID(networkName) + + // Create a minimal full config set with just the dependency set + // This is a simplified approach - in a real implementation you might want + // to create a proper FullConfigSetMerged + cluster := &Cluster{ + id: clusterID, + cfgset: depset.FullConfigSetMerged{}, // Empty for now + } + + orch.clusters.Set(clusterID, cluster) + }), + ) +} diff --git a/op-devstack/sysgo/l2_proposer.go b/op-devstack/sysgo/l2_proposer.go index 37089f9b626..f5d436dbbcd 100644 --- a/op-devstack/sysgo/l2_proposer.go +++ b/op-devstack/sysgo/l2_proposer.go @@ -96,7 +96,9 @@ func WithProposerPostDeploy(orch *Orchestrator, proposerID stack.L2ProposerID, l PollInterval: 500 * time.Millisecond, AllowNonFinalized: true, TxMgrConfig: setuputils.NewTxMgrConfig(endpoint.URL(l1EL.userRPC), proposerSecret), - RPCConfig: oprpc.CLIConfig{}, + RPCConfig: oprpc.CLIConfig{ + ListenAddr: "127.0.0.1", + }, LogConfig: oplog.CLIConfig{ Level: log.LvlInfo, Format: oplog.FormatText, @@ -118,12 +120,12 @@ func WithProposerPostDeploy(orch *Orchestrator, proposerID stack.L2ProposerID, l require.NotNil(supervisorID, "need supervisor to connect to in interop") supervisorNode, ok := orch.supervisors.Get(*supervisorID) require.True(ok) - proposerCLIConfig.SupervisorRpcs = []string{supervisorNode.userRPC} + proposerCLIConfig.SupervisorRpcs = []string{supervisorNode.UserRPC()} } else { require.NotNil(l2CLID, "need L2 CL to connect to pre-interop") l2CL, ok := orch.l2CLs.Get(*l2CLID) require.True(ok) - proposerCLIConfig.RollupRpc = l2CL.userRPC + proposerCLIConfig.RollupRpc = l2CL.UserRPC() } proposer, err := ps.ProposerServiceFromCLIConfig(ctx, "0.0.1", proposerCLIConfig, logger) diff --git a/op-devstack/sysgo/orchestrator.go b/op-devstack/sysgo/orchestrator.go index c6f3baa0e41..3d74508054e 100644 --- a/op-devstack/sysgo/orchestrator.go +++ b/op-devstack/sysgo/orchestrator.go @@ -31,7 +31,8 @@ type Orchestrator struct { // options batcherOptions []BatcherOption proposerOptions []ProposerOption - l2CLOptions []L2CLOption + l2CLOptions L2CLOptionBundle + l2ELOptions L2ELOptionBundle deployerPipelineOptions []DeployerPipelineOption superchains locks.RWMap[stack.SuperchainID, *Superchain] @@ -40,9 +41,9 @@ type Orchestrator struct { l2Nets locks.RWMap[eth.ChainID, *L2Network] l1ELs locks.RWMap[stack.L1ELNodeID, *L1ELNode] l1CLs locks.RWMap[stack.L1CLNodeID, *L1CLNode] - l2ELs locks.RWMap[stack.L2ELNodeID, *L2ELNode] - l2CLs locks.RWMap[stack.L2CLNodeID, *L2CLNode] - supervisors locks.RWMap[stack.SupervisorID, *Supervisor] + l2ELs locks.RWMap[stack.L2ELNodeID, L2ELNode] + l2CLs locks.RWMap[stack.L2CLNodeID, L2CLNode] + supervisors locks.RWMap[stack.SupervisorID, Supervisor] testSequencers locks.RWMap[stack.TestSequencerID, *TestSequencer] batchers locks.RWMap[stack.L2BatcherID, *L2Batcher] challengers locks.RWMap[stack.L2ChallengerID, *L2Challenger] @@ -122,17 +123,17 @@ func (o *Orchestrator) Hydrate(sys stack.ExtensibleSystem) { o.l2Nets.Range(rangeHydrateFn[eth.ChainID, *L2Network](sys)) o.l1ELs.Range(rangeHydrateFn[stack.L1ELNodeID, *L1ELNode](sys)) o.l1CLs.Range(rangeHydrateFn[stack.L1CLNodeID, *L1CLNode](sys)) - o.l2ELs.Range(rangeHydrateFn[stack.L2ELNodeID, *L2ELNode](sys)) - o.l2CLs.Range(rangeHydrateFn[stack.L2CLNodeID, *L2CLNode](sys)) - o.supervisors.Range(rangeHydrateFn[stack.SupervisorID, *Supervisor](sys)) + o.l2ELs.Range(rangeHydrateFn[stack.L2ELNodeID, L2ELNode](sys)) + o.l2CLs.Range(rangeHydrateFn[stack.L2CLNodeID, L2CLNode](sys)) + o.supervisors.Range(rangeHydrateFn[stack.SupervisorID, Supervisor](sys)) o.testSequencers.Range(rangeHydrateFn[stack.TestSequencerID, *TestSequencer](sys)) o.batchers.Range(rangeHydrateFn[stack.L2BatcherID, *L2Batcher](sys)) o.challengers.Range(rangeHydrateFn[stack.L2ChallengerID, *L2Challenger](sys)) o.proposers.Range(rangeHydrateFn[stack.L2ProposerID, *L2Proposer](sys)) - o.faucet.hydrate(sys) if o.syncTester != nil { o.syncTester.hydrate(sys) } + o.faucet.hydrate(sys) o.sysHook.PostHydrate(sys) } diff --git a/op-devstack/sysgo/proxy.go b/op-devstack/sysgo/proxy.go new file mode 100644 index 00000000000..3e932f220a8 --- /dev/null +++ b/op-devstack/sysgo/proxy.go @@ -0,0 +1,14 @@ +package sysgo + +import ( + "net" + "net/url" + + "github.com/ethereum-optimism/optimism/op-service/testreq" +) + +func ProxyAddr(require *testreq.Assertions, urlStr string) string { + u, err := url.Parse(urlStr) + require.NoError(err) + return net.JoinHostPort(u.Hostname(), u.Port()) +} diff --git a/op-devstack/sysgo/subproc.go b/op-devstack/sysgo/subproc.go new file mode 100644 index 00000000000..799357a0497 --- /dev/null +++ b/op-devstack/sysgo/subproc.go @@ -0,0 +1,163 @@ +package sysgo + +import ( + "context" + "fmt" + "os" + "os/exec" + "sync" + "time" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-service/logpipe" +) + +// SubProcess is a process that can be started, and stopped, and restarted. +// +// If at any point the process fails to start or exit successfully, +// the failure is reported to the devtest.P. +// +// If the sub-process exits by itself, the exit is detected, +// and if not successful (non-zero exit code on unix) it also reports failure to the devtest.P. +// +// Sub-process logs are assumed to be structured JSON logs, and are piped to the logger. +type SubProcess struct { + p devtest.P + cmd *exec.Cmd + + stdOutLogs logpipe.LogProcessor + stdErrLogs logpipe.LogProcessor + + waitCtx context.Context // closed when process-Wait completes + + mu sync.Mutex +} + +func NewSubProcess(p devtest.P, stdOutLogs, stdErrLogs logpipe.LogProcessor) *SubProcess { + return &SubProcess{ + p: p, + stdOutLogs: stdOutLogs, + stdErrLogs: stdErrLogs, + } +} + +func (sp *SubProcess) Start(cmdPath string, args []string, env []string) error { + sp.mu.Lock() + defer sp.mu.Unlock() + if sp.cmd != nil { + return fmt.Errorf("process is still running (PID: %d)", sp.cmd.Process.Pid) + } + cmd := exec.Command(cmdPath, args...) + cmd.Env = append(os.Environ(), env...) + stdout, err := cmd.StdoutPipe() + sp.p.Require().NoError(err, "stdout err") + stderr, err := cmd.StderrPipe() + sp.p.Require().NoError(err, "stderr err") + go func() { + err := logpipe.PipeLogs(stdout, sp.stdOutLogs) + sp.p.Require().NoError(err, "stdout logging error") + }() + go func() { + err := logpipe.PipeLogs(stderr, sp.stdErrLogs) + sp.p.Require().NoError(err, "stderr logging error") + }() + if err := cmd.Start(); err != nil { + return err + } + sp.cmd = cmd + + subCtx, subCancel := context.WithCancelCause(context.Background()) + go func() { + state, err := cmd.Process.Wait() + subCancel(err) + sp.p.Require().NoError(err, "Sub-process failed to be closed") + sp.p.Logger().Info("Sub-process stopped", "exitCode", state.ExitCode(), "pid", state.Pid()) + // if it exited on its own, then we care about the error. If not, we (or the user) signaled it. + if state.Exited() { + sp.p.Require().True(state.Success(), "Sub-process closed with error status: %s", state.String()) + } + }() + sp.waitCtx = subCtx + + sp.p.Cleanup(func() { + err := sp.Stop() + if err != nil { + sp.p.Logger().Error("Shutdown error", "err", err) + } + }) + return nil +} + +// Kill stops the process, and does not wait for it to complete. +func (sp *SubProcess) Kill() error { + ctx, cancel := context.WithCancel(context.Background()) + cancel() // don't wait, just force it to stop immediately + return sp.GracefulStop(ctx) +} + +// Stop implements the default control-panel interface, +// and gracefully stops with a 10-second timeout. +func (sp *SubProcess) Stop() error { + // by default, for control-panel, use an interrupt and a 10-second grace + ctx, cancel := context.WithTimeout(context.Background(), time.Second*10) + defer cancel() + return sp.GracefulStop(ctx) +} + +// GracefulStop sends an interrupt and waits for the process to stop. +// If the given ctx is closed, a forced shutdown (process kill) is pursued. +func (sp *SubProcess) GracefulStop(ctx context.Context) error { + sp.mu.Lock() + defer sp.mu.Unlock() + if sp.cmd == nil { + return nil // already stopped gracefully + } + + if ctx.Err() == nil && sp.waitCtx.Err() == nil { + // if not force-closing, and not already done, then try an interrupt first. + sp.p.Logger().Info("Sending interrupt") + if err := sp.cmd.Process.Signal(os.Interrupt); err != nil { + return err + } + } + select { + case <-ctx.Done(): + sp.p.Logger().Warn("Sub-process did not respond to interrupt, force-closing now") + err := sp.cmd.Process.Kill() + if err != nil { + return fmt.Errorf("failed to force-close sub-process: %w", err) + } + sp.p.Logger().Info("Successfully force-closed sub-process") + // resources of cmd.Process will be cleaned up by the Process.Wait + case <-sp.waitCtx.Done(): + if err := context.Cause(sp.waitCtx); err != nil && err != context.Canceled { + sp.p.Logger().Warn("Sub-process exited with error", "err", err) + } else { + sp.p.Logger().Info("Sub-process gracefully exited") + } + } + sp.cmd = nil + sp.waitCtx = nil + return nil +} + +// Wait waits for the process to complete. +func (sp *SubProcess) Wait(ctx context.Context) error { + sp.mu.Lock() + defer sp.mu.Unlock() + if sp.waitCtx == nil { + return nil + } + select { + case <-ctx.Done(): + return ctx.Err() + case <-sp.waitCtx.Done(): + if err := context.Cause(sp.waitCtx); err != nil && err != context.Canceled { + sp.p.Logger().Warn("Sub-process exited with error", "err", err) + return err + } else { + sp.p.Logger().Info("Sub-process gracefully exited") + return nil + } + } +} diff --git a/op-devstack/sysgo/subproc_test.go b/op-devstack/sysgo/subproc_test.go new file mode 100644 index 00000000000..59ab24133aa --- /dev/null +++ b/op-devstack/sysgo/subproc_test.go @@ -0,0 +1,77 @@ +package sysgo + +import ( + "context" + "testing" + + "github.com/stretchr/testify/require" + + "github.com/ethereum/go-ethereum/log" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-service/logpipe" + "github.com/ethereum-optimism/optimism/op-service/testlog" +) + +func TestSubProcess(gt *testing.T) { + tLog := testlog.Logger(gt, log.LevelInfo) + logger, capt := testlog.CaptureLogger(gt, log.LevelInfo) + + onFailNow := func(v bool) { + panic("fail") + } + onSkipNow := func() { + panic("skip") + } + p := devtest.NewP(context.Background(), logger, onFailNow, onSkipNow) + gt.Cleanup(p.Close) + + logProc := logpipe.LogProcessor(func(line []byte) { + logger.Info(string(line)) + tLog.Info("Sub-process logged message", "line", string(line)) + }) + sp := NewSubProcess(p, logProc, logProc) + + gt.Log("Running first sub-process") + testSleep(gt, capt, sp) + gt.Log("Restarting, second run") + capt.Clear() + testSleep(gt, capt, sp) + gt.Log("Trying a different command now") + capt.Clear() + testEcho(gt, capt, sp) + gt.Log("Second run of different command") + capt.Clear() + testEcho(gt, capt, sp) +} + +// testEcho tests that we can handle a sub-process that completes on its own +func testEcho(gt *testing.T, capt *testlog.CapturingHandler, sp *SubProcess) { + require.NoError(gt, sp.Start("/bin/echo", []string{"hello world"}, []string{})) + gt.Log("Started sub-process") + require.NoError(gt, sp.Wait(context.Background()), "echo must complete") + require.NoError(gt, sp.Stop()) + gt.Log("Stopped sub-process") + + require.NotNil(gt, capt.FindLog( + testlog.NewMessageFilter("hello world"))) + + require.NotNil(gt, capt.FindLog( + testlog.NewMessageFilter("Sub-process gracefully exited"))) +} + +// testSleep tests that we can force shut down a sub-process that is stuck +func testSleep(gt *testing.T, capt *testlog.CapturingHandler, sp *SubProcess) { + // Sleep for very, very, long + require.NoError(gt, sp.Start("/bin/sleep", []string{"10000000000"}, []string{})) + gt.Log("Started sub-process") + // Shut down the process before the sleep completes + require.NoError(gt, sp.Kill()) + gt.Log("Killed sub-process") + + require.NotNil(gt, capt.FindLog( + testlog.NewMessageFilter("Sub-process did not respond to interrupt, force-closing now"))) + + require.NotNil(gt, capt.FindLog( + testlog.NewMessageFilter("Successfully force-closed sub-process"))) +} diff --git a/op-devstack/sysgo/superroot.go b/op-devstack/sysgo/superroot.go index ab1cdc99515..d3627f75591 100644 --- a/op-devstack/sysgo/superroot.go +++ b/op-devstack/sysgo/superroot.go @@ -46,7 +46,7 @@ func WithSuperRoots(l1ChainID eth.ChainID, l1ELID stack.L1ELNodeID, l2CLID stack l2CL, ok := o.l2CLs.Get(l2CLID) require.True(ok, "must have L2 CL node") - rollupClientProvider, err := dial.NewStaticL2RollupProvider(t.Ctx(), t.Logger(), l2CL.opNode.UserRPC().RPC()) + rollupClientProvider, err := dial.NewStaticL2RollupProvider(t.Ctx(), t.Logger(), l2CL.UserRPC()) require.NoError(err) rollupClient, err := rollupClientProvider.RollupClient(t.Ctx()) require.NoError(err) @@ -188,8 +188,11 @@ func WithSuperRoots(l1ChainID eth.ChainID, l1ELID stack.L1ELNodeID, l2CLID stack } func deployDelegateCallProxy(t devtest.CommonT, transactOpts *bind.TransactOpts, client *ethclient.Client, owner common.Address) (common.Address, *delegatecallproxy.Delegatecallproxy) { - deployAddress, _, proxyContract, err := delegatecallproxy.DeployDelegatecallproxy(transactOpts, client, owner) + deployAddress, tx, proxyContract, err := delegatecallproxy.DeployDelegatecallproxy(transactOpts, client, owner) t.Require().NoError(err, "DelegateCallProxy deployment failed") + // Make sure the transaction actually got included rather than just being sent + _, err = wait.ForReceiptOK(t.Ctx(), client, tx.Hash()) + t.Require().NoError(err, "DelegateCallProxy deployment tx was not included successfully") return deployAddress, proxyContract } @@ -197,7 +200,7 @@ func getSuperRoot(t devtest.CommonT, o *Orchestrator, timestamp uint64, supervis supervisor, ok := o.supervisors.Get(supervisorID) t.Require().True(ok, "must have supervisor") - client, err := dial.DialSupervisorClientWithTimeout(t.Ctx(), t.Logger(), supervisor.userRPC) + client, err := dial.DialSupervisorClientWithTimeout(t.Ctx(), t.Logger(), supervisor.UserRPC()) t.Require().NoError(err) super, err := client.SuperRootAtTimestamp(t.Ctx(), hexutil.Uint64(timestamp)) t.Require().NoError(err, "super root at timestamp failed") diff --git a/op-devstack/sysgo/supervisor.go b/op-devstack/sysgo/supervisor.go index 39433121295..8f39d8110e5 100644 --- a/op-devstack/sysgo/supervisor.go +++ b/op-devstack/sysgo/supervisor.go @@ -1,158 +1,27 @@ package sysgo import ( - "context" - "sync" + "os" - "github.com/ethereum-optimism/optimism/op-service/testutils/tcpproxy" - - "github.com/ethereum-optimism/optimism/op-devstack/devtest" - "github.com/ethereum/go-ethereum/log" - - "github.com/ethereum-optimism/optimism/op-devstack/shim" "github.com/ethereum-optimism/optimism/op-devstack/stack" "github.com/ethereum-optimism/optimism/op-service/client" "github.com/ethereum-optimism/optimism/op-service/dial" - oplog "github.com/ethereum-optimism/optimism/op-service/log" - "github.com/ethereum-optimism/optimism/op-service/metrics" - "github.com/ethereum-optimism/optimism/op-service/oppprof" "github.com/ethereum-optimism/optimism/op-service/retry" - oprpc "github.com/ethereum-optimism/optimism/op-service/rpc" - supervisorConfig "github.com/ethereum-optimism/optimism/op-supervisor/config" - "github.com/ethereum-optimism/optimism/op-supervisor/supervisor" - "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/backend/syncnode" ) -type Supervisor struct { - mu sync.Mutex - - id stack.SupervisorID - userRPC string - - cfg *supervisorConfig.Config - p devtest.P - logger log.Logger - - service *supervisor.SupervisorService - - proxy *tcpproxy.Proxy -} - -var _ stack.Lifecycle = (*Supervisor)(nil) - -func (s *Supervisor) hydrate(sys stack.ExtensibleSystem) { - tlog := sys.Logger().New("id", s.id) - supClient, err := client.NewRPC(sys.T().Ctx(), tlog, s.userRPC, client.WithLazyDial()) - sys.T().Require().NoError(err) - sys.T().Cleanup(supClient.Close) - - sys.AddSupervisor(shim.NewSupervisor(shim.SupervisorConfig{ - CommonConfig: shim.NewCommonConfig(sys.T()), - ID: s.id, - Client: supClient, - })) -} - -func (s *Supervisor) Start() { - s.mu.Lock() - defer s.mu.Unlock() - if s.service != nil { - s.logger.Warn("Supervisor already started") - return - } - - if s.proxy == nil { - s.proxy = tcpproxy.New(s.logger.New("proxy", "supervisor")) - s.p.Require().NoError(s.proxy.Start()) - s.p.Cleanup(func() { - s.proxy.Close() - }) - s.userRPC = "http://" + s.proxy.Addr() - } - - super, err := supervisor.SupervisorFromConfig(context.Background(), s.cfg, s.logger) - s.p.Require().NoError(err) - - s.service = super - s.logger.Info("Starting supervisor") - err = super.Start(context.Background()) - s.p.Require().NoError(err, "supervisor failed to start") - s.logger.Info("Started supervisor") - s.proxy.SetUpstream(ProxyAddr(s.p.Require(), super.RPC())) -} - -func (s *Supervisor) Stop() { - s.mu.Lock() - defer s.mu.Unlock() - if s.service == nil { - s.logger.Warn("Supervisor already stopped") - return - } - ctx, cancel := context.WithCancel(context.Background()) - cancel() // force-quit - s.logger.Info("Closing supervisor") - closeErr := s.service.Stop(ctx) - s.logger.Info("Closed supervisor", "err", closeErr) - - s.service = nil +type Supervisor interface { + hydrate(system stack.ExtensibleSystem) + stack.Lifecycle + UserRPC() string } func WithSupervisor(supervisorID stack.SupervisorID, clusterID stack.ClusterID, l1ELID stack.L1ELNodeID) stack.Option[*Orchestrator] { - return stack.AfterDeploy(func(orch *Orchestrator) { - p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), supervisorID)) - require := p.Require() - - l1EL, ok := orch.l1ELs.Get(l1ELID) - require.True(ok, "need L1 EL node to connect supervisor to") - - cluster, ok := orch.clusters.Get(clusterID) - require.True(ok, "need cluster to determine dependency set") - - require.NotNil(cluster.cfgset, "need a full config set") - require.NoError(cluster.cfgset.CheckChains(), "config set must be valid") - cfg := &supervisorConfig.Config{ - MetricsConfig: metrics.CLIConfig{ - Enabled: false, - }, - PprofConfig: oppprof.CLIConfig{ - ListenEnabled: false, - }, - LogConfig: oplog.CLIConfig{ // ignored, logger overrides this - Level: log.LevelDebug, - Format: oplog.FormatText, - }, - RPC: oprpc.CLIConfig{ - ListenAddr: "127.0.0.1", - // When supervisor starts, store its RPC port here - // given by the os, to reclaim when restart. - ListenPort: 0, - EnableAdmin: true, - }, - SyncSources: &syncnode.CLISyncNodes{}, // no sync-sources - L1RPC: l1EL.userRPC, - // Note: datadir is created here, - // persistent across stop/start, for the duration of the package execution. - Datadir: orch.p.TempDir(), - Version: "dev", - FullConfigSetSource: cluster.cfgset, - MockRun: false, - SynchronousProcessors: false, - DatadirSyncEndpoint: "", - } - - plog := p.Logger() - supervisorNode := &Supervisor{ - id: supervisorID, - userRPC: "", // set on start - cfg: cfg, - p: p, - logger: plog, - service: nil, // set on start - } - orch.supervisors.Set(supervisorID, supervisorNode) - supervisorNode.Start() - orch.p.Cleanup(supervisorNode.Stop) - }) + switch os.Getenv("DEVSTACK_SUPERVISOR_KIND") { + case "kona": + return WithKonaSupervisor(supervisorID, clusterID, l1ELID) + default: + return WithOPSupervisor(supervisorID, clusterID, l1ELID) + } } func WithManagedBySupervisor(l2CLID stack.L2CLNodeID, supervisorID stack.SupervisorID) stack.Option[*Orchestrator] { @@ -167,7 +36,7 @@ func WithManagedBySupervisor(l2CLID stack.L2CLNodeID, supervisorID stack.Supervi require.True(ok, "looking for supervisor") ctx := orch.P().Ctx() - supClient, err := dial.DialSupervisorClientWithTimeout(ctx, orch.P().Logger(), s.userRPC, client.WithLazyDial()) + supClient, err := dial.DialSupervisorClientWithTimeout(ctx, orch.P().Logger(), s.UserRPC(), client.WithLazyDial()) orch.P().Require().NoError(err) err = retry.Do0(ctx, 10, retry.Exponential(), func() error { diff --git a/op-devstack/sysgo/supervisor_kona.go b/op-devstack/sysgo/supervisor_kona.go new file mode 100644 index 00000000000..2363aca2769 --- /dev/null +++ b/op-devstack/sysgo/supervisor_kona.go @@ -0,0 +1,179 @@ +package sysgo + +import ( + "encoding/json" + "os" + "sync" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum-optimism/optimism/op-devstack/shim" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-service/client" + "github.com/ethereum-optimism/optimism/op-service/logpipe" + "github.com/ethereum-optimism/optimism/op-service/tasks" + "github.com/ethereum-optimism/optimism/op-service/testutils/tcpproxy" +) + +type KonaSupervisor struct { + mu sync.Mutex + + id stack.SupervisorID + userRPC string + + userProxy *tcpproxy.Proxy + + execPath string + args []string + // Each entry is of the form "key=value". + env []string + + p devtest.P + + sub *SubProcess +} + +var _ stack.Lifecycle = (*OpSupervisor)(nil) + +func (s *KonaSupervisor) hydrate(sys stack.ExtensibleSystem) { + tlog := sys.Logger().New("id", s.id) + supClient, err := client.NewRPC(sys.T().Ctx(), tlog, s.userRPC, client.WithLazyDial()) + sys.T().Require().NoError(err) + sys.T().Cleanup(supClient.Close) + + sys.AddSupervisor(shim.NewSupervisor(shim.SupervisorConfig{ + CommonConfig: shim.NewCommonConfig(sys.T()), + ID: s.id, + Client: supClient, + })) +} + +func (s *KonaSupervisor) UserRPC() string { + return s.userRPC +} + +func (s *KonaSupervisor) Start() { + s.mu.Lock() + defer s.mu.Unlock() + if s.sub != nil { + s.p.Logger().Warn("Kona-supervisor already started") + return + } + + // Create a proxy for the user RPC, + // so other services can connect, and stay connected, across restarts. + if s.userProxy == nil { + s.userProxy = tcpproxy.New(s.p.Logger()) + s.p.Require().NoError(s.userProxy.Start()) + s.p.Cleanup(func() { + s.userProxy.Close() + }) + s.userRPC = "http://" + s.userProxy.Addr() + } + + // Create the sub-process. + // We pipe sub-process logs to the test-logger. + // And inspect them along the way, to get the RPC server address. + logOut := logpipe.ToLogger(s.p.Logger().New("src", "stdout")) + logErr := logpipe.ToLogger(s.p.Logger().New("src", "stderr")) + userRPC := make(chan string, 1) + onLogEntry := func(e logpipe.LogEntry) { + switch e.LogMessage() { + case "RPC server bound to address": + userRPC <- "http://" + e.FieldValue("addr").(string) + } + } + stdOutLogs := logpipe.LogProcessor(func(line []byte) { + e := logpipe.ParseRustStructuredLogs(line) + logOut(e) + onLogEntry(e) + }) + stdErrLogs := logpipe.LogProcessor(func(line []byte) { + e := logpipe.ParseRustStructuredLogs(line) + logErr(e) + }) + + s.sub = NewSubProcess(s.p, stdOutLogs, stdErrLogs) + err := s.sub.Start(s.execPath, s.args, s.env) + s.p.Require().NoError(err, "Must start") + + var userRPCAddr string + s.p.Require().NoError(tasks.Await(s.p.Ctx(), userRPC, &userRPCAddr), "need user RPC") + + s.userProxy.SetUpstream(ProxyAddr(s.p.Require(), userRPCAddr)) +} + +func (s *KonaSupervisor) Stop() { + s.mu.Lock() + defer s.mu.Unlock() + if s.sub == nil { + s.p.Logger().Warn("kona-supervisor already stopped") + return + } + err := s.sub.Stop() + s.p.Require().NoError(err, "Must stop") + s.sub = nil +} + +func WithKonaSupervisor(supervisorID stack.SupervisorID, clusterID stack.ClusterID, l1ELID stack.L1ELNodeID) stack.Option[*Orchestrator] { + return stack.AfterDeploy(func(orch *Orchestrator) { + p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), supervisorID)) + require := p.Require() + + l1EL, ok := orch.l1ELs.Get(l1ELID) + require.True(ok, "need L1 EL node to connect supervisor to") + + cluster, ok := orch.clusters.Get(clusterID) + require.True(ok, "need cluster to determine dependency set") + + require.NotNil(cluster.cfgset, "need a full config set") + require.NoError(cluster.cfgset.CheckChains(), "config set must be valid") + + tempDataDir := p.TempDir() + + cfgDir := p.TempDir() + + depsetCfgPath := cfgDir + "/depset.json" + depsetData, err := cluster.DepSet().MarshalJSON() + require.NoError(err, "failed to marshal dependency set") + p.Require().NoError(err, os.WriteFile(depsetCfgPath, depsetData, 0o644)) + + rollupCfgPath := cfgDir + "/rollup-config-*.json" + for _, l2Net := range orch.l2Nets.Values() { + chainID := l2Net.id.ChainID() + rollupData, err := json.Marshal(l2Net.rollupCfg) + require.NoError(err, "failed to marshal rollup config") + p.Require().NoError(err, os.WriteFile(cfgDir+"/rollup-config-"+chainID.String()+".json", rollupData, 0o644)) + } + + envVars := []string{ + "RPC_ADDR=127.0.0.1", + "DATADIR=" + tempDataDir, + "DEPENDENCY_SET=" + depsetCfgPath, + "ROLLUP_CONFIG_PATHS=" + rollupCfgPath, + "L1_RPC=" + l1EL.userRPC, + "RPC_ENABLE_ADMIN=true", + "L2_CONSENSUS_NODES=", + "L2_CONSENSUS_JWT_SECRET=", + "KONA_LOG_STDOUT_FORMAT=json", + } + + execPath := os.Getenv("KONA_SUPERVISOR_EXEC_PATH") + p.Require().NotEmpty(execPath, "KONA_SUPERVISOR_EXEC_PATH environment variable must be set") + _, err = os.Stat(execPath) + p.Require().NotErrorIs(err, os.ErrNotExist, "executable must exist") + + konaSupervisor := &KonaSupervisor{ + id: supervisorID, + userRPC: "", // retrieved from logs + execPath: execPath, + args: []string{}, + env: envVars, + p: p, + } + orch.supervisors.Set(supervisorID, konaSupervisor) + p.Logger().Info("Starting kona-supervisor") + konaSupervisor.Start() + p.Cleanup(konaSupervisor.Stop) + p.Logger().Info("Kona-supervisor is up", "rpc", konaSupervisor.UserRPC()) + }) +} diff --git a/op-devstack/sysgo/supervisor_op.go b/op-devstack/sysgo/supervisor_op.go new file mode 100644 index 00000000000..3dbdae961a8 --- /dev/null +++ b/op-devstack/sysgo/supervisor_op.go @@ -0,0 +1,158 @@ +package sysgo + +import ( + "context" + "sync" + + "github.com/ethereum-optimism/optimism/op-service/testutils/tcpproxy" + + "github.com/ethereum-optimism/optimism/op-devstack/devtest" + "github.com/ethereum/go-ethereum/log" + + "github.com/ethereum-optimism/optimism/op-devstack/shim" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-service/client" + oplog "github.com/ethereum-optimism/optimism/op-service/log" + "github.com/ethereum-optimism/optimism/op-service/metrics" + "github.com/ethereum-optimism/optimism/op-service/oppprof" + oprpc "github.com/ethereum-optimism/optimism/op-service/rpc" + supervisorConfig "github.com/ethereum-optimism/optimism/op-supervisor/config" + "github.com/ethereum-optimism/optimism/op-supervisor/supervisor" + "github.com/ethereum-optimism/optimism/op-supervisor/supervisor/backend/syncnode" +) + +type OpSupervisor struct { + mu sync.Mutex + + id stack.SupervisorID + userRPC string + + cfg *supervisorConfig.Config + p devtest.P + logger log.Logger + + service *supervisor.SupervisorService + + proxy *tcpproxy.Proxy +} + +var _ stack.Lifecycle = (*OpSupervisor)(nil) + +func (s *OpSupervisor) hydrate(sys stack.ExtensibleSystem) { + tlog := sys.Logger().New("id", s.id) + supClient, err := client.NewRPC(sys.T().Ctx(), tlog, s.userRPC, client.WithLazyDial()) + sys.T().Require().NoError(err) + sys.T().Cleanup(supClient.Close) + + sys.AddSupervisor(shim.NewSupervisor(shim.SupervisorConfig{ + CommonConfig: shim.NewCommonConfig(sys.T()), + ID: s.id, + Client: supClient, + })) +} + +func (s *OpSupervisor) UserRPC() string { + return s.userRPC +} + +func (s *OpSupervisor) Start() { + s.mu.Lock() + defer s.mu.Unlock() + if s.service != nil { + s.logger.Warn("Supervisor already started") + return + } + + if s.proxy == nil { + s.proxy = tcpproxy.New(s.logger.New("proxy", "supervisor")) + s.p.Require().NoError(s.proxy.Start()) + s.p.Cleanup(func() { + s.proxy.Close() + }) + s.userRPC = "http://" + s.proxy.Addr() + } + + super, err := supervisor.SupervisorFromConfig(context.Background(), s.cfg, s.logger) + s.p.Require().NoError(err) + + s.service = super + s.logger.Info("Starting supervisor") + err = super.Start(context.Background()) + s.p.Require().NoError(err, "supervisor failed to start") + s.logger.Info("Started supervisor") + s.proxy.SetUpstream(ProxyAddr(s.p.Require(), super.RPC())) +} + +func (s *OpSupervisor) Stop() { + s.mu.Lock() + defer s.mu.Unlock() + if s.service == nil { + s.logger.Warn("Supervisor already stopped") + return + } + ctx, cancel := context.WithCancel(context.Background()) + cancel() // force-quit + s.logger.Info("Closing supervisor") + closeErr := s.service.Stop(ctx) + s.logger.Info("Closed supervisor", "err", closeErr) + + s.service = nil +} + +func WithOPSupervisor(supervisorID stack.SupervisorID, clusterID stack.ClusterID, l1ELID stack.L1ELNodeID) stack.Option[*Orchestrator] { + return stack.AfterDeploy(func(orch *Orchestrator) { + p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), supervisorID)) + require := p.Require() + + l1EL, ok := orch.l1ELs.Get(l1ELID) + require.True(ok, "need L1 EL node to connect supervisor to") + + cluster, ok := orch.clusters.Get(clusterID) + require.True(ok, "need cluster to determine dependency set") + + require.NotNil(cluster.cfgset, "need a full config set") + require.NoError(cluster.cfgset.CheckChains(), "config set must be valid") + cfg := &supervisorConfig.Config{ + MetricsConfig: metrics.CLIConfig{ + Enabled: false, + }, + PprofConfig: oppprof.CLIConfig{ + ListenEnabled: false, + }, + LogConfig: oplog.CLIConfig{ // ignored, logger overrides this + Level: log.LevelDebug, + Format: oplog.FormatText, + }, + RPC: oprpc.CLIConfig{ + ListenAddr: "127.0.0.1", + // When supervisor starts, store its RPC port here + // given by the os, to reclaim when restart. + ListenPort: 0, + EnableAdmin: true, + }, + SyncSources: &syncnode.CLISyncNodes{}, // no sync-sources + L1RPC: l1EL.userRPC, + // Note: datadir is created here, + // persistent across stop/start, for the duration of the package execution. + Datadir: orch.p.TempDir(), + Version: "dev", + FullConfigSetSource: cluster.cfgset, + MockRun: false, + SynchronousProcessors: false, + DatadirSyncEndpoint: "", + } + + plog := p.Logger() + supervisorNode := &OpSupervisor{ + id: supervisorID, + userRPC: "", // set on start + cfg: cfg, + p: p, + logger: plog, + service: nil, // set on start + } + orch.supervisors.Set(supervisorID, supervisorNode) + supervisorNode.Start() + orch.p.Cleanup(supervisorNode.Stop) + }) +} diff --git a/op-devstack/sysgo/sync_tester.go b/op-devstack/sysgo/sync_tester.go index f4b58527886..ace022fd639 100644 --- a/op-devstack/sysgo/sync_tester.go +++ b/op-devstack/sysgo/sync_tester.go @@ -8,6 +8,7 @@ import ( "github.com/ethereum-optimism/optimism/op-devstack/stack" "github.com/ethereum-optimism/optimism/op-service/client" "github.com/ethereum-optimism/optimism/op-service/endpoint" + "github.com/ethereum-optimism/optimism/op-service/eth" oprpc "github.com/ethereum-optimism/optimism/op-service/rpc" "github.com/ethereum-optimism/optimism/op-sync-tester/config" @@ -17,7 +18,9 @@ import ( sttypes "github.com/ethereum-optimism/optimism/op-sync-tester/synctester/backend/types" ) +// Caveat: id is binded by a single EL(chainID), but service can support multiple ELs type SyncTesterService struct { + id stack.SyncTesterID service *synctester.Service } @@ -25,7 +28,7 @@ func (n *SyncTesterService) hydrate(system stack.ExtensibleSystem) { require := system.T().Require() for syncTesterID, chainID := range n.service.SyncTesters() { - syncTesterRPC := n.service.SyncTesterEndpoint(chainID) + syncTesterRPC := n.service.SyncTesterRPC(chainID, false) rpcCl, err := client.NewRPC(system.T().Ctx(), system.Logger(), syncTesterRPC, client.WithLazyDial()) require.NoError(err) system.T().Cleanup(rpcCl.Close) @@ -33,6 +36,7 @@ func (n *SyncTesterService) hydrate(system stack.ExtensibleSystem) { front := shim.NewSyncTester(shim.SyncTesterConfig{ CommonConfig: shim.NewCommonConfig(system.T()), ID: id, + Addr: syncTesterRPC, Client: rpcCl, }) net := system.Network(chainID).(stack.ExtensibleNetwork) @@ -40,9 +44,8 @@ func (n *SyncTesterService) hydrate(system stack.ExtensibleSystem) { } } -func WithSyncTesters(l2ELs []stack.L2ELNodeID) stack.Option[*Orchestrator] { +func WithSyncTester(syncTesterID stack.SyncTesterID, l2ELs []stack.L2ELNodeID) stack.Option[*Orchestrator] { return stack.AfterDeploy(func(orch *Orchestrator) { - syncTesterID := stack.NewSyncTesterID("dev-sync-tester", l2ELs[0].ChainID()) p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), syncTesterID)) require := p.Require() @@ -59,15 +62,55 @@ func WithSyncTesters(l2ELs []stack.L2ELNodeID) stack.Option[*Orchestrator] { require.True(ok, "need L2 EL for sync tester", elID) syncTesters[id] = &stconf.SyncTesterEntry{ - ELRPC: endpoint.MustRPC{Value: endpoint.URL(el.userRPC)}, - // EngineRPC: endpoint.MustRPC{Value: endpoint.URL(el.authRPC)}, - // JwtPath: el.jwtPath, + ELRPC: endpoint.MustRPC{Value: endpoint.URL(el.UserRPC())}, ChainID: elID.ChainID(), } } cfg := &config.Config{ - RPC: oprpc.CLIConfig{}, + RPC: oprpc.CLIConfig{ + ListenAddr: "127.0.0.1", + }, + SyncTesters: &stconf.Config{ + SyncTesters: syncTesters, + }, + } + logger := p.Logger() + srv, err := synctester.FromConfig(p.Ctx(), cfg, logger) + require.NoError(err, "must setup sync tester service") + require.NoError(srv.Start(p.Ctx())) + p.Cleanup(func() { + ctx, cancel := context.WithCancel(context.Background()) + cancel() // force-quit + logger.Info("Closing sync tester") + _ = srv.Stop(ctx) + logger.Info("Closed sync tester") + }) + orch.syncTester = &SyncTesterService{id: syncTesterID, service: srv} + }) +} + +func WithSyncTesterWithExternalEndpoint(syncTesterID stack.SyncTesterID, endpointRPC string, chainID eth.ChainID) stack.Option[*Orchestrator] { + return stack.AfterDeploy(func(orch *Orchestrator) { + p := orch.P().WithCtx(stack.ContextWithID(orch.P().Ctx(), syncTesterID)) + + require := p.Require() + + require.Nil(orch.syncTester, "can only support a single sync-tester-service in sysgo") + + syncTesters := make(map[sttypes.SyncTesterID]*stconf.SyncTesterEntry) + + // Create a sync tester entry with the external endpoint + id := sttypes.SyncTesterID(fmt.Sprintf("dev-sync-tester-%s", chainID)) + syncTesters[id] = &stconf.SyncTesterEntry{ + ELRPC: endpoint.MustRPC{Value: endpoint.URL(endpointRPC)}, + ChainID: chainID, + } + + cfg := &config.Config{ + RPC: oprpc.CLIConfig{ + ListenAddr: "127.0.0.1", + }, SyncTesters: &stconf.Config{ SyncTesters: syncTesters, }, @@ -83,6 +126,6 @@ func WithSyncTesters(l2ELs []stack.L2ELNodeID) stack.Option[*Orchestrator] { _ = srv.Stop(ctx) logger.Info("Closed sync tester") }) - orch.syncTester = &SyncTesterService{service: srv} + orch.syncTester = &SyncTesterService{id: syncTesterID, service: srv} }) } diff --git a/op-devstack/sysgo/system.go b/op-devstack/sysgo/system.go index ba21757ac19..92b818b0a37 100644 --- a/op-devstack/sysgo/system.go +++ b/op-devstack/sysgo/system.go @@ -2,6 +2,7 @@ package sysgo import ( "github.com/ethereum-optimism/optimism/op-chain-ops/devkeys" + "github.com/ethereum-optimism/optimism/op-chain-ops/interopgen" "github.com/ethereum-optimism/optimism/op-devstack/stack" "github.com/ethereum-optimism/optimism/op-service/eth" ) @@ -64,8 +65,8 @@ func DefaultMinimalSystem(dest *DefaultMinimalSystemIDs) stack.Option[*Orchestra opt.Add(WithL1Nodes(ids.L1EL, ids.L1CL)) - opt.Add(WithL2ELNode(ids.L2EL, nil)) - opt.Add(WithL2CLNode(ids.L2CL, true, false, ids.L1CL, ids.L1EL, ids.L2EL)) + opt.Add(WithL2ELNode(ids.L2EL)) + opt.Add(WithL2CLNode(ids.L2CL, ids.L1CL, ids.L1EL, ids.L2EL, L2CLSequencer())) opt.Add(WithBatcher(ids.L2Batcher, ids.L1EL, ids.L2CL, ids.L2EL)) opt.Add(WithProposer(ids.L2Proposer, ids.L1EL, &ids.L2CL, nil)) @@ -95,11 +96,11 @@ func NewDefaultMinimalSystemWithSyncTesterIDs(l1ID, l2ID eth.ChainID) DefaultMin minimal := NewDefaultMinimalSystemIDs(l1ID, l2ID) return DefaultMinimalSystemWithSyncTesterIDs{ DefaultMinimalSystemIDs: minimal, - SyncTester: stack.NewSyncTesterID("s", l2ID), + SyncTester: stack.NewSyncTesterID("sync-tester", l2ID), } } -func DefaultMinimalSystemWithSyncTester(dest *DefaultMinimalSystemWithSyncTesterIDs) stack.Option[*Orchestrator] { +func DefaultMinimalSystemWithSyncTester(dest *DefaultMinimalSystemWithSyncTesterIDs, fcu eth.FCUState) stack.Option[*Orchestrator] { l1ID := eth.ChainIDFromUInt64(900) l2ID := eth.ChainIDFromUInt64(901) ids := NewDefaultMinimalSystemWithSyncTesterIDs(l1ID, l2ID) @@ -121,8 +122,8 @@ func DefaultMinimalSystemWithSyncTester(dest *DefaultMinimalSystemWithSyncTester opt.Add(WithL1Nodes(ids.L1EL, ids.L1CL)) - opt.Add(WithL2ELNode(ids.L2EL, nil)) - opt.Add(WithL2CLNode(ids.L2CL, true, false, ids.L1CL, ids.L1EL, ids.L2EL)) + opt.Add(WithL2ELNode(ids.L2EL)) + opt.Add(WithL2CLNode(ids.L2CL, ids.L1CL, ids.L1EL, ids.L2EL, L2CLSequencer())) opt.Add(WithBatcher(ids.L2Batcher, ids.L1EL, ids.L2CL, ids.L2EL)) opt.Add(WithProposer(ids.L2Proposer, ids.L1EL, &ids.L2CL, nil)) @@ -135,7 +136,7 @@ func DefaultMinimalSystemWithSyncTester(dest *DefaultMinimalSystemWithSyncTester ids.L2EL, })) - opt.Add(WithSyncTesters([]stack.L2ELNodeID{ids.L2EL})) + opt.Add(WithSyncTester(ids.SyncTester, []stack.L2ELNodeID{ids.L2EL})) opt.Add(stack.Finally(func(orch *Orchestrator) { *dest = ids @@ -227,8 +228,8 @@ func baseInteropSystem(ids *DefaultSingleChainInteropSystemIDs) stack.Option[*Or opt.Add(WithSupervisor(ids.Supervisor, ids.Cluster, ids.L1EL)) - opt.Add(WithL2ELNode(ids.L2AEL, &ids.Supervisor)) - opt.Add(WithL2CLNode(ids.L2ACL, true, true, ids.L1CL, ids.L1EL, ids.L2AEL)) + opt.Add(WithL2ELNode(ids.L2AEL, L2ELWithSupervisor(ids.Supervisor))) + opt.Add(WithL2CLNode(ids.L2ACL, ids.L1CL, ids.L1EL, ids.L2AEL, L2CLSequencer(), L2CLIndexing())) opt.Add(WithTestSequencer(ids.TestSequencer, ids.L1CL, ids.L2ACL, ids.L1EL, ids.L2AEL)) opt.Add(WithBatcher(ids.L2ABatcher, ids.L1EL, ids.L2ACL, ids.L2AEL)) @@ -277,8 +278,8 @@ func DefaultInteropSystem(dest *DefaultInteropSystemIDs) stack.Option[*Orchestra WithPrefundedL2(ids.L1.ChainID(), ids.L2B.ChainID()), WithInteropAtGenesis(), // this can be overridden by later options )) - opt.Add(WithL2ELNode(ids.L2BEL, &ids.Supervisor)) - opt.Add(WithL2CLNode(ids.L2BCL, true, true, ids.L1CL, ids.L1EL, ids.L2BEL)) + opt.Add(WithL2ELNode(ids.L2BEL, L2ELWithSupervisor(ids.Supervisor))) + opt.Add(WithL2CLNode(ids.L2BCL, ids.L1CL, ids.L1EL, ids.L2BEL, L2CLSequencer(), L2CLIndexing())) opt.Add(WithBatcher(ids.L2BBatcher, ids.L1EL, ids.L2BCL, ids.L2BEL)) opt.Add(WithManagedBySupervisor(ids.L2BCL, ids.Supervisor)) @@ -331,16 +332,18 @@ func defaultSuperProofsSystem(dest *DefaultInteropSystemIDs, deployerOpts ...Dep WithCommons(ids.L1.ChainID()), WithPrefundedL2(ids.L1.ChainID(), ids.L2A.ChainID()), WithPrefundedL2(ids.L1.ChainID(), ids.L2B.ChainID()), + WithDevFeatureBitmap(interopgen.OptimismPortalInteropDevFlag), }, deployerOpts...)...)) opt.Add(WithL1Nodes(ids.L1EL, ids.L1CL)) opt.Add(WithSupervisor(ids.Supervisor, ids.Cluster, ids.L1EL)) - opt.Add(WithL2ELNode(ids.L2AEL, &ids.Supervisor)) - opt.Add(WithL2CLNode(ids.L2ACL, true, true, ids.L1CL, ids.L1EL, ids.L2AEL)) - opt.Add(WithL2ELNode(ids.L2BEL, &ids.Supervisor)) - opt.Add(WithL2CLNode(ids.L2BCL, true, true, ids.L1CL, ids.L1EL, ids.L2BEL)) + opt.Add(WithL2ELNode(ids.L2AEL, L2ELWithSupervisor(ids.Supervisor))) + opt.Add(WithL2CLNode(ids.L2ACL, ids.L1CL, ids.L1EL, ids.L2AEL, L2CLSequencer(), L2CLIndexing())) + + opt.Add(WithL2ELNode(ids.L2BEL, L2ELWithSupervisor(ids.Supervisor))) + opt.Add(WithL2CLNode(ids.L2BCL, ids.L1CL, ids.L1EL, ids.L2BEL, L2CLSequencer(), L2CLIndexing())) opt.Add(WithTestSequencer(ids.TestSequencer, ids.L1CL, ids.L2ACL, ids.L1EL, ids.L2AEL)) @@ -399,11 +402,11 @@ func MultiSupervisorInteropSystem(dest *MultiSupervisorInteropSystemIDs) stack.O // add backup supervisor opt.Add(WithSupervisor(ids.SupervisorSecondary, ids.Cluster, ids.L1EL)) - opt.Add(WithL2ELNode(ids.L2A2EL, &ids.SupervisorSecondary)) - opt.Add(WithL2CLNode(ids.L2A2CL, false, true, ids.L1CL, ids.L1EL, ids.L2A2EL)) + opt.Add(WithL2ELNode(ids.L2A2EL, L2ELWithSupervisor(ids.SupervisorSecondary))) + opt.Add(WithL2CLNode(ids.L2A2CL, ids.L1CL, ids.L1EL, ids.L2A2EL, L2CLIndexing())) - opt.Add(WithL2ELNode(ids.L2B2EL, &ids.SupervisorSecondary)) - opt.Add(WithL2CLNode(ids.L2B2CL, false, true, ids.L1CL, ids.L1EL, ids.L2B2EL)) + opt.Add(WithL2ELNode(ids.L2B2EL, L2ELWithSupervisor(ids.SupervisorSecondary))) + opt.Add(WithL2CLNode(ids.L2B2CL, ids.L1CL, ids.L1EL, ids.L2B2EL, L2CLIndexing())) // verifier must be also managed or it cannot advance // we attach verifier L2CL with backup supervisor diff --git a/op-devstack/sysgo/system_singlechain_multinode.go b/op-devstack/sysgo/system_singlechain_multinode.go index ef864147816..a58b632fa7f 100644 --- a/op-devstack/sysgo/system_singlechain_multinode.go +++ b/op-devstack/sysgo/system_singlechain_multinode.go @@ -27,8 +27,8 @@ func DefaultSingleChainMultiNodeSystem(dest *DefaultSingleChainMultiNodeSystemID opt := stack.Combine[*Orchestrator]() opt.Add(DefaultMinimalSystem(&dest.DefaultMinimalSystemIDs)) - opt.Add(WithL2ELNode(ids.L2ELB, nil)) - opt.Add(WithL2CLNode(ids.L2CLB, false, false, ids.L1CL, ids.L1EL, ids.L2ELB)) + opt.Add(WithL2ELNode(ids.L2ELB)) + opt.Add(WithL2CLNode(ids.L2CLB, ids.L1CL, ids.L1EL, ids.L2ELB)) // P2P connect L2CL nodes opt.Add(WithL2CLP2PConnection(ids.L2CL, ids.L2CLB)) diff --git a/op-devstack/sysgo/system_synctester.go b/op-devstack/sysgo/system_synctester.go new file mode 100644 index 00000000000..9cef547b9d8 --- /dev/null +++ b/op-devstack/sysgo/system_synctester.go @@ -0,0 +1,74 @@ +package sysgo + +import ( + "github.com/ethereum-optimism/optimism/op-chain-ops/devkeys" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-service/eth" +) + +type DefaultSimpleSystemWithSyncTesterIDs struct { + DefaultMinimalSystemIDs + + L2CL2 stack.L2CLNodeID + SyncTesterL2EL stack.L2ELNodeID + SyncTester stack.SyncTesterID +} + +func NewDefaultSimpleSystemWithSyncTesterIDs(l1ID, l2ID eth.ChainID) DefaultSimpleSystemWithSyncTesterIDs { + minimal := NewDefaultMinimalSystemIDs(l1ID, l2ID) + return DefaultSimpleSystemWithSyncTesterIDs{ + DefaultMinimalSystemIDs: minimal, + L2CL2: stack.NewL2CLNodeID("verifier", l2ID), + SyncTesterL2EL: stack.NewL2ELNodeID("sync-tester-el", l2ID), + SyncTester: stack.NewSyncTesterID("sync-tester", l2ID), + } +} + +func DefaultSimpleSystemWithSyncTester(dest *DefaultSimpleSystemWithSyncTesterIDs, fcu eth.FCUState) stack.Option[*Orchestrator] { + l1ID := eth.ChainIDFromUInt64(900) + l2ID := eth.ChainIDFromUInt64(901) + ids := NewDefaultSimpleSystemWithSyncTesterIDs(l1ID, l2ID) + + opt := stack.Combine[*Orchestrator]() + opt.Add(stack.BeforeDeploy(func(o *Orchestrator) { + o.P().Logger().Info("Setting up") + })) + + opt.Add(WithMnemonicKeys(devkeys.TestMnemonic)) + + opt.Add(WithDeployer(), + WithDeployerOptions( + WithLocalContractSources(), + WithCommons(ids.L1.ChainID()), + WithPrefundedL2(ids.L1.ChainID(), ids.L2.ChainID()), + ), + ) + + opt.Add(WithL1Nodes(ids.L1EL, ids.L1CL)) + + opt.Add(WithL2ELNode(ids.L2EL)) + opt.Add(WithL2CLNode(ids.L2CL, ids.L1CL, ids.L1EL, ids.L2EL, L2CLSequencer())) + + opt.Add(WithBatcher(ids.L2Batcher, ids.L1EL, ids.L2CL, ids.L2EL)) + opt.Add(WithProposer(ids.L2Proposer, ids.L1EL, &ids.L2CL, nil)) + + opt.Add(WithFaucets([]stack.L1ELNodeID{ids.L1EL}, []stack.L2ELNodeID{ids.L2EL})) + + opt.Add(WithTestSequencer(ids.TestSequencer, ids.L1CL, ids.L2CL, ids.L1EL, ids.L2EL)) + + opt.Add(WithL2Challenger(ids.L2Challenger, ids.L1EL, ids.L1CL, nil, nil, &ids.L2CL, []stack.L2ELNodeID{ + ids.L2EL, + })) + + opt.Add(WithSyncTester(ids.SyncTester, []stack.L2ELNodeID{ids.L2EL})) + + // Create a SyncTesterEL with the same chain ID as the EL node + opt.Add(WithSyncTesterL2ELNode(ids.SyncTesterL2EL, ids.L2EL, fcu)) + opt.Add(WithL2CLNode(ids.L2CL2, ids.L1CL, ids.L1EL, ids.SyncTesterL2EL)) + + opt.Add(stack.Finally(func(orch *Orchestrator) { + *dest = ids + })) + + return opt +} diff --git a/op-devstack/sysgo/system_synctester_ext.go b/op-devstack/sysgo/system_synctester_ext.go new file mode 100644 index 00000000000..4d6ef8e211f --- /dev/null +++ b/op-devstack/sysgo/system_synctester_ext.go @@ -0,0 +1,94 @@ +package sysgo + +import ( + "fmt" + "math/big" + + "github.com/ethereum-optimism/optimism/op-chain-ops/devkeys" + "github.com/ethereum-optimism/optimism/op-devstack/stack" + "github.com/ethereum-optimism/optimism/op-node/chaincfg" + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum/go-ethereum/core" + "github.com/ethereum/go-ethereum/params" +) + +type DefaultMinimalExternalELSystemIDs struct { + L1 stack.L1NetworkID + L1EL stack.L1ELNodeID + L1CL stack.L1CLNodeID + + L2 stack.L2NetworkID + L2CL stack.L2CLNodeID + L2EL stack.L2ELNodeID + + SyncTester stack.SyncTesterID +} + +func NewDefaultMinimalExternalELSystemIDs(l1ID, l2ID eth.ChainID) DefaultMinimalExternalELSystemIDs { + ids := DefaultMinimalExternalELSystemIDs{ + L1: stack.L1NetworkID(l1ID), + L1EL: stack.NewL1ELNodeID("l1", l1ID), + L1CL: stack.NewL1CLNodeID("l1", l1ID), + L2: stack.L2NetworkID(l2ID), + L2CL: stack.NewL2CLNodeID("verifier", l2ID), + L2EL: stack.NewL2ELNodeID("sync-tester-el", l2ID), + SyncTester: stack.NewSyncTesterID("sync-tester", l2ID), + } + return ids +} + +// DefaultMinimalExternalELSystemWithEndpointAndSuperchainRegistry creates a minimal external EL system +// using a network from the superchain registry instead of the deployer +func DefaultMinimalExternalELSystemWithEndpointAndSuperchainRegistry(dest *DefaultMinimalExternalELSystemIDs, l1CLBeaconRPC, l1ELRPC, l2ELRPC string, l1ChainID eth.ChainID, networkName string, fcu eth.FCUState) stack.Option[*Orchestrator] { + chainCfg := chaincfg.ChainByName(networkName) + if chainCfg == nil { + panic(fmt.Sprintf("network %s not found in superchain registry", networkName)) + } + l2ChainID := eth.ChainIDFromUInt64(chainCfg.ChainID) + + ids := NewDefaultMinimalExternalELSystemIDs(l1ChainID, l2ChainID) + + opt := stack.Combine[*Orchestrator]() + opt.Add(stack.BeforeDeploy(func(o *Orchestrator) { + o.P().Logger().Info("Setting up with superchain registry network", "network", networkName) + })) + + opt.Add(WithMnemonicKeys(devkeys.TestMnemonic)) + + // Skip deployer since we're using external L1 and superchain registry for L2 config + // Create L1 network record for external L1 + opt.Add(stack.BeforeDeploy(func(o *Orchestrator) { + chainID, _ := ids.L1.ChainID().Uint64() + l1Net := &L1Network{ + id: ids.L1, + genesis: &core.Genesis{ + Config: ¶ms.ChainConfig{ + ChainID: big.NewInt(int64(chainID)), + }, + }, + blockTime: 12, + } + o.l1Nets.Set(ids.L1.ChainID(), l1Net) + })) + + opt.Add(WithExtL1Nodes(ids.L1EL, ids.L1CL, l1ELRPC, l1CLBeaconRPC)) + + // Use superchain registry instead of deployer + opt.Add(WithL2NetworkFromSuperchainRegistryWithDependencySet( + stack.L2NetworkID(l2ChainID), + networkName, + )) + + // Add SyncTester service with external endpoint + opt.Add(WithSyncTesterWithExternalEndpoint(ids.SyncTester, l2ELRPC, l2ChainID)) + + // Add SyncTesterL2ELNode as the L2EL replacement for real-world EL endpoint + opt.Add(WithSyncTesterL2ELNode(ids.L2EL, ids.L2EL, fcu)) + opt.Add(WithL2CLNode(ids.L2CL, ids.L1CL, ids.L1EL, ids.L2EL)) + + opt.Add(stack.Finally(func(orch *Orchestrator) { + *dest = ids + })) + + return opt +} diff --git a/op-devstack/sysgo/test_sequencer.go b/op-devstack/sysgo/test_sequencer.go index ffc0a52f6df..fe46a79b279 100644 --- a/op-devstack/sysgo/test_sequencer.go +++ b/op-devstack/sysgo/test_sequencer.go @@ -117,10 +117,10 @@ func WithTestSequencer(testSequencerID stack.TestSequencerID, l1CLID stack.L1CLN Value: endpoint.HttpURL(l1EL.userRPC), }, L2EL: endpoint.MustRPC{ - Value: endpoint.HttpURL(l2EL.userRPC), + Value: endpoint.HttpURL(l2EL.UserRPC()), }, L2CL: endpoint.MustRPC{ - Value: endpoint.HttpURL(l2CL.userRPC), + Value: endpoint.HttpURL(l2CL.UserRPC()), }, }, }, @@ -149,7 +149,7 @@ func WithTestSequencer(testSequencerID stack.TestSequencerID, l1CLID stack.L1CLN cid_L2: { Standard: &standardcommitter.Config{ RPC: endpoint.MustRPC{ - Value: endpoint.HttpURL(l2CL.userRPC), + Value: endpoint.HttpURL(l2CL.UserRPC()), }, }, }, @@ -161,7 +161,7 @@ func WithTestSequencer(testSequencerID stack.TestSequencerID, l1CLID stack.L1CLN pid_L2: { Standard: &standardpublisher.Config{ RPC: endpoint.MustRPC{ - Value: endpoint.HttpURL(l2CL.userRPC), + Value: endpoint.HttpURL(l2CL.UserRPC()), }, }, }, diff --git a/op-dispute-mon/mon/extract/caller.go b/op-dispute-mon/mon/extract/caller.go index eff20e7effb..9658c2533c9 100644 --- a/op-dispute-mon/mon/extract/caller.go +++ b/op-dispute-mon/mon/extract/caller.go @@ -53,12 +53,14 @@ func (g *GameCallerCreator) CreateContract(ctx context.Context, game gameTypes.G switch faultTypes.GameType(game.GameType) { case faultTypes.CannonGameType, faultTypes.PermissionedGameType, + faultTypes.CannonKonaGameType, faultTypes.AsteriscGameType, faultTypes.AlphabetGameType, faultTypes.FastGameType, faultTypes.AsteriscKonaGameType, faultTypes.SuperCannonGameType, faultTypes.SuperPermissionedGameType, + faultTypes.SuperCannonKonaGameType, faultTypes.SuperAsteriscKonaGameType: fdg, err := contracts.NewFaultDisputeGameContract(ctx, g.m, game.Proxy, g.caller) if err != nil { diff --git a/op-dispute-mon/mon/extract/caller_test.go b/op-dispute-mon/mon/extract/caller_test.go index bbca26d6653..585ab609392 100644 --- a/op-dispute-mon/mon/extract/caller_test.go +++ b/op-dispute-mon/mon/extract/caller_test.go @@ -35,6 +35,10 @@ func TestMetadataCreator_CreateContract(t *testing.T) { name: "validPermissionedGameType", game: types.GameMetadata{GameType: uint32(faultTypes.PermissionedGameType), Proxy: fdgAddr}, }, + { + name: "validCannonKonaGameType", + game: types.GameMetadata{GameType: uint32(faultTypes.CannonKonaGameType), Proxy: fdgAddr}, + }, { name: "validAsteriscGameType", game: types.GameMetadata{GameType: uint32(faultTypes.AsteriscGameType), Proxy: fdgAddr}, @@ -59,6 +63,10 @@ func TestMetadataCreator_CreateContract(t *testing.T) { name: "validSuperPermissionedGameType", game: types.GameMetadata{GameType: uint32(faultTypes.SuperPermissionedGameType), Proxy: fdgAddr}, }, + { + name: "validSuperCannonKonaGameType", + game: types.GameMetadata{GameType: uint32(faultTypes.SuperCannonKonaGameType), Proxy: fdgAddr}, + }, { name: "validSuperAsteriscKonaGameType", game: types.GameMetadata{GameType: uint32(faultTypes.SuperAsteriscKonaGameType), Proxy: fdgAddr}, @@ -93,7 +101,10 @@ func TestMetadataCreator_CreateContract(t *testing.T) { func setupMetadataLoaderTest(t *testing.T, gameType uint32) (*batching.MultiCaller, *mockCacheMetrics) { fdgAbi := snapshots.LoadFaultDisputeGameABI() - if gameType == uint32(faultTypes.SuperPermissionedGameType) || gameType == uint32(faultTypes.SuperCannonGameType) || gameType == uint32(faultTypes.SuperAsteriscKonaGameType) { + if gameType == uint32(faultTypes.SuperPermissionedGameType) || + gameType == uint32(faultTypes.SuperCannonGameType) || + gameType == uint32(faultTypes.SuperCannonKonaGameType) || + gameType == uint32(faultTypes.SuperAsteriscKonaGameType) { fdgAbi = snapshots.LoadSuperFaultDisputeGameABI() } stubRpc := batchingTest.NewAbiBasedRpc(t, fdgAddr, fdgAbi) diff --git a/op-e2e/README.md b/op-e2e/README.md index ba385547461..21d895d30e8 100644 --- a/op-e2e/README.md +++ b/op-e2e/README.md @@ -58,6 +58,10 @@ E.g. P2P, CLI usage, and dynamic block building are not covered. ### `system`-tests +> [!IMPORTANT] +> System tests are deprecated. While existing tests should continue to be maintained, +> any net-new tests should be added in [op-acceptance-tests](../op-acceptance-tests/) instead. + System tests are more complete than `action` tests, but also require a live system. This trade-off enables coverage of most of each Go service, at the cost of making navigation to cover the known edge-cases less reliable and reproducible. diff --git a/op-e2e/actions/helpers/l2_sequencer.go b/op-e2e/actions/helpers/l2_sequencer.go index 7b3d224e9fd..23be8eaf8c9 100644 --- a/op-e2e/actions/helpers/l2_sequencer.go +++ b/op-e2e/actions/helpers/l2_sequencer.go @@ -125,7 +125,7 @@ func (s *L2Sequencer) ActL2EndBlock(t Testing) { // After having built a L2 block, make sure to get an engine update processed, // and request a forkchoice update directly. - s.synchronousEvents.Emit(t.Ctx(), engine.TryUpdateEngineEvent{}) + s.engine.TryUpdateEngine(t.Ctx()) s.engine.RequestForkchoiceUpdate(t.Ctx()) require.NoError(t, s.drainer.DrainUntil(func(ev event.Event) bool { x, ok := ev.(engine.ForkchoiceUpdateEvent) diff --git a/op-e2e/actions/helpers/l2_verifier.go b/op-e2e/actions/helpers/l2_verifier.go index 3825b076bab..82a125932ec 100644 --- a/op-e2e/actions/helpers/l2_verifier.go +++ b/op-e2e/actions/helpers/l2_verifier.go @@ -147,32 +147,46 @@ func NewL2Verifier(t Testing, log log.Logger, l1 derive.L1Fetcher, metrics := &testutils.TestDerivationMetrics{} ec := engine.NewEngineController(ctx, eng, log, opnodemetrics.NoopMetrics, cfg, syncCfg, sys.Register("engine-controller", nil, opts)) - sys.Register("engine-reset", - engine.NewEngineResetDeriver(ctx, log, cfg, l1, eng, syncCfg), opts) + if mm, ok := interopSys.(*indexing.IndexingMode); ok { + mm.SetEngineController(ec) + } + + engineResetDeriver := engine.NewEngineResetDeriver(ctx, log, cfg, l1, eng, syncCfg) + sys.Register("engine-reset", engineResetDeriver, opts) + engineResetDeriver.SetEngController(ec) clSync := clsync.NewCLSync(log, cfg, metrics, ec) sys.Register("cl-sync", clSync, opts) var finalizer driver.Finalizer if cfg.AltDAEnabled() { - finalizer = finality.NewAltDAFinalizer(ctx, log, cfg, l1, altDASrc) + finalizer = finality.NewAltDAFinalizer(ctx, log, cfg, l1, altDASrc, ec) } else { - finalizer = finality.NewFinalizer(ctx, log, cfg, l1) + finalizer = finality.NewFinalizer(ctx, log, cfg, l1, ec) } sys.Register("finalizer", finalizer, opts) attrHandler := attributes.NewAttributesHandler(log, cfg, ctx, eng, ec) sys.Register("attributes-handler", attrHandler, opts) + ec.SetAttributesResetter(attrHandler) indexingMode := interopSys != nil pipeline := derive.NewDerivationPipeline(log, cfg, depSet, l1, blobsSrc, altDASrc, eng, metrics, indexingMode) - sys.Register("pipeline", derive.NewPipelineDeriver(ctx, pipeline), opts) + pipelineDeriver := derive.NewPipelineDeriver(ctx, pipeline) + sys.Register("pipeline", pipelineDeriver, opts) + ec.SetPipelineResetter(pipelineDeriver) testActionEmitter := sys.Register("test-action", nil, opts) syncStatusTracker := status.NewStatusTracker(log, metrics) sys.Register("status", syncStatusTracker, opts) + // TODO(#17115): Refactor dependency cycles + ec.SetCrossUpdateHandler(syncStatusTracker) + + stepDeriver := NewTestingStepSchedulingDeriver() + stepDeriver.AttachEmitter(testActionEmitter) + syncDeriver := &driver.SyncDeriver{ Derivation: pipeline, SafeHeadNotifs: safeHeadListener, @@ -186,6 +200,7 @@ func NewL2Verifier(t Testing, log log.Logger, l1 derive.L1Fetcher, Log: log, Ctx: ctx, ManagedBySupervisor: indexingMode, + StepDeriver: stepDeriver, } // TODO(#16917) Remove Event System Refactor Comments // Couple SyncDeriver and EngineController for event refactoring @@ -401,8 +416,6 @@ func (s *L2Verifier) OnEvent(ctx context.Context, ev event.Event) bool { s.L2PipelineIdle = true case derive.PipelineStepEvent: s.L2PipelineIdle = false - case driver.StepReqEvent: - s.synchronousEvents.Emit(ctx, driver.StepEvent{}) default: return false } @@ -461,3 +474,33 @@ func (s *L2Verifier) SyncSupervisor(t Testing) { _, err := s.InteropControl.PullEvents(t.Ctx()) require.NoError(t, err) } + +type TestingStepSchedulingDeriver struct { + emitter event.Emitter +} + +func NewTestingStepSchedulingDeriver() *TestingStepSchedulingDeriver { + return &TestingStepSchedulingDeriver{} +} + +func (t *TestingStepSchedulingDeriver) NextStep() <-chan struct{} { + return nil +} + +func (t *TestingStepSchedulingDeriver) NextDelayedStep() <-chan time.Time { + return nil +} + +func (t *TestingStepSchedulingDeriver) RequestStep(ctx context.Context, resetBackoff bool) { + t.emitter.Emit(ctx, driver.StepEvent{}) +} + +func (t *TestingStepSchedulingDeriver) AttemptStep(ctx context.Context) { +} + +func (t *TestingStepSchedulingDeriver) ResetStepBackoff(ctx context.Context) { +} + +func (t *TestingStepSchedulingDeriver) AttachEmitter(em event.Emitter) { + t.emitter = em +} diff --git a/op-e2e/actions/helpers/user.go b/op-e2e/actions/helpers/user.go index 4c1bf047132..f064ff6170a 100644 --- a/op-e2e/actions/helpers/user.go +++ b/op-e2e/actions/helpers/user.go @@ -429,25 +429,6 @@ func (s *CrossLayerUser) CheckDepositTx(t Testing, l1TxHash common.Hash, index i } } -func (s *CrossLayerUser) ActStartWithdrawal(t Testing) { - targetAddr := common.Address{} - if s.L1.txToAddr != nil { - targetAddr = *s.L2.txToAddr - } - tx, err := s.L2.env.Bindings.L2ToL1MessagePasser.InitiateWithdrawal(&s.L2.txOpts, targetAddr, new(big.Int).SetUint64(s.L1.txOpts.GasLimit), s.L1.txCallData) - require.NoError(t, err, "create initiate withdraw tx") - err = s.L2.env.EthCl.SendTransaction(t.Ctx(), tx) - require.NoError(t, err, "must send tx") - s.lastL2WithdrawalTxHash = tx.Hash() -} - -// ActCheckStartWithdrawal checks that a previous witdrawal tx was either successful or failed. -func (s *CrossLayerUser) ActCheckStartWithdrawal(success bool) Action { - return func(t Testing) { - s.L2.CheckReceipt(t, success, s.lastL2WithdrawalTxHash) - } -} - func (s *CrossLayerUser) Address() common.Address { return s.L1.address } @@ -529,12 +510,6 @@ func (s *CrossLayerUser) getDisputeGame(t Testing, params withdrawals.ProvenWith return proxy, game.DisputeGameProxy, nil } -// ActCompleteWithdrawal creates a L1 proveWithdrawal tx for latest withdrawal. -// The tx hash is remembered as the last L1 tx, to check as L1 actor. -func (s *CrossLayerUser) ActProveWithdrawal(t Testing) { - s.L1.lastTxHash = s.ProveWithdrawal(t, s.lastL2WithdrawalTxHash) -} - // ProveWithdrawal creates a L1 proveWithdrawal tx for the given L2 withdrawal tx, returning the tx hash. func (s *CrossLayerUser) ProveWithdrawal(t Testing, l2TxHash common.Hash) common.Hash { params, err := s.getLastWithdrawalParams(t) @@ -566,13 +541,6 @@ func (s *CrossLayerUser) ProveWithdrawal(t Testing, l2TxHash common.Hash) common return tx.Hash() } -// ActCompleteWithdrawal creates a L1 withdrawal finalization tx for latest withdrawal. -// The tx hash is remembered as the last L1 tx, to check as L1 actor. -// The withdrawal functions like CompleteWithdrawal -func (s *CrossLayerUser) ActCompleteWithdrawal(t Testing) { - s.L1.lastTxHash = s.CompleteWithdrawal(t, s.lastL2WithdrawalTxHash) -} - // CompleteWithdrawal creates a L1 withdrawal finalization tx for the given L2 withdrawal tx, returning the tx hash. // It's an invalid action to attempt to complete a withdrawal that has not passed the L1 finalization period yet func (s *CrossLayerUser) CompleteWithdrawal(t Testing, l2TxHash common.Hash) common.Hash { diff --git a/op-e2e/actions/helpers/user_test.go b/op-e2e/actions/helpers/user_test.go deleted file mode 100644 index 55b3373616c..00000000000 --- a/op-e2e/actions/helpers/user_test.go +++ /dev/null @@ -1,374 +0,0 @@ -package helpers - -import ( - "fmt" - "math/rand" - "testing" - "time" - - "github.com/stretchr/testify/require" - - "github.com/ethereum/go-ethereum/accounts/abi/bind" - "github.com/ethereum/go-ethereum/common/hexutil" - "github.com/ethereum/go-ethereum/core/types" - "github.com/ethereum/go-ethereum/log" - - "github.com/ethereum-optimism/optimism/op-e2e/config" - "github.com/ethereum-optimism/optimism/op-e2e/e2eutils" - bindingspreview "github.com/ethereum-optimism/optimism/op-node/bindings/preview" - "github.com/ethereum-optimism/optimism/op-service/eth" - "github.com/ethereum-optimism/optimism/op-service/testlog" -) - -type hardforkScheduledTest struct { - regolithTime *hexutil.Uint64 - canyonTime *hexutil.Uint64 - deltaTime *hexutil.Uint64 - ecotoneTime *hexutil.Uint64 - fjordTime *hexutil.Uint64 - graniteTime *hexutil.Uint64 - holoceneTime *hexutil.Uint64 - isthmusTime *hexutil.Uint64 - interopTime *hexutil.Uint64 - jovianTime *hexutil.Uint64 - runToFork string - allocType config.AllocType -} - -func (tc *hardforkScheduledTest) SetFork(fork string, v uint64) { - *tc.fork(fork) = (*hexutil.Uint64)(&v) -} - -func (tc *hardforkScheduledTest) GetFork(fork string) *uint64 { - return (*uint64)(*tc.fork(fork)) -} - -func (tc *hardforkScheduledTest) fork(fork string) **hexutil.Uint64 { - switch fork { - case "jovian": - return &tc.jovianTime - case "interop": - return &tc.interopTime - case "isthmus": - return &tc.isthmusTime - case "holocene": - return &tc.holoceneTime - case "granite": - return &tc.graniteTime - case "fjord": - return &tc.fjordTime - case "ecotone": - return &tc.ecotoneTime - case "delta": - return &tc.deltaTime - case "canyon": - return &tc.canyonTime - case "regolith": - return &tc.regolithTime - default: - panic(fmt.Errorf("unrecognized fork: %s", fork)) - } -} - -func TestCrossLayerUser_Default(t *testing.T) { - testCrossLayerUser(t, config.DefaultAllocType) -} - -// TestCrossLayerUser tests that common actions of the CrossLayerUser actor work in various hardfork configurations: -// - transact on L1 -// - transact on L2 -// - deposit on L1 -// - withdraw from L2 -// - prove tx on L1 -// - wait 1 week + 1 second -// - finalize withdrawal on L1 -func testCrossLayerUser(t *testing.T, allocType config.AllocType) { - futureTime := uint64(20) - farFutureTime := uint64(2000) - - forks := []string{ - "regolith", - "canyon", - "delta", - "ecotone", - "fjord", - "granite", - "holocene", - "isthmus", - "interop", - "jovian", - } - for i, fork := range forks { - i := i - fork := fork - t.Run("fork_"+fork, func(t *testing.T) { - t.Run("at_genesis", func(t *testing.T) { - tc := hardforkScheduledTest{ - allocType: allocType, - } - for _, f := range forks[:i+1] { // activate, all up to and incl this fork, at genesis - tc.SetFork(f, 0) - } - runCrossLayerUserTest(t, tc) - }) - t.Run("after_genesis", func(t *testing.T) { - tc := hardforkScheduledTest{ - allocType: allocType, - } - for _, f := range forks[:i] { // activate, all up to this fork, at genesis - tc.SetFork(f, 0) - } - // activate this fork after genesis - tc.SetFork(fork, futureTime) - tc.runToFork = fork - runCrossLayerUserTest(t, tc) - }) - t.Run("not_yet", func(t *testing.T) { - tc := hardforkScheduledTest{ - allocType: allocType, - } - for _, f := range forks[:i] { // activate, all up to this fork, at genesis - tc.SetFork(f, 0) - } - // activate this fork later - tc.SetFork(fork, farFutureTime) - if i > 0 { - tc.runToFork = forks[i-1] - } - runCrossLayerUserTest(t, tc) - }) - }) - } -} - -func runCrossLayerUserTest(gt *testing.T, test hardforkScheduledTest) { - t := NewDefaultTesting(gt) - params := DefaultRollupTestParams() - params.AllocType = test.allocType - dp := e2eutils.MakeDeployParams(t, params) - // This overwrites all deploy-config settings, - // so even when the deploy-config defaults change, we test the right transitions. - dp.DeployConfig.L2GenesisRegolithTimeOffset = test.regolithTime - dp.DeployConfig.L2GenesisCanyonTimeOffset = test.canyonTime - dp.DeployConfig.L2GenesisDeltaTimeOffset = test.deltaTime - dp.DeployConfig.L2GenesisEcotoneTimeOffset = test.ecotoneTime - dp.DeployConfig.L2GenesisFjordTimeOffset = test.fjordTime - dp.DeployConfig.L2GenesisGraniteTimeOffset = test.graniteTime - dp.DeployConfig.L2GenesisHoloceneTimeOffset = test.holoceneTime - dp.DeployConfig.L2GenesisIsthmusTimeOffset = test.isthmusTime - - if test.canyonTime != nil { - require.Zero(t, uint64(*test.canyonTime)%uint64(dp.DeployConfig.L2BlockTime), "canyon fork must be aligned") - } - if test.ecotoneTime != nil { - require.Zero(t, uint64(*test.ecotoneTime)%uint64(dp.DeployConfig.L2BlockTime), "ecotone fork must be aligned") - } - - sd := e2eutils.Setup(t, dp, DefaultAlloc) - log := testlog.Logger(t, log.LevelDebug) - - require.Equal(t, dp.Secrets.Addresses().Batcher, dp.DeployConfig.BatchSenderAddress) - require.Equal(t, dp.Secrets.Addresses().Proposer, dp.DeployConfig.L2OutputOracleProposer) - - miner, seqEngine, seq := SetupSequencerTest(t, sd, log) - batcher := NewL2Batcher(log, sd.RollupCfg, DefaultBatcherCfg(dp), - seq.RollupClient(), miner.EthClient(), seqEngine.EthClient(), seqEngine.EngineClient(t, sd.RollupCfg)) - - var proposer *L2Proposer - if test.allocType.UsesProofs() { - optimismPortal2Contract, err := bindingspreview.NewOptimismPortal2(sd.DeploymentsL1.OptimismPortalProxy, miner.EthClient()) - require.NoError(t, err) - respectedGameType, err := optimismPortal2Contract.RespectedGameType(&bind.CallOpts{}) - require.NoError(t, err) - proposer = NewL2Proposer(t, log, &ProposerCfg{ - DisputeGameFactoryAddr: &sd.DeploymentsL1.DisputeGameFactoryProxy, - ProposalInterval: 6 * time.Second, - ProposalRetryInterval: 3 * time.Second, - DisputeGameType: respectedGameType, - ProposerKey: dp.Secrets.Proposer, - AllowNonFinalized: true, - AllocType: test.allocType, - ChainID: eth.ChainIDFromBig(sd.L1Cfg.Config.ChainID), - }, miner.EthClient(), seq.RollupClient()) - } else { - proposer = NewL2Proposer(t, log, &ProposerCfg{ - OutputOracleAddr: &sd.DeploymentsL1.L2OutputOracleProxy, - ProposerKey: dp.Secrets.Proposer, - ProposalRetryInterval: 3 * time.Second, - AllowNonFinalized: true, - AllocType: test.allocType, - ChainID: eth.ChainIDFromBig(sd.L1Cfg.Config.ChainID), - }, miner.EthClient(), seq.RollupClient()) - } - - // need to start derivation before we can make L2 blocks - seq.ActL2PipelineFull(t) - - l1Cl := miner.EthClient() - l2Cl := seqEngine.EthClient() - l2ProofCl := seqEngine.GethClient() - - addresses := e2eutils.CollectAddresses(sd, dp) - - l1UserEnv := &BasicUserEnv[*L1Bindings]{ - EthCl: l1Cl, - Signer: types.LatestSigner(sd.L1Cfg.Config), - AddressCorpora: addresses, - Bindings: NewL1Bindings(t, l1Cl, test.allocType), - } - l2UserEnv := &BasicUserEnv[*L2Bindings]{ - EthCl: l2Cl, - Signer: types.LatestSigner(sd.L2Cfg.Config), - AddressCorpora: addresses, - Bindings: NewL2Bindings(t, l2Cl, l2ProofCl), - } - - alice := NewCrossLayerUser(log, dp.Secrets.Alice, rand.New(rand.NewSource(1234)), test.allocType) - alice.L1.SetUserEnv(l1UserEnv) - alice.L2.SetUserEnv(l2UserEnv) - - // Build at least one l2 block so we have an unsafe head with a deposit info tx (genesis block doesn't) - seq.ActL2StartBlock(t) - seq.ActL2EndBlock(t) - - if test.runToFork != "" { - forkTime := test.GetFork(test.runToFork) - require.NotNil(t, forkTime, "fork we are running up to must be configured") - // advance L2 enough to activate the fork we are running up to - seq.ActBuildL2ToTime(t, *forkTime) - } - // Check Regolith is active or not by confirming the system info tx is not a system tx - infoTx, err := l2Cl.TransactionInBlock(t.Ctx(), seq.L2Unsafe().Hash, 0) - require.NoError(t, err) - require.True(t, infoTx.IsDepositTx()) - // Should only be a system tx if regolith is not enabled - require.Equal(t, !seq.RollupCfg.IsRegolith(seq.L2Unsafe().Time), infoTx.IsSystemTx()) - - // regular L2 tx, in new L2 block - alice.L2.ActResetTxOpts(t) - alice.L2.ActSetTxToAddr(&dp.Addresses.Bob)(t) - alice.L2.ActMakeTx(t) - seq.ActL2StartBlock(t) - seqEngine.ActL2IncludeTx(alice.Address())(t) - seq.ActL2EndBlock(t) - alice.L2.ActCheckReceiptStatusOfLastTx(true)(t) - - // regular L1 tx, in new L1 block - alice.L1.ActResetTxOpts(t) - alice.L1.ActSetTxToAddr(&dp.Addresses.Bob)(t) - alice.L1.ActMakeTx(t) - miner.ActL1StartBlock(12)(t) - miner.ActL1IncludeTx(alice.Address())(t) - miner.ActL1EndBlock(t) - alice.L1.ActCheckReceiptStatusOfLastTx(true)(t) - - // regular Deposit, in new L1 block - alice.L1.ActResetTxOpts(t) - alice.ActDeposit(t) - miner.ActL1StartBlock(12)(t) - miner.ActL1IncludeTx(alice.Address())(t) - miner.ActL1EndBlock(t) - - seq.ActL1HeadSignal(t) - - // sync sequencer build enough blocks to adopt latest L1 origin - for seq.SyncStatus().UnsafeL2.L1Origin.Number < miner.l1Chain.CurrentBlock().Number.Uint64() { - seq.ActL2StartBlock(t) - seq.ActL2EndBlock(t) - } - // Now that the L2 chain adopted the latest L1 block, check that we processed the deposit - alice.ActCheckDepositStatus(true, true)(t) - - // regular withdrawal, in new L2 block - alice.ActStartWithdrawal(t) - seq.ActL2StartBlock(t) - seqEngine.ActL2IncludeTx(alice.Address())(t) - seq.ActL2EndBlock(t) - alice.ActCheckStartWithdrawal(true)(t) - - // build a L1 block and more L2 blocks, - // to ensure the L2 withdrawal is old enough to be able to get into an output root proposal on L1 - miner.ActEmptyBlock(t) - seq.ActL1HeadSignal(t) - seq.ActBuildToL1Head(t) - - // submit everything to L1 - batcher.ActSubmitAll(t) - // include batch on L1 - miner.ActL1StartBlock(12)(t) - miner.ActL1IncludeTx(dp.Addresses.Batcher)(t) - miner.ActL1EndBlock(t) - - // derive from L1, blocks will now become safe to propose - seq.ActL2PipelineFull(t) - - // make proposals until there is nothing left to propose - for proposer.CanPropose(t) { - // propose it to L1 - proposer.ActMakeProposalTx(t) - // include proposal on L1 - miner.ActL1StartBlock(12)(t) - miner.ActL1IncludeTx(dp.Addresses.Proposer)(t) - miner.ActL1EndBlock(t) - // Check proposal was successful - receipt, err := miner.EthClient().TransactionReceipt(t.Ctx(), proposer.LastProposalTx()) - require.NoError(t, err) - require.Equal(t, types.ReceiptStatusSuccessful, receipt.Status, "proposal failed") - } - - // Mine an empty block so that the timestamp is updated. Otherwise ActProveWithdrawal will fail - // because it tries to estimate gas based on the current timestamp, which is the same timestamp - // as the dispute game creation timestamp, which causes proveWithdrawalTransaction to revert. - miner.ActL1StartBlock(12)(t) - miner.ActL1EndBlock(t) - - // prove our withdrawal on L1 - alice.ActProveWithdrawal(t) - // include proved withdrawal in new L1 block - miner.ActL1StartBlock(12)(t) - miner.ActL1IncludeTx(alice.Address())(t) - miner.ActL1EndBlock(t) - // check withdrawal succeeded - alice.L1.ActCheckReceiptStatusOfLastTx(true)(t) - - // A bit hacky- Mines an empty block with the time delta - // of the finalization period (12s) + 1 in order for the - // withdrawal to be finalized successfully. - miner.ActL1StartBlock(13)(t) - miner.ActL1EndBlock(t) - - // If using fault proofs we need to resolve the game - if test.allocType.UsesProofs() { - // Resolve the root claim - alice.ActResolveClaim(t) - miner.ActL1StartBlock(12)(t) - miner.ActL1IncludeTx(alice.Address())(t) - miner.ActL1EndBlock(t) - // Resolve the game - alice.L1.ActCheckReceiptStatusOfLastTx(true)(t) - alice.ActResolve(t) - miner.ActL1StartBlock(12)(t) - miner.ActL1IncludeTx(alice.Address())(t) - miner.ActL1EndBlock(t) - // Create an empty block to pass the air-gap window - alice.L1.ActCheckReceiptStatusOfLastTx(true)(t) - miner.ActL1StartBlock(13)(t) - miner.ActL1EndBlock(t) - } - - // make the L1 finalize withdrawal tx - alice.ActCompleteWithdrawal(t) - // include completed withdrawal in new L1 block - miner.ActL1StartBlock(12)(t) - miner.ActL1IncludeTx(alice.Address())(t) - miner.ActL1EndBlock(t) - // check withdrawal succeeded - alice.L1.ActCheckReceiptStatusOfLastTx(true)(t) - - // Check Regolith wasn't activated during the test unintentionally - infoTx, err = l2Cl.TransactionInBlock(t.Ctx(), seq.L2Unsafe().Hash, 0) - require.NoError(t, err) - require.True(t, infoTx.IsDepositTx()) - // Should only be a system tx if regolith is not enabled - require.Equal(t, !seq.RollupCfg.IsRegolith(seq.L2Unsafe().Time), infoTx.IsSystemTx()) -} diff --git a/op-e2e/actions/sync/sync_test.go b/op-e2e/actions/sync/sync_test.go index 0b154ea451f..9705777647a 100644 --- a/op-e2e/actions/sync/sync_test.go +++ b/op-e2e/actions/sync/sync_test.go @@ -1052,8 +1052,7 @@ func TestSpanBatchAtomicity_Consolidation(gt *testing.T) { require.Equal(t, verifier.L2Safe().Number, uint64(0)) } else { // Make sure we do the post-processing of what safety updates might happen - // Digest events until EngDeriver implicitly consumes PromoteSafeEvent - verifier.ActL2EventsUntil(t, event.Is[engine2.TryUpdateEngineEvent], 100, true) + verifier.ActL2PipelineFull(t) // Once the span batch is fully processed, the safe head must advance to the end of span batch. require.Equal(t, verifier.L2Safe().Number, targetHeadNumber) require.Equal(t, verifier.L2Safe(), verifier.L2PendingSafe()) diff --git a/op-e2e/actions/upgrades/dencun_fork_test.go b/op-e2e/actions/upgrades/dencun_fork_test.go index 52cd7652384..13c88fefc77 100644 --- a/op-e2e/actions/upgrades/dencun_fork_test.go +++ b/op-e2e/actions/upgrades/dencun_fork_test.go @@ -5,6 +5,7 @@ import ( "testing" "github.com/ethereum-optimism/optimism/op-e2e/actions/helpers" + "github.com/ethereum-optimism/optimism/op-node/rollup" "github.com/stretchr/testify/require" "github.com/ethereum/go-ethereum/common" @@ -124,12 +125,7 @@ func TestDencunL2ForkAfterGenesis(gt *testing.T) { dp := e2eutils.MakeDeployParams(t, helpers.DefaultRollupTestParams()) require.Zero(t, *dp.DeployConfig.L1CancunTimeOffset) // This test will fork on the second block - offset := hexutil.Uint64(dp.DeployConfig.L2BlockTime * 2) - dp.DeployConfig.L2GenesisEcotoneTimeOffset = &offset - dp.DeployConfig.L2GenesisFjordTimeOffset = nil - dp.DeployConfig.L2GenesisGraniteTimeOffset = nil - dp.DeployConfig.L2GenesisHoloceneTimeOffset = nil - // New forks have to be added here, after changing the default deploy config! + dp.DeployConfig.ActivateForkAtOffset(rollup.Ecotone, dp.DeployConfig.L2BlockTime*2) sd := e2eutils.Setup(t, dp, helpers.DefaultAlloc) log := testlog.Logger(t, log.LevelDebug) diff --git a/op-e2e/actions/upgrades/ecotone_fork_test.go b/op-e2e/actions/upgrades/ecotone_fork_test.go index 19b36eb91f4..09aa995fc36 100644 --- a/op-e2e/actions/upgrades/ecotone_fork_test.go +++ b/op-e2e/actions/upgrades/ecotone_fork_test.go @@ -18,6 +18,7 @@ import ( "github.com/ethereum-optimism/optimism/op-chain-ops/genesis" "github.com/ethereum-optimism/optimism/op-e2e/bindings" "github.com/ethereum-optimism/optimism/op-e2e/e2eutils" + "github.com/ethereum-optimism/optimism/op-node/rollup" "github.com/ethereum-optimism/optimism/op-node/rollup/derive" "github.com/ethereum-optimism/optimism/op-service/predeploys" "github.com/ethereum-optimism/optimism/op-service/testlog" @@ -43,17 +44,13 @@ func verifyCodeHashMatches(t helpers.Testing, client *ethclient.Client, address func TestEcotoneNetworkUpgradeTransactions(gt *testing.T) { t := helpers.NewDefaultTesting(gt) dp := e2eutils.MakeDeployParams(t, helpers.DefaultRollupTestParams()) - ecotoneOffset := hexutil.Uint64(4) + ecotoneOffset := 4 log := testlog.Logger(t, log.LevelDebug) require.Zero(t, *dp.DeployConfig.L1CancunTimeOffset) // Activate all forks at genesis, and schedule Ecotone the block after - dp.DeployConfig.L2GenesisEcotoneTimeOffset = &ecotoneOffset - dp.DeployConfig.L2GenesisFjordTimeOffset = nil - dp.DeployConfig.L2GenesisGraniteTimeOffset = nil - dp.DeployConfig.L2GenesisHoloceneTimeOffset = nil - // New forks have to be added here... + dp.DeployConfig.ActivateForkAtOffset(rollup.Ecotone, uint64(ecotoneOffset)) require.NoError(t, dp.DeployConfig.Check(log), "must have valid config") sd := e2eutils.Setup(t, dp, helpers.DefaultAlloc) diff --git a/op-e2e/actions/upgrades/fjord_fork_test.go b/op-e2e/actions/upgrades/fjord_fork_test.go index ae0dbfb0b2b..24839388f1c 100644 --- a/op-e2e/actions/upgrades/fjord_fork_test.go +++ b/op-e2e/actions/upgrades/fjord_fork_test.go @@ -10,7 +10,6 @@ import ( "github.com/ethereum-optimism/optimism/op-service/predeploys" "github.com/ethereum/go-ethereum/accounts/abi/bind" "github.com/ethereum/go-ethereum/common" - "github.com/ethereum/go-ethereum/common/hexutil" "github.com/ethereum/go-ethereum/core/types" "github.com/ethereum/go-ethereum/crypto" "github.com/ethereum/go-ethereum/log" @@ -19,6 +18,7 @@ import ( "github.com/ethereum-optimism/optimism/op-chain-ops/genesis" "github.com/ethereum-optimism/optimism/op-e2e/bindings" "github.com/ethereum-optimism/optimism/op-e2e/e2eutils" + "github.com/ethereum-optimism/optimism/op-node/rollup" "github.com/ethereum-optimism/optimism/op-node/rollup/derive" "github.com/ethereum-optimism/optimism/op-service/testlog" ) @@ -32,21 +32,13 @@ var ( func TestFjordNetworkUpgradeTransactions(gt *testing.T) { t := helpers.NewDefaultTesting(gt) dp := e2eutils.MakeDeployParams(t, helpers.DefaultRollupTestParams()) - genesisBlock := hexutil.Uint64(0) - fjordOffset := hexutil.Uint64(2) log := testlog.Logger(t, log.LvlDebug) - dp.DeployConfig.L1CancunTimeOffset = &genesisBlock // can be removed once Cancun on L1 is the default - // Activate all forks at genesis, and schedule Fjord the block after - dp.DeployConfig.L2GenesisRegolithTimeOffset = &genesisBlock - dp.DeployConfig.L2GenesisCanyonTimeOffset = &genesisBlock - dp.DeployConfig.L2GenesisDeltaTimeOffset = &genesisBlock - dp.DeployConfig.L2GenesisEcotoneTimeOffset = &genesisBlock - dp.DeployConfig.L2GenesisFjordTimeOffset = &fjordOffset - dp.DeployConfig.L2GenesisGraniteTimeOffset = nil - dp.DeployConfig.L2GenesisHoloceneTimeOffset = nil + fjordOffset := uint64(2) + dp.DeployConfig.ActivateForkAtOffset(rollup.Fjord, fjordOffset) + require.NoError(t, dp.DeployConfig.Check(log), "must have valid config") sd := e2eutils.Setup(t, dp, helpers.DefaultAlloc) diff --git a/op-e2e/bindings/opcontractsmanager.go b/op-e2e/bindings/opcontractsmanager.go index ca744990965..155dd255ade 100644 --- a/op-e2e/bindings/opcontractsmanager.go +++ b/op-e2e/bindings/opcontractsmanager.go @@ -111,6 +111,7 @@ type OPContractsManagerImplementations struct { ProtocolVersionsImpl common.Address L1ERC721BridgeImpl common.Address OptimismPortalImpl common.Address + OptimismPortalInteropImpl common.Address EthLockboxImpl common.Address SystemConfigImpl common.Address OptimismMintableERC20FactoryImpl common.Address @@ -180,8 +181,8 @@ type Proposal struct { // OPContractsManagerMetaData contains all meta data concerning the OPContractsManager contract. var OPContractsManagerMetaData = &bind.MetaData{ - ABI: "[{\"type\":\"constructor\",\"inputs\":[{\"name\":\"_opcmGameTypeAdder\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerGameTypeAdder\"},{\"name\":\"_opcmDeployer\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerDeployer\"},{\"name\":\"_opcmUpgrader\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerUpgrader\"},{\"name\":\"_opcmInteropMigrator\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerInteropMigrator\"},{\"name\":\"_opcmStandardValidator\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerStandardValidator\"},{\"name\":\"_superchainConfig\",\"type\":\"address\",\"internalType\":\"contractISuperchainConfig\"},{\"name\":\"_protocolVersions\",\"type\":\"address\",\"internalType\":\"contractIProtocolVersions\"},{\"name\":\"_superchainProxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"_upgradeController\",\"type\":\"address\",\"internalType\":\"address\"}],\"stateMutability\":\"nonpayable\"},{\"type\":\"function\",\"name\":\"addGameType\",\"inputs\":[{\"name\":\"_gameConfigs\",\"type\":\"tuple[]\",\"internalType\":\"structOPContractsManager.AddGameInput[]\",\"components\":[{\"name\":\"saltMixer\",\"type\":\"string\",\"internalType\":\"string\"},{\"name\":\"systemConfig\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"delayedWETH\",\"type\":\"address\",\"internalType\":\"contractIDelayedWETH\"},{\"name\":\"disputeGameType\",\"type\":\"uint32\",\"internalType\":\"GameType\"},{\"name\":\"disputeAbsolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"Claim\"},{\"name\":\"disputeMaxGameDepth\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"disputeSplitDepth\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"disputeClockExtension\",\"type\":\"uint64\",\"internalType\":\"Duration\"},{\"name\":\"disputeMaxClockDuration\",\"type\":\"uint64\",\"internalType\":\"Duration\"},{\"name\":\"initialBond\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"vm\",\"type\":\"address\",\"internalType\":\"contractIBigStepper\"},{\"name\":\"permissioned\",\"type\":\"bool\",\"internalType\":\"bool\"}]}],\"outputs\":[{\"name\":\"\",\"type\":\"tuple[]\",\"internalType\":\"structOPContractsManager.AddGameOutput[]\",\"components\":[{\"name\":\"delayedWETH\",\"type\":\"address\",\"internalType\":\"contractIDelayedWETH\"},{\"name\":\"faultDisputeGame\",\"type\":\"address\",\"internalType\":\"contractIFaultDisputeGame\"}]}],\"stateMutability\":\"nonpayable\"},{\"type\":\"function\",\"name\":\"blueprints\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManager.Blueprints\",\"components\":[{\"name\":\"addressManager\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"proxy\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"l1ChugSplashProxy\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"resolvedDelegateProxy\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"permissionedDisputeGame1\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"permissionedDisputeGame2\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"permissionlessDisputeGame1\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"permissionlessDisputeGame2\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"superPermissionedDisputeGame1\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"superPermissionedDisputeGame2\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"superPermissionlessDisputeGame1\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"superPermissionlessDisputeGame2\",\"type\":\"address\",\"internalType\":\"address\"}]}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"chainIdToBatchInboxAddress\",\"inputs\":[{\"name\":\"_l2ChainId\",\"type\":\"uint256\",\"internalType\":\"uint256\"}],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"address\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"deploy\",\"inputs\":[{\"name\":\"_input\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManager.DeployInput\",\"components\":[{\"name\":\"roles\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManager.Roles\",\"components\":[{\"name\":\"opChainProxyAdminOwner\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"systemConfigOwner\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"batcher\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"unsafeBlockSigner\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"proposer\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"challenger\",\"type\":\"address\",\"internalType\":\"address\"}]},{\"name\":\"basefeeScalar\",\"type\":\"uint32\",\"internalType\":\"uint32\"},{\"name\":\"blobBasefeeScalar\",\"type\":\"uint32\",\"internalType\":\"uint32\"},{\"name\":\"l2ChainId\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"startingAnchorRoot\",\"type\":\"bytes\",\"internalType\":\"bytes\"},{\"name\":\"saltMixer\",\"type\":\"string\",\"internalType\":\"string\"},{\"name\":\"gasLimit\",\"type\":\"uint64\",\"internalType\":\"uint64\"},{\"name\":\"disputeGameType\",\"type\":\"uint32\",\"internalType\":\"GameType\"},{\"name\":\"disputeAbsolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"Claim\"},{\"name\":\"disputeMaxGameDepth\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"disputeSplitDepth\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"disputeClockExtension\",\"type\":\"uint64\",\"internalType\":\"Duration\"},{\"name\":\"disputeMaxClockDuration\",\"type\":\"uint64\",\"internalType\":\"Duration\"}]}],\"outputs\":[{\"name\":\"\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManager.DeployOutput\",\"components\":[{\"name\":\"opChainProxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"addressManager\",\"type\":\"address\",\"internalType\":\"contractIAddressManager\"},{\"name\":\"l1ERC721BridgeProxy\",\"type\":\"address\",\"internalType\":\"contractIL1ERC721Bridge\"},{\"name\":\"systemConfigProxy\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"optimismMintableERC20FactoryProxy\",\"type\":\"address\",\"internalType\":\"contractIOptimismMintableERC20Factory\"},{\"name\":\"l1StandardBridgeProxy\",\"type\":\"address\",\"internalType\":\"contractIL1StandardBridge\"},{\"name\":\"l1CrossDomainMessengerProxy\",\"type\":\"address\",\"internalType\":\"contractIL1CrossDomainMessenger\"},{\"name\":\"ethLockboxProxy\",\"type\":\"address\",\"internalType\":\"contractIETHLockbox\"},{\"name\":\"optimismPortalProxy\",\"type\":\"address\",\"internalType\":\"contractIOptimismPortal2\"},{\"name\":\"disputeGameFactoryProxy\",\"type\":\"address\",\"internalType\":\"contractIDisputeGameFactory\"},{\"name\":\"anchorStateRegistryProxy\",\"type\":\"address\",\"internalType\":\"contractIAnchorStateRegistry\"},{\"name\":\"faultDisputeGame\",\"type\":\"address\",\"internalType\":\"contractIFaultDisputeGame\"},{\"name\":\"permissionedDisputeGame\",\"type\":\"address\",\"internalType\":\"contractIPermissionedDisputeGame\"},{\"name\":\"delayedWETHPermissionedGameProxy\",\"type\":\"address\",\"internalType\":\"contractIDelayedWETH\"},{\"name\":\"delayedWETHPermissionlessGameProxy\",\"type\":\"address\",\"internalType\":\"contractIDelayedWETH\"}]}],\"stateMutability\":\"nonpayable\"},{\"type\":\"function\",\"name\":\"implementations\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManager.Implementations\",\"components\":[{\"name\":\"superchainConfigImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"protocolVersionsImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"l1ERC721BridgeImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"optimismPortalImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"ethLockboxImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"systemConfigImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"optimismMintableERC20FactoryImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"l1CrossDomainMessengerImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"l1StandardBridgeImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"disputeGameFactoryImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"anchorStateRegistryImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"delayedWETHImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"mipsImpl\",\"type\":\"address\",\"internalType\":\"address\"}]}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"migrate\",\"inputs\":[{\"name\":\"_input\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManagerInteropMigrator.MigrateInput\",\"components\":[{\"name\":\"usePermissionlessGame\",\"type\":\"bool\",\"internalType\":\"bool\"},{\"name\":\"startingAnchorRoot\",\"type\":\"tuple\",\"internalType\":\"structProposal\",\"components\":[{\"name\":\"root\",\"type\":\"bytes32\",\"internalType\":\"Hash\"},{\"name\":\"l2SequenceNumber\",\"type\":\"uint256\",\"internalType\":\"uint256\"}]},{\"name\":\"gameParameters\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManagerInteropMigrator.GameParameters\",\"components\":[{\"name\":\"proposer\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"challenger\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"maxGameDepth\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"splitDepth\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"initBond\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"clockExtension\",\"type\":\"uint64\",\"internalType\":\"Duration\"},{\"name\":\"maxClockDuration\",\"type\":\"uint64\",\"internalType\":\"Duration\"}]},{\"name\":\"opChainConfigs\",\"type\":\"tuple[]\",\"internalType\":\"structOPContractsManager.OpChainConfig[]\",\"components\":[{\"name\":\"systemConfigProxy\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"absolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"Claim\"}]}]}],\"outputs\":[],\"stateMutability\":\"nonpayable\"},{\"type\":\"function\",\"name\":\"opcmDeployer\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerDeployer\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"opcmGameTypeAdder\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerGameTypeAdder\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"opcmInteropMigrator\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerInteropMigrator\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"opcmStandardValidator\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerStandardValidator\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"opcmUpgrader\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerUpgrader\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"protocolVersions\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractIProtocolVersions\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"superchainConfig\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractISuperchainConfig\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"superchainProxyAdmin\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"updatePrestate\",\"inputs\":[{\"name\":\"_prestateUpdateInputs\",\"type\":\"tuple[]\",\"internalType\":\"structOPContractsManager.OpChainConfig[]\",\"components\":[{\"name\":\"systemConfigProxy\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"absolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"Claim\"}]}],\"outputs\":[],\"stateMutability\":\"nonpayable\"},{\"type\":\"function\",\"name\":\"upgrade\",\"inputs\":[{\"name\":\"_opChainConfigs\",\"type\":\"tuple[]\",\"internalType\":\"structOPContractsManager.OpChainConfig[]\",\"components\":[{\"name\":\"systemConfigProxy\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"absolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"Claim\"}]}],\"outputs\":[],\"stateMutability\":\"nonpayable\"},{\"type\":\"function\",\"name\":\"upgradeController\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"address\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"validate\",\"inputs\":[{\"name\":\"_input\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManagerStandardValidator.ValidationInput\",\"components\":[{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"sysCfg\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"absolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"bytes32\"},{\"name\":\"l2ChainID\",\"type\":\"uint256\",\"internalType\":\"uint256\"}]},{\"name\":\"_allowFailure\",\"type\":\"bool\",\"internalType\":\"bool\"}],\"outputs\":[{\"name\":\"\",\"type\":\"string\",\"internalType\":\"string\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"validateWithOverrides\",\"inputs\":[{\"name\":\"_input\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManagerStandardValidator.ValidationInput\",\"components\":[{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"sysCfg\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"absolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"bytes32\"},{\"name\":\"l2ChainID\",\"type\":\"uint256\",\"internalType\":\"uint256\"}]},{\"name\":\"_allowFailure\",\"type\":\"bool\",\"internalType\":\"bool\"},{\"name\":\"_overrides\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManagerStandardValidator.ValidationOverrides\",\"components\":[{\"name\":\"l1PAOMultisig\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"challenger\",\"type\":\"address\",\"internalType\":\"address\"}]}],\"outputs\":[{\"name\":\"\",\"type\":\"string\",\"internalType\":\"string\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"version\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"string\",\"internalType\":\"string\"}],\"stateMutability\":\"pure\"},{\"type\":\"error\",\"name\":\"AddressHasNoCode\",\"inputs\":[{\"name\":\"who\",\"type\":\"address\",\"internalType\":\"address\"}]},{\"type\":\"error\",\"name\":\"AddressNotFound\",\"inputs\":[{\"name\":\"who\",\"type\":\"address\",\"internalType\":\"address\"}]},{\"type\":\"error\",\"name\":\"AlreadyReleased\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"InvalidChainId\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"InvalidGameConfigs\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"InvalidRoleAddress\",\"inputs\":[{\"name\":\"role\",\"type\":\"string\",\"internalType\":\"string\"}]},{\"type\":\"error\",\"name\":\"InvalidStartingAnchorRoot\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"LatestReleaseNotSet\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"OnlyDelegatecall\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"PrestateNotSet\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"PrestateRequired\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"SuperchainConfigMismatch\",\"inputs\":[{\"name\":\"systemConfig\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"}]},{\"type\":\"error\",\"name\":\"SuperchainProxyAdminMismatch\",\"inputs\":[]}]", - Bin: "0x6101c06040523480156200001257600080fd5b506040516200271b3803806200271b833981016040819052620000359162000313565b60405163b6a4cd2160e01b81526001600160a01b03858116600483015289169063b6a4cd219060240160006040518083038186803b1580156200007757600080fd5b505afa1580156200008c573d6000803e3d6000fd5b505060405163b6a4cd2160e01b81526001600160a01b0386811660048301528b16925063b6a4cd21915060240160006040518083038186803b158015620000d257600080fd5b505afa158015620000e7573d6000803e3d6000fd5b505060405163b6a4cd2160e01b81526001600160a01b038c811660048301528b16925063b6a4cd21915060240160006040518083038186803b1580156200012d57600080fd5b505afa15801562000142573d6000803e3d6000fd5b505060405163b6a4cd2160e01b81526001600160a01b038b1660048201819052925063b6a4cd21915060240160006040518083038186803b1580156200018757600080fd5b505afa1580156200019c573d6000803e3d6000fd5b505060405163b6a4cd2160e01b81526001600160a01b038a811660048301528b16925063b6a4cd21915060240160006040518083038186803b158015620001e257600080fd5b505afa158015620001f7573d6000803e3d6000fd5b505060405163b6a4cd2160e01b81526001600160a01b0389811660048301528b16925063b6a4cd21915060240160006040518083038186803b1580156200023d57600080fd5b505afa15801562000252573d6000803e3d6000fd5b505060405163b6a4cd2160e01b81526001600160a01b0388811660048301528b16925063b6a4cd21915060240160006040518083038186803b1580156200029857600080fd5b505afa158015620002ad573d6000803e3d6000fd5b5050506001600160a01b03998a166080525096881660a05294871660c05292861660e052908516610100528416610120528316610140528216610160523061018052166101a052620003ea565b6001600160a01b03811681146200031057600080fd5b50565b60008060008060008060008060006101208a8c0312156200033357600080fd5b89516200034081620002fa565b60208b01519099506200035381620002fa565b60408b01519098506200036681620002fa565b60608b01519097506200037981620002fa565b60808b01519096506200038c81620002fa565b60a08b01519095506200039f81620002fa565b60c08b0151909450620003b281620002fa565b60e08b0151909350620003c581620002fa565b6101008b0151909250620003d981620002fa565b809150509295985092959850929598565b60805160a05160c05160e05161010051610120516101405161016051610180516101a051612245620004d660003960006103660152600081816104100152818161077701528181610a680152610c290152600081816102010152610ca60152600061032c0152600081816102700152818161093f0152610c850152600081816103a80152818161055201526109e00152600081816101ba01526108410152600081816101760152610d3701526000818161030501528181610642015281816106fa015281816109080152610bc20152600081816103cf015281816104dc0152610b3201526122456000f3fe608060405234801561001057600080fd5b506004361061016c5760003560e01c8063613e827b116100cd5780639a72745b11610081578063ba7903db11610066578063ba7903db146103a3578063becbdf4a146103ca578063ff2dd5a1146103f157600080fd5b80639a72745b14610388578063b51f9c2b1461039b57600080fd5b80636624856a116100b25780636624856a1461032757806367cda69c1461034e57806387543ef61461036157600080fd5b8063613e827b146102e0578063622d56f11461030057600080fd5b806330e9012c1161012457806335e80ab31161010957806335e80ab31461026b5780633fe13f3f1461029257806354fd4d50146102a757600080fd5b806330e9012c14610243578063318b1b801461025857600080fd5b80631661a2e9116101555780631661a2e9146101dc5780632b96b839146101fc57806330d148881461022357600080fd5b806303dbe68c146101715780631481a724146101b5575b600080fd5b6101987f000000000000000000000000000000000000000000000000000000000000000081565b6040516001600160a01b0390911681526020015b60405180910390f35b6101987f000000000000000000000000000000000000000000000000000000000000000081565b6101ef6101ea366004610fca565b610404565b6040516101ac9190611172565b6101987f000000000000000000000000000000000000000000000000000000000000000081565b610236610231366004611246565b61051f565b6040516101ac91906112d6565b61024b6105d7565b6040516101ac9190611407565b610198610266366004611416565b6106c8565b6101987f000000000000000000000000000000000000000000000000000000000000000081565b6102a56102a036600461142f565b61076d565b005b60408051808201909152600581527f322e362e300000000000000000000000000000000000000000000000000000006020820152610236565b6102f36102ee366004611472565b61086b565b6040516101ac91906114ae565b6101987f000000000000000000000000000000000000000000000000000000000000000081565b6101987f000000000000000000000000000000000000000000000000000000000000000081565b61023661035c3660046115ea565b6109ad565b6101987f000000000000000000000000000000000000000000000000000000000000000081565b6102a5610396366004611682565b610a5e565b61024b610b57565b6101987f000000000000000000000000000000000000000000000000000000000000000081565b6101987f000000000000000000000000000000000000000000000000000000000000000081565b6102a56103ff366004611682565b610c1f565b60606001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000163003610468576040517f0a57d61d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b60008260405160240161047b9190611752565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f1661a2e900000000000000000000000000000000000000000000000000000000179052905060006105017f000000000000000000000000000000000000000000000000000000000000000083610d58565b905080806020019051810190610517919061189f565b949350505050565b6040517f30d148880000000000000000000000000000000000000000000000000000000081526060906001600160a01b037f000000000000000000000000000000000000000000000000000000000000000016906330d14888906105899086908690600401611968565b600060405180830381865afa1580156105a6573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f191682016040526105ce91908101906119b3565b90505b92915050565b604080516101a081018252600080825260208201819052918101829052606081018290526080810182905260a0810182905260c0810182905260e0810182905261010081018290526101208101829052610140810182905261016081018290526101808101919091527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166330e9012c6040518163ffffffff1660e01b81526004016101a060405180830381865afa15801561069f573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106c39190611b29565b905090565b6040517f318b1b80000000000000000000000000000000000000000000000000000000008152600481018290526000907f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03169063318b1b8090602401602060405180830381865afa158015610749573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906105d19190611b46565b6001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001630036107cf576040517f0a57d61d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6000816040516024016107e29190611c3b565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f3fe13f3f0000000000000000000000000000000000000000000000000000000017905290506108667f000000000000000000000000000000000000000000000000000000000000000082610d58565b505050565b604080516101e081018252600080825260208201819052818301819052606082018190526080820181905260a0820181905260c0820181905260e08201819052610100820181905261012082018190526101408201819052610160820181905261018082018190526101a082018190526101c082015290517fb2e48a3f0000000000000000000000000000000000000000000000000000000081527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03169063b2e48a3f906109699085907f0000000000000000000000000000000000000000000000000000000000000000903390600401611e4a565b6101e0604051808303816000875af1158015610989573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906105d19190611fff565b6040517f67cda69c0000000000000000000000000000000000000000000000000000000081526060906001600160a01b037f000000000000000000000000000000000000000000000000000000000000000016906367cda69c90610a1990879087908790600401612121565b600060405180830381865afa158015610a36573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f1916820160405261051791908101906119b3565b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000163003610ac0576040517f0a57d61d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b600081604051602401610ad391906121dd565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f9a72745b0000000000000000000000000000000000000000000000000000000017905290506108667f000000000000000000000000000000000000000000000000000000000000000082610d58565b604080516101a081018252600080825260208201819052918101829052606081018290526080810182905260a0810182905260c0810182905260e0810182905261010081018290526101208101829052610140810182905261016081018290526101808101919091527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663b51f9c2b6040518163ffffffff1660e01b81526004016101a060405180830381865afa15801561069f573d6000803e3d6000fd5b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000163003610c81576040517f0a57d61d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b60007f00000000000000000000000000000000000000000000000000000000000000007f000000000000000000000000000000000000000000000000000000000000000083604051602401610cd8939291906121f0565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f8a196cd40000000000000000000000000000000000000000000000000000000017905290506108667f0000000000000000000000000000000000000000000000000000000000000000825b6060600080846001600160a01b031684604051610d75919061221c565b600060405180830381855af49150503d8060008114610db0576040519150601f19603f3d011682016040523d82523d6000602084013e610db5565b606091505b50915091508161051757805160208201fd5b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b6040516101a0810167ffffffffffffffff81118282101715610e1a57610e1a610dc7565b60405290565b6040805190810167ffffffffffffffff81118282101715610e1a57610e1a610dc7565b6040516060810167ffffffffffffffff81118282101715610e1a57610e1a610dc7565b6040516101e0810167ffffffffffffffff81118282101715610e1a57610e1a610dc7565b604051601f8201601f1916810167ffffffffffffffff81118282101715610eb357610eb3610dc7565b604052919050565b600067ffffffffffffffff821115610ed557610ed5610dc7565b5060051b60200190565b600067ffffffffffffffff821115610ef957610ef9610dc7565b50601f01601f191660200190565b600082601f830112610f1857600080fd5b8135610f2b610f2682610edf565b610e8a565b818152846020838601011115610f4057600080fd5b816020850160208301376000918101602001919091529392505050565b6001600160a01b0381168114610f7257600080fd5b50565b8035610f8081610f5d565b919050565b803563ffffffff81168114610f8057600080fd5b67ffffffffffffffff81168114610f7257600080fd5b8035610f8081610f99565b80358015158114610f8057600080fd5b60006020808385031215610fdd57600080fd5b823567ffffffffffffffff80821115610ff557600080fd5b818501915085601f83011261100957600080fd5b8135611017610f2682610ebb565b81815260059190911b8301840190848101908883111561103657600080fd5b8585015b83811015611165578035858111156110525760008081fd5b86016101a0818c03601f190181131561106b5760008081fd5b611073610df6565b89830135888111156110855760008081fd5b6110938e8c83870101610f07565b82525060406110a3818501610f75565b8b83015260606110b4818601610f75565b82840152608091506110c7828601610f75565b9083015260a06110d8858201610f85565b8284015260c0915081850135818401525060e08085013582840152610100915081850135818401525061012061110f818601610faf565b828401526101409150611123828601610faf565b818401525061016080850135828401526101809150611143828601610f75565b90830152611152848401610fba565b908201528552505091860191860161103a565b5098975050505050505050565b602080825282518282018190526000919060409081850190868401855b828110156111c157815180516001600160a01b039081168652908701511686850152928401929085019060010161118f565b5091979650505050505050565b6000608082840312156111e057600080fd5b6040516080810181811067ffffffffffffffff8211171561120357611203610dc7565b604052905080823561121481610f5d565b8152602083013561122481610f5d565b8060208301525060408301356040820152606083013560608201525092915050565b60008060a0838503121561125957600080fd5b61126384846111ce565b915061127160808401610fba565b90509250929050565b60005b8381101561129557818101518382015260200161127d565b838111156112a4576000848401525b50505050565b600081518084526112c281602086016020860161127a565b601f01601f19169290920160200192915050565b6020815260006105ce60208301846112aa565b80516001600160a01b03168252602081015161131060208401826001600160a01b03169052565b50604081015161132b60408401826001600160a01b03169052565b50606081015161134660608401826001600160a01b03169052565b50608081015161136160808401826001600160a01b03169052565b5060a081015161137c60a08401826001600160a01b03169052565b5060c081015161139760c08401826001600160a01b03169052565b5060e08101516113b260e08401826001600160a01b03169052565b50610100818101516001600160a01b03908116918401919091526101208083015182169084015261014080830151821690840152610160808301518216908401526101808083015191821681850152906112a4565b6101a081016105d182846112e9565b60006020828403121561142857600080fd5b5035919050565b60006020828403121561144157600080fd5b813567ffffffffffffffff81111561145857600080fd5b8201610160818503121561146b57600080fd5b9392505050565b60006020828403121561148457600080fd5b813567ffffffffffffffff81111561149b57600080fd5b8201610240818503121561146b57600080fd5b81516001600160a01b031681526101e0810160208301516114da60208401826001600160a01b03169052565b5060408301516114f560408401826001600160a01b03169052565b50606083015161151060608401826001600160a01b03169052565b50608083015161152b60808401826001600160a01b03169052565b5060a083015161154660a08401826001600160a01b03169052565b5060c083015161156160c08401826001600160a01b03169052565b5060e083015161157c60e08401826001600160a01b03169052565b50610100838101516001600160a01b0390811691840191909152610120808501518216908401526101408085015182169084015261016080850151821690840152610180808501518216908401526101a0808501518216908401526101c09384015116929091019190915290565b600080600083850360e081121561160057600080fd5b61160a86866111ce565b935061161860808601610fba565b925060407fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff608201121561164a57600080fd5b50611653610e20565b60a085013561166181610f5d565b815260c085013561167181610f5d565b602082015292959194509192509050565b6000602080838503121561169557600080fd5b823567ffffffffffffffff8111156116ac57600080fd5b8301601f810185136116bd57600080fd5b80356116cb610f2682610ebb565b818152606091820283018401918482019190888411156116ea57600080fd5b938501935b838510156117465780858a0312156117075760008081fd5b61170f610e43565b853561171a81610f5d565b81528587013561172981610f5d565b8188015260408681013590820152835293840193918501916116ef565b50979650505050505050565b60006020808301818452808551808352604092508286019150828160051b87010184880160005b83811015611886577fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffc089840301855281516101a081518186526117be828701826112aa565b915050888201516117d98a8701826001600160a01b03169052565b50878201516001600160a01b03908116868a015260608084015182169087015260808084015163ffffffff169087015260a0808401519087015260c0808401519087015260e080840151908701526101008084015167ffffffffffffffff9081169188019190915261012080850151909116908701526101408084015190870152610160808401519091169086015261018091820151151591909401529386019390860190600101611779565b509098975050505050505050565b8051610f8081610f5d565b600060208083850312156118b257600080fd5b825167ffffffffffffffff8111156118c957600080fd5b8301601f810185136118da57600080fd5b80516118e8610f2682610ebb565b81815260069190911b8201830190838101908783111561190757600080fd5b928401925b8284101561195d57604084890312156119255760008081fd5b61192d610e20565b845161193881610f5d565b81528486015161194781610f5d565b818701528252604093909301929084019061190c565b979650505050505050565b60a081016119a482856001600160a01b038082511683528060208301511660208401525060408101516040830152606081015160608301525050565b82151560808301529392505050565b6000602082840312156119c557600080fd5b815167ffffffffffffffff8111156119dc57600080fd5b8201601f810184136119ed57600080fd5b80516119fb610f2682610edf565b818152856020838501011115611a1057600080fd5b611a2182602083016020860161127a565b95945050505050565b60006101a08284031215611a3d57600080fd5b611a45610df6565b9050611a5082611894565b8152611a5e60208301611894565b6020820152611a6f60408301611894565b6040820152611a8060608301611894565b6060820152611a9160808301611894565b6080820152611aa260a08301611894565b60a0820152611ab360c08301611894565b60c0820152611ac460e08301611894565b60e0820152610100611ad7818401611894565b90820152610120611ae9838201611894565b90820152610140611afb838201611894565b90820152610160611b0d838201611894565b90820152610180611b1f838201611894565b9082015292915050565b60006101a08284031215611b3c57600080fd5b6105ce8383611a2a565b600060208284031215611b5857600080fd5b815161146b81610f5d565b60008083357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe1843603018112611b9857600080fd5b830160208101925035905067ffffffffffffffff811115611bb857600080fd5b606081023603821315611bca57600080fd5b9250929050565b8183526000602080850194508260005b85811015611c30578135611bf481610f5d565b6001600160a01b0390811688528284013590611c0f82610f5d565b16878401526040828101359088015260609687019690910190600101611be1565b509495945050505050565b60208152611c4882610fba565b15156020820152602082013560408201526040820135606082015260006060830135611c7381610f5d565b6001600160a01b03808216608085015260808501359150611c9382610f5d565b80821660a0850152505060a083013560c083015260c083013560e083015261010060e084013581840152808401359050611ccc81610f99565b61012067ffffffffffffffff821681850152611ce9818601610faf565b915050610140611d048185018367ffffffffffffffff169052565b611d1081860186611b63565b6101608681015292509050611a2161018085018383611bd1565b8035611d3581610f5d565b6001600160a01b039081168352602082013590611d5182610f5d565b9081166020840152604082013590611d6882610f5d565b9081166040840152606082013590611d7f82610f5d565b9081166060840152608082013590611d9682610f5d565b908116608084015260a082013590611dad82610f5d565b80821660a085015250505050565b60008083357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe1843603018112611df057600080fd5b830160208101925035905067ffffffffffffffff811115611e1057600080fd5b803603821315611bca57600080fd5b818352818160208501375060006020828401015260006020601f19601f840116840101905092915050565b60608152611e5b6060820185611d2a565b6000611e6960c08601610f85565b610120611e7d8185018363ffffffff169052565b611e8960e08801610f85565b9150610140611e9f8186018463ffffffff169052565b610160925061010088013583860152611eba82890189611dbb565b92506102406101808181890152611ed66102a089018685611e1f565b9450611ee4848c018c611dbb565b945092506101a07fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffa089870301818a0152611f1f868686611e1f565b9550611f2c878d01610faf565b96506101c09450611f48858a018867ffffffffffffffff169052565b611f53828d01610f85565b96506101e09350611f6b848a018863ffffffff169052565b6102009650808c0135878a01525050610220838b013581890152828b013582890152611f98868c01610faf565b67ffffffffffffffff81166102608a01529550611fb6818c01610faf565b955050505050611fd361028085018367ffffffffffffffff169052565b6001600160a01b03861660208501529150611feb9050565b6001600160a01b0383166040830152610517565b60006101e0828403121561201257600080fd5b61201a610e66565b61202383611894565b815261203160208401611894565b602082015261204260408401611894565b604082015261205360608401611894565b606082015261206460808401611894565b608082015261207560a08401611894565b60a082015261208660c08401611894565b60c082015261209760e08401611894565b60e08201526101006120aa818501611894565b908201526101206120bc848201611894565b908201526101406120ce848201611894565b908201526101606120e0848201611894565b908201526101806120f2848201611894565b908201526101a0612104848201611894565b908201526101c0612116848201611894565b908201529392505050565b60e0810161215d82866001600160a01b038082511683528060208301511660208401525060408101516040830152606081015160608301525050565b83151560808301526001600160a01b038084511660a08401528060208501511660c084015250949350505050565b600081518084526020808501945080840160005b83811015611c3057815180516001600160a01b039081168952848201511684890152604090810151908801526060909601959082019060010161219f565b6020815260006105ce602083018461218b565b60006001600160a01b03808616835280851660208401525060606040830152611a21606083018461218b565b6000825161222e81846020870161127a565b919091019291505056fea164736f6c634300080f000a", + ABI: "[{\"type\":\"constructor\",\"inputs\":[{\"name\":\"_opcmGameTypeAdder\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerGameTypeAdder\"},{\"name\":\"_opcmDeployer\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerDeployer\"},{\"name\":\"_opcmUpgrader\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerUpgrader\"},{\"name\":\"_opcmInteropMigrator\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerInteropMigrator\"},{\"name\":\"_opcmStandardValidator\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerStandardValidator\"},{\"name\":\"_superchainConfig\",\"type\":\"address\",\"internalType\":\"contractISuperchainConfig\"},{\"name\":\"_protocolVersions\",\"type\":\"address\",\"internalType\":\"contractIProtocolVersions\"},{\"name\":\"_superchainProxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"_upgradeController\",\"type\":\"address\",\"internalType\":\"address\"}],\"stateMutability\":\"nonpayable\"},{\"type\":\"function\",\"name\":\"addGameType\",\"inputs\":[{\"name\":\"_gameConfigs\",\"type\":\"tuple[]\",\"internalType\":\"structOPContractsManager.AddGameInput[]\",\"components\":[{\"name\":\"saltMixer\",\"type\":\"string\",\"internalType\":\"string\"},{\"name\":\"systemConfig\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"delayedWETH\",\"type\":\"address\",\"internalType\":\"contractIDelayedWETH\"},{\"name\":\"disputeGameType\",\"type\":\"uint32\",\"internalType\":\"GameType\"},{\"name\":\"disputeAbsolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"Claim\"},{\"name\":\"disputeMaxGameDepth\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"disputeSplitDepth\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"disputeClockExtension\",\"type\":\"uint64\",\"internalType\":\"Duration\"},{\"name\":\"disputeMaxClockDuration\",\"type\":\"uint64\",\"internalType\":\"Duration\"},{\"name\":\"initialBond\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"vm\",\"type\":\"address\",\"internalType\":\"contractIBigStepper\"},{\"name\":\"permissioned\",\"type\":\"bool\",\"internalType\":\"bool\"}]}],\"outputs\":[{\"name\":\"\",\"type\":\"tuple[]\",\"internalType\":\"structOPContractsManager.AddGameOutput[]\",\"components\":[{\"name\":\"delayedWETH\",\"type\":\"address\",\"internalType\":\"contractIDelayedWETH\"},{\"name\":\"faultDisputeGame\",\"type\":\"address\",\"internalType\":\"contractIFaultDisputeGame\"}]}],\"stateMutability\":\"nonpayable\"},{\"type\":\"function\",\"name\":\"blueprints\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManager.Blueprints\",\"components\":[{\"name\":\"addressManager\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"proxy\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"l1ChugSplashProxy\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"resolvedDelegateProxy\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"permissionedDisputeGame1\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"permissionedDisputeGame2\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"permissionlessDisputeGame1\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"permissionlessDisputeGame2\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"superPermissionedDisputeGame1\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"superPermissionedDisputeGame2\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"superPermissionlessDisputeGame1\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"superPermissionlessDisputeGame2\",\"type\":\"address\",\"internalType\":\"address\"}]}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"chainIdToBatchInboxAddress\",\"inputs\":[{\"name\":\"_l2ChainId\",\"type\":\"uint256\",\"internalType\":\"uint256\"}],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"address\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"deploy\",\"inputs\":[{\"name\":\"_input\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManager.DeployInput\",\"components\":[{\"name\":\"roles\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManager.Roles\",\"components\":[{\"name\":\"opChainProxyAdminOwner\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"systemConfigOwner\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"batcher\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"unsafeBlockSigner\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"proposer\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"challenger\",\"type\":\"address\",\"internalType\":\"address\"}]},{\"name\":\"basefeeScalar\",\"type\":\"uint32\",\"internalType\":\"uint32\"},{\"name\":\"blobBasefeeScalar\",\"type\":\"uint32\",\"internalType\":\"uint32\"},{\"name\":\"l2ChainId\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"startingAnchorRoot\",\"type\":\"bytes\",\"internalType\":\"bytes\"},{\"name\":\"saltMixer\",\"type\":\"string\",\"internalType\":\"string\"},{\"name\":\"gasLimit\",\"type\":\"uint64\",\"internalType\":\"uint64\"},{\"name\":\"disputeGameType\",\"type\":\"uint32\",\"internalType\":\"GameType\"},{\"name\":\"disputeAbsolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"Claim\"},{\"name\":\"disputeMaxGameDepth\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"disputeSplitDepth\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"disputeClockExtension\",\"type\":\"uint64\",\"internalType\":\"Duration\"},{\"name\":\"disputeMaxClockDuration\",\"type\":\"uint64\",\"internalType\":\"Duration\"}]}],\"outputs\":[{\"name\":\"\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManager.DeployOutput\",\"components\":[{\"name\":\"opChainProxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"addressManager\",\"type\":\"address\",\"internalType\":\"contractIAddressManager\"},{\"name\":\"l1ERC721BridgeProxy\",\"type\":\"address\",\"internalType\":\"contractIL1ERC721Bridge\"},{\"name\":\"systemConfigProxy\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"optimismMintableERC20FactoryProxy\",\"type\":\"address\",\"internalType\":\"contractIOptimismMintableERC20Factory\"},{\"name\":\"l1StandardBridgeProxy\",\"type\":\"address\",\"internalType\":\"contractIL1StandardBridge\"},{\"name\":\"l1CrossDomainMessengerProxy\",\"type\":\"address\",\"internalType\":\"contractIL1CrossDomainMessenger\"},{\"name\":\"ethLockboxProxy\",\"type\":\"address\",\"internalType\":\"contractIETHLockbox\"},{\"name\":\"optimismPortalProxy\",\"type\":\"address\",\"internalType\":\"contractIOptimismPortal2\"},{\"name\":\"disputeGameFactoryProxy\",\"type\":\"address\",\"internalType\":\"contractIDisputeGameFactory\"},{\"name\":\"anchorStateRegistryProxy\",\"type\":\"address\",\"internalType\":\"contractIAnchorStateRegistry\"},{\"name\":\"faultDisputeGame\",\"type\":\"address\",\"internalType\":\"contractIFaultDisputeGame\"},{\"name\":\"permissionedDisputeGame\",\"type\":\"address\",\"internalType\":\"contractIPermissionedDisputeGame\"},{\"name\":\"delayedWETHPermissionedGameProxy\",\"type\":\"address\",\"internalType\":\"contractIDelayedWETH\"},{\"name\":\"delayedWETHPermissionlessGameProxy\",\"type\":\"address\",\"internalType\":\"contractIDelayedWETH\"}]}],\"stateMutability\":\"nonpayable\"},{\"type\":\"function\",\"name\":\"devFeatureBitmap\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"bytes32\",\"internalType\":\"bytes32\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"implementations\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManager.Implementations\",\"components\":[{\"name\":\"superchainConfigImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"protocolVersionsImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"l1ERC721BridgeImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"optimismPortalImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"optimismPortalInteropImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"ethLockboxImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"systemConfigImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"optimismMintableERC20FactoryImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"l1CrossDomainMessengerImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"l1StandardBridgeImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"disputeGameFactoryImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"anchorStateRegistryImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"delayedWETHImpl\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"mipsImpl\",\"type\":\"address\",\"internalType\":\"address\"}]}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"isDevFeatureEnabled\",\"inputs\":[{\"name\":\"_feature\",\"type\":\"bytes32\",\"internalType\":\"bytes32\"}],\"outputs\":[{\"name\":\"\",\"type\":\"bool\",\"internalType\":\"bool\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"migrate\",\"inputs\":[{\"name\":\"_input\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManagerInteropMigrator.MigrateInput\",\"components\":[{\"name\":\"usePermissionlessGame\",\"type\":\"bool\",\"internalType\":\"bool\"},{\"name\":\"startingAnchorRoot\",\"type\":\"tuple\",\"internalType\":\"structProposal\",\"components\":[{\"name\":\"root\",\"type\":\"bytes32\",\"internalType\":\"Hash\"},{\"name\":\"l2SequenceNumber\",\"type\":\"uint256\",\"internalType\":\"uint256\"}]},{\"name\":\"gameParameters\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManagerInteropMigrator.GameParameters\",\"components\":[{\"name\":\"proposer\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"challenger\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"maxGameDepth\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"splitDepth\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"initBond\",\"type\":\"uint256\",\"internalType\":\"uint256\"},{\"name\":\"clockExtension\",\"type\":\"uint64\",\"internalType\":\"Duration\"},{\"name\":\"maxClockDuration\",\"type\":\"uint64\",\"internalType\":\"Duration\"}]},{\"name\":\"opChainConfigs\",\"type\":\"tuple[]\",\"internalType\":\"structOPContractsManager.OpChainConfig[]\",\"components\":[{\"name\":\"systemConfigProxy\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"absolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"Claim\"}]}]}],\"outputs\":[],\"stateMutability\":\"nonpayable\"},{\"type\":\"function\",\"name\":\"opcmDeployer\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerDeployer\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"opcmGameTypeAdder\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerGameTypeAdder\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"opcmInteropMigrator\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerInteropMigrator\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"opcmStandardValidator\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerStandardValidator\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"opcmUpgrader\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractOPContractsManagerUpgrader\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"protocolVersions\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractIProtocolVersions\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"superchainConfig\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractISuperchainConfig\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"superchainProxyAdmin\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"updatePrestate\",\"inputs\":[{\"name\":\"_prestateUpdateInputs\",\"type\":\"tuple[]\",\"internalType\":\"structOPContractsManager.OpChainConfig[]\",\"components\":[{\"name\":\"systemConfigProxy\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"absolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"Claim\"}]}],\"outputs\":[],\"stateMutability\":\"nonpayable\"},{\"type\":\"function\",\"name\":\"upgrade\",\"inputs\":[{\"name\":\"_opChainConfigs\",\"type\":\"tuple[]\",\"internalType\":\"structOPContractsManager.OpChainConfig[]\",\"components\":[{\"name\":\"systemConfigProxy\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"absolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"Claim\"}]}],\"outputs\":[],\"stateMutability\":\"nonpayable\"},{\"type\":\"function\",\"name\":\"upgradeController\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"address\",\"internalType\":\"address\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"validate\",\"inputs\":[{\"name\":\"_input\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManagerStandardValidator.ValidationInput\",\"components\":[{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"sysCfg\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"absolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"bytes32\"},{\"name\":\"l2ChainID\",\"type\":\"uint256\",\"internalType\":\"uint256\"}]},{\"name\":\"_allowFailure\",\"type\":\"bool\",\"internalType\":\"bool\"}],\"outputs\":[{\"name\":\"\",\"type\":\"string\",\"internalType\":\"string\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"validateWithOverrides\",\"inputs\":[{\"name\":\"_input\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManagerStandardValidator.ValidationInput\",\"components\":[{\"name\":\"proxyAdmin\",\"type\":\"address\",\"internalType\":\"contractIProxyAdmin\"},{\"name\":\"sysCfg\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"},{\"name\":\"absolutePrestate\",\"type\":\"bytes32\",\"internalType\":\"bytes32\"},{\"name\":\"l2ChainID\",\"type\":\"uint256\",\"internalType\":\"uint256\"}]},{\"name\":\"_allowFailure\",\"type\":\"bool\",\"internalType\":\"bool\"},{\"name\":\"_overrides\",\"type\":\"tuple\",\"internalType\":\"structOPContractsManagerStandardValidator.ValidationOverrides\",\"components\":[{\"name\":\"l1PAOMultisig\",\"type\":\"address\",\"internalType\":\"address\"},{\"name\":\"challenger\",\"type\":\"address\",\"internalType\":\"address\"}]}],\"outputs\":[{\"name\":\"\",\"type\":\"string\",\"internalType\":\"string\"}],\"stateMutability\":\"view\"},{\"type\":\"function\",\"name\":\"version\",\"inputs\":[],\"outputs\":[{\"name\":\"\",\"type\":\"string\",\"internalType\":\"string\"}],\"stateMutability\":\"pure\"},{\"type\":\"error\",\"name\":\"AddressHasNoCode\",\"inputs\":[{\"name\":\"who\",\"type\":\"address\",\"internalType\":\"address\"}]},{\"type\":\"error\",\"name\":\"AddressNotFound\",\"inputs\":[{\"name\":\"who\",\"type\":\"address\",\"internalType\":\"address\"}]},{\"type\":\"error\",\"name\":\"AlreadyReleased\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"InvalidChainId\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"InvalidGameConfigs\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"InvalidRoleAddress\",\"inputs\":[{\"name\":\"role\",\"type\":\"string\",\"internalType\":\"string\"}]},{\"type\":\"error\",\"name\":\"InvalidStartingAnchorRoot\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"LatestReleaseNotSet\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"OnlyDelegatecall\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"PrestateNotSet\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"PrestateRequired\",\"inputs\":[]},{\"type\":\"error\",\"name\":\"SuperchainConfigMismatch\",\"inputs\":[{\"name\":\"systemConfig\",\"type\":\"address\",\"internalType\":\"contractISystemConfig\"}]},{\"type\":\"error\",\"name\":\"SuperchainProxyAdminMismatch\",\"inputs\":[]}]", + Bin: "0x6101c06040523480156200001257600080fd5b5060405162002b4b38038062002b4b833981016040819052620000359162000313565b60405163b6a4cd2160e01b81526001600160a01b03858116600483015289169063b6a4cd219060240160006040518083038186803b1580156200007757600080fd5b505afa1580156200008c573d6000803e3d6000fd5b505060405163b6a4cd2160e01b81526001600160a01b0386811660048301528b16925063b6a4cd21915060240160006040518083038186803b158015620000d257600080fd5b505afa158015620000e7573d6000803e3d6000fd5b505060405163b6a4cd2160e01b81526001600160a01b038c811660048301528b16925063b6a4cd21915060240160006040518083038186803b1580156200012d57600080fd5b505afa15801562000142573d6000803e3d6000fd5b505060405163b6a4cd2160e01b81526001600160a01b038b1660048201819052925063b6a4cd21915060240160006040518083038186803b1580156200018757600080fd5b505afa1580156200019c573d6000803e3d6000fd5b505060405163b6a4cd2160e01b81526001600160a01b038a811660048301528b16925063b6a4cd21915060240160006040518083038186803b158015620001e257600080fd5b505afa158015620001f7573d6000803e3d6000fd5b505060405163b6a4cd2160e01b81526001600160a01b0389811660048301528b16925063b6a4cd21915060240160006040518083038186803b1580156200023d57600080fd5b505afa15801562000252573d6000803e3d6000fd5b505060405163b6a4cd2160e01b81526001600160a01b0388811660048301528b16925063b6a4cd21915060240160006040518083038186803b1580156200029857600080fd5b505afa158015620002ad573d6000803e3d6000fd5b5050506001600160a01b03998a166080525096881660a05294871660c05292861660e052908516610100528416610120528316610140528216610160523061018052166101a052620003ea565b6001600160a01b03811681146200031057600080fd5b50565b60008060008060008060008060006101208a8c0312156200033357600080fd5b89516200034081620002fa565b60208b01519099506200035381620002fa565b60408b01519098506200036681620002fa565b60608b01519097506200037981620002fa565b60808b01519096506200038c81620002fa565b60a08b01519095506200039f81620002fa565b60c08b0151909450620003b281620002fa565b60e08b0151909350620003c581620002fa565b6101008b0151909250620003d981620002fa565b809150509295985092959850929598565b60805160a05160c05160e05161010051610120516101405161016051610180516101a051612667620004e460003960006103b501526000818161046c0152818161086301528181610bf90152610dde01526000818161022d0152610e5b0152600061035801526000818161029c01528181610a2b0152610e3a015260008181610404015281816106370152610acc0152600081816101d0015261092d01526000818161018c0152610eec0152600081816103310152818161057f0152818161072d015281816107e0015281816109f401528181610b7c0152610d5301526000818161042b015281816105380152610cc301526126676000f3fe608060405234801561001057600080fd5b50600436106101825760003560e01c8063613e827b116100d857806387543ef61161008c578063ba7903db11610066578063ba7903db146103ff578063becbdf4a14610426578063ff2dd5a11461044d57600080fd5b806387543ef6146103b05780639a72745b146103d7578063b51f9c2b146103ea57600080fd5b80636624856a116100bd5780636624856a1461035357806367cda69c1461037a57806378ecabce1461038d57600080fd5b8063613e827b1461030c578063622d56f11461032c57600080fd5b806330d148881161013a57806335e80ab31161011457806335e80ab3146102975780633fe13f3f146102be57806354fd4d50146102d357600080fd5b806330d148881461024f57806330e9012c1461026f578063318b1b801461028457600080fd5b80631661a2e91161016b5780631661a2e9146101f25780631d8a4e92146102125780632b96b8391461022857600080fd5b806303dbe68c146101875780631481a724146101cb575b600080fd5b6101ae7f000000000000000000000000000000000000000000000000000000000000000081565b6040516001600160a01b0390911681526020015b60405180910390f35b6101ae7f000000000000000000000000000000000000000000000000000000000000000081565b6102056102003660046111ac565b610460565b6040516101c29190611354565b61021a61057b565b6040519081526020016101c2565b6101ae7f000000000000000000000000000000000000000000000000000000000000000081565b61026261025d366004611428565b610604565b6040516101c291906114bc565b6102776106ba565b6040516101c291906114cf565b6101ae610292366004611603565b6107ae565b6101ae7f000000000000000000000000000000000000000000000000000000000000000081565b6102d16102cc36600461161c565b610859565b005b60408051808201909152600581527f332e312e300000000000000000000000000000000000000000000000000000006020820152610262565b61031f61031a366004611658565b610957565b6040516101c29190611694565b6101ae7f000000000000000000000000000000000000000000000000000000000000000081565b6101ae7f000000000000000000000000000000000000000000000000000000000000000081565b6102626103883660046117d1565b610a99565b6103a061039b366004611603565b610b4a565b60405190151581526020016101c2565b6101ae7f000000000000000000000000000000000000000000000000000000000000000081565b6102d16103e536600461186b565b610bef565b6103f2610ce8565b6040516101c2919061193b565b6101ae7f000000000000000000000000000000000000000000000000000000000000000081565b6101ae7f000000000000000000000000000000000000000000000000000000000000000081565b6102d161045b36600461186b565b610dd4565b60606001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001630036104c4576040517f0a57d61d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6000826040516024016104d79190611a5e565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f1661a2e9000000000000000000000000000000000000000000000000000000001790529050600061055d7f000000000000000000000000000000000000000000000000000000000000000083610f0d565b9050808060200190518101906105739190611bab565b949350505050565b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316631d8a4e926040518163ffffffff1660e01b8152600401602060405180830381865afa1580156105db573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906105ff9190611c74565b905090565b6040517f30d148880000000000000000000000000000000000000000000000000000000081526060906001600160a01b037f000000000000000000000000000000000000000000000000000000000000000016906330d148889061066e9086908690600401611c8d565b600060405180830381865afa15801561068b573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f191682016040526106b39190810190611cd8565b9392505050565b604080516101c081018252600080825260208201819052918101829052606081018290526080810182905260a0810182905260c0810182905260e08101829052610100810182905261012081018290526101408101829052610160810182905261018081018290526101a08101919091527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166330e9012c6040518163ffffffff1660e01b81526004016101c060405180830381865afa15801561078a573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906105ff9190611d4f565b6040517f318b1b80000000000000000000000000000000000000000000000000000000008152600481018290526000907f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03169063318b1b8090602401602060405180830381865afa15801561082f573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906108539190611e5f565b92915050565b6001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001630036108bb576040517f0a57d61d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b6000816040516024016108ce9190611f54565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f3fe13f3f0000000000000000000000000000000000000000000000000000000017905290506109527f000000000000000000000000000000000000000000000000000000000000000082610f0d565b505050565b604080516101e081018252600080825260208201819052818301819052606082018190526080820181905260a0820181905260c0820181905260e08201819052610100820181905261012082018190526101408201819052610160820181905261018082018190526101a082018190526101c082015290517fb2e48a3f0000000000000000000000000000000000000000000000000000000081527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03169063b2e48a3f90610a559085907f0000000000000000000000000000000000000000000000000000000000000000903390600401612167565b6101e0604051808303816000875af1158015610a75573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610853919061231c565b6040517f67cda69c0000000000000000000000000000000000000000000000000000000081526060906001600160a01b037f000000000000000000000000000000000000000000000000000000000000000016906367cda69c90610b0590879087908790600401612433565b600060405180830381865afa158015610b22573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f191682016040526105739190810190611cd8565b6040517f78ecabce000000000000000000000000000000000000000000000000000000008152600481018290526000907f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316906378ecabce90602401602060405180830381865afa158015610bcb573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610853919061249d565b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000163003610c51576040517f0a57d61d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b600081604051602401610c64919061250c565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f9a72745b0000000000000000000000000000000000000000000000000000000017905290506109527f000000000000000000000000000000000000000000000000000000000000000082610f0d565b604080516101a081018252600080825260208201819052918101829052606081018290526080810182905260a0810182905260c0810182905260e0810182905261010081018290526101208101829052610140810182905261016081018290526101808101919091527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663b51f9c2b6040518163ffffffff1660e01b81526004016101a060405180830381865afa158015610db0573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906105ff919061251f565b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000163003610e36576040517f0a57d61d00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b60007f00000000000000000000000000000000000000000000000000000000000000007f000000000000000000000000000000000000000000000000000000000000000083604051602401610e8d93929190612612565b60408051601f198184030181529190526020810180517bffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f8a196cd40000000000000000000000000000000000000000000000000000000017905290506109527f0000000000000000000000000000000000000000000000000000000000000000825b6060600080846001600160a01b031684604051610f2a919061263e565b600060405180830381855af49150503d8060008114610f65576040519150601f19603f3d011682016040523d82523d6000602084013e610f6a565b606091505b50915091508161057357805160208201fd5b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b6040516101a0810167ffffffffffffffff81118282101715610fcf57610fcf610f7c565b60405290565b6040805190810167ffffffffffffffff81118282101715610fcf57610fcf610f7c565b6040516060810167ffffffffffffffff81118282101715610fcf57610fcf610f7c565b6040516101c0810167ffffffffffffffff81118282101715610fcf57610fcf610f7c565b6040516101e0810167ffffffffffffffff81118282101715610fcf57610fcf610f7c565b604051601f8201601f1916810167ffffffffffffffff8111828210171561108c5761108c610f7c565b604052919050565b600067ffffffffffffffff8211156110ae576110ae610f7c565b5060051b60200190565b600067ffffffffffffffff8211156110d2576110d2610f7c565b50601f01601f191660200190565b600082601f8301126110f157600080fd5b81356111046110ff826110b8565b611063565b81815284602083860101111561111957600080fd5b816020850160208301376000918101602001919091529392505050565b6001600160a01b038116811461114b57600080fd5b50565b803561115981611136565b919050565b803563ffffffff8116811461115957600080fd5b67ffffffffffffffff8116811461114b57600080fd5b803561115981611172565b801515811461114b57600080fd5b803561115981611193565b600060208083850312156111bf57600080fd5b823567ffffffffffffffff808211156111d757600080fd5b818501915085601f8301126111eb57600080fd5b81356111f96110ff82611094565b81815260059190911b8301840190848101908883111561121857600080fd5b8585015b83811015611347578035858111156112345760008081fd5b86016101a0818c03601f190181131561124d5760008081fd5b611255610fab565b89830135888111156112675760008081fd5b6112758e8c838701016110e0565b825250604061128581850161114e565b8b830152606061129681860161114e565b82840152608091506112a982860161114e565b9083015260a06112ba85820161115e565b8284015260c0915081850135818401525060e0808501358284015261010091508185013581840152506101206112f1818601611188565b828401526101409150611305828601611188565b81840152506101608085013582840152610180915061132582860161114e565b908301526113348484016111a1565b908201528552505091860191860161121c565b5098975050505050505050565b602080825282518282018190526000919060409081850190868401855b828110156113a357815180516001600160a01b0390811686529087015116868501529284019290850190600101611371565b5091979650505050505050565b6000608082840312156113c257600080fd5b6040516080810181811067ffffffffffffffff821117156113e5576113e5610f7c565b60405290508082356113f681611136565b8152602083013561140681611136565b8060208301525060408301356040820152606083013560608201525092915050565b60008060a0838503121561143b57600080fd5b61144584846113b0565b9150608083013561145581611193565b809150509250929050565b60005b8381101561147b578181015183820152602001611463565b8381111561148a576000848401525b50505050565b600081518084526114a8816020860160208601611460565b601f01601f19169290920160200192915050565b6020815260006106b36020830184611490565b81516001600160a01b031681526101c0810160208301516114fb60208401826001600160a01b03169052565b50604083015161151660408401826001600160a01b03169052565b50606083015161153160608401826001600160a01b03169052565b50608083015161154c60808401826001600160a01b03169052565b5060a083015161156760a08401826001600160a01b03169052565b5060c083015161158260c08401826001600160a01b03169052565b5060e083015161159d60e08401826001600160a01b03169052565b50610100838101516001600160a01b0390811691840191909152610120808501518216908401526101408085015182169084015261016080850151821690840152610180808501518216908401526101a08085015191821681850152905b505092915050565b60006020828403121561161557600080fd5b5035919050565b60006020828403121561162e57600080fd5b813567ffffffffffffffff81111561164557600080fd5b820161016081850312156106b357600080fd5b60006020828403121561166a57600080fd5b813567ffffffffffffffff81111561168157600080fd5b820161024081850312156106b357600080fd5b81516001600160a01b031681526101e0810160208301516116c060208401826001600160a01b03169052565b5060408301516116db60408401826001600160a01b03169052565b5060608301516116f660608401826001600160a01b03169052565b50608083015161171160808401826001600160a01b03169052565b5060a083015161172c60a08401826001600160a01b03169052565b5060c083015161174760c08401826001600160a01b03169052565b5060e083015161176260e08401826001600160a01b03169052565b50610100838101516001600160a01b0390811691840191909152610120808501518216908401526101408085015182169084015261016080850151821690840152610180808501518216908401526101a0808501518216908401526101c08085015191821681850152906115fb565b600080600083850360e08112156117e757600080fd5b6117f186866113b0565b9350608085013561180181611193565b925060407fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff608201121561183357600080fd5b5061183c610fd5565b60a085013561184a81611136565b815260c085013561185a81611136565b602082015292959194509192509050565b6000602080838503121561187e57600080fd5b823567ffffffffffffffff81111561189557600080fd5b8301601f810185136118a657600080fd5b80356118b46110ff82611094565b818152606091820283018401918482019190888411156118d357600080fd5b938501935b8385101561192f5780858a0312156118f05760008081fd5b6118f8610ff8565b853561190381611136565b81528587013561191281611136565b8188015260408681013590820152835293840193918501916118d8565b50979650505050505050565b81516001600160a01b031681526101a08101602083015161196760208401826001600160a01b03169052565b50604083015161198260408401826001600160a01b03169052565b50606083015161199d60608401826001600160a01b03169052565b5060808301516119b860808401826001600160a01b03169052565b5060a08301516119d360a08401826001600160a01b03169052565b5060c08301516119ee60c08401826001600160a01b03169052565b5060e0830151611a0960e08401826001600160a01b03169052565b50610100838101516001600160a01b03908116918401919091526101208085015182169084015261014080850151821690840152610160808501518216908401526101808085015191821681850152906115fb565b60006020808301818452808551808352604092508286019150828160051b87010184880160005b83811015611b92577fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffc089840301855281516101a08151818652611aca82870182611490565b91505088820151611ae58a8701826001600160a01b03169052565b50878201516001600160a01b03908116868a015260608084015182169087015260808084015163ffffffff169087015260a0808401519087015260c0808401519087015260e080840151908701526101008084015167ffffffffffffffff9081169188019190915261012080850151909116908701526101408084015190870152610160808401519091169086015261018091820151151591909401529386019390860190600101611a85565b509098975050505050505050565b805161115981611136565b60006020808385031215611bbe57600080fd5b825167ffffffffffffffff811115611bd557600080fd5b8301601f81018513611be657600080fd5b8051611bf46110ff82611094565b81815260069190911b82018301908381019087831115611c1357600080fd5b928401925b82841015611c695760408489031215611c315760008081fd5b611c39610fd5565b8451611c4481611136565b815284860151611c5381611136565b8187015282526040939093019290840190611c18565b979650505050505050565b600060208284031215611c8657600080fd5b5051919050565b60a08101611cc982856001600160a01b038082511683528060208301511660208401525060408101516040830152606081015160608301525050565b82151560808301529392505050565b600060208284031215611cea57600080fd5b815167ffffffffffffffff811115611d0157600080fd5b8201601f81018413611d1257600080fd5b8051611d206110ff826110b8565b818152856020838501011115611d3557600080fd5b611d46826020830160208601611460565b95945050505050565b60006101c08284031215611d6257600080fd5b611d6a61101b565b611d7383611ba0565b8152611d8160208401611ba0565b6020820152611d9260408401611ba0565b6040820152611da360608401611ba0565b6060820152611db460808401611ba0565b6080820152611dc560a08401611ba0565b60a0820152611dd660c08401611ba0565b60c0820152611de760e08401611ba0565b60e0820152610100611dfa818501611ba0565b90820152610120611e0c848201611ba0565b90820152610140611e1e848201611ba0565b90820152610160611e30848201611ba0565b90820152610180611e42848201611ba0565b908201526101a0611e54848201611ba0565b908201529392505050565b600060208284031215611e7157600080fd5b81516106b381611136565b60008083357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe1843603018112611eb157600080fd5b830160208101925035905067ffffffffffffffff811115611ed157600080fd5b606081023603821315611ee357600080fd5b9250929050565b8183526000602080850194508260005b85811015611f49578135611f0d81611136565b6001600160a01b0390811688528284013590611f2882611136565b16878401526040828101359088015260609687019690910190600101611efa565b509495945050505050565b6020815260008235611f6581611193565b80151560208401525060208301356040830152604083013560608301526060830135611f9081611136565b6001600160a01b03808216608085015260808501359150611fb082611136565b80821660a0850152505060a083013560c083015260c083013560e083015261010060e084013581840152808401359050611fe981611172565b61012067ffffffffffffffff821681850152612006818601611188565b9150506101406120218185018367ffffffffffffffff169052565b61202d81860186611e7c565b6101608681015292509050611d4661018085018383611eea565b803561205281611136565b6001600160a01b03908116835260208201359061206e82611136565b908116602084015260408201359061208582611136565b908116604084015260608201359061209c82611136565b90811660608401526080820135906120b382611136565b908116608084015260a0820135906120ca82611136565b80821660a085015250505050565b60008083357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe184360301811261210d57600080fd5b830160208101925035905067ffffffffffffffff81111561212d57600080fd5b803603821315611ee357600080fd5b818352818160208501375060006020828401015260006020601f19601f840116840101905092915050565b606081526121786060820185612047565b600061218660c0860161115e565b61012061219a8185018363ffffffff169052565b6121a660e0880161115e565b91506101406121bc8186018463ffffffff169052565b6101609250610100880135838601526121d7828901896120d8565b925061024061018081818901526121f36102a08901868561213c565b9450612201848c018c6120d8565b945092506101a07fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffa089870301818a015261223c86868661213c565b9550612249878d01611188565b96506101c09450612265858a018867ffffffffffffffff169052565b612270828d0161115e565b96506101e09350612288848a018863ffffffff169052565b6102009650808c0135878a01525050610220838b013581890152828b0135828901526122b5868c01611188565b67ffffffffffffffff81166102608a015295506122d3818c01611188565b9550505050506122f061028085018367ffffffffffffffff169052565b6001600160a01b038616602085015291506123089050565b6001600160a01b0383166040830152610573565b60006101e0828403121561232f57600080fd5b61233761103f565b61234083611ba0565b815261234e60208401611ba0565b602082015261235f60408401611ba0565b604082015261237060608401611ba0565b606082015261238160808401611ba0565b608082015261239260a08401611ba0565b60a08201526123a360c08401611ba0565b60c08201526123b460e08401611ba0565b60e08201526101006123c7818501611ba0565b908201526101206123d9848201611ba0565b908201526101406123eb848201611ba0565b908201526101606123fd848201611ba0565b9082015261018061240f848201611ba0565b908201526101a0612421848201611ba0565b908201526101c0611e54848201611ba0565b60e0810161246f82866001600160a01b038082511683528060208301511660208401525060408101516040830152606081015160608301525050565b83151560808301526001600160a01b038084511660a08401528060208501511660c084015250949350505050565b6000602082840312156124af57600080fd5b81516106b381611193565b600081518084526020808501945080840160005b83811015611f4957815180516001600160a01b03908116895284820151168489015260409081015190880152606090960195908201906001016124ce565b6020815260006106b360208301846124ba565b60006101a0828403121561253257600080fd5b61253a610fab565b61254383611ba0565b815261255160208401611ba0565b602082015261256260408401611ba0565b604082015261257360608401611ba0565b606082015261258460808401611ba0565b608082015261259560a08401611ba0565b60a08201526125a660c08401611ba0565b60c08201526125b760e08401611ba0565b60e08201526101006125ca818501611ba0565b908201526101206125dc848201611ba0565b908201526101406125ee848201611ba0565b90820152610160612600848201611ba0565b90820152610180611e54848201611ba0565b60006001600160a01b03808616835280851660208401525060606040830152611d4660608301846124ba565b60008251612650818460208701611460565b919091019291505056fea164736f6c634300080f000a", } // OPContractsManagerABI is the input ABI used to generate the binding from. @@ -413,9 +414,40 @@ func (_OPContractsManager *OPContractsManagerCallerSession) ChainIdToBatchInboxA return _OPContractsManager.Contract.ChainIdToBatchInboxAddress(&_OPContractsManager.CallOpts, _l2ChainId) } +// DevFeatureBitmap is a free data retrieval call binding the contract method 0x1d8a4e92. +// +// Solidity: function devFeatureBitmap() view returns(bytes32) +func (_OPContractsManager *OPContractsManagerCaller) DevFeatureBitmap(opts *bind.CallOpts) ([32]byte, error) { + var out []interface{} + err := _OPContractsManager.contract.Call(opts, &out, "devFeatureBitmap") + + if err != nil { + return *new([32]byte), err + } + + out0 := *abi.ConvertType(out[0], new([32]byte)).(*[32]byte) + + return out0, err + +} + +// DevFeatureBitmap is a free data retrieval call binding the contract method 0x1d8a4e92. +// +// Solidity: function devFeatureBitmap() view returns(bytes32) +func (_OPContractsManager *OPContractsManagerSession) DevFeatureBitmap() ([32]byte, error) { + return _OPContractsManager.Contract.DevFeatureBitmap(&_OPContractsManager.CallOpts) +} + +// DevFeatureBitmap is a free data retrieval call binding the contract method 0x1d8a4e92. +// +// Solidity: function devFeatureBitmap() view returns(bytes32) +func (_OPContractsManager *OPContractsManagerCallerSession) DevFeatureBitmap() ([32]byte, error) { + return _OPContractsManager.Contract.DevFeatureBitmap(&_OPContractsManager.CallOpts) +} + // Implementations is a free data retrieval call binding the contract method 0x30e9012c. // -// Solidity: function implementations() view returns((address,address,address,address,address,address,address,address,address,address,address,address,address)) +// Solidity: function implementations() view returns((address,address,address,address,address,address,address,address,address,address,address,address,address,address)) func (_OPContractsManager *OPContractsManagerCaller) Implementations(opts *bind.CallOpts) (OPContractsManagerImplementations, error) { var out []interface{} err := _OPContractsManager.contract.Call(opts, &out, "implementations") @@ -432,18 +464,49 @@ func (_OPContractsManager *OPContractsManagerCaller) Implementations(opts *bind. // Implementations is a free data retrieval call binding the contract method 0x30e9012c. // -// Solidity: function implementations() view returns((address,address,address,address,address,address,address,address,address,address,address,address,address)) +// Solidity: function implementations() view returns((address,address,address,address,address,address,address,address,address,address,address,address,address,address)) func (_OPContractsManager *OPContractsManagerSession) Implementations() (OPContractsManagerImplementations, error) { return _OPContractsManager.Contract.Implementations(&_OPContractsManager.CallOpts) } // Implementations is a free data retrieval call binding the contract method 0x30e9012c. // -// Solidity: function implementations() view returns((address,address,address,address,address,address,address,address,address,address,address,address,address)) +// Solidity: function implementations() view returns((address,address,address,address,address,address,address,address,address,address,address,address,address,address)) func (_OPContractsManager *OPContractsManagerCallerSession) Implementations() (OPContractsManagerImplementations, error) { return _OPContractsManager.Contract.Implementations(&_OPContractsManager.CallOpts) } +// IsDevFeatureEnabled is a free data retrieval call binding the contract method 0x78ecabce. +// +// Solidity: function isDevFeatureEnabled(bytes32 _feature) view returns(bool) +func (_OPContractsManager *OPContractsManagerCaller) IsDevFeatureEnabled(opts *bind.CallOpts, _feature [32]byte) (bool, error) { + var out []interface{} + err := _OPContractsManager.contract.Call(opts, &out, "isDevFeatureEnabled", _feature) + + if err != nil { + return *new(bool), err + } + + out0 := *abi.ConvertType(out[0], new(bool)).(*bool) + + return out0, err + +} + +// IsDevFeatureEnabled is a free data retrieval call binding the contract method 0x78ecabce. +// +// Solidity: function isDevFeatureEnabled(bytes32 _feature) view returns(bool) +func (_OPContractsManager *OPContractsManagerSession) IsDevFeatureEnabled(_feature [32]byte) (bool, error) { + return _OPContractsManager.Contract.IsDevFeatureEnabled(&_OPContractsManager.CallOpts, _feature) +} + +// IsDevFeatureEnabled is a free data retrieval call binding the contract method 0x78ecabce. +// +// Solidity: function isDevFeatureEnabled(bytes32 _feature) view returns(bool) +func (_OPContractsManager *OPContractsManagerCallerSession) IsDevFeatureEnabled(_feature [32]byte) (bool, error) { + return _OPContractsManager.Contract.IsDevFeatureEnabled(&_OPContractsManager.CallOpts, _feature) +} + // OpcmDeployer is a free data retrieval call binding the contract method 0x622d56f1. // // Solidity: function opcmDeployer() view returns(address) diff --git a/op-e2e/config/init.go b/op-e2e/config/init.go index 04aa0fd6209..c2b4c8b5086 100644 --- a/op-e2e/config/init.go +++ b/op-e2e/config/init.go @@ -16,6 +16,7 @@ import ( "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/artifacts" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/inspect" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/pipeline" + "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/standard" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/state" "github.com/ethereum-optimism/optimism/op-node/rollup" "github.com/ethereum/go-ethereum/common" @@ -209,6 +210,7 @@ func initAllocType(root string, allocType AllocType) { allocModes := []genesis.L2AllocsMode{ genesis.L2AllocsInterop, + genesis.L2AllocsJovian, genesis.L2AllocsIsthmus, genesis.L2AllocsHolocene, genesis.L2AllocsGranite, @@ -250,6 +252,7 @@ func initAllocType(root string, allocType AllocType) { "l2GenesisGraniteTimeOffset": nil, "l2GenesisHoloceneTimeOffset": nil, "l2GenesisIsthmusTimeOffset": nil, + "l2GenesisJovianTimeOffset": nil, } upgradeSchedule := new(genesis.UpgradeScheduleDeployConfig) @@ -359,7 +362,7 @@ func defaultIntent(root string, loc *artifacts.Locator, deployer common.Address, "gasPriceOracleOverhead": 2100, "gasPriceOracleScalar": 1000000, "gasPriceOracleBaseFeeScalar": 1368, - "gasPriceOracleBlobBaseFeeScalar": 810949, + "gasPriceOracleBlobBaseFeeScalar": 801949, "gasPriceOracleOperatorFeeScalar": 0, "gasPriceOracleOperatorFeeConstant": 0, "l1CancunTimeOffset": "0x0", @@ -386,6 +389,7 @@ func defaultIntent(root string, loc *artifacts.Locator, deployer common.Address, Eip1559Denominator: 250, Eip1559DenominatorCanyon: 250, Eip1559Elasticity: 6, + GasLimit: standard.GasLimit, Roles: state.ChainRoles{ // Use deployer as L1PAO to deploy additional dispute impls L1ProxyAdminOwner: deployer, diff --git a/op-e2e/e2eutils/challenger/helper.go b/op-e2e/e2eutils/challenger/helper.go index fbe61f691a5..82f61a490cc 100644 --- a/op-e2e/e2eutils/challenger/helper.go +++ b/op-e2e/e2eutils/challenger/helper.go @@ -92,6 +92,18 @@ func WithPollInterval(pollInterval time.Duration) Option { } } +func WithResponseDelay(responseDelay time.Duration) Option { + return func(c *config.Config) { + c.ResponseDelay = responseDelay + } +} + +func WithResponseDelayAfter(responseDelayAfter uint64) Option { + return func(c *config.Config) { + c.ResponseDelayAfter = responseDelayAfter + } +} + func WithValidPrestateRequired() Option { return func(c *config.Config) { c.AllowInvalidPrestate = false diff --git a/op-e2e/e2eutils/intentbuilder/builder.go b/op-e2e/e2eutils/intentbuilder/builder.go index 88482bbc11a..448cb72e1c4 100644 --- a/op-e2e/e2eutils/intentbuilder/builder.go +++ b/op-e2e/e2eutils/intentbuilder/builder.go @@ -194,6 +194,7 @@ func (b *intentBuilder) WithL2(l2ChainID eth.ChainID) (Builder, L2Configurator) Eip1559DenominatorCanyon: standard.Eip1559DenominatorCanyon, Eip1559Denominator: standard.Eip1559Denominator, Eip1559Elasticity: standard.Eip1559Elasticity, + GasLimit: standard.GasLimit, DeployOverrides: make(map[string]any), } b.intent.Chains = append(b.intent.Chains, chainIntent) diff --git a/op-e2e/e2eutils/intentbuilder/builder_test.go b/op-e2e/e2eutils/intentbuilder/builder_test.go index eeffb15a14d..ecf7e19d307 100644 --- a/op-e2e/e2eutils/intentbuilder/builder_test.go +++ b/op-e2e/e2eutils/intentbuilder/builder_test.go @@ -13,6 +13,7 @@ import ( "github.com/ethereum-optimism/optimism/op-chain-ops/addresses" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/artifacts" + "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/standard" "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/state" "github.com/ethereum-optimism/optimism/op-node/rollup" "github.com/ethereum-optimism/optimism/op-service/eth" @@ -157,6 +158,7 @@ func TestBuilder(t *testing.T) { Eip1559DenominatorCanyon: 250, Eip1559Denominator: 50, Eip1559Elasticity: 10, + GasLimit: standard.GasLimit, OperatorFeeScalar: 100, OperatorFeeConstant: 200, DeployOverrides: map[string]any{ diff --git a/op-e2e/faultproofs/response_delay_test.go b/op-e2e/faultproofs/response_delay_test.go new file mode 100644 index 00000000000..2e809345aca --- /dev/null +++ b/op-e2e/faultproofs/response_delay_test.go @@ -0,0 +1,130 @@ +package faultproofs + +import ( + "context" + "testing" + "time" + + op_e2e "github.com/ethereum-optimism/optimism/op-e2e" + "github.com/ethereum-optimism/optimism/op-e2e/e2eutils/challenger" + "github.com/ethereum-optimism/optimism/op-e2e/e2eutils/disputegame" + "github.com/ethereum/go-ethereum/common" + "github.com/stretchr/testify/require" +) + +// TestChallengerResponseDelay tests that the challenger respects the configured response delay +// This is a sanity check integration test that verifies minimum delay timing is honored +func TestChallengerResponseDelay(t *testing.T) { + op_e2e.InitParallel(t) + + // Test with different delay configurations + testCases := []struct { + name string + delay time.Duration + minTime time.Duration // Minimum expected time for challenger response + }{ + { + name: "NoDelay", + delay: 0, + minTime: 0, // No minimum delay expected + }, + { + name: "ShortDelay", + delay: 2 * time.Second, + minTime: 2 * time.Second, // Must take at least the configured delay + }, + { + name: "MediumDelay", + delay: 5 * time.Second, + minTime: 5 * time.Second, // Must take at least the configured delay + }, + } + + for _, tc := range testCases { + tc := tc // capture loop variable + t.Run(tc.name, func(t *testing.T) { + ctx := context.Background() + sys, _ := StartFaultDisputeSystem(t) + t.Cleanup(sys.Close) + + // Create a dispute game with incorrect root to trigger challenger response + disputeGameFactory := disputegame.NewFactoryHelper(t, ctx, sys) + game := disputeGameFactory.StartOutputAlphabetGame(ctx, "sequencer", 1, common.Hash{0xaa, 0xbb, 0xcc}) + + // Make an invalid claim that the honest challenger should counter + invalidClaim := game.RootClaim(ctx) + + // Record time before starting challenger + startTime := time.Now() + + // Start challenger with response delay + game.StartChallenger(ctx, "sequencer", "DelayedChallenger", + challenger.WithAlphabet(), + challenger.WithPrivKey(sys.Cfg.Secrets.Alice), + challenger.WithResponseDelay(tc.delay), + challenger.WithPollInterval(100*time.Millisecond), // Fast polling to ensure delay isn't from polling + ) + + // Wait for challenger to respond to the invalid root claim + counterClaim := invalidClaim.WaitForCounterClaim(ctx) + responseTime := time.Since(startTime) + + // Sanity check: verify minimum delay is respected (includes polling time and system overhead) + require.GreaterOrEqualf(t, responseTime, tc.minTime, + "Challenger responded too quickly (expected >= %v, got %v)", tc.minTime, responseTime) + + // Verify the counter claim is valid (challenger actually responded correctly) + require.NotNil(t, counterClaim, "Challenger should have posted a counter claim") + counterClaim.RequireCorrectOutputRoot(ctx) + }) + } +} + +// TestChallengerResponseDelayWithMultipleActions tests that delay applies to each individual action +func TestChallengerResponseDelayWithMultipleActions(t *testing.T) { + op_e2e.InitParallel(t) + + if testing.Short() { + t.Skip("Skipping multi-action test during short run") + } + + ctx := context.Background() + sys, _ := StartFaultDisputeSystem(t) + t.Cleanup(sys.Close) + + responseDelay := 2 * time.Second + + disputeGameFactory := disputegame.NewFactoryHelper(t, ctx, sys) + game := disputeGameFactory.StartOutputAlphabetGame(ctx, "sequencer", 1, common.Hash{0xaa, 0xbb, 0xcc}) + + // Start challenger with response delay + game.StartChallenger(ctx, "sequencer", "DelayedChallenger", + challenger.WithAlphabet(), + challenger.WithPrivKey(sys.Cfg.Secrets.Alice), + challenger.WithResponseDelay(responseDelay), + challenger.WithPollInterval(100*time.Millisecond), + ) + + // Track multiple challenger responses and their timing + var responseTimes []time.Duration + + // First response to root claim + claim := game.RootClaim(ctx) + startTime := time.Now() + claim = claim.WaitForCounterClaim(ctx) + responseTimes = append(responseTimes, time.Since(startTime)) + + // Second response - attack the challenger's claim to trigger another response + startTime = time.Now() + claim = claim.Attack(ctx, common.Hash{0x01}) + claim.WaitForCounterClaim(ctx) + responseTimes = append(responseTimes, time.Since(startTime)) + + // Sanity check: verify each response took at least the minimum delay + for i, responseTime := range responseTimes { + require.GreaterOrEqualf(t, responseTime, responseDelay, + "Response %d was too fast (expected >= %v, got %v)", i+1, responseDelay, responseTime) + } + + require.Len(t, responseTimes, 2, "Should have measured 2 response times") +} diff --git a/op-e2e/faultproofs/util.go b/op-e2e/faultproofs/util.go index 2654ef5b050..31e76cb3b0e 100644 --- a/op-e2e/faultproofs/util.go +++ b/op-e2e/faultproofs/util.go @@ -3,6 +3,9 @@ package faultproofs import ( "crypto/ecdsa" "fmt" + "os" + "strconv" + "sync" "testing" op_e2e "github.com/ethereum-optimism/optimism/op-e2e" @@ -60,6 +63,8 @@ func WithLatestFork() faultDisputeConfigOpts { cfg.DeployConfig.L2GenesisGraniteTimeOffset = &genesisActivation cfg.DeployConfig.L2GenesisHoloceneTimeOffset = &genesisActivation cfg.DeployConfig.L2GenesisIsthmusTimeOffset = &genesisActivation + // TODO(#17348): Jovian is not supported in op-e2e tests yet + //cfg.DeployConfig.L2GenesisJovianTimeOffset = &genesisActivation }) } } @@ -190,8 +195,49 @@ func RunTestsAcrossVmTypes[T any](t *testing.T, testCases []T, test VMTestCase[T testName := options.testNameModifier(string(allocType), testCase) t.Run(testName, func(t *testing.T) { op_e2e.InitParallel(t, op_e2e.UsesCannon) - test(t, allocType, testCase) + func() { + limiter.Acquire() + defer limiter.Release() + test(t, allocType, testCase) + }() }) } } } + +var executorLimitEnv = os.Getenv("OP_E2E_EXECUTOR_LIMIT") + +type executorLimiter struct { + ch chan struct{} +} + +func (l *executorLimiter) Acquire() { + // TODO: sample memory usage over time to admit more tests and reduce total runtime. + initExecutorLimiter() + l.ch <- struct{}{} +} + +func (l *executorLimiter) Release() { + <-l.ch +} + +var limiter executorLimiter +var limiterOnce sync.Once + +func initExecutorLimiter() { + limiterOnce.Do(func() { + var executorLimit uint64 + if executorLimitEnv != "" { + var err error + executorLimit, err = strconv.ParseUint(executorLimitEnv, 10, 0) + if err != nil { + panic(fmt.Sprintf("Could not parse OP_E2E_EXECUTOR_LIMIT env var %v: %v", executorLimitEnv, err)) + } + } else { + // faultproof tests may use 1 GiB of memory. So let's be very conservative and aggressively limit the number of test executions + // considering other processes running on the same machine. + executorLimit = 16 + } + limiter = executorLimiter{ch: make(chan struct{}, executorLimit)} + }) +} diff --git a/op-e2e/system/conductor/system_adminrpc_test.go b/op-e2e/system/conductor/system_adminrpc_test.go index 25bfd6e4f59..eebcdd6b54d 100644 --- a/op-e2e/system/conductor/system_adminrpc_test.go +++ b/op-e2e/system/conductor/system_adminrpc_test.go @@ -182,7 +182,8 @@ func TestLoadSequencerStateOnStarted_Started(t *testing.T) { func TestPostUnsafePayload(t *testing.T) { op_e2e.InitParallel(t) - ctx := context.Background() + ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second) + defer cancel() cfg := e2esys.DefaultSystemConfig(t) cfg.Nodes["verifier"].RPC.EnableAdmin = true diff --git a/op-e2e/system/proofs/system_fpp_test.go b/op-e2e/system/proofs/system_fpp_test.go index e21fbcff4a7..dd275ddf751 100644 --- a/op-e2e/system/proofs/system_fpp_test.go +++ b/op-e2e/system/proofs/system_fpp_test.go @@ -79,6 +79,8 @@ func applySpanBatchActivation(active bool, dp *genesis.DeployConfig) { dp.L2GenesisFjordTimeOffset = nil dp.L2GenesisGraniteTimeOffset = nil dp.L2GenesisHoloceneTimeOffset = nil + dp.L2GenesisIsthmusTimeOffset = nil + dp.L2GenesisJovianTimeOffset = nil } } diff --git a/op-node/README.md b/op-node/README.md index d18e8521775..4729ef3aeaa 100644 --- a/op-node/README.md +++ b/op-node/README.md @@ -51,8 +51,8 @@ just op-node --l1=ws://localhost:8546 \ --l1.beacon=http://localhost:4000 \ --l2=ws://localhost:9001 \ - --p2p.listen.tcp=9222 - --p2p.listen.udp=9222 + --p2p.listen.tcp=9222 \ + --p2p.listen.udp=9222 \ --rpc.port=7000 \ --syncmode=execution-layer diff --git a/op-node/flags/flags.go b/op-node/flags/flags.go index d7b8ece67a1..e032e14c439 100644 --- a/op-node/flags/flags.go +++ b/op-node/flags/flags.go @@ -171,7 +171,7 @@ var ( L1CacheSize = &cli.UintFlag{ Name: "l1.cache-size", Usage: "Cache size for blocks, receipts and transactions. " + - "If this flag is set to 0, 2/3 of the sequencing window size is used (usually 2400). " + + "If this flag is set to 0, 3/2 of the sequencing window size is used (usually 2400). " + "The default value of 900 (~3h of L1 blocks) is good for (high-throughput) networks that see frequent safe head increments. " + "On (low-throughput) networks with infrequent safe head increments, it is recommended to set this value to 0, " + "or a value that well covers the typical span between safe head increments. " + diff --git a/op-node/node/node.go b/op-node/node/node.go index 0e09fca50af..b3fbb0f0cfd 100644 --- a/op-node/node/node.go +++ b/op-node/node/node.go @@ -194,7 +194,7 @@ func (n *OpNode) initL1Source(ctx context.Context, cfg *config.Config) error { return fmt.Errorf("failed to create L1 source: %w", err) } - if err := cfg.Rollup.ValidateL1Config(ctx, n.l1Source); err != nil { + if err := cfg.Rollup.ValidateL1Config(ctx, n.log, n.l1Source); err != nil { return fmt.Errorf("failed to validate the L1 config: %w", err) } @@ -211,7 +211,7 @@ func (n *OpNode) initL1Handlers(cfg *config.Config) error { if n.cfg.Tracer != nil { n.cfg.Tracer.OnNewL1Head(ctx, sig) } - n.l2Driver.L1Tracker.OnL1Unsafe(sig) + n.l2Driver.SyncDeriver.L1Tracker.OnL1Unsafe(sig) n.l2Driver.StatusTracker.OnL1Unsafe(sig) n.l2Driver.SyncDeriver.OnL1Unsafe(ctx) } @@ -462,6 +462,14 @@ func (n *OpNode) initL2(ctx context.Context, cfg *config.Config) error { n.l2Driver = driver.NewDriver(n.eventSys, n.eventDrain, &cfg.Driver, &cfg.Rollup, cfg.DependencySet, n.l2Source, n.l1Source, n.beacon, n, n, n.log, n.metrics, cfg.ConfigPersistence, n.safeDB, &cfg.Sync, sequencerConductor, altDA, indexingMode) + + // Wire up IndexingMode to engine controller for direct procedure call + if n.interopSys != nil { + if indexingMode, ok := n.interopSys.(*indexing.IndexingMode); ok { + indexingMode.SetEngineController(n.l2Driver.SyncDeriver.Engine) + } + } + return nil } @@ -479,7 +487,7 @@ func (n *OpNode) initRPCServer(cfg *config.Config) error { if cfg.ExperimentalOPStackAPI { server.AddAPI(rpc.API{ Namespace: "opstack", - Service: NewOpstackAPI(n.l2Driver.Engine, n), + Service: NewOpstackAPI(n.l2Driver.SyncDeriver.Engine, n), }) n.log.Info("Experimental OP stack API enabled") } diff --git a/op-node/rollup/attributes/attributes.go b/op-node/rollup/attributes/attributes.go index 4b08d67ad37..2dc5c32254d 100644 --- a/op-node/rollup/attributes/attributes.go +++ b/op-node/rollup/attributes/attributes.go @@ -26,6 +26,7 @@ type EngineController interface { TryUpdateLocalSafe(ctx context.Context, ref eth.L2BlockRef, concluding bool, source eth.L1BlockRef) // RequestForkchoiceUpdate requests a forkchoice update RequestForkchoiceUpdate(ctx context.Context) + RequestPendingSafeUpdate(ctx context.Context) } type L2 interface { @@ -69,6 +70,17 @@ func (eq *AttributesHandler) AttachEmitter(em event.Emitter) { eq.emitter = em } +func (eq *AttributesHandler) forceResetLocked() { + eq.sentAttributes = false + eq.attributes = nil +} + +func (eq *AttributesHandler) ForceReset(ctx context.Context, localUnsafe, crossUnsafe, localSafe, crossSafe, finalized eth.L2BlockRef) { + eq.mu.Lock() + defer eq.mu.Unlock() + eq.forceResetLocked() +} + func (eq *AttributesHandler) OnEvent(ctx context.Context, ev event.Event) bool { // Events may be concurrent in the future. Prevent unsafe concurrent modifications to the attributes. eq.mu.Lock() @@ -82,10 +94,9 @@ func (eq *AttributesHandler) OnEvent(ctx context.Context, ev event.Event) bool { eq.sentAttributes = false eq.emitter.Emit(ctx, derive.ConfirmReceivedAttributesEvent{}) // to make sure we have a pre-state signal to process the attributes from - eq.emitter.Emit(ctx, engine.PendingSafeRequestEvent{}) - case rollup.ResetEvent, rollup.ForceResetEvent: - eq.sentAttributes = false - eq.attributes = nil + eq.engineController.RequestPendingSafeUpdate(ctx) + case rollup.ResetEvent: + eq.forceResetLocked() case rollup.EngineTemporaryErrorEvent: eq.sentAttributes = false case engine.InvalidPayloadAttributesEvent: @@ -98,7 +109,7 @@ func (eq *AttributesHandler) OnEvent(ctx context.Context, ev event.Event) bool { eq.attributes = nil // Time to re-evaluate without attributes. // (the pending-safe state will then be forwarded to our source of attributes). - eq.emitter.Emit(ctx, engine.PendingSafeRequestEvent{}) + eq.engineController.RequestPendingSafeUpdate(ctx) case engine.PayloadSealExpiredErrorEvent: if x.DerivedFrom == (eth.L1BlockRef{}) { return true // from sequencing @@ -115,7 +126,7 @@ func (eq *AttributesHandler) OnEvent(ctx context.Context, ev event.Event) bool { "build_id", x.Info.ID, "timestamp", x.Info.Timestamp, "err", x.Err) eq.sentAttributes = false eq.attributes = nil - eq.emitter.Emit(ctx, engine.PendingSafeRequestEvent{}) + eq.engineController.RequestPendingSafeUpdate(ctx) default: return false } diff --git a/op-node/rollup/attributes/attributes_test.go b/op-node/rollup/attributes/attributes_test.go index 632f46d5063..48ef35b2dbb 100644 --- a/op-node/rollup/attributes/attributes_test.go +++ b/op-node/rollup/attributes/attributes_test.go @@ -175,17 +175,19 @@ func TestAttributesHandler(t *testing.T) { ah.AttachEmitter(emitter) emitter.ExpectOnce(derive.ConfirmReceivedAttributesEvent{}) - emitter.ExpectOnce(engine.PendingSafeRequestEvent{}) + engDeriver.On("RequestPendingSafeUpdate", context.Background()).Once() ah.OnEvent(context.Background(), derive.DerivedAttributesEvent{ Attributes: attrA1, }) + engDeriver.AssertExpectations(t) emitter.AssertExpectations(t) require.NotNil(t, ah.attributes, "queue the invalid attributes") - emitter.ExpectOnce(engine.PendingSafeRequestEvent{}) + engDeriver.On("RequestPendingSafeUpdate", context.Background()).Once() ah.OnEvent(context.Background(), engine.InvalidPayloadAttributesEvent{ Attributes: attrA1, }) + engDeriver.AssertExpectations(t) emitter.AssertExpectations(t) require.Nil(t, ah.attributes, "drop the invalid attributes") }) @@ -198,10 +200,11 @@ func TestAttributesHandler(t *testing.T) { ah.AttachEmitter(emitter) emitter.ExpectOnce(derive.ConfirmReceivedAttributesEvent{}) - emitter.ExpectOnce(engine.PendingSafeRequestEvent{}) + engDeriver.On("RequestPendingSafeUpdate", context.Background()).Once() ah.OnEvent(context.Background(), derive.DerivedAttributesEvent{ Attributes: attrA1, }) + engDeriver.AssertExpectations(t) emitter.AssertExpectations(t) require.NotNil(t, ah.attributes) // New attributes will have to get generated after processing the last ones @@ -224,10 +227,11 @@ func TestAttributesHandler(t *testing.T) { ah.AttachEmitter(emitter) emitter.ExpectOnce(derive.ConfirmReceivedAttributesEvent{}) - emitter.ExpectOnce(engine.PendingSafeRequestEvent{}) + engDeriver.On("RequestPendingSafeUpdate", context.Background()).Once() ah.OnEvent(context.Background(), derive.DerivedAttributesEvent{ Attributes: attrA1, }) + engDeriver.AssertExpectations(t) emitter.AssertExpectations(t) require.NotNil(t, ah.attributes) @@ -252,8 +256,9 @@ func TestAttributesHandler(t *testing.T) { // attrA1Alt does not match block A1, so will cause force-reorg. emitter.ExpectOnce(derive.ConfirmReceivedAttributesEvent{}) - emitter.ExpectOnce(engine.PendingSafeRequestEvent{}) + engDeriver.On("RequestPendingSafeUpdate", context.Background()).Once() ah.OnEvent(context.Background(), derive.DerivedAttributesEvent{Attributes: attrA1Alt}) + engDeriver.AssertExpectations(t) emitter.AssertExpectations(t) require.NotNil(t, ah.attributes, "queued up derived attributes") @@ -295,8 +300,9 @@ func TestAttributesHandler(t *testing.T) { DerivedFrom: refB, } emitter.ExpectOnce(derive.ConfirmReceivedAttributesEvent{}) - emitter.ExpectOnce(engine.PendingSafeRequestEvent{}) + engDeriver.On("RequestPendingSafeUpdate", context.Background()).Once() ah.OnEvent(context.Background(), derive.DerivedAttributesEvent{Attributes: attr}) + engDeriver.AssertExpectations(t) emitter.AssertExpectations(t) require.NotNil(t, ah.attributes, "queued up derived attributes") @@ -344,8 +350,9 @@ func TestAttributesHandler(t *testing.T) { ah.AttachEmitter(emitter) emitter.ExpectOnce(derive.ConfirmReceivedAttributesEvent{}) - emitter.ExpectOnce(engine.PendingSafeRequestEvent{}) + engDeriver.On("RequestPendingSafeUpdate", context.Background()).Once() ah.OnEvent(context.Background(), derive.DerivedAttributesEvent{Attributes: attrA1Alt}) + engDeriver.AssertExpectations(t) emitter.AssertExpectations(t) require.NotNil(t, ah.attributes, "queued up derived attributes") diff --git a/op-node/rollup/attributes/engine_consolidate.go b/op-node/rollup/attributes/engine_consolidate.go index 19a2b2aea8f..ce359746114 100644 --- a/op-node/rollup/attributes/engine_consolidate.go +++ b/op-node/rollup/attributes/engine_consolidate.go @@ -10,7 +10,6 @@ import ( "github.com/ethereum/go-ethereum/consensus/misc/eip1559" "github.com/ethereum/go-ethereum/core/types" "github.com/ethereum/go-ethereum/log" - "github.com/ethereum/go-ethereum/params" "github.com/ethereum-optimism/optimism/op-node/rollup" "github.com/ethereum-optimism/optimism/op-node/rollup/derive" @@ -75,7 +74,7 @@ func AttributesMatchBlock(rollupCfg *rollup.Config, attrs *eth.PayloadAttributes if attrs.SuggestedFeeRecipient != block.FeeRecipient { return fmt.Errorf("fee recipient data does not match, expected %s but got %s", block.FeeRecipient, attrs.SuggestedFeeRecipient) } - if err := checkEIP1559ParamsMatch(rollupCfg.ChainOpConfig, attrs.EIP1559Params, block.ExtraData); err != nil { + if err := checkExtraDataParamsMatch(rollupCfg, uint64(block.Timestamp), attrs.EIP1559Params, attrs.MinBaseFee, block.ExtraData); err != nil { return err } @@ -96,8 +95,8 @@ func checkParentBeaconBlockRootMatch(attrRoot, blockRoot *common.Hash) error { } return nil } +func checkExtraDataParamsMatch(cfg *rollup.Config, blockTimestamp uint64, attrParams *eth.Bytes8, attrMinBaseFee *uint64, blockExtraData []byte) error { -func checkEIP1559ParamsMatch(opCfg *params.OptimismConfig, attrParams *eth.Bytes8, blockExtraData []byte) error { // Note that we can assume that the attributes' eip1559params are non-nil iff Holocene is active // according to the local rollup config. if attrParams != nil { @@ -109,10 +108,6 @@ func checkEIP1559ParamsMatch(opCfg *params.OptimismConfig, attrParams *eth.Bytes if err := eip1559.ValidateHolocene1559Params(params); err != nil { // This would be a critical error, because the attributes are generated by derivation and must be valid. return fmt.Errorf("invalid attributes EIP1559 parameters: %w", err) - } else if err := eip1559.ValidateHoloceneExtraData(blockExtraData); err != nil { - // This can happen if the unsafe chain contains invalid (in particular, empty) extraData while Holocene - // is active. The extraData field of blocks from sequencer gossip isn't currently checked during import. - return fmt.Errorf("invalid block extraData: %w", err) } ad, ae := eip1559.DecodeHolocene1559Params(params) @@ -120,12 +115,18 @@ func checkEIP1559ParamsMatch(opCfg *params.OptimismConfig, attrParams *eth.Bytes // Translate 0,0 to the pre-Holocene protocol constants, like the EL does too. if ad == 0 { // If attrParams are non-nil, Holocene, and so Canyon, must be active. - ad = *opCfg.EIP1559DenominatorCanyon - ae = opCfg.EIP1559Elasticity + ad = *cfg.ChainOpConfig.EIP1559DenominatorCanyon + ae = cfg.ChainOpConfig.EIP1559Elasticity translated = true } - bd, be := eip1559.DecodeHoloceneExtraData(blockExtraData) + // Decode block parameters and check for mismatch + err := eip1559.ValidateOptimismExtraData(cfg, blockTimestamp, blockExtraData) + if err != nil { + return fmt.Errorf("invalid block extraData: %w", err) + } + bd, be, bm := eip1559.DecodeOptimismExtraData(cfg, blockTimestamp, blockExtraData) + if ad != bd || ae != be { extraErr := "" if translated { @@ -133,6 +134,9 @@ func checkEIP1559ParamsMatch(opCfg *params.OptimismConfig, attrParams *eth.Bytes } return fmt.Errorf("eip1559 parameters do not match, attributes: %d, %d%s, block: %d, %d", ad, ae, extraErr, bd, be) } + if bm == nil && attrMinBaseFee != nil || bm != nil && attrMinBaseFee == nil || bm != nil && attrMinBaseFee != nil && *bm != *attrMinBaseFee { + return fmt.Errorf("minBaseFee does not match, attributes: %d, block: %d", attrMinBaseFee, bm) + } } else if len(blockExtraData) > 0 { // When deriving pre-Holocene blocks, the extraData must be empty. return fmt.Errorf("nil EIP1559Params in attributes but non-nil extraData in block: %v", blockExtraData) @@ -162,7 +166,7 @@ func checkWithdrawals(rollupCfg *rollup.Config, attrs *eth.PayloadAttributes, bl return fmt.Errorf("%w: attributes", ErrCanyonMustHaveWithdrawals) } if !isIsthmus { - // canyon: the withdrawals root should be set to the empty value + // canyon: the withdrawals root should be set to the empty withdrawals hash if block.WithdrawalsRoot != nil && *block.WithdrawalsRoot != types.EmptyWithdrawalsHash { return fmt.Errorf("%w: got %v", ErrCanyonWithdrawalsRoot, *block.WithdrawalsRoot) } diff --git a/op-node/rollup/attributes/engine_consolidate_test.go b/op-node/rollup/attributes/engine_consolidate_test.go index ad1af4ce65b..2f9cef28a70 100644 --- a/op-node/rollup/attributes/engine_consolidate_test.go +++ b/op-node/rollup/attributes/engine_consolidate_test.go @@ -36,7 +36,7 @@ type matchArgs struct { parentHash common.Hash } -func holoceneArgs() matchArgs { +func jovianArgs() matchArgs { var ( validParentHash = common.HexToHash("0x123") validTimestamp = eth.Uint64Quantity(50) @@ -46,24 +46,29 @@ func holoceneArgs() matchArgs { validFeeRecipient = predeploys.SequencerFeeVaultAddr validTx = testutils.RandomLegacyTxNotProtected(rand.New(rand.NewSource(42))) validTxData, _ = validTx.MarshalBinary() + minBaseFee = uint64(1e9) - validHoloceneExtraData = eth.BytesMax32(eip1559.EncodeHoloceneExtraData( - *defaultOpConfig.EIP1559DenominatorCanyon, defaultOpConfig.EIP1559Elasticity)) - validHoloceneEIP1559Params = new(eth.Bytes8) + validJovianExtraData = eth.BytesMax32(eip1559.EncodeJovianExtraData( + *defaultOpConfig.EIP1559DenominatorCanyon, defaultOpConfig.EIP1559Elasticity, minBaseFee)) + validJovianEIP1559Params = new(eth.Bytes8) ) + // Populate the EIP1559 params with the encoded values + copy((*validJovianEIP1559Params)[:], eip1559.EncodeHolocene1559Params( + *defaultOpConfig.EIP1559DenominatorCanyon, defaultOpConfig.EIP1559Elasticity)) return matchArgs{ envelope: ð.ExecutionPayloadEnvelope{ ParentBeaconBlockRoot: &validParentBeaconRoot, ExecutionPayload: ð.ExecutionPayload{ - ParentHash: validParentHash, - Timestamp: validTimestamp, - PrevRandao: validPrevRandao, - GasLimit: validGasLimit, - Transactions: []eth.Data{validTxData}, - Withdrawals: &types.Withdrawals{}, - FeeRecipient: validFeeRecipient, - ExtraData: validHoloceneExtraData, + ParentHash: validParentHash, + Timestamp: validTimestamp, + PrevRandao: validPrevRandao, + GasLimit: validGasLimit, + Transactions: []eth.Data{validTxData}, + Withdrawals: &types.Withdrawals{}, + FeeRecipient: validFeeRecipient, + ExtraData: validJovianExtraData, + WithdrawalsRoot: &types.EmptyWithdrawalsHash, }, }, attrs: ð.PayloadAttributes{ @@ -74,12 +79,41 @@ func holoceneArgs() matchArgs { Transactions: []eth.Data{validTxData}, Withdrawals: &types.Withdrawals{}, SuggestedFeeRecipient: validFeeRecipient, - EIP1559Params: validHoloceneEIP1559Params, + EIP1559Params: validJovianEIP1559Params, + MinBaseFee: &minBaseFee, }, parentHash: validParentHash, } } +func jovianArgsMinBaseFeeMissingFromAttributes() matchArgs { + args := jovianArgs() + args.attrs.MinBaseFee = nil + return args +} + +func jovianArgsMinBaseFeeMissingFromBlock() matchArgs { + args := jovianArgs() + args.envelope.ExecutionPayload.ExtraData = eth.BytesMax32(eip1559.EncodeHoloceneExtraData( + *defaultOpConfig.EIP1559DenominatorCanyon, defaultOpConfig.EIP1559Elasticity)) // Note use of HoloceneExtraData instead of JovianExtraData + return args +} + +func jovianArgsInconsistentMinBaseFee() matchArgs { + args := jovianArgs() + args.attrs.MinBaseFee = ptr(uint64(2e9)) + return args +} + +func holoceneArgs() matchArgs { + args := jovianArgs() + args.envelope.ExecutionPayload.ExtraData = eth.BytesMax32(eip1559.EncodeHoloceneExtraData( + *defaultOpConfig.EIP1559DenominatorCanyon, defaultOpConfig.EIP1559Elasticity)) + args.attrs.EIP1559Params = new(eth.Bytes8) + args.attrs.MinBaseFee = nil + return args +} + func ecotoneArgs() matchArgs { args := holoceneArgs() args.attrs.EIP1559Params = nil @@ -184,12 +218,11 @@ func createMismatchedEIP1559Params() matchArgs { } func TestAttributesMatch(t *testing.T) { - // default valid timestamp is 50 - pastTime := uint64(0) - futureTime := uint64(100) - - rollupCfgPreCanyon := &rollup.Config{CanyonTime: &futureTime, ChainOpConfig: defaultOpConfig} - rollupCfgPreIsthmus := &rollup.Config{CanyonTime: &pastTime, IsthmusTime: &futureTime, ChainOpConfig: defaultOpConfig} + cfg := func(fork rollup.ForkName) *rollup.Config { + cfg := &rollup.Config{ChainOpConfig: defaultOpConfig} + cfg.ActivateAtGenesis(fork) + return cfg + } tests := []struct { args matchArgs @@ -199,106 +232,129 @@ func TestAttributesMatch(t *testing.T) { }{ { args: bedrockArgs(), - rollupCfg: rollupCfgPreCanyon, + rollupCfg: cfg(rollup.Bedrock), desc: "validBedrockArgs", }, { args: bedrockArgs(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Canyon), err: ErrCanyonMustHaveWithdrawals.Error() + ": block", desc: "bedrockArgsPostCanyon", }, { args: canyonArgs(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Canyon), desc: "validCanyonArgs", }, { args: ecotoneArgs(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Ecotone), desc: "validEcotoneArgs", }, { args: holoceneArgs(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Holocene), desc: "validholoceneArgs", }, + { + args: jovianArgs(), + rollupCfg: cfg(rollup.Jovian), + desc: "validJovianArgs", + }, { args: mismatchedParentHashArgs(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Holocene), err: "parent hash field does not match", desc: "mismatchedParentHashArgs", }, { args: createMismatchedTimestamp(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Holocene), err: "timestamp field does not match", desc: "createMismatchedTimestamp", }, { args: createMismatchedPrevRandao(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Holocene), err: "random field does not match", desc: "createMismatchedPrevRandao", }, { args: createMismatchedTransactions(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Holocene), err: "transaction count does not match", desc: "createMismatchedTransactions", }, { args: ecotoneNoParentBeaconBlockRoot(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Holocene), err: "expected non-nil parent beacon block root", desc: "ecotoneNoParentBeaconBlockRoot", }, { args: ecotoneUnexpectedParentBeaconBlockRoot(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Holocene), err: "expected nil parent beacon block root but got non-nil", desc: "ecotoneUnexpectedParentBeaconBlockRoot", }, { args: ecotoneMismatchParentBeaconBlockRoot(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Ecotone), err: "parent beacon block root does not match", desc: "ecotoneMismatchParentBeaconBlockRoot", }, { args: ecotoneMismatchParentBeaconBlockRootPtr(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Ecotone), desc: "ecotoneMismatchParentBeaconBlockRootPtr", }, { args: ecotoneNilParentBeaconBlockRoots(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Ecotone), desc: "ecotoneNilParentBeaconBlockRoots", }, { args: createMismatchedGasLimit(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Holocene), err: "gas limit does not match", desc: "createMismatchedGasLimit", }, { args: createNilGasLimit(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Holocene), err: "expected gaslimit in attributes to not be nil", desc: "createNilGasLimit", }, { args: createMismatchedFeeRecipient(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Holocene), err: "fee recipient data does not match", desc: "createMismatchedFeeRecipient", }, { args: createMismatchedEIP1559Params(), - rollupCfg: rollupCfgPreIsthmus, + rollupCfg: cfg(rollup.Holocene), err: "eip1559 parameters do not match", desc: "createMismatchedEIP1559Params", }, + { + args: jovianArgsMinBaseFeeMissingFromAttributes(), + rollupCfg: cfg(rollup.Jovian), + err: "minBaseFee does not match", + desc: "missingMinBaseFee", + }, + { + args: jovianArgsMinBaseFeeMissingFromBlock(), + rollupCfg: cfg(rollup.Jovian), + err: "invalid block extraData: jovian extraData should be 17 bytes, got 9", + desc: "missingMinBaseFee", + }, + { + args: jovianArgsInconsistentMinBaseFee(), + rollupCfg: cfg(rollup.Jovian), + err: "minBaseFee does not match", + desc: "inconsistentMinBaseFee", + }, } for _, test := range tests { @@ -530,7 +586,7 @@ func TestCheckEIP1559ParamsMatch(t *testing.T) { desc: "err-invalid-extra", attrParams: ¶ms, blockExtraData: append(eth.BytesMax32{42}, params[:]...), - err: "invalid block extraData: holocene extraData should have 0 version byte, got 42", + err: "invalid block extraData: holocene extraData version byte should be 0, got 42", }, { desc: "err-no-match", @@ -545,7 +601,15 @@ func TestCheckEIP1559ParamsMatch(t *testing.T) { }, } { t.Run(test.desc, func(t *testing.T) { - err := checkEIP1559ParamsMatch(defaultOpConfig, test.attrParams, test.blockExtraData) + pastTime := uint64(0) + futureTime := uint64(3) + cfg := &rollup.Config{ + CanyonTime: &pastTime, + HoloceneTime: &pastTime, + IsthmusTime: &pastTime, + JovianTime: &futureTime, + ChainOpConfig: defaultOpConfig} + err := checkExtraDataParamsMatch(cfg, uint64(2), test.attrParams, nil, test.blockExtraData) if test.err == "" { require.NoError(t, err) } else { diff --git a/op-node/rollup/attributes/testutils.go b/op-node/rollup/attributes/testutils.go index f1a3e8d4b1c..bd6542c70df 100644 --- a/op-node/rollup/attributes/testutils.go +++ b/op-node/rollup/attributes/testutils.go @@ -24,3 +24,7 @@ func (m *MockEngineController) TryUpdateLocalSafe(ctx context.Context, ref eth.L func (m *MockEngineController) RequestForkchoiceUpdate(ctx context.Context) { m.Mock.MethodCalled("RequestForkchoiceUpdate", ctx) } + +func (m *MockEngineController) RequestPendingSafeUpdate(ctx context.Context) { + m.Mock.MethodCalled("RequestPendingSafeUpdate", ctx) +} diff --git a/op-node/rollup/chain_spec.go b/op-node/rollup/chain_spec.go index b152c2ef2ff..8e62b1b6808 100644 --- a/op-node/rollup/chain_spec.go +++ b/op-node/rollup/chain_spec.go @@ -123,6 +123,11 @@ func (s *ChainSpec) IsIsthmus(t uint64) bool { return s.config.IsIsthmus(t) } +// IsJovian returns true if t >= jovian_time +func (s *ChainSpec) IsJovian(t uint64) bool { + return s.config.IsJovian(t) +} + // MaxChannelBankSize returns the maximum number of bytes the can allocated inside the channel bank // before pruning occurs at the given timestamp. func (s *ChainSpec) MaxChannelBankSize(t uint64) uint64 { diff --git a/op-node/rollup/clsync/clsync_test.go b/op-node/rollup/clsync/clsync_test.go index 97e5a7e818a..5243a479bdc 100644 --- a/op-node/rollup/clsync/clsync_test.go +++ b/op-node/rollup/clsync/clsync_test.go @@ -29,6 +29,8 @@ func (f *fakeEngController) TryUpdatePendingSafe(ctx context.Context, ref eth.L2 } func (f *fakeEngController) TryUpdateLocalSafe(ctx context.Context, ref eth.L2BlockRef, concluding bool, source eth.L1BlockRef) { } +func (f *fakeEngController) RequestPendingSafeUpdate(ctx context.Context) { +} func TestCLSync_InvalidPayloadDropsHead(t *testing.T) { logger := testlog.Logger(t, 0) diff --git a/op-node/rollup/derive/attributes.go b/op-node/rollup/derive/attributes.go index 54fa6a45703..ca97fd3021c 100644 --- a/op-node/rollup/derive/attributes.go +++ b/op-node/rollup/derive/attributes.go @@ -198,6 +198,9 @@ func (ba *FetchingAttributesBuilder) PreparePayloadAttributes(ctx context.Contex r.EIP1559Params = new(eth.Bytes8) *r.EIP1559Params = sysConfig.EIP1559Params } - + if ba.rollupCfg.IsJovian(nextL2Time) { + zero := uint64(0) + r.MinBaseFee = &zero // TODO: replace with sysConfig.MinBaseFee + } return r, nil } diff --git a/op-node/rollup/derive/deriver.go b/op-node/rollup/derive/deriver.go index a76802b31a3..042b7a9e4a7 100644 --- a/op-node/rollup/derive/deriver.go +++ b/op-node/rollup/derive/deriver.go @@ -121,10 +121,12 @@ func (d *PipelineDeriver) AttachEmitter(em event.Emitter) { d.emitter = em } +func (d *PipelineDeriver) ResetPipeline() { + d.pipeline.Reset() +} + func (d *PipelineDeriver) OnEvent(ctx context.Context, ev event.Event) bool { switch x := ev.(type) { - case rollup.ForceResetEvent: - d.pipeline.Reset() case PipelineStepEvent: // Don't generate attributes if there are already attributes in-flight if d.needAttributesConfirmation { diff --git a/op-node/rollup/derive/payload_util.go b/op-node/rollup/derive/payload_util.go index eb02d1afa45..24721e95acc 100644 --- a/op-node/rollup/derive/payload_util.go +++ b/op-node/rollup/derive/payload_util.go @@ -90,13 +90,14 @@ func PayloadToSystemConfig(rollupCfg *rollup.Config, payload *eth.ExecutionPaylo Scalar: info.L1FeeScalar, GasLimit: uint64(payload.GasLimit), } - if rollupCfg.IsHolocene(uint64(payload.Timestamp)) { - if err := eip1559.ValidateHoloceneExtraData(payload.ExtraData); err != nil { - return eth.SystemConfig{}, err - } - d, e := eip1559.DecodeHoloceneExtraData(payload.ExtraData) - copy(r.EIP1559Params[:], eip1559.EncodeHolocene1559Params(d, e)) + err = eip1559.ValidateOptimismExtraData(rollupCfg, uint64(payload.Timestamp), payload.ExtraData) + if err != nil { + return eth.SystemConfig{}, err } + d, e, _ := eip1559.DecodeOptimismExtraData(rollupCfg, uint64(payload.Timestamp), payload.ExtraData) + copy(r.EIP1559Params[:], eip1559.EncodeHolocene1559Params(d, e)) + // TODO https://github.com/ethereum-optimism/optimism/issues/16839 + // r.MinBaseFee = m if rollupCfg.IsIsthmus(uint64(payload.Timestamp)) { r.OperatorFeeParams = eth.EncodeOperatorFeeParams(eth.OperatorFeeParams{ diff --git a/op-node/rollup/derive/pipeline.go b/op-node/rollup/derive/pipeline.go index a593dd1bc94..d8f718e1347 100644 --- a/op-node/rollup/derive/pipeline.go +++ b/op-node/rollup/derive/pipeline.go @@ -138,7 +138,8 @@ func NewDerivationPipeline(log log.Logger, rollupCfg *rollup.Config, depSet Depe // DerivationReady returns true if the derivation pipeline is ready to be used. // When it's being reset its state is inconsistent, and should not be used externally. func (dp *DerivationPipeline) DerivationReady() bool { - return dp.engineIsReset && dp.resetting > 0 + // Ready only when the engine has been confirmed reset and all stages finished resetting + return dp.engineIsReset && dp.resetting >= len(dp.stages) } func (dp *DerivationPipeline) Reset() { diff --git a/op-node/rollup/driver/constants.go b/op-node/rollup/driver/constants.go new file mode 100644 index 00000000000..68176b32fdd --- /dev/null +++ b/op-node/rollup/driver/constants.go @@ -0,0 +1,9 @@ +package driver + +import "github.com/ethereum-optimism/optimism/op-node/rollup/sequencing" + +// aliases to not disrupt op-conductor code +var ( + ErrSequencerAlreadyStarted = sequencing.ErrSequencerAlreadyStarted + ErrSequencerAlreadyStopped = sequencing.ErrSequencerAlreadyStopped +) diff --git a/op-node/rollup/driver/driver.go b/op-node/rollup/driver/driver.go index cfcc73edc95..0d746fbca78 100644 --- a/op-node/rollup/driver/driver.go +++ b/op-node/rollup/driver/driver.go @@ -2,12 +2,14 @@ package driver import ( "context" + "fmt" + "time" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/log" - altda "github.com/ethereum-optimism/optimism/op-alt-da" - opnodemetrics "github.com/ethereum-optimism/optimism/op-node/metrics" + gosync "sync" + "github.com/ethereum-optimism/optimism/op-node/metrics/metered" "github.com/ethereum-optimism/optimism/op-node/rollup" "github.com/ethereum-optimism/optimism/op-node/rollup/async" @@ -25,141 +27,6 @@ import ( "github.com/ethereum-optimism/optimism/op-service/event" ) -// aliases to not disrupt op-conductor code -var ( - ErrSequencerAlreadyStarted = sequencing.ErrSequencerAlreadyStarted - ErrSequencerAlreadyStopped = sequencing.ErrSequencerAlreadyStopped -) - -type Metrics interface { - RecordPipelineReset() - RecordPublishingError() - RecordDerivationError() - - RecordL1Ref(name string, ref eth.L1BlockRef) - RecordL2Ref(name string, ref eth.L2BlockRef) - RecordChannelInputBytes(inputCompressedBytes int) - RecordHeadChannelOpened() - RecordChannelTimedOut() - RecordFrame() - - RecordDerivedBatches(batchType string) - - RecordUnsafePayloadsBuffer(length uint64, memSize uint64, next eth.BlockID) - - SetDerivationIdle(idle bool) - SetSequencerState(active bool) - - RecordL1ReorgDepth(d uint64) - - opnodemetrics.Metricer - metered.L1FetcherMetrics - event.Metrics - sequencing.Metrics -} - -type L1Chain interface { - derive.L1Fetcher - L1BlockRefByLabel(context.Context, eth.BlockLabel) (eth.L1BlockRef, error) -} - -type L2Chain interface { - engine.Engine - L2BlockRefByLabel(ctx context.Context, label eth.BlockLabel) (eth.L2BlockRef, error) - L2BlockRefByHash(ctx context.Context, l2Hash common.Hash) (eth.L2BlockRef, error) - L2BlockRefByNumber(ctx context.Context, num uint64) (eth.L2BlockRef, error) -} - -type DerivationPipeline interface { - Reset() - Step(ctx context.Context, pendingSafeHead eth.L2BlockRef) (*derive.AttributesWithParent, error) - Origin() eth.L1BlockRef - DerivationReady() bool - ConfirmEngineReset() -} - -type EngineController interface { - engine.RollupAPI - engine.LocalEngineControl - IsEngineSyncing() bool - InsertUnsafePayload(ctx context.Context, payload *eth.ExecutionPayloadEnvelope, ref eth.L2BlockRef) error - TryUpdateEngine(ctx context.Context) error - TryBackupUnsafeReorg(ctx context.Context) (bool, error) -} - -type CLSync interface { - LowestQueuedUnsafeBlock() eth.L2BlockRef -} - -type AttributesHandler interface { - // HasAttributes returns if there are any block attributes to process. - // HasAttributes is for EngineQueue testing only, and can be removed when attribute processing is fully independent. - HasAttributes() bool - // SetAttributes overwrites the set of attributes. This may be nil, to clear what may be processed next. - SetAttributes(attributes *derive.AttributesWithParent) - // Proceed runs one attempt of processing attributes, if any. - // Proceed returns io.EOF if there are no attributes to process. - Proceed(ctx context.Context) error -} - -type Finalizer interface { - FinalizedL1() eth.L1BlockRef - OnL1Finalized(x eth.L1BlockRef) - event.Deriver -} - -type AltDAIface interface { - // Notify L1 finalized head so AltDA finality is always behind L1 - Finalize(ref eth.L1BlockRef) - // Set the engine finalization signal callback - OnFinalizedHeadSignal(f altda.HeadSignalFn) - - derive.AltDAInputFetcher -} - -type SyncStatusTracker interface { - event.Deriver - SyncStatus() *eth.SyncStatus - L1Head() eth.L1BlockRef - OnL1Unsafe(x eth.L1BlockRef) - OnL1Safe(x eth.L1BlockRef) - OnL1Finalized(x eth.L1BlockRef) -} - -type Network interface { - // SignAndPublishL2Payload is called by the driver whenever there is a new payload to publish, synchronously with the driver main loop. - SignAndPublishL2Payload(ctx context.Context, payload *eth.ExecutionPayloadEnvelope) error -} - -type AltSync interface { - // RequestL2Range informs the sync source that the given range of L2 blocks is missing, - // and should be retrieved from any available alternative syncing source. - // The start and end of the range are exclusive: - // the start is the head we already have, the end is the first thing we have queued up. - // It's the task of the alt-sync mechanism to use this hint to fetch the right payloads. - // Note that the end and start may not be consistent: in this case the sync method should fetch older history - // - // If the end value is zeroed, then the sync-method may determine the end free of choice, - // e.g. sync till the chain head meets the wallclock time. This functionality is optional: - // a fixed target to sync towards may be determined by picking up payloads through P2P gossip or other sources. - // - // The sync results should be returned back to the driver via the OnUnsafeL2Payload(ctx, payload) method. - // The latest requested range should always take priority over previous requests. - // There may be overlaps in requested ranges. - // An error may be returned if the scheduling fails immediately, e.g. a context timeout. - RequestL2Range(ctx context.Context, start, end eth.L2BlockRef) error -} - -type SequencerStateListener interface { - SequencerStarted() error - SequencerStopped() error -} - -type Drain interface { - Drain() error - Await() <-chan struct{} -} - // NewDriver composes an events handler that tracks L1 state, triggers L2 Derivation, and optionally sequences new L2 blocks. func NewDriver( sys event.Registry, @@ -192,18 +59,21 @@ func NewDriver( verifConfDepth := confdepth.NewConfDepth(driverCfg.VerifierConfDepth, statusTracker.L1Head, l1) ec := engine.NewEngineController(driverCtx, l2, log, metrics, cfg, syncCfg, sys.Register("engine-controller", nil)) + // TODO(#17115): Refactor dependency cycles + ec.SetCrossUpdateHandler(statusTracker) - sys.Register("engine-reset", - engine.NewEngineResetDeriver(driverCtx, log, cfg, l1, l2, syncCfg)) + engineReset := engine.NewEngineResetDeriver(driverCtx, log, cfg, l1, l2, syncCfg) + engineReset.SetEngController(ec) + sys.Register("engine-reset", engineReset) clSync := clsync.NewCLSync(log, cfg, metrics, ec) // alt-sync still uses cl-sync state to determine what to sync to sys.Register("cl-sync", clSync) var finalizer Finalizer if cfg.AltDAEnabled() { - finalizer = finality.NewAltDAFinalizer(driverCtx, log, cfg, l1, altDA) + finalizer = finality.NewAltDAFinalizer(driverCtx, log, cfg, l1, altDA, ec) } else { - finalizer = finality.NewFinalizer(driverCtx, log, cfg, l1) + finalizer = finality.NewFinalizer(driverCtx, log, cfg, l1, ec) } sys.Register("finalizer", finalizer) @@ -212,8 +82,15 @@ func NewDriver( derivationPipeline := derive.NewDerivationPipeline(log, cfg, depSet, verifConfDepth, l1Blobs, altDA, l2, metrics, indexingMode) - sys.Register("pipeline", - derive.NewPipelineDeriver(driverCtx, derivationPipeline)) + pipelineDeriver := derive.NewPipelineDeriver(driverCtx, derivationPipeline) + sys.Register("pipeline", pipelineDeriver) + + // Connect components that need force reset notifications to the engine controller + ec.SetAttributesResetter(attrHandler) + ec.SetPipelineResetter(pipelineDeriver) + + schedDeriv := NewStepSchedulingDeriver(log) + sys.Register("step-scheduler", schedDeriv) syncDeriver := &SyncDeriver{ Derivation: derivationPipeline, @@ -228,6 +105,7 @@ func NewDriver( Log: log, Ctx: driverCtx, ManagedBySupervisor: indexingMode, + StepDeriver: schedDeriv, } // TODO(#16917) Remove Event System Refactor Comments // Couple SyncDeriver and EngineController for event refactoring @@ -236,9 +114,6 @@ func NewDriver( sys.Register("sync", syncDeriver) sys.Register("engine", ec) - schedDeriv := NewStepSchedulingDeriver(log) - sys.Register("step-scheduler", schedDeriv) - var sequencer sequencing.SequencerIface if driverCfg.SequencerEnabled { asyncGossiper := async.NewAsyncGossiper(driverCtx, network, log, metrics) @@ -246,6 +121,10 @@ func NewDriver( sequencerConfDepth := confdepth.NewConfDepth(driverCfg.SequencerConfDepth, statusTracker.L1Head, l1) findL1Origin := sequencing.NewL1OriginSelector(driverCtx, log, cfg, sequencerConfDepth) sys.Register("origin-selector", findL1Origin) + + // Connect origin selector to the engine controller for force reset notifications + ec.SetOriginSelectorResetter(findL1Origin) + sequencer = sequencing.NewSequencer(driverCtx, log, cfg, attrBuilder, findL1Origin, sequencerStateListener, sequencerConductor, asyncGossiper, metrics, ec) sys.Register("sequencer", sequencer) @@ -274,3 +153,267 @@ func NewDriver( return driver } + +type Driver struct { + StatusTracker SyncStatusTracker + Finalizer Finalizer + + SyncDeriver *SyncDeriver + + sched *StepSchedulingDeriver + + emitter event.Emitter + drain Drain + + // Requests to block the event loop for synchronous execution to avoid reading an inconsistent state + stateReq chan chan struct{} + + // Upon receiving a channel in this channel, the derivation pipeline is forced to be reset. + // It tells the caller that the reset occurred by closing the passed in channel. + forceReset chan chan struct{} + + // Driver config: verifier and sequencer settings. + // May not be modified after starting the Driver. + driverConfig *Config + + // Interface to signal the L2 block range to sync. + altSync AltSync + + sequencer sequencing.SequencerIface + + metrics Metrics + log log.Logger + + wg gosync.WaitGroup + + driverCtx context.Context + driverCancel context.CancelFunc +} + +// Start starts up the state loop. +// The loop will have been started iff err is not nil. +func (s *Driver) Start() error { + log.Info("Starting driver", "sequencerEnabled", s.driverConfig.SequencerEnabled, + "sequencerStopped", s.driverConfig.SequencerStopped, "recoverMode", s.driverConfig.RecoverMode) + if s.driverConfig.SequencerEnabled { + if s.driverConfig.RecoverMode { + log.Warn("sequencer is in recover mode") + s.sequencer.SetRecoverMode(true) + } + if err := s.sequencer.SetMaxSafeLag(s.driverCtx, s.driverConfig.SequencerMaxSafeLag); err != nil { + return fmt.Errorf("failed to set sequencer max safe lag: %w", err) + } + if err := s.sequencer.Init(s.driverCtx, !s.driverConfig.SequencerStopped); err != nil { + return fmt.Errorf("persist initial sequencer state: %w", err) + } + } + + s.wg.Add(1) + go s.eventLoop() + + return nil +} + +func (s *Driver) Close() error { + s.driverCancel() + s.wg.Wait() + s.sequencer.Close() + return nil +} + +// the eventLoop responds to L1 changes and internal timers to produce L2 blocks. +func (s *Driver) eventLoop() { + defer s.wg.Done() + s.log.Info("State loop started") + defer s.log.Info("State loop returned") + + defer s.driverCancel() + + // reqStep requests a derivation step nicely, with a delay if this is a reattempt, or not at all if we already scheduled a reattempt. + reqStep := func() { + s.sched.RequestStep(s.driverCtx, false) + } + + // We call reqStep right away to finish syncing to the tip of the chain if we're behind. + // reqStep will also be triggered when the L1 head moves forward or if there was a reorg on the + // L1 chain that we need to handle. + reqStep() + + sequencerTimer := time.NewTimer(0) + var sequencerCh <-chan time.Time + var prevTime time.Time + // planSequencerAction updates the sequencerTimer with the next action, if any. + // The sequencerCh is nil (indefinitely blocks on read) if no action needs to be performed, + // or set to the timer channel if there is an action scheduled. + planSequencerAction := func() { + nextAction, ok := s.sequencer.NextAction() + if !ok { + if sequencerCh != nil { + s.log.Info("Sequencer paused until new events") + } + sequencerCh = nil + return + } + // avoid unnecessary timer resets + if nextAction == prevTime { + return + } + prevTime = nextAction + sequencerCh = sequencerTimer.C + if len(sequencerCh) > 0 { // empty if not already drained before resetting + <-sequencerCh + } + delta := time.Until(nextAction) + s.log.Info("Scheduled sequencer action", "delta", delta) + sequencerTimer.Reset(delta) + } + + // Create a ticker to check if there is a gap in the engine queue. Whenever + // there is, we send requests to sync source to retrieve the missing payloads. + syncCheckInterval := time.Duration(s.SyncDeriver.Config.BlockTime) * time.Second * 2 + altSyncTicker := time.NewTicker(syncCheckInterval) + defer altSyncTicker.Stop() + lastUnsafeL2 := s.SyncDeriver.Engine.UnsafeL2Head() + + for { + if s.driverCtx.Err() != nil { // don't try to schedule/handle more work when we are closing. + return + } + + planSequencerAction() + + // If the engine is not ready, or if the L2 head is actively changing, then reset the alt-sync: + // there is no need to request L2 blocks when we are syncing already. + if head := s.SyncDeriver.Engine.UnsafeL2Head(); head != lastUnsafeL2 || !s.SyncDeriver.Derivation.DerivationReady() { + lastUnsafeL2 = head + altSyncTicker.Reset(syncCheckInterval) + } + + select { + case <-sequencerCh: + s.emitter.Emit(s.driverCtx, sequencing.SequencerActionEvent{}) + case <-altSyncTicker.C: + // Check if there is a gap in the current unsafe payload queue. + ctx, cancel := context.WithTimeout(s.driverCtx, time.Second*2) + err := s.checkForGapInUnsafeQueue(ctx) + cancel() + if err != nil { + s.log.Warn("failed to check for unsafe L2 blocks to sync", "err", err) + } + case <-s.sched.NextDelayedStep(): + s.sched.AttemptStep(s.driverCtx) + case <-s.sched.NextStep(): + s.sched.AttemptStep(s.driverCtx) + case respCh := <-s.stateReq: + respCh <- struct{}{} + case respCh := <-s.forceReset: + s.log.Warn("Derivation pipeline is manually reset") + s.SyncDeriver.Derivation.Reset() + s.metrics.RecordPipelineReset() + close(respCh) + case <-s.drain.Await(): + if err := s.drain.Drain(); err != nil { + if s.driverCtx.Err() != nil { + return + } else { + s.log.Error("unexpected error from event-draining", "err", err) + s.emitter.Emit(s.driverCtx, rollup.CriticalErrorEvent{ + Err: fmt.Errorf("unexpected error: %w", err), + }) + } + } + case <-s.driverCtx.Done(): + return + } + } +} + +// ResetDerivationPipeline forces a reset of the derivation pipeline. +// It waits for the reset to occur. It simply unblocks the caller rather +// than fully cancelling the reset request upon a context cancellation. +func (s *Driver) ResetDerivationPipeline(ctx context.Context) error { + respCh := make(chan struct{}, 1) + select { + case <-ctx.Done(): + return ctx.Err() + case s.forceReset <- respCh: + select { + case <-ctx.Done(): + return ctx.Err() + case <-respCh: + return nil + } + } +} + +func (s *Driver) StartSequencer(ctx context.Context, blockHash common.Hash) error { + return s.sequencer.Start(ctx, blockHash) +} + +func (s *Driver) StopSequencer(ctx context.Context) (common.Hash, error) { + return s.sequencer.Stop(ctx) +} + +func (s *Driver) SequencerActive(ctx context.Context) (bool, error) { + return s.sequencer.Active(), nil +} + +func (s *Driver) OverrideLeader(ctx context.Context) error { + return s.sequencer.OverrideLeader(ctx) +} + +func (s *Driver) ConductorEnabled(ctx context.Context) (bool, error) { + return s.sequencer.ConductorEnabled(ctx), nil +} + +func (s *Driver) SetRecoverMode(ctx context.Context, mode bool) error { + s.sequencer.SetRecoverMode(mode) + return nil +} + +// SyncStatus blocks the driver event loop and captures the syncing status. +func (s *Driver) SyncStatus(ctx context.Context) (*eth.SyncStatus, error) { + return s.StatusTracker.SyncStatus(), nil +} + +// BlockRefWithStatus blocks the driver event loop and captures the syncing status, +// along with an L2 block reference by number consistent with that same status. +// If the event loop is too busy and the context expires, a context error is returned. +func (s *Driver) BlockRefWithStatus(ctx context.Context, num uint64) (eth.L2BlockRef, *eth.SyncStatus, error) { + resp := s.StatusTracker.SyncStatus() + if resp.FinalizedL2.Number >= num { // If finalized, we are certain it does not reorg, and don't have to lock. + ref, err := s.SyncDeriver.L2.L2BlockRefByNumber(ctx, num) + return ref, resp, err + } + wait := make(chan struct{}) + select { + case s.stateReq <- wait: + resp := s.StatusTracker.SyncStatus() + ref, err := s.SyncDeriver.L2.L2BlockRefByNumber(ctx, num) + <-wait + return ref, resp, err + case <-ctx.Done(): + return eth.L2BlockRef{}, nil, ctx.Err() + } +} + +// checkForGapInUnsafeQueue checks if there is a gap in the unsafe queue and attempts to retrieve the missing payloads from an alt-sync method. +// WARNING: This is only an outgoing signal, the blocks are not guaranteed to be retrieved. +// Results are received through OnUnsafeL2Payload. +func (s *Driver) checkForGapInUnsafeQueue(ctx context.Context) error { + start := s.SyncDeriver.Engine.UnsafeL2Head() + end := s.SyncDeriver.CLSync.LowestQueuedUnsafeBlock() + // Check if we have missing blocks between the start and end. Request them if we do. + if end == (eth.L2BlockRef{}) { + s.log.Debug("requesting sync with open-end range", "start", start) + return s.altSync.RequestL2Range(ctx, start, eth.L2BlockRef{}) + } else if end.Number > start.Number+1 { + s.log.Debug("requesting missing unsafe L2 block range", "start", start, "end", end, "size", end.Number-start.Number) + return s.altSync.RequestL2Range(ctx, start, end) + } + return nil +} + +func (s *Driver) OnUnsafeL2Payload(ctx context.Context, payload *eth.ExecutionPayloadEnvelope) { + s.SyncDeriver.OnUnsafeL2Payload(ctx, payload) +} diff --git a/op-node/rollup/driver/interfaces.go b/op-node/rollup/driver/interfaces.go new file mode 100644 index 00000000000..4a826883c36 --- /dev/null +++ b/op-node/rollup/driver/interfaces.go @@ -0,0 +1,143 @@ +package driver + +import ( + "context" + + altda "github.com/ethereum-optimism/optimism/op-alt-da" + opnodemetrics "github.com/ethereum-optimism/optimism/op-node/metrics" + "github.com/ethereum-optimism/optimism/op-node/metrics/metered" + "github.com/ethereum-optimism/optimism/op-node/rollup/derive" + "github.com/ethereum-optimism/optimism/op-node/rollup/engine" + "github.com/ethereum-optimism/optimism/op-node/rollup/sequencing" + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum-optimism/optimism/op-service/event" + "github.com/ethereum/go-ethereum/common" +) + +type Metrics interface { + RecordPipelineReset() + RecordPublishingError() + RecordDerivationError() + + RecordL1Ref(name string, ref eth.L1BlockRef) + RecordL2Ref(name string, ref eth.L2BlockRef) + RecordChannelInputBytes(inputCompressedBytes int) + RecordHeadChannelOpened() + RecordChannelTimedOut() + RecordFrame() + + RecordDerivedBatches(batchType string) + + RecordUnsafePayloadsBuffer(length uint64, memSize uint64, next eth.BlockID) + + SetDerivationIdle(idle bool) + SetSequencerState(active bool) + + RecordL1ReorgDepth(d uint64) + + opnodemetrics.Metricer + metered.L1FetcherMetrics + event.Metrics + sequencing.Metrics +} + +type L1Chain interface { + derive.L1Fetcher + L1BlockRefByLabel(context.Context, eth.BlockLabel) (eth.L1BlockRef, error) +} + +type L2Chain interface { + engine.Engine + L2BlockRefByLabel(ctx context.Context, label eth.BlockLabel) (eth.L2BlockRef, error) + L2BlockRefByHash(ctx context.Context, l2Hash common.Hash) (eth.L2BlockRef, error) + L2BlockRefByNumber(ctx context.Context, num uint64) (eth.L2BlockRef, error) +} + +type DerivationPipeline interface { + Reset() + Step(ctx context.Context, pendingSafeHead eth.L2BlockRef) (*derive.AttributesWithParent, error) + Origin() eth.L1BlockRef + DerivationReady() bool + ConfirmEngineReset() +} + +type EngineController interface { + engine.RollupAPI + engine.LocalEngineControl + IsEngineSyncing() bool + InsertUnsafePayload(ctx context.Context, payload *eth.ExecutionPayloadEnvelope, ref eth.L2BlockRef) error + TryBackupUnsafeReorg(ctx context.Context) (bool, error) +} + +type CLSync interface { + LowestQueuedUnsafeBlock() eth.L2BlockRef +} + +type AttributesHandler interface { + // HasAttributes returns if there are any block attributes to process. + // HasAttributes is for EngineQueue testing only, and can be removed when attribute processing is fully independent. + HasAttributes() bool + // SetAttributes overwrites the set of attributes. This may be nil, to clear what may be processed next. + SetAttributes(attributes *derive.AttributesWithParent) + // Proceed runs one attempt of processing attributes, if any. + // Proceed returns io.EOF if there are no attributes to process. + Proceed(ctx context.Context) error +} + +type Finalizer interface { + FinalizedL1() eth.L1BlockRef + OnL1Finalized(x eth.L1BlockRef) + event.Deriver +} + +type AltDAIface interface { + // Notify L1 finalized head so AltDA finality is always behind L1 + Finalize(ref eth.L1BlockRef) + // Set the engine finalization signal callback + OnFinalizedHeadSignal(f altda.HeadSignalFn) + + derive.AltDAInputFetcher +} + +type SyncStatusTracker interface { + event.Deriver + SyncStatus() *eth.SyncStatus + L1Head() eth.L1BlockRef + OnL1Unsafe(x eth.L1BlockRef) + OnL1Safe(x eth.L1BlockRef) + OnL1Finalized(x eth.L1BlockRef) +} + +type Network interface { + // SignAndPublishL2Payload is called by the driver whenever there is a new payload to publish, synchronously with the driver main loop. + SignAndPublishL2Payload(ctx context.Context, payload *eth.ExecutionPayloadEnvelope) error +} + +type AltSync interface { + // RequestL2Range informs the sync source that the given range of L2 blocks is missing, + // and should be retrieved from any available alternative syncing source. + // The start and end of the range are exclusive: + // the start is the head we already have, the end is the first thing we have queued up. + // It's the task of the alt-sync mechanism to use this hint to fetch the right payloads. + // Note that the end and start may not be consistent: in this case the sync method should fetch older history + // + // If the end value is zeroed, then the sync-method may determine the end free of choice, + // e.g. sync till the chain head meets the wallclock time. This functionality is optional: + // a fixed target to sync towards may be determined by picking up payloads through P2P gossip or other sources. + // + // The sync results should be returned back to the driver via the OnUnsafeL2Payload(ctx, payload) method. + // The latest requested range should always take priority over previous requests. + // There may be overlaps in requested ranges. + // An error may be returned if the scheduling fails immediately, e.g. a context timeout. + RequestL2Range(ctx context.Context, start, end eth.L2BlockRef) error +} + +type SequencerStateListener interface { + SequencerStarted() error + SequencerStopped() error +} + +type Drain interface { + Drain() error + Await() <-chan struct{} +} diff --git a/op-node/rollup/driver/steps.go b/op-node/rollup/driver/step_scheduling_deriver.go similarity index 63% rename from op-node/rollup/driver/steps.go rename to op-node/rollup/driver/step_scheduling_deriver.go index 2b29e1d13f6..31e1c550e85 100644 --- a/op-node/rollup/driver/steps.go +++ b/op-node/rollup/driver/step_scheduling_deriver.go @@ -10,36 +10,6 @@ import ( "github.com/ethereum-optimism/optimism/op-service/retry" ) -type ResetStepBackoffEvent struct { -} - -func (ev ResetStepBackoffEvent) String() string { - return "reset-step-backoff" -} - -type StepDelayedReqEvent struct { - Delay time.Duration -} - -func (ev StepDelayedReqEvent) String() string { - return "step-delayed-req" -} - -type StepReqEvent struct { - ResetBackoff bool -} - -func (ev StepReqEvent) String() string { - return "step-req" -} - -type StepAttemptEvent struct { -} - -func (ev StepAttemptEvent) String() string { - return "step-attempt" -} - type StepEvent struct { } @@ -47,6 +17,15 @@ func (ev StepEvent) String() string { return "step" } +type StepDeriver interface { + event.AttachEmitter + NextStep() <-chan struct{} + NextDelayedStep() <-chan time.Time + RequestStep(ctx context.Context, resetBackoff bool) + AttemptStep(ctx context.Context) + ResetStepBackoff(ctx context.Context) +} + // StepSchedulingDeriver is a deriver that emits StepEvent events. // The deriver can be requested to schedule a step with a StepReqEvent. // @@ -102,7 +81,7 @@ func (s *StepSchedulingDeriver) NextDelayedStep() <-chan time.Time { return s.delayedStepReq } -func (s *StepSchedulingDeriver) OnEvent(ctx context.Context, ev event.Event) bool { +func (s *StepSchedulingDeriver) RequestStep(ctx context.Context, resetBackoff bool) { step := func() { s.delayedStepReq = nil select { @@ -112,40 +91,38 @@ func (s *StepSchedulingDeriver) OnEvent(ctx context.Context, ev event.Event) boo } } - switch x := ev.(type) { - case StepDelayedReqEvent: + if resetBackoff { + s.stepAttempts = 0 + } + if s.stepAttempts > 0 { + // if this is not the first attempt, we re-schedule with a backoff, *without blocking other events* if s.delayedStepReq == nil { - s.delayedStepReq = time.After(x.Delay) - } - case StepReqEvent: - if x.ResetBackoff { - s.stepAttempts = 0 - } - if s.stepAttempts > 0 { - // if this is not the first attempt, we re-schedule with a backoff, *without blocking other events* - if s.delayedStepReq == nil { - delay := s.bOffStrategy.Duration(s.stepAttempts) - s.log.Debug("scheduling re-attempt with delay", "attempts", s.stepAttempts, "delay", delay) - s.delayedStepReq = time.After(delay) - } else { - s.log.Debug("ignoring step request, already scheduled re-attempt after previous failure", "attempts", s.stepAttempts) - } + delay := s.bOffStrategy.Duration(s.stepAttempts) + s.log.Debug("scheduling re-attempt with delay", "attempts", s.stepAttempts, "delay", delay) + s.delayedStepReq = time.After(delay) } else { - step() - } - case StepAttemptEvent: - // clear the delayed-step channel - s.delayedStepReq = nil - if s.stepAttempts > 0 { - s.log.Debug("Running step retry", "attempts", s.stepAttempts) + s.log.Debug("ignoring step request, already scheduled re-attempt after previous failure", "attempts", s.stepAttempts) } - // count as attempt by default. We reset to 0 if we are making healthy progress. - s.stepAttempts += 1 - s.emitter.Emit(ctx, StepEvent(x)) - case ResetStepBackoffEvent: - s.stepAttempts = 0 - default: - return false + } else { + step() } - return true +} + +func (s *StepSchedulingDeriver) AttemptStep(ctx context.Context) { + // clear the delayed-step channel + s.delayedStepReq = nil + if s.stepAttempts > 0 { + s.log.Debug("Running step retry", "attempts", s.stepAttempts) + } + // count as attempt by default. We reset to 0 if we are making healthy progress. + s.stepAttempts += 1 + s.emitter.Emit(ctx, StepEvent{}) +} + +func (s *StepSchedulingDeriver) ResetStepBackoff(ctx context.Context) { + s.stepAttempts = 0 +} + +func (s *StepSchedulingDeriver) OnEvent(ctx context.Context, ev event.Event) bool { + return false } diff --git a/op-node/rollup/driver/steps_test.go b/op-node/rollup/driver/step_scheduling_deriver.go_test.go similarity index 70% rename from op-node/rollup/driver/steps_test.go rename to op-node/rollup/driver/step_scheduling_deriver.go_test.go index 60c74d34fad..6b7a3ad56fb 100644 --- a/op-node/rollup/driver/steps_test.go +++ b/op-node/rollup/driver/step_scheduling_deriver.go_test.go @@ -21,35 +21,35 @@ func TestStepSchedulingDeriver(t *testing.T) { sched := NewStepSchedulingDeriver(logger) sched.AttachEmitter(emitter) require.Len(t, sched.NextStep(), 0, "start empty") - sched.OnEvent(context.Background(), StepReqEvent{}) + sched.RequestStep(context.Background(), false) require.Len(t, sched.NextStep(), 1, "take request") - sched.OnEvent(context.Background(), StepReqEvent{}) + sched.RequestStep(context.Background(), false) require.Len(t, sched.NextStep(), 1, "ignore duplicate request") require.Empty(t, queued, "only scheduled so far, no step attempts yet") <-sched.NextStep() - sched.OnEvent(context.Background(), StepAttemptEvent{}) + sched.AttemptStep(context.Background()) require.Equal(t, []event.Event{StepEvent{}}, queued, "got step event") require.Nil(t, sched.NextDelayedStep(), "no delayed steps yet") - sched.OnEvent(context.Background(), StepReqEvent{}) + sched.RequestStep(context.Background(), false) require.NotNil(t, sched.NextDelayedStep(), "2nd attempt before backoff reset causes delayed step to be scheduled") - sched.OnEvent(context.Background(), StepReqEvent{}) + sched.RequestStep(context.Background(), false) require.NotNil(t, sched.NextDelayedStep(), "can continue to request attempts") - sched.OnEvent(context.Background(), StepReqEvent{}) + sched.RequestStep(context.Background(), false) require.Len(t, sched.NextStep(), 0, "no step requests accepted without delay if backoff is counting") - sched.OnEvent(context.Background(), StepReqEvent{ResetBackoff: true}) + sched.RequestStep(context.Background(), true) require.Len(t, sched.NextStep(), 1, "request accepted if backoff is reset") <-sched.NextStep() - sched.OnEvent(context.Background(), StepReqEvent{}) + sched.RequestStep(context.Background(), false) require.Len(t, sched.NextStep(), 1, "no backoff, no attempt has been made yet") <-sched.NextStep() - sched.OnEvent(context.Background(), StepAttemptEvent{}) - sched.OnEvent(context.Background(), StepReqEvent{}) + sched.AttemptStep(context.Background()) + sched.RequestStep(context.Background(), false) require.Len(t, sched.NextStep(), 0, "backoff again") - sched.OnEvent(context.Background(), ResetStepBackoffEvent{}) - sched.OnEvent(context.Background(), StepReqEvent{}) + sched.ResetStepBackoff(context.Background()) + sched.RequestStep(context.Background(), false) require.Len(t, sched.NextStep(), 1, "reset backoff accepted, was able to schedule non-delayed step") } diff --git a/op-node/rollup/driver/state.go b/op-node/rollup/driver/sync_deriver.go similarity index 50% rename from op-node/rollup/driver/state.go rename to op-node/rollup/driver/sync_deriver.go index 1f0a8ddbcc3..8d0122cb8db 100644 --- a/op-node/rollup/driver/state.go +++ b/op-node/rollup/driver/sync_deriver.go @@ -4,200 +4,18 @@ import ( "context" "errors" "fmt" - gosync "sync" - "time" - - "github.com/ethereum/go-ethereum/common" - "github.com/ethereum/go-ethereum/log" "github.com/ethereum-optimism/optimism/op-node/rollup" "github.com/ethereum-optimism/optimism/op-node/rollup/clsync" "github.com/ethereum-optimism/optimism/op-node/rollup/derive" "github.com/ethereum-optimism/optimism/op-node/rollup/engine" - "github.com/ethereum-optimism/optimism/op-node/rollup/sequencing" "github.com/ethereum-optimism/optimism/op-node/rollup/status" "github.com/ethereum-optimism/optimism/op-node/rollup/sync" "github.com/ethereum-optimism/optimism/op-service/eth" "github.com/ethereum-optimism/optimism/op-service/event" + "github.com/ethereum/go-ethereum/log" ) -// Deprecated: use eth.SyncStatus instead. -type SyncStatus = eth.SyncStatus - -type Driver struct { - StatusTracker SyncStatusTracker - Finalizer Finalizer - - *SyncDeriver - - sched *StepSchedulingDeriver - - emitter event.Emitter - drain Drain - - // Requests to block the event loop for synchronous execution to avoid reading an inconsistent state - stateReq chan chan struct{} - - // Upon receiving a channel in this channel, the derivation pipeline is forced to be reset. - // It tells the caller that the reset occurred by closing the passed in channel. - forceReset chan chan struct{} - - // Driver config: verifier and sequencer settings. - // May not be modified after starting the Driver. - driverConfig *Config - - // Interface to signal the L2 block range to sync. - altSync AltSync - - sequencer sequencing.SequencerIface - - metrics Metrics - log log.Logger - - wg gosync.WaitGroup - - driverCtx context.Context - driverCancel context.CancelFunc -} - -// Start starts up the state loop. -// The loop will have been started iff err is not nil. -func (s *Driver) Start() error { - log.Info("Starting driver", "sequencerEnabled", s.driverConfig.SequencerEnabled, - "sequencerStopped", s.driverConfig.SequencerStopped, "recoverMode", s.driverConfig.RecoverMode) - if s.driverConfig.SequencerEnabled { - if s.driverConfig.RecoverMode { - log.Warn("sequencer is in recover mode") - s.sequencer.SetRecoverMode(true) - } - if err := s.sequencer.SetMaxSafeLag(s.driverCtx, s.driverConfig.SequencerMaxSafeLag); err != nil { - return fmt.Errorf("failed to set sequencer max safe lag: %w", err) - } - if err := s.sequencer.Init(s.driverCtx, !s.driverConfig.SequencerStopped); err != nil { - return fmt.Errorf("persist initial sequencer state: %w", err) - } - } - - s.wg.Add(1) - go s.eventLoop() - - return nil -} - -func (s *Driver) Close() error { - s.driverCancel() - s.wg.Wait() - s.sequencer.Close() - return nil -} - -// the eventLoop responds to L1 changes and internal timers to produce L2 blocks. -func (s *Driver) eventLoop() { - defer s.wg.Done() - s.log.Info("State loop started") - defer s.log.Info("State loop returned") - - defer s.driverCancel() - - // reqStep requests a derivation step nicely, with a delay if this is a reattempt, or not at all if we already scheduled a reattempt. - reqStep := func() { - s.emitter.Emit(s.driverCtx, StepReqEvent{}) - } - - // We call reqStep right away to finish syncing to the tip of the chain if we're behind. - // reqStep will also be triggered when the L1 head moves forward or if there was a reorg on the - // L1 chain that we need to handle. - reqStep() - - sequencerTimer := time.NewTimer(0) - var sequencerCh <-chan time.Time - var prevTime time.Time - // planSequencerAction updates the sequencerTimer with the next action, if any. - // The sequencerCh is nil (indefinitely blocks on read) if no action needs to be performed, - // or set to the timer channel if there is an action scheduled. - planSequencerAction := func() { - nextAction, ok := s.sequencer.NextAction() - if !ok { - if sequencerCh != nil { - s.log.Info("Sequencer paused until new events") - } - sequencerCh = nil - return - } - // avoid unnecessary timer resets - if nextAction == prevTime { - return - } - prevTime = nextAction - sequencerCh = sequencerTimer.C - if len(sequencerCh) > 0 { // empty if not already drained before resetting - <-sequencerCh - } - delta := time.Until(nextAction) - s.log.Info("Scheduled sequencer action", "delta", delta) - sequencerTimer.Reset(delta) - } - - // Create a ticker to check if there is a gap in the engine queue. Whenever - // there is, we send requests to sync source to retrieve the missing payloads. - syncCheckInterval := time.Duration(s.Config.BlockTime) * time.Second * 2 - altSyncTicker := time.NewTicker(syncCheckInterval) - defer altSyncTicker.Stop() - lastUnsafeL2 := s.Engine.UnsafeL2Head() - - for { - if s.driverCtx.Err() != nil { // don't try to schedule/handle more work when we are closing. - return - } - - planSequencerAction() - - // If the engine is not ready, or if the L2 head is actively changing, then reset the alt-sync: - // there is no need to request L2 blocks when we are syncing already. - if head := s.Engine.UnsafeL2Head(); head != lastUnsafeL2 || !s.Derivation.DerivationReady() { - lastUnsafeL2 = head - altSyncTicker.Reset(syncCheckInterval) - } - - select { - case <-sequencerCh: - s.Emitter.Emit(s.driverCtx, sequencing.SequencerActionEvent{}) - case <-altSyncTicker.C: - // Check if there is a gap in the current unsafe payload queue. - ctx, cancel := context.WithTimeout(s.driverCtx, time.Second*2) - err := s.checkForGapInUnsafeQueue(ctx) - cancel() - if err != nil { - s.log.Warn("failed to check for unsafe L2 blocks to sync", "err", err) - } - case <-s.sched.NextDelayedStep(): - s.emitter.Emit(s.driverCtx, StepAttemptEvent{}) - case <-s.sched.NextStep(): - s.emitter.Emit(s.driverCtx, StepAttemptEvent{}) - case respCh := <-s.stateReq: - respCh <- struct{}{} - case respCh := <-s.forceReset: - s.log.Warn("Derivation pipeline is manually reset") - s.Derivation.Reset() - s.metrics.RecordPipelineReset() - close(respCh) - case <-s.drain.Await(): - if err := s.drain.Drain(); err != nil { - if s.driverCtx.Err() != nil { - return - } else { - s.log.Error("unexpected error from event-draining", "err", err) - s.Emitter.Emit(s.driverCtx, rollup.CriticalErrorEvent{ - Err: fmt.Errorf("unexpected error: %w", err), - }) - } - } - case <-s.driverCtx.Done(): - return - } - } -} - type SyncDeriver struct { // The derivation pipeline is reset whenever we reorg. // The derivation pipeline determines the new l2Safe. @@ -230,6 +48,8 @@ type SyncDeriver struct { // When in interop, and managed by an op-supervisor, // the node performs a reset based on the instructions of the op-supervisor. ManagedBySupervisor bool + + StepDeriver StepDeriver } func (s *SyncDeriver) AttachEmitter(em event.Emitter) { @@ -238,13 +58,13 @@ func (s *SyncDeriver) AttachEmitter(em event.Emitter) { func (s *SyncDeriver) OnL1Unsafe(ctx context.Context) { // a new L1 head may mean we have the data to not get an EOF again. - s.Emitter.Emit(ctx, StepReqEvent{}) + s.StepDeriver.RequestStep(ctx, false) } func (s *SyncDeriver) OnL1Finalized(ctx context.Context) { // On "safe" L1 blocks: no step, justified L1 information does not do anything for L2 derivation or status. // On "finalized" L1 blocks: we may be able to mark more L2 data as finalized now. - s.Emitter.Emit(ctx, StepReqEvent{}) + s.StepDeriver.RequestStep(ctx, false) } func (s *SyncDeriver) OnEvent(ctx context.Context, ev event.Event) bool { @@ -260,26 +80,26 @@ func (s *SyncDeriver) OnEvent(ctx context.Context, ev event.Event) bool { s.onResetEvent(ctx, x) case rollup.L1TemporaryErrorEvent: s.Log.Warn("L1 temporary error", "err", x.Err) - s.Emitter.Emit(ctx, StepReqEvent{}) + s.StepDeriver.RequestStep(ctx, false) case rollup.EngineTemporaryErrorEvent: s.Log.Warn("Engine temporary error", "err", x.Err) // Make sure that for any temporarily failed attributes we retry processing. // This will be triggered by a step. After appropriate backoff. - s.Emitter.Emit(ctx, StepReqEvent{}) + s.StepDeriver.RequestStep(ctx, false) case engine.EngineResetConfirmedEvent: s.onEngineConfirmedReset(ctx, x) case derive.DeriverIdleEvent: // Once derivation is idle the system is healthy // and we can wait for new inputs. No backoff necessary. - s.Emitter.Emit(ctx, ResetStepBackoffEvent{}) + s.StepDeriver.ResetStepBackoff(ctx) case derive.DeriverMoreEvent: // If there is more data to process, // continue derivation quickly - s.Emitter.Emit(ctx, StepReqEvent{ResetBackoff: true}) + s.StepDeriver.RequestStep(ctx, true) case engine.SafeDerivedEvent: s.onSafeDerivedBlock(ctx, x) case derive.ProvideL1Traversal: - s.Emitter.Emit(ctx, StepReqEvent{}) + s.StepDeriver.RequestStep(ctx, false) default: return false } @@ -369,8 +189,8 @@ func (s *SyncDeriver) onResetEvent(ctx context.Context, x rollup.ResetEvent) { } // If the system corrupts, e.g. due to a reorg, simply reset it s.Log.Warn("Deriver system is resetting", "err", x.Err) - s.Emitter.Emit(ctx, StepReqEvent{}) s.Emitter.Emit(ctx, engine.ResetEngineRequestEvent{}) + s.StepDeriver.RequestStep(ctx, false) } func (s *SyncDeriver) tryBackupUnsafeReorg() { @@ -405,13 +225,13 @@ func (s *SyncDeriver) SyncStep() { s.tryBackupUnsafeReorg() - s.Emitter.Emit(s.Ctx, engine.TryUpdateEngineEvent{}) + s.Engine.TryUpdateEngine(s.Ctx) if s.Engine.IsEngineSyncing() { // The pipeline cannot move forwards if doing EL sync. s.Log.Debug("Rollup driver is backing off because execution engine is syncing.", "unsafe_head", s.Engine.UnsafeL2Head()) - s.Emitter.Emit(s.Ctx, ResetStepBackoffEvent{}) + s.StepDeriver.ResetStepBackoff(s.Ctx) return } @@ -423,97 +243,6 @@ func (s *SyncDeriver) SyncStep() { // Instead, we request the engine to repeat where its pending-safe head is at. // Upon the pending-safe signal the attributes deriver can then ask the pipeline // to generate new attributes, if no attributes are known already. - s.Emitter.Emit(s.Ctx, engine.PendingSafeRequestEvent{}) - - // If interop is configured, we have to run the engine events, - // to ensure cross-L2 safety is continuously verified against the interop-backend. - if s.Config.InteropTime != nil && !s.ManagedBySupervisor { - s.Emitter.Emit(s.Ctx, engine.CrossUpdateRequestEvent{}) - } -} + s.Engine.RequestPendingSafeUpdate(s.Ctx) -// ResetDerivationPipeline forces a reset of the derivation pipeline. -// It waits for the reset to occur. It simply unblocks the caller rather -// than fully cancelling the reset request upon a context cancellation. -func (s *Driver) ResetDerivationPipeline(ctx context.Context) error { - respCh := make(chan struct{}, 1) - select { - case <-ctx.Done(): - return ctx.Err() - case s.forceReset <- respCh: - select { - case <-ctx.Done(): - return ctx.Err() - case <-respCh: - return nil - } - } -} - -func (s *Driver) StartSequencer(ctx context.Context, blockHash common.Hash) error { - return s.sequencer.Start(ctx, blockHash) -} - -func (s *Driver) StopSequencer(ctx context.Context) (common.Hash, error) { - return s.sequencer.Stop(ctx) -} - -func (s *Driver) SequencerActive(ctx context.Context) (bool, error) { - return s.sequencer.Active(), nil -} - -func (s *Driver) OverrideLeader(ctx context.Context) error { - return s.sequencer.OverrideLeader(ctx) -} - -func (s *Driver) ConductorEnabled(ctx context.Context) (bool, error) { - return s.sequencer.ConductorEnabled(ctx), nil -} - -func (s *Driver) SetRecoverMode(ctx context.Context, mode bool) error { - s.sequencer.SetRecoverMode(mode) - return nil -} - -// SyncStatus blocks the driver event loop and captures the syncing status. -func (s *Driver) SyncStatus(ctx context.Context) (*eth.SyncStatus, error) { - return s.StatusTracker.SyncStatus(), nil -} - -// BlockRefWithStatus blocks the driver event loop and captures the syncing status, -// along with an L2 block reference by number consistent with that same status. -// If the event loop is too busy and the context expires, a context error is returned. -func (s *Driver) BlockRefWithStatus(ctx context.Context, num uint64) (eth.L2BlockRef, *eth.SyncStatus, error) { - resp := s.StatusTracker.SyncStatus() - if resp.FinalizedL2.Number >= num { // If finalized, we are certain it does not reorg, and don't have to lock. - ref, err := s.L2.L2BlockRefByNumber(ctx, num) - return ref, resp, err - } - wait := make(chan struct{}) - select { - case s.stateReq <- wait: - resp := s.StatusTracker.SyncStatus() - ref, err := s.L2.L2BlockRefByNumber(ctx, num) - <-wait - return ref, resp, err - case <-ctx.Done(): - return eth.L2BlockRef{}, nil, ctx.Err() - } -} - -// checkForGapInUnsafeQueue checks if there is a gap in the unsafe queue and attempts to retrieve the missing payloads from an alt-sync method. -// WARNING: This is only an outgoing signal, the blocks are not guaranteed to be retrieved. -// Results are received through OnUnsafeL2Payload. -func (s *Driver) checkForGapInUnsafeQueue(ctx context.Context) error { - start := s.Engine.UnsafeL2Head() - end := s.CLSync.LowestQueuedUnsafeBlock() - // Check if we have missing blocks between the start and end. Request them if we do. - if end == (eth.L2BlockRef{}) { - s.log.Debug("requesting sync with open-end range", "start", start) - return s.altSync.RequestL2Range(ctx, start, eth.L2BlockRef{}) - } else if end.Number > start.Number+1 { - s.log.Debug("requesting missing unsafe L2 block range", "start", start, "end", end, "size", end.Number-start.Number) - return s.altSync.RequestL2Range(ctx, start, end) - } - return nil } diff --git a/op-node/rollup/engine/api.go b/op-node/rollup/engine/api.go index 7e03e4b6e42..664e9723eb4 100644 --- a/op-node/rollup/engine/api.go +++ b/op-node/rollup/engine/api.go @@ -138,7 +138,7 @@ func (ec *EngineController) CommitBlock(ctx context.Context, signed *opsigner.Si ec.SetUnsafeHead(ref) ec.emitter.Emit(ctx, UnsafeUpdateEvent{Ref: ref}) - if err := ec.TryUpdateEngine(ctx); err != nil { + if err := ec.tryUpdateEngine(ctx); err != nil { return fmt.Errorf("failed to update engine forkchoice: %w", err) } return nil diff --git a/op-node/rollup/engine/engine_controller.go b/op-node/rollup/engine/engine_controller.go index f1b1c6ecd90..34e824610fb 100644 --- a/op-node/rollup/engine/engine_controller.go +++ b/op-node/rollup/engine/engine_controller.go @@ -50,6 +50,25 @@ type SyncDeriver interface { OnELSyncStarted() } +type AttributesForceResetter interface { + ForceReset(ctx context.Context, localUnsafe, crossUnsafe, localSafe, crossSafe, finalized eth.L2BlockRef) +} + +type PipelineForceResetter interface { + ResetPipeline() +} + +type OriginSelectorForceResetter interface { + ResetOrigins() +} + +// CrossUpdateHandler handles both cross-unsafe and cross-safe L2 head changes. +// Nil check required because op-program omits this handler. +type CrossUpdateHandler interface { + OnCrossUnsafeUpdate(ctx context.Context, crossUnsafe eth.L2BlockRef, localUnsafe eth.L2BlockRef) + OnCrossSafeUpdate(ctx context.Context, crossSafe eth.L2BlockRef, localSafe eth.L2BlockRef) +} + type EngineController struct { engine ExecEngine // Underlying execution engine RPC log log.Logger @@ -102,6 +121,14 @@ type EngineController struct { // EngineController is first initialized and used to initialize SyncDeriver. // Embed SyncDeriver into EngineController after initializing SyncDeriver SyncDeriver SyncDeriver + + // Components that need to be notified during force reset + attributesResetter AttributesForceResetter + pipelineResetter PipelineForceResetter + originSelectorResetter OriginSelectorForceResetter + + // Handler for cross-unsafe and cross-safe updates + crossUpdateHandler CrossUpdateHandler } func NewEngineController(ctx context.Context, engine ExecEngine, log log.Logger, m opmetrics.Metricer, @@ -156,8 +183,6 @@ func (e *EngineController) BackupUnsafeL2Head() eth.L2BlockRef { return e.backupUnsafeHead } -// RequestForkchoiceUpdate implements attributes.EngineController. -// It reads the current heads under a read lock and emits a ForkchoiceUpdateEvent. func (e *EngineController) RequestForkchoiceUpdate(ctx context.Context) { e.mu.RLock() unsafe := e.UnsafeL2Head() @@ -224,6 +249,24 @@ func (e *EngineController) SetBackupUnsafeL2Head(r eth.L2BlockRef, triggerReorg e.needFCUCallForBackupUnsafeReorg = triggerReorg } +func (e *EngineController) SetCrossUpdateHandler(handler CrossUpdateHandler) { + e.crossUpdateHandler = handler +} + +func (e *EngineController) onUnsafeUpdate(ctx context.Context, crossUnsafe, localUnsafe eth.L2BlockRef) { + // Nil check required because op-program omits this handler. + if e.crossUpdateHandler != nil { + e.crossUpdateHandler.OnCrossUnsafeUpdate(ctx, crossUnsafe, localUnsafe) + } +} + +func (e *EngineController) onSafeUpdate(ctx context.Context, crossSafe, localSafe eth.L2BlockRef) { + // Nil check required because op-program omits this handler. + if e.crossUpdateHandler != nil { + e.crossUpdateHandler.OnCrossSafeUpdate(ctx, crossSafe, localSafe) + } +} + // logSyncProgressMaybe helps log forkchoice state-changes when applicable. // First, the pre-state is registered. // A callback is returned to then log the changes to the pre-state, if any. @@ -346,9 +389,9 @@ func (e *EngineController) initializeUnknowns(ctx context.Context) error { return nil } -// TryUpdateEngine attempts to update the engine with the current forkchoice state of the rollup node, +// tryUpdateEngine attempts to update the engine with the current forkchoice state of the rollup node, // this is a no-op if the nodes already agree on the forkchoice state. -func (e *EngineController) TryUpdateEngine(ctx context.Context) error { +func (e *EngineController) tryUpdateEngine(ctx context.Context) error { if !e.needFCUCall { return ErrNoFCUNeeded } @@ -449,7 +492,7 @@ func (e *EngineController) InsertUnsafePayload(ctx context.Context, envelope *et e.emitter.Emit(ctx, UnsafeUpdateEvent{Ref: ref}) e.SetLocalSafeHead(ref) e.SetSafeHead(ref) - e.emitter.Emit(ctx, CrossSafeUpdateEvent{LocalSafe: ref, CrossSafe: ref}) + e.onSafeUpdate(ctx, ref, ref) e.SetFinalizedHead(ref) } logFn := e.logSyncProgressMaybe() @@ -583,31 +626,32 @@ func (e *EngineController) TryBackupUnsafeReorg(ctx context.Context) (bool, erro eth.ForkchoiceUpdateErr(fcRes.PayloadStatus))) } +func (d *EngineController) TryUpdateEngine(ctx context.Context) { + // If we don't need to call FCU, keep going b/c this was a no-op. If we needed to + // perform a network call, then we should yield even if we did not encounter an error. + if err := d.tryUpdateEngine(d.ctx); err != nil && !errors.Is(err, ErrNoFCUNeeded) { + if errors.Is(err, derive.ErrReset) { + d.emitter.Emit(ctx, rollup.ResetEvent{Err: err}) + } else if errors.Is(err, derive.ErrTemporary) { + d.emitter.Emit(ctx, rollup.EngineTemporaryErrorEvent{Err: err}) + } else { + d.emitter.Emit(ctx, rollup.CriticalErrorEvent{ + Err: fmt.Errorf("unexpected tryUpdateEngine error type: %w", err), + }) + } + } +} + // TODO(#16917) Remove Event System Refactor Comments // OnEvent implements event.Deriver (moved from EngDeriver) +// TryUpdateEngineEvent is replaced with TryUpdateEngine func (d *EngineController) OnEvent(ctx context.Context, ev event.Event) bool { d.mu.Lock() defer d.mu.Unlock() // TODO(#16917) Remove Event System Refactor Comments // PromoteUnsafeEvent, PromotePendingSafeEvent, PromoteLocalSafeEvent fan out is updated to procedural + // PromoteSafeEvent fan out is updated to procedural PromoteSafe method call switch x := ev.(type) { - case TryUpdateEngineEvent: - // If we don't need to call FCU, keep going b/c this was a no-op. If we needed to - // perform a network call, then we should yield even if we did not encounter an error. - if err := d.TryUpdateEngine(d.ctx); err != nil && !errors.Is(err, ErrNoFCUNeeded) { - if errors.Is(err, derive.ErrReset) { - d.emitter.Emit(ctx, rollup.ResetEvent{Err: err}) - } else if errors.Is(err, derive.ErrTemporary) { - d.emitter.Emit(ctx, rollup.EngineTemporaryErrorEvent{Err: err}) - } else { - d.emitter.Emit(ctx, rollup.CriticalErrorEvent{ - Err: fmt.Errorf("unexpected TryUpdateEngine error type: %w", err), - }) - } - } else if x.triggeredByPayloadSuccess() { - logValues := x.getBlockProcessingMetrics() - d.log.Info("Inserted new L2 unsafe block", logValues...) - } case ProcessUnsafePayloadEvent: ref, err := derive.PayloadToBlockRef(d.rollupCfg, x.Envelope.ExecutionPayload) if err != nil { @@ -639,97 +683,20 @@ func (d *EngineController) OnEvent(ctx context.Context, ev event.Event) bool { } else { d.log.Info("successfully processed payload", "ref", ref, "txs", len(x.Envelope.ExecutionPayload.Transactions)) } - case rollup.ForceResetEvent: - ForceEngineReset(d, x) - - // Time to apply the changes to the underlying engine - d.emitter.Emit(ctx, TryUpdateEngineEvent{}) - - v := EngineResetConfirmedEvent{ - LocalUnsafe: d.UnsafeL2Head(), - CrossUnsafe: d.CrossUnsafeL2Head(), - LocalSafe: d.LocalSafeL2Head(), - CrossSafe: d.SafeL2Head(), - Finalized: d.Finalized(), - } - // We do not emit the original event values, since those might not be set (optional attributes). - d.emitter.Emit(ctx, v) - d.log.Info("Reset of Engine is completed", - "local_unsafe", v.LocalUnsafe, - "cross_unsafe", v.CrossUnsafe, - "local_safe", v.LocalSafe, - "cross_safe", v.CrossSafe, - "finalized", v.Finalized, - ) - case UnsafeUpdateEvent: // pre-interop everything that is local-unsafe is also immediately cross-unsafe. if !d.rollupCfg.IsInterop(x.Ref.Time) { d.emitter.Emit(ctx, PromoteCrossUnsafeEvent(x)) } // Try to apply the forkchoice changes - d.emitter.Emit(ctx, TryUpdateEngineEvent{}) + d.TryUpdateEngine(ctx) case PromoteCrossUnsafeEvent: d.SetCrossUnsafeHead(x.Ref) - d.emitter.Emit(ctx, CrossUnsafeUpdateEvent{ - CrossUnsafe: x.Ref, - LocalUnsafe: d.UnsafeL2Head(), - }) - case PendingSafeRequestEvent: - d.emitter.Emit(ctx, PendingSafeUpdateEvent{ - PendingSafe: d.PendingSafeL2Head(), - Unsafe: d.UnsafeL2Head(), - }) - + d.onUnsafeUpdate(ctx, x.Ref, d.UnsafeL2Head()) case LocalSafeUpdateEvent: - // pre-interop everything that is local-unsafe is also immediately cross-unsafe. + // pre-interop everything that is local-safe is also immediately cross-safe. if !d.rollupCfg.IsInterop(x.Ref.Time) { - d.emitter.Emit(ctx, PromoteSafeEvent(x)) - } - case PromoteSafeEvent: - d.log.Debug("Updating safe", "safe", x.Ref, "unsafe", d.UnsafeL2Head()) - d.SetSafeHead(x.Ref) - // Finalizer can pick up this safe cross-block now - d.emitter.Emit(ctx, SafeDerivedEvent{Safe: x.Ref, Source: x.Source}) - d.emitter.Emit(ctx, CrossSafeUpdateEvent{ - CrossSafe: d.SafeL2Head(), - LocalSafe: d.LocalSafeL2Head(), - }) - if x.Ref.Number > d.crossUnsafeHead.Number { - d.log.Debug("Cross Unsafe Head is stale, updating to match cross safe", "cross_unsafe", d.crossUnsafeHead, "cross_safe", x.Ref) - d.SetCrossUnsafeHead(x.Ref) - d.emitter.Emit(ctx, CrossUnsafeUpdateEvent{ - CrossUnsafe: x.Ref, - LocalUnsafe: d.UnsafeL2Head(), - }) - } - // Try to apply the forkchoice changes - d.emitter.Emit(ctx, TryUpdateEngineEvent{}) - case PromoteFinalizedEvent: - if x.Ref.Number < d.Finalized().Number { - d.log.Error("Cannot rewind finality,", "ref", x.Ref, "finalized", d.Finalized()) - return true - } - if x.Ref.Number > d.SafeL2Head().Number { - d.log.Error("Block must be safe before it can be finalized", "ref", x.Ref, "safe", d.SafeL2Head()) - return true - } - d.SetFinalizedHead(x.Ref) - d.emitter.Emit(ctx, FinalizedUpdateEvent(x)) - // Try to apply the forkchoice changes - d.emitter.Emit(ctx, TryUpdateEngineEvent{}) - case CrossUpdateRequestEvent: - if x.CrossUnsafe { - d.emitter.Emit(ctx, CrossUnsafeUpdateEvent{ - CrossUnsafe: d.CrossUnsafeL2Head(), - LocalUnsafe: d.UnsafeL2Head(), - }) - } - if x.CrossSafe { - d.emitter.Emit(ctx, CrossSafeUpdateEvent{ - CrossSafe: d.SafeL2Head(), - LocalSafe: d.LocalSafeL2Head(), - }) + d.PromoteSafe(ctx, x.Ref, x.Source) } case InteropInvalidateBlockEvent: d.emitter.Emit(ctx, BuildStartEvent{Attributes: x.Attributes}) @@ -757,6 +724,13 @@ func (d *EngineController) OnEvent(ctx context.Context, ev event.Event) bool { return true } +func (d *EngineController) RequestPendingSafeUpdate(ctx context.Context) { + d.emitter.Emit(ctx, PendingSafeUpdateEvent{ + PendingSafe: d.PendingSafeL2Head(), + Unsafe: d.UnsafeL2Head(), + }) +} + // TryUpdatePendingSafe updates the pending safe head if the new reference is newer func (e *EngineController) TryUpdatePendingSafe(ctx context.Context, ref eth.L2BlockRef, concluding bool, source eth.L1BlockRef) { // Only promote if not already stale. @@ -790,3 +764,89 @@ func (e *EngineController) TryUpdateUnsafe(ctx context.Context, ref eth.L2BlockR e.SetUnsafeHead(ref) e.emitter.Emit(ctx, UnsafeUpdateEvent{Ref: ref}) } + +func (e *EngineController) PromoteSafe(ctx context.Context, ref eth.L2BlockRef, source eth.L1BlockRef) { + e.log.Debug("Updating safe", "safe", ref, "unsafe", e.UnsafeL2Head()) + e.SetSafeHead(ref) + // Finalizer can pick up this safe cross-block now + e.emitter.Emit(ctx, SafeDerivedEvent{Safe: ref, Source: source}) + e.onSafeUpdate(ctx, e.SafeL2Head(), e.LocalSafeL2Head()) + if ref.Number > e.crossUnsafeHead.Number { + e.log.Debug("Cross Unsafe Head is stale, updating to match cross safe", "cross_unsafe", e.crossUnsafeHead, "cross_safe", ref) + e.SetCrossUnsafeHead(ref) + e.onUnsafeUpdate(ctx, ref, e.UnsafeL2Head()) + } + // Try to apply the forkchoice changes + e.TryUpdateEngine(ctx) +} + +func (e *EngineController) PromoteFinalized(ctx context.Context, ref eth.L2BlockRef) { + if ref.Number < e.Finalized().Number { + e.log.Error("Cannot rewind finality,", "ref", ref, "finalized", e.Finalized()) + return + } + if ref.Number > e.SafeL2Head().Number { + e.log.Error("Block must be safe before it can be finalized", "ref", ref, "safe", e.SafeL2Head()) + return + } + e.SetFinalizedHead(ref) + e.emitter.Emit(ctx, FinalizedUpdateEvent{Ref: ref}) + // Try to apply the forkchoice changes + e.TryUpdateEngine(ctx) +} + +// SetAttributesResetter sets the attributes component that needs force reset notifications +func (e *EngineController) SetAttributesResetter(resetter AttributesForceResetter) { + e.attributesResetter = resetter +} + +// SetPipelineResetter sets the pipeline component that needs force reset notifications +func (e *EngineController) SetPipelineResetter(resetter PipelineForceResetter) { + e.pipelineResetter = resetter +} + +// SetOriginSelectorResetter sets the origin selector component that needs force reset notifications +func (e *EngineController) SetOriginSelectorResetter(resetter OriginSelectorForceResetter) { + e.originSelectorResetter = resetter +} + +// ForceReset performs a forced reset to the specified block references +func (e *EngineController) ForceReset(ctx context.Context, localUnsafe, crossUnsafe, localSafe, crossSafe, finalized eth.L2BlockRef) { + // Reset other components before resetting the engine + if e.attributesResetter != nil { + e.attributesResetter.ForceReset(ctx, localUnsafe, crossUnsafe, localSafe, crossSafe, finalized) + } + if e.pipelineResetter != nil { + e.pipelineResetter.ResetPipeline() + } + // originSelectorResetter is only present when sequencing is enabled + if e.originSelectorResetter != nil { + e.originSelectorResetter.ResetOrigins() + } + + ForceEngineReset(e, localUnsafe, crossUnsafe, localSafe, crossSafe, finalized) + + if e.pipelineResetter != nil { + e.emitter.Emit(ctx, derive.ConfirmPipelineResetEvent{}) + } + + // Time to apply the changes to the underlying engine + e.TryUpdateEngine(ctx) + + v := EngineResetConfirmedEvent{ + LocalUnsafe: e.UnsafeL2Head(), + CrossUnsafe: e.CrossUnsafeL2Head(), + LocalSafe: e.LocalSafeL2Head(), + CrossSafe: e.SafeL2Head(), + Finalized: e.Finalized(), + } + // We do not emit the original event values, since those might not be set (optional attributes). + e.emitter.Emit(ctx, v) + e.log.Info("Reset of Engine is completed", + "local_unsafe", v.LocalUnsafe, + "cross_unsafe", v.CrossUnsafe, + "local_safe", v.LocalSafe, + "cross_safe", v.CrossSafe, + "finalized", v.Finalized, + ) +} diff --git a/op-node/rollup/engine/engine_reset.go b/op-node/rollup/engine/engine_reset.go index 9fcfe25f57c..7a1e327737c 100644 --- a/op-node/rollup/engine/engine_reset.go +++ b/op-node/rollup/engine/engine_reset.go @@ -31,6 +31,8 @@ type EngineResetDeriver struct { syncCfg *sync.Config emitter event.Emitter + + engController *EngineController } func NewEngineResetDeriver(ctx context.Context, log log.Logger, cfg *rollup.Config, @@ -45,6 +47,10 @@ func NewEngineResetDeriver(ctx context.Context, log log.Logger, cfg *rollup.Conf } } +func (d *EngineResetDeriver) SetEngController(engController *EngineController) { + d.engController = engController +} + func (d *EngineResetDeriver) AttachEmitter(em event.Emitter) { d.emitter = em } @@ -59,13 +65,7 @@ func (d *EngineResetDeriver) OnEvent(ctx context.Context, ev event.Event) bool { }) return true } - d.emitter.Emit(ctx, rollup.ForceResetEvent{ - LocalUnsafe: result.Unsafe, - CrossUnsafe: result.Unsafe, - LocalSafe: result.Safe, - CrossSafe: result.Safe, - Finalized: result.Finalized, - }) + d.engController.ForceReset(ctx, result.Unsafe, result.Unsafe, result.Safe, result.Safe, result.Finalized) default: return false } diff --git a/op-node/rollup/engine/events.go b/op-node/rollup/engine/events.go index 0a0c007c73f..c59a54d063e 100644 --- a/op-node/rollup/engine/events.go +++ b/op-node/rollup/engine/events.go @@ -1,11 +1,8 @@ package engine import ( - "time" - "github.com/ethereum/go-ethereum/common" - "github.com/ethereum-optimism/optimism/op-node/rollup" "github.com/ethereum-optimism/optimism/op-node/rollup/derive" "github.com/ethereum-optimism/optimism/op-service/eth" ) @@ -49,16 +46,6 @@ func (ev PromoteCrossUnsafeEvent) String() string { return "promote-cross-unsafe" } -// CrossUnsafeUpdateEvent signals that the given block is now considered cross-unsafe. -type CrossUnsafeUpdateEvent struct { - CrossUnsafe eth.L2BlockRef - LocalUnsafe eth.L2BlockRef -} - -func (ev CrossUnsafeUpdateEvent) String() string { - return "cross-unsafe-update" -} - type PendingSafeUpdateEvent struct { PendingSafe eth.L2BlockRef Unsafe eth.L2BlockRef // tip, added to the signal, to determine if there are existing blocks to consolidate @@ -68,15 +55,6 @@ func (ev PendingSafeUpdateEvent) String() string { return "pending-safe-update" } -type CrossSafeUpdateEvent struct { - CrossSafe eth.L2BlockRef - LocalSafe eth.L2BlockRef -} - -func (ev CrossSafeUpdateEvent) String() string { - return "cross-safe-update" -} - // LocalSafeUpdateEvent signals that a block is now considered to be local-safe. type LocalSafeUpdateEvent struct { Ref eth.L2BlockRef @@ -87,18 +65,8 @@ func (ev LocalSafeUpdateEvent) String() string { return "local-safe-update" } -// PromoteSafeEvent signals that a block can be promoted to cross-safe. -type PromoteSafeEvent struct { - Ref eth.L2BlockRef - Source eth.L1BlockRef -} - -func (ev PromoteSafeEvent) String() string { - return "promote-safe" -} - // SafeDerivedEvent signals that a block was determined to be safe, and derived from the given L1 block. -// This is signaled upon successful processing of PromoteSafeEvent. +// This is signaled upon procedural call of PromoteSafe method type SafeDerivedEvent struct { Safe eth.L2BlockRef Source eth.L1BlockRef @@ -108,13 +76,6 @@ func (ev SafeDerivedEvent) String() string { return "safe-derived" } -type PendingSafeRequestEvent struct { -} - -func (ev PendingSafeRequestEvent) String() string { - return "pending-safe-request" -} - type ProcessUnsafePayloadEvent struct { Envelope *eth.ExecutionPayloadEnvelope } @@ -123,67 +84,6 @@ func (ev ProcessUnsafePayloadEvent) String() string { return "process-unsafe-payload" } -type TryUpdateEngineEvent struct { - // These fields will be zero-value (BuildStarted,InsertStarted=time.Time{}, Envelope=nil) if - // this event is emitted outside of engineDeriver.onPayloadSuccess - BuildStarted time.Time - InsertStarted time.Time - Envelope *eth.ExecutionPayloadEnvelope -} - -func (ev TryUpdateEngineEvent) String() string { - return "try-update-engine" -} - -// Checks for the existence of the Envelope field, which is only -// added by the PayloadSuccessEvent -func (ev TryUpdateEngineEvent) triggeredByPayloadSuccess() bool { - return ev.Envelope != nil -} - -// Returns key/value pairs that can be logged and are useful for plotting -// block build/insert time as a way to measure performance. -func (ev TryUpdateEngineEvent) getBlockProcessingMetrics() []interface{} { - fcuFinish := time.Now() - payload := ev.Envelope.ExecutionPayload - - logValues := []interface{}{ - "hash", payload.BlockHash, - "number", uint64(payload.BlockNumber), - "state_root", payload.StateRoot, - "timestamp", uint64(payload.Timestamp), - "parent", payload.ParentHash, - "prev_randao", payload.PrevRandao, - "fee_recipient", payload.FeeRecipient, - "txs", len(payload.Transactions), - } - - var totalTime time.Duration - var mgasps float64 - if !ev.BuildStarted.IsZero() { - totalTime = fcuFinish.Sub(ev.BuildStarted) - logValues = append(logValues, - "build_time", common.PrettyDuration(ev.InsertStarted.Sub(ev.BuildStarted)), - "insert_time", common.PrettyDuration(fcuFinish.Sub(ev.InsertStarted)), - ) - } else if !ev.InsertStarted.IsZero() { - totalTime = fcuFinish.Sub(ev.InsertStarted) - } - - // Avoid divide-by-zero for mgasps - if totalTime > 0 { - mgasps = float64(payload.GasUsed) * 1000 / float64(totalTime) - } - - logValues = append(logValues, - "total_time", common.PrettyDuration(totalTime), - "mgas", float64(payload.GasUsed)/1000000, - "mgasps", mgasps, - ) - - return logValues -} - type EngineResetConfirmedEvent struct { LocalUnsafe eth.L2BlockRef CrossUnsafe eth.L2BlockRef @@ -196,15 +96,6 @@ func (ev EngineResetConfirmedEvent) String() string { return "engine-reset-confirmed" } -// PromoteFinalizedEvent signals that a block can be marked as finalized. -type PromoteFinalizedEvent struct { - Ref eth.L2BlockRef -} - -func (ev PromoteFinalizedEvent) String() string { - return "promote-finalized" -} - // FinalizedUpdateEvent signals that a block has been marked as finalized. type FinalizedUpdateEvent struct { Ref eth.L2BlockRef @@ -214,16 +105,6 @@ func (ev FinalizedUpdateEvent) String() string { return "finalized-update" } -// CrossUpdateRequestEvent triggers update events to be emitted, repeating the current state. -type CrossUpdateRequestEvent struct { - CrossUnsafe bool - CrossSafe bool -} - -func (ev CrossUpdateRequestEvent) String() string { - return "cross-update-request" -} - // InteropInvalidateBlockEvent is emitted when a block needs to be invalidated, and a replacement is needed. type InteropInvalidateBlockEvent struct { Invalidated eth.BlockRef @@ -254,21 +135,21 @@ type ResetEngineControl interface { SetPendingSafeL2Head(eth.L2BlockRef) } -func ForceEngineReset(ec ResetEngineControl, x rollup.ForceResetEvent) { - ec.SetUnsafeHead(x.LocalUnsafe) +func ForceEngineReset(ec ResetEngineControl, localUnsafe, crossUnsafe, localSafe, crossSafe, finalized eth.L2BlockRef) { + ec.SetUnsafeHead(localUnsafe) // cross-safe is fine to revert back, it does not affect engine logic, just sync-status - ec.SetCrossUnsafeHead(x.CrossUnsafe) + ec.SetCrossUnsafeHead(crossUnsafe) // derivation continues at local-safe point - ec.SetLocalSafeHead(x.LocalSafe) - ec.SetPendingSafeL2Head(x.LocalSafe) + ec.SetLocalSafeHead(localSafe) + ec.SetPendingSafeL2Head(localSafe) // "safe" in RPC terms is cross-safe - ec.SetSafeHead(x.CrossSafe) + ec.SetSafeHead(crossSafe) // finalized head - ec.SetFinalizedHead(x.Finalized) + ec.SetFinalizedHead(finalized) ec.SetBackupUnsafeL2Head(eth.L2BlockRef{}, false) } diff --git a/op-node/rollup/engine/payload_success.go b/op-node/rollup/engine/payload_success.go index c95ac04bfe9..3c4dce977e0 100644 --- a/op-node/rollup/engine/payload_success.go +++ b/op-node/rollup/engine/payload_success.go @@ -4,7 +4,6 @@ import ( "context" "time" - "github.com/ethereum-optimism/optimism/op-node/rollup" "github.com/ethereum-optimism/optimism/op-service/eth" ) @@ -29,25 +28,19 @@ func (eq *EngineController) onPayloadSuccess(ctx context.Context, ev PayloadSucc eq.log.Warn("Successfully built replacement block, resetting chain to continue now", "replacement", ev.Ref) // Change the engine state to make the replacement block the cross-safe head of the chain, // And continue syncing from there. - eq.emitter.Emit(ctx, rollup.ForceResetEvent{ - LocalUnsafe: ev.Ref, - CrossUnsafe: ev.Ref, - LocalSafe: ev.Ref, - CrossSafe: ev.Ref, - Finalized: eq.Finalized(), - }) + eq.ForceReset(ctx, ev.Ref, ev.Ref, ev.Ref, ev.Ref, eq.Finalized()) eq.emitter.Emit(ctx, InteropReplacedBlockEvent{ Envelope: ev.Envelope, Ref: ev.Ref.BlockRef(), }) // Apply it to the execution engine - eq.emitter.Emit(ctx, TryUpdateEngineEvent{}) + eq.TryUpdateEngine(ctx) // Not a regular reset, since we don't wind back to any L2 block. // We start specifically from the replacement block. return } - // TryUpdateUnsafe, TryUpdatePendingSafe, TryUpdateLocalSafe, TryUpdateEngine must be sequentially invoked + // TryUpdateUnsafe, TryUpdatePendingSafe, TryUpdateLocalSafe, tryUpdateEngine must be sequentially invoked eq.TryUpdateUnsafe(ctx, ev.Ref) // If derived from L1, then it can be considered (pending) safe if ev.DerivedFrom != (eth.L1BlockRef{}) { @@ -55,7 +48,7 @@ func (eq *EngineController) onPayloadSuccess(ctx context.Context, ev PayloadSucc eq.TryUpdateLocalSafe(ctx, ev.Ref, ev.Concluding, ev.DerivedFrom) } // Now if possible synchronously call FCU - err := eq.TryUpdateEngine(ctx) + err := eq.tryUpdateEngine(ctx) if err != nil { eq.log.Error("Failed to update engine", "error", err) } diff --git a/op-node/rollup/event.go b/op-node/rollup/event.go index efd5f40cc03..4e268240fd4 100644 --- a/op-node/rollup/event.go +++ b/op-node/rollup/event.go @@ -1,7 +1,6 @@ package rollup import ( - "github.com/ethereum-optimism/optimism/op-service/eth" "github.com/ethereum-optimism/optimism/op-service/event" ) @@ -40,17 +39,5 @@ func (ev ResetEvent) String() string { return "reset-event" } -// ForceResetEvent forces a reset to a specific local-unsafe/local-safe/finalized starting point. -// Resets may override local-unsafe, to reset the very end of the chain. -// Resets may override local-safe, since post-interop we need the local-safe block derivation to continue. -// Pre-interop both local and cross values should be set the same. -type ForceResetEvent struct { - LocalUnsafe, CrossUnsafe, LocalSafe, CrossSafe, Finalized eth.L2BlockRef -} - -func (ev ForceResetEvent) String() string { - return "force-reset" -} - // CriticalErrorEvent is an alias for event.CriticalErrorEvent type CriticalErrorEvent = event.CriticalErrorEvent diff --git a/op-node/rollup/finality/altda.go b/op-node/rollup/finality/altda.go index 1d87d1f0f53..ae32725c70e 100644 --- a/op-node/rollup/finality/altda.go +++ b/op-node/rollup/finality/altda.go @@ -29,9 +29,9 @@ type AltDAFinalizer struct { func NewAltDAFinalizer(ctx context.Context, log log.Logger, cfg *rollup.Config, l1Fetcher FinalizerL1Interface, - backend AltDABackend) *AltDAFinalizer { + backend AltDABackend, ec EngineController) *AltDAFinalizer { - inner := NewFinalizer(ctx, log, cfg, l1Fetcher) + inner := NewFinalizer(ctx, log, cfg, l1Fetcher, ec) // In alt-da mode, the finalization signal is proxied through the AltDA manager. // Finality signal will come from the DA contract or L1 finality whichever is last. diff --git a/op-node/rollup/finality/altda_test.go b/op-node/rollup/finality/altda_test.go index a33f7053207..a3c1a384386 100644 --- a/op-node/rollup/finality/altda_test.go +++ b/op-node/rollup/finality/altda_test.go @@ -35,6 +35,16 @@ func (b *fakeAltDABackend) OnFinalizedHeadSignal(f altda.HeadSignalFn) { var _ AltDABackend = (*fakeAltDABackend)(nil) +type fakeEngineController struct { + finalizedL2 eth.L2BlockRef +} + +var _ EngineController = (*fakeEngineController)(nil) + +func (f *fakeEngineController) PromoteFinalized(_ context.Context, ref eth.L2BlockRef) { + f.finalizedL2 = ref +} + func TestAltDAFinalityData(t *testing.T) { logger := testlog.Logger(t, log.LevelInfo) l1F := &testutils.MockL1Source{} @@ -97,7 +107,8 @@ func TestAltDAFinalityData(t *testing.T) { } emitter := &testutils.MockEmitter{} - fi := NewAltDAFinalizer(context.Background(), logger, cfg, l1F, altDABackend) + ec := new(fakeEngineController) + fi := NewAltDAFinalizer(context.Background(), logger, cfg, l1F, altDABackend, ec) fi.AttachEmitter(emitter) require.NotNil(t, altDABackend.forwardTo, "altda backend must have access to underlying standard finalizer") @@ -167,20 +178,12 @@ func TestAltDAFinalityData(t *testing.T) { // of the safe block matches that of the finalized L1 block. l1F.ExpectL1BlockRefByNumber(commitmentInclusionFinalized.Number, commitmentInclusionFinalized, nil) l1F.ExpectL1BlockRefByNumber(commitmentInclusionFinalized.Number, commitmentInclusionFinalized, nil) - var finalizedL2 eth.L2BlockRef - emitter.ExpectOnceRun(func(ev event.Event) { - if x, ok := ev.(engine.PromoteFinalizedEvent); ok { - finalizedL2 = x.Ref - } else { - t.Fatalf("expected L2 finalization, but got: %s", ev) - } - }) fi.OnEvent(context.Background(), TryFinalizeEvent{}) l1F.AssertExpectations(t) emitter.AssertExpectations(t) - require.Equal(t, commitmentInclusionFinalized.Number, finalizedL2.L1Origin.Number+1) + require.Equal(t, commitmentInclusionFinalized.Number, ec.finalizedL2.L1Origin.Number+1) // Confirm finalization, so there will be no repeats of the PromoteFinalizedEvent - fi.OnEvent(context.Background(), engine.ForkchoiceUpdateEvent{FinalizedL2Head: finalizedL2}) + fi.OnEvent(context.Background(), engine.ForkchoiceUpdateEvent{FinalizedL2Head: ec.finalizedL2}) emitter.AssertExpectations(t) } } diff --git a/op-node/rollup/finality/finalizer.go b/op-node/rollup/finality/finalizer.go index 4d7e44cecf3..4d520696d94 100644 --- a/op-node/rollup/finality/finalizer.go +++ b/op-node/rollup/finality/finalizer.go @@ -66,6 +66,10 @@ type FinalizerL1Interface interface { L1BlockRefByNumber(context.Context, uint64) (eth.L1BlockRef, error) } +type EngineController interface { + PromoteFinalized(context.Context, eth.L2BlockRef) +} + type Finalizer struct { mu sync.Mutex @@ -77,6 +81,8 @@ type Finalizer struct { emitter event.Emitter + engineController EngineController + // finalizedL1 is the currently perceived finalized L1 block. // This may be ahead of the current traversed origin when syncing. finalizedL1 eth.L1BlockRef @@ -96,13 +102,14 @@ type Finalizer struct { l1Fetcher FinalizerL1Interface } -func NewFinalizer(ctx context.Context, log log.Logger, cfg *rollup.Config, l1Fetcher FinalizerL1Interface) *Finalizer { +func NewFinalizer(ctx context.Context, log log.Logger, cfg *rollup.Config, l1Fetcher FinalizerL1Interface, ec EngineController) *Finalizer { lookback := calcFinalityLookback(cfg) return &Finalizer{ ctx: ctx, cfg: cfg, log: log, finalizedL1: eth.L1BlockRef{}, + engineController: ec, triedFinalizeAt: 0, finalityData: make([]FinalityData, 0, lookback), finalityLookback: lookback, @@ -247,7 +254,7 @@ func (fi *Finalizer) tryFinalize() { }) return } - fi.emitter.Emit(fi.ctx, engine.PromoteFinalizedEvent{Ref: finalizedL2}) + fi.engineController.PromoteFinalized(ctx, finalizedL2) } } diff --git a/op-node/rollup/finality/finalizer_test.go b/op-node/rollup/finality/finalizer_test.go index 5bb5d78924e..4ab1cf492c1 100644 --- a/op-node/rollup/finality/finalizer_test.go +++ b/op-node/rollup/finality/finalizer_test.go @@ -193,7 +193,8 @@ func TestEngineQueue_Finalize(t *testing.T) { l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil) emitter := &testutils.MockEmitter{} - fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F) + ec := new(fakeEngineController) + fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F, ec) fi.AttachEmitter(emitter) // now say C1 was included in D and became the new safe head @@ -212,9 +213,9 @@ func TestEngineQueue_Finalize(t *testing.T) { fi.OnL1Finalized(refD) // C1 was included in finalized D, and should now be finalized - emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refC1}) fi.OnEvent(ctx, TryFinalizeEvent{}) emitter.AssertExpectations(t) + require.Equal(t, refC1, ec.finalizedL2) }) // Finality signal is received, but couldn't immediately be checked @@ -227,7 +228,8 @@ func TestEngineQueue_Finalize(t *testing.T) { l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil) // to check what was derived from (same in this case) emitter := &testutils.MockEmitter{} - fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F) + ec := new(fakeEngineController) + fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F, ec) fi.AttachEmitter(emitter) // now say C1 was included in D and became the new safe head @@ -254,9 +256,8 @@ func TestEngineQueue_Finalize(t *testing.T) { emitter.AssertExpectations(t) // C1 was included in finalized D, and should now be finalized, as check can succeed when revisited - emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refC1}) fi.OnEvent(ctx, TryFinalizeEvent{}) - emitter.AssertExpectations(t) + require.Equal(t, refC1, ec.finalizedL2) }) // Test that finality progression can repeat a few times. @@ -266,7 +267,8 @@ func TestEngineQueue_Finalize(t *testing.T) { defer l1F.AssertExpectations(t) emitter := &testutils.MockEmitter{} - fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F) + ec := new(fakeEngineController) + fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F, ec) fi.AttachEmitter(emitter) fi.OnEvent(ctx, engine.SafeDerivedEvent{Safe: refC1, Source: refD}) @@ -282,10 +284,10 @@ func TestEngineQueue_Finalize(t *testing.T) { fi.OnL1Finalized(refD) // C1 was included in D, and should be finalized now - emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refC1}) l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil) l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil) fi.OnEvent(ctx, TryFinalizeEvent{}) + require.Equal(t, refC1, ec.finalizedL2) emitter.AssertExpectations(t) l1F.AssertExpectations(t) @@ -294,10 +296,10 @@ func TestEngineQueue_Finalize(t *testing.T) { fi.OnL1Finalized(refE) // D0 was included in E, and should be finalized now - emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refD0}) l1F.ExpectL1BlockRefByNumber(refE.Number, refE, nil) l1F.ExpectL1BlockRefByNumber(refE.Number, refE, nil) fi.OnEvent(ctx, TryFinalizeEvent{}) + require.Equal(t, refD0, ec.finalizedL2) emitter.AssertExpectations(t) l1F.AssertExpectations(t) @@ -331,10 +333,10 @@ func TestEngineQueue_Finalize(t *testing.T) { fi.OnL1Finalized(refH) // F1 should be finalized now, since it was included in H - emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refF1}) l1F.ExpectL1BlockRefByNumber(refH.Number, refH, nil) l1F.ExpectL1BlockRefByNumber(refH.Number, refH, nil) fi.OnEvent(ctx, TryFinalizeEvent{}) + require.Equal(t, refF1, ec.finalizedL2) emitter.AssertExpectations(t) l1F.AssertExpectations(t) }) @@ -349,7 +351,8 @@ func TestEngineQueue_Finalize(t *testing.T) { l1F.ExpectL1BlockRefByNumber(refC.Number, refC, nil) // check what we derived the L2 block from emitter := &testutils.MockEmitter{} - fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F) + ec := new(fakeEngineController) + fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F, ec) fi.AttachEmitter(emitter) // now say B1 was included in C and became the new safe head @@ -367,8 +370,8 @@ func TestEngineQueue_Finalize(t *testing.T) { fi.OnL1Finalized(refD) // B1 was included in finalized D, and should now be finalized - emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refB1}) fi.OnEvent(ctx, TryFinalizeEvent{}) + require.Equal(t, refB1, ec.finalizedL2) emitter.AssertExpectations(t) }) @@ -385,7 +388,8 @@ func TestEngineQueue_Finalize(t *testing.T) { l1F.ExpectL1BlockRefByNumber(refE.Number, refE, nil) // post-reorg emitter := &testutils.MockEmitter{} - fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F) + ec := new(fakeEngineController) + fi := NewFinalizer(context.Background(), logger, &rollup.Config{}, l1F, ec) fi.AttachEmitter(emitter) // now say B1 was included in C and became the new safe head @@ -464,8 +468,8 @@ func TestEngineQueue_Finalize(t *testing.T) { emitter.ExpectOnce(TryFinalizeEvent{}) fi.OnEvent(ctx, derive.DeriverIdleEvent{Origin: refE}) emitter.AssertExpectations(t) - emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refC0}) fi.OnEvent(ctx, TryFinalizeEvent{}) + require.Equal(t, refC0, ec.finalizedL2) emitter.AssertExpectations(t) }) @@ -479,9 +483,10 @@ func TestEngineQueue_Finalize(t *testing.T) { l1F.ExpectL1BlockRefByNumber(refD.Number, refD, nil) emitter := &testutils.MockEmitter{} + ec := new(fakeEngineController) fi := NewFinalizer(context.Background(), logger, &rollup.Config{ InteropTime: &refC1.Time, - }, l1F) + }, l1F, ec) fi.AttachEmitter(emitter) // now say C0 and C1 were included in D and became the new safe head @@ -494,8 +499,8 @@ func TestEngineQueue_Finalize(t *testing.T) { fi.OnL1Finalized(refD) // C1 was Interop, C0 was not yet interop and can be finalized - emitter.ExpectOnce(engine.PromoteFinalizedEvent{Ref: refC0}) fi.OnEvent(ctx, TryFinalizeEvent{}) + require.Equal(t, refC0, ec.finalizedL2) emitter.AssertExpectations(t) }) } diff --git a/op-node/rollup/interop/indexing/attributes.go b/op-node/rollup/interop/indexing/attributes.go index 0dfa09aab7f..b0feb434896 100644 --- a/op-node/rollup/interop/indexing/attributes.go +++ b/op-node/rollup/interop/indexing/attributes.go @@ -54,7 +54,7 @@ func AttributesToReplaceInvalidBlock(invalidatedBlock *eth.ExecutionPayloadEnvel // unfortunately, the engine API needs the inner value, not the extra-data. // So we translate it here. extraData := invalidatedBlock.ExecutionPayload.ExtraData - denominator, elasticity := eip1559.DecodeHoloceneExtraData(extraData) + denominator, elasticity, minBaseFee := eip1559.DecodeJovianExtraData(extraData) eip1559Params := eth.Bytes8(eip1559.EncodeHolocene1559Params(denominator, elasticity)) attrs := ð.PayloadAttributes{ @@ -67,6 +67,7 @@ func AttributesToReplaceInvalidBlock(invalidatedBlock *eth.ExecutionPayloadEnvel NoTxPool: true, GasLimit: &gasLimit, EIP1559Params: &eip1559Params, + MinBaseFee: minBaseFee, } return attrs } diff --git a/op-node/rollup/interop/indexing/system.go b/op-node/rollup/interop/indexing/system.go index e316fa9ccd4..61a7d9c5194 100644 --- a/op-node/rollup/interop/indexing/system.go +++ b/op-node/rollup/interop/indexing/system.go @@ -45,6 +45,11 @@ type L1Source interface { L1BlockRefByHash(ctx context.Context, hash common.Hash) (eth.L1BlockRef, error) L1BlockRefByNumber(ctx context.Context, num uint64) (eth.L1BlockRef, error) } +type EngineController interface { + ForceReset(ctx context.Context, localUnsafe, crossUnsafe, localSafe, crossSafe, finalized eth.L2BlockRef) + PromoteSafe(ctx context.Context, ref eth.L2BlockRef, source eth.L1BlockRef) + PromoteFinalized(ctx context.Context, ref eth.L2BlockRef) +} // IndexingMode makes the op-node managed by an op-supervisor, // by serving sync work and updating the canonical chain based on instructions. @@ -73,6 +78,8 @@ type IndexingMode struct { srv *rpc.Server jwtSecret eth.Bytes32 + + engineController EngineController } func NewIndexingMode(log log.Logger, cfg *rollup.Config, addr string, port int, jwtSecret eth.Bytes32, l1 L1Source, l2 L2Source, m opmetrics.RPCMetricer) *IndexingMode { @@ -111,6 +118,10 @@ func NewIndexingMode(log log.Logger, cfg *rollup.Config, addr string, port int, return out } +func (m *IndexingMode) SetEngineController(engineController EngineController) { + m.engineController = engineController +} + // TestDisableEventDeduplication is a test-only function that disables event deduplication. // It is necessary to make action tests work. func (m *IndexingMode) TestDisableEventDeduplication() { @@ -288,12 +299,7 @@ func (m *IndexingMode) UpdateCrossSafe(ctx context.Context, derived eth.BlockID, if err != nil { return fmt.Errorf("failed to get L1BlockRef: %w", err) } - m.emitter.Emit(m.ctx, engine.PromoteSafeEvent{ - Ref: l2Ref, - Source: l1Ref, - }) - // We return early: there is no point waiting for the cross-safe engine-update synchronously. - // All error-feedback comes to the supervisor by aborting derivation tasks with an error. + m.engineController.PromoteSafe(ctx, l2Ref, l1Ref) return nil } @@ -302,9 +308,7 @@ func (m *IndexingMode) UpdateFinalized(ctx context.Context, id eth.BlockID) erro if err != nil { return fmt.Errorf("failed to get L2BlockRef: %w", err) } - m.emitter.Emit(m.ctx, engine.PromoteFinalizedEvent{Ref: l2Ref}) - // We return early: there is no point waiting for the finalized engine-update synchronously. - // All error-feedback comes to the supervisor by aborting derivation tasks with an error. + m.engineController.PromoteFinalized(ctx, l2Ref) return nil } @@ -450,13 +454,7 @@ func (m *IndexingMode) Reset(ctx context.Context, lUnsafe, xUnsafe, lSafe, xSafe return err } - m.emitter.Emit(ctx, rollup.ForceResetEvent{ - LocalUnsafe: lUnsafeRef, - CrossUnsafe: xUnsafeRef, - LocalSafe: lSafeRef, - CrossSafe: xSafeRef, - Finalized: finalizedRef, - }) + m.engineController.ForceReset(ctx, lUnsafeRef, xUnsafeRef, lSafeRef, xSafeRef, finalizedRef) return nil } diff --git a/op-node/rollup/sequencing/origin_selector.go b/op-node/rollup/sequencing/origin_selector.go index 938c16affe4..255522d4644 100644 --- a/op-node/rollup/sequencing/origin_selector.go +++ b/op-node/rollup/sequencing/origin_selector.go @@ -54,12 +54,16 @@ func (los *L1OriginSelector) SetRecoverMode(enabled bool) { los.recoverMode.Store(enabled) } +func (los *L1OriginSelector) ResetOrigins() { + los.reset() +} + func (los *L1OriginSelector) OnEvent(ctx context.Context, ev event.Event) bool { switch x := ev.(type) { case engine.ForkchoiceUpdateEvent: los.onForkchoiceUpdate(x.UnsafeL2Head) - case rollup.ResetEvent, rollup.ForceResetEvent: - los.reset() + case rollup.ResetEvent: + los.ResetOrigins() default: return false } diff --git a/op-node/rollup/sequencing/sequencer_test.go b/op-node/rollup/sequencing/sequencer_test.go index 353388a9a6c..bcdd6cdd790 100644 --- a/op-node/rollup/sequencing/sequencer_test.go +++ b/op-node/rollup/sequencing/sequencer_test.go @@ -171,6 +171,8 @@ func (fakeEngController) TryUpdatePendingSafe(ctx context.Context, ref eth.L2Blo func (fakeEngController) TryUpdateLocalSafe(ctx context.Context, ref eth.L2BlockRef, concluding bool, source eth.L1BlockRef) { } +func (fakeEngController) RequestPendingSafeUpdate(ctx context.Context) {} + // TestSequencer_StartStop runs through start/stop state back and forth to test state changes. func TestSequencer_StartStop(t *testing.T) { logger := testlog.Logger(t, log.LevelError) @@ -714,6 +716,8 @@ func createSequencer(log log.Logger) (*Sequencer, *sequencerTestDeps) { FjordTime: new(uint64), GraniteTime: new(uint64), HoloceneTime: new(uint64), + IsthmusTime: new(uint64), + JovianTime: new(uint64), } deps := &sequencerTestDeps{ cfg: cfg, diff --git a/op-node/rollup/status/status.go b/op-node/rollup/status/status.go index f0f95f98e93..b6419f26f2c 100644 --- a/op-node/rollup/status/status.go +++ b/op-node/rollup/status/status.go @@ -14,6 +14,9 @@ import ( "github.com/ethereum-optimism/optimism/op-service/event" ) +// Compile-time interface compliance check +var _ engine.CrossUpdateHandler = (*StatusTracker)(nil) + type Metrics interface { RecordL1ReorgDepth(d uint64) RecordL1Ref(name string, ref eth.L1BlockRef) @@ -60,17 +63,9 @@ func (st *StatusTracker) OnEvent(ctx context.Context, ev event.Event) bool { case engine.PendingSafeUpdateEvent: st.data.UnsafeL2 = x.Unsafe st.data.PendingSafeL2 = x.PendingSafe - case engine.CrossUnsafeUpdateEvent: - st.log.Debug("Cross unsafe head updated", "cross_unsafe", x.CrossUnsafe, "local_unsafe", x.LocalUnsafe) - st.data.CrossUnsafeL2 = x.CrossUnsafe - st.data.UnsafeL2 = x.LocalUnsafe case engine.LocalSafeUpdateEvent: st.log.Debug("Local safe head updated", "local_safe", x.Ref) st.data.LocalSafeL2 = x.Ref - case engine.CrossSafeUpdateEvent: - st.log.Debug("Cross safe head updated", "cross_safe", x.CrossSafe, "local_safe", x.LocalSafe) - st.data.SafeL2 = x.CrossSafe - st.data.LocalSafeL2 = x.LocalSafe case derive.DeriverL1StatusEvent: st.data.CurrentL1 = x.Origin case rollup.ResetEvent: @@ -151,3 +146,25 @@ func (st *StatusTracker) SyncStatus() *eth.SyncStatus { func (st *StatusTracker) L1Head() eth.L1BlockRef { return st.SyncStatus().HeadL1 } + +func (st *StatusTracker) OnCrossUnsafeUpdate(ctx context.Context, crossUnsafe eth.L2BlockRef, localUnsafe eth.L2BlockRef) { + st.mu.Lock() + defer st.mu.Unlock() + + st.log.Debug("Cross unsafe head updated", "cross_unsafe", crossUnsafe, "local_unsafe", localUnsafe) + st.data.CrossUnsafeL2 = crossUnsafe + st.data.UnsafeL2 = localUnsafe + + st.UpdateSyncStatus() +} + +func (st *StatusTracker) OnCrossSafeUpdate(ctx context.Context, crossSafe eth.L2BlockRef, localSafe eth.L2BlockRef) { + st.mu.Lock() + defer st.mu.Unlock() + + st.log.Debug("Cross safe head updated", "cross_safe", crossSafe, "local_safe", localSafe) + st.data.SafeL2 = crossSafe + st.data.LocalSafeL2 = localSafe + + st.UpdateSyncStatus() +} diff --git a/op-node/rollup/types.go b/op-node/rollup/types.go index 28f9e195644..5a2ede09aba 100644 --- a/op-node/rollup/types.go +++ b/op-node/rollup/types.go @@ -11,6 +11,7 @@ import ( altda "github.com/ethereum-optimism/optimism/op-alt-da" "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum/go-ethereum" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/core/types" "github.com/ethereum/go-ethereum/log" @@ -165,14 +166,14 @@ type Config struct { } // ValidateL1Config checks L1 config variables for errors. -func (cfg *Config) ValidateL1Config(ctx context.Context, client L1Client) error { +func (cfg *Config) ValidateL1Config(ctx context.Context, logger log.Logger, client L1Client) error { // Validate the L1 Client Chain ID if err := cfg.CheckL1ChainID(ctx, client); err != nil { return err } // Validate the Rollup L1 Genesis Blockhash - if err := cfg.CheckL1GenesisBlockHash(ctx, client); err != nil { + if err := cfg.CheckL1GenesisBlockHash(ctx, logger, client); err != nil { return err } @@ -233,9 +234,14 @@ func (cfg *Config) CheckL1ChainID(ctx context.Context, client L1Client) error { } // CheckL1GenesisBlockHash checks that the configured L1 genesis block hash is valid for the given client. -func (cfg *Config) CheckL1GenesisBlockHash(ctx context.Context, client L1Client) error { +func (cfg *Config) CheckL1GenesisBlockHash(ctx context.Context, logger log.Logger, client L1Client) error { l1GenesisBlockRef, err := client.L1BlockRefByNumber(ctx, cfg.Genesis.L1.Number) if err != nil { + if errors.Is(eth.MaybeAsNotFoundErr(err), ethereum.NotFound) { + // Genesis block isn't available to check, so just accept it and hope for the best + logger.Warn("L1 genesis block not found, skipping validity check") + return nil + } return fmt.Errorf("failed to get L1 genesis blockhash: %w", err) } if l1GenesisBlockRef.Hash != cfg.Genesis.L1.Hash { @@ -425,54 +431,59 @@ func (c *Config) L1Signer() types.Signer { return types.LatestSignerForChainID(c.L1ChainID) } +func (c *Config) IsForkActive(fork ForkName, timestamp uint64) bool { + activationTime := c.ActivationTimeFor(fork) + return activationTime != nil && timestamp >= *activationTime +} + // IsRegolith returns true if the Regolith hardfork is active at or past the given timestamp. func (c *Config) IsRegolith(timestamp uint64) bool { - return c.RegolithTime != nil && timestamp >= *c.RegolithTime + return c.IsForkActive(Regolith, timestamp) } // IsCanyon returns true if the Canyon hardfork is active at or past the given timestamp. func (c *Config) IsCanyon(timestamp uint64) bool { - return c.CanyonTime != nil && timestamp >= *c.CanyonTime + return c.IsForkActive(Canyon, timestamp) } // IsDelta returns true if the Delta hardfork is active at or past the given timestamp. func (c *Config) IsDelta(timestamp uint64) bool { - return c.DeltaTime != nil && timestamp >= *c.DeltaTime + return c.IsForkActive(Delta, timestamp) } // IsEcotone returns true if the Ecotone hardfork is active at or past the given timestamp. func (c *Config) IsEcotone(timestamp uint64) bool { - return c.EcotoneTime != nil && timestamp >= *c.EcotoneTime + return c.IsForkActive(Ecotone, timestamp) } // IsFjord returns true if the Fjord hardfork is active at or past the given timestamp. func (c *Config) IsFjord(timestamp uint64) bool { - return c.FjordTime != nil && timestamp >= *c.FjordTime + return c.IsForkActive(Fjord, timestamp) } // IsGranite returns true if the Granite hardfork is active at or past the given timestamp. func (c *Config) IsGranite(timestamp uint64) bool { - return c.GraniteTime != nil && timestamp >= *c.GraniteTime + return c.IsForkActive(Granite, timestamp) } // IsHolocene returns true if the Holocene hardfork is active at or past the given timestamp. func (c *Config) IsHolocene(timestamp uint64) bool { - return c.HoloceneTime != nil && timestamp >= *c.HoloceneTime + return c.IsForkActive(Holocene, timestamp) } // IsIsthmus returns true if the Isthmus hardfork is active at or past the given timestamp. func (c *Config) IsIsthmus(timestamp uint64) bool { - return c.IsthmusTime != nil && timestamp >= *c.IsthmusTime + return c.IsForkActive(Isthmus, timestamp) } // IsJovian returns true if the Jovian hardfork is active at or past the given timestamp. func (c *Config) IsJovian(timestamp uint64) bool { - return c.JovianTime != nil && timestamp >= *c.JovianTime + return c.IsForkActive(Jovian, timestamp) } // IsInterop returns true if the Interop hardfork is active at or past the given timestamp. func (c *Config) IsInterop(timestamp uint64) bool { - return c.InteropTime != nil && timestamp >= *c.InteropTime + return c.IsForkActive(Interop, timestamp) } func (c *Config) IsRegolithActivationBlock(l2BlockTime uint64) bool { @@ -547,14 +558,43 @@ func (c *Config) IsInteropActivationBlock(l2BlockTime uint64) bool { !c.IsInterop(l2BlockTime-c.BlockTime) } +func (c *Config) ActivationTimeFor(fork ForkName) *uint64 { + switch fork { + case Interop: + return c.InteropTime + case Jovian: + return c.JovianTime + case Isthmus: + return c.IsthmusTime + case Holocene: + return c.HoloceneTime + case Granite: + return c.GraniteTime + case Fjord: + return c.FjordTime + case Ecotone: + return c.EcotoneTime + case Delta: + return c.DeltaTime + case Canyon: + return c.CanyonTime + case Regolith: + return c.RegolithTime + default: + panic(fmt.Sprintf("unknown fork: %v", fork)) + } +} + // IsActivationBlock returns the fork which activates at the block with time newTime if the previous // block's time is oldTime. It return an empty ForkName if no fork activation takes place between // those timestamps. It can be used for both, L1 and L2 blocks. -// TODO(12490): Currently only supports Holocene. Will be modularized in a follow-up. func (c *Config) IsActivationBlock(oldTime, newTime uint64) ForkName { if c.IsInterop(newTime) && !c.IsInterop(oldTime) { return Interop } + if c.IsJovian(newTime) && !c.IsJovian(oldTime) { + return Jovian + } if c.IsIsthmus(newTime) && !c.IsIsthmus(oldTime) { return Isthmus } diff --git a/op-node/rollup/types_test.go b/op-node/rollup/types_test.go index aad48c1757e..bb53ef9cd9e 100644 --- a/op-node/rollup/types_test.go +++ b/op-node/rollup/types_test.go @@ -3,12 +3,15 @@ package rollup import ( "context" "encoding/json" + "errors" "fmt" "math/big" "math/rand" "testing" "time" + "github.com/ethereum-optimism/optimism/op-service/testlog" + "github.com/ethereum/go-ethereum/log" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" @@ -64,6 +67,7 @@ func TestConfigJSON(t *testing.T) { type mockL1Client struct { chainID *big.Int Hash common.Hash + err error } func (m *mockL1Client) ChainID(context.Context) (*big.Int, error) { @@ -71,6 +75,9 @@ func (m *mockL1Client) ChainID(context.Context) (*big.Int, error) { } func (m *mockL1Client) L1BlockRefByNumber(ctx context.Context, number uint64) (eth.L1BlockRef, error) { + if m.err != nil { + return eth.L1BlockRef{}, m.err + } return eth.L1BlockRef{ Hash: m.Hash, Number: 100, @@ -83,7 +90,7 @@ func TestValidateL1Config(t *testing.T) { config.Genesis.L1.Number = 100 config.Genesis.L1.Hash = [32]byte{0x01} mockClient := mockL1Client{chainID: big.NewInt(100), Hash: common.Hash{0x01}} - err := config.ValidateL1Config(context.TODO(), &mockClient) + err := config.ValidateL1Config(context.TODO(), testlog.Logger(t, log.LvlInfo), &mockClient) assert.NoError(t, err) } @@ -93,10 +100,11 @@ func TestValidateL1ConfigInvalidChainIdFails(t *testing.T) { config.Genesis.L1.Number = 100 config.Genesis.L1.Hash = [32]byte{0x01} mockClient := mockL1Client{chainID: big.NewInt(100), Hash: common.Hash{0x01}} - err := config.ValidateL1Config(context.TODO(), &mockClient) + logger := testlog.Logger(t, log.LvlInfo) + err := config.ValidateL1Config(context.TODO(), logger, &mockClient) assert.Error(t, err) config.L1ChainID = big.NewInt(99) - err = config.ValidateL1Config(context.TODO(), &mockClient) + err = config.ValidateL1Config(context.TODO(), logger, &mockClient) assert.Error(t, err) } @@ -106,10 +114,11 @@ func TestValidateL1ConfigInvalidGenesisHashFails(t *testing.T) { config.Genesis.L1.Number = 100 config.Genesis.L1.Hash = [32]byte{0x00} mockClient := mockL1Client{chainID: big.NewInt(100), Hash: common.Hash{0x01}} - err := config.ValidateL1Config(context.TODO(), &mockClient) + logger := testlog.Logger(t, log.LvlInfo) + err := config.ValidateL1Config(context.TODO(), logger, &mockClient) assert.Error(t, err) config.Genesis.L1.Hash = [32]byte{0x02} - err = config.ValidateL1Config(context.TODO(), &mockClient) + err = config.ValidateL1Config(context.TODO(), logger, &mockClient) assert.Error(t, err) } @@ -125,18 +134,23 @@ func TestCheckL1ChainID(t *testing.T) { } func TestCheckL1BlockRefByNumber(t *testing.T) { + logger := testlog.Logger(t, log.LvlInfo) config := randConfig() config.Genesis.L1.Number = 100 config.Genesis.L1.Hash = [32]byte{0x01} mockClient := mockL1Client{chainID: big.NewInt(100), Hash: common.Hash{0x01}} - err := config.CheckL1GenesisBlockHash(context.TODO(), &mockClient) + err := config.CheckL1GenesisBlockHash(context.Background(), logger, &mockClient) assert.NoError(t, err) mockClient.Hash = common.Hash{0x02} - err = config.CheckL1GenesisBlockHash(context.TODO(), &mockClient) + err = config.CheckL1GenesisBlockHash(context.Background(), logger, &mockClient) assert.Error(t, err) mockClient.Hash = common.Hash{0x00} - err = config.CheckL1GenesisBlockHash(context.TODO(), &mockClient) + err = config.CheckL1GenesisBlockHash(context.Background(), logger, &mockClient) assert.Error(t, err) + + mockClient.err = errors.New("block not found") + err = config.CheckL1GenesisBlockHash(context.Background(), logger, &mockClient) + assert.NoError(t, err) } // TestRandomConfigDescription tests that the description works for different variations of a random rollup config. diff --git a/op-node/service.go b/op-node/service.go index 78216daa445..b27503f33a7 100644 --- a/op-node/service.go +++ b/op-node/service.go @@ -280,6 +280,10 @@ func applyOverrides(ctx *cli.Context, rollupConfig *rollup.Config) { isthmus := ctx.Uint64(opflags.IsthmusOverrideFlagName) rollupConfig.IsthmusTime = &isthmus } + if ctx.IsSet(opflags.JovianOverrideFlagName) { + jovian := ctx.Uint64(opflags.JovianOverrideFlagName) + rollupConfig.JovianTime = &jovian + } if ctx.IsSet(opflags.InteropOverrideFlagName) { interop := ctx.Uint64(opflags.InteropOverrideFlagName) rollupConfig.InteropTime = &interop diff --git a/op-program/client/cmd/godebug.go b/op-program/client/cmd/godebug.go new file mode 100644 index 00000000000..47bda43fa4a --- /dev/null +++ b/op-program/client/cmd/godebug.go @@ -0,0 +1,8 @@ +// Disable annotating anonymous memory mappings. Cannon doesn't support this syscall +// The directive (and functionality) only exists on go1.25 and above so this file is conditionally included. + +//go:build go1.25 + +//go:debug decoratemappings=0 + +package main diff --git a/op-program/client/driver/driver.go b/op-program/client/driver/driver.go index e6c8eb5da37..b309da7816e 100644 --- a/op-program/client/driver/driver.go +++ b/op-program/client/driver/driver.go @@ -10,6 +10,7 @@ import ( altda "github.com/ethereum-optimism/optimism/op-alt-da" "github.com/ethereum-optimism/optimism/op-node/metrics" "github.com/ethereum-optimism/optimism/op-node/rollup" + "github.com/ethereum-optimism/optimism/op-node/rollup/attributes" "github.com/ethereum-optimism/optimism/op-node/rollup/derive" "github.com/ethereum-optimism/optimism/op-node/rollup/engine" "github.com/ethereum-optimism/optimism/op-node/rollup/sync" @@ -45,15 +46,22 @@ func NewDriver(logger log.Logger, cfg *rollup.Config, depSet derive.DependencySe ec := engine.NewEngineController(context.Background(), l2Source, logger, metrics.NoopMetrics, cfg, &sync.Config{SyncMode: sync.CLSync}, d) syncCfg := &sync.Config{SyncMode: sync.CLSync} + + attrHandler := attributes.NewAttributesHandler(logger, cfg, context.Background(), l2Source, ec) + ec.SetAttributesResetter(attrHandler) + ec.SetPipelineResetter(pipelineDeriver) + engResetDeriv := engine.NewEngineResetDeriver(context.Background(), logger, cfg, l1Source, l2Source, syncCfg) engResetDeriv.AttachEmitter(d) + engResetDeriv.SetEngController(ec) prog := &ProgramDeriver{ - logger: logger, - Emitter: d, - closing: false, - result: eth.L2BlockRef{}, - targetBlockNum: targetBlockNum, + logger: logger, + Emitter: d, + engineController: ec, + closing: false, + result: eth.L2BlockRef{}, + targetBlockNum: targetBlockNum, } d.deriver = &event.DeriverMux{ diff --git a/op-program/client/driver/program.go b/op-program/client/driver/program.go index 9b9e7ad2dbf..4f1e23b1503 100644 --- a/op-program/client/driver/program.go +++ b/op-program/client/driver/program.go @@ -13,6 +13,10 @@ import ( "github.com/ethereum-optimism/optimism/op-service/event" ) +type EngineController interface { + RequestPendingSafeUpdate(context.Context) +} + // ProgramDeriver expresses how engine and derivation events are // translated and monitored to execute the pure L1 to L2 state transition. // @@ -22,6 +26,8 @@ type ProgramDeriver struct { Emitter event.Emitter + engineController EngineController + closing bool result eth.L2BlockRef resultError error @@ -42,11 +48,11 @@ func (d *ProgramDeriver) OnEvent(ctx context.Context, ev event.Event) bool { d.Emitter.Emit(ctx, derive.ConfirmPipelineResetEvent{}) // After initial reset we can request the pending-safe block, // where attributes will be generated on top of. - d.Emitter.Emit(ctx, engine.PendingSafeRequestEvent{}) + d.engineController.RequestPendingSafeUpdate(ctx) case engine.PendingSafeUpdateEvent: d.Emitter.Emit(ctx, derive.PipelineStepEvent{PendingSafe: x.PendingSafe}) case derive.DeriverMoreEvent: - d.Emitter.Emit(ctx, engine.PendingSafeRequestEvent{}) + d.engineController.RequestPendingSafeUpdate(ctx) case derive.DerivedAttributesEvent: // Allow new attributes to be generated. // We will process the current attributes synchronously, @@ -59,7 +65,7 @@ func (d *ProgramDeriver) OnEvent(ctx context.Context, ev event.Event) bool { case engine.InvalidPayloadAttributesEvent: // If a set of attributes was invalid, then we drop the attributes, // and continue with the next. - d.Emitter.Emit(ctx, engine.PendingSafeRequestEvent{}) + d.engineController.RequestPendingSafeUpdate(ctx) case engine.ForkchoiceUpdateEvent: // Track latest head. if x.SafeL2Head.Number >= d.result.Number { @@ -94,7 +100,7 @@ func (d *ProgramDeriver) OnEvent(ctx context.Context, ev event.Event) bool { // (Legacy case): While most temporary errors are due to requests for external data failing which can't happen, // they may also be returned due to other events like channels timing out so need to be handled d.logger.Warn("Temporary error in derivation", "err", x.Err) - d.Emitter.Emit(ctx, engine.PendingSafeRequestEvent{}) + d.engineController.RequestPendingSafeUpdate(ctx) case rollup.CriticalErrorEvent: d.closing = true d.resultError = x.Err diff --git a/op-program/client/driver/program_test.go b/op-program/client/driver/program_test.go index 0b8b55ef0b6..b9401512d6f 100644 --- a/op-program/client/driver/program_test.go +++ b/op-program/client/driver/program_test.go @@ -23,14 +23,21 @@ var ( errTestCrit = errors.New("crit test err") ) +type fakeEngineController struct{} + +var _ EngineController = fakeEngineController{} + +func (fakeEngineController) RequestPendingSafeUpdate(ctx context.Context) {} + func TestProgramDeriver(t *testing.T) { newProgram := func(t *testing.T, target uint64) (*ProgramDeriver, *testutils.MockEmitter) { m := &testutils.MockEmitter{} logger := testlog.Logger(t, log.LevelInfo) prog := &ProgramDeriver{ - logger: logger, - Emitter: m, - targetBlockNum: target, + logger: logger, + engineController: fakeEngineController{}, + Emitter: m, + targetBlockNum: target, } return prog, m } @@ -39,7 +46,6 @@ func TestProgramDeriver(t *testing.T) { t.Run("engine reset confirmed", func(t *testing.T) { p, m := newProgram(t, 1000) m.ExpectOnce(derive.ConfirmPipelineResetEvent{}) - m.ExpectOnce(engine.PendingSafeRequestEvent{}) p.OnEvent(context.Background(), engine.EngineResetConfirmedEvent{}) m.AssertExpectations(t) require.False(t, p.closing) @@ -60,7 +66,6 @@ func TestProgramDeriver(t *testing.T) { // step 3: if no attributes are generated, loop back to derive more. t.Run("deriver more", func(t *testing.T) { p, m := newProgram(t, 1000) - m.ExpectOnce(engine.PendingSafeRequestEvent{}) p.OnEvent(context.Background(), derive.DeriverMoreEvent{}) m.AssertExpectations(t) require.False(t, p.closing) @@ -80,7 +85,6 @@ func TestProgramDeriver(t *testing.T) { // step 5: if attributes were invalid, continue with derivation for new attributes. t.Run("invalid payload", func(t *testing.T) { p, m := newProgram(t, 1000) - m.ExpectOnce(engine.PendingSafeRequestEvent{}) p.OnEvent(context.Background(), engine.InvalidPayloadAttributesEvent{Attributes: &derive.AttributesWithParent{}}) m.AssertExpectations(t) require.False(t, p.closing) @@ -113,49 +117,42 @@ func TestProgramDeriver(t *testing.T) { }) // Do not stop processing when the deriver is idle, the engine may still be busy and create further events. t.Run("deriver idle", func(t *testing.T) { - p, m := newProgram(t, 1000) + p, _ := newProgram(t, 1000) p.OnEvent(context.Background(), derive.DeriverIdleEvent{}) - m.AssertExpectations(t) require.False(t, p.closing) require.NoError(t, p.resultError) }) // on inconsistent chain data: stop with error t.Run("reset event", func(t *testing.T) { - p, m := newProgram(t, 1000) + p, _ := newProgram(t, 1000) p.OnEvent(context.Background(), rollup.ResetEvent{Err: errTestReset}) - m.AssertExpectations(t) require.True(t, p.closing) require.Error(t, p.resultError) }) // on L1 temporary error: stop with error t.Run("L1 temporary error event", func(t *testing.T) { - p, m := newProgram(t, 1000) + p, _ := newProgram(t, 1000) p.OnEvent(context.Background(), rollup.L1TemporaryErrorEvent{Err: errTestTemp}) - m.AssertExpectations(t) require.True(t, p.closing) require.Error(t, p.resultError) }) // on engine temporary error: continue derivation (because legacy, not all connection related) t.Run("engine temp error event", func(t *testing.T) { - p, m := newProgram(t, 1000) - m.ExpectOnce(engine.PendingSafeRequestEvent{}) + p, _ := newProgram(t, 1000) p.OnEvent(context.Background(), rollup.EngineTemporaryErrorEvent{Err: errTestTemp}) - m.AssertExpectations(t) require.False(t, p.closing) require.NoError(t, p.resultError) }) // on critical error: stop t.Run("critical error event", func(t *testing.T) { - p, m := newProgram(t, 1000) + p, _ := newProgram(t, 1000) p.OnEvent(context.Background(), rollup.ResetEvent{Err: errTestCrit}) - m.AssertExpectations(t) require.True(t, p.closing) require.Error(t, p.resultError) }) t.Run("unknown event", func(t *testing.T) { - p, m := newProgram(t, 1000) + p, _ := newProgram(t, 1000) p.OnEvent(context.Background(), TestEvent{}) - m.AssertExpectations(t) require.False(t, p.closing) require.NoError(t, p.resultError) }) diff --git a/op-program/client/interop/interop.go b/op-program/client/interop/interop.go index 00f191be353..1e979506320 100644 --- a/op-program/client/interop/interop.go +++ b/op-program/client/interop/interop.go @@ -107,7 +107,7 @@ func stateTransition(logger log.Logger, bootInfo *boot.BootInfoInterop, l1Preima } else if transitionState.Step == ConsolidateStep { logger.Info("Running consolidate step") // sanity check - if len(transitionState.PendingProgress) >= ConsolidateStep { + if len(transitionState.PendingProgress) > ConsolidateStep { return common.Hash{}, fmt.Errorf("%w: pending progress length does not match the expected step", ErrInvalidPrestate) } expectedSuperRoot, err := RunConsolidation( diff --git a/op-program/client/interop/interop_test.go b/op-program/client/interop/interop_test.go index e61aa181289..f3182275a67 100644 --- a/op-program/client/interop/interop_test.go +++ b/op-program/client/interop/interop_test.go @@ -35,6 +35,7 @@ import ( type chainSetupOpts struct { expiryWindow uint64 + chainCount int } func WithExpiryWindow(window uint64) func(*chainSetupOpts) { @@ -43,49 +44,63 @@ func WithExpiryWindow(window uint64) func(*chainSetupOpts) { } } +func WithChainCount(count int) func(*chainSetupOpts) { + return func(opts *chainSetupOpts) { + opts.chainCount = count + } +} + func setupTwoChains(opts ...func(*chainSetupOpts)) (*staticConfigSource, *eth.SuperV1, *stubTasks) { + opts = append(opts, WithChainCount(2)) + return setupChains(opts...) +} + +func setupChains(opts ...func(setupOpts *chainSetupOpts)) (*staticConfigSource, *eth.SuperV1, *stubTasks) { chainSetupOpts := &chainSetupOpts{} for _, opt := range opts { opt(chainSetupOpts) } - rollupCfg1 := *chaincfg.OPSepolia() - chainCfg1 := *chainconfig.OPSepoliaChainConfig() - - rollupCfg2 := *chaincfg.OPSepolia() - rollupCfg2.L2ChainID = new(big.Int).SetUint64(42) - chainCfg2 := *chainconfig.OPSepoliaChainConfig() - chainCfg2.ChainID = rollupCfg2.L2ChainID - - // activate interop at genesis for both - rollupCfg1.InteropTime = new(uint64) - rollupCfg2.InteropTime = new(uint64) + rollupCfgs := make([]*rollup.Config, 0, chainSetupOpts.chainCount) + chainCfgs := make([]*params.ChainConfig, 0, chainSetupOpts.chainCount) + chainIDAndOutputs := make([]eth.ChainIDAndOutput, 0, chainSetupOpts.chainCount) + dependencies := make(map[eth.ChainID]*depset.StaticConfigDependency, chainSetupOpts.chainCount) + chainIDs := make([]eth.ChainID, 0, chainSetupOpts.chainCount) + + for i := 0; i < chainSetupOpts.chainCount; i++ { + rollupCfg := *chaincfg.OPSepolia() + rollupCfg.L2ChainID = big.NewInt(int64(i)) + // activate interop at genesis + rollupCfg.InteropTime = new(uint64) + chainCfg := *chainconfig.OPSepoliaChainConfig() + chainCfg.ChainID = rollupCfg.L2ChainID + rollupCfgs = append(rollupCfgs, &rollupCfg) + chainCfgs = append(chainCfgs, &chainCfg) + chainIDs = append(chainIDs, eth.ChainIDFromBig(rollupCfg.L2ChainID)) + + chainIDAndOutputs = append(chainIDAndOutputs, eth.ChainIDAndOutput{ + ChainID: eth.ChainIDFromBig(rollupCfg.L2ChainID), + Output: eth.OutputRoot(ð.OutputV0{BlockHash: common.Hash{byte(i)}}), + }) + dependencies[eth.ChainIDFromBig(rollupCfg.L2ChainID)] = &depset.StaticConfigDependency{} + } agreedSuperRoot := ð.SuperV1{ - Timestamp: rollupCfg1.Genesis.L2Time + 1234, - Chains: []eth.ChainIDAndOutput{ - {ChainID: eth.ChainIDFromBig(rollupCfg1.L2ChainID), Output: eth.OutputRoot(ð.OutputV0{BlockHash: common.Hash{0x11}})}, - {ChainID: eth.ChainIDFromBig(rollupCfg2.L2ChainID), Output: eth.OutputRoot(ð.OutputV0{BlockHash: common.Hash{0x22}})}, - }, + Timestamp: rollupCfgs[0].Genesis.L2Time + 1234, + Chains: chainIDAndOutputs, } var ds *depset.StaticConfigDependencySet if chainSetupOpts.expiryWindow > 0 { - ds, _ = depset.NewStaticConfigDependencySetWithMessageExpiryOverride(map[eth.ChainID]*depset.StaticConfigDependency{ - eth.ChainIDFromBig(rollupCfg1.L2ChainID): {}, - eth.ChainIDFromBig(rollupCfg2.L2ChainID): {}, - }, chainSetupOpts.expiryWindow) + ds, _ = depset.NewStaticConfigDependencySetWithMessageExpiryOverride(dependencies, chainSetupOpts.expiryWindow) } else { - ds, _ = depset.NewStaticConfigDependencySet(map[eth.ChainID]*depset.StaticConfigDependency{ - eth.ChainIDFromBig(rollupCfg1.L2ChainID): {}, - eth.ChainIDFromBig(rollupCfg2.L2ChainID): {}, - }) + ds, _ = depset.NewStaticConfigDependencySet(dependencies) } configSource := &staticConfigSource{ - rollupCfgs: []*rollup.Config{&rollupCfg1, &rollupCfg2}, - chainConfigs: []*params.ChainConfig{&chainCfg1, &chainCfg2}, + rollupCfgs: rollupCfgs, + chainConfigs: chainCfgs, depset: ds, - chainIDs: []eth.ChainID{eth.ChainIDFromBig(rollupCfg1.L2ChainID), eth.ChainIDFromBig(rollupCfg2.L2ChainID)}, + chainIDs: chainIDs, } tasksStub := &stubTasks{ l2SafeHead: eth.L2BlockRef{Number: 918429823450218}, // Past the claimed block @@ -729,6 +744,64 @@ func TestHazardSet_ExpiredMessageShortCircuitsInclusionCheck(t *testing.T) { }) } +func TestMaximumNumberOfChains(t *testing.T) { + logger := testlog.Logger(t, log.LevelError) + chainCount := ConsolidateStep + configSource, agreedSuperRoot, tasksStub := setupChains(WithChainCount(chainCount)) + defer tasksStub.AssertExpectations(t) + rng := rand.New(rand.NewSource(123)) + + agreedHash := common.Hash(eth.SuperRoot(agreedSuperRoot)) + pendingProgress := make([]types.OptimisticBlock, 0, chainCount) + step := uint64(0) + l2PreimageOracle, _ := test.NewStubOracle(t) + l2PreimageOracle.TransitionStates[agreedHash] = &types.TransitionState{SuperRoot: agreedSuperRoot.Marshal()} + + // Generate an optimistic block for every chain + for _, cfg := range configSource.rollupCfgs { + block, rcpts := createBlock(rng, cfg, 100, nil) + l2PreimageOracle.Receipts[block.Hash()] = rcpts + tasksStub.blockHash = block.Hash() + output := createOutput(tasksStub.blockHash) + tasksStub.outputRoot = eth.OutputRoot(output) + newPendingProgress := append(pendingProgress, types.OptimisticBlock{BlockHash: tasksStub.blockHash, OutputRoot: tasksStub.outputRoot}) + expectedIntermediateRoot := &types.TransitionState{ + SuperRoot: agreedSuperRoot.Marshal(), + PendingProgress: newPendingProgress, + Step: step + 1, + } + + expectedClaim := expectedIntermediateRoot.Hash() + verifyResult(t, logger, tasksStub, configSource, l2PreimageOracle, agreedHash, agreedSuperRoot.Timestamp+100000, expectedClaim) + pendingProgress = newPendingProgress + agreedHash = expectedIntermediateRoot.Hash() + l2PreimageOracle.TransitionStates[agreedHash] = expectedIntermediateRoot + l2PreimageOracle.Outputs[common.Hash(tasksStub.outputRoot)] = output + l2PreimageOracle.Blocks[tasksStub.blockHash] = block + step++ + } + + // Populate initial agreed blocks + for i, chain := range agreedSuperRoot.Chains { + block, _ := createBlock(rng, configSource.rollupCfgs[i], 99, nil) + l2PreimageOracle.Outputs[common.Hash(chain.Output)] = createOutput(block.Hash()) + l2PreimageOracle.Blocks[block.Hash()] = block + } + // Run the consolidate step + finalOutputs := make([]eth.ChainIDAndOutput, 0, chainCount) + for i, block := range pendingProgress { + finalOutputs = append(finalOutputs, eth.ChainIDAndOutput{ + ChainID: configSource.chainIDs[i], + Output: block.OutputRoot, + }) + } + expectedClaim := common.Hash(eth.SuperRoot(ð.SuperV1{ + Timestamp: agreedSuperRoot.Timestamp + 1, + Chains: finalOutputs, + })) + verifyResult(t, logger, tasksStub, configSource, l2PreimageOracle, agreedHash, agreedSuperRoot.Timestamp+100000, expectedClaim) +} + type mockConsolidateDeps struct { mock.Mock *consolidateCheckDeps diff --git a/op-program/client/l2/db.go b/op-program/client/l2/db.go index 0c1f2c3714c..1d3a8ac5253 100644 --- a/op-program/client/l2/db.go +++ b/op-program/client/l2/db.go @@ -74,6 +74,10 @@ func (o *OracleKeyValueStore) Close() error { // Remaining methods are unused when accessing the state for block processing so leaving unimplemented. +func (o *OracleKeyValueStore) SyncKeyValue() error { + panic("not supported") +} + func (o *OracleKeyValueStore) Has(key []byte) (bool, error) { panic("not supported") } diff --git a/op-program/client/l2/engineapi/block_processor.go b/op-program/client/l2/engineapi/block_processor.go index 953b6d526d8..26906d970ec 100644 --- a/op-program/client/l2/engineapi/block_processor.go +++ b/op-program/client/l2/engineapi/block_processor.go @@ -61,7 +61,9 @@ func NewBlockProcessorFromPayloadAttributes(provider BlockDataProvider, parent c d = provider.Config().BaseFeeChangeDenominator(header.Time) e = provider.Config().ElasticityMultiplier() } - header.Extra = eip1559.EncodeHoloceneExtraData(d, e) + if provider.Config().IsOptimismHolocene(header.Time) { + header.Extra = eip1559.EncodeOptimismExtraData(provider.Config(), header.Time, d, e, attrs.MinBaseFee) + } } return NewBlockProcessorFromHeader(provider, header) diff --git a/op-program/client/l2/engineapi/l2_engine_api.go b/op-program/client/l2/engineapi/l2_engine_api.go index 5ae6391f291..d3a42079391 100644 --- a/op-program/client/l2/engineapi/l2_engine_api.go +++ b/op-program/client/l2/engineapi/l2_engine_api.go @@ -107,6 +107,9 @@ func computePayloadId(headBlockHash common.Hash, attrs *eth.PayloadAttributes) e if attrs.EIP1559Params != nil { hasher.Write(attrs.EIP1559Params[:]) } + if attrs.MinBaseFee != nil { + _ = binary.Write(hasher, binary.BigEndian, *attrs.MinBaseFee) + } var out engine.PayloadID copy(out[:], hasher.Sum(nil)[:8]) return out @@ -355,19 +358,18 @@ func (ea *L2EngineAPI) NewPayloadV3(ctx context.Context, params *eth.ExecutionPa return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(errors.New("nil parentBeaconBlockRoot post-cancun")) } - if !ea.config().IsCancun(new(big.Int).SetUint64(uint64(params.BlockNumber)), uint64(params.Timestamp)) { + cfg := ea.config() + + if !cfg.IsCancun(new(big.Int).SetUint64(uint64(params.BlockNumber)), uint64(params.Timestamp)) { return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.UnsupportedFork.With(errors.New("newPayloadV3 called pre-cancun")) } - // Payload must have eip-1559 params in ExtraData after Holocene - if ea.config().IsHolocene(uint64(params.Timestamp)) { - if err := eip1559.ValidateHoloceneExtraData(params.ExtraData); err != nil { - return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.UnsupportedFork.With(errors.New("invalid holocene extraData post-holocene")) - } + if err := eip1559.ValidateOptimismExtraData(cfg, uint64(params.Timestamp), params.ExtraData); err != nil { + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.UnsupportedFork.With(err) } // Payload must have WithdrawalsRoot after Isthmus - if ea.config().IsIsthmus(uint64(params.Timestamp)) { + if cfg.IsIsthmus(uint64(params.Timestamp)) { if params.WithdrawalsRoot == nil { return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.UnsupportedFork.With(errors.New("nil withdrawalsRoot post-isthmus")) } diff --git a/op-program/client/l2/engineapi/l2_engine_api_test.go b/op-program/client/l2/engineapi/l2_engine_api_test.go index a3588300453..c717917f4f3 100644 --- a/op-program/client/l2/engineapi/l2_engine_api_test.go +++ b/op-program/client/l2/engineapi/l2_engine_api_test.go @@ -5,6 +5,7 @@ import ( "math/big" "testing" + "github.com/ethereum-optimism/optimism/op-chain-ops/genesis" "github.com/ethereum-optimism/optimism/op-service/eth" "github.com/ethereum-optimism/optimism/op-service/testlog" "github.com/ethereum/go-ethereum/beacon/engine" @@ -17,7 +18,6 @@ import ( "github.com/ethereum/go-ethereum/eth/ethconfig" "github.com/ethereum/go-ethereum/log" "github.com/ethereum/go-ethereum/node" - "github.com/ethereum/go-ethereum/params" "github.com/stretchr/testify/require" ) @@ -35,9 +35,7 @@ func TestNewPayloadV4(t *testing.T) { logger, _ := testlog.CaptureLogger(t, log.LvlInfo) for _, c := range cases { - genesis := createGenesis() - isthmusTime := c.isthmusTime - genesis.Config.IsthmusTime = &isthmusTime + genesis := createGenesisWithForkTimeOffset(c.isthmusTime) ethCfg := ðconfig.Config{ NetworkId: genesis.Config.ChainID.Uint64(), Genesis: genesis, @@ -50,6 +48,8 @@ func TestNewPayloadV4(t *testing.T) { genesisBlock := backend.GetHeaderByNumber(0) genesisHash := genesisBlock.Hash() eip1559Params := eth.Bytes8([]byte{0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8}) + minBaseFee := uint64(1e9) + minBaseFeePtr := &minBaseFee gasLimit := eth.Uint64Quantity(4712388) result, err := engineAPI.ForkchoiceUpdatedV3(context.Background(), ð.ForkchoiceState{ HeadBlockHash: genesisHash, @@ -64,6 +64,7 @@ func TestNewPayloadV4(t *testing.T) { NoTxPool: false, GasLimit: &gasLimit, EIP1559Params: &eip1559Params, + MinBaseFee: minBaseFeePtr, }) require.NoError(t, err) require.EqualValues(t, engine.VALID, result.PayloadStatus.Status) @@ -102,6 +103,9 @@ func TestCreatedBlocksAreCached(t *testing.T) { genesis := backend.GetHeaderByNumber(0) genesisHash := genesis.Hash() eip1559Params := eth.Bytes8([]byte{0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8}) + minBaseFee := uint64(1e9) + minBaseFeePtr := &minBaseFee + gasLimit := eth.Uint64Quantity(genesis.GasLimit) result, err := engineAPI.ForkchoiceUpdatedV3(context.Background(), ð.ForkchoiceState{ HeadBlockHash: genesisHash, SafeBlockHash: genesisHash, @@ -113,8 +117,9 @@ func TestCreatedBlocksAreCached(t *testing.T) { Withdrawals: &types.Withdrawals{}, ParentBeaconBlockRoot: &common.Hash{0x22}, NoTxPool: false, - GasLimit: (*eth.Uint64Quantity)(&genesis.GasLimit), + GasLimit: &gasLimit, EIP1559Params: &eip1559Params, + MinBaseFee: minBaseFeePtr, }) require.NoError(t, err) require.EqualValues(t, engine.VALID, result.PayloadStatus.Status) @@ -160,25 +165,53 @@ func newStubBackend(t *testing.T) *stubCachingBackend { } func createGenesis() *core.Genesis { - config := *params.MergedTestChainConfig - config.PragueTime = nil - var zero uint64 - // activate recent OP-stack forks - config.RegolithTime = &zero - config.CanyonTime = &zero - config.EcotoneTime = &zero - config.FjordTime = &zero - config.GraniteTime = &zero - config.HoloceneTime = &zero - config.IsthmusTime = &zero - - l2Genesis := &core.Genesis{ - Config: &config, - Difficulty: common.Big0, - ParentHash: common.Hash{}, - BaseFee: big.NewInt(7), - Alloc: map[common.Address]types.Account{}, - ExtraData: []byte{0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8}, // for Holocene eip-1559 params + return createGenesisWithForkTimeOffset(0) +} + +func createGenesisWithForkTimeOffset(forkTimeOffset uint64) *core.Genesis { + deployConfig := &genesis.DeployConfig{ + L2InitializationConfig: genesis.L2InitializationConfig{ + DevDeployConfig: genesis.DevDeployConfig{ + FundDevAccounts: true, + }, + L2GenesisBlockDeployConfig: genesis.L2GenesisBlockDeployConfig{ + L2GenesisBlockGasLimit: 30_000_000, + L2GenesisBlockDifficulty: (*hexutil.Big)(big.NewInt(100)), + }, + L2CoreDeployConfig: genesis.L2CoreDeployConfig{ + L1ChainID: 900, + L2ChainID: 901, + L2BlockTime: 2, + }, + UpgradeScheduleDeployConfig: genesis.UpgradeScheduleDeployConfig{ + L1CancunTimeOffset: new(hexutil.Uint64), + }, + }, + } + + // Enable all forks up to the specified time + ts := hexutil.Uint64(0) + deployConfig.L2GenesisRegolithTimeOffset = &ts + deployConfig.L2GenesisCanyonTimeOffset = &ts + deployConfig.L2GenesisDeltaTimeOffset = &ts + deployConfig.L2GenesisEcotoneTimeOffset = &ts + deployConfig.L2GenesisFjordTimeOffset = &ts + deployConfig.L2GenesisGraniteTimeOffset = &ts + deployConfig.L2GenesisHoloceneTimeOffset = &ts + + // Set fork time for latest forks + offset := hexutil.Uint64(forkTimeOffset) + deployConfig.L2GenesisIsthmusTimeOffset = &offset + deployConfig.L2GenesisInteropTimeOffset = &offset + deployConfig.L2GenesisJovianTimeOffset = &offset + + l1Genesis, err := genesis.NewL1Genesis(deployConfig) + if err != nil { + panic(err) + } + l2Genesis, err := genesis.NewL2Genesis(deployConfig, eth.BlockRefFromHeader(l1Genesis.ToBlock().Header())) + if err != nil { + panic(err) } return l2Genesis diff --git a/op-program/client/l2/test/miner.go b/op-program/client/l2/test/miner.go index 156c7c3d248..7c5247bc7f9 100644 --- a/op-program/client/l2/test/miner.go +++ b/op-program/client/l2/test/miner.go @@ -40,6 +40,10 @@ func NewMiner(t *testing.T, logger log.Logger, isthmusTime uint64) (*Miner, *cor config.HoloceneTime = &zero config.IsthmusTime = &isthmusTime config.PragueTime = &isthmusTime + + // Disable future Ethereum forks for now + config.OsakaTime = nil + denomCanyon := uint64(250) config.Optimism = ¶ms.OptimismConfig{ EIP1559Denominator: 50, @@ -118,6 +122,10 @@ func (m *Miner) Fork(t *testing.T, blockNumber uint64, attrs *eth.PayloadAttribu GasLimit: &gasLimit, EIP1559Params: &eip1559Params, } + if m.backend.Config().IsJovian(head.Time) { + stub := uint64(1e9) + attrs.MinBaseFee = &stub + } } m.MineAt(t, head, attrs) } @@ -138,6 +146,10 @@ func (m *Miner) MineAt(t *testing.T, head *types.Header, attrs *eth.PayloadAttri GasLimit: &gasLimit, EIP1559Params: &eip1559Params, } + if m.backend.Config().IsJovian(head.Time) { + stub := uint64(1e9) + attrs.MinBaseFee = &stub + } } result, err := m.engineAPI.ForkchoiceUpdatedV3(context.Background(), ð.ForkchoiceState{ HeadBlockHash: hash, diff --git a/op-program/client/mpt/db.go b/op-program/client/mpt/db.go index e6cc79160b1..265d591e3a9 100644 --- a/op-program/client/mpt/db.go +++ b/op-program/client/mpt/db.go @@ -114,4 +114,12 @@ func (p *DB) AncientDatadir() (string, error) { panic("not supported") } +func (p *DB) SyncAncient() error { + panic("not supported") +} + +func (p *DB) SyncKeyValue() error { + panic("not supported") +} + var _ ethdb.Database = (*DB)(nil) diff --git a/op-program/client/tasks/deposits_block.go b/op-program/client/tasks/deposits_block.go index ab16fcf70dd..2a35c42a8eb 100644 --- a/op-program/client/tasks/deposits_block.go +++ b/op-program/client/tasks/deposits_block.go @@ -145,10 +145,12 @@ func blockToDepositsOnlyAttributes(cfg *rollup.Config, block *types.Block, outpu NoTxPool: true, GasLimit: &gasLimit, } + if cfg.IsHolocene(block.Time()) { - d, e := eip1559.DecodeHoloceneExtraData(block.Extra()) + d, e, m := eip1559.DecodeOptimismExtraData(cfg, block.Time(), block.Extra()) eip1559Params := eth.Bytes8(eip1559.EncodeHolocene1559Params(d, e)) attrs.EIP1559Params = &eip1559Params + attrs.MinBaseFee = m } return attrs, nil } diff --git a/op-program/compatibility-test/baseline-cannon-multithreaded-64-next.json b/op-program/compatibility-test/baseline-cannon-multithreaded-64-next.json index 28a8885269d..dafbcaf7b3b 100644 --- a/op-program/compatibility-test/baseline-cannon-multithreaded-64-next.json +++ b/op-program/compatibility-test/baseline-cannon-multithreaded-64-next.json @@ -640,70 +640,6 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "25ee1dccb8d01fcf5c5e7b3ac41188fa9c613a6ba12f07e368dd37f0fa21fa93" }, - { - "callStack": { - "function": "syscall.Flock", - "callStack": { - "function": "github.com/gofrs/flock.(*Flock).Unlock", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).loadTransactions", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).consolidatedBlockByHash", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", - "callStack": { - "function": "main.main" - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - }, - "message": "Potential Incompatible Syscall Detected: 5071", - "severity": "CRITICAL", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "262876708b03addf04292a157bf304f20115cfe55bc65bd3de80ab72ffd5db49" - }, { "callStack": { "function": "golang.org/x/sys/unix.Sysinfo", @@ -1314,6 +1250,64 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "3cde82f65fb30a398c492e48a470104a376f4f9ea855026b5961fbc936ccaa04" }, + { + "callStack": { + "function": "golang.org/x/sys/unix.Flock", + "callStack": { + "function": "github.com/gofrs/flock.(*Flock).Unlock", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "callStack": { + "function": "main.main" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "message": "Potential Incompatible Syscall Detected: 5071", + "severity": "CRITICAL", + "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", + "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", + "hash": "40fa0eb7f9e4191fa33b1c7eaa32d4e6733dab9f790c7afbbf1d72ab231e2e35" + }, { "callStack": { "function": "syscall.Ftruncate", @@ -3710,6 +3704,70 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "acc0d615135b118439c6cda3f95baf7b9c0e85aac025c87968f60b0421ac27ee" }, + { + "callStack": { + "function": "golang.org/x/sys/unix.Flock", + "callStack": { + "function": "github.com/gofrs/flock.(*Flock).Unlock", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).loadTransactions", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).consolidatedBlockByHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "callStack": { + "function": "main.main" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "message": "Potential Incompatible Syscall Detected: 5071", + "severity": "CRITICAL", + "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", + "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", + "hash": "ade27e0b52d1c4050f192d6155199c8112288f564e8d56ecf1690aa5ad3ae0f2" + }, { "callStack": { "function": "syscall.lstat", @@ -4431,64 +4489,6 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "d3a9e0e4814e9f74db0571ba63e4f9ec806ce8f085f6feb46f51b78d161685b3" }, - { - "callStack": { - "function": "syscall.Flock", - "callStack": { - "function": "github.com/gofrs/flock.(*Flock).Unlock", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", - "callStack": { - "function": "main.main" - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - }, - "message": "Potential Incompatible Syscall Detected: 5071", - "severity": "CRITICAL", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "d9e0c3a236defe9edbba0b197c64c4d2e2c21ac351cf77a56269c5db2c2c0167" - }, { "callStack": { "function": "syscall.lstat", @@ -4791,50 +4791,19 @@ }, { "callStack": { - "function": "internal/syscall/unix.GetRandom", + "function": "runtime.netpollclose", "callStack": { - "function": "crypto/internal/sysrand.read", + "function": "internal/poll.runtime_pollClose", "callStack": { - "function": "crypto/internal/sysrand.Read", + "function": "internal/poll.(*FD).destroy", "callStack": { - "function": "crypto/internal/entropy.Depleted", + "function": "internal/poll.(*FD).decref", "callStack": { - "function": "crypto/internal/fips140/drbg.Read", + "function": "internal/poll.(*FD).Close", "callStack": { - "function": "crypto/internal/fips140/drbg.ReadWithReader", + "function": "os.(*file).close", "callStack": { - "function": "crypto/internal/fips140/ecdh.GenerateKey[go.shape.*crypto/internal/fips140/nistec.P521Point]", - "callStack": { - "function": "crypto/ecdh.init.func9" - } - } - } - } - } - } - } - }, - "message": "Potential NOOP Syscall Detected: 5313", - "severity": "WARNING", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "0299af5c9cd64575dca6ef14515c1c335e739d5c113b93139f70e221f3bff196" - }, - { - "callStack": { - "function": "runtime.netpollclose", - "callStack": { - "function": "internal/poll.runtime_pollClose", - "callStack": { - "function": "internal/poll.(*FD).destroy", - "callStack": { - "function": "internal/poll.(*FD).decref", - "callStack": { - "function": "internal/poll.(*FD).Close", - "callStack": { - "function": "os.(*file).close", - "callStack": { - "function": "os.removeAllFrom", + "function": "os.removeAllFrom", "callStack": { "function": "os.removeAll", "callStack": { @@ -7731,6 +7700,73 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "4fa487ac912e96dac666815d38f915ea81cae9f42db94c21a5e1cb04f78a1d97" }, + { + "callStack": { + "function": "syscall.stat", + "callStack": { + "function": "syscall.Stat", + "callStack": { + "function": "os.statNolog", + "callStack": { + "function": "os.Stat", + "callStack": { + "function": "github.com/ethereum/go-ethereum/common.FileExist", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).loadJournal", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).loadLayers", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).loadTransactions", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).consolidatedBlockByHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "callStack": { + "function": "main.main" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "message": "Potential NOOP Syscall Detected: 5004", + "severity": "WARNING", + "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", + "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", + "hash": "5013ea916f3e0f37ec609b3ca053b80c8f7aea0073d0b5a8452135c9fa1d9657" + }, { "callStack": { "function": "syscall.openat", @@ -10154,37 +10190,6 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "88ac28e344788a275b36d1274da5c5da8627c6c237849c6a30d93a1227fb0ba0" }, - { - "callStack": { - "function": "internal/syscall/unix.GetRandom", - "callStack": { - "function": "crypto/internal/sysrand.read", - "callStack": { - "function": "crypto/internal/sysrand.Read", - "callStack": { - "function": "crypto/internal/entropy.Depleted", - "callStack": { - "function": "crypto/internal/fips140/drbg.Read", - "callStack": { - "function": "crypto/internal/fips140/drbg.ReadWithReader", - "callStack": { - "function": "crypto/internal/fips140/ecdh.GenerateKey[go.shape.*crypto/internal/fips140/nistec.P384Point]", - "callStack": { - "function": "crypto/ecdh.init.func5" - } - } - } - } - } - } - } - }, - "message": "Potential NOOP Syscall Detected: 5313", - "severity": "WARNING", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "8a9f47ff88e528d60c299294057d517fb1d37d4ed484937eebf7cf08f921302e" - }, { "callStack": { "function": "runtime.netpollinit", @@ -10396,6 +10401,88 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "8bdbc310bac5de456e009ee897e0331a9ad7a55271b9d2b598963076fd86fc92" }, + { + "callStack": { + "function": "runtime.netpollclose", + "callStack": { + "function": "internal/poll.runtime_pollClose", + "callStack": { + "function": "internal/poll.(*FD).destroy", + "callStack": { + "function": "internal/poll.(*FD).decref", + "callStack": { + "function": "internal/poll.(*FD).Close", + "callStack": { + "function": "os.(*file).close", + "callStack": { + "function": "github.com/gofrs/flock.(*Flock).resetFh", + "callStack": { + "function": "github.com/gofrs/flock.(*Flock).Unlock", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).loadTransactions", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).consolidatedBlockByHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "callStack": { + "function": "main.main" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "message": "Potential NOOP Syscall Detected: 5208", + "severity": "WARNING", + "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", + "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", + "hash": "8c8bcd5c08c7f155c27bcf48b638e8951d4e209b74cf3bec1973eb45bebd74f7" + }, { "callStack": { "function": "syscall.openat", @@ -11011,28 +11098,6 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "97dfbb0bc343ead69931e67e17ef8db2cf7fcb0fce22dc61b8482dce9cd98c89" }, - { - "callStack": { - "function": "internal/syscall/unix.GetRandom", - "callStack": { - "function": "crypto/internal/sysrand.read", - "callStack": { - "function": "crypto/internal/sysrand.Read", - "callStack": { - "function": "crypto/internal/entropy.Depleted", - "callStack": { - "function": "crypto/internal/fips140/drbg.init.func1" - } - } - } - } - }, - "message": "Potential NOOP Syscall Detected: 5313", - "severity": "WARNING", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "98e5dde5d38ec92fa907da4c2fcc8c0f88a7559d5bdff992696d4876d2a94c4d" - }, { "callStack": { "function": "runtime.tgkill", @@ -12128,21 +12193,21 @@ }, { "callStack": { - "function": "syscall.Seek", + "function": "runtime.netpollclose", "callStack": { - "function": "internal/poll.(*FD).Seek", + "function": "internal/poll.runtime_pollClose", "callStack": { - "function": "os.(*File).seek", + "function": "internal/poll.(*FD).destroy", "callStack": { - "function": "os.(*File).Seek", + "function": "internal/poll.(*FD).decref", "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.(*freezerTableMeta).write", + "function": "internal/poll.(*FD).Close", "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.(*freezerTable).doSync", + "function": "os.(*file).close", "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.(*freezerTable).Close", + "function": "github.com/gofrs/flock.(*Flock).resetFh", "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.newTable", + "function": "github.com/gofrs/flock.(*Flock).Unlock", "callStack": { "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", "callStack": { @@ -12158,27 +12223,21 @@ "callStack": { "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).loadTransactions", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).consolidatedBlockByHash", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", - "callStack": { - "function": "main.main" - } - } + "function": "main.main" } } } @@ -12202,88 +12261,66 @@ } } }, - "message": "Potential NOOP Syscall Detected: 5008", + "message": "Potential NOOP Syscall Detected: 5208", "severity": "WARNING", "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "b54b1cdac0dce3c02378c79e2fd5ea2c99b53648f9c7918b52383f2b5ad4dc20" + "hash": "b51d3f1ff926563ad6cda4d625444b22c19a1b0a88677169873182df0f147907" }, { "callStack": { - "function": "runtime.netpollinit", + "function": "syscall.Seek", "callStack": { - "function": "runtime.netpollGenericInit", + "function": "internal/poll.(*FD).Seek", "callStack": { - "function": "runtime.(*timers).addHeap", + "function": "os.(*File).seek", "callStack": { - "function": "runtime.(*timer).maybeAdd", + "function": "os.(*File).Seek", "callStack": { - "function": "runtime.blockTimerChan", + "function": "github.com/ethereum/go-ethereum/core/rawdb.(*freezerTableMeta).write", "callStack": { - "function": "runtime.selectgo", + "function": "github.com/ethereum/go-ethereum/core/rawdb.(*freezerTable).doSync", "callStack": { - "function": "github.com/ethereum/go-ethereum/p2p/nat.discoverPMP", + "function": "github.com/ethereum/go-ethereum/core/rawdb.(*freezerTable).Close", "callStack": { - "function": "github.com/ethereum/go-ethereum/node.init.Any.func2.2" - } - } - } - } - } - } - } - }, - "message": "Potential NOOP Syscall Detected: 5285", - "severity": "WARNING", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "b726c684145b290d0039ee9f525cfeda00d1743da1bfd59f85236cef26a35f52" - }, - { - "callStack": { - "function": "runtime.netpollclose", - "callStack": { - "function": "internal/poll.runtime_pollClose", - "callStack": { - "function": "internal/poll.(*FD).destroy", - "callStack": { - "function": "internal/poll.(*FD).decref", - "callStack": { - "function": "internal/poll.(*FD).Close", - "callStack": { - "function": "os.(*file).close", - "callStack": { - "function": "github.com/gofrs/flock.(*Flock).Unlock", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", + "function": "github.com/ethereum/go-ethereum/core/rawdb.newTable", "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", + "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", + "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).loadTransactions", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).consolidatedBlockByHash", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", "callStack": { - "function": "main.main" + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "callStack": { + "function": "main.main" + } + } + } } } } @@ -12306,11 +12343,42 @@ } } }, - "message": "Potential NOOP Syscall Detected: 5208", + "message": "Potential NOOP Syscall Detected: 5008", + "severity": "WARNING", + "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", + "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", + "hash": "b54b1cdac0dce3c02378c79e2fd5ea2c99b53648f9c7918b52383f2b5ad4dc20" + }, + { + "callStack": { + "function": "runtime.netpollinit", + "callStack": { + "function": "runtime.netpollGenericInit", + "callStack": { + "function": "runtime.(*timers).addHeap", + "callStack": { + "function": "runtime.(*timer).maybeAdd", + "callStack": { + "function": "runtime.blockTimerChan", + "callStack": { + "function": "runtime.selectgo", + "callStack": { + "function": "github.com/ethereum/go-ethereum/p2p/nat.discoverPMP", + "callStack": { + "function": "github.com/ethereum/go-ethereum/node.init.Any.func2.2" + } + } + } + } + } + } + } + }, + "message": "Potential NOOP Syscall Detected: 5285", "severity": "WARNING", "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "b9c7263a4b2bdd73a5030de130c9f26b56285141bed4b21cf372ac2bec7edf61" + "hash": "b726c684145b290d0039ee9f525cfeda00d1743da1bfd59f85236cef26a35f52" }, { "callStack": { @@ -12939,37 +13007,6 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "cdc85b076baeb732ebe46810a7798301c569410870a3d1842cdca42c8152e691" }, - { - "callStack": { - "function": "internal/syscall/unix.GetRandom", - "callStack": { - "function": "crypto/internal/sysrand.read", - "callStack": { - "function": "crypto/internal/sysrand.Read", - "callStack": { - "function": "crypto/internal/entropy.Depleted", - "callStack": { - "function": "crypto/internal/fips140/drbg.Read", - "callStack": { - "function": "crypto/internal/fips140/drbg.ReadWithReader", - "callStack": { - "function": "crypto/internal/fips140/ecdh.GenerateKey[go.shape.*crypto/internal/fips140/nistec.P256Point]", - "callStack": { - "function": "crypto/ecdh.init.func1" - } - } - } - } - } - } - } - }, - "message": "Potential NOOP Syscall Detected: 5313", - "severity": "WARNING", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "cf70026ef86e5cc06804b0effc2d5c1c7b2b7a9f07876db1e7bffe04fe482655" - }, { "callStack": { "function": "syscall.fstat", @@ -14132,85 +14169,6 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "e765d842c669be18a8bd4092a0a168e55aaf724ff54d00020da8ca27b872f888" }, - { - "callStack": { - "function": "runtime.netpollclose", - "callStack": { - "function": "internal/poll.runtime_pollClose", - "callStack": { - "function": "internal/poll.(*FD).destroy", - "callStack": { - "function": "internal/poll.(*FD).decref", - "callStack": { - "function": "internal/poll.(*FD).Close", - "callStack": { - "function": "os.(*file).close", - "callStack": { - "function": "github.com/gofrs/flock.(*Flock).Unlock", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).loadTransactions", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).consolidatedBlockByHash", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", - "callStack": { - "function": "main.main" - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - }, - "message": "Potential NOOP Syscall Detected: 5208", - "severity": "WARNING", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "e7ced58322ac64ae4c5931010d6a3fc5a647942facc783846b707a2fc5bb0e52" - }, { "callStack": { "function": "syscall.Seek", @@ -14369,40 +14327,6 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "ee019853c1c8cd393e91ae684a879ab4e80224ef34f34fecda7a42b8ee738ffb" }, - { - "callStack": { - "function": "internal/syscall/unix.GetRandom", - "callStack": { - "function": "crypto/internal/sysrand.read", - "callStack": { - "function": "crypto/internal/sysrand.Read", - "callStack": { - "function": "crypto/internal/entropy.Depleted", - "callStack": { - "function": "crypto/internal/fips140/drbg.Read", - "callStack": { - "function": "crypto/rand.(*reader).Read", - "callStack": { - "function": "crypto/rand.Read", - "callStack": { - "function": "github.com/ethereum/go-ethereum/rpc.randomIDGenerator", - "callStack": { - "function": "github.com/ethereum/go-ethereum/rpc.init" - } - } - } - } - } - } - } - } - }, - "message": "Potential NOOP Syscall Detected: 5313", - "severity": "WARNING", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "ee383489540ecb15022a72bcc900093ba6f652b5d76a5e405ddfe546e29e47df" - }, { "callStack": { "function": "syscall.openat", @@ -14904,6 +14828,67 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "fc6d08605736c4822973b5a95bd49cfcd854aeb70beeaf9486dd57cc56a0414a" }, + { + "callStack": { + "function": "syscall.stat", + "callStack": { + "function": "syscall.Stat", + "callStack": { + "function": "os.statNolog", + "callStack": { + "function": "os.Stat", + "callStack": { + "function": "github.com/ethereum/go-ethereum/common.FileExist", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).loadJournal", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).loadLayers", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "callStack": { + "function": "main.main" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "message": "Potential NOOP Syscall Detected: 5004", + "severity": "WARNING", + "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", + "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", + "hash": "fc7609bd18384b36954855ebd2d909707e01ed0c67a7c45ea4aead058369210d" + }, { "callStack": { "function": "syscall.fstat", diff --git a/op-program/compatibility-test/baseline-cannon-multithreaded-64.json b/op-program/compatibility-test/baseline-cannon-multithreaded-64.json index 26c890bb23e..89a722c3123 100644 --- a/op-program/compatibility-test/baseline-cannon-multithreaded-64.json +++ b/op-program/compatibility-test/baseline-cannon-multithreaded-64.json @@ -610,70 +610,6 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "25ee1dccb8d01fcf5c5e7b3ac41188fa9c613a6ba12f07e368dd37f0fa21fa93" }, - { - "callStack": { - "function": "syscall.Flock", - "callStack": { - "function": "github.com/gofrs/flock.(*Flock).Unlock", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).loadTransactions", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).consolidatedBlockByHash", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", - "callStack": { - "function": "main.main" - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - }, - "message": "Potential Incompatible Syscall Detected: 5071", - "severity": "CRITICAL", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "262876708b03addf04292a157bf304f20115cfe55bc65bd3de80ab72ffd5db49" - }, { "callStack": { "function": "golang.org/x/sys/unix.Sysinfo", @@ -1226,6 +1162,64 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "3cde82f65fb30a398c492e48a470104a376f4f9ea855026b5961fbc936ccaa04" }, + { + "callStack": { + "function": "golang.org/x/sys/unix.Flock", + "callStack": { + "function": "github.com/gofrs/flock.(*Flock).Unlock", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "callStack": { + "function": "main.main" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "message": "Potential Incompatible Syscall Detected: 5071", + "severity": "CRITICAL", + "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", + "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", + "hash": "40fa0eb7f9e4191fa33b1c7eaa32d4e6733dab9f790c7afbbf1d72ab231e2e35" + }, { "callStack": { "function": "syscall.Ftruncate", @@ -3472,6 +3466,70 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "acc0d615135b118439c6cda3f95baf7b9c0e85aac025c87968f60b0421ac27ee" }, + { + "callStack": { + "function": "golang.org/x/sys/unix.Flock", + "callStack": { + "function": "github.com/gofrs/flock.(*Flock).Unlock", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).loadTransactions", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).consolidatedBlockByHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "callStack": { + "function": "main.main" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "message": "Potential Incompatible Syscall Detected: 5071", + "severity": "CRITICAL", + "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", + "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", + "hash": "ade27e0b52d1c4050f192d6155199c8112288f564e8d56ecf1690aa5ad3ae0f2" + }, { "callStack": { "function": "syscall.lstat", @@ -4224,64 +4282,6 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "d3a9e0e4814e9f74db0571ba63e4f9ec806ce8f085f6feb46f51b78d161685b3" }, - { - "callStack": { - "function": "syscall.Flock", - "callStack": { - "function": "github.com/gofrs/flock.(*Flock).Unlock", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", - "callStack": { - "function": "main.main" - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - }, - "message": "Potential Incompatible Syscall Detected: 5071", - "severity": "CRITICAL", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "d9e0c3a236defe9edbba0b197c64c4d2e2c21ac351cf77a56269c5db2c2c0167" - }, { "callStack": { "function": "syscall.lstat", @@ -6873,29 +6873,96 @@ }, { "callStack": { - "function": "syscall.Seek", + "function": "syscall.stat", "callStack": { - "function": "internal/poll.(*FD).Seek", + "function": "syscall.Stat", "callStack": { - "function": "os.(*File).seek", + "function": "os.statNolog", "callStack": { - "function": "os.(*File).Seek", + "function": "os.Stat", "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.(*freezerTableMeta).write", + "function": "github.com/ethereum/go-ethereum/common.FileExist", "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.(*freezerTable).doSync", + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).loadJournal", "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.(*freezerTable).Close", + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).loadLayers", "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", + "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", + "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).loadTransactions", "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).consolidatedBlockByHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "callStack": { + "function": "main.main" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "message": "Potential NOOP Syscall Detected: 5004", + "severity": "WARNING", + "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", + "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", + "hash": "5013ea916f3e0f37ec609b3ca053b80c8f7aea0073d0b5a8452135c9fa1d9657" + }, + { + "callStack": { + "function": "syscall.Seek", + "callStack": { + "function": "internal/poll.(*FD).Seek", + "callStack": { + "function": "os.(*File).seek", + "callStack": { + "function": "os.(*File).Seek", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.(*freezerTableMeta).write", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.(*freezerTable).doSync", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.(*freezerTable).Close", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", "callStack": { "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", "callStack": { @@ -9010,6 +9077,88 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "8abefb23a2e31c4f6c7e774de8cb638710702c8e269905dcf1902b09a0257c25" }, + { + "callStack": { + "function": "runtime.netpollclose", + "callStack": { + "function": "internal/poll.runtime_pollClose", + "callStack": { + "function": "internal/poll.(*FD).destroy", + "callStack": { + "function": "internal/poll.(*FD).decref", + "callStack": { + "function": "internal/poll.(*FD).Close", + "callStack": { + "function": "os.(*file).close", + "callStack": { + "function": "github.com/gofrs/flock.(*Flock).resetFh", + "callStack": { + "function": "github.com/gofrs/flock.(*Flock).Unlock", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).loadTransactions", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).consolidatedBlockByHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "callStack": { + "function": "main.main" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "message": "Potential NOOP Syscall Detected: 5208", + "severity": "WARNING", + "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", + "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", + "hash": "8c8bcd5c08c7f155c27bcf48b638e8951d4e209b74cf3bec1973eb45bebd74f7" + }, { "callStack": { "function": "runtime.mincore", @@ -10318,6 +10467,82 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "b328ee40de012bf87181591dfaf037c1485ab12d38a12e8b4db0af414a805ed6" }, + { + "callStack": { + "function": "runtime.netpollclose", + "callStack": { + "function": "internal/poll.runtime_pollClose", + "callStack": { + "function": "internal/poll.(*FD).destroy", + "callStack": { + "function": "internal/poll.(*FD).decref", + "callStack": { + "function": "internal/poll.(*FD).Close", + "callStack": { + "function": "os.(*file).close", + "callStack": { + "function": "github.com/gofrs/flock.(*Flock).resetFh", + "callStack": { + "function": "github.com/gofrs/flock.(*Flock).Unlock", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "callStack": { + "function": "main.main" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "message": "Potential NOOP Syscall Detected: 5208", + "severity": "WARNING", + "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", + "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", + "hash": "b51d3f1ff926563ad6cda4d625444b22c19a1b0a88677169873182df0f147907" + }, { "callStack": { "function": "syscall.Seek", @@ -10431,79 +10656,6 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "b726c684145b290d0039ee9f525cfeda00d1743da1bfd59f85236cef26a35f52" }, - { - "callStack": { - "function": "runtime.netpollclose", - "callStack": { - "function": "internal/poll.runtime_pollClose", - "callStack": { - "function": "internal/poll.(*FD).destroy", - "callStack": { - "function": "internal/poll.(*FD).decref", - "callStack": { - "function": "internal/poll.(*FD).Close", - "callStack": { - "function": "os.(*file).close", - "callStack": { - "function": "github.com/gofrs/flock.(*Flock).Unlock", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", - "callStack": { - "function": "main.main" - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - }, - "message": "Potential NOOP Syscall Detected: 5208", - "severity": "WARNING", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "b9c7263a4b2bdd73a5030de130c9f26b56285141bed4b21cf372ac2bec7edf61" - }, { "callStack": { "function": "runtime.madvise", @@ -12196,85 +12348,6 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "e765d842c669be18a8bd4092a0a168e55aaf724ff54d00020da8ca27b872f888" }, - { - "callStack": { - "function": "runtime.netpollclose", - "callStack": { - "function": "internal/poll.runtime_pollClose", - "callStack": { - "function": "internal/poll.(*FD).destroy", - "callStack": { - "function": "internal/poll.(*FD).decref", - "callStack": { - "function": "internal/poll.(*FD).Close", - "callStack": { - "function": "os.(*file).close", - "callStack": { - "function": "github.com/gofrs/flock.(*Flock).Unlock", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.newResettableFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/core/rawdb.NewStateFreezer", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).repairHistory", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", - "callStack": { - "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).loadTransactions", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).consolidatedBlockByHash", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", - "callStack": { - "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", - "callStack": { - "function": "main.main" - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - } - }, - "message": "Potential NOOP Syscall Detected: 5208", - "severity": "WARNING", - "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", - "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", - "hash": "e7ced58322ac64ae4c5931010d6a3fc5a647942facc783846b707a2fc5bb0e52" - }, { "callStack": { "function": "syscall.Seek", @@ -12673,6 +12746,67 @@ "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", "hash": "fb1420c0bb3d7d169c6f4201b39abcf009b20e5b0a80847c025d08ed26185e19" }, + { + "callStack": { + "function": "syscall.stat", + "callStack": { + "function": "syscall.Stat", + "callStack": { + "function": "os.statNolog", + "callStack": { + "function": "os.Stat", + "callStack": { + "function": "github.com/ethereum/go-ethereum/common.FileExist", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).loadJournal", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.(*Database).loadLayers", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb/pathdb.New", + "callStack": { + "function": "github.com/ethereum/go-ethereum/triedb.NewDatabase", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/mpt.ReadTrie", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.(*ConsolidateOracle).ReceiptsByBlockHash", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.singleRoundConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.RunConsolidation", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.stateTransition", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client/interop.runInteropProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.RunProgram", + "callStack": { + "function": "github.com/ethereum-optimism/optimism/op-program/client.Main", + "callStack": { + "function": "main.main" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "message": "Potential NOOP Syscall Detected: 5004", + "severity": "WARNING", + "impact": "This syscall is present in the program, but its execution depends on the actual runtime behavior. \n If the execution path does not reach this syscall, it may not affect execution.", + "reference": "https://github.com/ChainSafe/vm-compat?tab=readme-ov-file#how-it-works", + "hash": "fc7609bd18384b36954855ebd2d909707e01ed0c67a7c45ea4aead058369210d" + }, { "callStack": { "function": "runtime.sysFaultOS", diff --git a/op-program/host/common/l2_store.go b/op-program/host/common/l2_store.go index c18d668c189..b9333b1ca66 100644 --- a/op-program/host/common/l2_store.go +++ b/op-program/host/common/l2_store.go @@ -96,6 +96,11 @@ func (b *batch) Delete(key []byte) error { return nil } +func (b *batch) DeleteRange(start []byte, end []byte) error { + // ignore deletes + return nil +} + func (b *batch) ValueSize() int { return b.size } diff --git a/op-program/host/kvstore/pebble.go b/op-program/host/kvstore/pebble.go index 5bc7fcc9f23..9a678a26c3f 100644 --- a/op-program/host/kvstore/pebble.go +++ b/op-program/host/kvstore/pebble.go @@ -52,9 +52,10 @@ func (d *pebbleKV) Get(k common.Hash) ([]byte, error) { } return nil, err } + defer closer.Close() + ret := make([]byte, len(dat)) copy(ret, dat) - closer.Close() return ret, nil } diff --git a/op-program/repro.justfile b/op-program/repro.justfile index 94ae3dc66ad..71ebfdd54eb 100644 --- a/op-program/repro.justfile +++ b/op-program/repro.justfile @@ -32,27 +32,13 @@ op-program-client-mips: GITDATE={{GIT_DATE}} \ VERSION={{OP_PROGRAM_VERSION}} -# Run the op-program-client elf binary directly through cannon's load-elf subcommand. -client TYPE CLIENT_SUFFIX PRESTATE_SUFFIX: cannon op-program-client-mips - #!/bin/bash - echo "Checking program version | $(go version /app/op-program/bin/op-program-client{{CLIENT_SUFFIX}}.elf)" - /app/cannon/bin/cannon load-elf \ - --type {{TYPE}} \ - --path /app/op-program/bin/op-program-client{{CLIENT_SUFFIX}}.elf \ - --out /app/op-program/bin/prestate{{PRESTATE_SUFFIX}}.bin.gz \ - --meta "/app/op-program/bin/meta{{PRESTATE_SUFFIX}}.json" - # Generate the prestate proof containing the absolute pre-state hash. -prestate TYPE CLIENT_SUFFIX PRESTATE_SUFFIX: (client TYPE CLIENT_SUFFIX PRESTATE_SUFFIX) +prestate TYPE CLIENT_SUFFIX PRESTATE_SUFFIX: cannon op-program-client-mips #!/bin/bash - /app/cannon/bin/cannon run \ - --proof-at '=0' \ - --stop-at '=1' \ - --input /app/op-program/bin/prestate{{PRESTATE_SUFFIX}}.bin.gz \ - --meta "" \ - --proof-fmt '/app/op-program/bin/%d{{PRESTATE_SUFFIX}}.json' \ - --output "" - mv /app/op-program/bin/0{{PRESTATE_SUFFIX}}.json /app/op-program/bin/prestate-proof{{PRESTATE_SUFFIX}}.json + go run /app/op-program/builder/main.go build-prestate \ + --program-elf /app/op-program/bin/op-program-client{{CLIENT_SUFFIX}}.elf \ + --version {{TYPE}}\ + --suffix {{PRESTATE_SUFFIX}} build-mt64: (prestate "multithreaded64-4" "64" "-mt64") build-mt64Next: (prestate "multithreaded64-5" "64" "-mt64Next") diff --git a/op-program/scripts/build-prestates.sh b/op-program/scripts/build-prestates.sh index 533f412ae00..aa77ae0be5d 100755 --- a/op-program/scripts/build-prestates.sh +++ b/op-program/scripts/build-prestates.sh @@ -22,21 +22,31 @@ VERSIONS_FILE="${STATES_DIR}/versions.json" mkdir -p "${STATES_DIR}" "${LOGS_DIR}" - cd "${REPO_DIR}" VERSIONS_JSON="[]" -VERSIONS=$(git tag --list 'op-program/v*' --sort taggerdate) +readarray -t VERSIONS < <(git tag --list 'op-program/v*' --sort taggerdate) -for VERSION in ${VERSIONS} +for VERSION in "${VERSIONS[@]}" do SHORT_VERSION=$(echo "${VERSION}" | cut -c 13-) LOG_FILE="${LOGS_DIR}/build-${SHORT_VERSION}.txt" echo "Building Version: ${VERSION} Logs: ${LOG_FILE}" - git checkout "${VERSION}" > "${LOG_FILE}" 2>&1 + # use --force to overwrite any mise.toml changes + git checkout --force "${VERSION}" > "${LOG_FILE}" 2>&1 if [ -f mise.toml ] then echo "Install dependencies with mise" >> "${LOG_FILE}" + # we rely only on go and jq for the reproducible-prestate build. + # The mise cache should already have jq preinstalled + # But we need to ensure that this ${VERSION} has the correct go version + # So we replace the mise.toml with a minimal one that only specifies go + # Otherwise, `mise install` fails as it conflicts with other preinstalled dependencies + GO_VERSION=$(mise config get tools.go) + cat >mise.toml <> "${LOG_FILE}" 2>&1 fi rm -rf "${BIN_DIR}" diff --git a/op-service/README.md b/op-service/README.md index 8626cc355e3..e5a9cad89b0 100644 --- a/op-service/README.md +++ b/op-service/README.md @@ -28,6 +28,7 @@ Pull requests: [monorepo](https://github.com/ethereum-optimism/optimism/pulls?q= ├── jsonutil - JSON encoding/decoding utils ├── locks - Lock utils, like read-write wrapped types ├── log - Logging CLI and middleware utils +├── logpipe - Logs streaming from io.Reader to logger ├── logfilter - Logging filters ├── logmods - Log handler wrapping/unwrapping utils ├── metrics - Metrics types, metering abstractions, server utils diff --git a/op-service/apis/sync_tester.go b/op-service/apis/sync_tester.go index 1bf71361eaf..1a826470d29 100644 --- a/op-service/apis/sync_tester.go +++ b/op-service/apis/sync_tester.go @@ -2,10 +2,47 @@ package apis import ( "context" + "encoding/json" "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum/go-ethereum/common" + "github.com/ethereum/go-ethereum/common/hexutil" + "github.com/ethereum/go-ethereum/core/types" + "github.com/ethereum/go-ethereum/rpc" ) type SyncTester interface { + // Only expose sync namespace for encapsulation + SyncAPI + // ChainID for minimal sanity check ChainID(ctx context.Context) (eth.ChainID, error) } + +type SyncAPI interface { + GetSession(ctx context.Context) (*eth.SyncTesterSession, error) + DeleteSession(ctx context.Context) error + ListSessions(ctx context.Context) ([]string, error) +} + +type EthAPI interface { + GetBlockByNumber(ctx context.Context, number rpc.BlockNumber, fullTx bool) (json.RawMessage, error) + GetBlockByHash(ctx context.Context, hash common.Hash, fullTx bool) (json.RawMessage, error) + GetBlockReceipts(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) ([]*types.Receipt, error) + ChainId(ctx context.Context) (hexutil.Big, error) +} + +type EngineAPI interface { + GetPayloadV1(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) + GetPayloadV2(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) + GetPayloadV3(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) + GetPayloadV4(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) + + ForkchoiceUpdatedV1(ctx context.Context, state *eth.ForkchoiceState, attr *eth.PayloadAttributes) (*eth.ForkchoiceUpdatedResult, error) + ForkchoiceUpdatedV2(ctx context.Context, state *eth.ForkchoiceState, attr *eth.PayloadAttributes) (*eth.ForkchoiceUpdatedResult, error) + ForkchoiceUpdatedV3(ctx context.Context, state *eth.ForkchoiceState, attr *eth.PayloadAttributes) (*eth.ForkchoiceUpdatedResult, error) + + NewPayloadV1(ctx context.Context, payload *eth.ExecutionPayload) (*eth.PayloadStatusV1, error) + NewPayloadV2(ctx context.Context, payload *eth.ExecutionPayload) (*eth.PayloadStatusV1, error) + NewPayloadV3(ctx context.Context, payload *eth.ExecutionPayload, versionedHashes []common.Hash, beaconRoot *common.Hash) (*eth.PayloadStatusV1, error) + NewPayloadV4(ctx context.Context, payload *eth.ExecutionPayload, versionedHashes []common.Hash, beaconRoot *common.Hash, executionRequests []hexutil.Bytes) (*eth.PayloadStatusV1, error) +} diff --git a/op-service/cliutil/struct.go b/op-service/cliutil/struct.go index 74fd4320599..8f7cbf5dcbb 100644 --- a/op-service/cliutil/struct.go +++ b/op-service/cliutil/struct.go @@ -2,8 +2,10 @@ package cliutil import ( "encoding" + "encoding/hex" "fmt" "reflect" + "strings" "github.com/ethereum/go-ethereum/common" "github.com/urfave/cli/v2" @@ -102,6 +104,32 @@ func handleSpecialTypes(fieldValue reflect.Value, fieldType reflect.Type, ctx *c return nil } + // Handle common.Hash + if fieldType == reflect.TypeOf(common.Hash{}) { + if !ctx.IsSet(flag) { + return nil + } + + hashStr := strings.TrimPrefix(ctx.String(flag), "0x") + + // Validate hex format and length + if hashStr != "" { + // Check length - common.Hash is 32 bytes = 64 hex chars + "0x" prefix = 66 total + if len(hashStr) != 64 { + return fmt.Errorf("invalid hash: length must be 64 characters") + } + + // Validate hex characters + if _, err := hex.DecodeString(hashStr); err != nil { + return fmt.Errorf("invalid hash: non-hex characters in hash") + } + } + + hash := common.HexToHash(hashStr) + fieldValue.Set(reflect.ValueOf(hash)) + return nil + } + // If type implements TextUnmarshaler if unmarshaler, ok := fieldValue.Interface().(encoding.TextUnmarshaler); ok { return unmarshaler.UnmarshalText([]byte(ctx.String(flag))) diff --git a/op-service/cliutil/struct_test.go b/op-service/cliutil/struct_test.go index a13dde9a057..758cd0ca5f1 100644 --- a/op-service/cliutil/struct_test.go +++ b/op-service/cliutil/struct_test.go @@ -26,6 +26,7 @@ func TestPopulateStruct(t *testing.T) { Int64 int64 `cli:"int64"` Uint64 uint64 `cli:"uint64"` Address common.Address `cli:"address"` + Hash common.Hash `cli:"hash"` TextUnmarshaler *textUnmarshalerThing `cli:"text-unmarshaler"` NotTagged string } @@ -45,6 +46,7 @@ func TestPopulateStruct(t *testing.T) { "--int64=2", "--uint64=3", fmt.Sprintf("--address=%s", common.HexToAddress("0x42")), + fmt.Sprintf("--hash=%s", common.HexToHash("43")), "--text-unmarshaler=hello", }, exp: testStruct{ @@ -54,6 +56,7 @@ func TestPopulateStruct(t *testing.T) { Int64: 2, Uint64: 3, Address: common.HexToAddress("0x42"), + Hash: common.HexToHash("0x43"), TextUnmarshaler: &textUnmarshalerThing{ text: "hello", }, @@ -71,6 +74,29 @@ func TestPopulateStruct(t *testing.T) { }, expErr: "invalid address", }, + { + name: "invalid hash flag (invalid length)", + args: []string{ + "--hash=12345678901234567890123456789012345678901234567890123456789012345", + }, + expErr: "invalid hash: length must be 64 characters", + }, + { + name: "invalid hash flag (invalid characters)", + args: []string{ + "--hash=123456789012345678901234567890123456789012345678901234567890123g", + }, + expErr: "invalid hash: non-hex characters in hash", + }, + { + name: "allow zero hash", + args: []string{ + fmt.Sprintf("--hash=%s", common.HexToHash("0")), + }, + exp: testStruct{ + Hash: common.HexToHash("0x0"), + }, + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { @@ -95,6 +121,9 @@ func TestPopulateStruct(t *testing.T) { &cli.StringFlag{ Name: "address", }, + &cli.StringFlag{ + Name: "hash", + }, &cli.StringFlag{ Name: "text-unmarshaler", }, diff --git a/op-service/eth/status.go b/op-service/eth/status.go index 52e2e9c58cc..4626941b4e2 100644 --- a/op-service/eth/status.go +++ b/op-service/eth/status.go @@ -22,20 +22,24 @@ func ForkchoiceUpdateErr(payloadStatus PayloadStatusV1) error { } func NewPayloadErr(payload *ExecutionPayload, payloadStatus *PayloadStatusV1) error { + vErr := "" + if payloadStatus.ValidationError != nil { + vErr = *payloadStatus.ValidationError + } switch payloadStatus.Status { case ExecutionValid: return nil case ExecutionSyncing: return fmt.Errorf("failed to execute payload %s, node is syncing", payload.ID()) case ExecutionInvalid: - return fmt.Errorf("execution payload %s was INVALID! Latest valid hash is %s, ignoring bad block: %v", payload.ID(), payloadStatus.LatestValidHash, payloadStatus.ValidationError) + return fmt.Errorf("execution payload %s was INVALID! Latest valid hash is %s, ignoring bad block: %s", payload.ID(), payloadStatus.LatestValidHash, vErr) case ExecutionInvalidBlockHash: - return fmt.Errorf("execution payload %s has INVALID BLOCKHASH! %v", payload.BlockHash, payloadStatus.ValidationError) + return fmt.Errorf("execution payload %s has INVALID BLOCKHASH! %s", payload.BlockHash, vErr) case ExecutionInvalidTerminalBlock: - return fmt.Errorf("engine is misconfigured. Received invalid-terminal-block error while engine API should be active at genesis. err: %v", payloadStatus.ValidationError) + return fmt.Errorf("engine is misconfigured. Received invalid-terminal-block error while engine API should be active at genesis. err: %s", vErr) case ExecutionAccepted: return fmt.Errorf("execution payload cannot be validated yet, latest valid hash is %s", payloadStatus.LatestValidHash) default: - return fmt.Errorf("unknown execution status on %s: %q, ", payload.ID(), string(payloadStatus.Status)) + return fmt.Errorf("unknown execution status on %s: %q; err: %s", payload.ID(), string(payloadStatus.Status), vErr) } } diff --git a/op-service/eth/synctester_session.go b/op-service/eth/synctester_session.go new file mode 100644 index 00000000000..b8f107494a9 --- /dev/null +++ b/op-service/eth/synctester_session.go @@ -0,0 +1,51 @@ +package eth + +import ( + "sync" +) + +// FCUState represents the Fork Choice Update state with Latest, Safe, and Finalized block numbers +type FCUState struct { + Latest uint64 `json:"latest"` + Safe uint64 `json:"safe"` + Finalized uint64 `json:"finalized"` +} + +type SyncTesterSession struct { + sync.Mutex + + SessionID string `json:"sessionID"` + + // Non canonical view of the chain + Validated uint64 `json:"validated"` + // Canonical view of the chain + CurrentState FCUState `json:"currentState"` + // payloads + Payloads map[PayloadID]*ExecutionPayloadEnvelope `json:"-"` + + InitialState FCUState `json:"initialState"` +} + +func (s *SyncTesterSession) UpdateFCUState(latest, safe, finalized uint64) { + s.CurrentState.Latest = latest + s.CurrentState.Safe = safe + s.CurrentState.Finalized = finalized +} + +func NewSyncTesterSession(sessionID string, latest, safe, finalized uint64) *SyncTesterSession { + return &SyncTesterSession{ + SessionID: sessionID, + Validated: latest, + CurrentState: FCUState{ + Latest: latest, + Safe: safe, + Finalized: finalized, + }, + Payloads: make(map[PayloadID]*ExecutionPayloadEnvelope), + InitialState: FCUState{ + Latest: latest, + Safe: safe, + Finalized: finalized, + }, + } +} diff --git a/op-service/eth/types.go b/op-service/eth/types.go index f10a1cc3243..365060132b2 100644 --- a/op-service/eth/types.go +++ b/op-service/eth/types.go @@ -270,6 +270,97 @@ type ExecutionPayload struct { WithdrawalsRoot *common.Hash `json:"withdrawalsRoot,omitempty"` } +func (p *ExecutionPayload) CheckEqual(o *ExecutionPayload) error { + if p == nil || o == nil { + if p == o { + return nil + } + return fmt.Errorf("one of the payloads is nil: p=%v, o=%v", p, o) + } + if p.ParentHash != o.ParentHash { + return fmt.Errorf("ParentHash mismatch: %v != %v", p.ParentHash, o.ParentHash) + } + if p.FeeRecipient != o.FeeRecipient { + return fmt.Errorf("FeeRecipient mismatch: %v != %v", p.FeeRecipient, o.FeeRecipient) + } + if p.StateRoot != o.StateRoot { + return fmt.Errorf("StateRoot mismatch: %v != %v", p.StateRoot, o.StateRoot) + } + if p.ReceiptsRoot != o.ReceiptsRoot { + return fmt.Errorf("ReceiptsRoot mismatch: %v != %v", p.ReceiptsRoot, o.ReceiptsRoot) + } + if p.LogsBloom != o.LogsBloom { + return fmt.Errorf("LogsBloom mismatch") + } + if p.PrevRandao != o.PrevRandao { + return fmt.Errorf("PrevRandao mismatch: %v != %v", p.PrevRandao, o.PrevRandao) + } + if p.BlockNumber != o.BlockNumber { + return fmt.Errorf("BlockNumber mismatch: %v != %v", p.BlockNumber, o.BlockNumber) + } + if p.GasLimit != o.GasLimit { + return fmt.Errorf("GasLimit mismatch: %v != %v", p.GasLimit, o.GasLimit) + } + if p.GasUsed != o.GasUsed { + return fmt.Errorf("GasUsed mismatch: %v != %v", p.GasUsed, o.GasUsed) + } + if p.Timestamp != o.Timestamp { + return fmt.Errorf("timestamp mismatch: %v != %v", p.Timestamp, o.Timestamp) + } + if p.BaseFeePerGas != o.BaseFeePerGas { + return fmt.Errorf("BaseFeePerGas mismatch: %v != %v", p.BaseFeePerGas, o.BaseFeePerGas) + } + if p.BlockHash != o.BlockHash { + return fmt.Errorf("BlockHash mismatch: %v != %v", p.BlockHash, o.BlockHash) + } + if !bytes.Equal(p.ExtraData, o.ExtraData) { + return fmt.Errorf("ExtraData mismatch") + } + if len(p.Transactions) != len(o.Transactions) { + return fmt.Errorf("transactions length mismatch: %d != %d", len(p.Transactions), len(o.Transactions)) + } + for i := range p.Transactions { + if !bytes.Equal(p.Transactions[i], o.Transactions[i]) { + return fmt.Errorf("transaction[%d] mismatch", i) + } + } + if (p.Withdrawals == nil) != (o.Withdrawals == nil) { + return fmt.Errorf("withdrawals nil mismatch: %v != %v", p.Withdrawals == nil, o.Withdrawals == nil) + } + if p.Withdrawals != nil { + if p.Withdrawals.Len() != o.Withdrawals.Len() { + return fmt.Errorf("withdrawals length mismatch: %d != %d", p.Withdrawals.Len(), o.Withdrawals.Len()) + } + for i := range p.Withdrawals.Len() { + if ((*p.Withdrawals)[i] == nil) != ((*o.Withdrawals)[i] == nil) { + return fmt.Errorf("withdrawals[%d] nil mismatch", i) + } + if (*p.Withdrawals)[i] != nil && *(*p.Withdrawals)[i] != *(*o.Withdrawals)[i] { + return fmt.Errorf("withdrawals[%d] mismatch", i) + } + } + } + if (p.BlobGasUsed == nil) != (o.BlobGasUsed == nil) { + return fmt.Errorf("BlobGasUsed nil mismatch") + } + if p.BlobGasUsed != nil && *p.BlobGasUsed != *o.BlobGasUsed { + return fmt.Errorf("BlobGasUsed mismatch: %v != %v", *p.BlobGasUsed, *o.BlobGasUsed) + } + if (p.ExcessBlobGas == nil) != (o.ExcessBlobGas == nil) { + return fmt.Errorf("ExcessBlobGas nil mismatch") + } + if p.ExcessBlobGas != nil && *p.ExcessBlobGas != *o.ExcessBlobGas { + return fmt.Errorf("ExcessBlobGas mismatch: %v != %v", *p.ExcessBlobGas, *o.ExcessBlobGas) + } + if (p.WithdrawalsRoot == nil) != (o.WithdrawalsRoot == nil) { + return fmt.Errorf("WithdrawalsRoot nil mismatch") + } + if p.WithdrawalsRoot != nil && *p.WithdrawalsRoot != *o.WithdrawalsRoot { + return fmt.Errorf("WithdrawalsRoot mismatch: %v != %v", *p.WithdrawalsRoot, *o.WithdrawalsRoot) + } + return nil +} + func (payload *ExecutionPayload) ID() BlockID { return BlockID{Hash: payload.BlockHash, Number: uint64(payload.BlockNumber)} } @@ -344,6 +435,9 @@ func (envelope *ExecutionPayloadEnvelope) CheckBlockHash() (actual common.Hash, return blockHash, blockHash == payload.BlockHash } +// BlockAsPayload converts a [*types.Block] to an [ExecutionPayload]. It can only be used to convert +// OP-Stack blocks, as it follows Canyon and Isthmus rules to set the Withdrawals and +// WithdrawalsRoot fields. func BlockAsPayload(bl *types.Block, config *params.ChainConfig) (*ExecutionPayload, error) { baseFee, overflow := uint256.FromBig(bl.BaseFee()) if overflow { @@ -381,11 +475,11 @@ func BlockAsPayload(bl *types.Block, config *params.ChainConfig) (*ExecutionPayl // WithdrawalsRoot is only set starting at Isthmus } - if config.ShanghaiTime != nil && uint64(payload.Timestamp) >= *config.ShanghaiTime { + if config.IsCanyon(uint64(payload.Timestamp)) { payload.Withdrawals = &types.Withdrawals{} } - if config.IsthmusTime != nil && uint64(payload.Timestamp) >= *config.IsthmusTime { + if config.IsIsthmus(uint64(payload.Timestamp)) { payload.WithdrawalsRoot = bl.Header().WithdrawalsHash } @@ -425,6 +519,8 @@ type PayloadAttributes struct { GasLimit *Uint64Quantity `json:"gasLimit,omitempty"` // EIP-1559 parameters, to be specified only post-Holocene EIP1559Params *Bytes8 `json:"eip1559Params,omitempty"` + // MinBaseFee is the minimum base fee, to be specified only post-Jovian + MinBaseFee *uint64 `json:"minBaseFee,omitempty"` } // IsDepositsOnly returns whether all transactions of the PayloadAttributes are of Deposit diff --git a/op-service/flags/flags.go b/op-service/flags/flags.go index c9763414c6e..2f51794b57d 100644 --- a/op-service/flags/flags.go +++ b/op-service/flags/flags.go @@ -22,6 +22,7 @@ const ( PectraBlobScheduleOverrideFlagName = "override.pectrablobschedule" IsthmusOverrideFlagName = "override.isthmus" InteropOverrideFlagName = "override.interop" + JovianOverrideFlagName = "override.jovian" ) func CLIFlags(envPrefix string, category string) []cli.Flag { @@ -82,6 +83,13 @@ func CLIFlags(envPrefix string, category string) []cli.Flag { Hidden: false, Category: category, }, + &cli.Uint64Flag{ + Name: JovianOverrideFlagName, + Usage: "Manually specify the Jovian fork timestamp, overriding the bundled setting", + EnvVars: opservice.PrefixEnvVar(envPrefix, "OVERRIDE_JOVIAN"), + Hidden: false, + Category: category, + }, &cli.Uint64Flag{ Name: InteropOverrideFlagName, Usage: "Manually specify the Interop fork timestamp, overriding the bundled setting", diff --git a/op-service/httputil/downloader.go b/op-service/httputil/downloader.go new file mode 100644 index 00000000000..89a6bffab46 --- /dev/null +++ b/op-service/httputil/downloader.go @@ -0,0 +1,59 @@ +package httputil + +import ( + "context" + "fmt" + "io" + "net/http" + + "github.com/ethereum-optimism/optimism/op-service/ioutil" +) + +type Downloader struct { + Client *http.Client + Progressor ioutil.Progressor + MaxSize int64 +} + +func (d *Downloader) Download(ctx context.Context, url string, out io.Writer) error { + if out == nil { + return fmt.Errorf("output writer is nil") + } + + req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil) + if err != nil { + return fmt.Errorf("failed to create request: %w", err) + } + + client := d.Client + if client == nil { + client = http.DefaultClient + } + resp, err := client.Do(req) + if err != nil { + return err + } + if resp.StatusCode < 200 || resp.StatusCode >= 300 { + return fmt.Errorf("download failed with status code %d: %s", resp.StatusCode, resp.Status) + } + if resp.ContentLength > 0 && d.MaxSize > 0 && resp.ContentLength > d.MaxSize { + return fmt.Errorf("content length %d exceeds maximum allowed size %d", resp.ContentLength, d.MaxSize) + } + + defer resp.Body.Close() + + r := io.Reader(resp.Body) + if d.MaxSize > 0 { + r = io.LimitReader(resp.Body, d.MaxSize) + } + + pr := &ioutil.ProgressReader{ + R: r, + Progressor: d.Progressor, + Total: resp.ContentLength, + } + if _, err := io.Copy(out, pr); err != nil { + return fmt.Errorf("failed to write download: %w", err) + } + return nil +} diff --git a/op-service/httputil/downloader_test.go b/op-service/httputil/downloader_test.go new file mode 100644 index 00000000000..66cc9f52b00 --- /dev/null +++ b/op-service/httputil/downloader_test.go @@ -0,0 +1,61 @@ +package httputil + +import ( + "bytes" + "context" + "fmt" + "io" + "net/http" + "net/http/httptest" + "testing" + + "github.com/stretchr/testify/require" +) + +func TestDownloader_Download(t *testing.T) { + t.Run("ok", func(t *testing.T) { + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusOK) + _, _ = fmt.Fprint(w, "test") + })) + t.Cleanup(srv.Close) + + d := new(Downloader) + out := new(bytes.Buffer) + err := d.Download(context.Background(), srv.URL, out) + require.NoError(t, err) + require.Equal(t, "test", out.String()) + }) + + t.Run("above max size", func(t *testing.T) { + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusOK) + _, _ = fmt.Fprint(w, "test") + })) + t.Cleanup(srv.Close) + + d := &Downloader{ + MaxSize: 2, + } + out := new(bytes.Buffer) + err := d.Download(context.Background(), srv.URL, out) + require.ErrorContains(t, err, "exceeds maximum allowed size") + }) + + t.Run("above max size with fake content length", func(t *testing.T) { + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + // Header needs to come before WriteHeader otherwise it will be automatically corrected. + w.Header().Set("Content-Length", "1") + w.WriteHeader(http.StatusOK) + _, _ = fmt.Fprint(w, "test") + })) + t.Cleanup(srv.Close) + + d := &Downloader{ + MaxSize: 2, + } + out := new(bytes.Buffer) + err := d.Download(context.Background(), srv.URL, out) + require.ErrorIs(t, err, io.ErrUnexpectedEOF) + }) +} diff --git a/op-service/ioutil/progress.go b/op-service/ioutil/progress.go new file mode 100644 index 00000000000..680175803cc --- /dev/null +++ b/op-service/ioutil/progress.go @@ -0,0 +1,86 @@ +package ioutil + +import ( + "io" + "sync" + "time" + + "github.com/ethereum/go-ethereum/log" + "github.com/schollz/progressbar/v3" +) + +type Progressor func(curr, total int64) + +func BarProgressor() Progressor { + var bar *progressbar.ProgressBar + var init sync.Once + return func(curr, total int64) { + init.Do(func() { + bar = progressbar.DefaultBytes(total) + }) + _ = bar.Set64(curr) + } +} + +func NoopProgressor() Progressor { + return func(curr, total int64) {} +} + +type LogProgressor struct { + L log.Logger + Msg string + Interval time.Duration + + lastLog time.Time + mu sync.Mutex +} + +func NewLogProgressor(l log.Logger, msg string) *LogProgressor { + return &LogProgressor{ + L: l, + Msg: msg, + } +} + +func (l *LogProgressor) Progressor(curr, total int64) { + if !l.calcInterval() { + return + } + + msg := l.Msg + if msg == "" { + msg = "progress" + } + l.L.Info(msg, "current", curr, "total", total) +} + +func (l *LogProgressor) calcInterval() bool { + l.mu.Lock() + defer l.mu.Unlock() + + interval := l.Interval + if interval == 0 { + interval = time.Second + } + if time.Since(l.lastLog) < interval { + return false + } + l.lastLog = time.Now() + return true +} + +type ProgressReader struct { + R io.Reader + Progressor Progressor + curr int64 + Total int64 +} + +func (pr *ProgressReader) Read(p []byte) (int, error) { + n, err := pr.R.Read(p) + pr.curr += int64(n) + if pr.Progressor != nil { + pr.Progressor(pr.curr, pr.Total) + } + return n, err +} diff --git a/op-service/logpipe/pipe.go b/op-service/logpipe/pipe.go new file mode 100644 index 00000000000..64e7d1b89d3 --- /dev/null +++ b/op-service/logpipe/pipe.go @@ -0,0 +1,132 @@ +package logpipe + +import ( + "bufio" + "bytes" + "encoding/json" + "errors" + "io" + "log/slog" + + oplog "github.com/ethereum-optimism/optimism/op-service/log" + "github.com/ethereum/go-ethereum/log" +) + +type rawRustJSONLog struct { + //"timestamp" ignored + Level string `json:"level"` + Fields map[string]any `json:"fields"` + //"target" ignored" +} + +type StructuredRustLogEntry struct { + Message string + Level slog.Level + Fields map[string]any +} + +func ParseRustStructuredLogs(line []byte) LogEntry { + dec := json.NewDecoder(bytes.NewReader(line)) + dec.UseNumber() // to preserve number formatting + var e rawRustJSONLog + if err := dec.Decode(&e); err != nil { + return StructuredRustLogEntry{ + Message: "Invalid JSON", + Level: slog.LevelWarn, + Fields: map[string]any{"line": string(line)}, + } + } + lvl, err := oplog.LevelFromString(e.Level) + if err != nil { + lvl = log.LevelInfo + } + msg, _ := e.Fields["message"].(string) + delete(e.Fields, "message") + + return StructuredRustLogEntry{ + Message: msg, + Level: lvl, + Fields: e.Fields, + } +} + +func (e StructuredRustLogEntry) LogLevel() slog.Level { + return e.Level +} + +func (e StructuredRustLogEntry) LogMessage() string { + return e.Message +} + +func (e StructuredRustLogEntry) LogFields() []any { + attrs := make([]any, 0, len(e.Fields)) + for k, v := range e.Fields { + if x, ok := v.(json.Number); ok { + v = x.String() + } + attrs = append(attrs, slog.Any(k, v)) + } + return attrs +} + +func (e StructuredRustLogEntry) FieldValue(key string) any { + return e.Fields[key] +} + +type LogEntry interface { + LogLevel() slog.Level + LogMessage() string + LogFields() []any + FieldValue(key string) any +} + +type LogProcessor func(line []byte) + +type LogParser func(line []byte) LogEntry + +func ToLogger(logger log.Logger) func(e LogEntry) { + return func(e LogEntry) { + msg := e.LogMessage() + attrs := e.LogFields() + lvl := e.LogLevel() + + if lvl >= log.LevelCrit { + // If a sub-process has a critical error, this process can handle it + // Don't force an os.Exit, downgrade to error instead + lvl = log.LevelError + attrs = append(attrs, slog.String("innerLevel", "CRIT")) + } + logger.Log(lvl, msg, attrs...) + } +} + +// PipeLogs reads logs from the provided io.ReadCloser (e.g., subprocess stdout), +// and outputs them to the provider logger. +// +// This: +// 1. assumes each line is a JSON object +// 2. parses it +// 3. extracts the "level" and optional "msg" +// 4. treats remaining fields as structured attributes +// 5. logs the entries using the provided log.Logger +// +// Non-JSON lines are logged as warnings. +// Crit level is mapped to error-level, to prevent untrusted crit logs from stopping the process. +// This function processes until the stream ends, and closes the reader. +// This returns the first read error (If we run into EOF, nil returned is returned instead). +func PipeLogs(r io.ReadCloser, onLog LogProcessor) (outErr error) { + defer func() { + outErr = errors.Join(outErr, r.Close()) + }() + + scanner := bufio.NewScanner(r) + for scanner.Scan() { + lineBytes := scanner.Bytes() + if len(lineBytes) == 0 { + continue // Skip empty lines + } + onLog(lineBytes) + } + + return scanner.Err() +} diff --git a/op-service/logpipe/pipe_test.go b/op-service/logpipe/pipe_test.go new file mode 100644 index 00000000000..19b4a1baee4 --- /dev/null +++ b/op-service/logpipe/pipe_test.go @@ -0,0 +1,63 @@ +package logpipe + +import ( + "bytes" + "io" + "sync" + "testing" + + "github.com/stretchr/testify/require" + + "github.com/ethereum/go-ethereum/log" + + "github.com/ethereum-optimism/optimism/op-service/testlog" +) + +func TestPipeLogs(t *testing.T) { + logger, capt := testlog.CaptureLogger(t, log.LevelTrace) + + wg := new(sync.WaitGroup) + wg.Add(2) + + r, w := io.Pipe() + // Write the log output to the pipe + go func() { + defer wg.Done() + _, err := io.Copy(w, bytes.NewReader([]byte(`{"level": "DEBUG", "fields": {"message": "hello", "foo": 1}}`+"\n"))) + require.NoError(t, err) + _, err = io.Copy(w, bytes.NewReader([]byte(`test invalid JSON`+"\n"))) + require.NoError(t, err) + _, err = io.Copy(w, bytes.NewReader([]byte(`{"fields": {"message": "world", "bar": "sunny"}, "level": "INFO"}`+"\n"))) + require.NoError(t, err) + require.NoError(t, w.Close()) + }() + // Read the log output from the pipe + go func() { + defer wg.Done() + toLogger := ToLogger(logger) + logProc := func(line []byte) { + toLogger(ParseRustStructuredLogs(line)) + } + err := PipeLogs(r, logProc) + require.NoError(t, err) + }() + wg.Wait() + + entry1 := capt.FindLog( + testlog.NewLevelFilter(log.LevelDebug), + testlog.NewAttributesContainsFilter("foo", "1")) + require.NotNil(t, entry1) + require.Equal(t, "hello", entry1.Message) + + entry2 := capt.FindLog( + testlog.NewLevelFilter(log.LevelWarn), + testlog.NewAttributesContainsFilter("line", "test invalid JSON")) + require.NotNil(t, entry2) + require.Equal(t, "Invalid JSON", entry2.Message) + + entry3 := capt.FindLog( + testlog.NewLevelFilter(log.LevelInfo), + testlog.NewAttributesContainsFilter("bar", "sunny")) + require.NotNil(t, entry3) + require.Equal(t, "world", entry3.Message) +} diff --git a/op-service/plan/node.go b/op-service/plan/node.go index 7622f5a845c..ea8332a52b8 100644 --- a/op-service/plan/node.go +++ b/op-service/plan/node.go @@ -172,6 +172,20 @@ func (p *Lazy[V]) DependOn(dep ...upstreamDep) { p.invalidate() } +// ResetFnAndDependencies sets the Fn to nil and unregisters all existing dependencies from the value. +func (p *Lazy[V]) ResetFnAndDependencies() { + p.mu.Lock() + defer p.mu.Unlock() + p.upstream.Lock() + defer p.upstream.Unlock() + for _, d := range p.upstream.Value { + d.unregister(p) + } + p.upstream.Value = nil + p.fn = nil + p.invalidate() +} + // Set invalidates any downstream deps, and sets the value. func (p *Lazy[V]) Set(v V) { p.mu.Lock() diff --git a/op-service/plan/node_test.go b/op-service/plan/node_test.go index dea7d040676..a242f84625d 100644 --- a/op-service/plan/node_test.go +++ b/op-service/plan/node_test.go @@ -105,6 +105,77 @@ func TestNode(t *testing.T) { require.Equal(t, `*plan.Lazy[uint64](*plan.Lazy[uint64], *plan.Lazy[uint32])`, s) }) + t.Run("reset dependencies - no downstream invalidation", func(t *testing.T) { + x := new(plan.Lazy[int]) + y := new(plan.Lazy[int]) + z := new(plan.Lazy[int]) + x.DependOn(y, z) + y.Set(10) + z.Set(20) + x.Fn(func(ctx context.Context) (int, error) { + return y.Value() + z.Value(), nil + }) + val, err := x.Eval(context.Background()) + require.NoError(t, err) + require.Equal(t, 10+20, val) + + x.ResetFnAndDependencies() + x.Set(100) + y.Set(30) // Changing y or z no longer invalidates x + z.Set(20) + val, err = x.Eval(context.Background()) + require.NoError(t, err) + require.Equal(t, 100, val) + }) + + t.Run("reset dependencies - no upstream evaluation", func(t *testing.T) { + x := new(plan.Lazy[int]) + y := new(plan.Lazy[int]) + z := new(plan.Lazy[int]) + x.DependOn(y, z) + x.Fn(func(ctx context.Context) (int, error) { + return 100, nil + }) + dependencyCalls := 0 + countEvaluations := func(ctx context.Context) (int, error) { + dependencyCalls++ + return 0, nil + } + y.Fn(countEvaluations) + z.Fn(countEvaluations) + + x.ResetFnAndDependencies() + x.Fn(func(ctx context.Context) (int, error) { + return 100, nil + }) + val, err := x.Eval(context.Background()) + require.NoError(t, err) + require.Equal(t, 100, val) + require.Zero(t, dependencyCalls, "Previous dependencies should not be evaluated") + }) + + t.Run("reset dependencies - other nodes unaffected", func(t *testing.T) { + x := new(plan.Lazy[int]) + y := new(plan.Lazy[int]) + y.DependOn(x) + y.Fn(func(ctx context.Context) (int, error) { + return x.Value() + 10, nil + }) + + x.Set(5) + val, err := y.Eval(context.Background()) + require.NoError(t, err) + require.Equal(t, 15, val) + + x.ResetFnAndDependencies() + + // y should be re-evaluated even though x no longer has dependencies + x.Set(6) + val, err = y.Eval(context.Background()) + require.NoError(t, err) + require.Equal(t, 16, val) + }) + t.Run("close", func(t *testing.T) { x := new(plan.Lazy[uint64]) y := new(plan.Lazy[int32]) diff --git a/op-service/sources/sync_tester_client.go b/op-service/sources/sync_tester_client.go index 63cb19238fb..7285e75e705 100644 --- a/op-service/sources/sync_tester_client.go +++ b/op-service/sources/sync_tester_client.go @@ -25,3 +25,19 @@ func (cl *SyncTesterClient) ChainID(ctx context.Context) (eth.ChainID, error) { err := cl.client.CallContext(ctx, &result, "eth_chainId") return result, err } + +func (cl *SyncTesterClient) GetSession(ctx context.Context) (*eth.SyncTesterSession, error) { + var session *eth.SyncTesterSession + err := cl.client.CallContext(ctx, &session, "sync_getSession") + return session, err +} + +func (cl *SyncTesterClient) ListSessions(ctx context.Context) ([]string, error) { + var sessions []string + err := cl.client.CallContext(ctx, &sessions, "sync_listSessions") + return sessions, err +} + +func (cl *SyncTesterClient) DeleteSession(ctx context.Context) error { + return cl.client.CallContext(ctx, nil, "sync_deleteSession") +} diff --git a/op-service/sources/types.go b/op-service/sources/types.go index 0bf7ed41755..efbbe78ed2c 100644 --- a/op-service/sources/types.go +++ b/op-service/sources/types.go @@ -257,24 +257,30 @@ func (block *RPCBlock) ExecutionPayloadEnvelope(trustCache bool) (*eth.Execution } payload := ð.ExecutionPayload{ - ParentHash: block.ParentHash, - FeeRecipient: block.Coinbase, - StateRoot: eth.Bytes32(block.Root), - ReceiptsRoot: eth.Bytes32(block.ReceiptHash), - LogsBloom: block.Bloom, - PrevRandao: eth.Bytes32(block.MixDigest), // mix-digest field is used for prevRandao post-merge - BlockNumber: block.Number, - GasLimit: block.GasLimit, - GasUsed: block.GasUsed, - Timestamp: block.Time, - ExtraData: eth.BytesMax32(block.Extra), - BaseFeePerGas: eth.Uint256Quantity(baseFee), - BlockHash: block.Hash, - Transactions: opaqueTxs, - Withdrawals: block.Withdrawals, - BlobGasUsed: block.BlobGasUsed, - ExcessBlobGas: block.ExcessBlobGas, - WithdrawalsRoot: block.WithdrawalsRoot, + ParentHash: block.ParentHash, + FeeRecipient: block.Coinbase, + StateRoot: eth.Bytes32(block.Root), + ReceiptsRoot: eth.Bytes32(block.ReceiptHash), + LogsBloom: block.Bloom, + PrevRandao: eth.Bytes32(block.MixDigest), // mix-digest field is used for prevRandao post-merge + BlockNumber: block.Number, + GasLimit: block.GasLimit, + GasUsed: block.GasUsed, + Timestamp: block.Time, + ExtraData: eth.BytesMax32(block.Extra), + BaseFeePerGas: eth.Uint256Quantity(baseFee), + BlockHash: block.Hash, + Transactions: opaqueTxs, + Withdrawals: block.Withdrawals, + BlobGasUsed: block.BlobGasUsed, + ExcessBlobGas: block.ExcessBlobGas, + } + + // Only Isthmus execution payloads must set the withdrawals root. + // They are guaranteed to not be the empty withdrawals hash, which is set pre-Isthmus (post-Canyon). + if wr := block.WithdrawalsRoot; wr != nil && *wr != types.EmptyWithdrawalsHash { + wr := *wr + payload.WithdrawalsRoot = &wr } return ð.ExecutionPayloadEnvelope{ diff --git a/op-service/tasks/await.go b/op-service/tasks/await.go new file mode 100644 index 00000000000..490fd2ca174 --- /dev/null +++ b/op-service/tasks/await.go @@ -0,0 +1,15 @@ +package tasks + +import "context" + +// Await waits for a value, and sets it to the destination value. +// This returns an error if the context closes before a value is received from the channel. +func Await[E any](ctx context.Context, src chan E, dest *E) error { + select { + case <-ctx.Done(): + return ctx.Err() + case x := <-src: + *dest = x + return nil + } +} diff --git a/op-service/testlog/testlog.go b/op-service/testlog/testlog.go index 2363530e237..0f03f9680c4 100644 --- a/op-service/testlog/testlog.go +++ b/op-service/testlog/testlog.go @@ -106,6 +106,8 @@ var ( ) func fileHandler(t Testing, outdir string, level slog.Level) slog.Handler { + var rootLoggerName string + rootSetup.Do(func() { f, err := os.OpenFile(path.Join(outdir, fmt.Sprintf("root-%d.log", os.Getpid())), os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644) if err != nil { @@ -119,6 +121,7 @@ func fileHandler(t Testing, outdir string, level slog.Level) slog.Handler { rootHdlr := log.NewTerminalHandlerWithLevel(writer, level, false) oplog.SetGlobalLogHandler(rootHdlr) t.Logf("redirecting root logger to %s", f.Name()) + rootLoggerName = f.Name() }) testName := fmt.Sprintf( @@ -146,6 +149,8 @@ func fileHandler(t Testing, outdir string, level slog.Level) slog.Handler { flMtx.Unlock() }) t.Logf("writing test log to %s", logPath) + t.Logf("some tests may have written to the root logger") + t.Logf("logs from the root logger have been written to %s", rootLoggerName) h := log.NewTerminalHandlerWithLevel(dw, level, false) flHandlers[testName] = h return h diff --git a/op-service/txintent/bindings/GasPriceOracle.go b/op-service/txintent/bindings/GasPriceOracle.go new file mode 100644 index 00000000000..8f08620451b --- /dev/null +++ b/op-service/txintent/bindings/GasPriceOracle.go @@ -0,0 +1,24 @@ +package bindings + +import ( + "math/big" + + "github.com/ethereum-optimism/optimism/op-service/eth" +) + +type GasPriceOracle struct { + // Read-only functions + BaseFeeScalar func() TypedCall[uint32] `sol:"baseFeeScalar"` + BlobBaseFeeScalar func() TypedCall[uint32] `sol:"blobBaseFeeScalar"` + L1BaseFee func() TypedCall[*eth.ETH] `sol:"l1BaseFee"` + BlobBaseFee func() TypedCall[*eth.ETH] `sol:"blobBaseFee"` + IsFjord func() TypedCall[bool] `sol:"isFjord"` + GetL1Fee func(data []byte) TypedCall[eth.ETH] `sol:"getL1Fee"` + GetL1GasUsed func(data []byte) TypedCall[uint64] `sol:"getL1GasUsed"` + GetL1FeeUpperBound func(unsignedTxSize *big.Int) TypedCall[eth.ETH] `sol:"getL1FeeUpperBound"` +} + +func NewGasPriceOracle(opts ...CallFactoryOption) *GasPriceOracle { + gpo := NewBindings[GasPriceOracle](opts...) + return &gpo +} diff --git a/op-service/txplan/txplan.go b/op-service/txplan/txplan.go index e2d41220fbf..07d802ad8a8 100644 --- a/op-service/txplan/txplan.go +++ b/op-service/txplan/txplan.go @@ -84,9 +84,9 @@ func WithTo(to *common.Address) Option { } } -func WithValue(val *big.Int) Option { +func WithValue(val eth.ETH) Option { return func(tx *PlannedTx) { - tx.Value.Set(val) + tx.Value.Set(val.ToBig()) } } @@ -135,6 +135,24 @@ func WithAuthorizations(auths []types.SetCodeAuthorization) Option { } } +func WithAuthorizationTo(codeAddr common.Address) Option { + return func(tx *PlannedTx) { + tx.AuthList.DependOn(&tx.Nonce, &tx.ChainID, &tx.Priv) + tx.AuthList.Fn(func(ctx context.Context) ([]types.SetCodeAuthorization, error) { + auth1, err := types.SignSetCode(tx.Priv.Value(), types.SetCodeAuthorization{ + ChainID: *uint256.MustFromBig(tx.ChainID.Value().ToBig()), + Address: codeAddr, + // before the nonce is compared with the authorization in the EVM, it is incremented by 1 + Nonce: tx.Nonce.Value() + 1, + }) + if err != nil { + return nil, fmt.Errorf("failed to sign 7702 authorization: %w", err) + } + return []types.SetCodeAuthorization{auth1}, nil + }) + } +} + func WithType(t uint8) Option { return func(tx *PlannedTx) { tx.Type.Set(t) @@ -143,6 +161,9 @@ func WithType(t uint8) Option { func WithGasLimit(limit uint64) Option { return func(tx *PlannedTx) { + // The gas limit is explicitly set so remove any dependencies which may have been added by a previous call + // to WithEstimator. + tx.Gas.ResetFnAndDependencies() tx.Gas.Set(limit) } } @@ -505,7 +526,7 @@ func (tx *PlannedTx) Defaults() { if rec.Status == types.ReceiptStatusSuccessful { return struct{}{}, nil } else { - return struct{}{}, errors.New("tx failed") + return struct{}{}, fmt.Errorf("tx failed with status %v (%v of %v gas used)", rec.Status, rec.GasUsed, tx.Gas.Value()) } }) } diff --git a/op-service/txplan/txplan_test.go b/op-service/txplan/txplan_test.go index ab889a3868b..b1a3e510b4a 100644 --- a/op-service/txplan/txplan_test.go +++ b/op-service/txplan/txplan_test.go @@ -16,7 +16,7 @@ func TestPlannedTx_Defaults(t *testing.T) { key, err := crypto.GenerateKey() require.NoError(t, err) - ptx := NewPlannedTx(WithPrivateKey(key), WithValue(big.NewInt(123))) + ptx := NewPlannedTx(WithPrivateKey(key), WithValue(eth.WeiU64(123))) t.Log("tx", ptx.Signed.String()) block := types.NewBlock(&types.Header{BaseFee: big.NewInt(7e9)}, nil, nil, nil, types.DefaultBlockConfig) diff --git a/op-supervisor/supervisor/backend/backend_test.go b/op-supervisor/supervisor/backend/backend_test.go index c1e7bcf6836..ca5035bc7c0 100644 --- a/op-supervisor/supervisor/backend/backend_test.go +++ b/op-supervisor/supervisor/backend/backend_test.go @@ -340,11 +340,13 @@ func TestBackendCallsMetrics(t *testing.T) { fullCfgSet := fullConfigSet(t, 1) cfg := &config.Config{ - Version: "test", - LogConfig: oplog.CLIConfig{}, - MetricsConfig: opmetrics.CLIConfig{}, - PprofConfig: oppprof.CLIConfig{}, - RPC: oprpc.CLIConfig{}, + Version: "test", + LogConfig: oplog.CLIConfig{}, + MetricsConfig: opmetrics.CLIConfig{}, + PprofConfig: oppprof.CLIConfig{}, + RPC: oprpc.CLIConfig{ + ListenAddr: "127.0.0.1", + }, FullConfigSetSource: fullCfgSet, SynchronousProcessors: true, MockRun: false, @@ -535,11 +537,13 @@ func TestAsyncVerifyAccessWithRPC(t *testing.T) { // Initialize backend with mock metrics cfg := &config.Config{ - Version: "test", - LogConfig: oplog.CLIConfig{}, - MetricsConfig: opmetrics.CLIConfig{}, - PprofConfig: oppprof.CLIConfig{}, - RPC: oprpc.CLIConfig{}, + Version: "test", + LogConfig: oplog.CLIConfig{}, + MetricsConfig: opmetrics.CLIConfig{}, + PprofConfig: oppprof.CLIConfig{}, + RPC: oprpc.CLIConfig{ + ListenAddr: "127.0.0.1", + }, FullConfigSetSource: fullCfgSet, SynchronousProcessors: true, MockRun: false, diff --git a/op-sync-tester/example_config.yaml b/op-sync-tester/example_config.yaml index 121fd6a60bb..04092229c8f 100644 --- a/op-sync-tester/example_config.yaml +++ b/op-sync-tester/example_config.yaml @@ -1,7 +1,10 @@ synctesters: local: chain_id: 2151908 - el_rpc: http://localhost:32988/ + el_rpc: http://localhost:62654/ sepolia: chain_id: 11155420 - el_rpc: https://sepolia.optimism.io + el_rpc: https://sepolia.optimism.io + mainnet: + chain_id: 10 + el_rpc: https://mainnet.optimism.io diff --git a/op-sync-tester/synctester/backend/backend.go b/op-sync-tester/synctester/backend/backend.go index 80ae7b04b0e..3743231519a 100644 --- a/op-sync-tester/synctester/backend/backend.go +++ b/op-sync-tester/synctester/backend/backend.go @@ -4,7 +4,6 @@ import ( "context" "errors" "fmt" - "sort" "github.com/ethereum/go-ethereum/log" "github.com/ethereum/go-ethereum/rpc" @@ -18,28 +17,6 @@ import ( sttypes "github.com/ethereum-optimism/optimism/op-sync-tester/synctester/backend/types" ) -type sessionKeyType struct{} - -var ctxKeySession = sessionKeyType{} - -// WithSession returns a new context with the given Session. -func WithSession(ctx context.Context, s *Session) context.Context { - return context.WithValue(ctx, ctxKeySession, s) -} - -// SessionFromContext retrieves the Session from the context, if present. -func SessionFromContext(ctx context.Context) (*Session, bool) { - s, ok := ctx.Value(ctxKeySession).(*Session) - return s, ok -} - -type Session struct { - SessionID string - Latest uint64 - Safe uint64 - Finalized uint64 -} - type APIRouter interface { AddRPC(route string) error AddAPIToRPC(route string, api rpc.API) error @@ -63,20 +40,14 @@ func FromConfig(log log.Logger, m metrics.Metricer, cfg *config.Config, router A log: log, m: m, } - var syncTesterIDs []sttypes.SyncTesterID + for stID, stCfg := range cfg.SyncTesters { st, err := SyncTesterFromConfig(log, m, stID, stCfg) if err != nil { return nil, fmt.Errorf("failed to setup sync tester %q: %w", stID, err) } b.syncTesters.Set(stID, st) - syncTesterIDs = append(syncTesterIDs, stID) } - // Infer defaults for chains that were not explicitly mentioned. - // Always use the lowest sync tester ID, so map-iteration doesn't affect defaults. - sort.Slice(syncTesterIDs, func(i, j int) bool { - return syncTesterIDs[i] < syncTesterIDs[j] - }) // Set up the sync tester routes var syncTesterErr error b.syncTesters.Range(func(id sttypes.SyncTesterID, st *SyncTester) bool { diff --git a/op-sync-tester/synctester/backend/backend_test.go b/op-sync-tester/synctester/backend/backend_test.go index b309ad78b59..142b82f032c 100644 --- a/op-sync-tester/synctester/backend/backend_test.go +++ b/op-sync-tester/synctester/backend/backend_test.go @@ -4,6 +4,7 @@ import ( "testing" "github.com/ethereum-optimism/optimism/op-service/endpoint" + "github.com/ethereum-optimism/optimism/op-service/eth" "github.com/ethereum-optimism/optimism/op-service/testlog" "github.com/ethereum/go-ethereum/log" "github.com/ethereum/go-ethereum/rpc" @@ -49,12 +50,14 @@ func TestBackend(t *testing.T) { logger := testlog.Logger(t, log.LevelInfo) syncTesterCfgA := &stconf.SyncTesterEntry{ - ELRPC: endpoint.MustRPC{Value: endpoint.URL("http://" + srv.Endpoint())}, + ELRPC: endpoint.MustRPC{Value: endpoint.URL("http://" + srv.Endpoint())}, + ChainID: eth.ChainIDFromUInt64(1), } syncTesterA := sttypes.SyncTesterID("syncTesterA") syncTesterCfgB := &stconf.SyncTesterEntry{ - ELRPC: endpoint.MustRPC{Value: endpoint.URL("http://" + srv.Endpoint())}, + ELRPC: endpoint.MustRPC{Value: endpoint.URL("http://" + srv.Endpoint())}, + ChainID: eth.ChainIDFromUInt64(2), } syncTesterB := sttypes.SyncTesterID("syncTesterB") diff --git a/op-sync-tester/synctester/backend/el_reader.go b/op-sync-tester/synctester/backend/el_reader.go new file mode 100644 index 00000000000..ee7ad6e8a44 --- /dev/null +++ b/op-sync-tester/synctester/backend/el_reader.go @@ -0,0 +1,82 @@ +package backend + +import ( + "context" + "encoding/json" + "math/big" + + "github.com/ethereum/go-ethereum/common" + "github.com/ethereum/go-ethereum/common/hexutil" + "github.com/ethereum/go-ethereum/core/types" + "github.com/ethereum/go-ethereum/ethclient" + "github.com/ethereum/go-ethereum/rpc" +) + +// ReadOnlyELBackend defines the minimal, read-only execution layer +// interface used by the sync tester and its mock backends. +// The interface exposes two flavors of block accessors: +// - JSON-returning methods (GetBlockByNumberJSON, GetBlockByHashJSON) +// which return the raw RPC payload exactly as delivered by the EL. +// These are useful for relaying the response from read-only exec layer directly +// - Typed methods (GetBlockByNumber, GetBlockByHash) which decode +// the RPC response into geth *types.Block for structured +// inspection in code. +// - Additional helpers include GetBlockReceipts and ChainId +// +// Implementation wraps ethclient.Client to forward RPC +// calls. For testing, a mock implementation can be provided to return +// deterministic values without requiring a live execution layer node. +type ReadOnlyELBackend interface { + GetBlockByNumberJSON(ctx context.Context, number rpc.BlockNumber, fullTx bool) (json.RawMessage, error) + GetBlockByHashJSON(ctx context.Context, hash common.Hash, fullTx bool) (json.RawMessage, error) + GetBlockByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Block, error) + GetBlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error) + GetBlockReceipts(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) ([]*types.Receipt, error) + ChainId(ctx context.Context) (hexutil.Big, error) +} + +var _ ReadOnlyELBackend = (*ELReader)(nil) + +type ELReader struct { + c *ethclient.Client +} + +func NewELReader(c *ethclient.Client) *ELReader { + return &ELReader{c: c} +} + +func (g *ELReader) GetBlockByNumberJSON(ctx context.Context, number rpc.BlockNumber, fullTx bool) (json.RawMessage, error) { + var raw json.RawMessage + if err := g.c.Client().CallContext(ctx, &raw, "eth_getBlockByNumber", number, fullTx); err != nil { + return nil, err + } + return raw, nil +} + +func (g *ELReader) GetBlockByHashJSON(ctx context.Context, hash common.Hash, fullTx bool) (json.RawMessage, error) { + var raw json.RawMessage + if err := g.c.Client().CallContext(ctx, &raw, "eth_getBlockByHash", hash, fullTx); err != nil { + return nil, err + } + return raw, nil +} + +func (g *ELReader) GetBlockByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Block, error) { + return g.c.BlockByNumber(ctx, big.NewInt(number.Int64())) +} + +func (g *ELReader) GetBlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error) { + return g.c.BlockByHash(ctx, hash) +} + +func (g *ELReader) GetBlockReceipts(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) ([]*types.Receipt, error) { + return g.c.BlockReceipts(ctx, blockNrOrHash) +} + +func (g *ELReader) ChainId(ctx context.Context) (hexutil.Big, error) { + chainID, err := g.c.ChainID(ctx) + if err != nil { + return hexutil.Big{}, err + } + return hexutil.Big(*chainID), nil +} diff --git a/op-sync-tester/synctester/backend/session/session.go b/op-sync-tester/synctester/backend/session/session.go new file mode 100644 index 00000000000..10da7b97e0b --- /dev/null +++ b/op-sync-tester/synctester/backend/session/session.go @@ -0,0 +1,112 @@ +package session + +import ( + "context" + "fmt" + "sort" + "sync" + + "github.com/ethereum-optimism/optimism/op-service/eth" + + "github.com/ethereum/go-ethereum/log" +) + +type SessionManager struct { + sync.Mutex + sessions map[string]*eth.SyncTesterSession + deletedSessionIDs map[string]struct{} + + log log.Logger +} + +type sessionKeyType struct{} + +var ctxKeySession = sessionKeyType{} + +// WithSyncTesterSession returns a new context with the given Session. +func WithSyncTesterSession(ctx context.Context, s *eth.SyncTesterSession) context.Context { + return context.WithValue(ctx, ctxKeySession, s) +} + +// SyncTesterSessionFromContext retrieves the Session from the context, if present. +func SyncTesterSessionFromContext(ctx context.Context) (*eth.SyncTesterSession, bool) { + s, ok := ctx.Value(ctxKeySession).(*eth.SyncTesterSession) + return s, ok +} + +func NewSessionManager(logger log.Logger) *SessionManager { + return &SessionManager{log: logger, + sessions: make(map[string]*eth.SyncTesterSession), + deletedSessionIDs: make(map[string]struct{}), + } +} + +func (s *SessionManager) SessionIDs() []string { + s.Lock() + defer s.Unlock() + keys := make([]string, 0) + for key := range s.sessions { + keys = append(keys, key) + } + sort.Strings(keys) + return keys +} + +func (s *SessionManager) DeleteSession(sessionID string) error { + s.Lock() + defer s.Unlock() + if _, ok := s.sessions[sessionID]; !ok { + return fmt.Errorf("attempted to delete non-existent session: %s", sessionID) + } + s.deletedSessionIDs[sessionID] = struct{}{} + delete(s.sessions, sessionID) + s.log.Info("Deleted session", "sessionID", sessionID) + return nil +} + +func (s *SessionManager) get(given *eth.SyncTesterSession) (*eth.SyncTesterSession, error) { + if given == nil { + s.log.Warn("No initial session value provided") + return nil, fmt.Errorf("no initial session value") + } + id := given.SessionID + s.Lock() + defer s.Unlock() + if _, ok := s.deletedSessionIDs[id]; ok { + s.log.Warn("Attempted to use deleted session", "sessionID", id) + return nil, fmt.Errorf("session already deleted: %s", id) + } + var sess *eth.SyncTesterSession + sess, ok := s.sessions[id] + if ok { + s.log.Trace("Using existing session", "sessionID", id) + } else { + s.sessions[id] = given + sess = given + s.log.Info("Initialized new session", "sessionID", id) + } + return sess, nil +} + +func WithSession[T any]( + mgr *SessionManager, + ctx context.Context, + logger log.Logger, + fn func(*eth.SyncTesterSession, log.Logger) (T, error), +) (T, error) { + var zero T + given, ok := SyncTesterSessionFromContext(ctx) + if !ok || given == nil { + return zero, fmt.Errorf("no session found in context") + } + session, err := mgr.get(given) + if err != nil { + return zero, err + } + // blocking + session.Lock() + defer session.Unlock() + // Bind session ID and starting fcu state + logger = logger.With("id", session.SessionID, "start_fcu", session.CurrentState) + return fn(session, logger) +} diff --git a/op-sync-tester/synctester/backend/sync_tester.go b/op-sync-tester/synctester/backend/sync_tester.go index 1fbf3e22648..c51060f3c16 100644 --- a/op-sync-tester/synctester/backend/sync_tester.go +++ b/op-sync-tester/synctester/backend/sync_tester.go @@ -1,44 +1,50 @@ package backend import ( + "bytes" "context" + "encoding/hex" + "encoding/json" "errors" "fmt" - "math/big" - "sync" "github.com/ethereum-optimism/optimism/op-service/eth" "github.com/ethereum-optimism/optimism/op-sync-tester/metrics" "github.com/ethereum/go-ethereum" + "github.com/ethereum/go-ethereum/beacon/engine" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/common/hexutil" + "github.com/ethereum/go-ethereum/consensus/misc/eip1559" "github.com/ethereum/go-ethereum/core/types" "github.com/ethereum/go-ethereum/ethclient" "github.com/ethereum/go-ethereum/log" + "github.com/ethereum/go-ethereum/miner" + "github.com/ethereum/go-ethereum/params" "github.com/ethereum/go-ethereum/rpc" - "github.com/holiman/uint256" "github.com/ethereum-optimism/optimism/op-sync-tester/synctester/backend/config" + "github.com/ethereum-optimism/optimism/op-sync-tester/synctester/backend/session" sttypes "github.com/ethereum-optimism/optimism/op-sync-tester/synctester/backend/types" "github.com/ethereum-optimism/optimism/op-sync-tester/synctester/frontend" ) -var ( - ErrNoSession = errors.New("no session") - ErrNoReceipts = errors.New("no receipts") -) - type SyncTester struct { - mu sync.RWMutex - log log.Logger m metrics.Metricer - id sttypes.SyncTesterID - chainID eth.ChainID - elClient *ethclient.Client + id sttypes.SyncTesterID + chainID eth.ChainID + + elReader ReadOnlyELBackend + + sessMgr *session.SessionManager +} - sessions map[string]*Session +// HeaderNumberOnly is a lightweight header type that only contains the +// block number field. It is useful in contexts where the full Ethereum +// block header is not needed, and only the block number is required. +type HeaderNumberOnly struct { + Number *hexutil.Big `json:"number" gencodec:"required"` } var _ frontend.SyncBackend = (*SyncTester)(nil) @@ -51,155 +57,660 @@ func SyncTesterFromConfig(logger log.Logger, m metrics.Metricer, stID sttypes.Sy if err != nil { return nil, fmt.Errorf("failed to dial EL client: %w", err) } + elReader := NewELReader(elClient) + logger.Info("Initialized sync tester from config", "syncTester", stID) + return NewSyncTester(logger, m, stID, stCfg.ChainID, elReader), nil +} + +func NewSyncTester(logger log.Logger, m metrics.Metricer, stID sttypes.SyncTesterID, chainID eth.ChainID, elReader ReadOnlyELBackend) *SyncTester { return &SyncTester{ log: logger, m: m, id: stID, - chainID: stCfg.ChainID, - elClient: elClient, - sessions: make(map[string]*Session), - }, nil -} - -func (s *SyncTester) fetchSession(ctx context.Context) (*Session, error) { - session, ok := SessionFromContext(ctx) - if !ok || session == nil { - return nil, fmt.Errorf("no session found in context") - } - s.mu.Lock() - defer s.mu.Unlock() - if existing, ok := s.sessions[session.SessionID]; ok { - s.log.Info("Using existing session", "session", existing) - } else { - s.sessions[session.SessionID] = session - s.log.Info("Initialized new session", "session", session) + chainID: chainID, + elReader: elReader, + sessMgr: session.NewSessionManager(logger), } - return session, nil } -func (s *SyncTester) GetSession(ctx context.Context) error { - _, err := s.fetchSession(ctx) - if err != nil { - return ErrNoSession - } - return nil +func (s *SyncTester) GetSession(ctx context.Context) (*eth.SyncTesterSession, error) { + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (*eth.SyncTesterSession, error) { + logger.Debug("GetSession") + return session, nil + }) } func (s *SyncTester) DeleteSession(ctx context.Context) error { - session, err := s.fetchSession(ctx) - if err != nil { - return ErrNoSession - } - delete(s.sessions, session.SessionID) - return nil + _, err := session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (any, error) { + logger.Debug("DeleteSession") + return struct{}{}, s.sessMgr.DeleteSession(session.SessionID) + }) + return err } func (s *SyncTester) ListSessions(ctx context.Context) ([]string, error) { - panic("not implemented") + ids := s.sessMgr.SessionIDs() + s.log.Debug("ListSessions", "count", len(ids)) + return ids, nil } func (s *SyncTester) GetBlockReceipts(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) ([]*types.Receipt, error) { - session, err := s.fetchSession(ctx) - if err != nil { - return nil, err - } - - receipts, err := s.elClient.BlockReceipts(ctx, blockNrOrHash) - if err != nil { - return nil, err - } - - if len(receipts) == 0 { - return nil, ErrNoReceipts - } - - if receipts[0].BlockNumber.Uint64() > session.Latest { - return nil, ethereum.NotFound - } - - return receipts, nil + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) ([]*types.Receipt, error) { + logger.Debug("GetBlockReceipts", "blockNrOrHash", blockNrOrHash) + number, isNumber := blockNrOrHash.Number() + var err error + var receipts []*types.Receipt + if !isNumber { + // hash + receipts, err = s.elReader.GetBlockReceipts(ctx, blockNrOrHash) + if err != nil { + return nil, err + } + } else { + var target uint64 + if target, err = s.checkBlockNumber(number, session, logger); err != nil { + return nil, err + } + receipts, err = s.elReader.GetBlockReceipts(ctx, rpc.BlockNumberOrHashWithNumber(rpc.BlockNumber(target))) + if err != nil { + return nil, err + } + } + if len(receipts) == 0 { + // Should never happen since every block except genesis has at least one deposit tx + logger.Warn("L2 Block has zero receipts", "blockNrHash", blockNrOrHash) + return nil, errors.New("no receipts") + } + target := receipts[0].BlockNumber.Uint64() + if target > session.CurrentState.Latest { + logger.Warn("Requested block is ahead of sync tester state", "requested", target) + return nil, ethereum.NotFound + } + return receipts, nil + }) } -func (s *SyncTester) GetBlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error) { - session, err := s.fetchSession(ctx) - if err != nil { - return nil, err - } - - block, err := s.elClient.BlockByHash(ctx, hash) - if err != nil { - return nil, err - } - - if block.NumberU64() > session.Latest { - return nil, ethereum.NotFound - } - - return block, nil +func (s *SyncTester) GetBlockByHash(ctx context.Context, hash common.Hash, fullTx bool) (json.RawMessage, error) { + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (json.RawMessage, error) { + logger.Debug("GetBlockByHash", "hash", hash, "fullTx", fullTx) + var err error + var raw json.RawMessage + if raw, err = s.elReader.GetBlockByHashJSON(ctx, hash, fullTx); err != nil { + return nil, err + } + var header HeaderNumberOnly + if err := json.Unmarshal(raw, &header); err != nil { + return nil, err + } + target := header.Number.ToInt().Uint64() + if target > session.CurrentState.Latest { + logger.Warn("Requested block is ahead of sync tester state", "requested", target) + return nil, ethereum.NotFound + } + return raw, nil + }) } -func (s *SyncTester) GetBlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) { - session, err := s.fetchSession(ctx) - if err != nil { - return nil, err - } - - if number.Uint64() > session.Latest { - return nil, ethereum.NotFound +func (s *SyncTester) checkBlockNumber(number rpc.BlockNumber, session *eth.SyncTesterSession, logger log.Logger) (uint64, error) { + var target uint64 + switch number { + case rpc.LatestBlockNumber: + target = session.CurrentState.Latest + case rpc.SafeBlockNumber: + target = session.CurrentState.Safe + case rpc.FinalizedBlockNumber: + target = session.CurrentState.Finalized + case rpc.PendingBlockNumber, rpc.EarliestBlockNumber: + // pending, earliest block label not supported + return 0, ethereum.NotFound + default: + if number.Int64() < 0 { + // safety guard for overflow + return 0, ethereum.NotFound + } + target = uint64(number.Int64()) + // Short circuit for numeric request beyond sync tester canonical head + if target > session.CurrentState.Latest { + logger.Warn("Requested block is ahead of sync tester state", "requested", target) + return 0, ethereum.NotFound + } } - - return s.elClient.BlockByNumber(ctx, number) + return target, nil } -func (s *SyncTester) ChainId(ctx context.Context) (eth.ChainID, error) { - _, err := s.fetchSession(ctx) - if err != nil { - return eth.ChainID(uint256.Int{}), err - } +func (s *SyncTester) GetBlockByNumber(ctx context.Context, number rpc.BlockNumber, fullTx bool) (json.RawMessage, error) { + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (json.RawMessage, error) { + logger.Debug("GetBlockByNumber", "number", number, "fullTx", fullTx) + var err error + var target uint64 + if target, err = s.checkBlockNumber(number, session, logger); err != nil { + return nil, err + } + var raw json.RawMessage + if raw, err = s.elReader.GetBlockByNumberJSON(ctx, rpc.BlockNumber(target), fullTx); err != nil { + return nil, err + } + return raw, nil + }) +} - return s.chainID, nil +func (s *SyncTester) ChainId(ctx context.Context) (hexutil.Big, error) { + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (hexutil.Big, error) { + logger.Debug("ChainId") + chainID, err := s.elReader.ChainId(ctx) + if err != nil { + return hexutil.Big{}, err + } + if chainID.ToInt().Cmp(s.chainID.ToBig()) != 0 { + logger.Error("ChainId mismatch", "config", s.chainID, "backend", chainID.ToInt()) + return hexutil.Big{}, fmt.Errorf("chainID mismatch: config: %s, backend: %s", s.chainID, chainID.ToInt()) + } + return hexutil.Big(*s.chainID.ToBig()), nil + }) } -func (s *SyncTester) GetPayloadV1(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayload, error) { - return nil, nil +// GetPayloadV1 only supports V1 payloads. +func (s *SyncTester) GetPayloadV1(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) { + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (*eth.ExecutionPayloadEnvelope, error) { + logger.Debug("GetPayloadV1", "payloadID", payloadID) + if !payloadID.Is(engine.PayloadV1) { + return nil, engine.UnsupportedFork + } + return s.getPayload(session, logger, payloadID) + }) } +// GetPayloadV2 supports V1, V2 payloads. func (s *SyncTester) GetPayloadV2(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) { - return nil, nil + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (*eth.ExecutionPayloadEnvelope, error) { + logger.Debug("GetPayloadV2", "payloadID", payloadID) + if !payloadID.Is(engine.PayloadV1, engine.PayloadV2) { + return nil, engine.UnsupportedFork + } + return s.getPayload(session, logger, payloadID) + }) } +// GetPayloadV3 must be only called when Ecotone activated. func (s *SyncTester) GetPayloadV3(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) { - return nil, nil + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (*eth.ExecutionPayloadEnvelope, error) { + logger.Debug("GetPayloadV3", "payloadID", payloadID) + if !payloadID.Is(engine.PayloadV3) { + return nil, engine.UnsupportedFork + } + return s.getPayload(session, logger, payloadID) + }) } +// GetPayloadV4 must be only called when Isthmus activated. func (s *SyncTester) GetPayloadV4(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) { - return nil, nil + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (*eth.ExecutionPayloadEnvelope, error) { + logger.Debug("GetPayloadV4", "payloadID", payloadID) + if !payloadID.Is(engine.PayloadV3) { + return nil, engine.UnsupportedFork + } + return s.getPayload(session, logger, payloadID) + }) } +// getPayload retrieves an execution payload previously initialized by +// ForkchoiceUpdated engine APIs when valid payload attributes were provided. +// Retrieved payloads are deleted from the session after being served to +// emulate one-time consumption by the consensus layer. +func (s *SyncTester) getPayload(session *eth.SyncTesterSession, logger log.Logger, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) { + payloadEnv, ok := session.Payloads[payloadID] + if !ok { + return nil, engine.UnknownPayload + } + // Clean up payload + delete(session.Payloads, payloadID) + logger.Trace("Deleted payload", "payloadID", payloadID) + return payloadEnv, nil +} + +// ForkchoiceUpdatedV1 is called for processing V1 attributes func (s *SyncTester) ForkchoiceUpdatedV1(ctx context.Context, state *eth.ForkchoiceState, attr *eth.PayloadAttributes) (*eth.ForkchoiceUpdatedResult, error) { - return nil, nil + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (*eth.ForkchoiceUpdatedResult, error) { + logger.Debug("ForkchoiceUpdatedV1", "state", state, "attr", attr) + return s.forkchoiceUpdated(ctx, session, logger, state, attr, engine.PayloadV1, false, false) + }) } +// ForkchoiceUpdatedV2 is called for processing V2 attributes func (s *SyncTester) ForkchoiceUpdatedV2(ctx context.Context, state *eth.ForkchoiceState, attr *eth.PayloadAttributes) (*eth.ForkchoiceUpdatedResult, error) { - return nil, nil + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (*eth.ForkchoiceUpdatedResult, error) { + logger.Debug("ForkchoiceUpdatedV2", "state", state, "attr", attr) + return s.forkchoiceUpdated(ctx, session, logger, state, attr, engine.PayloadV2, true, false) + }) } +// ForkchoiceUpdatedV3 must be only called with Ecotone attributes func (s *SyncTester) ForkchoiceUpdatedV3(ctx context.Context, state *eth.ForkchoiceState, attr *eth.PayloadAttributes) (*eth.ForkchoiceUpdatedResult, error) { - return nil, nil + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (*eth.ForkchoiceUpdatedResult, error) { + logger.Debug("ForkchoiceUpdatedV3", "state", state, "attr", attr) + return s.forkchoiceUpdated(ctx, session, logger, state, attr, engine.PayloadV3, true, true) + }) +} + +// forkchoiceUpdated processes a forkchoice state update from the consensus +// layer, validates the request against the current execution layer state, and +// optionally initializes a new payload build process if payload attributes are +// provided. When payload attributes are not nil and validation succeeds, the +// derived payload is stored for later retrieval via GetPayload. +// +// Return values: +// - {status: VALID, latestValidHash: headBlockHash, payloadId: id} when the +// forkchoice state is applied successfully and payload attributes were +// provided and validated. +// - {status: VALID, latestValidHash: headBlockHash, payloadId: null} when the +// forkchoice state is applied successfully but no payload build was started +// (attr was not provided). +// - {status: INVALID, latestValidHash: null, validationError: err} when payload +// attributes are malformed or finalized/safe blocks are not canonical. +// - {status: SYNCING} when the head block is unknown or not yet validated, or +// when block data cannot be retrieved from the execution layer. +func (s *SyncTester) forkchoiceUpdated(ctx context.Context, session *eth.SyncTesterSession, logger log.Logger, state *eth.ForkchoiceState, attr *eth.PayloadAttributes, payloadVersion engine.PayloadVersion, + isCanyon, isEcotone bool, +) (*eth.ForkchoiceUpdatedResult, error) { + // Validate attributes shape + if attr != nil { + if isEcotone { + // https://github.com/ethereum/execution-apis/blob/bc5a37ee69a64769bd8d0a2056672361ef5f3839/src/engine/cancun.md#engine_forkchoiceupdatedv3 + // Spec: payloadAttributes matches the PayloadAttributesV3 structure, return -38003: Invalid payload attributes on failure. + // Ecotone activated Cancun + if attr.ParentBeaconBlockRoot == nil { + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionInvalid}, PayloadID: nil}, engine.InvalidPayloadAttributes.With(errors.New("missing beacon root")) + } + if attr.Withdrawals == nil { + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionInvalid}, PayloadID: nil}, engine.InvalidPayloadAttributes.With(errors.New("missing withdrawals")) + } + } else if isCanyon { + if attr.ParentBeaconBlockRoot != nil { + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionInvalid}, PayloadID: nil}, engine.InvalidPayloadAttributes.With(errors.New("unexpected beacon root")) + } + // Canyon activated Shanghai + if attr.Withdrawals == nil { + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionInvalid}, PayloadID: nil}, engine.InvalidPayloadAttributes.With(errors.New("missing withdrawals")) + } + } else { + // Bedrock + if attr.Withdrawals != nil || attr.ParentBeaconBlockRoot != nil { + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionInvalid}, PayloadID: nil}, engine.InvalidParams.With(errors.New("withdrawals and beacon root not supported")) + } + } + } + // Simulate head block hash check + candLatest, err := s.elReader.GetBlockByHash(ctx, state.HeadBlockHash) + // https://github.com/ethereum/execution-apis/blob/584905270d8ad665718058060267061ecfd79ca5/src/engine/paris.md#specification-1 + // Spec: {payloadStatus: {status: SYNCING, latestValidHash: null, validationError: null}, payloadId: null} if forkchoiceState.headBlockHash references an unknown payload or a payload that can't be validated because requisite data for the validation is missing + if err != nil { + // Consider as sync error if read only EL interaction fails because we cannot validate + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionSyncing}, PayloadID: nil}, nil + } + if candLatest.NumberU64() > session.Validated { + // Let CL backfill via newPayload + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionSyncing}, PayloadID: nil}, nil + } + // Simulate db check for finalized head + var finalizedNum uint64 + if state.FinalizedBlockHash != (common.Hash{}) { + // https://github.com/ethereum/execution-apis/blob/584905270d8ad665718058060267061ecfd79ca5/src/engine/paris.md#specification-1 + // Spec: MUST return -38002: Invalid forkchoice state error if the payload referenced by forkchoiceState.headBlockHash is VALID and a payload referenced by either forkchoiceState.finalizedBlockHash or forkchoiceState.safeBlockHash does not belong to the chain defined by forkchoiceState.headBlockHash. + candFinalized, err := s.elReader.GetBlockByHash(ctx, state.FinalizedBlockHash) + if err != nil { + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionInvalid}, PayloadID: nil}, engine.InvalidForkChoiceState.With(errors.New("finalized block not available")) + } + finalizedNum = candFinalized.NumberU64() + if session.CurrentState.Latest < finalizedNum { + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionInvalid}, PayloadID: nil}, engine.InvalidForkChoiceState.With(errors.New("finalized block not canonical")) + } + } + // Simulate db check for safe head + var safeNum uint64 + if state.SafeBlockHash != (common.Hash{}) { + // https://github.com/ethereum/execution-apis/blob/584905270d8ad665718058060267061ecfd79ca5/src/engine/paris.md#specification-1 + // Spec: MUST return -38002: Invalid forkchoice state error if the payload referenced by forkchoiceState.headBlockHash is VALID and a payload referenced by either forkchoiceState.finalizedBlockHash or forkchoiceState.safeBlockHash does not belong to the chain defined by forkchoiceState.headBlockHash. + candSafe, err := s.elReader.GetBlockByHash(ctx, state.SafeBlockHash) + if err != nil { + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionInvalid}, PayloadID: nil}, engine.InvalidForkChoiceState.With(errors.New("safe block not available")) + } + safeNum = candSafe.NumberU64() + if session.CurrentState.Latest < safeNum { + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionInvalid}, PayloadID: nil}, engine.InvalidForkChoiceState.With(errors.New("safe block not canonical")) + } + } + var id *engine.PayloadID + if attr != nil { + // attr is the ingredient for the block built after the head block + candNum := int64(candLatest.NumberU64()) + // Query read only EL to fetch block which is desired to be produced from attr + newBlock, err := s.elReader.GetBlockByNumber(ctx, rpc.BlockNumber(candNum+1)) + if err != nil { + // Consider as sync error if read only EL interaction fails because we cannot validate + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionSyncing}, PayloadID: nil}, nil + } + // https://github.com/ethereum-optimism/specs/blob/972dec7c7c967800513c354b2f8e5b79340de1c3/specs/protocol/holocene/exec-engine.md#eip-1559-parameters-in-block-header + // Implicitly determine whether holocene is enabled by inspecting extraData from read only EL data + isHolocene := eip1559.ValidateHoloceneExtraData(newBlock.Header().Extra) == nil + // Sanity check attr comparing with newBlock + if err := s.validateAttributesForBlock(attr, newBlock, isHolocene); err != nil { + // https://github.com/ethereum/execution-apis/blob/584905270d8ad665718058060267061ecfd79ca5/src/engine/paris.md#specification-1 + // Client software MUST respond to this method call in the following way: {error: {code: -38003, message: "Invalid payload attributes"}} if the payload is deemed VALID and forkchoiceState has been applied successfully, but no build process has been started due to invalid payloadAttributes. + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionInvalid}, PayloadID: nil}, engine.InvalidPayloadAttributes.With(err) + } + // https://github.com/ethereum-optimism/specs/blob/7b39adb0bea3b0a56d6d3a7d61feef5c33e49b73/specs/protocol/isthmus/exec-engine.md#header-validity-rules + // Implicitly determine whether isthmus is enabled by inspecting withdrawalsRoot from read only EL data + isIsthmus := newBlock.WithdrawalsRoot() != nil && len(*newBlock.WithdrawalsRoot()) == 32 + // Initialize payload args for sane payload ID + // All attr fields already sanity checked + args := miner.BuildPayloadArgs{ + Parent: state.HeadBlockHash, + Timestamp: uint64(attr.Timestamp), + FeeRecipient: attr.SuggestedFeeRecipient, + Random: common.Hash(attr.PrevRandao), + BeaconRoot: attr.ParentBeaconBlockRoot, + NoTxPool: attr.NoTxPool, + Transactions: newBlock.Transactions(), + GasLimit: &newBlock.Header().GasLimit, + Version: payloadVersion, + } + config := ¶ms.ChainConfig{} + if isCanyon { + args.Withdrawals = *attr.Withdrawals + config.CanyonTime = new(uint64) + } + if isHolocene { + args.EIP1559Params = (*attr.EIP1559Params)[:] + } + if isIsthmus { + config.IsthmusTime = new(uint64) + } + payloadID := args.Id() + id = &payloadID + payloadEnv, err := eth.BlockAsPayloadEnv(newBlock, config) + if err != nil { + // The failure is from the EL processing so consider as a server error and make CL retry + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionInvalid}, PayloadID: nil}, engine.GenericServerError.With(err) + } + // Store payload and payloadID. This will be processed using GetPayload engine API + logger.Debug("Store payload", "payloadID", payloadID) + session.Payloads[payloadID] = payloadEnv + } + session.UpdateFCUState(candLatest.NumberU64(), safeNum, finalizedNum) + logger.Debug("Updated FCU State") + // https://github.com/ethereum/execution-apis/blob/584905270d8ad665718058060267061ecfd79ca5/src/engine/paris.md#specification-1 + // Spec: Client software MUST respond to this method call in the following way: {payloadStatus: {status: VALID, latestValidHash: forkchoiceState.headBlockHash, validationError: null}, payloadId: buildProcessId} if the payload is deemed VALID and the build process has begun + return ð.ForkchoiceUpdatedResult{PayloadStatus: eth.PayloadStatusV1{Status: eth.ExecutionValid, LatestValidHash: &state.HeadBlockHash}, PayloadID: id}, nil +} + +// validateAttributesForBlock verifies that a given block matches the expected +// execution payload attributes. It ensures consistency between the provided +// PayloadAttributes and the block header and body. +// +// OP Stack additions: +// - Transaction count and raw transaction bytes must match exactly. +// - NoTxPool must be always true, since sync tester only runs in verifier mode. +// - Gas limit must match. +// - If Holocene is active: Extra data must be exactly 9 bytes, the version byte must equal to 0, +// the remaining 8 bytes must match the EIP-1559 parameters. +// +// Returns an error if any mismatch or invalid condition is found, otherwise nil. +func (s *SyncTester) validateAttributesForBlock(attr *eth.PayloadAttributes, block *types.Block, isHolocene bool) error { + h := block.Header() + if h.Time != uint64(attr.Timestamp) { + return fmt.Errorf("timestamp mismatch: header=%d, attr=%d", h.Time, attr.Timestamp) + } + if h.MixDigest != common.Hash(attr.PrevRandao) { + return fmt.Errorf("prevRandao mismatch: header=%s, attr=%s", h.MixDigest, attr.PrevRandao) + } + if h.Coinbase != attr.SuggestedFeeRecipient { + return fmt.Errorf("coinbase mismatch: header=%s, attr=%s", h.Coinbase, attr.SuggestedFeeRecipient) + } + if attr.Withdrawals != nil && len(*attr.Withdrawals) != 0 { + return errors.New("withdrawals must be nil or empty") + } + if (attr.ParentBeaconBlockRoot == nil) != (h.ParentBeaconRoot == nil) { + return fmt.Errorf("parentBeaconBlockRoot mismatch: attr=%v, header=%v", attr.ParentBeaconBlockRoot, h.ParentBeaconRoot) + } + if h.ParentBeaconRoot != nil && (*attr.ParentBeaconBlockRoot).Cmp(*h.ParentBeaconRoot) != 0 { + return fmt.Errorf("parentBeaconBlockRoot mismatch: attr=%s, header=%s", *attr.ParentBeaconBlockRoot, *h.ParentBeaconRoot) + } + // OP Stack additions + if len(attr.Transactions) != len(block.Transactions()) { + return fmt.Errorf("tx count mismatch: attr=%d, block=%d", len(attr.Transactions), len(block.Transactions())) + } + for idx := range len(attr.Transactions) { + blockTx := block.Transactions()[idx] + blockTxRaw, err := blockTx.MarshalBinary() + if err != nil { + return fmt.Errorf("failed to marshal block tx: %w", err) + } + if !bytes.Equal([]byte(attr.Transactions[idx]), blockTxRaw) { + return fmt.Errorf("tx mismatch: tx=%s, idx=%d", attr.Transactions[idx], idx) + } + } + if !attr.NoTxPool { + // Sync Tester only supports verifier sync + return errors.New("txpool cannot be enabled yet") + } + if *attr.GasLimit != eth.Uint64Quantity(h.GasLimit) { + return fmt.Errorf("gaslimit mismatch: attr=%d, header=%d", *attr.GasLimit, h.GasLimit) + } + if isHolocene { + // https://github.com/ethereum-optimism/specs/blob/972dec7c7c967800513c354b2f8e5b79340de1c3/specs/protocol/holocene/exec-engine.md#encoding + // Spec: At and after Holocene activation, eip1559Parameters in PayloadAttributeV3 must be exactly 8 bytes with the following format + if attr.EIP1559Params == nil { + return errors.New("holocene enabled but EIP1559Params nil") + } + if err := eip1559.ValidateHolocene1559Params((*attr.EIP1559Params)[:]); err != nil { + return fmt.Errorf("invalid eip1559Params: %w", err) + } + denominator, elasticity := eip1559.DecodeHolocene1559Params((*attr.EIP1559Params)[:]) + if denominator == 0 && elasticity == 0 { + // https://github.com/ethereum-optimism/specs/blob/972dec7c7c967800513c354b2f8e5b79340de1c3/specs/protocol/holocene/exec-engine.md#payload-attributes-processing + // Spec: The denominator and elasticity values within this extraData must correspond to those in eip1559Parameters, unless both are 0. When both are 0, the prior EIP-1559 constants must be used to populate extraData instead. + // Cannot validate since EL will fall back to prior eip1559 constants + return nil + } + if !bytes.Equal(block.Extra()[1:], (*attr.EIP1559Params)[:]) { + return fmt.Errorf("eip1559Params mismatch: %s != 0x%s", *attr.EIP1559Params, hex.EncodeToString(block.Extra()[1:])) + } + } else { + // https://github.com/ethereum-optimism/specs/blob/972dec7c7c967800513c354b2f8e5b79340de1c3/specs/protocol/holocene/exec-engine.md#payload-attributes-processing + // Spec: Prior to Holocene activation, eip1559Parameters in PayloadAttributesV3 must be null and is otherwise considered invalid. + if attr.EIP1559Params != nil { + return fmt.Errorf("holocene disabled but EIP1559Params not nil. eip1559Params: %s", attr.EIP1559Params) + } + } + return nil } +// NewPayloadV1 must be only called with Bedrock Payload func (s *SyncTester) NewPayloadV1(ctx context.Context, payload *eth.ExecutionPayload) (*eth.PayloadStatusV1, error) { - return nil, nil + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (*eth.PayloadStatusV1, error) { + logger.Debug("NewPayloadV1", "payload", payload) + return s.newPayload(ctx, session, logger, payload, nil, nil, nil, false, false) + }) } +// NewPayloadV2 must be only called with Bedrock, Canyon, Delta Payload func (s *SyncTester) NewPayloadV2(ctx context.Context, payload *eth.ExecutionPayload) (*eth.PayloadStatusV1, error) { - return nil, nil + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (*eth.PayloadStatusV1, error) { + logger.Debug("NewPayloadV2", "payload", payload) + return s.newPayload(ctx, session, logger, payload, nil, nil, nil, false, false) + }) } +// NewPayloadV3 must be only called with Ecotone Payload func (s *SyncTester) NewPayloadV3(ctx context.Context, payload *eth.ExecutionPayload, versionedHashes []common.Hash, beaconRoot *common.Hash) (*eth.PayloadStatusV1, error) { - return nil, nil + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (*eth.PayloadStatusV1, error) { + logger.Debug("NewPayloadV3", "payload", payload, "versionedHashes", versionedHashes, "beaconRoot", beaconRoot) + return s.newPayload(ctx, session, logger, payload, versionedHashes, beaconRoot, nil, true, false) + }) } +// NewPayloadV4 must be only called with Isthmus payload func (s *SyncTester) NewPayloadV4(ctx context.Context, payload *eth.ExecutionPayload, versionedHashes []common.Hash, beaconRoot *common.Hash, executionRequests []hexutil.Bytes) (*eth.PayloadStatusV1, error) { - return nil, nil + return session.WithSession(s.sessMgr, ctx, s.log, func(session *eth.SyncTesterSession, logger log.Logger) (*eth.PayloadStatusV1, error) { + logger.Debug("NewPayloadV4", "payload", payload, "versionedHashes", versionedHashes, "beaconRoot", beaconRoot, "executionRequests", executionRequests) + return s.newPayload(ctx, session, logger, payload, versionedHashes, beaconRoot, executionRequests, true, true) + }) +} + +// newPayload validates and processes a new execution payload according to the +// Engine API rules to simulate consensus-layer to execution-layer interactions +// without advancing canonical chain state. +// +// The method enforces mandatory post-fork fields, including withdrawals, excessBlobGas, +// blobGasUsed, versionedHashes, beaconRoot, executionRequests, and withdrawalsRoot, +// returning an InvalidParams error if any are missing or improperly shaped. +// +// Return values: +// - {status: VALID, latestValidHash: payload.blockHash} if validation succeeds. +// - {status: INVALID, latestValidHash: null, validationError: err} on mismatch +// or malformed payloads. +// - {status: SYNCING} when the block cannot be executed because its parent is missing. +// - Errors surfaced as engine.InvalidParams or engine.GenericServerError to +// trigger appropriate consensus-layer retries. +func (s *SyncTester) newPayload(ctx context.Context, session *eth.SyncTesterSession, logger log.Logger, payload *eth.ExecutionPayload, versionedHashes []common.Hash, beaconRoot *common.Hash, executionRequests []hexutil.Bytes, + isEcotone, isIsthmus bool, +) (*eth.PayloadStatusV1, error) { + // Validate request shape, fork required fields + // https://github.com/ethereum/execution-apis/blob/584905270d8ad665718058060267061ecfd79ca5/src/engine/shanghai.md#engine_newpayloadv2 + // Spec: Client software MUST return -32602: Invalid params error if the wrong version of the structure is used in the method call. + if isEcotone { + if payload.ExcessBlobGas == nil { + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(errors.New("nil excessBlobGas post-cancun")) + } + if payload.BlobGasUsed == nil { + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(errors.New("nil blobGasUsed post-cancun")) + } + if versionedHashes == nil { + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(errors.New("nil versionedHashes post-cancun")) + } + if beaconRoot == nil { + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(errors.New("nil beaconRoot post-cancun")) + } + } else { + if payload.ExcessBlobGas != nil { + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(errors.New("non-nil excessBlobGas pre-cancun")) + } + if payload.BlobGasUsed != nil { + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(errors.New("non-nil blobGasUsed pre-cancun")) + } + } + if isIsthmus { + if executionRequests == nil { + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(errors.New("nil executionRequests post-prague")) + } + } + // OP Stack specific request shape validation + if isEcotone { + if payload.WithdrawalsRoot == nil { + // https://github.com/ethereum-optimism/specs/blob/a773587fca6756f8468164613daa79fcee7bbbe4/specs/protocol/exec-engine.md#engine_newpayloadv3 + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(errors.New("nil withdrawalsRoot post-isthmus")) + } + if len(versionedHashes) != 0 { + // https://github.com/ethereum-optimism/specs/blob/a773587fca6756f8468164613daa79fcee7bbbe4/specs/protocol/exec-engine.md#engine_newpayloadv3 + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(fmt.Errorf("versionedHashes length non-zero: %d", len(versionedHashes))) + } + } + if isIsthmus { + if len(executionRequests) != 0 { + // https://github.com/ethereum-optimism/specs/blob/a773587fca6756f8468164613daa79fcee7bbbe4/specs/protocol/exec-engine.md#engine_newpayloadv4 + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(fmt.Errorf("executionRequests must be empty array but got %d", len(executionRequests))) + } + } + // Look up canonical block for relay comparison + block, err := s.elReader.GetBlockByHash(ctx, payload.BlockHash) + if err != nil { + // Do not know block hash included in payload is correct or not. Consider as a server error and make CL retry + if errors.Is(err, ethereum.NotFound) { + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.GenericServerError.With(wrapSyncTesterError("block not found", err)) + } + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.GenericServerError.With(wrapSyncTesterError("failed to fetch block", err)) + } + // https://github.com/ethereum-optimism/specs/blob/972dec7c7c967800513c354b2f8e5b79340de1c3/specs/protocol/derivation.md#building-individual-payload-attributes + // Implicitly determine whether canyon is enabled by inspecting withdrawals from read only EL data + isCanyon := block.Withdrawals() != nil + if isCanyon { + if payload.Withdrawals == nil { + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(errors.New("nil withdrawals post-shanghai")) + } + } else { + if payload.Withdrawals != nil { + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.InvalidParams.With(errors.New("non-nil withdrawals pre-shanghai")) + } + } + + blockHash := block.Hash() + // We only attempt to advance non-canonical view of the chain, following the read only EL + if block.NumberU64() <= session.Validated+1 { + // Already have the block locally or advance single block without setting the head + // https://github.com/ethereum/execution-apis/blob/584905270d8ad665718058060267061ecfd79ca5/src/engine/shanghai.md#specification + // Spec: MUST return {status: INVALID, latestValidHash: null, validationError: errorMessage | null} if the blockHash validation has failed. + config := ¶ms.ChainConfig{} + if isCanyon { + config.CanyonTime = new(uint64) + } + if isIsthmus { + config.IsthmusTime = new(uint64) + } + correctPayload, err := eth.BlockAsPayload(block, config) + if err != nil { + // The failure is from the EL processing so consider as a server error and make CL retry + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid}, engine.GenericServerError.With(wrapSyncTesterError("failed to convert block to payload", err)) + } + // Sanity check parent beacon block root and block hash by recomputation + if !isIsthmus { + // Depopulate withdrawal root field for block hash recomputation + if payload.WithdrawalsRoot != nil { + logger.Warn("Isthmus disabled but withdrawal roots included in payload not nil", "root", payload.WithdrawalsRoot) + } + payload.WithdrawalsRoot = nil + } + // Check given payload matches the payload derived using the read only EL block + if err := correctPayload.CheckEqual(payload); err != nil { + // Consider as block hash validation error when payload mismatch + return s.newPayloadInvalid(fmt.Errorf("payload check mismatch: %w", err), nil), nil + } + execEnvelope := eth.ExecutionPayloadEnvelope{ParentBeaconBlockRoot: beaconRoot, ExecutionPayload: payload} + actual, ok := execEnvelope.CheckBlockHash() + if blockHash != payload.BlockHash || !ok { + return s.newPayloadInvalid(fmt.Errorf("block hash check from execution envelope failed. %s != %s", blockHash, actual), nil), nil + } + if block.NumberU64() == session.Validated+1 { + // Advance single block without setting the head, equivalent to geth InsertBlockWithoutSetHead + session.Validated += 1 + logger.Debug("Advanced non canonical chain", "validated", session.Validated) + } + // https://github.com/ethereum/execution-apis/blob/584905270d8ad665718058060267061ecfd79ca5/src/engine/paris.md#payload-validation + // Spec: If validation succeeds, the response MUST contain {status: VALID, latestValidHash: payload.blockHash} + return ð.PayloadStatusV1{Status: eth.ExecutionValid, LatestValidHash: &blockHash}, nil + } + // Block not available so mark as syncing + return ð.PayloadStatusV1{Status: eth.ExecutionSyncing}, nil +} + +func wrapSyncTesterError(msg string, err error) error { + if err == nil { + return fmt.Errorf("sync tester: %s", msg) + } + return fmt.Errorf("sync tester: %s: %w", msg, err) +} + +func (s *SyncTester) newPayloadInvalid(err error, latestValid *types.Header) *eth.PayloadStatusV1 { + var currentHash *common.Hash + if latestValid != nil { + if latestValid.Difficulty.BitLen() != 0 { + // Set latest valid hash to 0x0 if parent is PoW block + currentHash = &common.Hash{} + } else { + // Otherwise set latest valid hash to parent hash + h := latestValid.Hash() + currentHash = &h + } + } + errorMsg := err.Error() + return ð.PayloadStatusV1{Status: eth.ExecutionInvalid, LatestValidHash: currentHash, ValidationError: &errorMsg} } diff --git a/op-sync-tester/synctester/backend/sync_tester_test.go b/op-sync-tester/synctester/backend/sync_tester_test.go new file mode 100644 index 00000000000..4caafae7a8f --- /dev/null +++ b/op-sync-tester/synctester/backend/sync_tester_test.go @@ -0,0 +1,480 @@ +package backend + +import ( + "context" + "encoding/json" + "fmt" + "math/big" + "testing" + + "github.com/ethereum-optimism/optimism/op-service/eth" + "github.com/ethereum-optimism/optimism/op-service/testlog" + "github.com/ethereum-optimism/optimism/op-sync-tester/synctester/backend/session" + sttypes "github.com/ethereum-optimism/optimism/op-sync-tester/synctester/backend/types" + "github.com/ethereum/go-ethereum" + "github.com/ethereum/go-ethereum/common" + "github.com/ethereum/go-ethereum/common/hexutil" + "github.com/ethereum/go-ethereum/core/types" + "github.com/ethereum/go-ethereum/log" + "github.com/ethereum/go-ethereum/rpc" + "github.com/google/uuid" + "github.com/stretchr/testify/require" +) + +var _ ReadOnlyELBackend = (*MockELReader)(nil) + +type MockELReader struct { + ChainID hexutil.Big + + BlocksByHash map[common.Hash]*json.RawMessage + BlocksByNumber map[rpc.BlockNumber]*json.RawMessage + + ReceiptsByHash map[common.Hash][]*types.Receipt + ReceiptsByNumber map[rpc.BlockNumber][]*types.Receipt + + Latest *json.RawMessage + Safe *json.RawMessage + Finalized *json.RawMessage +} + +func NewMockELReader(chainID eth.ChainID) *MockELReader { + return &MockELReader{ + ChainID: hexutil.Big(*chainID.ToBig()), + BlocksByHash: make(map[common.Hash]*json.RawMessage), + BlocksByNumber: make(map[rpc.BlockNumber]*json.RawMessage), + ReceiptsByHash: make(map[common.Hash][]*types.Receipt), + ReceiptsByNumber: make(map[rpc.BlockNumber][]*types.Receipt), + } +} + +func (m *MockELReader) ChainId(ctx context.Context) (hexutil.Big, error) { + return m.ChainID, nil +} + +func (m *MockELReader) GetBlockByNumberJSON(ctx context.Context, number rpc.BlockNumber, fullTx bool) (json.RawMessage, error) { + raw, ok := m.BlocksByNumber[number] + if !ok { + return nil, ethereum.NotFound + } + return *raw, nil +} + +func (m *MockELReader) GetBlockByHashJSON(ctx context.Context, hash common.Hash, fullTx bool) (json.RawMessage, error) { + raw, ok := m.BlocksByHash[hash] + if !ok { + return nil, ethereum.NotFound + } + return *raw, nil +} + +func (m *MockELReader) GetBlockByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Block, error) { + return nil, nil +} + +func (m *MockELReader) GetBlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error) { + return nil, nil +} + +func (m *MockELReader) GetBlockReceipts(ctx context.Context, bnh rpc.BlockNumberOrHash) ([]*types.Receipt, error) { + hash, isHash := bnh.Hash() + if isHash { + receipts, ok := m.ReceiptsByHash[hash] + if !ok { + return nil, ethereum.NotFound + } + return receipts, nil + } + number, isNumber := bnh.Number() + if !isNumber { + // bnh is not a number and not a hash so return not found + return nil, ethereum.NotFound + } + receipts, ok := m.ReceiptsByNumber[number] + if !ok { + return nil, ethereum.NotFound + } + return receipts, nil +} + +func initTestSyncTester(t *testing.T, chainID eth.ChainID, elReader ReadOnlyELBackend) *SyncTester { + syncTester := NewSyncTester(testlog.Logger(t, log.LevelInfo), nil, sttypes.SyncTesterID("test"), chainID, elReader) + return syncTester +} + +func TestSyncTester_ChainId(t *testing.T) { + dummySession := ð.SyncTesterSession{SessionID: uuid.New().String()} + tests := []struct { + name string + cfgID eth.ChainID + elID eth.ChainID + session *eth.SyncTesterSession + wantErrContains string + }{ + { + name: "no session", + cfgID: eth.ChainIDFromUInt64(1), + elID: eth.ChainIDFromUInt64(1), + wantErrContains: "no session", + }, + { + name: "happy path", + cfgID: eth.ChainIDFromUInt64(11155111), + elID: eth.ChainIDFromUInt64(11155111), + session: dummySession, + }, + { + name: "mismatch", + cfgID: eth.ChainIDFromUInt64(1), + elID: eth.ChainIDFromUInt64(11155111), + session: dummySession, + wantErrContains: "chainID mismatch", + }, + } + + for _, tc := range tests { + t.Run(tc.name, func(t *testing.T) { + mock := NewMockELReader(tc.elID) + st := initTestSyncTester(t, tc.cfgID, mock) + ctx := context.Background() + if tc.session != nil { + ctx = session.WithSyncTesterSession(ctx, tc.session) + } + got, err := st.ChainId(ctx) + if tc.wantErrContains != "" { + require.Error(t, err) + require.Contains(t, err.Error(), tc.wantErrContains) + return + } + require.NoError(t, err) + require.Equal(t, hexutil.Big(*tc.cfgID.ToBig()), got) + }) + } +} + +func makeBlockRaw(num uint64) *json.RawMessage { + raw := json.RawMessage(fmt.Sprintf(`{"number":"0x%x"}`, num)) + return &raw +} + +func TestSyncTester_GetBlockByHash(t *testing.T) { + hash := common.HexToHash("0xdeadbeef") + tests := []struct { + name string + sessionLatest uint64 + rawNumber uint64 // block.number returned by EL + session *eth.SyncTesterSession + wantErrContains string + }{ + { + name: "no session", + sessionLatest: 0, + rawNumber: 0, + session: nil, + wantErrContains: "no session", + }, + { + name: "block number greater than latest", + sessionLatest: 100, + rawNumber: 101, // greater than Latest + session: ð.SyncTesterSession{SessionID: uuid.New().String(), CurrentState: eth.FCUState{Latest: 100}}, + wantErrContains: "not found", + }, + { + name: "happy path", + sessionLatest: 100, + rawNumber: 99, + session: ð.SyncTesterSession{SessionID: uuid.New().String(), CurrentState: eth.FCUState{Latest: 100}}, + }, + } + + for _, tc := range tests { + t.Run(tc.name, func(t *testing.T) { + el := NewMockELReader(eth.ChainIDFromUInt64(1)) + block := makeBlockRaw(tc.rawNumber) + el.BlocksByHash[hash] = block + st := initTestSyncTester(t, eth.ChainIDFromUInt64(1), el) + ctx := context.Background() + if tc.session != nil { + ctx = session.WithSyncTesterSession(ctx, tc.session) + } + raw, err := st.GetBlockByHash(ctx, hash, false) + if tc.wantErrContains != "" { + require.Error(t, err) + require.Contains(t, err.Error(), tc.wantErrContains) + return + } + require.NoError(t, err) + require.NotNil(t, raw) + + var header HeaderNumberOnly + require.NoError(t, json.Unmarshal(raw, &header)) + require.EqualValues(t, tc.rawNumber, header.Number.ToInt().Uint64()) + }) + } +} + +func TestSyncTester_GetBlockByNumber(t *testing.T) { + type testCase struct { + name string + session *eth.SyncTesterSession + inNumber rpc.BlockNumber + wantNum uint64 + wantErrContains string + } + + tests := []testCase{ + { + name: "no session", + session: nil, + wantErrContains: "no session", + }, + { + name: "happy path: numeric less than latest", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{ + Latest: 100, + Safe: 95, + Finalized: 90, + }, + }, + inNumber: rpc.BlockNumber(99), + wantNum: 99, + }, + { + name: "happy path: label latest returns latest", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{ + Latest: 100, + Safe: 95, + Finalized: 90, + }, + }, + inNumber: rpc.LatestBlockNumber, + wantNum: 100, + }, + { + name: "happy path: label safe returns safe", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{ + Latest: 100, + Safe: 97, + Finalized: 90, + }, + }, + inNumber: rpc.SafeBlockNumber, + wantNum: 97, + }, + { + name: "happy path: label finalized returns finalized", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{ + Latest: 100, + Safe: 97, + Finalized: 92, + }, + }, + inNumber: rpc.FinalizedBlockNumber, + wantNum: 92, + }, + { + name: "pending returns not found", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{Latest: 100, Safe: 97, Finalized: 92}, + }, + inNumber: rpc.PendingBlockNumber, + wantErrContains: "not found", + }, + { + name: "earliest label returns not found", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{Latest: 100, Safe: 97, Finalized: 92}, + }, + inNumber: rpc.EarliestBlockNumber, + wantErrContains: "not found", + }, + { + name: "numeric greater than latest returns not found", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{Latest: 100, Safe: 97, Finalized: 92}, + }, + inNumber: rpc.BlockNumber(101), + wantErrContains: "not found", + }, + } + + for _, tc := range tests { + t.Run(tc.name, func(t *testing.T) { + el := NewMockELReader(eth.ChainIDFromUInt64(1)) + if tc.session != nil { + el.BlocksByNumber[rpc.BlockNumber(tc.session.CurrentState.Latest)] = makeBlockRaw(tc.session.CurrentState.Latest) + el.BlocksByNumber[rpc.BlockNumber(tc.session.CurrentState.Safe)] = makeBlockRaw(tc.session.CurrentState.Safe) + el.BlocksByNumber[rpc.BlockNumber(tc.session.CurrentState.Finalized)] = makeBlockRaw(tc.session.CurrentState.Finalized) + } + el.BlocksByNumber[tc.inNumber] = makeBlockRaw(uint64(tc.inNumber.Int64())) + st := initTestSyncTester(t, eth.ChainIDFromUInt64(1), el) + ctx := context.Background() + if tc.session != nil { + ctx = session.WithSyncTesterSession(ctx, tc.session) + } + raw, err := st.GetBlockByNumber(ctx, tc.inNumber, false) + if tc.wantErrContains != "" { + require.Error(t, err) + require.Contains(t, err.Error(), tc.wantErrContains) + return + } + require.NoError(t, err) + require.NotNil(t, raw) + var header HeaderNumberOnly + require.NoError(t, json.Unmarshal(raw, &header)) + require.EqualValues(t, tc.wantNum, header.Number.ToInt().Uint64()) + }) + } +} + +func TestSyncTester_GetBlockReceipts(t *testing.T) { + makeReceipts := func(n uint64) []*types.Receipt { + r := new(types.Receipt) + r.BlockNumber = new(big.Int).SetUint64(n) + return []*types.Receipt{r} + } + type testCase struct { + name string + session *eth.SyncTesterSession + arg rpc.BlockNumberOrHash + seedFn func(el *MockELReader, s *eth.SyncTesterSession) + wantFirstBN uint64 + wantErrContains string + } + hashGood := common.HexToHash("0xabc1") + hashTooNew := common.HexToHash("0xabc2") + tests := []testCase{ + { + name: "no session", + session: nil, + arg: rpc.BlockNumberOrHashWithNumber(rpc.LatestBlockNumber), + wantErrContains: "no session", + }, + { + name: "happy: via hash, blockNumber less than latest", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{ + Latest: 100, + Safe: 95, + Finalized: 90, + }, + }, + arg: rpc.BlockNumberOrHashWithHash(hashGood, false), + seedFn: func(el *MockELReader, s *eth.SyncTesterSession) { + el.ReceiptsByHash[hashGood] = makeReceipts(s.CurrentState.Latest - 1) + }, + wantFirstBN: 99, + }, + { + name: "bad: via hash, blockNumber >= latest returns not found", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{ + Latest: 100, + Safe: 95, + Finalized: 90, + }, + }, + arg: rpc.BlockNumberOrHashWithHash(hashTooNew, false), + seedFn: func(el *MockELReader, s *eth.SyncTesterSession) { + // strictly greater than Latest so the post-check triggers NotFound + el.ReceiptsByHash[hashTooNew] = makeReceipts(s.CurrentState.Latest + 1) + }, + wantErrContains: "not found", + }, + { + name: "happy: label latest returns latest", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{Latest: 100, Safe: 95, Finalized: 90}, + }, + arg: rpc.BlockNumberOrHashWithNumber(rpc.LatestBlockNumber), + seedFn: func(el *MockELReader, s *eth.SyncTesterSession) { + el.ReceiptsByNumber[rpc.BlockNumber(s.CurrentState.Latest)] = makeReceipts(s.CurrentState.Latest) + }, + wantFirstBN: 100, + }, + { + name: "happy: label safe returns safe", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{Latest: 100, Safe: 97, Finalized: 90}, + }, + arg: rpc.BlockNumberOrHashWithNumber(rpc.SafeBlockNumber), + seedFn: func(el *MockELReader, s *eth.SyncTesterSession) { + el.ReceiptsByNumber[rpc.BlockNumber(s.CurrentState.Safe)] = makeReceipts(s.CurrentState.Safe) + }, + wantFirstBN: 97, + }, + { + name: "happy: label finalized returns finalized", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{Latest: 100, Safe: 97, Finalized: 92}, + }, + arg: rpc.BlockNumberOrHashWithNumber(rpc.FinalizedBlockNumber), + seedFn: func(el *MockELReader, s *eth.SyncTesterSession) { + el.ReceiptsByNumber[rpc.BlockNumber(s.CurrentState.Finalized)] = makeReceipts(s.CurrentState.Finalized) + }, + wantFirstBN: 92, + }, + { + name: "happy: numeric less than latest", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{Latest: 100, Safe: 97, Finalized: 92}, + }, + arg: rpc.BlockNumberOrHashWithNumber(rpc.BlockNumber(99)), + seedFn: func(el *MockELReader, _ *eth.SyncTesterSession) { + el.ReceiptsByNumber[rpc.BlockNumber(99)] = makeReceipts(99) + }, + wantFirstBN: 99, + }, + { + name: "bad: numeric greater than latest returns not found", + session: ð.SyncTesterSession{ + SessionID: uuid.New().String(), + CurrentState: eth.FCUState{Latest: 100, Safe: 97, Finalized: 92}, + }, + arg: rpc.BlockNumberOrHashWithNumber(rpc.BlockNumber(101)), + wantErrContains: "not found", + // No seeding needed: checkBlockNumber should fail before EL call + }, + } + + for _, tc := range tests { + t.Run(tc.name, func(t *testing.T) { + el := NewMockELReader(eth.ChainIDFromUInt64(1)) + if tc.seedFn != nil && tc.session != nil { + tc.seedFn(el, tc.session) + } + st := initTestSyncTester(t, eth.ChainIDFromUInt64(1), el) + ctx := context.Background() + if tc.session != nil { + ctx = session.WithSyncTesterSession(ctx, tc.session) + } + recs, err := st.GetBlockReceipts(ctx, tc.arg) + if tc.wantErrContains != "" { + require.Error(t, err) + require.Contains(t, err.Error(), tc.wantErrContains) + return + } + require.NoError(t, err) + require.NotNil(t, recs) + require.GreaterOrEqual(t, len(recs), 1) + require.EqualValues(t, tc.wantFirstBN, recs[0].BlockNumber.Uint64()) + }) + } +} diff --git a/op-sync-tester/synctester/frontend/engine.go b/op-sync-tester/synctester/frontend/engine.go index d34af81b0c2..eefdcd4a6b6 100644 --- a/op-sync-tester/synctester/frontend/engine.go +++ b/op-sync-tester/synctester/frontend/engine.go @@ -3,25 +3,14 @@ package frontend import ( "context" + "github.com/ethereum-optimism/optimism/op-service/apis" "github.com/ethereum-optimism/optimism/op-service/eth" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/common/hexutil" ) type EngineBackend interface { - GetPayloadV1(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayload, error) - GetPayloadV2(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) - GetPayloadV3(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) - GetPayloadV4(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) - - ForkchoiceUpdatedV1(ctx context.Context, state *eth.ForkchoiceState, attr *eth.PayloadAttributes) (*eth.ForkchoiceUpdatedResult, error) - ForkchoiceUpdatedV2(ctx context.Context, state *eth.ForkchoiceState, attr *eth.PayloadAttributes) (*eth.ForkchoiceUpdatedResult, error) - ForkchoiceUpdatedV3(ctx context.Context, state *eth.ForkchoiceState, attr *eth.PayloadAttributes) (*eth.ForkchoiceUpdatedResult, error) - - NewPayloadV1(ctx context.Context, payload *eth.ExecutionPayload) (*eth.PayloadStatusV1, error) - NewPayloadV2(ctx context.Context, payload *eth.ExecutionPayload) (*eth.PayloadStatusV1, error) - NewPayloadV3(ctx context.Context, payload *eth.ExecutionPayload, versionedHashes []common.Hash, beaconRoot *common.Hash) (*eth.PayloadStatusV1, error) - NewPayloadV4(ctx context.Context, payload *eth.ExecutionPayload, versionedHashes []common.Hash, beaconRoot *common.Hash, executionRequests []hexutil.Bytes) (*eth.PayloadStatusV1, error) + apis.EngineAPI } type EngineFrontend struct { @@ -32,7 +21,7 @@ func NewEngineFrontend(b EngineBackend) *EngineFrontend { return &EngineFrontend{b: b} } -func (e *EngineFrontend) GetPayloadV1(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayload, error) { +func (e *EngineFrontend) GetPayloadV1(ctx context.Context, payloadID eth.PayloadID) (*eth.ExecutionPayloadEnvelope, error) { return e.b.GetPayloadV1(ctx, payloadID) } diff --git a/op-sync-tester/synctester/frontend/eth.go b/op-sync-tester/synctester/frontend/eth.go index 5258bad9f0f..98a0001fbd8 100644 --- a/op-sync-tester/synctester/frontend/eth.go +++ b/op-sync-tester/synctester/frontend/eth.go @@ -2,21 +2,19 @@ package frontend import ( "context" - "math/big" + "encoding/json" + + "github.com/ethereum-optimism/optimism/op-service/apis" - "github.com/ethereum-optimism/optimism/op-service/eth" "github.com/ethereum/go-ethereum/common" + "github.com/ethereum/go-ethereum/common/hexutil" "github.com/ethereum/go-ethereum/core/types" "github.com/ethereum/go-ethereum/rpc" ) type EthBackend interface { - GetBlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) - GetBlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error) - GetBlockReceipts(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) ([]*types.Receipt, error) - ChainId(ctx context.Context) (eth.ChainID, error) + apis.EthAPI } - type EthFrontend struct { b EthBackend } @@ -25,18 +23,18 @@ func NewEthFrontend(b EthBackend) *EthFrontend { return &EthFrontend{b: b} } -func (e *EthFrontend) GetBlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) { - return e.b.GetBlockByNumber(ctx, number) +func (e *EthFrontend) GetBlockByNumber(ctx context.Context, number rpc.BlockNumber, fullTx bool) (json.RawMessage, error) { + return e.b.GetBlockByNumber(ctx, number, fullTx) } -func (e *EthFrontend) GetBlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error) { - return e.b.GetBlockByHash(ctx, hash) +func (e *EthFrontend) GetBlockByHash(ctx context.Context, hash common.Hash, fullTx bool) (json.RawMessage, error) { + return e.b.GetBlockByHash(ctx, hash, fullTx) } func (e *EthFrontend) GetBlockReceipts(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) ([]*types.Receipt, error) { return e.b.GetBlockReceipts(ctx, blockNrOrHash) } -func (e *EthFrontend) ChainId(ctx context.Context) (eth.ChainID, error) { +func (e *EthFrontend) ChainId(ctx context.Context) (hexutil.Big, error) { return e.b.ChainId(ctx) } diff --git a/op-sync-tester/synctester/frontend/sync.go b/op-sync-tester/synctester/frontend/sync.go index 6e780c42bd0..d0663aa8032 100644 --- a/op-sync-tester/synctester/frontend/sync.go +++ b/op-sync-tester/synctester/frontend/sync.go @@ -2,14 +2,14 @@ package frontend import ( "context" + + "github.com/ethereum-optimism/optimism/op-service/apis" + "github.com/ethereum-optimism/optimism/op-service/eth" ) type SyncBackend interface { - GetSession(ctx context.Context) error - DeleteSession(ctx context.Context) error - ListSessions(ctx context.Context) ([]string, error) + apis.SyncAPI } - type SyncFrontend struct { b SyncBackend } @@ -18,7 +18,7 @@ func NewSyncFrontend(b SyncBackend) *SyncFrontend { return &SyncFrontend{b: b} } -func (s *SyncFrontend) GetSession(ctx context.Context) error { +func (s *SyncFrontend) GetSession(ctx context.Context) (*eth.SyncTesterSession, error) { return s.b.GetSession(ctx) } diff --git a/op-sync-tester/synctester/middleware.go b/op-sync-tester/synctester/middleware.go index 314baf461a3..ca624c336fe 100644 --- a/op-sync-tester/synctester/middleware.go +++ b/op-sync-tester/synctester/middleware.go @@ -8,14 +8,24 @@ import ( "strings" "github.com/ethereum-optimism/optimism/op-service/eth" - "github.com/ethereum-optimism/optimism/op-sync-tester/synctester/backend" - "github.com/ethereum/go-ethereum/log" + "github.com/ethereum-optimism/optimism/op-sync-tester/synctester/backend/session" "github.com/google/uuid" ) var ErrInvalidSessionIDFormat = errors.New("invalid UUID") var ErrInvalidParams = errors.New("invalid param") +func IsValidSessionID(sessionID string) error { + u, err := uuid.Parse(sessionID) + if err != nil { + return fmt.Errorf("invalid session id format: %w", err) + } + if u.Version() == 4 { + return nil + } + return errors.New("session format must satisfy uuid4 format") +} + // parseSession inspects the incoming request to determine if it targets a session-specific route. // If the request path matches the pattern `/chain/{chain_id}/synctest/{uuid}`, it attempts to parse // the UUID and optional query parameters (`latest`, `safe`, `finalized`) used to initialize the session. @@ -30,18 +40,17 @@ var ErrInvalidParams = errors.New("invalid param") // /chain/{chain_id}/synctest/{session_uuid} // // Returns an error if the session UUID is invalid or any query parameter is malformed. -func parseSession(r *http.Request, log log.Logger) (*http.Request, error) { +func parseSession(r *http.Request) (*http.Request, error) { segments := strings.Split(strings.Trim(r.URL.Path, "/"), "/") if len(segments) == 4 && segments[0] == "chain" && segments[2] == "synctest" { sessionID := segments[3] - if _, err := uuid.Parse(sessionID); err != nil { - return r, ErrInvalidSessionIDFormat + if err := IsValidSessionID(sessionID); err != nil { + return r, errors.Join(ErrInvalidSessionIDFormat, err) } query := r.URL.Query() parseParam := func(name string) (uint64, error) { raw := query.Get(name) if raw == "" { - log.Warn("Parameter not provided. Defaulting to 0", "param", name) return 0, nil } val, err := strconv.ParseUint(raw, 10, 64) @@ -62,13 +71,8 @@ func parseSession(r *http.Request, log log.Logger) (*http.Request, error) { if err != nil { return r, err } - session := &backend.Session{ - SessionID: sessionID, - Latest: latest, - Safe: safe, - Finalized: finalized, - } - ctx := backend.WithSession(r.Context(), session) + sess := eth.NewSyncTesterSession(sessionID, latest, safe, finalized) + ctx := session.WithSyncTesterSession(r.Context(), sess) // remove uuid path for routing r.URL.Path = "/" + strings.Join(segments[:3], "/") r = r.WithContext(ctx) diff --git a/op-sync-tester/synctester/middleware_test.go b/op-sync-tester/synctester/middleware_test.go index f02330b676b..4da5fe7a907 100644 --- a/op-sync-tester/synctester/middleware_test.go +++ b/op-sync-tester/synctester/middleware_test.go @@ -6,8 +6,7 @@ import ( "testing" "github.com/ethereum-optimism/optimism/op-service/eth" - "github.com/ethereum-optimism/optimism/op-sync-tester/synctester/backend" - "github.com/ethereum/go-ethereum/log" + "github.com/ethereum-optimism/optimism/op-sync-tester/synctester/backend/session" "github.com/google/uuid" "github.com/stretchr/testify/require" ) @@ -29,17 +28,19 @@ func TestParseSession_Valid(t *testing.T) { query.Set(eth.Finalized, "80") req := newRequest("/chain/1/synctest/"+id, query) - newReq, err := parseSession(req, log.New()) + newReq, err := parseSession(req) require.NoError(t, err) require.NotNil(t, newReq) - session, ok := backend.SessionFromContext(newReq.Context()) + session, ok := session.SyncTesterSessionFromContext(newReq.Context()) require.True(t, ok) require.NotNil(t, session) require.Equal(t, id, session.SessionID) - require.Equal(t, uint64(100), session.Latest) - require.Equal(t, uint64(90), session.Safe) - require.Equal(t, uint64(80), session.Finalized) + require.Equal(t, uint64(100), session.InitialState.Latest) + require.Equal(t, uint64(90), session.InitialState.Safe) + require.Equal(t, uint64(80), session.InitialState.Finalized) + require.Equal(t, session.InitialState.Latest, session.Validated) + require.Equal(t, session.InitialState, session.CurrentState) require.Equal(t, "/chain/1/synctest", newReq.URL.Path) } @@ -47,33 +48,35 @@ func TestParseSession_DefaultsToZero(t *testing.T) { id := uuid.New().String() req := newRequest("/chain/1/synctest/"+id, nil) - newReq, err := parseSession(req, log.New()) + newReq, err := parseSession(req) require.NoError(t, err) require.NotNil(t, newReq) - session, ok := backend.SessionFromContext(newReq.Context()) + session, ok := session.SyncTesterSessionFromContext(newReq.Context()) require.True(t, ok) require.NotNil(t, session) require.Equal(t, id, session.SessionID) - require.Equal(t, uint64(0), session.Latest) - require.Equal(t, uint64(0), session.Safe) - require.Equal(t, uint64(0), session.Finalized) + require.Equal(t, uint64(0), session.InitialState.Latest) + require.Equal(t, uint64(0), session.InitialState.Safe) + require.Equal(t, uint64(0), session.InitialState.Finalized) + require.Equal(t, session.InitialState.Latest, session.Validated) + require.Equal(t, session.InitialState, session.CurrentState) } func TestParseSession_NoSessionInitialized(t *testing.T) { req := newRequest("/chain/1/synctest", nil) - newReq, err := parseSession(req, log.New()) + newReq, err := parseSession(req) require.NoError(t, err) require.Same(t, req, newReq) - _, ok := backend.SessionFromContext(newReq.Context()) + _, ok := session.SyncTesterSessionFromContext(newReq.Context()) require.False(t, ok) } func TestParseSession_InvalidSessionIDFormat(t *testing.T) { req := newRequest("/chain/1/synctest/not-a-uuid", nil) - _, err := parseSession(req, log.New()) + _, err := parseSession(req) require.ErrorIs(t, err, ErrInvalidSessionIDFormat) } @@ -83,6 +86,6 @@ func TestParseSession_InvalidQueryParam(t *testing.T) { query.Set(eth.Unsafe, "not-a-number") // invalid uint64 req := newRequest("/chain/1/synctest/"+id, query) - _, err := parseSession(req, log.New()) + _, err := parseSession(req) require.ErrorIs(t, err, ErrInvalidParams) } diff --git a/op-sync-tester/synctester/service.go b/op-sync-tester/synctester/service.go index 530f3d75456..c0758a99cf3 100644 --- a/op-sync-tester/synctester/service.go +++ b/op-sync-tester/synctester/service.go @@ -147,7 +147,7 @@ func (s *Service) initHTTPServer(cfg *config.Config) error { endpoint := net.JoinHostPort(cfg.RPC.ListenAddr, strconv.Itoa(cfg.RPC.ListenPort)) // middleware to initialize session handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - r, err := parseSession(r, s.log) + r, err := parseSession(r) if errors.Is(err, ErrInvalidSessionIDFormat) || errors.Is(err, ErrInvalidParams) { http.Error(w, err.Error(), http.StatusBadRequest) return @@ -213,9 +213,16 @@ func (s *Service) RPC() string { return s.httpServer.HTTPEndpoint() } -func (s *Service) SyncTesterEndpoint(chainID eth.ChainID) string { - uuid := uuid.New() - return fmt.Sprintf("%s/chain/%s/synctest/%s", s.RPC(), chainID, uuid) +func (s *Service) SyncTesterRPC(chainID eth.ChainID, withSessionID bool) string { + return s.RPC() + s.SyncTesterRPCPath(chainID, withSessionID) +} + +func (s *Service) SyncTesterRPCPath(chainID eth.ChainID, withSessionID bool) string { + path := fmt.Sprintf("/chain/%s/synctest", chainID) + if withSessionID { + path = fmt.Sprintf("%s/%s", path, uuid.New()) + } + return path } func (s *Service) SyncTesters() map[sttypes.SyncTesterID]eth.ChainID { diff --git a/op-up/.goreleaser.yaml b/op-up/.goreleaser.yaml index 5b78edd8732..c7cb05c73f8 100644 --- a/op-up/.goreleaser.yaml +++ b/op-up/.goreleaser.yaml @@ -25,6 +25,11 @@ builds: - goos: linux goarch: arm64 mod_timestamp: "{{ .CommitTimestamp }}" + ldflags: + - -X main.GitCommit={{ .FullCommit }} + - -X main.GitDate={{ .CommitDate }} + - -X main.Version={{ .Version }} + - -X main.VersionMeta= archives: - format: tar.gz diff --git a/op-up/install.sh b/op-up/install.sh index 10f50d2b724..8ff37ccf60d 100755 --- a/op-up/install.sh +++ b/op-up/install.sh @@ -7,7 +7,7 @@ # All configs are here. # If you modify the configs in any way, please also update the help text below. -OP_UP_VERSION="${OP_UP_VERSION:-0.1.0}" # The default version is hardcoded for now. +OP_UP_VERSION="${OP_UP_VERSION:-0.2.0}" # The default version is hardcoded for now. OP_UP_REPO="${OP_UP_REPO:-ethereum-optimism/optimism}" OP_UP_DIR="${OP_UP_DIR:-"${HOME}/.op-up"}" diff --git a/op-up/justfile b/op-up/justfile index ba9cac89d6d..af964d49357 100644 --- a/op-up/justfile +++ b/op-up/justfile @@ -1,17 +1,20 @@ -BINARY := "op-up" +import '../justfiles/go.just' -# Default target -default: build +_LDFLAGSSTRING := "'" + trim( + "-X main.Version=" + VERSION + " " + \ + "-X main.VersionMeta=" + VERSION_META + " " + \ + "-X main.GitCommit=" + GITCOMMIT + " " + \ + "-X main.GitDate=" + GITDATE + " " + \ + "") + "'" -# Build target -build: artifacts - mkdir -p bin - go build -o ./bin/{{ BINARY }} . +BINARY := "./bin/op-up" + +default: op-up + +op-up: (go_build BINARY "." "-ldflags" _LDFLAGSSTRING) -# Build dependency artifacts: just ../op-deployer/copy-contract-artifacts -# Clean target clean: rm -f {{ BINARY }} diff --git a/op-up/main.go b/op-up/main.go index 6bbce88b0df..1dd31fd5a06 100644 --- a/op-up/main.go +++ b/op-up/main.go @@ -11,6 +11,7 @@ import ( "os" "os/signal" "path/filepath" + "runtime/debug" "slices" "sync" "syscall" @@ -18,50 +19,89 @@ import ( "github.com/ethereum-optimism/optimism/op-chain-ops/devkeys" "github.com/ethereum-optimism/optimism/op-devstack/devtest" - "github.com/ethereum-optimism/optimism/op-devstack/presets" "github.com/ethereum-optimism/optimism/op-devstack/shim" "github.com/ethereum-optimism/optimism/op-devstack/stack" "github.com/ethereum-optimism/optimism/op-devstack/stack/match" "github.com/ethereum-optimism/optimism/op-devstack/sysgo" + opservice "github.com/ethereum-optimism/optimism/op-service" + "github.com/ethereum-optimism/optimism/op-service/cliapp" "github.com/ethereum-optimism/optimism/op-service/client" "github.com/ethereum-optimism/optimism/op-service/eth" + oplog "github.com/ethereum-optimism/optimism/op-service/log" "github.com/ethereum-optimism/optimism/op-service/log/logfilter" "github.com/ethereum-optimism/optimism/op-service/testreq" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/crypto" "github.com/ethereum/go-ethereum/log" + "github.com/urfave/cli/v2" "go.opentelemetry.io/otel/trace" ) +const asciiArt = ` ____ ____ _ ____ +/ _ \/ __\ / \ /\/ __\ +| / \|| \/|_____ | | ||| \/| +| \_/|| __/\____\| \_/|| __/ +\____/\_/ \____/\_/` + +var ( + Version = "v0.0.0" + VersionMeta = "dev" + GitCommit string + GitDate string + + envPrefix = "OP_UP" + dirFlag = &cli.PathFlag{ + Name: "dir", + Usage: "the path to the op-up directory, which is used for caching among other things.", + EnvVars: opservice.PrefixEnvVar(envPrefix, "DIR"), + Value: func() string { + parentDir, err := os.UserHomeDir() + if err != nil { + parentDir, err = os.Getwd() + if err != nil { + return "error: could not find home or working directories" + } + } + return filepath.Join(parentDir, ".op-up") + }(), + } +) + func main() { - if err := run(); err != nil { + ctx, cancel := signal.NotifyContext(context.Background(), syscall.SIGTERM, os.Interrupt) + defer cancel() + if err := run(ctx, os.Args, os.Stdout, os.Stderr); err != nil { fmt.Fprintf(os.Stderr, "error: %v\n", err) os.Exit(1) } } -func run() error { - // presets.DoMain calls op-service/flags.ReadTestConfig, which, as of this comment, parses the - // global flag set and printing the usage statement on `-help`. Since op-up does not respect - // any configuration right now, the usage statement will only confuse users and should not be - // printed. - // - // Lots of acceptance tests depend on the presets.DoMain behavior and are downstream of the - // current use (misuse?) of the global flag set. Rather than modifying that shared code, we - // settle for hacking around the problem by printing an error when any command line arguments - // are present. op-up should evolve beyond this pretty soon. - if numArgs := len(os.Args) - 1; numArgs > 0 { - return fmt.Errorf("expected no command line args, got %d", numArgs) - } - - opUpDir, ok := os.LookupEnv("OP_UP_DIR") - if !ok { - homeDir, err := os.UserHomeDir() - if err != nil { - return fmt.Errorf("get user home dir: %w", err) +func run(ctx context.Context, args []string, stdout, stderr io.Writer) error { + app := cli.NewApp() + app.Writer = stdout + app.ErrWriter = stderr + app.Version = opservice.FormatVersion(Version, GitCommit, GitDate, VersionMeta) + app.Name = "op-up" + app.Usage = "deploys an in-memory OP Stack devnet." + app.Flags = cliapp.ProtectFlags([]cli.Flag{dirFlag}) + // The default OnUsageError behavior will print the error twice: once in the cli package and + // once in our main function. + // The function below prints help and returns the error for further handling/error messages. + app.OnUsageError = func(cliCtx *cli.Context, err error, isSubcommand bool) error { + if !cliCtx.App.HideHelp { + _ = cli.ShowAppHelp(cliCtx) } - opUpDir = filepath.Join(homeDir, ".op-up") + return err + } + app.Action = func(cliCtx *cli.Context) error { + return runOpUp(cliCtx.Context, cliCtx.App.ErrWriter, cliCtx.String(dirFlag.Name)) } + return app.RunContext(ctx, args) +} + +func runOpUp(ctx context.Context, stderr io.Writer, opUpDir string) error { + fmt.Fprintf(stderr, "%s\n", asciiArt) + if err := os.MkdirAll(opUpDir, 0o755); err != nil { return fmt.Errorf("create the op-up dir: %w", err) } @@ -70,8 +110,13 @@ func run() error { return fmt.Errorf("create the deployer cache dir: %w", err) } + devtest.RootContext = ctx + + p := newP(ctx, stderr) + defer p.Close() + ids := sysgo.NewDefaultMinimalSystemIDs(sysgo.DefaultL1ID, sysgo.DefaultL2AID) - presets.DoMain(testingM{}, stack.MakeCommon(stack.Combine( + opts := stack.Combine( sysgo.WithMnemonicKeys(devkeys.TestMnemonic), sysgo.WithDeployer(), @@ -84,34 +129,46 @@ func run() error { sysgo.WithL1Nodes(ids.L1EL, ids.L1CL), - sysgo.WithL2ELNode(ids.L2EL, nil), - sysgo.WithL2CLNode(ids.L2CL, true, false, ids.L1CL, ids.L1EL, ids.L2EL), + sysgo.WithL2ELNode(ids.L2EL), + sysgo.WithL2CLNode(ids.L2CL, ids.L1CL, ids.L1EL, ids.L2EL, sysgo.L2CLSequencer()), sysgo.WithBatcher(ids.L2Batcher, ids.L1EL, ids.L2CL, ids.L2EL), sysgo.WithProposer(ids.L2Proposer, ids.L1EL, &ids.L2CL, nil), sysgo.WithFaucets([]stack.L1ELNodeID{ids.L1EL}, []stack.L2ELNodeID{ids.L2EL}), - )), presets.WithLogFilter(logfilter.DefaultMute())) + ) + orch := sysgo.NewOrchestrator(p, opts) + stack.ApplyOptionLifecycle[*sysgo.Orchestrator](opts, orch) + if err := runSysgo(ctx, stderr, orch); err != nil { + return err + } + fmt.Fprintf(stderr, "\nPlease consider filling out this survey to influence future development: https://www.surveymonkey.com/r/JTGHFK3\n") return nil } -type testingM struct{} - -var _ presets.TestingM = testingM{} - -func (t testingM) Run() int { - if err := runSysgo(); err != nil { - fmt.Fprintf(os.Stderr, "error: %v", err) - return 1 +func newP(ctx context.Context, stderr io.Writer) devtest.P { + logHandler := oplog.NewLogHandler(stderr, oplog.DefaultCLIConfig()) + logHandler = logfilter.WrapFilterHandler(logHandler) + logHandler.(logfilter.FilterHandler).Set(logfilter.DefaultMute()) + logHandler = logfilter.WrapContextHandler(logHandler) + logger := log.NewLogger(logHandler) + oplog.SetGlobalLogHandler(logHandler) + logger.SetContext(ctx) + onFail := func(now bool) { + logger.Error("Main failed") + debug.PrintStack() + if now { + panic("critical Main fail") + } } - return 0 + p := devtest.NewP(ctx, logger, onFail, func() { + onFail(true) + }) + return p } -func runSysgo() error { - ctx, cancel := signal.NotifyContext(context.Background(), syscall.SIGTERM, os.Interrupt) - defer cancel() - +func runSysgo(ctx context.Context, stderr io.Writer, orch *sysgo.Orchestrator) error { // Print available account. hd, err := devkeys.NewMnemonicDevKeys(devkeys.TestMnemonic) if err != nil { @@ -128,11 +185,10 @@ func runSysgo() error { return fmt.Errorf("secret: %w", err) } - fmt.Printf("Test Account Address: %s\n", funderAddress) - fmt.Printf("Test Account Private Key: %s\n", "0x"+common.Bytes2Hex(crypto.FromECDSA(funderPrivKey))) - fmt.Printf("EL Node URL: %s\n", "http://localhost:8545") + fmt.Fprintf(stderr, "Test Account Address: %s\n", funderAddress) + fmt.Fprintf(stderr, "Test Account Private Key: %s\n", "0x"+common.Bytes2Hex(crypto.FromECDSA(funderPrivKey))) + fmt.Fprintf(stderr, "EL Node URL: %s\n", "http://localhost:8545") - orch := presets.Orchestrator() t := &testingT{ ctx: ctx, cleanups: make([]func(), 0), @@ -161,7 +217,7 @@ func runSysgo() error { continue } if unsafe.Number != lastBlock { - fmt.Printf("New L2 block: number %d, hash %s\n", unsafe.Number, unsafe.Hash) + fmt.Fprintf(stderr, "New L2 block: number %d, hash %s\n", unsafe.Number, unsafe.Hash) lastBlock = unsafe.Number } } @@ -170,8 +226,8 @@ func runSysgo() error { // Proxy L2 EL requests. go func() { - if err := proxyEL(elNode.L2EthClient().RPC()); err != nil { - fmt.Fprintf(os.Stderr, "error: %v", err) + if err := proxyEL(stderr, elNode.L2EthClient().RPC()); err != nil { + fmt.Fprintf(stderr, "error: %v", err) } }() @@ -182,7 +238,7 @@ func runSysgo() error { // proxyEL is a hacky way to intercept EL json rpc requests for logging to get around log filtering // bugs. -func proxyEL(client client.RPC) error { +func proxyEL(stderr io.Writer, client client.RPC) error { // Set up the HTTP handler for all incoming requests. http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { // Ensure the request method is POST, as JSON RPC typically uses POST. @@ -242,7 +298,7 @@ func proxyEL(client client.RPC) error { ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second) // 30-second timeout defer cancel() // Ensure the context is cancelled to release resources - fmt.Println(method) + fmt.Fprintf(stderr, "%s\n", method) // Use the rpc.Client to make the actual call to the backend Ethereum node. // The `callParams...` syntax unpacks the slice into variadic arguments. @@ -258,7 +314,7 @@ func proxyEL(client client.RPC) error { "message": message, }, } - fmt.Printf("RPC error: %s\n", message) + fmt.Fprintf(stderr, "RPC error: %s\n", message) jsonResponse, _ := json.Marshal(rpcErr) // Marshaling error is unlikely here, so we ignore it. w.Header().Set("Content-Type", "application/json") // For JSON-RPC, errors are typically returned with an HTTP 200 OK status, diff --git a/op-up/main_test.go b/op-up/main_test.go new file mode 100644 index 00000000000..038550d9d31 --- /dev/null +++ b/op-up/main_test.go @@ -0,0 +1,48 @@ +package main + +import ( + "context" + "io" + "sync" + "testing" + "time" + + "github.com/ethereum-optimism/optimism/op-devstack/sysgo" + "github.com/ethereum/go-ethereum/ethclient" + "github.com/stretchr/testify/require" +) + +func TestRun(t *testing.T) { + var wg sync.WaitGroup + defer wg.Wait() + ctx, cancel := context.WithCancel(context.Background()) + defer cancel() + + errCh := make(chan error) + wg.Add(1) + go func() { + defer wg.Done() + defer close(errCh) + if err := run(ctx, []string{"op-up", "--dir", t.TempDir()}, io.Discard, io.Discard); err != nil { + errCh <- err + } + }() + + client, err := ethclient.DialContext(ctx, "http://localhost:8545") + require.NoError(t, err) + ticker := time.NewTicker(time.Millisecond * 250) + for { + select { + case e := <-errCh: + require.NoError(t, e) + case <-ticker.C: + chainID, err := client.ChainID(ctx) + if err != nil { + t.Logf("error while querying chain ID, will retry: %s", err) + continue + } + require.Equal(t, sysgo.DefaultL2AID.ToBig(), chainID) + return + } + } +} diff --git a/op-wheel/cheat/cheat.go b/op-wheel/cheat/cheat.go index 0f1ce16c88e..e81487a182d 100644 --- a/op-wheel/cheat/cheat.go +++ b/op-wheel/cheat/cheat.go @@ -21,7 +21,6 @@ import ( "github.com/ethereum/go-ethereum/core/rawdb" "github.com/ethereum/go-ethereum/core/state" "github.com/ethereum/go-ethereum/core/types" - "github.com/ethereum/go-ethereum/core/vm" "github.com/ethereum/go-ethereum/ethdb" "github.com/ethereum/go-ethereum/ethdb/leveldb" "github.com/ethereum/go-ethereum/params" @@ -48,7 +47,11 @@ func OpenGethRawDB(dataDirPath string, readOnly bool) (ethdb.Database, error) { if err != nil { return nil, fmt.Errorf("failed to open leveldb: %w", err) } - db, err := rawdb.NewDatabaseWithFreezer(kvs, filepath.Join(dataDirPath, "ancient"), "", readOnly) + db, err := rawdb.Open(kvs, rawdb.OpenOptions{ + Ancient: filepath.Join(dataDirPath, "ancient"), + MetricsNamespace: "", + ReadOnly: readOnly, + }) if err != nil { return nil, fmt.Errorf("failed to open db with freezer: %w", err) } @@ -61,8 +64,7 @@ func OpenGethDB(dataDirPath string, readOnly bool) (*Cheater, error) { if err != nil { return nil, err } - ch, err := core.NewBlockChain(db, nil, nil, nil, - beacon.New(ethash.NewFullFaker()), vm.Config{}, nil) + ch, err := core.NewBlockChain(db, nil, beacon.New(ethash.NewFullFaker()), nil) if err != nil { _ = db.Close() return nil, fmt.Errorf("failed to open blockchain around chain db: %w", err) diff --git a/ops/docker/op-stack-go/Dockerfile b/ops/docker/op-stack-go/Dockerfile index c077852bb17..723dd7e3159 100644 --- a/ops/docker/op-stack-go/Dockerfile +++ b/ops/docker/op-stack-go/Dockerfile @@ -194,12 +194,14 @@ RUN apt-get update && apt-get install -y --no-install-recommends musl openssl ca COPY --from=op-challenger-builder /app/op-challenger/bin/op-challenger /usr/local/bin/ # Copy in op-program and cannon COPY --from=op-program-builder /app/op-program/bin/op-program /usr/local/bin/ +ENV OP_CHALLENGER_ASTERISC_SERVER=/usr/local/bin/op-program ENV OP_CHALLENGER_CANNON_SERVER=/usr/local/bin/op-program COPY --from=cannon-builder /app/cannon/bin/cannon /usr/local/bin/ ENV OP_CHALLENGER_CANNON_BIN=/usr/local/bin/cannon # Copy in kona and asterisc COPY --from=kona /usr/local/bin/kona-host /usr/local/bin/ ENV OP_CHALLENGER_ASTERISC_KONA_SERVER=/usr/local/bin/kona-host +ENV OP_CHALLENGER_CANNON_KONA_SERVER=/usr/local/bin/kona-host COPY --from=asterisc /usr/local/bin/asterisc /usr/local/bin/ ENV OP_CHALLENGER_ASTERISC_BIN=/usr/local/bin/asterisc CMD ["op-challenger"] diff --git a/ops/scripts/latest-versions.sh b/ops/scripts/latest-versions.sh new file mode 100755 index 00000000000..341281dc936 --- /dev/null +++ b/ops/scripts/latest-versions.sh @@ -0,0 +1,140 @@ +#!/usr/bin/env bash +set -euo pipefail + +# latest-versions.sh - reads all remote tags from the origin repository, +# groups them by component, and then finds the latest version for each component. + +######################################################## +#### FUNCTIONS #### +######################################################## + +# find_latest_versions - finds both latest and stable versions in one pass +# +# Input: space-separated string of version numbers (e.g., "1.2.3 1.3.0-rc.1 1.2.4") +# Output: single line in format "latest_version|stable_version" +# where stable_version is empty if no stable (vX.Y.Z only) versions exist +# +# Latest: Uses custom precedence rules (non-suffix beats suffix with same base version) +# 1. Highest semantic version wins (e.g., 1.3.0 > 1.2.9) +# 2. For same base version, non-suffixed preferred over suffixed (e.g., 1.13.6 > 1.13.6-rc.3) +# 3. Higher base version beats lower, even if suffixed (e.g., 1.13.6-rc.1 > 1.13.5) +# 4. For same base version with multiple suffixes, higher lexicographical suffix wins (e.g., 1.5.3-rc.3 > 1.5.3-rc.1) +# Stable: Highest pure X.Y.Z format (no suffixes) +find_latest_versions() { + local versions="$1" + + # Convert space-separated string to array for iteration + read -ra version_array <<< "$versions" + + # Create sortable versions for both latest and stable + local sortable_versions=() + local stable_sortable_versions=() + + for ver in "${version_array[@]}"; do + # Extract base version (everything before first '-' suffix) + local base="${ver%%-*}" + + # Modifies the string (while preserving the original version via | separator) + # so lexicographical sort will work + if [[ "$ver" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then + # stable (non-suffixed) versions: base.1.0 (priority 1, higher than any suffix) + local sortable_ver="$base.1.0|$ver" + sortable_versions+=("$sortable_ver") + stable_sortable_versions+=("$sortable_ver") + else + # suffixed versions: base.0.suffix (priority 0, lower than stable version) + local suffix="${ver#*-}" + sortable_versions+=("$base.0.$suffix|$ver") + fi + done + + # Find highest latest version using lexicographical sort + local latest_sortable + latest_sortable=$(printf '%s\n' "${sortable_versions[@]}" | sort -V | tail -n1) + local latest="${latest_sortable##*|}" + + # Find highest stable version using lexicographical sort + local stable="" + if [[ ${#stable_sortable_versions[@]} -gt 0 ]]; then + local stable_sortable + stable_sortable=$(printf '%s\n' "${stable_sortable_versions[@]}" | sort -V | tail -n1) + stable="${stable_sortable##*|}" + fi + + # Output in format "latest_version|stable_version" + echo "$latest|$stable" +} + +# Helper function to print component JSON +# Output example: +# "component": { +# "stable": "v1.0.0" (empty string if no stable version), +# "latest": "v1.0.0" +# } +print_component_json() { + local component="$1" + local stable_ver="$2" + local latest_ver="$3" + local is_first="$4" + + [[ "$is_first" != "true" ]] && echo "," + + local stable_field='""' + [[ -n "$stable_ver" ]] && stable_field="\"v$stable_ver\"" + + printf ' "%s": {\n "stable": %s,\n "latest": "v%s"\n }' \ + "$component" "$stable_field" "$latest_ver" +} + +######################################################## +#### MAIN #### +######################################################## + +declare -A component_versions # hash map: component -> "space-separated versions" +declare -A latest_versions # hash map: component -> latest version +declare -A stable_versions # hash map: component -> stable version + +# Collect all remote tags once and group by component in `component_versions` +while IFS= read -r tag; do + # Skip empty lines + [[ -z "$tag" ]] && continue + + # Skip ^{} annotated tags completely + [[ "$tag" == *"^{}" ]] && continue + + # git ls-remote output format: " refs/tags/" + # Only process tags that match our refs/tags//v pattern + if [[ "$tag" =~ refs/tags/([a-zA-Z0-9_-]+)/v(.+)$ ]]; then + component="${BASH_REMATCH[1]}" + version="${BASH_REMATCH[2]}" + + # Append version to component's list (space-separated) + if [[ -n "${component_versions[$component]:-}" ]]; then + component_versions["$component"]+=" $version" + else + component_versions["$component"]="$version" + fi + fi +done < <(git ls-remote --tags origin) + +# Process each component once and store results in `latest_versions`, `stable_versions` +for component in "${!component_versions[@]}"; do + result=$(find_latest_versions "${component_versions[$component]}") + latest_versions["$component"]="${result%|*}" # Everything before pipe delimiter + stable_versions["$component"]="${result#*|}" # Everything after pipe delimiter +done + +# Sort components alphabetically for consistent output +mapfile -t sorted_components < <(printf '%s\n' "${!latest_versions[@]}" | sort) + +# Print results in JSON format +echo "{" +for i in "${!sorted_components[@]}"; do + component="${sorted_components[i]}" + print_component_json "$component" \ + "${stable_versions[$component]}" \ + "${latest_versions[$component]}" \ + "$([ "$i" -eq 0 ] && echo true || echo false)" +done +echo "" +echo "}" diff --git a/packages/contracts-bedrock/book/src/contributing/style-guide.md b/packages/contracts-bedrock/book/src/contributing/style-guide.md index 0bfa18df11e..a8686aa023f 100644 --- a/packages/contracts-bedrock/book/src/contributing/style-guide.md +++ b/packages/contracts-bedrock/book/src/contributing/style-guide.md @@ -29,9 +29,13 @@ -This document provides guidance on how we organize and write our smart contracts. For cases where -this document does not provide guidance, please refer to existing contracts for guidance, -with priority on the `L2OutputOracle` and `OptimismPortal`. +This document provides guidance on how we organize and write our smart contracts. + +Notes: +1. There are many cases where the code is not up to date with this guide, when in doubt, this guide + should take precedence. +2. For cases where this document does not provide guidance, please refer to existing contracts, + with priority on the `SystemConfig` and `OptimismPortal`. ## Standards and Conventions @@ -57,24 +61,90 @@ We also have the following custom tags: #### Errors -- Use `require` statements when making simple assertions. -- Use `revert(string)` if throwing an error where an assertion is not being made (no custom errors). - See [here](https://github.com/ethereum-optimism/optimism/blob/861ae315a6db698a8c0adb1f8eab8311fd96be4c/packages/contracts-bedrock/contracts/L2/OVM_ETH.sol#L31) - for an example of this in practice. -- Error strings MUST have the format `"{ContractName}: {message}"` where `message` is a lower case string. +- Prefer custom Solidity errors for all new errors. +- Name custom errors using `ContractName_ErrorDescription`. +- Use `revert ContractName_ErrorDescription()` to revert. +- Avoid `revert(string)` and string-typed error messages in new code. + +Example: + +```solidity +// ✅ Correct - Custom errors with contract-prefixed names +contract SystemConfig { + error SystemConfig_InvalidFeatureState(); + error SystemConfig_UnauthorizedCaller(address caller); + + address internal owner; + + function setFeature(bool _enabled) external { + if (msg.sender != owner) revert SystemConfig_UnauthorizedCaller(msg.sender); + if (!_enabled) revert SystemConfig_InvalidFeatureState(); + // ... + } +} + +// ❌ Incorrect - string-based reverts and contract-prefixed strings +function bad(uint256 _amount) external { + require(_amount > 0, "MyContract: amount must be > 0"); // Prefer custom error + revert("MyContract: unsupported"); // Avoid string reverts +} +``` #### Function Parameters - Function parameters should be prefixed with an underscore. +Example: + +```solidity +// ✅ Correct - parameters are prefixed with underscore +function setOwner(address _newOwner) external { + // ... +} + +// ❌ Incorrect - parameters without underscore prefix +function setOwner(address newOwner) external { + // ... +} +``` + #### Function Return Arguments - Arguments returned by functions should be suffixed with an underscore. +Example: + +```solidity +// ✅ Correct - return variable is suffixed with underscore +function balanceOf(address _account) public view returns (uint256 balance_) { + balance_ = balances[_account]; +} + +// ❌ Incorrect - return variable without underscore suffix +function balanceOf(address _account) public view returns (uint256 balance) { + balance = balances[_account]; +} +``` + #### Event Parameters +- Event parameters should be named using camelCase. - Event parameters should NOT be prefixed with an underscore. +Example: + +```solidity +// ✅ Correct - event params are not prefixed with underscore +event OwnerChanged(address previousOwner, address newOwner); + +// ❌ Incorrect - event params prefixed with underscore +event OwnerChanged(address _previousOwner, address _newOwner); + +// ❌ Incorrect - event params are not camelCase or are unnamed +event OwnerChanged(address, address NEW_OWNER); + +``` + #### Immutable variables Immutable variables: @@ -87,6 +157,30 @@ This approach clearly indicates to the developer that the value is immutable, wi the non-standard casing to the interface. It also ensures that we don’t need to break the ABIs if we switch between values being in storage and immutable. +Example: + +```solidity +contract ExampleWithImmutable { + // ❌ Incorrect - immutable is not SCREAMING_SNAKE_CASE + address internal immutable ownerAddress; + + // ❌ Incorrect - immutable is public + address public immutable ownerAddress; + + // ✅ Correct - immutable is internal and SCREAMING_SNAKE_CASE + address internal immutable OWNER_ADDRESS; + + constructor(address _owner) { + OWNER_ADDRESS = _owner; + } + + // ✅ Handwritten getter + function ownerAddress() public view returns (address) { + return OWNER_ADDRESS; + } +} +``` + #### Spacers We use spacer variables to account for old storage slots that are no longer being used. @@ -95,6 +189,21 @@ The name of a spacer variable MUST be in the format `spacer___` is the original size of the variable. Spacers MUST be `private`. +Example: + +```solidity +contract ExampleStorageV2 { + // ✅ Correct - spacer preserves old storage layout + bytes32 private spacer_5_0_32; + uint256 public value; +} + +// ❌ Incorrect - wrong visibility and/or naming +contract BadStorageLayout { + bytes32 internal spacer5; +} +``` + ### Proxy by Default All contracts should be assumed to live behind proxies (except in certain special circumstances). @@ -147,6 +256,41 @@ patch increment should be used. Where basic functionality is already supported by an existing contract in the OpenZeppelin library, we should default to using the Upgradeable version of that contract. +### Interface Inheritance + +In order to reduce build times, all external dependencies (ie. a contract that is being interacted with) +should be imported as interfaces. In order to facilitate this, implementation contracts must have an +associated interface in the `interfaces/` directory of the contracts package. Checks in CI +will ensure that the interface exists and is correct. These interfaces should include a +"pseudo-constructor" function (`function __constructor__()`) which ensures that the constructor's +encoding is exposed in the ABI. + +Contracts must not inherit from their own interfaces (e.g., `contract SomeContract is ISomeContract`). +Interfaces may or may not inherit from other interfaces to compose functionality. + +**Rationale:** + +- **Alignment Issues**: If a contracts inherits from a base contracts (like `Ownable`), it cannot inherit from the interface as well, as this prevents 1:1 alignment between the implementation and interface, since the interface cannot include the base contract functions (ie. `owner()`) without causing compiler errors. +- **Constructor Complications**: Interface inheritance can cause issues with pseudo-constructors. + +**Example:** + +```solidity +// ✅ Correct - contract inherits from base contracts, interface composes other interfaces +contract SomeContract is SomeBaseContract, ... { + // Implementation +} + +interface ISomeContract is ISomeBaseContract { + // Interface definition +} + +// ❌ Incorrect - contract inheriting from its own interface +contract SomeContract is ISomeContract, ... { + // This creates alignment and compilation issues +} +``` + ### Source Code The following guidelines should be followed for all contracts in the `src/` directory: diff --git a/packages/contracts-bedrock/book/src/introduction.md b/packages/contracts-bedrock/book/src/introduction.md index a6c0c841926..1f24911d06a 100644 --- a/packages/contracts-bedrock/book/src/introduction.md +++ b/packages/contracts-bedrock/book/src/introduction.md @@ -44,13 +44,4 @@ OP Stack smart contracts use contract interfaces in a relatively unique way. Ple OP Stack smart contracts are designed to utilize a single, consistent Solidity version. Please refer to the [Solidity upgrades][solidity-upgrades] guide to understand the process for updating to newer Solidity versions. -[solidity-upgrades]: ./policies/solidity-upgrades.md - -### Frozen Code - -From time to time we need to ensure that certain files remain frozen, as they may be under audit or a large PR is in the -works and we wish to avoid a large rebase. In order to enforce this, a hardcoded list of contracts is stored in -`./scripts/checks/check-frozen-files.sh`. Any change which affects the resulting init or source code of a contract which -is not allowed to be modified will prevent merging to the `develop` branch. - -In order to remove a file from the freeze it must be removed from the check file. \ No newline at end of file +[solidity-upgrades]: ./policies/solidity-upgrades.md \ No newline at end of file diff --git a/packages/contracts-bedrock/book/src/policies/code-freezes.md b/packages/contracts-bedrock/book/src/policies/code-freezes.md deleted file mode 100644 index bcabe8d672a..00000000000 --- a/packages/contracts-bedrock/book/src/policies/code-freezes.md +++ /dev/null @@ -1,22 +0,0 @@ -# Smart Contract Code Freeze Process - -The Smart Contract Freeze Process is used to protect specific files from accidental changes during sensitive periods. - -## Code Freeze - -Code freezes are implemented by comparison of the bytecode and source code hashes of the local file against the upstream files. - -To enable a code freeze, follow these steps: - -1. Create a PR. -2. The `semver-lock.json` file should already be up to date, but run anyway `just semver-lock` to be sure. -3. Comment out the path and filename of the file/s you want to freeze in check-frozen-files.sh. - -To disable a code freeze, comment out the path and filename of the file/s you want to unfreeze in check-frozen-files.sh. -1. Create a PR. -2. Uncomment the path and filename of all files in check-frozen-files.sh. - -## Exceptions - -To bypass the freeze you can apply the "M-exempt-frozen-files" label on affected PRs. This should be done upon agreement with the code owner. Expected uses of this exception are to fix issues found on audits or to add comments to frozen files. - diff --git a/packages/contracts-bedrock/deploy-config/hardhat.json b/packages/contracts-bedrock/deploy-config/hardhat.json index eee538f39b4..634c8314b4e 100644 --- a/packages/contracts-bedrock/deploy-config/hardhat.json +++ b/packages/contracts-bedrock/deploy-config/hardhat.json @@ -19,7 +19,7 @@ "gasPriceOracleBaseFeeScalar": 1368, "gasPriceOracleBlobBaseFeeScalar": 810949, "l2OutputOracleProposer": "0x70997970C51812dc3A010C7d01b50e0d17dc79C8", - "l2OutputOracleChallenger": "0x6925B8704Ff96DEe942623d6FB5e946EF5884b63", + "l2OutputOracleChallenger": "0x9BA6e03D8B90dE867373Db8cF1A58d2F7F006b3A", "l2GenesisBlockBaseFeePerGas": "0x3B9ACA00", "l2GenesisBlockGasLimit": "0x17D7840", "baseFeeVaultRecipient": "0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc", @@ -56,8 +56,8 @@ "faultGameWithdrawalDelay": 302400, "preimageOracleMinProposalSize": 126000, "preimageOracleChallengePeriod": 86400, - "proofMaturityDelaySeconds": 12, - "disputeGameFinalityDelaySeconds": 6, + "proofMaturityDelaySeconds": 604800, + "disputeGameFinalityDelaySeconds": 302400, "respectedGameType": 0, "useFaultProofs": false, "fundDevAccounts": true, diff --git a/packages/contracts-bedrock/foundry.toml b/packages/contracts-bedrock/foundry.toml index 48deeb6d843..6183fb17ad9 100644 --- a/packages/contracts-bedrock/foundry.toml +++ b/packages/contracts-bedrock/foundry.toml @@ -23,7 +23,9 @@ additional_compiler_profiles = [ ] compilation_restrictions = [ { paths = "src/dispute/FaultDisputeGame.sol", optimizer_runs = 5000 }, + { paths = "src/dispute/v2/FaultDisputeGameV2.sol", optimizer_runs = 5000 }, { paths = "src/dispute/PermissionedDisputeGame.sol", optimizer_runs = 5000 }, + { paths = "src/dispute/v2/PermissionedDisputeGameV2.sol", optimizer_runs = 5000 }, { paths = "src/L1/OPContractsManager.sol", optimizer_runs = 5000 }, { paths = "src/L1/OPContractsManagerStandardValidator.sol", optimizer_runs = 5000 }, { paths = "src/L1/OptimismPortal2.sol", optimizer_runs = 5000 } @@ -137,7 +139,9 @@ additional_compiler_profiles = [ ] compilation_restrictions = [ { paths = "src/dispute/FaultDisputeGame.sol", optimizer_runs = 0 }, + { paths = "src/dispute/v2/FaultDisputeGameV2.sol", optimizer_runs = 0 }, { paths = "src/dispute/PermissionedDisputeGame.sol", optimizer_runs = 0 }, + { paths = "src/dispute/v2/PermissionedDisputeGameV2.sol", optimizer_runs = 0 }, { paths = "src/L1/OPContractsManager.sol", optimizer_runs = 0 }, { paths = "src/L1/OPContractsManagerStandardValidator.sol", optimizer_runs = 0 }, { paths = "src/L1/OptimismPortal2.sol", optimizer_runs = 0 }, diff --git a/packages/contracts-bedrock/interfaces/L1/IL1CrossDomainMessenger.sol b/packages/contracts-bedrock/interfaces/L1/IL1CrossDomainMessenger.sol index 81d7bcd22ab..75d61233ae2 100644 --- a/packages/contracts-bedrock/interfaces/L1/IL1CrossDomainMessenger.sol +++ b/packages/contracts-bedrock/interfaces/L1/IL1CrossDomainMessenger.sol @@ -22,7 +22,6 @@ interface IL1CrossDomainMessenger is ICrossDomainMessenger, IProxyAdminOwnedBase function systemConfig() external view returns (ISystemConfig); function version() external view returns (string memory); function superchainConfig() external view returns (ISuperchainConfig); - function upgrade(ISystemConfig _systemConfig) external; function __constructor__() external; } diff --git a/packages/contracts-bedrock/interfaces/L1/IL1ERC721Bridge.sol b/packages/contracts-bedrock/interfaces/L1/IL1ERC721Bridge.sol index ab50cdb2442..a73a743dacd 100644 --- a/packages/contracts-bedrock/interfaces/L1/IL1ERC721Bridge.sol +++ b/packages/contracts-bedrock/interfaces/L1/IL1ERC721Bridge.sol @@ -11,7 +11,6 @@ interface IL1ERC721Bridge is IERC721Bridge, IProxyAdminOwnedBase { error ReinitializableBase_ZeroInitVersion(); function initVersion() external view returns (uint8); - function upgrade(ISystemConfig _systemConfig) external; function bridgeERC721( address _localToken, address _remoteToken, diff --git a/packages/contracts-bedrock/interfaces/L1/IL1StandardBridge.sol b/packages/contracts-bedrock/interfaces/L1/IL1StandardBridge.sol index 4ea5e42f1ed..0e22bb9b9c4 100644 --- a/packages/contracts-bedrock/interfaces/L1/IL1StandardBridge.sol +++ b/packages/contracts-bedrock/interfaces/L1/IL1StandardBridge.sol @@ -31,7 +31,6 @@ interface IL1StandardBridge is IStandardBridge, IProxyAdminOwnedBase { event ETHWithdrawalFinalized(address indexed from, address indexed to, uint256 amount, bytes extraData); function initVersion() external view returns (uint8); - function upgrade(ISystemConfig _systemConfig) external; function depositERC20( address _l1Token, address _l2Token, diff --git a/packages/contracts-bedrock/interfaces/L1/IOPContractsManager.sol b/packages/contracts-bedrock/interfaces/L1/IOPContractsManager.sol index 63273248e3f..adb75fe8c8d 100644 --- a/packages/contracts-bedrock/interfaces/L1/IOPContractsManager.sol +++ b/packages/contracts-bedrock/interfaces/L1/IOPContractsManager.sol @@ -26,14 +26,19 @@ import { IETHLockbox } from "interfaces/L1/IETHLockbox.sol"; import { IOPContractsManagerStandardValidator } from "interfaces/L1/IOPContractsManagerStandardValidator.sol"; interface IOPContractsManagerContractsContainer { + error OPContractsManagerContractsContainer_DevFeatureInProd(); + function __constructor__( IOPContractsManager.Blueprints memory _blueprints, - IOPContractsManager.Implementations memory _implementations + IOPContractsManager.Implementations memory _implementations, + bytes32 _devFeatureBitmap ) external; function blueprints() external view returns (IOPContractsManager.Blueprints memory); function implementations() external view returns (IOPContractsManager.Implementations memory); + function devFeatureBitmap() external view returns (bytes32); + function isDevFeatureEnabled(bytes32 _feature) external view returns (bool); } interface IOPContractsManagerGameTypeAdder { @@ -81,10 +86,16 @@ interface IOPContractsManagerDeployer { interface IOPContractsManagerUpgrader { event Upgraded(uint256 indexed l2ChainId, address indexed systemConfig, address indexed upgrader); + error OPContractsManagerUpgrader_SuperchainConfigNeedsUpgrade(uint256 index); + + error OPContractsManagerUpgrader_SuperchainConfigAlreadyUpToDate(); + function __constructor__(IOPContractsManagerContractsContainer _contractsContainer) external; function upgrade(IOPContractsManager.OpChainConfig[] memory _opChainConfigs) external; + function upgradeSuperchainConfig(ISuperchainConfig _superchainConfig, IProxyAdmin _superchainProxyAdmin) external; + function contractsContainer() external view returns (IOPContractsManagerContractsContainer); } @@ -195,6 +206,7 @@ interface IOPContractsManager { address protocolVersionsImpl; address l1ERC721BridgeImpl; address optimismPortalImpl; + address optimismPortalInteropImpl; address ethLockboxImpl; address systemConfigImpl; address optimismMintableERC20FactoryImpl; @@ -323,6 +335,11 @@ interface IOPContractsManager { /// @param _opChainConfigs The chains to upgrade function upgrade(OpChainConfig[] memory _opChainConfigs) external; + /// @notice Upgrades the SuperchainConfig contract. + /// @param _superchainConfig The SuperchainConfig contract to upgrade. + /// @param _superchainProxyAdmin The ProxyAdmin contract to use for the upgrade. + function upgradeSuperchainConfig(ISuperchainConfig _superchainConfig, IProxyAdmin _superchainProxyAdmin) external; + /// @notice addGameType deploys a new dispute game and links it to the DisputeGameFactory. The inputted _gameConfigs /// must be added in ascending GameType order. function addGameType(AddGameInput[] memory _gameConfigs) external returns (AddGameOutput[] memory); @@ -355,32 +372,17 @@ interface IOPContractsManager { function opcmStandardValidator() external view returns (IOPContractsManagerStandardValidator); + /// @notice Retrieves the development feature bitmap stored in this OPCM contract + /// @return The development feature bitmap. + function devFeatureBitmap() external view returns (bytes32); + + /// @notice Returns the status of a development feature. + /// @param _feature The feature to check. + /// @return True if the feature is enabled, false otherwise. + function isDevFeatureEnabled(bytes32 _feature) external view returns (bool); + /// @notice Returns the implementation contract addresses. function implementations() external view returns (Implementations memory); function upgradeController() external view returns (address); } - -/// @notice Minimal interface only used for calling `implementations()` method but without retrieving the ETHLockbox -/// on it, since the OPCM contracts already deployed on mainnet don't have it. -/// @dev Only used for testing. -interface IOPCMImplementationsWithoutLockbox { - /// @notice The implementation contracts for the OP Stack, without the newly added ETHLockbox. - struct Implementations { - address superchainConfigImpl; - address protocolVersionsImpl; - address l1ERC721BridgeImpl; - address optimismPortalImpl; - address systemConfigImpl; - address optimismMintableERC20FactoryImpl; - address l1CrossDomainMessengerImpl; - address l1StandardBridgeImpl; - address disputeGameFactoryImpl; - address anchorStateRegistryImpl; - address delayedWETHImpl; - address mipsImpl; - } - - /// @notice Returns the implementation contracts without the ETHLockbox. - function implementations() external view returns (Implementations memory); -} diff --git a/packages/contracts-bedrock/interfaces/L1/IOPContractsManager180.sol b/packages/contracts-bedrock/interfaces/L1/IOPContractsManager180.sol deleted file mode 100644 index 682d3431f49..00000000000 --- a/packages/contracts-bedrock/interfaces/L1/IOPContractsManager180.sol +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: MIT -pragma solidity ^0.8.0; - -/// @notice Interface for the OPCM v1.8.0 release contract. This is temporarily required for -/// upgrade 12 so that the deployment of the OPPrestateUpdater can read and reuse the existing -/// permissioned dispute game blueprints. -interface IOPContractsManager180 { - struct Blueprints { - address addressManager; - address proxy; - address proxyAdmin; - address l1ChugSplashProxy; - address resolvedDelegateProxy; - address anchorStateRegistry; - address permissionedDisputeGame1; - address permissionedDisputeGame2; - } - - function blueprints() external view returns (Blueprints memory); -} diff --git a/packages/contracts-bedrock/interfaces/L1/IOPContractsManager200.sol b/packages/contracts-bedrock/interfaces/L1/IOPContractsManager200.sol deleted file mode 100644 index 830ab69aeb3..00000000000 --- a/packages/contracts-bedrock/interfaces/L1/IOPContractsManager200.sol +++ /dev/null @@ -1,19 +0,0 @@ -// SPDX-License-Identifier: MIT -pragma solidity ^0.8.0; - -/// @notice Interface for the OPCM v2.0.0 release. -interface IOPContractsManager200 { - struct Blueprints { - address addressManager; - address proxy; - address proxyAdmin; - address l1ChugSplashProxy; - address resolvedDelegateProxy; - address permissionedDisputeGame1; - address permissionedDisputeGame2; - address permissionlessDisputeGame1; - address permissionlessDisputeGame2; - } - - function blueprints() external view returns (Blueprints memory); -} diff --git a/packages/contracts-bedrock/interfaces/L1/IOPContractsManagerStandardValidator.sol b/packages/contracts-bedrock/interfaces/L1/IOPContractsManagerStandardValidator.sol index fedf131fd0c..15cb768e44d 100644 --- a/packages/contracts-bedrock/interfaces/L1/IOPContractsManagerStandardValidator.sol +++ b/packages/contracts-bedrock/interfaces/L1/IOPContractsManagerStandardValidator.sol @@ -10,6 +10,7 @@ interface IOPContractsManagerStandardValidator { struct Implementations { address l1ERC721BridgeImpl; address optimismPortalImpl; + address optimismPortalInteropImpl; address ethLockboxImpl; address systemConfigImpl; address optimismMintableERC20FactoryImpl; @@ -35,32 +36,23 @@ interface IOPContractsManagerStandardValidator { function version() external view returns (string memory); function anchorStateRegistryImpl() external view returns (address); - function anchorStateRegistryVersion() external pure returns (string memory); function challenger() external view returns (address); function delayedWETHImpl() external view returns (address); - function delayedWETHVersion() external pure returns (string memory); + function devFeatureBitmap() external view returns (bytes32); function disputeGameFactoryImpl() external view returns (address); - function disputeGameFactoryVersion() external pure returns (string memory); function l1CrossDomainMessengerImpl() external view returns (address); - function l1CrossDomainMessengerVersion() external pure returns (string memory); function l1ERC721BridgeImpl() external view returns (address); - function l1ERC721BridgeVersion() external pure returns (string memory); function l1PAOMultisig() external view returns (address); function l1StandardBridgeImpl() external view returns (address); - function l1StandardBridgeVersion() external pure returns (string memory); function mipsImpl() external view returns (address); - function mipsVersion() external pure returns (string memory); function optimismMintableERC20FactoryImpl() external view returns (address); - function optimismMintableERC20FactoryVersion() external pure returns (string memory); function optimismPortalImpl() external view returns (address); - function optimismPortalVersion() external pure returns (string memory); + function optimismPortalInteropImpl() external view returns (address); function ethLockboxImpl() external view returns (address); - function ethLockboxVersion() external pure returns (string memory); function permissionedDisputeGameVersion() external pure returns (string memory); function preimageOracleVersion() external pure returns (string memory); function superchainConfig() external view returns (ISuperchainConfig); function systemConfigImpl() external view returns (address); - function systemConfigVersion() external pure returns (string memory); function withdrawalDelaySeconds() external view returns (uint256); function validateWithOverrides( @@ -78,7 +70,8 @@ interface IOPContractsManagerStandardValidator { ISuperchainConfig _superchainConfig, address _l1PAOMultisig, address _challenger, - uint256 _withdrawalDelaySeconds + uint256 _withdrawalDelaySeconds, + bytes32 _devFeatureBitmap ) external; } diff --git a/packages/contracts-bedrock/interfaces/L1/IOptimismPortal2.sol b/packages/contracts-bedrock/interfaces/L1/IOptimismPortal2.sol index eb73b2956cc..987450481d6 100644 --- a/packages/contracts-bedrock/interfaces/L1/IOptimismPortal2.sol +++ b/packages/contracts-bedrock/interfaces/L1/IOptimismPortal2.sol @@ -12,7 +12,6 @@ import { IProxyAdminOwnedBase } from "interfaces/L1/IProxyAdminOwnedBase.sol"; import { IETHLockbox } from "interfaces/L1/IETHLockbox.sol"; interface IOptimismPortal2 is IProxyAdminOwnedBase { - error OptimismPortal_Unauthorized(); error ContentLengthMismatch(); error EmptyItem(); error InvalidDataRemainder(); @@ -33,13 +32,7 @@ interface IOptimismPortal2 is IProxyAdminOwnedBase { error OptimismPortal_NoReentrancy(); error OptimismPortal_ProofNotOldEnough(); error OptimismPortal_Unproven(); - error OptimismPortal_InvalidOutputRootIndex(); - error OptimismPortal_InvalidSuperRootProof(); - error OptimismPortal_InvalidOutputRootChainId(); - error OptimismPortal_WrongProofMethod(); - error OptimismPortal_MigratingToSameRegistry(); - error Encoding_EmptySuperRoot(); - error Encoding_InvalidSuperRootVersion(); + error OptimismPortal_InvalidLockboxState(); error OutOfGas(); error UnexpectedList(); error UnexpectedString(); @@ -49,8 +42,6 @@ interface IOptimismPortal2 is IProxyAdminOwnedBase { event WithdrawalFinalized(bytes32 indexed withdrawalHash, bool success); event WithdrawalProven(bytes32 indexed withdrawalHash, address indexed from, address indexed to); event WithdrawalProvenExtension1(bytes32 indexed withdrawalHash, address indexed proofSubmitter); - event ETHMigrated(address indexed lockbox, uint256 ethBalance); - event PortalMigrated(IETHLockbox oldLockbox, IETHLockbox newLockbox, IAnchorStateRegistry oldAnchorStateRegistry, IAnchorStateRegistry newAnchorStateRegistry); receive() external payable; @@ -71,7 +62,6 @@ interface IOptimismPortal2 is IProxyAdminOwnedBase { function disputeGameFinalityDelaySeconds() external view returns (uint256); function donateETH() external payable; function superchainConfig() external view returns (ISuperchainConfig); - function migrateToSuperRoots(IETHLockbox _newLockbox, IAnchorStateRegistry _newAnchorStateRegistry) external; function finalizeWithdrawalTransaction(Types.WithdrawalTransaction memory _tx) external; function finalizeWithdrawalTransactionExternalProof( Types.WithdrawalTransaction memory _tx, @@ -82,8 +72,7 @@ interface IOptimismPortal2 is IProxyAdminOwnedBase { function guardian() external view returns (address); function initialize( ISystemConfig _systemConfig, - IAnchorStateRegistry _anchorStateRegistry, - IETHLockbox _ethLockbox + IAnchorStateRegistry _anchorStateRegistry ) external; function initVersion() external view returns (uint8); @@ -101,15 +90,6 @@ interface IOptimismPortal2 is IProxyAdminOwnedBase { bytes[] memory _withdrawalProof ) external; - function proveWithdrawalTransaction( - Types.WithdrawalTransaction memory _tx, - IDisputeGame _disputeGameProxy, - uint256 _outputRootIndex, - Types.SuperRootProof memory _superRootProof, - Types.OutputRootProof memory _outputRootProof, - bytes[] memory _withdrawalProof - ) - external; function provenWithdrawals( bytes32, address @@ -119,11 +99,8 @@ interface IOptimismPortal2 is IProxyAdminOwnedBase { returns (IDisputeGame disputeGameProxy, uint64 timestamp); function respectedGameType() external view returns (GameType); function respectedGameTypeUpdatedAt() external view returns (uint64); - function superRootsActive() external view returns (bool); function systemConfig() external view returns (ISystemConfig); - function upgrade(IAnchorStateRegistry _anchorStateRegistry, IETHLockbox _ethLockbox) external; function version() external pure returns (string memory); - function migrateLiquidity() external; function __constructor__(uint256 _proofMaturityDelaySeconds) external; } diff --git a/packages/contracts-bedrock/interfaces/L1/IOptimismPortalInterop.sol b/packages/contracts-bedrock/interfaces/L1/IOptimismPortalInterop.sol new file mode 100644 index 00000000000..6e37f366478 --- /dev/null +++ b/packages/contracts-bedrock/interfaces/L1/IOptimismPortalInterop.sol @@ -0,0 +1,128 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.0; + +import { Types } from "src/libraries/Types.sol"; +import { GameType } from "src/dispute/lib/LibUDT.sol"; +import { IDisputeGame } from "interfaces/dispute/IDisputeGame.sol"; +import { IDisputeGameFactory } from "interfaces/dispute/IDisputeGameFactory.sol"; +import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol"; +import { ISuperchainConfig } from "interfaces/L1/ISuperchainConfig.sol"; +import { IAnchorStateRegistry } from "interfaces/dispute/IAnchorStateRegistry.sol"; +import { IProxyAdminOwnedBase } from "interfaces/L1/IProxyAdminOwnedBase.sol"; +import { IETHLockbox } from "interfaces/L1/IETHLockbox.sol"; + +interface IOptimismPortalInterop is IProxyAdminOwnedBase { + error ContentLengthMismatch(); + error EmptyItem(); + error InvalidDataRemainder(); + error InvalidHeader(); + error ReinitializableBase_ZeroInitVersion(); + error OptimismPortal_AlreadyFinalized(); + error OptimismPortal_BadTarget(); + error OptimismPortal_CallPaused(); + error OptimismPortal_CalldataTooLarge(); + error OptimismPortal_GasEstimation(); + error OptimismPortal_GasLimitTooLow(); + error OptimismPortal_ImproperDisputeGame(); + error OptimismPortal_InvalidDisputeGame(); + error OptimismPortal_InvalidMerkleProof(); + error OptimismPortal_InvalidOutputRootProof(); + error OptimismPortal_InvalidProofTimestamp(); + error OptimismPortal_InvalidRootClaim(); + error OptimismPortal_NoReentrancy(); + error OptimismPortal_ProofNotOldEnough(); + error OptimismPortal_Unproven(); + error OptimismPortal_InvalidOutputRootIndex(); + error OptimismPortal_InvalidSuperRootProof(); + error OptimismPortal_InvalidOutputRootChainId(); + error OptimismPortal_WrongProofMethod(); + error OptimismPortal_MigratingToSameRegistry(); + error Encoding_EmptySuperRoot(); + error Encoding_InvalidSuperRootVersion(); + error OutOfGas(); + error UnexpectedList(); + error UnexpectedString(); + + event Initialized(uint8 version); + event TransactionDeposited(address indexed from, address indexed to, uint256 indexed version, bytes opaqueData); + event WithdrawalFinalized(bytes32 indexed withdrawalHash, bool success); + event WithdrawalProven(bytes32 indexed withdrawalHash, address indexed from, address indexed to); + event WithdrawalProvenExtension1(bytes32 indexed withdrawalHash, address indexed proofSubmitter); + event ETHMigrated(address indexed lockbox, uint256 ethBalance); + event PortalMigrated(IETHLockbox oldLockbox, IETHLockbox newLockbox, IAnchorStateRegistry oldAnchorStateRegistry, IAnchorStateRegistry newAnchorStateRegistry); + + receive() external payable; + + function anchorStateRegistry() external view returns (IAnchorStateRegistry); + function ethLockbox() external view returns (IETHLockbox); + function checkWithdrawal(bytes32 _withdrawalHash, address _proofSubmitter) external view; + function depositTransaction( + address _to, + uint256 _value, + uint64 _gasLimit, + bool _isCreation, + bytes memory _data + ) + external + payable; + function disputeGameBlacklist(IDisputeGame _disputeGame) external view returns (bool); + function disputeGameFactory() external view returns (IDisputeGameFactory); + function disputeGameFinalityDelaySeconds() external view returns (uint256); + function donateETH() external payable; + function superchainConfig() external view returns (ISuperchainConfig); + function migrateToSuperRoots(IETHLockbox _newLockbox, IAnchorStateRegistry _newAnchorStateRegistry) external; + function finalizeWithdrawalTransaction(Types.WithdrawalTransaction memory _tx) external; + function finalizeWithdrawalTransactionExternalProof( + Types.WithdrawalTransaction memory _tx, + address _proofSubmitter + ) + external; + function finalizedWithdrawals(bytes32) external view returns (bool); + function guardian() external view returns (address); + function initialize( + ISystemConfig _systemConfig, + IAnchorStateRegistry _anchorStateRegistry, + IETHLockbox _ethLockbox + ) + external; + function initVersion() external view returns (uint8); + function l2Sender() external view returns (address); + function minimumGasLimit(uint64 _byteCount) external pure returns (uint64); + function numProofSubmitters(bytes32 _withdrawalHash) external view returns (uint256); + function params() external view returns (uint128 prevBaseFee, uint64 prevBoughtGas, uint64 prevBlockNum); // nosemgrep + function paused() external view returns (bool); + function proofMaturityDelaySeconds() external view returns (uint256); + function proofSubmitters(bytes32, uint256) external view returns (address); + function proveWithdrawalTransaction( + Types.WithdrawalTransaction memory _tx, + uint256 _disputeGameIndex, + Types.OutputRootProof memory _outputRootProof, + bytes[] memory _withdrawalProof + ) + external; + function proveWithdrawalTransaction( + Types.WithdrawalTransaction memory _tx, + IDisputeGame _disputeGameProxy, + uint256 _outputRootIndex, + Types.SuperRootProof memory _superRootProof, + Types.OutputRootProof memory _outputRootProof, + bytes[] memory _withdrawalProof + ) + external; + function provenWithdrawals( + bytes32, + address + ) + external + view + returns (IDisputeGame disputeGameProxy, uint64 timestamp); + function respectedGameType() external view returns (GameType); + function respectedGameTypeUpdatedAt() external view returns (uint64); + function superRootsActive() external view returns (bool); + function systemConfig() external view returns (ISystemConfig); + function upgrade(IAnchorStateRegistry _anchorStateRegistry, IETHLockbox _ethLockbox) external; + function version() external pure returns (string memory); + function migrateLiquidity() external; + + function __constructor__(uint256 _proofMaturityDelaySeconds) external; +} diff --git a/packages/contracts-bedrock/interfaces/L1/ISuperchainConfig.sol b/packages/contracts-bedrock/interfaces/L1/ISuperchainConfig.sol index df63c688887..73973b52a0f 100644 --- a/packages/contracts-bedrock/interfaces/L1/ISuperchainConfig.sol +++ b/packages/contracts-bedrock/interfaces/L1/ISuperchainConfig.sol @@ -20,7 +20,6 @@ interface ISuperchainConfig is IProxyAdminOwnedBase { function guardian() external view returns (address); function initialize(address _guardian) external; - function upgrade() external; function pause(address _identifier) external; function unpause(address _identifier) external; function pausable(address _identifier) external view returns (bool); diff --git a/packages/contracts-bedrock/interfaces/L1/ISystemConfig.sol b/packages/contracts-bedrock/interfaces/L1/ISystemConfig.sol index ca2c3ebe144..4abb69a1c1a 100644 --- a/packages/contracts-bedrock/interfaces/L1/ISystemConfig.sol +++ b/packages/contracts-bedrock/interfaces/L1/ISystemConfig.sol @@ -12,7 +12,8 @@ interface ISystemConfig is IProxyAdminOwnedBase { GAS_LIMIT, UNSAFE_BLOCK_SIGNER, EIP_1559_PARAMS, - OPERATOR_FEE_PARAMS + OPERATOR_FEE_PARAMS, + MIN_BASE_FEE } struct Addresses { @@ -24,8 +25,10 @@ interface ISystemConfig is IProxyAdminOwnedBase { } error ReinitializableBase_ZeroInitVersion(); + error SystemConfig_InvalidFeatureState(); event ConfigUpdate(uint256 indexed version, UpdateType indexed updateType, bytes data); + event FeatureSet(bytes32 indexed feature, bool indexed enabled); event Initialized(uint8 version); event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); @@ -70,6 +73,7 @@ interface ISystemConfig is IProxyAdminOwnedBase { function minimumGasLimit() external view returns (uint64); function operatorFeeConstant() external view returns (uint64); function operatorFeeScalar() external view returns (uint32); + function minBaseFee() external view returns (uint64); function optimismMintableERC20Factory() external view returns (address addr_); function optimismPortal() external view returns (address addr_); function overhead() external view returns (uint256); @@ -84,14 +88,16 @@ interface ISystemConfig is IProxyAdminOwnedBase { function setOperatorFeeScalars(uint32 _operatorFeeScalar, uint64 _operatorFeeConstant) external; function setUnsafeBlockSigner(address _unsafeBlockSigner) external; function setEIP1559Params(uint32 _denominator, uint32 _elasticity) external; + function setMinBaseFee(uint64 _minBaseFee) external; function startBlock() external view returns (uint256 startBlock_); function transferOwnership(address newOwner) external; // nosemgrep function unsafeBlockSigner() external view returns (address addr_); - function upgrade(uint256 _l2ChainId, ISuperchainConfig _superchainConfig) external; function version() external pure returns (string memory); function paused() external view returns (bool); function superchainConfig() external view returns (ISuperchainConfig); function guardian() external view returns (address); + function setFeature(bytes32 _feature, bool _enabled) external; + function isFeatureEnabled(bytes32) external view returns (bool); function __constructor__() external; } diff --git a/packages/contracts-bedrock/interfaces/dispute/IDelayedWETH.sol b/packages/contracts-bedrock/interfaces/dispute/IDelayedWETH.sol index 4b8d9750934..05b448e55df 100644 --- a/packages/contracts-bedrock/interfaces/dispute/IDelayedWETH.sol +++ b/packages/contracts-bedrock/interfaces/dispute/IDelayedWETH.sol @@ -3,15 +3,9 @@ pragma solidity ^0.8.0; import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol"; import { ISuperchainConfig } from "interfaces/L1/ISuperchainConfig.sol"; -import { IProxyAdmin } from "interfaces/universal/IProxyAdmin.sol"; - -interface IDelayedWETH { - error ProxyAdminOwnedBase_NotSharedProxyAdminOwner(); - error ProxyAdminOwnedBase_NotProxyAdminOwner(); - error ProxyAdminOwnedBase_NotProxyAdmin(); - error ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner(); - error ProxyAdminOwnedBase_ProxyAdminNotFound(); - error ProxyAdminOwnedBase_NotResolvedDelegateProxy(); +import { IProxyAdminOwnedBase } from "interfaces/L1/IProxyAdminOwnedBase.sol"; + +interface IDelayedWETH is IProxyAdminOwnedBase { error ReinitializableBase_ZeroInitVersion(); struct WithdrawalRequest { @@ -35,8 +29,6 @@ interface IDelayedWETH { function withdraw(address _guy, uint256 _wad) external; function withdrawals(address, address) external view returns (uint256 amount, uint256 timestamp); function version() external view returns (string memory); - function proxyAdmin() external view returns (IProxyAdmin); - function proxyAdminOwner() external view returns (address); function withdraw(uint256 _wad) external; event Approval(address indexed src, address indexed guy, uint256 wad); diff --git a/packages/contracts-bedrock/interfaces/dispute/IDisputeGameFactory.sol b/packages/contracts-bedrock/interfaces/dispute/IDisputeGameFactory.sol index f0d94c6581c..da99c869a97 100644 --- a/packages/contracts-bedrock/interfaces/dispute/IDisputeGameFactory.sol +++ b/packages/contracts-bedrock/interfaces/dispute/IDisputeGameFactory.sol @@ -21,6 +21,7 @@ interface IDisputeGameFactory is IProxyAdminOwnedBase, IReinitializableBase { event DisputeGameCreated(address indexed disputeProxy, GameType indexed gameType, Claim indexed rootClaim); event ImplementationSet(address indexed impl, GameType indexed gameType); + event ImplementationArgsSet(GameType indexed gameType, bytes args); event InitBondUpdated(GameType indexed gameType, uint256 indexed newBond); event Initialized(uint8 version); event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); @@ -46,6 +47,7 @@ interface IDisputeGameFactory is IProxyAdminOwnedBase, IReinitializableBase { view returns (GameType gameType_, Timestamp timestamp_, IDisputeGame proxy_); function gameCount() external view returns (uint256 gameCount_); + function gameArgs(GameType) external view returns (bytes memory); function gameImpls(GameType) external view returns (IDisputeGame); function games( GameType _gameType, @@ -68,6 +70,7 @@ interface IDisputeGameFactory is IProxyAdminOwnedBase, IReinitializableBase { function owner() external view returns (address); function renounceOwnership() external; function setImplementation(GameType _gameType, IDisputeGame _impl) external; + function setImplementation(GameType _gameType, IDisputeGame _impl, bytes calldata _args) external; function setInitBond(GameType _gameType, uint256 _initBond) external; function transferOwnership(address newOwner) external; // nosemgrep function version() external view returns (string memory); diff --git a/packages/contracts-bedrock/interfaces/dispute/IFaultDisputeGame.sol b/packages/contracts-bedrock/interfaces/dispute/IFaultDisputeGame.sol index 80b41bc958b..86ace4d5270 100644 --- a/packages/contracts-bedrock/interfaces/dispute/IFaultDisputeGame.sol +++ b/packages/contracts-bedrock/interfaces/dispute/IFaultDisputeGame.sol @@ -41,6 +41,7 @@ interface IFaultDisputeGame is IDisputeGame { error AlreadyInitialized(); error AnchorRootNotFound(); + error BadExtraData(); error BlockNumberMatches(); error BondTransferFailed(); error CannotDefendRootClaim(); diff --git a/packages/contracts-bedrock/interfaces/dispute/IPermissionedDisputeGame.sol b/packages/contracts-bedrock/interfaces/dispute/IPermissionedDisputeGame.sol index aa174ddaa1d..788c65790c0 100644 --- a/packages/contracts-bedrock/interfaces/dispute/IPermissionedDisputeGame.sol +++ b/packages/contracts-bedrock/interfaces/dispute/IPermissionedDisputeGame.sol @@ -30,6 +30,7 @@ interface IPermissionedDisputeGame is IDisputeGame { error AlreadyInitialized(); error AnchorRootNotFound(); + error BadExtraData(); error BlockNumberMatches(); error BondTransferFailed(); error CannotDefendRootClaim(); diff --git a/packages/contracts-bedrock/interfaces/dispute/ISuperFaultDisputeGame.sol b/packages/contracts-bedrock/interfaces/dispute/ISuperFaultDisputeGame.sol index 390f09e537a..276551af7a7 100644 --- a/packages/contracts-bedrock/interfaces/dispute/ISuperFaultDisputeGame.sol +++ b/packages/contracts-bedrock/interfaces/dispute/ISuperFaultDisputeGame.sol @@ -40,6 +40,7 @@ interface ISuperFaultDisputeGame is IDisputeGame { error AlreadyInitialized(); error AnchorRootNotFound(); + error BadExtraData(); error BondTransferFailed(); error CannotDefendRootClaim(); error ClaimAboveSplit(); diff --git a/packages/contracts-bedrock/interfaces/dispute/ISuperPermissionedDisputeGame.sol b/packages/contracts-bedrock/interfaces/dispute/ISuperPermissionedDisputeGame.sol index 2a2fed00363..7e2b5e73aa4 100644 --- a/packages/contracts-bedrock/interfaces/dispute/ISuperPermissionedDisputeGame.sol +++ b/packages/contracts-bedrock/interfaces/dispute/ISuperPermissionedDisputeGame.sol @@ -41,6 +41,7 @@ interface ISuperPermissionedDisputeGame is IDisputeGame { error AlreadyInitialized(); error AnchorRootNotFound(); + error BadExtraData(); error BondTransferFailed(); error CannotDefendRootClaim(); error ClaimAboveSplit(); diff --git a/packages/contracts-bedrock/interfaces/dispute/v2/IFaultDisputeGameV2.sol b/packages/contracts-bedrock/interfaces/dispute/v2/IFaultDisputeGameV2.sol new file mode 100644 index 00000000000..91553eddb8d --- /dev/null +++ b/packages/contracts-bedrock/interfaces/dispute/v2/IFaultDisputeGameV2.sol @@ -0,0 +1,137 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.0; + +import { IDisputeGame } from "interfaces/dispute/IDisputeGame.sol"; +import { IDelayedWETH } from "interfaces/dispute/IDelayedWETH.sol"; +import { IAnchorStateRegistry } from "interfaces/dispute/IAnchorStateRegistry.sol"; +import { IBigStepper } from "interfaces/dispute/IBigStepper.sol"; +import { Types } from "src/libraries/Types.sol"; +import { GameType, Claim, Position, Clock, Hash, Duration, BondDistributionMode } from "src/dispute/lib/Types.sol"; + +interface IFaultDisputeGameV2 is IDisputeGame { + struct ClaimData { + uint32 parentIndex; + address counteredBy; + address claimant; + uint128 bond; + Claim claim; + Position position; + Clock clock; + } + + struct ResolutionCheckpoint { + bool initialCheckpointComplete; + uint32 subgameIndex; + Position leftmostPosition; + address counteredBy; + } + + struct GameConstructorParams { + GameType gameType; + uint256 maxGameDepth; + uint256 splitDepth; + Duration clockExtension; + Duration maxClockDuration; + } + + error AlreadyInitialized(); + error AnchorRootNotFound(); + error BadExtraData(); + error BlockNumberMatches(); + error BondTransferFailed(); + error CannotDefendRootClaim(); + error ClaimAboveSplit(); + error ClaimAlreadyExists(); + error ClaimAlreadyResolved(); + error ClockNotExpired(); + error ClockTimeExceeded(); + error ContentLengthMismatch(); + error DuplicateStep(); + error EmptyItem(); + error GameDepthExceeded(); + error GameNotInProgress(); + error IncorrectBondAmount(); + error InvalidChallengePeriod(); + error InvalidClockExtension(); + error InvalidDataRemainder(); + error InvalidDisputedClaimIndex(); + error InvalidHeader(); + error InvalidHeaderRLP(); + error InvalidLocalIdent(); + error InvalidOutputRootProof(); + error InvalidParent(); + error InvalidPrestate(); + error InvalidSplitDepth(); + error L2BlockNumberChallenged(); + error MaxDepthTooLarge(); + error NoCreditToClaim(); + error OutOfOrderResolution(); + error UnexpectedList(); + error UnexpectedRootClaim(Claim rootClaim); + error UnexpectedString(); + error ValidStep(); + error InvalidBondDistributionMode(); + error GameNotFinalized(); + error GameNotResolved(); + error ReservedGameType(); + error GamePaused(); + event Move(uint256 indexed parentIndex, Claim indexed claim, address indexed claimant); + event GameClosed(BondDistributionMode bondDistributionMode); + + function absolutePrestate() external view returns (Claim absolutePrestate_); + function addLocalData(uint256 _ident, uint256 _execLeafIdx, uint256 _partOffset) external; + function anchorStateRegistry() external view returns (IAnchorStateRegistry registry_); + function attack(Claim _disputed, uint256 _parentIndex, Claim _claim) external payable; + function bondDistributionMode() external view returns (BondDistributionMode); + function challengeRootL2Block(Types.OutputRootProof memory _outputRootProof, bytes memory _headerRLP) external; + function claimCredit(address _recipient) external; + function claimData(uint256) + external + view // nosemgrep + returns ( + uint32 parentIndex, + address counteredBy, + address claimant, + uint128 bond, + Claim claim, + Position position, + Clock clock + ); + function claimDataLen() external view returns (uint256 len_); + function claims(Hash) external view returns (bool); + function clockExtension() external view returns (Duration clockExtension_); + function closeGame() external; + function credit(address _recipient) external view returns (uint256 credit_); + function defend(Claim _disputed, uint256 _parentIndex, Claim _claim) external payable; + function getChallengerDuration(uint256 _claimIndex) external view returns (Duration duration_); + function getNumToResolve(uint256 _claimIndex) external view returns (uint256 numRemainingChildren_); + function getRequiredBond(Position _position) external view returns (uint256 requiredBond_); + function hasUnlockedCredit(address) external view returns (bool); + function l2BlockNumber() external pure returns (uint256 l2BlockNumber_); + function l2BlockNumberChallenged() external view returns (bool); + function l2BlockNumberChallenger() external view returns (address); + function l2ChainId() external view returns (uint256 l2ChainId_); + function maxClockDuration() external view returns (Duration maxClockDuration_); + function maxGameDepth() external view returns (uint256 maxGameDepth_); + function move(Claim _disputed, uint256 _challengeIndex, Claim _claim, bool _isAttack) external payable; + function normalModeCredit(address) external view returns (uint256); + function refundModeCredit(address) external view returns (uint256); + function resolutionCheckpoints(uint256) + external + view + returns (bool initialCheckpointComplete, uint32 subgameIndex, Position leftmostPosition, address counteredBy); // nosemgrep + function resolveClaim(uint256 _claimIndex, uint256 _numToResolve) external; + function resolvedSubgames(uint256) external view returns (bool); + function splitDepth() external view returns (uint256 splitDepth_); + function startingBlockNumber() external view returns (uint256 startingBlockNumber_); + function startingOutputRoot() external view returns (Hash root, uint256 l2SequenceNumber); // nosemgrep + function startingRootHash() external view returns (Hash startingRootHash_); + function step(uint256 _claimIndex, bool _isAttack, bytes memory _stateData, bytes memory _proof) external; + function subgames(uint256, uint256) external view returns (uint256); + function version() external pure returns (string memory); + function vm() external view returns (IBigStepper vm_); + function wasRespectedGameTypeWhenCreated() external view returns (bool); + function weth() external view returns (IDelayedWETH weth_); + + function __constructor__(GameConstructorParams memory _params) external; +} diff --git a/packages/contracts-bedrock/interfaces/dispute/v2/IPermissionedDisputeGameV2.sol b/packages/contracts-bedrock/interfaces/dispute/v2/IPermissionedDisputeGameV2.sol new file mode 100644 index 00000000000..1f8cb3b9919 --- /dev/null +++ b/packages/contracts-bedrock/interfaces/dispute/v2/IPermissionedDisputeGameV2.sol @@ -0,0 +1,142 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.0; + +import { Types } from "src/libraries/Types.sol"; +import { Claim, Position, Clock, Hash, Duration, BondDistributionMode } from "src/dispute/lib/Types.sol"; + +import { IAnchorStateRegistry } from "interfaces/dispute/IAnchorStateRegistry.sol"; +import { IDelayedWETH } from "interfaces/dispute/IDelayedWETH.sol"; +import { IBigStepper } from "interfaces/dispute/IBigStepper.sol"; +import { IDisputeGame } from "interfaces/dispute/IDisputeGame.sol"; +import { IFaultDisputeGameV2 } from "interfaces/dispute/v2/IFaultDisputeGameV2.sol"; + +interface IPermissionedDisputeGameV2 is IDisputeGame { + struct ClaimData { + uint32 parentIndex; + address counteredBy; + address claimant; + uint128 bond; + Claim claim; + Position position; + Clock clock; + } + + struct ResolutionCheckpoint { + bool initialCheckpointComplete; + uint32 subgameIndex; + Position leftmostPosition; + address counteredBy; + } + + error AlreadyInitialized(); + error AnchorRootNotFound(); + error BadExtraData(); + error BlockNumberMatches(); + error BondTransferFailed(); + error CannotDefendRootClaim(); + error ClaimAboveSplit(); + error ClaimAlreadyExists(); + error ClaimAlreadyResolved(); + error ClockNotExpired(); + error ClockTimeExceeded(); + error ContentLengthMismatch(); + error DuplicateStep(); + error EmptyItem(); + error GameDepthExceeded(); + error GameNotInProgress(); + error IncorrectBondAmount(); + error InvalidChallengePeriod(); + error InvalidClockExtension(); + error InvalidDataRemainder(); + error InvalidDisputedClaimIndex(); + error InvalidHeader(); + error InvalidHeaderRLP(); + error InvalidLocalIdent(); + error InvalidOutputRootProof(); + error InvalidParent(); + error InvalidPrestate(); + error InvalidSplitDepth(); + error L2BlockNumberChallenged(); + error MaxDepthTooLarge(); + error NoCreditToClaim(); + error OutOfOrderResolution(); + error UnexpectedList(); + error UnexpectedRootClaim(Claim rootClaim); + error UnexpectedString(); + error ValidStep(); + error InvalidBondDistributionMode(); + error GameNotFinalized(); + error GameNotResolved(); + error ReservedGameType(); + error GamePaused(); + event Move(uint256 indexed parentIndex, Claim indexed claim, address indexed claimant); + event GameClosed(BondDistributionMode bondDistributionMode); + + function absolutePrestate() external view returns (Claim absolutePrestate_); + function addLocalData(uint256 _ident, uint256 _execLeafIdx, uint256 _partOffset) external; + function anchorStateRegistry() external view returns (IAnchorStateRegistry registry_); + function attack(Claim _disputed, uint256 _parentIndex, Claim _claim) external payable; + function bondDistributionMode() external view returns (BondDistributionMode); + function challengeRootL2Block(Types.OutputRootProof memory _outputRootProof, bytes memory _headerRLP) external; + function claimCredit(address _recipient) external; + function claimData(uint256) + external + view // nosemgrep + returns ( + uint32 parentIndex, + address counteredBy, + address claimant, + uint128 bond, + Claim claim, + Position position, + Clock clock + ); + function claimDataLen() external view returns (uint256 len_); + function claims(Hash) external view returns (bool); + function clockExtension() external view returns (Duration clockExtension_); + function closeGame() external; + function credit(address _recipient) external view returns (uint256 credit_); + function defend(Claim _disputed, uint256 _parentIndex, Claim _claim) external payable; + function getChallengerDuration(uint256 _claimIndex) external view returns (Duration duration_); + function getNumToResolve(uint256 _claimIndex) external view returns (uint256 numRemainingChildren_); + function getRequiredBond(Position _position) external view returns (uint256 requiredBond_); + function hasUnlockedCredit(address) external view returns (bool); + function initialize() external payable; + function l2BlockNumber() external pure returns (uint256 l2BlockNumber_); + function l2BlockNumberChallenged() external view returns (bool); + function l2BlockNumberChallenger() external view returns (address); + function l2ChainId() external view returns (uint256 l2ChainId_); + function maxClockDuration() external view returns (Duration maxClockDuration_); + function maxGameDepth() external view returns (uint256 maxGameDepth_); + function move(Claim _disputed, uint256 _challengeIndex, Claim _claim, bool _isAttack) external payable; + function normalModeCredit(address) external view returns (uint256); + function refundModeCredit(address) external view returns (uint256); + function resolutionCheckpoints(uint256) + external + view + returns (bool initialCheckpointComplete, uint32 subgameIndex, Position leftmostPosition, address counteredBy); // nosemgrep + function resolveClaim(uint256 _claimIndex, uint256 _numToResolve) external; + function resolvedSubgames(uint256) external view returns (bool); + function splitDepth() external view returns (uint256 splitDepth_); + function startingBlockNumber() external view returns (uint256 startingBlockNumber_); + function startingOutputRoot() external view returns (Hash root, uint256 l2SequenceNumber); // nosemgrep + function startingRootHash() external view returns (Hash startingRootHash_); + function step(uint256 _claimIndex, bool _isAttack, bytes memory _stateData, bytes memory _proof) external; + function subgames(uint256, uint256) external view returns (uint256); + function version() external pure returns (string memory); + function vm() external view returns (IBigStepper vm_); + function wasRespectedGameTypeWhenCreated() external view returns (bool); + function weth() external view returns (IDelayedWETH weth_); + + error BadAuth(); + + function proposer() external view returns (address proposer_); + function challenger() external view returns (address challenger_); + + function __constructor__( + IFaultDisputeGameV2.GameConstructorParams memory _params, + address _proposer, + address _challenger + ) + external; +} diff --git a/packages/contracts-bedrock/justfile b/packages/contracts-bedrock/justfile index 09ed00739d1..a06fa27b8b9 100644 --- a/packages/contracts-bedrock/justfile +++ b/packages/contracts-bedrock/justfile @@ -62,8 +62,8 @@ test-dev *ARGS: build-go-ffi # Default block number for the forked upgrade path. -export sepoliaBlockNumber := "7701807" -export mainnetBlockNumber := "21983965" +export sepoliaBlockNumber := "9118951" +export mainnetBlockNumber := "23327678" export pinnedBlockNumber := if env_var_or_default("FORK_BASE_CHAIN", "") == "mainnet" { mainnetBlockNumber @@ -88,6 +88,8 @@ prepare-upgrade-env *ARGS : build-go-ffi export FORK_BLOCK_NUMBER=$pinnedBlockNumber echo "Running upgrade tests at block $FORK_BLOCK_NUMBER" export FORK_RPC_URL=$ETH_RPC_URL + export FORK_RETRIES=10 + export FORK_BACKOFF=1000 export FORK_TEST=true export USE_MT_CANNON=true {{ARGS}} \ @@ -298,10 +300,6 @@ semgrep: semgrep-test: cd ../../ && semgrep scan --test --config .semgrep/rules/ .semgrep/tests/ -# Checks that the frozen code has not been modified. -check-frozen-code: - ./scripts/checks/check-frozen-files.sh - # Runs all checks. check: @just semgrep-test-validity-check \ diff --git a/packages/contracts-bedrock/scripts/checks/check-frozen-files.sh b/packages/contracts-bedrock/scripts/checks/check-frozen-files.sh deleted file mode 100755 index 7391b448690..00000000000 --- a/packages/contracts-bedrock/scripts/checks/check-frozen-files.sh +++ /dev/null @@ -1,134 +0,0 @@ -#!/usr/bin/env bash -set -euo pipefail - -# Grab the directory of the contracts-bedrock package. -SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) - -# Load semver-utils. -# shellcheck source=/dev/null -source "$SCRIPT_DIR/utils/semver-utils.sh" - -# Path to semver-lock.json. -SEMVER_LOCK="snapshots/semver-lock.json" - -# Create a temporary directory. -temp_dir=$(mktemp -d) -trap 'rm -rf "$temp_dir"' EXIT - -# Exit early if semver-lock.json has not changed. -if ! { git diff origin/develop...HEAD --name-only; git diff --name-only; git diff --cached --name-only; } | grep -q "$SEMVER_LOCK"; then - echo "No changes detected in semver-lock.json" - exit 0 -fi - -# Get the upstream semver-lock.json. -if ! git show origin/develop:packages/contracts-bedrock/snapshots/semver-lock.json > "$temp_dir/upstream_semver_lock.json" 2>/dev/null; then - echo "❌ Error: Could not find semver-lock.json in the snapshots/ directory of develop branch" - exit 1 -fi - -# Copy the local semver-lock.json. -cp "$SEMVER_LOCK" "$temp_dir/local_semver_lock.json" - -# Get the changed contracts. -changed_contracts=$(jq -r ' - def changes: - to_entries as $local - | input as $upstream - | $local | map( - select( - .key as $key - | .value != $upstream[$key] - ) - ) | map(.key); - changes[] -' "$temp_dir/local_semver_lock.json" "$temp_dir/upstream_semver_lock.json") - -# List of files that are allowed to be modified. -# In order to prevent a file from being modified, comment it out. Do not delete it. -# All files in semver-lock.json should be in this list. -ALLOWED_FILES=( - "src/L1/OPContractsManagerStandardValidator.sol:OPContractsManagerStandardValidator" - "src/L1/DataAvailabilityChallenge.sol:DataAvailabilityChallenge" - # "src/L1/ETHLockbox.sol:ETHLockbox" - "src/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger" - "src/L1/L1ERC721Bridge.sol:L1ERC721Bridge" - "src/L1/L1StandardBridge.sol:L1StandardBridge" - "src/L1/OPContractsManager.sol:OPContractsManager" - # "src/L1/OptimismPortal2.sol:OptimismPortal2" - "src/L1/ProtocolVersions.sol:ProtocolVersions" - "src/L1/SuperchainConfig.sol:SuperchainConfig" - "src/L1/SystemConfig.sol:SystemConfig" - "src/L2/BaseFeeVault.sol:BaseFeeVault" - "src/L2/CrossL2Inbox.sol:CrossL2Inbox" - "src/L2/ETHLiquidity.sol:ETHLiquidity" - "src/L2/GasPriceOracle.sol:GasPriceOracle" - "src/L2/L1Block.sol:L1Block" - "src/L2/L1FeeVault.sol:L1FeeVault" - "src/L2/L2CrossDomainMessenger.sol:L2CrossDomainMessenger" - "src/L2/L2ERC721Bridge.sol:L2ERC721Bridge" - "src/L2/L2StandardBridge.sol:L2StandardBridge" - "src/L2/L2StandardBridgeInterop.sol:L2StandardBridgeInterop" - "src/L2/L2ToL1MessagePasser.sol:L2ToL1MessagePasser" - "src/L2/L2ToL2CrossDomainMessenger.sol:L2ToL2CrossDomainMessenger" - "src/L2/OptimismMintableERC721.sol:OptimismMintableERC721" - "src/L2/OptimismMintableERC721Factory.sol:OptimismMintableERC721Factory" - "src/L2/OptimismSuperchainERC20.sol:OptimismSuperchainERC20" - "src/L2/OptimismSuperchainERC20Beacon.sol:OptimismSuperchainERC20Beacon" - "src/L2/OptimismSuperchainERC20Factory.sol:OptimismSuperchainERC20Factory" - "src/L2/SequencerFeeVault.sol:SequencerFeeVault" - "src/L2/SuperchainERC20.sol:SuperchainERC20" - "src/L2/SuperchainTokenBridge.sol:SuperchainTokenBridge" - "src/L2/SuperchainETHBridge.sol:SuperchainETHBridge" - "src/L2/WETH.sol:WETH" - "src/cannon/MIPS64.sol:MIPS64" - "src/cannon/PreimageOracle.sol:PreimageOracle" - # "src/dispute/AnchorStateRegistry.sol:AnchorStateRegistry" - "src/dispute/DelayedWETH.sol:DelayedWETH" - # "src/dispute/DisputeGameFactory.sol:DisputeGameFactory" - "src/dispute/FaultDisputeGame.sol:FaultDisputeGame" - "src/dispute/PermissionedDisputeGame.sol:PermissionedDisputeGame" - "src/dispute/SuperFaultDisputeGame.sol:SuperFaultDisputeGame" - "src/dispute/SuperPermissionedDisputeGame.sol:SuperPermissionedDisputeGame" - "src/legacy/DeployerWhitelist.sol:DeployerWhitelist" - "src/legacy/L1BlockNumber.sol:L1BlockNumber" - "src/legacy/LegacyMessagePasser.sol:LegacyMessagePasser" - "src/safe/DeputyGuardianModule.sol:DeputyGuardianModule" - "src/safe/DeputyPauseModule.sol:DeputyPauseModule" - "src/safe/LivenessGuard.sol:LivenessGuard" - "src/safe/LivenessModule.sol:LivenessModule" - "src/universal/OptimismMintableERC20.sol:OptimismMintableERC20" - "src/universal/OptimismMintableERC20Factory.sol:OptimismMintableERC20Factory" - "src/universal/StorageSetter.sol:StorageSetter" - "src/vendor/asterisc/RISCV.sol:RISCV" - "src/vendor/eas/EAS.sol:EAS" - "src/vendor/eas/SchemaRegistry.sol:SchemaRegistry" -) - -MATCHED_FILES=() -# Check each changed contract against allowed patterns -for contract in $changed_contracts; do - is_allowed=false - for allowed_file in "${ALLOWED_FILES[@]}"; do - if [[ "$contract" == "$allowed_file" ]]; then - is_allowed=true - break - fi - done - if [[ "$is_allowed" == "false" ]]; then - MATCHED_FILES+=("$contract") - fi -done - -if [ ${#MATCHED_FILES[@]} -gt 0 ]; then - echo "❌ Error: Changes detected in files that are not allowed to be modified." - echo "The following files were modified but are not in the allowed list:" - printf ' - %s\n' "${MATCHED_FILES[@]}" - echo "Only the following files can be modified:" - printf ' - %s\n' "${ALLOWED_FILES[@]}" - echo "The code freeze is expected to be lifted no later than 2025-02-20." - exit 1 -fi - -echo "✅ All changes are in allowed files" -exit 0 diff --git a/packages/contracts-bedrock/scripts/checks/interfaces/main.go b/packages/contracts-bedrock/scripts/checks/interfaces/main.go index 82f78d8a3e9..fb2bdf40512 100644 --- a/packages/contracts-bedrock/scripts/checks/interfaces/main.go +++ b/packages/contracts-bedrock/scripts/checks/interfaces/main.go @@ -41,7 +41,7 @@ var excludeSourceContracts = []string{ "CrossDomainOwnable", "CrossDomainOwnable2", "CrossDomainOwnable3", "CrossDomainMessengerLegacySpacer0", "CrossDomainMessengerLegacySpacer1", // Helper contracts - "SafeSend", "EventLogger", "StorageSetter", "DisputeMonitorHelper", + "SafeSend", "EventLogger", "StorageSetter", "DisputeMonitorHelper", "GameHelper", // Periphery "TransferOnion", "AssetReceiver", "AdminFaucetAuthModule", "CheckSecrets", "CheckBalanceLow", "CheckTrue", "Drippie", "Transactor", "Faucet", diff --git a/packages/contracts-bedrock/scripts/checks/opcm-upgrade-checks/main.go b/packages/contracts-bedrock/scripts/checks/opcm-upgrade-checks/main.go index 6098879cf95..1b5c6f29d45 100644 --- a/packages/contracts-bedrock/scripts/checks/opcm-upgrade-checks/main.go +++ b/packages/contracts-bedrock/scripts/checks/opcm-upgrade-checks/main.go @@ -107,20 +107,35 @@ func processFile(artifactPath string) (*common.Void, []error) { return nil, []error{err} } - // Get the AST of OPCM's upgrade function. - opcmUpgradeAst, err := getOpcmUpgradeFunctionAst(opcmAst) - if err != nil { - return nil, []error{err} - } - // Check that there is a call to contract.upgrade. contractName := strings.Split(filepath.Base(artifactPath), ".")[0] typeName := "contract I" + contractName - callType := upgradesContract(opcmUpgradeAst.Body.Statements, "upgrade", typeName, InternalUpgradeFunctionType{ - name: "upgradeToAndCall", - typeName: "function (contract IProxyAdmin,address,address,bytes memory)", - }) + var callType CallType + if contractName == "SuperchainConfig" { + // Get the AST of OPCM's upgradeSuperchainConfig function. + opcmUpgradeSuperchainConfigAst, err := getOpcmUpgradeFunctionAst(opcmAst, "upgradeSuperchainConfig") + if err != nil { + return nil, []error{err} + } + + callType = upgradesContract(opcmUpgradeSuperchainConfigAst.Body.Statements, "upgrade", typeName, InternalUpgradeFunctionType{ + name: "upgradeToAndCall", + typeName: "function (contract IProxyAdmin,address,address,bytes memory)", + }) + } else { + // Get the AST of OPCM's upgrade function. + opcmUpgradeAst, err := getOpcmUpgradeFunctionAst(opcmAst, "_doChainUpgrade") + if err != nil { + return nil, []error{err} + } + + callType = upgradesContract(opcmUpgradeAst.Body.Statements, "upgrade", typeName, InternalUpgradeFunctionType{ + name: "upgradeToAndCall", + typeName: "function (contract IProxyAdmin,address,address,bytes memory)", + }) + } + if callType == NOT_FOUND { return nil, []error{fmt.Errorf("OPCM upgrade function does not call %v.upgrade", contractName)} } @@ -293,14 +308,13 @@ func identifyValidInternalUpgradeCall(expression *solc.Expression, internalFunct // Get the AST of OPCM's upgrade function. // Returns an error if zero or more than one external upgrade function is found. -func getOpcmUpgradeFunctionAst(opcmArtifact *solc.ForgeArtifact) (*solc.AstNode, error) { +func getOpcmUpgradeFunctionAst(opcmArtifact *solc.ForgeArtifact, upgradeFunctionName string) (*solc.AstNode, error) { opcmUpgradeFunctions := []solc.AstNode{} for _, astNode := range opcmArtifact.Ast.Nodes { if astNode.NodeType == "ContractDefinition" && astNode.Name == "OPContractsManagerUpgrader" { for _, node := range astNode.Nodes { if node.NodeType == "FunctionDefinition" && - node.Name == "upgrade" && - node.Visibility == "external" { + node.Name == upgradeFunctionName { opcmUpgradeFunctions = append(opcmUpgradeFunctions, node) } } @@ -308,11 +322,11 @@ func getOpcmUpgradeFunctionAst(opcmArtifact *solc.ForgeArtifact) (*solc.AstNode, } if len(opcmUpgradeFunctions) == 0 { - return nil, fmt.Errorf("no external upgrade function found in OPContractsManagerUpgrader") + return nil, fmt.Errorf("no external %s function found in OPContractsManagerUpgrader", upgradeFunctionName) } if len(opcmUpgradeFunctions) > 1 { - return nil, fmt.Errorf("multiple external upgrade functions found in OPContractsManagerUpgrader, expected 1") + return nil, fmt.Errorf("multiple external %s functions found in OPContractsManagerUpgrader, expected 1", upgradeFunctionName) } return &opcmUpgradeFunctions[0], nil diff --git a/packages/contracts-bedrock/scripts/checks/opcm-upgrade-checks/main_test.go b/packages/contracts-bedrock/scripts/checks/opcm-upgrade-checks/main_test.go index 296e7fb60e6..b7b7ef16bea 100644 --- a/packages/contracts-bedrock/scripts/checks/opcm-upgrade-checks/main_test.go +++ b/packages/contracts-bedrock/scripts/checks/opcm-upgrade-checks/main_test.go @@ -10,13 +10,14 @@ import ( func TestGetOpcmUpgradeFunctionAst(t *testing.T) { tests := []struct { - name string - opcmArtifact *solc.ForgeArtifact - expectedAst *solc.AstNode - expectedError string + name string + opcmArtifact *solc.ForgeArtifact + upgradeFunctionName string + expectedAst *solc.AstNode + expectedError string }{ { - name: "With one external upgrade function", + name: "With one _doChainUpgrade function", opcmArtifact: &solc.ForgeArtifact{ Ast: solc.Ast{ Nodes: []solc.AstNode{ @@ -25,7 +26,7 @@ func TestGetOpcmUpgradeFunctionAst(t *testing.T) { Nodes: []solc.AstNode{ { NodeType: "FunctionDefinition", - Name: "upgrade", + Name: "_doChainUpgrade", Visibility: "external", Nodes: []solc.AstNode{ { @@ -39,9 +40,10 @@ func TestGetOpcmUpgradeFunctionAst(t *testing.T) { }, }, }, + upgradeFunctionName: "_doChainUpgrade", expectedAst: &solc.AstNode{ NodeType: "FunctionDefinition", - Name: "upgrade", + Name: "_doChainUpgrade", Visibility: "external", Nodes: []solc.AstNode{ { @@ -52,7 +54,7 @@ func TestGetOpcmUpgradeFunctionAst(t *testing.T) { expectedError: "", }, { - name: "With an upgrade function but public visibility", + name: "With a _doChainUpgrade function but public visibility", opcmArtifact: &solc.ForgeArtifact{ Ast: solc.Ast{ Nodes: []solc.AstNode{ @@ -61,7 +63,7 @@ func TestGetOpcmUpgradeFunctionAst(t *testing.T) { Nodes: []solc.AstNode{ { NodeType: "FunctionDefinition", - Name: "upgrade", + Name: "_doChainUpgrade", Visibility: "public", }, }, @@ -70,11 +72,16 @@ func TestGetOpcmUpgradeFunctionAst(t *testing.T) { }, }, }, - expectedAst: nil, - expectedError: "no external upgrade function found in OPContractsManagerUpgrader", + upgradeFunctionName: "_doChainUpgrade", + expectedAst: &solc.AstNode{ + NodeType: "FunctionDefinition", + Name: "_doChainUpgrade", + Visibility: "public", + }, + expectedError: "", }, { - name: "With an upgrade function and irrelevant function selector", + name: "With a _doChainUpgrade function and irrelevant function selector", opcmArtifact: &solc.ForgeArtifact{ Ast: solc.Ast{ Nodes: []solc.AstNode{ @@ -83,7 +90,7 @@ func TestGetOpcmUpgradeFunctionAst(t *testing.T) { Nodes: []solc.AstNode{ { NodeType: "FunctionDefinition", - Name: "upgrade", + Name: "_doChainUpgrade", Visibility: "external", FunctionSelector: "aabbccdd", Nodes: []solc.AstNode{ @@ -98,9 +105,10 @@ func TestGetOpcmUpgradeFunctionAst(t *testing.T) { }, }, }, + upgradeFunctionName: "_doChainUpgrade", expectedAst: &solc.AstNode{ NodeType: "FunctionDefinition", - Name: "upgrade", + Name: "_doChainUpgrade", Visibility: "external", FunctionSelector: "aabbccdd", Nodes: []solc.AstNode{ @@ -112,7 +120,7 @@ func TestGetOpcmUpgradeFunctionAst(t *testing.T) { expectedError: "", }, { - name: "With multiple external upgrade functions", + name: "With multiple _doChainUpgrade functions", opcmArtifact: &solc.ForgeArtifact{ Ast: solc.Ast{ Nodes: []solc.AstNode{ @@ -121,12 +129,12 @@ func TestGetOpcmUpgradeFunctionAst(t *testing.T) { Nodes: []solc.AstNode{ { NodeType: "FunctionDefinition", - Name: "upgrade", + Name: "_doChainUpgrade", Visibility: "external", }, { NodeType: "FunctionDefinition", - Name: "upgrade", + Name: "_doChainUpgrade", Visibility: "external", }, }, @@ -135,11 +143,12 @@ func TestGetOpcmUpgradeFunctionAst(t *testing.T) { }, }, }, - expectedAst: nil, - expectedError: "multiple external upgrade functions found in OPContractsManagerUpgrader, expected 1", + upgradeFunctionName: "_doChainUpgrade", + expectedAst: nil, + expectedError: "multiple external _doChainUpgrade functions found in OPContractsManagerUpgrader, expected 1", }, { - name: "With no upgrade function", + name: "With no _doChainUpgrade function", opcmArtifact: &solc.ForgeArtifact{ Ast: solc.Ast{ Nodes: []solc.AstNode{ @@ -162,8 +171,9 @@ func TestGetOpcmUpgradeFunctionAst(t *testing.T) { }, }, }, - expectedAst: nil, - expectedError: "no external upgrade function found in OPContractsManagerUpgrader", + upgradeFunctionName: "_doChainUpgrade", + expectedAst: nil, + expectedError: "no external _doChainUpgrade function found in OPContractsManagerUpgrader", }, { name: "With no contract definition", @@ -172,14 +182,15 @@ func TestGetOpcmUpgradeFunctionAst(t *testing.T) { Nodes: []solc.AstNode{}, }, }, - expectedAst: nil, - expectedError: "no external upgrade function found in OPContractsManagerUpgrader", + upgradeFunctionName: "_doChainUpgrade", + expectedAst: nil, + expectedError: "no external _doChainUpgrade function found in OPContractsManagerUpgrader", }, } for _, test := range tests { t.Run(test.name, func(t *testing.T) { - ast, err := getOpcmUpgradeFunctionAst(test.opcmArtifact) + ast, err := getOpcmUpgradeFunctionAst(test.opcmArtifact, test.upgradeFunctionName) if test.expectedError == "" { assert.NoError(t, err) diff --git a/packages/contracts-bedrock/scripts/checks/test-validation/main.go b/packages/contracts-bedrock/scripts/checks/test-validation/main.go index 4b32827ab3d..56eec89b62a 100644 --- a/packages/contracts-bedrock/scripts/checks/test-validation/main.go +++ b/packages/contracts-bedrock/scripts/checks/test-validation/main.go @@ -147,6 +147,10 @@ func checkTestStructure(artifact *solc.ForgeArtifact) []error { // Validate each contract name in the compilation target for _, contractName := range artifact.Metadata.Settings.CompilationTarget { + if isExcludedTest(contractName) { + continue + } + contractParts := strings.Split(contractName, "_") // Check for initialization test pattern @@ -309,6 +313,16 @@ func isExcluded(filePath string) bool { return false } +// Checks if a contract name should be excluded from test validation +func isExcludedTest(contractName string) bool { + for _, excluded := range excludedTests { + if excluded == contractName { + return true + } + } + return false +} + // Defines the list of paths that should be excluded from validation var excludedPaths = []string{ // PATHS EXCLUDED FROM SRC VALIDATION: @@ -350,15 +364,17 @@ var excludedPaths = []string{ // // These naming inconsistencies may indicate the presence of specialized test // infrastructure beyond standard harnesses or different setup contracts patterns. - "test/dispute/FaultDisputeGame.t.sol", // Contains contracts not matching FaultDisputeGame base name - "test/dispute/SuperFaultDisputeGame.t.sol", // Contains contracts not matching SuperFaultDisputeGame base name - "test/L1/ResourceMetering.t.sol", // Contains contracts not matching ResourceMetering base name - "test/L1/OPContractsManagerStandardValidator.t.sol", // Contains contracts not matching OPContractsManagerStandardValidator base name - "test/L2/CrossDomainOwnable.t.sol", // Contains contracts not matching CrossDomainOwnable base name - "test/L2/CrossDomainOwnable2.t.sol", // Contains contracts not matching CrossDomainOwnable2 base name - "test/L2/CrossDomainOwnable3.t.sol", // Contains contracts not matching CrossDomainOwnable3 base name - "test/L2/GasPriceOracle.t.sol", // Contains contracts not matching GasPriceOracle base name - "test/universal/StandardBridge.t.sol", // Contains contracts not matching StandardBridge base name + "test/dispute/FaultDisputeGame.t.sol", // Contains contracts not matching FaultDisputeGame base name + "test/dispute/v2/FaultDisputeGameV2.t.sol", // Contains contracts not matching FaultDisputeGameV2 base name + "test/dispute/SuperFaultDisputeGame.t.sol", // Contains contracts not matching SuperFaultDisputeGame base name + "test/L1/ResourceMetering.t.sol", // Contains contracts not matching ResourceMetering base name + "test/L1/OPContractsManagerStandardValidator.t.sol", // Contains contracts not matching OPContractsManagerStandardValidator base name + "test/L2/CrossDomainOwnable.t.sol", // Contains contracts not matching CrossDomainOwnable base name + "test/L2/CrossDomainOwnable2.t.sol", // Contains contracts not matching CrossDomainOwnable2 base name + "test/L2/CrossDomainOwnable3.t.sol", // Contains contracts not matching CrossDomainOwnable3 base name + "test/L2/GasPriceOracle.t.sol", // Contains contracts not matching GasPriceOracle base name + "test/universal/StandardBridge.t.sol", // Contains contracts not matching StandardBridge base name + "test/L1/OPContractsManagerContractsContainer.t.sol", // Contains contracts not matching OPContractsManagerContractsContainer base name // PATHS EXCLUDED FROM FUNCTION NAME VALIDATION: // These paths are excluded because they don't pass the function name validation, which checks @@ -384,6 +400,13 @@ var excludedPaths = []string{ "test/safe/SafeSigners.t.sol", // Function name validation issues } +var excludedTests = []string{ + // Interop tests hosted in the OptimismPortal2 test file. + "OptimismPortal2_MigrateLiquidity_Test", + "OptimismPortal2_MigrateToSuperRoots_Test", + "OptimismPortal2_UpgradeInterop_Test", +} + // Defines the signature for test name validation functions type CheckFunc func(parts []string) bool diff --git a/packages/contracts-bedrock/scripts/deploy/ChainAssertions.sol b/packages/contracts-bedrock/scripts/deploy/ChainAssertions.sol index 8c693f0ca88..d29855f776b 100644 --- a/packages/contracts-bedrock/scripts/deploy/ChainAssertions.sol +++ b/packages/contracts-bedrock/scripts/deploy/ChainAssertions.sol @@ -277,7 +277,10 @@ library ChainAssertions { require(address(portal.superchainConfig()) == address(_superchainConfig), "PORTAL-40"); require(portal.guardian() == _superchainConfig.guardian(), "CHECK-OP2-40"); require(portal.paused() == ISystemConfig(_contracts.SystemConfig).paused(), "CHECK-OP2-60"); - require(address(portal.ethLockbox()) == _contracts.ETHLockbox, "CHECK-OP2-80"); + require( + address(portal.ethLockbox()) == _contracts.ETHLockbox || address(portal.ethLockbox()) == address(0), + "CHECK-OP2-80" + ); require(portal.proxyAdminOwner() == _opChainProxyAdminOwner, "CHECK-OP2-90"); } else { require(address(portal.anchorStateRegistry()) == address(0), "CHECK-OP2-80"); diff --git a/packages/contracts-bedrock/scripts/deploy/Deploy.s.sol b/packages/contracts-bedrock/scripts/deploy/Deploy.s.sol index b3afc5ac39c..b806e6c3a3b 100644 --- a/packages/contracts-bedrock/scripts/deploy/Deploy.s.sol +++ b/packages/contracts-bedrock/scripts/deploy/Deploy.s.sol @@ -278,7 +278,8 @@ contract Deploy is Deployer { superchainConfigProxy: superchainConfigProxy, superchainProxyAdmin: superchainProxyAdmin, upgradeController: superchainProxyAdmin.owner(), - challenger: cfg.l2OutputOracleChallenger() + challenger: cfg.l2OutputOracleChallenger(), + devFeatureBitmap: cfg.devFeatureBitmap() }) ); diff --git a/packages/contracts-bedrock/scripts/deploy/DeployConfig.s.sol b/packages/contracts-bedrock/scripts/deploy/DeployConfig.s.sol index 54bf57093e7..20a1a0bc275 100644 --- a/packages/contracts-bedrock/scripts/deploy/DeployConfig.s.sol +++ b/packages/contracts-bedrock/scripts/deploy/DeployConfig.s.sol @@ -29,6 +29,7 @@ contract DeployConfig is Script { uint256 public l2GenesisFjordTimeOffset; uint256 public l2GenesisGraniteTimeOffset; uint256 public l2GenesisHoloceneTimeOffset; + uint256 public l2GenesisJovianTimeOffset; address public p2pSequencerAddress; address public batchInboxAddress; address public batchSenderAddress; @@ -80,6 +81,8 @@ contract DeployConfig is Script { bool public useInterop; bool public useUpgradedFork; + bytes32 public devFeatureBitmap; + bool public useRevenueShare; address public chainFeesRecipient; address public l1FeesDepositor; @@ -102,6 +105,7 @@ contract DeployConfig is Script { l2GenesisFjordTimeOffset = _readOr(_json, "$.l2GenesisFjordTimeOffset", NULL_OFFSET); l2GenesisGraniteTimeOffset = _readOr(_json, "$.l2GenesisGraniteTimeOffset", NULL_OFFSET); l2GenesisHoloceneTimeOffset = _readOr(_json, "$.l2GenesisHoloceneTimeOffset", NULL_OFFSET); + l2GenesisJovianTimeOffset = _readOr(_json, "$.l2GenesisJovianTimeOffset", NULL_OFFSET); p2pSequencerAddress = stdJson.readAddress(_json, "$.p2pSequencerAddress"); batchInboxAddress = stdJson.readAddress(_json, "$.batchInboxAddress"); @@ -158,6 +162,7 @@ contract DeployConfig is Script { daResolverRefundPercentage = _readOr(_json, "$.daResolverRefundPercentage", 0); useInterop = _readOr(_json, "$.useInterop", false); + devFeatureBitmap = bytes32(_readOr(_json, "$.devFeatureBitmap", 0)); useUpgradedFork; useRevenueShare = _readOr(_json, "$.useRevenueShare", false); chainFeesRecipient = _readOr(_json, "$.chainFeesRecipient", address(0)); @@ -232,6 +237,11 @@ contract DeployConfig is Script { fundDevAccounts = _fundDevAccounts; } + /// @notice Allow the `devFeatureBitmap` config to be overridden in testing environments + function setDevFeatureBitmap(bytes32 _devFeatureBitmap) public { + devFeatureBitmap = _devFeatureBitmap; + } + /// @notice Allow the `useUpgradedFork` config to be overridden in testing environments /// @dev When true, the forked system WILL be upgraded in setUp(). /// When false, the forked system WILL NOT be upgraded in setUp(). @@ -244,7 +254,9 @@ contract DeployConfig is Script { } function latestGenesisFork() internal view returns (Fork) { - if (l2GenesisHoloceneTimeOffset == 0) { + if (l2GenesisJovianTimeOffset == 0) { + return Fork.JOVIAN; + } else if (l2GenesisHoloceneTimeOffset == 0) { return Fork.HOLOCENE; } else if (l2GenesisGraniteTimeOffset == 0) { return Fork.GRANITE; diff --git a/packages/contracts-bedrock/scripts/deploy/DeployImplementations.s.sol b/packages/contracts-bedrock/scripts/deploy/DeployImplementations.s.sol index 20dd2de9a17..dbc3b02fae1 100644 --- a/packages/contracts-bedrock/scripts/deploy/DeployImplementations.s.sol +++ b/packages/contracts-bedrock/scripts/deploy/DeployImplementations.s.sol @@ -25,6 +25,7 @@ import { IOPContractsManagerStandardValidator } from "interfaces/L1/IOPContractsManager.sol"; import { IOptimismPortal2 as IOptimismPortal } from "interfaces/L1/IOptimismPortal2.sol"; +import { IOptimismPortalInterop } from "interfaces/L1/IOptimismPortalInterop.sol"; import { IETHLockbox } from "interfaces/L1/IETHLockbox.sol"; import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol"; import { IL1CrossDomainMessenger } from "interfaces/L1/IL1CrossDomainMessenger.sol"; @@ -46,6 +47,7 @@ contract DeployImplementations is Script { uint256 proofMaturityDelaySeconds; uint256 disputeGameFinalityDelaySeconds; uint256 mipsVersion; + bytes32 devFeatureBitmap; // Outputs from DeploySuperchain.s.sol. ISuperchainConfig superchainConfigProxy; IProtocolVersions protocolVersionsProxy; @@ -64,6 +66,7 @@ contract DeployImplementations is Script { IOPContractsManagerStandardValidator opcmStandardValidator; IDelayedWETH delayedWETHImpl; IOptimismPortal optimismPortalImpl; + IOptimismPortalInterop optimismPortalInteropImpl; IETHLockbox ethLockboxImpl; IPreimageOracle preimageOracleSingleton; IMIPS64 mipsSingleton; @@ -94,6 +97,7 @@ contract DeployImplementations is Script { deployL1StandardBridgeImpl(output_); deployOptimismMintableERC20FactoryImpl(output_); deployOptimismPortalImpl(_input, output_); + deployOptimismPortalInteropImpl(_input, output_); deployETHLockboxImpl(output_); deployDelayedWETHImpl(_input, output_); deployPreimageOracleSingleton(_input, output_); @@ -124,6 +128,7 @@ contract DeployImplementations is Script { protocolVersionsImpl: address(_output.protocolVersionsImpl), l1ERC721BridgeImpl: address(_output.l1ERC721BridgeImpl), optimismPortalImpl: address(_output.optimismPortalImpl), + optimismPortalInteropImpl: address(_output.optimismPortalInteropImpl), ethLockboxImpl: address(_output.ethLockboxImpl), systemConfigImpl: address(_output.systemConfigImpl), optimismMintableERC20FactoryImpl: address(_output.optimismMintableERC20FactoryImpl), @@ -135,7 +140,7 @@ contract DeployImplementations is Script { mipsImpl: address(_output.mipsSingleton) }); - deployOPCMBPImplsContainer(_output, _blueprints, implementations); + deployOPCMBPImplsContainer(_input, _output, _blueprints, implementations); deployOPCMGameTypeAdder(_output); deployOPCMDeployer(_input, _output); deployOPCMUpgrader(_output); @@ -350,8 +355,6 @@ contract DeployImplementations is Script { // These are: // - FaultDisputeGame (not proxied) // - PermissionedDisputeGame (not proxied) - // - DelayedWeth (proxies only) - // - OptimismPortal2 (proxies only) function deployOptimismPortalImpl(Input memory _input, Output memory _output) private { uint256 proofMaturityDelaySeconds = _input.proofMaturityDelaySeconds; @@ -368,6 +371,21 @@ contract DeployImplementations is Script { _output.optimismPortalImpl = impl; } + function deployOptimismPortalInteropImpl(Input memory _input, Output memory _output) private { + uint256 proofMaturityDelaySeconds = _input.proofMaturityDelaySeconds; + IOptimismPortalInterop impl = IOptimismPortalInterop( + DeployUtils.createDeterministic({ + _name: "OptimismPortalInterop", + _args: DeployUtils.encodeConstructor( + abi.encodeCall(IOptimismPortalInterop.__constructor__, (proofMaturityDelaySeconds)) + ), + _salt: _salt + }) + ); + vm.label(address(impl), "OptimismPortalInteropImpl"); + _output.optimismPortalInteropImpl = impl; + } + function deployDelayedWETHImpl(Input memory _input, Output memory _output) private { uint256 withdrawalDelaySeconds = _input.withdrawalDelaySeconds; IDelayedWETH impl = IDelayedWETH( @@ -447,6 +465,7 @@ contract DeployImplementations is Script { } function deployOPCMBPImplsContainer( + Input memory _input, Output memory _output, IOPContractsManager.Blueprints memory _blueprints, IOPContractsManager.Implementations memory _implementations @@ -457,7 +476,10 @@ contract DeployImplementations is Script { DeployUtils.createDeterministic({ _name: "OPContractsManager.sol:OPContractsManagerContractsContainer", _args: DeployUtils.encodeConstructor( - abi.encodeCall(IOPContractsManagerContractsContainer.__constructor__, (_blueprints, _implementations)) + abi.encodeCall( + IOPContractsManagerContractsContainer.__constructor__, + (_blueprints, _implementations, _input.devFeatureBitmap) + ) ), _salt: _salt }) @@ -532,6 +554,7 @@ contract DeployImplementations is Script { IOPContractsManagerStandardValidator.Implementations memory opcmImplementations; opcmImplementations.l1ERC721BridgeImpl = _implementations.l1ERC721BridgeImpl; opcmImplementations.optimismPortalImpl = _implementations.optimismPortalImpl; + opcmImplementations.optimismPortalInteropImpl = _implementations.optimismPortalInteropImpl; opcmImplementations.ethLockboxImpl = _implementations.ethLockboxImpl; opcmImplementations.systemConfigImpl = _implementations.systemConfigImpl; opcmImplementations.optimismMintableERC20FactoryImpl = _implementations.optimismMintableERC20FactoryImpl; @@ -553,7 +576,8 @@ contract DeployImplementations is Script { _input.superchainConfigProxy, _input.upgradeController, // Proxy admin owner _input.challenger, - _input.withdrawalDelaySeconds + _input.withdrawalDelaySeconds, + _input.devFeatureBitmap ) ) ), diff --git a/packages/contracts-bedrock/scripts/deploy/ReadImplementationAddresses.s.sol b/packages/contracts-bedrock/scripts/deploy/ReadImplementationAddresses.s.sol index e51847a2702..db68fc7fceb 100644 --- a/packages/contracts-bedrock/scripts/deploy/ReadImplementationAddresses.s.sol +++ b/packages/contracts-bedrock/scripts/deploy/ReadImplementationAddresses.s.sol @@ -30,6 +30,7 @@ contract ReadImplementationAddressesInput is DeployOPChainOutput { contract ReadImplementationAddressesOutput is BaseDeployIO { address internal _delayedWETH; address internal _optimismPortal; + address internal _optimismPortalInterop; address internal _ethLockbox; address internal _systemConfig; address internal _l1CrossDomainMessenger; @@ -44,6 +45,7 @@ contract ReadImplementationAddressesOutput is BaseDeployIO { require(_addr != address(0), "ReadImplementationAddressesOutput: cannot set zero address"); if (_sel == this.delayedWETH.selector) _delayedWETH = _addr; else if (_sel == this.optimismPortal.selector) _optimismPortal = _addr; + else if (_sel == this.optimismPortalInterop.selector) _optimismPortalInterop = _addr; else if (_sel == this.ethLockbox.selector) _ethLockbox = _addr; else if (_sel == this.systemConfig.selector) _systemConfig = _addr; else if (_sel == this.l1CrossDomainMessenger.selector) _l1CrossDomainMessenger = _addr; @@ -66,6 +68,13 @@ contract ReadImplementationAddressesOutput is BaseDeployIO { return _optimismPortal; } + function optimismPortalInterop() public view returns (address) { + require( + _optimismPortalInterop != address(0), "ReadImplementationAddressesOutput: optimismPortalInterop not set" + ); + return _optimismPortalInterop; + } + function ethLockbox() public view returns (address) { require(_ethLockbox != address(0), "ReadImplementationAddressesOutput: ethLockbox not set"); return _ethLockbox; @@ -164,5 +173,8 @@ contract ReadImplementationAddresses is Script { address ethLockbox = _rii.opcm().implementations().ethLockboxImpl; _rio.set(_rio.ethLockbox.selector, ethLockbox); + + address optimismPortalInterop = _rii.opcm().implementations().optimismPortalInteropImpl; + _rio.set(_rio.optimismPortalInterop.selector, optimismPortalInterop); } } diff --git a/packages/contracts-bedrock/scripts/deploy/StandardConstants.sol b/packages/contracts-bedrock/scripts/deploy/StandardConstants.sol index e3ac46ec44b..15b10faa660 100644 --- a/packages/contracts-bedrock/scripts/deploy/StandardConstants.sol +++ b/packages/contracts-bedrock/scripts/deploy/StandardConstants.sol @@ -2,5 +2,5 @@ pragma solidity 0.8.15; library StandardConstants { - uint256 public constant MIPS_VERSION = 7; + uint256 public constant MIPS_VERSION = 8; } diff --git a/packages/contracts-bedrock/scripts/deploy/VerifyOPCM.s.sol b/packages/contracts-bedrock/scripts/deploy/VerifyOPCM.s.sol index e88f8aae302..39ae8d5eb02 100644 --- a/packages/contracts-bedrock/scripts/deploy/VerifyOPCM.s.sol +++ b/packages/contracts-bedrock/scripts/deploy/VerifyOPCM.s.sol @@ -52,6 +52,9 @@ contract VerifyOPCM is Script { /// @notice Thrown when there are getter functions in the ABI that are not being checked. error VerifyOPCM_UnaccountedGetters(string[] _unaccountedGetters); + /// @notice Thrown when the dev feature bitmap is not empty on mainnet. + error VerifyOPCM_DevFeatureBitmapNotEmpty(); + /// @notice Preamble used for blueprint contracts. bytes constant BLUEPRINT_PREAMBLE = hex"FE7100"; @@ -107,6 +110,7 @@ contract VerifyOPCM is Script { function setUp() public { // Overrides for situations where field names do not cleanly map to contract names. fieldNameOverrides["optimismPortalImpl"] = "OptimismPortal2"; + fieldNameOverrides["optimismPortalInteropImpl"] = "OptimismPortalInterop"; fieldNameOverrides["mipsImpl"] = "MIPS64"; fieldNameOverrides["ethLockboxImpl"] = "ETHLockbox"; fieldNameOverrides["permissionlessDisputeGame1"] = "FaultDisputeGame"; @@ -152,6 +156,10 @@ contract VerifyOPCM is Script { expectedGetters["opcmStandardValidator"] = "SKIP"; // Address verified via bytecode comparison expectedGetters["opcmUpgrader"] = "SKIP"; // Address verified via bytecode comparison + // Getters that don't need any sort of verification + expectedGetters["devFeatureBitmap"] = "SKIP"; + expectedGetters["isDevFeatureEnabled"] = "SKIP"; + // Mark as ready. ready = true; } @@ -197,6 +205,9 @@ contract VerifyOPCM is Script { // Validate that all ABI getters are accounted for. _validateAllGettersAccounted(); + // Validate that the dev feature bitmap is empty on mainnet. + _validateDevFeatureBitmap(opcm); + // Collect all the references. OpcmContractRef[] memory refs = _collectOpcmContractRefs(opcm); @@ -910,6 +921,21 @@ contract VerifyOPCM is Script { ); } + /// @notice Validates that the dev feature bitmap is empty on mainnet. + /// @param _opcm The OPCM contract. + function _validateDevFeatureBitmap(IOPContractsManager _opcm) internal view { + // Get the dev feature bitmap. + bytes32 devFeatureBitmap = _opcm.devFeatureBitmap(); + + // Check if we're in a testing environment. + bool isTestingEnvironment = address(0xbeefcafe).code.length > 0; + + // Check if any dev features are enabled. + if (block.chainid == 1 && !isTestingEnvironment && devFeatureBitmap != bytes32(0)) { + revert VerifyOPCM_DevFeatureBitmapNotEmpty(); + } + } + /// @notice Validates that all getter functions in the OPContractsManager ABI are accounted for /// in the expectedGetters mapping. This ensures we don't miss any new getters that /// might be added to the contract. diff --git a/packages/contracts-bedrock/scripts/libraries/Config.sol b/packages/contracts-bedrock/scripts/libraries/Config.sol index 247475576c9..a9a4fb8bf82 100644 --- a/packages/contracts-bedrock/scripts/libraries/Config.sol +++ b/packages/contracts-bedrock/scripts/libraries/Config.sol @@ -235,4 +235,9 @@ library Config { function forkTest() internal view returns (bool) { return vm.envOr("FORK_TEST", false); } + + /// @notice Returns true if the development feature interop is enabled. + function devFeatureInterop() internal view returns (bool) { + return vm.envOr("DEV_FEATURE__OPTIMISM_PORTAL_INTEROP", false); + } } diff --git a/packages/contracts-bedrock/snapshots/abi/DisputeGameFactory.json b/packages/contracts-bedrock/snapshots/abi/DisputeGameFactory.json index c7a791ed32e..016224be139 100644 --- a/packages/contracts-bedrock/snapshots/abi/DisputeGameFactory.json +++ b/packages/contracts-bedrock/snapshots/abi/DisputeGameFactory.json @@ -89,6 +89,25 @@ "stateMutability": "view", "type": "function" }, + { + "inputs": [ + { + "internalType": "GameType", + "name": "", + "type": "uint32" + } + ], + "name": "gameArgs", + "outputs": [ + { + "internalType": "bytes", + "name": "", + "type": "bytes" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [ { @@ -322,6 +341,29 @@ "stateMutability": "nonpayable", "type": "function" }, + { + "inputs": [ + { + "internalType": "GameType", + "name": "_gameType", + "type": "uint32" + }, + { + "internalType": "contract IDisputeGame", + "name": "_impl", + "type": "address" + }, + { + "internalType": "bytes", + "name": "_args", + "type": "bytes" + } + ], + "name": "setImplementation", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, { "inputs": [ { @@ -391,6 +433,25 @@ "name": "DisputeGameCreated", "type": "event" }, + { + "anonymous": false, + "inputs": [ + { + "indexed": true, + "internalType": "GameType", + "name": "gameType", + "type": "uint32" + }, + { + "indexed": false, + "internalType": "bytes", + "name": "args", + "type": "bytes" + } + ], + "name": "ImplementationArgsSet", + "type": "event" + }, { "anonymous": false, "inputs": [ diff --git a/packages/contracts-bedrock/snapshots/abi/FaultDisputeGame.json b/packages/contracts-bedrock/snapshots/abi/FaultDisputeGame.json index e19ce9e2812..26a1351d53d 100644 --- a/packages/contracts-bedrock/snapshots/abi/FaultDisputeGame.json +++ b/packages/contracts-bedrock/snapshots/abi/FaultDisputeGame.json @@ -1016,6 +1016,11 @@ "name": "AnchorRootNotFound", "type": "error" }, + { + "inputs": [], + "name": "BadExtraData", + "type": "error" + }, { "inputs": [], "name": "BlockNumberMatches", diff --git a/packages/contracts-bedrock/snapshots/abi/FaultDisputeGameV2.json b/packages/contracts-bedrock/snapshots/abi/FaultDisputeGameV2.json new file mode 100644 index 00000000000..d4a4f83892a --- /dev/null +++ b/packages/contracts-bedrock/snapshots/abi/FaultDisputeGameV2.json @@ -0,0 +1,1195 @@ +[ + { + "inputs": [ + { + "components": [ + { + "internalType": "GameType", + "name": "gameType", + "type": "uint32" + }, + { + "internalType": "uint256", + "name": "maxGameDepth", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "splitDepth", + "type": "uint256" + }, + { + "internalType": "Duration", + "name": "clockExtension", + "type": "uint64" + }, + { + "internalType": "Duration", + "name": "maxClockDuration", + "type": "uint64" + } + ], + "internalType": "struct FaultDisputeGameV2.GameConstructorParams", + "name": "_params", + "type": "tuple" + } + ], + "stateMutability": "nonpayable", + "type": "constructor" + }, + { + "inputs": [], + "name": "absolutePrestate", + "outputs": [ + { + "internalType": "Claim", + "name": "absolutePrestate_", + "type": "bytes32" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "_ident", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "_execLeafIdx", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "_partOffset", + "type": "uint256" + } + ], + "name": "addLocalData", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [], + "name": "anchorStateRegistry", + "outputs": [ + { + "internalType": "contract IAnchorStateRegistry", + "name": "registry_", + "type": "address" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "Claim", + "name": "_disputed", + "type": "bytes32" + }, + { + "internalType": "uint256", + "name": "_parentIndex", + "type": "uint256" + }, + { + "internalType": "Claim", + "name": "_claim", + "type": "bytes32" + } + ], + "name": "attack", + "outputs": [], + "stateMutability": "payable", + "type": "function" + }, + { + "inputs": [], + "name": "bondDistributionMode", + "outputs": [ + { + "internalType": "enum BondDistributionMode", + "name": "", + "type": "uint8" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "components": [ + { + "internalType": "bytes32", + "name": "version", + "type": "bytes32" + }, + { + "internalType": "bytes32", + "name": "stateRoot", + "type": "bytes32" + }, + { + "internalType": "bytes32", + "name": "messagePasserStorageRoot", + "type": "bytes32" + }, + { + "internalType": "bytes32", + "name": "latestBlockhash", + "type": "bytes32" + } + ], + "internalType": "struct Types.OutputRootProof", + "name": "_outputRootProof", + "type": "tuple" + }, + { + "internalType": "bytes", + "name": "_headerRLP", + "type": "bytes" + } + ], + "name": "challengeRootL2Block", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "address", + "name": "_recipient", + "type": "address" + } + ], + "name": "claimCredit", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "name": "claimData", + "outputs": [ + { + "internalType": "uint32", + "name": "parentIndex", + "type": "uint32" + }, + { + "internalType": "address", + "name": "counteredBy", + "type": "address" + }, + { + "internalType": "address", + "name": "claimant", + "type": "address" + }, + { + "internalType": "uint128", + "name": "bond", + "type": "uint128" + }, + { + "internalType": "Claim", + "name": "claim", + "type": "bytes32" + }, + { + "internalType": "Position", + "name": "position", + "type": "uint128" + }, + { + "internalType": "Clock", + "name": "clock", + "type": "uint128" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "claimDataLen", + "outputs": [ + { + "internalType": "uint256", + "name": "len_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "Hash", + "name": "", + "type": "bytes32" + } + ], + "name": "claims", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "clockExtension", + "outputs": [ + { + "internalType": "Duration", + "name": "clockExtension_", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "closeGame", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [], + "name": "createdAt", + "outputs": [ + { + "internalType": "Timestamp", + "name": "", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "address", + "name": "_recipient", + "type": "address" + } + ], + "name": "credit", + "outputs": [ + { + "internalType": "uint256", + "name": "credit_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "Claim", + "name": "_disputed", + "type": "bytes32" + }, + { + "internalType": "uint256", + "name": "_parentIndex", + "type": "uint256" + }, + { + "internalType": "Claim", + "name": "_claim", + "type": "bytes32" + } + ], + "name": "defend", + "outputs": [], + "stateMutability": "payable", + "type": "function" + }, + { + "inputs": [], + "name": "extraData", + "outputs": [ + { + "internalType": "bytes", + "name": "extraData_", + "type": "bytes" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "gameCreator", + "outputs": [ + { + "internalType": "address", + "name": "creator_", + "type": "address" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "gameData", + "outputs": [ + { + "internalType": "GameType", + "name": "gameType_", + "type": "uint32" + }, + { + "internalType": "Claim", + "name": "rootClaim_", + "type": "bytes32" + }, + { + "internalType": "bytes", + "name": "extraData_", + "type": "bytes" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "gameType", + "outputs": [ + { + "internalType": "GameType", + "name": "gameType_", + "type": "uint32" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "_claimIndex", + "type": "uint256" + } + ], + "name": "getChallengerDuration", + "outputs": [ + { + "internalType": "Duration", + "name": "duration_", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "_claimIndex", + "type": "uint256" + } + ], + "name": "getNumToResolve", + "outputs": [ + { + "internalType": "uint256", + "name": "numRemainingChildren_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "Position", + "name": "_position", + "type": "uint128" + } + ], + "name": "getRequiredBond", + "outputs": [ + { + "internalType": "uint256", + "name": "requiredBond_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "name": "hasUnlockedCredit", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "initialize", + "outputs": [], + "stateMutability": "payable", + "type": "function" + }, + { + "inputs": [], + "name": "l1Head", + "outputs": [ + { + "internalType": "Hash", + "name": "l1Head_", + "type": "bytes32" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "l2BlockNumber", + "outputs": [ + { + "internalType": "uint256", + "name": "l2BlockNumber_", + "type": "uint256" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "l2BlockNumberChallenged", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "l2BlockNumberChallenger", + "outputs": [ + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "l2ChainId", + "outputs": [ + { + "internalType": "uint256", + "name": "l2ChainId_", + "type": "uint256" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "l2SequenceNumber", + "outputs": [ + { + "internalType": "uint256", + "name": "l2SequenceNumber_", + "type": "uint256" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "maxClockDuration", + "outputs": [ + { + "internalType": "Duration", + "name": "maxClockDuration_", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "maxGameDepth", + "outputs": [ + { + "internalType": "uint256", + "name": "maxGameDepth_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "Claim", + "name": "_disputed", + "type": "bytes32" + }, + { + "internalType": "uint256", + "name": "_challengeIndex", + "type": "uint256" + }, + { + "internalType": "Claim", + "name": "_claim", + "type": "bytes32" + }, + { + "internalType": "bool", + "name": "_isAttack", + "type": "bool" + } + ], + "name": "move", + "outputs": [], + "stateMutability": "payable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "name": "normalModeCredit", + "outputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "name": "refundModeCredit", + "outputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "name": "resolutionCheckpoints", + "outputs": [ + { + "internalType": "bool", + "name": "initialCheckpointComplete", + "type": "bool" + }, + { + "internalType": "uint32", + "name": "subgameIndex", + "type": "uint32" + }, + { + "internalType": "Position", + "name": "leftmostPosition", + "type": "uint128" + }, + { + "internalType": "address", + "name": "counteredBy", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "resolve", + "outputs": [ + { + "internalType": "enum GameStatus", + "name": "status_", + "type": "uint8" + } + ], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "_claimIndex", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "_numToResolve", + "type": "uint256" + } + ], + "name": "resolveClaim", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [], + "name": "resolvedAt", + "outputs": [ + { + "internalType": "Timestamp", + "name": "", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "name": "resolvedSubgames", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "rootClaim", + "outputs": [ + { + "internalType": "Claim", + "name": "rootClaim_", + "type": "bytes32" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "splitDepth", + "outputs": [ + { + "internalType": "uint256", + "name": "splitDepth_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "startingBlockNumber", + "outputs": [ + { + "internalType": "uint256", + "name": "startingBlockNumber_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "startingOutputRoot", + "outputs": [ + { + "internalType": "Hash", + "name": "root", + "type": "bytes32" + }, + { + "internalType": "uint256", + "name": "l2SequenceNumber", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "startingRootHash", + "outputs": [ + { + "internalType": "Hash", + "name": "startingRootHash_", + "type": "bytes32" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "status", + "outputs": [ + { + "internalType": "enum GameStatus", + "name": "", + "type": "uint8" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "_claimIndex", + "type": "uint256" + }, + { + "internalType": "bool", + "name": "_isAttack", + "type": "bool" + }, + { + "internalType": "bytes", + "name": "_stateData", + "type": "bytes" + }, + { + "internalType": "bytes", + "name": "_proof", + "type": "bytes" + } + ], + "name": "step", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "name": "subgames", + "outputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "version", + "outputs": [ + { + "internalType": "string", + "name": "", + "type": "string" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "vm", + "outputs": [ + { + "internalType": "contract IBigStepper", + "name": "vm_", + "type": "address" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "wasRespectedGameTypeWhenCreated", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "weth", + "outputs": [ + { + "internalType": "contract IDelayedWETH", + "name": "weth_", + "type": "address" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": false, + "internalType": "enum BondDistributionMode", + "name": "bondDistributionMode", + "type": "uint8" + } + ], + "name": "GameClosed", + "type": "event" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": true, + "internalType": "uint256", + "name": "parentIndex", + "type": "uint256" + }, + { + "indexed": true, + "internalType": "Claim", + "name": "claim", + "type": "bytes32" + }, + { + "indexed": true, + "internalType": "address", + "name": "claimant", + "type": "address" + } + ], + "name": "Move", + "type": "event" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": true, + "internalType": "enum GameStatus", + "name": "status", + "type": "uint8" + } + ], + "name": "Resolved", + "type": "event" + }, + { + "inputs": [], + "name": "AlreadyInitialized", + "type": "error" + }, + { + "inputs": [], + "name": "AnchorRootNotFound", + "type": "error" + }, + { + "inputs": [], + "name": "BadExtraData", + "type": "error" + }, + { + "inputs": [], + "name": "BlockNumberMatches", + "type": "error" + }, + { + "inputs": [], + "name": "BondTransferFailed", + "type": "error" + }, + { + "inputs": [], + "name": "CannotDefendRootClaim", + "type": "error" + }, + { + "inputs": [], + "name": "ClaimAboveSplit", + "type": "error" + }, + { + "inputs": [], + "name": "ClaimAlreadyExists", + "type": "error" + }, + { + "inputs": [], + "name": "ClaimAlreadyResolved", + "type": "error" + }, + { + "inputs": [], + "name": "ClockNotExpired", + "type": "error" + }, + { + "inputs": [], + "name": "ClockTimeExceeded", + "type": "error" + }, + { + "inputs": [], + "name": "ContentLengthMismatch", + "type": "error" + }, + { + "inputs": [], + "name": "DuplicateStep", + "type": "error" + }, + { + "inputs": [], + "name": "EmptyItem", + "type": "error" + }, + { + "inputs": [], + "name": "GameDepthExceeded", + "type": "error" + }, + { + "inputs": [], + "name": "GameNotFinalized", + "type": "error" + }, + { + "inputs": [], + "name": "GameNotInProgress", + "type": "error" + }, + { + "inputs": [], + "name": "GameNotResolved", + "type": "error" + }, + { + "inputs": [], + "name": "GamePaused", + "type": "error" + }, + { + "inputs": [], + "name": "IncorrectBondAmount", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidBondDistributionMode", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidChallengePeriod", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidClockExtension", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidDataRemainder", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidDisputedClaimIndex", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidHeader", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidHeaderRLP", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidLocalIdent", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidOutputRootProof", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidParent", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidPrestate", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidSplitDepth", + "type": "error" + }, + { + "inputs": [], + "name": "L2BlockNumberChallenged", + "type": "error" + }, + { + "inputs": [], + "name": "MaxDepthTooLarge", + "type": "error" + }, + { + "inputs": [], + "name": "NoCreditToClaim", + "type": "error" + }, + { + "inputs": [], + "name": "OutOfOrderResolution", + "type": "error" + }, + { + "inputs": [], + "name": "ReservedGameType", + "type": "error" + }, + { + "inputs": [], + "name": "UnexpectedList", + "type": "error" + }, + { + "inputs": [ + { + "internalType": "Claim", + "name": "rootClaim", + "type": "bytes32" + } + ], + "name": "UnexpectedRootClaim", + "type": "error" + }, + { + "inputs": [], + "name": "UnexpectedString", + "type": "error" + }, + { + "inputs": [], + "name": "ValidStep", + "type": "error" + } +] \ No newline at end of file diff --git a/packages/contracts-bedrock/snapshots/abi/GameHelper.json b/packages/contracts-bedrock/snapshots/abi/GameHelper.json new file mode 100644 index 00000000000..f44f1598a20 --- /dev/null +++ b/packages/contracts-bedrock/snapshots/abi/GameHelper.json @@ -0,0 +1,97 @@ +[ + { + "stateMutability": "payable", + "type": "receive" + }, + { + "inputs": [ + { + "internalType": "contract IDisputeGameFactory", + "name": "_dgf", + "type": "address" + }, + { + "internalType": "GameType", + "name": "_gameType", + "type": "uint32" + }, + { + "internalType": "Claim", + "name": "_rootClaim", + "type": "bytes32" + }, + { + "internalType": "bytes", + "name": "_extraData", + "type": "bytes" + }, + { + "components": [ + { + "internalType": "uint256", + "name": "parentIdx", + "type": "uint256" + }, + { + "internalType": "Claim", + "name": "claim", + "type": "bytes32" + }, + { + "internalType": "bool", + "name": "attack", + "type": "bool" + } + ], + "internalType": "struct GameHelper.Move[]", + "name": "_moves", + "type": "tuple[]" + } + ], + "name": "createGameWithClaims", + "outputs": [ + { + "internalType": "address", + "name": "gameAddr_", + "type": "address" + } + ], + "stateMutability": "payable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "contract IFaultDisputeGame", + "name": "_game", + "type": "address" + }, + { + "components": [ + { + "internalType": "uint256", + "name": "parentIdx", + "type": "uint256" + }, + { + "internalType": "Claim", + "name": "claim", + "type": "bytes32" + }, + { + "internalType": "bool", + "name": "attack", + "type": "bool" + } + ], + "internalType": "struct GameHelper.Move[]", + "name": "_moves", + "type": "tuple[]" + } + ], + "name": "performMoves", + "outputs": [], + "stateMutability": "payable", + "type": "function" + } +] \ No newline at end of file diff --git a/packages/contracts-bedrock/snapshots/abi/L1CrossDomainMessenger.json b/packages/contracts-bedrock/snapshots/abi/L1CrossDomainMessenger.json index 487c45491aa..bc0174b42fa 100644 --- a/packages/contracts-bedrock/snapshots/abi/L1CrossDomainMessenger.json +++ b/packages/contracts-bedrock/snapshots/abi/L1CrossDomainMessenger.json @@ -431,19 +431,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [ - { - "internalType": "contract ISystemConfig", - "name": "_systemConfig", - "type": "address" - } - ], - "name": "upgrade", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, { "inputs": [], "name": "version", diff --git a/packages/contracts-bedrock/snapshots/abi/L1ERC721Bridge.json b/packages/contracts-bedrock/snapshots/abi/L1ERC721Bridge.json index 7783e2b38ee..7b83c924650 100644 --- a/packages/contracts-bedrock/snapshots/abi/L1ERC721Bridge.json +++ b/packages/contracts-bedrock/snapshots/abi/L1ERC721Bridge.json @@ -290,19 +290,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [ - { - "internalType": "contract ISystemConfig", - "name": "_systemConfig", - "type": "address" - } - ], - "name": "upgrade", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, { "inputs": [], "name": "version", diff --git a/packages/contracts-bedrock/snapshots/abi/L1StandardBridge.json b/packages/contracts-bedrock/snapshots/abi/L1StandardBridge.json index 259a0a21bdf..78752f602e8 100644 --- a/packages/contracts-bedrock/snapshots/abi/L1StandardBridge.json +++ b/packages/contracts-bedrock/snapshots/abi/L1StandardBridge.json @@ -549,19 +549,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [ - { - "internalType": "contract ISystemConfig", - "name": "_systemConfig", - "type": "address" - } - ], - "name": "upgrade", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, { "inputs": [], "name": "version", diff --git a/packages/contracts-bedrock/snapshots/abi/OPContractsManager.json b/packages/contracts-bedrock/snapshots/abi/OPContractsManager.json index d7d8a6551ec..f4ef1718aa4 100644 --- a/packages/contracts-bedrock/snapshots/abi/OPContractsManager.json +++ b/packages/contracts-bedrock/snapshots/abi/OPContractsManager.json @@ -442,6 +442,19 @@ "stateMutability": "nonpayable", "type": "function" }, + { + "inputs": [], + "name": "devFeatureBitmap", + "outputs": [ + { + "internalType": "bytes32", + "name": "", + "type": "bytes32" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [], "name": "implementations", @@ -468,6 +481,11 @@ "name": "optimismPortalImpl", "type": "address" }, + { + "internalType": "address", + "name": "optimismPortalInteropImpl", + "type": "address" + }, { "internalType": "address", "name": "ethLockboxImpl", @@ -522,6 +540,25 @@ "stateMutability": "view", "type": "function" }, + { + "inputs": [ + { + "internalType": "bytes32", + "name": "_feature", + "type": "bytes32" + } + ], + "name": "isDevFeatureEnabled", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [ { @@ -800,6 +837,24 @@ "stateMutability": "view", "type": "function" }, + { + "inputs": [ + { + "internalType": "contract ISuperchainConfig", + "name": "_superchainConfig", + "type": "address" + }, + { + "internalType": "contract IProxyAdmin", + "name": "_superchainProxyAdmin", + "type": "address" + } + ], + "name": "upgradeSuperchainConfig", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, { "inputs": [ { diff --git a/packages/contracts-bedrock/snapshots/abi/OPContractsManagerContractsContainer.json b/packages/contracts-bedrock/snapshots/abi/OPContractsManagerContractsContainer.json index c1383b7dd77..c49484fc722 100644 --- a/packages/contracts-bedrock/snapshots/abi/OPContractsManagerContractsContainer.json +++ b/packages/contracts-bedrock/snapshots/abi/OPContractsManagerContractsContainer.json @@ -95,6 +95,11 @@ "name": "optimismPortalImpl", "type": "address" }, + { + "internalType": "address", + "name": "optimismPortalInteropImpl", + "type": "address" + }, { "internalType": "address", "name": "ethLockboxImpl", @@ -144,11 +149,29 @@ "internalType": "struct OPContractsManager.Implementations", "name": "_implementations", "type": "tuple" + }, + { + "internalType": "bytes32", + "name": "_devFeatureBitmap", + "type": "bytes32" } ], "stateMutability": "nonpayable", "type": "constructor" }, + { + "inputs": [], + "name": "_isTestingEnvironment", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [], "name": "blueprints", @@ -229,6 +252,19 @@ "stateMutability": "view", "type": "function" }, + { + "inputs": [], + "name": "devFeatureBitmap", + "outputs": [ + { + "internalType": "bytes32", + "name": "", + "type": "bytes32" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [], "name": "implementations", @@ -255,6 +291,11 @@ "name": "optimismPortalImpl", "type": "address" }, + { + "internalType": "address", + "name": "optimismPortalInteropImpl", + "type": "address" + }, { "internalType": "address", "name": "ethLockboxImpl", @@ -308,5 +349,29 @@ ], "stateMutability": "view", "type": "function" + }, + { + "inputs": [ + { + "internalType": "bytes32", + "name": "_feature", + "type": "bytes32" + } + ], + "name": "isDevFeatureEnabled", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "OPContractsManagerContractsContainer_DevFeatureInProd", + "type": "error" } ] \ No newline at end of file diff --git a/packages/contracts-bedrock/snapshots/abi/OPContractsManagerDeployer.json b/packages/contracts-bedrock/snapshots/abi/OPContractsManagerDeployer.json index 81fd1cef7bb..7cd7a44502c 100644 --- a/packages/contracts-bedrock/snapshots/abi/OPContractsManagerDeployer.json +++ b/packages/contracts-bedrock/snapshots/abi/OPContractsManagerDeployer.json @@ -340,6 +340,19 @@ "stateMutability": "nonpayable", "type": "function" }, + { + "inputs": [], + "name": "devFeatureBitmap", + "outputs": [ + { + "internalType": "bytes32", + "name": "", + "type": "bytes32" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [], "name": "implementations", @@ -366,6 +379,11 @@ "name": "optimismPortalImpl", "type": "address" }, + { + "internalType": "address", + "name": "optimismPortalInteropImpl", + "type": "address" + }, { "internalType": "address", "name": "ethLockboxImpl", @@ -420,6 +438,25 @@ "stateMutability": "view", "type": "function" }, + { + "inputs": [ + { + "internalType": "bytes32", + "name": "_feature", + "type": "bytes32" + } + ], + "name": "isDevFeatureEnabled", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, { "anonymous": false, "inputs": [ diff --git a/packages/contracts-bedrock/snapshots/abi/OPContractsManagerGameTypeAdder.json b/packages/contracts-bedrock/snapshots/abi/OPContractsManagerGameTypeAdder.json index bcce3c57dae..80b80512aeb 100644 --- a/packages/contracts-bedrock/snapshots/abi/OPContractsManagerGameTypeAdder.json +++ b/packages/contracts-bedrock/snapshots/abi/OPContractsManagerGameTypeAdder.json @@ -233,6 +233,19 @@ "stateMutability": "view", "type": "function" }, + { + "inputs": [], + "name": "devFeatureBitmap", + "outputs": [ + { + "internalType": "bytes32", + "name": "", + "type": "bytes32" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [], "name": "implementations", @@ -259,6 +272,11 @@ "name": "optimismPortalImpl", "type": "address" }, + { + "internalType": "address", + "name": "optimismPortalInteropImpl", + "type": "address" + }, { "internalType": "address", "name": "ethLockboxImpl", @@ -313,6 +331,25 @@ "stateMutability": "view", "type": "function" }, + { + "inputs": [ + { + "internalType": "bytes32", + "name": "_feature", + "type": "bytes32" + } + ], + "name": "isDevFeatureEnabled", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [ { diff --git a/packages/contracts-bedrock/snapshots/abi/OPContractsManagerInteropMigrator.json b/packages/contracts-bedrock/snapshots/abi/OPContractsManagerInteropMigrator.json index be5788a9022..b06cd541bb3 100644 --- a/packages/contracts-bedrock/snapshots/abi/OPContractsManagerInteropMigrator.json +++ b/packages/contracts-bedrock/snapshots/abi/OPContractsManagerInteropMigrator.json @@ -135,6 +135,19 @@ "stateMutability": "view", "type": "function" }, + { + "inputs": [], + "name": "devFeatureBitmap", + "outputs": [ + { + "internalType": "bytes32", + "name": "", + "type": "bytes32" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [], "name": "implementations", @@ -161,6 +174,11 @@ "name": "optimismPortalImpl", "type": "address" }, + { + "internalType": "address", + "name": "optimismPortalInteropImpl", + "type": "address" + }, { "internalType": "address", "name": "ethLockboxImpl", @@ -215,6 +233,25 @@ "stateMutability": "view", "type": "function" }, + { + "inputs": [ + { + "internalType": "bytes32", + "name": "_feature", + "type": "bytes32" + } + ], + "name": "isDevFeatureEnabled", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [ { diff --git a/packages/contracts-bedrock/snapshots/abi/OPContractsManagerStandardValidator.json b/packages/contracts-bedrock/snapshots/abi/OPContractsManagerStandardValidator.json index f58f77eb2b9..7ec9ab0bc71 100644 --- a/packages/contracts-bedrock/snapshots/abi/OPContractsManagerStandardValidator.json +++ b/packages/contracts-bedrock/snapshots/abi/OPContractsManagerStandardValidator.json @@ -13,6 +13,11 @@ "name": "optimismPortalImpl", "type": "address" }, + { + "internalType": "address", + "name": "optimismPortalInteropImpl", + "type": "address" + }, { "internalType": "address", "name": "ethLockboxImpl", @@ -82,6 +87,11 @@ "internalType": "uint256", "name": "_withdrawalDelaySeconds", "type": "uint256" + }, + { + "internalType": "bytes32", + "name": "_devFeatureBitmap", + "type": "bytes32" } ], "stateMutability": "nonpayable", @@ -100,19 +110,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [], - "name": "anchorStateRegistryVersion", - "outputs": [ - { - "internalType": "string", - "name": "", - "type": "string" - } - ], - "stateMutability": "pure", - "type": "function" - }, { "inputs": [], "name": "challenger", @@ -141,15 +138,15 @@ }, { "inputs": [], - "name": "delayedWETHVersion", + "name": "devFeatureBitmap", "outputs": [ { - "internalType": "string", + "internalType": "bytes32", "name": "", - "type": "string" + "type": "bytes32" } ], - "stateMutability": "pure", + "stateMutability": "view", "type": "function" }, { @@ -165,19 +162,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [], - "name": "disputeGameFactoryVersion", - "outputs": [ - { - "internalType": "string", - "name": "", - "type": "string" - } - ], - "stateMutability": "pure", - "type": "function" - }, { "inputs": [], "name": "ethLockboxImpl", @@ -191,19 +175,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [], - "name": "ethLockboxVersion", - "outputs": [ - { - "internalType": "string", - "name": "", - "type": "string" - } - ], - "stateMutability": "pure", - "type": "function" - }, { "inputs": [], "name": "l1CrossDomainMessengerImpl", @@ -217,19 +188,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [], - "name": "l1CrossDomainMessengerVersion", - "outputs": [ - { - "internalType": "string", - "name": "", - "type": "string" - } - ], - "stateMutability": "pure", - "type": "function" - }, { "inputs": [], "name": "l1ERC721BridgeImpl", @@ -243,19 +201,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [], - "name": "l1ERC721BridgeVersion", - "outputs": [ - { - "internalType": "string", - "name": "", - "type": "string" - } - ], - "stateMutability": "pure", - "type": "function" - }, { "inputs": [], "name": "l1PAOMultisig", @@ -282,19 +227,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [], - "name": "l1StandardBridgeVersion", - "outputs": [ - { - "internalType": "string", - "name": "", - "type": "string" - } - ], - "stateMutability": "pure", - "type": "function" - }, { "inputs": [], "name": "mipsImpl", @@ -308,19 +240,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [], - "name": "mipsVersion", - "outputs": [ - { - "internalType": "string", - "name": "", - "type": "string" - } - ], - "stateMutability": "pure", - "type": "function" - }, { "inputs": [], "name": "optimismMintableERC20FactoryImpl", @@ -334,19 +253,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [], - "name": "optimismMintableERC20FactoryVersion", - "outputs": [ - { - "internalType": "string", - "name": "", - "type": "string" - } - ], - "stateMutability": "pure", - "type": "function" - }, { "inputs": [], "name": "optimismPortalImpl", @@ -362,15 +268,15 @@ }, { "inputs": [], - "name": "optimismPortalVersion", + "name": "optimismPortalInteropImpl", "outputs": [ { - "internalType": "string", + "internalType": "address", "name": "", - "type": "string" + "type": "address" } ], - "stateMutability": "pure", + "stateMutability": "view", "type": "function" }, { @@ -425,19 +331,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [], - "name": "systemConfigVersion", - "outputs": [ - { - "internalType": "string", - "name": "", - "type": "string" - } - ], - "stateMutability": "pure", - "type": "function" - }, { "inputs": [ { diff --git a/packages/contracts-bedrock/snapshots/abi/OPContractsManagerUpgrader.json b/packages/contracts-bedrock/snapshots/abi/OPContractsManagerUpgrader.json index f6c3e32692d..512a83ae75c 100644 --- a/packages/contracts-bedrock/snapshots/abi/OPContractsManagerUpgrader.json +++ b/packages/contracts-bedrock/snapshots/abi/OPContractsManagerUpgrader.json @@ -135,6 +135,19 @@ "stateMutability": "view", "type": "function" }, + { + "inputs": [], + "name": "devFeatureBitmap", + "outputs": [ + { + "internalType": "bytes32", + "name": "", + "type": "bytes32" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [], "name": "implementations", @@ -161,6 +174,11 @@ "name": "optimismPortalImpl", "type": "address" }, + { + "internalType": "address", + "name": "optimismPortalInteropImpl", + "type": "address" + }, { "internalType": "address", "name": "ethLockboxImpl", @@ -218,15 +236,24 @@ { "inputs": [ { - "internalType": "contract ISuperchainConfig", - "name": "_superchainConfig", - "type": "address" - }, + "internalType": "bytes32", + "name": "_feature", + "type": "bytes32" + } + ], + "name": "isDevFeatureEnabled", + "outputs": [ { - "internalType": "contract IProxyAdmin", - "name": "_superchainProxyAdmin", - "type": "address" - }, + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ { "components": [ { @@ -255,6 +282,24 @@ "stateMutability": "nonpayable", "type": "function" }, + { + "inputs": [ + { + "internalType": "contract ISuperchainConfig", + "name": "_superchainConfig", + "type": "address" + }, + { + "internalType": "contract IProxyAdmin", + "name": "_superchainProxyAdmin", + "type": "address" + } + ], + "name": "upgradeSuperchainConfig", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, { "anonymous": false, "inputs": [ @@ -316,11 +361,27 @@ "name": "NotABlueprint", "type": "error" }, + { + "inputs": [], + "name": "OPContractsManagerUpgrader_SuperchainConfigAlreadyUpToDate", + "type": "error" + }, { "inputs": [], "name": "OPContractsManagerUpgrader_SuperchainConfigMismatch", "type": "error" }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "index", + "type": "uint256" + } + ], + "name": "OPContractsManagerUpgrader_SuperchainConfigNeedsUpgrade", + "type": "error" + }, { "inputs": [], "name": "OPContractsManager_InvalidGameType", @@ -336,6 +397,11 @@ "name": "ReservedBitsSet", "type": "error" }, + { + "inputs": [], + "name": "SemverComp_InvalidSemverParts", + "type": "error" + }, { "inputs": [ { diff --git a/packages/contracts-bedrock/snapshots/abi/OptimismPortal2.json b/packages/contracts-bedrock/snapshots/abi/OptimismPortal2.json index 39d02adf5ec..49ae551310b 100644 --- a/packages/contracts-bedrock/snapshots/abi/OptimismPortal2.json +++ b/packages/contracts-bedrock/snapshots/abi/OptimismPortal2.json @@ -294,11 +294,6 @@ "internalType": "contract IAnchorStateRegistry", "name": "_anchorStateRegistry", "type": "address" - }, - { - "internalType": "contract IETHLockbox", - "name": "_ethLockbox", - "type": "address" } ], "name": "initialize", @@ -319,31 +314,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [], - "name": "migrateLiquidity", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, - { - "inputs": [ - { - "internalType": "contract IETHLockbox", - "name": "_newLockbox", - "type": "address" - }, - { - "internalType": "contract IAnchorStateRegistry", - "name": "_newAnchorStateRegistry", - "type": "address" - } - ], - "name": "migrateToSuperRoots", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, { "inputs": [ { @@ -537,127 +507,6 @@ "stateMutability": "nonpayable", "type": "function" }, - { - "inputs": [ - { - "components": [ - { - "internalType": "uint256", - "name": "nonce", - "type": "uint256" - }, - { - "internalType": "address", - "name": "sender", - "type": "address" - }, - { - "internalType": "address", - "name": "target", - "type": "address" - }, - { - "internalType": "uint256", - "name": "value", - "type": "uint256" - }, - { - "internalType": "uint256", - "name": "gasLimit", - "type": "uint256" - }, - { - "internalType": "bytes", - "name": "data", - "type": "bytes" - } - ], - "internalType": "struct Types.WithdrawalTransaction", - "name": "_tx", - "type": "tuple" - }, - { - "internalType": "contract IDisputeGame", - "name": "_disputeGameProxy", - "type": "address" - }, - { - "internalType": "uint256", - "name": "_outputRootIndex", - "type": "uint256" - }, - { - "components": [ - { - "internalType": "bytes1", - "name": "version", - "type": "bytes1" - }, - { - "internalType": "uint64", - "name": "timestamp", - "type": "uint64" - }, - { - "components": [ - { - "internalType": "uint256", - "name": "chainId", - "type": "uint256" - }, - { - "internalType": "bytes32", - "name": "root", - "type": "bytes32" - } - ], - "internalType": "struct Types.OutputRootWithChainId[]", - "name": "outputRoots", - "type": "tuple[]" - } - ], - "internalType": "struct Types.SuperRootProof", - "name": "_superRootProof", - "type": "tuple" - }, - { - "components": [ - { - "internalType": "bytes32", - "name": "version", - "type": "bytes32" - }, - { - "internalType": "bytes32", - "name": "stateRoot", - "type": "bytes32" - }, - { - "internalType": "bytes32", - "name": "messagePasserStorageRoot", - "type": "bytes32" - }, - { - "internalType": "bytes32", - "name": "latestBlockhash", - "type": "bytes32" - } - ], - "internalType": "struct Types.OutputRootProof", - "name": "_outputRootProof", - "type": "tuple" - }, - { - "internalType": "bytes[]", - "name": "_withdrawalProof", - "type": "bytes[]" - } - ], - "name": "proveWithdrawalTransaction", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, { "inputs": [ { @@ -739,19 +588,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [], - "name": "superRootsActive", - "outputs": [ - { - "internalType": "bool", - "name": "", - "type": "bool" - } - ], - "stateMutability": "view", - "type": "function" - }, { "inputs": [], "name": "superchainConfig", @@ -778,24 +614,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [ - { - "internalType": "contract IAnchorStateRegistry", - "name": "_anchorStateRegistry", - "type": "address" - }, - { - "internalType": "contract IETHLockbox", - "name": "_ethLockbox", - "type": "address" - } - ], - "name": "upgrade", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, { "inputs": [], "name": "version", @@ -809,25 +627,6 @@ "stateMutability": "pure", "type": "function" }, - { - "anonymous": false, - "inputs": [ - { - "indexed": true, - "internalType": "address", - "name": "lockbox", - "type": "address" - }, - { - "indexed": false, - "internalType": "uint256", - "name": "ethBalance", - "type": "uint256" - } - ], - "name": "ETHMigrated", - "type": "event" - }, { "anonymous": false, "inputs": [ @@ -841,37 +640,6 @@ "name": "Initialized", "type": "event" }, - { - "anonymous": false, - "inputs": [ - { - "indexed": false, - "internalType": "contract IETHLockbox", - "name": "oldLockbox", - "type": "address" - }, - { - "indexed": false, - "internalType": "contract IETHLockbox", - "name": "newLockbox", - "type": "address" - }, - { - "indexed": false, - "internalType": "contract IAnchorStateRegistry", - "name": "oldAnchorStateRegistry", - "type": "address" - }, - { - "indexed": false, - "internalType": "contract IAnchorStateRegistry", - "name": "newAnchorStateRegistry", - "type": "address" - } - ], - "name": "PortalMigrated", - "type": "event" - }, { "anonymous": false, "inputs": [ @@ -976,16 +744,6 @@ "name": "EmptyItem", "type": "error" }, - { - "inputs": [], - "name": "Encoding_EmptySuperRoot", - "type": "error" - }, - { - "inputs": [], - "name": "Encoding_InvalidSuperRootVersion", - "type": "error" - }, { "inputs": [], "name": "InvalidDataRemainder", @@ -1038,17 +796,12 @@ }, { "inputs": [], - "name": "OptimismPortal_InvalidMerkleProof", - "type": "error" - }, - { - "inputs": [], - "name": "OptimismPortal_InvalidOutputRootChainId", + "name": "OptimismPortal_InvalidLockboxState", "type": "error" }, { "inputs": [], - "name": "OptimismPortal_InvalidOutputRootIndex", + "name": "OptimismPortal_InvalidMerkleProof", "type": "error" }, { @@ -1066,16 +819,6 @@ "name": "OptimismPortal_InvalidRootClaim", "type": "error" }, - { - "inputs": [], - "name": "OptimismPortal_InvalidSuperRootProof", - "type": "error" - }, - { - "inputs": [], - "name": "OptimismPortal_MigratingToSameRegistry", - "type": "error" - }, { "inputs": [], "name": "OptimismPortal_NoReentrancy", @@ -1086,21 +829,11 @@ "name": "OptimismPortal_ProofNotOldEnough", "type": "error" }, - { - "inputs": [], - "name": "OptimismPortal_Unauthorized", - "type": "error" - }, { "inputs": [], "name": "OptimismPortal_Unproven", "type": "error" }, - { - "inputs": [], - "name": "OptimismPortal_WrongProofMethod", - "type": "error" - }, { "inputs": [], "name": "OutOfGas", diff --git a/packages/contracts-bedrock/snapshots/abi/OptimismPortalInterop.json b/packages/contracts-bedrock/snapshots/abi/OptimismPortalInterop.json new file mode 100644 index 00000000000..d01d85015e4 --- /dev/null +++ b/packages/contracts-bedrock/snapshots/abi/OptimismPortalInterop.json @@ -0,0 +1,1149 @@ +[ + { + "inputs": [ + { + "internalType": "uint256", + "name": "_proofMaturityDelaySeconds", + "type": "uint256" + } + ], + "stateMutability": "nonpayable", + "type": "constructor" + }, + { + "stateMutability": "payable", + "type": "receive" + }, + { + "inputs": [], + "name": "anchorStateRegistry", + "outputs": [ + { + "internalType": "contract IAnchorStateRegistry", + "name": "", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "bytes32", + "name": "_withdrawalHash", + "type": "bytes32" + }, + { + "internalType": "address", + "name": "_proofSubmitter", + "type": "address" + } + ], + "name": "checkWithdrawal", + "outputs": [], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "address", + "name": "_to", + "type": "address" + }, + { + "internalType": "uint256", + "name": "_value", + "type": "uint256" + }, + { + "internalType": "uint64", + "name": "_gasLimit", + "type": "uint64" + }, + { + "internalType": "bool", + "name": "_isCreation", + "type": "bool" + }, + { + "internalType": "bytes", + "name": "_data", + "type": "bytes" + } + ], + "name": "depositTransaction", + "outputs": [], + "stateMutability": "payable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "contract IDisputeGame", + "name": "_disputeGame", + "type": "address" + } + ], + "name": "disputeGameBlacklist", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "disputeGameFactory", + "outputs": [ + { + "internalType": "contract IDisputeGameFactory", + "name": "", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "disputeGameFinalityDelaySeconds", + "outputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "donateETH", + "outputs": [], + "stateMutability": "payable", + "type": "function" + }, + { + "inputs": [], + "name": "ethLockbox", + "outputs": [ + { + "internalType": "contract IETHLockbox", + "name": "", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "components": [ + { + "internalType": "uint256", + "name": "nonce", + "type": "uint256" + }, + { + "internalType": "address", + "name": "sender", + "type": "address" + }, + { + "internalType": "address", + "name": "target", + "type": "address" + }, + { + "internalType": "uint256", + "name": "value", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "gasLimit", + "type": "uint256" + }, + { + "internalType": "bytes", + "name": "data", + "type": "bytes" + } + ], + "internalType": "struct Types.WithdrawalTransaction", + "name": "_tx", + "type": "tuple" + } + ], + "name": "finalizeWithdrawalTransaction", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "components": [ + { + "internalType": "uint256", + "name": "nonce", + "type": "uint256" + }, + { + "internalType": "address", + "name": "sender", + "type": "address" + }, + { + "internalType": "address", + "name": "target", + "type": "address" + }, + { + "internalType": "uint256", + "name": "value", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "gasLimit", + "type": "uint256" + }, + { + "internalType": "bytes", + "name": "data", + "type": "bytes" + } + ], + "internalType": "struct Types.WithdrawalTransaction", + "name": "_tx", + "type": "tuple" + }, + { + "internalType": "address", + "name": "_proofSubmitter", + "type": "address" + } + ], + "name": "finalizeWithdrawalTransactionExternalProof", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "bytes32", + "name": "", + "type": "bytes32" + } + ], + "name": "finalizedWithdrawals", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "guardian", + "outputs": [ + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "initVersion", + "outputs": [ + { + "internalType": "uint8", + "name": "", + "type": "uint8" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "contract ISystemConfig", + "name": "_systemConfig", + "type": "address" + }, + { + "internalType": "contract IAnchorStateRegistry", + "name": "_anchorStateRegistry", + "type": "address" + }, + { + "internalType": "contract IETHLockbox", + "name": "_ethLockbox", + "type": "address" + } + ], + "name": "initialize", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [], + "name": "l2Sender", + "outputs": [ + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "migrateLiquidity", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "contract IETHLockbox", + "name": "_newLockbox", + "type": "address" + }, + { + "internalType": "contract IAnchorStateRegistry", + "name": "_newAnchorStateRegistry", + "type": "address" + } + ], + "name": "migrateToSuperRoots", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint64", + "name": "_byteCount", + "type": "uint64" + } + ], + "name": "minimumGasLimit", + "outputs": [ + { + "internalType": "uint64", + "name": "", + "type": "uint64" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "bytes32", + "name": "_withdrawalHash", + "type": "bytes32" + } + ], + "name": "numProofSubmitters", + "outputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "params", + "outputs": [ + { + "internalType": "uint128", + "name": "prevBaseFee", + "type": "uint128" + }, + { + "internalType": "uint64", + "name": "prevBoughtGas", + "type": "uint64" + }, + { + "internalType": "uint64", + "name": "prevBlockNum", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "paused", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "proofMaturityDelaySeconds", + "outputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "bytes32", + "name": "", + "type": "bytes32" + }, + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "name": "proofSubmitters", + "outputs": [ + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "components": [ + { + "internalType": "uint256", + "name": "nonce", + "type": "uint256" + }, + { + "internalType": "address", + "name": "sender", + "type": "address" + }, + { + "internalType": "address", + "name": "target", + "type": "address" + }, + { + "internalType": "uint256", + "name": "value", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "gasLimit", + "type": "uint256" + }, + { + "internalType": "bytes", + "name": "data", + "type": "bytes" + } + ], + "internalType": "struct Types.WithdrawalTransaction", + "name": "_tx", + "type": "tuple" + }, + { + "internalType": "uint256", + "name": "_disputeGameIndex", + "type": "uint256" + }, + { + "components": [ + { + "internalType": "bytes32", + "name": "version", + "type": "bytes32" + }, + { + "internalType": "bytes32", + "name": "stateRoot", + "type": "bytes32" + }, + { + "internalType": "bytes32", + "name": "messagePasserStorageRoot", + "type": "bytes32" + }, + { + "internalType": "bytes32", + "name": "latestBlockhash", + "type": "bytes32" + } + ], + "internalType": "struct Types.OutputRootProof", + "name": "_outputRootProof", + "type": "tuple" + }, + { + "internalType": "bytes[]", + "name": "_withdrawalProof", + "type": "bytes[]" + } + ], + "name": "proveWithdrawalTransaction", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "components": [ + { + "internalType": "uint256", + "name": "nonce", + "type": "uint256" + }, + { + "internalType": "address", + "name": "sender", + "type": "address" + }, + { + "internalType": "address", + "name": "target", + "type": "address" + }, + { + "internalType": "uint256", + "name": "value", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "gasLimit", + "type": "uint256" + }, + { + "internalType": "bytes", + "name": "data", + "type": "bytes" + } + ], + "internalType": "struct Types.WithdrawalTransaction", + "name": "_tx", + "type": "tuple" + }, + { + "internalType": "contract IDisputeGame", + "name": "_disputeGameProxy", + "type": "address" + }, + { + "internalType": "uint256", + "name": "_outputRootIndex", + "type": "uint256" + }, + { + "components": [ + { + "internalType": "bytes1", + "name": "version", + "type": "bytes1" + }, + { + "internalType": "uint64", + "name": "timestamp", + "type": "uint64" + }, + { + "components": [ + { + "internalType": "uint256", + "name": "chainId", + "type": "uint256" + }, + { + "internalType": "bytes32", + "name": "root", + "type": "bytes32" + } + ], + "internalType": "struct Types.OutputRootWithChainId[]", + "name": "outputRoots", + "type": "tuple[]" + } + ], + "internalType": "struct Types.SuperRootProof", + "name": "_superRootProof", + "type": "tuple" + }, + { + "components": [ + { + "internalType": "bytes32", + "name": "version", + "type": "bytes32" + }, + { + "internalType": "bytes32", + "name": "stateRoot", + "type": "bytes32" + }, + { + "internalType": "bytes32", + "name": "messagePasserStorageRoot", + "type": "bytes32" + }, + { + "internalType": "bytes32", + "name": "latestBlockhash", + "type": "bytes32" + } + ], + "internalType": "struct Types.OutputRootProof", + "name": "_outputRootProof", + "type": "tuple" + }, + { + "internalType": "bytes[]", + "name": "_withdrawalProof", + "type": "bytes[]" + } + ], + "name": "proveWithdrawalTransaction", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "bytes32", + "name": "", + "type": "bytes32" + }, + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "name": "provenWithdrawals", + "outputs": [ + { + "internalType": "contract IDisputeGame", + "name": "disputeGameProxy", + "type": "address" + }, + { + "internalType": "uint64", + "name": "timestamp", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "proxyAdmin", + "outputs": [ + { + "internalType": "contract IProxyAdmin", + "name": "", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "proxyAdminOwner", + "outputs": [ + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "respectedGameType", + "outputs": [ + { + "internalType": "GameType", + "name": "", + "type": "uint32" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "respectedGameTypeUpdatedAt", + "outputs": [ + { + "internalType": "uint64", + "name": "", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "superRootsActive", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "superchainConfig", + "outputs": [ + { + "internalType": "contract ISuperchainConfig", + "name": "", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "systemConfig", + "outputs": [ + { + "internalType": "contract ISystemConfig", + "name": "", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "contract IAnchorStateRegistry", + "name": "_anchorStateRegistry", + "type": "address" + }, + { + "internalType": "contract IETHLockbox", + "name": "_ethLockbox", + "type": "address" + } + ], + "name": "upgrade", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [], + "name": "version", + "outputs": [ + { + "internalType": "string", + "name": "", + "type": "string" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": true, + "internalType": "address", + "name": "lockbox", + "type": "address" + }, + { + "indexed": false, + "internalType": "uint256", + "name": "ethBalance", + "type": "uint256" + } + ], + "name": "ETHMigrated", + "type": "event" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": false, + "internalType": "uint8", + "name": "version", + "type": "uint8" + } + ], + "name": "Initialized", + "type": "event" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": false, + "internalType": "contract IETHLockbox", + "name": "oldLockbox", + "type": "address" + }, + { + "indexed": false, + "internalType": "contract IETHLockbox", + "name": "newLockbox", + "type": "address" + }, + { + "indexed": false, + "internalType": "contract IAnchorStateRegistry", + "name": "oldAnchorStateRegistry", + "type": "address" + }, + { + "indexed": false, + "internalType": "contract IAnchorStateRegistry", + "name": "newAnchorStateRegistry", + "type": "address" + } + ], + "name": "PortalMigrated", + "type": "event" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": true, + "internalType": "address", + "name": "from", + "type": "address" + }, + { + "indexed": true, + "internalType": "address", + "name": "to", + "type": "address" + }, + { + "indexed": true, + "internalType": "uint256", + "name": "version", + "type": "uint256" + }, + { + "indexed": false, + "internalType": "bytes", + "name": "opaqueData", + "type": "bytes" + } + ], + "name": "TransactionDeposited", + "type": "event" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": true, + "internalType": "bytes32", + "name": "withdrawalHash", + "type": "bytes32" + }, + { + "indexed": false, + "internalType": "bool", + "name": "success", + "type": "bool" + } + ], + "name": "WithdrawalFinalized", + "type": "event" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": true, + "internalType": "bytes32", + "name": "withdrawalHash", + "type": "bytes32" + }, + { + "indexed": true, + "internalType": "address", + "name": "from", + "type": "address" + }, + { + "indexed": true, + "internalType": "address", + "name": "to", + "type": "address" + } + ], + "name": "WithdrawalProven", + "type": "event" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": true, + "internalType": "bytes32", + "name": "withdrawalHash", + "type": "bytes32" + }, + { + "indexed": true, + "internalType": "address", + "name": "proofSubmitter", + "type": "address" + } + ], + "name": "WithdrawalProvenExtension1", + "type": "event" + }, + { + "inputs": [], + "name": "ContentLengthMismatch", + "type": "error" + }, + { + "inputs": [], + "name": "EmptyItem", + "type": "error" + }, + { + "inputs": [], + "name": "Encoding_EmptySuperRoot", + "type": "error" + }, + { + "inputs": [], + "name": "Encoding_InvalidSuperRootVersion", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidDataRemainder", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidHeader", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_AlreadyFinalized", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_BadTarget", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_CallPaused", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_CalldataTooLarge", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_GasEstimation", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_GasLimitTooLow", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_ImproperDisputeGame", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_InvalidDisputeGame", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_InvalidMerkleProof", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_InvalidOutputRootChainId", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_InvalidOutputRootIndex", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_InvalidOutputRootProof", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_InvalidProofTimestamp", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_InvalidRootClaim", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_InvalidSuperRootProof", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_MigratingToSameRegistry", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_NoReentrancy", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_ProofNotOldEnough", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_Unproven", + "type": "error" + }, + { + "inputs": [], + "name": "OptimismPortal_WrongProofMethod", + "type": "error" + }, + { + "inputs": [], + "name": "OutOfGas", + "type": "error" + }, + { + "inputs": [], + "name": "ProxyAdminOwnedBase_NotProxyAdmin", + "type": "error" + }, + { + "inputs": [], + "name": "ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner", + "type": "error" + }, + { + "inputs": [], + "name": "ProxyAdminOwnedBase_NotProxyAdminOwner", + "type": "error" + }, + { + "inputs": [], + "name": "ProxyAdminOwnedBase_NotResolvedDelegateProxy", + "type": "error" + }, + { + "inputs": [], + "name": "ProxyAdminOwnedBase_NotSharedProxyAdminOwner", + "type": "error" + }, + { + "inputs": [], + "name": "ProxyAdminOwnedBase_ProxyAdminNotFound", + "type": "error" + }, + { + "inputs": [], + "name": "ReinitializableBase_ZeroInitVersion", + "type": "error" + }, + { + "inputs": [], + "name": "UnexpectedList", + "type": "error" + }, + { + "inputs": [], + "name": "UnexpectedString", + "type": "error" + } +] \ No newline at end of file diff --git a/packages/contracts-bedrock/snapshots/abi/PermissionedDisputeGame.json b/packages/contracts-bedrock/snapshots/abi/PermissionedDisputeGame.json index 7548b6d3484..8bb88f46639 100644 --- a/packages/contracts-bedrock/snapshots/abi/PermissionedDisputeGame.json +++ b/packages/contracts-bedrock/snapshots/abi/PermissionedDisputeGame.json @@ -1057,6 +1057,11 @@ "name": "BadAuth", "type": "error" }, + { + "inputs": [], + "name": "BadExtraData", + "type": "error" + }, { "inputs": [], "name": "BlockNumberMatches", diff --git a/packages/contracts-bedrock/snapshots/abi/PermissionedDisputeGameV2.json b/packages/contracts-bedrock/snapshots/abi/PermissionedDisputeGameV2.json new file mode 100644 index 00000000000..6e0e7681c7f --- /dev/null +++ b/packages/contracts-bedrock/snapshots/abi/PermissionedDisputeGameV2.json @@ -0,0 +1,1236 @@ +[ + { + "inputs": [ + { + "components": [ + { + "internalType": "GameType", + "name": "gameType", + "type": "uint32" + }, + { + "internalType": "uint256", + "name": "maxGameDepth", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "splitDepth", + "type": "uint256" + }, + { + "internalType": "Duration", + "name": "clockExtension", + "type": "uint64" + }, + { + "internalType": "Duration", + "name": "maxClockDuration", + "type": "uint64" + } + ], + "internalType": "struct FaultDisputeGameV2.GameConstructorParams", + "name": "_params", + "type": "tuple" + }, + { + "internalType": "address", + "name": "_proposer", + "type": "address" + }, + { + "internalType": "address", + "name": "_challenger", + "type": "address" + } + ], + "stateMutability": "nonpayable", + "type": "constructor" + }, + { + "inputs": [], + "name": "absolutePrestate", + "outputs": [ + { + "internalType": "Claim", + "name": "absolutePrestate_", + "type": "bytes32" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "_ident", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "_execLeafIdx", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "_partOffset", + "type": "uint256" + } + ], + "name": "addLocalData", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [], + "name": "anchorStateRegistry", + "outputs": [ + { + "internalType": "contract IAnchorStateRegistry", + "name": "registry_", + "type": "address" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "Claim", + "name": "_disputed", + "type": "bytes32" + }, + { + "internalType": "uint256", + "name": "_parentIndex", + "type": "uint256" + }, + { + "internalType": "Claim", + "name": "_claim", + "type": "bytes32" + } + ], + "name": "attack", + "outputs": [], + "stateMutability": "payable", + "type": "function" + }, + { + "inputs": [], + "name": "bondDistributionMode", + "outputs": [ + { + "internalType": "enum BondDistributionMode", + "name": "", + "type": "uint8" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "components": [ + { + "internalType": "bytes32", + "name": "version", + "type": "bytes32" + }, + { + "internalType": "bytes32", + "name": "stateRoot", + "type": "bytes32" + }, + { + "internalType": "bytes32", + "name": "messagePasserStorageRoot", + "type": "bytes32" + }, + { + "internalType": "bytes32", + "name": "latestBlockhash", + "type": "bytes32" + } + ], + "internalType": "struct Types.OutputRootProof", + "name": "_outputRootProof", + "type": "tuple" + }, + { + "internalType": "bytes", + "name": "_headerRLP", + "type": "bytes" + } + ], + "name": "challengeRootL2Block", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [], + "name": "challenger", + "outputs": [ + { + "internalType": "address", + "name": "challenger_", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "address", + "name": "_recipient", + "type": "address" + } + ], + "name": "claimCredit", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "name": "claimData", + "outputs": [ + { + "internalType": "uint32", + "name": "parentIndex", + "type": "uint32" + }, + { + "internalType": "address", + "name": "counteredBy", + "type": "address" + }, + { + "internalType": "address", + "name": "claimant", + "type": "address" + }, + { + "internalType": "uint128", + "name": "bond", + "type": "uint128" + }, + { + "internalType": "Claim", + "name": "claim", + "type": "bytes32" + }, + { + "internalType": "Position", + "name": "position", + "type": "uint128" + }, + { + "internalType": "Clock", + "name": "clock", + "type": "uint128" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "claimDataLen", + "outputs": [ + { + "internalType": "uint256", + "name": "len_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "Hash", + "name": "", + "type": "bytes32" + } + ], + "name": "claims", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "clockExtension", + "outputs": [ + { + "internalType": "Duration", + "name": "clockExtension_", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "closeGame", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [], + "name": "createdAt", + "outputs": [ + { + "internalType": "Timestamp", + "name": "", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "address", + "name": "_recipient", + "type": "address" + } + ], + "name": "credit", + "outputs": [ + { + "internalType": "uint256", + "name": "credit_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "Claim", + "name": "_disputed", + "type": "bytes32" + }, + { + "internalType": "uint256", + "name": "_parentIndex", + "type": "uint256" + }, + { + "internalType": "Claim", + "name": "_claim", + "type": "bytes32" + } + ], + "name": "defend", + "outputs": [], + "stateMutability": "payable", + "type": "function" + }, + { + "inputs": [], + "name": "extraData", + "outputs": [ + { + "internalType": "bytes", + "name": "extraData_", + "type": "bytes" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "gameCreator", + "outputs": [ + { + "internalType": "address", + "name": "creator_", + "type": "address" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "gameData", + "outputs": [ + { + "internalType": "GameType", + "name": "gameType_", + "type": "uint32" + }, + { + "internalType": "Claim", + "name": "rootClaim_", + "type": "bytes32" + }, + { + "internalType": "bytes", + "name": "extraData_", + "type": "bytes" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "gameType", + "outputs": [ + { + "internalType": "GameType", + "name": "gameType_", + "type": "uint32" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "_claimIndex", + "type": "uint256" + } + ], + "name": "getChallengerDuration", + "outputs": [ + { + "internalType": "Duration", + "name": "duration_", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "_claimIndex", + "type": "uint256" + } + ], + "name": "getNumToResolve", + "outputs": [ + { + "internalType": "uint256", + "name": "numRemainingChildren_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "Position", + "name": "_position", + "type": "uint128" + } + ], + "name": "getRequiredBond", + "outputs": [ + { + "internalType": "uint256", + "name": "requiredBond_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "name": "hasUnlockedCredit", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "initialize", + "outputs": [], + "stateMutability": "payable", + "type": "function" + }, + { + "inputs": [], + "name": "l1Head", + "outputs": [ + { + "internalType": "Hash", + "name": "l1Head_", + "type": "bytes32" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "l2BlockNumber", + "outputs": [ + { + "internalType": "uint256", + "name": "l2BlockNumber_", + "type": "uint256" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "l2BlockNumberChallenged", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "l2BlockNumberChallenger", + "outputs": [ + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "l2ChainId", + "outputs": [ + { + "internalType": "uint256", + "name": "l2ChainId_", + "type": "uint256" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "l2SequenceNumber", + "outputs": [ + { + "internalType": "uint256", + "name": "l2SequenceNumber_", + "type": "uint256" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "maxClockDuration", + "outputs": [ + { + "internalType": "Duration", + "name": "maxClockDuration_", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "maxGameDepth", + "outputs": [ + { + "internalType": "uint256", + "name": "maxGameDepth_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "Claim", + "name": "_disputed", + "type": "bytes32" + }, + { + "internalType": "uint256", + "name": "_challengeIndex", + "type": "uint256" + }, + { + "internalType": "Claim", + "name": "_claim", + "type": "bytes32" + }, + { + "internalType": "bool", + "name": "_isAttack", + "type": "bool" + } + ], + "name": "move", + "outputs": [], + "stateMutability": "payable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "name": "normalModeCredit", + "outputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "proposer", + "outputs": [ + { + "internalType": "address", + "name": "proposer_", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "address", + "name": "", + "type": "address" + } + ], + "name": "refundModeCredit", + "outputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "name": "resolutionCheckpoints", + "outputs": [ + { + "internalType": "bool", + "name": "initialCheckpointComplete", + "type": "bool" + }, + { + "internalType": "uint32", + "name": "subgameIndex", + "type": "uint32" + }, + { + "internalType": "Position", + "name": "leftmostPosition", + "type": "uint128" + }, + { + "internalType": "address", + "name": "counteredBy", + "type": "address" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "resolve", + "outputs": [ + { + "internalType": "enum GameStatus", + "name": "status_", + "type": "uint8" + } + ], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "_claimIndex", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "_numToResolve", + "type": "uint256" + } + ], + "name": "resolveClaim", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [], + "name": "resolvedAt", + "outputs": [ + { + "internalType": "Timestamp", + "name": "", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "name": "resolvedSubgames", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "rootClaim", + "outputs": [ + { + "internalType": "Claim", + "name": "rootClaim_", + "type": "bytes32" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "splitDepth", + "outputs": [ + { + "internalType": "uint256", + "name": "splitDepth_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "startingBlockNumber", + "outputs": [ + { + "internalType": "uint256", + "name": "startingBlockNumber_", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "startingOutputRoot", + "outputs": [ + { + "internalType": "Hash", + "name": "root", + "type": "bytes32" + }, + { + "internalType": "uint256", + "name": "l2SequenceNumber", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "startingRootHash", + "outputs": [ + { + "internalType": "Hash", + "name": "startingRootHash_", + "type": "bytes32" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "status", + "outputs": [ + { + "internalType": "enum GameStatus", + "name": "", + "type": "uint8" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "_claimIndex", + "type": "uint256" + }, + { + "internalType": "bool", + "name": "_isAttack", + "type": "bool" + }, + { + "internalType": "bytes", + "name": "_stateData", + "type": "bytes" + }, + { + "internalType": "bytes", + "name": "_proof", + "type": "bytes" + } + ], + "name": "step", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "inputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + }, + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "name": "subgames", + "outputs": [ + { + "internalType": "uint256", + "name": "", + "type": "uint256" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "version", + "outputs": [ + { + "internalType": "string", + "name": "", + "type": "string" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "vm", + "outputs": [ + { + "internalType": "contract IBigStepper", + "name": "vm_", + "type": "address" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "inputs": [], + "name": "wasRespectedGameTypeWhenCreated", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [], + "name": "weth", + "outputs": [ + { + "internalType": "contract IDelayedWETH", + "name": "weth_", + "type": "address" + } + ], + "stateMutability": "pure", + "type": "function" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": false, + "internalType": "enum BondDistributionMode", + "name": "bondDistributionMode", + "type": "uint8" + } + ], + "name": "GameClosed", + "type": "event" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": true, + "internalType": "uint256", + "name": "parentIndex", + "type": "uint256" + }, + { + "indexed": true, + "internalType": "Claim", + "name": "claim", + "type": "bytes32" + }, + { + "indexed": true, + "internalType": "address", + "name": "claimant", + "type": "address" + } + ], + "name": "Move", + "type": "event" + }, + { + "anonymous": false, + "inputs": [ + { + "indexed": true, + "internalType": "enum GameStatus", + "name": "status", + "type": "uint8" + } + ], + "name": "Resolved", + "type": "event" + }, + { + "inputs": [], + "name": "AlreadyInitialized", + "type": "error" + }, + { + "inputs": [], + "name": "AnchorRootNotFound", + "type": "error" + }, + { + "inputs": [], + "name": "BadAuth", + "type": "error" + }, + { + "inputs": [], + "name": "BadExtraData", + "type": "error" + }, + { + "inputs": [], + "name": "BlockNumberMatches", + "type": "error" + }, + { + "inputs": [], + "name": "BondTransferFailed", + "type": "error" + }, + { + "inputs": [], + "name": "CannotDefendRootClaim", + "type": "error" + }, + { + "inputs": [], + "name": "ClaimAboveSplit", + "type": "error" + }, + { + "inputs": [], + "name": "ClaimAlreadyExists", + "type": "error" + }, + { + "inputs": [], + "name": "ClaimAlreadyResolved", + "type": "error" + }, + { + "inputs": [], + "name": "ClockNotExpired", + "type": "error" + }, + { + "inputs": [], + "name": "ClockTimeExceeded", + "type": "error" + }, + { + "inputs": [], + "name": "ContentLengthMismatch", + "type": "error" + }, + { + "inputs": [], + "name": "DuplicateStep", + "type": "error" + }, + { + "inputs": [], + "name": "EmptyItem", + "type": "error" + }, + { + "inputs": [], + "name": "GameDepthExceeded", + "type": "error" + }, + { + "inputs": [], + "name": "GameNotFinalized", + "type": "error" + }, + { + "inputs": [], + "name": "GameNotInProgress", + "type": "error" + }, + { + "inputs": [], + "name": "GameNotResolved", + "type": "error" + }, + { + "inputs": [], + "name": "GamePaused", + "type": "error" + }, + { + "inputs": [], + "name": "IncorrectBondAmount", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidBondDistributionMode", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidChallengePeriod", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidClockExtension", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidDataRemainder", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidDisputedClaimIndex", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidHeader", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidHeaderRLP", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidLocalIdent", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidOutputRootProof", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidParent", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidPrestate", + "type": "error" + }, + { + "inputs": [], + "name": "InvalidSplitDepth", + "type": "error" + }, + { + "inputs": [], + "name": "L2BlockNumberChallenged", + "type": "error" + }, + { + "inputs": [], + "name": "MaxDepthTooLarge", + "type": "error" + }, + { + "inputs": [], + "name": "NoCreditToClaim", + "type": "error" + }, + { + "inputs": [], + "name": "OutOfOrderResolution", + "type": "error" + }, + { + "inputs": [], + "name": "ReservedGameType", + "type": "error" + }, + { + "inputs": [], + "name": "UnexpectedList", + "type": "error" + }, + { + "inputs": [ + { + "internalType": "Claim", + "name": "rootClaim", + "type": "bytes32" + } + ], + "name": "UnexpectedRootClaim", + "type": "error" + }, + { + "inputs": [], + "name": "UnexpectedString", + "type": "error" + }, + { + "inputs": [], + "name": "ValidStep", + "type": "error" + } +] \ No newline at end of file diff --git a/packages/contracts-bedrock/snapshots/abi/SuperFaultDisputeGame.json b/packages/contracts-bedrock/snapshots/abi/SuperFaultDisputeGame.json index b746003f132..6ea8b243ed6 100644 --- a/packages/contracts-bedrock/snapshots/abi/SuperFaultDisputeGame.json +++ b/packages/contracts-bedrock/snapshots/abi/SuperFaultDisputeGame.json @@ -924,6 +924,11 @@ "name": "AnchorRootNotFound", "type": "error" }, + { + "inputs": [], + "name": "BadExtraData", + "type": "error" + }, { "inputs": [], "name": "BondTransferFailed", diff --git a/packages/contracts-bedrock/snapshots/abi/SuperPermissionedDisputeGame.json b/packages/contracts-bedrock/snapshots/abi/SuperPermissionedDisputeGame.json index 17c01e9593f..b9988791a0f 100644 --- a/packages/contracts-bedrock/snapshots/abi/SuperPermissionedDisputeGame.json +++ b/packages/contracts-bedrock/snapshots/abi/SuperPermissionedDisputeGame.json @@ -965,6 +965,11 @@ "name": "BadAuth", "type": "error" }, + { + "inputs": [], + "name": "BadExtraData", + "type": "error" + }, { "inputs": [], "name": "BondTransferFailed", diff --git a/packages/contracts-bedrock/snapshots/abi/SuperchainConfig.json b/packages/contracts-bedrock/snapshots/abi/SuperchainConfig.json index ed7ad5c10f9..e430da3ccca 100644 --- a/packages/contracts-bedrock/snapshots/abi/SuperchainConfig.json +++ b/packages/contracts-bedrock/snapshots/abi/SuperchainConfig.json @@ -210,13 +210,6 @@ "stateMutability": "nonpayable", "type": "function" }, - { - "inputs": [], - "name": "upgrade", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, { "inputs": [], "name": "version", diff --git a/packages/contracts-bedrock/snapshots/abi/SystemConfig.json b/packages/contracts-bedrock/snapshots/abi/SystemConfig.json index a295b986db2..10a956622f8 100644 --- a/packages/contracts-bedrock/snapshots/abi/SystemConfig.json +++ b/packages/contracts-bedrock/snapshots/abi/SystemConfig.json @@ -413,6 +413,25 @@ "stateMutability": "nonpayable", "type": "function" }, + { + "inputs": [ + { + "internalType": "bytes32", + "name": "", + "type": "bytes32" + } + ], + "name": "isFeatureEnabled", + "outputs": [ + { + "internalType": "bool", + "name": "", + "type": "bool" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [], "name": "l1CrossDomainMessenger", @@ -478,6 +497,19 @@ "stateMutability": "pure", "type": "function" }, + { + "inputs": [], + "name": "minBaseFee", + "outputs": [ + { + "internalType": "uint64", + "name": "", + "type": "uint64" + } + ], + "stateMutability": "view", + "type": "function" + }, { "inputs": [], "name": "minimumGasLimit", @@ -704,6 +736,24 @@ "stateMutability": "nonpayable", "type": "function" }, + { + "inputs": [ + { + "internalType": "bytes32", + "name": "_feature", + "type": "bytes32" + }, + { + "internalType": "bool", + "name": "_enabled", + "type": "bool" + } + ], + "name": "setFeature", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, { "inputs": [ { @@ -753,6 +803,19 @@ "stateMutability": "nonpayable", "type": "function" }, + { + "inputs": [ + { + "internalType": "uint64", + "name": "_minBaseFee", + "type": "uint64" + } + ], + "name": "setMinBaseFee", + "outputs": [], + "stateMutability": "nonpayable", + "type": "function" + }, { "inputs": [ { @@ -836,24 +899,6 @@ "stateMutability": "view", "type": "function" }, - { - "inputs": [ - { - "internalType": "uint256", - "name": "_l2ChainId", - "type": "uint256" - }, - { - "internalType": "contract ISuperchainConfig", - "name": "_superchainConfig", - "type": "address" - } - ], - "name": "upgrade", - "outputs": [], - "stateMutability": "nonpayable", - "type": "function" - }, { "inputs": [], "name": "version", @@ -892,6 +937,25 @@ "name": "ConfigUpdate", "type": "event" }, + { + "anonymous": false, + "inputs": [ + { + "indexed": true, + "internalType": "bytes32", + "name": "feature", + "type": "bytes32" + }, + { + "indexed": true, + "internalType": "bool", + "name": "enabled", + "type": "bool" + } + ], + "name": "FeatureSet", + "type": "event" + }, { "anonymous": false, "inputs": [ @@ -958,5 +1022,10 @@ "inputs": [], "name": "ReinitializableBase_ZeroInitVersion", "type": "error" + }, + { + "inputs": [], + "name": "SystemConfig_InvalidFeatureState", + "type": "error" } ] \ No newline at end of file diff --git a/packages/contracts-bedrock/snapshots/semver-lock.json b/packages/contracts-bedrock/snapshots/semver-lock.json index 2b0ce31af42..dc2ac56022a 100644 --- a/packages/contracts-bedrock/snapshots/semver-lock.json +++ b/packages/contracts-bedrock/snapshots/semver-lock.json @@ -8,40 +8,44 @@ "sourceCodeHash": "0x6c9d3e2dee44c234d59ab93b6564536dfd807f1c4a02a82d5393bc53cb15b8b7" }, "src/L1/L1CrossDomainMessenger.sol:L1CrossDomainMessenger": { - "initCodeHash": "0x117e4126f2accbcd0c4de00b8d19f522e76396dd39145b4c2e2b4f9dfa1b03ef", - "sourceCodeHash": "0x66b6e4d41c40efcc50b644d22d736408e28a73a6b55b18fcbb89a83bd3230d53" + "initCodeHash": "0x3dc659aafb03bd357f92abfc6794af89ee0ddd5212364551637422bf8d0b00f9", + "sourceCodeHash": "0xef3d366cd22eac2dfd22a658e003700c679bd9c38758d9c21befa7335bbd82ad" }, "src/L1/L1ERC721Bridge.sol:L1ERC721Bridge": { - "initCodeHash": "0xf1eaecec5e9c9c3d143bc9980d15e4671e97cb840f044bc2189a9d42ea7a1ef7", - "sourceCodeHash": "0x24e870fc3620d07ef9e336bd56e0df0604df69a2909c1aaf709f2c253ad16c78" + "initCodeHash": "0x6f586bf82f6e89b75c2cc707e16a71ac921a911acf00f1594659f82e5c819fcc", + "sourceCodeHash": "0x4d48a9cf80dd288d1c54c9576a1a8c12c1c5b9f1694246d0ebba60996f786b69" }, "src/L1/L1StandardBridge.sol:L1StandardBridge": { - "initCodeHash": "0x11e28569436e16691f03820e0fd5252492706f5855b350439f695c7e4cd331c3", - "sourceCodeHash": "0x11b35ee81f797b30ee834e2ffad52686d2100d7ee139db4299b7d854dba25550" + "initCodeHash": "0xadd7863f0d14360be0f0c575d07aa304457b190b64a91a8976770fb7c34b28a3", + "sourceCodeHash": "0xfca613b5d055ffc4c3cbccb0773ddb9030abedc1aa6508c9e2e7727cc0cd617b" }, "src/L1/OPContractsManager.sol:OPContractsManager": { - "initCodeHash": "0x8c209f938d6aa21f1dbc93d50bed559c4cfe3d1b7b4f2cb81c4ea46e880b443c", - "sourceCodeHash": "0xb1264c7af50b6134c98cb82d1ffc7891adf97068fa7048ee70992fb94bc15bd1" + "initCodeHash": "0x38dfaa504d646a48b85da1d2cf853263241070ac25a93d16f12468d948aa5f96", + "sourceCodeHash": "0xb5cb0e204bde0e5ab59c3be61e234c2c6b0efa60f9e550c25f64b8d5eeffae4e" }, "src/L1/OPContractsManagerStandardValidator.sol:OPContractsManagerStandardValidator": { - "initCodeHash": "0x4c9b9f7888ce14a672dae0f24af9cf20627b1629b5075a364ad17f4db0d06a70", - "sourceCodeHash": "0xb65ed0b9cc62c13a053f1b416792802269be37409df917c31e1140f064cf1073" + "initCodeHash": "0x17a40747da8a9978f7294f071ea371b8c021504b898919431e6acf62623e8adc", + "sourceCodeHash": "0xa80dcd2ebafc5a6a437f712d8073f8a48998807aa317ad7762b3fc9dc2caa133" }, "src/L1/OptimismPortal2.sol:OptimismPortal2": { - "initCodeHash": "0x785b09610b2da65d248b49150fafc85b8369c921ddae95b0ea45608b1ce5cbc6", - "sourceCodeHash": "0x925821e7ca59f1799a900fbf5ce7d2c6bef35fc2636c306977d9889f60a987bb" + "initCodeHash": "0x8faaaf0aa74a8f7a98674e94009a516dddae7bb1feb687f4a6d43641c23efe45", + "sourceCodeHash": "0x63002978f0cc521ed4f0572ef81a5d57cd788d2c068ff75fddc71b08c7e92305" + }, + "src/L1/OptimismPortalInterop.sol:OptimismPortalInterop": { + "initCodeHash": "0x087281cd2a48e882648c09fa90bfcca7487d222e16300f9372deba6b2b8ccfad", + "sourceCodeHash": "0x1cc641a4272aea85e13cbf42d9032d1b91ef858eafe3be6b5649cc8504c9cf69" }, "src/L1/ProtocolVersions.sol:ProtocolVersions": { "initCodeHash": "0x5a76c8530cb24cf23d3baacc6eefaac226382af13f1e2a35535d2ec2b0573b29", "sourceCodeHash": "0xb3e32b18c95d4940980333e1e99b4dcf42d8a8bfce78139db4dc3fb06e9349d0" }, "src/L1/SuperchainConfig.sol:SuperchainConfig": { - "initCodeHash": "0x0ea921059d71fd19ac9c6e29c05b9724ad584eb27f74231de6df9551e9b13084", - "sourceCodeHash": "0xad12c20a00dc20683bd3f68e6ee254f968da6cc2d98930be6534107ee5cb11d9" + "initCodeHash": "0xfb8c98028f1a0e70bb1afbbc532035ea71b0724883554eeaae62e1910a6c1cd9", + "sourceCodeHash": "0xbf344c4369b8cb00ec7a3108f72795747f3bc59ab5b37ac18cf21e72e2979dbf" }, "src/L1/SystemConfig.sol:SystemConfig": { - "initCodeHash": "0x07b7039de5b8a4dc57642ee9696e949d70516b7f6dce41dde4920efb17105ef2", - "sourceCodeHash": "0x997212ceadabb306c2abd31918b09bccbba0b21662c1d8930a3599831c374b13" + "initCodeHash": "0x43b5fc9ca19b5f34623b7b6cc5d71f56153fe4b8f1930cad9d946d2471b2395c", + "sourceCodeHash": "0xa82f3f62be32f9f9988b2b44d740c8cbeec3f7623c29c4b7401d0f257e58279e" }, "src/L2/BaseFeeVault.sol:BaseFeeVault": { "initCodeHash": "0xe68cf9422671396ab876cdae71ddfa634a511b8400fa784f466bec380ce4aa84", @@ -152,8 +156,8 @@ "sourceCodeHash": "0x734a6b2aa6406bc145d848ad6071d3af1d40852aeb8f4b2f6f51beaad476e2d3" }, "src/cannon/MIPS64.sol:MIPS64": { - "initCodeHash": "0xbc7c3c50e8c3679576f87d79c2dae05dd1174e64bdaa4c1e0857314618e415a3", - "sourceCodeHash": "0xf6e87bf46edca31c2b30c83fdf7b57a7851404743e16dd4f783be3a34c481d76" + "initCodeHash": "0x6a649986370d18e5fddcd89df73e520063fb373f7dba2f731a2b7e79a1c132a5", + "sourceCodeHash": "0x657afae82e6e3627389153736e568bf99498a272ec6d9ecc22ecfd645c56c453" }, "src/cannon/PreimageOracle.sol:PreimageOracle": { "initCodeHash": "0x6af5b0e83b455aab8d0946c160a4dc049a4e03be69f8a2a9e87b574f27b25a66", @@ -168,24 +172,32 @@ "sourceCodeHash": "0xdebf2ab3af4d5549c40e9dd9db6b2458af286f323b6891f3b0c4e89f3c8928db" }, "src/dispute/DisputeGameFactory.sol:DisputeGameFactory": { - "initCodeHash": "0xa3e6a7466e16e6b7a8ce7a257ec543c1bf675e24f53565080d826404654b9262", - "sourceCodeHash": "0x1871aaeba0658f17270190cc95ffff172d92dca795d698401ec34a7462bf5242" + "initCodeHash": "0x41ea0025ffbbb7dabc45da9b8afe4bce6b8ec1f132b424f351cf8c7d3fe15579", + "sourceCodeHash": "0x81ffb8f29b29774847e8b699d8719aaf6c633070841b8e2c3a651105822ce9ea" }, "src/dispute/FaultDisputeGame.sol:FaultDisputeGame": { - "initCodeHash": "0x9748700f873b6fe0599f9674a4c2dfbc9e35bbc918ebd2f7c54f709b1480df36", - "sourceCodeHash": "0xe6d4bdbfb05491164f203f1c5542a7ba961a20727a5b706b393f4f886ba5f901" + "initCodeHash": "0xe7d3c982532946d196d7efadb9e2576c76b8f9e0d1f885ac36977d6f3fb72a65", + "sourceCodeHash": "0x63222e6926c8dd050d1adc0e65039c42382f269c3b0e113751d79e7a5167b7ac" }, "src/dispute/PermissionedDisputeGame.sol:PermissionedDisputeGame": { - "initCodeHash": "0x1018dcbe7714a80a33dd8ad09bcc533dc6cbe1e97d2a17d3780887d406fc46a8", - "sourceCodeHash": "0x09455fe79619e63a08244647dca734fa58e96352fe21aeb289cc467437389125" + "initCodeHash": "0xefa478f976e55eb53fcccf653b202bc2532781230f20013450ce0845b77d815c", + "sourceCodeHash": "0x335a503a4cc02dd30d88d163393680f3fd89168e0faa4fa4b0ae5da399656f91" }, "src/dispute/SuperFaultDisputeGame.sol:SuperFaultDisputeGame": { - "initCodeHash": "0x687bde7b8632b47dc16530cc523946e4109e023f0d32c9bf0281b51f412f0f0d", - "sourceCodeHash": "0x7dd3852f6b744ddfb08699bf2d201eba92314ef70c9c62c06d84b0baac5f0299" + "initCodeHash": "0xe7591ef9c806c236d78ed4b83e81701732e0fe2237d3d455d26f054aefcc54b6", + "sourceCodeHash": "0x089f457ecaa85379bcdb4b843a2b2db9616d87f957f7964de23f80e7655d3f53" }, "src/dispute/SuperPermissionedDisputeGame.sol:SuperPermissionedDisputeGame": { - "initCodeHash": "0x9c954076097eb80f70333a387f12ba190eb9374aebb923ce30ecfe1d17030cc0", - "sourceCodeHash": "0x9baa0f9e744cc0ecc61d0fade8bffc18321b228833ea0904dc645f3975be9ed1" + "initCodeHash": "0x615baee73b605785025893fad655f8b7d8d546d77fbeca1f799000513ded3309", + "sourceCodeHash": "0x8fdd69d4bcd33a3d8b49a73ff5b6855f9ad5f7e2b7393e67cd755973b127b1e8" + }, + "src/dispute/v2/FaultDisputeGameV2.sol:FaultDisputeGameV2": { + "initCodeHash": "0x13ef27ad793c95be884dea8259ac06619bf13d10868c5fc9980bc402b59efb8d", + "sourceCodeHash": "0x47c141889e647820759a2eaa84c31be8acdce6427cc4fe7c00a482ba44d62b87" + }, + "src/dispute/v2/PermissionedDisputeGameV2.sol:PermissionedDisputeGameV2": { + "initCodeHash": "0x7b1385d347dce625d63f71c13201fd90e63fcaeae17416911bccd9d670b3afc4", + "sourceCodeHash": "0xc5aa308a19fd9600607370693885155a3d6f9f7bf8a7c6ff93a389c37c136555" }, "src/legacy/DeployerWhitelist.sol:DeployerWhitelist": { "initCodeHash": "0x53099379ed48b87f027d55712dbdd1da7d7099925426eb0531da9c0012e02c29", diff --git a/packages/contracts-bedrock/snapshots/storageLayout/DisputeGameFactory.json b/packages/contracts-bedrock/snapshots/storageLayout/DisputeGameFactory.json index f53a86716ca..e8edf11aae6 100644 --- a/packages/contracts-bedrock/snapshots/storageLayout/DisputeGameFactory.json +++ b/packages/contracts-bedrock/snapshots/storageLayout/DisputeGameFactory.json @@ -61,5 +61,12 @@ "offset": 0, "slot": "104", "type": "GameId[]" + }, + { + "bytes": "32", + "label": "gameArgs", + "offset": 0, + "slot": "105", + "type": "mapping(GameType => bytes)" } ] \ No newline at end of file diff --git a/packages/contracts-bedrock/snapshots/storageLayout/FaultDisputeGameV2.json b/packages/contracts-bedrock/snapshots/storageLayout/FaultDisputeGameV2.json new file mode 100644 index 00000000000..efae9aab937 --- /dev/null +++ b/packages/contracts-bedrock/snapshots/storageLayout/FaultDisputeGameV2.json @@ -0,0 +1,121 @@ +[ + { + "bytes": "8", + "label": "createdAt", + "offset": 0, + "slot": "0", + "type": "Timestamp" + }, + { + "bytes": "8", + "label": "resolvedAt", + "offset": 8, + "slot": "0", + "type": "Timestamp" + }, + { + "bytes": "1", + "label": "status", + "offset": 16, + "slot": "0", + "type": "enum GameStatus" + }, + { + "bytes": "1", + "label": "initialized", + "offset": 17, + "slot": "0", + "type": "bool" + }, + { + "bytes": "1", + "label": "l2BlockNumberChallenged", + "offset": 18, + "slot": "0", + "type": "bool" + }, + { + "bytes": "20", + "label": "l2BlockNumberChallenger", + "offset": 0, + "slot": "1", + "type": "address" + }, + { + "bytes": "32", + "label": "claimData", + "offset": 0, + "slot": "2", + "type": "struct FaultDisputeGameV2.ClaimData[]" + }, + { + "bytes": "32", + "label": "normalModeCredit", + "offset": 0, + "slot": "3", + "type": "mapping(address => uint256)" + }, + { + "bytes": "32", + "label": "claims", + "offset": 0, + "slot": "4", + "type": "mapping(Hash => bool)" + }, + { + "bytes": "32", + "label": "subgames", + "offset": 0, + "slot": "5", + "type": "mapping(uint256 => uint256[])" + }, + { + "bytes": "32", + "label": "resolvedSubgames", + "offset": 0, + "slot": "6", + "type": "mapping(uint256 => bool)" + }, + { + "bytes": "32", + "label": "resolutionCheckpoints", + "offset": 0, + "slot": "7", + "type": "mapping(uint256 => struct FaultDisputeGameV2.ResolutionCheckpoint)" + }, + { + "bytes": "64", + "label": "startingOutputRoot", + "offset": 0, + "slot": "8", + "type": "struct Proposal" + }, + { + "bytes": "1", + "label": "wasRespectedGameTypeWhenCreated", + "offset": 0, + "slot": "10", + "type": "bool" + }, + { + "bytes": "32", + "label": "refundModeCredit", + "offset": 0, + "slot": "11", + "type": "mapping(address => uint256)" + }, + { + "bytes": "32", + "label": "hasUnlockedCredit", + "offset": 0, + "slot": "12", + "type": "mapping(address => bool)" + }, + { + "bytes": "1", + "label": "bondDistributionMode", + "offset": 0, + "slot": "13", + "type": "enum BondDistributionMode" + } +] \ No newline at end of file diff --git a/packages/contracts-bedrock/snapshots/storageLayout/GameHelper.json b/packages/contracts-bedrock/snapshots/storageLayout/GameHelper.json new file mode 100644 index 00000000000..0637a088a01 --- /dev/null +++ b/packages/contracts-bedrock/snapshots/storageLayout/GameHelper.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/packages/contracts-bedrock/snapshots/storageLayout/OPContractsManagerContractsContainer.json b/packages/contracts-bedrock/snapshots/storageLayout/OPContractsManagerContractsContainer.json index a0a6fd6d439..d87deb94bc7 100644 --- a/packages/contracts-bedrock/snapshots/storageLayout/OPContractsManagerContractsContainer.json +++ b/packages/contracts-bedrock/snapshots/storageLayout/OPContractsManagerContractsContainer.json @@ -7,7 +7,7 @@ "type": "struct OPContractsManager.Blueprints" }, { - "bytes": "416", + "bytes": "448", "label": "implementation", "offset": 0, "slot": "13", diff --git a/packages/contracts-bedrock/snapshots/storageLayout/OPContractsManagerStandardValidator.json b/packages/contracts-bedrock/snapshots/storageLayout/OPContractsManagerStandardValidator.json index 6ac032e39f1..4b248cfef65 100644 --- a/packages/contracts-bedrock/snapshots/storageLayout/OPContractsManagerStandardValidator.json +++ b/packages/contracts-bedrock/snapshots/storageLayout/OPContractsManagerStandardValidator.json @@ -43,65 +43,79 @@ }, { "bytes": "20", - "label": "ethLockboxImpl", + "label": "optimismPortalInteropImpl", "offset": 0, "slot": "6", "type": "address" }, { "bytes": "20", - "label": "systemConfigImpl", + "label": "ethLockboxImpl", "offset": 0, "slot": "7", "type": "address" }, { "bytes": "20", - "label": "optimismMintableERC20FactoryImpl", + "label": "systemConfigImpl", "offset": 0, "slot": "8", "type": "address" }, { "bytes": "20", - "label": "l1CrossDomainMessengerImpl", + "label": "optimismMintableERC20FactoryImpl", "offset": 0, "slot": "9", "type": "address" }, { "bytes": "20", - "label": "l1StandardBridgeImpl", + "label": "l1CrossDomainMessengerImpl", "offset": 0, "slot": "10", "type": "address" }, { "bytes": "20", - "label": "disputeGameFactoryImpl", + "label": "l1StandardBridgeImpl", "offset": 0, "slot": "11", "type": "address" }, { "bytes": "20", - "label": "anchorStateRegistryImpl", + "label": "disputeGameFactoryImpl", "offset": 0, "slot": "12", "type": "address" }, { "bytes": "20", - "label": "delayedWETHImpl", + "label": "anchorStateRegistryImpl", "offset": 0, "slot": "13", "type": "address" }, { "bytes": "20", - "label": "mipsImpl", + "label": "delayedWETHImpl", "offset": 0, "slot": "14", "type": "address" + }, + { + "bytes": "20", + "label": "mipsImpl", + "offset": 0, + "slot": "15", + "type": "address" + }, + { + "bytes": "32", + "label": "devFeatureBitmap", + "offset": 0, + "slot": "16", + "type": "bytes32" } ] \ No newline at end of file diff --git a/packages/contracts-bedrock/snapshots/storageLayout/OptimismPortal2.json b/packages/contracts-bedrock/snapshots/storageLayout/OptimismPortal2.json index 8dc6639f303..649ad99cba2 100644 --- a/packages/contracts-bedrock/snapshots/storageLayout/OptimismPortal2.json +++ b/packages/contracts-bedrock/snapshots/storageLayout/OptimismPortal2.json @@ -141,7 +141,7 @@ }, { "bytes": "1", - "label": "superRootsActive", + "label": "spacer_63_20_1", "offset": 20, "slot": "63", "type": "bool" diff --git a/packages/contracts-bedrock/snapshots/storageLayout/OptimismPortalInterop.json b/packages/contracts-bedrock/snapshots/storageLayout/OptimismPortalInterop.json new file mode 100644 index 00000000000..c0bcf34cc42 --- /dev/null +++ b/packages/contracts-bedrock/snapshots/storageLayout/OptimismPortalInterop.json @@ -0,0 +1,149 @@ +[ + { + "bytes": "1", + "label": "_initialized", + "offset": 0, + "slot": "0", + "type": "uint8" + }, + { + "bytes": "1", + "label": "_initializing", + "offset": 1, + "slot": "0", + "type": "bool" + }, + { + "bytes": "32", + "label": "params", + "offset": 0, + "slot": "1", + "type": "struct ResourceMetering.ResourceParams" + }, + { + "bytes": "1536", + "label": "__gap", + "offset": 0, + "slot": "2", + "type": "uint256[48]" + }, + { + "bytes": "20", + "label": "l2Sender", + "offset": 0, + "slot": "50", + "type": "address" + }, + { + "bytes": "32", + "label": "finalizedWithdrawals", + "offset": 0, + "slot": "51", + "type": "mapping(bytes32 => bool)" + }, + { + "bytes": "32", + "label": "spacer_52_0_32", + "offset": 0, + "slot": "52", + "type": "bytes32" + }, + { + "bytes": "1", + "label": "spacer_53_0_1", + "offset": 0, + "slot": "53", + "type": "bool" + }, + { + "bytes": "20", + "label": "spacer_53_1_20", + "offset": 1, + "slot": "53", + "type": "address" + }, + { + "bytes": "20", + "label": "spacer_54_0_20", + "offset": 0, + "slot": "54", + "type": "address" + }, + { + "bytes": "20", + "label": "systemConfig", + "offset": 0, + "slot": "55", + "type": "contract ISystemConfig" + }, + { + "bytes": "20", + "label": "spacer_56_0_20", + "offset": 0, + "slot": "56", + "type": "address" + }, + { + "bytes": "32", + "label": "provenWithdrawals", + "offset": 0, + "slot": "57", + "type": "mapping(bytes32 => mapping(address => struct OptimismPortalInterop.ProvenWithdrawal))" + }, + { + "bytes": "32", + "label": "spacer_58_0_32", + "offset": 0, + "slot": "58", + "type": "bytes32" + }, + { + "bytes": "4", + "label": "spacer_59_0_4", + "offset": 0, + "slot": "59", + "type": "GameType" + }, + { + "bytes": "8", + "label": "spacer_59_4_8", + "offset": 4, + "slot": "59", + "type": "uint64" + }, + { + "bytes": "32", + "label": "proofSubmitters", + "offset": 0, + "slot": "60", + "type": "mapping(bytes32 => address[])" + }, + { + "bytes": "32", + "label": "spacer_61_0_32", + "offset": 0, + "slot": "61", + "type": "uint256" + }, + { + "bytes": "20", + "label": "anchorStateRegistry", + "offset": 0, + "slot": "62", + "type": "contract IAnchorStateRegistry" + }, + { + "bytes": "20", + "label": "ethLockbox", + "offset": 0, + "slot": "63", + "type": "contract IETHLockbox" + }, + { + "bytes": "1", + "label": "superRootsActive", + "offset": 20, + "slot": "63", + "type": "bool" + } +] \ No newline at end of file diff --git a/packages/contracts-bedrock/snapshots/storageLayout/PermissionedDisputeGameV2.json b/packages/contracts-bedrock/snapshots/storageLayout/PermissionedDisputeGameV2.json new file mode 100644 index 00000000000..efae9aab937 --- /dev/null +++ b/packages/contracts-bedrock/snapshots/storageLayout/PermissionedDisputeGameV2.json @@ -0,0 +1,121 @@ +[ + { + "bytes": "8", + "label": "createdAt", + "offset": 0, + "slot": "0", + "type": "Timestamp" + }, + { + "bytes": "8", + "label": "resolvedAt", + "offset": 8, + "slot": "0", + "type": "Timestamp" + }, + { + "bytes": "1", + "label": "status", + "offset": 16, + "slot": "0", + "type": "enum GameStatus" + }, + { + "bytes": "1", + "label": "initialized", + "offset": 17, + "slot": "0", + "type": "bool" + }, + { + "bytes": "1", + "label": "l2BlockNumberChallenged", + "offset": 18, + "slot": "0", + "type": "bool" + }, + { + "bytes": "20", + "label": "l2BlockNumberChallenger", + "offset": 0, + "slot": "1", + "type": "address" + }, + { + "bytes": "32", + "label": "claimData", + "offset": 0, + "slot": "2", + "type": "struct FaultDisputeGameV2.ClaimData[]" + }, + { + "bytes": "32", + "label": "normalModeCredit", + "offset": 0, + "slot": "3", + "type": "mapping(address => uint256)" + }, + { + "bytes": "32", + "label": "claims", + "offset": 0, + "slot": "4", + "type": "mapping(Hash => bool)" + }, + { + "bytes": "32", + "label": "subgames", + "offset": 0, + "slot": "5", + "type": "mapping(uint256 => uint256[])" + }, + { + "bytes": "32", + "label": "resolvedSubgames", + "offset": 0, + "slot": "6", + "type": "mapping(uint256 => bool)" + }, + { + "bytes": "32", + "label": "resolutionCheckpoints", + "offset": 0, + "slot": "7", + "type": "mapping(uint256 => struct FaultDisputeGameV2.ResolutionCheckpoint)" + }, + { + "bytes": "64", + "label": "startingOutputRoot", + "offset": 0, + "slot": "8", + "type": "struct Proposal" + }, + { + "bytes": "1", + "label": "wasRespectedGameTypeWhenCreated", + "offset": 0, + "slot": "10", + "type": "bool" + }, + { + "bytes": "32", + "label": "refundModeCredit", + "offset": 0, + "slot": "11", + "type": "mapping(address => uint256)" + }, + { + "bytes": "32", + "label": "hasUnlockedCredit", + "offset": 0, + "slot": "12", + "type": "mapping(address => bool)" + }, + { + "bytes": "1", + "label": "bondDistributionMode", + "offset": 0, + "slot": "13", + "type": "enum BondDistributionMode" + } +] \ No newline at end of file diff --git a/packages/contracts-bedrock/snapshots/storageLayout/SystemConfig.json b/packages/contracts-bedrock/snapshots/storageLayout/SystemConfig.json index be5a739fa69..3a80e68ed8b 100644 --- a/packages/contracts-bedrock/snapshots/storageLayout/SystemConfig.json +++ b/packages/contracts-bedrock/snapshots/storageLayout/SystemConfig.json @@ -124,5 +124,19 @@ "offset": 0, "slot": "108", "type": "contract ISuperchainConfig" + }, + { + "bytes": "8", + "label": "minBaseFee", + "offset": 20, + "slot": "108", + "type": "uint64" + }, + { + "bytes": "32", + "label": "isFeatureEnabled", + "offset": 0, + "slot": "109", + "type": "mapping(bytes32 => bool)" } ] \ No newline at end of file diff --git a/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol b/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol index cee1d3765eb..b6208c80180 100644 --- a/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol +++ b/packages/contracts-bedrock/src/L1/L1CrossDomainMessenger.sol @@ -36,14 +36,14 @@ contract L1CrossDomainMessenger is CrossDomainMessenger, ProxyAdminOwnedBase, Re address private spacer_253_0_20; /// @notice Semantic version. - /// @custom:semver 2.9.0 - string public constant version = "2.9.0"; + /// @custom:semver 2.11.0 + string public constant version = "2.11.0"; /// @notice Contract of the SystemConfig. ISystemConfig public systemConfig; /// @notice Constructs the L1CrossDomainMessenger contract. - constructor() ReinitializableBase(2) { + constructor() ReinitializableBase(3) { _disableInitializers(); } @@ -60,16 +60,6 @@ contract L1CrossDomainMessenger is CrossDomainMessenger, ProxyAdminOwnedBase, Re __CrossDomainMessenger_init({ _otherMessenger: CrossDomainMessenger(Predeploys.L2_CROSS_DOMAIN_MESSENGER) }); } - /// @notice Upgrades the contract to have a reference to the SystemConfig. - /// @param _systemConfig The new SystemConfig contract. - function upgrade(ISystemConfig _systemConfig) external reinitializer(initVersion()) { - // Upgrade transactions must come from the ProxyAdmin or its owner. - _assertOnlyProxyAdminOrProxyAdminOwner(); - - // Now perform upgrade logic. - systemConfig = _systemConfig; - } - /// @inheritdoc CrossDomainMessenger function paused() public view override returns (bool) { return systemConfig.paused(); diff --git a/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol b/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol index 9fe0ce89333..98c557a603c 100644 --- a/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol +++ b/packages/contracts-bedrock/src/L1/L1ERC721Bridge.sol @@ -33,14 +33,14 @@ contract L1ERC721Bridge is ERC721Bridge, ProxyAdminOwnedBase, ReinitializableBas address private spacer_50_0_20; /// @notice Semantic version. - /// @custom:semver 2.7.0 - string public constant version = "2.7.0"; + /// @custom:semver 2.9.0 + string public constant version = "2.9.0"; /// @notice Address of the SystemConfig contract. ISystemConfig public systemConfig; /// @notice Constructs the L1ERC721Bridge contract. - constructor() ERC721Bridge() ReinitializableBase(2) { + constructor() ERC721Bridge() ReinitializableBase(3) { _disableInitializers(); } @@ -62,16 +62,6 @@ contract L1ERC721Bridge is ERC721Bridge, ProxyAdminOwnedBase, ReinitializableBas __ERC721Bridge_init({ _messenger: _messenger, _otherBridge: ERC721Bridge(payable(Predeploys.L2_ERC721_BRIDGE)) }); } - /// @notice Upgrades the contract to have a reference to the SystemConfig. - /// @param _systemConfig SystemConfig contract. - function upgrade(ISystemConfig _systemConfig) external reinitializer(initVersion()) { - // Upgrade transactions must come from the ProxyAdmin or its owner. - _assertOnlyProxyAdminOrProxyAdminOwner(); - - // Now perform upgrade logic. - systemConfig = _systemConfig; - } - /// @inheritdoc ERC721Bridge function paused() public view override returns (bool) { return systemConfig.paused(); diff --git a/packages/contracts-bedrock/src/L1/L1StandardBridge.sol b/packages/contracts-bedrock/src/L1/L1StandardBridge.sol index 504ba854fb5..465ec7f7ed5 100644 --- a/packages/contracts-bedrock/src/L1/L1StandardBridge.sol +++ b/packages/contracts-bedrock/src/L1/L1StandardBridge.sol @@ -77,8 +77,8 @@ contract L1StandardBridge is StandardBridge, ProxyAdminOwnedBase, Reinitializabl ); /// @notice Semantic version. - /// @custom:semver 2.6.0 - string public constant version = "2.6.0"; + /// @custom:semver 2.8.0 + string public constant version = "2.8.0"; /// @custom:legacy /// @custom:spacer superchainConfig @@ -94,7 +94,7 @@ contract L1StandardBridge is StandardBridge, ProxyAdminOwnedBase, Reinitializabl ISystemConfig public systemConfig; /// @notice Constructs the L1StandardBridge contract. - constructor() StandardBridge() ReinitializableBase(2) { + constructor() StandardBridge() ReinitializableBase(3) { _disableInitializers(); } @@ -119,16 +119,6 @@ contract L1StandardBridge is StandardBridge, ProxyAdminOwnedBase, Reinitializabl }); } - /// @notice Upgrades the contract to have a reference to the SystemConfig. - /// @param _systemConfig SystemConfig contract. - function upgrade(ISystemConfig _systemConfig) external reinitializer(initVersion()) { - // Upgrade transactions must come from the ProxyAdmin or its owner. - _assertOnlyProxyAdminOrProxyAdminOwner(); - - // Now perform upgrade logic. - systemConfig = _systemConfig; - } - /// @inheritdoc StandardBridge function paused() public view override returns (bool) { return systemConfig.paused(); diff --git a/packages/contracts-bedrock/src/L1/OPContractsManager.sol b/packages/contracts-bedrock/src/L1/OPContractsManager.sol index 03d997b15a2..70ac7617970 100644 --- a/packages/contracts-bedrock/src/L1/OPContractsManager.sol +++ b/packages/contracts-bedrock/src/L1/OPContractsManager.sol @@ -1,12 +1,18 @@ // SPDX-License-Identifier: MIT pragma solidity 0.8.15; +// Contracts +import { OPContractsManagerStandardValidator } from "src/L1/OPContractsManagerStandardValidator.sol"; + // Libraries import { Blueprint } from "src/libraries/Blueprint.sol"; import { Constants } from "src/libraries/Constants.sol"; import { Bytes } from "src/libraries/Bytes.sol"; -import { Claim, Duration, GameType, Hash, GameTypes, Proposal } from "src/dispute/lib/Types.sol"; +import { Claim, Duration, GameType, GameTypes, Proposal } from "src/dispute/lib/Types.sol"; import { Strings } from "@openzeppelin/contracts/utils/Strings.sol"; +import { SemverComp } from "src/libraries/SemverComp.sol"; +import { Features } from "src/libraries/Features.sol"; +import { DevFeatures } from "src/libraries/DevFeatures.sol"; // Interfaces import { ISemver } from "interfaces/universal/ISemver.sol"; @@ -25,14 +31,13 @@ import { ISuperPermissionedDisputeGame } from "interfaces/dispute/ISuperPermissi import { ISuperchainConfig } from "interfaces/L1/ISuperchainConfig.sol"; import { IProtocolVersions } from "interfaces/L1/IProtocolVersions.sol"; import { IOptimismPortal2 as IOptimismPortal } from "interfaces/L1/IOptimismPortal2.sol"; +import { IOptimismPortalInterop } from "interfaces/L1/IOptimismPortalInterop.sol"; import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol"; import { IL1CrossDomainMessenger } from "interfaces/L1/IL1CrossDomainMessenger.sol"; import { IL1ERC721Bridge } from "interfaces/L1/IL1ERC721Bridge.sol"; import { IL1StandardBridge } from "interfaces/L1/IL1StandardBridge.sol"; import { IOptimismMintableERC20Factory } from "interfaces/universal/IOptimismMintableERC20Factory.sol"; -import { IHasSuperchainConfig } from "interfaces/L1/IHasSuperchainConfig.sol"; import { IETHLockbox } from "interfaces/L1/IETHLockbox.sol"; -import { OPContractsManagerStandardValidator } from "src/L1/OPContractsManagerStandardValidator.sol"; contract OPContractsManagerContractsContainer { /// @notice Addresses of the Blueprint contracts. @@ -43,12 +48,30 @@ contract OPContractsManagerContractsContainer { /// @notice Addresses of the latest implementation contracts. OPContractsManager.Implementations internal implementation; + /// @notice Bitmap of development features that are enabled. We keep the development feature + /// bitmap here rather than in the actual OPCM because other contracts always get a + /// reference to this but not to the OPCM itself. + bytes32 public immutable devFeatureBitmap; + + /// @notice Thrown when a development feature is enabled in production. + error OPContractsManagerContractsContainer_DevFeatureInProd(); + + /// @param _blueprints The blueprint contract addresses. + /// @param _implementations The implementation contract addresses. + /// @param _devFeatureBitmap The bitmap of development features that are enabled. constructor( OPContractsManager.Blueprints memory _blueprints, - OPContractsManager.Implementations memory _implementations + OPContractsManager.Implementations memory _implementations, + bytes32 _devFeatureBitmap ) { blueprint = _blueprints; implementation = _implementations; + devFeatureBitmap = _devFeatureBitmap; + + // Development features MUST NOT be enabled on Mainnet. + if (block.chainid == 1 && !_isTestingEnvironment() && uint256(_devFeatureBitmap) != 0) { + revert OPContractsManagerContractsContainer_DevFeatureInProd(); + } } function blueprints() public view returns (OPContractsManager.Blueprints memory) { @@ -58,6 +81,24 @@ contract OPContractsManagerContractsContainer { function implementations() public view returns (OPContractsManager.Implementations memory) { return implementation; } + + /// @notice Returns the status of a development feature. Note that this function does not check + /// that the input feature represents a single feature and the bitwise AND operation + /// allows for multiple features to be enabled at once. Users should generally check + /// for only a single feature at a time. + /// @param _feature The feature to check. + /// @return True if the feature is enabled, false otherwise. + function isDevFeatureEnabled(bytes32 _feature) public view returns (bool) { + return DevFeatures.isDevFeatureEnabled(devFeatureBitmap, _feature); + } + + /// @notice Returns true if the contract is running in a testing environment. Checks that the + /// code for the address 0xbeefcafe is not zero, which is an address that should never + /// have any code in production environments but can be made to have code in tests. + /// @return True if the contract is running in a testing environment, false otherwise. + function _isTestingEnvironment() public view returns (bool) { + return address(0xbeefcafe).code.length > 0; + } } abstract contract OPContractsManagerBase { @@ -97,6 +138,21 @@ abstract contract OPContractsManagerBase { return contractsContainer.blueprints(); } + /// @notice Retrieves the development feature bitmap stored in this OPCM contract + function devFeatureBitmap() public view returns (bytes32) { + return contractsContainer.devFeatureBitmap(); + } + + /// @notice Retrieves the status of a development feature. Note that this function does not check + /// that the input feature represents a single feature and the bitwise AND operation + /// allows for multiple features to be enabled at once. Users should generally check + /// for only a single feature at a time. + /// @param _feature The feature to check. + /// @return True if the feature is enabled, false otherwise. + function isDevFeatureEnabled(bytes32 _feature) public view returns (bool) { + return contractsContainer.isDevFeatureEnabled(_feature); + } + /// @notice Maps an L2 chain ID to an L1 batch inbox address as defined by the standard /// configuration's convention. This convention is `versionByte || keccak256(bytes32(chainId))[:19]`, /// where || denotes concatenation`, versionByte is 0x00, and chainId is a uint256. @@ -592,265 +648,195 @@ contract OPContractsManagerUpgrader is OPContractsManagerBase { /// @notice Thrown when the SuperchainConfig contract does not match the unified config. error OPContractsManagerUpgrader_SuperchainConfigMismatch(); + /// @notice Thrown when upgrade is called with a chain whose superchainConfig is not upgraded. + error OPContractsManagerUpgrader_SuperchainConfigNeedsUpgrade(uint256 index); + + /// @notice Thrown when upgradeSuperchainConfig is called with a superchainConfig that is already up to date. + error OPContractsManagerUpgrader_SuperchainConfigAlreadyUpToDate(); + /// @param _contractsContainer The OPContractsManagerContractsContainer to use. constructor(OPContractsManagerContractsContainer _contractsContainer) OPContractsManagerBase(_contractsContainer) { } /// @notice Upgrades a set of chains to the latest implementation contracts - /// @param _superchainConfig The SuperchainConfig contract to upgrade - /// @param _superchainProxyAdmin The ProxyAdmin contract for the SuperchainConfig /// @param _opChainConfigs Array of OpChain structs, one per chain to upgrade - /// @dev This function is intended to be called via DELEGATECALL from the Upgrade Controller Safe - function upgrade( - ISuperchainConfig _superchainConfig, - IProxyAdmin _superchainProxyAdmin, - OPContractsManager.OpChainConfig[] memory _opChainConfigs - ) - external - virtual - { + /// @dev This function is intended to be called via DELEGATECALL from the Upgrade Controller Safe. + /// @dev This function requires that each chain's superchainConfig is already upgraded. + function upgrade(OPContractsManager.OpChainConfig[] memory _opChainConfigs) external virtual { + // Grab the implementations. OPContractsManager.Implementations memory impls = getImplementations(); - // If the SuperchainConfig is not already upgraded, upgrade it. NOTE that this type of - // upgrade means that chains can ONLY be upgraded via this OPCM contract if they use the - // same SuperchainConfig contract. We will assert this later. - if (_superchainProxyAdmin.getProxyImplementation(address(_superchainConfig)) != impls.superchainConfigImpl) { - // Attempt to upgrade. If the ProxyAdmin is not the SuperchainConfig's admin, this will revert. - upgradeToAndCall( - _superchainProxyAdmin, - address(_superchainConfig), - impls.superchainConfigImpl, - abi.encodeCall(ISuperchainConfig.upgrade, ()) - ); - } - // Loop through each chain and upgrade. for (uint256 i = 0; i < _opChainConfigs.length; i++) { assertValidOpChainConfig(_opChainConfigs[i]); + uint256 l2ChainId = _opChainConfigs[i].systemConfigProxy.l2ChainId(); - // Use the SystemConfig to grab the DisputeGameFactory address. - IDisputeGameFactory dgf = IDisputeGameFactory(_opChainConfigs[i].systemConfigProxy.disputeGameFactory()); - - // Need to upgrade the DisputeGameFactory implementation, no internal upgrade call. - upgradeTo(_opChainConfigs[i].proxyAdmin, address(dgf), impls.disputeGameFactoryImpl); - - // All chains have the PermissionedDisputeGame, grab that. - IPermissionedDisputeGame permissionedDisputeGame = - IPermissionedDisputeGame(address(getGameImplementation(dgf, GameTypes.PERMISSIONED_CANNON))); - - // Grab the L2 chain ID from the PermissionedDisputeGame. - uint256 l2ChainId = getL2ChainId(IFaultDisputeGame(address(permissionedDisputeGame))); + // Grab the SuperchainConfig. + ISuperchainConfig superchainConfig = _opChainConfigs[i].systemConfigProxy.superchainConfig(); - // Pull out the OptimismPortal from the SystemConfig. - IOptimismPortal optimismPortal = - IOptimismPortal(payable(_opChainConfigs[i].systemConfigProxy.optimismPortal())); - - // Assert that SuperchainConfig matches the unified config. - if (optimismPortal.superchainConfig() != _superchainConfig) { - revert OPContractsManagerUpgrader_SuperchainConfigMismatch(); + // If the SuperchainConfig is not already upgraded, revert. + if (SemverComp.lt(superchainConfig.version(), ISuperchainConfig(impls.superchainConfigImpl).version())) { + revert OPContractsManagerUpgrader_SuperchainConfigNeedsUpgrade(i); } - // Start by upgrading the SystemConfig contract to have the l2ChainId and - // SuperchainConfig. We can get the SuperchainConfig from the existing OptimismPortal, - // we need to inline the call to avoid a stack too deep error. - upgradeToAndCall( - _opChainConfigs[i].proxyAdmin, - address(_opChainConfigs[i].systemConfigProxy), - impls.systemConfigImpl, - abi.encodeCall(ISystemConfig.upgrade, (l2ChainId, _superchainConfig)) - ); + // Do the chain upgrade. + // All of your updates should be done in this internal function unless you're making a + // change to how upgrades work in general. + _doChainUpgrade(impls, _opChainConfigs[i], l2ChainId); - // Separate context to avoid stack too deep. - IAnchorStateRegistry newAnchorStateRegistryProxy; - { - // Grab the current respectedGameType from the OptimismPortal contract before the - // upgrade. - GameType respectedGameType = optimismPortal.respectedGameType(); + // Emit the upgraded event with the address of the caller. Since this will be a delegatecall, + // the caller will be the value of the ADDRESS opcode. + emit Upgraded(l2ChainId, _opChainConfigs[i].systemConfigProxy, address(this)); + } + } - // Deploy a new AnchorStateRegistry contract. - // We use the SOT suffix to avoid CREATE2 conflicts with the existing ASR. - newAnchorStateRegistryProxy = IAnchorStateRegistry( - deployProxy({ - _l2ChainId: l2ChainId, - _proxyAdmin: _opChainConfigs[i].proxyAdmin, - _saltMixer: reusableSaltMixer(_opChainConfigs[i]), - _contractName: "AnchorStateRegistry-U16" - }) - ); + /// @notice Performs an upgrade for a specific chain. + /// @param _impls The implementations of the contracts. + /// @param _opChainConfig The configuration of the chain to upgrade. + /// @param _l2ChainId The L2 chain ID of the chain to upgrade. + function _doChainUpgrade( + OPContractsManager.Implementations memory _impls, + OPContractsManager.OpChainConfig memory _opChainConfig, + uint256 _l2ChainId + ) + internal + { + // Upgrade the SystemConfig first. + upgradeTo(_opChainConfig.proxyAdmin, address(_opChainConfig.systemConfigProxy), _impls.systemConfigImpl); - // Separate context to avoid stack too deep. - { - // Get the existing anchor root from the old AnchorStateRegistry contract. - // Get the AnchorStateRegistry from the PermissionedDisputeGame. - (Hash root, uint256 l2BlockNumber) = getAnchorStateRegistry( - IFaultDisputeGame(address(permissionedDisputeGame)) - ).anchors(respectedGameType); - - // Upgrade and initialize the AnchorStateRegistry contract. - // Since this is a net-new contract, we need to initialize it. - upgradeToAndCall( - _opChainConfigs[i].proxyAdmin, - address(newAnchorStateRegistryProxy), - impls.anchorStateRegistryImpl, - abi.encodeCall( - IAnchorStateRegistry.initialize, - ( - _opChainConfigs[i].systemConfigProxy, - dgf, - Proposal({ root: root, l2SequenceNumber: l2BlockNumber }), - respectedGameType - ) - ) - ); - } - } + // Grab the OptimismPortal contract. + IOptimismPortal optimismPortal = IOptimismPortal(payable(_opChainConfig.systemConfigProxy.optimismPortal())); + // Upgrade the OptimismPortal contract. + if (isDevFeatureEnabled(DevFeatures.OPTIMISM_PORTAL_INTEROP)) { + // This does NOT run in production. // Upgrade the OptimismPortal contract implementation. - upgradeTo(_opChainConfigs[i].proxyAdmin, address(optimismPortal), impls.optimismPortalImpl); + upgradeTo(_opChainConfig.proxyAdmin, address(optimismPortal), _impls.optimismPortalInteropImpl); - // Separate context to avoid stack too deep. - { + // If we don't already have an ETHLockbox, deploy and initialize it. + IETHLockbox ethLockbox = optimismPortal.ethLockbox(); + if (address(ethLockbox) == address(0)) { // Deploy the ETHLockbox proxy. - IETHLockbox ethLockbox = IETHLockbox( + ethLockbox = IETHLockbox( deployProxy({ - _l2ChainId: l2ChainId, - _proxyAdmin: _opChainConfigs[i].proxyAdmin, - _saltMixer: reusableSaltMixer(_opChainConfigs[i]), - _contractName: "ETHLockbox-U16" + _l2ChainId: _l2ChainId, + _proxyAdmin: _opChainConfig.proxyAdmin, + _saltMixer: reusableSaltMixer(_opChainConfig), + _contractName: "ETHLockbox-U16a" }) ); - // Upgrade the OptimismPortal contract first so that the SystemConfig will have - // the SuperchainConfig reference required in the ETHLockbox. - optimismPortal.upgrade(newAnchorStateRegistryProxy, ethLockbox); - // Initialize the ETHLockbox setting the OptimismPortal as an authorized portal. IOptimismPortal[] memory portals = new IOptimismPortal[](1); portals[0] = optimismPortal; upgradeToAndCall( - _opChainConfigs[i].proxyAdmin, + _opChainConfig.proxyAdmin, address(ethLockbox), - impls.ethLockboxImpl, - abi.encodeCall(IETHLockbox.initialize, (_opChainConfigs[i].systemConfigProxy, portals)) + _impls.ethLockboxImpl, + abi.encodeCall(IETHLockbox.initialize, (_opChainConfig.systemConfigProxy, portals)) ); // Migrate liquidity from the OptimismPortal to the ETHLockbox. - optimismPortal.migrateLiquidity(); + IOptimismPortalInterop(payable(optimismPortal)).migrateLiquidity(); } - // Separate context to avoid stack too deep. - { - // Grab chain addresses here. We need to do this after the SystemConfig upgrade or - // the addresses will be incorrect. - ISystemConfig.Addresses memory opChainAddrs = _opChainConfigs[i].systemConfigProxy.getAddresses(); + // Use the existing AnchorStateRegistry reference. + IAnchorStateRegistry anchorStateRegistry = optimismPortal.anchorStateRegistry(); - // Upgrade the L1CrossDomainMessenger contract. - upgradeToAndCall( - _opChainConfigs[i].proxyAdmin, - address(IL1CrossDomainMessenger(opChainAddrs.l1CrossDomainMessenger)), - impls.l1CrossDomainMessengerImpl, - abi.encodeCall(IL1CrossDomainMessenger.upgrade, (_opChainConfigs[i].systemConfigProxy)) - ); + // Upgrade the OptimismPortal contract first so that the SystemConfig will have + // the SuperchainConfig reference required in the ETHLockbox. + IOptimismPortalInterop(payable(optimismPortal)).upgrade(anchorStateRegistry, ethLockbox); + } else { + // This runs in production. + upgradeTo(_opChainConfig.proxyAdmin, address(optimismPortal), _impls.optimismPortalImpl); + } - // Upgrade the L1StandardBridge contract. - upgradeToAndCall( - _opChainConfigs[i].proxyAdmin, - address(IL1StandardBridge(payable(opChainAddrs.l1StandardBridge))), - impls.l1StandardBridgeImpl, - abi.encodeCall(IL1StandardBridge.upgrade, (_opChainConfigs[i].systemConfigProxy)) - ); + // Use the SystemConfig to grab the DisputeGameFactory address. + IDisputeGameFactory dgf = IDisputeGameFactory(_opChainConfig.systemConfigProxy.disputeGameFactory()); - // Upgrade the L1ERC721Bridge contract. - upgradeToAndCall( - _opChainConfigs[i].proxyAdmin, - address(IL1ERC721Bridge(opChainAddrs.l1ERC721Bridge)), - impls.l1ERC721BridgeImpl, - abi.encodeCall(IL1ERC721Bridge.upgrade, (_opChainConfigs[i].systemConfigProxy)) - ); - } + // Need to upgrade the DisputeGameFactory implementation, no internal upgrade call. + upgradeTo(_opChainConfig.proxyAdmin, address(dgf), _impls.disputeGameFactoryImpl); - // We also need to redeploy the dispute games because the AnchorStateRegistry is new. - // Separate context to avoid stack too deep. - { - // Create a new DelayedWETH for the permissioned game. - IDelayedWETH permissionedDelayedWeth = IDelayedWETH( - payable( - deployProxy({ - _l2ChainId: l2ChainId, - _proxyAdmin: _opChainConfigs[i].proxyAdmin, - _saltMixer: reusableSaltMixer(_opChainConfigs[i]), - _contractName: "PermissionedDelayedWETH-U16" - }) - ) - ); + // Separate context to avoid stack too deep. + { + // Grab chain addresses here. We need to do this after the SystemConfig upgrade or + // the addresses will be incorrect. + ISystemConfig.Addresses memory opChainAddrs = _opChainConfig.systemConfigProxy.getAddresses(); + + // Upgrade the L1CrossDomainMessenger contract. + upgradeTo( + _opChainConfig.proxyAdmin, + address(IL1CrossDomainMessenger(opChainAddrs.l1CrossDomainMessenger)), + _impls.l1CrossDomainMessengerImpl + ); - // Initialize the DelayedWETH. - upgradeToAndCall( - _opChainConfigs[i].proxyAdmin, - address(permissionedDelayedWeth), - impls.delayedWETHImpl, - abi.encodeCall(IDelayedWETH.initialize, (_opChainConfigs[i].systemConfigProxy)) - ); + // Upgrade the L1StandardBridge contract. + upgradeTo( + _opChainConfig.proxyAdmin, + address(IL1StandardBridge(payable(opChainAddrs.l1StandardBridge))), + _impls.l1StandardBridgeImpl + ); - // Deploy and set a new permissioned game to update its prestate. - deployAndSetNewGameImpl({ - _l2ChainId: l2ChainId, - _disputeGame: IDisputeGame(address(permissionedDisputeGame)), - _newDelayedWeth: permissionedDelayedWeth, - _newAnchorStateRegistryProxy: newAnchorStateRegistryProxy, - _gameType: GameTypes.PERMISSIONED_CANNON, - _opChainConfig: _opChainConfigs[i] - }); - } + // Upgrade the L1ERC721Bridge contract. + upgradeTo( + _opChainConfig.proxyAdmin, + address(IL1ERC721Bridge(opChainAddrs.l1ERC721Bridge)), + _impls.l1ERC721BridgeImpl + ); + } - // Separate context to avoid stack too deep. - { - // Now retrieve the permissionless game. - IFaultDisputeGame permissionlessDisputeGame = - IFaultDisputeGame(address(getGameImplementation(dgf, GameTypes.CANNON))); - - // If it exists, replace its implementation. - if (address(permissionlessDisputeGame) != address(0)) { - // Create a new DelayedWETH for the permissionless game. - IDelayedWETH permissionlessDelayedWeth = IDelayedWETH( - payable( - deployProxy({ - _l2ChainId: l2ChainId, - _proxyAdmin: _opChainConfigs[i].proxyAdmin, - _saltMixer: reusableSaltMixer(_opChainConfigs[i]), - _contractName: "PermissionlessDelayedWETH-U16" - }) - ) - ); - - // Initialize the DelayedWETH. - upgradeToAndCall( - _opChainConfigs[i].proxyAdmin, - address(permissionlessDelayedWeth), - impls.delayedWETHImpl, - abi.encodeCall(IDelayedWETH.initialize, (_opChainConfigs[i].systemConfigProxy)) - ); - - // Deploy and set a new permissionless game to update its prestate - deployAndSetNewGameImpl({ - _l2ChainId: l2ChainId, - _disputeGame: IDisputeGame(address(permissionlessDisputeGame)), - _newDelayedWeth: permissionlessDelayedWeth, - _newAnchorStateRegistryProxy: newAnchorStateRegistryProxy, - _gameType: GameTypes.CANNON, - _opChainConfig: _opChainConfigs[i] - }); - } - } + // All chains have the PermissionedDisputeGame, grab that. + IPermissionedDisputeGame permissionedDisputeGame = + IPermissionedDisputeGame(address(getGameImplementation(dgf, GameTypes.PERMISSIONED_CANNON))); + + // Update the PermissionedDisputeGame. + // We're reusing the same DelayedWETH and ASR contracts. + deployAndSetNewGameImpl({ + _l2ChainId: _l2ChainId, + _disputeGame: IDisputeGame(address(permissionedDisputeGame)), + _newDelayedWeth: permissionedDisputeGame.weth(), + _newAnchorStateRegistryProxy: permissionedDisputeGame.anchorStateRegistry(), + _gameType: GameTypes.PERMISSIONED_CANNON, + _opChainConfig: _opChainConfig + }); - // Emit the upgraded event with the address of the caller. Since this will be a delegatecall, - // the caller will be the value of the ADDRESS opcode. - emit Upgraded(l2ChainId, _opChainConfigs[i].systemConfigProxy, address(this)); + // Now retrieve the permissionless game. + IFaultDisputeGame permissionlessDisputeGame = + IFaultDisputeGame(address(getGameImplementation(dgf, GameTypes.CANNON))); + + // If it exists, replace its implementation. + // We're reusing the same DelayedWETH and ASR contracts. + if (address(permissionlessDisputeGame) != address(0)) { + deployAndSetNewGameImpl({ + _l2ChainId: _l2ChainId, + _disputeGame: IDisputeGame(address(permissionlessDisputeGame)), + _newDelayedWeth: permissionlessDisputeGame.weth(), + _newAnchorStateRegistryProxy: permissionlessDisputeGame.anchorStateRegistry(), + _gameType: GameTypes.CANNON, + _opChainConfig: _opChainConfig + }); } } - /// @notice Retrieves the Superchain Config for a bridge contract - function getSuperchainConfig(address _hasSuperchainConfig) internal view returns (ISuperchainConfig) { - return IHasSuperchainConfig(_hasSuperchainConfig).superchainConfig(); + /// @notice Upgrades the SuperchainConfig contract. + /// @param _superchainConfig The SuperchainConfig contract to upgrade. + /// @param _superchainProxyAdmin The ProxyAdmin contract to use for the upgrade. + /// @dev This function is intended to be called via DELEGATECALL from the Upgrade Controller Safe. + /// @dev This function will revert if the SuperchainConfig is already at or above the target version. + function upgradeSuperchainConfig(ISuperchainConfig _superchainConfig, IProxyAdmin _superchainProxyAdmin) external { + // Only upgrade the superchainConfig if the current version is less than the target version. + if ( + SemverComp.gte( + _superchainConfig.version(), ISuperchainConfig(getImplementations().superchainConfigImpl).version() + ) + ) { + revert OPContractsManagerUpgrader_SuperchainConfigAlreadyUpToDate(); + } + + // Grab the implementations. + OPContractsManager.Implementations memory impls = getImplementations(); + + // Attempt to upgrade. If the ProxyAdmin is not the SuperchainConfig's admin, this will revert. + upgradeTo(_superchainProxyAdmin, address(_superchainConfig), impls.superchainConfigImpl); } /// @notice Updates the implementation of a proxy without calling the initializer. @@ -1077,18 +1063,38 @@ contract OPContractsManagerDeployer is OPContractsManagerBase { output.opChainProxyAdmin, address(output.l1ERC721BridgeProxy), implementation.l1ERC721BridgeImpl, data ); - data = encodeOptimismPortalInitializer(output); - upgradeToAndCall( - output.opChainProxyAdmin, address(output.optimismPortalProxy), implementation.optimismPortalImpl, data - ); - // Initialize the SystemConfig before the ETHLockbox, required because the ETHLockbox will - // try to get the SuperchainConfig from the SystemConfig inside of its initializer. + // try to get the SuperchainConfig from the SystemConfig inside of its initializer. Also + // need to initialize before OptimismPortal because OptimismPortal does some sanity checks + // based on the ETHLockbox feature flag. data = encodeSystemConfigInitializer(_input, output, _superchainConfig); upgradeToAndCall( output.opChainProxyAdmin, address(output.systemConfigProxy), implementation.systemConfigImpl, data ); + // If the interop feature was requested, enable the ETHLockbox feature in the SystemConfig + // contract. Only other way to get the ETHLockbox feature as of u16a is to have already had + // the ETHLockbox in U16 and then upgrade to U16a. + if (isDevFeatureEnabled(DevFeatures.OPTIMISM_PORTAL_INTEROP)) { + output.systemConfigProxy.setFeature(Features.ETH_LOCKBOX, true); + } + + // Initialize the OptimismPortal. + if (isDevFeatureEnabled(DevFeatures.OPTIMISM_PORTAL_INTEROP)) { + data = encodeOptimismPortalInteropInitializer(output); + upgradeToAndCall( + output.opChainProxyAdmin, + address(output.optimismPortalProxy), + implementation.optimismPortalInteropImpl, + data + ); + } else { + data = encodeOptimismPortalInitializer(output); + upgradeToAndCall( + output.opChainProxyAdmin, address(output.optimismPortalProxy), implementation.optimismPortalImpl, data + ); + } + // Initialize the ETHLockbox. IOptimismPortal[] memory portals = new IOptimismPortal[](1); portals[0] = output.optimismPortalProxy; @@ -1234,9 +1240,19 @@ contract OPContractsManagerDeployer is OPContractsManagerBase { view virtual returns (bytes memory) + { + return abi.encodeCall(IOptimismPortal.initialize, (_output.systemConfigProxy, _output.anchorStateRegistryProxy)); + } + + /// @notice Helper method for encoding the OptimismPortalInterop initializer data. + function encodeOptimismPortalInteropInitializer(OPContractsManager.DeployOutput memory _output) + internal + view + virtual + returns (bytes memory) { return abi.encodeCall( - IOptimismPortal.initialize, + IOptimismPortalInterop.initialize, (_output.systemConfigProxy, _output.anchorStateRegistryProxy, _output.ethLockboxProxy) ); } @@ -1415,9 +1431,9 @@ contract OPContractsManagerInteropMigrator is OPContractsManagerBase { } // Grab an array of portals from the configs. - IOptimismPortal[] memory portals = new IOptimismPortal[](_input.opChainConfigs.length); + IOptimismPortalInterop[] memory portals = new IOptimismPortalInterop[](_input.opChainConfigs.length); for (uint256 i = 0; i < _input.opChainConfigs.length; i++) { - portals[i] = IOptimismPortal(payable(_input.opChainConfigs[i].systemConfigProxy.optimismPortal())); + portals[i] = IOptimismPortalInterop(payable(_input.opChainConfigs[i].systemConfigProxy.optimismPortal())); } // Check that the portals have the same SuperchainConfig. @@ -1448,14 +1464,23 @@ contract OPContractsManagerInteropMigrator is OPContractsManagerBase { }) ); - // Initialize the new ETHLockbox. - // Note that this authorizes the portals to use the ETHLockbox. - upgradeToAndCall( - _input.opChainConfigs[0].proxyAdmin, - address(newEthLockbox), - getImplementations().ethLockboxImpl, - abi.encodeCall(IETHLockbox.initialize, (portals[0].systemConfig(), portals)) - ); + // Separate context to avoid stack too deep. + { + // Lockbox requires standard portal interfaces, need to cast to IOptimismPortal. + IOptimismPortal[] memory castedPortals; + assembly ("memory-safe") { + castedPortals := portals + } + + // Initialize the new ETHLockbox. + // Note that this authorizes the portals to use the ETHLockbox. + upgradeToAndCall( + _input.opChainConfigs[0].proxyAdmin, + address(newEthLockbox), + getImplementations().ethLockboxImpl, + abi.encodeCall(IETHLockbox.initialize, (portals[0].systemConfig(), castedPortals)) + ); + } // Deploy the new DisputeGameFactory. IDisputeGameFactory newDisputeGameFactory = IDisputeGameFactory( @@ -1719,6 +1744,7 @@ contract OPContractsManager is ISemver { address protocolVersionsImpl; address l1ERC721BridgeImpl; address optimismPortalImpl; + address optimismPortalInteropImpl; address ethLockboxImpl; address systemConfigImpl; address optimismMintableERC20FactoryImpl; @@ -1760,9 +1786,9 @@ contract OPContractsManager is ISemver { // -------- Constants and Variables -------- - /// @custom:semver 3.0.0 + /// @custom:semver 3.3.0 function version() public pure virtual returns (string memory) { - return "3.0.0"; + return "3.3.0"; } OPContractsManagerGameTypeAdder public immutable opcmGameTypeAdder; @@ -1899,12 +1925,25 @@ contract OPContractsManager is ISemver { /// @notice Upgrades a set of chains to the latest implementation contracts /// @param _opChainConfigs Array of OpChain structs, one per chain to upgrade - /// @dev This function is intended to be called via DELEGATECALL from the Upgrade Controller Safe + /// @dev This function is intended to be called via DELEGATECALL from the Upgrade Controller Safe. + /// @dev This function requires that each chain's superchainConfig is already upgraded. function upgrade(OpChainConfig[] memory _opChainConfigs) external virtual { if (address(this) == address(thisOPCM)) revert OnlyDelegatecall(); + bytes memory data = abi.encodeCall(OPContractsManagerUpgrader.upgrade, (_opChainConfigs)); + _performDelegateCall(address(opcmUpgrader), data); + } + + /// @notice Upgrades the SuperchainConfig contract. + /// @param _superchainConfig The SuperchainConfig contract to upgrade. + /// @param _superchainProxyAdmin The ProxyAdmin contract to use for the upgrade. + /// @dev This function is intended to be called via DELEGATECALL from the Upgrade Controller Safe. + /// @dev This function will revert if the SuperchainConfig is already at or above the target version. + function upgradeSuperchainConfig(ISuperchainConfig _superchainConfig, IProxyAdmin _superchainProxyAdmin) external { + if (address(this) == address(thisOPCM)) revert OnlyDelegatecall(); + bytes memory data = abi.encodeCall( - OPContractsManagerUpgrader.upgrade, (superchainConfig, superchainProxyAdmin, _opChainConfigs) + OPContractsManagerUpgrader.upgradeSuperchainConfig, (_superchainConfig, _superchainProxyAdmin) ); _performDelegateCall(address(opcmUpgrader), data); } @@ -1957,6 +1996,22 @@ contract OPContractsManager is ISemver { return opcmDeployer.implementations(); } + /// @notice Retrieves the development feature bitmap stored in this OPCM contract + /// @return The development feature bitmap. + function devFeatureBitmap() public view returns (bytes32) { + return opcmDeployer.devFeatureBitmap(); + } + + /// @notice Returns the status of a development feature. Note that this function does not check + /// that the input feature represents a single feature and the bitwise AND operation + /// allows for multiple features to be enabled at once. Users should generally check + /// for only a single feature at a time. + /// @param _feature The feature to check. + /// @return True if the feature is enabled, false otherwise. + function isDevFeatureEnabled(bytes32 _feature) public view returns (bool) { + return opcmDeployer.isDevFeatureEnabled(_feature); + } + /// @notice Helper function to perform a delegatecall to a target contract /// @param _target The target contract address /// @param _data The calldata to send to the target diff --git a/packages/contracts-bedrock/src/L1/OPContractsManagerStandardValidator.sol b/packages/contracts-bedrock/src/L1/OPContractsManagerStandardValidator.sol index b9d23ee8506..f4ad8630b71 100644 --- a/packages/contracts-bedrock/src/L1/OPContractsManagerStandardValidator.sol +++ b/packages/contracts-bedrock/src/L1/OPContractsManagerStandardValidator.sol @@ -8,6 +8,8 @@ import { Duration } from "src/dispute/lib/LibUDT.sol"; import { Predeploys } from "src/libraries/Predeploys.sol"; import { Constants } from "src/libraries/Constants.sol"; import { Hash } from "src/dispute/lib/Types.sol"; +import { Features } from "src/libraries/Features.sol"; +import { DevFeatures } from "src/libraries/DevFeatures.sol"; // Interfaces import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol"; @@ -36,8 +38,8 @@ import { IProxyAdminOwnedBase } from "interfaces/L1/IProxyAdminOwnedBase.sol"; /// before and after an upgrade. contract OPContractsManagerStandardValidator is ISemver { /// @notice The semantic version of the OPContractsManagerStandardValidator contract. - /// @custom:semver 1.5.0 - string public constant version = "1.5.0"; + /// @custom:semver 1.16.0 + string public constant version = "1.16.0"; /// @notice The SuperchainConfig contract. ISuperchainConfig public superchainConfig; @@ -59,6 +61,9 @@ contract OPContractsManagerStandardValidator is ISemver { /// @notice The OptimismPortal implementation address. address public optimismPortalImpl; + /// @notice The OptimismPortalInterop implementation address. + address public optimismPortalInteropImpl; + /// @notice The ETHLockbox implementation address. address public ethLockboxImpl; @@ -86,10 +91,14 @@ contract OPContractsManagerStandardValidator is ISemver { /// @notice The MIPS implementation address. address public mipsImpl; + /// @notice Bitmap of development features, verification may depend on these features. + bytes32 public devFeatureBitmap; + /// @notice Struct containing the implementation addresses of the L1 contracts. struct Implementations { address l1ERC721BridgeImpl; address optimismPortalImpl; + address optimismPortalInteropImpl; address ethLockboxImpl; address systemConfigImpl; address optimismMintableERC20FactoryImpl; @@ -121,16 +130,19 @@ contract OPContractsManagerStandardValidator is ISemver { ISuperchainConfig _superchainConfig, address _l1PAOMultisig, address _challenger, - uint256 _withdrawalDelaySeconds + uint256 _withdrawalDelaySeconds, + bytes32 _devFeatureBitmap ) { superchainConfig = _superchainConfig; l1PAOMultisig = _l1PAOMultisig; challenger = _challenger; withdrawalDelaySeconds = _withdrawalDelaySeconds; + devFeatureBitmap = _devFeatureBitmap; // Set implementation addresses from struct l1ERC721BridgeImpl = _implementations.l1ERC721BridgeImpl; optimismPortalImpl = _implementations.optimismPortalImpl; + optimismPortalInteropImpl = _implementations.optimismPortalInteropImpl; ethLockboxImpl = _implementations.ethLockboxImpl; systemConfigImpl = _implementations.systemConfigImpl; optimismMintableERC20FactoryImpl = _implementations.optimismMintableERC20FactoryImpl; @@ -174,59 +186,9 @@ contract OPContractsManagerStandardValidator is ISemver { return challenger; } - /// @notice Returns the expected SystemConfig version. - function systemConfigVersion() public pure returns (string memory) { - return "3.4.0"; - } - - /// @notice Returns the expected OptimismPortal version. - function optimismPortalVersion() public pure returns (string memory) { - return "4.6.0"; - } - - /// @notice Returns the expected L1CrossDomainMessenger version. - function l1CrossDomainMessengerVersion() public pure returns (string memory) { - return "2.9.0"; - } - - /// @notice Returns the expected L1ERC721Bridge version. - function l1ERC721BridgeVersion() public pure returns (string memory) { - return "2.7.0"; - } - - /// @notice Returns the expected L1StandardBridge version. - function l1StandardBridgeVersion() public pure returns (string memory) { - return "2.6.0"; - } - - /// @notice Returns the expected MIPS version. - function mipsVersion() public pure returns (string memory) { - return "1.8.0"; - } - - /// @notice Returns the expected OptimismMintableERC20Factory version. - function optimismMintableERC20FactoryVersion() public pure returns (string memory) { - return "1.10.1"; - } - - /// @notice Returns the expected DisputeGameFactory version. - function disputeGameFactoryVersion() public pure returns (string memory) { - return "1.2.0"; - } - - /// @notice Returns the expected AnchorStateRegistry version. - function anchorStateRegistryVersion() public pure returns (string memory) { - return "3.5.0"; - } - - /// @notice Returns the expected DelayedWETH version. - function delayedWETHVersion() public pure returns (string memory) { - return "1.5.0"; - } - /// @notice Returns the expected PermissionedDisputeGame version. function permissionedDisputeGameVersion() public pure returns (string memory) { - return "1.7.0"; + return "1.8.0"; } /// @notice Returns the expected PreimageOracle version. @@ -234,11 +196,6 @@ contract OPContractsManagerStandardValidator is ISemver { return "1.1.4"; } - /// @notice Returns the expected ETHLockbox version. - function ethLockboxVersion() public pure returns (string memory) { - return "1.2.0"; - } - /// @notice Internal function to get version from any contract implementing ISemver. function getVersion(address _contract) private view returns (string memory) { return ISemver(_contract).version(); @@ -286,8 +243,9 @@ contract OPContractsManagerStandardValidator is ISemver { virtual returns (string memory) { - _errors = - internalRequire(LibString.eq(getVersion(address(_sysCfg)), systemConfigVersion()), "SYSCON-10", _errors); + _errors = internalRequire( + LibString.eq(getVersion(address(_sysCfg)), getVersion(systemConfigImpl)), "SYSCON-10", _errors + ); _errors = internalRequire(_sysCfg.gasLimit() <= uint64(500_000_000), "SYSCON-20", _errors); _errors = internalRequire(_sysCfg.scalar() != 0, "SYSCON-30", _errors); _errors = @@ -319,7 +277,7 @@ contract OPContractsManagerStandardValidator is ISemver { { IL1CrossDomainMessenger _messenger = IL1CrossDomainMessenger(_sysCfg.l1CrossDomainMessenger()); _errors = internalRequire( - LibString.eq(getVersion(address(_messenger)), l1CrossDomainMessengerVersion()), "L1xDM-10", _errors + LibString.eq(getVersion(address(_messenger)), getVersion(l1CrossDomainMessengerImpl)), "L1xDM-10", _errors ); _errors = internalRequire( getProxyImplementation(_admin, address(_messenger)) == l1CrossDomainMessengerImpl, "L1xDM-20", _errors @@ -351,8 +309,9 @@ contract OPContractsManagerStandardValidator is ISemver { returns (string memory) { IL1StandardBridge _bridge = IL1StandardBridge(payable(_sysCfg.l1StandardBridge())); - _errors = - internalRequire(LibString.eq(getVersion(address(_bridge)), l1StandardBridgeVersion()), "L1SB-10", _errors); + _errors = internalRequire( + LibString.eq(getVersion(address(_bridge)), getVersion(l1StandardBridgeImpl)), "L1SB-10", _errors + ); _errors = internalRequire( getProxyImplementation(_admin, address(_bridge)) == l1StandardBridgeImpl, "L1SB-20", _errors ); @@ -380,7 +339,9 @@ contract OPContractsManagerStandardValidator is ISemver { { IOptimismMintableERC20Factory _factory = IOptimismMintableERC20Factory(_sysCfg.optimismMintableERC20Factory()); _errors = internalRequire( - LibString.eq(getVersion(address(_factory)), optimismMintableERC20FactoryVersion()), "MERC20F-10", _errors + LibString.eq(getVersion(address(_factory)), getVersion(optimismMintableERC20FactoryImpl)), + "MERC20F-10", + _errors ); _errors = internalRequire( getProxyImplementation(_admin, address(_factory)) == optimismMintableERC20FactoryImpl, "MERC20F-20", _errors @@ -403,8 +364,9 @@ contract OPContractsManagerStandardValidator is ISemver { returns (string memory) { IL1ERC721Bridge _bridge = IL1ERC721Bridge(_sysCfg.l1ERC721Bridge()); - _errors = - internalRequire(LibString.eq(getVersion(address(_bridge)), l1ERC721BridgeVersion()), "L721B-10", _errors); + _errors = internalRequire( + LibString.eq(getVersion(address(_bridge)), getVersion(l1ERC721BridgeImpl)), "L721B-10", _errors + ); _errors = internalRequire(getProxyImplementation(_admin, address(_bridge)) == l1ERC721BridgeImpl, "L721B-20", _errors); @@ -429,11 +391,24 @@ contract OPContractsManagerStandardValidator is ISemver { returns (string memory) { IOptimismPortal2 _portal = IOptimismPortal2(payable(_sysCfg.optimismPortal())); - _errors = - internalRequire(LibString.eq(getVersion(address(_portal)), optimismPortalVersion()), "PORTAL-10", _errors); - _errors = internalRequire( - getProxyImplementation(_admin, address(_portal)) == optimismPortalImpl, "PORTAL-20", _errors - ); + + if (DevFeatures.isDevFeatureEnabled(devFeatureBitmap, DevFeatures.OPTIMISM_PORTAL_INTEROP)) { + _errors = internalRequire( + LibString.eq(getVersion(address(_portal)), string.concat(getVersion(optimismPortalInteropImpl))), + "PORTAL-10", + _errors + ); + _errors = internalRequire( + getProxyImplementation(_admin, address(_portal)) == optimismPortalInteropImpl, "PORTAL-20", _errors + ); + } else { + _errors = internalRequire( + LibString.eq(getVersion(address(_portal)), getVersion(optimismPortalImpl)), "PORTAL-10", _errors + ); + _errors = internalRequire( + getProxyImplementation(_admin, address(_portal)) == optimismPortalImpl, "PORTAL-20", _errors + ); + } IDisputeGameFactory _dgf = IDisputeGameFactory(_sysCfg.disputeGameFactory()); _errors = internalRequire(address(_portal.disputeGameFactory()) == address(_dgf), "PORTAL-30", _errors); @@ -456,8 +431,14 @@ contract OPContractsManagerStandardValidator is ISemver { IOptimismPortal2 _portal = IOptimismPortal2(payable(_sysCfg.optimismPortal())); IETHLockbox _lockbox = IETHLockbox(_portal.ethLockbox()); - _errors = - internalRequire(LibString.eq(getVersion(address(_lockbox)), ethLockboxVersion()), "LOCKBOX-10", _errors); + // If this chain isn't using the ETHLockbox, skip the validation. + if (!_sysCfg.isFeatureEnabled(Features.ETH_LOCKBOX)) { + return _errors; + } + + _errors = internalRequire( + LibString.eq(getVersion(address(_lockbox)), getVersion(ethLockboxImpl)), "LOCKBOX-10", _errors + ); _errors = internalRequire(getProxyImplementation(_admin, address(_lockbox)) == ethLockboxImpl, "LOCKBOX-20", _errors); _errors = internalRequire(getProxyAdmin(address(_lockbox)) == _admin, "LOCKBOX-30", _errors); @@ -479,8 +460,9 @@ contract OPContractsManagerStandardValidator is ISemver { { address _l1PAOMultisig = expectedL1PAOMultisig(_overrides); IDisputeGameFactory _factory = IDisputeGameFactory(_sysCfg.disputeGameFactory()); - _errors = - internalRequire(LibString.eq(getVersion(address(_factory)), disputeGameFactoryVersion()), "DF-10", _errors); + _errors = internalRequire( + LibString.eq(getVersion(address(_factory)), getVersion(disputeGameFactoryImpl)), "DF-10", _errors + ); _errors = internalRequire( getProxyImplementation(_admin, address(_factory)) == disputeGameFactoryImpl, "DF-20", _errors ); @@ -644,7 +626,9 @@ contract OPContractsManagerStandardValidator is ISemver { { _errorPrefix = string.concat(_errorPrefix, "-DWETH"); _errors = internalRequire( - LibString.eq(getVersion(address(_weth)), delayedWETHVersion()), string.concat(_errorPrefix, "-10"), _errors + LibString.eq(getVersion(address(_weth)), getVersion(delayedWETHImpl)), + string.concat(_errorPrefix, "-10"), + _errors ); _errors = internalRequire( getProxyImplementation(_admin, address(_weth)) == delayedWETHImpl, @@ -676,7 +660,7 @@ contract OPContractsManagerStandardValidator is ISemver { { _errorPrefix = string.concat(_errorPrefix, "-ANCHORP"); _errors = internalRequire( - LibString.eq(getVersion(address(_asr)), anchorStateRegistryVersion()), + LibString.eq(getVersion(address(_asr)), getVersion(anchorStateRegistryImpl)), string.concat(_errorPrefix, "-10"), _errors ); @@ -707,9 +691,9 @@ contract OPContractsManagerStandardValidator is ISemver { _errorPrefix = string.concat(_errorPrefix, "-VM"); _errors = internalRequire(address(_mips) == mipsImpl, string.concat(_errorPrefix, "-10"), _errors); _errors = internalRequire( - LibString.eq(getVersion(address(_mips)), mipsVersion()), string.concat(_errorPrefix, "-20"), _errors + LibString.eq(getVersion(address(_mips)), getVersion(mipsImpl)), string.concat(_errorPrefix, "-20"), _errors ); - _errors = internalRequire(_mips.stateVersion() == 7, string.concat(_errorPrefix, "-30"), _errors); + _errors = internalRequire(_mips.stateVersion() == 8, string.concat(_errorPrefix, "-30"), _errors); return _errors; } diff --git a/packages/contracts-bedrock/src/L1/OptimismPortal2.sol b/packages/contracts-bedrock/src/L1/OptimismPortal2.sol index ef2f8c8cb0e..92292831947 100644 --- a/packages/contracts-bedrock/src/L1/OptimismPortal2.sol +++ b/packages/contracts-bedrock/src/L1/OptimismPortal2.sol @@ -16,6 +16,7 @@ import { Hashing } from "src/libraries/Hashing.sol"; import { SecureMerkleTrie } from "src/libraries/trie/SecureMerkleTrie.sol"; import { AddressAliasHelper } from "src/vendor/AddressAliasHelper.sol"; import { GameStatus, GameType } from "src/dispute/lib/Types.sol"; +import { Features } from "src/libraries/Features.sol"; // Interfaces import { ISemver } from "interfaces/universal/ISemver.sol"; @@ -119,11 +120,15 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase /// @notice Address of the AnchorStateRegistry contract. IAnchorStateRegistry public anchorStateRegistry; - /// @notice Address of the ETHLockbox contract. + /// @notice Address of the ETHLockbox contract. NOTE that as of v4.1.0 it is not possible to + /// set this value in storage and it is only possible for this value to be set if the + /// chain was first upgraded to v4.0.0. Chains that skip v4.0.0 will not have any + /// ETHLockbox set here. IETHLockbox public ethLockbox; - /// @notice Whether the OptimismPortal is using Super Roots or Output Roots. - bool public superRootsActive; + /// @custom:legacy + /// @custom:spacer superRootsActive + bool private spacer_63_20_1; /// @notice Emitted when a transaction is deposited from L1 to L2. The parameters of this event /// are read by the rollup node and used to derive deposit transactions on L2. @@ -151,23 +156,6 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase /// @param success Whether the withdrawal transaction was successful. event WithdrawalFinalized(bytes32 indexed withdrawalHash, bool success); - /// @notice Emitted when the total ETH balance is migrated to the ETHLockbox. - /// @param lockbox The address of the ETHLockbox contract. - /// @param ethBalance Amount of ETH migrated. - event ETHMigrated(address indexed lockbox, uint256 ethBalance); - - /// @notice Emitted when the ETHLockbox contract is updated. - /// @param oldLockbox The address of the old ETHLockbox contract. - /// @param newLockbox The address of the new ETHLockbox contract. - /// @param oldAnchorStateRegistry The address of the old AnchorStateRegistry contract. - /// @param newAnchorStateRegistry The address of the new AnchorStateRegistry contract. - event PortalMigrated( - IETHLockbox oldLockbox, - IETHLockbox newLockbox, - IAnchorStateRegistry oldAnchorStateRegistry, - IAnchorStateRegistry newAnchorStateRegistry - ); - /// @notice Thrown when a withdrawal has already been finalized. error OptimismPortal_AlreadyFinalized(); @@ -213,32 +201,17 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase /// @notice Thrown when a withdrawal has not been proven. error OptimismPortal_Unproven(); - /// @notice Thrown when the caller is not authorized to call the function. - error OptimismPortal_Unauthorized(); - - /// @notice Thrown when the wrong proof method is used. - error OptimismPortal_WrongProofMethod(); - - /// @notice Thrown when a super root proof is invalid. - error OptimismPortal_InvalidSuperRootProof(); - - /// @notice Thrown when an output root index is invalid. - error OptimismPortal_InvalidOutputRootIndex(); - - /// @notice Thrown when an output root chain id is invalid. - error OptimismPortal_InvalidOutputRootChainId(); - - /// @notice Thrown when trying to migrate to the same AnchorStateRegistry. - error OptimismPortal_MigratingToSameRegistry(); + /// @notice Thrown when ETHLockbox is set/unset incorrectly depending on the feature flag. + error OptimismPortal_InvalidLockboxState(); /// @notice Semantic version. - /// @custom:semver 4.6.0 + /// @custom:semver 5.1.0 function version() public pure virtual returns (string memory) { - return "4.6.0"; + return "5.1.0"; } /// @param _proofMaturityDelaySeconds The proof maturity delay in seconds. - constructor(uint256 _proofMaturityDelaySeconds) ReinitializableBase(2) { + constructor(uint256 _proofMaturityDelaySeconds) ReinitializableBase(3) { PROOF_MATURITY_DELAY_SECONDS = _proofMaturityDelaySeconds; _disableInitializers(); } @@ -246,11 +219,9 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase /// @notice Initializer. /// @param _systemConfig Address of the SystemConfig. /// @param _anchorStateRegistry Address of the AnchorStateRegistry. - /// @param _ethLockbox Contract of the ETHLockbox. function initialize( ISystemConfig _systemConfig, - IAnchorStateRegistry _anchorStateRegistry, - IETHLockbox _ethLockbox + IAnchorStateRegistry _anchorStateRegistry ) external reinitializer(initVersion()) @@ -261,7 +232,9 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase // Now perform initialization logic. systemConfig = _systemConfig; anchorStateRegistry = _anchorStateRegistry; - ethLockbox = _ethLockbox; + + // Assert that the lockbox state is valid. + _assertValidLockboxState(); // Set the l2Sender slot, only if it is currently empty. This signals the first // initialization of the contract. @@ -269,27 +242,10 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase l2Sender = Constants.DEFAULT_L2_SENDER; } + // Initialize the ResourceMetering contract. __ResourceMetering_init(); } - /// @notice Upgrades the OptimismPortal contract to have a reference to the AnchorStateRegistry and SystemConfig - /// @param _anchorStateRegistry AnchorStateRegistry contract. - /// @param _ethLockbox ETHLockbox contract. - function upgrade( - IAnchorStateRegistry _anchorStateRegistry, - IETHLockbox _ethLockbox - ) - external - reinitializer(initVersion()) - { - // Upgrade transactions must come from the ProxyAdmin or its owner. - _assertOnlyProxyAdminOrProxyAdminOwner(); - - // Now perform upgrade logic. - anchorStateRegistry = _anchorStateRegistry; - ethLockbox = _ethLockbox; - } - /// @notice Getter for the current paused status. function paused() public view returns (bool) { return systemConfig.paused(); @@ -370,96 +326,6 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase // Intentionally empty. } - /// @notice Migrates the total ETH balance to the ETHLockbox. - function migrateLiquidity() public { - // Liquidity migration can only be triggered by the ProxyAdmin owner. - _assertOnlyProxyAdminOwner(); - - // Migrate the liquidity. - uint256 ethBalance = address(this).balance; - ethLockbox.lockETH{ value: ethBalance }(); - emit ETHMigrated(address(ethLockbox), ethBalance); - } - - /// @notice Allows the owner of the ProxyAdmin to migrate the OptimismPortal to use a new - /// lockbox, point at a new AnchorStateRegistry, and start to use the Super Roots proof - /// method. Primarily used for OptimismPortal instances to join the interop set, but - /// can also be used to swap the proof method from Output Roots to Super Roots if the - /// provided lockbox is the same as the current one. - /// @dev It is possible to change lockboxes without migrating liquidity. This can cause one - /// of the OptimismPortal instances connected to the new lockbox to not be able to - /// unlock sufficient ETH to finalize withdrawals which would trigger reverts. To avoid - /// this issue, guarantee that this function is called atomically alongside the - /// ETHLockbox.migrateLiquidity() function within the same transaction. - /// @param _newLockbox The address of the new ETHLockbox contract. - /// @param _newAnchorStateRegistry The address of the new AnchorStateRegistry contract. - function migrateToSuperRoots(IETHLockbox _newLockbox, IAnchorStateRegistry _newAnchorStateRegistry) external { - // Migration can only be triggered when the system is not paused because the migration can - // potentially unpause the system as a result of the modified ETHLockbox address. - _assertNotPaused(); - - // Migration can only be triggered by the ProxyAdmin owner. - _assertOnlyProxyAdminOwner(); - - // Chains can use this method to swap the proof method from Output Roots to Super Roots - // without joining the interop set. In this case, the old and new lockboxes will be the - // same. However, whether or not a chain is joining the interop set, all chains will need a - // new AnchorStateRegistry when migrating to Super Roots. We therefore check that the new - // AnchorStateRegistry is different than the old one to prevent this function from being - // accidentally misused. - if (anchorStateRegistry == _newAnchorStateRegistry) { - revert OptimismPortal_MigratingToSameRegistry(); - } - - // Update the ETHLockbox. - IETHLockbox oldLockbox = ethLockbox; - ethLockbox = _newLockbox; - - // Update the AnchorStateRegistry. - IAnchorStateRegistry oldAnchorStateRegistry = anchorStateRegistry; - anchorStateRegistry = _newAnchorStateRegistry; - - // Set the proof method to Super Roots. We expect that migration will happen more than once - // for some chains (switching to single-chain Super Roots and then later joining the - // interop set) so we don't need to check that this is false. - superRootsActive = true; - - // Emit a PortalMigrated event. - emit PortalMigrated(oldLockbox, _newLockbox, oldAnchorStateRegistry, _newAnchorStateRegistry); - } - - /// @notice Proves a withdrawal transaction using a Super Root proof. Only callable when the - /// OptimismPortal is using Super Roots (superRootsActive flag is true). - /// @param _tx Withdrawal transaction to finalize. - /// @param _disputeGameProxy Address of the dispute game to prove the withdrawal against. - /// @param _outputRootIndex Index of the target Output Root within the Super Root. - /// @param _superRootProof Inclusion proof of the Output Root within the Super Root. - /// @param _outputRootProof Inclusion proof of the L2ToL1MessagePasser storage root. - /// @param _withdrawalProof Inclusion proof of the withdrawal within the L2ToL1MessagePasser. - function proveWithdrawalTransaction( - Types.WithdrawalTransaction memory _tx, - IDisputeGame _disputeGameProxy, - uint256 _outputRootIndex, - Types.SuperRootProof calldata _superRootProof, - Types.OutputRootProof calldata _outputRootProof, - bytes[] calldata _withdrawalProof - ) - external - { - // Cannot prove withdrawal transactions while the system is paused. - _assertNotPaused(); - - // Make sure that the OptimismPortal is using Super Roots. - if (!superRootsActive) { - revert OptimismPortal_WrongProofMethod(); - } - - // Prove the transaction. - _proveWithdrawalTransaction( - _tx, _disputeGameProxy, _outputRootIndex, _superRootProof, _outputRootProof, _withdrawalProof - ); - } - /// @notice Proves a withdrawal transaction using an Output Root proof. Only callable when the /// OptimismPortal is using Output Roots (superRootsActive flag is false). /// @param _tx Withdrawal transaction to finalize. @@ -477,59 +343,26 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase // Cannot prove withdrawal transactions while the system is paused. _assertNotPaused(); - // Make sure that the OptimismPortal is using Output Roots. - if (superRootsActive) { - revert OptimismPortal_WrongProofMethod(); - } - // Fetch the dispute game proxy from the `DisputeGameFactory` contract. (,, IDisputeGame disputeGameProxy) = disputeGameFactory().gameAtIndex(_disputeGameIndex); - // Create a dummy super root proof to pass into the internal function. Note that this is - // not a valid Super Root proof but it isn't used anywhere in the internal function when - // using Output Roots. - Types.SuperRootProof memory superRootProof; - - // Prove the transaction. - _proveWithdrawalTransaction(_tx, disputeGameProxy, 0, superRootProof, _outputRootProof, _withdrawalProof); - } - - /// @notice Internal function for proving a withdrawal transaction, used by both the Super Root - /// and Output Root proof functions. Will eventually be replaced with a single function - /// when the Output Root proof method is deprecated. - /// @param _tx Withdrawal transaction to prove. - /// @param _disputeGameProxy Address of the dispute game to prove the withdrawal against. - /// @param _outputRootIndex Index of the target Output Root within the Super Root. - /// @param _superRootProof Inclusion proof of the Output Root within the Super Root. - /// @param _outputRootProof Inclusion proof of the L2ToL1MessagePasser storage root. - /// @param _withdrawalProof Inclusion proof of the withdrawal within the L2ToL1MessagePasser. - function _proveWithdrawalTransaction( - Types.WithdrawalTransaction memory _tx, - IDisputeGame _disputeGameProxy, - uint256 _outputRootIndex, - Types.SuperRootProof memory _superRootProof, - Types.OutputRootProof memory _outputRootProof, - bytes[] memory _withdrawalProof - ) - internal - { // Make sure that the target address is safe. if (_isUnsafeTarget(_tx.target)) { revert OptimismPortal_BadTarget(); } // Game must be a Proper Game. - if (!anchorStateRegistry.isGameProper(_disputeGameProxy)) { + if (!anchorStateRegistry.isGameProper(disputeGameProxy)) { revert OptimismPortal_ImproperDisputeGame(); } // Game must have been respected game type when created. - if (!anchorStateRegistry.isGameRespected(_disputeGameProxy)) { + if (!anchorStateRegistry.isGameRespected(disputeGameProxy)) { revert OptimismPortal_InvalidDisputeGame(); } // Game must not have resolved in favor of the Challenger (invalid root claim). - if (_disputeGameProxy.status() == GameStatus.CHALLENGER_WINS) { + if (disputeGameProxy.status() == GameStatus.CHALLENGER_WINS) { revert OptimismPortal_InvalidDisputeGame(); } @@ -537,37 +370,13 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase // the dispute game's creation timestamp. Not strictly necessary but extra layer of // safety against weird bugs. Note that this blocks withdrawals from being proven in the // same block that a dispute game is created. - if (block.timestamp <= _disputeGameProxy.createdAt().raw()) { + if (block.timestamp <= disputeGameProxy.createdAt().raw()) { revert OptimismPortal_InvalidProofTimestamp(); } - // Validate the provided Output Root and/or Super Root proof depending on proof method. - if (superRootsActive) { - // Verify that the super root can be generated with the elements in the proof. - if (_disputeGameProxy.rootClaim().raw() != Hashing.hashSuperRootProof(_superRootProof)) { - revert OptimismPortal_InvalidSuperRootProof(); - } - - // Check that the index exists in the super root proof. - if (_outputRootIndex >= _superRootProof.outputRoots.length) { - revert OptimismPortal_InvalidOutputRootIndex(); - } - - // Check that the output root has the correct chain id. - Types.OutputRootWithChainId memory outputRoot = _superRootProof.outputRoots[_outputRootIndex]; - if (outputRoot.chainId != systemConfig.l2ChainId()) { - revert OptimismPortal_InvalidOutputRootChainId(); - } - - // Verify that the output root can be generated with the elements in the proof. - if (outputRoot.root != Hashing.hashOutputRootProof(_outputRootProof)) { - revert OptimismPortal_InvalidOutputRootProof(); - } - } else { - // Verify that the output root can be generated with the elements in the proof. - if (_disputeGameProxy.rootClaim().raw() != Hashing.hashOutputRootProof(_outputRootProof)) { - revert OptimismPortal_InvalidOutputRootProof(); - } + // Verify that the output root can be generated with the elements in the proof. + if (disputeGameProxy.rootClaim().raw() != Hashing.hashOutputRootProof(_outputRootProof)) { + revert OptimismPortal_InvalidOutputRootProof(); } // Load the ProvenWithdrawal into memory, using the withdrawal hash as a unique identifier. @@ -602,7 +411,7 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase // the provenWithdrawals mapping. A given user may re-prove a withdrawalHash multiple // times, but each proof will reset the proof timer. provenWithdrawals[withdrawalHash][msg.sender] = - ProvenWithdrawal({ disputeGameProxy: _disputeGameProxy, timestamp: uint64(block.timestamp) }); + ProvenWithdrawal({ disputeGameProxy: disputeGameProxy, timestamp: uint64(block.timestamp) }); // Add the proof submitter to the list of proof submitters for this withdrawal hash. proofSubmitters[withdrawalHash].push(msg.sender); @@ -651,8 +460,10 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase // Mark the withdrawal as finalized so it can't be replayed. finalizedWithdrawals[withdrawalHash] = true; - // Unlock the ETH from the ETHLockbox. - if (_tx.value > 0) ethLockbox.unlockETH(_tx.value); + // If using ETHLockbox, unlock the ETH from the ETHLockbox. + if (_isUsingLockbox()) { + if (_tx.value > 0) ethLockbox.unlockETH(_tx.value); + } // Set the l2Sender so contracts know who triggered this withdrawal on L2. l2Sender = _tx.sender; @@ -673,10 +484,12 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase // be achieved through contracts built on top of this contract emit WithdrawalFinalized(withdrawalHash, success); - // Send ETH back to the Lockbox in the case of a failed transaction or it'll get stuck here - // and would need to be moved back via the migrateLiquidity function. - if (!success && _tx.value > 0) { - ethLockbox.lockETH{ value: _tx.value }(); + // If using ETHLockbox, send ETH back to the Lockbox in the case of a failed transaction or + // it'll get stuck here and would need to be moved back via admin action. + if (_isUsingLockbox()) { + if (!success && _tx.value > 0) { + ethLockbox.lockETH{ value: _tx.value }(); + } } // Reverting here is useful for determining the exact gas cost to successfully execute the @@ -748,8 +561,10 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase payable metered(_gasLimit) { - // Lock the ETH in the ETHLockbox. - if (msg.value > 0) ethLockbox.lockETH{ value: msg.value }(); + // If using ETHLockbox, lock the ETH in the ETHLockbox. + if (_isUsingLockbox()) { + if (msg.value > 0) ethLockbox.lockETH{ value: msg.value }(); + } // Just to be safe, make sure that people specify address(0) as the target when doing // contract creations. @@ -794,6 +609,12 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase return proofSubmitters[_withdrawalHash].length; } + /// @notice Checks if the ETHLockbox feature is enabled. + /// @return bool True if the ETHLockbox feature is enabled. + function _isUsingLockbox() internal view returns (bool) { + return systemConfig.isFeatureEnabled(Features.ETH_LOCKBOX) && address(ethLockbox) != address(0); + } + /// @notice Asserts that the contract is not paused. function _assertNotPaused() internal view { if (paused()) { @@ -801,6 +622,16 @@ contract OptimismPortal2 is Initializable, ResourceMetering, ReinitializableBase } } + /// @notice Asserts that the ETHLockbox is set/unset correctly depending on the feature flag. + function _assertValidLockboxState() internal view { + if ( + systemConfig.isFeatureEnabled(Features.ETH_LOCKBOX) && address(ethLockbox) == address(0) + || !systemConfig.isFeatureEnabled(Features.ETH_LOCKBOX) && address(ethLockbox) != address(0) + ) { + revert OptimismPortal_InvalidLockboxState(); + } + } + /// @notice Checks if a target address is unsafe. function _isUnsafeTarget(address _target) internal view virtual returns (bool) { // Prevent users from targeting an unsafe target address on a withdrawal transaction. diff --git a/packages/contracts-bedrock/src/L1/OptimismPortalInterop.sol b/packages/contracts-bedrock/src/L1/OptimismPortalInterop.sol new file mode 100644 index 00000000000..54db98d889f --- /dev/null +++ b/packages/contracts-bedrock/src/L1/OptimismPortalInterop.sol @@ -0,0 +1,816 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.15; + +// Contracts +import { ProxyAdminOwnedBase } from "src/L1/ProxyAdminOwnedBase.sol"; +import { Initializable } from "@openzeppelin/contracts/proxy/utils/Initializable.sol"; +import { ResourceMetering } from "src/L1/ResourceMetering.sol"; +import { ReinitializableBase } from "src/universal/ReinitializableBase.sol"; + +// Libraries +import { EOA } from "src/libraries/EOA.sol"; +import { SafeCall } from "src/libraries/SafeCall.sol"; +import { Constants } from "src/libraries/Constants.sol"; +import { Types } from "src/libraries/Types.sol"; +import { Hashing } from "src/libraries/Hashing.sol"; +import { SecureMerkleTrie } from "src/libraries/trie/SecureMerkleTrie.sol"; +import { AddressAliasHelper } from "src/vendor/AddressAliasHelper.sol"; +import { GameStatus, GameType } from "src/dispute/lib/Types.sol"; + +// Interfaces +import { ISemver } from "interfaces/universal/ISemver.sol"; +import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol"; +import { IResourceMetering } from "interfaces/L1/IResourceMetering.sol"; +import { IDisputeGameFactory } from "interfaces/dispute/IDisputeGameFactory.sol"; +import { IDisputeGame } from "interfaces/dispute/IDisputeGame.sol"; +import { IAnchorStateRegistry } from "interfaces/dispute/IAnchorStateRegistry.sol"; +import { IETHLockbox } from "interfaces/L1/IETHLockbox.sol"; +import { ISuperchainConfig } from "interfaces/L1/ISuperchainConfig.sol"; + +/// @custom:proxied true +/// @title OptimismPortalInterop +/// @notice The OptimismPortal is a low-level contract responsible for passing messages between L1 +/// and L2. Messages sent directly to the OptimismPortal have no form of replayability. +/// Users are encouraged to use the L1CrossDomainMessenger for a higher-level interface. +contract OptimismPortalInterop is Initializable, ResourceMetering, ReinitializableBase, ProxyAdminOwnedBase, ISemver { + /// @notice Represents a proven withdrawal. + /// @custom:field disputeGameProxy Game that the withdrawal was proven against. + /// @custom:field timestamp Timestamp at which the withdrawal was proven. + struct ProvenWithdrawal { + IDisputeGame disputeGameProxy; + uint64 timestamp; + } + + /// @notice The delay between when a withdrawal is proven and when it may be finalized. + uint256 internal immutable PROOF_MATURITY_DELAY_SECONDS; + + /// @notice Version of the deposit event. + uint256 internal constant DEPOSIT_VERSION = 0; + + /// @notice The L2 gas limit set when eth is deposited using the receive() function. + uint64 internal constant RECEIVE_DEFAULT_GAS_LIMIT = 100_000; + + /// @notice Address of the L2 account which initiated a withdrawal in this transaction. + /// If the value of this variable is the default L2 sender address, then we are NOT + /// inside of a call to finalizeWithdrawalTransaction. + address public l2Sender; + + /// @notice A list of withdrawal hashes which have been successfully finalized. + mapping(bytes32 => bool) public finalizedWithdrawals; + + /// @custom:legacy + /// @custom:spacer provenWithdrawals + /// @notice Spacer taking up the legacy `provenWithdrawals` mapping slot. + bytes32 private spacer_52_0_32; + + /// @custom:legacy + /// @custom:spacer paused + /// @notice Spacer for backwards compatibility. + bool private spacer_53_0_1; + + /// @custom:legacy + /// @custom:spacer superchainConfig + /// @notice Spacer for backwards compatibility. + address private spacer_53_1_20; + + /// @custom:legacy + /// @custom:spacer l2Oracle + /// @notice Spacer taking up the legacy `l2Oracle` address slot. + address private spacer_54_0_20; + + /// @notice Address of the SystemConfig contract. + /// @custom:network-specific + ISystemConfig public systemConfig; + + /// @custom:network-specific + /// @custom:legacy + /// @custom:spacer disputeGameFactory + /// @notice Spacer taking up the legacy `disputeGameFactory` address slot. + address private spacer_56_0_20; + + /// @notice A mapping of withdrawal hashes to proof submitters to ProvenWithdrawal data. + mapping(bytes32 => mapping(address => ProvenWithdrawal)) public provenWithdrawals; + + /// @custom:legacy + /// @custom:spacer disputeGameBlacklist + bytes32 private spacer_58_0_32; + + /// @custom:legacy + /// @custom:spacer respectedGameType + GameType private spacer_59_0_4; + + /// @custom:legacy + /// @custom:spacer respectedGameTypeUpdatedAt + uint64 private spacer_59_4_8; + + /// @notice Mapping of withdrawal hashes to addresses that have submitted a proof for the + /// withdrawal. Original OptimismPortal contract only allowed one proof to be submitted + /// for any given withdrawal hash. Fault Proofs version of this contract must allow + /// multiple proofs for the same withdrawal hash to prevent a malicious user from + /// blocking other withdrawals by proving them against invalid proposals. Submitters + /// are tracked in an array to simplify the off-chain process of determining which + /// proof submission should be used when finalizing a withdrawal. + mapping(bytes32 => address[]) public proofSubmitters; + + /// @custom:legacy + /// @custom:spacer _balance + uint256 private spacer_61_0_32; + + /// @notice Address of the AnchorStateRegistry contract. + IAnchorStateRegistry public anchorStateRegistry; + + /// @notice Address of the ETHLockbox contract. + IETHLockbox public ethLockbox; + + /// @notice Whether the OptimismPortal is using Super Roots or Output Roots. + bool public superRootsActive; + + /// @notice Emitted when a transaction is deposited from L1 to L2. The parameters of this event + /// are read by the rollup node and used to derive deposit transactions on L2. + /// @param from Address that triggered the deposit transaction. + /// @param to Address that the deposit transaction is directed to. + /// @param version Version of this deposit transaction event. + /// @param opaqueData ABI encoded deposit data to be parsed off-chain. + event TransactionDeposited(address indexed from, address indexed to, uint256 indexed version, bytes opaqueData); + + /// @notice Emitted when a withdrawal transaction is proven. + /// @param withdrawalHash Hash of the withdrawal transaction. + /// @param from Address that triggered the withdrawal transaction. + /// @param to Address that the withdrawal transaction is directed to. + event WithdrawalProven(bytes32 indexed withdrawalHash, address indexed from, address indexed to); + + /// @notice Emitted when a withdrawal transaction is proven. Exists as a separate event to + /// allow for backwards compatibility for tooling that observes the WithdrawalProven + /// event. + /// @param withdrawalHash Hash of the withdrawal transaction. + /// @param proofSubmitter Address of the proof submitter. + event WithdrawalProvenExtension1(bytes32 indexed withdrawalHash, address indexed proofSubmitter); + + /// @notice Emitted when a withdrawal transaction is finalized. + /// @param withdrawalHash Hash of the withdrawal transaction. + /// @param success Whether the withdrawal transaction was successful. + event WithdrawalFinalized(bytes32 indexed withdrawalHash, bool success); + + /// @notice Emitted when the total ETH balance is migrated to the ETHLockbox. + /// @param lockbox The address of the ETHLockbox contract. + /// @param ethBalance Amount of ETH migrated. + event ETHMigrated(address indexed lockbox, uint256 ethBalance); + + /// @notice Emitted when the ETHLockbox contract is updated. + /// @param oldLockbox The address of the old ETHLockbox contract. + /// @param newLockbox The address of the new ETHLockbox contract. + /// @param oldAnchorStateRegistry The address of the old AnchorStateRegistry contract. + /// @param newAnchorStateRegistry The address of the new AnchorStateRegistry contract. + event PortalMigrated( + IETHLockbox oldLockbox, + IETHLockbox newLockbox, + IAnchorStateRegistry oldAnchorStateRegistry, + IAnchorStateRegistry newAnchorStateRegistry + ); + + /// @notice Thrown when a withdrawal has already been finalized. + error OptimismPortal_AlreadyFinalized(); + + /// @notice Thrown when the target of a withdrawal is unsafe. + error OptimismPortal_BadTarget(); + + /// @notice Thrown when the calldata for a deposit is too large. + error OptimismPortal_CalldataTooLarge(); + + /// @notice Thrown when the portal is paused. + error OptimismPortal_CallPaused(); + + /// @notice Thrown when a gas estimation transaction is being executed. + error OptimismPortal_GasEstimation(); + + /// @notice Thrown when the gas limit for a deposit is too low. + error OptimismPortal_GasLimitTooLow(); + + /// @notice Thrown when the target of a withdrawal is not a proper dispute game. + error OptimismPortal_ImproperDisputeGame(); + + /// @notice Thrown when a withdrawal has not been proven against a valid dispute game. + error OptimismPortal_InvalidDisputeGame(); + + /// @notice Thrown when a withdrawal has not been proven against a valid merkle proof. + error OptimismPortal_InvalidMerkleProof(); + + /// @notice Thrown when a withdrawal has not been proven against a valid output root proof. + error OptimismPortal_InvalidOutputRootProof(); + + /// @notice Thrown when a withdrawal's timestamp is not greater than the dispute game's creation timestamp. + error OptimismPortal_InvalidProofTimestamp(); + + /// @notice Thrown when the root claim of a dispute game is invalid. + error OptimismPortal_InvalidRootClaim(); + + /// @notice Thrown when a withdrawal is being finalized by a reentrant call. + error OptimismPortal_NoReentrancy(); + + /// @notice Thrown when a withdrawal has not been proven for long enough. + error OptimismPortal_ProofNotOldEnough(); + + /// @notice Thrown when a withdrawal has not been proven. + error OptimismPortal_Unproven(); + + /// @notice Thrown when the wrong proof method is used. + error OptimismPortal_WrongProofMethod(); + + /// @notice Thrown when a super root proof is invalid. + error OptimismPortal_InvalidSuperRootProof(); + + /// @notice Thrown when an output root index is invalid. + error OptimismPortal_InvalidOutputRootIndex(); + + /// @notice Thrown when an output root chain id is invalid. + error OptimismPortal_InvalidOutputRootChainId(); + + /// @notice Thrown when trying to migrate to the same AnchorStateRegistry. + error OptimismPortal_MigratingToSameRegistry(); + + /// @notice Semantic version. + /// @custom:semver 5.1.0+interop + function version() public pure virtual returns (string memory) { + return "5.1.0+interop"; + } + + /// @param _proofMaturityDelaySeconds The proof maturity delay in seconds. + constructor(uint256 _proofMaturityDelaySeconds) ReinitializableBase(4) { + PROOF_MATURITY_DELAY_SECONDS = _proofMaturityDelaySeconds; + _disableInitializers(); + } + + /// @notice Initializer. + /// @param _systemConfig Address of the SystemConfig. + /// @param _anchorStateRegistry Address of the AnchorStateRegistry. + /// @param _ethLockbox Contract of the ETHLockbox. + function initialize( + ISystemConfig _systemConfig, + IAnchorStateRegistry _anchorStateRegistry, + IETHLockbox _ethLockbox + ) + external + reinitializer(initVersion()) + { + // Initialization transactions must come from the ProxyAdmin or its owner. + _assertOnlyProxyAdminOrProxyAdminOwner(); + + // Now perform initialization logic. + systemConfig = _systemConfig; + anchorStateRegistry = _anchorStateRegistry; + ethLockbox = _ethLockbox; + + // Set the l2Sender slot, only if it is currently empty. This signals the first + // initialization of the contract. + if (l2Sender == address(0)) { + l2Sender = Constants.DEFAULT_L2_SENDER; + } + + __ResourceMetering_init(); + } + + /// @notice Upgrades the OptimismPortal contract to have a reference to the AnchorStateRegistry and SystemConfig + /// @param _anchorStateRegistry AnchorStateRegistry contract. + /// @param _ethLockbox ETHLockbox contract. + function upgrade( + IAnchorStateRegistry _anchorStateRegistry, + IETHLockbox _ethLockbox + ) + external + reinitializer(initVersion()) + { + // Upgrade transactions must come from the ProxyAdmin or its owner. + _assertOnlyProxyAdminOrProxyAdminOwner(); + + // Now perform upgrade logic. + anchorStateRegistry = _anchorStateRegistry; + ethLockbox = _ethLockbox; + } + + /// @notice Getter for the current paused status. + function paused() public view returns (bool) { + return systemConfig.paused(); + } + + /// @notice Getter for the proof maturity delay. + function proofMaturityDelaySeconds() public view returns (uint256) { + return PROOF_MATURITY_DELAY_SECONDS; + } + + /// @notice Getter for the address of the DisputeGameFactory contract. + function disputeGameFactory() public view returns (IDisputeGameFactory) { + return anchorStateRegistry.disputeGameFactory(); + } + + /// @notice Returns the SuperchainConfig contract. + /// @return ISuperchainConfig The SuperchainConfig contract. + function superchainConfig() external view returns (ISuperchainConfig) { + return systemConfig.superchainConfig(); + } + + /// @custom:legacy + /// @notice Getter function for the address of the guardian. + function guardian() external view returns (address) { + return systemConfig.guardian(); + } + + /// @custom:legacy + /// @notice Getter for the dispute game finality delay. + function disputeGameFinalityDelaySeconds() external view returns (uint256) { + return anchorStateRegistry.disputeGameFinalityDelaySeconds(); + } + + /// @custom:legacy + /// @notice Getter for the respected game type. + function respectedGameType() external view returns (GameType) { + return anchorStateRegistry.respectedGameType(); + } + + /// @custom:legacy + /// @notice Getter for the retirement timestamp. Note that this value NO LONGER reflects the + /// timestamp at which the respected game type was updated. Game retirement and + /// respected game type value have been decoupled, this function now only returns the + /// retirement timestamp. + function respectedGameTypeUpdatedAt() external view returns (uint64) { + return anchorStateRegistry.retirementTimestamp(); + } + + /// @custom:legacy + /// @notice Getter for the dispute game blacklist. + /// @param _disputeGame The dispute game to check. + /// @return Whether the dispute game is blacklisted. + function disputeGameBlacklist(IDisputeGame _disputeGame) public view returns (bool) { + return anchorStateRegistry.disputeGameBlacklist(_disputeGame); + } + + /// @notice Computes the minimum gas limit for a deposit. + /// The minimum gas limit linearly increases based on the size of the calldata. + /// This is to prevent users from creating L2 resource usage without paying for it. + /// This function can be used when interacting with the portal to ensure forwards + /// compatibility. + /// @param _byteCount Number of bytes in the calldata. + /// @return The minimum gas limit for a deposit. + function minimumGasLimit(uint64 _byteCount) public pure returns (uint64) { + return _byteCount * 40 + 21000; + } + + /// @notice Accepts value so that users can send ETH directly to this contract and have the + /// funds be deposited to their address on L2. This is intended as a convenience + /// function for EOAs. Contracts should call the depositTransaction() function directly + /// otherwise any deposited funds will be lost due to address aliasing. + receive() external payable { + depositTransaction(msg.sender, msg.value, RECEIVE_DEFAULT_GAS_LIMIT, false, bytes("")); + } + + /// @notice Accepts ETH value without triggering a deposit to L2. + function donateETH() external payable { + // Intentionally empty. + } + + /// @notice Migrates the total ETH balance to the ETHLockbox. + function migrateLiquidity() public { + // Liquidity migration can only be triggered by the ProxyAdmin owner. + _assertOnlyProxyAdminOwner(); + + // Migrate the liquidity. + uint256 ethBalance = address(this).balance; + ethLockbox.lockETH{ value: ethBalance }(); + emit ETHMigrated(address(ethLockbox), ethBalance); + } + + /// @notice Allows the owner of the ProxyAdmin to migrate the OptimismPortal to use a new + /// lockbox, point at a new AnchorStateRegistry, and start to use the Super Roots proof + /// method. Primarily used for OptimismPortal instances to join the interop set, but + /// can also be used to swap the proof method from Output Roots to Super Roots if the + /// provided lockbox is the same as the current one. + /// @dev It is possible to change lockboxes without migrating liquidity. This can cause one + /// of the OptimismPortal instances connected to the new lockbox to not be able to + /// unlock sufficient ETH to finalize withdrawals which would trigger reverts. To avoid + /// this issue, guarantee that this function is called atomically alongside the + /// ETHLockbox.migrateLiquidity() function within the same transaction. + /// @param _newLockbox The address of the new ETHLockbox contract. + /// @param _newAnchorStateRegistry The address of the new AnchorStateRegistry contract. + function migrateToSuperRoots(IETHLockbox _newLockbox, IAnchorStateRegistry _newAnchorStateRegistry) external { + // Migration can only be triggered when the system is not paused because the migration can + // potentially unpause the system as a result of the modified ETHLockbox address. + _assertNotPaused(); + + // Migration can only be triggered by the ProxyAdmin owner. + _assertOnlyProxyAdminOwner(); + + // Chains can use this method to swap the proof method from Output Roots to Super Roots + // without joining the interop set. In this case, the old and new lockboxes will be the + // same. However, whether or not a chain is joining the interop set, all chains will need a + // new AnchorStateRegistry when migrating to Super Roots. We therefore check that the new + // AnchorStateRegistry is different than the old one to prevent this function from being + // accidentally misused. + if (anchorStateRegistry == _newAnchorStateRegistry) { + revert OptimismPortal_MigratingToSameRegistry(); + } + + // Update the ETHLockbox. + IETHLockbox oldLockbox = ethLockbox; + ethLockbox = _newLockbox; + + // Update the AnchorStateRegistry. + IAnchorStateRegistry oldAnchorStateRegistry = anchorStateRegistry; + anchorStateRegistry = _newAnchorStateRegistry; + + // Set the proof method to Super Roots. We expect that migration will happen more than once + // for some chains (switching to single-chain Super Roots and then later joining the + // interop set) so we don't need to check that this is false. + superRootsActive = true; + + // Emit a PortalMigrated event. + emit PortalMigrated(oldLockbox, _newLockbox, oldAnchorStateRegistry, _newAnchorStateRegistry); + } + + /// @notice Proves a withdrawal transaction using a Super Root proof. Only callable when the + /// OptimismPortal is using Super Roots (superRootsActive flag is true). + /// @param _tx Withdrawal transaction to finalize. + /// @param _disputeGameProxy Address of the dispute game to prove the withdrawal against. + /// @param _outputRootIndex Index of the target Output Root within the Super Root. + /// @param _superRootProof Inclusion proof of the Output Root within the Super Root. + /// @param _outputRootProof Inclusion proof of the L2ToL1MessagePasser storage root. + /// @param _withdrawalProof Inclusion proof of the withdrawal within the L2ToL1MessagePasser. + function proveWithdrawalTransaction( + Types.WithdrawalTransaction memory _tx, + IDisputeGame _disputeGameProxy, + uint256 _outputRootIndex, + Types.SuperRootProof calldata _superRootProof, + Types.OutputRootProof calldata _outputRootProof, + bytes[] calldata _withdrawalProof + ) + external + { + // Cannot prove withdrawal transactions while the system is paused. + _assertNotPaused(); + + // Make sure that the OptimismPortal is using Super Roots. + if (!superRootsActive) { + revert OptimismPortal_WrongProofMethod(); + } + + // Prove the transaction. + _proveWithdrawalTransaction( + _tx, _disputeGameProxy, _outputRootIndex, _superRootProof, _outputRootProof, _withdrawalProof + ); + } + + /// @notice Proves a withdrawal transaction using an Output Root proof. Only callable when the + /// OptimismPortal is using Output Roots (superRootsActive flag is false). + /// @param _tx Withdrawal transaction to finalize. + /// @param _disputeGameIndex Index of the dispute game to prove the withdrawal against. + /// @param _outputRootProof Inclusion proof of the L2ToL1MessagePasser storage root. + /// @param _withdrawalProof Inclusion proof of the withdrawal within the L2ToL1MessagePasser. + function proveWithdrawalTransaction( + Types.WithdrawalTransaction memory _tx, + uint256 _disputeGameIndex, + Types.OutputRootProof calldata _outputRootProof, + bytes[] calldata _withdrawalProof + ) + external + { + // Cannot prove withdrawal transactions while the system is paused. + _assertNotPaused(); + + // Make sure that the OptimismPortal is using Output Roots. + if (superRootsActive) { + revert OptimismPortal_WrongProofMethod(); + } + + // Fetch the dispute game proxy from the `DisputeGameFactory` contract. + (,, IDisputeGame disputeGameProxy) = disputeGameFactory().gameAtIndex(_disputeGameIndex); + + // Create a dummy super root proof to pass into the internal function. Note that this is + // not a valid Super Root proof but it isn't used anywhere in the internal function when + // using Output Roots. + Types.SuperRootProof memory superRootProof; + + // Prove the transaction. + _proveWithdrawalTransaction(_tx, disputeGameProxy, 0, superRootProof, _outputRootProof, _withdrawalProof); + } + + /// @notice Internal function for proving a withdrawal transaction, used by both the Super Root + /// and Output Root proof functions. Will eventually be replaced with a single function + /// when the Output Root proof method is deprecated. + /// @param _tx Withdrawal transaction to prove. + /// @param _disputeGameProxy Address of the dispute game to prove the withdrawal against. + /// @param _outputRootIndex Index of the target Output Root within the Super Root. + /// @param _superRootProof Inclusion proof of the Output Root within the Super Root. + /// @param _outputRootProof Inclusion proof of the L2ToL1MessagePasser storage root. + /// @param _withdrawalProof Inclusion proof of the withdrawal within the L2ToL1MessagePasser. + function _proveWithdrawalTransaction( + Types.WithdrawalTransaction memory _tx, + IDisputeGame _disputeGameProxy, + uint256 _outputRootIndex, + Types.SuperRootProof memory _superRootProof, + Types.OutputRootProof memory _outputRootProof, + bytes[] memory _withdrawalProof + ) + internal + { + // Make sure that the target address is safe. + if (_isUnsafeTarget(_tx.target)) { + revert OptimismPortal_BadTarget(); + } + + // Game must be a Proper Game. + if (!anchorStateRegistry.isGameProper(_disputeGameProxy)) { + revert OptimismPortal_ImproperDisputeGame(); + } + + // Game must have been respected game type when created. + if (!anchorStateRegistry.isGameRespected(_disputeGameProxy)) { + revert OptimismPortal_InvalidDisputeGame(); + } + + // Game must not have resolved in favor of the Challenger (invalid root claim). + if (_disputeGameProxy.status() == GameStatus.CHALLENGER_WINS) { + revert OptimismPortal_InvalidDisputeGame(); + } + + // As a sanity check, we make sure that the current timestamp is not less than or equal to + // the dispute game's creation timestamp. Not strictly necessary but extra layer of + // safety against weird bugs. Note that this blocks withdrawals from being proven in the + // same block that a dispute game is created. + if (block.timestamp <= _disputeGameProxy.createdAt().raw()) { + revert OptimismPortal_InvalidProofTimestamp(); + } + + // Validate the provided Output Root and/or Super Root proof depending on proof method. + if (superRootsActive) { + // Verify that the super root can be generated with the elements in the proof. + if (_disputeGameProxy.rootClaim().raw() != Hashing.hashSuperRootProof(_superRootProof)) { + revert OptimismPortal_InvalidSuperRootProof(); + } + + // Check that the index exists in the super root proof. + if (_outputRootIndex >= _superRootProof.outputRoots.length) { + revert OptimismPortal_InvalidOutputRootIndex(); + } + + // Check that the output root has the correct chain id. + Types.OutputRootWithChainId memory outputRoot = _superRootProof.outputRoots[_outputRootIndex]; + if (outputRoot.chainId != systemConfig.l2ChainId()) { + revert OptimismPortal_InvalidOutputRootChainId(); + } + + // Verify that the output root can be generated with the elements in the proof. + if (outputRoot.root != Hashing.hashOutputRootProof(_outputRootProof)) { + revert OptimismPortal_InvalidOutputRootProof(); + } + } else { + // Verify that the output root can be generated with the elements in the proof. + if (_disputeGameProxy.rootClaim().raw() != Hashing.hashOutputRootProof(_outputRootProof)) { + revert OptimismPortal_InvalidOutputRootProof(); + } + } + + // Load the ProvenWithdrawal into memory, using the withdrawal hash as a unique identifier. + bytes32 withdrawalHash = Hashing.hashWithdrawal(_tx); + + // Compute the storage slot of the withdrawal hash in the L2ToL1MessagePasser contract. + // Refer to the Solidity documentation for more information on how storage layouts are + // computed for mappings. + bytes32 storageKey = keccak256( + abi.encode( + withdrawalHash, + uint256(0) // The withdrawals mapping is at the first slot in the layout. + ) + ); + + // Verify that the hash of this withdrawal was stored in the L2toL1MessagePasser contract + // on L2. If this is true, under the assumption that the SecureMerkleTrie does not have + // bugs, then we know that this withdrawal was actually triggered on L2 and can therefore + // be relayed on L1. + if ( + SecureMerkleTrie.verifyInclusionProof({ + _key: abi.encode(storageKey), + _value: hex"01", + _proof: _withdrawalProof, + _root: _outputRootProof.messagePasserStorageRoot + }) == false + ) { + revert OptimismPortal_InvalidMerkleProof(); + } + + // Designate the withdrawalHash as proven by storing the disputeGameProxy and timestamp in + // the provenWithdrawals mapping. A given user may re-prove a withdrawalHash multiple + // times, but each proof will reset the proof timer. + provenWithdrawals[withdrawalHash][msg.sender] = + ProvenWithdrawal({ disputeGameProxy: _disputeGameProxy, timestamp: uint64(block.timestamp) }); + + // Add the proof submitter to the list of proof submitters for this withdrawal hash. + proofSubmitters[withdrawalHash].push(msg.sender); + + // Emit a WithdrawalProven events. + emit WithdrawalProven(withdrawalHash, _tx.sender, _tx.target); + emit WithdrawalProvenExtension1(withdrawalHash, msg.sender); + } + + /// @notice Finalizes a withdrawal transaction. + /// @param _tx Withdrawal transaction to finalize. + function finalizeWithdrawalTransaction(Types.WithdrawalTransaction memory _tx) external { + finalizeWithdrawalTransactionExternalProof(_tx, msg.sender); + } + + /// @notice Finalizes a withdrawal transaction, using an external proof submitter. + /// @param _tx Withdrawal transaction to finalize. + /// @param _proofSubmitter Address of the proof submitter. + function finalizeWithdrawalTransactionExternalProof( + Types.WithdrawalTransaction memory _tx, + address _proofSubmitter + ) + public + { + // Cannot finalize withdrawal transactions while the system is paused. + _assertNotPaused(); + + // Make sure that the l2Sender has not yet been set. The l2Sender is set to a value other + // than the default value when a withdrawal transaction is being finalized. This check is + // a defacto reentrancy guard. + if (l2Sender != Constants.DEFAULT_L2_SENDER) { + revert OptimismPortal_NoReentrancy(); + } + + // Make sure that the target address is safe. + if (_isUnsafeTarget(_tx.target)) { + revert OptimismPortal_BadTarget(); + } + + // Grab the withdrawal. + bytes32 withdrawalHash = Hashing.hashWithdrawal(_tx); + + // Check that the withdrawal can be finalized. + checkWithdrawal(withdrawalHash, _proofSubmitter); + + // Mark the withdrawal as finalized so it can't be replayed. + finalizedWithdrawals[withdrawalHash] = true; + + // Unlock the ETH from the ETHLockbox. + if (_tx.value > 0) ethLockbox.unlockETH(_tx.value); + + // Set the l2Sender so contracts know who triggered this withdrawal on L2. + l2Sender = _tx.sender; + + // Trigger the call to the target contract. We use a custom low level method + // SafeCall.callWithMinGas to ensure two key properties + // 1. Target contracts cannot force this call to run out of gas by returning a very large + // amount of data (and this is OK because we don't care about the returndata here). + // 2. The amount of gas provided to the execution context of the target is at least the + // gas limit specified by the user. If there is not enough gas in the current context + // to accomplish this, `callWithMinGas` will revert. + bool success = SafeCall.callWithMinGas(_tx.target, _tx.gasLimit, _tx.value, _tx.data); + + // Reset the l2Sender back to the default value. + l2Sender = Constants.DEFAULT_L2_SENDER; + + // All withdrawals are immediately finalized. Replayability can + // be achieved through contracts built on top of this contract + emit WithdrawalFinalized(withdrawalHash, success); + + // Send ETH back to the Lockbox in the case of a failed transaction or it'll get stuck here + // and would need to be moved back via the migrateLiquidity function. + if (!success && _tx.value > 0) { + ethLockbox.lockETH{ value: _tx.value }(); + } + + // Reverting here is useful for determining the exact gas cost to successfully execute the + // sub call to the target contract if the minimum gas limit specified by the user would not + // be sufficient to execute the sub call. + if (!success && tx.origin == Constants.ESTIMATION_ADDRESS) { + revert OptimismPortal_GasEstimation(); + } + } + + /// @notice Checks that a withdrawal has been proven and is ready to be finalized. + /// @param _withdrawalHash Hash of the withdrawal. + /// @param _proofSubmitter Address of the proof submitter. + function checkWithdrawal(bytes32 _withdrawalHash, address _proofSubmitter) public view { + // Grab the withdrawal and dispute game proxy. + ProvenWithdrawal memory provenWithdrawal = provenWithdrawals[_withdrawalHash][_proofSubmitter]; + IDisputeGame disputeGameProxy = provenWithdrawal.disputeGameProxy; + + // Check that this withdrawal has not already been finalized, this is replay protection. + if (finalizedWithdrawals[_withdrawalHash]) { + revert OptimismPortal_AlreadyFinalized(); + } + + // A withdrawal can only be finalized if it has been proven. We know that a withdrawal has + // been proven at least once when its timestamp is non-zero. Unproven withdrawals will have + // a timestamp of zero. + if (provenWithdrawal.timestamp == 0) { + revert OptimismPortal_Unproven(); + } + + // As a sanity check, we make sure that the proven withdrawal's timestamp is greater than + // starting timestamp inside the Dispute Game. Not strictly necessary but extra layer of + // safety against weird bugs in the proving step. Note that this blocks withdrawals that + // are proven in the same block that a dispute game is created. + if (provenWithdrawal.timestamp <= disputeGameProxy.createdAt().raw()) { + revert OptimismPortal_InvalidProofTimestamp(); + } + + // A proven withdrawal must wait at least `PROOF_MATURITY_DELAY_SECONDS` before finalizing. + if (block.timestamp - provenWithdrawal.timestamp <= PROOF_MATURITY_DELAY_SECONDS) { + revert OptimismPortal_ProofNotOldEnough(); + } + + // Check that the root claim is valid. + if (!anchorStateRegistry.isGameClaimValid(disputeGameProxy)) { + revert OptimismPortal_InvalidRootClaim(); + } + } + + /// @notice Accepts deposits of ETH and data, and emits a TransactionDeposited event for use in + /// deriving deposit transactions. Note that if a deposit is made by a contract, its + /// address will be aliased when retrieved using `tx.origin` or `msg.sender`. Consider + /// using the CrossDomainMessenger contracts for a simpler developer experience. + /// @dev The `msg.value` is locked on the ETHLockbox and minted as ETH when the deposit + /// arrives on L2, while `_value` specifies how much ETH to send to the target. + /// @param _to Target address on L2. + /// @param _value ETH value to send to the recipient. + /// @param _gasLimit Amount of L2 gas to purchase by burning gas on L1. + /// @param _isCreation Whether or not the transaction is a contract creation. + /// @param _data Data to trigger the recipient with. + function depositTransaction( + address _to, + uint256 _value, + uint64 _gasLimit, + bool _isCreation, + bytes memory _data + ) + public + payable + metered(_gasLimit) + { + // Lock the ETH in the ETHLockbox. + if (msg.value > 0) ethLockbox.lockETH{ value: msg.value }(); + + // Just to be safe, make sure that people specify address(0) as the target when doing + // contract creations. + if (_isCreation && _to != address(0)) { + revert OptimismPortal_BadTarget(); + } + + // Prevent depositing transactions that have too small of a gas limit. Users should pay + // more for more resource usage. + if (_gasLimit < minimumGasLimit(uint64(_data.length))) { + revert OptimismPortal_GasLimitTooLow(); + } + + // Prevent the creation of deposit transactions that have too much calldata. This gives an + // upper limit on the size of unsafe blocks over the p2p network. 120kb is chosen to ensure + // that the transaction can fit into the p2p network policy of 128kb even though deposit + // transactions are not gossipped over the p2p network. + if (_data.length > 120_000) { + revert OptimismPortal_CalldataTooLarge(); + } + + // Transform the from-address to its alias if the caller is a contract. + address from = msg.sender; + if (!EOA.isSenderEOA()) { + from = AddressAliasHelper.applyL1ToL2Alias(msg.sender); + } + + // Compute the opaque data that will be emitted as part of the TransactionDeposited event. + // We use opaque data so that we can update the TransactionDeposited event in the future + // without breaking the current interface. + bytes memory opaqueData = abi.encodePacked(msg.value, _value, _gasLimit, _isCreation, _data); + + // Emit a TransactionDeposited event so that the rollup node can derive a deposit + // transaction for this deposit. + emit TransactionDeposited(from, _to, DEPOSIT_VERSION, opaqueData); + } + + /// @notice External getter for the number of proof submitters for a withdrawal hash. + /// @param _withdrawalHash Hash of the withdrawal. + /// @return The number of proof submitters for the withdrawal hash. + function numProofSubmitters(bytes32 _withdrawalHash) external view returns (uint256) { + return proofSubmitters[_withdrawalHash].length; + } + + /// @notice Asserts that the contract is not paused. + function _assertNotPaused() internal view { + if (paused()) { + revert OptimismPortal_CallPaused(); + } + } + + /// @notice Checks if a target address is unsafe. + function _isUnsafeTarget(address _target) internal view virtual returns (bool) { + // Prevent users from targeting an unsafe target address on a withdrawal transaction. + return _target == address(this) || _target == address(ethLockbox); + } + + /// @notice Getter for the resource config. Used internally by the ResourceMetering contract. + /// The SystemConfig is the source of truth for the resource config. + /// @return config_ ResourceMetering ResourceConfig + function _resourceConfig() internal view override returns (ResourceMetering.ResourceConfig memory config_) { + IResourceMetering.ResourceConfig memory config = systemConfig.resourceConfig(); + assembly ("memory-safe") { + config_ := config + } + } +} diff --git a/packages/contracts-bedrock/src/L1/SuperchainConfig.sol b/packages/contracts-bedrock/src/L1/SuperchainConfig.sol index 870a35e1344..c0157fef35c 100644 --- a/packages/contracts-bedrock/src/L1/SuperchainConfig.sol +++ b/packages/contracts-bedrock/src/L1/SuperchainConfig.sol @@ -9,9 +9,6 @@ import { ReinitializableBase } from "src/universal/ReinitializableBase.sol"; // Interfaces import { ISemver } from "interfaces/universal/ISemver.sol"; -// Libraries -import { Storage } from "src/libraries/Storage.sol"; - /// @custom:proxied true /// @custom:audit none This contracts is not yet audited. /// @title SuperchainConfig @@ -59,8 +56,8 @@ contract SuperchainConfig is ProxyAdminOwnedBase, Initializable, Reinitializable event ConfigUpdate(UpdateType indexed updateType, bytes data); /// @notice Semantic version. - /// @custom:semver 2.3.0 - string public constant version = "2.3.0"; + /// @custom:semver 2.4.0 + string public constant version = "2.4.0"; /// @notice Constructs the SuperchainConfig contract. constructor() ReinitializableBase(2) { @@ -77,28 +74,6 @@ contract SuperchainConfig is ProxyAdminOwnedBase, Initializable, Reinitializable _setGuardian(_guardian); } - /// @notice Upgrades the SuperchainConfig contract. - function upgrade() external reinitializer(initVersion()) { - // Upgrade transactions must come from the ProxyAdmin or its owner. - _assertOnlyProxyAdminOrProxyAdminOwner(); - - // Now perform upgrade logic. - // Transfer the guardian into the new variable and clear the old storage slot. - // We generally do not clear out old storage slots but in the case of the SuperchainConfig - // these are the only spacer slots, they aren't cleanly represented by spacer variables, - // and we can get rid of them now and never think about them again later. - bytes32 guardianSlot = bytes32(uint256(keccak256("superchainConfig.guardian")) - 1); - _setGuardian(Storage.getAddress(guardianSlot)); - Storage.setBytes32(guardianSlot, bytes32(0)); - - // Clear the old paused slot. - // Note that if the pause was active while the upgrade was happening, the system will no - // longer be paused after the upgrade. Upgrades should generally not ever be executed while - // the system is paused, but it's worth noting that this is the case. - bytes32 pausedSlot = bytes32(uint256(keccak256("superchainConfig.paused")) - 1); - Storage.setBytes32(pausedSlot, bytes32(0)); - } - /// @notice Returns the duration after which a pause expires. /// @return The duration after which a pause expires. function pauseExpiry() external pure returns (uint256) { diff --git a/packages/contracts-bedrock/src/L1/SystemConfig.sol b/packages/contracts-bedrock/src/L1/SystemConfig.sol index 604a9936d3a..8a686b67bcf 100644 --- a/packages/contracts-bedrock/src/L1/SystemConfig.sol +++ b/packages/contracts-bedrock/src/L1/SystemConfig.sol @@ -8,13 +8,13 @@ import { ProxyAdminOwnedBase } from "src/L1/ProxyAdminOwnedBase.sol"; // Libraries import { Storage } from "src/libraries/Storage.sol"; +import { Features } from "src/libraries/Features.sol"; // Interfaces import { ISemver } from "interfaces/universal/ISemver.sol"; import { IResourceMetering } from "interfaces/L1/IResourceMetering.sol"; import { IOptimismPortal2 } from "interfaces/L1/IOptimismPortal2.sol"; import { ISuperchainConfig } from "interfaces/L1/ISuperchainConfig.sol"; -import { IETHLockbox } from "interfaces/L1/IETHLockbox.sol"; /// @custom:proxied true /// @title SystemConfig @@ -28,13 +28,17 @@ contract SystemConfig is ProxyAdminOwnedBase, OwnableUpgradeable, Reinitializabl /// @custom:value GAS_LIMIT Represents an update to gas limit on L2. /// @custom:value UNSAFE_BLOCK_SIGNER Represents an update to the signer key for unsafe /// block distrubution. + /// @custom:value EIP_1559_PARAMS Represents an update to EIP-1559 parameters. + /// @custom:value OPERATOR_FEE_PARAMS Represents an update to operator fee parameters. + /// @custom:value MIN_BASE_FEE Represents an update to the minimum base fee. enum UpdateType { BATCHER, FEE_SCALARS, GAS_LIMIT, UNSAFE_BLOCK_SIGNER, EIP_1559_PARAMS, - OPERATOR_FEE_PARAMS + OPERATOR_FEE_PARAMS, + MIN_BASE_FEE } /// @notice Struct representing the addresses of L1 system contracts. These should be the @@ -135,22 +139,37 @@ contract SystemConfig is ProxyAdminOwnedBase, OwnableUpgradeable, Reinitializabl /// @notice The SuperchainConfig contract that manages the pause state. ISuperchainConfig public superchainConfig; + /// @notice The minimum base fee, in wei. + uint64 public minBaseFee; + + /// @notice Bytes32 feature flag name to boolean enabled value. + mapping(bytes32 => bool) public isFeatureEnabled; + /// @notice Emitted when configuration is updated. /// @param version SystemConfig version. /// @param updateType Type of update. /// @param data Encoded update data. event ConfigUpdate(uint256 indexed version, UpdateType indexed updateType, bytes data); + /// @notice Emitted when a feature is set. + /// @param feature Feature that was set. + /// @param enabled Whether the feature is enabled. + event FeatureSet(bytes32 indexed feature, bool indexed enabled); + + /// @notice Thrown when attempting to enable/disable a feature when already enabled/disabled, + /// respectively. + error SystemConfig_InvalidFeatureState(); + /// @notice Semantic version. - /// @custom:semver 3.4.0 + /// @custom:semver 3.8.0 function version() public pure virtual returns (string memory) { - return "3.4.0"; + return "3.8.0"; } /// @notice Constructs the SystemConfig contract. /// @dev START_BLOCK_SLOT is set to type(uint256).max here so that it will be a dead value /// in the singleton. - constructor() ReinitializableBase(2) { + constructor() ReinitializableBase(3) { Storage.setUint(START_BLOCK_SLOT, type(uint256).max); _disableInitializers(); } @@ -213,27 +232,6 @@ contract SystemConfig is ProxyAdminOwnedBase, OwnableUpgradeable, Reinitializabl superchainConfig = _superchainConfig; } - /// @notice Upgrades the SystemConfig by adding a reference to the SuperchainConfig. - /// @param _l2ChainId The L2 chain ID that this SystemConfig configures. - /// @param _superchainConfig The SuperchainConfig contract address. - function upgrade(uint256 _l2ChainId, ISuperchainConfig _superchainConfig) external reinitializer(initVersion()) { - // Upgrade transactions must come from the ProxyAdmin or its owner. - _assertOnlyProxyAdminOrProxyAdminOwner(); - - // Now perform upgrade logic. - // Set the L2 chain ID. - l2ChainId = _l2ChainId; - - // Set the SuperchainConfig contract. - superchainConfig = _superchainConfig; - - // Clear out the old dispute game factory address, it's derived now. We get rid of this - // storage slot because it doesn't use structured storage and we can't use a spacer - // variable to block it off. - bytes32 disputeGameFactorySlot = bytes32(uint256(keccak256("systemconfig.disputegamefactory")) - 1); - Storage.setBytes32(disputeGameFactorySlot, bytes32(0)); - } - /// @notice Returns the minimum L2 gas limit that can be safely set for the system to /// operate. The L2 gas limit must be larger than or equal to the amount of /// gas that is allocated for deposits per block plus the amount of gas that @@ -419,6 +417,21 @@ contract SystemConfig is ProxyAdminOwnedBase, OwnableUpgradeable, Reinitializabl emit ConfigUpdate(VERSION, UpdateType.EIP_1559_PARAMS, data); } + /// @notice Updates the minimum base fee. Can only be called by the owner. + /// Setting this value to 0 is equivalent to disabling the min base fee feature + /// @param _minBaseFee New minimum base fee. + function setMinBaseFee(uint64 _minBaseFee) external onlyOwner { + _setMinBaseFee(_minBaseFee); + } + + /// @notice Internal function for updating the minimum base fee. + function _setMinBaseFee(uint64 _minBaseFee) internal { + minBaseFee = _minBaseFee; + + bytes memory data = abi.encode(_minBaseFee); + emit ConfigUpdate(VERSION, UpdateType.MIN_BASE_FEE, data); + } + /// @notice Updates the operator fee parameters. Can only be called by the owner. /// @param _operatorFeeScalar operator fee scalar. /// @param _operatorFeeConstant operator fee constant. @@ -484,12 +497,41 @@ contract SystemConfig is ProxyAdminOwnedBase, OwnableUpgradeable, Reinitializabl _resourceConfig = _config; } - /// @notice Returns the current pause state of the system by checking if the SuperchainConfig is paused for this - /// chain's ETHLockbox. + /// @notice Sets a feature flag enabled or disabled. Can only be called by the ProxyAdmin or + /// its owner. + /// @param _feature Feature to set. + /// @param _enabled Whether the feature should be enabled or disabled. + function setFeature(bytes32 _feature, bool _enabled) external { + // Features can only be set by the ProxyAdmin or its owner. + _assertOnlyProxyAdminOrProxyAdminOwner(); + + // As a sanity check, prevent users from enabling the feature if already enabled or + // disabling the feature if already disabled. This helps to prevent accidental misuse. + if ((_enabled && isFeatureEnabled[_feature]) || (!_enabled && !isFeatureEnabled[_feature])) { + revert SystemConfig_InvalidFeatureState(); + } + + // Set the feature. + isFeatureEnabled[_feature] = _enabled; + + // Emit an event. + emit FeatureSet(_feature, _enabled); + } + + /// @notice Returns the current pause state for this network. If the network is using + /// ETHLockbox, the system is paused if either the global pause is active or the pause + /// is active where the ETHLockbox address is used as the identifier. If the network is + /// not using ETHLockbox, the system is paused if either the global pause is active or + /// the pause is active where the OptimismPortal address is used as the identifier. /// @return bool True if the system is paused, false otherwise. function paused() public view returns (bool) { - IETHLockbox lockbox = IOptimismPortal2(payable(optimismPortal())).ethLockbox(); - return superchainConfig.paused(address(lockbox)) || superchainConfig.paused(address(0)); + // Determine the appropriate chain identifier based on the feature flags. + address identifier = isFeatureEnabled[Features.ETH_LOCKBOX] + ? address(IOptimismPortal2(payable(optimismPortal())).ethLockbox()) + : address(optimismPortal()); + + // Check if either global or local pause is active. + return superchainConfig.paused(address(0)) || superchainConfig.paused(identifier); } /// @notice Returns the guardian address of the SuperchainConfig. diff --git a/packages/contracts-bedrock/src/cannon/MIPS64.sol b/packages/contracts-bedrock/src/cannon/MIPS64.sol index ef632155a86..c00c705f4a6 100644 --- a/packages/contracts-bedrock/src/cannon/MIPS64.sol +++ b/packages/contracts-bedrock/src/cannon/MIPS64.sol @@ -66,8 +66,8 @@ contract MIPS64 is ISemver { } /// @notice The semantic version of the MIPS64 contract. - /// @custom:semver 1.8.0 - string public constant version = "1.8.0"; + /// @custom:semver 1.9.0 + string public constant version = "1.9.0"; /// @notice The preimage oracle contract. IPreimageOracle internal immutable ORACLE; @@ -273,8 +273,7 @@ contract MIPS64 is ISemver { memProofOffset: MIPS64Memory.memoryProofOffset(MEM_PROOF_OFFSET, 1), insn: insn, opcode: opcode, - fun: fun, - stateVersion: STATE_VERSION + fun: fun }); bool memUpdated; uint64 effMemAddr; @@ -568,9 +567,7 @@ contract MIPS64 is ISemver { } else if (syscall_no == sys.SYS_MUNMAP) { // ignored } else if (syscall_no == sys.SYS_MPROTECT) { - if (!st.featuresForVersion(STATE_VERSION).supportNoopMprotect) { - revert("MIPS64: unimplemented syscall"); - } + // ignored } else if (syscall_no == sys.SYS_GETAFFINITY) { // ignored } else if (syscall_no == sys.SYS_MADVISE) { @@ -630,10 +627,6 @@ contract MIPS64 is ISemver { } else if (syscall_no == sys.SYS_LSEEK) { // ignored } else if (syscall_no == sys.SYS_EVENTFD2) { - if (!st.featuresForVersion(STATE_VERSION).supportMinimalSysEventFd2) { - revert("MIPS64: unimplemented syscall"); - } - // a0 = initial value, a1 = flags // Validate flags if (a1 & sys.EFD_NONBLOCK == 0) { diff --git a/packages/contracts-bedrock/src/cannon/libraries/MIPS64Instructions.sol b/packages/contracts-bedrock/src/cannon/libraries/MIPS64Instructions.sol index 2c0f3acfa3c..42c150af3b3 100644 --- a/packages/contracts-bedrock/src/cannon/libraries/MIPS64Instructions.sol +++ b/packages/contracts-bedrock/src/cannon/libraries/MIPS64Instructions.sol @@ -34,8 +34,6 @@ library MIPS64Instructions { uint32 opcode; /// @param fun The function value parsed from insn. uint32 fun; - /// @param stateVersion The state version. - uint256 stateVersion; } struct ExecuteMipsInstructionParams { @@ -51,8 +49,6 @@ library MIPS64Instructions { uint64 rt; /// @param mem The value fetched from memory for the current instruction. uint64 mem; - /// @param stateVersion The state version. - uint256 stateVersion; } /// @param _pc The program counter. @@ -181,8 +177,7 @@ library MIPS64Instructions { fun: _args.fun, rs: rs, rt: rt, - mem: mem, - stateVersion: _args.stateVersion + mem: mem }); uint64 val = executeMipsInstruction(params) & U64_MASK; @@ -248,7 +243,6 @@ library MIPS64Instructions { uint64 rs = _args.rs; uint64 rt = _args.rt; uint64 mem = _args.mem; - uint256 stateVersion = _args.stateVersion; unchecked { if (opcode == 0 || (opcode >= 8 && opcode < 0xF) || opcode == 0x18 || opcode == 0x19) { assembly { @@ -494,7 +488,7 @@ library MIPS64Instructions { return i; } // dclz, dclo - else if (st.featuresForVersion(stateVersion).supportDclzDclo && (fun == 0x24 || fun == 0x25)) { + else if (fun == 0x24 || fun == 0x25) { if (fun == 0x24) { rs = ~rs; } diff --git a/packages/contracts-bedrock/src/cannon/libraries/MIPS64State.sol b/packages/contracts-bedrock/src/cannon/libraries/MIPS64State.sol index 9c74a730dc6..c19d1f66a00 100644 --- a/packages/contracts-bedrock/src/cannon/libraries/MIPS64State.sol +++ b/packages/contracts-bedrock/src/cannon/libraries/MIPS64State.sol @@ -13,9 +13,6 @@ library MIPS64State { } struct Features { - bool supportMinimalSysEventFd2; - bool supportDclzDclo; - bool supportNoopMprotect; bool supportWorkingSysGetRandom; } @@ -26,11 +23,6 @@ library MIPS64State { } function featuresForVersion(uint256 _version) internal pure returns (Features memory features_) { - if (_version >= 7) { - features_.supportMinimalSysEventFd2 = true; - features_.supportDclzDclo = true; - features_.supportNoopMprotect = true; - } if (_version >= 8) { features_.supportWorkingSysGetRandom = true; } diff --git a/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol b/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol index 3453d752c44..f9a9e2bf68b 100644 --- a/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol +++ b/packages/contracts-bedrock/src/dispute/DisputeGameFactory.sol @@ -36,6 +36,11 @@ contract DisputeGameFactory is ProxyAdminOwnedBase, ReinitializableBase, Ownable /// @param gameType The type of the DisputeGame. event ImplementationSet(address indexed impl, GameType indexed gameType); + /// @notice Emitted when a game type's implementation args are set + /// @param gameType The type of the DisputeGame. + /// @param args The constructor args for the game type. + event ImplementationArgsSet(GameType indexed gameType, bytes args); + /// @notice Emitted when a game type's initialization bond is updated /// @param gameType The type of the DisputeGame. /// @param newBond The new bond (in wei) for initializing the game type. @@ -51,8 +56,8 @@ contract DisputeGameFactory is ProxyAdminOwnedBase, ReinitializableBase, Ownable } /// @notice Semantic version. - /// @custom:semver 1.2.0 - string public constant version = "1.2.0"; + /// @custom:semver 1.3.0 + string public constant version = "1.3.0"; /// @notice `gameImpls` is a mapping that maps `GameType`s to their respective /// `IDisputeGame` implementations. @@ -69,6 +74,10 @@ contract DisputeGameFactory is ProxyAdminOwnedBase, ReinitializableBase, Ownable /// efficiently track dispute games. GameId[] internal _disputeGameList; + /// @notice Maps each Game Type to an associated configuration to use with it, but because we need to pass them + /// to a clone with immutable args so they have to be stored as arbitrary bytes unfortunately + mapping(GameType => bytes) public gameArgs; + /// @notice Constructs a new DisputeGameFactory contract. constructor() OwnableUpgradeable() ReinitializableBase(1) { _disableInitializers(); @@ -159,15 +168,18 @@ contract DisputeGameFactory is ProxyAdminOwnedBase, ReinitializableBase, Ownable // Clone the implementation contract and initialize it with the given parameters. // // CWIA Calldata Layout: - // ┌──────────────┬────────────────────────────────────┐ - // │ Bytes │ Description │ - // ├──────────────┼────────────────────────────────────┤ - // │ [0, 20) │ Game creator address │ - // │ [20, 52) │ Root claim │ - // │ [52, 84) │ Parent block hash at creation time │ - // │ [84, 84 + n) │ Extra data (opaque) │ - // └──────────────┴────────────────────────────────────┘ - proxy_ = IDisputeGame(address(impl).clone(abi.encodePacked(msg.sender, _rootClaim, parentHash, _extraData))); + // ┌──────────────────────┬─────────────────────────────────────┐ + // │ Bytes │ Description │ + // ├──────────────────────┼─────────────────────────────────────┤ + // │ [0, 20) │ Game creator address │ + // │ [20, 52) │ Root claim │ + // │ [52, 84) │ Parent block hash at creation time │ + // │ [84, 84 + n) │ Extra data (opaque) │ + // │ [84 + n, 84 + n + m) │ Implementation args (opaque) │ + // └──────────────────────┴─────────────────────────────────────┘ + proxy_ = IDisputeGame( + address(impl).clone(abi.encodePacked(msg.sender, _rootClaim, parentHash, _extraData, gameArgs[_gameType])) + ); proxy_.initialize{ value: msg.value }(); // Compute the unique identifier for the dispute game. @@ -268,6 +280,19 @@ contract DisputeGameFactory is ProxyAdminOwnedBase, ReinitializableBase, Ownable emit ImplementationSet(address(_impl), _gameType); } + /// @notice Sets the implementation contract for a specific `GameType`. + /// @dev May only be called by the `owner`. + /// @param _gameType The type of the DisputeGame. + /// @param _impl The implementation contract for the given `GameType`. + /// @param _args The constructor args to be passed for each implementation + function setImplementation(GameType _gameType, IDisputeGame _impl, bytes calldata _args) external onlyOwner { + gameImpls[_gameType] = _impl; + gameArgs[_gameType] = _args; + + emit ImplementationSet(address(_impl), _gameType); + emit ImplementationArgsSet(_gameType, _args); + } + /// @notice Sets the bond (in wei) for initializing a game type. /// @dev May only be called by the `owner`. /// @param _gameType The type of the DisputeGame. diff --git a/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol b/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol index bedb826f97f..8689221a03a 100644 --- a/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol +++ b/packages/contracts-bedrock/src/dispute/FaultDisputeGame.sol @@ -57,7 +57,8 @@ import { InvalidBondDistributionMode, GameNotResolved, ReservedGameType, - GamePaused + GamePaused, + BadExtraData } from "src/dispute/lib/Errors.sol"; // Interfaces @@ -171,9 +172,9 @@ contract FaultDisputeGame is Clone, ISemver { uint256 internal constant HEADER_BLOCK_NUMBER_INDEX = 8; /// @notice Semantic version. - /// @custom:semver 1.7.0 + /// @custom:semver 1.8.0 function version() public pure virtual returns (string memory) { - return "1.7.0"; + return "1.8.0"; } /// @notice The starting timestamp of the game @@ -312,20 +313,14 @@ contract FaultDisputeGame is Clone, ISemver { // in the factory, but are not used by the game, which would allow for multiple dispute games for the same // output proposal to be created. // - // Expected length: 0x7A - // - 0x04 selector - // - 0x14 creator address - // - 0x20 root claim - // - 0x20 l1 head - // - 0x20 extraData - // - 0x02 CWIA bytes - assembly { - if iszero(eq(calldatasize(), 0x7A)) { - // Store the selector for `BadExtraData()` & revert - mstore(0x00, 0x9824bdab) - revert(0x1C, 0x04) - } - } + // Expected length: 122 bytes + // - 4 bytes selector + // - 20 bytes creator address + // - 32 bytes root claim + // - 32 bytes l1 head + // - 32 bytes extraData + // - 2 bytes CWIA length + if (msg.data.length != 122) revert BadExtraData(); // Do not allow the game to be initialized if the root claim corresponds to a block at or before the // configured starting block number. @@ -645,7 +640,7 @@ contract FaultDisputeGame is Clone, ISemver { /// @notice The l2BlockNumber of the disputed output root in the `L2OutputOracle`. function l2BlockNumber() public pure returns (uint256 l2BlockNumber_) { - l2BlockNumber_ = _getArgUint256(0x54); + l2BlockNumber_ = _getArgUint256(84); } /// @notice The l2SequenceNumber of the disputed output root in the `L2OutputOracle` (in this case - block number). @@ -860,21 +855,21 @@ contract FaultDisputeGame is Clone, ISemver { /// @dev `clones-with-immutable-args` argument #1 /// @return creator_ The creator of the dispute game. function gameCreator() public pure returns (address creator_) { - creator_ = _getArgAddress(0x00); + creator_ = _getArgAddress(0); } /// @notice Getter for the root claim. /// @dev `clones-with-immutable-args` argument #2 /// @return rootClaim_ The root claim of the DisputeGame. function rootClaim() public pure returns (Claim rootClaim_) { - rootClaim_ = Claim.wrap(_getArgBytes32(0x14)); + rootClaim_ = Claim.wrap(_getArgBytes32(20)); } /// @notice Getter for the parent hash of the L1 block when the dispute game was created. /// @dev `clones-with-immutable-args` argument #3 /// @return l1Head_ The parent hash of the L1 block when the dispute game was created. function l1Head() public pure returns (Hash l1Head_) { - l1Head_ = Hash.wrap(_getArgBytes32(0x34)); + l1Head_ = Hash.wrap(_getArgBytes32(52)); } /// @notice Getter for the extra data. @@ -883,7 +878,7 @@ contract FaultDisputeGame is Clone, ISemver { function extraData() public pure returns (bytes memory extraData_) { // The extra data starts at the second word within the cwia calldata and // is 32 bytes long. - extraData_ = _getArgBytes(0x54, 0x20); + extraData_ = _getArgBytes(84, 32); } /// @notice A compliant implementation of this interface should return the components of the diff --git a/packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol b/packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol index 8e5574512dd..f356190ccdd 100644 --- a/packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol +++ b/packages/contracts-bedrock/src/dispute/PermissionedDisputeGame.sol @@ -32,9 +32,9 @@ contract PermissionedDisputeGame is FaultDisputeGame { } /// @notice Semantic version. - /// @custom:semver 1.7.0 + /// @custom:semver 1.8.0 function version() public pure override returns (string memory) { - return "1.7.0"; + return "1.8.0"; } /// @param _params Parameters for creating a new FaultDisputeGame. diff --git a/packages/contracts-bedrock/src/dispute/SuperFaultDisputeGame.sol b/packages/contracts-bedrock/src/dispute/SuperFaultDisputeGame.sol index 17c8a5bbd7b..ccb4e882395 100644 --- a/packages/contracts-bedrock/src/dispute/SuperFaultDisputeGame.sol +++ b/packages/contracts-bedrock/src/dispute/SuperFaultDisputeGame.sol @@ -50,7 +50,8 @@ import { InvalidBondDistributionMode, GameNotResolved, ReservedGameType, - GamePaused + GamePaused, + BadExtraData } from "src/dispute/lib/Errors.sol"; // Interfaces @@ -164,9 +165,9 @@ contract SuperFaultDisputeGame is Clone, ISemver { Position internal constant ROOT_POSITION = Position.wrap(1); /// @notice Semantic version. - /// @custom:semver 0.4.0 + /// @custom:semver 0.5.0 function version() public pure virtual returns (string memory) { - return "0.4.0"; + return "0.5.0"; } /// @notice The starting timestamp of the game @@ -302,20 +303,14 @@ contract SuperFaultDisputeGame is Clone, ISemver { // in the factory, but are not used by the game, which would allow for multiple dispute games for the same // output proposal to be created. // - // Expected length: 0x7A - // - 0x04 selector - // - 0x14 creator address - // - 0x20 root claim - // - 0x20 l1 head - // - 0x20 extraData - // - 0x02 CWIA bytes - assembly { - if iszero(eq(calldatasize(), 0x7A)) { - // Store the selector for `BadExtraData()` & revert - mstore(0x00, 0x9824bdab) - revert(0x1C, 0x04) - } - } + // Expected length: 122 bytes + // - 4 bytes selector + // - 20 bytes creator address + // - 32 bytes root claim + // - 32 bytes l1 head + // - 32 bytes extraData + // - 2 bytes CWIA length + if (msg.data.length != 122) revert BadExtraData(); // Do not allow the game to be initialized if the root claim corresponds to a l2 sequence number (timestamp) at // or before the configured starting sequence number. @@ -618,7 +613,7 @@ contract SuperFaultDisputeGame is Clone, ISemver { /// @notice The l2SequenceNumber (timestamp) of the disputed super root in game root claim. function l2SequenceNumber() public pure returns (uint256 l2SequenceNumber_) { - l2SequenceNumber_ = _getArgUint256(0x54); + l2SequenceNumber_ = _getArgUint256(84); } /// @notice Only the starting sequence number (timestamp) of the game. @@ -772,21 +767,21 @@ contract SuperFaultDisputeGame is Clone, ISemver { /// @dev `clones-with-immutable-args` argument #1 /// @return creator_ The creator of the dispute game. function gameCreator() public pure returns (address creator_) { - creator_ = _getArgAddress(0x00); + creator_ = _getArgAddress(0); } /// @notice Getter for the root claim. /// @dev `clones-with-immutable-args` argument #2 /// @return rootClaim_ The root claim of the DisputeGame. function rootClaim() public pure returns (Claim rootClaim_) { - rootClaim_ = Claim.wrap(_getArgBytes32(0x14)); + rootClaim_ = Claim.wrap(_getArgBytes32(20)); } /// @notice Getter for the parent hash of the L1 block when the dispute game was created. /// @dev `clones-with-immutable-args` argument #3 /// @return l1Head_ The parent hash of the L1 block when the dispute game was created. function l1Head() public pure returns (Hash l1Head_) { - l1Head_ = Hash.wrap(_getArgBytes32(0x34)); + l1Head_ = Hash.wrap(_getArgBytes32(52)); } /// @notice Getter for the extra data. @@ -795,7 +790,7 @@ contract SuperFaultDisputeGame is Clone, ISemver { function extraData() public pure returns (bytes memory extraData_) { // The extra data starts at the second word within the cwia calldata and // is 32 bytes long. - extraData_ = _getArgBytes(0x54, 0x20); + extraData_ = _getArgBytes(84, 32); } /// @notice A compliant implementation of this interface should return the components of the diff --git a/packages/contracts-bedrock/src/dispute/SuperPermissionedDisputeGame.sol b/packages/contracts-bedrock/src/dispute/SuperPermissionedDisputeGame.sol index d41e3f0171e..429bef26ce1 100644 --- a/packages/contracts-bedrock/src/dispute/SuperPermissionedDisputeGame.sol +++ b/packages/contracts-bedrock/src/dispute/SuperPermissionedDisputeGame.sol @@ -33,9 +33,9 @@ contract SuperPermissionedDisputeGame is SuperFaultDisputeGame { } /// @notice Semantic version. - /// @custom:semver 0.4.0 + /// @custom:semver 0.5.0 function version() public pure override returns (string memory) { - return "0.4.0"; + return "0.5.0"; } /// @param _params Parameters for creating a new FaultDisputeGame. diff --git a/packages/contracts-bedrock/src/dispute/lib/Types.sol b/packages/contracts-bedrock/src/dispute/lib/Types.sol index d7ca36663df..78e3e99d37d 100644 --- a/packages/contracts-bedrock/src/dispute/lib/Types.sol +++ b/packages/contracts-bedrock/src/dispute/lib/Types.sol @@ -70,6 +70,15 @@ library GameTypes { /// @notice A dispute game type that uses OP Succinct GameType internal constant OP_SUCCINCT = GameType.wrap(6); + /// @notice A dispute game type that uses the asterisc vm with Kona (Super Roots). + GameType internal constant SUPER_ASTERISC_KONA = GameType.wrap(7); + + /// @notice A dispute game type that uses the cannon vm with Kona. + GameType internal constant CANNON_KONA = GameType.wrap(8); + + /// @notice A dispute game type that uses the cannon vm with Kona (Super Roots). + GameType internal constant SUPER_CANNON_KONA = GameType.wrap(9); + /// @notice A dispute game type with short game duration for testing withdrawals. /// Not intended for production use. GameType internal constant FAST = GameType.wrap(254); diff --git a/packages/contracts-bedrock/src/dispute/v2/FaultDisputeGameV2.sol b/packages/contracts-bedrock/src/dispute/v2/FaultDisputeGameV2.sol new file mode 100644 index 00000000000..9417b9649c7 --- /dev/null +++ b/packages/contracts-bedrock/src/dispute/v2/FaultDisputeGameV2.sol @@ -0,0 +1,1308 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.15; + +// Libraries +import { Math } from "@openzeppelin/contracts/utils/math/Math.sol"; +import { FixedPointMathLib } from "@solady/utils/FixedPointMathLib.sol"; +import { Clone } from "@solady/utils/Clone.sol"; +import { Types } from "src/libraries/Types.sol"; +import { Hashing } from "src/libraries/Hashing.sol"; +import { RLPReader } from "src/libraries/rlp/RLPReader.sol"; +import { + GameStatus, + GameType, + BondDistributionMode, + Claim, + Clock, + Duration, + Timestamp, + Hash, + Proposal, + LibClock, + LocalPreimageKey, + VMStatuses +} from "src/dispute/lib/Types.sol"; +import { Position, LibPosition } from "src/dispute/lib/LibPosition.sol"; +import { + InvalidParent, + ClaimAlreadyExists, + ClaimAlreadyResolved, + OutOfOrderResolution, + InvalidChallengePeriod, + InvalidSplitDepth, + InvalidClockExtension, + MaxDepthTooLarge, + AnchorRootNotFound, + AlreadyInitialized, + UnexpectedRootClaim, + GameNotInProgress, + InvalidPrestate, + ValidStep, + GameDepthExceeded, + L2BlockNumberChallenged, + InvalidDisputedClaimIndex, + ClockTimeExceeded, + DuplicateStep, + CannotDefendRootClaim, + IncorrectBondAmount, + InvalidLocalIdent, + BlockNumberMatches, + InvalidHeaderRLP, + ClockNotExpired, + BondTransferFailed, + NoCreditToClaim, + InvalidOutputRootProof, + ClaimAboveSplit, + GameNotFinalized, + InvalidBondDistributionMode, + GameNotResolved, + ReservedGameType, + GamePaused, + BadExtraData +} from "src/dispute/lib/Errors.sol"; + +// Interfaces +import { ISemver } from "interfaces/universal/ISemver.sol"; +import { IDelayedWETH } from "interfaces/dispute/IDelayedWETH.sol"; +import { IBigStepper, IPreimageOracle } from "interfaces/dispute/IBigStepper.sol"; +import { IAnchorStateRegistry } from "interfaces/dispute/IAnchorStateRegistry.sol"; +import { IDisputeGame } from "interfaces/dispute/IDisputeGame.sol"; + +/// @title FaultDisputeGameV2 +/// @notice An implementation of the `IFaultDisputeGame` interface. +contract FaultDisputeGameV2 is Clone, ISemver { + //////////////////////////////////////////////////////////////// + // Structs // + //////////////////////////////////////////////////////////////// + + /// @notice The `ClaimData` struct represents the data associated with a Claim. + struct ClaimData { + uint32 parentIndex; + address counteredBy; + address claimant; + uint128 bond; + Claim claim; + Position position; + Clock clock; + } + + /// @notice The `ResolutionCheckpoint` struct represents the data associated with an in-progress claim resolution. + struct ResolutionCheckpoint { + bool initialCheckpointComplete; + uint32 subgameIndex; + Position leftmostPosition; + address counteredBy; + } + + /// @notice Parameters for creating a new FaultDisputeGame. We place this into a struct to + /// avoid stack-too-deep errors when compiling without the optimizer enabled. + struct GameConstructorParams { + GameType gameType; + uint256 maxGameDepth; + uint256 splitDepth; + Duration clockExtension; + Duration maxClockDuration; + } + + //////////////////////////////////////////////////////////////// + // Events // + //////////////////////////////////////////////////////////////// + + /// @notice Emitted when the game is resolved. + /// @param status The status of the game after resolution. + event Resolved(GameStatus indexed status); + + /// @notice Emitted when a new claim is added to the DAG by `claimant` + /// @param parentIndex The index within the `claimData` array of the parent claim + /// @param claim The claim being added + /// @param claimant The address of the claimant + event Move(uint256 indexed parentIndex, Claim indexed claim, address indexed claimant); + + /// @notice Emitted when the game is closed. + event GameClosed(BondDistributionMode bondDistributionMode); + + //////////////////////////////////////////////////////////////// + // State Vars // + //////////////////////////////////////////////////////////////// + + /// @notice The max depth of the game. + uint256 internal immutable MAX_GAME_DEPTH; + + /// @notice The max depth of the output bisection portion of the position tree. Immediately beneath + /// this depth, execution trace bisection begins. + uint256 internal immutable SPLIT_DEPTH; + + /// @notice The maximum duration that may accumulate on a team's chess clock before they may no longer respond. + Duration internal immutable MAX_CLOCK_DURATION; + + /// @notice The game type ID. + GameType internal immutable GAME_TYPE; + + /// @notice The duration of the clock extension. Will be doubled if the grandchild is the root claim of an execution + /// trace bisection subgame. + Duration internal immutable CLOCK_EXTENSION; + + /// @notice The global root claim's position is always at gindex 1. + Position internal constant ROOT_POSITION = Position.wrap(1); + + /// @notice The index of the block number in the RLP-encoded block header. + /// @dev Consensus encoding reference: + /// https://github.com/paradigmxyz/reth/blob/5f82993c23164ce8ccdc7bf3ae5085205383a5c8/crates/primitives/src/header.rs#L368 + uint256 internal constant HEADER_BLOCK_NUMBER_INDEX = 8; + + /// @notice Semantic version. + /// @custom:semver 2.0.0 + function version() public pure virtual returns (string memory) { + return "2.0.0"; + } + + /// @notice The starting timestamp of the game + Timestamp public createdAt; + + /// @notice The timestamp of the game's global resolution. + Timestamp public resolvedAt; + + /// @notice Returns the current status of the game. + GameStatus public status; + + /// @notice Flag for the `initialize` function to prevent re-initialization. + bool internal initialized; + + /// @notice Flag for whether or not the L2 block number claim has been invalidated via `challengeRootL2Block`. + bool public l2BlockNumberChallenged; + + /// @notice The challenger of the L2 block number claim. Should always be `address(0)` if `l2BlockNumberChallenged` + /// is `false`. Should be the address of the challenger if `l2BlockNumberChallenged` is `true`. + address public l2BlockNumberChallenger; + + /// @notice An append-only array of all claims made during the dispute game. + ClaimData[] public claimData; + + /// @notice Credited balances for winning participants. + mapping(address => uint256) public normalModeCredit; + + /// @notice A mapping to allow for constant-time lookups of existing claims. + mapping(Hash => bool) public claims; + + /// @notice A mapping of subgames rooted at a claim index to other claim indices in the subgame. + mapping(uint256 => uint256[]) public subgames; + + /// @notice A mapping of resolved subgames rooted at a claim index. + mapping(uint256 => bool) public resolvedSubgames; + + /// @notice A mapping of claim indices to resolution checkpoints. + mapping(uint256 => ResolutionCheckpoint) public resolutionCheckpoints; + + /// @notice The latest finalized output root, serving as the anchor for output bisection. + Proposal public startingOutputRoot; + + /// @notice A boolean for whether or not the game type was respected when the game was created. + bool public wasRespectedGameTypeWhenCreated; + + /// @notice A mapping of each claimant's refund mode credit. + mapping(address => uint256) public refundModeCredit; + + /// @notice A mapping of whether a claimant has unlocked their credit. + mapping(address => bool) public hasUnlockedCredit; + + /// @notice The bond distribution mode of the game. + BondDistributionMode public bondDistributionMode; + + /// @param _params Parameters for creating a new FaultDisputeGame. + constructor(GameConstructorParams memory _params) { + // The max game depth may not be greater than `LibPosition.MAX_POSITION_BITLEN - 1`. + if (_params.maxGameDepth > LibPosition.MAX_POSITION_BITLEN - 1) revert MaxDepthTooLarge(); + + // The split depth plus one cannot be greater than or equal to the max game depth. We add + // an additional depth to the split depth to avoid a bug in trace ancestor lookup. We know + // that the case where the split depth is the max value for uint256 is equivalent to the + // second check though we do need to check it explicitly to avoid an overflow. + if (_params.splitDepth == type(uint256).max || _params.splitDepth + 1 >= _params.maxGameDepth) { + revert InvalidSplitDepth(); + } + + // The split depth cannot be 0 or 1 to stay in bounds of clock extension arithmetic. + if (_params.splitDepth < 2) revert InvalidSplitDepth(); + + // Block type(uint32).max from being used as a game type so that it can be used in the + // OptimismPortal respected game type trick. + if (_params.gameType.raw() == type(uint32).max) revert ReservedGameType(); + + // Validate clock extension bounds that don't require VM access. + // The split depth extension is always clockExtension * 2. + uint256 splitDepthExtension = uint256(_params.clockExtension.raw()) * 2; + + // The split depth extension must fit into a uint64. + if (splitDepthExtension > type(uint64).max) revert InvalidClockExtension(); + + // The split depth extension may not be greater than the maximum clock duration. + if (uint64(splitDepthExtension) > _params.maxClockDuration.raw()) revert InvalidClockExtension(); + + // Set up initial game state. + GAME_TYPE = _params.gameType; + MAX_GAME_DEPTH = _params.maxGameDepth; + SPLIT_DEPTH = _params.splitDepth; + CLOCK_EXTENSION = _params.clockExtension; + MAX_CLOCK_DURATION = _params.maxClockDuration; + } + + /// @notice Initializes the contract. + /// @dev This function may only be called once. + function initialize() public payable virtual { + // SAFETY: Any revert in this function will bubble up to the DisputeGameFactory and + // prevent the game from being created. + // + // Implicit assumptions: + // - The `gameStatus` state variable defaults to 0, which is `GameStatus.IN_PROGRESS` + // - The dispute game factory will enforce the required bond to initialize the game. + // + // Explicit checks: + // - The game must not have already been initialized. + // - An output root cannot be proposed at or before the starting block number. + + // INVARIANT: The game must not have already been initialized. + if (initialized) revert AlreadyInitialized(); + + // Revert if the calldata size is not the expected length. + // + // This is to prevent adding extra or omitting bytes from to `extraData` that result in a different game UUID + // in the factory, but are not used by the game, which would allow for multiple dispute games for the same + // output proposal to be created. + // + // Expected length: 246 bytes + // - 4 bytes: selector + // - 2 bytes: CWIA length prefix + // - 20 bytes: creator address + // - 32 bytes: root claim + // - 32 bytes: l1 head + // - 32 bytes: extraData + // - 32 bytes: absolutePrestate + // - 20 bytes: vm address + // - 20 bytes: anchorStateRegistry address + // - 20 bytes: weth address + // - 32 bytes: l2ChainId + if (msg.data.length != 246) revert BadExtraData(); + + // Grab the latest anchor root. + (Hash root, uint256 rootBlockNumber) = anchorStateRegistry().getAnchorRoot(); + + // Should only happen if this is a new game type that hasn't been set up yet. + if (root.raw() == bytes32(0)) revert AnchorRootNotFound(); + + // Set the starting proposal. + startingOutputRoot = Proposal({ l2SequenceNumber: rootBlockNumber, root: root }); + + // Do not allow the game to be initialized if the root claim corresponds to a block at or before the + // configured starting block number. + if (l2BlockNumber() <= rootBlockNumber) revert UnexpectedRootClaim(rootClaim()); + + // Validate parameters that require access to the VM. + // The PreimageOracle challenge period must fit into uint64 so we can safely use it here. + if (vm().oracle().challengePeriod() > type(uint64).max) revert InvalidChallengePeriod(); + + // Determine the maximum clock extension which is either the split depth extension or the + // maximum game depth extension depending on the configuration of these contracts. + uint256 splitDepthExtension = uint256(CLOCK_EXTENSION.raw()) * 2; + uint256 maxGameDepthExtension = uint256(CLOCK_EXTENSION.raw()) + uint64(vm().oracle().challengePeriod()); + uint256 maxClockExtension = Math.max(splitDepthExtension, maxGameDepthExtension); + + // The maximum clock extension must fit into a uint64. + if (maxClockExtension > type(uint64).max) revert InvalidClockExtension(); + + // The maximum clock extension may not be greater than the maximum clock duration. + if (uint64(maxClockExtension) > MAX_CLOCK_DURATION.raw()) revert InvalidClockExtension(); + + // Set the root claim + claimData.push( + ClaimData({ + parentIndex: type(uint32).max, + counteredBy: address(0), + claimant: gameCreator(), + bond: uint128(msg.value), + claim: rootClaim(), + position: ROOT_POSITION, + clock: LibClock.wrap(Duration.wrap(0), Timestamp.wrap(uint64(block.timestamp))) + }) + ); + + // Set the game as initialized. + initialized = true; + + // Deposit the bond. + refundModeCredit[gameCreator()] += msg.value; + weth().deposit{ value: msg.value }(); + + // Set the game's starting timestamp + createdAt = Timestamp.wrap(uint64(block.timestamp)); + + // Set whether the game type was respected when the game was created. + wasRespectedGameTypeWhenCreated = + GameType.unwrap(anchorStateRegistry().respectedGameType()) == GameType.unwrap(GAME_TYPE); + } + + //////////////////////////////////////////////////////////////// + // `IFaultDisputeGame` impl // + //////////////////////////////////////////////////////////////// + + /// @notice Perform an instruction step via an on-chain fault proof processor. + /// @dev This function should point to a fault proof processor in order to execute + /// a step in the fault proof program on-chain. The interface of the fault proof + /// processor contract should adhere to the `IBigStepper` interface. + /// @param _claimIndex The index of the challenged claim within `claimData`. + /// @param _isAttack Whether or not the step is an attack or a defense. + /// @param _stateData The stateData of the step is the preimage of the claim at the given + /// prestate, which is at `_stateIndex` if the move is an attack and `_claimIndex` if + /// the move is a defense. If the step is an attack on the first instruction, it is + /// the absolute prestate of the fault proof VM. + /// @param _proof Proof to access memory nodes in the VM's merkle state tree. + function step( + uint256 _claimIndex, + bool _isAttack, + bytes calldata _stateData, + bytes calldata _proof + ) + public + virtual + { + // INVARIANT: Steps cannot be made unless the game is currently in progress. + if (status != GameStatus.IN_PROGRESS) revert GameNotInProgress(); + + // Get the parent. If it does not exist, the call will revert with OOB. + ClaimData storage parent = claimData[_claimIndex]; + + // Pull the parent position out of storage. + Position parentPos = parent.position; + // Determine the position of the step. + Position stepPos = parentPos.move(_isAttack); + + // INVARIANT: A step cannot be made unless the move position is 1 below the `MAX_GAME_DEPTH` + if (stepPos.depth() != MAX_GAME_DEPTH + 1) revert InvalidParent(); + + // Determine the expected pre & post states of the step. + Claim preStateClaim; + ClaimData storage postState; + if (_isAttack) { + // If the step position's index at depth is 0, the prestate is the absolute + // prestate. + // If the step is an attack at a trace index > 0, the prestate exists elsewhere in + // the game state. + // NOTE: We localize the `indexAtDepth` for the current execution trace subgame by finding + // the remainder of the index at depth divided by 2 ** (MAX_GAME_DEPTH - SPLIT_DEPTH), + // which is the number of leaves in each execution trace subgame. This is so that we can + // determine whether or not the step position is represents the `ABSOLUTE_PRESTATE`. + preStateClaim = (stepPos.indexAtDepth() % (1 << (MAX_GAME_DEPTH - SPLIT_DEPTH))) == 0 + ? absolutePrestate() + : _findTraceAncestor(Position.wrap(parentPos.raw() - 1), parent.parentIndex, false).claim; + // For all attacks, the poststate is the parent claim. + postState = parent; + } else { + // If the step is a defense, the poststate exists elsewhere in the game state, + // and the parent claim is the expected pre-state. + preStateClaim = parent.claim; + postState = _findTraceAncestor(Position.wrap(parentPos.raw() + 1), parent.parentIndex, false); + } + + // INVARIANT: The prestate is always invalid if the passed `_stateData` is not the + // preimage of the prestate claim hash. + // We ignore the highest order byte of the digest because it is used to + // indicate the VM Status and is added after the digest is computed. + if (keccak256(_stateData) << 8 != preStateClaim.raw() << 8) revert InvalidPrestate(); + + // Compute the local preimage context for the step. + Hash uuid = _findLocalContext(_claimIndex); + + // INVARIANT: If a step is an attack, the poststate is valid if the step produces + // the same poststate hash as the parent claim's value. + // If a step is a defense: + // 1. If the parent claim and the found post state agree with each other + // (depth diff % 2 == 0), the step is valid if it produces the same + // state hash as the post state's claim. + // 2. If the parent claim and the found post state disagree with each other + // (depth diff % 2 != 0), the parent cannot be countered unless the step + // produces the same state hash as `postState.claim`. + // SAFETY: While the `attack` path does not need an extra check for the post + // state's depth in relation to the parent, we don't need another + // branch because (n - n) % 2 == 0. + bool validStep = vm().step(_stateData, _proof, uuid.raw()) == postState.claim.raw(); + bool parentPostAgree = (parentPos.depth() - postState.position.depth()) % 2 == 0; + if (parentPostAgree == validStep) revert ValidStep(); + + // INVARIANT: A step cannot be made against a claim for a second time. + if (parent.counteredBy != address(0)) revert DuplicateStep(); + + // Set the parent claim as countered. We do not need to append a new claim to the game; + // instead, we can just set the existing parent as countered. + parent.counteredBy = msg.sender; + } + + /// @notice Generic move function, used for both `attack` and `defend` moves. + /// @param _disputed The disputed `Claim`. + /// @param _challengeIndex The index of the claim being moved against. + /// @param _claim The claim at the next logical position in the game. + /// @param _isAttack Whether or not the move is an attack or defense. + function move(Claim _disputed, uint256 _challengeIndex, Claim _claim, bool _isAttack) public payable virtual { + // INVARIANT: Moves cannot be made unless the game is currently in progress. + if (status != GameStatus.IN_PROGRESS) revert GameNotInProgress(); + + // Get the parent. If it does not exist, the call will revert with OOB. + ClaimData memory parent = claimData[_challengeIndex]; + + // INVARIANT: The claim at the _challengeIndex must be the disputed claim. + if (Claim.unwrap(parent.claim) != Claim.unwrap(_disputed)) revert InvalidDisputedClaimIndex(); + + // Compute the position that the claim commits to. Because the parent's position is already + // known, we can compute the next position by moving left or right depending on whether + // or not the move is an attack or defense. + Position parentPos = parent.position; + Position nextPosition = parentPos.move(_isAttack); + uint256 nextPositionDepth = nextPosition.depth(); + + // INVARIANT: A defense can never be made against the root claim of either the output root game or any + // of the execution trace bisection subgames. This is because the root claim commits to the + // entire state. Therefore, the only valid defense is to do nothing if it is agreed with. + if ((_challengeIndex == 0 || nextPositionDepth == SPLIT_DEPTH + 2) && !_isAttack) { + revert CannotDefendRootClaim(); + } + + // INVARIANT: No moves against the root claim can be made after it has been challenged with + // `challengeRootL2Block`.` + if (l2BlockNumberChallenged && _challengeIndex == 0) revert L2BlockNumberChallenged(); + + // INVARIANT: A move can never surpass the `MAX_GAME_DEPTH`. The only option to counter a + // claim at this depth is to perform a single instruction step on-chain via + // the `step` function to prove that the state transition produces an unexpected + // post-state. + if (nextPositionDepth > MAX_GAME_DEPTH) revert GameDepthExceeded(); + + // When the next position surpasses the split depth (i.e., it is the root claim of an execution + // trace bisection sub-game), we need to perform some extra verification steps. + if (nextPositionDepth == SPLIT_DEPTH + 1) { + _verifyExecBisectionRoot(_claim, _challengeIndex, parentPos, _isAttack); + } + + // INVARIANT: The `msg.value` must exactly equal the required bond. + if (getRequiredBond(nextPosition) != msg.value) revert IncorrectBondAmount(); + + // Compute the duration of the next clock. This is done by adding the duration of the + // grandparent claim to the difference between the current block timestamp and the + // parent's clock timestamp. + Duration nextDuration = getChallengerDuration(_challengeIndex); + + // INVARIANT: A move can never be made once its clock has exceeded `MAX_CLOCK_DURATION` + // seconds of time. + if (nextDuration.raw() == MAX_CLOCK_DURATION.raw()) revert ClockTimeExceeded(); + + // Clock extension is a mechanism that automatically extends the clock for a potential + // grandchild claim when there would be less than the clock extension time left if a player + // is forced to inherit another team's clock when countering a freeloader claim. Exact + // amount of clock extension time depends exactly where we are within the game. + uint64 actualExtension; + if (nextPositionDepth == MAX_GAME_DEPTH - 1) { + // If the next position is `MAX_GAME_DEPTH - 1` then we're about to execute a step. Our + // clock extension must therefore account for the LPP challenge period in addition to + // the standard clock extension. + actualExtension = CLOCK_EXTENSION.raw() + uint64(vm().oracle().challengePeriod()); + } else if (nextPositionDepth == SPLIT_DEPTH - 1) { + // If the next position is `SPLIT_DEPTH - 1` then we're about to begin an execution + // trace bisection and we need to give extra time for the off-chain challenge agent to + // be able to generate the initial instruction trace on the native FPVM. + actualExtension = CLOCK_EXTENSION.raw() * 2; + } else { + // Otherwise, we just use the standard clock extension. + actualExtension = CLOCK_EXTENSION.raw(); + } + + // Check if we need to apply the clock extension. + if (nextDuration.raw() > MAX_CLOCK_DURATION.raw() - actualExtension) { + nextDuration = Duration.wrap(MAX_CLOCK_DURATION.raw() - actualExtension); + } + + // Construct the next clock with the new duration and the current block timestamp. + Clock nextClock = LibClock.wrap(nextDuration, Timestamp.wrap(uint64(block.timestamp))); + + // INVARIANT: There cannot be multiple identical claims with identical moves on the same challengeIndex. Multiple + // claims at the same position may dispute the same challengeIndex. However, they must have different + // values. + Hash claimHash = _claim.hashClaimPos(nextPosition, _challengeIndex); + if (claims[claimHash]) revert ClaimAlreadyExists(); + claims[claimHash] = true; + + // Create the new claim. + claimData.push( + ClaimData({ + parentIndex: uint32(_challengeIndex), + // This is updated during subgame resolution + counteredBy: address(0), + claimant: msg.sender, + bond: uint128(msg.value), + claim: _claim, + position: nextPosition, + clock: nextClock + }) + ); + + // Update the subgame rooted at the parent claim. + subgames[_challengeIndex].push(claimData.length - 1); + + // Deposit the bond. + refundModeCredit[msg.sender] += msg.value; + weth().deposit{ value: msg.value }(); + + // Emit the appropriate event for the attack or defense. + emit Move(_challengeIndex, _claim, msg.sender); + } + + /// @notice Attack a disagreed upon `Claim`. + /// @param _disputed The `Claim` being attacked. + /// @param _parentIndex Index of the `Claim` to attack in the `claimData` array. This must match the `_disputed` + /// claim. + /// @param _claim The `Claim` at the relative attack position. + function attack(Claim _disputed, uint256 _parentIndex, Claim _claim) external payable { + move(_disputed, _parentIndex, _claim, true); + } + + /// @notice Defend an agreed upon `Claim`. + /// @notice _disputed The `Claim` being defended. + /// @param _parentIndex Index of the claim to defend in the `claimData` array. This must match the `_disputed` + /// claim. + /// @param _claim The `Claim` at the relative defense position. + function defend(Claim _disputed, uint256 _parentIndex, Claim _claim) external payable { + move(_disputed, _parentIndex, _claim, false); + } + + /// @notice Posts the requested local data to the VM's `PreimageOralce`. + /// @param _ident The local identifier of the data to post. + /// @param _execLeafIdx The index of the leaf claim in an execution subgame that requires the local data for a step. + /// @param _partOffset The offset of the data to post. + function addLocalData(uint256 _ident, uint256 _execLeafIdx, uint256 _partOffset) external { + // INVARIANT: Local data can only be added if the game is currently in progress. + if (status != GameStatus.IN_PROGRESS) revert GameNotInProgress(); + + (Claim starting, Position startingPos, Claim disputed, Position disputedPos) = + _findStartingAndDisputedOutputs(_execLeafIdx); + Hash uuid = _computeLocalContext(starting, startingPos, disputed, disputedPos); + + IPreimageOracle oracle = vm().oracle(); + if (_ident == LocalPreimageKey.L1_HEAD_HASH) { + // Load the L1 head hash + oracle.loadLocalData(_ident, uuid.raw(), l1Head().raw(), 32, _partOffset); + } else if (_ident == LocalPreimageKey.STARTING_OUTPUT_ROOT) { + // Load the starting proposal's output root. + oracle.loadLocalData(_ident, uuid.raw(), starting.raw(), 32, _partOffset); + } else if (_ident == LocalPreimageKey.DISPUTED_OUTPUT_ROOT) { + // Load the disputed proposal's output root + oracle.loadLocalData(_ident, uuid.raw(), disputed.raw(), 32, _partOffset); + } else if (_ident == LocalPreimageKey.DISPUTED_L2_BLOCK_NUMBER) { + // Load the disputed proposal's L2 block number as a big-endian uint64 in the + // high order 8 bytes of the word. + + // We add the index at depth + 1 to the starting block number to get the disputed L2 + // block number. + uint256 l2Number = startingOutputRoot.l2SequenceNumber + disputedPos.traceIndex(SPLIT_DEPTH) + 1; + + // Choose the minimum between the `l2BlockNumber` claim and the bisected-to L2 block number. + l2Number = l2Number < l2BlockNumber() ? l2Number : l2BlockNumber(); + + oracle.loadLocalData(_ident, uuid.raw(), bytes32(l2Number << 0xC0), 8, _partOffset); + } else if (_ident == LocalPreimageKey.CHAIN_ID) { + // Load the chain ID as a big-endian uint64 in the high order 8 bytes of the word. + oracle.loadLocalData(_ident, uuid.raw(), bytes32(l2ChainId() << 0xC0), 8, _partOffset); + } else { + revert InvalidLocalIdent(); + } + } + + /// @notice Returns the number of children that still need to be resolved in order to fully resolve a subgame rooted + /// at `_claimIndex`. + /// @param _claimIndex The subgame root claim's index within `claimData`. + /// @return numRemainingChildren_ The number of children that still need to be checked to resolve the subgame. + function getNumToResolve(uint256 _claimIndex) public view returns (uint256 numRemainingChildren_) { + ResolutionCheckpoint storage checkpoint = resolutionCheckpoints[_claimIndex]; + uint256[] storage challengeIndices = subgames[_claimIndex]; + uint256 challengeIndicesLen = challengeIndices.length; + + numRemainingChildren_ = challengeIndicesLen - checkpoint.subgameIndex; + } + + /// @notice The l2BlockNumber of the disputed output root in the `L2OutputOracle`. + function l2BlockNumber() public pure returns (uint256 l2BlockNumber_) { + l2BlockNumber_ = _getArgUint256(84); + } + + /// @notice The l2SequenceNumber of the disputed output root in the `L2OutputOracle` (in this case - block number). + function l2SequenceNumber() public pure returns (uint256 l2SequenceNumber_) { + l2SequenceNumber_ = l2BlockNumber(); + } + + /// @notice Only the starting block number of the game. + function startingBlockNumber() external view returns (uint256 startingBlockNumber_) { + startingBlockNumber_ = startingOutputRoot.l2SequenceNumber; + } + + /// @notice Starting output root and block number of the game. + function startingRootHash() external view returns (Hash startingRootHash_) { + startingRootHash_ = startingOutputRoot.root; + } + + /// @notice Challenges the root L2 block number by providing the preimage of the output root and the L2 block header + /// and showing that the committed L2 block number is incorrect relative to the claimed L2 block number. + /// @param _outputRootProof The output root proof. + /// @param _headerRLP The RLP-encoded L2 block header. + function challengeRootL2Block( + Types.OutputRootProof calldata _outputRootProof, + bytes calldata _headerRLP + ) + external + { + // INVARIANT: Moves cannot be made unless the game is currently in progress. + if (status != GameStatus.IN_PROGRESS) revert GameNotInProgress(); + + // The root L2 block claim can only be challenged once. + if (l2BlockNumberChallenged) revert L2BlockNumberChallenged(); + + // Verify the output root preimage. + if (Hashing.hashOutputRootProof(_outputRootProof) != rootClaim().raw()) revert InvalidOutputRootProof(); + + // Verify the block hash preimage. + if (keccak256(_headerRLP) != _outputRootProof.latestBlockhash) revert InvalidHeaderRLP(); + + // Decode the header RLP to find the number of the block. In the consensus encoding, the timestamp + // is the 9th element in the list that represents the block header. + RLPReader.RLPItem[] memory headerContents = RLPReader.readList(RLPReader.toRLPItem(_headerRLP)); + bytes memory rawBlockNumber = RLPReader.readBytes(headerContents[HEADER_BLOCK_NUMBER_INDEX]); + + // Sanity check the block number string length. + if (rawBlockNumber.length > 32) revert InvalidHeaderRLP(); + + // Convert the raw, left-aligned block number to a uint256 by aligning it as a big-endian + // number in the low-order bytes of a 32-byte word. + // + // SAFETY: The length of `rawBlockNumber` is checked above to ensure it is at most 32 bytes. + uint256 blockNumber; + assembly { + blockNumber := shr(shl(0x03, sub(0x20, mload(rawBlockNumber))), mload(add(rawBlockNumber, 0x20))) + } + + // Ensure the block number does not match the block number claimed in the dispute game. + if (blockNumber == l2BlockNumber()) revert BlockNumberMatches(); + + // Issue a special counter to the root claim. This counter will always win the root claim subgame, and receive + // the bond from the root claimant. + l2BlockNumberChallenger = msg.sender; + l2BlockNumberChallenged = true; + } + + //////////////////////////////////////////////////////////////// + // `IDisputeGame` impl // + //////////////////////////////////////////////////////////////// + + /// @notice If all necessary information has been gathered, this function should mark the game + /// status as either `CHALLENGER_WINS` or `DEFENDER_WINS` and return the status of + /// the resolved game. It is at this stage that the bonds should be awarded to the + /// necessary parties. + /// @dev May only be called if the `status` is `IN_PROGRESS`. + /// @return status_ The status of the game after resolution. + function resolve() external returns (GameStatus status_) { + // INVARIANT: Resolution cannot occur unless the game is currently in progress. + if (status != GameStatus.IN_PROGRESS) revert GameNotInProgress(); + + // INVARIANT: Resolution cannot occur unless the absolute root subgame has been resolved. + if (!resolvedSubgames[0]) revert OutOfOrderResolution(); + + // Update the global game status; The dispute has concluded. + status_ = claimData[0].counteredBy == address(0) ? GameStatus.DEFENDER_WINS : GameStatus.CHALLENGER_WINS; + resolvedAt = Timestamp.wrap(uint64(block.timestamp)); + + // Update the status and emit the resolved event, note that we're performing an assignment here. + emit Resolved(status = status_); + } + + /// @notice Resolves the subgame rooted at the given claim index. `_numToResolve` specifies how many children of + /// the subgame will be checked in this call. If `_numToResolve` is less than the number of children, an + /// internal cursor will be updated and this function may be called again to complete resolution of the + /// subgame. + /// @dev This function must be called bottom-up in the DAG + /// A subgame is a tree of claims that has a maximum depth of 1. + /// A subgame root claims is valid if, and only if, all of its child claims are invalid. + /// At the deepest level in the DAG, a claim is invalid if there's a successful step against it. + /// @param _claimIndex The index of the subgame root claim to resolve. + /// @param _numToResolve The number of subgames to resolve in this call. If the input is `0`, and this is the first + /// page, this function will attempt to check all of the subgame's children at once. + function resolveClaim(uint256 _claimIndex, uint256 _numToResolve) external { + // INVARIANT: Resolution cannot occur unless the game is currently in progress. + if (status != GameStatus.IN_PROGRESS) revert GameNotInProgress(); + + ClaimData storage subgameRootClaim = claimData[_claimIndex]; + Duration challengeClockDuration = getChallengerDuration(_claimIndex); + + // INVARIANT: Cannot resolve a subgame unless the clock of its would-be counter has expired + // INVARIANT: Assuming ordered subgame resolution, challengeClockDuration is always >= MAX_CLOCK_DURATION if all + // descendant subgames are resolved + if (challengeClockDuration.raw() < MAX_CLOCK_DURATION.raw()) revert ClockNotExpired(); + + // INVARIANT: Cannot resolve a subgame twice. + if (resolvedSubgames[_claimIndex]) revert ClaimAlreadyResolved(); + + uint256[] storage challengeIndices = subgames[_claimIndex]; + uint256 challengeIndicesLen = challengeIndices.length; + + // Uncontested claims are resolved implicitly unless they are the root claim. Pay out the bond to the claimant + // and return early. + if (challengeIndicesLen == 0 && _claimIndex != 0) { + // In the event that the parent claim is at the max depth, there will always be 0 subgames. If the + // `counteredBy` field is set and there are no subgames, this implies that the parent claim was successfully + // stepped against. In this case, we pay out the bond to the party that stepped against the parent claim. + // Otherwise, the parent claim is uncontested, and the bond is returned to the claimant. + address counteredBy = subgameRootClaim.counteredBy; + address recipient = counteredBy == address(0) ? subgameRootClaim.claimant : counteredBy; + _distributeBond(recipient, subgameRootClaim); + resolvedSubgames[_claimIndex] = true; + return; + } + + // Fetch the resolution checkpoint from storage. + ResolutionCheckpoint memory checkpoint = resolutionCheckpoints[_claimIndex]; + + // If the checkpoint does not currently exist, initialize the current left most position as max u128. + if (!checkpoint.initialCheckpointComplete) { + checkpoint.leftmostPosition = Position.wrap(type(uint128).max); + checkpoint.initialCheckpointComplete = true; + + // If `_numToResolve == 0`, assume that we can check all child subgames in this one callframe. + if (_numToResolve == 0) _numToResolve = challengeIndicesLen; + } + + // Assume parent is honest until proven otherwise + uint256 lastToResolve = checkpoint.subgameIndex + _numToResolve; + uint256 finalCursor = lastToResolve > challengeIndicesLen ? challengeIndicesLen : lastToResolve; + for (uint256 i = checkpoint.subgameIndex; i < finalCursor; i++) { + uint256 challengeIndex = challengeIndices[i]; + + // INVARIANT: Cannot resolve a subgame containing an unresolved claim + if (!resolvedSubgames[challengeIndex]) revert OutOfOrderResolution(); + + ClaimData storage claim = claimData[challengeIndex]; + + // If the child subgame is uncountered and further left than the current left-most counter, + // update the parent subgame's `countered` address and the current `leftmostCounter`. + // The left-most correct counter is preferred in bond payouts in order to discourage attackers + // from countering invalid subgame roots via an invalid defense position. As such positions + // cannot be correctly countered. + // Note that correctly positioned defense, but invalid claimes can still be successfully countered. + if (claim.counteredBy == address(0) && checkpoint.leftmostPosition.raw() > claim.position.raw()) { + checkpoint.counteredBy = claim.claimant; + checkpoint.leftmostPosition = claim.position; + } + } + + // Increase the checkpoint's cursor position by the number of children that were checked. + checkpoint.subgameIndex = uint32(finalCursor); + + // Persist the checkpoint and allow for continuing in a separate transaction, if resolution is not already + // complete. + resolutionCheckpoints[_claimIndex] = checkpoint; + + // If all children have been traversed in the above loop, the subgame may be resolved. Otherwise, persist the + // checkpoint and allow for continuation in a separate transaction. + if (checkpoint.subgameIndex == challengeIndicesLen) { + address countered = checkpoint.counteredBy; + + // Mark the subgame as resolved. + resolvedSubgames[_claimIndex] = true; + + // Distribute the bond to the appropriate party. + if (_claimIndex == 0 && l2BlockNumberChallenged) { + // Special case: If the root claim has been challenged with the `challengeRootL2Block` function, + // the bond is always paid out to the issuer of that challenge. + address challenger = l2BlockNumberChallenger; + _distributeBond(challenger, subgameRootClaim); + subgameRootClaim.counteredBy = challenger; + } else { + // If the parent was not successfully countered, pay out the parent's bond to the claimant. + // If the parent was successfully countered, pay out the parent's bond to the challenger. + _distributeBond(countered == address(0) ? subgameRootClaim.claimant : countered, subgameRootClaim); + + // Once a subgame is resolved, we percolate the result up the DAG so subsequent calls to + // resolveClaim will not need to traverse this subgame. + subgameRootClaim.counteredBy = countered; + } + } + } + + /// @notice Getter for the creator of the dispute game. + /// @dev `clones-with-immutable-args` argument #1 + /// @return creator_ The creator of the dispute game. + function gameCreator() public pure returns (address creator_) { + creator_ = _getArgAddress(0); + } + + /// @notice Getter for the root claim. + /// @dev `clones-with-immutable-args` argument #2 + /// @return rootClaim_ The root claim of the DisputeGame. + function rootClaim() public pure returns (Claim rootClaim_) { + rootClaim_ = Claim.wrap(_getArgBytes32(20)); + } + + /// @notice Getter for the parent hash of the L1 block when the dispute game was created. + /// @dev `clones-with-immutable-args` argument #3 + /// @return l1Head_ The parent hash of the L1 block when the dispute game was created. + function l1Head() public pure returns (Hash l1Head_) { + l1Head_ = Hash.wrap(_getArgBytes32(52)); + } + + /// @notice Getter for the extra data. + /// @dev `clones-with-immutable-args` argument #4 + /// @return extraData_ Any extra data supplied to the dispute game contract by the creator. + function extraData() public pure returns (bytes memory extraData_) { + // The extra data starts at the second word within the cwia calldata and + // is 32 bytes long. + extraData_ = _getArgBytes(84, 32); + } + + /// @notice Getter for the absolute prestate of the instruction trace. + /// @dev `clones-with-immutable-args` argument #5 + /// @return absolutePrestate_ The absolute prestate of the instruction trace. + function absolutePrestate() public pure returns (Claim absolutePrestate_) { + absolutePrestate_ = Claim.wrap(_getArgBytes32(116)); + } + + /// @notice Getter for the VM implementation. + /// @dev `clones-with-immutable-args` argument #6 + /// @return vm_ The onchain VM implementation address. + function vm() public pure returns (IBigStepper vm_) { + vm_ = IBigStepper(_getArgAddress(148)); + } + + /// @notice Getter for the anchor state registry. + /// @dev `clones-with-immutable-args` argument #7 + /// @return registry_ The anchor state registry contract address. + function anchorStateRegistry() public pure returns (IAnchorStateRegistry registry_) { + registry_ = IAnchorStateRegistry(_getArgAddress(168)); + } + + /// @notice Getter for the WETH contract. + /// @dev `clones-with-immutable-args` argument #8 + /// @return weth_ The WETH contract for holding ETH. + function weth() public pure returns (IDelayedWETH weth_) { + weth_ = IDelayedWETH(payable(_getArgAddress(188))); + } + + /// @notice Getter for the L2 chain ID. + /// @dev `clones-with-immutable-args` argument #9 + /// @return l2ChainId_ The L2 chain ID. + function l2ChainId() public pure returns (uint256 l2ChainId_) { + l2ChainId_ = _getArgUint256(208); + } + + /// @notice A compliant implementation of this interface should return the components of the + /// game UUID's preimage provided in the cwia payload. The preimage of the UUID is + /// constructed as `keccak256(gameType . rootClaim . extraData)` where `.` denotes + /// concatenation. + /// @return gameType_ The type of proof system being used. + /// @return rootClaim_ The root claim of the DisputeGame. + /// @return extraData_ Any extra data supplied to the dispute game contract by the creator. + function gameData() external view returns (GameType gameType_, Claim rootClaim_, bytes memory extraData_) { + gameType_ = gameType(); + rootClaim_ = rootClaim(); + extraData_ = extraData(); + } + + /// @notice Getter for the game type. + /// @dev The reference impl should be entirely different depending on the type (fault, validity) + /// i.e. The game type should indicate the security model. + /// @return gameType_ The type of proof system being used. + function gameType() public view returns (GameType gameType_) { + gameType_ = GAME_TYPE; + } + + //////////////////////////////////////////////////////////////// + // MISC EXTERNAL // + //////////////////////////////////////////////////////////////// + + /// @notice Returns the required bond for a given move kind. + /// @param _position The position of the bonded interaction. + /// @return requiredBond_ The required ETH bond for the given move, in wei. + function getRequiredBond(Position _position) public view returns (uint256 requiredBond_) { + uint256 depth = uint256(_position.depth()); + if (depth > MAX_GAME_DEPTH) revert GameDepthExceeded(); + + // Values taken from Big Bonds v1.5 (TM) spec. + uint256 assumedBaseFee = 200 gwei; + uint256 baseGasCharged = 400_000; + uint256 highGasCharged = 300_000_000; + + // Goal here is to compute the fixed multiplier that will be applied to the base gas + // charged to get the required gas amount for the given depth. We apply this multiplier + // some `n` times where `n` is the depth of the position. We are looking for some number + // that, when multiplied by itself `MAX_GAME_DEPTH` times and then multiplied by the base + // gas charged, will give us the maximum gas that we want to charge. + // We want to solve for (highGasCharged/baseGasCharged) ** (1/MAX_GAME_DEPTH). + // We know that a ** (b/c) is equal to e ** (ln(a) * (b/c)). + // We can compute e ** (ln(a) * (b/c)) quite easily with FixedPointMathLib. + + // Set up a, b, and c. + uint256 a = highGasCharged / baseGasCharged; + uint256 b = FixedPointMathLib.WAD; + uint256 c = MAX_GAME_DEPTH * FixedPointMathLib.WAD; + + // Compute ln(a). + // slither-disable-next-line divide-before-multiply + uint256 lnA = uint256(FixedPointMathLib.lnWad(int256(a * FixedPointMathLib.WAD))); + + // Computes (b / c) with full precision using WAD = 1e18. + uint256 bOverC = FixedPointMathLib.divWad(b, c); + + // Compute e ** (ln(a) * (b/c)) + // sMulWad can be used here since WAD = 1e18 maintains the same precision. + uint256 numerator = FixedPointMathLib.mulWad(lnA, bOverC); + int256 base = FixedPointMathLib.expWad(int256(numerator)); + + // Compute the required gas amount. + int256 rawGas = FixedPointMathLib.powWad(base, int256(depth * FixedPointMathLib.WAD)); + uint256 requiredGas = FixedPointMathLib.mulWad(baseGasCharged, uint256(rawGas)); + + // Compute the required bond. + requiredBond_ = assumedBaseFee * requiredGas; + } + + /// @notice Claim the credit belonging to the recipient address. Reverts if the game isn't + /// finalized, if the recipient has no credit to claim, or if the bond transfer + /// fails. If the game is finalized but no bond has been paid out yet, this method + /// will determine the bond distribution mode and also try to update anchor game. + /// @param _recipient The owner and recipient of the credit. + function claimCredit(address _recipient) external { + // Close out the game and determine the bond distribution mode if not already set. + // We call this as part of claim credit to reduce the number of additional calls that a + // Challenger needs to make to this contract. + closeGame(); + + // Fetch the recipient's credit balance based on the bond distribution mode. + uint256 recipientCredit; + if (bondDistributionMode == BondDistributionMode.REFUND) { + recipientCredit = refundModeCredit[_recipient]; + } else if (bondDistributionMode == BondDistributionMode.NORMAL) { + recipientCredit = normalModeCredit[_recipient]; + } else { + // We shouldn't get here, but sanity check just in case. + revert InvalidBondDistributionMode(); + } + + // If the game is in refund mode, and the recipient has not unlocked their refund mode + // credit, we unlock it and return early. + if (!hasUnlockedCredit[_recipient]) { + hasUnlockedCredit[_recipient] = true; + weth().unlock(_recipient, recipientCredit); + return; + } + + // Revert if the recipient has no credit to claim. + if (recipientCredit == 0) revert NoCreditToClaim(); + + // Set the recipient's credit balances to 0. + refundModeCredit[_recipient] = 0; + normalModeCredit[_recipient] = 0; + + // Try to withdraw the WETH amount so it can be used here. + weth().withdraw(_recipient, recipientCredit); + + // Transfer the credit to the recipient. + (bool success,) = _recipient.call{ value: recipientCredit }(hex""); + if (!success) revert BondTransferFailed(); + } + + /// @notice Closes out the game, determines the bond distribution mode, attempts to register + /// the game as the anchor game, and emits an event. + function closeGame() public { + // If the bond distribution mode has already been determined, we can return early. + if (bondDistributionMode == BondDistributionMode.REFUND || bondDistributionMode == BondDistributionMode.NORMAL) + { + // We can't revert or we'd break claimCredit(). + return; + } else if (bondDistributionMode != BondDistributionMode.UNDECIDED) { + // We shouldn't get here, but sanity check just in case. + revert InvalidBondDistributionMode(); + } + + // We won't close the game if the system is currently paused. Paused games are temporarily + // invalid which would cause the game to go into refund mode and potentially cause some + // confusion for honest challengers. By blocking the game from being closed while the + // system is paused, the game will only go into refund mode if it ends up being explicitly + // invalidated in the AnchorStateRegistry. If the game has already been closed and a refund + // mode has been selected, we'll already have returned and we won't hit this revert. + if (anchorStateRegistry().paused()) { + revert GamePaused(); + } + + // Make sure that the game is resolved. + // AnchorStateRegistry should be checking this but we're being defensive here. + if (resolvedAt.raw() == 0) { + revert GameNotResolved(); + } + + // Game must be finalized according to the AnchorStateRegistry. + bool finalized = anchorStateRegistry().isGameFinalized(IDisputeGame(address(this))); + if (!finalized) { + revert GameNotFinalized(); + } + + // Try to update the anchor game first. Won't always succeed because delays can lead + // to situations in which this game might not be eligible to be a new anchor game. + // eip150-safe + try anchorStateRegistry().setAnchorState(IDisputeGame(address(this))) { } catch { } + + // Check if the game is a proper game, which will determine the bond distribution mode. + bool properGame = anchorStateRegistry().isGameProper(IDisputeGame(address(this))); + + // If the game is a proper game, the bonds should be distributed normally. Otherwise, go + // into refund mode and distribute bonds back to their original depositors. + if (properGame) { + bondDistributionMode = BondDistributionMode.NORMAL; + } else { + bondDistributionMode = BondDistributionMode.REFUND; + } + + // Emit an event to signal that the game has been closed. + emit GameClosed(bondDistributionMode); + } + + /// @notice Returns the amount of time elapsed on the potential challenger to `_claimIndex`'s chess clock. Maxes + /// out at `MAX_CLOCK_DURATION`. + /// @param _claimIndex The index of the subgame root claim. + /// @return duration_ The time elapsed on the potential challenger to `_claimIndex`'s chess clock. + function getChallengerDuration(uint256 _claimIndex) public view returns (Duration duration_) { + // INVARIANT: The game must be in progress to query the remaining time to respond to a given claim. + if (status != GameStatus.IN_PROGRESS) { + revert GameNotInProgress(); + } + + // Fetch the subgame root claim. + ClaimData storage subgameRootClaim = claimData[_claimIndex]; + + // Fetch the parent of the subgame root's clock, if it exists. + Clock parentClock; + if (subgameRootClaim.parentIndex != type(uint32).max) { + parentClock = claimData[subgameRootClaim.parentIndex].clock; + } + + // Compute the duration elapsed of the potential challenger's clock. + uint64 challengeDuration = + uint64(parentClock.duration().raw() + (block.timestamp - subgameRootClaim.clock.timestamp().raw())); + duration_ = challengeDuration > MAX_CLOCK_DURATION.raw() ? MAX_CLOCK_DURATION : Duration.wrap(challengeDuration); + } + + /// @notice Returns the length of the `claimData` array. + function claimDataLen() external view returns (uint256 len_) { + len_ = claimData.length; + } + + /// @notice Returns the credit balance of a given recipient. + /// @param _recipient The recipient of the credit. + /// @return credit_ The credit balance of the recipient. + function credit(address _recipient) external view returns (uint256 credit_) { + if (bondDistributionMode == BondDistributionMode.REFUND) { + credit_ = refundModeCredit[_recipient]; + } else { + // Always return normal credit balance by default unless we're in refund mode. + credit_ = normalModeCredit[_recipient]; + } + } + + //////////////////////////////////////////////////////////////// + // IMMUTABLE GETTERS // + //////////////////////////////////////////////////////////////// + + /// @notice Returns the max game depth. + function maxGameDepth() external view returns (uint256 maxGameDepth_) { + maxGameDepth_ = MAX_GAME_DEPTH; + } + + /// @notice Returns the split depth. + function splitDepth() external view returns (uint256 splitDepth_) { + splitDepth_ = SPLIT_DEPTH; + } + + /// @notice Returns the max clock duration. + function maxClockDuration() external view returns (Duration maxClockDuration_) { + maxClockDuration_ = MAX_CLOCK_DURATION; + } + + /// @notice Returns the clock extension constant. + function clockExtension() external view returns (Duration clockExtension_) { + clockExtension_ = CLOCK_EXTENSION; + } + + //////////////////////////////////////////////////////////////// + // HELPERS // + //////////////////////////////////////////////////////////////// + + /// @notice Pays out the bond of a claim to a given recipient. + /// @param _recipient The recipient of the bond. + /// @param _bonded The claim to pay out the bond of. + function _distributeBond(address _recipient, ClaimData storage _bonded) internal { + normalModeCredit[_recipient] += _bonded.bond; + } + + /// @notice Verifies the integrity of an execution bisection subgame's root claim. Reverts if the claim + /// is invalid. + /// @param _rootClaim The root claim of the execution bisection subgame. + function _verifyExecBisectionRoot( + Claim _rootClaim, + uint256 _parentIdx, + Position _parentPos, + bool _isAttack + ) + internal + view + { + // The root claim of an execution trace bisection sub-game must: + // 1. Signal that the VM panicked or resulted in an invalid transition if the disputed output root + // was made by the opposing party. + // 2. Signal that the VM resulted in a valid transition if the disputed output root was made by the same party. + + // If the move is a defense, the disputed output could have been made by either party. In this case, we + // need to search for the parent output to determine what the expected status byte should be. + Position disputedLeafPos = Position.wrap(_parentPos.raw() + 1); + ClaimData storage disputed = _findTraceAncestor({ _pos: disputedLeafPos, _start: _parentIdx, _global: true }); + uint8 vmStatus = uint8(_rootClaim.raw()[0]); + + if (_isAttack || disputed.position.depth() % 2 == SPLIT_DEPTH % 2) { + // If the move is an attack, the parent output is always deemed to be disputed. In this case, we only need + // to check that the root claim signals that the VM panicked or resulted in an invalid transition. + // If the move is a defense, and the disputed output and creator of the execution trace subgame disagree, + // the root claim should also signal that the VM panicked or resulted in an invalid transition. + if (!(vmStatus == VMStatuses.INVALID.raw() || vmStatus == VMStatuses.PANIC.raw())) { + revert UnexpectedRootClaim(_rootClaim); + } + } else if (vmStatus != VMStatuses.VALID.raw()) { + // The disputed output and the creator of the execution trace subgame agree. The status byte should + // have signaled that the VM succeeded. + revert UnexpectedRootClaim(_rootClaim); + } + } + + /// @notice Finds the trace ancestor of a given position within the DAG. + /// @param _pos The position to find the trace ancestor claim of. + /// @param _start The index to start searching from. + /// @param _global Whether or not to search the entire dag or just within an execution trace subgame. If set to + /// `true`, and `_pos` is at or above the split depth, this function will revert. + /// @return ancestor_ The ancestor claim that commits to the same trace index as `_pos`. + function _findTraceAncestor( + Position _pos, + uint256 _start, + bool _global + ) + internal + view + returns (ClaimData storage ancestor_) + { + // Grab the trace ancestor's expected position. + Position traceAncestorPos = _global ? _pos.traceAncestor() : _pos.traceAncestorBounded(SPLIT_DEPTH); + + // Walk up the DAG to find a claim that commits to the same trace index as `_pos`. It is + // guaranteed that such a claim exists. + ancestor_ = claimData[_start]; + while (ancestor_.position.raw() != traceAncestorPos.raw()) { + ancestor_ = claimData[ancestor_.parentIndex]; + } + } + + /// @notice Finds the starting and disputed output root for a given `ClaimData` within the DAG. This + /// `ClaimData` must be below the `SPLIT_DEPTH`. + /// @param _start The index within `claimData` of the claim to start searching from. + /// @return startingClaim_ The starting output root claim. + /// @return startingPos_ The starting output root position. + /// @return disputedClaim_ The disputed output root claim. + /// @return disputedPos_ The disputed output root position. + function _findStartingAndDisputedOutputs(uint256 _start) + internal + view + returns (Claim startingClaim_, Position startingPos_, Claim disputedClaim_, Position disputedPos_) + { + // Fatch the starting claim. + uint256 claimIdx = _start; + ClaimData storage claim = claimData[claimIdx]; + + // If the starting claim's depth is less than or equal to the split depth, we revert as this is UB. + if (claim.position.depth() <= SPLIT_DEPTH) revert ClaimAboveSplit(); + + // We want to: + // 1. Find the first claim at the split depth. + // 2. Determine whether it was the starting or disputed output for the exec game. + // 3. Find the complimentary claim depending on the info from #2 (pre or post). + + // Walk up the DAG until the ancestor's depth is equal to the split depth. + uint256 currentDepth; + ClaimData storage execRootClaim = claim; + while ((currentDepth = claim.position.depth()) > SPLIT_DEPTH) { + uint256 parentIndex = claim.parentIndex; + + // If we're currently at the split depth + 1, we're at the root of the execution sub-game. + // We need to keep track of the root claim here to determine whether the execution sub-game was + // started with an attack or defense against the output leaf claim. + if (currentDepth == SPLIT_DEPTH + 1) execRootClaim = claim; + + claim = claimData[parentIndex]; + claimIdx = parentIndex; + } + + // Determine whether the start of the execution sub-game was an attack or defense to the output root + // above. This is important because it determines which claim is the starting output root and which + // is the disputed output root. + (Position execRootPos, Position outputPos) = (execRootClaim.position, claim.position); + bool wasAttack = execRootPos.parent().raw() == outputPos.raw(); + + // Determine the starting and disputed output root indices. + // 1. If it was an attack, the disputed output root is `claim`, and the starting output root is + // elsewhere in the DAG (it must commit to the block # index at depth of `outputPos - 1`). + // 2. If it was a defense, the starting output root is `claim`, and the disputed output root is + // elsewhere in the DAG (it must commit to the block # index at depth of `outputPos + 1`). + if (wasAttack) { + // If this is an attack on the first output root (the block directly after the starting + // block number), the starting claim nor position exists in the tree. We leave these as + // 0, which can be easily identified due to 0 being an invalid Gindex. + if (outputPos.indexAtDepth() > 0) { + ClaimData storage starting = _findTraceAncestor(Position.wrap(outputPos.raw() - 1), claimIdx, true); + (startingClaim_, startingPos_) = (starting.claim, starting.position); + } else { + startingClaim_ = Claim.wrap(startingOutputRoot.root.raw()); + } + (disputedClaim_, disputedPos_) = (claim.claim, claim.position); + } else { + ClaimData storage disputed = _findTraceAncestor(Position.wrap(outputPos.raw() + 1), claimIdx, true); + (startingClaim_, startingPos_) = (claim.claim, claim.position); + (disputedClaim_, disputedPos_) = (disputed.claim, disputed.position); + } + } + + /// @notice Finds the local context hash for a given claim index that is present in an execution trace subgame. + /// @param _claimIndex The index of the claim to find the local context hash for. + /// @return uuid_ The local context hash. + function _findLocalContext(uint256 _claimIndex) internal view returns (Hash uuid_) { + (Claim starting, Position startingPos, Claim disputed, Position disputedPos) = + _findStartingAndDisputedOutputs(_claimIndex); + uuid_ = _computeLocalContext(starting, startingPos, disputed, disputedPos); + } + + /// @notice Computes the local context hash for a set of starting/disputed claim values and positions. + /// @param _starting The starting claim. + /// @param _startingPos The starting claim's position. + /// @param _disputed The disputed claim. + /// @param _disputedPos The disputed claim's position. + /// @return uuid_ The local context hash. + function _computeLocalContext( + Claim _starting, + Position _startingPos, + Claim _disputed, + Position _disputedPos + ) + internal + pure + returns (Hash uuid_) + { + // A position of 0 indicates that the starting claim is the absolute prestate. In this special case, + // we do not include the starting claim within the local context hash. + uuid_ = _startingPos.raw() == 0 + ? Hash.wrap(keccak256(abi.encode(_disputed, _disputedPos))) + : Hash.wrap(keccak256(abi.encode(_starting, _startingPos, _disputed, _disputedPos))); + } +} diff --git a/packages/contracts-bedrock/src/dispute/v2/PermissionedDisputeGameV2.sol b/packages/contracts-bedrock/src/dispute/v2/PermissionedDisputeGameV2.sol new file mode 100644 index 00000000000..a71777012c9 --- /dev/null +++ b/packages/contracts-bedrock/src/dispute/v2/PermissionedDisputeGameV2.sol @@ -0,0 +1,109 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.15; + +// Contracts +import { FaultDisputeGameV2 } from "src/dispute/v2/FaultDisputeGameV2.sol"; + +// Libraries +import { Claim } from "src/dispute/lib/Types.sol"; +import { BadAuth } from "src/dispute/lib/Errors.sol"; + +/// @title PermissionedDisputeGameV2 +/// @notice PermissionedDisputeGameV2 is a contract that inherits from `FaultDisputeGameV2`, and contains two roles: +/// - The `challenger` role, which is allowed to challenge a dispute. +/// - The `proposer` role, which is allowed to create proposals and participate in their game. +/// This contract exists as a way for networks to support the fault proof iteration of the OptimismPortal +/// contract without needing to support a fully permissionless system. Permissionless systems can introduce +/// costs that certain networks may not wish to support. This contract can also be used as a fallback mechanism +/// in case of a failure in the permissionless fault proof system in the stage one release. +contract PermissionedDisputeGameV2 is FaultDisputeGameV2 { + /// @notice The proposer role is allowed to create proposals and participate in the dispute game. + address internal immutable PROPOSER; + + /// @notice The challenger role is allowed to participate in the dispute game. + address internal immutable CHALLENGER; + + /// @notice Modifier that gates access to the `challenger` and `proposer` roles. + modifier onlyAuthorized() { + if (!(msg.sender == PROPOSER || msg.sender == CHALLENGER)) { + revert BadAuth(); + } + _; + } + + /// @notice Semantic version. + /// @custom:semver 2.0.0 + function version() public pure override returns (string memory) { + return "2.0.0"; + } + + /// @param _params Parameters for creating a new FaultDisputeGame. + /// @param _proposer Address that is allowed to create instances of this contract. + /// @param _challenger Address that is allowed to challenge instances of this contract. + constructor( + GameConstructorParams memory _params, + address _proposer, + address _challenger + ) + FaultDisputeGameV2(_params) + { + PROPOSER = _proposer; + CHALLENGER = _challenger; + } + + /// @inheritdoc FaultDisputeGameV2 + function step( + uint256 _claimIndex, + bool _isAttack, + bytes calldata _stateData, + bytes calldata _proof + ) + public + override + onlyAuthorized + { + super.step(_claimIndex, _isAttack, _stateData, _proof); + } + + /// @notice Generic move function, used for both `attack` and `defend` moves. + /// @notice _disputed The disputed `Claim`. + /// @param _challengeIndex The index of the claim being moved against. This must match the `_disputed` claim. + /// @param _claim The claim at the next logical position in the game. + /// @param _isAttack Whether or not the move is an attack or defense. + function move( + Claim _disputed, + uint256 _challengeIndex, + Claim _claim, + bool _isAttack + ) + public + payable + override + onlyAuthorized + { + super.move(_disputed, _challengeIndex, _claim, _isAttack); + } + + /// @notice Initializes the contract. + function initialize() public payable override { + // The creator of the dispute game must be the proposer EOA. + if (tx.origin != PROPOSER) revert BadAuth(); + + // Fallthrough initialization. + super.initialize(); + } + + //////////////////////////////////////////////////////////////// + // IMMUTABLE GETTERS // + //////////////////////////////////////////////////////////////// + + /// @notice Returns the proposer address. + function proposer() external view returns (address proposer_) { + proposer_ = PROPOSER; + } + + /// @notice Returns the challenger address. + function challenger() external view returns (address challenger_) { + challenger_ = CHALLENGER; + } +} diff --git a/packages/contracts-bedrock/src/integration/GameHelper.sol b/packages/contracts-bedrock/src/integration/GameHelper.sol new file mode 100644 index 00000000000..c65685b97ae --- /dev/null +++ b/packages/contracts-bedrock/src/integration/GameHelper.sol @@ -0,0 +1,59 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.0; + +import { IDisputeGameFactory } from "../../interfaces/dispute/IDisputeGameFactory.sol"; +import { IFaultDisputeGame } from "../../interfaces/dispute/IFaultDisputeGame.sol"; + +// Libraries +import { Claim, Position, GameType } from "src/dispute/lib/Types.sol"; + +/// @title GameHelper +/// @notice GameHelper is a util contract for testing to perform multiple moves in a dispute game in a single +/// transaction. Note that it is unsafe to use in production as the bonds paid cannot be recovered. +contract GameHelper { + struct Move { + uint256 parentIdx; + Claim claim; + bool attack; + } + + /// @notice Performs the specified set of moves in the supplied dispute game. + /// @param _game the game to perform moves in. + /// @param _moves the moves to perform. + function performMoves(IFaultDisputeGame _game, Move[] calldata _moves) public payable { + uint256 movesLen = _moves.length; + for (uint256 i = 0; i < movesLen; i++) { + Move memory move = _moves[i]; + (,,,, Claim pClaim, Position pPosition,) = _game.claimData(move.parentIdx); + uint256 requiredBond = _game.getRequiredBond(pPosition.move(move.attack)); + _game.move{ value: requiredBond }(pClaim, move.parentIdx, move.claim, move.attack); + } + } + + /// @notice Creates a new game and performs the specified moves in it. + /// @param _dgf the DisputeGameFactory to create a game in. + /// @param _gameType the type of game to create. + /// @param _rootClaim the root claim of the new game. + /// @param _extraData the extra data for the new game. + /// @param _moves the array of moves to perform in the new game. + /// @return gameAddr_ the address of the newly created game. + function createGameWithClaims( + IDisputeGameFactory _dgf, + GameType _gameType, + Claim _rootClaim, + bytes memory _extraData, + Move[] calldata _moves + ) + external + payable + returns (address gameAddr_) + { + uint256 initBond = _dgf.initBonds(_gameType); + gameAddr_ = address(_dgf.create{ value: initBond }(_gameType, _rootClaim, _extraData)); + IFaultDisputeGame game = IFaultDisputeGame(gameAddr_); + performMoves(game, _moves); + } + + // @notice Allows funds to be sent to this contract or to use it in a 7702 authorization. + receive() external payable { } +} diff --git a/packages/contracts-bedrock/src/libraries/DevFeatures.sol b/packages/contracts-bedrock/src/libraries/DevFeatures.sol new file mode 100644 index 00000000000..9ec47379bac --- /dev/null +++ b/packages/contracts-bedrock/src/libraries/DevFeatures.sol @@ -0,0 +1,27 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.0; + +/// @notice Library of constants representing development features. We use a 32 byte bitmap because +/// it's easier to integrate with op-deployer. Note that users should typically set a +/// single nibble to 1 and the rest to zero, which gives us 64 potential features, like: +/// 0x0000000000000000000000000000000000000000000000000000000000000001 +/// 0x0000000000000000000000000000000000000000000000000000000000000010 +/// 0x0000000000000000000000000000000000000000000000000000000000000100 +/// etc. +/// We'll expand to using all available bits if we need more than 64 concurrent features. +library DevFeatures { + /// @notice The feature that enables the OptimismPortalInterop contract. + bytes32 public constant OPTIMISM_PORTAL_INTEROP = + bytes32(0x0000000000000000000000000000000000000000000000000000000000000001); + + /// @notice Checks if a feature is enabled in a bitmap. Note that this function does not check + /// that the input feature represents a single feature and the bitwise AND operation + /// allows for multiple features to be enabled at once. Users should generally check + /// for only a single feature at a time. + /// @param _bitmap The bitmap to check. + /// @param _feature The feature to check. + /// @return True if the feature is enabled, false otherwise. + function isDevFeatureEnabled(bytes32 _bitmap, bytes32 _feature) internal pure returns (bool) { + return (_bitmap & _feature) != 0; + } +} diff --git a/packages/contracts-bedrock/src/libraries/Features.sol b/packages/contracts-bedrock/src/libraries/Features.sol new file mode 100644 index 00000000000..1521b1d1a33 --- /dev/null +++ b/packages/contracts-bedrock/src/libraries/Features.sol @@ -0,0 +1,13 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.0; + +/// @notice Features is a library that stores feature name constants. Can be used alongside the +/// feature flagging functionality in the SystemConfig contract to selectively enable or +/// disable customizable features of the OP Stack. +library Features { + /// @notice The ETH_LOCKBOX feature determines if the system is configured to use the + /// ETHLockbox contract in the OptimismPortal. When the ETH_LOCKBOX feature is active + /// and the ETHLockbox contract has been configured, the OptimismPortal will use the + /// ETHLockbox to store ETH instead of storing ETH directly in the portal itself. + bytes32 internal constant ETH_LOCKBOX = "ETH_LOCKBOX"; +} diff --git a/packages/contracts-bedrock/src/libraries/SemverComp.sol b/packages/contracts-bedrock/src/libraries/SemverComp.sol new file mode 100644 index 00000000000..23e2b1b7eb0 --- /dev/null +++ b/packages/contracts-bedrock/src/libraries/SemverComp.sol @@ -0,0 +1,95 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.0; + +// Libraries +import { LibString } from "solady/src/utils/LibString.sol"; +import { JSONParserLib } from "solady/src/utils/JSONParserLib.sol"; + +/// @notice Library for comparing semver strings. Ignores prereleases and build metadata. +library SemverComp { + /// @notice Struct representing a semver string. + /// @custom:field major The major version number. + /// @custom:field minor The minor version number. + /// @custom:field patch The patch version number. + struct Semver { + uint256 major; + uint256 minor; + uint256 patch; + } + + /// @notice Error thrown when a semver string has less than 3 parts. + error SemverComp_InvalidSemverParts(); + + /// @notice Parses a semver string into a Semver struct. Only handles the major, minor, and + /// patch numerical components, ignores prereleases and build metadata. + /// @param _semver The semver string to parse. + /// @return The parsed Semver struct. + function parse(string memory _semver) internal pure returns (Semver memory) { + string[] memory parts = LibString.split(_semver, "."); + + // We need at least 3 parts to be a valid semver, but we might have more parts if the + // semver looks like "1.2.3-beta.4+build.5". + if (parts.length < 3) { + revert SemverComp_InvalidSemverParts(); + } + + // Split the patch component by hyphen, if it exists. We only want the first part of the + // patch. We're ignoring prereleases and build versions in this library. We're handling + // cases like 1.2.3-beta.4+build.5 as well as 1.2.3+build.5. + string[] memory patchParts = LibString.split(parts[2], "-"); + string[] memory patchParts2 = LibString.split(patchParts[0], "+"); + + // Parse the major, minor, and patch components. JSONParserLib will revert if the + // components are not valid decimal numbers. + return Semver({ + major: JSONParserLib.parseUint(parts[0]), + minor: JSONParserLib.parseUint(parts[1]), + patch: JSONParserLib.parseUint(patchParts2[0]) + }); + } + + /// @notice Compares two semver strings (=). Ignores prereleases and build metadata. + /// @param _a The first semver string. + /// @param _b The second semver string. + /// @return True if the semver strings are equal, false otherwise. + function eq(string memory _a, string memory _b) internal pure returns (bool) { + Semver memory a = parse(_a); + Semver memory b = parse(_b); + return a.major == b.major && a.minor == b.minor && a.patch == b.patch; + } + + /// @notice Compares two semver strings (<). Ignores prereleases and build metadata. + /// @param _a The first semver string. + /// @param _b The second semver string. + /// @return True if the first semver string is less than the second, false otherwise. + function lt(string memory _a, string memory _b) internal pure returns (bool) { + Semver memory a = parse(_a); + Semver memory b = parse(_b); + return a.major < b.major || (a.major == b.major && a.minor < b.minor) + || (a.major == b.major && a.minor == b.minor && a.patch < b.patch); + } + + /// @notice Compares two semver strings (<=). Ignores prereleases and build metadata. + /// @param _a The first semver string. + /// @param _b The second semver string. + /// @return True if the first semver string is less than or equal to the second, false otherwise. + function lte(string memory _a, string memory _b) internal pure returns (bool) { + return eq(_a, _b) || lt(_a, _b); + } + + /// @notice Compares two semver strings (>). Ignores prereleases and build metadata. + /// @param _a The first semver string. + /// @param _b The second semver string. + /// @return True if the first semver string is greater than the second, false otherwise. + function gt(string memory _a, string memory _b) internal pure returns (bool) { + return !eq(_a, _b) && !lt(_a, _b); + } + + /// @notice Compares two semver strings (>=). Ignores prereleases and build metadata. + /// @param _a The first semver string. + /// @param _b The second semver string. + /// @return True if the first semver string is greater than or equal to the second, false otherwise. + function gte(string memory _a, string memory _b) internal pure returns (bool) { + return eq(_a, _b) || gt(_a, _b); + } +} diff --git a/packages/contracts-bedrock/test/L1/ETHLockbox.t.sol b/packages/contracts-bedrock/test/L1/ETHLockbox.t.sol index 2b0685873a5..a8528797d38 100644 --- a/packages/contracts-bedrock/test/L1/ETHLockbox.t.sol +++ b/packages/contracts-bedrock/test/L1/ETHLockbox.t.sol @@ -11,6 +11,7 @@ import { Proxy } from "src/universal/Proxy.sol"; import { Constants } from "src/libraries/Constants.sol"; import { EIP1967Helper } from "test/mocks/EIP1967Helper.sol"; import { ForgeArtifacts, StorageSlot } from "scripts/libraries/ForgeArtifacts.sol"; +import { Features } from "src/libraries/Features.sol"; // Interfaces import { IETHLockbox } from "interfaces/L1/IETHLockbox.sol"; @@ -36,6 +37,9 @@ contract ETHLockbox_TestInit is CommonTest { // deployed // TODO(#14691): Remove this check once Upgrade 15 is deployed on Mainnet. if (isForkTest() && !deploy.cfg().useUpgradedFork()) vm.skip(true); + + // If the ETHLockbox system feature is not enabled, skip these tests. + skipIfSysFeatureDisabled(Features.ETH_LOCKBOX); } } diff --git a/packages/contracts-bedrock/test/L1/L1CrossDomainMessenger.t.sol b/packages/contracts-bedrock/test/L1/L1CrossDomainMessenger.t.sol index a48bc710d3e..ea464f5ae59 100644 --- a/packages/contracts-bedrock/test/L1/L1CrossDomainMessenger.t.sol +++ b/packages/contracts-bedrock/test/L1/L1CrossDomainMessenger.t.sol @@ -166,81 +166,6 @@ contract L1CrossDomainMessenger_Initialize_Test is L1CrossDomainMessenger_TestIn } } -/// @title L1CrossDomainMessenger_Upgrade_Test -/// @notice Reusable test for the current `upgrade` function in the L1CrossDomainMessenger -/// contract. If the `upgrade` function is changed, tests inside of this contract should be -/// updated to reflect the new function. If the `upgrade` function is removed, remove the -/// corresponding tests but leave this contract in place so it\'s easy to add tests back -/// in the future. -contract L1CrossDomainMessenger_Upgrade_Test is L1CrossDomainMessenger_TestInit { - /// @notice Tests that the upgrade() function succeeds. - function test_upgrade_succeeds() external { - // Get the slot for _initial. - StorageSlot memory slot = ForgeArtifacts.getSlot("L1CrossDomainMessenger", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(l1CrossDomainMessenger), bytes32(slot.slot), bytes32(0)); - - // Verify the initial systemConfig slot is non-zero. - StorageSlot memory systemConfigSlot = ForgeArtifacts.getSlot("L1CrossDomainMessenger", "systemConfig"); - vm.store(address(l1CrossDomainMessenger), bytes32(systemConfigSlot.slot), bytes32(uint256(1))); - assertNotEq(address(l1CrossDomainMessenger.systemConfig()), address(0)); - assertNotEq(vm.load(address(l1CrossDomainMessenger), bytes32(systemConfigSlot.slot)), bytes32(0)); - - ISystemConfig newSystemConfig = ISystemConfig(address(0xdeadbeef)); - - // Trigger upgrade(). - vm.prank(address(l1CrossDomainMessenger.proxyAdmin())); - l1CrossDomainMessenger.upgrade(newSystemConfig); - - // Verify that the systemConfig was updated. - assertEq(address(l1CrossDomainMessenger.systemConfig()), address(newSystemConfig)); - } - - /// @notice Tests that the upgrade() function reverts if called a second time. - function test_upgrade_upgradeTwice_reverts() external { - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("L1CrossDomainMessenger", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(l1CrossDomainMessenger), bytes32(slot.slot), bytes32(0)); - - // Create a new SystemConfig contract - ISystemConfig newSystemConfig = ISystemConfig(address(0xdeadbeef)); - - // Trigger first upgrade. - vm.prank(address(l1CrossDomainMessenger.proxyAdmin())); - l1CrossDomainMessenger.upgrade(newSystemConfig); - - // Try to trigger second upgrade. - vm.prank(address(l1CrossDomainMessenger.proxyAdmin())); - vm.expectRevert("Initializable: contract is already initialized"); - l1CrossDomainMessenger.upgrade(newSystemConfig); - } - - /// @notice Tests that the upgrade() function reverts if called by a non-proxy admin or owner. - /// @param _sender The address of the sender to test. - function testFuzz_upgrade_notProxyAdminOrProxyAdminOwner_reverts(address _sender) public { - // Prank as the not ProxyAdmin or ProxyAdmin owner. - vm.assume(_sender != address(proxyAdmin) && _sender != proxyAdminOwner); - - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("L1CrossDomainMessenger", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(l1CrossDomainMessenger), bytes32(slot.slot), bytes32(0)); - - // Create a new SystemConfig contract - ISystemConfig newSystemConfig = ISystemConfig(address(0xdeadbeef)); - - // Call the `upgrade` function with the sender - // Expect the revert with `ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner` selector - vm.prank(_sender); - vm.expectRevert(IProxyAdminOwnedBase.ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner.selector); - l1CrossDomainMessenger.upgrade(newSystemConfig); - } -} - /// @title L1CrossDomainMessenger_Paused_Test /// @notice Tests for the `paused` functionality of the L1CrossDomainMessenger. contract L1CrossDomainMessenger_Paused_Test is L1CrossDomainMessenger_TestInit { diff --git a/packages/contracts-bedrock/test/L1/L1ERC721Bridge.t.sol b/packages/contracts-bedrock/test/L1/L1ERC721Bridge.t.sol index 33a471d48bb..8bf3d99f0f6 100644 --- a/packages/contracts-bedrock/test/L1/L1ERC721Bridge.t.sol +++ b/packages/contracts-bedrock/test/L1/L1ERC721Bridge.t.sol @@ -139,78 +139,6 @@ contract L1ERC721Bridge_Initialize_Test is L1ERC721Bridge_TestInit { } } -/// @title L1ERC721Bridge_Upgrade_Test -/// @notice Reusable test for the current upgrade() function in the L1ERC721Bridge contract. If -/// the upgrade() function is changed, tests inside of this contract should be updated to -/// reflect the new function. If the upgrade() function is removed, remove the -/// corresponding tests but leave this contract in place so it's easy to add tests back -/// in the future. -contract L1ERC721Bridge_Upgrade_Test is L1ERC721Bridge_TestInit { - /// @notice Tests that the upgrade() function succeeds. - function test_upgrade_succeeds() external { - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("L1ERC721Bridge", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(l1ERC721Bridge), bytes32(slot.slot), bytes32(0)); - - // Verify the initial systemConfig slot is non-zero. - StorageSlot memory systemConfigSlot = ForgeArtifacts.getSlot("L1ERC721Bridge", "systemConfig"); - vm.store(address(l1ERC721Bridge), bytes32(systemConfigSlot.slot), bytes32(uint256(1))); - assertNotEq(address(l1ERC721Bridge.systemConfig()), address(0)); - assertNotEq(vm.load(address(l1ERC721Bridge), bytes32(systemConfigSlot.slot)), bytes32(0)); - - ISystemConfig newSystemConfig = ISystemConfig(address(0xdeadbeef)); - - // Trigger upgrade(). - vm.prank(address(l1ERC721Bridge.proxyAdmin())); - l1ERC721Bridge.upgrade(newSystemConfig); - - // Verify that the systemConfig was updated. - assertEq(address(l1ERC721Bridge.systemConfig()), address(newSystemConfig)); - } - - /// @notice Tests that the upgrade() function reverts if called a second time. - function test_upgrade_upgradeTwice_reverts() external { - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("L1ERC721Bridge", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(l1ERC721Bridge), bytes32(slot.slot), bytes32(0)); - - ISystemConfig newSystemConfig = ISystemConfig(address(0xdeadbeef)); - - // Trigger first upgrade. - vm.prank(address(l1ERC721Bridge.proxyAdmin())); - l1ERC721Bridge.upgrade(newSystemConfig); - - // Try to trigger second upgrade. - vm.prank(address(l1ERC721Bridge.proxyAdmin())); - vm.expectRevert("Initializable: contract is already initialized"); - l1ERC721Bridge.upgrade(newSystemConfig); - } - - /// @notice Tests that the upgrade() function reverts if called by a non-proxy admin or owner. - /// @param _sender The address of the sender to test. - function testFuzz_upgrade_notProxyAdminOrProxyAdminOwner_reverts(address _sender) public { - // Prank as the not ProxyAdmin or ProxyAdmin owner. - vm.assume(_sender != address(proxyAdmin) && _sender != proxyAdminOwner); - - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("L1ERC721Bridge", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(l1ERC721Bridge), bytes32(slot.slot), bytes32(0)); - - // Expect the revert with `ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner` selector - vm.expectRevert(IProxyAdminOwnedBase.ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner.selector); - - // Call the `upgrade` function with the sender - vm.prank(_sender); - l1ERC721Bridge.upgrade(ISystemConfig(address(0xdeadbeef))); - } -} - /// @title L1ERC721Bridge_SuperchainConfig_Test /// @notice Test contract for L1ERC721Bridge `superchainConfig` function. contract L1ERC721Bridge_SuperchainConfig_Test is L1ERC721Bridge_TestInit { @@ -223,9 +151,9 @@ contract L1ERC721Bridge_SuperchainConfig_Test is L1ERC721Bridge_TestInit { /// @title L1ERC721Bridge_Version_Test /// @notice Test contract for L1ERC721Bridge `version` constant. contract L1ERC721Bridge_Version_Test is L1ERC721Bridge_TestInit { - /// @notice Verifies version returns the expected semantic version. + /// @notice Tests that the version function returns a non-empty string. function test_version_succeeds() external view { - assertEq(l1ERC721Bridge.version(), "2.7.0"); + assert(bytes(l1ERC721Bridge.version()).length > 0); } } diff --git a/packages/contracts-bedrock/test/L1/L1StandardBridge.t.sol b/packages/contracts-bedrock/test/L1/L1StandardBridge.t.sol index a67aeb6f714..03ebb729696 100644 --- a/packages/contracts-bedrock/test/L1/L1StandardBridge.t.sol +++ b/packages/contracts-bedrock/test/L1/L1StandardBridge.t.sol @@ -14,6 +14,7 @@ import { StandardBridge } from "src/universal/StandardBridge.sol"; import { Predeploys } from "src/libraries/Predeploys.sol"; import { AddressAliasHelper } from "src/vendor/AddressAliasHelper.sol"; import { EIP1967Helper } from "test/mocks/EIP1967Helper.sol"; +import { Features } from "src/libraries/Features.sol"; // Interfaces import { ICrossDomainMessenger } from "interfaces/universal/ICrossDomainMessenger.sol"; @@ -217,71 +218,6 @@ contract L1StandardBridge_Initialize_Test is CommonTest { } } -/// @title L1StandardBridge_Upgrade_Test -/// @notice Reusable test for the current upgrade() function in the L1StandardBridge contract. If -/// the upgrade() function is changed, tests inside of this contract should be updated to -/// reflect the new function. If the upgrade() function is removed, remove the -/// corresponding tests but leave this contract in place so it's easy to add tests back -/// in the future. -contract L1StandardBridge_Upgrade_Test is CommonTest { - /// @notice Tests that the upgrade() function succeeds. - function test_upgrade_succeeds() external { - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("L1StandardBridge", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(l1StandardBridge), bytes32(slot.slot), bytes32(0)); - - // Verify the initial systemConfig slot is non-zero. - StorageSlot memory systemConfigSlot = ForgeArtifacts.getSlot("L1StandardBridge", "systemConfig"); - vm.store(address(l1StandardBridge), bytes32(systemConfigSlot.slot), bytes32(uint256(1))); - assertNotEq(address(l1StandardBridge.systemConfig()), address(0)); - assertNotEq(vm.load(address(l1StandardBridge), bytes32(systemConfigSlot.slot)), bytes32(0)); - - ISystemConfig newSystemConfig = ISystemConfig(address(0xdeadbeef)); - - // Trigger upgrade(). - vm.prank(address(l1StandardBridge.proxyAdmin())); - l1StandardBridge.upgrade(newSystemConfig); - - // Verify that the systemConfig was updated. - assertEq(address(l1StandardBridge.systemConfig()), address(newSystemConfig)); - } - - /// @notice Tests that the upgrade() function reverts if called a second time. - function test_upgrade_upgradeTwice_reverts() external { - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("L1StandardBridge", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(l1StandardBridge), bytes32(slot.slot), bytes32(0)); - - ISystemConfig newSystemConfig = ISystemConfig(address(0xdeadbeef)); - - // Trigger first upgrade. - vm.prank(address(l1StandardBridge.proxyAdmin())); - l1StandardBridge.upgrade(newSystemConfig); - - // Try to trigger second upgrade. - vm.prank(address(l1StandardBridge.proxyAdmin())); - vm.expectRevert("Initializable: contract is already initialized"); - l1StandardBridge.upgrade(newSystemConfig); - } - - /// @notice Verifies upgrade reverts with random unauthorized addresses - /// @param _sender Random address for access control test - function testFuzz_upgrade_notProxyAdminOrProxyAdminOwner_reverts(address _sender) public { - vm.assume(_sender != address(proxyAdmin) && _sender != proxyAdminOwner); - - StorageSlot memory slot = ForgeArtifacts.getSlot("L1StandardBridge", "_initialized"); - vm.store(address(l1StandardBridge), bytes32(slot.slot), bytes32(0)); - - vm.expectRevert(IProxyAdminOwnedBase.ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner.selector); - vm.prank(_sender); - l1StandardBridge.upgrade(ISystemConfig(address(0xdeadbeef))); - } -} - /// @title L1StandardBridge_Paused_Test /// @notice Tests the `paused` function of the `L1StandardBridge` contract. contract L1StandardBridge_Paused_Test is CommonTest { @@ -421,8 +357,13 @@ contract L1StandardBridge_Receive_Test is CommonTest { vm.prank(alice, alice); (bool success,) = address(l1StandardBridge).call{ value: 100 }(hex""); assertEq(success, true); - assertEq(address(optimismPortal2).balance, portalBalanceBefore); - assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + 100); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq(address(optimismPortal2).balance, portalBalanceBefore); + assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + 100); + } else { + assertEq(address(optimismPortal2).balance, portalBalanceBefore + 100); + } } /// @notice Verifies receive function reverts when called by contracts @@ -448,8 +389,13 @@ contract L1StandardBridge_DepositETH_Test is L1StandardBridge_TestInit { uint256 portalBalanceBefore = address(optimismPortal2).balance; uint256 ethLockboxBalanceBefore = address(ethLockbox).balance; l1StandardBridge.depositETH{ value: 500 }(50000, hex"dead"); - assertEq(address(optimismPortal2).balance, portalBalanceBefore); - assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + 500); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq(address(optimismPortal2).balance, portalBalanceBefore); + assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + 500); + } else { + assertEq(address(optimismPortal2).balance, portalBalanceBefore + 500); + } } /// @notice Tests that depositing ETH succeeds for an EOA using 7702 delegation. @@ -461,8 +407,13 @@ contract L1StandardBridge_DepositETH_Test is L1StandardBridge_TestInit { uint256 portalBalanceBefore = address(optimismPortal2).balance; uint256 ethLockboxBalanceBefore = address(ethLockbox).balance; l1StandardBridge.depositETH{ value: 500 }(50000, hex"dead"); - assertEq(address(optimismPortal2).balance, portalBalanceBefore); - assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + 500); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq(address(optimismPortal2).balance, portalBalanceBefore); + assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + 500); + } else { + assertEq(address(optimismPortal2).balance, portalBalanceBefore + 500); + } } /// @notice Tests that depositing ETH reverts if the call is not from an EOA. @@ -487,8 +438,13 @@ contract L1StandardBridge_DepositETHTo_Test is L1StandardBridge_TestInit { uint256 portalBalanceBefore = address(optimismPortal2).balance; uint256 ethLockboxBalanceBefore = address(ethLockbox).balance; l1StandardBridge.depositETHTo{ value: 600 }(bob, 60000, hex"dead"); - assertEq(address(optimismPortal2).balance, portalBalanceBefore); - assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + 600); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq(address(optimismPortal2).balance, portalBalanceBefore); + assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + 600); + } else { + assertEq(address(optimismPortal2).balance, portalBalanceBefore + 600); + } } /// @notice Verifies depositETHTo succeeds with various recipients and amounts @@ -500,10 +456,17 @@ contract L1StandardBridge_DepositETHTo_Test is L1StandardBridge_TestInit { vm.deal(alice, _amount); + uint256 portalBalanceBefore = address(optimismPortal2).balance; uint256 ethLockboxBalanceBefore = address(ethLockbox).balance; + vm.prank(alice); l1StandardBridge.depositETHTo{ value: _amount }(_to, 60000, hex"dead"); - assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + _amount); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + _amount); + } else { + assertEq(address(optimismPortal2).balance, portalBalanceBefore + _amount); + } } } @@ -820,8 +783,13 @@ contract L1StandardBridge_Uncategorized_Test is L1StandardBridge_TestInit { uint256 portalBalanceBefore = address(optimismPortal2).balance; uint256 ethLockboxBalanceBefore = address(ethLockbox).balance; l1StandardBridge.bridgeETH{ value: 500 }(50000, hex"dead"); - assertEq(address(optimismPortal2).balance, portalBalanceBefore); - assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + 500); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq(address(optimismPortal2).balance, portalBalanceBefore); + assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + 500); + } else { + assertEq(address(optimismPortal2).balance, portalBalanceBefore + 500); + } } /// @notice Tests that bridging ETH to a different address succeeds. @@ -834,8 +802,13 @@ contract L1StandardBridge_Uncategorized_Test is L1StandardBridge_TestInit { uint256 portalBalanceBefore = address(optimismPortal2).balance; uint256 ethLockboxBalanceBefore = address(ethLockbox).balance; l1StandardBridge.bridgeETHTo{ value: 600 }(bob, 60000, hex"dead"); - assertEq(address(optimismPortal2).balance, portalBalanceBefore); - assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + 600); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq(address(optimismPortal2).balance, portalBalanceBefore); + assertEq(address(ethLockbox).balance, ethLockboxBalanceBefore + 600); + } else { + assertEq(address(optimismPortal2).balance, portalBalanceBefore + 600); + } } /// @notice Tests that finalizing bridged ETH succeeds. diff --git a/packages/contracts-bedrock/test/L1/OPContractsManager.t.sol b/packages/contracts-bedrock/test/L1/OPContractsManager.t.sol index e98bb2b4e56..4df6358cae1 100644 --- a/packages/contracts-bedrock/test/L1/OPContractsManager.t.sol +++ b/packages/contracts-bedrock/test/L1/OPContractsManager.t.sol @@ -14,27 +14,19 @@ import { DeployUtils } from "scripts/libraries/DeployUtils.sol"; import { Deploy } from "scripts/deploy/Deploy.s.sol"; import { VerifyOPCM } from "scripts/deploy/VerifyOPCM.s.sol"; import { Config } from "scripts/libraries/Config.sol"; -import { StandardConstants } from "scripts/deploy/StandardConstants.sol"; // Libraries import { EIP1967Helper } from "test/mocks/EIP1967Helper.sol"; -import { Blueprint } from "src/libraries/Blueprint.sol"; import { GameType, Duration, Hash, Claim } from "src/dispute/lib/LibUDT.sol"; import { Proposal, GameTypes } from "src/dispute/lib/Types.sol"; +import { DevFeatures } from "src/libraries/DevFeatures.sol"; // Interfaces import { IAnchorStateRegistry } from "interfaces/dispute/IAnchorStateRegistry.sol"; -import { IL1ERC721Bridge } from "interfaces/L1/IL1ERC721Bridge.sol"; -import { IL1StandardBridge } from "interfaces/L1/IL1StandardBridge.sol"; -import { IOptimismMintableERC20Factory } from "interfaces/universal/IOptimismMintableERC20Factory.sol"; -import { IL1CrossDomainMessenger } from "interfaces/L1/IL1CrossDomainMessenger.sol"; -import { IMIPS64 } from "interfaces/cannon/IMIPS64.sol"; import { IOptimismPortal2 } from "interfaces/L1/IOptimismPortal2.sol"; -import { IProxy } from "interfaces/universal/IProxy.sol"; import { IProxyAdmin } from "interfaces/universal/IProxyAdmin.sol"; import { ISuperchainConfig } from "interfaces/L1/ISuperchainConfig.sol"; import { IProtocolVersions } from "interfaces/L1/IProtocolVersions.sol"; -import { IPreimageOracle } from "interfaces/cannon/IPreimageOracle.sol"; import { IFaultDisputeGame } from "interfaces/dispute/IFaultDisputeGame.sol"; import { IPermissionedDisputeGame } from "interfaces/dispute/IPermissionedDisputeGame.sol"; import { IDelayedWETH } from "interfaces/dispute/IDelayedWETH.sol"; @@ -43,21 +35,15 @@ import { IDisputeGameFactory } from "interfaces/dispute/IDisputeGameFactory.sol" import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol"; import { IOPContractsManager, - IOPCMImplementationsWithoutLockbox, IOPContractsManagerGameTypeAdder, - IOPContractsManagerDeployer, - IOPContractsManagerUpgrader, - IOPContractsManagerContractsContainer, IOPContractsManagerInteropMigrator, - IOPContractsManagerStandardValidator + IOPContractsManagerUpgrader } from "interfaces/L1/IOPContractsManager.sol"; -import { IOPContractsManager200 } from "interfaces/L1/IOPContractsManager200.sol"; -import { ISemver } from "interfaces/universal/ISemver.sol"; +import { IOPContractsManagerStandardValidator } from "interfaces/L1/IOPContractsManagerStandardValidator.sol"; import { IETHLockbox } from "interfaces/L1/IETHLockbox.sol"; import { IBigStepper } from "interfaces/dispute/IBigStepper.sol"; import { ISuperFaultDisputeGame } from "interfaces/dispute/ISuperFaultDisputeGame.sol"; import { ISuperPermissionedDisputeGame } from "interfaces/dispute/ISuperPermissionedDisputeGame.sol"; -import { IOPContractsManagerStandardValidator } from "interfaces/L1/IOPContractsManagerStandardValidator.sol"; // Contracts import { @@ -122,6 +108,9 @@ contract OPContractsManager_Upgrade_Harness is CommonTest { // The ImplementationSet event emitted by the DisputeGameFactory contract. event ImplementationSet(address indexed impl, GameType indexed gameType); + /// @notice Thrown when testing with an unsupported chain ID. + error UnsupportedChainId(); + uint256 l2ChainId; address upgrader; IOPContractsManager.OpChainConfig[] opChainConfigs; @@ -164,543 +153,171 @@ contract OPContractsManager_Upgrade_Harness is CommonTest { delayedWeth = IDelayedWETH(payable(artifacts.mustGetAddress("PermissionlessDelayedWETHProxy"))); permissionedDisputeGame = IPermissionedDisputeGame(address(artifacts.mustGetAddress("PermissionedDisputeGame"))); faultDisputeGame = IFaultDisputeGame(address(artifacts.mustGetAddress("FaultDisputeGame"))); - } - function expectEmitUpgraded(address impl, address proxy) public { - vm.expectEmit(proxy); - emit Upgraded(impl); + // Since this superchainConfig is already at the expected reinitializer version... + // We do this to pass the reinitializer check when trying to upgrade the superchainConfig contract. + + // Get the value of the 0th storage slot of the superchainConfig contract. + bytes32 slot0 = vm.load(address(superchainConfig), bytes32(0)); + // Remove the value of initialized slot. + slot0 = slot0 & bytes32(~uint256(0xff)); + // Store 1 there. + slot0 = bytes32(uint256(slot0) + 1); + // Store the new value. + vm.store(address(superchainConfig), bytes32(0), slot0); } - function runUpgrade13UpgradeAndChecks(address _delegateCaller) public { - // The address below corresponds with the address of the v2.0.0-rc.1 OPCM on mainnet. - address OPCM_ADDRESS = 0x026b2F158255Beac46c1E7c6b8BbF29A4b6A7B76; - - IOPContractsManager deployedOPCM = IOPContractsManager(OPCM_ADDRESS); - IOPCMImplementationsWithoutLockbox.Implementations memory impls = - IOPCMImplementationsWithoutLockbox(address(deployedOPCM)).implementations(); - - // Always trigger U13 once with an empty opChainConfig array to ensure that the - // SuperchainConfig contract is upgraded. Separate context to avoid stack too deep. - { - ISuperchainConfig superchainConfig = ISuperchainConfig(artifacts.mustGetAddress("SuperchainConfigProxy")); - address superchainPAO = IProxyAdmin(EIP1967Helper.getAdmin(address(superchainConfig))).owner(); - vm.etch(superchainPAO, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); - DelegateCaller(superchainPAO).dcForward( - OPCM_ADDRESS, abi.encodeCall(IOPContractsManager.upgrade, (new IOPContractsManager.OpChainConfig[](0))) + /// @notice Helper function that runs an OPCM upgrade, asserts that the upgrade was successful, + /// asserts that it fits within a certain amount of gas, and runs the StandardValidator + /// over the result. + /// @param _opcm The OPCM contract to upgrade with. + /// @param _delegateCaller The address of the delegate caller to use for the upgrade. + /// @param _revertBytes The bytes of the revert to expect. + function _runOpcmUpgradeAndChecks( + IOPContractsManager _opcm, + address _delegateCaller, + bytes memory _revertBytes + ) + internal + { + // Always start by upgrading the SuperchainConfig contract. + // Temporarily replace the superchainPAO with a DelegateCaller. + address superchainPAO = IProxyAdmin(EIP1967Helper.getAdmin(address(superchainConfig))).owner(); + bytes memory superchainPAOCode = address(superchainPAO).code; + vm.etch(superchainPAO, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); + + // Execute the SuperchainConfig upgrade. + // nosemgrep: sol-safety-trycatch-eip150 + try DelegateCaller(superchainPAO).dcForward( + address(_opcm), + abi.encodeCall(IOPContractsManager.upgradeSuperchainConfig, (superchainConfig, superchainProxyAdmin)) + ) { + // Great, the upgrade succeeded. + } catch (bytes memory reason) { + // Only acceptable revert reason is the SuperchainConfig already being up to date. This + // try/catch is better than checking the version via the implementations struct because + // the implementations struct interface can change between OPCM versions which would + // cause the test to break and be a pain to resolve. + assertTrue( + bytes4(reason) + == IOPContractsManagerUpgrader.OPContractsManagerUpgrader_SuperchainConfigAlreadyUpToDate.selector, + "Revert reason other than SuperchainConfigAlreadyUpToDate" ); } - // Cache the old L1xDM address so we can look for it in the AddressManager's event - address oldL1CrossDomainMessenger = addressManager.getAddress("OVM_L1CrossDomainMessenger"); - - // Predict the address of the new AnchorStateRegistry proxy - bytes32 salt = keccak256( - abi.encode( - l2ChainId, - string.concat( - string(bytes.concat(bytes32(uint256(uint160(address(opChainConfigs[0].systemConfigProxy)))))) - ), - "AnchorStateRegistry" - ) - ); - address proxyBp = IOPContractsManager200(address(deployedOPCM)).blueprints().proxy; - Blueprint.Preamble memory preamble = Blueprint.parseBlueprintPreamble(proxyBp.code); - bytes memory initCode = bytes.concat(preamble.initcode, abi.encode(proxyAdmin)); - address newAnchorStateRegistryProxy = vm.computeCreate2Address(salt, keccak256(initCode), _delegateCaller); - vm.label(newAnchorStateRegistryProxy, "NewAnchorStateRegistryProxy"); - - expectEmitUpgraded(impls.systemConfigImpl, address(systemConfig)); - vm.expectEmit(address(addressManager)); - emit AddressSet("OVM_L1CrossDomainMessenger", impls.l1CrossDomainMessengerImpl, oldL1CrossDomainMessenger); - // This is where we would emit an event for the L1StandardBridge however - // the Chugsplash proxy does not emit such an event. - expectEmitUpgraded(impls.l1ERC721BridgeImpl, address(l1ERC721Bridge)); - expectEmitUpgraded(impls.disputeGameFactoryImpl, address(disputeGameFactory)); - expectEmitUpgraded(impls.optimismPortalImpl, address(optimismPortal2)); - expectEmitUpgraded(impls.optimismMintableERC20FactoryImpl, address(l1OptimismMintableERC20Factory)); - vm.expectEmit(address(newAnchorStateRegistryProxy)); - emit AdminChanged(address(0), address(proxyAdmin)); - expectEmitUpgraded(impls.anchorStateRegistryImpl, address(newAnchorStateRegistryProxy)); - expectEmitUpgraded(impls.delayedWETHImpl, address(delayedWETHPermissionedGameProxy)); - - // We don't yet know the address of the new permissionedGame which will be deployed by the - // OPContractsManager.upgrade() call, so ignore the first topic. - vm.expectEmit(false, true, true, true, address(disputeGameFactory)); - emit ImplementationSet(address(0), GameTypes.PERMISSIONED_CANNON); - - IFaultDisputeGame oldFDG = IFaultDisputeGame(address(disputeGameFactory.gameImpls(GameTypes.CANNON))); - if (address(oldFDG) != address(0)) { - IDelayedWETH weth = oldFDG.weth(); - expectEmitUpgraded(impls.delayedWETHImpl, address(weth)); - - // Ignore the first topic for the same reason as the previous comment. - vm.expectEmit(false, true, true, true, address(disputeGameFactory)); - emit ImplementationSet(address(0), GameTypes.CANNON); - } - - vm.expectEmit(address(_delegateCaller)); - emit Upgraded(l2ChainId, opChainConfigs[0].systemConfigProxy, address(_delegateCaller)); + // Reset the superchainPAO to the original code. + vm.etch(superchainPAO, superchainPAOCode); - // Temporarily replace the upgrader with a DelegateCaller so we can test the upgrade, - // then reset its code to the original code. + // Temporarily replace the upgrader with a DelegateCaller. bytes memory delegateCallerCode = address(_delegateCaller).code; vm.etch(_delegateCaller, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); - DelegateCaller(_delegateCaller).dcForward( - address(deployedOPCM), abi.encodeCall(IOPContractsManager.upgrade, (opChainConfigs)) - ); - - VmSafe.Gas memory gas = vm.lastCallGas(); - - // Less than 90% of the gas target of 20M to account for the gas used by using Safe. - assertLt(gas.gasTotalUsed, 0.9 * 20_000_000, "Upgrade exceeds gas target of 15M"); - - vm.etch(_delegateCaller, delegateCallerCode); - - // Check the implementations of the core addresses - assertEq(impls.systemConfigImpl, EIP1967Helper.getImplementation(address(systemConfig))); - assertEq(impls.l1ERC721BridgeImpl, EIP1967Helper.getImplementation(address(l1ERC721Bridge))); - assertEq(impls.disputeGameFactoryImpl, EIP1967Helper.getImplementation(address(disputeGameFactory))); - assertEq(impls.optimismPortalImpl, EIP1967Helper.getImplementation(address(optimismPortal2))); - assertEq( - impls.optimismMintableERC20FactoryImpl, - EIP1967Helper.getImplementation(address(l1OptimismMintableERC20Factory)) - ); - assertEq(impls.l1StandardBridgeImpl, EIP1967Helper.getImplementation(address(l1StandardBridge))); - assertEq(impls.l1CrossDomainMessengerImpl, addressManager.getAddress("OVM_L1CrossDomainMessenger")); - - // Check the implementations of the FP contracts - assertEq(impls.anchorStateRegistryImpl, EIP1967Helper.getImplementation(address(newAnchorStateRegistryProxy))); - assertEq(impls.delayedWETHImpl, EIP1967Helper.getImplementation(address(delayedWETHPermissionedGameProxy))); - - // Check that the PermissionedDisputeGame is upgraded to the expected version, references - // the correct anchor state and has the mipsImpl. - IPermissionedDisputeGame pdg = - IPermissionedDisputeGame(address(disputeGameFactory.gameImpls(GameTypes.PERMISSIONED_CANNON))); - assertEq(ISemver(address(pdg)).version(), "1.4.1"); - assertEq(address(pdg.anchorStateRegistry()), address(newAnchorStateRegistryProxy)); - assertEq(address(pdg.vm()), impls.mipsImpl); - - if (address(oldFDG) != address(0)) { - // Check that the PermissionlessDisputeGame is upgraded to the expected version - IFaultDisputeGame newFDG = IFaultDisputeGame(address(disputeGameFactory.gameImpls(GameTypes.CANNON))); - // Check that the PermissionlessDisputeGame is upgraded to the expected version, - // references the correct anchor state and has the mipsImpl. - assertEq(impls.delayedWETHImpl, EIP1967Helper.getImplementation(address(newFDG.weth()))); - assertEq(ISemver(address(newFDG)).version(), "1.4.1"); - assertEq(address(newFDG.anchorStateRegistry()), address(newAnchorStateRegistryProxy)); - assertEq(address(newFDG.vm()), impls.mipsImpl); + // Expect the revert if one is specified. + if (_revertBytes.length > 0) { + vm.expectRevert(_revertBytes); } - } - - function runUpgrade14UpgradeAndChecks(address _delegateCaller) public { - address OPCM_ADDRESS = 0x3A1f523a4bc09cd344A2745a108Bb0398288094F; - - IOPContractsManager deployedOPCM = IOPContractsManager(OPCM_ADDRESS); - IOPCMImplementationsWithoutLockbox.Implementations memory impls = - IOPCMImplementationsWithoutLockbox(address(deployedOPCM)).implementations(); - - address mainnetPAO = artifacts.mustGetAddress("SuperchainConfigProxy"); - - // If the delegate caller is not the mainnet PAO, we need to call upgrade as the mainnet - // PAO first. - if (_delegateCaller != mainnetPAO) { - IOPContractsManager.OpChainConfig[] memory opmChain = new IOPContractsManager.OpChainConfig[](0); - ISuperchainConfig superchainConfig = ISuperchainConfig(mainnetPAO); - - address opmUpgrader = IProxyAdmin(EIP1967Helper.getAdmin(address(superchainConfig))).owner(); - vm.etch(opmUpgrader, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); - - DelegateCaller(opmUpgrader).dcForward(OPCM_ADDRESS, abi.encodeCall(IOPContractsManager.upgrade, (opmChain))); - } - - // sanity check - IPermissionedDisputeGame oldPDG = - IPermissionedDisputeGame(address(disputeGameFactory.gameImpls(GameTypes.PERMISSIONED_CANNON))); - IFaultDisputeGame oldFDG = IFaultDisputeGame(address(disputeGameFactory.gameImpls(GameTypes.CANNON))); - - // Sanity check that the mips IMPL is not MIPS64 - assertNotEq(address(oldPDG.vm()), impls.mipsImpl); - - // We don't yet know the address of the new permissionedGame which will be deployed by the - // OPContractsManager.upgrade() call, so ignore the first topic. - vm.expectEmit(false, true, true, true, address(disputeGameFactory)); - emit ImplementationSet(address(0), GameTypes.PERMISSIONED_CANNON); - - if (address(oldFDG) != address(0)) { - // Sanity check that the mips IMPL is not MIPS64 - assertNotEq(address(oldFDG.vm()), impls.mipsImpl); - // Ignore the first topic for the same reason as the previous comment. - vm.expectEmit(false, true, true, true, address(disputeGameFactory)); - emit ImplementationSet(address(0), GameTypes.CANNON); - } - vm.expectEmit(address(_delegateCaller)); - emit Upgraded(l2ChainId, opChainConfigs[0].systemConfigProxy, address(_delegateCaller)); - - // Temporarily replace the upgrader with a DelegateCaller so we can test the upgrade, - // then reset its code to the original code. - bytes memory delegateCallerCode = address(_delegateCaller).code; - vm.etch(_delegateCaller, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); + // Execute the chain upgrade. DelegateCaller(_delegateCaller).dcForward( - address(deployedOPCM), abi.encodeCall(IOPContractsManager.upgrade, (opChainConfigs)) + address(_opcm), abi.encodeCall(IOPContractsManager.upgrade, (opChainConfigs)) ); - VmSafe.Gas memory gas = vm.lastCallGas(); - - // Less than 90% of the gas target of 20M to account for the gas used by using Safe. - assertLt(gas.gasTotalUsed, 0.9 * 20_000_000, "Upgrade exceeds gas target of 15M"); - - vm.etch(_delegateCaller, delegateCallerCode); - - // Check that the PermissionedDisputeGame is upgraded to the expected version, references - // the correct anchor state and has the mipsImpl. - IPermissionedDisputeGame pdg = - IPermissionedDisputeGame(address(disputeGameFactory.gameImpls(GameTypes.PERMISSIONED_CANNON))); - assertEq(ISemver(address(pdg)).version(), "1.4.1"); - assertEq(address(pdg.vm()), impls.mipsImpl); - - // Check that the SystemConfig is upgraded to the expected version - assertEq(ISemver(address(systemConfig)).version(), "2.5.0"); - assertEq(impls.systemConfigImpl, EIP1967Helper.getImplementation(address(systemConfig))); - - if (address(oldFDG) != address(0)) { - // Check that the PermissionlessDisputeGame is upgraded to the expected version - IFaultDisputeGame newFDG = IFaultDisputeGame(address(disputeGameFactory.gameImpls(GameTypes.CANNON))); - // Check that the PermissionlessDisputeGame is upgraded to the expected version, - // references the correct anchor state and has the mipsImpl. - assertEq(ISemver(address(newFDG)).version(), "1.4.1"); - assertEq(address(newFDG.vm()), impls.mipsImpl); + // Return early if a revert was expected. Otherwise we'll get errors below. + if (_revertBytes.length > 0) { + return; } - } - function runUpgrade15UpgradeAndChecks(address _delegateCaller) public { - IOPContractsManager.Implementations memory impls = opcm.implementations(); + // Less than 90% of the gas target of 2**24 (EIP-7825) to account for the gas used by + // using Safe. + uint256 fusakaLimit = 2 ** 24; + VmSafe.Gas memory gas = vm.lastCallGas(); + assertLt(gas.gasTotalUsed, fusakaLimit * 9 / 10, "Upgrade exceeds gas target of 90% of 2**24 (EIP-7825)"); - // Always trigger U15 once with an empty opChainConfig array to ensure that the - // SuperchainConfig contract is upgraded. Separate context to avoid stack too deep. - { - ISuperchainConfig superchainConfig = ISuperchainConfig(artifacts.mustGetAddress("SuperchainConfigProxy")); - address superchainPAO = IProxyAdmin(EIP1967Helper.getAdmin(address(superchainConfig))).owner(); - vm.etch(superchainPAO, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); - DelegateCaller(superchainPAO).dcForward( - address(opcm), abi.encodeCall(IOPContractsManager.upgrade, (new IOPContractsManager.OpChainConfig[](0))) - ); - } + // Reset the upgrader to the original code. + vm.etch(_delegateCaller, delegateCallerCode); - // Predict the address of the new AnchorStateRegistry proxy. - // Subcontext to avoid stack too deep. - address newAsrProxy; - { - // Compute the salt using the system config address. - bytes32 salt = keccak256( - abi.encode( - l2ChainId, - string.concat(string(bytes.concat(bytes32(uint256(uint160(address(systemConfig))))))), - "AnchorStateRegistry-U16" - ) - ); + // We expect there to only be one chain config for these tests, you will have to rework + // this test if you add more. + assertEq(opChainConfigs.length, 1); - // Use the actual proxy instead of the local code so we can reuse this test. - address proxyBp = opcm.blueprints().proxy; - Blueprint.Preamble memory preamble = Blueprint.parseBlueprintPreamble(proxyBp.code); - bytes memory initCode = bytes.concat(preamble.initcode, abi.encode(proxyAdmin)); - newAsrProxy = vm.computeCreate2Address(salt, keccak256(initCode), _delegateCaller); - vm.label(newAsrProxy, "NewAnchorStateRegistryProxy"); + // Coverage changes bytecode, so we get various errors. We can safely ignore the result of + // the standard validator in the coverage case, if the validator is failing in coverage + // then it will also fail in other CI tests (unless it's the expected issues, in which case + // we can safely skip). + if (vm.isContext(VmSafe.ForgeContext.Coverage)) { + return; } - // Grab the PermissionedDisputeGame and FaultDisputeGame implementations before upgrade. - address oldPDGImpl = address(disputeGameFactory.gameImpls(GameTypes.PERMISSIONED_CANNON)); - address oldFDGImpl = address(disputeGameFactory.gameImpls(GameTypes.CANNON)); - IPermissionedDisputeGame oldPDG = IPermissionedDisputeGame(oldPDGImpl); - IFaultDisputeGame oldFDG = IFaultDisputeGame(oldFDGImpl); - - // Expect the SystemConfig and OptimismPortal to be upgraded. - expectEmitUpgraded(impls.systemConfigImpl, address(systemConfig)); - expectEmitUpgraded(impls.optimismPortalImpl, address(optimismPortal2)); - - // We always expect the PermissionedDisputeGame to be deployed. We don't yet know the - // address of the new permissionedGame which will be deployed by the - // OPContractsManager.upgrade() call, so ignore the first topic. - vm.expectEmit(false, true, true, true, address(disputeGameFactory)); - emit ImplementationSet(address(0), GameTypes.PERMISSIONED_CANNON); - - // If the old FaultDisputeGame exists, we expect it to be upgraded. - if (address(oldFDG) != address(0)) { - // Ignore the first topic for the same reason as the previous comment. - vm.expectEmit(false, true, true, true, address(disputeGameFactory)); - emit ImplementationSet(address(0), GameTypes.CANNON); + // Grab the validator before we do the error assertion because otherwise the assertion will + // try to apply to this function call instead. + IOPContractsManagerStandardValidator validator = _opcm.opcmStandardValidator(); + + // If the absolute prestate is zero, we will always get a PDDG-40,PLDG-40 error here in the + // standard validator. This happens because an absolute prestate of zero means that the + // user is requesting to use the existing prestate. We could avoid the error by grabbing + // the prestate from the actual contracts, but that doesn't actually give us any valuable + // checks. Easier to just expect the error in this case. + if (opChainConfigs[0].absolutePrestate.raw() == bytes32(0)) { + vm.expectRevert("OPContractsManagerStandardValidator: PDDG-40,PLDG-40"); } - vm.expectEmit(address(_delegateCaller)); - emit Upgraded(l2ChainId, systemConfig, address(_delegateCaller)); - - // Temporarily replace the upgrader with a DelegateCaller so we can test the upgrade, - // then reset its code to the original code. - bytes memory delegateCallerCode = address(_delegateCaller).code; - vm.etch(_delegateCaller, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); - - // Execute the upgrade. - // We use the new format here, not the legacy one. - DelegateCaller(_delegateCaller).dcForward( - address(opcm), abi.encodeCall(IOPContractsManager.upgrade, (opChainConfigs)) + // Run the StandardValidator checks. + validator.validate( + IOPContractsManagerStandardValidator.ValidationInput({ + proxyAdmin: opChainConfigs[0].proxyAdmin, + sysCfg: opChainConfigs[0].systemConfigProxy, + absolutePrestate: opChainConfigs[0].absolutePrestate.raw(), + l2ChainID: l2ChainId + }), + false ); + } - // Less than 90% of the gas target of 20M to account for the gas used by using Safe. - VmSafe.Gas memory gas = vm.lastCallGas(); - assertLt(gas.gasTotalUsed, 0.9 * 20_000_000, "Upgrade exceeds gas target of 15M"); - - // Reset the upgrader's code to the original code. - vm.etch(_delegateCaller, delegateCallerCode); - - // Grab the new implementations. - address newPDGImpl = address(disputeGameFactory.gameImpls(GameTypes.PERMISSIONED_CANNON)); - IPermissionedDisputeGame pdg = IPermissionedDisputeGame(newPDGImpl); - address newFDGImpl = address(disputeGameFactory.gameImpls(GameTypes.CANNON)); - IFaultDisputeGame fdg = IFaultDisputeGame(newFDGImpl); - - // Check that the PermissionedDisputeGame is upgraded to the expected version, references - // the correct anchor state and has the mipsImpl. Although Upgrade 15 doesn't actually - // change any of this, we might as well check it again. - assertEq(ISemver(address(pdg)).version(), "1.7.0"); - assertEq(address(pdg.vm()), impls.mipsImpl); - assertEq(pdg.l2ChainId(), oldPDG.l2ChainId()); - - // If the old FaultDisputeGame exists, we expect it to be upgraded. Check same as above. - if (address(oldFDG) != address(0)) { - assertEq(ISemver(address(fdg)).version(), "1.7.0"); - assertEq(address(fdg.vm()), impls.mipsImpl); - assertEq(fdg.l2ChainId(), oldFDG.l2ChainId()); + /// @notice Executes all past upgrades that have not yet been executed on mainnet as of the + /// current simulation block defined in the justfile for this package. This function + /// might be empty if there are no previous upgrades to execute. You should remove + /// upgrades from this function once they've been executed on mainnet and the + /// simulation block has been bumped beyond the execution block. + /// @param _delegateCaller The address of the delegate caller to use for the upgrade. + function runPastUpgrades(address _delegateCaller) internal { + // Run past upgrades depending on network. + if (block.chainid == 1) { + // Mainnet + // U16a + _runOpcmUpgradeAndChecks( + IOPContractsManager(0x8123739C1368C2DEDc8C564255bc417FEEeBFF9D), _delegateCaller, bytes("") + ); + } else { + revert UnsupportedChainId(); } + } - // Make sure that the SystemConfig is upgraded to the right version. It must also have the - // right l2ChainId and must be properly initialized. - assertEq(ISemver(address(systemConfig)).version(), "3.4.0"); - assertEq(impls.systemConfigImpl, EIP1967Helper.getImplementation(address(systemConfig))); - assertEq(systemConfig.l2ChainId(), l2ChainId); - DeployUtils.assertInitialized({ _contractAddress: address(systemConfig), _isProxy: true, _slot: 0, _offset: 0 }); - - // Make sure that the OptimismPortal is upgraded to the right version. It must also have a - // reference to the new AnchorStateRegistry. - assertEq(ISemver(address(optimismPortal2)).version(), "4.6.0"); - assertEq(impls.optimismPortalImpl, EIP1967Helper.getImplementation(address(optimismPortal2))); - assertEq(address(optimismPortal2.anchorStateRegistry()), address(newAsrProxy)); - DeployUtils.assertInitialized({ - _contractAddress: address(optimismPortal2), - _isProxy: true, - _slot: 0, - _offset: 0 - }); - - // Make sure the new AnchorStateRegistry has the right version and is initialized. - assertEq(ISemver(address(newAsrProxy)).version(), "3.5.0"); - vm.prank(address(proxyAdmin)); - assertEq(IProxy(payable(newAsrProxy)).admin(), address(proxyAdmin)); - DeployUtils.assertInitialized({ _contractAddress: address(newAsrProxy), _isProxy: true, _slot: 0, _offset: 0 }); + /// @notice Executes the current upgrade and checks the results. + /// @param _delegateCaller The address of the delegate caller to use for the upgrade. + function runCurrentUpgrade(address _delegateCaller) public { + _runOpcmUpgradeAndChecks(opcm, _delegateCaller, bytes("")); } - function runUpgradeTestAndChecks(address _delegateCaller) public { - // TODO(#14691): Remove this function once Upgrade 15 is deployed on Mainnet. - runUpgrade13UpgradeAndChecks(_delegateCaller); - // TODO(#14691): Remove this function once Upgrade 15 is deployed on Mainnet. - runUpgrade14UpgradeAndChecks(_delegateCaller); - runUpgrade15UpgradeAndChecks(_delegateCaller); + /// @notice Executes the current upgrade and expects reverts. + /// @param _delegateCaller The address of the delegate caller to use for the upgrade. + /// @param _revertBytes The bytes of the revert to expect. + function runCurrentUpgrade(address _delegateCaller, bytes memory _revertBytes) public { + _runOpcmUpgradeAndChecks(opcm, _delegateCaller, _revertBytes); } } /// @title OPContractsManager_TestInit /// @notice Reusable test initialization for `OPContractsManager` tests. -contract OPContractsManager_TestInit is Test { - IOPContractsManager internal opcm; +contract OPContractsManager_TestInit is CommonTest { IOPContractsManager.DeployOutput internal chainDeployOutput1; IOPContractsManager.DeployOutput internal chainDeployOutput2; - address challenger = makeAddr("challenger"); - ISuperchainConfig superchainConfigProxy = ISuperchainConfig(makeAddr("superchainConfig")); - IProtocolVersions protocolVersionsProxy = IProtocolVersions(makeAddr("protocolVersions")); - IProxyAdmin superchainProxyAdmin = IProxyAdmin(makeAddr("superchainProxyAdmin")); - - function setUp() public virtual { - bytes32 salt = hex"01"; - IOPContractsManager.Blueprints memory blueprints; - (blueprints.addressManager,) = Blueprint.create(vm.getCode("AddressManager"), salt); - (blueprints.proxy,) = Blueprint.create(vm.getCode("Proxy"), salt); - (blueprints.proxyAdmin,) = Blueprint.create(vm.getCode("ProxyAdmin"), salt); - (blueprints.l1ChugSplashProxy,) = Blueprint.create(vm.getCode("L1ChugSplashProxy"), salt); - (blueprints.resolvedDelegateProxy,) = Blueprint.create(vm.getCode("ResolvedDelegateProxy"), salt); - (blueprints.permissionedDisputeGame1, blueprints.permissionedDisputeGame2) = - Blueprint.create(vm.getCode("PermissionedDisputeGame"), salt); - (blueprints.permissionlessDisputeGame1, blueprints.permissionlessDisputeGame2) = - Blueprint.create(vm.getCode("FaultDisputeGame"), salt); - (blueprints.superPermissionedDisputeGame1, blueprints.superPermissionedDisputeGame2) = - Blueprint.create(vm.getCode("SuperPermissionedDisputeGame"), salt); - (blueprints.superPermissionlessDisputeGame1, blueprints.superPermissionlessDisputeGame2) = - Blueprint.create(vm.getCode("SuperFaultDisputeGame"), salt); - - IPreimageOracle oracle = IPreimageOracle( - DeployUtils.create1({ - _name: "PreimageOracle", - _args: DeployUtils.encodeConstructor(abi.encodeCall(IPreimageOracle.__constructor__, (126000, 86400))) - }) - ); - IOPContractsManager.Implementations memory impls = IOPContractsManager.Implementations({ - superchainConfigImpl: DeployUtils.create1({ - _name: "SuperchainConfig", - _args: DeployUtils.encodeConstructor(abi.encodeCall(ISuperchainConfig.__constructor__, ())) - }), - protocolVersionsImpl: DeployUtils.create1({ - _name: "ProtocolVersions", - _args: DeployUtils.encodeConstructor(abi.encodeCall(IProtocolVersions.__constructor__, ())) - }), - l1ERC721BridgeImpl: DeployUtils.create1({ - _name: "L1ERC721Bridge", - _args: DeployUtils.encodeConstructor(abi.encodeCall(IL1ERC721Bridge.__constructor__, ())) - }), - optimismPortalImpl: DeployUtils.create1({ - _name: "OptimismPortal2", - _args: DeployUtils.encodeConstructor(abi.encodeCall(IOptimismPortal2.__constructor__, (1))) - }), - ethLockboxImpl: DeployUtils.create1({ - _name: "ETHLockbox", - _args: DeployUtils.encodeConstructor(abi.encodeCall(IETHLockbox.__constructor__, ())) - }), - systemConfigImpl: DeployUtils.create1({ - _name: "SystemConfig", - _args: DeployUtils.encodeConstructor(abi.encodeCall(ISystemConfig.__constructor__, ())) - }), - optimismMintableERC20FactoryImpl: DeployUtils.create1({ - _name: "OptimismMintableERC20Factory", - _args: DeployUtils.encodeConstructor(abi.encodeCall(IOptimismMintableERC20Factory.__constructor__, ())) - }), - l1CrossDomainMessengerImpl: DeployUtils.create1({ - _name: "L1CrossDomainMessenger", - _args: DeployUtils.encodeConstructor(abi.encodeCall(IL1CrossDomainMessenger.__constructor__, ())) - }), - l1StandardBridgeImpl: DeployUtils.create1({ - _name: "L1StandardBridge", - _args: DeployUtils.encodeConstructor(abi.encodeCall(IL1StandardBridge.__constructor__, ())) - }), - disputeGameFactoryImpl: DeployUtils.create1({ - _name: "DisputeGameFactory", - _args: DeployUtils.encodeConstructor(abi.encodeCall(IDisputeGameFactory.__constructor__, ())) - }), - anchorStateRegistryImpl: DeployUtils.create1({ - _name: "AnchorStateRegistry", - _args: DeployUtils.encodeConstructor(abi.encodeCall(IAnchorStateRegistry.__constructor__, (1))) - }), - delayedWETHImpl: DeployUtils.create1({ - _name: "DelayedWETH", - _args: DeployUtils.encodeConstructor(abi.encodeCall(IDelayedWETH.__constructor__, (3))) - }), - mipsImpl: DeployUtils.create1({ - _name: "MIPS64", - _args: DeployUtils.encodeConstructor( - abi.encodeCall(IMIPS64.__constructor__, (oracle, StandardConstants.MIPS_VERSION)) - ) - }) - }); - - vm.etch(address(superchainConfigProxy), hex"01"); - vm.etch(address(protocolVersionsProxy), hex"01"); - - IOPContractsManagerContractsContainer container = IOPContractsManagerContractsContainer( - DeployUtils.createDeterministic({ - _name: "OPContractsManagerContractsContainer", - _args: DeployUtils.encodeConstructor( - abi.encodeCall(IOPContractsManagerContractsContainer.__constructor__, (blueprints, impls)) - ), - _salt: DeployUtils.DEFAULT_SALT - }) - ); - - IOPContractsManager.Implementations memory __opcmImplementations = container.implementations(); - IOPContractsManagerStandardValidator.Implementations memory opcmImplementations; - assembly { - opcmImplementations := __opcmImplementations - } - - opcm = IOPContractsManager( - DeployUtils.createDeterministic({ - _name: "OPContractsManager", - _args: DeployUtils.encodeConstructor( - abi.encodeCall( - IOPContractsManager.__constructor__, - ( - IOPContractsManagerGameTypeAdder( - DeployUtils.createDeterministic({ - _name: "OPContractsManagerGameTypeAdder", - _args: DeployUtils.encodeConstructor( - abi.encodeCall(IOPContractsManagerGameTypeAdder.__constructor__, (container)) - ), - _salt: DeployUtils.DEFAULT_SALT - }) - ), - IOPContractsManagerDeployer( - DeployUtils.createDeterministic({ - _name: "OPContractsManagerDeployer", - _args: DeployUtils.encodeConstructor( - abi.encodeCall(IOPContractsManagerDeployer.__constructor__, (container)) - ), - _salt: DeployUtils.DEFAULT_SALT - }) - ), - IOPContractsManagerUpgrader( - DeployUtils.createDeterministic({ - _name: "OPContractsManagerUpgrader", - _args: DeployUtils.encodeConstructor( - abi.encodeCall(IOPContractsManagerUpgrader.__constructor__, (container)) - ), - _salt: DeployUtils.DEFAULT_SALT - }) - ), - IOPContractsManagerInteropMigrator( - DeployUtils.createDeterministic({ - _name: "OPContractsManagerInteropMigrator", - _args: DeployUtils.encodeConstructor( - abi.encodeCall(IOPContractsManagerInteropMigrator.__constructor__, (container)) - ), - _salt: DeployUtils.DEFAULT_SALT - }) - ), - IOPContractsManagerStandardValidator( - DeployUtils.createDeterministic({ - _name: "OPContractsManagerStandardValidator", - _args: DeployUtils.encodeConstructor( - abi.encodeCall( - IOPContractsManagerStandardValidator.__constructor__, - ( - opcmImplementations, - superchainConfigProxy, - address(superchainProxyAdmin), - challenger, - 100 - ) - ) - ), - _salt: DeployUtils.DEFAULT_SALT - }) - ), - superchainConfigProxy, - protocolVersionsProxy, - superchainProxyAdmin, - address(this) - ) - ) - ), - _salt: DeployUtils.DEFAULT_SALT - }) - ); + function setUp() public virtual override { + super.setUp(); chainDeployOutput1 = createChainContracts(100); chainDeployOutput2 = createChainContracts(101); - // Mock the SuperchainConfig.paused function to return false. - // Otherwise migration will fail! - // We use abi.encodeWithSignature because paused is overloaded. - // nosemgrep: sol-style-use-abi-encodecall - vm.mockCall(address(superchainConfigProxy), abi.encodeWithSignature("paused(address)"), abi.encode(false)); - - // Fund the lockboxes for testing. vm.deal(address(chainDeployOutput1.ethLockboxProxy), 100 ether); vm.deal(address(chainDeployOutput2.ethLockboxProxy), 100 ether); } @@ -769,7 +386,7 @@ contract OPContractsManager_ChainIdToBatchInboxAddress_Test is Test { vm.etch(address(protocolVersionsProxy), hex"01"); OPContractsManagerContractsContainer container = - new OPContractsManagerContractsContainer(emptyBlueprints, emptyImpls); + new OPContractsManagerContractsContainer(emptyBlueprints, emptyImpls, bytes32(0)); OPContractsManager.Implementations memory __opcmImplementations = container.implementations(); OPContractsManagerStandardValidator.Implementations memory opcmImplementations; @@ -783,7 +400,7 @@ contract OPContractsManager_ChainIdToBatchInboxAddress_Test is Test { _opcmUpgrader: new OPContractsManagerUpgrader(container), _opcmInteropMigrator: new OPContractsManagerInteropMigrator(container), _opcmStandardValidator: new OPContractsManagerStandardValidator( - opcmImplementations, superchainConfigProxy, address(superchainProxyAdmin), challenger, 100 + opcmImplementations, superchainConfigProxy, address(superchainProxyAdmin), challenger, 100, bytes32(0) ), _superchainConfig: superchainConfigProxy, _protocolVersions: protocolVersionsProxy, @@ -1352,11 +969,14 @@ contract OPContractsManager_Upgrade_Test is OPContractsManager_Upgrade_Harness { function setUp() public override { skipIfNotOpFork("OPContractsManager_Upgrade_Test"); super.setUp(); + + // Run all past upgrades. + runPastUpgrades(upgrader); } function test_upgradeOPChainOnly_succeeds() public { // Run the upgrade test and checks - runUpgradeTestAndChecks(upgrader); + runCurrentUpgrade(upgrader); } function test_verifyOpcmCorrectness_succeeds() public { @@ -1369,9 +989,9 @@ contract OPContractsManager_Upgrade_Test is OPContractsManager_Upgrade_Harness { vm.setEnv("EXPECTED_UPGRADE_CONTROLLER", vm.toString(opcm.upgradeController())); // Run the upgrade test and checks - runUpgradeTestAndChecks(upgrader); + runCurrentUpgrade(upgrader); - // Run the verification script without etherscan verificatin. Hard to run with etherscan + // Run the verification script without etherscan verification. Hard to run with etherscan // verification in these tests, can do it but means we add even more dependencies to the // test environment. VerifyOPCM verify = new VerifyOPCM(); @@ -1387,16 +1007,11 @@ contract OPContractsManager_Upgrade_Test is OPContractsManager_Upgrade_Harness { opcm.deploy(deployInput); // Try to upgrade the current OPChain - runUpgradeTestAndChecks(upgrader); + runCurrentUpgrade(upgrader); } /// @notice Tests that the absolute prestate can be overridden using the upgrade config. function test_upgrade_absolutePrestateOverride_succeeds() public { - // Run Upgrade 13 and 14 to get us to a state where we can run Upgrade 15. - // Can remove these two calls as Upgrade 13 and 14 are executed in prod. - runUpgrade13UpgradeAndChecks(upgrader); - runUpgrade14UpgradeAndChecks(upgrader); - // Get the pdg and fdg before the upgrade Claim pdgPrestateBefore = IPermissionedDisputeGame( address(disputeGameFactory.gameImpls(GameTypes.PERMISSIONED_CANNON)) @@ -1411,8 +1026,8 @@ contract OPContractsManager_Upgrade_Test is OPContractsManager_Upgrade_Harness { // Set the absolute prestate input to something non-zero. opChainConfigs[0].absolutePrestate = Claim.wrap(bytes32(uint256(1))); - // Now run Upgrade 15. - runUpgrade15UpgradeAndChecks(upgrader); + // Run the upgrade. + runCurrentUpgrade(upgrader); // Get the absolute prestate after the upgrade Claim pdgPrestateAfter = IPermissionedDisputeGame( @@ -1429,11 +1044,6 @@ contract OPContractsManager_Upgrade_Test is OPContractsManager_Upgrade_Harness { /// @notice Tests that the old absolute prestate is used if the upgrade config does not set an /// absolute prestate. function test_upgrade_absolutePrestateNotSet_succeeds() public { - // Run Upgrade 13 and 14 to get us to a state where we can run Upgrade 15. - // Can remove these two calls as Upgrade 13 and 14 are executed in prod. - runUpgrade13UpgradeAndChecks(upgrader); - runUpgrade14UpgradeAndChecks(upgrader); - // Get the pdg and fdg before the upgrade Claim pdgPrestateBefore = IPermissionedDisputeGame( address(disputeGameFactory.gameImpls(GameTypes.PERMISSIONED_CANNON)) @@ -1448,8 +1058,8 @@ contract OPContractsManager_Upgrade_Test is OPContractsManager_Upgrade_Harness { // Set the absolute prestate input to zero. opChainConfigs[0].absolutePrestate = Claim.wrap(bytes32(0)); - // Now run Upgrade 15. - runUpgrade15UpgradeAndChecks(upgrader); + // Run the upgrade. + runCurrentUpgrade(upgrader); // Get the absolute prestate after the upgrade Claim pdgPrestateAfter = IPermissionedDisputeGame( @@ -1464,33 +1074,24 @@ contract OPContractsManager_Upgrade_Test is OPContractsManager_Upgrade_Harness { } function test_upgrade_notDelegateCalled_reverts() public { - runUpgrade13UpgradeAndChecks(upgrader); - vm.prank(upgrader); vm.expectRevert(IOPContractsManager.OnlyDelegatecall.selector); opcm.upgrade(opChainConfigs); } function test_upgrade_notProxyAdminOwner_reverts() public { - runUpgrade13UpgradeAndChecks(upgrader); - address delegateCaller = makeAddr("delegateCaller"); vm.etch(delegateCaller, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); assertNotEq(superchainProxyAdmin.owner(), delegateCaller); assertNotEq(proxyAdmin.owner(), delegateCaller); - vm.expectRevert("Ownable: caller is not the owner"); - DelegateCaller(delegateCaller).dcForward( - address(opcm), abi.encodeCall(IOPContractsManager.upgrade, (opChainConfigs)) - ); + runCurrentUpgrade(delegateCaller, bytes("Ownable: caller is not the owner")); } /// @notice Tests that upgrade reverts when absolutePrestate is zero and the existing game also /// has an absolute prestate of zero. function test_upgrade_absolutePrestateNotSet_reverts() public { - runUpgrade13UpgradeAndChecks(upgrader); - // Set the config to try to update the absolutePrestate to zero. opChainConfigs[0].absolutePrestate = Claim.wrap(bytes32(0)); @@ -1506,8 +1107,96 @@ contract OPContractsManager_Upgrade_Test is OPContractsManager_Upgrade_Harness { ); // Expect the upgrade to revert with PrestateNotSet. - vm.expectRevert(IOPContractsManager.PrestateNotSet.selector); - DelegateCaller(upgrader).dcForward(address(opcm), abi.encodeCall(IOPContractsManager.upgrade, (opChainConfigs))); + // nosemgrep: sol-style-use-abi-encodecall + runCurrentUpgrade(upgrader, abi.encodeWithSelector(IOPContractsManager.PrestateNotSet.selector)); + } + + /// @notice Tests that the upgrade function reverts when the superchainConfig is not at the expected target version. + function test_upgrade_superchainConfigNeedsUpgrade_reverts() public { + // Force the SuperchainConfig to return an obviously outdated version. + vm.mockCall(address(superchainConfig), abi.encodeCall(ISuperchainConfig.version, ()), abi.encode("0.0.0")); + + // Try upgrading an OPChain without upgrading its superchainConfig. + // nosemgrep: sol-style-use-abi-encodecall + runCurrentUpgrade( + upgrader, + abi.encodeWithSelector( + IOPContractsManagerUpgrader.OPContractsManagerUpgrader_SuperchainConfigNeedsUpgrade.selector, (0) + ) + ); + } +} + +contract OPContractsManager_UpgradeSuperchainConfig_Test is OPContractsManager_Upgrade_Harness { + function setUp() public override { + super.setUp(); + + // The superchainConfig is already at the expected version so we mock this call here to bypass that check and + // get our expected error. + vm.mockCall(address(superchainConfig), abi.encodeCall(ISuperchainConfig.version, ()), abi.encode("2.2.0")); + } + + /// @notice Tests that the upgradeSuperchainConfig function succeeds when the superchainConfig is at the expected + /// version and the delegate caller is the superchainProxyAdmin owner. + function test_upgradeSuperchainConfig_succeeds() public { + IOPContractsManager.Implementations memory impls = opcm.implementations(); + + ISuperchainConfig superchainConfig = ISuperchainConfig(artifacts.mustGetAddress("SuperchainConfigProxy")); + + address superchainPAO = IProxyAdmin(EIP1967Helper.getAdmin(address(superchainConfig))).owner(); + vm.etch(superchainPAO, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); + + vm.expectEmit(address(superchainConfig)); + emit Upgraded(impls.superchainConfigImpl); + DelegateCaller(superchainPAO).dcForward( + address(opcm), + abi.encodeCall(IOPContractsManager.upgradeSuperchainConfig, (superchainConfig, superchainProxyAdmin)) + ); + } + + /// @notice Tests that the upgradeSuperchainConfig function reverts when it is not called via delegatecall. + function test_upgradeSuperchainConfig_notDelegateCalled_reverts() public { + ISuperchainConfig superchainConfig = ISuperchainConfig(artifacts.mustGetAddress("SuperchainConfigProxy")); + + vm.expectRevert(IOPContractsManager.OnlyDelegatecall.selector); + opcm.upgradeSuperchainConfig(superchainConfig, superchainProxyAdmin); + } + + /// @notice Tests that the upgradeSuperchainConfig function reverts when the delegate caller is not the + /// superchainProxyAdmin owner. + function test_upgradeSuperchainConfig_notProxyAdminOwner_reverts() public { + ISuperchainConfig superchainConfig = ISuperchainConfig(artifacts.mustGetAddress("SuperchainConfigProxy")); + + address delegateCaller = makeAddr("delegateCaller"); + vm.etch(delegateCaller, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); + + assertNotEq(superchainProxyAdmin.owner(), delegateCaller); + assertNotEq(proxyAdmin.owner(), delegateCaller); + + vm.expectRevert("Ownable: caller is not the owner"); + DelegateCaller(delegateCaller).dcForward( + address(opcm), + abi.encodeCall(IOPContractsManager.upgradeSuperchainConfig, (superchainConfig, superchainProxyAdmin)) + ); + } + + /// @notice Tests that the upgradeSuperchainConfig function reverts when the superchainConfig version is the same or + /// newer than the target version. + function test_upgradeSuperchainConfig_superchainConfigAlreadyUpToDate_reverts() public { + ISuperchainConfig superchainConfig = ISuperchainConfig(artifacts.mustGetAddress("SuperchainConfigProxy")); + + // Set the version of the superchain config to a version that is the target version. + vm.clearMockedCalls(); + + // Mock the SuperchainConfig to return a very large version. + vm.mockCall(address(superchainConfig), abi.encodeCall(ISuperchainConfig.version, ()), abi.encode("99.99.99")); + + // Try to upgrade the SuperchainConfig contract again, should fail. + vm.expectRevert(IOPContractsManagerUpgrader.OPContractsManagerUpgrader_SuperchainConfigAlreadyUpToDate.selector); + DelegateCaller(upgrader).dcForward( + address(opcm), + abi.encodeCall(IOPContractsManager.upgradeSuperchainConfig, (superchainConfig, superchainProxyAdmin)) + ); } } @@ -1517,6 +1206,12 @@ contract OPContractsManager_Migrate_Test is OPContractsManager_TestInit { Claim absolutePrestate1 = Claim.wrap(bytes32(hex"ABBA")); Claim absolutePrestate2 = Claim.wrap(bytes32(hex"DEAD")); + /// @notice Function requires interop portal. + function setUp() public override { + super.setUp(); + skipIfDevFeatureDisabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + } + /// @notice Helper function to create the default migration input. function _getDefaultInput() internal view returns (IOPContractsManagerInteropMigrator.MigrateInput memory) { IOPContractsManagerInteropMigrator.GameParameters memory gameParameters = IOPContractsManagerInteropMigrator diff --git a/packages/contracts-bedrock/test/L1/OPContractsManagerContractsContainer.t.sol b/packages/contracts-bedrock/test/L1/OPContractsManagerContractsContainer.t.sol new file mode 100644 index 00000000000..0028b6db813 --- /dev/null +++ b/packages/contracts-bedrock/test/L1/OPContractsManagerContractsContainer.t.sol @@ -0,0 +1,90 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.15; + +// Testing +import { OPContractsManager_TestInit } from "test/L1/OPContractsManager.t.sol"; + +// Contracts +import { OPContractsManager, OPContractsManagerContractsContainer } from "src/L1/OPContractsManager.sol"; + +/// @title OPContractsManagerContractsContainer_Constructor_Test +/// @notice Tests the constructor of the `OPContractsManagerContractsContainer` contract. +contract OPContractsManagerContractsContainer_Constructor_Test is OPContractsManager_TestInit { + /// @notice Tests that the constructor succeeds when the devFeatureBitmap is in dev. + /// @param _devFeatureBitmap The devFeatureBitmap to use. + function testFuzz_constructor_devBitmapInDev_succeeds(bytes32 _devFeatureBitmap) public { + // Etch into the magic testing address. + vm.etch(address(0xbeefcafe), hex"01"); + + // Convert to proper OPCM type for construction. + OPContractsManager opcm2 = OPContractsManager(address(opcm)); + + // Should not revert. + OPContractsManagerContractsContainer container = new OPContractsManagerContractsContainer({ + _blueprints: opcm2.blueprints(), + _implementations: opcm2.implementations(), + _devFeatureBitmap: _devFeatureBitmap + }); + + // Should have the correct devFeatureBitmap. + assertEq(container.devFeatureBitmap(), _devFeatureBitmap); + } + + /// @notice Tests that the constructor reverts when the devFeatureBitmap is in prod. + /// @param _devFeatureBitmap The devFeatureBitmap to use. + function testFuzz_constructor_devBitmapInProd_reverts(bytes32 _devFeatureBitmap) public { + // Anything but zero! + _devFeatureBitmap = bytes32(bound(uint256(_devFeatureBitmap), 1, type(uint256).max)); + + // Make sure magic address has no code. + vm.etch(address(0xbeefcafe), bytes("")); + + // Convert to proper OPCM type for construction. + OPContractsManager opcm2 = OPContractsManager(address(opcm)); + + // Set the chain ID to 1. + vm.chainId(1); + + // Fetch ahead of time to avoid expectRevert applying to these functions by accident. + OPContractsManager.Blueprints memory blueprints = opcm2.blueprints(); + OPContractsManager.Implementations memory implementations = opcm2.implementations(); + + // Should revert. + vm.expectRevert( + OPContractsManagerContractsContainer.OPContractsManagerContractsContainer_DevFeatureInProd.selector + ); + OPContractsManagerContractsContainer container = new OPContractsManagerContractsContainer({ + _blueprints: blueprints, + _implementations: implementations, + _devFeatureBitmap: _devFeatureBitmap + }); + + // Constructor shouldn't have worked, foundry makes this return address(1). + assertEq(address(container), address(1)); + } + + /// @notice Tests that the constructor succeeds when the devFeatureBitmap is used on the + /// mainnet chain ID but this is actually a test environment as shown by the magic + /// address having code. + /// @param _devFeatureBitmap The devFeatureBitmap to use. + function test_constructor_devBitmapMainnetButTestEnv_succeeds(bytes32 _devFeatureBitmap) public { + // Make sure magic address has code. + vm.etch(address(0xbeefcafe), hex"01"); + + // Convert to proper OPCM type for construction. + OPContractsManager opcm2 = OPContractsManager(address(opcm)); + + // Set the chain ID to 1. + vm.chainId(1); + + // Should not revert. + OPContractsManagerContractsContainer container = new OPContractsManagerContractsContainer({ + _blueprints: opcm2.blueprints(), + _implementations: opcm2.implementations(), + _devFeatureBitmap: _devFeatureBitmap + }); + + // Should have the correct devFeatureBitmap. + assertEq(container.devFeatureBitmap(), _devFeatureBitmap); + } +} diff --git a/packages/contracts-bedrock/test/L1/OPContractsManagerStandardValidator.t.sol b/packages/contracts-bedrock/test/L1/OPContractsManagerStandardValidator.t.sol index bbda893e412..8bbbd9e8c2c 100644 --- a/packages/contracts-bedrock/test/L1/OPContractsManagerStandardValidator.t.sol +++ b/packages/contracts-bedrock/test/L1/OPContractsManagerStandardValidator.t.sol @@ -3,11 +3,13 @@ pragma solidity 0.8.15; // Testing import { CommonTest } from "test/setup/CommonTest.sol"; +import { StandardConstants } from "scripts/deploy/StandardConstants.sol"; // Libraries import { GameTypes, Duration, Claim } from "src/dispute/lib/Types.sol"; import { DeployUtils } from "scripts/libraries/DeployUtils.sol"; import { ForgeArtifacts } from "scripts/libraries/ForgeArtifacts.sol"; +import { Features } from "src/libraries/Features.sol"; // Interfaces import { IOPContractsManager } from "interfaces/L1/IOPContractsManager.sol"; @@ -134,7 +136,7 @@ contract OPContractsManagerStandardValidator_TestInit is CommonTest { ); vm.mockCall( address(delayedWeth), - abi.encodeCall(IDelayedWETH.proxyAdminOwner, ()), + abi.encodeCall(IProxyAdminOwnedBase.proxyAdminOwner, ()), abi.encode(opcm.opcmStandardValidator().l1PAOMultisig()) ); // Use vm.store so that the .setImplementation call below works. @@ -280,7 +282,9 @@ contract OPContractsManagerStandardValidator_GeneralOverride_Test is OPContracts IOPContractsManagerStandardValidator.ValidationOverrides memory overrides = IOPContractsManagerStandardValidator .ValidationOverrides({ l1PAOMultisig: address(0xbad), challenger: address(0xc0ffee) }); vm.mockCall( - address(delayedWeth), abi.encodeCall(IDelayedWETH.proxyAdminOwner, ()), abi.encode(overrides.l1PAOMultisig) + address(delayedWeth), + abi.encodeCall(IProxyAdminOwnedBase.proxyAdminOwner, ()), + abi.encode(overrides.l1PAOMultisig) ); vm.mockCall(address(proxyAdmin), abi.encodeCall(IProxyAdmin.owner, ()), abi.encode(overrides.l1PAOMultisig)); vm.mockCall( @@ -332,7 +336,9 @@ contract OPContractsManagerStandardValidator_ProxyAdmin_Test is OPContractsManag /// ProxyAdmin owner is not correct. function test_validate_invalidProxyAdminOwner_succeeds() public { vm.mockCall(address(proxyAdmin), abi.encodeCall(IProxyAdmin.owner, ()), abi.encode(address(0xbad))); - vm.mockCall(address(delayedWeth), abi.encodeCall(IDelayedWETH.proxyAdminOwner, ()), abi.encode(address(0xbad))); + vm.mockCall( + address(delayedWeth), abi.encodeCall(IProxyAdminOwnedBase.proxyAdminOwner, ()), abi.encode(address(0xbad)) + ); assertEq("PROXYA-10,PDDG-DWETH-30,PLDG-DWETH-30", _validate(true)); } @@ -341,7 +347,7 @@ contract OPContractsManagerStandardValidator_ProxyAdmin_Test is OPContractsManag function test_validate_overridenProxyAdminOwner_succeeds() public { IOPContractsManagerStandardValidator.ValidationOverrides memory overrides = _defaultValidationOverrides(); overrides.l1PAOMultisig = address(0xbad); - vm.mockCall(address(delayedWeth), abi.encodeCall(IDelayedWETH.proxyAdminOwner, ()), abi.encode(0xbad)); + vm.mockCall(address(delayedWeth), abi.encodeCall(IProxyAdminOwnedBase.proxyAdminOwner, ()), abi.encode(0xbad)); vm.mockCall(address(proxyAdmin), abi.encodeCall(IProxyAdmin.owner, ()), abi.encode(address(0xbad))); vm.mockCall( address(disputeGameFactory), @@ -754,7 +760,12 @@ contract OPContractsManagerStandardValidator_ETHLockbox_Test is OPContractsManag /// ETHLockbox version is invalid. function test_validate_ethLockboxInvalidVersion_succeeds() public { vm.mockCall(address(ethLockbox), abi.encodeCall(ISemver.version, ()), abi.encode("0.0.0")); - assertEq("LOCKBOX-10", _validate(true)); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq("LOCKBOX-10", _validate(true)); + } else { + assertEq("", _validate(true)); + } } /// @notice Tests that the validate function successfully returns the right error when the @@ -765,7 +776,12 @@ contract OPContractsManagerStandardValidator_ETHLockbox_Test is OPContractsManag abi.encodeCall(IProxyAdmin.getProxyImplementation, (address(ethLockbox))), abi.encode(address(0xbad)) ); - assertEq("LOCKBOX-20", _validate(true)); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq("LOCKBOX-20", _validate(true)); + } else { + assertEq("", _validate(true)); + } } /// @notice Tests that the validate function successfully returns the right error when the @@ -774,14 +790,24 @@ contract OPContractsManagerStandardValidator_ETHLockbox_Test is OPContractsManag vm.mockCall( address(ethLockbox), abi.encodeCall(IProxyAdminOwnedBase.proxyAdmin, ()), abi.encode(address(0xbad)) ); - assertEq("LOCKBOX-30", _validate(true)); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq("LOCKBOX-30", _validate(true)); + } else { + assertEq("", _validate(true)); + } } /// @notice Tests that the validate function successfully returns the right error when the /// ETHLockbox systemConfig is invalid. function test_validate_ethLockboxInvalidSystemConfig_succeeds() public { vm.mockCall(address(ethLockbox), abi.encodeCall(IETHLockbox.systemConfig, ()), abi.encode(address(0xbad))); - assertEq("LOCKBOX-40", _validate(true)); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq("LOCKBOX-40", _validate(true)); + } else { + assertEq("", _validate(true)); + } } /// @notice Tests that the validate function successfully returns the right error when the @@ -790,7 +816,12 @@ contract OPContractsManagerStandardValidator_ETHLockbox_Test is OPContractsManag vm.mockCall( address(ethLockbox), abi.encodeCall(IETHLockbox.authorizedPortals, (optimismPortal2)), abi.encode(false) ); - assertEq("LOCKBOX-50", _validate(true)); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq("LOCKBOX-50", _validate(true)); + } else { + assertEq("", _validate(true)); + } } } @@ -871,7 +902,9 @@ contract OPContractsManagerStandardValidator_PermissionedDisputeGame_Test is function test_validate_permissionedDisputeGameInvalidVM_succeeds() public { vm.mockCall(address(pdg), abi.encodeCall(IPermissionedDisputeGame.vm, ()), abi.encode(address(0xbad))); vm.mockCall(address(0xbad), abi.encodeCall(ISemver.version, ()), abi.encode("0.0.0")); - vm.mockCall(address(0xbad), abi.encodeCall(IMIPS64.stateVersion, ()), abi.encode(7)); + vm.mockCall( + address(0xbad), abi.encodeCall(IMIPS64.stateVersion, ()), abi.encode(StandardConstants.MIPS_VERSION) + ); assertEq("PDDG-VM-10,PDDG-VM-20", _validate(true)); } @@ -1187,7 +1220,9 @@ contract OPContractsManagerStandardValidator_FaultDisputeGame_Test is OPContract function test_validate_faultDisputeGameInvalidVM_succeeds() public { vm.mockCall(address(fdg), abi.encodeCall(IFaultDisputeGame.vm, ()), abi.encode(address(0xbad))); vm.mockCall(address(0xbad), abi.encodeCall(ISemver.version, ()), abi.encode("0.0.0")); - vm.mockCall(address(0xbad), abi.encodeCall(IMIPS64.stateVersion, ()), abi.encode(7)); + vm.mockCall( + address(0xbad), abi.encodeCall(IMIPS64.stateVersion, ()), abi.encode(StandardConstants.MIPS_VERSION) + ); assertEq("PLDG-VM-10,PLDG-VM-20", _validate(true)); } @@ -1316,34 +1351,43 @@ contract OPContractsManagerStandardValidator_Versions_Test is OPContractsManager /// @notice Tests that the version getter functions on `OPContractsManagerStandardValidator` return non-empty /// strings. function test_versions_succeeds() public view { - assertTrue(bytes(opcm.opcmStandardValidator().systemConfigVersion()).length > 0, "systemConfigVersion empty"); assertTrue( - bytes(opcm.opcmStandardValidator().optimismPortalVersion()).length > 0, "optimismPortalVersion empty" + bytes(ISemver(opcm.opcmStandardValidator().systemConfigImpl()).version()).length > 0, + "systemConfigVersion empty" + ); + assertTrue( + bytes(ISemver(opcm.opcmStandardValidator().optimismPortalImpl()).version()).length > 0, + "optimismPortalVersion empty" ); assertTrue( - bytes(opcm.opcmStandardValidator().l1CrossDomainMessengerVersion()).length > 0, + bytes(ISemver(opcm.opcmStandardValidator().l1CrossDomainMessengerImpl()).version()).length > 0, "l1CrossDomainMessengerVersion empty" ); assertTrue( - bytes(opcm.opcmStandardValidator().l1ERC721BridgeVersion()).length > 0, "l1ERC721BridgeVersion empty" + bytes(ISemver(opcm.opcmStandardValidator().l1ERC721BridgeImpl()).version()).length > 0, + "l1ERC721BridgeVersion empty" ); assertTrue( - bytes(opcm.opcmStandardValidator().l1StandardBridgeVersion()).length > 0, "l1StandardBridgeVersion empty" + bytes(ISemver(opcm.opcmStandardValidator().l1StandardBridgeImpl()).version()).length > 0, + "l1StandardBridgeVersion empty" ); - assertTrue(bytes(opcm.opcmStandardValidator().mipsVersion()).length > 0, "mipsVersion empty"); + assertTrue(bytes(ISemver(opcm.opcmStandardValidator().mipsImpl()).version()).length > 0, "mipsVersion empty"); assertTrue( - bytes(opcm.opcmStandardValidator().optimismMintableERC20FactoryVersion()).length > 0, + bytes(ISemver(opcm.opcmStandardValidator().optimismMintableERC20FactoryImpl()).version()).length > 0, "optimismMintableERC20FactoryVersion empty" ); assertTrue( - bytes(opcm.opcmStandardValidator().disputeGameFactoryVersion()).length > 0, + bytes(ISemver(opcm.opcmStandardValidator().disputeGameFactoryImpl()).version()).length > 0, "disputeGameFactoryVersion empty" ); assertTrue( - bytes(opcm.opcmStandardValidator().anchorStateRegistryVersion()).length > 0, + bytes(ISemver(opcm.opcmStandardValidator().anchorStateRegistryImpl()).version()).length > 0, "anchorStateRegistryVersion empty" ); - assertTrue(bytes(opcm.opcmStandardValidator().delayedWETHVersion()).length > 0, "delayedWETHVersion empty"); + assertTrue( + bytes(ISemver(opcm.opcmStandardValidator().delayedWETHImpl()).version()).length > 0, + "delayedWETHVersion empty" + ); assertTrue( bytes(opcm.opcmStandardValidator().permissionedDisputeGameVersion()).length > 0, "permissionedDisputeGameVersion empty" @@ -1351,6 +1395,9 @@ contract OPContractsManagerStandardValidator_Versions_Test is OPContractsManager assertTrue( bytes(opcm.opcmStandardValidator().preimageOracleVersion()).length > 0, "preimageOracleVersion empty" ); - assertTrue(bytes(opcm.opcmStandardValidator().ethLockboxVersion()).length > 0, "ethLockboxVersion empty"); + assertTrue( + bytes(ISemver(opcm.opcmStandardValidator().ethLockboxImpl()).version()).length > 0, + "ethLockboxVersion empty" + ); } } diff --git a/packages/contracts-bedrock/test/L1/OptimismPortal2.t.sol b/packages/contracts-bedrock/test/L1/OptimismPortal2.t.sol index ab80ffb6777..90691b95afa 100644 --- a/packages/contracts-bedrock/test/L1/OptimismPortal2.t.sol +++ b/packages/contracts-bedrock/test/L1/OptimismPortal2.t.sol @@ -19,11 +19,14 @@ import { Hashing } from "src/libraries/Hashing.sol"; import { Constants } from "src/libraries/Constants.sol"; import { AddressAliasHelper } from "src/vendor/AddressAliasHelper.sol"; import { EIP1967Helper } from "test/mocks/EIP1967Helper.sol"; +import { DevFeatures } from "src/libraries/DevFeatures.sol"; +import { Features } from "src/libraries/Features.sol"; import "src/dispute/lib/Types.sol"; // Interfaces import { IResourceMetering } from "interfaces/L1/IResourceMetering.sol"; import { IOptimismPortal2 as IOptimismPortal } from "interfaces/L1/IOptimismPortal2.sol"; +import { IOptimismPortalInterop } from "interfaces/L1/IOptimismPortalInterop.sol"; import { IDisputeGame } from "interfaces/dispute/IDisputeGame.sol"; import { IFaultDisputeGame } from "interfaces/dispute/IFaultDisputeGame.sol"; import { IProxy } from "interfaces/universal/IProxy.sol"; @@ -45,8 +48,8 @@ contract OptimismPortal2_TestInit is DisputeGameFactory_TestInit { bytes[] _withdrawalProof; Types.OutputRootProof internal _outputRootProof; GameType internal respectedGameType; - // Use a constructor to set the storage vars above, so as to minimize the number of ffi calls. + // Use a constructor to set the storage vars above, so as to minimize the number of ffi calls. constructor() { super.setUp(); @@ -115,7 +118,10 @@ contract OptimismPortal2_TestInit is DisputeGameFactory_TestInit { vm.warp(block.timestamp + game.maxClockDuration().raw() + 1 seconds); // Fund the portal so that we can withdraw ETH. - vm.deal(address(ethLockbox), 0xFFFFFFFF); + vm.deal(address(optimismPortal2), 0xFFFFFFFF); + if (isUsingLockbox()) { + vm.deal(address(ethLockbox), 0xFFFFFFFF); + } } /// @notice Asserts that the reentrant call will revert. @@ -134,7 +140,7 @@ contract OptimismPortal2_TestInit is DisputeGameFactory_TestInit { /// @param _superRootsActive The value to set the superRootsActive variable to. function setSuperRootsActive(bool _superRootsActive) public { // Get the slot for superRootsActive. - StorageSlot memory slot = ForgeArtifacts.getSlot("OptimismPortal2", "superRootsActive"); + StorageSlot memory slot = ForgeArtifacts.getSlot("OptimismPortalInterop", "superRootsActive"); // Load the existing storage slot value. bytes32 existingValue = vm.load(address(optimismPortal2), bytes32(slot.slot)); @@ -147,6 +153,31 @@ contract OptimismPortal2_TestInit is DisputeGameFactory_TestInit { // Store the new value at the correct slot/offset. vm.store(address(optimismPortal2), bytes32(slot.slot), newValue); } + + /// @notice Checks if the ETHLockbox feature is enabled. + /// @return bool True if the ETHLockbox feature is enabled. + function isUsingLockbox() public view returns (bool) { + return + systemConfig.isFeatureEnabled(Features.ETH_LOCKBOX) && address(optimismPortal2.ethLockbox()) != address(0); + } + + /// @notice Enables the ETHLockbox feature if not enabled. + /// @param _lockbox Address of the lockbox to enable. + function forceEnableLockbox(address _lockbox) public { + if (!isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + vm.prank(address(proxyAdmin)); + systemConfig.setFeature(Features.ETH_LOCKBOX, true); + } + + // Overwrite the lockbox either way. + StorageSlot memory slot = ForgeArtifacts.getSlot("OptimismPortal2", "ethLockbox"); + vm.store(address(optimismPortal2), bytes32(slot.slot), bytes32(uint256(uint160(address(_lockbox))))); + + // If the recipient address has no code, store STOP so we don't get reverts. + if (address(_lockbox).code.length == 0) { + vm.etch(address(_lockbox), hex"00"); + } + } } /// @title OptimismPortal2_Version_Test @@ -188,7 +219,12 @@ contract OptimismPortal2_Initialize_Test is OptimismPortal2_TestInit { assertEq(optimismPortal2.l2Sender(), Constants.DEFAULT_L2_SENDER); assertEq(optimismPortal2.paused(), false); assertEq(address(optimismPortal2.systemConfig()), address(systemConfig)); - assertEq(address(optimismPortal2.ethLockbox()), address(ethLockbox)); + + if (isUsingLockbox()) { + assertEq(address(optimismPortal2.ethLockbox()), address(ethLockbox)); + } else { + assertEq(address(optimismPortal2.ethLockbox()), address(0)); + } returnIfForkTest( "OptimismPortal2_Initialize_Test: Do not check guardian and respectedGameType on forked networks" @@ -220,6 +256,8 @@ contract OptimismPortal2_Initialize_Test is OptimismPortal2_TestInit { /// @notice Tests that the initialize function reverts if called by a non-proxy admin or owner. /// @param _sender The address of the sender to test. function testFuzz_initialize_notProxyAdminOrProxyAdminOwner_reverts(address _sender) public { + skipIfDevFeatureEnabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + // Prank as the not ProxyAdmin or ProxyAdmin owner. vm.assume(_sender != address(proxyAdmin) && _sender != proxyAdminOwner); @@ -234,19 +272,74 @@ contract OptimismPortal2_Initialize_Test is OptimismPortal2_TestInit { // Call the `initialize` function with the sender vm.prank(_sender); - optimismPortal2.initialize(systemConfig, anchorStateRegistry, ethLockbox); + optimismPortal2.initialize(systemConfig, anchorStateRegistry); + } + + /// @notice Tests that the initialize function reverts if called by a non-proxy admin or owner. + /// @param _sender The address of the sender to test. + function testFuzz_initialize_interopNotProxyAdminOrProxyAdminOwner_reverts(address _sender) public { + skipIfDevFeatureDisabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + + // Prank as the not ProxyAdmin or ProxyAdmin owner. + vm.assume(_sender != address(proxyAdmin) && _sender != proxyAdminOwner); + + // Get the slot for _initialized. + StorageSlot memory slot = ForgeArtifacts.getSlot("OptimismPortal2", "_initialized"); + + // Set the initialized slot to 0. + vm.store(address(optimismPortal2), bytes32(slot.slot), bytes32(0)); + + // Expect the revert with `ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner` selector. + vm.expectRevert(IProxyAdminOwnedBase.ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner.selector); + + // Call the `initialize` function with the sender + vm.prank(_sender); + IOptimismPortalInterop(payable(optimismPortal2)).initialize(systemConfig, anchorStateRegistry, ethLockbox); + } + + /// @notice Tests that the initialize function reverts when lockbox state is invalid. + function test_initialize_invalidLockboxState_reverts() external { + skipIfDevFeatureEnabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + + // Get the slot for _initialized. + StorageSlot memory slot = ForgeArtifacts.getSlot("OptimismPortal2", "_initialized"); + + // Set the initialized slot to 0. + vm.store(address(optimismPortal2), bytes32(slot.slot), bytes32(0)); + + // Enable ETH_LOCKBOX feature but clear the lockbox address to create invalid state. + if (!systemConfig.isFeatureEnabled(Features.ETH_LOCKBOX)) { + vm.prank(address(proxyAdmin)); + systemConfig.setFeature(Features.ETH_LOCKBOX, true); + } + + // Clear the lockbox address. + StorageSlot memory lockboxSlot = ForgeArtifacts.getSlot("OptimismPortal2", "ethLockbox"); + vm.store(address(optimismPortal2), bytes32(lockboxSlot.slot), bytes32(0)); + + // Expect the revert with `OptimismPortal_InvalidLockboxState` selector. + vm.expectRevert(IOptimismPortal.OptimismPortal_InvalidLockboxState.selector); + + // Call the `initialize` function + vm.prank(address(proxyAdmin)); + optimismPortal2.initialize(systemConfig, anchorStateRegistry); } } -/// @title OptimismPortal2_Upgrade_Test +/// @title OptimismPortal2_UpgradeInterop_Test /// @notice Reusable test for the current upgrade() function in the OptimismPortal2 contract. If /// the upgrade() function is changed, tests inside of this contract should be updated to /// reflect the new function. If the upgrade() function is removed, remove the /// corresponding tests but leave this contract in place so it's easy to add tests back /// in the future. -contract OptimismPortal2_Upgrade_Test is CommonTest { +contract OptimismPortal2_UpgradeInterop_Test is CommonTest { + function setUp() public virtual override { + super.setUp(); + skipIfDevFeatureDisabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + } + /// @notice Tests that the upgrade() function succeeds. - function testFuzz_upgrade_succeeds(address _newAnchorStateRegistry, uint256 _balance) external { + function testFuzz_upgrade_interop_succeeds(address _newAnchorStateRegistry, uint256 _balance) external { // Prevent overflow on an upgrade context _balance = bound(_balance, 0, type(uint256).max - address(ethLockbox).balance); @@ -265,11 +358,13 @@ contract OptimismPortal2_Upgrade_Test is CommonTest { // Call the upgrade function. vm.prank(address(optimismPortal2.proxyAdmin())); - optimismPortal2.upgrade(IAnchorStateRegistry(_newAnchorStateRegistry), IETHLockbox(ethLockbox)); + IOptimismPortalInterop(payable(optimismPortal2)).upgrade( + IAnchorStateRegistry(_newAnchorStateRegistry), IETHLockbox(ethLockbox) + ); // Verify that the initialized slot was updated. bytes32 initializedSlotAfter = vm.load(address(optimismPortal2), bytes32(slot.slot)); - assertEq(initializedSlotAfter, bytes32(uint256(2))); + assertEq(initializedSlotAfter, bytes32(uint256(optimismPortal2.initVersion()))); // Assert the portal is properly upgraded. assertEq(address(optimismPortal2.ethLockbox()), address(ethLockbox)); @@ -281,7 +376,7 @@ contract OptimismPortal2_Upgrade_Test is CommonTest { // Now we migrate liquidity. vm.prank(proxyAdminOwner); - optimismPortal2.migrateLiquidity(); + IOptimismPortalInterop(payable(optimismPortal2)).migrateLiquidity(); // Balance has been updated. assertEq(address(optimismPortal2).balance, 0); @@ -298,12 +393,16 @@ contract OptimismPortal2_Upgrade_Test is CommonTest { // Trigger first upgrade. vm.prank(address(optimismPortal2.proxyAdmin())); - optimismPortal2.upgrade(IAnchorStateRegistry(address(0xdeadbeef)), IETHLockbox(ethLockbox)); + IOptimismPortalInterop(payable(optimismPortal2)).upgrade( + IAnchorStateRegistry(address(0xdeadbeef)), IETHLockbox(ethLockbox) + ); // Try to trigger second upgrade. vm.prank(address(optimismPortal2.proxyAdmin())); vm.expectRevert("Initializable: contract is already initialized"); - optimismPortal2.upgrade(IAnchorStateRegistry(address(0xdeadbeef)), IETHLockbox(ethLockbox)); + IOptimismPortalInterop(payable(optimismPortal2)).upgrade( + IAnchorStateRegistry(address(0xdeadbeef)), IETHLockbox(ethLockbox) + ); } /// @notice Tests that the upgrade() function reverts if called after initialization. @@ -311,9 +410,9 @@ contract OptimismPortal2_Upgrade_Test is CommonTest { // Get the slot for _initialized. StorageSlot memory slot = ForgeArtifacts.getSlot("OptimismPortal2", "_initialized"); - // Slot value should be set to 2 (already initialized). + // Slot value should be set to already initialized. bytes32 initializedSlotBefore = vm.load(address(optimismPortal2), bytes32(slot.slot)); - assertEq(initializedSlotBefore, bytes32(uint256(2))); + assertEq(initializedSlotBefore, bytes32(uint256(optimismPortal2.initVersion()))); // AnchorStateRegistry address should be non-zero. assertNotEq(address(optimismPortal2.anchorStateRegistry()), address(0)); @@ -323,7 +422,9 @@ contract OptimismPortal2_Upgrade_Test is CommonTest { // Try to trigger upgrade(). vm.expectRevert("Initializable: contract is already initialized"); - optimismPortal2.upgrade(IAnchorStateRegistry(address(0xdeadbeef)), IETHLockbox(ethLockbox)); + IOptimismPortalInterop(payable(optimismPortal2)).upgrade( + IAnchorStateRegistry(address(0xdeadbeef)), IETHLockbox(ethLockbox) + ); } /// @notice Tests that the upgrade() function reverts if called by a non-proxy admin or owner. @@ -343,7 +444,9 @@ contract OptimismPortal2_Upgrade_Test is CommonTest { // Call the `upgrade` function with the sender vm.prank(_sender); - optimismPortal2.upgrade(IAnchorStateRegistry(address(0xdeadbeef)), IETHLockbox(ethLockbox)); + IOptimismPortalInterop(payable(optimismPortal2)).upgrade( + IAnchorStateRegistry(address(0xdeadbeef)), IETHLockbox(ethLockbox) + ); } } @@ -535,8 +638,52 @@ contract OptimismPortal2_Receive_Test is OptimismPortal2_TestInit { _data: hex"" }); + if (isUsingLockbox()) { + // Expect call to the ETHLockbox to lock the funds only if the value is greater than 0. + vm.expectCall(address(ethLockbox), _value, abi.encodeCall(ethLockbox.lockETH, ()), _value > 0 ? 1 : 0); + } + + // give alice money and send as an eoa + vm.deal(alice, _value); + vm.prank(alice, alice); + (bool s,) = address(optimismPortal2).call{ value: _value }(hex""); + + assertTrue(s); + + if (isUsingLockbox()) { + assertEq(address(optimismPortal2).balance, balanceBefore); + assertEq(address(ethLockbox).balance, lockboxBalanceBefore + _value); + } else { + assertEq(address(optimismPortal2).balance, balanceBefore + _value); + } + } + + function testFuzz_receive_withLockbox_succeeds(uint256 _value) external { + // Prevent overflow on an upgrade context. + // We use a dummy lockbox here because the real one won't work for upgrade tests. + address dummyLockbox = address(0xdeadbeef); + _value = bound(_value, 0, type(uint256).max - address(dummyLockbox).balance); + uint256 balanceBefore = address(optimismPortal2).balance; + uint256 lockboxBalanceBefore = address(dummyLockbox).balance; + _value = bound(_value, 0, type(uint256).max - balanceBefore); + + // Enable the lockbox. + forceEnableLockbox(dummyLockbox); + + // Expect the transaction deposited event. + vm.expectEmit(address(optimismPortal2)); + emitTransactionDeposited({ + _from: alice, + _to: alice, + _value: _value, + _mint: _value, + _gasLimit: 100_000, + _isCreation: false, + _data: hex"" + }); + // Expect call to the ETHLockbox to lock the funds only if the value is greater than 0. - vm.expectCall(address(ethLockbox), _value, abi.encodeCall(ethLockbox.lockETH, ()), _value > 0 ? 1 : 0); + vm.expectCall(address(dummyLockbox), _value, abi.encodeCall(ethLockbox.lockETH, ()), _value > 0 ? 1 : 0); // give alice money and send as an eoa vm.deal(alice, _value); @@ -545,7 +692,7 @@ contract OptimismPortal2_Receive_Test is OptimismPortal2_TestInit { assertTrue(s); assertEq(address(optimismPortal2).balance, balanceBefore); - assertEq(address(ethLockbox).balance, lockboxBalanceBefore + _value); + assertEq(address(dummyLockbox).balance, lockboxBalanceBefore + _value); } } @@ -610,13 +757,18 @@ contract OptimismPortal2_DonateETH_Test is OptimismPortal2_TestInit { /// @title OptimismPortal2_MigrateLiquidity_Test /// @notice Test contract for OptimismPortal2 `migrateLiquidity` function. contract OptimismPortal2_MigrateLiquidity_Test is CommonTest { + function setUp() public virtual override { + super.setUp(); + skipIfDevFeatureDisabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + } + /// @notice Tests the liquidity migration from the portal to the lockbox reverts if not called /// by the admin owner. function testFuzz_migrateLiquidity_notProxyAdminOwner_reverts(address _caller) external { vm.assume(_caller != optimismPortal2.proxyAdminOwner()); vm.expectRevert(IProxyAdminOwnedBase.ProxyAdminOwnedBase_NotProxyAdminOwner.selector); vm.prank(_caller); - optimismPortal2.migrateLiquidity(); + IOptimismPortalInterop(payable(optimismPortal2)).migrateLiquidity(); } /// @notice Tests that the liquidity migration from the portal to the lockbox succeeds. @@ -633,7 +785,7 @@ contract OptimismPortal2_MigrateLiquidity_Test is CommonTest { emit ETHMigrated(address(ethLockbox), _portalBalance); vm.prank(proxyAdminOwner); - optimismPortal2.migrateLiquidity(); + IOptimismPortalInterop(payable(optimismPortal2)).migrateLiquidity(); assertEq(address(optimismPortal2).balance, 0); assertEq(address(ethLockbox).balance, lockboxBalanceBefore + _portalBalance); @@ -643,6 +795,11 @@ contract OptimismPortal2_MigrateLiquidity_Test is CommonTest { /// @title OptimismPortal2_MigrateToSuperRoots_Test /// @notice Test contract for OptimismPortal2 `migrateToSuperRoots` function. contract OptimismPortal2_MigrateToSuperRoots_Test is OptimismPortal2_TestInit { + function setUp() public override { + super.setUp(); + skipIfDevFeatureDisabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + } + /// @notice Tests that `migrateToSuperRoots` reverts if the caller is not the proxy admin /// owner. function testFuzz_migrateToSuperRoots_notProxyAdminOwner_reverts(address _caller) external { @@ -650,7 +807,9 @@ contract OptimismPortal2_MigrateToSuperRoots_Test is OptimismPortal2_TestInit { vm.expectRevert(IProxyAdminOwnedBase.ProxyAdminOwnedBase_NotProxyAdminOwner.selector); vm.prank(_caller); - optimismPortal2.migrateToSuperRoots(IETHLockbox(address(1)), IAnchorStateRegistry(address(1))); + IOptimismPortalInterop(payable(optimismPortal2)).migrateToSuperRoots( + IETHLockbox(address(1)), IAnchorStateRegistry(address(1)) + ); } /// @notice Tests that `migrateToSuperRoots` reverts if the new registry is the same as the @@ -666,9 +825,11 @@ contract OptimismPortal2_MigrateToSuperRoots_Test is OptimismPortal2_TestInit { address caller = optimismPortal2.proxyAdminOwner(); // Expect the migration to revert. - vm.expectRevert(IOptimismPortal.OptimismPortal_MigratingToSameRegistry.selector); + vm.expectRevert(IOptimismPortalInterop.OptimismPortal_MigratingToSameRegistry.selector); vm.prank(caller); - optimismPortal2.migrateToSuperRoots(IETHLockbox(_newLockbox), newAnchorStateRegistry); + IOptimismPortalInterop(payable(optimismPortal2)).migrateToSuperRoots( + IETHLockbox(_newLockbox), newAnchorStateRegistry + ); } /// @notice Tests that `migrateToSuperRoots` updates the ETHLockbox contract, updates the @@ -685,11 +846,13 @@ contract OptimismPortal2_MigrateToSuperRoots_Test is OptimismPortal2_TestInit { emit PortalMigrated(oldLockbox, _newLockbox, oldAnchorStateRegistry, _newAnchorStateRegistry); vm.prank(optimismPortal2.proxyAdminOwner()); - optimismPortal2.migrateToSuperRoots(IETHLockbox(_newLockbox), IAnchorStateRegistry(_newAnchorStateRegistry)); + IOptimismPortalInterop(payable(optimismPortal2)).migrateToSuperRoots( + IETHLockbox(_newLockbox), IAnchorStateRegistry(_newAnchorStateRegistry) + ); assertEq(address(optimismPortal2.ethLockbox()), _newLockbox); assertEq(address(optimismPortal2.anchorStateRegistry()), _newAnchorStateRegistry); - assertTrue(optimismPortal2.superRootsActive()); + assertTrue(IOptimismPortalInterop(payable(optimismPortal2)).superRootsActive()); } /// @notice Tests that `migrateToSuperRoots` reverts when the system is paused. @@ -701,7 +864,9 @@ contract OptimismPortal2_MigrateToSuperRoots_Test is OptimismPortal2_TestInit { address caller = optimismPortal2.proxyAdminOwner(); vm.expectRevert(IOptimismPortal.OptimismPortal_CallPaused.selector); vm.prank(caller); - optimismPortal2.migrateToSuperRoots(IETHLockbox(address(1)), IAnchorStateRegistry(address(1))); + IOptimismPortalInterop(payable(optimismPortal2)).migrateToSuperRoots( + IETHLockbox(address(1)), IAnchorStateRegistry(address(1)) + ); } } @@ -735,14 +900,16 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test _withdrawalProof: _withdrawalProof }); - _defaultTx.target = address(ethLockbox); - vm.expectRevert(IOptimismPortal.OptimismPortal_BadTarget.selector); - optimismPortal2.proveWithdrawalTransaction({ - _tx: _defaultTx, - _disputeGameIndex: _proposedGameIndex, - _outputRootProof: _outputRootProof, - _withdrawalProof: _withdrawalProof - }); + if (isUsingLockbox()) { + _defaultTx.target = address(ethLockbox); + vm.expectRevert(IOptimismPortal.OptimismPortal_BadTarget.selector); + optimismPortal2.proveWithdrawalTransaction({ + _tx: _defaultTx, + _disputeGameIndex: _proposedGameIndex, + _outputRootProof: _outputRootProof, + _withdrawalProof: _withdrawalProof + }); + } } /// @notice Tests that `proveWithdrawalTransaction` reverts when the current timestamp is less @@ -966,12 +1133,14 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test /// @notice Tests that `proveWithdrawalTransaction` reverts when using the Output Roots version /// of `proveWithdrawalTransaction` when `superRootsActive` is true. function test_proveWithdrawalTransaction_outputRootVersionWhenSuperRootsActive_reverts() external { + skipIfDevFeatureDisabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + // Set superRootsActive to true. setSuperRootsActive(true); // Should revert. - vm.expectRevert(IOptimismPortal.OptimismPortal_WrongProofMethod.selector); - optimismPortal2.proveWithdrawalTransaction({ + vm.expectRevert(IOptimismPortalInterop.OptimismPortal_WrongProofMethod.selector); + IOptimismPortalInterop(payable(optimismPortal2)).proveWithdrawalTransaction({ _tx: _defaultTx, _disputeGameIndex: _proposedGameIndex, _outputRootProof: _outputRootProof, @@ -982,6 +1151,8 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test /// @notice Tests that `proveWithdrawalTransaction` reverts when using the Super Roots version /// of `proveWithdrawalTransaction` when `superRootsActive` is false. function test_proveWithdrawalTransaction_superRootsVersionWhenSuperRootsInactive_reverts() external { + skipIfDevFeatureDisabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + // Set up a dummy super root proof. Types.OutputRootWithChainId[] memory outputRootWithChainIdArr = new Types.OutputRootWithChainId[](1); outputRootWithChainIdArr[0] = @@ -993,8 +1164,8 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test }); // Should revert. - vm.expectRevert(IOptimismPortal.OptimismPortal_WrongProofMethod.selector); - optimismPortal2.proveWithdrawalTransaction({ + vm.expectRevert(IOptimismPortalInterop.OptimismPortal_WrongProofMethod.selector); + IOptimismPortalInterop(payable(optimismPortal2)).proveWithdrawalTransaction({ _tx: _defaultTx, _disputeGameProxy: game, _outputRootIndex: 0, @@ -1007,6 +1178,8 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test /// @notice Tests that `proveWithdrawalTransaction` reverts when using the Super Roots version /// of `proveWithdrawalTransaction` when the provided proof is invalid. function test_proveWithdrawalTransaction_superRootsVersionBadProof_reverts() external { + skipIfDevFeatureDisabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + // Enable super roots. setSuperRootsActive(true); @@ -1021,8 +1194,8 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test }); // Should revert because the proof is wrong. - vm.expectRevert(IOptimismPortal.OptimismPortal_InvalidSuperRootProof.selector); - optimismPortal2.proveWithdrawalTransaction({ + vm.expectRevert(IOptimismPortalInterop.OptimismPortal_InvalidSuperRootProof.selector); + IOptimismPortalInterop(payable(optimismPortal2)).proveWithdrawalTransaction({ _tx: _defaultTx, _disputeGameProxy: game, _outputRootIndex: 0, @@ -1036,6 +1209,8 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test /// of `proveWithdrawalTransaction` when the provided proof is valid but the index is /// out of bounds. function test_proveWithdrawalTransaction_superRootsVersionBadIndex_reverts() external { + skipIfDevFeatureDisabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + // Enable super roots. setSuperRootsActive(true); @@ -1056,8 +1231,8 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test vm.mockCall(address(game), abi.encodeCall(game.rootClaim, ()), abi.encode(expectedSuperRoot)); // Should revert because the proof is wrong. - vm.expectRevert(IOptimismPortal.OptimismPortal_InvalidOutputRootIndex.selector); - optimismPortal2.proveWithdrawalTransaction({ + vm.expectRevert(IOptimismPortalInterop.OptimismPortal_InvalidOutputRootIndex.selector); + IOptimismPortalInterop(payable(optimismPortal2)).proveWithdrawalTransaction({ _tx: _defaultTx, _disputeGameProxy: game, _outputRootIndex: outputRootWithChainIdArr.length, // out of bounds @@ -1071,6 +1246,8 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test /// of `proveWithdrawalTransaction` when the provided proof is valid, index is correct, /// but the output root has the wrong chain id. function test_proveWithdrawalTransaction_superRootsVersionBadChainId_reverts() external { + skipIfDevFeatureDisabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + // Enable super roots. setSuperRootsActive(true); @@ -1093,8 +1270,8 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test vm.mockCall(address(game), abi.encodeCall(game.rootClaim, ()), abi.encode(expectedSuperRoot)); // Should revert because the proof is wrong. - vm.expectRevert(IOptimismPortal.OptimismPortal_InvalidOutputRootChainId.selector); - optimismPortal2.proveWithdrawalTransaction({ + vm.expectRevert(IOptimismPortalInterop.OptimismPortal_InvalidOutputRootChainId.selector); + IOptimismPortalInterop(payable(optimismPortal2)).proveWithdrawalTransaction({ _tx: _defaultTx, _disputeGameProxy: game, _outputRootIndex: 0, @@ -1108,6 +1285,8 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test /// of `proveWithdrawalTransaction` when the provided proof is valid, index is correct, /// chain id is correct, but the output root proof is invalid. function test_proveWithdrawalTransaction_superRootsVersionBadOutputRootProof_reverts() external { + skipIfDevFeatureDisabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + // Enable super roots. setSuperRootsActive(true); @@ -1130,8 +1309,8 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test vm.mockCall(address(game), abi.encodeCall(game.rootClaim, ()), abi.encode(expectedSuperRoot)); // Should revert because the proof is wrong. - vm.expectRevert(IOptimismPortal.OptimismPortal_InvalidOutputRootProof.selector); - optimismPortal2.proveWithdrawalTransaction({ + vm.expectRevert(IOptimismPortalInterop.OptimismPortal_InvalidOutputRootProof.selector); + IOptimismPortalInterop(payable(optimismPortal2)).proveWithdrawalTransaction({ _tx: _defaultTx, _disputeGameProxy: game, _outputRootIndex: 0, @@ -1143,6 +1322,8 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test /// @notice Tests that `proveWithdrawalTransaction` succeeds when all parameters are valid. function test_proveWithdrawalTransaction_superRootsVersion_succeeds() external { + skipIfDevFeatureDisabled(DevFeatures.OPTIMISM_PORTAL_INTEROP); + // Enable super roots. setSuperRootsActive(true); @@ -1163,7 +1344,7 @@ contract OptimismPortal2_ProveWithdrawalTransaction_Test is OptimismPortal2_Test vm.mockCall(address(game), abi.encodeCall(game.rootClaim, ()), abi.encode(expectedSuperRoot)); // Should succeed. - optimismPortal2.proveWithdrawalTransaction({ + IOptimismPortalInterop(payable(optimismPortal2)).proveWithdrawalTransaction({ _tx: _defaultTx, _disputeGameProxy: game, _outputRootIndex: 0, @@ -1198,9 +1379,11 @@ contract OptimismPortal2_FinalizeWithdrawalTransaction_Test is OptimismPortal2_T vm.expectRevert(IOptimismPortal.OptimismPortal_BadTarget.selector); optimismPortal2.finalizeWithdrawalTransaction(_defaultTx); - _defaultTx.target = address(ethLockbox); - vm.expectRevert(IOptimismPortal.OptimismPortal_BadTarget.selector); - optimismPortal2.finalizeWithdrawalTransaction(_defaultTx); + if (isUsingLockbox()) { + _defaultTx.target = address(ethLockbox); + vm.expectRevert(IOptimismPortal.OptimismPortal_BadTarget.selector); + optimismPortal2.finalizeWithdrawalTransaction(_defaultTx); + } } /// @notice Tests that `finalizeWithdrawalTransaction` reverts if the target reverts and caller @@ -1268,7 +1451,10 @@ contract OptimismPortal2_FinalizeWithdrawalTransaction_Test is OptimismPortal2_T // Fund the portal so that we can withdraw ETH. vm.store(address(optimismPortal2), bytes32(uint256(61)), bytes32(uint256(0xFFFFFFFF))); - vm.deal(address(ethLockbox), 0xFFFFFFFF); + vm.deal(address(optimismPortal2), 0xFFFFFFFF); + if (isUsingLockbox()) { + vm.deal(address(ethLockbox), 0xFFFFFFFF); + } uint256 bobBalanceBefore = bob.balance; @@ -1486,6 +1672,51 @@ contract OptimismPortal2_FinalizeWithdrawalTransaction_Test is OptimismPortal2_T /// @notice Tests that `finalizeWithdrawalTransaction` reverts if the target reverts. function test_finalizeWithdrawalTransaction_targetFails_fails() external { + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + vm.deal(address(optimismPortal2), 0); // no balance + } + + uint256 bobBalanceBefore = address(bob).balance; + vm.etch(bob, hex"fe"); // Contract with just the invalid opcode. + + vm.expectEmit(true, true, true, true); + emit WithdrawalProven(_withdrawalHash, alice, bob); + vm.expectEmit(true, true, true, true); + emit WithdrawalProvenExtension1(_withdrawalHash, address(this)); + optimismPortal2.proveWithdrawalTransaction({ + _tx: _defaultTx, + _disputeGameIndex: _proposedGameIndex, + _outputRootProof: _outputRootProof, + _withdrawalProof: _withdrawalProof + }); + + // Resolve the dispute game. + game.resolveClaim(0, 0); + game.resolve(); + + vm.warp(block.timestamp + optimismPortal2.proofMaturityDelaySeconds() + 1); + vm.expectEmit(true, true, true, true); + emit WithdrawalFinalized(_withdrawalHash, false); + optimismPortal2.finalizeWithdrawalTransaction(_defaultTx); + + // Bob's balance should not have changed. + assertEq(address(bob).balance, bobBalanceBefore); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + // OptimismPortal2 should not have any stuck ETH. + assertEq(address(optimismPortal2).balance, 0); + } + } + + /// @notice Tests that `finalizeWithdrawalTransaction` reverts if the target reverts when + /// using the ETHLockbox. + function test_finalizeWithdrawalTransaction_lockboxAndTargetFails_fails() external { + // Enable the ETHLockbox. + address dummyLockbox = address(0xdeadbeef); + forceEnableLockbox(dummyLockbox); + vm.deal(address(dummyLockbox), 0xFFFFFFFF); + vm.deal(address(optimismPortal2), _defaultTx.value); + uint256 bobBalanceBefore = address(bob).balance; vm.etch(bob, hex"fe"); // Contract with just the invalid opcode. @@ -1657,7 +1888,10 @@ contract OptimismPortal2_FinalizeWithdrawalTransaction_Test is OptimismPortal2_T // Total ETH supply is currently about 120M ETH. uint256 value = bound(_value, 0, 200_000_000 ether); - vm.deal(address(ethLockbox), value); + vm.deal(address(optimismPortal2), value); + if (isUsingLockbox()) { + vm.deal(address(ethLockbox), value); + } uint256 gasLimit = bound(_gasLimit, 0, 50_000_000); uint256 nonce = l2ToL1MessagePasser.messageNonce(); @@ -1738,7 +1972,10 @@ contract OptimismPortal2_FinalizeWithdrawalTransaction_Test is OptimismPortal2_T // Total ETH supply is currently about 120M ETH. uint256 value = bound(_value, 0, 200_000_000 ether); - vm.deal(address(ethLockbox), value); + vm.deal(address(optimismPortal2), value); + if (isUsingLockbox()) { + vm.deal(address(ethLockbox), value); + } uint256 gasLimit = bound(_gasLimit, 0, 50_000_000); uint256 nonce = l2ToL1MessagePasser.messageNonce(); @@ -2270,8 +2507,10 @@ contract OptimismPortal2_DepositTransaction_Test is OptimismPortal2_TestInit { _data: _data }); - // Expect call to the ETHLockbox to lock the funds only if the value is greater than 0. - vm.expectCall(address(ethLockbox), _mint, abi.encodeCall(ethLockbox.lockETH, ()), _mint > 0 ? 1 : 0); + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + // Expect call to the ETHLockbox to lock the funds only if the value is greater than 0. + vm.expectCall(address(ethLockbox), _mint, abi.encodeCall(ethLockbox.lockETH, ()), _mint > 0 ? 1 : 0); + } vm.deal(depositor, _mint); vm.prank(depositor, depositor); @@ -2283,8 +2522,12 @@ contract OptimismPortal2_DepositTransaction_Test is OptimismPortal2_TestInit { _data: _data }); - assertEq(address(optimismPortal2).balance, balanceBefore); - assertEq(address(ethLockbox).balance, lockboxBalanceBefore + _mint); + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq(address(optimismPortal2).balance, balanceBefore); + assertEq(address(ethLockbox).balance, lockboxBalanceBefore + _mint); + } else { + assertEq(address(optimismPortal2).balance, balanceBefore + _mint); + } } /// @notice Tests that `depositTransaction` succeeds for an EOA using 7702 delegation. @@ -2341,8 +2584,13 @@ contract OptimismPortal2_DepositTransaction_Test is OptimismPortal2_TestInit { _isCreation: _isCreation, _data: _data }); - assertEq(address(optimismPortal2).balance, portalBalanceBefore); - assertEq(address(ethLockbox).balance, lockboxBalanceBefore + _mint); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq(address(optimismPortal2).balance, portalBalanceBefore); + assertEq(address(ethLockbox).balance, lockboxBalanceBefore + _mint); + } else { + assertEq(address(optimismPortal2).balance, portalBalanceBefore + _mint); + } } /// @notice Tests that `depositTransaction` succeeds for a contract. @@ -2382,8 +2630,10 @@ contract OptimismPortal2_DepositTransaction_Test is OptimismPortal2_TestInit { _data: _data }); - // Expect call to the ETHLockbox to lock the funds only if the value is greater than 0. - vm.expectCall(address(ethLockbox), _mint, abi.encodeCall(ethLockbox.lockETH, ()), _mint > 0 ? 1 : 0); + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + // Expect call to the ETHLockbox to lock the funds only if the value is greater than 0. + vm.expectCall(address(ethLockbox), _mint, abi.encodeCall(ethLockbox.lockETH, ()), _mint > 0 ? 1 : 0); + } vm.deal(address(this), _mint); vm.prank(address(this)); @@ -2394,8 +2644,13 @@ contract OptimismPortal2_DepositTransaction_Test is OptimismPortal2_TestInit { _isCreation: _isCreation, _data: _data }); - assertEq(address(optimismPortal2).balance, balanceBefore); - assertEq(address(ethLockbox).balance, lockboxBalanceBefore + _mint); + + if (isSysFeatureEnabled(Features.ETH_LOCKBOX)) { + assertEq(address(optimismPortal2).balance, balanceBefore); + assertEq(address(ethLockbox).balance, lockboxBalanceBefore + _mint); + } else { + assertEq(address(optimismPortal2).balance, balanceBefore + _mint); + } } } @@ -2522,7 +2777,7 @@ contract OptimismPortal2_Params_Test is CommonTest { // The value passed to the initialize must be larger than the last value // that initialize was called with. IProxy(payable(address(optimismPortal2))).upgradeToAndCall( - address(nextImpl), abi.encodeCall(NextImpl.initialize, (3)) + address(nextImpl), abi.encodeCall(NextImpl.initialize, (optimismPortal2.initVersion() + 1)) ); assertEq(IProxy(payable(address(optimismPortal2))).implementation(), address(nextImpl)); diff --git a/packages/contracts-bedrock/test/L1/SuperchainConfig.t.sol b/packages/contracts-bedrock/test/L1/SuperchainConfig.t.sol index 2c155a76ae8..ce63b4a5037 100644 --- a/packages/contracts-bedrock/test/L1/SuperchainConfig.t.sol +++ b/packages/contracts-bedrock/test/L1/SuperchainConfig.t.sol @@ -7,7 +7,6 @@ import { CommonTest } from "test/setup/CommonTest.sol"; // Libraries import { DeployUtils } from "scripts/libraries/DeployUtils.sol"; import { ForgeArtifacts, StorageSlot } from "scripts/libraries/ForgeArtifacts.sol"; -import { Constants } from "src/libraries/Constants.sol"; // Interfaces import { IProxy } from "interfaces/universal/IProxy.sol"; @@ -76,8 +75,8 @@ contract SuperchainConfig_Initialize_Test is SuperchainConfig_TestInit { /// owner. /// @param _sender The address of the sender to test. function testFuzz_initialize_notProxyAdminOrProxyAdminOwner_reverts(address _sender) public { - // Prank as the not ProxyAdmin or ProxyAdmin owner. - vm.assume(_sender != address(proxyAdmin) && _sender != proxyAdminOwner); + // Prank as not the superchain ProxyAdmin or ProxyAdmin owner. + vm.assume(_sender != address(superchainProxyAdmin) && _sender != superchainProxyAdminOwner); // Get the slot for _initialized. StorageSlot memory slot = ForgeArtifacts.getSlot("SuperchainConfig", "_initialized"); @@ -94,77 +93,6 @@ contract SuperchainConfig_Initialize_Test is SuperchainConfig_TestInit { } } -/// @title SuperchainConfig_Upgrade_Test -/// @notice Test contract for SuperchainConfig `upgrade` function. -contract SuperchainConfig_Upgrade_Test is SuperchainConfig_TestInit { - /// @notice Tests that `upgrade` successfully upgrades the contract. - function test_upgrade_succeeds() external { - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("SuperchainConfig", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(superchainConfig), bytes32(slot.slot), bytes32(0)); - - // Get the slot for the SuperchainConfig's ProxyAdmin. - address proxyAdminAddress = - address(uint160(uint256(vm.load(address(superchainConfig), Constants.PROXY_OWNER_ADDRESS)))); - - // Upgrade the contract. - vm.prank(proxyAdminAddress); - superchainConfig.upgrade(); - - // Check that the guardian slot was updated. - bytes32 guardianSlot = bytes32(uint256(keccak256("superchainConfig.guardian")) - 1); - assertEq(vm.load(address(superchainConfig), guardianSlot), bytes32(0)); - - // Check that the paused slot was cleared. - bytes32 pausedSlot = bytes32(uint256(keccak256("superchainConfig.paused")) - 1); - assertEq(vm.load(address(superchainConfig), pausedSlot), bytes32(0)); - } - - /// @notice Tests that `upgrade` reverts when called a second time. - function test_upgrade_upgradeTwice_reverts() external { - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("SuperchainConfig", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(superchainConfig), bytes32(slot.slot), bytes32(0)); - - // Get the slot for the SuperchainConfig's ProxyAdmin. - address proxyAdminAddress = - address(uint160(uint256(vm.load(address(superchainConfig), Constants.PROXY_OWNER_ADDRESS)))); - - // Trigger first upgrade. - vm.prank(proxyAdminAddress); - superchainConfig.upgrade(); - - // Trigger second upgrade. - vm.prank(proxyAdminAddress); - vm.expectRevert("Initializable: contract is already initialized"); - superchainConfig.upgrade(); - } - - /// @notice Tests that `upgrade` reverts when called by a non-proxy admin or owner. - /// @param _sender The address of the sender to test. - function testFuzz_upgrade_notProxyAdminOrProxyAdminOwner_reverts(address _sender) public { - // Prank as the not ProxyAdmin or ProxyAdmin owner. - vm.assume(_sender != address(superchainProxyAdmin) && _sender != superchainProxyAdminOwner); - - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("SuperchainConfig", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(superchainConfig), bytes32(slot.slot), bytes32(0)); - - // Expect the revert with `ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner` selector. - vm.expectRevert(IProxyAdminOwnedBase.ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner.selector); - - // Call the `upgrade` function with the sender - vm.prank(_sender); - superchainConfig.upgrade(); - } -} - /// @title SuperchainConfig_PauseExpiry_Test /// @notice Test contract for SuperchainConfig `pauseExpiry` function. contract SuperchainConfig_PauseExpiry_Test is SuperchainConfig_TestInit { @@ -434,9 +362,9 @@ contract SuperchainConfig_PauseTimestamps_Test is SuperchainConfig_TestInit { /// @title SuperchainConfig_Version_Test /// @notice Test contract for SuperchainConfig `version` getter function. contract SuperchainConfig_Version_Test is SuperchainConfig_TestInit { - /// @notice Tests that `version` returns the correct version string. + /// @notice Tests that `version` returns a version string. function test_version_succeeds() external view { - assertEq(superchainConfig.version(), "2.3.0"); + assert(bytes(superchainConfig.version()).length > 0); } } diff --git a/packages/contracts-bedrock/test/L1/SystemConfig.t.sol b/packages/contracts-bedrock/test/L1/SystemConfig.t.sol index 9b1e1c3d813..91a4e2eed16 100644 --- a/packages/contracts-bedrock/test/L1/SystemConfig.t.sol +++ b/packages/contracts-bedrock/test/L1/SystemConfig.t.sol @@ -10,6 +10,7 @@ import { ForgeArtifacts, StorageSlot } from "scripts/libraries/ForgeArtifacts.so // Libraries import { Constants } from "src/libraries/Constants.sol"; import { EIP1967Helper } from "test/mocks/EIP1967Helper.sol"; +import { Features } from "src/libraries/Features.sol"; // Interfaces import { IResourceMetering } from "interfaces/L1/IResourceMetering.sol"; @@ -22,6 +23,8 @@ import { IProxyAdminOwnedBase } from "interfaces/L1/IProxyAdminOwnedBase.sol"; contract SystemConfig_TestInit is CommonTest { event ConfigUpdate(uint256 indexed version, ISystemConfig.UpdateType indexed updateType, bytes data); + bytes32 public constant EXAMPLE_FEATURE = "EXAMPLE_FEATURE"; + address batchInbox; address owner; bytes32 batcherHash; @@ -34,7 +37,6 @@ contract SystemConfig_TestInit is CommonTest { function setUp() public virtual override { super.setUp(); - skipIfForkTest("SystemConfig_Initialize_Test: cannot test initialization on forked network"); batchInbox = deploy.cfg().batchInboxAddress(); owner = deploy.cfg().finalSystemOwner(); basefeeScalar = deploy.cfg().basefeeScalar(); @@ -92,6 +94,12 @@ contract SystemConfig_Constructor_Test is SystemConfig_TestInit { /// @title SystemConfig_Initialize_Test /// @notice Test contract for SystemConfig `initialize` function. contract SystemConfig_Initialize_Test is SystemConfig_TestInit { + /// @notice Skips the test if it's running on a forked network. + function setUp() public override { + super.setUp(); + skipIfForkTest("SystemConfig_Initialize_Test: cannot test initialization on forked network"); + } + /// @notice Tests that initialization sets the correct values. function test_initialize_succeeds() external view { assertEq(systemConfig.owner(), owner); @@ -220,99 +228,6 @@ contract SystemConfig_Initialize_Test is SystemConfig_TestInit { } } -/// @title SystemConfig_upgrade_Test -/// @notice Reusable test for the current upgrade() function in the SystemConfig contract. If -/// the upgrade() function is changed, tests inside of this contract should be updated to -/// reflect the new function. If the upgrade() function is removed, remove the -/// corresponding tests but leave this contract in place so it's easy to add tests back -/// in the future. -contract SystemConfig_Upgrade_Test is SystemConfig_TestInit { - /// @notice Tests that the upgrade() function succeeds. - function test_upgrade_succeeds() external { - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("SystemConfig", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(systemConfig), bytes32(slot.slot), bytes32(0)); - - // Verify the initial dispute game factory slot is non-zero. - // We set a value here since it seems this defaults to zero. - bytes32 disputeGameFactorySlot = bytes32(uint256(keccak256("systemconfig.disputegamefactory")) - 1); - vm.store(address(systemConfig), disputeGameFactorySlot, bytes32(uint256(1))); - assertNotEq(systemConfig.disputeGameFactory(), address(0)); - assertNotEq(vm.load(address(systemConfig), disputeGameFactorySlot), bytes32(0)); - - // Trigger upgrade(). - vm.prank(address(systemConfig.proxyAdmin())); - systemConfig.upgrade(1234, ISuperchainConfig(address(0xdeadbeef))); - - // Verify that the initialized slot was updated. - bytes32 initializedSlotAfter = vm.load(address(systemConfig), bytes32(slot.slot)); - assertEq(initializedSlotAfter, bytes32(uint256(2))); - - // Verify that the l2ChainId was updated. - assertEq(systemConfig.l2ChainId(), 1234); - - // Verify that the dispute game factory address was cleared. - assertEq(vm.load(address(systemConfig), disputeGameFactorySlot), bytes32(0)); - } - - /// @notice Tests that the upgrade() function reverts if called a second time. - function test_upgrade_upgradeTwice_reverts() external { - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("SystemConfig", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(systemConfig), bytes32(slot.slot), bytes32(0)); - - // Trigger first upgrade. - vm.prank(address(systemConfig.proxyAdmin())); - systemConfig.upgrade(1234, ISuperchainConfig(address(0xdeadbeef))); - - // Try to trigger second upgrade. - vm.prank(address(systemConfig.proxyAdmin())); - vm.expectRevert("Initializable: contract is already initialized"); - systemConfig.upgrade(1234, ISuperchainConfig(address(0xdeadbeef))); - } - - /// @notice Tests that the upgrade() function reverts if called after initialization. - function test_upgrade_afterInitialization_reverts() external { - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("SystemConfig", "_initialized"); - - // Slot value should be set to 2 (already initialized). - bytes32 initializedSlotBefore = vm.load(address(systemConfig), bytes32(slot.slot)); - assertEq(initializedSlotBefore, bytes32(uint256(2))); - - // l2ChainId should be non-zero. - assertNotEq(systemConfig.l2ChainId(), 0); - - // Try to trigger upgrade(). - vm.expectRevert("Initializable: contract is already initialized"); - systemConfig.upgrade(1234, ISuperchainConfig(address(0xdeadbeef))); - } - - /// @notice Tests that the upgrade() function reverts if called by a non-proxy admin or owner. - /// @param _sender The address of the sender to test. - function testFuzz_upgrade_notProxyAdminOrProxyAdminOwner_reverts(address _sender) public { - // Prank as the not ProxyAdmin or ProxyAdmin owner. - vm.assume(_sender != address(systemConfig.proxyAdmin()) && _sender != systemConfig.proxyAdminOwner()); - - // Get the slot for _initialized. - StorageSlot memory slot = ForgeArtifacts.getSlot("SystemConfig", "_initialized"); - - // Set the initialized slot to 0. - vm.store(address(systemConfig), bytes32(slot.slot), bytes32(0)); - - // Expect the revert with `ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner` selector. - vm.expectRevert(IProxyAdminOwnedBase.ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner.selector); - - // Call the `upgrade` function with the sender - vm.prank(_sender); - systemConfig.upgrade(1234, ISuperchainConfig(address(0xdeadbeef))); - } -} - /// @title SystemConfig_StartBlock_Test /// @notice Test contract for SystemConfig `startBlock` function. contract SystemConfig_StartBlock_Test is SystemConfig_TestInit { @@ -678,28 +593,45 @@ contract SystemConfig_SetResourceConfig_Test is SystemConfig_TestInit { /// @title SystemConfig_Paused_Test /// @notice Test contract for SystemConfig `paused` function. contract SystemConfig_Paused_Test is SystemConfig_TestInit { - /// @notice Tests that `paused()` returns the correct value. - function test_paused_succeeds() external view { - assertEq(systemConfig.paused(), superchainConfig.paused(address(0))); + /// @notice Tests that `paused()` returns false when no pauses are active. + function test_paused_noPauses_succeeds() external view { + assertFalse(systemConfig.paused()); } - /// @notice Tests that `paused()` returns the correct value after pausing. - function test_paused_afterPause_succeeds() external { + /// @notice Tests that `paused()` returns true when global pause is active. + function test_paused_globalPause_succeeds() external { // Initially not paused assertFalse(systemConfig.paused()); - assertEq(systemConfig.paused(), superchainConfig.paused(address(0))); - // Pause the system + // Pause the system globally vm.prank(superchainConfig.guardian()); superchainConfig.pause(address(0)); // Verify paused state assertTrue(systemConfig.paused()); - assertEq(systemConfig.paused(), superchainConfig.paused(address(0))); } - /// @notice Tests that `paused()` returns true when the ETHLockbox identifier is set. + /// @notice Tests that `paused()` returns true when OptimismPortal identifier is paused and + /// the ETH_LOCKBOX feature is disabled. + function test_paused_optimismPortalIdentifier_succeeds() external { + skipIfSysFeatureEnabled(Features.ETH_LOCKBOX); + + // Initially not paused + assertFalse(systemConfig.paused()); + + // Pause the system with OptimismPortal identifier + vm.prank(superchainConfig.guardian()); + superchainConfig.pause(address(optimismPortal2)); + + // Verify paused state + assertTrue(systemConfig.paused()); + } + + /// @notice Tests that `paused()` returns true when ETHLockbox identifier is paused and + /// ETH_LOCKBOX feature is enabled. function test_paused_ethLockboxIdentifier_succeeds() external { + skipIfSysFeatureDisabled(Features.ETH_LOCKBOX); + // Initially not paused assertFalse(systemConfig.paused()); @@ -711,20 +643,168 @@ contract SystemConfig_Paused_Test is SystemConfig_TestInit { assertTrue(systemConfig.paused()); } - /// @notice Tests that `paused()` returns false when any other address is set. - function test_paused_otherAddress_works() external { + /// @notice Tests that `paused()` returns true when both pauses are active. + function test_paused_bothPausesActive_succeeds() external { + assertFalse(systemConfig.paused()); + + // Pause both globally and with identifier + vm.startPrank(superchainConfig.guardian()); + superchainConfig.pause(address(0)); + superchainConfig.pause(address(optimismPortal2)); + vm.stopPrank(); + + // Verify paused state + assertTrue(systemConfig.paused()); + } + + /// @notice Tests that `paused()` returns false when any other address is paused. + /// @param _address The address to pause. + function testFuzz_paused_otherAddress_succeeds(address _address) external { + vm.assume(_address != address(0)); + vm.assume(_address != address(optimismPortal2)); + vm.assume(_address != address(ethLockbox)); + // Initially not paused assertFalse(systemConfig.paused()); - // Pause the system with a different address + // Pause the system with a different address that's not global or identifier vm.prank(superchainConfig.guardian()); - superchainConfig.pause(address(0x1234)); + superchainConfig.pause(_address); // Verify still not paused assertFalse(systemConfig.paused()); } } +/// @title SystemConfig_SetFeature_Test +/// @notice Test contract for SystemConfig `setFeature` function. +contract SystemConfig_SetFeature_Test is SystemConfig_TestInit { + event FeatureSet(bytes32 indexed feature, bool indexed enabled); + + /// @notice Tests that `setFeature` reverts if the caller is not ProxyAdmin or ProxyAdmin owner. + /// @param _sender The address to test. + function testFuzz_setFeature_notProxyAdminOrProxyAdminOwner_reverts(address _sender) external { + // Ensure sender is not ProxyAdmin or ProxyAdmin owner + vm.assume(_sender != address(systemConfig.proxyAdmin()) && _sender != systemConfig.proxyAdminOwner()); + + vm.expectRevert(IProxyAdminOwnedBase.ProxyAdminOwnedBase_NotProxyAdminOrProxyAdminOwner.selector); + vm.prank(_sender); + systemConfig.setFeature(EXAMPLE_FEATURE, true); + } + + /// @notice Tests that `setFeature` enables a feature successfully when called by ProxyAdmin. + function test_setFeature_enableFeatureByProxyAdmin_succeeds() external { + vm.expectEmit(address(systemConfig)); + emit FeatureSet(EXAMPLE_FEATURE, true); + + vm.prank(address(systemConfig.proxyAdmin())); + systemConfig.setFeature(EXAMPLE_FEATURE, true); + + // Verify feature is now enabled + assertTrue(systemConfig.isFeatureEnabled(EXAMPLE_FEATURE)); + } + + /// @notice Tests that `setFeature` disables a feature successfully when called by ProxyAdmin. + function test_setFeature_disableFeatureByProxyAdmin_succeeds() external { + // First enable the feature + vm.prank(address(systemConfig.proxyAdmin())); + systemConfig.setFeature(EXAMPLE_FEATURE, true); + assertTrue(systemConfig.isFeatureEnabled(EXAMPLE_FEATURE)); + + vm.expectEmit(address(systemConfig)); + emit FeatureSet(EXAMPLE_FEATURE, false); + + vm.prank(address(systemConfig.proxyAdmin())); + systemConfig.setFeature(EXAMPLE_FEATURE, false); + + // Verify feature is now disabled + assertFalse(systemConfig.isFeatureEnabled(EXAMPLE_FEATURE)); + } + + /// @notice Tests that `setFeature` enables a feature successfully when called by ProxyAdmin owner. + function test_setFeature_enableFeatureByProxyAdminOwner_succeeds() external { + vm.expectEmit(address(systemConfig)); + emit FeatureSet(EXAMPLE_FEATURE, true); + + vm.prank(systemConfig.proxyAdminOwner()); + systemConfig.setFeature(EXAMPLE_FEATURE, true); + + // Verify feature is now enabled + assertTrue(systemConfig.isFeatureEnabled(EXAMPLE_FEATURE)); + } + + /// @notice Tests that `setFeature` can toggle the same feature multiple times. + function test_setFeature_multipleToggles_succeeds() external { + address proxyAdmin = address(systemConfig.proxyAdmin()); + + // Enable feature + vm.prank(proxyAdmin); + systemConfig.setFeature(EXAMPLE_FEATURE, true); + assertTrue(systemConfig.isFeatureEnabled(EXAMPLE_FEATURE)); + + // Disable feature + vm.prank(proxyAdmin); + systemConfig.setFeature(EXAMPLE_FEATURE, false); + assertFalse(systemConfig.isFeatureEnabled(EXAMPLE_FEATURE)); + + // Enable again + vm.prank(proxyAdmin); + systemConfig.setFeature(EXAMPLE_FEATURE, true); + assertTrue(systemConfig.isFeatureEnabled(EXAMPLE_FEATURE)); + } + + /// @notice Tests that `setFeature` reverts when trying to enable a feature that is already + /// enabled. + function test_setFeature_alreadyEnabled_reverts() external { + vm.prank(address(systemConfig.proxyAdmin())); + systemConfig.setFeature(EXAMPLE_FEATURE, true); + assertTrue(systemConfig.isFeatureEnabled(EXAMPLE_FEATURE)); + + vm.prank(address(systemConfig.proxyAdmin())); + vm.expectRevert(ISystemConfig.SystemConfig_InvalidFeatureState.selector); + systemConfig.setFeature(EXAMPLE_FEATURE, true); + } + + /// @notice Tests that `setFeature` reverts when trying to disable a feature that is already + /// disabled. + function test_setFeature_alreadyDisabled_reverts() external { + vm.prank(address(systemConfig.proxyAdmin())); + vm.expectRevert(ISystemConfig.SystemConfig_InvalidFeatureState.selector); + systemConfig.setFeature("EXAMPLE FEATURE", false); + } +} + +/// @title SystemConfig_IsFeatureEnabled_Test +/// @notice Test contract for SystemConfig `isFeatureEnabled` function. +contract SystemConfig_IsFeatureEnabled_Test is SystemConfig_TestInit { + /// @notice Tests that `isFeatureEnabled` returns false for unset features. + /// @param _feature The feature to check. + function testFuzz_isFeatureEnabled_unsetFeature_succeeds(bytes32 _feature) external view { + assertFalse(systemConfig.isFeatureEnabled(_feature)); + } + + /// @notice Tests that `isFeatureEnabled` returns correct value after feature is enabled. + function test_isFeatureEnabled_afterEnable_succeeds() external { + vm.prank(address(systemConfig.proxyAdmin())); + systemConfig.setFeature(EXAMPLE_FEATURE, true); + + assertTrue(systemConfig.isFeatureEnabled(EXAMPLE_FEATURE)); + } + + /// @notice Tests that `isFeatureEnabled` returns correct value after feature is disabled. + function test_isFeatureEnabled_afterDisable_succeeds() external { + // First enable the feature + vm.prank(address(systemConfig.proxyAdmin())); + systemConfig.setFeature(EXAMPLE_FEATURE, true); + assertTrue(systemConfig.isFeatureEnabled(EXAMPLE_FEATURE)); + + // Then disable it + vm.prank(address(systemConfig.proxyAdmin())); + systemConfig.setFeature(EXAMPLE_FEATURE, false); + assertFalse(systemConfig.isFeatureEnabled(EXAMPLE_FEATURE)); + } +} + /// @title SystemConfig_Guardian_Test /// @notice Test contract for SystemConfig `guardian` function. contract SystemConfig_Guardian_Test is SystemConfig_TestInit { @@ -743,3 +823,23 @@ contract SystemConfig_SuperchainConfig_Test is SystemConfig_TestInit { assertEq(address(systemConfig.superchainConfig()), address(superchainConfig)); } } + +/// @title SystemConfig_SetMinBaseFee_Test +/// @notice Test contract for SystemConfig `setMinBaseFee` function. +contract SystemConfig_SetMinBaseFee_Test is SystemConfig_TestInit { + /// @notice Tests that `setMinBaseFee` reverts if the caller is not the owner. + function test_setMinBaseFee_notOwner_reverts() external { + vm.expectRevert("Ownable: caller is not the owner"); + systemConfig.setMinBaseFee(0); + } + + /// @notice Tests that `setMinBaseFee` updates the min base fee successfully. + function testFuzz_setMinBaseFee_succeeds(uint64 newMinBaseFee) external { + vm.expectEmit(address(systemConfig)); + emit ConfigUpdate(0, ISystemConfig.UpdateType.MIN_BASE_FEE, abi.encode(newMinBaseFee)); + + vm.prank(systemConfig.owner()); + systemConfig.setMinBaseFee(newMinBaseFee); + assertEq(systemConfig.minBaseFee(), newMinBaseFee); + } +} diff --git a/packages/contracts-bedrock/test/L2/GasPriceOracle.t.sol b/packages/contracts-bedrock/test/L2/GasPriceOracle.t.sol index 8b92a7dbd5e..95053e369da 100644 --- a/packages/contracts-bedrock/test/L2/GasPriceOracle.t.sol +++ b/packages/contracts-bedrock/test/L2/GasPriceOracle.t.sol @@ -9,10 +9,6 @@ import { Fork } from "scripts/libraries/Config.sol"; import { Encoding } from "src/libraries/Encoding.sol"; contract GasPriceOracle_Test is CommonTest { - event OverheadUpdated(uint256); - event ScalarUpdated(uint256); - event DecimalsUpdated(uint256); - address depositor; // The initial L1 context values diff --git a/packages/contracts-bedrock/test/L2/L2CrossDomainMessenger.t.sol b/packages/contracts-bedrock/test/L2/L2CrossDomainMessenger.t.sol index ea223778ec5..c9c8fd06f41 100644 --- a/packages/contracts-bedrock/test/L2/L2CrossDomainMessenger.t.sol +++ b/packages/contracts-bedrock/test/L2/L2CrossDomainMessenger.t.sol @@ -35,6 +35,8 @@ contract L2CrossDomainMessenger_Constructor_Test is L2CrossDomainMessenger_TestI assertEq(address(impl.OTHER_MESSENGER()), address(0)); assertEq(address(impl.otherMessenger()), address(0)); assertEq(address(impl.l1CrossDomainMessenger()), address(0)); + assertGt(bytes(impl.version()).length, 0); + assertEq(impl.MESSAGE_VERSION(), 1); } } @@ -46,13 +48,29 @@ contract L2CrossDomainMessenger_Initialize_Test is L2CrossDomainMessenger_TestIn assertEq(address(l2CrossDomainMessenger.OTHER_MESSENGER()), address(l1CrossDomainMessenger)); assertEq(address(l2CrossDomainMessenger.otherMessenger()), address(l1CrossDomainMessenger)); assertEq(address(l2CrossDomainMessenger.l1CrossDomainMessenger()), address(l1CrossDomainMessenger)); + assertGt(bytes(l2CrossDomainMessenger.version()).length, 0); + assertEq(l2CrossDomainMessenger.MESSAGE_VERSION(), 1); + assertGt(l2CrossDomainMessenger.messageNonce(), 0); } } /// @title L2CrossDomainMessenger_SendMessage_Test /// @notice Tests the `sendMessage` function of the `L2CrossDomainMessenger` contract. contract L2CrossDomainMessenger_SendMessage_Test is L2CrossDomainMessenger_TestInit { - /// @notice Tests that `sendMessage` executes successfully. + /// @notice Tests that `sendMessage` executes successfully with various target addresses and gas limits. + function testFuzz_sendMessage_withValidTargetAndGasLimit_succeeds(address _target, uint32 _minGasLimit) external { + vm.assume(_target != address(0)); + _minGasLimit = uint32(bound(_minGasLimit, 21000, 30_000_000)); + + uint256 initialNonce = l2CrossDomainMessenger.messageNonce(); + + vm.prank(alice); + l2CrossDomainMessenger.sendMessage(_target, hex"1234", _minGasLimit); + + assertEq(l2CrossDomainMessenger.messageNonce(), initialNonce + 1); + } + + /// @notice Tests that `sendMessage` executes successfully with the original test case. function test_sendMessage_succeeds() external { bytes memory xDomainCallData = Encoding.encodeCrossDomainMessage(l2CrossDomainMessenger.messageNonce(), alice, recipient, 0, 100, hex"ff"); @@ -64,7 +82,6 @@ contract L2CrossDomainMessenger_SendMessage_Test is L2CrossDomainMessenger_TestI ) ); - // MessagePassed event vm.expectEmit(true, true, true, true); emit MessagePassed( l2ToL1MessagePasser.messageNonce(), @@ -89,13 +106,11 @@ contract L2CrossDomainMessenger_SendMessage_Test is L2CrossDomainMessenger_TestI l2CrossDomainMessenger.sendMessage(recipient, hex"ff", uint32(100)); } - /// @notice Tests that `sendMessage` can be called twice and that the nonce increments - /// correctly. + /// @notice Tests that `sendMessage` can be called twice and that the nonce increments correctly. function test_sendMessage_twice_succeeds() external { uint256 nonce = l2CrossDomainMessenger.messageNonce(); l2CrossDomainMessenger.sendMessage(recipient, hex"aa", uint32(500_000)); l2CrossDomainMessenger.sendMessage(recipient, hex"aa", uint32(500_000)); - // the nonce increments for each message sent assertEq(nonce + 2, l2CrossDomainMessenger.messageNonce()); } } diff --git a/packages/contracts-bedrock/test/dispute/DisputeGameFactory.t.sol b/packages/contracts-bedrock/test/dispute/DisputeGameFactory.t.sol index 186761a1855..9a87ff81a73 100644 --- a/packages/contracts-bedrock/test/dispute/DisputeGameFactory.t.sol +++ b/packages/contracts-bedrock/test/dispute/DisputeGameFactory.t.sol @@ -18,8 +18,10 @@ import { IDisputeGame } from "interfaces/dispute/IDisputeGame.sol"; import { IProxyAdminOwnedBase } from "interfaces/L1/IProxyAdminOwnedBase.sol"; import { IPreimageOracle } from "interfaces/cannon/IPreimageOracle.sol"; import { IFaultDisputeGame } from "interfaces/dispute/IFaultDisputeGame.sol"; +import { IFaultDisputeGameV2 } from "interfaces/dispute/v2/IFaultDisputeGameV2.sol"; import { ISuperFaultDisputeGame } from "interfaces/dispute/ISuperFaultDisputeGame.sol"; import { IPermissionedDisputeGame } from "interfaces/dispute/IPermissionedDisputeGame.sol"; +import { IPermissionedDisputeGameV2 } from "interfaces/dispute/v2/IPermissionedDisputeGameV2.sol"; import { ISuperPermissionedDisputeGame } from "interfaces/dispute/ISuperPermissionedDisputeGame.sol"; // Mocks import { AlphabetVM } from "test/mocks/AlphabetVM.sol"; @@ -50,8 +52,11 @@ contract DisputeGameFactory_TestInit is CommonTest { event DisputeGameCreated(address indexed disputeProxy, GameType indexed gameType, Claim indexed rootClaim); event ImplementationSet(address indexed impl, GameType indexed gameType); + event ImplementationArgsSet(GameType indexed gameType, bytes args); event InitBondUpdated(GameType indexed gameType, uint256 indexed newBond); + uint256 l2ChainId = 111; + function setUp() public virtual override { super.setUp(); fakeClone = new DisputeGameFactory_FakeClone_Harness(); @@ -97,6 +102,20 @@ contract DisputeGameFactory_TestInit is CommonTest { }); } + function _getGameConstructorParamsV2(GameType _gameType) + internal + pure + returns (IFaultDisputeGameV2.GameConstructorParams memory params_) + { + return IFaultDisputeGameV2.GameConstructorParams({ + gameType: _gameType, + maxGameDepth: 2 ** 3, + splitDepth: 2 ** 2, + clockExtension: Duration.wrap(3 hours), + maxClockDuration: Duration.wrap(3.5 days) + }); + } + function _getSuperGameConstructorParams( Claim _absolutePrestate, AlphabetVM _vm, @@ -110,9 +129,13 @@ contract DisputeGameFactory_TestInit is CommonTest { params_ = abi.decode(args, (ISuperFaultDisputeGame.GameConstructorParams)); } - function _setGame(address _gameImpl, GameType _gameType) internal { + function _setGame(address _gameImpl, GameType _gameType, bytes memory _implArgs) internal { vm.startPrank(disputeGameFactory.owner()); - disputeGameFactory.setImplementation(_gameType, IDisputeGame(_gameImpl)); + if (_implArgs.length > 0) { + disputeGameFactory.setImplementation(_gameType, IDisputeGame(_gameImpl), _implArgs); + } else { + disputeGameFactory.setImplementation(_gameType, IDisputeGame(_gameImpl)); + } disputeGameFactory.setInitBond(_gameType, 0.08 ether); vm.stopPrank(); } @@ -134,7 +157,7 @@ contract DisputeGameFactory_TestInit is CommonTest { ) }); - _setGame(gameImpl_, GameTypes.SUPER_CANNON); + _setGame(gameImpl_, GameTypes.SUPER_CANNON, ""); } /// @notice Sets up a super permissioned game implementation @@ -162,7 +185,7 @@ contract DisputeGameFactory_TestInit is CommonTest { ) }); - _setGame(gameImpl_, GameTypes.SUPER_PERMISSIONED_CANNON); + _setGame(gameImpl_, GameTypes.SUPER_PERMISSIONED_CANNON, ""); } /// @notice Sets up a fault game implementation @@ -180,7 +203,32 @@ contract DisputeGameFactory_TestInit is CommonTest { ) }); - _setGame(gameImpl_, GameTypes.CANNON); + _setGame(gameImpl_, GameTypes.CANNON, ""); + } + + /// @notice Sets up a fault game v2 implementation + function setupFaultDisputeGameV2(Claim _absolutePrestate) + internal + returns (address gameImpl_, AlphabetVM vm_, IPreimageOracle preimageOracle_) + { + (vm_, preimageOracle_) = _createVM(_absolutePrestate); + gameImpl_ = DeployUtils.create1({ + _name: "FaultDisputeGameV2", + _args: DeployUtils.encodeConstructor( + abi.encodeCall(IFaultDisputeGameV2.__constructor__, (_getGameConstructorParamsV2(GameTypes.CANNON))) + ) + }); + + // Encode the implementation args for CWIA (tightly packed) + bytes memory implArgs = abi.encodePacked( + _absolutePrestate, // 32 bytes + vm_, // 20 bytes + anchorStateRegistry, // 20 bytes + delayedWeth, // 20 bytes + l2ChainId // 32 bytes (l2ChainId) + ); + + _setGame(gameImpl_, GameTypes.CANNON, implArgs); } function setupPermissionedDisputeGame( @@ -206,7 +254,44 @@ contract DisputeGameFactory_TestInit is CommonTest { ) }); - _setGame(gameImpl_, GameTypes.PERMISSIONED_CANNON); + _setGame(gameImpl_, GameTypes.PERMISSIONED_CANNON, ""); + } + + function changeClaimStatus(Claim _claim, VMStatus _status) public pure returns (Claim out_) { + assembly { + out_ := or(and(not(shl(248, 0xFF)), _claim), shl(248, _status)) + } + } + + function setupPermissionedDisputeGameV2( + Claim _absolutePrestate, + address _proposer, + address _challenger + ) + internal + returns (address gameImpl_, AlphabetVM vm_, IPreimageOracle preimageOracle_) + { + (vm_, preimageOracle_) = _createVM(_absolutePrestate); + gameImpl_ = DeployUtils.create1({ + _name: "PermissionedDisputeGameV2", + _args: DeployUtils.encodeConstructor( + abi.encodeCall( + IPermissionedDisputeGameV2.__constructor__, + (_getGameConstructorParamsV2(GameTypes.PERMISSIONED_CANNON), _proposer, _challenger) + ) + ) + }); + + // Encode the implementation args for CWIA (tightly packed) + bytes memory implArgs = abi.encodePacked( + _absolutePrestate, // 32 bytes + vm_, // 20 bytes + anchorStateRegistry, // 20 bytes + delayedWeth, // 20 bytes + l2ChainId // 32 bytes (l2ChainId) + ); + + _setGame(gameImpl_, GameTypes.PERMISSIONED_CANNON, implArgs); } } @@ -375,10 +460,45 @@ contract DisputeGameFactory_Create_Test is DisputeGameFactory_TestInit { disputeGameFactory.create{ value: bondAmount }(gt, rootClaim, extraData); } - function changeClaimStatus(Claim _claim, VMStatus _status) public pure returns (Claim out_) { - assembly { - out_ := or(and(not(shl(248, 0xFF)), _claim), shl(248, _status)) - } + function test_create_implArgs_succeeds() public { + Claim absolutePrestate = Claim.wrap(bytes32(hex"dead")); + (, AlphabetVM vm_,) = setupFaultDisputeGameV2(absolutePrestate); + + Claim rootClaim = changeClaimStatus(Claim.wrap(bytes32(hex"beef")), VMStatuses.INVALID); + // extraData should contain the l2BlockNumber as first 32 bytes + bytes memory extraData = bytes.concat(bytes32(uint256(type(uint32).max))); + + uint256 bondAmount = disputeGameFactory.initBonds(GameTypes.CANNON); + vm.deal(address(this), bondAmount); + + // Create the game + IDisputeGame proxy = disputeGameFactory.create{ value: bondAmount }(GameTypes.CANNON, rootClaim, extraData); + + // Verify the game was created and stored + (IDisputeGame game, Timestamp timestamp) = disputeGameFactory.games(GameTypes.CANNON, rootClaim, extraData); + + assertEq(address(game), address(proxy)); + assertEq(Timestamp.unwrap(timestamp), block.timestamp); + + // Verify the game has the correct parameters via CWIA + IFaultDisputeGameV2 gameV2 = IFaultDisputeGameV2(address(proxy)); + + // Test CWIA getters + assertEq(Claim.unwrap(gameV2.absolutePrestate()), Claim.unwrap(absolutePrestate)); + assertEq(Claim.unwrap(gameV2.rootClaim()), Claim.unwrap(rootClaim)); + assertEq(gameV2.extraData(), extraData); + assertEq(gameV2.l2ChainId(), l2ChainId); + assertEq(address(gameV2.gameCreator()), address(this)); + assertEq(gameV2.l2BlockNumber(), uint256(type(uint32).max)); + assertEq(address(gameV2.vm()), address(vm_)); + assertEq(address(gameV2.weth()), address(delayedWeth)); + assertEq(address(gameV2.anchorStateRegistry()), address(anchorStateRegistry)); + // Test Constructor args + assertEq(GameType.unwrap(gameV2.gameType()), GameType.unwrap(GameTypes.CANNON)); + assertEq(gameV2.maxGameDepth(), 2 ** 3); + assertEq(gameV2.splitDepth(), 2 ** 2); + assertEq(Duration.unwrap(gameV2.clockExtension()), Duration.unwrap(Duration.wrap(3 hours))); + assertEq(Duration.unwrap(gameV2.maxClockDuration()), Duration.unwrap(Duration.wrap(3.5 days))); } } @@ -405,6 +525,48 @@ contract DisputeGameFactory_SetImplementation_Test is DisputeGameFactory_TestIni vm.expectRevert("Ownable: caller is not the owner"); disputeGameFactory.setImplementation(GameTypes.CANNON, IDisputeGame(address(1))); } + + /// @notice Tests that the `setImplementation` function with args properly sets the implementation + /// and args for a given `GameType`. + function test_setImplementation_withArgs_succeeds() public { + address fakeGame = address(1); + Claim absolutePrestate = Claim.wrap(bytes32(hex"dead")); + AlphabetVM vm_; + IPreimageOracle preimageOracle_; + (vm_, preimageOracle_) = _createVM(absolutePrestate); + uint256 l2ChainId = 111; + + bytes memory args = abi.encodePacked( + absolutePrestate, // 32 bytes + vm_, // 20 bytes + anchorStateRegistry, // 20 bytes + delayedWeth, // 20 bytes + l2ChainId // 32 bytes (l2ChainId) + ); + + vm.expectEmit(true, true, true, true, address(disputeGameFactory)); + emit ImplementationSet(address(1), GameTypes.CANNON); + vm.expectEmit(true, true, true, true, address(disputeGameFactory)); + emit ImplementationArgsSet(GameTypes.CANNON, args); + + // Set the implementation and args for the `GameTypes.CANNON` enum value. + disputeGameFactory.setImplementation(GameTypes.CANNON, IDisputeGame(fakeGame), args); + + // Ensure that the implementation for the `GameTypes.CANNON` enum value is set. + assertEq(address(disputeGameFactory.gameImpls(GameTypes.CANNON)), address(1)); + // Ensure that the args for the `GameTypes.CANNON` enum value are set. + assertEq(disputeGameFactory.gameArgs(GameTypes.CANNON), args); + } + + /// @notice Tests that the `setImplementation` function with args reverts when called by a non-owner. + function test_setImplementationArgs_notOwner_reverts() public { + bytes memory args = abi.encode(uint256(123), address(0xdead)); + + // Ensure that the `setImplementation` function reverts when called by a non-owner. + vm.prank(address(0)); + vm.expectRevert("Ownable: caller is not the owner"); + disputeGameFactory.setImplementation(GameTypes.CANNON, IDisputeGame(address(1)), args); + } } /// @title DisputeGameFactory_SetInitBond_Test diff --git a/packages/contracts-bedrock/test/dispute/v2/FaultDisputeGameV2.t.sol b/packages/contracts-bedrock/test/dispute/v2/FaultDisputeGameV2.t.sol new file mode 100644 index 00000000000..9667f9c0674 --- /dev/null +++ b/packages/contracts-bedrock/test/dispute/v2/FaultDisputeGameV2.t.sol @@ -0,0 +1,3152 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.15; + +// Testing +import { Vm } from "forge-std/Vm.sol"; +import { DisputeGameFactory_TestInit } from "test/dispute/DisputeGameFactory.t.sol"; +import { AlphabetVM } from "test/mocks/AlphabetVM.sol"; +import { stdError } from "forge-std/StdError.sol"; + +// Scripts +import { DeployUtils } from "scripts/libraries/DeployUtils.sol"; + +// Contracts +import { DisputeActor, HonestDisputeActor } from "test/actors/FaultDisputeActors.sol"; + +// Libraries +import { Types } from "src/libraries/Types.sol"; +import { Hashing } from "src/libraries/Hashing.sol"; +import { RLPWriter } from "src/libraries/rlp/RLPWriter.sol"; +import { LibClock } from "src/dispute/lib/LibUDT.sol"; +import { LibPosition } from "src/dispute/lib/LibPosition.sol"; +import "src/dispute/lib/Types.sol"; +import "src/dispute/lib/Errors.sol"; + +// Interfaces +import { IDisputeGame } from "interfaces/dispute/IDisputeGame.sol"; +import { IPreimageOracle } from "interfaces/dispute/IBigStepper.sol"; +import { IAnchorStateRegistry } from "interfaces/dispute/IAnchorStateRegistry.sol"; +import { IFaultDisputeGame } from "interfaces/dispute/IFaultDisputeGame.sol"; +import { IFaultDisputeGameV2 } from "interfaces/dispute/v2/IFaultDisputeGameV2.sol"; + +contract ClaimCreditReenter { + Vm internal immutable vm; + IFaultDisputeGameV2 internal immutable GAME; + uint256 public numCalls; + + constructor(IFaultDisputeGameV2 _gameProxy, Vm _vm) { + GAME = _gameProxy; + vm = _vm; + } + + function claimCredit(address _recipient) public { + numCalls += 1; + if (numCalls > 1) { + vm.expectRevert(NoCreditToClaim.selector); + } + GAME.claimCredit(_recipient); + } + + receive() external payable { + if (numCalls == 5) { + return; + } + claimCredit(address(this)); + } +} + +/// @notice Helper to change the VM status byte of a claim. +function _changeClaimStatus(Claim _claim, VMStatus _status) pure returns (Claim out_) { + assembly { + out_ := or(and(not(shl(248, 0xFF)), _claim), shl(248, _status)) + } +} + +/// @title BaseFaultDisputeGameV2_TestInit +/// @notice Base test initializer that can be used by other contracts outside of this test suite. +contract BaseFaultDisputeGameV2_TestInit is DisputeGameFactory_TestInit { + /// @dev The type of the game being tested. + GameType internal immutable GAME_TYPE = GameTypes.CANNON; + + /// @dev The initial bond for the game. + uint256 internal initBond; + + /// @dev The implementation of the game. + IFaultDisputeGameV2 internal gameImpl; + /// @dev The `Clone` proxy of the game. + IFaultDisputeGameV2 internal gameProxy; + + /// @dev The extra data passed to the game for initialization. + bytes internal extraData; + + event Move(uint256 indexed parentIndex, Claim indexed pivot, address indexed claimant); + event GameClosed(BondDistributionMode bondDistributionMode); + + event ReceiveETH(uint256 amount); + + function init(Claim rootClaim, Claim absolutePrestate, uint256 l2BlockNumber) public { + // Set the time to a realistic date. + if (!isForkTest()) { + vm.warp(1690906994); + } + + // Set the extra data for the game creation + extraData = abi.encode(l2BlockNumber); + + (address _impl, AlphabetVM _vm,) = setupFaultDisputeGameV2(absolutePrestate); + gameImpl = IFaultDisputeGameV2(_impl); + + // Set the init bond for the given game type. + initBond = disputeGameFactory.initBonds(GAME_TYPE); + + // Warp ahead of the game retirement timestamp if needed. + if (block.timestamp <= anchorStateRegistry.retirementTimestamp()) { + vm.warp(anchorStateRegistry.retirementTimestamp() + 1); + } + + // Create a new game. + gameProxy = IFaultDisputeGameV2( + payable(address(disputeGameFactory.create{ value: initBond }(GAME_TYPE, rootClaim, extraData))) + ); + + // Check immutables + assertEq(gameProxy.gameType().raw(), GAME_TYPE.raw()); + assertEq(gameProxy.absolutePrestate().raw(), absolutePrestate.raw()); + assertEq(gameProxy.maxGameDepth(), 2 ** 3); + assertEq(gameProxy.splitDepth(), 2 ** 2); + assertEq(gameProxy.clockExtension().raw(), 3 hours); + assertEq(gameProxy.maxClockDuration().raw(), 3.5 days); + assertEq(address(gameProxy.weth()), address(delayedWeth)); + assertEq(address(gameProxy.anchorStateRegistry()), address(anchorStateRegistry)); + assertEq(address(gameProxy.vm()), address(_vm)); + assertEq(address(gameProxy.gameCreator()), address(this)); + assertEq(gameProxy.l2ChainId(), l2ChainId); + + // Label the proxy + vm.label(address(gameProxy), "FaultDisputeGame_Clone"); + } + + fallback() external payable { } + + receive() external payable { } +} + +/// @title FaultDisputeGameV2_TestInit +/// @notice Reusable test initialization for `FaultDisputeGame` tests. +contract FaultDisputeGameV2_TestInit is BaseFaultDisputeGameV2_TestInit { + /// @dev The root claim of the game. + Claim internal ROOT_CLAIM; + /// @dev An arbitrary root claim for testing. + Claim internal arbitaryRootClaim = Claim.wrap(bytes32(uint256(123))); + + /// @dev The preimage of the absolute prestate claim + bytes internal absolutePrestateData; + /// @dev The absolute prestate of the trace. + Claim internal absolutePrestate; + /// @dev A valid l2BlockNumber that comes after the current anchor root block. + uint256 internal validL2BlockNumber; + + function setUp() public virtual override { + absolutePrestateData = abi.encode(0); + absolutePrestate = _changeClaimStatus(Claim.wrap(keccak256(absolutePrestateData)), VMStatuses.UNFINISHED); + + super.setUp(); + + // Get the actual anchor roots + (Hash root, uint256 l2Bn) = anchorStateRegistry.getAnchorRoot(); + validL2BlockNumber = l2Bn + 1; + + ROOT_CLAIM = Claim.wrap(Hash.unwrap(root)); + + super.init({ rootClaim: ROOT_CLAIM, absolutePrestate: absolutePrestate, l2BlockNumber: validL2BlockNumber }); + } + + /// @notice Helper to generate a mock RLP encoded header (with only a real block number) & an + /// output root proof. + function _generateOutputRootProof( + bytes32 _storageRoot, + bytes32 _withdrawalRoot, + bytes memory _l2BlockNumber + ) + internal + pure + returns (Types.OutputRootProof memory proof_, bytes32 root_, bytes memory rlp_) + { + // L2 Block header + bytes[] memory rawHeaderRLP = new bytes[](9); + rawHeaderRLP[0] = hex"83FACADE"; + rawHeaderRLP[1] = hex"83FACADE"; + rawHeaderRLP[2] = hex"83FACADE"; + rawHeaderRLP[3] = hex"83FACADE"; + rawHeaderRLP[4] = hex"83FACADE"; + rawHeaderRLP[5] = hex"83FACADE"; + rawHeaderRLP[6] = hex"83FACADE"; + rawHeaderRLP[7] = hex"83FACADE"; + rawHeaderRLP[8] = RLPWriter.writeBytes(_l2BlockNumber); + rlp_ = RLPWriter.writeList(rawHeaderRLP); + + // Output root + proof_ = Types.OutputRootProof({ + version: 0, + stateRoot: _storageRoot, + messagePasserStorageRoot: _withdrawalRoot, + latestBlockhash: keccak256(rlp_) + }); + root_ = Hashing.hashOutputRootProof(proof_); + } + + /// @notice Helper to get the required bond for the given claim index. + function _getRequiredBond(uint256 _claimIndex) internal view returns (uint256 bond_) { + (,,,,, Position parent,) = gameProxy.claimData(_claimIndex); + Position pos = parent.move(true); + bond_ = gameProxy.getRequiredBond(pos); + } + + /// @notice Helper to return a pseudo-random claim + function _dummyClaim() internal view returns (Claim) { + return Claim.wrap(keccak256(abi.encode(gasleft()))); + } + + /// @notice Helper to get the localized key for an identifier in the context of the game proxy. + function _getKey(uint256 _ident, bytes32 _localContext) internal view returns (bytes32) { + bytes32 h = keccak256(abi.encode(_ident | (1 << 248), address(gameProxy), _localContext)); + return bytes32((uint256(h) & ~uint256(0xFF << 248)) | (1 << 248)); + } +} + +/// @title FaultDisputeGame_Version_Test +/// @notice Tests the `version` function of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_Version_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that the game's version function returns a string. + function test_version_works() public view { + assertTrue(bytes(gameProxy.version()).length > 0); + } +} + +/// @title FaultDisputeGame_Constructor_Test +/// @notice Tests the constructor of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_Constructor_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that the constructor of the `FaultDisputeGame` reverts when the + /// `MAX_GAME_DEPTH` parameter is greater than `LibPosition.MAX_POSITION_BITLEN - 1`. + function testFuzz_constructor_maxDepthTooLarge_reverts(uint256 _maxGameDepth) public { + _maxGameDepth = bound(_maxGameDepth, LibPosition.MAX_POSITION_BITLEN, type(uint256).max - 1); + vm.expectRevert(MaxDepthTooLarge.selector); + DeployUtils.create1({ + _name: "FaultDisputeGameV2", + _args: DeployUtils.encodeConstructor( + abi.encodeCall( + IFaultDisputeGameV2.__constructor__, + ( + IFaultDisputeGameV2.GameConstructorParams({ + gameType: GAME_TYPE, + maxGameDepth: _maxGameDepth, + splitDepth: _maxGameDepth + 1, + clockExtension: Duration.wrap(3 hours), + maxClockDuration: Duration.wrap(3.5 days) + }) + ) + ) + ) + }); + } + + /// @notice Tests that the constructor of the `FaultDisputeGame` reverts when the `_splitDepth` + /// parameter is greater than or equal to the `MAX_GAME_DEPTH` + function testFuzz_constructor_invalidSplitDepth_reverts(uint256 _splitDepth) public { + uint256 maxGameDepth = 2 ** 3; + _splitDepth = bound(_splitDepth, maxGameDepth - 1, type(uint256).max); + vm.expectRevert(InvalidSplitDepth.selector); + DeployUtils.create1({ + _name: "FaultDisputeGameV2", + _args: DeployUtils.encodeConstructor( + abi.encodeCall( + IFaultDisputeGameV2.__constructor__, + ( + IFaultDisputeGameV2.GameConstructorParams({ + gameType: GAME_TYPE, + maxGameDepth: maxGameDepth, + splitDepth: _splitDepth, + clockExtension: Duration.wrap(3 hours), + maxClockDuration: Duration.wrap(3.5 days) + }) + ) + ) + ) + }); + } + + /// @notice Tests that the constructor of the `FaultDisputeGame` reverts when the `_splitDepth` + /// parameter is less than the minimum split depth (currently 2). + function testFuzz_constructor_lowSplitDepth_reverts(uint256 _splitDepth) public { + uint256 minSplitDepth = 2; + _splitDepth = bound(_splitDepth, 0, minSplitDepth - 1); + vm.expectRevert(InvalidSplitDepth.selector); + DeployUtils.create1({ + _name: "FaultDisputeGameV2", + _args: DeployUtils.encodeConstructor( + abi.encodeCall( + IFaultDisputeGameV2.__constructor__, + ( + IFaultDisputeGameV2.GameConstructorParams({ + gameType: GAME_TYPE, + maxGameDepth: 2 ** 3, + splitDepth: _splitDepth, + clockExtension: Duration.wrap(3 hours), + maxClockDuration: Duration.wrap(3.5 days) + }) + ) + ) + ) + }); + } + + /// @notice Tests that the constructor of the `FaultDisputeGame` reverts when clock + /// extension * 2 is greater than the max clock duration. + function testFuzz_constructor_clockExtensionTooLong_reverts( + uint64 _maxClockDuration, + uint64 _clockExtension + ) + public + { + // Force the clock extension * 2 to be greater than the max clock duration, but keep things + // within bounds of the uint64 type. + _maxClockDuration = uint64(bound(_maxClockDuration, 0, type(uint64).max / 2 - 1)); + _clockExtension = uint64(bound(_clockExtension, _maxClockDuration / 2 + 1, type(uint64).max / 2)); + + vm.expectRevert(InvalidClockExtension.selector); + DeployUtils.create1({ + _name: "FaultDisputeGameV2", + _args: DeployUtils.encodeConstructor( + abi.encodeCall( + IFaultDisputeGameV2.__constructor__, + ( + IFaultDisputeGameV2.GameConstructorParams({ + gameType: GAME_TYPE, + maxGameDepth: 16, + splitDepth: 8, + clockExtension: Duration.wrap(_clockExtension), + maxClockDuration: Duration.wrap(_maxClockDuration) + }) + ) + ) + ) + }); + } + + /// @notice Tests that the constructor of the `FaultDisputeGame` reverts when the `_gameType` + /// parameter is set to the reserved `type(uint32).max` game type. + function test_constructor_reservedGameType_reverts() public { + vm.expectRevert(ReservedGameType.selector); + DeployUtils.create1({ + _name: "FaultDisputeGameV2", + _args: DeployUtils.encodeConstructor( + abi.encodeCall( + IFaultDisputeGameV2.__constructor__, + ( + IFaultDisputeGameV2.GameConstructorParams({ + gameType: GameType.wrap(type(uint32).max), + maxGameDepth: 16, + splitDepth: 8, + clockExtension: Duration.wrap(3 hours), + maxClockDuration: Duration.wrap(3.5 days) + }) + ) + ) + ) + }); + } +} + +/// @title FaultDisputeGame_Initialize_Test +/// @notice Tests the initialization of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_Initialize_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that the game cannot be initialized with an output root that commits to <= + /// the configured starting block number + function testFuzz_initialize_cannotProposeGenesis_reverts(uint256 _blockNumber) public { + (, uint256 startingL2Block) = gameProxy.startingOutputRoot(); + _blockNumber = bound(_blockNumber, 0, startingL2Block); + + Claim claim = _dummyClaim(); + vm.expectRevert(abi.encodeWithSelector(UnexpectedRootClaim.selector, claim)); + gameProxy = IFaultDisputeGameV2( + payable(address(disputeGameFactory.create{ value: initBond }(GAME_TYPE, claim, abi.encode(_blockNumber)))) + ); + } + + /// @notice Tests that the proxy receives ETH from the dispute game factory. + function test_initialize_receivesETH_succeeds() public { + uint256 _value = disputeGameFactory.initBonds(GAME_TYPE); + vm.deal(address(this), _value); + + assertEq(address(gameProxy).balance, 0); + gameProxy = IFaultDisputeGameV2( + payable( + address( + disputeGameFactory.create{ value: _value }( + GAME_TYPE, arbitaryRootClaim, abi.encode(validL2BlockNumber) + ) + ) + ) + ); + assertEq(address(gameProxy).balance, 0); + assertEq(delayedWeth.balanceOf(address(gameProxy)), _value); + } + + /// @notice Tests that the game cannot be initialized with incorrect CWIA calldata length + /// (must be exactly 246 bytes) + function test_initialize_wrongCalldataLength_reverts(uint256 _extraDataLen) public { + // The `DisputeGameFactory` will pack the root claim and the extra data into a single + // array, which is enforced to be at least 64 bytes long. + // We bound the upper end to 23.5KB to ensure that the minimal proxy never surpasses the + // contract size limit in this test, as CWIA proxies store the immutable args in their + // bytecode. + // [0 bytes, 31 bytes] u [33 bytes, 23.5 KB] + _extraDataLen = bound(_extraDataLen, 0, 23_500); + if (_extraDataLen == 32) { + _extraDataLen++; + } + bytes memory _extraData = new bytes(_extraDataLen); + + // Assign the first 32 bytes in `extraData` to a valid L2 block number passed the starting + // block. + (, uint256 startingL2Block) = gameProxy.startingOutputRoot(); + assembly { + mstore(add(_extraData, 0x20), add(startingL2Block, 1)) + } + + Claim claim = _dummyClaim(); + vm.expectRevert(IFaultDisputeGameV2.BadExtraData.selector); + gameProxy = IFaultDisputeGameV2( + payable(address(disputeGameFactory.create{ value: initBond }(GAME_TYPE, claim, _extraData))) + ); + } + + /// @notice Tests that the game is initialized with the correct data. + function test_initialize_correctData_succeeds() public view { + // Assert that the root claim is initialized correctly. + ( + uint32 parentIndex, + address counteredBy, + address claimant, + uint128 bond, + Claim claim, + Position position, + Clock clock + ) = gameProxy.claimData(0); + assertEq(parentIndex, type(uint32).max); + assertEq(counteredBy, address(0)); + assertEq(claimant, address(this)); + assertEq(bond, initBond); + assertEq(claim.raw(), ROOT_CLAIM.raw()); + assertEq(position.raw(), 1); + assertEq(clock.raw(), LibClock.wrap(Duration.wrap(0), Timestamp.wrap(uint64(block.timestamp))).raw()); + + // Assert that the `createdAt` timestamp is correct. + assertEq(gameProxy.createdAt().raw(), block.timestamp); + + // Assert that the blockhash provided is correct. + assertEq(gameProxy.l1Head().raw(), blockhash(block.number - 1)); + } + + /// @notice Tests that the game cannot be initialized when the anchor root is not found. + function test_initialize_anchorRootNotFound_reverts() public { + // Mock the AnchorStateRegistry to return a zero root. + vm.mockCall( + address(anchorStateRegistry), + abi.encodeCall(IAnchorStateRegistry.getAnchorRoot, ()), + abi.encode(Hash.wrap(bytes32(0)), 0) + ); + + // Creation should fail. + vm.expectRevert(AnchorRootNotFound.selector); + gameProxy = IFaultDisputeGameV2( + payable( + address(disputeGameFactory.create{ value: initBond }(GAME_TYPE, _dummyClaim(), new bytes(uint256(32)))) + ) + ); + } + + /// @notice Tests that the game cannot be initialized twice. + function test_initialize_onlyOnce_succeeds() public { + vm.expectRevert(AlreadyInitialized.selector); + gameProxy.initialize(); + } + + /// @notice Tests that initialization reverts when oracle challenge period is too large. + /// @dev V2 validates oracle challenge period during initialize(), not constructor + function testFuzz_initialize_oracleChallengePeriodTooLarge_reverts(uint256 _challengePeriod) public { + // Bound to values larger than uint64.max + _challengePeriod = bound(_challengePeriod, uint256(type(uint64).max) + 1, type(uint256).max); + + // Get the current AlphabetVM from the setup + (, AlphabetVM vm_,) = setupFaultDisputeGameV2(absolutePrestate); + + // Mock the VM's oracle to return invalid challenge period + vm.mockCall( + address(vm_.oracle()), abi.encodeCall(IPreimageOracle.challengePeriod, ()), abi.encode(_challengePeriod) + ); + + // Expect the initialize call to revert with InvalidChallengePeriod + vm.expectRevert(InvalidChallengePeriod.selector); + + // Create game via factory - initialize() is called automatically and should revert + gameProxy = IFaultDisputeGameV2( + payable( + address( + disputeGameFactory.create{ value: initBond }( + GAME_TYPE, _dummyClaim(), abi.encode(validL2BlockNumber) + ) + ) + ) + ); + } +} + +/// @title FaultDisputeGame_Step_Test +/// @notice Tests the step functionality of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_Step_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that a claim cannot be stepped against twice. + function test_step_duplicateStep_reverts() public { + // Give the test contract some ether + vm.deal(address(this), 1000 ether); + + // Make claims all the way down the tree. + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: _getRequiredBond(1) }(disputed, 1, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.attack{ value: _getRequiredBond(2) }(disputed, 2, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(3); + gameProxy.attack{ value: _getRequiredBond(3) }(disputed, 3, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.attack{ value: _getRequiredBond(4) }(disputed, 4, _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC)); + (,,,, disputed,,) = gameProxy.claimData(5); + gameProxy.attack{ value: _getRequiredBond(5) }(disputed, 5, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(6); + gameProxy.attack{ value: _getRequiredBond(6) }(disputed, 6, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(7); + gameProxy.attack{ value: _getRequiredBond(7) }(disputed, 7, _dummyClaim()); + gameProxy.addLocalData(LocalPreimageKey.DISPUTED_L2_BLOCK_NUMBER, 8, 0); + gameProxy.step(8, true, absolutePrestateData, hex""); + + vm.expectRevert(DuplicateStep.selector); + gameProxy.step(8, true, absolutePrestateData, hex""); + } + + /// @notice Tests that successfully step with true attacking claim when there is a true defend + /// claim(claim5) in the middle of the dispute game. + function test_stepAttackDummyClaim_defendTrueClaimInTheMiddle_succeeds() public { + // Give the test contract some ether + vm.deal(address(this), 1000 ether); + + // Make claims all the way down the tree. + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: _getRequiredBond(1) }(disputed, 1, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.attack{ value: _getRequiredBond(2) }(disputed, 2, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(3); + gameProxy.attack{ value: _getRequiredBond(3) }(disputed, 3, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.attack{ value: _getRequiredBond(4) }(disputed, 4, _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC)); + bytes memory claimData5 = abi.encode(5, 5); + Claim claim5 = Claim.wrap(keccak256(claimData5)); + (,,,, disputed,,) = gameProxy.claimData(5); + gameProxy.attack{ value: _getRequiredBond(5) }(disputed, 5, claim5); + (,,,, disputed,,) = gameProxy.claimData(6); + gameProxy.defend{ value: _getRequiredBond(6) }(disputed, 6, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(7); + gameProxy.attack{ value: _getRequiredBond(7) }(disputed, 7, _dummyClaim()); + gameProxy.addLocalData(LocalPreimageKey.DISPUTED_L2_BLOCK_NUMBER, 8, 0); + gameProxy.step(8, true, claimData5, hex""); + } + + /// @notice Tests that successfully step with true defend claim when there is a true defend + /// claim(claim7) in the middle of the dispute game. + function test_stepDefendDummyClaim_defendTrueClaimInTheMiddle_succeeds() public { + // Give the test contract some ether + vm.deal(address(this), 1000 ether); + + // Make claims all the way down the tree. + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: _getRequiredBond(1) }(disputed, 1, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.attack{ value: _getRequiredBond(2) }(disputed, 2, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(3); + gameProxy.attack{ value: _getRequiredBond(3) }(disputed, 3, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.attack{ value: _getRequiredBond(4) }(disputed, 4, _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC)); + + bytes memory claimData7 = abi.encode(7, 7); + Claim postState_ = Claim.wrap(gameProxy.vm().step(claimData7, hex"", bytes32(0))); + + (,,,, disputed,,) = gameProxy.claimData(5); + gameProxy.attack{ value: _getRequiredBond(5) }(disputed, 5, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(6); + gameProxy.defend{ value: _getRequiredBond(6) }(disputed, 6, postState_); + (,,,, disputed,,) = gameProxy.claimData(7); + + gameProxy.attack{ value: _getRequiredBond(7) }(disputed, 7, Claim.wrap(keccak256(claimData7))); + gameProxy.addLocalData(LocalPreimageKey.DISPUTED_L2_BLOCK_NUMBER, 8, 0); + gameProxy.step(8, false, claimData7, hex""); + } + + /// @notice Tests that step reverts with false attacking claim when there is a true defend + /// claim(claim5) in the middle of the dispute game. + function test_stepAttackTrueClaim_defendTrueClaimInTheMiddle_reverts() public { + // Give the test contract some ether + vm.deal(address(this), 1000 ether); + + // Make claims all the way down the tree. + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: _getRequiredBond(1) }(disputed, 1, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.attack{ value: _getRequiredBond(2) }(disputed, 2, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(3); + gameProxy.attack{ value: _getRequiredBond(3) }(disputed, 3, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.attack{ value: _getRequiredBond(4) }(disputed, 4, _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC)); + bytes memory claimData5 = abi.encode(5, 5); + Claim claim5 = Claim.wrap(keccak256(claimData5)); + (,,,, disputed,,) = gameProxy.claimData(5); + gameProxy.attack{ value: _getRequiredBond(5) }(disputed, 5, claim5); + (,,,, disputed,,) = gameProxy.claimData(6); + gameProxy.defend{ value: _getRequiredBond(6) }(disputed, 6, _dummyClaim()); + Claim postState_ = Claim.wrap(gameProxy.vm().step(claimData5, hex"", bytes32(0))); + (,,,, disputed,,) = gameProxy.claimData(7); + gameProxy.attack{ value: _getRequiredBond(7) }(disputed, 7, postState_); + gameProxy.addLocalData(LocalPreimageKey.DISPUTED_L2_BLOCK_NUMBER, 8, 0); + + vm.expectRevert(ValidStep.selector); + gameProxy.step(8, true, claimData5, hex""); + } + + /// @notice Tests that step reverts with false defending claim when there is a true defend + /// claim(postState_) in the middle of the dispute game. + function test_stepDefendDummyClaim_defendTrueClaimInTheMiddle_reverts() public { + // Give the test contract some ether + vm.deal(address(this), 1000 ether); + + // Make claims all the way down the tree. + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: _getRequiredBond(1) }(disputed, 1, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.attack{ value: _getRequiredBond(2) }(disputed, 2, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(3); + gameProxy.attack{ value: _getRequiredBond(3) }(disputed, 3, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.attack{ value: _getRequiredBond(4) }(disputed, 4, _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC)); + + bytes memory claimData7 = abi.encode(5, 5); + Claim postState_ = Claim.wrap(gameProxy.vm().step(claimData7, hex"", bytes32(0))); + + (,,,, disputed,,) = gameProxy.claimData(5); + gameProxy.attack{ value: _getRequiredBond(5) }(disputed, 5, postState_); + (,,,, disputed,,) = gameProxy.claimData(6); + gameProxy.defend{ value: _getRequiredBond(6) }(disputed, 6, _dummyClaim()); + + bytes memory _dummyClaimData = abi.encode(gasleft(), gasleft()); + Claim dummyClaim7 = Claim.wrap(keccak256(_dummyClaimData)); + (,,,, disputed,,) = gameProxy.claimData(7); + gameProxy.attack{ value: _getRequiredBond(7) }(disputed, 7, dummyClaim7); + gameProxy.addLocalData(LocalPreimageKey.DISPUTED_L2_BLOCK_NUMBER, 8, 0); + vm.expectRevert(ValidStep.selector); + gameProxy.step(8, false, _dummyClaimData, hex""); + } + + /// @notice Tests that step reverts with true defending claim when there is a true defend + /// claim(postState_) in the middle of the dispute game. + function test_stepDefendTrueClaim_defendTrueClaimInTheMiddle_reverts() public { + // Give the test contract some ether + vm.deal(address(this), 1000 ether); + + // Make claims all the way down the tree. + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: _getRequiredBond(1) }(disputed, 1, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.attack{ value: _getRequiredBond(2) }(disputed, 2, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(3); + gameProxy.attack{ value: _getRequiredBond(3) }(disputed, 3, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.attack{ value: _getRequiredBond(4) }(disputed, 4, _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC)); + + bytes memory claimData7 = abi.encode(5, 5); + Claim claim7 = Claim.wrap(keccak256(claimData7)); + Claim postState_ = Claim.wrap(gameProxy.vm().step(claimData7, hex"", bytes32(0))); + + (,,,, disputed,,) = gameProxy.claimData(5); + gameProxy.attack{ value: _getRequiredBond(5) }(disputed, 5, postState_); + (,,,, disputed,,) = gameProxy.claimData(6); + gameProxy.defend{ value: _getRequiredBond(6) }(disputed, 6, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(7); + gameProxy.attack{ value: _getRequiredBond(7) }(disputed, 7, claim7); + gameProxy.addLocalData(LocalPreimageKey.DISPUTED_L2_BLOCK_NUMBER, 8, 0); + + vm.expectRevert(ValidStep.selector); + gameProxy.step(8, false, claimData7, hex""); + } +} + +/// @title FaultDisputeGame_Move_Test +/// @notice Tests the move functionality of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_Move_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that a move while the game status is not `IN_PROGRESS` causes the call to + /// revert with the `GameNotInProgress` error + function test_move_gameNotInProgress_reverts() public { + uint256 chalWins = uint256(GameStatus.CHALLENGER_WINS); + + // Replace the game status in storage. It exists in slot 0 at offset 16. + uint256 slot = uint256(vm.load(address(gameProxy), bytes32(0))); + uint256 offset = 16 << 3; + uint256 mask = 0xFF << offset; + // Replace the byte in the slot value with the challenger wins status. + slot = (slot & ~mask) | (chalWins << offset); + vm.store(address(gameProxy), bytes32(0), bytes32(slot)); + + // Ensure that the game status was properly updated. + GameStatus status = gameProxy.status(); + assertEq(uint256(status), chalWins); + + (,,,, Claim root,,) = gameProxy.claimData(0); + // Attempt to make a move. Should revert. + vm.expectRevert(GameNotInProgress.selector); + gameProxy.attack(root, 0, Claim.wrap(0)); + } + + /// @notice Tests that an attempt to defend the root claim reverts with the + /// `CannotDefendRootClaim` error. + function test_move_defendRoot_reverts() public { + (,,,, Claim root,,) = gameProxy.claimData(0); + vm.expectRevert(CannotDefendRootClaim.selector); + gameProxy.defend(root, 0, _dummyClaim()); + } + + /// @notice Tests that an attempt to move against a claim that does not exist reverts with the + /// `ParentDoesNotExist` error. + function test_move_nonExistentParent_reverts() public { + Claim claim = _dummyClaim(); + + // Expect an out of bounds revert for an attack + vm.expectRevert(stdError.indexOOBError); + gameProxy.attack(_dummyClaim(), 1, claim); + + // Expect an out of bounds revert for a defense + vm.expectRevert(stdError.indexOOBError); + gameProxy.defend(_dummyClaim(), 1, claim); + } + + /// @notice Tests that an attempt to move at the maximum game depth reverts with the + /// `GameDepthExceeded` error. + function test_move_gameDepthExceeded_reverts() public { + Claim claim = _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC); + + uint256 maxDepth = gameProxy.maxGameDepth(); + + for (uint256 i = 0; i <= maxDepth; i++) { + (,,,, Claim disputed,,) = gameProxy.claimData(i); + // At the max game depth, the `_move` function should revert with + // the `GameDepthExceeded` error. + if (i == maxDepth) { + vm.expectRevert(GameDepthExceeded.selector); + gameProxy.attack{ value: 100 ether }(disputed, i, claim); + } else { + gameProxy.attack{ value: _getRequiredBond(i) }(disputed, i, claim); + } + } + } + + /// @notice Tests that a move made after the clock time has exceeded reverts with the + /// `ClockTimeExceeded` error. + function test_move_clockTimeExceeded_reverts() public { + // Warp ahead past the clock time for the first move (3 1/2 days) + vm.warp(block.timestamp + 3 days + 12 hours + 1); + uint256 bond = _getRequiredBond(0); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + vm.expectRevert(ClockTimeExceeded.selector); + gameProxy.attack{ value: bond }(disputed, 0, _dummyClaim()); + } + + /// @notice Static unit test for the correctness of the chess clock incrementation. + function test_move_clockCorrectness_succeeds() public { + (,,,,,, Clock clock) = gameProxy.claimData(0); + assertEq(clock.raw(), LibClock.wrap(Duration.wrap(0), Timestamp.wrap(uint64(block.timestamp))).raw()); + + Claim claim = _dummyClaim(); + + vm.warp(block.timestamp + 15); + uint256 bond = _getRequiredBond(0); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: bond }(disputed, 0, claim); + (,,,,,, clock) = gameProxy.claimData(1); + assertEq(clock.raw(), LibClock.wrap(Duration.wrap(15), Timestamp.wrap(uint64(block.timestamp))).raw()); + + vm.warp(block.timestamp + 10); + bond = _getRequiredBond(1); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: bond }(disputed, 1, claim); + (,,,,,, clock) = gameProxy.claimData(2); + assertEq(clock.raw(), LibClock.wrap(Duration.wrap(10), Timestamp.wrap(uint64(block.timestamp))).raw()); + + // We are at the split depth, so we need to set the status byte of the claim for the next + // move. + claim = _changeClaimStatus(claim, VMStatuses.PANIC); + + vm.warp(block.timestamp + 10); + bond = _getRequiredBond(2); + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.attack{ value: bond }(disputed, 2, claim); + (,,,,,, clock) = gameProxy.claimData(3); + assertEq(clock.raw(), LibClock.wrap(Duration.wrap(25), Timestamp.wrap(uint64(block.timestamp))).raw()); + + vm.warp(block.timestamp + 10); + bond = _getRequiredBond(3); + (,,,, disputed,,) = gameProxy.claimData(3); + gameProxy.attack{ value: bond }(disputed, 3, claim); + (,,,,,, clock) = gameProxy.claimData(4); + assertEq(clock.raw(), LibClock.wrap(Duration.wrap(20), Timestamp.wrap(uint64(block.timestamp))).raw()); + } + + /// @notice Tests that the standard clock extension is triggered for a move that is not the + /// split depth or the max game depth. + function test_move_standardClockExtension_succeeds() public { + (,,,,,, Clock clock) = gameProxy.claimData(0); + assertEq(clock.raw(), LibClock.wrap(Duration.wrap(0), Timestamp.wrap(uint64(block.timestamp))).raw()); + + uint256 bond; + Claim disputed; + Claim claim = _dummyClaim(); + uint256 splitDepth = gameProxy.splitDepth(); + uint64 halfGameDuration = gameProxy.maxClockDuration().raw(); + uint64 clockExtension = gameProxy.clockExtension().raw(); + + // Warp ahead so that the next move will trigger a clock extension. We warp to the very + // first timestamp where a clock extension should be triggered. + vm.warp(block.timestamp + halfGameDuration - clockExtension + 1 seconds); + + // Execute a move that should cause a clock extension. + bond = _getRequiredBond(0); + (,,,, disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: bond }(disputed, 0, claim); + (,,,,,, clock) = gameProxy.claimData(1); + + // The clock should have been pushed back to the clock extension time. + assertEq(clock.duration().raw(), halfGameDuration - clockExtension); + + // Warp ahead again so that clock extensions will also trigger for the other team. Here we + // only warp to the clockExtension time because we'll be warping ahead by one second during + // each additional move. + vm.warp(block.timestamp + halfGameDuration - clockExtension); + + // Work our way down to the split depth. + for (uint256 i = 1; i < splitDepth - 2; i++) { + // Warp ahead by one second so that the next move will trigger a clock extension. + vm.warp(block.timestamp + 1 seconds); + + // Execute a move that should cause a clock extension. + bond = _getRequiredBond(i); + (,,,, disputed,,) = gameProxy.claimData(i); + gameProxy.attack{ value: bond }(disputed, i, claim); + (,,,,,, clock) = gameProxy.claimData(i + 1); + + // The clock should have been pushed back to the clock extension time. + assertEq(clock.duration().raw(), halfGameDuration - clockExtension); + } + } + + function test_move_splitDepthClockExtension_succeeds() public { + (,,,,,, Clock clock) = gameProxy.claimData(0); + assertEq(clock.raw(), LibClock.wrap(Duration.wrap(0), Timestamp.wrap(uint64(block.timestamp))).raw()); + + uint256 bond; + Claim disputed; + Claim claim = _dummyClaim(); + uint256 splitDepth = gameProxy.splitDepth(); + uint64 halfGameDuration = gameProxy.maxClockDuration().raw(); + uint64 clockExtension = gameProxy.clockExtension().raw(); + + // Work our way down to the split depth without moving ahead in time, we don't care about + // the exact clock here, just don't want take the clock below the clock extension time that + // we're trying to test here. + for (uint256 i = 0; i < splitDepth - 2; i++) { + bond = _getRequiredBond(i); + (,,,, disputed,,) = gameProxy.claimData(i); + gameProxy.attack{ value: bond }(disputed, i, claim); + } + + // Warp ahead to the very first timestamp where a clock extension should be triggered. + vm.warp(block.timestamp + halfGameDuration - clockExtension * 2 + 1 seconds); + + // Execute a move that should cause a clock extension. + bond = _getRequiredBond(splitDepth - 2); + (,,,, disputed,,) = gameProxy.claimData(splitDepth - 2); + gameProxy.attack{ value: bond }(disputed, splitDepth - 2, claim); + (,,,,,, clock) = gameProxy.claimData(splitDepth - 1); + + // The clock should have been pushed back to the clock extension time. + assertEq(clock.duration().raw(), halfGameDuration - clockExtension * 2); + } + + function test_move_maxGameDepthClockExtension_succeeds() public { + (,,,,,, Clock clock) = gameProxy.claimData(0); + assertEq(clock.raw(), LibClock.wrap(Duration.wrap(0), Timestamp.wrap(uint64(block.timestamp))).raw()); + + uint256 bond; + Claim disputed; + Claim claim = _dummyClaim(); + uint256 splitDepth = gameProxy.splitDepth(); + uint64 halfGameDuration = gameProxy.maxClockDuration().raw(); + uint64 clockExtension = gameProxy.clockExtension().raw(); + + // Work our way down to the split depth without moving ahead in time, we don't care about + // the exact clock here, just don't want take the clock below the clock extension time that + // we're trying to test here. + for (uint256 i = 0; i < gameProxy.maxGameDepth() - 2; i++) { + bond = _getRequiredBond(i); + (,,,, disputed,,) = gameProxy.claimData(i); + gameProxy.attack{ value: bond }(disputed, i, claim); + + // Change the claim status when we're crossing the split depth. + if (i == splitDepth - 2) { + claim = _changeClaimStatus(claim, VMStatuses.PANIC); + } + } + + // Warp ahead to the very first timestamp where a clock extension should be triggered. + vm.warp(block.timestamp + halfGameDuration - (clockExtension + gameProxy.vm().oracle().challengePeriod()) + 1); + + // Execute a move that should cause a clock extension. + bond = _getRequiredBond(gameProxy.maxGameDepth() - 2); + (,,,, disputed,,) = gameProxy.claimData(gameProxy.maxGameDepth() - 2); + gameProxy.attack{ value: bond }(disputed, gameProxy.maxGameDepth() - 2, claim); + (,,,,,, clock) = gameProxy.claimData(gameProxy.maxGameDepth() - 1); + + // The clock should have been pushed back to the clock extension time. + assertEq( + clock.duration().raw(), halfGameDuration - (clockExtension + gameProxy.vm().oracle().challengePeriod()) + ); + } + + /// @notice Tests that an identical claim cannot be made twice. The duplicate claim attempt + /// should revert with the `ClaimAlreadyExists` error. + function test_move_duplicateClaim_reverts() public { + Claim claim = _dummyClaim(); + + // Make the first move. This should succeed. + uint256 bond = _getRequiredBond(0); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: bond }(disputed, 0, claim); + + // Attempt to make the same move again. + vm.expectRevert(ClaimAlreadyExists.selector); + gameProxy.attack{ value: bond }(disputed, 0, claim); + } + + /// @notice Static unit test asserting that identical claims at the same position can be made + /// in different subgames. + function test_move_duplicateClaimsDifferentSubgames_succeeds() public { + Claim claimA = _dummyClaim(); + Claim claimB = _dummyClaim(); + + // Make the first moves. This should succeed. + uint256 bond = _getRequiredBond(0); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: bond }(disputed, 0, claimA); + gameProxy.attack{ value: bond }(disputed, 0, claimB); + + // Perform an attack at the same position with the same claim value in both subgames. + // These both should succeed. + bond = _getRequiredBond(1); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: bond }(disputed, 1, claimA); + bond = _getRequiredBond(2); + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.attack{ value: bond }(disputed, 2, claimA); + } + + /// @notice Static unit test for the correctness of an opening attack. + function test_move_simpleAttack_succeeds() public { + // Warp ahead 5 seconds. + vm.warp(block.timestamp + 5); + + Claim counter = _dummyClaim(); + + // Perform the attack. + uint256 reqBond = _getRequiredBond(0); + vm.expectEmit(true, true, true, false); + emit Move(0, counter, address(this)); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: reqBond }(disputed, 0, counter); + + // Grab the claim data of the attack. + ( + uint32 parentIndex, + address counteredBy, + address claimant, + uint128 bond, + Claim claim, + Position position, + Clock clock + ) = gameProxy.claimData(1); + + // Assert correctness of the attack claim's data. + assertEq(parentIndex, 0); + assertEq(counteredBy, address(0)); + assertEq(claimant, address(this)); + assertEq(bond, reqBond); + assertEq(claim.raw(), counter.raw()); + assertEq(position.raw(), Position.wrap(1).move(true).raw()); + assertEq(clock.raw(), LibClock.wrap(Duration.wrap(5), Timestamp.wrap(uint64(block.timestamp))).raw()); + + // Grab the claim data of the parent. + (parentIndex, counteredBy, claimant, bond, claim, position, clock) = gameProxy.claimData(0); + + // Assert correctness of the parent claim's data. + assertEq(parentIndex, type(uint32).max); + assertEq(counteredBy, address(0)); + assertEq(claimant, address(this)); + assertEq(bond, initBond); + assertEq(claim.raw(), ROOT_CLAIM.raw()); + assertEq(position.raw(), 1); + assertEq(clock.raw(), LibClock.wrap(Duration.wrap(0), Timestamp.wrap(uint64(block.timestamp - 5))).raw()); + } + + /// @notice Tests that making a claim at the execution trace bisection root level with an + /// invalid status byte reverts with the `UnexpectedRootClaim` error. + function test_move_incorrectStatusExecRoot_reverts() public { + Claim disputed; + for (uint256 i; i < 4; i++) { + (,,,, disputed,,) = gameProxy.claimData(i); + gameProxy.attack{ value: _getRequiredBond(i) }(disputed, i, _dummyClaim()); + } + + uint256 bond = _getRequiredBond(4); + (,,,, disputed,,) = gameProxy.claimData(4); + vm.expectRevert(abi.encodeWithSelector(UnexpectedRootClaim.selector, bytes32(0))); + gameProxy.attack{ value: bond }(disputed, 4, Claim.wrap(bytes32(0))); + } + + /// @notice Tests that making a claim at the execution trace bisection root level with a valid + /// status byte succeeds. + function test_move_correctStatusExecRoot_succeeds() public { + Claim disputed; + for (uint256 i; i < 4; i++) { + uint256 bond = _getRequiredBond(i); + (,,,, disputed,,) = gameProxy.claimData(i); + gameProxy.attack{ value: bond }(disputed, i, _dummyClaim()); + } + uint256 lastBond = _getRequiredBond(4); + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.attack{ value: lastBond }(disputed, 4, _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC)); + } + + /// @notice Static unit test asserting that a move reverts when the bonded amount is incorrect. + function test_move_incorrectBondAmount_reverts() public { + (,,,, Claim disputed,,) = gameProxy.claimData(0); + vm.expectRevert(IncorrectBondAmount.selector); + gameProxy.attack{ value: 0 }(disputed, 0, _dummyClaim()); + } + + /// @notice Static unit test asserting that a move reverts when the disputed claim does not + /// match its index. + function test_move_incorrectDisputedIndex_reverts() public { + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + uint256 bond = _getRequiredBond(1); + vm.expectRevert(InvalidDisputedClaimIndex.selector); + gameProxy.attack{ value: bond }(disputed, 1, _dummyClaim()); + } +} + +/// @title FaultDisputeGame_AddLocalData_Test +/// @notice Tests the addLocalData functionality of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_AddLocalData_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that adding local data with an out of bounds identifier reverts. + function testFuzz_addLocalData_oob_reverts(uint256 _ident) public { + Claim disputed; + // Get a claim below the split depth so that we can add local data for an execution trace + // subgame. + for (uint256 i; i < 4; i++) { + uint256 bond = _getRequiredBond(i); + (,,,, disputed,,) = gameProxy.claimData(i); + gameProxy.attack{ value: bond }(disputed, i, _dummyClaim()); + } + uint256 lastBond = _getRequiredBond(4); + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.attack{ value: lastBond }(disputed, 4, _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC)); + + // [1, 5] are valid local data identifiers. + if (_ident <= 5) _ident = 0; + + vm.expectRevert(InvalidLocalIdent.selector); + gameProxy.addLocalData(_ident, 5, 0); + } + + /// @notice Tests that local data is loaded into the preimage oracle correctly in the subgame + /// that is disputing the transition from `GENESIS -> GENESIS + 1` + function test_addLocalDataGenesisTransition_static_succeeds() public { + IPreimageOracle oracle = IPreimageOracle(address(gameProxy.vm().oracle())); + Claim disputed; + + // Get a claim below the split depth so that we can add local data for an execution trace + // subgame. + for (uint256 i; i < 4; i++) { + uint256 bond = _getRequiredBond(i); + (,,,, disputed,,) = gameProxy.claimData(i); + gameProxy.attack{ value: bond }(disputed, i, Claim.wrap(bytes32(i))); + } + uint256 lastBond = _getRequiredBond(4); + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.attack{ value: lastBond }(disputed, 4, _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC)); + + // Expected start/disputed claims + (Hash root,) = gameProxy.startingOutputRoot(); + bytes32 startingClaim = root.raw(); + bytes32 disputedClaim = bytes32(uint256(3)); + Position disputedPos = LibPosition.wrap(4, 0); + + // Expected local data + bytes32[5] memory data = [ + gameProxy.l1Head().raw(), + startingClaim, + disputedClaim, + bytes32(validL2BlockNumber << 0xC0), + bytes32(gameProxy.l2ChainId() << 0xC0) + ]; + + for (uint256 i = 1; i <= 5; i++) { + uint256 expectedLen = i > 3 ? 8 : 32; + bytes32 key = _getKey(i, keccak256(abi.encode(disputedClaim, disputedPos))); + + gameProxy.addLocalData(i, 5, 0); + (bytes32 dat, uint256 datLen) = oracle.readPreimage(key, 0); + assertEq(dat >> 0xC0, bytes32(expectedLen)); + // Account for the length prefix if i > 3 (the data stored at identifiers i <= 3 are + // 32 bytes long, so the expected length is already correct. If i > 3, the data is only + // 8 bytes long, so the length prefix + the data is 16 bytes total.) + assertEq(datLen, expectedLen + (i > 3 ? 8 : 0)); + + gameProxy.addLocalData(i, 5, 8); + (dat, datLen) = oracle.readPreimage(key, 8); + assertEq(dat, data[i - 1]); + assertEq(datLen, expectedLen); + } + } + + /// @notice Tests that local data is loaded into the preimage oracle correctly. + function test_addLocalDataMiddle_static_succeeds() public { + IPreimageOracle oracle = IPreimageOracle(address(gameProxy.vm().oracle())); + Claim disputed; + + // Get a claim below the split depth so that we can add local data for an execution trace + // subgame. + for (uint256 i; i < 4; i++) { + uint256 bond = _getRequiredBond(i); + (,,,, disputed,,) = gameProxy.claimData(i); + gameProxy.attack{ value: bond }(disputed, i, Claim.wrap(bytes32(i))); + } + uint256 lastBond = _getRequiredBond(4); + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.defend{ value: lastBond }(disputed, 4, _changeClaimStatus(ROOT_CLAIM, VMStatuses.VALID)); + + // Expected start/disputed claims + bytes32 startingClaim = bytes32(uint256(3)); + Position startingPos = LibPosition.wrap(4, 0); + bytes32 disputedClaim = bytes32(uint256(2)); + Position disputedPos = LibPosition.wrap(3, 0); + + // Expected local data + bytes32[5] memory data = [ + gameProxy.l1Head().raw(), + startingClaim, + disputedClaim, + bytes32(validL2BlockNumber << 0xC0), + bytes32(gameProxy.l2ChainId() << 0xC0) + ]; + + for (uint256 i = 1; i <= 5; i++) { + uint256 expectedLen = i > 3 ? 8 : 32; + bytes32 key = _getKey(i, keccak256(abi.encode(startingClaim, startingPos, disputedClaim, disputedPos))); + + gameProxy.addLocalData(i, 5, 0); + (bytes32 dat, uint256 datLen) = oracle.readPreimage(key, 0); + assertEq(dat >> 0xC0, bytes32(expectedLen)); + // Account for the length prefix if i > 3 (the data stored at identifiers i <= 3 are + // 32 bytes long, so the expected length is already correct. If i > 3, the data is only + // 8 bytes long, so the length prefix + the data is 16 bytes total.) + assertEq(datLen, expectedLen + (i > 3 ? 8 : 0)); + + gameProxy.addLocalData(i, 5, 8); + (dat, datLen) = oracle.readPreimage(key, 8); + assertEq(dat, data[i - 1]); + assertEq(datLen, expectedLen); + } + } + + /// @notice Tests that the L2 block number claim is favored over the bisected-to block when + /// adding data. + function test_addLocalData_l2BlockNumberExtension_succeeds() public { + // Deploy a new dispute game with a L2 block number claim of 8. This is directly in the + // middle of the leaves in our output bisection test tree, at SPLIT_DEPTH = 2 ** 2 + IFaultDisputeGameV2 game = IFaultDisputeGameV2( + address( + disputeGameFactory.create{ value: initBond }( + GAME_TYPE, Claim.wrap(bytes32(uint256(0xFF))), abi.encode(validL2BlockNumber) + ) + ) + ); + + // Get a claim below the split depth so that we can add local data for an execution trace + // subgame. + { + Claim disputed; + Position parent; + Position pos; + + for (uint256 i; i < 4; i++) { + (,,,,, parent,) = game.claimData(i); + pos = parent.move(true); + uint256 bond = game.getRequiredBond(pos); + + (,,,, disputed,,) = game.claimData(i); + if (i == 0) { + game.attack{ value: bond }(disputed, i, Claim.wrap(bytes32(i))); + } else { + game.defend{ value: bond }(disputed, i, Claim.wrap(bytes32(i))); + } + } + (,,,,, parent,) = game.claimData(4); + pos = parent.move(true); + uint256 lastBond = game.getRequiredBond(pos); + (,,,, disputed,,) = game.claimData(4); + game.defend{ value: lastBond }(disputed, 4, _changeClaimStatus(ROOT_CLAIM, VMStatuses.INVALID)); + } + + // Expected start/disputed claims + bytes32 startingClaim = bytes32(uint256(3)); + Position startingPos = LibPosition.wrap(4, 14); + bytes32 disputedClaim = bytes32(uint256(0xFF)); + Position disputedPos = LibPosition.wrap(0, 0); + + // Expected local data. This should be `l2BlockNumber`, and not the actual bisected-to + // block, as we choose the minimum between the two. + bytes32 expectedNumber = bytes32(validL2BlockNumber << 0xC0); + uint256 expectedLen = 8; + uint256 l2NumberIdent = LocalPreimageKey.DISPUTED_L2_BLOCK_NUMBER; + + // Compute the preimage key for the local data + bytes32 localContext = keccak256(abi.encode(startingClaim, startingPos, disputedClaim, disputedPos)); + bytes32 rawKey = keccak256(abi.encode(l2NumberIdent | (1 << 248), address(game), localContext)); + bytes32 key = bytes32((uint256(rawKey) & ~uint256(0xFF << 248)) | (1 << 248)); + + IPreimageOracle oracle = IPreimageOracle(address(game.vm().oracle())); + game.addLocalData(l2NumberIdent, 5, 0); + + (bytes32 dat, uint256 datLen) = oracle.readPreimage(key, 0); + assertEq(dat >> 0xC0, bytes32(expectedLen)); + assertEq(datLen, expectedLen + 8); + + game.addLocalData(l2NumberIdent, 5, 8); + (dat, datLen) = oracle.readPreimage(key, 8); + assertEq(dat, expectedNumber); + assertEq(datLen, expectedLen); + } +} + +/// @title FaultDisputeGame_ChallengeRootL2Block_Test +/// @notice Tests the challengeRootL2Block functionality of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_ChallengeRootL2Block_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that challenging the root claim's L2 block number by providing the real + /// preimage of the output root succeeds. + function testFuzz_challengeRootL2Block_succeeds( + bytes32 _storageRoot, + bytes32 _withdrawalRoot, + uint256 _l2BlockNumber + ) + public + { + _l2BlockNumber = bound(_l2BlockNumber, validL2BlockNumber, type(uint256).max - 1); + + (Types.OutputRootProof memory outputRootProof, bytes32 outputRoot, bytes memory headerRLP) = + _generateOutputRootProof(_storageRoot, _withdrawalRoot, abi.encodePacked(_l2BlockNumber)); + + // Create the dispute game with the output root at the wrong L2 block number. + uint256 wrongL2BlockNumber = bound(vm.randomUint(), _l2BlockNumber + 1, type(uint256).max); + IDisputeGame game = disputeGameFactory.create{ value: initBond }( + GAME_TYPE, Claim.wrap(outputRoot), abi.encode(wrongL2BlockNumber) + ); + + // Challenge the L2 block number. + IFaultDisputeGameV2 fdg = IFaultDisputeGameV2(address(game)); + fdg.challengeRootL2Block(outputRootProof, headerRLP); + + // Ensure that a duplicate challenge reverts. + vm.expectRevert(L2BlockNumberChallenged.selector); + fdg.challengeRootL2Block(outputRootProof, headerRLP); + + // Warp past the clocks, resolve the game. + vm.warp(block.timestamp + 3 days + 12 hours + 1); + fdg.resolveClaim(0, 0); + fdg.resolve(); + + // Ensure the challenge was successful. + assertEq(uint8(fdg.status()), uint8(GameStatus.CHALLENGER_WINS)); + assertTrue(fdg.l2BlockNumberChallenged()); + } + + /// @notice Tests that challenging the root claim's L2 block number by providing the real + /// preimage of the output root succeeds. Also, this claim should always receive the + /// bond when there is another counter that is as far left as possible. + function testFuzz_challengeRootL2Block_receivesBond_succeeds( + bytes32 _storageRoot, + bytes32 _withdrawalRoot, + uint256 _l2BlockNumber + ) + public + { + vm.deal(address(0xb0b), 1 ether); + _l2BlockNumber = bound(_l2BlockNumber, validL2BlockNumber, type(uint256).max - 1); + + (Types.OutputRootProof memory outputRootProof, bytes32 outputRoot, bytes memory headerRLP) = + _generateOutputRootProof(_storageRoot, _withdrawalRoot, abi.encodePacked(_l2BlockNumber)); + + // Create the dispute game with the output root at the wrong L2 block number. + disputeGameFactory.setInitBond(GAME_TYPE, 0.1 ether); + uint256 balanceBefore = address(this).balance; + _l2BlockNumber = bound(vm.randomUint(), _l2BlockNumber + 1, type(uint256).max); + IDisputeGame game = + disputeGameFactory.create{ value: 0.1 ether }(GAME_TYPE, Claim.wrap(outputRoot), abi.encode(_l2BlockNumber)); + IFaultDisputeGameV2 fdg = IFaultDisputeGameV2(address(game)); + + // Attack the root as 0xb0b + uint256 bond = _getRequiredBond(0); + (,,,, Claim disputed,,) = fdg.claimData(0); + vm.prank(address(0xb0b)); + fdg.attack{ value: bond }(disputed, 0, Claim.wrap(0)); + + // Challenge the L2 block number as 0xace. This claim should receive the root claim's bond. + vm.prank(address(0xace)); + fdg.challengeRootL2Block(outputRootProof, headerRLP); + + // Warp past the clocks, resolve the game. + vm.warp(block.timestamp + 3 days + 12 hours + 1); + fdg.resolveClaim(1, 0); + fdg.resolveClaim(0, 0); + fdg.resolve(); + + // Ensure the challenge was successful. + assertEq(uint8(fdg.status()), uint8(GameStatus.CHALLENGER_WINS)); + + // Wait for finalization delay. + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Close the game. + fdg.closeGame(); + + // Claim credit once to trigger unlock period. + fdg.claimCredit(address(this)); + fdg.claimCredit(address(0xb0b)); + fdg.claimCredit(address(0xace)); + + // Wait for the withdrawal delay. + vm.warp(block.timestamp + delayedWeth.delay() + 1 seconds); + + // Claim credit + vm.expectRevert(NoCreditToClaim.selector); + fdg.claimCredit(address(this)); + fdg.claimCredit(address(0xb0b)); + fdg.claimCredit(address(0xace)); + + // Ensure that the party who challenged the L2 block number with the special move received + // the bond. + // - Root claim loses their bond + // - 0xace receives the root claim's bond + // - 0xb0b receives their bond back + assertEq(address(this).balance, balanceBefore - 0.1 ether); + assertEq(address(0xb0b).balance, 1 ether); + assertEq(address(0xace).balance, 0.1 ether); + } + + /// @notice Tests that challenging the root claim's L2 block number by providing the real + /// preimage of the output root never succeeds. + function testFuzz_challengeRootL2Block_rightBlockNumber_reverts( + bytes32 _storageRoot, + bytes32 _withdrawalRoot, + uint256 _l2BlockNumber + ) + public + { + _l2BlockNumber = bound(_l2BlockNumber, validL2BlockNumber, type(uint256).max); + + (Types.OutputRootProof memory outputRootProof, bytes32 outputRoot, bytes memory headerRLP) = + _generateOutputRootProof(_storageRoot, _withdrawalRoot, abi.encodePacked(_l2BlockNumber)); + + // Create the dispute game with the output root at the wrong L2 block number. + IDisputeGame game = + disputeGameFactory.create{ value: initBond }(GAME_TYPE, Claim.wrap(outputRoot), abi.encode(_l2BlockNumber)); + + // Challenge the L2 block number. + IFaultDisputeGameV2 fdg = IFaultDisputeGameV2(address(game)); + vm.expectRevert(BlockNumberMatches.selector); + fdg.challengeRootL2Block(outputRootProof, headerRLP); + + // Warp past the clocks, resolve the game. + vm.warp(block.timestamp + 3 days + 12 hours + 1); + fdg.resolveClaim(0, 0); + fdg.resolve(); + + // Ensure the challenge was successful. + assertEq(uint8(fdg.status()), uint8(GameStatus.DEFENDER_WINS)); + } + + /// @notice Tests that challenging the root claim's L2 block number with a bad output root + /// proof reverts. + function test_challengeRootL2Block_badProof_reverts() public { + Types.OutputRootProof memory outputRootProof = + Types.OutputRootProof({ version: 0, stateRoot: 0, messagePasserStorageRoot: 0, latestBlockhash: 0 }); + + vm.expectRevert(InvalidOutputRootProof.selector); + gameProxy.challengeRootL2Block(outputRootProof, hex""); + } + + /// @notice Tests that challenging the root claim's L2 block number with a bad output root + /// proof reverts. + function test_challengeRootL2Block_badHeaderRLP_reverts() public { + Types.OutputRootProof memory outputRootProof = + Types.OutputRootProof({ version: 0, stateRoot: 0, messagePasserStorageRoot: 0, latestBlockhash: 0 }); + bytes32 outputRoot = Hashing.hashOutputRootProof(outputRootProof); + + // Create the dispute game with the output root at the wrong L2 block number. + IDisputeGame game = disputeGameFactory.create{ value: initBond }( + GAME_TYPE, Claim.wrap(outputRoot), abi.encode(validL2BlockNumber) + ); + IFaultDisputeGameV2 fdg = IFaultDisputeGameV2(address(game)); + + vm.expectRevert(InvalidHeaderRLP.selector); + fdg.challengeRootL2Block(outputRootProof, hex""); + } + + /// @notice Tests that challenging the root claim's L2 block number with a bad output root + /// proof reverts. + function test_challengeRootL2Block_badHeaderRLPBlockNumberLength_reverts() public { + (Types.OutputRootProof memory outputRootProof, bytes32 outputRoot,) = + _generateOutputRootProof(0, 0, new bytes(64)); + + // Create the dispute game with the output root at the wrong L2 block number. + IDisputeGame game = disputeGameFactory.create{ value: initBond }( + GAME_TYPE, Claim.wrap(outputRoot), abi.encode(validL2BlockNumber) + ); + IFaultDisputeGameV2 fdg = IFaultDisputeGameV2(address(game)); + + vm.expectRevert(InvalidHeaderRLP.selector); + fdg.challengeRootL2Block(outputRootProof, hex""); + } +} + +/// @title FaultDisputeGame_Resolve_Test +/// @notice Tests the resolve functionality of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_Resolve_Test is FaultDisputeGameV2_TestInit { + /// @notice Static unit test for the correctness an uncontested root resolution. + function test_resolve_rootUncontested_succeeds() public { + vm.warp(block.timestamp + 3 days + 12 hours); + gameProxy.resolveClaim(0, 0); + assertEq(uint8(gameProxy.resolve()), uint8(GameStatus.DEFENDER_WINS)); + } + + /// @notice Static unit test for the correctness an uncontested root resolution. + function test_resolve_rootUncontestedClockNotExpired_succeeds() public { + vm.warp(block.timestamp + 3 days + 12 hours - 1 seconds); + vm.expectRevert(ClockNotExpired.selector); + gameProxy.resolveClaim(0, 0); + } + + /// @notice Static unit test for the correctness of a multi-part resolution of a single claim. + function test_resolve_multiPart_succeeds() public { + vm.deal(address(this), 10_000 ether); + + uint256 bond = _getRequiredBond(0); + for (uint256 i = 0; i < 2048; i++) { + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: bond }(disputed, 0, Claim.wrap(bytes32(i))); + } + + // Warp past the clock period. + vm.warp(block.timestamp + 3 days + 12 hours + 1 seconds); + + // Resolve all children of the root subgame. Every single one of these will be uncontested. + for (uint256 i = 1; i <= 2048; i++) { + gameProxy.resolveClaim(i, 0); + } + + // Resolve the first half of the root claim subgame. + gameProxy.resolveClaim(0, 1024); + + // Fetch the resolution checkpoint for the root subgame and assert correctness. + (bool initCheckpoint, uint32 subgameIndex, Position leftmostPosition, address counteredBy) = + gameProxy.resolutionCheckpoints(0); + assertTrue(initCheckpoint); + assertEq(subgameIndex, 1024); + assertEq(leftmostPosition.raw(), Position.wrap(1).move(true).raw()); + assertEq(counteredBy, address(this)); + + // The root subgame should not be resolved. + assertFalse(gameProxy.resolvedSubgames(0)); + vm.expectRevert(OutOfOrderResolution.selector); + gameProxy.resolve(); + + // Resolve the second half of the root claim subgame. + uint256 numToResolve = gameProxy.getNumToResolve(0); + assertEq(numToResolve, 1024); + gameProxy.resolveClaim(0, numToResolve); + + // Fetch the resolution checkpoint for the root subgame and assert correctness. + (initCheckpoint, subgameIndex, leftmostPosition, counteredBy) = gameProxy.resolutionCheckpoints(0); + assertTrue(initCheckpoint); + assertEq(subgameIndex, 2048); + assertEq(leftmostPosition.raw(), Position.wrap(1).move(true).raw()); + assertEq(counteredBy, address(this)); + + // The root subgame should now be resolved + assertTrue(gameProxy.resolvedSubgames(0)); + assertEq(uint8(gameProxy.resolve()), uint8(GameStatus.CHALLENGER_WINS)); + } + + /// @notice Static unit test asserting that resolve reverts when the absolute root + /// subgame has not been resolved. + function test_resolve_rootUncontestedButUnresolved_reverts() public { + vm.warp(block.timestamp + 3 days + 12 hours); + vm.expectRevert(OutOfOrderResolution.selector); + gameProxy.resolve(); + } + + /// @notice Static unit test asserting that resolve reverts when the game state is + /// not in progress. + function test_resolve_notInProgress_reverts() public { + uint256 chalWins = uint256(GameStatus.CHALLENGER_WINS); + + // Replace the game status in storage. It exists in slot 0 at offset 16. + uint256 slot = uint256(vm.load(address(gameProxy), bytes32(0))); + uint256 offset = 16 << 3; + uint256 mask = 0xFF << offset; + // Replace the byte in the slot value with the challenger wins status. + slot = (slot & ~mask) | (chalWins << offset); + + vm.store(address(gameProxy), bytes32(uint256(0)), bytes32(slot)); + vm.expectRevert(GameNotInProgress.selector); + gameProxy.resolveClaim(0, 0); + } + + /// @notice Static unit test for the correctness of resolving a single attack game state. + function test_resolve_rootContested_succeeds() public { + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + + vm.warp(block.timestamp + 3 days + 12 hours); + + gameProxy.resolveClaim(1, 0); + gameProxy.resolveClaim(0, 0); + assertEq(uint8(gameProxy.resolve()), uint8(GameStatus.CHALLENGER_WINS)); + } + + /// @notice Static unit test for the correctness of resolving a game with a contested challenge + /// claim. + function test_resolve_challengeContested_succeeds() public { + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.defend{ value: _getRequiredBond(1) }(disputed, 1, _dummyClaim()); + + vm.warp(block.timestamp + 3 days + 12 hours); + + gameProxy.resolveClaim(2, 0); + gameProxy.resolveClaim(1, 0); + gameProxy.resolveClaim(0, 0); + assertEq(uint8(gameProxy.resolve()), uint8(GameStatus.DEFENDER_WINS)); + } + + /// @notice Static unit test for the correctness of resolving a game with multiplayer moves. + function test_resolve_teamDeathmatch_succeeds() public { + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.defend{ value: _getRequiredBond(1) }(disputed, 1, _dummyClaim()); + gameProxy.defend{ value: _getRequiredBond(1) }(disputed, 1, _dummyClaim()); + + vm.warp(block.timestamp + 3 days + 12 hours); + + gameProxy.resolveClaim(4, 0); + gameProxy.resolveClaim(3, 0); + gameProxy.resolveClaim(2, 0); + gameProxy.resolveClaim(1, 0); + gameProxy.resolveClaim(0, 0); + assertEq(uint8(gameProxy.resolve()), uint8(GameStatus.CHALLENGER_WINS)); + } + + /// @notice Static unit test for the correctness of resolving a game that reaches max game + /// depth. + function test_resolve_stepReached_succeeds() public { + Claim claim = _dummyClaim(); + for (uint256 i; i < gameProxy.splitDepth(); i++) { + (,,,, Claim disputed,,) = gameProxy.claimData(i); + gameProxy.attack{ value: _getRequiredBond(i) }(disputed, i, claim); + } + + claim = _changeClaimStatus(claim, VMStatuses.PANIC); + for (uint256 i = gameProxy.claimDataLen() - 1; i < gameProxy.maxGameDepth(); i++) { + (,,,, Claim disputed,,) = gameProxy.claimData(i); + gameProxy.attack{ value: _getRequiredBond(i) }(disputed, i, claim); + } + + vm.warp(block.timestamp + 3 days + 12 hours); + + for (uint256 i = 9; i > 0; i--) { + gameProxy.resolveClaim(i - 1, 0); + } + assertEq(uint8(gameProxy.resolve()), uint8(GameStatus.DEFENDER_WINS)); + } + + /// @notice Static unit test asserting that resolve reverts when attempting to resolve a + /// subgame multiple times + function test_resolve_claimAlreadyResolved_reverts() public { + Claim claim = _dummyClaim(); + uint256 firstBond = _getRequiredBond(0); + vm.deal(address(this), firstBond); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: firstBond }(disputed, 0, claim); + uint256 secondBond = _getRequiredBond(1); + vm.deal(address(this), secondBond); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: secondBond }(disputed, 1, claim); + + vm.warp(block.timestamp + 3 days + 12 hours); + + gameProxy.resolveClaim(2, 0); + gameProxy.resolveClaim(1, 0); + + vm.expectRevert(ClaimAlreadyResolved.selector); + gameProxy.resolveClaim(1, 0); + } + + /// @notice Static unit test asserting that resolve reverts when attempting to resolve a + /// subgame at max depth + function test_resolve_claimAtMaxDepthAlreadyResolved_reverts() public { + Claim claim = _dummyClaim(); + for (uint256 i; i < gameProxy.splitDepth(); i++) { + (,,,, Claim disputed,,) = gameProxy.claimData(i); + gameProxy.attack{ value: _getRequiredBond(i) }(disputed, i, claim); + } + + vm.deal(address(this), 10000 ether); + claim = _changeClaimStatus(claim, VMStatuses.PANIC); + for (uint256 i = gameProxy.claimDataLen() - 1; i < gameProxy.maxGameDepth(); i++) { + (,,,, Claim disputed,,) = gameProxy.claimData(i); + gameProxy.attack{ value: _getRequiredBond(i) }(disputed, i, claim); + } + + vm.warp(block.timestamp + 3 days + 12 hours); + + gameProxy.resolveClaim(8, 0); + + vm.expectRevert(ClaimAlreadyResolved.selector); + gameProxy.resolveClaim(8, 0); + } + + /// @notice Static unit test asserting that resolve reverts when attempting to resolve + /// subgames out of order + function test_resolve_outOfOrderResolution_reverts() public { + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: _getRequiredBond(1) }(disputed, 1, _dummyClaim()); + + vm.warp(block.timestamp + 3 days + 12 hours); + + vm.expectRevert(OutOfOrderResolution.selector); + gameProxy.resolveClaim(0, 0); + } + + /// @notice Static unit test asserting that resolve pays out bonds on step, output bisection, + /// and execution trace moves. + function test_resolve_bondPayouts_succeeds() public { + // Give the test contract some ether + uint256 bal = 1000 ether; + vm.deal(address(this), bal); + + // Make claims all the way down the tree. + uint256 bond = _getRequiredBond(0); + uint256 totalBonded = bond; + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: bond }(disputed, 0, _dummyClaim()); + bond = _getRequiredBond(1); + totalBonded += bond; + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: bond }(disputed, 1, _dummyClaim()); + bond = _getRequiredBond(2); + totalBonded += bond; + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.attack{ value: bond }(disputed, 2, _dummyClaim()); + bond = _getRequiredBond(3); + totalBonded += bond; + (,,,, disputed,,) = gameProxy.claimData(3); + gameProxy.attack{ value: bond }(disputed, 3, _dummyClaim()); + bond = _getRequiredBond(4); + totalBonded += bond; + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.attack{ value: bond }(disputed, 4, _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC)); + bond = _getRequiredBond(5); + totalBonded += bond; + (,,,, disputed,,) = gameProxy.claimData(5); + gameProxy.attack{ value: bond }(disputed, 5, _dummyClaim()); + bond = _getRequiredBond(6); + totalBonded += bond; + (,,,, disputed,,) = gameProxy.claimData(6); + gameProxy.attack{ value: bond }(disputed, 6, _dummyClaim()); + bond = _getRequiredBond(7); + totalBonded += bond; + (,,,, disputed,,) = gameProxy.claimData(7); + gameProxy.attack{ value: bond }(disputed, 7, _dummyClaim()); + gameProxy.addLocalData(LocalPreimageKey.DISPUTED_L2_BLOCK_NUMBER, 8, 0); + gameProxy.step(8, true, absolutePrestateData, hex""); + + // Ensure that the step successfully countered the leaf claim. + (, address counteredBy,,,,,) = gameProxy.claimData(8); + assertEq(counteredBy, address(this)); + + // Ensure we bonded the correct amounts + assertEq(address(this).balance, bal - totalBonded); + assertEq(address(gameProxy).balance, 0); + assertEq(delayedWeth.balanceOf(address(gameProxy)), initBond + totalBonded); + + // Resolve all claims + vm.warp(block.timestamp + 3 days + 12 hours); + for (uint256 i = gameProxy.claimDataLen(); i > 0; i--) { + (bool success,) = address(gameProxy).call(abi.encodeCall(gameProxy.resolveClaim, (i - 1, 0))); + assertTrue(success); + } + gameProxy.resolve(); + + // Wait for finalization delay + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Close the game. + gameProxy.closeGame(); + + // Claim credit once to trigger unlock period. + gameProxy.claimCredit(address(this)); + + // Wait for the withdrawal delay. + vm.warp(block.timestamp + delayedWeth.delay() + 1 seconds); + + // Claim credit again to get the bond back. + gameProxy.claimCredit(address(this)); + + // Ensure that bonds were paid out correctly. + assertEq(address(this).balance, bal + initBond); + assertEq(address(gameProxy).balance, 0); + assertEq(delayedWeth.balanceOf(address(gameProxy)), 0); + + // Ensure that the init bond for the game is 0, in case we change it in the test suite in + // the future. + assertEq(disputeGameFactory.initBonds(GAME_TYPE), initBond); + } + + /// @notice Static unit test asserting that resolve pays out bonds on step, output bisection, + /// and execution trace moves with 2 actors and a dishonest root claim. + function test_resolve_bondPayoutsSeveralActors_succeeds() public { + // Give the test contract and bob some ether + // We use the "1000 ether" literal for `bal`, the initial balance, to avoid stack too deep + //uint256 bal = 1000 ether; + address bob = address(0xb0b); + vm.deal(address(this), 1000 ether); + vm.deal(bob, 1000 ether); + + // Make claims all the way down the tree, trading off between bob and the test contract. + uint256 firstBond = _getRequiredBond(0); + uint256 thisBonded = firstBond; + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: firstBond }(disputed, 0, _dummyClaim()); + + uint256 secondBond = _getRequiredBond(1); + uint256 bobBonded = secondBond; + (,,,, disputed,,) = gameProxy.claimData(1); + vm.prank(bob); + gameProxy.attack{ value: secondBond }(disputed, 1, _dummyClaim()); + + uint256 thirdBond = _getRequiredBond(2); + thisBonded += thirdBond; + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.attack{ value: thirdBond }(disputed, 2, _dummyClaim()); + + uint256 fourthBond = _getRequiredBond(3); + bobBonded += fourthBond; + (,,,, disputed,,) = gameProxy.claimData(3); + vm.prank(bob); + gameProxy.attack{ value: fourthBond }(disputed, 3, _dummyClaim()); + + uint256 fifthBond = _getRequiredBond(4); + thisBonded += fifthBond; + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.attack{ value: fifthBond }(disputed, 4, _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC)); + + uint256 sixthBond = _getRequiredBond(5); + bobBonded += sixthBond; + (,,,, disputed,,) = gameProxy.claimData(5); + vm.prank(bob); + gameProxy.attack{ value: sixthBond }(disputed, 5, _dummyClaim()); + + uint256 seventhBond = _getRequiredBond(6); + thisBonded += seventhBond; + (,,,, disputed,,) = gameProxy.claimData(6); + gameProxy.attack{ value: seventhBond }(disputed, 6, _dummyClaim()); + + uint256 eighthBond = _getRequiredBond(7); + bobBonded += eighthBond; + (,,,, disputed,,) = gameProxy.claimData(7); + vm.prank(bob); + gameProxy.attack{ value: eighthBond }(disputed, 7, _dummyClaim()); + + gameProxy.addLocalData(LocalPreimageKey.DISPUTED_L2_BLOCK_NUMBER, 8, 0); + gameProxy.step(8, true, absolutePrestateData, hex""); + + // Ensure that the step successfully countered the leaf claim. + (, address counteredBy,,,,,) = gameProxy.claimData(8); + assertEq(counteredBy, address(this)); + + // Ensure we bonded the correct amounts + assertEq(address(this).balance, 1000 ether - thisBonded); + assertEq(bob.balance, 1000 ether - bobBonded); + assertEq(address(gameProxy).balance, 0); + assertEq(delayedWeth.balanceOf(address(gameProxy)), initBond + thisBonded + bobBonded); + + // Resolve all claims + vm.warp(block.timestamp + 3 days + 12 hours); + for (uint256 i = gameProxy.claimDataLen(); i > 0; i--) { + (bool success,) = address(gameProxy).call(abi.encodeCall(gameProxy.resolveClaim, (i - 1, 0))); + assertTrue(success); + } + + // Resolve the game. + gameProxy.resolve(); + + // Wait for finalization delay + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Close the game. + gameProxy.closeGame(); + + // Claim credit once to trigger unlock period. + gameProxy.claimCredit(address(this)); + gameProxy.claimCredit(bob); + + // Wait for the withdrawal delay. + vm.warp(block.timestamp + delayedWeth.delay() + 1 seconds); + + // Claim credit again to get the bond back. + gameProxy.claimCredit(address(this)); + + // Bob's claim should revert since it's value is 0 + vm.expectRevert(NoCreditToClaim.selector); + gameProxy.claimCredit(bob); + + // Ensure that bonds were paid out correctly. + assertEq(address(this).balance, 1000 ether + initBond + bobBonded); + assertEq(bob.balance, 1000 ether - bobBonded); + assertEq(address(gameProxy).balance, 0); + assertEq(delayedWeth.balanceOf(address(gameProxy)), 0); + + // Ensure that the init bond for the game is 0, in case we change it in the test suite in + // the future. + assertEq(disputeGameFactory.initBonds(GAME_TYPE), initBond); + } + + /// @notice Static unit test asserting that resolve pays out bonds on moves to the leftmost + /// actor in subgames containing successful counters. + function test_resolve_leftmostBondPayout_succeeds() public { + uint256 bal = 1000 ether; + address alice = address(0xa11ce); + address bob = address(0xb0b); + address charlie = address(0xc0c); + vm.deal(address(this), bal); + vm.deal(alice, bal); + vm.deal(bob, bal); + vm.deal(charlie, bal); + + // Make claims with bob, charlie and the test contract on defense, and alice as the + // challenger charlie is successfully countered by alice alice is successfully countered by + // both bob and the test contract + uint256 firstBond = _getRequiredBond(0); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + vm.prank(alice); + gameProxy.attack{ value: firstBond }(disputed, 0, _dummyClaim()); + + uint256 secondBond = _getRequiredBond(1); + (,,,, disputed,,) = gameProxy.claimData(1); + vm.prank(bob); + gameProxy.defend{ value: secondBond }(disputed, 1, _dummyClaim()); + vm.prank(charlie); + gameProxy.attack{ value: secondBond }(disputed, 1, _dummyClaim()); + gameProxy.attack{ value: secondBond }(disputed, 1, _dummyClaim()); + + uint256 thirdBond = _getRequiredBond(3); + (,,,, disputed,,) = gameProxy.claimData(3); + vm.prank(alice); + gameProxy.attack{ value: thirdBond }(disputed, 3, _dummyClaim()); + + // Resolve all claims + vm.warp(block.timestamp + 3 days + 12 hours); + for (uint256 i = gameProxy.claimDataLen(); i > 0; i--) { + (bool success,) = address(gameProxy).call(abi.encodeCall(gameProxy.resolveClaim, (i - 1, 0))); + assertTrue(success); + } + gameProxy.resolve(); + + // Wait for finalization delay + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Close the game. + gameProxy.closeGame(); + + // Claim credit once to trigger unlock period. + gameProxy.claimCredit(address(this)); + gameProxy.claimCredit(alice); + gameProxy.claimCredit(bob); + gameProxy.claimCredit(charlie); + + // Wait for the withdrawal delay. + vm.warp(block.timestamp + delayedWeth.delay() + 1 seconds); + + // All of these claims should work. + gameProxy.claimCredit(address(this)); + gameProxy.claimCredit(alice); + gameProxy.claimCredit(bob); + + // Charlie's claim should revert since it's value is 0 + vm.expectRevert(NoCreditToClaim.selector); + gameProxy.claimCredit(charlie); + + // Ensure that bonds were paid out correctly. + uint256 aliceLosses = firstBond; + uint256 charlieLosses = secondBond; + assertEq(address(this).balance, bal + aliceLosses + initBond, "incorrect this balance"); + assertEq(alice.balance, bal - aliceLosses + charlieLosses, "incorrect alice balance"); + assertEq(bob.balance, bal, "incorrect bob balance"); + assertEq(charlie.balance, bal - charlieLosses, "incorrect charlie balance"); + assertEq(address(gameProxy).balance, 0); + + // Ensure that the init bond for the game is 0, in case we change it in the test suite in + // the future. + assertEq(disputeGameFactory.initBonds(GAME_TYPE), initBond); + } + + /// @notice Static unit test asserting that the anchor state updates when the game resolves in + /// favor of the defender and the anchor state is older than the game state. + function test_resolve_validNewerStateUpdatesAnchor_succeeds() public { + // Confirm that the anchor state is older than the game state. + (Hash root, uint256 l2BlockNumber) = anchorStateRegistry.anchors(gameProxy.gameType()); + assert(l2BlockNumber < gameProxy.l2BlockNumber()); + + // Resolve the game. + vm.warp(block.timestamp + 3 days + 12 hours); + gameProxy.resolveClaim(0, 0); + assertEq(uint8(gameProxy.resolve()), uint8(GameStatus.DEFENDER_WINS)); + + // Wait for finalization delay. + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Close the game. + gameProxy.closeGame(); + + // Confirm that the anchor state is now the same as the game state. + (root, l2BlockNumber) = anchorStateRegistry.anchors(gameProxy.gameType()); + assertEq(l2BlockNumber, gameProxy.l2BlockNumber()); + assertEq(root.raw(), gameProxy.rootClaim().raw()); + } + + /// @notice Static unit test asserting that the anchor state does not change when the game + /// resolves in favor of the defender but the game state is not newer than the anchor + /// state. + function test_resolve_validOlderStateSameAnchor_succeeds() public { + // Mock the game block to be older than the game state. + vm.mockCall(address(gameProxy), abi.encodeCall(gameProxy.l2SequenceNumber, ()), abi.encode(0)); + + // Confirm that the anchor state is newer than the game state. + (Hash root, uint256 l2BlockNumber) = anchorStateRegistry.anchors(gameProxy.gameType()); + assert(l2BlockNumber >= gameProxy.l2SequenceNumber()); + + // Resolve the game. + vm.mockCall(address(gameProxy), abi.encodeCall(gameProxy.l2SequenceNumber, ()), abi.encode(0)); + vm.warp(block.timestamp + 3 days + 12 hours); + gameProxy.resolveClaim(0, 0); + assertEq(uint8(gameProxy.resolve()), uint8(GameStatus.DEFENDER_WINS)); + + // Wait for finalization delay. + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Close the game. + gameProxy.closeGame(); + + // Confirm that the anchor state is the same as the initial anchor state. + (Hash updatedRoot, uint256 updatedL2BlockNumber) = anchorStateRegistry.anchors(gameProxy.gameType()); + assertEq(updatedL2BlockNumber, l2BlockNumber); + assertEq(updatedRoot.raw(), root.raw()); + } + + /// @notice Static unit test asserting that the anchor state does not change when the game + /// resolves in favor of the challenger, even if the game state is newer than the + /// anchor state. + function test_resolve_invalidStateSameAnchor_succeeds() public { + // Confirm that the anchor state is older than the game state. + (Hash root, uint256 l2BlockNumber) = anchorStateRegistry.anchors(gameProxy.gameType()); + assert(l2BlockNumber < gameProxy.l2BlockNumber()); + + // Challenge the claim and resolve it. + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + vm.warp(block.timestamp + 3 days + 12 hours); + gameProxy.resolveClaim(1, 0); + gameProxy.resolveClaim(0, 0); + assertEq(uint8(gameProxy.resolve()), uint8(GameStatus.CHALLENGER_WINS)); + + // Wait for finalization delay. + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Close the game. + gameProxy.closeGame(); + + // Confirm that the anchor state is the same as the initial anchor state. + (Hash updatedRoot, uint256 updatedL2BlockNumber) = anchorStateRegistry.anchors(gameProxy.gameType()); + assertEq(updatedL2BlockNumber, l2BlockNumber); + assertEq(updatedRoot.raw(), root.raw()); + } +} + +/// @title FaultDisputeGame_GameType_Test +/// @notice Tests the `gameType` function of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_GameType_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that the game's type is set correctly. + function test_gameType_succeeds() public view { + assertEq(gameProxy.gameType().raw(), GAME_TYPE.raw()); + } +} + +/// @title FaultDisputeGame_RootClaim_Test +/// @notice Tests the `rootClaim` function of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_RootClaim_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that the game's root claim is set correctly. + function test_rootClaim_succeeds() public view { + assertEq(gameProxy.rootClaim().raw(), ROOT_CLAIM.raw()); + } +} + +/// @title FaultDisputeGame_ExtraData_Test +/// @notice Tests the `extraData` function of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_ExtraData_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that the game's extra data is set correctly. + function test_extraData_succeeds() public view { + assertEq(gameProxy.extraData(), extraData); + } +} + +/// @title FaultDisputeGame_GameData_Test +/// @notice Tests the `gameData` function of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_GameData_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that the game's data is set correctly. + function test_gameData_succeeds() public view { + (GameType gameType, Claim rootClaim, bytes memory _extraData) = gameProxy.gameData(); + + assertEq(gameType.raw(), GAME_TYPE.raw()); + assertEq(rootClaim.raw(), ROOT_CLAIM.raw()); + assertEq(_extraData, extraData); + } +} + +/// @title FaultDisputeGame_GetRequiredBond_Test +/// @notice Tests the `getRequiredBond` function of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_GetRequiredBond_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that the bond during the bisection game depths is correct. + function test_getRequiredBond_succeeds() public view { + for (uint8 i = 0; i < uint8(gameProxy.splitDepth()); i++) { + Position pos = LibPosition.wrap(i, 0); + uint256 bond = gameProxy.getRequiredBond(pos); + + // Reasonable approximation for a max depth of 8. + uint256 expected = 0.08 ether; + for (uint64 j = 0; j < i; j++) { + expected = expected * 22876; + expected = expected / 10000; + } + + assertApproxEqAbs(bond, expected, 0.01 ether); + } + } + + /// @notice Tests that the bond at a depth greater than the maximum game depth reverts. + function test_getRequiredBond_outOfBounds_reverts() public { + Position pos = LibPosition.wrap(uint8(gameProxy.maxGameDepth() + 1), 0); + vm.expectRevert(GameDepthExceeded.selector); + gameProxy.getRequiredBond(pos); + } +} + +/// @title FaultDisputeGame_ClaimCredit_Test +/// @notice Tests the claimCredit functionality of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_ClaimCredit_Test is FaultDisputeGameV2_TestInit { + function test_claimCredit_refundMode_succeeds() public { + // Set up actors. + address alice = address(0xa11ce); + address bob = address(0xb0b); + + // Give the game proxy 1 extra ether, unregistered. + vm.deal(address(gameProxy), 1 ether); + + // Perform a bonded move. + Claim claim = _dummyClaim(); + + // Bond the first claim. + uint256 firstBond = _getRequiredBond(0); + vm.deal(alice, firstBond); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + vm.prank(alice); + gameProxy.attack{ value: firstBond }(disputed, 0, claim); + + // Bond the second claim. + uint256 secondBond = _getRequiredBond(1); + vm.deal(bob, secondBond); + (,,,, disputed,,) = gameProxy.claimData(1); + vm.prank(bob); + gameProxy.attack{ value: secondBond }(disputed, 1, claim); + + // Warp past the finalization period + vm.warp(block.timestamp + 3 days + 12 hours); + + // Resolve the game. + // Second claim wins, so bob should get alice's credit. + gameProxy.resolveClaim(2, 0); + gameProxy.resolveClaim(1, 0); + gameProxy.resolveClaim(0, 0); + gameProxy.resolve(); + + // Wait for finalization delay. + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Mock that the game proxy is not proper, trigger refund mode. + vm.mockCall( + address(anchorStateRegistry), + abi.encodeCall(anchorStateRegistry.isGameProper, (gameProxy)), + abi.encode(false) + ); + + // Close the game. + gameProxy.closeGame(); + + // Assert bond distribution mode is refund mode. + assertTrue(gameProxy.bondDistributionMode() == BondDistributionMode.REFUND); + + // Claim credit once to trigger unlock period. + gameProxy.claimCredit(alice); + gameProxy.claimCredit(bob); + + // Wait for the withdrawal delay. + vm.warp(block.timestamp + delayedWeth.delay() + 1 seconds); + + // Grab balances before claim. + uint256 aliceBalanceBefore = alice.balance; + uint256 bobBalanceBefore = bob.balance; + + // Claim credit again to get the bond back. + gameProxy.claimCredit(alice); + gameProxy.claimCredit(bob); + + // Should have original balance again. + assertEq(alice.balance, aliceBalanceBefore + firstBond); + assertEq(bob.balance, bobBalanceBefore + secondBond); + } + + /// @notice Tests that claimCredit reverts if the game is paused. + function test_claimCredit_gamePaused_reverts() public { + // Pause the system with the Superchain-wide identifier (address(0)). + vm.prank(superchainConfig.guardian()); + superchainConfig.pause(address(0)); + + // Attempting to claim credit should now revert. + vm.expectRevert(GamePaused.selector); + gameProxy.claimCredit(address(0)); + } + + /// @notice Static unit test asserting that credit may not be drained past allowance through + /// reentrancy. + function test_claimCredit_claimAlreadyResolved_reverts() public { + ClaimCreditReenter reenter = new ClaimCreditReenter(gameProxy, vm); + vm.startPrank(address(reenter)); + + // Give the game proxy 1 extra ether, unregistered. + vm.deal(address(gameProxy), 1 ether); + + // Perform a bonded move. + Claim claim = _dummyClaim(); + uint256 firstBond = _getRequiredBond(0); + vm.deal(address(reenter), firstBond); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: firstBond }(disputed, 0, claim); + uint256 secondBond = _getRequiredBond(1); + vm.deal(address(reenter), secondBond); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: secondBond }(disputed, 1, claim); + uint256 reenterBond = firstBond + secondBond; + + // Warp past the finalization period + vm.warp(block.timestamp + 3 days + 12 hours); + + // Ensure that we bonded all the test contract's ETH + assertEq(address(reenter).balance, 0); + // Ensure the game proxy has 1 ether in it. + assertEq(address(gameProxy).balance, 1 ether); + // Ensure the game has a balance of reenterBond in the delayedWeth contract. + assertEq(delayedWeth.balanceOf(address(gameProxy)), initBond + reenterBond); + + // Resolve the claim at index 2 first so that index 1 can be resolved. + gameProxy.resolveClaim(2, 0); + + // Resolve the claim at index 1 and claim the reenter contract's credit. + gameProxy.resolveClaim(1, 0); + + // Ensure that the game registered the `reenter` contract's credit. + assertEq(gameProxy.credit(address(reenter)), reenterBond); + + // Resolve the root claim. + gameProxy.resolveClaim(0, 0); + + // Resolve the game. + gameProxy.resolve(); + + // Wait for finalization delay. + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Close the game. + gameProxy.closeGame(); + + // Claim credit once to trigger unlock period. + gameProxy.claimCredit(address(reenter)); + + // Wait for the withdrawal delay. + vm.warp(block.timestamp + delayedWeth.delay() + 1 seconds); + + // Initiate the reentrant credit claim. + reenter.claimCredit(address(reenter)); + + // The reenter contract should have performed 2 calls to `claimCredit`. + // Once all the credit is claimed, all subsequent calls will revert since there is 0 credit + // left to claim. + // The claimant must only have received the amount bonded for the gindex 1 subgame. + // The root claim bond and the unregistered ETH should still exist in the game proxy. + assertEq(reenter.numCalls(), 2); + assertEq(address(reenter).balance, reenterBond); + assertEq(address(gameProxy).balance, 1 ether); + assertEq(delayedWeth.balanceOf(address(gameProxy)), initBond); + + vm.stopPrank(); + } + + /// @notice Tests that claimCredit reverts when recipient can't receive value. + function test_claimCredit_recipientCantReceiveValue_reverts() public { + // Set up actors. + address alice = address(0xa11ce); + address bob = address(0xb0b); + + // Give the game proxy 1 extra ether, unregistered. + vm.deal(address(gameProxy), 1 ether); + + // Perform a bonded move. + Claim claim = _dummyClaim(); + + // Bond the first claim. + uint256 firstBond = _getRequiredBond(0); + vm.deal(alice, firstBond); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + vm.prank(alice); + gameProxy.attack{ value: firstBond }(disputed, 0, claim); + + // Bond the second claim. + uint256 secondBond = _getRequiredBond(1); + vm.deal(bob, secondBond); + (,,,, disputed,,) = gameProxy.claimData(1); + vm.prank(bob); + gameProxy.attack{ value: secondBond }(disputed, 1, claim); + + // Warp past the finalization period + vm.warp(block.timestamp + 3 days + 12 hours); + + // Resolve the game. + // Second claim wins, so bob should get alice's credit. + gameProxy.resolveClaim(2, 0); + gameProxy.resolveClaim(1, 0); + gameProxy.resolveClaim(0, 0); + gameProxy.resolve(); + + // Wait for finalization delay. + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Close the game. + gameProxy.closeGame(); + + // Claim credit once to trigger unlock period. + gameProxy.claimCredit(alice); + gameProxy.claimCredit(bob); + + // Wait for the withdrawal delay. + vm.warp(block.timestamp + delayedWeth.delay() + 1 seconds); + + // Make bob not be able to receive value by setting his contract code to something without + // `receive` + vm.etch(address(bob), address(L1Token).code); + + vm.expectRevert(BondTransferFailed.selector); + gameProxy.claimCredit(address(bob)); + } +} + +/// @title FaultDisputeGame_CloseGame_Test +/// @notice Tests the closeGame functionality of the `FaultDisputeGame` contract. +contract FaultDisputeGameV2_CloseGame_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that closeGame reverts if the game is not resolved + function test_closeGame_gameNotResolved_reverts() public { + vm.expectRevert(GameNotResolved.selector); + gameProxy.closeGame(); + } + + /// @notice Tests that closeGame reverts if the game is paused + function test_closeGame_gamePaused_reverts() public { + // Pause the system with the Superchain-wide identifier (address(0)). + vm.prank(superchainConfig.guardian()); + superchainConfig.pause(address(0)); + + // Attempting to close the game should now revert. + vm.expectRevert(GamePaused.selector); + gameProxy.closeGame(); + } + + /// @notice Tests that closeGame reverts if the game is not finalized + function test_closeGame_gameNotFinalized_reverts() public { + // Resolve the game + vm.warp(block.timestamp + 3 days + 12 hours); + gameProxy.resolveClaim(0, 0); + gameProxy.resolve(); + + // Don't wait the finalization delay + vm.expectRevert(GameNotFinalized.selector); + gameProxy.closeGame(); + } + + /// @notice Tests that closeGame succeeds for a proper game (normal distribution) + function test_closeGame_properGame_succeeds() public { + // Resolve the game + vm.warp(block.timestamp + 3 days + 12 hours); + gameProxy.resolveClaim(0, 0); + gameProxy.resolve(); + + // Wait for finalization delay + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Close the game and verify normal distribution mode + vm.expectEmit(true, true, true, true); + emit GameClosed(BondDistributionMode.NORMAL); + gameProxy.closeGame(); + assertEq(uint8(gameProxy.bondDistributionMode()), uint8(BondDistributionMode.NORMAL)); + + // Check that the anchor state was set correctly. + assertEq(address(gameProxy.anchorStateRegistry().anchorGame()), address(gameProxy)); + } + + /// @notice Tests that closeGame succeeds for an improper game (refund mode) + function test_closeGame_improperGame_succeeds() public { + // Resolve the game + vm.warp(block.timestamp + 3 days + 12 hours); + gameProxy.resolveClaim(0, 0); + gameProxy.resolve(); + + // Wait for finalization delay + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Mock the anchor registry to return improper game + vm.mockCall( + address(anchorStateRegistry), + abi.encodeCall(anchorStateRegistry.isGameProper, (IDisputeGame(address(gameProxy)))), + abi.encode(false, "") + ); + + // Close the game and verify refund mode + vm.expectEmit(true, true, true, true); + emit GameClosed(BondDistributionMode.REFUND); + gameProxy.closeGame(); + assertEq(uint8(gameProxy.bondDistributionMode()), uint8(BondDistributionMode.REFUND)); + } + + /// @notice Tests that multiple calls to closeGame succeed after initial distribution mode is + /// set + function test_closeGame_multipleCallsAfterSet_succeeds() public { + // Resolve and close the game first + vm.warp(block.timestamp + 3 days + 12 hours); + gameProxy.resolveClaim(0, 0); + gameProxy.resolve(); + + // Wait for finalization delay + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // First close sets the mode + gameProxy.closeGame(); + assertEq(uint8(gameProxy.bondDistributionMode()), uint8(BondDistributionMode.NORMAL)); + + // Subsequent closes should succeed without changing the mode + gameProxy.closeGame(); + assertEq(uint8(gameProxy.bondDistributionMode()), uint8(BondDistributionMode.NORMAL)); + + gameProxy.closeGame(); + assertEq(uint8(gameProxy.bondDistributionMode()), uint8(BondDistributionMode.NORMAL)); + } + + /// @notice Tests that closeGame called with any amount of gas either reverts (with OOG) or + /// updates the anchor state. This is specifically to verify that the try/catch inside + /// closeGame can't be called with just enough gas to OOG when calling the + /// AnchorStateRegistry but successfully execute the remainder of the function. + /// @param _gas Amount of gas to provide to closeGame. + function testFuzz_closeGame_canUpdateAnchorStateAndDoes_succeeds(uint256 _gas) public { + // Resolve and close the game first + vm.warp(block.timestamp + 3 days + 12 hours); + gameProxy.resolveClaim(0, 0); + gameProxy.resolve(); + + // Wait for finalization delay + vm.warp(block.timestamp + 3.5 days + 1 seconds); + + // Since providing *too* much gas isn't the issue here, bounding it to half the block gas + // limit is sufficient. We want to know that either (1) the function reverts or (2) the + // anchor state gets updated. If the function doesn't revert and the anchor state isn't + // updated then we have a problem. + _gas = bound(_gas, 0, block.gaslimit / 2); + + // The anchor state should not be the game proxy. + assert(address(gameProxy.anchorStateRegistry().anchorGame()) != address(gameProxy)); + + // Try closing the game. + try gameProxy.closeGame{ gas: _gas }() { + // If we got here, the function didn't revert, so the anchor state should have updated. + assert(address(gameProxy.anchorStateRegistry().anchorGame()) == address(gameProxy)); + } catch { + // Ok, function reverted. + } + } +} + +/// @title FaultDisputeGame_GetChallengerDuration_Test +/// @notice Tests the getChallengerDuration functionality and related resolution tests. +contract FaultDisputeGameV2_GetChallengerDuration_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that if the game is not in progress, querying of `getChallengerDuration` + /// reverts + function test_getChallengerDuration_gameNotInProgress_reverts() public { + // resolve the game + vm.warp(block.timestamp + gameProxy.maxClockDuration().raw()); + + gameProxy.resolveClaim(0, 0); + gameProxy.resolve(); + + vm.expectRevert(GameNotInProgress.selector); + gameProxy.getChallengerDuration(1); + } + + /// @notice Static unit test asserting that resolveClaim isn't possible if there's time left + /// for a counter. + function test_resolution_lastSecondDisputes_succeeds() public { + // The honest proposer created an honest root claim during setup - node 0 + + // Defender's turn + vm.warp(block.timestamp + 3.5 days - 1 seconds); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + // Chess clock time accumulated: + assertEq(gameProxy.getChallengerDuration(0).raw(), 3.5 days - 1 seconds); + assertEq(gameProxy.getChallengerDuration(1).raw(), 0); + + // Advance time by 1 second, so that the root claim challenger clock is expired. + vm.warp(block.timestamp + 1 seconds); + // Attempt a second attack against the root claim. This should revert since the challenger + // clock is expired. + uint256 expectedBond = _getRequiredBond(0); + vm.expectRevert(ClockTimeExceeded.selector); + gameProxy.attack{ value: expectedBond }(disputed, 0, _dummyClaim()); + // Chess clock time accumulated: + assertEq(gameProxy.getChallengerDuration(0).raw(), 3.5 days); + assertEq(gameProxy.getChallengerDuration(1).raw(), 1 seconds); + + // Should not be able to resolve the root claim or second counter yet. + vm.expectRevert(ClockNotExpired.selector); + gameProxy.resolveClaim(1, 0); + vm.expectRevert(OutOfOrderResolution.selector); + gameProxy.resolveClaim(0, 0); + + // Warp to the last second of the root claim defender clock. + vm.warp(block.timestamp + 3.5 days - 2 seconds); + // Attack the challenge to the root claim. This should succeed, since the defender clock is + // not expired. + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: _getRequiredBond(1) }(disputed, 1, _dummyClaim()); + // Chess clock time accumulated: + assertEq(gameProxy.getChallengerDuration(0).raw(), 3.5 days); + assertEq(gameProxy.getChallengerDuration(1).raw(), 3.5 days - 1 seconds); + assertEq(gameProxy.getChallengerDuration(2).raw(), 3.5 days - gameProxy.clockExtension().raw()); + + // Should not be able to resolve any claims yet. + vm.expectRevert(ClockNotExpired.selector); + gameProxy.resolveClaim(2, 0); + vm.expectRevert(ClockNotExpired.selector); + gameProxy.resolveClaim(1, 0); + vm.expectRevert(OutOfOrderResolution.selector); + gameProxy.resolveClaim(0, 0); + + vm.warp(block.timestamp + gameProxy.clockExtension().raw() - 1 seconds); + + // Should not be able to resolve any claims yet. + vm.expectRevert(ClockNotExpired.selector); + gameProxy.resolveClaim(2, 0); + vm.expectRevert(OutOfOrderResolution.selector); + gameProxy.resolveClaim(1, 0); + vm.expectRevert(OutOfOrderResolution.selector); + gameProxy.resolveClaim(0, 0); + + // Chess clock time accumulated: + assertEq(gameProxy.getChallengerDuration(0).raw(), 3.5 days); + assertEq(gameProxy.getChallengerDuration(1).raw(), 3.5 days); + assertEq(gameProxy.getChallengerDuration(2).raw(), 3.5 days - 1 seconds); + + // Warp past the challenge period for the root claim defender. Defending the root claim + // should now revert. + vm.warp(block.timestamp + 1 seconds); + expectedBond = _getRequiredBond(1); + vm.expectRevert(ClockTimeExceeded.selector); // no further move can be made + gameProxy.attack{ value: expectedBond }(disputed, 1, _dummyClaim()); + expectedBond = _getRequiredBond(2); + (,,,, disputed,,) = gameProxy.claimData(2); + vm.expectRevert(ClockTimeExceeded.selector); // no further move can be made + gameProxy.attack{ value: expectedBond }(disputed, 2, _dummyClaim()); + // Chess clock time accumulated: + assertEq(gameProxy.getChallengerDuration(0).raw(), 3.5 days); + assertEq(gameProxy.getChallengerDuration(1).raw(), 3.5 days); + assertEq(gameProxy.getChallengerDuration(2).raw(), 3.5 days); + + vm.expectRevert(OutOfOrderResolution.selector); + gameProxy.resolveClaim(1, 0); + vm.expectRevert(OutOfOrderResolution.selector); + gameProxy.resolveClaim(0, 0); + + // All clocks are expired. Resolve the game. + gameProxy.resolveClaim(2, 0); // Node 2 is resolved as UNCOUNTERED by default since it has no children + gameProxy.resolveClaim(1, 0); // Node 1 is resolved as COUNTERED since it has an UNCOUNTERED child + gameProxy.resolveClaim(0, 0); // Node 0 is resolved as UNCOUNTERED since it has no UNCOUNTERED children + + // Defender wins game since the root claim is uncountered + assertEq(uint8(gameProxy.resolve()), uint8(GameStatus.DEFENDER_WINS)); + } +} + +/// @title FaultDisputeGame_Unclassified_Test +/// @notice General tests that are not testing any function directly of the `FaultDisputeGame` +/// contract or are testing multiple functions at once. +contract FaultDisputeGameV2_Unclassified_Test is FaultDisputeGameV2_TestInit { + /// @notice Tests that the game's starting timestamp is set correctly. + function test_createdAt_succeeds() public view { + assertEq(gameProxy.createdAt().raw(), block.timestamp); + } + + /// @notice Tests that startingOutputRoot and it's getters are set correctly. + function test_startingOutputRootGetters_succeeds() public view { + (Hash root, uint256 l2BlockNumber) = gameProxy.startingOutputRoot(); + (Hash anchorRoot, uint256 anchorRootBlockNumber) = anchorStateRegistry.anchors(GAME_TYPE); + + assertEq(gameProxy.startingBlockNumber(), l2BlockNumber); + assertEq(gameProxy.startingBlockNumber(), anchorRootBlockNumber); + assertEq(Hash.unwrap(gameProxy.startingRootHash()), Hash.unwrap(root)); + assertEq(Hash.unwrap(gameProxy.startingRootHash()), Hash.unwrap(anchorRoot)); + } + + /// @notice Tests that the user cannot control the first 4 bytes of the CWIA data, disallowing + /// them to control the entrypoint when no calldata is provided to a call. + function test_cwiaCalldata_userCannotControlSelector_succeeds() public { + // Construct the expected CWIA data that the proxy will pass to the implementation, + // alongside any extra calldata passed by the user. + Hash l1Head = gameProxy.l1Head(); + bytes memory cwiaData = abi.encodePacked(address(this), gameProxy.rootClaim(), l1Head, gameProxy.extraData()); + + // We expect a `ReceiveETH` event to be emitted when 0 bytes of calldata are sent; The + // fallback is always reached *within the minimal proxy* in `LibClone`'s version of + // `clones-with-immutable-args` + vm.expectEmit(false, false, false, true); + emit ReceiveETH(0); + // We expect no delegatecall to the implementation contract if 0 bytes are sent. Assert + // that this happens 0 times. + vm.expectCall(address(gameImpl), cwiaData, 0); + (bool successA,) = address(gameProxy).call(hex""); + assertTrue(successA); + + // When calldata is forwarded, we do expect a delegatecall to the implementation. + bytes memory data = abi.encodePacked(gameProxy.l1Head.selector); + vm.expectCall(address(gameImpl), abi.encodePacked(data, cwiaData), 1); + (bool successB, bytes memory returnData) = address(gameProxy).call(data); + assertTrue(successB); + assertEq(returnData, abi.encode(l1Head)); + } +} + +contract FaultDispute_1v1_Actors_Test is FaultDisputeGameV2_TestInit { + /// @notice The honest actor + DisputeActor internal honest; + /// @notice The dishonest actor + DisputeActor internal dishonest; + + function setUp() public override { + // Setup the `FaultDisputeGame` + super.setUp(); + } + + /// @notice Fuzz test for a 1v1 output bisection dispute. + /// @notice The alphabet game has a constant status byte, and is not safe from someone being + /// dishonest in output bisection and then posting a correct execution trace bisection + /// root claim. This test does not cover this case (i.e. root claim of output bisection + /// is dishonest, root claim of execution trace bisection is made by the dishonest + /// actor but is honest, honest actor cannot attack it without risk of losing). + function testFuzz_outputBisection1v1honestRoot_succeeds(uint8 _divergeOutput, uint8 _divergeStep) public { + uint256[] memory honestL2Outputs = new uint256[](16); + for (uint256 i; i < honestL2Outputs.length; i++) { + honestL2Outputs[i] = i + 1; + } + bytes memory honestTrace = new bytes(256); + for (uint256 i; i < honestTrace.length; i++) { + honestTrace[i] = bytes1(uint8(i)); + } + + uint256 divergeAtOutput = bound(_divergeOutput, 0, 15); + uint256 divergeAtStep = bound(_divergeStep, 0, 7); + uint256 divergeStepOffset = (divergeAtOutput << 4) + divergeAtStep; + + uint256[] memory dishonestL2Outputs = new uint256[](16); + for (uint256 i; i < dishonestL2Outputs.length; i++) { + dishonestL2Outputs[i] = i >= divergeAtOutput ? 0xFF : i + 1; + } + bytes memory dishonestTrace = new bytes(256); + for (uint256 i; i < dishonestTrace.length; i++) { + dishonestTrace[i] = i >= divergeStepOffset ? bytes1(uint8(0xFF)) : bytes1(uint8(i)); + } + + // Run the actor test + _actorTest({ + _rootClaim: 16, + _absolutePrestateData: 0, + _honestTrace: honestTrace, + _honestL2Outputs: honestL2Outputs, + _dishonestTrace: dishonestTrace, + _dishonestL2Outputs: dishonestL2Outputs, + _expectedStatus: GameStatus.DEFENDER_WINS + }); + } + + /// @notice Static unit test for a 1v1 output bisection dispute. + function test_static_1v1honestRootGenesisAbsolutePrestate_succeeds() public { + // The honest l2 outputs are from [1, 16] in this game. + uint256[] memory honestL2Outputs = new uint256[](16); + for (uint256 i; i < honestL2Outputs.length; i++) { + honestL2Outputs[i] = i + 1; + } + // The honest trace covers all block -> block + 1 transitions, and is 256 bytes long, + // consisting of bytes [0, 255]. + bytes memory honestTrace = new bytes(256); + for (uint256 i; i < honestTrace.length; i++) { + honestTrace[i] = bytes1(uint8(i)); + } + + // The dishonest l2 outputs are from [2, 17] in this game. + uint256[] memory dishonestL2Outputs = new uint256[](16); + for (uint256 i; i < dishonestL2Outputs.length; i++) { + dishonestL2Outputs[i] = i + 2; + } + // The dishonest trace covers all block -> block + 1 transitions, and is 256 bytes long, + // consisting of all set bits. + bytes memory dishonestTrace = new bytes(256); + for (uint256 i; i < dishonestTrace.length; i++) { + dishonestTrace[i] = bytes1(0xFF); + } + + // Run the actor test + _actorTest({ + _rootClaim: 16, + _absolutePrestateData: 0, + _honestTrace: honestTrace, + _honestL2Outputs: honestL2Outputs, + _dishonestTrace: dishonestTrace, + _dishonestL2Outputs: dishonestL2Outputs, + _expectedStatus: GameStatus.DEFENDER_WINS + }); + } + + /// @notice Static unit test for a 1v1 output bisection dispute. + function test_static_1v1dishonestRootGenesisAbsolutePrestate_succeeds() public { + // The honest l2 outputs are from [1, 16] in this game. + uint256[] memory honestL2Outputs = new uint256[](16); + for (uint256 i; i < honestL2Outputs.length; i++) { + honestL2Outputs[i] = i + 1; + } + // The honest trace covers all block -> block + 1 transitions, and is 256 bytes long, + // consisting of bytes [0, 255]. + bytes memory honestTrace = new bytes(256); + for (uint256 i; i < honestTrace.length; i++) { + honestTrace[i] = bytes1(uint8(i)); + } + + // The dishonest l2 outputs are from [2, 17] in this game. + uint256[] memory dishonestL2Outputs = new uint256[](16); + for (uint256 i; i < dishonestL2Outputs.length; i++) { + dishonestL2Outputs[i] = i + 2; + } + // The dishonest trace covers all block -> block + 1 transitions, and is 256 bytes long, consisting + // of all set bits. + bytes memory dishonestTrace = new bytes(256); + for (uint256 i; i < dishonestTrace.length; i++) { + dishonestTrace[i] = bytes1(0xFF); + } + + // Run the actor test + _actorTest({ + _rootClaim: 17, + _absolutePrestateData: 0, + _honestTrace: honestTrace, + _honestL2Outputs: honestL2Outputs, + _dishonestTrace: dishonestTrace, + _dishonestL2Outputs: dishonestL2Outputs, + _expectedStatus: GameStatus.CHALLENGER_WINS + }); + } + + /// @notice Static unit test for a 1v1 output bisection dispute. + function test_static_1v1honestRoot_succeeds() public { + // The honest l2 outputs are from [1, 16] in this game. + uint256[] memory honestL2Outputs = new uint256[](16); + for (uint256 i; i < honestL2Outputs.length; i++) { + honestL2Outputs[i] = i + 1; + } + // The honest trace covers all block -> block + 1 transitions, and is 256 bytes long, consisting + // of bytes [0, 255]. + bytes memory honestTrace = new bytes(256); + for (uint256 i; i < honestTrace.length; i++) { + honestTrace[i] = bytes1(uint8(i)); + } + + // The dishonest l2 outputs are from [2, 17] in this game. + uint256[] memory dishonestL2Outputs = new uint256[](16); + for (uint256 i; i < dishonestL2Outputs.length; i++) { + dishonestL2Outputs[i] = i + 2; + } + // The dishonest trace covers all block -> block + 1 transitions, and is 256 bytes long, + // consisting of all zeros. + bytes memory dishonestTrace = new bytes(256); + + // Run the actor test + _actorTest({ + _rootClaim: 16, + _absolutePrestateData: 0, + _honestTrace: honestTrace, + _honestL2Outputs: honestL2Outputs, + _dishonestTrace: dishonestTrace, + _dishonestL2Outputs: dishonestL2Outputs, + _expectedStatus: GameStatus.DEFENDER_WINS + }); + } + + /// @notice Static unit test for a 1v1 output bisection dispute. + function test_static_1v1dishonestRoot_succeeds() public { + // The honest l2 outputs are from [1, 16] in this game. + uint256[] memory honestL2Outputs = new uint256[](16); + for (uint256 i; i < honestL2Outputs.length; i++) { + honestL2Outputs[i] = i + 1; + } + // The honest trace covers all block -> block + 1 transitions, and is 256 bytes long, + // consisting of bytes [0, 255]. + bytes memory honestTrace = new bytes(256); + for (uint256 i; i < honestTrace.length; i++) { + honestTrace[i] = bytes1(uint8(i)); + } + + // The dishonest l2 outputs are from [2, 17] in this game. + uint256[] memory dishonestL2Outputs = new uint256[](16); + for (uint256 i; i < dishonestL2Outputs.length; i++) { + dishonestL2Outputs[i] = i + 2; + } + // The dishonest trace covers all block -> block + 1 transitions, and is 256 bytes long, + // consisting of all zeros. + bytes memory dishonestTrace = new bytes(256); + + // Run the actor test + _actorTest({ + _rootClaim: 17, + _absolutePrestateData: 0, + _honestTrace: honestTrace, + _honestL2Outputs: honestL2Outputs, + _dishonestTrace: dishonestTrace, + _dishonestL2Outputs: dishonestL2Outputs, + _expectedStatus: GameStatus.CHALLENGER_WINS + }); + } + + /// @notice Static unit test for a 1v1 output bisection dispute. + function test_static_1v1correctRootHalfWay_succeeds() public { + // The honest l2 outputs are from [1, 16] in this game. + uint256[] memory honestL2Outputs = new uint256[](16); + for (uint256 i; i < honestL2Outputs.length; i++) { + honestL2Outputs[i] = i + 1; + } + // The honest trace covers all block -> block + 1 transitions, and is 256 bytes long, + // consisting of bytes [0, 255]. + bytes memory honestTrace = new bytes(256); + for (uint256 i; i < honestTrace.length; i++) { + honestTrace[i] = bytes1(uint8(i)); + } + + // The dishonest l2 outputs are half correct, half incorrect. + uint256[] memory dishonestL2Outputs = new uint256[](16); + for (uint256 i; i < dishonestL2Outputs.length; i++) { + dishonestL2Outputs[i] = i > 7 ? 0xFF : i + 1; + } + // The dishonest trace is half correct, half incorrect. + bytes memory dishonestTrace = new bytes(256); + for (uint256 i; i < dishonestTrace.length; i++) { + dishonestTrace[i] = i > (127 + 4) ? bytes1(0xFF) : bytes1(uint8(i)); + } + + // Run the actor test + _actorTest({ + _rootClaim: 16, + _absolutePrestateData: 0, + _honestTrace: honestTrace, + _honestL2Outputs: honestL2Outputs, + _dishonestTrace: dishonestTrace, + _dishonestL2Outputs: dishonestL2Outputs, + _expectedStatus: GameStatus.DEFENDER_WINS + }); + } + + /// @notice Static unit test for a 1v1 output bisection dispute. + function test_static_1v1dishonestRootHalfWay_succeeds() public { + // The honest l2 outputs are from [1, 16] in this game. + uint256[] memory honestL2Outputs = new uint256[](16); + for (uint256 i; i < honestL2Outputs.length; i++) { + honestL2Outputs[i] = i + 1; + } + // The honest trace covers all block -> block + 1 transitions, and is 256 bytes long, + // consisting of bytes [0, 255]. + bytes memory honestTrace = new bytes(256); + for (uint256 i; i < honestTrace.length; i++) { + honestTrace[i] = bytes1(uint8(i)); + } + + // The dishonest l2 outputs are half correct, half incorrect. + uint256[] memory dishonestL2Outputs = new uint256[](16); + for (uint256 i; i < dishonestL2Outputs.length; i++) { + dishonestL2Outputs[i] = i > 7 ? 0xFF : i + 1; + } + // The dishonest trace is half correct, half incorrect. + bytes memory dishonestTrace = new bytes(256); + for (uint256 i; i < dishonestTrace.length; i++) { + dishonestTrace[i] = i > (127 + 4) ? bytes1(0xFF) : bytes1(uint8(i)); + } + + // Run the actor test + _actorTest({ + _rootClaim: 0xFF, + _absolutePrestateData: 0, + _honestTrace: honestTrace, + _honestL2Outputs: honestL2Outputs, + _dishonestTrace: dishonestTrace, + _dishonestL2Outputs: dishonestL2Outputs, + _expectedStatus: GameStatus.CHALLENGER_WINS + }); + } + + /// @notice Static unit test for a 1v1 output bisection dispute. + function test_static_1v1correctAbsolutePrestate_succeeds() public { + // The honest l2 outputs are from [1, 16] in this game. + uint256[] memory honestL2Outputs = new uint256[](16); + for (uint256 i; i < honestL2Outputs.length; i++) { + honestL2Outputs[i] = i + 1; + } + // The honest trace covers all block -> block + 1 transitions, and is 256 bytes long, + // consisting of bytes [0, 255]. + bytes memory honestTrace = new bytes(256); + for (uint256 i; i < honestTrace.length; i++) { + honestTrace[i] = bytes1(uint8(i)); + } + + // The dishonest l2 outputs are half correct, half incorrect. + uint256[] memory dishonestL2Outputs = new uint256[](16); + for (uint256 i; i < dishonestL2Outputs.length; i++) { + dishonestL2Outputs[i] = i > 7 ? 0xFF : i + 1; + } + // The dishonest trace correct is half correct, half incorrect. + bytes memory dishonestTrace = new bytes(256); + for (uint256 i; i < dishonestTrace.length; i++) { + dishonestTrace[i] = i > 127 ? bytes1(0xFF) : bytes1(uint8(i)); + } + + // Run the actor test + _actorTest({ + _rootClaim: 16, + _absolutePrestateData: 0, + _honestTrace: honestTrace, + _honestL2Outputs: honestL2Outputs, + _dishonestTrace: dishonestTrace, + _dishonestL2Outputs: dishonestL2Outputs, + _expectedStatus: GameStatus.DEFENDER_WINS + }); + } + + /// @notice Static unit test for a 1v1 output bisection dispute. + function test_static_1v1dishonestAbsolutePrestate_succeeds() public { + // The honest l2 outputs are from [1, 16] in this game. + uint256[] memory honestL2Outputs = new uint256[](16); + for (uint256 i; i < honestL2Outputs.length; i++) { + honestL2Outputs[i] = i + 1; + } + // The honest trace covers all block -> block + 1 transitions, and is 256 bytes long, + // consisting of bytes [0, 255]. + bytes memory honestTrace = new bytes(256); + for (uint256 i; i < honestTrace.length; i++) { + honestTrace[i] = bytes1(uint8(i)); + } + + // The dishonest l2 outputs are half correct, half incorrect. + uint256[] memory dishonestL2Outputs = new uint256[](16); + for (uint256 i; i < dishonestL2Outputs.length; i++) { + dishonestL2Outputs[i] = i > 7 ? 0xFF : i + 1; + } + // The dishonest trace correct is half correct, half incorrect. + bytes memory dishonestTrace = new bytes(256); + for (uint256 i; i < dishonestTrace.length; i++) { + dishonestTrace[i] = i > 127 ? bytes1(0xFF) : bytes1(uint8(i)); + } + + // Run the actor test + _actorTest({ + _rootClaim: 0xFF, + _absolutePrestateData: 0, + _honestTrace: honestTrace, + _honestL2Outputs: honestL2Outputs, + _dishonestTrace: dishonestTrace, + _dishonestL2Outputs: dishonestL2Outputs, + _expectedStatus: GameStatus.CHALLENGER_WINS + }); + } + + /// @notice Static unit test for a 1v1 output bisection dispute. + function test_static_1v1honestRootFinalInstruction_succeeds() public { + // The honest l2 outputs are from [1, 16] in this game. + uint256[] memory honestL2Outputs = new uint256[](16); + for (uint256 i; i < honestL2Outputs.length; i++) { + honestL2Outputs[i] = i + 1; + } + // The honest trace covers all block -> block + 1 transitions, and is 256 bytes long, + // consisting of bytes [0, 255]. + bytes memory honestTrace = new bytes(256); + for (uint256 i; i < honestTrace.length; i++) { + honestTrace[i] = bytes1(uint8(i)); + } + + // The dishonest l2 outputs are half correct, half incorrect. + uint256[] memory dishonestL2Outputs = new uint256[](16); + for (uint256 i; i < dishonestL2Outputs.length; i++) { + dishonestL2Outputs[i] = i > 7 ? 0xFF : i + 1; + } + // The dishonest trace is half correct, and correct all the way up to the final instruction + // of the exec subgame. + bytes memory dishonestTrace = new bytes(256); + for (uint256 i; i < dishonestTrace.length; i++) { + dishonestTrace[i] = i > (127 + 7) ? bytes1(0xFF) : bytes1(uint8(i)); + } + + // Run the actor test + _actorTest({ + _rootClaim: 16, + _absolutePrestateData: 0, + _honestTrace: honestTrace, + _honestL2Outputs: honestL2Outputs, + _dishonestTrace: dishonestTrace, + _dishonestL2Outputs: dishonestL2Outputs, + _expectedStatus: GameStatus.DEFENDER_WINS + }); + } + + /// @notice Static unit test for a 1v1 output bisection dispute. + function test_static_1v1dishonestRootFinalInstruction_succeeds() public { + // The honest l2 outputs are from [1, 16] in this game. + uint256[] memory honestL2Outputs = new uint256[](16); + for (uint256 i; i < honestL2Outputs.length; i++) { + honestL2Outputs[i] = i + 1; + } + // The honest trace covers all block -> block + 1 transitions, and is 256 bytes long, + // consisting of bytes [0, 255]. + bytes memory honestTrace = new bytes(256); + for (uint256 i; i < honestTrace.length; i++) { + honestTrace[i] = bytes1(uint8(i)); + } + + // The dishonest l2 outputs are half correct, half incorrect. + uint256[] memory dishonestL2Outputs = new uint256[](16); + for (uint256 i; i < dishonestL2Outputs.length; i++) { + dishonestL2Outputs[i] = i > 7 ? 0xFF : i + 1; + } + // The dishonest trace is half correct, and correct all the way up to the final instruction + // of the exec subgame. + bytes memory dishonestTrace = new bytes(256); + for (uint256 i; i < dishonestTrace.length; i++) { + dishonestTrace[i] = i > (127 + 7) ? bytes1(0xFF) : bytes1(uint8(i)); + } + + // Run the actor test + _actorTest({ + _rootClaim: 0xFF, + _absolutePrestateData: 0, + _honestTrace: honestTrace, + _honestL2Outputs: honestL2Outputs, + _dishonestTrace: dishonestTrace, + _dishonestL2Outputs: dishonestL2Outputs, + _expectedStatus: GameStatus.CHALLENGER_WINS + }); + } + + //////////////////////////////////////////////////////////////// + // HELPERS // + //////////////////////////////////////////////////////////////// + + /// @notice Helper to run a 1v1 actor test + function _actorTest( + uint256 _rootClaim, + uint256 _absolutePrestateData, + bytes memory _honestTrace, + uint256[] memory _honestL2Outputs, + bytes memory _dishonestTrace, + uint256[] memory _dishonestL2Outputs, + GameStatus _expectedStatus + ) + internal + { + if (isForkTest()) { + // Mock the call anchorStateRegistry.getAnchorRoot() to return 0 as the block number + (Hash root,) = anchorStateRegistry.getAnchorRoot(); + vm.mockCall( + address(anchorStateRegistry), + abi.encodeCall(IAnchorStateRegistry.getAnchorRoot, ()), + abi.encode(root, 0) + ); + } + + // Setup the environment + bytes memory absolutePrestateData = + _setup({ _absolutePrestateData: _absolutePrestateData, _rootClaim: _rootClaim }); + + // Create actors + _createActors({ + _honestTrace: _honestTrace, + _honestPreStateData: absolutePrestateData, + _honestL2Outputs: _honestL2Outputs, + _dishonestTrace: _dishonestTrace, + _dishonestPreStateData: absolutePrestateData, + _dishonestL2Outputs: _dishonestL2Outputs + }); + + // Exhaust all moves from both actors + _exhaustMoves(); + + // Resolve the game and assert that the defender won + _warpAndResolve(); + assertEq(uint8(gameProxy.status()), uint8(_expectedStatus)); + } + + /// @notice Helper to setup the 1v1 test + function _setup( + uint256 _absolutePrestateData, + uint256 _rootClaim + ) + internal + returns (bytes memory absolutePrestateData_) + { + absolutePrestateData_ = abi.encode(_absolutePrestateData); + Claim absolutePrestateExec = + _changeClaimStatus(Claim.wrap(keccak256(absolutePrestateData_)), VMStatuses.UNFINISHED); + Claim rootClaim = Claim.wrap(bytes32(uint256(_rootClaim))); + super.init({ rootClaim: rootClaim, absolutePrestate: absolutePrestateExec, l2BlockNumber: _rootClaim }); + } + + /// @notice Helper to create actors for the 1v1 dispute. + function _createActors( + bytes memory _honestTrace, + bytes memory _honestPreStateData, + uint256[] memory _honestL2Outputs, + bytes memory _dishonestTrace, + bytes memory _dishonestPreStateData, + uint256[] memory _dishonestL2Outputs + ) + internal + { + honest = new HonestDisputeActor({ + _gameProxy: IFaultDisputeGame(address(gameProxy)), + _l2Outputs: _honestL2Outputs, + _trace: _honestTrace, + _preStateData: _honestPreStateData + }); + dishonest = new HonestDisputeActor({ + _gameProxy: IFaultDisputeGame(address(gameProxy)), + _l2Outputs: _dishonestL2Outputs, + _trace: _dishonestTrace, + _preStateData: _dishonestPreStateData + }); + + vm.deal(address(honest), 100 ether); + vm.deal(address(dishonest), 100 ether); + vm.label(address(honest), "HonestActor"); + vm.label(address(dishonest), "DishonestActor"); + } + + /// @notice Helper to exhaust all moves from both actors. + function _exhaustMoves() internal { + while (true) { + // Allow the dishonest actor to make their moves, and then the honest actor. + (uint256 numMovesA,) = dishonest.move(); + (uint256 numMovesB, bool success) = honest.move(); + + require(success, "FaultDispute_1v1_Actors_Test: Honest actor's moves should always be successful"); + + // If both actors have run out of moves, we're done. + if (numMovesA == 0 && numMovesB == 0) break; + } + } + + /// @notice Helper to warp past the chess clock and resolve all claims within the dispute game. + function _warpAndResolve() internal { + // Warp past the chess clock + vm.warp(block.timestamp + 3 days + 12 hours); + + // Resolve all claims in reverse order. We allow `resolveClaim` calls to fail due to the + // check that prevents claims with no subgames attached from being passed to + // `resolveClaim`. There's also a check in `resolve` to ensure all children have been + // resolved before global resolution, which catches any unresolved subgames here. + for (uint256 i = gameProxy.claimDataLen(); i > 0; i--) { + (bool success,) = address(gameProxy).call(abi.encodeCall(gameProxy.resolveClaim, (i - 1, 0))); + assertTrue(success); + } + gameProxy.resolve(); + } +} diff --git a/packages/contracts-bedrock/test/dispute/v2/PermissionedDisputeGameV2.t.sol b/packages/contracts-bedrock/test/dispute/v2/PermissionedDisputeGameV2.t.sol new file mode 100644 index 00000000000..e256ba17fa2 --- /dev/null +++ b/packages/contracts-bedrock/test/dispute/v2/PermissionedDisputeGameV2.t.sol @@ -0,0 +1,270 @@ +// SPDX-License-Identifier: MIT +pragma solidity ^0.8.15; + +// Testing +import { DisputeGameFactory_TestInit } from "test/dispute/DisputeGameFactory.t.sol"; +import { AlphabetVM } from "test/mocks/AlphabetVM.sol"; +// Libraries +import "src/dispute/lib/Types.sol"; +import "src/dispute/lib/Errors.sol"; + +// Interfaces +import { IPermissionedDisputeGameV2 } from "interfaces/dispute/v2/IPermissionedDisputeGameV2.sol"; + +/// @title PermissionedDisputeGameV2_TestInit +/// @notice Reusable test initialization for `PermissionedDisputeGame` tests. +contract PermissionedDisputeGameV2_TestInit is DisputeGameFactory_TestInit { + /// @notice The type of the game being tested. + GameType internal immutable GAME_TYPE = GameTypes.PERMISSIONED_CANNON; + /// @notice Mock proposer key + address internal constant PROPOSER = address(0xfacade9); + /// @notice Mock challenger key + address internal constant CHALLENGER = address(0xfacadec); + + /// @notice The implementation of the game. + IPermissionedDisputeGameV2 internal gameImpl; + /// @notice The `Clone` proxy of the game. + IPermissionedDisputeGameV2 internal gameProxy; + + /// @notice The extra data passed to the game for initialization. + bytes internal extraData; + + /// @notice The root claim of the game. + Claim internal rootClaim; + /// @notice An arbitrary root claim for testing. + Claim internal arbitaryRootClaim = Claim.wrap(bytes32(uint256(123))); + /// @notice Minimum bond value that covers all possible moves. + uint256 internal constant MIN_BOND = 50 ether; + + /// @notice The preimage of the absolute prestate claim + bytes internal absolutePrestateData; + /// @notice The absolute prestate of the trace. + Claim internal absolutePrestate; + /// @notice A valid l2BlockNumber that comes after the current anchor root block. + uint256 validL2BlockNumber; + + event Move(uint256 indexed parentIndex, Claim indexed pivot, address indexed claimant); + + function init(Claim _rootClaim, Claim _absolutePrestate, uint256 _l2BlockNumber) public { + // Set the time to a realistic date. + if (!isForkTest()) { + vm.warp(1690906994); + } + + // Fund the proposer on this fork. + vm.deal(PROPOSER, 100 ether); + + // Set the extra data for the game creation + extraData = abi.encode(_l2BlockNumber); + + (address _impl, AlphabetVM _vm,) = setupPermissionedDisputeGameV2(_absolutePrestate, PROPOSER, CHALLENGER); + gameImpl = IPermissionedDisputeGameV2(_impl); + + // Create a new game. + uint256 bondAmount = disputeGameFactory.initBonds(GAME_TYPE); + vm.mockCall( + address(anchorStateRegistry), + abi.encodeCall(anchorStateRegistry.anchors, (GAME_TYPE)), + abi.encode(_rootClaim, 0) + ); + vm.prank(PROPOSER, PROPOSER); + gameProxy = IPermissionedDisputeGameV2( + payable(address(disputeGameFactory.create{ value: bondAmount }(GAME_TYPE, _rootClaim, extraData))) + ); + + // Check immutables + assertEq(gameProxy.proposer(), PROPOSER); + assertEq(gameProxy.challenger(), CHALLENGER); + assertEq(gameProxy.gameType().raw(), GAME_TYPE.raw()); + assertEq(gameProxy.absolutePrestate().raw(), _absolutePrestate.raw()); + assertEq(gameProxy.maxGameDepth(), 2 ** 3); + assertEq(gameProxy.splitDepth(), 2 ** 2); + assertEq(gameProxy.clockExtension().raw(), 3 hours); + assertEq(gameProxy.maxClockDuration().raw(), 3.5 days); + assertEq(address(gameProxy.weth()), address(delayedWeth)); + assertEq(address(gameProxy.anchorStateRegistry()), address(anchorStateRegistry)); + assertEq(address(gameProxy.vm()), address(_vm)); + assertEq(address(gameProxy.gameCreator()), PROPOSER); + assertEq(gameProxy.l2ChainId(), l2ChainId); + + // Label the proxy + vm.label(address(gameProxy), "FaultDisputeGame_Clone"); + } + + function setUp() public override { + absolutePrestateData = abi.encode(0); + absolutePrestate = _changeClaimStatus(Claim.wrap(keccak256(absolutePrestateData)), VMStatuses.UNFINISHED); + + super.setUp(); + + // Get the actual anchor roots + (Hash root, uint256 l2BlockNumber) = anchorStateRegistry.getAnchorRoot(); + validL2BlockNumber = l2BlockNumber + 1; + rootClaim = Claim.wrap(Hash.unwrap(root)); + init({ _rootClaim: rootClaim, _absolutePrestate: absolutePrestate, _l2BlockNumber: validL2BlockNumber }); + } + + /// @dev Helper to return a pseudo-random claim + function _dummyClaim() internal view returns (Claim) { + return Claim.wrap(keccak256(abi.encode(gasleft()))); + } + + /// @dev Helper to get the required bond for the given claim index. + function _getRequiredBond(uint256 _claimIndex) internal view returns (uint256 bond_) { + (,,,,, Position parent,) = gameProxy.claimData(_claimIndex); + Position pos = parent.move(true); + bond_ = gameProxy.getRequiredBond(pos); + } + + /// @dev Helper to change the VM status byte of a claim. + function _changeClaimStatus(Claim _claim, VMStatus _status) internal pure returns (Claim out_) { + assembly { + out_ := or(and(not(shl(248, 0xFF)), _claim), shl(248, _status)) + } + } + + fallback() external payable { } + + receive() external payable { } +} + +/// @title PermissionedDisputeGameV2_Version_Test +/// @notice Tests the `version` function of the `PermissionedDisputeGame` contract. +contract PermissionedDisputeGameV2_Version_Test is PermissionedDisputeGameV2_TestInit { + /// @notice Tests that the game's version function returns a string. + function test_version_works() public view { + assertTrue(bytes(gameProxy.version()).length > 0); + } +} + +/// @title PermissionedDisputeGameV2_Step_Test +/// @notice Tests the `step` function of the `PermissionedDisputeGame` contract. +contract PermissionedDisputeGameV2_Step_Test is PermissionedDisputeGameV2_TestInit { + /// @notice Tests that step works properly. + function test_step_succeeds() public { + // Give the test contract some ether + vm.deal(CHALLENGER, 1_000 ether); + + vm.startPrank(CHALLENGER, CHALLENGER); + + // Make claims all the way down the tree. + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: _getRequiredBond(0) }(disputed, 0, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.attack{ value: _getRequiredBond(1) }(disputed, 1, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.attack{ value: _getRequiredBond(2) }(disputed, 2, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(3); + gameProxy.attack{ value: _getRequiredBond(3) }(disputed, 3, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(4); + gameProxy.attack{ value: _getRequiredBond(4) }(disputed, 4, _changeClaimStatus(_dummyClaim(), VMStatuses.PANIC)); + (,,,, disputed,,) = gameProxy.claimData(5); + gameProxy.attack{ value: _getRequiredBond(5) }(disputed, 5, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(6); + gameProxy.attack{ value: _getRequiredBond(6) }(disputed, 6, _dummyClaim()); + (,,,, disputed,,) = gameProxy.claimData(7); + gameProxy.attack{ value: _getRequiredBond(7) }(disputed, 7, _dummyClaim()); + + // Verify game state before step + assertEq(uint256(gameProxy.status()), uint256(GameStatus.IN_PROGRESS)); + + gameProxy.addLocalData(LocalPreimageKey.DISPUTED_L2_BLOCK_NUMBER, 8, 0); + gameProxy.step(8, true, absolutePrestateData, hex""); + + vm.warp(block.timestamp + gameProxy.maxClockDuration().raw() + 1); + gameProxy.resolveClaim(8, 0); + gameProxy.resolveClaim(7, 0); + gameProxy.resolveClaim(6, 0); + gameProxy.resolveClaim(5, 0); + gameProxy.resolveClaim(4, 0); + gameProxy.resolveClaim(3, 0); + gameProxy.resolveClaim(2, 0); + gameProxy.resolveClaim(1, 0); + + gameProxy.resolveClaim(0, 0); + gameProxy.resolve(); + + assertEq(uint256(gameProxy.status()), uint256(GameStatus.CHALLENGER_WINS)); + assertEq(gameProxy.resolvedAt().raw(), block.timestamp); + (, address counteredBy,,,,,) = gameProxy.claimData(0); + assertEq(counteredBy, CHALLENGER); + } +} + +/// @title PermissionedDisputeGameV2_Unclassified_Test +/// @notice General tests that are not testing any function directly of the +/// `PermissionedDisputeGame` contract or are testing multiple functions at once. +contract PermissionedDisputeGameV2_Unclassified_Test is PermissionedDisputeGameV2_TestInit { + /// @notice Tests that the proposer can create a permissioned dispute game. + function test_createGame_proposer_succeeds() public { + uint256 bondAmount = disputeGameFactory.initBonds(GAME_TYPE); + vm.prank(PROPOSER, PROPOSER); + disputeGameFactory.create{ value: bondAmount }(GAME_TYPE, arbitaryRootClaim, abi.encode(validL2BlockNumber)); + } + + /// @notice Tests that the permissioned game cannot be created by any address other than the + /// proposer. + function testFuzz_createGame_notProposer_reverts(address _p) public { + vm.assume(_p != PROPOSER); + + uint256 bondAmount = disputeGameFactory.initBonds(GAME_TYPE); + vm.deal(_p, bondAmount); + vm.prank(_p, _p); + vm.expectRevert(BadAuth.selector); + disputeGameFactory.create{ value: bondAmount }(GAME_TYPE, arbitaryRootClaim, abi.encode(validL2BlockNumber)); + } + + /// @notice Tests that the challenger can participate in a permissioned dispute game. + function test_participateInGame_challenger_succeeds() public { + vm.startPrank(CHALLENGER, CHALLENGER); + uint256 firstBond = _getRequiredBond(0); + vm.deal(CHALLENGER, firstBond); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: firstBond }(disputed, 0, Claim.wrap(0)); + uint256 secondBond = _getRequiredBond(1); + vm.deal(CHALLENGER, secondBond); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.defend{ value: secondBond }(disputed, 1, Claim.wrap(0)); + uint256 thirdBond = _getRequiredBond(2); + vm.deal(CHALLENGER, thirdBond); + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.move{ value: thirdBond }(disputed, 2, Claim.wrap(0), true); + vm.stopPrank(); + } + + /// @notice Tests that the proposer can participate in a permissioned dispute game. + function test_participateInGame_proposer_succeeds() public { + vm.startPrank(PROPOSER, PROPOSER); + uint256 firstBond = _getRequiredBond(0); + vm.deal(PROPOSER, firstBond); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + gameProxy.attack{ value: firstBond }(disputed, 0, Claim.wrap(0)); + uint256 secondBond = _getRequiredBond(1); + vm.deal(PROPOSER, secondBond); + (,,,, disputed,,) = gameProxy.claimData(1); + gameProxy.defend{ value: secondBond }(disputed, 1, Claim.wrap(0)); + uint256 thirdBond = _getRequiredBond(2); + vm.deal(PROPOSER, thirdBond); + (,,,, disputed,,) = gameProxy.claimData(2); + gameProxy.move{ value: thirdBond }(disputed, 2, Claim.wrap(0), true); + vm.stopPrank(); + } + + /// @notice Tests that addresses that are not the proposer or challenger cannot participate in + /// a permissioned dispute game. + function test_participateInGame_notAuthorized_reverts(address _p) public { + vm.assume(_p != PROPOSER && _p != CHALLENGER); + + vm.startPrank(_p, _p); + (,,,, Claim disputed,,) = gameProxy.claimData(0); + vm.expectRevert(BadAuth.selector); + gameProxy.attack(disputed, 0, Claim.wrap(0)); + vm.expectRevert(BadAuth.selector); + gameProxy.defend(disputed, 0, Claim.wrap(0)); + vm.expectRevert(BadAuth.selector); + gameProxy.move(disputed, 0, Claim.wrap(0), true); + vm.expectRevert(BadAuth.selector); + gameProxy.step(0, true, absolutePrestateData, hex""); + vm.stopPrank(); + } +} diff --git a/packages/contracts-bedrock/test/invariants/OptimismPortal2.t.sol b/packages/contracts-bedrock/test/invariants/OptimismPortal2.t.sol index a0dc3affa9d..63d05ad7a4f 100644 --- a/packages/contracts-bedrock/test/invariants/OptimismPortal2.t.sol +++ b/packages/contracts-bedrock/test/invariants/OptimismPortal2.t.sol @@ -143,6 +143,7 @@ contract OptimismPortal2_Invariant_Harness is DisputeGameFactory_TestInit { // Fund the portal so that we can withdraw ETH. vm.deal(address(ethLockbox), 0xFFFFFFFF); + vm.deal(address(optimismPortal2), 0xFFFFFFFF); } } diff --git a/packages/contracts-bedrock/test/libraries/SemverComp.t.sol b/packages/contracts-bedrock/test/libraries/SemverComp.t.sol new file mode 100644 index 00000000000..3bdf2b2cc9b --- /dev/null +++ b/packages/contracts-bedrock/test/libraries/SemverComp.t.sol @@ -0,0 +1,192 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.15; + +// Forge +import { Test } from "forge-std/Test.sol"; + +// Libraries +import { JSONParserLib } from "solady/src/utils/JSONParserLib.sol"; +import { SemverComp } from "src/libraries/SemverComp.sol"; + +/// @title SemverComp_Harness +/// @notice Exposes internal functions of `SemverComp` for testing. +contract SemverComp_Harness { + /// @notice Parses a semver string into a Semver struct. This is a wrapper around + /// `SemverComp.parse` that returns the major, minor, and patch components as + /// separate values. + /// @param _semver The semver string to parse. + /// @return major_ The major version. + /// @return minor_ The minor version. + /// @return patch_ The patch version. + function parse(string memory _semver) external pure returns (uint256 major_, uint256 minor_, uint256 patch_) { + SemverComp.Semver memory v = SemverComp.parse(_semver); + return (v.major, v.minor, v.patch); + } +} + +/// @title SemverComp_TestInit +/// @notice Reusable test initialization for `SemverComp` tests. +contract SemverComp_TestInit is Test { + SemverComp_Harness internal harness; + + /// @notice Sets up the test environment. + function setUp() public { + harness = new SemverComp_Harness(); + } + + /// @notice Asserts that the parsed semver components match the expected values. + /// @param _semver The semver string to parse. + /// @param _major The expected major version. + /// @param _minor The expected minor version. + /// @param _patch The expected patch version. + function assertParsedEq(string memory _semver, uint256 _major, uint256 _minor, uint256 _patch) internal view { + (uint256 major, uint256 minor, uint256 patch) = harness.parse(_semver); + assertEq(major, _major, "major mismatch"); + assertEq(minor, _minor, "minor mismatch"); + assertEq(patch, _patch, "patch mismatch"); + } +} + +/// @title SemverComp_parse_Test +/// @notice Tests the `parse` function behavior. +contract SemverComp_parse_Test is SemverComp_TestInit { + /// @notice Parses the minimal version. + function test_parse_basicZero_succeeds() external view { + assertParsedEq("0.0.0", 0, 0, 0); + } + + /// @notice Parses a standard version. + function test_parse_basic123_succeeds() external view { + assertParsedEq("1.2.3", 1, 2, 3); + } + + /// @notice Ignores prerelease identifiers. + function test_parse_withPrerelease_succeeds() external view { + assertParsedEq("1.2.3-alpha", 1, 2, 3); + assertParsedEq("1.2.3-alpha.1", 1, 2, 3); + assertParsedEq("10.20.30-rc.1", 10, 20, 30); + } + + /// @notice Ignores build metadata. + function test_parse_withBuildMetadataOnly_succeeds() external view { + assertParsedEq("1.2.3+build.5", 1, 2, 3); + assertParsedEq("1.2.3+20240101", 1, 2, 3); + } + + /// @notice Ignores prerelease and build metadata together. + function test_parse_withPrereleaseAndBuild_succeeds() external view { + assertParsedEq("1.2.3-rc.1+build.5", 1, 2, 3); + assertParsedEq("2.0.0-beta+exp.sha.5114f85", 2, 0, 0); + } + + /// @notice Reverts when fewer than 3 dot-separated core parts are present. + function test_parse_lessThanThreeParts_reverts() external { + vm.expectRevert(SemverComp.SemverComp_InvalidSemverParts.selector); + harness.parse("1.2"); + + vm.expectRevert(SemverComp.SemverComp_InvalidSemverParts.selector); + harness.parse("1"); + + vm.expectRevert(SemverComp.SemverComp_InvalidSemverParts.selector); + harness.parse(""); + } + + /// @notice Current behavior: extra dot-components beyond the core 3 are ignored. + function test_parse_extraDotComponents_succeeds() external view { + assertParsedEq("1.2.3.4", 1, 2, 3); + assertParsedEq("1.2.3.4.5", 1, 2, 3); + } + + /// @notice Reverts on non-numeric core parts. + function test_parse_nonNumeric_reverts() external { + vm.expectRevert(JSONParserLib.ParsingFailed.selector); + harness.parse("a.b.c"); + + vm.expectRevert(JSONParserLib.ParsingFailed.selector); + harness.parse("1.b.3"); + + vm.expectRevert(JSONParserLib.ParsingFailed.selector); + harness.parse("1.2.c"); + } + + /// @notice Reverts on certain commonly malformed inputs. + function test_parse_malformedInputs_reverts() external { + // Leading/trailing whitespace + vm.expectRevert(JSONParserLib.ParsingFailed.selector); + harness.parse(" 1.2.3"); + vm.expectRevert(JSONParserLib.ParsingFailed.selector); + harness.parse("1.2.3 "); + + // "v" prefix + vm.expectRevert(JSONParserLib.ParsingFailed.selector); + harness.parse("v1.2.3"); + } +} + +/// @title SemverComp_Eq_Test +/// @notice Tests the `eq` function behavior. +contract SemverComp_Eq_Test is SemverComp_TestInit { + function test_eq_succeeds() external pure { + assertTrue(SemverComp.eq("1.2.3", "1.2.3")); + + assertFalse(SemverComp.eq("1.2.3", "1.2.4")); + assertFalse(SemverComp.eq("1.2.3", "1.3.3")); + assertFalse(SemverComp.eq("1.2.3", "2.2.3")); + } +} + +/// @title SemverComp_Lt_Test +/// @notice Tests the `lt` function behavior. +contract SemverComp_Lt_Test is SemverComp_TestInit { + function test_lt_succeeds() external pure { + assertTrue(SemverComp.lt("1.2.3", "1.2.4")); + assertTrue(SemverComp.lt("1.2.3", "1.3.0")); + assertTrue(SemverComp.lt("1.2.3", "2.0.0")); + + assertFalse(SemverComp.lt("1.2.3", "1.2.3")); + assertFalse(SemverComp.lt("1.2.3", "1.2.2")); + assertFalse(SemverComp.lt("2.0.0", "1.9.9")); + } +} + +/// @title SemverComp_Lte_Test +/// @notice Tests the `lte` function behavior. +contract SemverComp_Lte_Test is SemverComp_TestInit { + function test_lte_succeeds() external pure { + assertTrue(SemverComp.lte("1.2.3", "1.2.3")); + assertTrue(SemverComp.lte("1.2.3", "1.2.4")); + assertTrue(SemverComp.lte("1.2.3", "1.3.0")); + assertTrue(SemverComp.lte("1.2.3", "2.0.0")); + + assertFalse(SemverComp.lte("1.2.3", "1.2.2")); + assertFalse(SemverComp.lte("2.0.0", "1.9.9")); + } +} + +/// @title SemverComp_Gt_Test +/// @notice Tests the `gt` function behavior. +contract SemverComp_Gt_Test is SemverComp_TestInit { + function test_gt_succeeds() external pure { + assertTrue(SemverComp.gt("1.2.4", "1.2.3")); + assertTrue(SemverComp.gt("1.3.0", "1.2.3")); + assertTrue(SemverComp.gt("2.0.0", "1.2.3")); + + assertFalse(SemverComp.gt("1.2.3", "1.2.3")); + assertFalse(SemverComp.gt("1.2.2", "1.2.3")); + assertFalse(SemverComp.gt("1.9.9", "2.0.0")); + } +} + +/// @title SemverComp_Gte_Test +/// @notice Tests the `gte` function behavior. +contract SemverComp_Gte_Test is SemverComp_TestInit { + function test_gte_succeeds() external pure { + assertTrue(SemverComp.gte("1.2.3", "1.2.3")); + assertTrue(SemverComp.gte("1.2.4", "1.2.3")); + assertTrue(SemverComp.gte("1.3.0", "1.2.3")); + assertTrue(SemverComp.gte("2.0.0", "1.2.3")); + + assertFalse(SemverComp.gte("1.2.2", "1.2.3")); + assertFalse(SemverComp.gte("1.9.9", "2.0.0")); + } +} diff --git a/packages/contracts-bedrock/test/opcm/DeployImplementations.t.sol b/packages/contracts-bedrock/test/opcm/DeployImplementations.t.sol index f9cfe2bfffb..4860d580eb7 100644 --- a/packages/contracts-bedrock/test/opcm/DeployImplementations.t.sol +++ b/packages/contracts-bedrock/test/opcm/DeployImplementations.t.sol @@ -116,6 +116,7 @@ contract DeployImplementations_Test is Test { _proofMaturityDelaySeconds, _disputeGameFinalityDelaySeconds, StandardConstants.MIPS_VERSION, // mipsVersion + bytes32(0), // devFeatureBitmap superchainConfigProxy, protocolVersionsProxy, superchainProxyAdmin, @@ -244,6 +245,7 @@ contract DeployImplementations_Test is Test { proofMaturityDelaySeconds, disputeGameFinalityDelaySeconds, StandardConstants.MIPS_VERSION, // mipsVersion + bytes32(0), // devFeatureBitmap superchainConfigProxy, protocolVersionsProxy, superchainProxyAdmin, diff --git a/packages/contracts-bedrock/test/opcm/DeployOPChain.t.sol b/packages/contracts-bedrock/test/opcm/DeployOPChain.t.sol index faa3f466f40..6f735c9a611 100644 --- a/packages/contracts-bedrock/test/opcm/DeployOPChain.t.sol +++ b/packages/contracts-bedrock/test/opcm/DeployOPChain.t.sol @@ -372,7 +372,8 @@ contract DeployOPChain_TestBase is Test { protocolVersionsProxy: protocolVersionsProxy, superchainProxyAdmin: superchainProxyAdmin, upgradeController: upgradeController, - challenger: challenger + challenger: challenger, + devFeatureBitmap: bytes32(0) }) ); diff --git a/packages/contracts-bedrock/test/safe/DeputyPauseModule.t.sol b/packages/contracts-bedrock/test/safe/DeputyPauseModule.t.sol index ab651861063..3302e301ffc 100644 --- a/packages/contracts-bedrock/test/safe/DeputyPauseModule.t.sol +++ b/packages/contracts-bedrock/test/safe/DeputyPauseModule.t.sol @@ -17,8 +17,8 @@ import { ISuperchainConfig } from "interfaces/L1/ISuperchainConfig.sol"; contract DeputyPauseModule_TestInit is CommonTest, SafeTestTools { using SafeTestLib for SafeInstance; - event ExecutionFromModuleSuccess(address indexed); - event DeputySet(address indexed); + event ExecutionFromModuleSuccess(address indexed module); + event DeputySet(address indexed deputy); event PauseTriggered(address indexed deputy, bytes32 nonce, address identifier); IDeputyPauseModule deputyPauseModule; diff --git a/packages/contracts-bedrock/test/scripts/VerifyOPCM.t.sol b/packages/contracts-bedrock/test/scripts/VerifyOPCM.t.sol index 96ca81c1a71..fd64d07b948 100644 --- a/packages/contracts-bedrock/test/scripts/VerifyOPCM.t.sol +++ b/packages/contracts-bedrock/test/scripts/VerifyOPCM.t.sol @@ -1,9 +1,6 @@ // SPDX-License-Identifier: MIT pragma solidity 0.8.15; -// Foundry -import { VmSafe } from "forge-std/Vm.sol"; - // Libraries import { LibString } from "@solady/utils/LibString.sol"; @@ -71,13 +68,6 @@ contract VerifyOPCM_TestInit is OPContractsManager_TestInit { harness = new VerifyOPCM_Harness(); harness.setUp(); } - - /// @notice Skips if running in coverage mode. - function skipIfCoverage() public { - if (vm.isContext(VmSafe.ForgeContext.Coverage)) { - vm.skip(true); - } - } } /// @title VerifyOPCM_Run_Test @@ -97,6 +87,29 @@ contract VerifyOPCM_Run_Test is VerifyOPCM_TestInit { harness.run(address(opcm), true); } + function test_run_bitmapNotEmptyOnMainnet_reverts(bytes32 _devFeatureBitmap) public { + // Coverage changes bytecode and causes failures, skip. + skipIfCoverage(); + + // Anything but zero! + _devFeatureBitmap = bytes32(bound(uint256(_devFeatureBitmap), 1, type(uint256).max)); + + // Mock opcm to return a non-zero dev feature bitmap. + vm.mockCall( + address(opcm), abi.encodeCall(IOPContractsManager.devFeatureBitmap, ()), abi.encode(_devFeatureBitmap) + ); + + // Set the chain ID to 1. + vm.chainId(1); + + // Disable testing environment. + vm.etch(address(0xbeefcafe), bytes("")); + + // Run the script. + vm.expectRevert(VerifyOPCM.VerifyOPCM_DevFeatureBitmapNotEmpty.selector); + harness.run(address(opcm), true); + } + /// @notice Tests that the script succeeds when differences are introduced into the immutable /// variables of implementation contracts. Fuzzing is too slow here, randomness is good /// enough. diff --git a/packages/contracts-bedrock/test/setup/CommonTest.sol b/packages/contracts-bedrock/test/setup/CommonTest.sol index cb2ccea8546..7c343b0f6e8 100644 --- a/packages/contracts-bedrock/test/setup/CommonTest.sol +++ b/packages/contracts-bedrock/test/setup/CommonTest.sol @@ -59,6 +59,11 @@ contract CommonTest is Test, Setup, Events { // changes will not be persisted into the new network. Setup.setUp(); + // Set the code for 0xbeefcafe to a single non-zero byte. We use this address as a signal + // that something is running in the testing environment and not production, useful for + // forked tests. + vm.etch(address(0xbeefcafe), bytes(hex"01")); + alice = makeAddr("alice"); bob = makeAddr("bob"); vm.deal(alice, 10000 ether); diff --git a/packages/contracts-bedrock/test/setup/FeatureFlags.sol b/packages/contracts-bedrock/test/setup/FeatureFlags.sol new file mode 100644 index 00000000000..675a130e558 --- /dev/null +++ b/packages/contracts-bedrock/test/setup/FeatureFlags.sol @@ -0,0 +1,98 @@ +// SPDX-License-Identifier: MIT +pragma solidity 0.8.15; + +// Testing +import { console2 as console } from "forge-std/console2.sol"; +import { Vm } from "forge-std/Vm.sol"; + +// Libraries +import { DevFeatures } from "src/libraries/DevFeatures.sol"; +import { Config } from "scripts/libraries/Config.sol"; + +// Interfaces +import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol"; + +/// @notice FeatureFlags manages the feature bitmap by either direct user input or via environment +/// variables. +contract FeatureFlags { + /// @notice The address of the foundry Vm contract. + Vm private constant vm = Vm(0x7109709ECfa91a80626fF3989D68f67F5b1DD12D); + + /// @notice The development feature bitmap. + bytes32 internal devFeatureBitmap; + + /// @notice The address of the SystemConfig contract. + ISystemConfig internal sysCfg; + + /// @notice Sets the address of the SystemConfig contract. + /// @param _sysCfg The address of the SystemConfig contract. + function setSystemConfig(ISystemConfig _sysCfg) public { + sysCfg = _sysCfg; + } + + /// @notice Resolves the development feature bitmap. + function resolveFeaturesFromEnv() public { + if (Config.devFeatureInterop()) { + console.log("Setup: DEV_FEATURE__OPTIMISM_PORTAL_INTEROP is enabled"); + devFeatureBitmap |= DevFeatures.OPTIMISM_PORTAL_INTEROP; + } + } + + /// @notice Enables a feature. + /// @param _feature The feature to set. + function setDevFeatureEnabled(bytes32 _feature) public { + devFeatureBitmap |= _feature; + } + + /// @notice Disables a feature. + /// @param _feature The feature to set. + function setDevFeatureDisabled(bytes32 _feature) public { + devFeatureBitmap &= ~_feature; + } + + /// @notice Checks if a system feature is enabled. + /// @param _feature The feature to check. + /// @return True if the feature is enabled, false otherwise. + function isSysFeatureEnabled(bytes32 _feature) public view returns (bool) { + return sysCfg.isFeatureEnabled(_feature); + } + + /// @notice Checks if a development feature is enabled. + /// @param _feature The feature to check. + /// @return True if the feature is enabled, false otherwise. + function isDevFeatureEnabled(bytes32 _feature) public view returns (bool) { + return DevFeatures.isDevFeatureEnabled(devFeatureBitmap, _feature); + } + + /// @notice Skips tests when the provided system feature is enabled. + /// @param _feature The feature to check. + function skipIfSysFeatureEnabled(bytes32 _feature) public { + if (isSysFeatureEnabled(_feature)) { + vm.skip(true); + } + } + + /// @notice Skips tests when the provided system feature is disabled. + /// @param _feature The feature to check. + function skipIfSysFeatureDisabled(bytes32 _feature) public { + if (!isSysFeatureEnabled(_feature)) { + vm.skip(true); + } + } + + /// @notice Skips tests when the provided development feature is enabled. + /// @param _feature The feature to check. + function skipIfDevFeatureEnabled(bytes32 _feature) public { + if (isDevFeatureEnabled(_feature)) { + vm.skip(true); + } + } + + /// @notice Skips tests when the provided development feature is disabled. + /// @param _feature The feature to check. + function skipIfDevFeatureDisabled(bytes32 _feature) public { + if (!isDevFeatureEnabled(_feature)) { + vm.skip(true); + } + } +} diff --git a/packages/contracts-bedrock/test/setup/ForkLive.s.sol b/packages/contracts-bedrock/test/setup/ForkLive.s.sol index 96c2752835c..4c12d6661dc 100644 --- a/packages/contracts-bedrock/test/setup/ForkLive.s.sol +++ b/packages/contracts-bedrock/test/setup/ForkLive.s.sol @@ -2,6 +2,7 @@ pragma solidity ^0.8.0; import { console2 as console } from "forge-std/console2.sol"; +import { StdAssertions } from "forge-std/StdAssertions.sol"; // Testing import { stdToml } from "forge-std/StdToml.sol"; @@ -18,18 +19,19 @@ import { EIP1967Helper } from "test/mocks/EIP1967Helper.sol"; import { LibString } from "solady/src/utils/LibString.sol"; // Interfaces +import { ISuperchainConfig } from "interfaces/L1/ISuperchainConfig.sol"; import { IFaultDisputeGame } from "interfaces/dispute/IFaultDisputeGame.sol"; import { IPermissionedDisputeGame } from "interfaces/dispute/IPermissionedDisputeGame.sol"; import { IDisputeGameFactory } from "interfaces/dispute/IDisputeGameFactory.sol"; import { IDelayedWETH } from "interfaces/dispute/IDelayedWETH.sol"; import { IAddressManager } from "interfaces/legacy/IAddressManager.sol"; import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol"; -import { ISuperchainConfig } from "interfaces/L1/ISuperchainConfig.sol"; import { IProxyAdmin } from "interfaces/universal/IProxyAdmin.sol"; import { IOPContractsManager } from "interfaces/L1/IOPContractsManager.sol"; import { IAnchorStateRegistry } from "interfaces/dispute/IAnchorStateRegistry.sol"; import { IETHLockbox } from "interfaces/L1/IETHLockbox.sol"; import { IOptimismPortal2 } from "interfaces/L1/IOptimismPortal2.sol"; +import { IOPContractsManagerUpgrader } from "interfaces/L1/IOPContractsManager.sol"; /// @title ForkLive /// @notice This script is called by Setup.sol as a preparation step for the foundry test suite, and is run as an @@ -41,12 +43,15 @@ import { IOptimismPortal2 } from "interfaces/L1/IOptimismPortal2.sol"; /// superchain-registry. /// This contract must not have constructor logic because it is set into state using `etch`. -contract ForkLive is Deployer { +contract ForkLive is Deployer, StdAssertions { using stdToml for string; using LibString for string; bool public useOpsRepo; + /// @notice Thrown when testing with an unsupported chain ID. + error UnsupportedChainId(); + /// @notice Returns the base chain name to use for forking /// @return The base chain name as a string function baseChain() internal view returns (string memory) { @@ -188,16 +193,13 @@ contract ForkLive is Deployer { deploy.deployImplementations({ _isInterop: false }); } - /// @notice Upgrades the contracts using the OPCM. - function _upgrade() internal { - IOPContractsManager opcm = IOPContractsManager(artifacts.mustGetAddress("OPContractsManager")); - + /// @notice Performs a single OPCM upgrade. + /// @param _opcm The OPCM contract to upgrade. + /// @param _delegateCaller The address of the upgrader to use for the upgrade. + function _doUpgrade(IOPContractsManager _opcm, address _delegateCaller) internal { ISystemConfig systemConfig = ISystemConfig(artifacts.mustGetAddress("SystemConfigProxy")); IProxyAdmin proxyAdmin = IProxyAdmin(EIP1967Helper.getAdmin(address(systemConfig))); - address upgrader = proxyAdmin.owner(); - vm.label(upgrader, "ProxyAdmin Owner"); - IOPContractsManager.OpChainConfig[] memory opChains = new IOPContractsManager.OpChainConfig[](1); opChains[0] = IOPContractsManager.OpChainConfig({ systemConfigProxy: systemConfig, @@ -205,47 +207,71 @@ contract ForkLive is Deployer { absolutePrestate: Claim.wrap(bytes32(keccak256("absolutePrestate"))) }); + // Turn the SuperchainPAO into a DelegateCaller so we can try to upgrade the + // SuperchainConfig contract. + ISuperchainConfig superchainConfig = ISuperchainConfig(artifacts.mustGetAddress("SuperchainConfigProxy")); + IProxyAdmin superchainProxyAdmin = IProxyAdmin(EIP1967Helper.getAdmin(address(superchainConfig))); + address superchainPAO = superchainProxyAdmin.owner(); + bytes memory superchainPAOCode = address(superchainPAO).code; + vm.etch(superchainPAO, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); + + // Always try to upgrade the SuperchainConfig. Not always necessary but easier to do it + // every time rather than adding or removing this code for each upgrade. + try DelegateCaller(superchainPAO).dcForward( + address(_opcm), + abi.encodeCall(IOPContractsManager.upgradeSuperchainConfig, (superchainConfig, superchainProxyAdmin)) + ) { + // Great, the upgrade succeeded. + } catch (bytes memory reason) { + // Only acceptable revert reason is the SuperchainConfig already being up to date. + assertTrue( + bytes4(reason) + == IOPContractsManagerUpgrader.OPContractsManagerUpgrader_SuperchainConfigAlreadyUpToDate.selector, + "Revert reason other than SuperchainConfigAlreadyUpToDate" + ); + } + + // Reset the superchainPAO to the original code. + vm.etch(superchainPAO, superchainPAOCode); + // Temporarily replace the upgrader with a DelegateCaller so we can test the upgrade, // then reset its code to the original code. - bytes memory upgraderCode = address(upgrader).code; - vm.etch(upgrader, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); + bytes memory upgraderCode = address(_delegateCaller).code; + vm.etch(_delegateCaller, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); - // The 2.0.0 OPCM requires that the SuperchainConfig and ProtocolVersions contracts have - // been upgraded before it will upgrade other contracts. These contracts can only be - // upgraded by the Superchain ProxyAdmin owner. For simplicity, we always just call U13 - // once without any chain configs to trigger this upgrade. - ISuperchainConfig superchainConfig = ISuperchainConfig(artifacts.mustGetAddress("SuperchainConfigProxy")); - address superchainPAO = IProxyAdmin(EIP1967Helper.getAdmin(address(superchainConfig))).owner(); - vm.etch(superchainPAO, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); - DelegateCaller(superchainPAO).dcForward( - address(0x026b2F158255Beac46c1E7c6b8BbF29A4b6A7B76), - abi.encodeCall(IOPContractsManager.upgrade, (new IOPContractsManager.OpChainConfig[](0))) + // Upgrade the chain. + DelegateCaller(_delegateCaller).dcForward( + address(_opcm), abi.encodeCall(IOPContractsManager.upgrade, (opChains)) ); - // Start by doing Upgrade 13. - DelegateCaller(upgrader).dcForward( - address(0x026b2F158255Beac46c1E7c6b8BbF29A4b6A7B76), abi.encodeCall(IOPContractsManager.upgrade, (opChains)) - ); + // Reset the upgrader to the original code. + vm.etch(_delegateCaller, upgraderCode); + } - // Then do Upgrade 14. - DelegateCaller(upgrader).dcForward( - address(0x3A1f523a4bc09cd344A2745a108Bb0398288094F), abi.encodeCall(IOPContractsManager.upgrade, (opChains)) - ); + /// @notice Upgrades the contracts using the OPCM. + function _upgrade() internal { + IOPContractsManager opcm = IOPContractsManager(artifacts.mustGetAddress("OPContractsManager")); - // Like with Upgrade 13, we need to first call U16 from the Superchain ProxyAdmin owner to - // trigger the upgrade of the SuperchainConfig contract. - vm.etch(superchainPAO, vm.getDeployedCode("test/mocks/Callers.sol:DelegateCaller")); - DelegateCaller(superchainPAO).dcForward( - address(opcm), abi.encodeCall(IOPContractsManager.upgrade, (new IOPContractsManager.OpChainConfig[](0))) - ); + ISystemConfig systemConfig = ISystemConfig(artifacts.mustGetAddress("SystemConfigProxy")); + IProxyAdmin proxyAdmin = IProxyAdmin(EIP1967Helper.getAdmin(address(systemConfig))); - // Then do the final upgrade. - DelegateCaller(upgrader).dcForward(address(opcm), abi.encodeCall(IOPContractsManager.upgrade, (opChains))); + address upgrader = proxyAdmin.owner(); + vm.label(upgrader, "ProxyAdmin Owner"); - // Reset the upgrader to the original code. - vm.etch(upgrader, upgraderCode); + // Run past upgrades depending on network. + if (block.chainid == 1) { + // Mainnet + // U16a. + _doUpgrade(IOPContractsManager(0x8123739C1368C2DEDc8C564255bc417FEEeBFF9D), upgrader); + } else { + revert UnsupportedChainId(); + } + + // Current upgrade. + _doUpgrade(opcm, upgrader); console.log("ForkLive: Saving newly deployed contracts"); + // A new ASR and new dispute games were deployed, so we need to update them IDisputeGameFactory disputeGameFactory = IDisputeGameFactory(artifacts.mustGetAddress("DisputeGameFactoryProxy")); diff --git a/packages/contracts-bedrock/test/setup/Setup.sol b/packages/contracts-bedrock/test/setup/Setup.sol index fffcf5514ef..7252f501f04 100644 --- a/packages/contracts-bedrock/test/setup/Setup.sol +++ b/packages/contracts-bedrock/test/setup/Setup.sol @@ -5,6 +5,7 @@ pragma solidity 0.8.15; import { console2 as console } from "forge-std/console2.sol"; import { Vm, VmSafe } from "forge-std/Vm.sol"; import { EIP1967Helper } from "test/mocks/EIP1967Helper.sol"; +import { FeatureFlags } from "test/setup/FeatureFlags.sol"; // Scripts import { Deploy } from "scripts/deploy/Deploy.s.sol"; @@ -71,7 +72,7 @@ import { ISuperchainRevSharesCalculator } from "interfaces/L2/ISuperchainRevShar /// sets the L2 contracts directly at the predeploy addresses instead of setting them /// up behind proxies. In the future we will migrate to importing the genesis JSON /// file that is created to set up the L2 contracts instead of setting them up manually. -contract Setup { +contract Setup is FeatureFlags { using ForkUtils for Fork; /// @notice The address of the foundry Vm contract. @@ -189,6 +190,10 @@ contract Setup { deploy.setUp(); forkLive.setUp(); + + resolveFeaturesFromEnv(); + deploy.cfg().setDevFeatureBitmap(devFeatureBitmap); + console.log("Setup: L1 setup done!"); if (isForkTest()) { @@ -267,7 +272,10 @@ contract Setup { // Only skip ETHLockbox assignment if we're in a fork test with non-upgraded fork // TODO(#14691): Remove this check once Upgrade 15 is deployed on Mainnet. if (!isForkTest() || deploy.cfg().useUpgradedFork()) { - ethLockbox = IETHLockbox(artifacts.mustGetAddress("ETHLockboxProxy")); + // Here we use getAddress instead of mustGetAddress because some chains might not have + // the ETHLockbox proxy. Chains that don't have the ETHLockbox proxy will just return + // address(0) and cause a revert if we use mustGetAddress. + ethLockbox = IETHLockbox(artifacts.getAddress("ETHLockboxProxy")); } systemConfig = ISystemConfig(artifacts.mustGetAddress("SystemConfigProxy")); @@ -298,6 +306,9 @@ contract Setup { } console.log("Setup: registered L1 deployments"); + + // Update the SystemConfig address. + setSystemConfig(systemConfig); } /// @dev Sets up the L2 contracts. Depends on `L1()` being called first. diff --git a/packages/contracts-bedrock/test/vendor/Initializable.t.sol b/packages/contracts-bedrock/test/vendor/Initializable.t.sol index e7460729bc6..5318d7d15fd 100644 --- a/packages/contracts-bedrock/test/vendor/Initializable.t.sol +++ b/packages/contracts-bedrock/test/vendor/Initializable.t.sol @@ -12,6 +12,7 @@ import { Process } from "scripts/libraries/Process.sol"; import { LibString } from "@solady/utils/LibString.sol"; import { GameType, Hash, Proposal } from "src/dispute/lib/Types.sol"; import { EIP1967Helper } from "test/mocks/EIP1967Helper.sol"; +import { DevFeatures } from "src/libraries/DevFeatures.sol"; // Interfaces import { ISystemConfig } from "interfaces/L1/ISystemConfig.sol"; @@ -20,6 +21,7 @@ import { IResourceMetering } from "interfaces/L1/IResourceMetering.sol"; import { IDisputeGameFactory } from "interfaces/dispute/IDisputeGameFactory.sol"; import { ProtocolVersion } from "interfaces/L1/IProtocolVersions.sol"; import { IOptimismPortal2 } from "interfaces/L1/IOptimismPortal2.sol"; +import { IOptimismPortalInterop } from "interfaces/L1/IOptimismPortalInterop.sol"; /// @title Initializer_Test /// @dev Ensures that the `initialize()` function on contracts cannot be called more than @@ -118,22 +120,48 @@ contract Initializer_Test is CommonTest { initCalldata: abi.encodeCall(delayedWeth.initialize, (ISystemConfig(address(0)))) }) ); - // OptimismPortal2Impl - contracts.push( - InitializeableContract({ - name: "OptimismPortal2Impl", - target: EIP1967Helper.getImplementation(address(optimismPortal2)), - initCalldata: abi.encodeCall(optimismPortal2.initialize, (systemConfig, anchorStateRegistry, ethLockbox)) - }) - ); - // OptimismPortal2Proxy - contracts.push( - InitializeableContract({ - name: "OptimismPortal2Proxy", - target: address(optimismPortal2), - initCalldata: abi.encodeCall(optimismPortal2.initialize, (systemConfig, anchorStateRegistry, ethLockbox)) - }) - ); + + if (isDevFeatureEnabled(DevFeatures.OPTIMISM_PORTAL_INTEROP)) { + // OptimismPortal2Impl + contracts.push( + InitializeableContract({ + name: "OptimismPortal2Impl", + target: EIP1967Helper.getImplementation(address(optimismPortal2)), + initCalldata: abi.encodeCall( + IOptimismPortalInterop(payable(optimismPortal2)).initialize, + (systemConfig, anchorStateRegistry, ethLockbox) + ) + }) + ); + // OptimismPortal2Proxy + contracts.push( + InitializeableContract({ + name: "OptimismPortal2Proxy", + target: address(optimismPortal2), + initCalldata: abi.encodeCall( + IOptimismPortalInterop(payable(optimismPortal2)).initialize, + (systemConfig, anchorStateRegistry, ethLockbox) + ) + }) + ); + } else { + // OptimismPortal2Impl + contracts.push( + InitializeableContract({ + name: "OptimismPortal2Impl", + target: EIP1967Helper.getImplementation(address(optimismPortal2)), + initCalldata: abi.encodeCall(optimismPortal2.initialize, (systemConfig, anchorStateRegistry)) + }) + ); + // OptimismPortal2Proxy + contracts.push( + InitializeableContract({ + name: "OptimismPortal2Proxy", + target: address(optimismPortal2), + initCalldata: abi.encodeCall(optimismPortal2.initialize, (systemConfig, anchorStateRegistry)) + }) + ); + } // SystemConfigImpl contracts.push( @@ -350,7 +378,7 @@ contract Initializer_Test is CommonTest { function test_cannotReinitialize_succeeds() public { // Collect exclusions. uint256 j; - string[] memory excludes = new string[](8); + string[] memory excludes = new string[](11); // Contract is currently not being deployed as part of the standard deployment script. excludes[j++] = "src/L2/OptimismSuperchainERC20.sol"; // Periphery contracts don't get deployed as part of the standard deployment script. @@ -361,11 +389,15 @@ contract Initializer_Test is CommonTest { // contracts and instead simply deploys them anonymously. Means that functions like "getInitializedSlot" // don't work properly. Remove these exclusions once the deployment script is fixed. excludes[j++] = "src/dispute/FaultDisputeGame.sol"; + excludes[j++] = "src/dispute/v2/FaultDisputeGameV2.sol"; + excludes[j++] = "src/dispute/v2/PermissionedDisputeGameV2.sol"; excludes[j++] = "src/dispute/SuperFaultDisputeGame.sol"; excludes[j++] = "src/dispute/PermissionedDisputeGame.sol"; excludes[j++] = "src/dispute/SuperPermissionedDisputeGame.sol"; // TODO: Eventually remove this exclusion. Same reason as above dispute contracts. excludes[j++] = "src/L1/OPContractsManager.sol"; + // TODO: Eventually remove this exclusion. Same reason as above dispute contracts. + excludes[j++] = "src/L1/OptimismPortalInterop.sol"; // L2 contract initialization is tested in Predeploys.t.sol excludes[j++] = "src/L2/*";