Merge pull request #6055 from ethereum-optimism/clabby/ctb/dispute-game-viz

feat(ctb): Add vizualizer script for the `FaultDisputeGame`

packages/contracts-bedrock/scripts/FaultDisputeGameViz.s.sol

+pragma solidity ^0.8.15;
+
+import { Script } from "forge-std/Script.sol";
+import { console2 as console } from "forge-std/console2.sol";
+
+import { FaultDisputeGame_Init } from "../contracts/test/FaultDisputeGame.t.sol";
+import { DisputeGameFactory } from "../contracts/dispute/DisputeGameFactory.sol";
+import { FaultDisputeGame } from "../contracts/dispute/FaultDisputeGame.sol";
+import { IFaultDisputeGame } from "../contracts/dispute/interfaces/IFaultDisputeGame.sol";
+
+import "../contracts/libraries/DisputeTypes.sol";
+import "../contracts/libraries/DisputeErrors.sol";
+import { LibClock } from "../contracts/dispute/lib/LibClock.sol";
+import { LibPosition } from "../contracts/dispute/lib/LibPosition.sol";
+
+/**
+ * @title FaultDisputeGameViz
+ * @dev To run this script, make sure to install the `dagviz` & `eth_abi` python packages.
+ */
+contract FaultDisputeGameViz is Script, FaultDisputeGame_Init {
+    /// @dev The root claim of the game.
+    Claim internal constant ROOT_CLAIM = Claim.wrap(bytes32(uint256(10)));
+    /// @dev The absolute prestate of the trace.
+    Claim internal constant ABSOLUTE_PRESTATE = Claim.wrap(bytes32(uint256(0)));
+
+    function setUp() public override {
+        super.init(ROOT_CLAIM, ABSOLUTE_PRESTATE);
+    }
+
+    /**
+     * @dev Entry point
+     */
+    function local() public {
+        // Construct the game by performing attacks, defenses, and steps.
+        // ...
+
+        buildGraph();
+        console.log("Saved graph to `./dispute_game.svg");
+    }
+
+    /**
+     * @dev Entry point
+     */
+    function remote(address _addr) public {
+        gameProxy = FaultDisputeGame(_addr);
+        buildGraph();
+        console.log("Saved graph to `./dispute_game.svg");
+    }
+
+    /**
+     * @dev Uses the `dag-viz` python script to generate a visual model of the game state.
+     */
+    function buildGraph() internal {
+        uint256 numClaims = uint256(vm.load(address(gameProxy), bytes32(uint256(1))));
+        IFaultDisputeGame.ClaimData[] memory gameData = new IFaultDisputeGame.ClaimData[](numClaims);
+        for (uint256 i = 0; i < numClaims; i++) {
+            (
+                uint32 parentIndex,
+                bool countered,
+                Claim claim,
+                Position position,
+                Clock clock
+            ) = gameProxy.claimData(i);
+
+            gameData[i] = IFaultDisputeGame.ClaimData({
+                parentIndex: parentIndex,
+                countered: countered,
+                claim: claim,
+                position: position,
+                clock: clock
+            });
+        }
+
+        string[] memory commands = new string[](3);
+        commands[0] = "python3";
+        commands[1] = "scripts/dag-viz.py";
+        commands[2] = vm.toString(abi.encode(gameData));
+        vm.ffi(commands);
+    }
+}

packages/contracts-bedrock/scripts/dag-viz.py

+import sys
+import dagviz
+import networkx as nx
+from eth_abi import decode
+
+# The parent of the root claim is uint32 max.
+ROOT_PARENT = 4294967295
+
+# Get the abi-encoded input
+b = sys.argv[1].removeprefix('0x')
+
+# Decode the input
+t = decode(['(uint32,bool,bytes32,uint128,uint128)[]'], bytes.fromhex(b))[0]
+
+# Create the graph
+G = nx.DiGraph()
+for c in t:
+    claim = c[2].hex()
+    key = f"Position: {bin(c[3])[2:]} | Claim: 0x{claim[:4]}..{claim[60:64]}"
+    G.add_node(key)
+    if int(c[0]) != ROOT_PARENT:
+        pclaim = t[c[0]][2].hex()
+        G.add_edge(f"Position: {bin(t[c[0]][3])[2:]} | Claim: 0x{pclaim[:4]}..{pclaim[60:64]}", key)
+r = dagviz.render_svg(G)
+
+f = open('dispute_game.svg', 'w')
+f.write(r)
+f.close()