fluencelabs/js-libp2p-interfaces
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-interfaces synced 2025-03-18 01:21:00 +00:00
Code Issues Projects Releases Wiki Activity

feat: peer-discovery not using peer-info

Browse Source 
BREAKING CHANGE: peer-discovery emits object with id and multiaddrs properties
This commit is contained in:
Vasco Santos 2020-04-06 14:43:16 +02:00 committed by Jacob Heun
parent 1bef8d5d78
commit bdd2502ef6
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/peer-discovery/README.md
View File

@ -72,4 +72,7 @@ It returns a `Promise`
- `discovery.on('peer', (peerInfo) => {})`
Everytime a peer is discovered by a discovery service, it emmits a `peer` event with the discover peer's [PeerInfo](https://github.com/libp2p/js-peer-info).
Everytime a peer is discovered by a discovery service, it emmits a `peer` event with the discovered peer's information, which must contain the following properties:
- `<`[`PeerId`](https://github.com/libp2p/js-peer-id)`>` `peerInfo.id`
- `<Array<`[`Multiaddr`](https://github.com/multiformats/js-multiaddr)`>>` `peerInfo.multiaddrs`