Class ConnectionManager

Hierarchy

TypedEventEmitter<IPeersByDiscoveryEvents & IConnectionStateEvents>
- ConnectionManager

Implements

IConnectionManager

Index

Constructors

Properties

#private configuredPubsubTopics currentActiveParallelDialCount dialAttemptsForPeer dialErrorsForPeer isP2PNetworkConnected keepAliveManager libp2p onEventHandlers options pendingPeerDialQueue instances

Constructors

`Private` constructor

new ConnectionManager(libp2p, keepAliveOptions, configuredPubsubTopics, relay?, options?): ConnectionManager
Parameters
- libp2p: Libp2p
- keepAliveOptions: KeepAliveOptions
- configuredPubsubTopics: string[]
- Optional relay: IRelay
- Optional options: Partial<ConnectionManagerOptions>
Returns ConnectionManager
Overrides TypedEventEmitter<IPeersByDiscoveryEvents & IConnectionStateEvents>.constructor
- Defined in packages/core/src/lib/connection_manager.ts:168

Properties

`Private` #private

#private: any

`Readonly` configuredPubsubTopics

configuredPubsubTopics: string[]

`Private` currentActiveParallelDialCount

currentActiveParallelDialCount: number = 0

`Private` dialAttemptsForPeer

dialAttemptsForPeer: Map<string, number> = ...

`Private` dialErrorsForPeer

dialErrorsForPeer: Map<string, any> = ...

`Private` isP2PNetworkConnected

isP2PNetworkConnected: boolean = false

`Private` keepAliveManager

keepAliveManager: KeepAliveManager

`Private` libp2p

libp2p: Libp2p

`Private` onEventHandlers

onEventHandlers: {
    browser:network: (() => void);
    peer:connect: ((evt) => void);
    peer:disconnect: ((evt) => void);
    peer:discovery: ((evt) => void);
} = ...

Type declaration

browser:network: (() => void)
- - (): void
  - Returns void
peer:connect: ((evt) => void)
- - (evt): void
  - Parameters
    - evt: CustomEvent<PeerId>
    Returns void
peer:disconnect: ((evt) => void)
- - (evt): void
  - Parameters
    - evt: CustomEvent<PeerId>
    Returns void
peer:discovery: ((evt) => void)
- - (evt): void
  - Parameters
    - evt: CustomEvent<PeerInfo>
    Returns void

`Private` options

options: ConnectionManagerOptions

`Private` pendingPeerDialQueue

pendingPeerDialQueue: PeerId[] = []

`Private` `Static` instances

instances: Map<string, ConnectionManager> = ...

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends CONNECTION_STATUS | (keyof IPeersByDiscoveryEvents)
Parameters
- type: K
- listener: null | EventHandler<(IPeersByDiscoveryEvents & IConnectionStateEvents)[K]>
- Optional options: boolean | AddEventListenerOptions
Returns void
Implementation of IConnectionManager.addEventListener
Inherited from TypedEventEmitter.addEventListener
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:31

attemptDial

attemptDial(peerId): Promise<void>
Parameters
- peerId: PeerId
Returns Promise<void>
- Defined in packages/core/src/lib/connection_manager.ts:469

`Private` attemptDnsDiscovery

attemptDnsDiscovery(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/lib/connection_manager.ts:402

dialPeer

dialPeer(peer): Promise<Connection>
Attempts to establish a connection with a peer and set up specified protocols. The method handles both PeerId and Multiaddr inputs, manages connection attempts, and maintains the connection state.

The dialing process includes:
1. Converting input to dialable peer info
2. Managing parallel dial attempts
3. Attempting to establish protocol-specific connections
4. Handling connection failures and retries
5. Updating the peer store and connection state
Parameters
- peer: PeerId | MultiaddrInput
  The peer to connect to, either as a PeerId or multiaddr
Returns Promise<Connection>
Throws
If the multiaddr is missing a peer ID

Throws
If the maximum dial attempts are reached and the peer cannot be dialed

Throws
If there's an error deleting an undialable peer from the peer store

Example
```
// Dial using PeerId
await connectionManager.dialPeer(peerId);

// Dial using multiaddr with specific protocols
await connectionManager.dialPeer(multiaddr, [
  "/vac/waku/relay/2.0.0",
  "/vac/waku/lightpush/2.0.0-beta1"
]);
```
Remarks
- The method implements exponential backoff through multiple dial attempts
- Maintains a queue for parallel dial attempts (limited by maxParallelDials)
- Integrates with the KeepAliveManager for connection maintenance
- Updates the peer store and connection state after successful/failed attempts
- If all dial attempts fail, triggers DNS discovery as a fallback
- Defined in packages/core/src/lib/connection_manager.ts:270

`Private` dialPeerStorePeers

dialPeerStorePeers(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/lib/connection_manager.ts:205

`Private` dispatchDiscoveryEvent

dispatchDiscoveryEvent(peerId): Promise<void>
Parameters
- peerId: PeerId
Returns Promise<void>
- Defined in packages/core/src/lib/connection_manager.ts:628

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Implementation of IConnectionManager.dispatchEvent
Inherited from TypedEventEmitter.dispatchEvent
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:33

`Private` dispatchWakuConnectionEvent

dispatchWakuConnectionEvent(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:732

dropConnection

dropConnection(peerId): Promise<void>
Parameters
- peerId: PeerId
Returns Promise<void>
Implementation of IConnectionManager.dropConnection
- Defined in packages/core/src/lib/connection_manager.ts:103

`Private` getDialablePeerInfo

getDialablePeerInfo(peer): PeerId | Multiaddr
Internal
Internal utility to extract a PeerId or Multiaddr from a peer input. This is used internally by the connection manager to handle different peer input formats.
Parameters
- peer: PeerId | MultiaddrInput
Returns PeerId | Multiaddr
- Defined in packages/core/src/lib/connection_manager.ts:386

`Private` getPeerShardInfo

getPeerShardInfo(peerId, peerStore): Promise<undefined | ShardInfo>
Parameters
- peerId: PeerId
- peerStore: PeerStore
Returns Promise<undefined | ShardInfo>
- Defined in packages/core/src/lib/connection_manager.ts:675

getPeersByDiscovery

getPeersByDiscovery(): Promise<PeersByDiscoveryResult>
Returns Promise<PeersByDiscoveryResult>
Implementation of IConnectionManager.getPeersByDiscovery
- Defined in packages/core/src/lib/connection_manager.ts:115

`Private` getTagNamesForPeer

getTagNamesForPeer(peerId): Promise<string[]>
Fetches the tag names for a given peer
Parameters
- peerId: PeerId
Returns Promise<string[]>
- Defined in packages/core/src/lib/connection_manager.ts:648

isConnected

isConnected(): boolean
Returns boolean
- Defined in packages/core/src/lib/connection_manager.ts:55

`Private` isPeerDialableBasedOnBootstrapStatus

isPeerDialableBasedOnBootstrapStatus(peerId): Promise<boolean>
Checks if the peer is dialable based on the following conditions:
1. If the peer is a bootstrap peer, it is only dialable if the number of current bootstrap connections is less than the max allowed.
2. If the peer is not a bootstrap peer
Parameters
- peerId: PeerId
Returns Promise<boolean>
- Defined in packages/core/src/lib/connection_manager.ts:608

`Private` isPeerTopicConfigured

isPeerTopicConfigured(peerId): Promise<boolean>
Parameters
- peerId: PeerId
Returns Promise<boolean>
- Defined in packages/core/src/lib/connection_manager.ts:658

listenerCount

listenerCount(type): number
Parameters
- type: string
Returns number
Implementation of IConnectionManager.listenerCount
Inherited from TypedEventEmitter.listenerCount
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:30

`Private` processDialQueue

processDialQueue(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:423

rawDialPeerWithProtocols

rawDialPeerWithProtocols(peer, protocolCodecs): Promise<Stream>
Dial a peer with specific protocols. This method is a raw proxy to the libp2p dialProtocol method.
Parameters
- peer: PeerId | MultiaddrInput
  The peer to connect to, either as a PeerId or multiaddr
- protocolCodecs: string[]
  Optional array of protocol-specific codec strings to establish
Returns Promise<Stream>
A stream to the peer
- Defined in packages/core/src/lib/connection_manager.ts:373

removeEventListener

removeEventListener<K>(type, listener?, options?): void
Type Parameters
- K extends CONNECTION_STATUS | (keyof IPeersByDiscoveryEvents)
Parameters
- type: K
- Optional listener: null | EventHandler<(IPeersByDiscoveryEvents & IConnectionStateEvents)[K]>
- Optional options: boolean | EventListenerOptions
Returns void
Implementation of IConnectionManager.removeEventListener
Inherited from TypedEventEmitter.removeEventListener
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:32

safeDispatchEvent

safeDispatchEvent<Detail>(type, detail?): boolean
Type Parameters
- Detail
Parameters
- type: CONNECTION_STATUS | (keyof IPeersByDiscoveryEvents)
- Optional detail: CustomEventInit<Detail>
Returns boolean
Implementation of IConnectionManager.safeDispatchEvent
Inherited from TypedEventEmitter.safeDispatchEvent
- Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:34

`Private` setP2PNetworkConnected

setP2PNetworkConnected(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:715

`Private` setP2PNetworkDisconnected

setP2PNetworkDisconnected(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:722

`Private` shouldDialPeer

shouldDialPeer(peerId): Promise<boolean>
Checks if the peer should be dialed based on the following conditions:
1. If the peer is already connected, don't dial
2. If the peer is not part of any of the configured pubsub topics, don't dial
3. If the peer is not dialable based on bootstrap status, don't dial
4. If the peer is already has an active dial attempt, or has been dialed before, don't dial it
Parameters
- peerId: PeerId
Returns Promise<boolean>
true if the peer should be dialed, false otherwise
- Defined in packages/core/src/lib/connection_manager.ts:559

`Private` startEventListeners

startEventListeners(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/lib/connection_manager.ts:223

`Private` startNetworkStatusListener

startNetworkStatusListener(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:685

`Private` startPeerConnectionListener

startPeerConnectionListener(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:443

`Private` startPeerDisconnectionListener

startPeerDisconnectionListener(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:450

`Private` startPeerDiscoveryListener

startPeerDiscoveryListener(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:436

stop

stop(): void
Returns void
Implementation of IConnectionManager.stop
- Defined in packages/core/src/lib/connection_manager.ts:86

`Private` stopNetworkStatusListener

stopNetworkStatusListener(): void
Returns void
- Defined in packages/core/src/lib/connection_manager.ts:700

`Static` create

create(peerId, libp2p, keepAliveOptions, pubsubTopics, relay?, options?): ConnectionManager
Parameters
- peerId: string
- libp2p: Libp2p
- keepAliveOptions: KeepAliveOptions
- pubsubTopics: string[]
- Optional relay: IRelay
- Optional options: ConnectionManagerOptions
Returns ConnectionManager
- Defined in packages/core/src/lib/connection_manager.ts:63

Class ConnectionManager

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

Returns ConnectionManager

Properties

Private #private

Readonly configuredPubsubTopics

Private currentActiveParallelDialCount

Private dialAttemptsForPeer

Private dialErrorsForPeer

Private isP2PNetworkConnected

Private keepAliveManager

Private libp2p

Private onEventHandlers

Type declaration

browser:network: (() => void)

Returns void

peer:connect: ((evt) => void)

Parameters

Returns void

peer:disconnect: ((evt) => void)

Parameters

Returns void

peer:discovery: ((evt) => void)

Parameters

Returns void

Private options

Private pendingPeerDialQueue

Private Static instances

Methods

addEventListener

Type Parameters

Parameters

Returns void

attemptDial

Parameters

Returns Promise<void>

Private attemptDnsDiscovery

Returns Promise<void>

dialPeer

Parameters

Returns Promise<Connection>

Throws

Throws

Throws

Example

Remarks

Private dialPeerStorePeers

Returns Promise<void>

Private dispatchDiscoveryEvent

Parameters

Returns Promise<void>

dispatchEvent

Parameters

Returns boolean

Private dispatchWakuConnectionEvent

Returns void

dropConnection

Parameters

Returns Promise<void>

Private getDialablePeerInfo

Parameters

Returns PeerId | Multiaddr

Private getPeerShardInfo

Parameters

Returns Promise<undefined | ShardInfo>

getPeersByDiscovery

Returns Promise<PeersByDiscoveryResult>

Private getTagNamesForPeer

Parameters

Returns Promise<string[]>

isConnected

Returns boolean

`Private` constructor

`Private` #private

`Readonly` configuredPubsubTopics

`Private` currentActiveParallelDialCount

`Private` dialAttemptsForPeer

`Private` dialErrorsForPeer

`Private` isP2PNetworkConnected

`Private` keepAliveManager

`Private` libp2p

`Private` onEventHandlers

`Private` options

`Private` pendingPeerDialQueue

`Private` `Static` instances

`Private` attemptDnsDiscovery

`Private` dialPeerStorePeers

`Private` dispatchDiscoveryEvent

`Private` dispatchWakuConnectionEvent

`Private` getDialablePeerInfo

`Private` getPeerShardInfo

`Private` getTagNamesForPeer

`Private` isPeerDialableBasedOnBootstrapStatus

`Private` isPeerTopicConfigured

`Private` processDialQueue

`Private` setP2PNetworkConnected

`Private` setP2PNetworkDisconnected

`Private` shouldDialPeer

`Private` startEventListeners

`Private` startNetworkStatusListener

`Private` startPeerConnectionListener

`Private` startPeerDisconnectionListener

`Private` startPeerDiscoveryListener

`Private` stopNetworkStatusListener

`Static` create