Merge pull request #4516 from ethereum-optimism/jm/monitoring/package

bmon: Add package scaffolding for balance-monitor

.changeset/weak-crabs-reflect.md

+---
+'minimum-balance-agent': patch
+---
+
+Created the Balance Monitoring package

packages/balance-monitor/.env.example

+CHAINID=
+L1_RPC_URL=
+
+SEQUENCER_ADDRESS=
+SEQUENCER_WARNING_THRESHOLD=
+SEQUENCER_DANGER_THRESHOLD=
+
+PROPOSER_ADDRESS=
+PROPOSER_WARNING_THRESHOLD=
+PROPOSER_DANGER_THRESHOLD=
+

packages/balance-monitor/.eslintignore

+node_modules
+

packages/balance-monitor/.eslintrc.js

+module.exports = {
+  extends: '../../.eslintrc.js',
+  ignorePatterns: ['src/contract-artifacts.ts'],
+}

packages/balance-monitor/.gitignore

+node_modules
+dist
+forta.config.json

packages/balance-monitor/.prettierignore

+node_modules

packages/balance-monitor/.prettierrc.js

+module.exports = {
+  ...require('../../.prettierrc.js'),
+}

packages/balance-monitor/README.md

+# Minimum Balance Agent
+
+## Description
+
+A forta agent which detects when a specified account balance is below 0.5 ETH
+
+## Running
+
+1. Copy `.env.example` into `.env` and set the values as desired.
+2. `yarn run start:prod`
+
+
+## Alerts
+
+- `OPTIMISM-BALANCE-WARNING-[ACCOUNT_NAME]`
+  - `ACCOUNT_NAME` is either `SEQUENCER` or `PROPOSER`
+  - Fired when the specified account balance is below the configured WARNING threshold
+  - Severity is always set to "info"
+  - Type is always set to "info"
+  - Metadata "balance" field contains amount of wei in account
+
+- `OPTIMISM-BALANCE-DANGER-[ACCOUNT_NAME]`
+  - Fired when the specified account balance is below the configured DANGER threshold
+  - Severity is always set to "high"
+  - Type is always set to "info"
+  - Metadata "balance" field contains amount of wei in account

packages/balance-monitor/package.json

+{
+  "name": "minimum-balance-agent",
+  "version": "0.0.1",
+  "description": "Forta Agent that reports whether certain accounts have fallen below some balance",
+  "scripts": {
+    "build": "echo 'todo'",
+    "start": "yarn run start:dev",
+    "start:dev": "nodemon --watch src --watch forta.config.json -e js,ts,json  --exec 'yarn run build && forta-agent run'",
+    "start:prod": "forta-agent run --prod",
+    "tx": "yarn run build && forta-agent run --tx",
+    "block": "yarn run build && forta-agent run --block",
+    "range": "yarn run build && forta-agent run --range",
+    "test": "echo 'todo'"
+  },
+  "dependencies": {
+    "ethers": "^5.7.2",
+    "forta-agent": "^0.1.1"
+  },
+  "devDependencies": {
+    "@types/nodemon": "^1.19.0",
+    "nodemon": "^2.0.8",
+    "typescript": "^4.3.4"
+  }
+}

packages/balance-monitor/tsconfig.json

+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+  "include": [
+    "src/**/*"
+  ]
+}