Skip to content

Monitoring scripts for DeFi protocols to track key metrics and send alerts.

Notifications You must be signed in to change notification settings

yearn/monitoring-scripts-py

Repository files navigation

SAM Tools

Ask DeepWiki Hourly Monitoring Scripts Daily Monitoring Scripts Safe Multisigs

Monitoring scripts for DeFi protocols to track key metrics and send alerts.

Supported Protocols

Cross-Protocol Monitoring

  • Timelock Alerts — monitors OpenZeppelin TimelockController contracts for CallScheduled events across multiple protocols and sends Telegram alerts to protocol-specific channels.
  • Safe Multisigs — monitors Safe multisig wallets for queued transactions across multiple protocols.

Telegram Alerts

  • Invite SAM alerter bot to Telegram group using handle: @sam_alerter_bot

Installation

  1. Clone the repository
git clone https://github.com/yearn/monitoring-scripts-py.git
cd monitoring-scripts-py
  1. Set up virtual environment
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
  1. Install dependencies
uv pip install -e ".[dev]"

Note: This project uses uv for faster dependency installation. If you don't have uv installed, you can install it with pip install uv or follow the installation instructions.

  1. Environment setup

Copy and edit example environment file:

cp .env.example .env

Usage

Run a specific script for a protocol. Example:

uv run aave/main.py

Code Style

Format and lint code with ruff:

uv run ruff format .
uv run ruff check --fix .
uv run pytest tests/

See CONTRIBUTING.md for full style guidelines, project conventions, and instructions on adding new protocols.

Details

For more details about this repository, check out AI generated docs using DeepWiki at https://deepwiki.com/yearn/monitoring-scripts-py.

About

Monitoring scripts for DeFi protocols to track key metrics and send alerts.

Resources

Contributing

Stars

Watchers

Forks

Languages