Libp2p node.
Will dial to the given peerId if the current number of
connected peers is less than the configured ConnectionManager
minConnections.
Called when libp2p has started and before it returns
Called whenever peer discovery services emit peer events.
Known peers may be emitted.
Initializes and starts peer discovery services
Gets a Map of the current connections. The keys are the stringified
PeerId of the peer. The value is an array of Connections to that peer.
Get a deduplicated list of peer advertising multiaddrs by concatenating the listen addresses used by transports with any configured announce addresses as well as observed addresses reported by peers.
If Announce addrs are specified, configured listen addresses will be ignored though observed addresses will still be included.
Dials to the provided peer. If successful, the known metadata of the
peer will be added to the nodes peerStore
The peer to dial
Dials to the provided peer and handshakes with the given protocol.
If successful, the known metadata of the peer will be added to the nodes peerStore,
and the Connection will be returned
The peer to dial
Registers the handler for each protocol
Load keychain keys from the datastore. Imports the private key as 'self', if needed.
Starts the libp2p node and all its subsystems
Stop the libp2p node by closing its listeners and open connections
Removes the handler for each protocol. The protocol will no longer be supported on streams.
Like new Libp2p(options) except it will create a PeerId
instance if one is not provided in options.
Libp2p configuration options
{boolean} persistence
{boolean} enabled
{import('./circuit').RelayAdvertiseOptions} advertise
{import('./circuit').HopOptions} hop
{import('./circuit').AutoRelayOptions} autoRelay
{Object} [dht] dht module options
{Object} [peerDiscovery]
{Pubsub} [pubsub] pubsub module options
{RelayOptions} [relay]
{Record<string, Object>} [transport] transport options indexed by transport key
{TransportFactory[]} transport
{MuxerFactory[]} streamMuxer
{Crypto[]} connEncryption
{Libp2pModules} modules libp2p modules to use
{import('./address-manager').AddressManagerOptions} [addresses]
{import('./connection-manager').ConnectionManagerOptions} [connectionManager]
{import('./dialer').DialerOptions} [dialer]
{import('./metrics').MetricsOptions} [metrics]
{Object} [keychain]
{import('./transport-manager').TransportManagerOptions} [transportManager]
{PeerStoreOptions & import('./peer-store/persistent').PersistentPeerStoreOptions} [peerStore]
{Libp2pConfig} [config]
{PeerId} peerId
{PeerId} [peerId]
Libp2p#error Emitted when an error occurs
Libp2p#peer:discovery Emitted when a peer is discovered