chore/remove-peer-info-from-api #25
Merged
Conversation
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
vasco-santos
commented
Apr 7, 2020
|
Just FYI there are issues with the latest http client being worked on in #23. Builds should be fine here once that's merged. |
hugomrdias
previously requested changes
Apr 7, 2020
|
you also need the stuff in the PR jacob mentioned for remote nodes |
vasco-santos
force-pushed
the
chore/remove-peer-info-from-api
branch
2 times, most recently
from
d925627 to
266a5f4
Compare
|
updated ipfsd-ctl docs to better explain the setup |
vasco-santos
force-pushed
the
chore/remove-peer-info-from-api
branch
2 times, most recently
from
b1af5e2 to
be62fa2
Compare
BREAKING CHANGE: findPeer returns id and addrs properties instead of peer-info instance
vasco-santos
force-pushed
the
chore/remove-peer-info-from-api
branch
from
be62fa2 to
60137d2
Compare
jacobheun
reviewed
Apr 21, 2020
README.md
Outdated
| @@ -17,9 +17,9 @@ const DelegatedPeerRouting = require('libp2p-delegated-peer-routing') | |||
| const routing = new DelegatedPeerRouing() | |||
|
|
|||
| try { | |||
| const peerInfo = await routing.findPeer('peerid') | |||
| const { id, addresses } = await routing.findPeer('peerid') | |||
There was a problem hiding this comment.
This will fail, needs to be addrs.
Also, I realized this is different than the peer discovery api. Perhaps we should make peer routing consistent with peer discovery and do { id, multiaddrs }? https://github.com/libp2p/js-libp2p-interfaces/tree/v0.3.x/src/peer-discovery#discoverying-peers
Suggested change
| const { id, addresses } = await routing.findPeer('peerid') | |
| const { id, addrs } = await routing.findPeer('peerid') |
src/index.js
Outdated
| @@ -36,25 +35,28 @@ class DelegatedPeerRouting { | |||
| * @param {PeerID} id | |||
| * @param {object} options | |||
| * @param {number} options.timeout How long the query can take. Defaults to 30 seconds | |||
| * @returns {Promise<PeerInfo>} | |||
| * @returns {Promise<{ id: PeerId, addrs: Multiaddr[] }>} | |||
There was a problem hiding this comment.
Per above, make this { id, multiaddrs }?
1 task
|
Beta release is out dist-tags:
beta: 0.5.0 latest: 0.4.3 |
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.
In the context of deprecating
peer-infoas described on libp2p/js-libp2p#589, this PR removes thepeer-infofrom being returned in the API, in favour of returning{ id, addrs }in the same way as ipfs does.BREAKING CHANGE: findPeer returns id and addrs properties instead of peer-info instance
Needs: