Skip to content

lidofinance/alerting-forta

Repository files navigation

Lido Detection bots for Forta

Bots list

ethereum-operations - Lido Detection bot fot stETH protocol operations

ethereum-financial - Lido Detection bot fot stETH protocol finance activity

ethereum-huge-tx - Lido Detection bot fot huge tx of the Lido tokens of interest detection

lido-on-polygon - Lido Detection bot for stMATIC protocol (should be launched against Ethereum mainnet)

polygon - Detection bot for Lido Apps on the Polygon network (should be launched against Polygon mainnet)

arb-subgraph - Lido Subgraph bot on the Arbitrum network (should be launched against Arbitrum mainnet)

l2-bridge-arbitrum - Detection bot for Arbitrum part of L2 bridge

l2-bridge-balance - Detection bot for L2 bridges balances

l2-bridge-base - Detection bot for Base part of L2 bridge

l2-bridge-ethereum - Detection bot for Ethereum part of L2 bridges

l2-bridge-mantle - Detection bot for Mantle part of L2 bridges

l2-bridge-optimism - Detection bot for Optimism part of L2 bridge

l2-bridge-zkSync - Detection bot for ZkSync part of L2 bridge

l2-bridge-scroll - Detection bot for Scroll part of L2 bridge

phishing-detect - Phishing detection bot for the Lido ERC20 tokens

multisig-watcher - Multisig events detector bot

voting-watcher - Lido bot for watching votes

storage-watcher - Detection bot that monitors critical storage changes

Local development

To launch the bot environment similar to the production environment, several services need to be set up:

  • NATS — Message bus
  • Forta-node — Forta wrapper over the Ethereum-like node
  • Forta-scanner — service communicating with forta-agent via gRPC

Setup

  1. Install docker
  2. Clone forta-node repo: git clone https://github.com/forta-network/forta-node
  3. cd forta-node && make containers. It creates containers for local usage
  4. Go back to alerting-forta and provide your own scan.jsonRpc.url in forta-local-config.yml
  5. Run docker-compose up -d
  6. Run your service in production mode. For example ethereum-steth
    1. cd ethereum-steth
    2. yarn start:prod
  7. Extra: If you want to send agent's findings into Telegram chat or discord chat then provide value in config: localMode.webhookUrl: http://localhost:5001/hook/<your slug name>

Full capabilities for running in localmode you can find here: https://docs.forta.network/en/latest/scanner-local-mode/. Also, the forta-scanner config file is useful for a deep dive — check the following: https://github.com/forta-network/forta-node/blob/master/config/config.go#L155

Or use emulation prod environment for local development.

Just navigate to the bot directory and run yarn start. Forta-sdk provides emulation prod environment for a simplified local development

Contribute

See bots README plus How to setup l2 bot. Please, check it L2_BOT

We use prettier and eslint

Everything you need to do involves a few steps. Add the following scripts to your package.json:

  • Add dependencies like devDependencies:
{
  "devDependencies": {
    "@typescript-eslint/eslint-plugin": "^6.12.0",
    "@typescript-eslint/parser": "^6.12.0",
    "eslint": "^8.54.0",
    "eslint-config-prettier": "^9.0.0",
    "eslint-plugin-jest": "^27.6.0",
    "eslint-plugin-prettier": "^5.0.1",
    "prettier": "^3.1.0"
  }
}
{
  "scripts": {
    "eslint:lint": "eslint ./src ./tests",
    "eslint:format": "eslint ./src ./tests --fix",
    "prettier:check": "prettier --check ./src ./tests",
    "prettier:format": "prettier --write ./src ./tests README.md",
    "lint": "yarn run prettier:check && yarn run eslint:lint",
    "format": "yarn run eslint:format && yarn run prettier:format"
  }
}

touch .eslintrc.json and past settings for eslint. This will allow to use eslint and prettier together.

{
  "parser": "@typescript-eslint/parser",
  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
  "plugins": ["@typescript-eslint", "prettier"],
  "env": {
    "node": true,
    "es6": true
  },
  "rules": {
    "prettier/prettier": "error",
    "curly": "error"
  }
}

And finally:

yarn install
yarn format