feat: add contract upgrade script for fp (#450)

* feat: add contract upgrade script for fp

* docs: add l1 rpc url

* feat(fault-proof): support dry run

Author: fakedev9999

book/SUMMARY.md

@@ -26,6 +26,7 @@
   - [Quick Start](./fault_proofs/quick_start.md)
   - [Best Practices](./fault_proofs/best_practices.md)
   - [Deploy FP Contracts](./fault_proofs/deploy.md)
+  - [Upgrade FP Contracts](./fault_proofs/upgrade.md)
   - [How to run the FP Proposer](./fault_proofs/proposer.md)
   - [How to run the FP Challenger](./fault_proofs/challenger.md)
   - [Running with Docker](./fault_proofs/docker.md)

book/fault_proofs/upgrade.md

@@ -0,0 +1,81 @@
+# Upgrading the OPSuccinct Fault Dispute Game
+
+This guide explains how to upgrade the OPSuccinct Fault Dispute Game contract.
+
+## Overview
+
+The upgrade script performs the following actions:
+1. Deploys a new implementation of the `OPSuccinctFaultDisputeGame` contract
+2. Sets the new implementation in the `DisputeGameFactory` for the specified game type
+
+### Required Environment Variables
+
+Create a `.env` file in the contracts directory with the following variables:
+
+| Variable | Description | Example |
+|----------|-------------|---------|
+| `FACTORY_ADDRESS` | Address of the existing DisputeGameFactory | `0x...` |
+| `GAME_TYPE` | Unique identifier for the game type (uint32) | `42` |
+| `MAX_CHALLENGE_DURATION` | Maximum duration for challenges in seconds | `604800` for 7 days |
+| `MAX_PROVE_DURATION` | Maximum duration for proving in seconds | `86400` for 1 day |
+| `VERIFIER_ADDRESS` | Address of the SP1 verifier | `0x...` |
+| `ROLLUP_CONFIG_HASH` | Hash of the rollup configuration | `0x...` |
+| `AGGREGATION_VKEY` | Verification key for aggregation | `0x...` |
+| `RANGE_VKEY_COMMITMENT` | Commitment to range verification key | `0x...` |
+| `ANCHOR_STATE_REGISTRY` | Address of the AnchorStateRegistry | `0x...` |
+| `ACCESS_MANAGER` | Address of the AccessManager | `0x...` |
+
+### Getting the Rollup Config Hash, Aggregation Verification Key, and Range Verification Key Commitment
+
+First, create a `.env` file in the root directory with the following variables:
+```bash
+L1_RPC=<L1_RPC_URL>
+L1_BEACON_RPC=<L1_BEACON_RPC_URL>
+L2_RPC=<L2_RPC_URL>
+L2_NODE_RPC=<L2_NODE_RPC_URL>
+```
+
+You can get the aggregation program verification key, range program verification key commitment, and rollup config hash by running the following command:
+
+```bash
+cargo run --bin config --release -- --env-file <PATH_TO_ENV_FILE>
+```
+
+### Optional Environment Variables
+
+| Variable | Description | Default | Example |
+|----------|-------------|---------|---------|
+| `CHALLENGER_BOND_WEI` | Challenger bond for the game | `0.001 ether` | `1000000000000000` |
+
+Use `cast --to-wei <value> eth` to convert the value to wei to avoid mistakes.
+
+## Upgrade Command
+
+Dry run the upgrade command in the root directory of the project:
+```bash
+DRY_RUN=true just -f fault-proof/justfile --dotenv-filename contracts/.env upgrade-fault-dispute-game
+```
+
+Run the upgrade command in the root directory of the project:
+```bash
+DRY_RUN=false just -f fault-proof/justfile --dotenv-filename contracts/.env upgrade-fault-dispute-game
+```
+
+## Verification
+
+You can verify the upgrade by running the following command:
+```bash
+cast call <FACTORY_ADDRESS> "gameImpls(uint32)" <GAME_TYPE> --rpc-url <L1_RPC_URL>
+```
+
+## Troubleshooting
+
+Common issues and solutions:
+
+1. **Compilation Errors**:
+   - Run `cd contracts && forge clean`
+
+2. **Deployment Failures**:
+   - Check RPC connection
+   - Verify sufficient ETH balance
+   - Confirm environment variables are set correctly

contracts/script/fp/UpgradeOPSuccinctFDG.s.sol

@@ -0,0 +1,54 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.15;
+
+// Libraries
+import {Script} from "forge-std/Script.sol";
+import {console} from "forge-std/console.sol";
+import {GameType, Duration} from "src/dispute/lib/Types.sol";
+
+// Interfaces
+import {IDisputeGame} from "interfaces/dispute/IDisputeGame.sol";
+import {IDisputeGameFactory} from "interfaces/dispute/IDisputeGameFactory.sol";
+import {ISP1Verifier} from "@sp1-contracts/src/ISP1Verifier.sol";
+import {IAnchorStateRegistry} from "interfaces/dispute/IAnchorStateRegistry.sol";
+
+// Contracts
+import {OPSuccinctFaultDisputeGame} from "../../src/fp/OPSuccinctFaultDisputeGame.sol";
+import {DisputeGameFactory} from "src/dispute/DisputeGameFactory.sol";
+import {AccessManager} from "../../src/fp/AccessManager.sol";
+
+contract UpgradeOPSuccinctFDG is Script {
+    function run() public {
+        vm.startBroadcast();
+
+        // Get the factory.
+        address factoryAddress = vm.envAddress("FACTORY_ADDRESS");
+        DisputeGameFactory factory = DisputeGameFactory(factoryAddress);
+
+        // Get the game type.
+        GameType gameType = GameType.wrap(uint32(vm.envUint("GAME_TYPE")));
+
+        // Deploy new implementation.
+        OPSuccinctFaultDisputeGame newImpl = new OPSuccinctFaultDisputeGame(
+            Duration.wrap(uint64(vm.envUint("MAX_CHALLENGE_DURATION"))),
+            Duration.wrap(uint64(vm.envUint("MAX_PROVE_DURATION"))),
+            IDisputeGameFactory(factoryAddress),
+            ISP1Verifier(vm.envAddress("VERIFIER_ADDRESS")),
+            vm.envBytes32("ROLLUP_CONFIG_HASH"),
+            vm.envBytes32("AGGREGATION_VKEY"),
+            vm.envBytes32("RANGE_VKEY_COMMITMENT"),
+            vm.envOr("CHALLENGER_BOND_WEI", uint256(0.001 ether)),
+            IAnchorStateRegistry(vm.envAddress("ANCHOR_STATE_REGISTRY")),
+            AccessManager(vm.envAddress("ACCESS_MANAGER"))
+        );
+
+        console.log("New OPSuccinctFaultDisputeGame implementation deployed at: ", address(newImpl));
+
+        // Set the new implementation.
+        factory.setImplementation(gameType, IDisputeGame(address(newImpl)));
+
+        console.log("New implementation set in factory: ", address(factory.gameImpls(gameType)));
+
+        vm.stopBroadcast();
+    }
+}

contracts/src/fp/OPSuccinctFaultDisputeGame.sol

@@ -641,13 +641,18 @@ contract OPSuccinctFaultDisputeGame is Clone, ISemver, IDisputeGame {
         disputeGameFactory_ = DISPUTE_GAME_FACTORY;
     }
 
+    /// @notice Returns the challenger bond amount.
+    function challengerBond() external view returns (uint256 challengerBond_) {
+        challengerBond_ = CHALLENGER_BOND;
+    }
+
     /// @notice Returns the anchor state registry contract.
     function anchorStateRegistry() external view returns (IAnchorStateRegistry registry_) {
         registry_ = ANCHOR_STATE_REGISTRY;
     }
 
-    /// @notice Returns the challenger bond amount.
-    function challengerBond() external view returns (uint256 challengerBond_) {
-        challengerBond_ = CHALLENGER_BOND;
+    /// @notice Returns the access manager contract.
+    function accessManager() external view returns (AccessManager accessManager_) {
+        accessManager_ = ACCESS_MANAGER;
     }
 }

fault-proof/justfile

@@ -0,0 +1,27 @@
+default:
+  @just --list
+
+# Upgrade the OPSuccinct Fault Dispute Game implementation.
+upgrade-fault-dispute-game:
+    #!/usr/bin/env bash
+    set -euo pipefail
+
+    # cd into contracts directory.
+    cd ../contracts
+
+    # Install dependencies.
+    forge install
+    
+    # Run the forge upgrade script.
+    if [ "${DRY_RUN}" = "false" ]; then
+        forge script script/fp/UpgradeOPSuccinctFDG.s.sol:UpgradeOPSuccinctFDG \
+            --rpc-url $L1_RPC \
+            --private-key $PRIVATE_KEY \
+            --etherscan-api-key $ETHERSCAN_API_KEY \
+            --broadcast
+    else
+        forge script script/fp/UpgradeOPSuccinctFDG.s.sol:UpgradeOPSuccinctFDG \
+            --rpc-url $L1_RPC \
+            --private-key $PRIVATE_KEY \
+            --etherscan-api-key $ETHERSCAN_API_KEY
+    fi