Class PeerDiscoveryDns

Parse options and expose function to return bootstrap peer addresses.

Throws

if an invalid combination of options is passed, see BootstrapOptions for details.

Hierarchy

EventEmitter<PeerDiscoveryEvents>
- PeerDiscoveryDns

Implements

PeerDiscovery

Index

Constructors

Properties

#private _started nextPeer

Accessors

[symbol] [toStringTag]

Methods

addEventListener dispatchEvent listenerCount removeEventListener start stop

Constructors

constructor

new PeerDiscoveryDns(enrUrl: string, wantedNodeCapabilityCount: Partial<NodeCapabilityCount>): PeerDiscoveryDns
Parameters
- enrUrl: string
  
  An EIP-1459 ENR Tree URL. For example: "enrtree://AOFTICU2XWDULNLZGRMQS4RIZPAZEHYMV4FYHAPW563HNRAOERP7C@test.nodes.vac.dev"
- wantedNodeCapabilityCount: Partial<NodeCapabilityCount>
  
  Specifies what node capabilities (protocol) must be returned.
Returns PeerDiscoveryDns
Overrides EventEmitter<PeerDiscoveryEvents>.constructor
- Defined in packages/dns-discovery/src/index.ts:34

Properties

`Private` #private

#private: any

`Private` _started

_started: boolean

`Private` `Readonly` nextPeer

nextPeer: (() => AsyncGenerator<ENR, any, unknown>)

Type declaration

- (): AsyncGenerator<ENR, any, unknown>
- Returns AsyncGenerator<ENR, any, unknown>

Accessors

[symbol]

get [symbol](): true
Returns true
Implementation of PeerDiscovery.__@symbol@5173
- Defined in packages/dns-discovery/src/index.ts:76

[toStringTag]

get [toStringTag](): string
Returns string
Implementation of PeerDiscovery.__@toStringTag@4371
- Defined in packages/dns-discovery/src/index.ts:80

Methods

addEventListener

addEventListener<K>(type: K, listener: null | EventHandler<PeerDiscoveryEvents[K]>, options?: boolean | AddEventListenerOptions): void
Type Parameters
- K extends "peer"
Parameters
- type: K
- listener: null | EventHandler<PeerDiscoveryEvents[K]>
- Optional options: boolean | AddEventListenerOptions
Returns void
Implementation of PeerDiscovery.addEventListener

Inherited from EventEmitter.addEventListener
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:21

dispatchEvent

dispatchEvent(event: Event): boolean
Parameters
- event: Event
Returns boolean
Implementation of PeerDiscovery.dispatchEvent

Inherited from EventEmitter.dispatchEvent
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:23

listenerCount

listenerCount(type: string): number
Parameters
- type: string
Returns number
Implementation of PeerDiscovery.listenerCount

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:20

removeEventListener

removeEventListener<K>(type: K, listener?: null | EventHandler<PeerDiscoveryEvents[K]>, options?: boolean | EventListenerOptions): void
Type Parameters
- K extends "peer"
Parameters
- type: K
- Optional listener: null | EventHandler<PeerDiscoveryEvents[K]>
- Optional options: boolean | EventListenerOptions
Returns void
Implementation of PeerDiscovery.removeEventListener

Inherited from EventEmitter.removeEventListener
- Defined in node_modules/@libp2p/interfaces/dist/src/events.d.ts:22

start

start(): Promise<void>
Start discovery process

Returns Promise<void>
- Defined in packages/dns-discovery/src/index.ts:54

stop

stop(): void
Stop emitting events

Returns void
- Defined in packages/dns-discovery/src/index.ts:72

Generated using TypeDoc