Merge pull request #5919 from ethereum-optimism/willc/bedrock-cleanup

feat: Add example.env

packages/fault-detector/example.env

+#  --l1rpcprovider                Provider for interacting with L1 (env: FAULT_DETECTOR__L1_RPC_PROVIDER)
+FAULT_DETECTOR__L1_RPC_PROVIDER=
+#  --l2rpcprovider                Provider for interacting with L2 (env: FAULT_DETECTOR__L2_RPC_PROVIDER)
+FAULT_DETECTOR__L2_RPC_PROVIDER=
+#  --bedrock                      Whether or not the service is running against a Bedrock chain (env: FAULT_DETECTOR__BEDROCK)
+BEDROCK=true
+
+# Optional Params
+
+#  --startbatchindex              Batch index to start checking from. For bedrock chains, this is the L2 height to start from (env: FAULT_DETECTOR__START_BATCH_INDEX)
+# FAULT_DETECTOR__START_BATCH_INDEX=
+#  --optimismportaladdress        [Custom Bedrock Chains] Deployed OptimismPortal contract address. Used to retrieve necessary info for ouput verification  (env: FAULT_DETECTOR__OPTIMISM_PORTAL_ADDRESS)
+# FAULT_DETECTOR__OPTIMISM_PORTAL_ADDRESS=
+#  --statecommitmentchainaddress  [Custom Legacy Chains] Deployed StateCommitmentChain contract address. Used to fetch necessary info for output verification. (env: FAULT_DETECTOR__STATE_COMMITMENT_CHAIN_ADDRESS)
+# FAULT_DETECTOR__STATE_COMMITMENT_CHAIN_ADDRESS=
+#  --loopintervalms               Loop interval in milliseconds, only applies if service is set to loop (env: FAULT_DETECTOR__LOOP_INTERVAL_MS)
+# FAULT_DETECTOR__LOOP_INTERVAL_MS=
+#  --port                         Port for the app server (env: FAULT_DETECTOR__PORT)
+# FAULT_DETECTOR__PORT=
+#  --hostname                     Hostname for the app server (env: FAULT_DETECTOR__HOSTNAME)
+# FAULT_DETECTOR__HOSTNAME=
+#  --loglevel                     Log level (env: FAULT_DETECTOR__LOG_LEVEL)
+# FAULT_DETECTOR__LOG_LEVEL=

packages/fault-detector/package.json

@@ -42,6 +42,7 @@
     "@types/dateformat": "^5.0.0",
     "chai-as-promised": "^7.1.1",
     "dateformat": "^4.5.1",
+    "dotenv": "^16.1.4",
     "ethereum-waffle": "^3.4.4",
     "ethers": "^5.7.0",
     "hardhat": "^2.9.6",

packages/fault-detector/src/service.ts

@@ -7,6 +7,7 @@ import {
   waitForProvider,
 } from '@eth-optimism/common-ts'
 import { getChainId, sleep, toRpcHexString } from '@eth-optimism/core-utils'
+import { config } from 'dotenv'
 import {
   CONTRACT_ADDRESSES,
   CrossChainMessenger,
@@ -553,6 +554,7 @@ export class FaultDetector extends BaseServiceV2<Options, Metrics, State> {
 }
 
 if (require.main === module) {
+  config()
   const service = new FaultDetector()
   service.run()
 }

yarn.lock

@@ -8999,6 +8999,11 @@ dotenv@^16.0.3:
   resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-16.0.3.tgz#115aec42bac5053db3c456db30cc243a5a836a07"
   integrity sha512-7GO6HghkA5fYG9TYnNxi14/7K9f5occMlp3zXAuSxn7CKCxt9xbNWG7yF8hTCSUchlfWSe3uLmlPfigevRItzQ==
 
+dotenv@^16.1.4:
+  version "16.1.4"
+  resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-16.1.4.tgz#67ac1a10cd9c25f5ba604e4e08bc77c0ebe0ca8c"
+  integrity sha512-m55RtE8AsPeJBpOIFKihEmqUcoVncQIwo7x9U8ZwLEZw9ZpXboz2c+rvog+jUaJvVrZ5kBOeYQBX5+8Aa/OZQw==
+
 dotignore@~0.1.2:
   version "0.1.2"
   resolved "https://registry.yarnpkg.com/dotignore/-/dotignore-0.1.2.tgz#f942f2200d28c3a76fbdd6f0ee9f3257c8a2e905"