openzeppelin/openzeppelin-monitor repository overview

⁠OpenZeppelin Monitor

In the rapidly evolving world of blockchain technology, effective monitoring is crucial for ensuring security and performance. OpenZeppelin Monitor is a blockchain monitoring service that watches for specific on-chain activities and triggers notifications based on configurable conditions. The service offers multi-chain support with configurable monitoring schedules, flexible trigger conditions, and an extensible architecture for adding new chains.

Install⁠ | User Docs⁠ | Quickstart⁠ | Crate Docs⁠

⁠Pre-requisites

• Docker installed on your machine
• Copy example configuration files to ./config directory and modify according to your needs. See examples⁠ for more information.

⁠How to use images pushed to DockerHub

• These images are automatically pulled when you use docker compose. See using docker compose⁠ for more information.
• If you are not using docker compose and you want to use these images, follow the steps below.

⁠1. Pull the image

You can pull the latest image using the following command:

docker pull openzeppelin/openzeppelin-monitor:latest

⁠2. Run the image

You can run the image using the following command:

docker run -d \
  --name monitor \
  -v ./config:/app/config:ro \
  openzeppelin/openzeppelin-monitor:latest

⁠3. Stop the container

You can stop the container using the following command:

docker stop monitor

⁠4. Remove the container

You can remove the container using the following command:

docker rm monitor

⁠5. Remove the image

You can remove the image using the following command:

docker rmi openzeppelin/openzeppelin-monitor:latest

⁠Contributing

We welcome contributions from the community. Please read our contributing section⁠ for more information.

⁠License

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE⁠ file for details.

⁠Security

For security concerns, please refer to our Security Policy⁠.

⁠Get Help

If you have any questions, first see if the answer to your question can be found in the User Documentation⁠.

If the answer is not there:

• Join the Telegram⁠ to get help, or
• Open an issue with the bug⁠

We encourage you to reach out with any questions or feedback.