@libp2p/identify

Implementation of the Identify Protocol

About

Use the identify function to add support for the Identify protocol to libp2p.

This protocol allows network peers to discover the multiaddrs the current node listens on, and the protocols it supports.

A second function, identifyPush is also exported to add support for identify/push.

This protocol will send updates to all connected peers when the multiaddrs or protocols of the current node change.

[!TIP] For maximum network compatibility you should configure both protocols

Example - Enabling identify

import { createLibp2p } from 'libp2p'
import { identify } from '@libp2p/identify'

const node = await createLibp2p({
  // ...other options
  services: {
    identify: identify()
  }
})
Copy

Example - Enabling identify push

import { createLibp2p } from 'libp2p'
import { identifyPush } from '@libp2p/identify'

const node = await createLibp2p({
  // ...other options
  services: {
    identifyPush: identifyPush()
  }
})
Copy

Install

$ npm i @libp2p/identify
Copy

Browser <script> tag

Loading this module through a script tag will make its exports available as Libp2pIdentify in the global namespace.

<script src="https://unpkg.com/@libp2p/identify/dist/index.min.js"></script>
Copy

API Docs

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