Class AddressManager

property

{string[]} [listen = []] - list of multiaddrs string representation to listen.

property

{string[]} [announce = []] - list of multiaddrs string representation to announce.

Hierarchy

  • AddressManager

Index

References

Constructors

Properties

Methods

References

AddressManagerOptions

Re-exports AddressManagerOptions

Multiaddr

Re-exports Multiaddr

Constructors

constructor

  • new AddressManager(__namedParameters?: { announce: undefined | string[]; listen: undefined | string[] }): AddressManager

  • Responsible for managing the peer addresses. Peers can specify their listen and announce addresses. The listen addresses will be used by the libp2p transports to listen for new connections, while the announce addresses will be used for the peer addresses' to other peers in the network.

    Parameters

    • Optional __namedParameters: { announce: undefined | string[]; listen: undefined | string[] }
      • announce: undefined | string[]
      • listen: undefined | string[]

    Returns AddressManager

Properties

announce

announce: Set<string>

listen

listen: Set<string>

Methods

getAnnounceAddrs

  • Get peer announcing multiaddrs.

    Returns Multiaddr[]

getListenAddrs

  • Get peer listen multiaddrs.

    Returns Multiaddr[]