OPSC Rehearsal setup

foundry.toml

@@ -7,7 +7,6 @@ optimizer_runs = 999999
 solc_version = "0.8.15"
 evm_version = "cancun"
 via_ir = true
-broadcast = 'records'
 fs_permissions = [{ access = "read-write", path = "./" }]
 # Enable FFI for reading lib/superchain-registry files in scripts SignFromJson.s.sol, NestedSignFromJson.s.sol within tasks
 ffi = true

security-council-rehearsals/2025-01-12-r1-hello-council-250112/.env

@@ -0,0 +1,4 @@
+ETH_RPC_URL="https://ethereum.publicnode.com"
+COUNCIL_SAFE=0x348eebA2609645182872CCd75256D873e689fCFf
+HelloWorld_ADDRESS=0x5f5514DcBCe7fAB4Cf694733340435ED4dcCEA46
+SAFE_NONCE=""

security-council-rehearsals/2025-01-12-r1-hello-council-250112/README.md

@@ -0,0 +1,259 @@
+# Rehearsal 1 - Hello World
+
+## Objective
+
+This rehearsal is intended simply to  ensure that all the signers feel
+confident running the tooling  and performing the validations required
+to execute an onchain action.
+
+Once completed, the HelloWorld contract will return true from its
+`helloed()` method.
+
+The call that will be executed by the Safe contract is defined in a
+json file. This will be the standard approach for all transactions.
+
+Note that no onchain actions will be taking place during this
+signing. You won’t be submitting a transaction and your address
+doesn’t even need to be funded. These are offchain signatures produced
+with your wallet which will be collected by a Facilitator will execute
+the contract, submitting all signatures for its execution.
+
+Execution can be finalized by anyone once a threshold of signatures
+are collected, so a Facilitator will do the final execution for
+convenience.
+
+## Approving the transaction
+
+### 1. Update repo and move to the appropriate folder for this rehearsal task:
+
+```
+cd superchain-ops
+git pull
+just install
+cd security-council-rehearsals/2025-01-12-r1-hello-council-250112
+```
+
+Please also read the main [`README.md`](../README.md), and particularly the
+[Installation](../README.md#installation) section as there are some dependencies
+that are not installed by `just install`.
+
+### 2. Setup Ledger
+
+Your Ledger needs to be connected and unlocked. The Ethereum
+application needs to be opened on Ledger with the message “Application
+is ready”.
+
+### 3. Simulate and validate the transaction
+
+Make sure your ledger is still unlocked and run the following.
+
+Remember that by default `just` is running with the address derived
+from `/0` (first nonce). If you wish to use a different account, run
+`just simulate [X]`, where X is the derivation path of the address
+that you want to use.
+
+``` shell
+just simulate
+```
+
+You will see a "Simulation link" from the output.
+
+Paste this URL in your browser. A prompt may ask you to choose a
+project, any project will do. You can create one if necessary.
+
+Click "Simulate Transaction".
+
+We will be performing 3 validations and ensure the domain hash and
+message hash are the same between the Tenderly simulation and your
+Ledger:
+
+1. Validate integrity of the simulation.
+2. Validate correctness of the state diff.
+3. Validate and extract domain hash and message hash to approve.
+
+#### 3.1. Validate integrity of the simulation.
+
+Make sure you are on the "Overview" tab of the tenderly simulation, to
+validate integrity of the simulation, we need to
+
+1. "Network": Check the network is Ethereum Mainnet.
+2. "Timestamp": Check the simulation is performed on a block with a
+   recent timestamp (i.e. close to when you run the script).
+3. "Sender": Check the address shown is your signer account. If not,
+   you will need to determine which “number” it is in the list of
+   addresses on your ledger. By default the script will assume the
+   derivation path is m/44'/60'/0'/0/0. By calling the script with
+   `just simulate 1` it will derive the address using
+   m/44'/60'/1'/0/0 instead.
+
+Here is an example screenshot, note that the Timestamp and Sender
+might be different in your simulation:
+
+![](./images/tenderly-overview-network.png)
+
+#### 3.2. Validate correctness of the state diff.
+
+Now click on the "State" tab. Verify that:
+
+1. Under address `0x5f5514DcBCe7fAB4Cf694733340435ED4dcCEA46`, the
+   storage key `0x0`'s value's last byte is changed from `0x00` to
+   `0x01`. This is indicating that the `HelloWorld.helloed` variable
+   is successfully changed from `false` to `true`.
+2. There are no other significant state changes except for 2 nonce
+   changes from the Safe and the signer address.
+3. You will see a state override (not a state chagne). This is
+   expected and its purpose is to generate a successful Safe execution
+   simulation without collecting any signatures.
+
+Here is an example screenshot. Note that the addresses may be
+different:
+
+![](./images/tenderly-state-changes.png)
+
+#### 3.3. Extract the domain hash and the message hash to approve.
+
+Now that we have verified the transaction performs the right
+operation, we need to extract the domain hash and the message hash to
+approve.
+
+Go back to the "Overview" tab, and find the first
+`GnosisSafe.domainSeparator` call. This call's return value will be
+the domain hash that will show up in your Ledger.
+
+Here is an example screenshot. Note that the hash value may be
+different:
+
+![](./images/tenderly-hashes-1.png)
+
+Right before the `GnosisSafe.domainSeparator` call, you will see a
+call to `GnosisSafe.encodeTransactionData`. Its return value will be a
+concatenation of `0x1901`, the domain hash, and the message hash:
+`0x1901[domain hash][message hash]`.
+
+Here is an example screenshot. Note that the hash value may be
+different:
+
+![](./images/tenderly-hashes-2.png)
+
+Note down both the domain hash and the message hash. You will need to
+compare them with the ones displayed on the Ledger screen at signing.
+
+### 4. Approve the signature on your ledger
+
+Once the validations are done, it's time to actually sign the
+transaction. Make sure your ledger is still unlocked and run the
+following:
+
+``` shell
+just sign # or just sign <hdPath>
+```
+
+> [!IMPORTANT]
+> This is the most security critical part of the
+> playbook: make sure the domain hash and message hash in the
+> following two places match:
+
+1. on your Ledger screen.
+2. in the Tenderly simulation. You should use the same Tenderly
+   simulation as the one you used to verify the state diffs, instead
+   of opening the new one printed in the console.
+
+There is no need to verify anything printed in the console. There is
+no need to open the new Tenderly simulation link either.
+
+After verification, sign the transaction. You will see the `Data`,
+`Signer` and `Signature` printed in the console. Format should be
+something like this:
+
+```
+Data:  <DATA>
+Signer: <ADDRESS>
+Signature: <SIGNATURE>
+```
+
+Double check the signer address is the right one.
+
+### 5. Send the output to Facilitator(s)
+
+Nothing has occurred onchain - these are offchain signatures which
+will be collected by Facilitators for execution. Execution can occur
+by anyone once a threshold of signatures are collected, so a
+Facilitator will do the final execution for convenience.
+
+Format should be something like this:
+
+```
+Data:  <DATA>
+Signer: <ADDRESS>
+Signature: <SIGNATURE>
+```
+
+Share the `Data`, `Signer` and `Signature` with the Facilitator, and
+congrats, you are done!
+
+## [For Facilitator ONLY] How to prepare and execute the rehearsal
+
+### [Before the rehearsal] Prepare the rehearsal
+
+#### 1. Create the Council Safe
+
+The first step of preparing the rehearsal is creating a multisig for
+the participants using the [Safe
+UI](https://app.safe.global/new-safe/create?chain=eth).
+
+To make the prepartion and coordination of the ceremonies easier, we
+recommend setting the threshold (M) of the multisig to be equal to the
+number of participants, and add M+1 additional signers
+using keys owned by the Facilitator, to make it a M-of-2M+1 multisig.
+For example, if there are 3 participants, we recommend creating a 3 of 7
+multisig with 4 additional keys owned by the Facilitator.
+
+#### 2. Create the HelloWorld contract
+
+1. Set the `COUNCIL_SAFE` address in `.env` to the newly-created Safe
+   address.
+2. Make sure your Ledger is connected and run `just deploy-contracts`
+   to deploy the `HelloWorld` contract.
+3. Set the `HelloWorld_ADDRESS` in `.env` to the newly-created
+   HelloWorld contract address.
+
+#### 3. Update input.json
+
+1. Make sure the `HelloWorld_ADDRESS` has been updated, then run `just
+   prepare-json` to update the `input.json` file.
+2. Test the newly created rehearsal by following the security council
+   steps in the `Approving the transaction` section above.
+3. Update the rehearsal folder name in the `1. Update repo and move to
+   the appropriate folder for this rehearsal task` section and the
+   address in the `3.2. Validate correctness of the state diff`
+   section above.
+4. Commit the newly created files to Github.
+
+### [After the rehearsal] Execute the output
+
+1. Collect outputs from all participating signers.
+2. Concatenate all signatures and export it as the `SIGNATURES`
+   environment variable, i.e. `export
+   SIGNATURES="0x[SIGNATURE1][SIGNATURE2]..."`.
+3. Run `just execute 0 # or 1 or ...` to execute the transaction onchain.
+
+For example, if the quorum is 2 and you get the following outputs:
+
+``` shell
+Data:  0xDEADBEEF
+Signer: 0xC0FFEE01
+Signature: AAAA
+```
+
+``` shell
+Data:  0xDEADBEEF
+Signer: 0xC0FFEE02
+Signature: BBBB
+```
+
+Then you should run
+
+``` shell
+export SIGNATURES="0xAAAABBBB"
+just execute 0 # or 1 or ...
+```

security-council-rehearsals/2025-01-12-r1-hello-council-250112/SignFromJson.s.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.15;
+
+// This import path should be relative to where the rehearsal script will be located after a new rehearsal is setup,
+// which is one level above the current location in
+// repo_root/security-council-rehearsals/<rehearsal-dir>/SignFromJson.s.sol
+import {SignFromJson as OriginalSignFromJson} from "../../script/SignFromJson.s.sol";
+import {Simulation} from "@base-contracts/script/universal/Simulation.sol";
+import {Vm, VmSafe} from "forge-std/Vm.sol";
+
+contract SignFromJson is OriginalSignFromJson {
+    // Since after _postCheck hook `require(false)`, the transaction will revert
+    // contract extending `SignFromJson` must implement its own `_postCheck` method, thus enforcing a more robust implementation pattern.
+    function _postCheck(Vm.AccountAccess[] memory accesses, Simulation.Payload memory simPayload)
+        internal
+        virtual
+        override
+    {
+        // Empty implementation for CI tasks
+        accesses; // Silences compiler warnings.
+        simPayload;
+    }
+}

security-council-rehearsals/2025-01-12-r1-hello-council-250112/input.json

@@ -0,0 +1,16 @@
+{
+  "version": "1.0",
+  "chainId": "1",
+  "meta": {
+    "name": "Hello World Rehearsal",
+    "description": "",
+    "txBuilderVersion": "1.16.2"
+  },
+  "transactions": [
+    {
+      "to": "0x5f5514DcBCe7fAB4Cf694733340435ED4dcCEA46",
+      "value": "0",
+      "data": "0xc605f76c"
+    }
+  ]
+}

security-council-rehearsals/2025-01-12-r1-hello-council-250112/justfile

@@ -0,0 +1,54 @@
+set dotenv-load
+export location := `pwd`
+export OWNER_SAFE := env_var("COUNCIL_SAFE")
+
+simulate hdPath='0':
+  #!/usr/bin/env bash
+  echo "getting signer address..."
+  if [ t"$SIMULATE_WITHOUT_LEDGER" == t1 ]
+  then
+    signer="0xc49d46E3F834f5C9856A7FcBEB185baD052c98e7"
+  else
+    signer=$(cast wallet address --ledger --mnemonic-derivation-path "m/44'/60'/{{hdPath}}'/0/0")
+  fi
+  echo "Simulating with: ${signer}"
+  echo ""
+
+  forge build
+  forge script ./SignFromJson.s.sol:SignFromJson --via-ir --rpc-url ${ETH_RPC_URL} \
+    --sig "signJson(string)" "${location}/input.json" \
+    --sender ${signer}
+
+sign hdPath='0':
+  #!/usr/bin/env bash
+  echo "getting signer address..."
+  signer=$(cast wallet address --ledger --mnemonic-derivation-path "m/44'/60'/{{hdPath}}'/0/0")
+  echo "Signing with: ${signer}"
+  echo ""
+  forge build
+  $(git rev-parse --show-toplevel)/bin/eip712sign --ledger --hd-paths "m/44'/60'/{{hdPath}}'/0/0" -- \
+    forge script ./SignFromJson.s.sol:SignFromJson --via-ir --rpc-url ${ETH_RPC_URL} \
+    --sig "signJson(string)" "${location}/input.json"
+
+execute hdPath='0':
+  #!/usr/bin/env bash
+  sender=$(cast wallet address --ledger --mnemonic-derivation-path "m/44'/60'/{{hdPath}}'/0/0")
+  forge build
+  forge script --fork-url ${ETH_RPC_URL} ./SignFromJson.s.sol:SignFromJson \
+  --sig "runJson(string,bytes)" ${location}/input.json ${SIGNATURES} \
+  --ledger --hd-paths "m/44'/60'/{{hdPath}}'/0/0" --broadcast \
+  --sender ${sender}
+
+deploy-contracts hdPath='0':
+  #!/usr/bin/env bash
+  sender=$(cast wallet address --ledger --mnemonic-derivation-path "m/44'/60'/{{hdPath}}'/0/0")
+  forge build
+  forge script DeployRehearsal1 --rpc-url ${ETH_RPC_URL} \
+    --ledger --hd-paths "m/44'/60'/{{hdPath}}'/0/0" --broadcast \
+    --sig 'run(address)' $COUNCIL_SAFE \
+    --sender ${sender}
+
+prepare-json:
+  #!/usr/bin/env bash
+
+  jq ".transactions[0].to |= \"${HelloWorld_ADDRESS}\"" ./input.json > ./input.tmp && mv input.tmp input.json