Relay Monitor API Specifications

Relay Monitor API is an interface for a MEV-Boost PBS relay monitoring service based on a design for a behavior and performance monitoring service. This interface enables interested parties such as validators running MEV-boost software to get insight into the operation of the relays that they connect to.

The Relay Monitor API consists of several groups of endpoints:

• Transcripts
• Relay Faults
• Relay Scores
• Relay Monitor Metrics

Contributing

The API specification is checked for lint errors before merging pull requests.

To run the linter locally, install it with:

npm install -g @redocly/cli

and then run it:

redocly lint rm-oapi.yaml

Render API Specification

To render spec in browser, you will simply need an HTTP server to load the index.html file in root of the repo.

For example:

python -m http.server 8080

The spec will render at http://localhost:8080.