Class ConnectionManager

Hierarchy

Implements

Constructors

constructor

Properties

#private attemptDnsDiscovery currentActiveParallelDialCount dialAttemptsForPeer dialErrorsForPeer dialPeerStorePeers dispatchDiscoveryEvent dispatchWakuConnectionEvent getDialablePeerInfo getPeerShardInfo getTagNamesForPeer isP2PNetworkConnected isPeerDialableBasedOnBootstrapStatus isPeerTopicConfigured keepAliveManager libp2p onEventHandlers options pendingPeerDialQueue processDialQueue pubsubTopics setP2PNetworkConnected setP2PNetworkDisconnected shouldDialPeer startEventListeners startNetworkStatusListener startPeerConnectionListener startPeerDisconnectionListener startPeerDiscoveryListener stopNetworkStatusListener

Methods

addEventListener attemptDial dialPeer dispatchEvent dropConnection getConnectedPeers getPeersByDiscovery isConnected listenerCount rawDialPeerWithProtocols removeEventListener safeDispatchEvent stop

Constructors

constructor

  • new ConnectionManager(options): waku.ConnectionManager

  • Parameters

    • options: ConnectionManagerConstructorOptions

    Returns waku.ConnectionManager

Properties

Private #private

#private: any

Private attemptDnsDiscovery

attemptDnsDiscovery: any

Private currentActiveParallelDialCount

currentActiveParallelDialCount: any

Private dialAttemptsForPeer

dialAttemptsForPeer: any

Private dialErrorsForPeer

dialErrorsForPeer: any

Private dialPeerStorePeers

dialPeerStorePeers: any

Private dispatchDiscoveryEvent

dispatchDiscoveryEvent: any

Private dispatchWakuConnectionEvent

dispatchWakuConnectionEvent: any

Private Internal getDialablePeerInfo

getDialablePeerInfo: any

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.

Private getPeerShardInfo

getPeerShardInfo: any

Private getTagNamesForPeer

getTagNamesForPeer: any

Fetches the tag names for a given peer

Private isP2PNetworkConnected

isP2PNetworkConnected: any

Private isPeerDialableBasedOnBootstrapStatus

isPeerDialableBasedOnBootstrapStatus: any

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

Private isPeerTopicConfigured

isPeerTopicConfigured: any

Private keepAliveManager

keepAliveManager: any

Private libp2p

libp2p: any

Private onEventHandlers

onEventHandlers: any

Private options

options: any

Private pendingPeerDialQueue

pendingPeerDialQueue: any

Private processDialQueue

processDialQueue: any

Readonly pubsubTopics

pubsubTopics: string[]

Private setP2PNetworkConnected

setP2PNetworkConnected: any

Private setP2PNetworkDisconnected

setP2PNetworkDisconnected: any

Private shouldDialPeer

shouldDialPeer: any

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

Returns

true if the peer should be dialed, false otherwise

Private startEventListeners

startEventListeners: any

Private startNetworkStatusListener

startNetworkStatusListener: any

Private startPeerConnectionListener

startPeerConnectionListener: any

Private startPeerDisconnectionListener

startPeerDisconnectionListener: any

Private startPeerDiscoveryListener

startPeerDiscoveryListener: any

Private stopNetworkStatusListener

stopNetworkStatusListener: any

Methods

addEventListener

attemptDial

  • attemptDial(peerId): Promise<void>

  • Parameters

    • peerId: PeerId

    Returns Promise<void>

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

dispatchEvent

  • dispatchEvent(event): boolean

  • Parameters

    • event: Event

    Returns boolean

dropConnection

  • dropConnection(peerId): Promise<void>

  • Parameters

    • peerId: PeerId

    Returns Promise<void>

getConnectedPeers

  • getConnectedPeers(codec?): Promise<Peer[]>

  • Parameters

    • Optional codec: string

    Returns Promise<Peer[]>

getPeersByDiscovery

isConnected

  • isConnected(): boolean

  • Returns boolean

listenerCount

  • listenerCount(type): number

  • Parameters

    • type: string

    Returns number

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

removeEventListener

safeDispatchEvent

  • safeDispatchEvent<Detail>(type, detail?): boolean

  • Type Parameters

    • Detail

    Parameters

    Returns boolean

stop

  • stop(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

constructor#privateattemptDnsDiscoverycurrentActiveParallelDialCountdialAttemptsForPeerdialErrorsForPeerdialPeerStorePeersdispatchDiscoveryEventdispatchWakuConnectionEventgetDialablePeerInfogetPeerShardInfogetTagNamesForPeerisP2PNetworkConnectedisPeerDialableBasedOnBootstrapStatusisPeerTopicConfiguredkeepAliveManagerlibp2ponEventHandlersoptionspendingPeerDialQueueprocessDialQueuepubsubTopicssetP2PNetworkConnectedsetP2PNetworkDisconnectedshouldDialPeerstartEventListenersstartNetworkStatusListenerstartPeerConnectionListenerstartPeerDisconnectionListenerstartPeerDiscoveryListenerstopNetworkStatusListeneraddEventListenerattemptDialdialPeerdispatchEventdropConnectiongetConnectedPeersgetPeersByDiscoveryisConnectedlistenerCountrawDialPeerWithProtocolsremoveEventListenersafeDispatchEventstop