Module @libp2p/identify

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()
  }
})

Example: Enabling identify push

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

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

Interfaces

Identify
IdentifyComponents
IdentifyInit
IdentifyPush
IdentifyPushComponents
IdentifyPushInit

Functions

identify
identifyPush