Merge pull request #5701 from ethereum-optimism/hamdi/fault.detector

fault-detector: add readme for custom op-chains (+ bugfix)

packages/fault-detector/README.md

@@ -16,8 +16,13 @@ yarn build
 
 ## Running the service
 
-Copy `.env.example` into a new file named `.env`, then set the environment variables listed there.
-Once your environment variables have been set, run the service via:
+Copy `.env.example` into a new file named `.env`, then set the environment variables listed there. Additional env setting are listed on `--help`. If running the fault detector against
+a custom op chain, the necessary contract addresses must also be set associated with the op-chain.
+
+- Bedrock: `OptimismPortal`
+- Legacy: `StateCommitmentChain`
+
+Once your environment variables or flags have been set, run the service via:
 
 ```
 yarn start
@@ -34,8 +39,14 @@ yarn start
 
 The `fault-detector` detects differences between the transaction results generated by your local Optimism node and the transaction results actually published to Ethereum.
 Currently, transaction results take the form of [the root of the Optimism state trie](https://medium.com/@eiki1212/ethereum-state-trie-architecture-explained-a30237009d4e).
-For every Optimism block, the state root of the block is published to the [`StateCommitmentChain`](https://github.com/ethereum-optimism/optimism/blob/39b7262cc3ffd78cd314341b8512b2683c1d9af7/packages/contracts/contracts/L1/rollup/StateCommitmentChain.sol) contract on Ethereum.
+
+- For bedrock chains, the state root of the block is published to the [`L2OutputOracle`](https://github.com/ethereum-optimism/optimism/blob/39b7262cc3ffd78cd314341b8512b2683c1d9af7/packages/contracts-bedrock/contracts/L1/L2OutputOracle.sol) contract on Ethereum.
+    - ***Note***: The service accepts the `OptimismPortal` as a flag instead of the `L2OutputOracle` for backwards compatibility with early versions of these contracts. The `L2OutputOracle`
+    is inferred from the portal contract.
+- For bedrock chains, the state root of the block is published to the [`StateCommitmentChain`](https://github.com/ethereum-optimism/optimism/blob/39b7262cc3ffd78cd314341b8512b2683c1d9af7/packages/contracts/contracts/L1/rollup/StateCommitmentChain.sol) contract on Ethereum.
+
 We can therefore detect differences by, for each block, checking the state root of the given block as reported by an Optimism node and the state root as published to Ethereum.
+In order for the fault detector to differentiate between bedrock and legacy chains, please make sure to specify `--bedrock`.
 
 We export a series of Prometheus metrics that you can use to trigger alerting when issues are detected.
 Check the list of available metrics via `yarn start --help`:
@@ -52,6 +63,9 @@ Options:
   --startbatchindex  Batch index to start checking from. Setting it to -1 will cause the fault detector to find the first state batch index that has not yet passed the fault proof window (env: FAULT_DETECTOR__START_BATCH_INDEX, default value: -1)
   --loopintervalms   Loop interval in milliseconds (env: FAULT_DETECTOR__LOOP_INTERVAL_MS)
   --bedrock          Whether or not the service is running against a Bedrock chain (env: FAULT_DETECTOR__BEDROCK, default value: false)
+  --optimismportaladdress        [Custom Bedrock Chains] Deployed OptimismPortal contract address. Used to retrieve necessary info for ouput verification  (env: FAULT_DETECTOR__OPTIMISM_PORTAL_ADDRESS, default 0x0)
+  --statecommitmentchainaddress  [Custom Legacy Chains] Deployed StateCommitmentChain contract address. Used to fetch necessary info for output verification. (env: FAULT_DETECTOR__STATE_COMMITMENT_CHAIN_ADDRESS, default 0x0)
+
   --port             Port for the app server (env: FAULT_DETECTOR__PORT)
   --hostname         Hostname for the app server (env: FAULT_DETECTOR__HOSTNAME)
   -h, --help         display help for command

packages/fault-detector/src/service.ts

@@ -10,7 +10,6 @@ import { getChainId, sleep, toRpcHexString } from '@eth-optimism/core-utils'
 import {
   CONTRACT_ADDRESSES,
   CrossChainMessenger,
-  DeepPartial,
   getOEContract,
   L2ChainID,
   OEL1ContractsLike,
@@ -85,13 +84,13 @@ export class FaultDetector extends BaseServiceV2<Options, Metrics, State> {
         optimismPortalAddress: {
           validator: validators.str,
           default: ethers.constants.AddressZero,
-          desc: '[Bedrock] Deployed OptimismPortal contract address. Used to retrieve necessary info for ouput verification. **Required** for custom op chains',
+          desc: '[Custom Bedrock Chains] Deployed OptimismPortal contract address. Used to retrieve necessary info for ouput verification ',
           public: true,
         },
         stateCommitmentChainAddress: {
           validator: validators.str,
           default: ethers.constants.AddressZero,
-          desc: '[Legacy] Deployed StateCommitmentChain contract address. Used to fetch necessary info for output verification. **Required** for custom op chains',
+          desc: '[Custom Legacy Chains] Deployed StateCommitmentChain contract address. Used to fetch necessary info for output verification.',
           public: true,
         },
       },
@@ -125,12 +124,21 @@ export class FaultDetector extends BaseServiceV2<Options, Metrics, State> {
    * - Legacy: StateCommitmentChain to query for output roots.
    *
    * @param l2ChainId op chain id
-   * @returns DeepPartial<OEL1ContractsLike> addresses needed just for the fault detector
+   * @returns OEL1ContractsLike  set of L1 contracts with only the required addresses set
    */
-  async getOEL1Contracts(
-    l2ChainId: number
-  ): Promise<DeepPartial<OEL1ContractsLike>> {
-    let contracts = {} as OEL1ContractsLike
+  async getOEL1Contracts(l2ChainId: number): Promise<OEL1ContractsLike> {
+    // CrossChainMessenger requires all address to be defined. Default to `AddressZero` to ignore unused contracts
+    let contracts: OEL1ContractsLike = {
+      AddressManager: ethers.constants.AddressZero,
+      L1CrossDomainMessenger: ethers.constants.AddressZero,
+      L1StandardBridge: ethers.constants.AddressZero,
+      StateCommitmentChain: ethers.constants.AddressZero,
+      CanonicalTransactionChain: ethers.constants.AddressZero,
+      BondManager: ethers.constants.AddressZero,
+      OptimismPortal: ethers.constants.AddressZero,
+      L2OutputOracle: ethers.constants.AddressZero,
+    }
+
     const chainType = this.options.bedrock ? 'bedrock' : 'legacy'
     this.logger.info(`Setting contracts for OP chain type: ${chainType}`)
 
@@ -157,7 +165,7 @@ export class FaultDetector extends BaseServiceV2<Options, Metrics, State> {
         contracts.OptimismPortal = address
 
         this.logger.info('fetching L2OutputOracle contract from OptimismPortal')
-        const opts = { address, signerOrPovider: this.options.l1RpcProvider }
+        const opts = { address, signerOrProvider: this.options.l1RpcProvider }
         const portalContract = getOEContract('OptimismPortal', l2ChainId, opts)
         contracts.L2OutputOracle = await portalContract.L2_ORACLE()
       }