interface-peer-discovery-compliance-tests

@libp2p/interface-peer-discovery-compliance-tests

Compliance tests for implementations of the libp2p Peer Discovery interface

Table of contents

• Install
• Usage
• API Docs
• License
• Contribution

Install

$ npm i @libp2p/interface-peer-discovery-compliance-tests

Usage

import tests from '@libp2p/interface-peer-discovery-compliance-tests'

describe('your peer discovery implementation', () => {
  tests({
    // Options should be passed to your implementation
    async setup (options) {
      return new YourImplementation()
    },
    async teardown () {
      // cleanup resources created by setup()
    }
  })
})

API Docs

• https://libp2p.github.io/js-libp2p-interfaces/modules/_libp2p_interface_peer_discovery_compliance_tests.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.