{"bugs":{"url":"https://github.com/libp2p/js-libp2p/issues"},"dist":{"shasum":"1eeae4ba723f3fc1af1d62d982dc17b4b371fc40","tarball":"https://registry.npmjs.org/@libp2p/interface-peer-id/-/interface-peer-id-2.0.2-d2f1eff4.tgz","fileCount":9,"integrity":"sha512-G5j9/i2X4v2s4gRMZoA9g3WfTtMBkN1ZQjvYpy2BBfF9K8sk4apVwq9QcHckaSevEgevE4QBJ+wXEJMAcCOx5g==","signatures":[{"sig":"MEQCIEMYSGK2SjR+5PfYy45i1z6OFDG9h6Kur1f+9jtjos4+AiASuOw+JWdCScOOejAkq2ElhpRoc6YOyrEL0UyjE89tdg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":10657},"name":"@libp2p/interface-peer-id","type":"module","types":"./dist/src/index.d.ts","readme":"# @libp2p/interface-peer-id <!-- omit in toc -->\n\n[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)\n[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)\n[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)\n[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=master\\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amaster)\n\n> Peer Identifier interface for libp2p\n\n## Table of contents <!-- omit in toc -->\n\n- [Install](#install)\n- [Modules that implement the interface](#modules-that-implement-the-interface)\n- [Badge](#badge)\n- [Usage](#usage)\n  - [Node.js](#nodejs)\n- [API Docs](#api-docs)\n- [License](#license)\n- [Contribution](#contribution)\n\n## Install\n\n```console\n$ npm i @libp2p/interface-peer-id\n```\n\nThe primary goal of this module is to enable developers to implement PeerId modules. This module and test suite was heavily inspired by earlier implementation of [PeerId](https://github.com/libp2p/js-peer-id).\n\nPublishing a test suite as a module lets multiple modules all ensure compatibility since they use the same test suite.\n\nThe 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.\n\n## Modules that implement the interface\n\n- [JavaScript libp2p-peer-id](https://github.com/libp2p/js-libp2p-peer-id)\n\nSend a PR to add a new one if you happen to find or write one.\n\n## Badge\n\nInclude this badge in your readme if you make a new module that uses interface-peer-id API.\n\n![](/img/badge.png)\n\n## Usage\n\n### Node.js\n\nInstall `libp2p-interfaces-compliance-tests` as one of the development dependencies of your project and as a test file. Then, using `mocha` (for JavaScript) or a test runner with compatible API, do:\n\n```js\nconst tests = require('libp2p-interfaces-compliance-tests/peer-id')\n\ndescribe('your peer id', () => {\n  // use all of the test suits\n  tests({\n    setup () {\n      return YourPeerIdFactory\n    },\n    teardown () {\n      // Clean up any resources created by setup()\n    }\n  })\n})\n```\n\n## API Docs\n\n- <https://libp2p.github.io/js-libp2p/modules/_libp2p_interface_peer_id.html>\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)\n- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)\n\n## Contribution\n\nUnless 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.\n","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js"}},"gitHead":"d2f1eff45ca2dd30c98497bb5dcbc3fb33496b6d","license":"Apache-2.0 OR MIT","release":{"plugins":[["@semantic-release/commit-analyzer",{"preset":"conventionalcommits","releaseRules":[{"release":"major","breaking":true},{"revert":true,"release":"patch"},{"type":"feat","release":"minor"},{"type":"fix","release":"patch"},{"type":"docs","release":"patch"},{"type":"test","release":"patch"},{"type":"deps","release":"patch"},{"scope":"no-release","release":false}]}],["@semantic-release/release-notes-generator",{"preset":"conventionalcommits","presetConfig":{"types":[{"type":"feat","section":"Features"},{"type":"fix","section":"Bug Fixes"},{"type":"chore","section":"Trivial Changes"},{"type":"docs","section":"Documentation"},{"type":"deps","section":"Dependencies"},{"type":"test","section":"Tests"}]}}],"@semantic-release/changelog","@semantic-release/npm","@semantic-release/github","@semantic-release/git"],"branches":["master"]},"scripts":{"lint":"aegir lint","build":"aegir build","clean":"aegir clean","dep-check":"aegir dep-check"},"typedoc":{"entryPoint":"./src/index.ts"},"_npmUser":{"name":"npm-service-account-libp2p","email":"npm-service-account+libp2p@protocol.ai"},"homepage":"https://github.com/libp2p/js-libp2p/tree/master/packages/interface-peer-id#readme","keywords":["interface","libp2p"],"repository":{"url":"git+https://github.com/libp2p/js-libp2p.git","type":"git"},"_npmVersion":"8.19.4","description":"Peer Identifier interface for libp2p","directories":{},"maintainers":[{"name":"jacobheun","email":"jacobheun@gmail.com"},{"name":"npm-service-account-libp2p","email":"npm-service-account+libp2p@protocol.ai"},{"name":"alanshaw","email":"alan138@gmail.com"},{"name":"vascosantos","email":"santos.vasco10@gmail.com"},{"name":"achingbrain","email":"alex@achingbrain.net"},{"name":"daviddias","email":"mail@daviddias.me"}],"_nodeVersion":"18.16.0","dependencies":{"multiformats":"^11.0.0"},"eslintConfig":{"extends":"ipfs","parserOptions":{"sourceType":"module"}},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"aegir":"^39.0.5"},"_npmOperationalInternal":{"tmp":"tmp/interface-peer-id_2.0.2-d2f1eff4_1686830954406_0.9285340125139194","host":"s3://npm-registry-packages"},"_id":"@libp2p/interface-peer-id@2.0.2-d2f1eff4","version":"2.0.2-d2f1eff4"}