refactor(iroh-relay)!: improve relay map api#3563
Merged
Conversation
dignifiedquire
approved these changes
Oct 21, 2025
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/3563/docs/iroh/ Last updated: 2025-10-21T12:00:04Z |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
#3542 included unintended changes to the
RelayMapAPI. This cleans this up: We don't call entries in the relay map endpoints, instead we simply call them relays.Also improves the API docs and adds some examples for how to work with the
FromIteratorgeneric types used in construction and access. And renamed a couple of variables at use site in tests mostly to follow the new pattern.Breaking Changes
Renamed
iroh_relay::RelayMap::get_endpoint->getiroh_relay::RelayMap::endpoints->relaysiroh_relay::RelayMap::contains_endpoint->containsNotes & open questions
Change checklist
quic-rpciroh-gossipiroh-blobsdumbpipesendme