Skip to content

refactor(libp2p): rename underlays to overlayToPeerID in peer registry#5337

Merged
gacevicljubisa merged 1 commit intomasterfrom
refactor/peer-registry-underlays-to-peer-ids
Jan 29, 2026
Merged

refactor(libp2p): rename underlays to overlayToPeerID in peer registry#5337
gacevicljubisa merged 1 commit intomasterfrom
refactor/peer-registry-underlays-to-peer-ids

Conversation

@gacevicljubisa
Copy link
Member

@gacevicljubisa gacevicljubisa commented Jan 29, 2026

Checklist

  • I have read the coding guide.
  • My change requires a documentation update, and I have done it.
  • I have added tests to cover my changes.
  • I have filled out the description and linked the related issues.

Description

The field 'underlays' was misleadingly named as it:

  • Is indexed by overlay addresses, not underlay addresses
  • Stores libp2p peer IDs, not underlay network addresses
  • Used plural form suggesting multiple values per key

Renamed to 'overlayToPeerID' to accurately reflect that it maps
overlay addresses (string) to their corresponding libp2p peer IDs.

Open API Spec Version Changes (if applicable)

Motivation and Context (Optional)

Related Issue (Optional)

Screenshots (if appropriate):

@gacevicljubisa gacevicljubisa changed the title refactor(libp2p): rename underlays to peerIDsByOverlay in peer registry refactor(libp2p): rename underlays to overlayToPeerID in peer registry Jan 29, 2026
@gacevicljubisa gacevicljubisa merged commit 6ddf9b4 into master Jan 29, 2026
19 checks passed
@gacevicljubisa gacevicljubisa deleted the refactor/peer-registry-underlays-to-peer-ids branch January 29, 2026 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants