-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrm-oapi.yaml
113 lines (106 loc) · 4.16 KB
/
rm-oapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
openapi: "3.0.3"
info:
title: Relay Monitor API
description: |
API specification for a MEV-Boost PBS relay 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.
version: "dev"
contact:
name: GitHub Repository
url: https://github.com/andriidski/relay-monitor-specs
license:
name: "CC0-1.0"
url: "https://creativecommons.org/publicdomain/zero/1.0/"
servers:
- url: "{server_url}"
variables:
server_url:
description: "Relay Monitor URL"
default: "http://localhost:8080"
tags:
- name: Transcript
description: Set of endpoints for providing proposer-view data to the relay monitor.
- name: Faults
description: Set of endpoints for fault data from monitored relays.
- name: Scores
description: Set of endpoints for scoring monitored relays.
- name: Metrics
description: Set of endpoints to receive relay monitor operation data.
paths:
# Transcript
/monitor/v1/transcript:
$ref: "./apis/monitor/transcript/transcript.yaml"
# Faults
/monitor/v1/fault/stats:
$ref: "./apis/monitor/faults/fault_stats_report.yaml"
/monitor/v1/fault/stats/{pubkey}:
$ref: "./apis/monitor/faults/fault_stats.yaml"
/monitor/v1/fault/records:
$ref: "./apis/monitor/faults/fault_records_report.yaml"
/monitor/v1/fault/records/{pubkey}:
$ref: "./apis/monitor/faults/fault_records.yaml"
# Scores
/monitor/v1/scores/reputation:
$ref: "./apis/monitor/scores/reputation_report.yaml"
/monitor/v1/scores/reputation/{pubkey}:
$ref: "./apis/monitor/scores/reputation.yaml"
/monitor/v1/scores/bid_delivery:
$ref: "./apis/monitor/scores/bid_delivery_report.yaml"
/monitor/v1/scores/bid_delivery/{pubkey}:
$ref: "./apis/monitor/scores/bid_delivery.yaml"
# Metrics
/monitor/v1/metrics/validators/count:
$ref: "./apis/monitor/metrics/validators_count.yaml"
/monitor/v1/metrics/validators/registration_count:
$ref: "./apis/monitor/metrics/validators_registration_count.yaml"
/monitor/v1/metrics/bids/analyzed_count:
$ref: "./apis/monitor/metrics/bids_analyzed_count.yaml"
/monitor/v1/metrics/bids/analyzed_count_valid:
$ref: "./apis/monitor/metrics/bids_analyzed_valid_count.yaml"
/monitor/v1/metrics/bids/analyzed_count_fault:
$ref: "./apis/monitor/metrics/bids_analyzed_fault_count.yaml"
components:
schemas:
Uint64:
$ref: "./beacon-apis/types/primitive.yaml#/Uint64"
Root:
$ref: "./beacon-apis/types/primitive.yaml#/Root"
Pubkey:
$ref: "./beacon-apis/types/primitive.yaml#/Pubkey"
ErrorMessage:
$ref: "./beacon-apis/types/http.yaml#/ErrorMessage"
FaultStatsReportResponse:
$ref: "./types/responses.yaml#/FaultStatsReportResponse"
FaultStatsResponse:
$ref: "./types/responses.yaml#/FaultStatsResponse"
FaultRecordsReportResponse:
$ref: "./types/responses.yaml#/FaultRecordsReportResponse"
FaultRecordsResponse:
$ref: "./types/responses.yaml#/FaultRecordsResponse"
ScoreReportReponse:
$ref: "./types/responses.yaml#/ScoreReportReponse"
ScoreResponse:
$ref: "./types/responses.yaml#/ScoreResponse"
CountResponse:
$ref: "./types/responses.yaml#/CountResponse"
Bellatrix.AuctionTranscript:
$ref: "./types/bellatrix/transcript.yaml#/Bellatrix/AuctionTranscript"
Capella.AuctionTranscript:
$ref: "./types/capella/transcript.yaml#/Capella/AuctionTranscript"
Bellatrix.SignedBuilderBid:
$ref: "./types/builder/bid.yaml#/Bellatrix/SignedBuilderBid"
Capella.SignedBuilderBid:
$ref: "./types/builder/bid.yaml#/Capella/SignedBuilderBid"
Bellatrix.SignedBlindedBeaconBlock:
$ref: "./beacon-apis/types/bellatrix/block.yaml#/Bellatrix/SignedBlindedBeaconBlock"
Capella.SignedBlindedBeaconBlock:
$ref: "./beacon-apis/types/capella/block.yaml#/Capella/SignedBlindedBeaconBlock"
responses:
InternalError:
$ref: "./types/http.yaml#/InternalError"
examples:
Bellatrix.AuctionTranscript:
$ref: "./examples/bellatrix/transcript.json"
Capella.AuctionTranscript:
$ref: "./examples/capella/transcript.json"