README.md

@libp2p/interface-keys

Keys interface for libp2p

Table of contents

• Install
• Using the Test Suite
• API Docs
• License
• Contribution

Install

$ npm i @libp2p/interface-keys

Using the Test Suite

You can also check out the internal test suite to see the setup in action.

const tests = require('libp2p-interfaces-compliance-tests/keys')
const yourKeys = require('./your-keys')

tests({
  setup () {
    // Set up your keys if needed, then return it
    return yourKeys
  },
  teardown () {
    // Clean up your keys if needed
  }
})

API Docs

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