@libp2p/interface-peer-discovery

@libp2p/interface-peer-discovery

Peer Discovery interface for libp2p

Table of contents

• Install
• Modules that implement the interface
• Badge
• Usage
  • Node.js
• API
  • start the service
  • stop the service
  • discovering peers
• API Docs
• License
• Contribution

Install

$ npm i @libp2p/interface-peer-discovery

The primary goal of this module is to enable developers to pick and/or swap their Peer Discovery modules as they see fit for their application, without having to go through shims or compatibility issues. This module and test suite was heavily inspired by abstract-blob-store.

Publishing a test suite as a module lets multiple modules all ensure compatibility since they use the same test suite.

The API is presented with both Node.js and Go primitives, however, there is not actual limitations for it to be extended for any other language, pushing forward the cross compatibility and interop through different stacks.

Modules that implement the interface

• JavaScript libp2p-mdns
• JavaScript libp2p-bootstrap
• JavaScript libp2p-kad-dht
• JavaScript libp2p-webrtc-star
• JavaScript libp2p-websocket-star
• TypeScript discv5

Send a PR to add a new one if you happen to find or write one.

Badge

Include this badge in your readme if you make a new module that uses interface-peer-discovery API.

Usage

Node.js

Install interface-discovery as one of the dependencies of your project and as a test file. Then, using mocha (for JavaScript) or a test runner with compatible API, do:

const tests = require('libp2p-interfaces-compliance-tests/peer-discovery')

describe('your discovery', () => {
  // use all of the test suits
  tests({
    setup () {
      return YourDiscovery
    },
    teardown () {
      // Clean up any resources created by setup()
    }
  })
})

API

A valid (read: that follows this abstraction) Peer Discovery module must implement the following API:

start the service

• await discovery.start()

Start the discovery service.

It returns a Promise

stop the service

• await discovery.stop()

Stop the discovery service.

It returns a Promise

discovering peers

• 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:

• <PeerId> peerData.id
• <Array<Multiaddr>> peerData.multiaddrs

API Docs

• https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_peer_discovery.html

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.