fix(routing/http): support lookups with legacy peerid notation #585
Conversation
This file contains 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
we already return base58, but we did not support them as input. libp2p specs state implementations MUST support both, it is also better for end users if we are liberal in inputs and support both notations: https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#string-representation
Codecov ReportAttention: Patch coverage is
@@ Coverage Diff @@
## main #585 +/- ##
==========================================
- Coverage 65.59% 65.58% -0.02%
==========================================
Files 207 207
Lines 25612 25617 +5
==========================================
Hits 16801 16801
- Misses 7338 7340 +2
- Partials 1473 1476 +3
|
hacdias
approved these changes
Mar 6, 2024
|
For the record, anothr bug fixed by this PR is case when a legacy RSA key is used: $ curl https://delegated-ipfs.dev/routing/v1/peers/QmQzqxhK82kAmKvARFZSkUVS6fo9sySaiogAnx5EnZ6ZmC
unable to parse peer ID: can't convert CID of type "dag-pb" to a peer ID |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR adds support for legacy Base58-encoded PeerIDs on
/routing/v1/peers/{peerid}endpoint.Rationale
Robustness and consistency.
We already return base58 in responses, but we did not support base58 notation as input, hoping this would force initial implementers to do the right thing. But returning error here likely hurts routing in general, as someone may learn about peer using legacy ID, do a naive lookup, fail due to using old encoding, and then assume the peer is offline.
Another reason: libp2p specs here state implementations MUST support both,
it is also better for end users if we are liberal in inputs and support both notations:
Ref.