fluencelabs/js-libp2p-interfaces
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-interfaces synced 2025-04-24 17:52:21 +00:00
Code Issues Projects Releases Wiki Activity

feat: signed peer records for discovery

Browse Source
This commit is contained in:
Vasco Santos 2020-07-16 14:47:58 +02:00
parent 71b813ad3b
commit e7a6a91ade
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -72,7 +72,10 @@ It returns a `Promise`
- `discovery.on('peer', (peerData) => {})` - `discovery.on('peer', (peerData) => {})`
Every time a peer is discovered by a discovery service, it emits a `peer` event with the discovered peer's information, which must contain the following properties: Every time a peer is discovered by a discovery service, it emits a `peer` event with the discovered peer's information, which may contain the following properties:
- `<`[`PeerId`](https://github.com/libp2p/js-peer-id)`>` `peerData.id` - [`<PeerId>`](https://github.com/libp2p/js-peer-id)`>` `peerData.id`
- `<Array<`[`Multiaddr`](https://github.com/multiformats/js-multiaddr)`>>` `peerData.multiaddrs` - `<Array`[`<Multiaddr>`](https://github.com/multiformats/js-multiaddr)`>` `peerData.multiaddrs`
- [`<Envelope>`](https://github.com/libp2p/js-libp2p/tree/0.29.x/src/record) `peerData.envelope`
The `id` property is required, ad well as one of `multiaddrs` and `envelope`.