Skip to content

feat(rest): expose peer score and disconnect reason on /eth/v1/node/peers #8449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
barnabasbusa wants to merge 3 commits into
base: unstable
Choose a base branch
from
Draft

feat(rest): expose peer score and disconnect reason on /eth/v1/node/peers #8449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d83806f
feat(rest): expose application-level peer score on /eth/v1/node/peers
barnabasbusa May 14, 2026
e202dd1
feat(rest): expose disconnect_reason on /eth/v1/node/peers
barnabasbusa May 14, 2026
416f44e
fix(rest): gate disconnect_reason on disconnected/disconnecting state
barnabasbusa May 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions beacon_chain/networking/eth2_network.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ type
direction*: PeerType
disconnectedFut: Future[void]
statistics*: SyncResponseStats
lastDisconnectReason*: Opt[DisconnectionReason]
lastDisconnectAt*: Opt[chronos.Moment]

PeerAddr* = object
peerId*: PeerId
Expand Down Expand Up @@ -569,6 +571,8 @@ proc disconnect*(peer: Peer, reason: DisconnectionReason,
# we currently don't - the fact that we're disconnecting is obvious and the
# reason already known (wrong network is known from status message) or doesn't
# greatly matter for the listening side (since it can't be trusted anyway)
peer.lastDisconnectReason = Opt.some(reason)
peer.lastDisconnectAt = Opt.some(chronos.Moment.now())
try:
if peer.connectionState notin {Disconnecting, Disconnected}:
peer.connectionState = Disconnecting
Expand Down
50 changes: 45 additions & 5 deletions beacon_chain/rpc/rest_node_api.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,19 @@ proc toString(direction: PeerType): string =
of PeerType.Outgoing:
"outbound"

proc mapDisconnectReason(reason: DisconnectionReason): string =

@tersec tersec Jun 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

func

# Maps Nimbus's internal `DisconnectionReason` enum onto the controlled
# vocabulary proposed for `/eth/v1/node/peers` `disconnect_reason`.
case reason
of ClientShutDown:
"client_shutdown"
of IrrelevantNetwork:
"irrelevant_network"
of FaultOrError:
"io_error"
of PeerScoreLow:
"bad_score"

proc getLastSeenAddress(node: BeaconNode, id: PeerId): string =
let
address = node.network.switch.peerStore[LastSeenBook][id].valueOr:
Expand Down Expand Up @@ -203,9 +216,20 @@ proc installNodeApiHandlers*(router: var RestRouter, node: BeaconNode) =
last_seen_p2p_address: getLastSeenAddress(node, peer.peerId),
state: peer.connectionState.toString(),
direction: peer.direction.toString(),
# Fields `agent` and `proto` are not part of specification
# Fields `agent`, `proto`, `score` and `disconnect_reason` are not
# part of specification
agent: node.network.switch.peerStore[AgentBook][peer.peerId],
proto: node.network.switch.peerStore[ProtoVersionBook][peer.peerId]
proto: node.network.switch.peerStore[ProtoVersionBook][peer.peerId],
score: Opt.some(peer.score),
# Per beacon-API spec, `disconnect_reason` MUST only be populated
# when `state` is `disconnected` or `disconnecting`.
disconnect_reason:
if peer.connectionState in
{ConnectionState.Disconnected, ConnectionState.Disconnecting} and
peer.lastDisconnectReason.isSome():
Opt.some(mapDisconnectReason(peer.lastDisconnectReason.get()))
else:
Opt.none(string)
)
res.add(peer)
RestApiResponse.jsonResponseWMeta(res, (count: RestNumeric(len(res))))
Expand Down Expand Up @@ -247,9 +271,25 @@ proc installNodeApiHandlers*(router: var RestRouter, node: BeaconNode) =
state: peer.connectionState.toString(),
direction: peer.direction.toString(),
agent: node.network.switch.peerStore[AgentBook][peer.peerId],
# Fields `agent` and `proto` are not part of specification
proto: node.network.switch.peerStore[ProtoVersionBook][peer.peerId]
# Fields `agent` and `proto` are not part of specification
# Fields `agent`, `proto`, `score` and `disconnect_reason` are not
# part of specification
proto: node.network.switch.peerStore[ProtoVersionBook][peer.peerId],
# Fields `agent`, `proto`, `score` and `disconnect_reason` are not
# part of specification
score: Opt.some(peer.score),
# Fields `agent`, `proto`, `score` and `disconnect_reason` are not
# part of specification
disconnect_reason:
# Per beacon-API spec, `disconnect_reason` MUST only be populated
# when `state` is `disconnected` or `disconnecting`.
if peer.connectionState in
{ConnectionState.Disconnected, ConnectionState.Disconnecting} and
peer.lastDisconnectReason.isSome():
Opt.some(mapDisconnectReason(peer.lastDisconnectReason.get()))
else:
Opt.none(string)
# Fields `agent`, `proto`, `score` and `disconnect_reason` are not
# part of specification
)
)

Expand Down
2 changes: 2 additions & 0 deletions beacon_chain/spec/eth2_apis/rest_types.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,8 @@ type
direction*: string
agent*: string # This is not part of specification
proto*: string # This is not part of specification
score*: Opt[int] # This is not part of specification
disconnect_reason*: Opt[string] # This is not part of specification

RestSyncPeer* = object
peer_id*: string
Expand Down
Loading