fluencelabs/js-libp2p-interfaces
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-interfaces synced 2025-06-13 17:01:38 +00:00
Code Issues Projects Releases Wiki Activity

chore: update content and peer routing interfaces removing peer-info (#43)

Browse Source 
* chore: update content and peer routing interfaces removing peer-info

BREAKING CHANGE: content-routing and peer-routing APIs return an object with relevant properties instead of peer-info
This commit is contained in:
Vasco Santos
2020-04-17 17:22:43 +02:00
committed by Jacob Heun
parent 5bcfc966f7
commit 87e2e89791
2 changed files with 38 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/peer-routing/README.md
View File

@ -30,12 +30,17 @@ TBD
A valid (read: that follows this abstraction) Peer Routing module must implement the following API.
### `.findPeers` - Find peers 'responsible' or 'closest' to a given key
### findPeer
- `Node.js` peerRouting.findPeers(key, function (err, peersPriorityQueue) {})
- `findPeer(peerId)`
In a peer to peer context, the concept of 'responsability' or 'closeness' for a given key translates to having a way to find deterministically or that at least there is a significant overlap between searches, the same group of peers when searching for the same given key.
Query the network for all multiaddresses associated with a `PeerId`.
This method will query the network (route it) and return a Priority Queue data structure with a list of PeerInfo objects, ordered by 'closeness'.
**Parameters**
- [peerId](https://github.com/libp2p/js-peer-id).
key is a multihash
**Returns**
It returns the [peerId](https://github.com/libp2p/js-peer-id) together with the known peers [multiaddrs](https://github.com/multiformats/js-multiaddr), as follows:
`Promise<{ id: PeerId, addrs: Multiaddr[] }>`