Interface AddressManager

interface AddressManager {
    addDNSMapping(domain, ipAddresses): void;
    addObservedAddr(addr): void;
    confirmObservedAddr(addr): void;
    getAddresses(): Multiaddr[];
    getAnnounceAddrs(): Multiaddr[];
    getListenAddrs(): Multiaddr[];
    getObservedAddrs(): Multiaddr[];
    removeDNSMapping(domain): void;
    removeObservedAddr(addr): void;
}

Index

Methods

addDNSMapping addObservedAddr confirmObservedAddr getAddresses getAnnounceAddrs getListenAddrs getObservedAddrs removeDNSMapping removeObservedAddr

Methods

addDNSMapping

addDNSMapping(domain, ipAddresses): void
Adds a mapping between one or more IP addresses and a domain name - when getAddresses is invoked, where the IP addresses are present in a multiaddr, an additional multiaddr will be added with ip4 and ip6 tuples replaced with dns4 and `dns6 ones respectively.
Parameters
- domain: string
- ipAddresses: string[]
Returns void
- Defined in packages/interface-internal/src/address-manager/index.ts:50

addObservedAddr

addObservedAddr(addr): void
Add peer observed addresses. These will then appear in the output of getObservedAddrs but not getAddresses() until their dialability has been confirmed via a call to confirmObservedAddr.
Parameters
- addr: Multiaddr
Returns void
- Defined in packages/interface-internal/src/address-manager/index.ts:37

confirmObservedAddr

confirmObservedAddr(addr): void
Signal that we have confidence an observed multiaddr is publicly dialable - this will make it appear in the output of getAddresses()
Parameters
- addr: Multiaddr
Returns void
- Defined in packages/interface-internal/src/address-manager/index.ts:24

getAddresses

getAddresses(): Multiaddr[]
Get the current node's addresses

Returns Multiaddr[]
- Defined in packages/interface-internal/src/address-manager/index.ts:42

getAnnounceAddrs

getAnnounceAddrs(): Multiaddr[]
Get peer announcing multiaddrs

Returns Multiaddr[]
- Defined in packages/interface-internal/src/address-manager/index.ts:12

getListenAddrs

getListenAddrs(): Multiaddr[]
Get peer listen multiaddrs

Returns Multiaddr[]
- Defined in packages/interface-internal/src/address-manager/index.ts:7

getObservedAddrs

getObservedAddrs(): Multiaddr[]
Get observed multiaddrs - these addresses may not have been confirmed as publicly dialable yet

Returns Multiaddr[]
- Defined in packages/interface-internal/src/address-manager/index.ts:18

removeDNSMapping

removeDNSMapping(domain): void
Remove a mapping previously added with addDNSMapping.
Parameters
- domain: string
Returns void
- Defined in packages/interface-internal/src/address-manager/index.ts:55

removeObservedAddr

removeObservedAddr(addr): void
Signal that we do not have confidence an observed multiaddr is publicly dialable - this will remove it from the output of getObservedAddrs()
Parameters
- addr: Multiaddr
Returns void
- Defined in packages/interface-internal/src/address-manager/index.ts:30