Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@libp2p/interface-peer-id

Package Overview
Dependencies
Maintainers
6
Versions
24
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@libp2p/interface-peer-id

Peer Identifier interface for libp2p

  • 2.0.2-d853d124
  • next
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
18K
increased by0.62%
Maintainers
6
Weekly downloads
 
Created
Source

@libp2p/interface-peer-id

libp2p.io Discuss codecov CI

Peer Identifier interface for libp2p

Table of contents

Install

$ npm i @libp2p/interface-peer-id

The 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.

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

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-id API.

Usage

Node.js

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

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

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

API Docs

License

Licensed under either of

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.

Keywords

FAQs

Package last updated on 19 Jun 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc