add-timelock-monitoring

Configure Envio indexing and monitoring routing for new timelock contracts.

12|13|Updated Aug 1, 2024
One-click install
npx skills add https://github.com/yearn/monitoring --skill add-timelock-monitoring
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-timelock-monitoring
Source: https://github.com/yearn/monitoring/tree/main/timelock
Command: npx skills add https://github.com/yearn/monitoring --skill add-timelock-monitoring

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines adding a new timelock contract to the monitoring system so Envio can index the right events and the monitoring script can reliably produce Telegram alerts.

Core Features & Use Cases

  • Timelock type identification: Determine the correct timelock “type” by verifying the exact scheduling event signature from the on-chain contract ABI.
  • Coordinated onboarding across repositories: Make the required Envio indexer changes first (to ensure events are indexed) and then update monitoring configuration (to route alerts to the correct Telegram protocol/channel).
  • Support for both existing and new timelock types: Reuse an existing contract type mapping when the event signature matches, or define a new contract type plus handler when it does not.
  • Operational verification: Provide a concrete validation run that backfills recent events to confirm the new timelock is functioning end-to-end.

Quick Start

Follow the deployment order by first updating and deploying the Envio indexer for the new timelock type or address, then update monitoring timelock configuration and verify with a backfill run using the provided command.

Frequently Asked Questions about add-timelock-monitoring

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I onboard a new DeFi governance timelock contract into a monitoring system?

Onboarding a new DeFi governance timelock requires updating the Envio indexer configuration to index scheduling events and then updating the monitoring routing configuration to direct Telegram alerts to the correct channel. Deployment order is critical for end-to-end verification.

How does event signature matching work when adding a timelock to an Envio indexer?

Event signature matching verifies the exact scheduling event signature from the on-chain contract ABI. If the signature matches an existing mapping, you reuse it; if not, you define a new contract type plus handler in the Envio indexer config.

Why do I need to run a backfill verification after adding a new timelock address?

A backfill verification run is needed to confirm the new timelock is functioning end-to-end. It backfills recent events using a specific lookback window and cache control to ensure the Envio indexer and monitoring script reliably produce Telegram alerts.

Can I add additional timelock addresses for existing protocols across multiple chains?

Yes, you can add additional timelock addresses for existing protocols across multiple chains and timelock event schemas. The process supports multi-repo changes, requiring coordinated updates in the Envio indexer config and event handler mapping.

What format should timelock contract addresses use in the monitoring configuration?

Timelock contract addresses must use lowercase format in the monitoring configuration. Ensuring exact lowercase address configuration prevents routing mismatches when the monitoring script processes indexed events and sends Telegram alerts.

What is the correct deployment order for adding timelock monitoring?

The correct deployment order for adding timelock monitoring is to first update and deploy the Envio indexer for the new timelock type or address, then update the monitoring timelock configuration, and finally verify with a backfill run using the provided command.