Class ENR

Hierarchy

RawEnr
- ENR

Implements

IEnr

Index

Constructors

`Protected` constructor

new ENR(kvs?, seq?, signature?): ENR
Parameters
- kvs: Record<string, Uint8Array> = {}
- seq: bigint = ...
- Optional signature: Uint8Array
Returns ENR
Inherited from RawEnr.constructor
- Defined in packages/enr/src/raw_enr.ts:24

Properties

`Readonly` [toStringTag]

[toStringTag]: string

getLocationMultiaddr

getLocationMultiaddr: ((protocol) => undefined | Multiaddr) = ...

Type declaration

- (protocol): undefined | Multiaddr
- Parameters
  - protocol: TransportProtocol | TransportProtocolPerIpVersion
  Returns undefined | Multiaddr

`Optional` peerId

peerId?: PeerId

seq

seq: bigint

`Optional` signature

signature?: Uint8Array

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` RECORD_PREFIX

RECORD_PREFIX: "enr:" = "enr:"

`Static` `Readonly` [species]

[species]: MapConstructor

Accessors

id

get id(): string
Returns string
Implementation of IEnr.id
Inherited from RawEnr.id
- Defined in packages/enr/src/raw_enr.ts:40

ip

get ip(): undefined | string
Returns undefined | string
Implementation of IEnr.ip
Inherited from RawEnr.ip
- Defined in packages/enr/src/raw_enr.ts:67
set ip(ip): void
Parameters
- ip: undefined | string
Returns void
Implementation of IEnr.ip
Inherited from RawEnr.ip
- Defined in packages/enr/src/raw_enr.ts:71

ip6

get ip6(): undefined | string
Returns undefined | string
Implementation of IEnr.ip6
Inherited from RawEnr.ip6
- Defined in packages/enr/src/raw_enr.ts:91
set ip6(ip): void
Parameters
- ip: undefined | string
Returns void
Implementation of IEnr.ip6
Inherited from RawEnr.ip6
- Defined in packages/enr/src/raw_enr.ts:95

multiaddrs

get multiaddrs(): undefined | Multiaddr[]
Get the multiaddrs field from ENR.

This field is used to store multiaddresses that cannot be stored with the current ENR pre-defined keys. These can be a multiaddresses that include encapsulation (e.g. wss) or do not use ip4 nor ip6 for the host address (e.g. dns4, dnsaddr, etc)..

If the peer information only contains information that can be represented with the ENR pre-defined keys (ip, tcp, etc) then the usage of ENR.getLocationMultiaddr should be preferred.

The multiaddresses stored in this field are expected to be location multiaddresses, ie, peer id less.

Returns undefined | Multiaddr[]
Implementation of IEnr.multiaddrs
Inherited from RawEnr.multiaddrs
- Defined in packages/enr/src/raw_enr.ts:127
set multiaddrs(multiaddrs): void
Set the multiaddrs field on the ENR.

This field is used to store multiaddresses that cannot be stored with the current ENR pre-defined keys. These can be a multiaddresses that include encapsulation (e.g. wss) or do not use ip4 nor ip6 for the host address (e.g. dns4, dnsaddr, etc)..

If the peer information only contains information that can be represented with the ENR pre-defined keys (ip, tcp, etc) then the usage of ENR.setLocationMultiaddr should be preferred. The multiaddresses stored in this field must be location multiaddresses, ie, without a peer id.
Parameters
- multiaddrs: undefined | Multiaddr[]
Returns void
Implementation of IEnr.multiaddrs
Inherited from RawEnr.multiaddrs
- Defined in packages/enr/src/raw_enr.ts:147

nodeId

get nodeId(): undefined | string
Returns undefined | string
Implementation of IEnr.nodeId
- Defined in packages/enr/src/enr.ts:55

peerInfo

get peerInfo(): undefined | PeerInfo
Returns undefined | PeerInfo
Implementation of IEnr.peerInfo
- Defined in packages/enr/src/enr.ts:118

publicKey

get publicKey(): undefined | Uint8Array
Returns undefined | Uint8Array
Implementation of IEnr.publicKey
Inherited from RawEnr.publicKey
- Defined in packages/enr/src/raw_enr.ts:46

rs

get rs(): undefined | ShardInfo
Returns undefined | ShardInfo
Inherited from RawEnr.rs
- Defined in packages/enr/src/raw_enr.ts:55

rsv

get rsv(): undefined | ShardInfo
Returns undefined | ShardInfo
Inherited from RawEnr.rsv
- Defined in packages/enr/src/raw_enr.ts:61

shardInfo

get shardInfo(): undefined | ShardInfo
Returns undefined | ShardInfo
Implementation of IEnr.shardInfo
- Defined in packages/enr/src/enr.ts:67

tcp

get tcp(): undefined | number
Returns undefined | number
Implementation of IEnr.tcp
Inherited from RawEnr.tcp
- Defined in packages/enr/src/raw_enr.ts:75
set tcp(port): void
Parameters
- port: undefined | number
Returns void
Implementation of IEnr.tcp
Inherited from RawEnr.tcp
- Defined in packages/enr/src/raw_enr.ts:79

tcp6

get tcp6(): undefined | number
Returns undefined | number
Implementation of IEnr.tcp6
Inherited from RawEnr.tcp6
- Defined in packages/enr/src/raw_enr.ts:99
set tcp6(port): void
Parameters
- port: undefined | number
Returns void
Implementation of IEnr.tcp6
Inherited from RawEnr.tcp6
- Defined in packages/enr/src/raw_enr.ts:103

udp

get udp(): undefined | number
Returns undefined | number
Implementation of IEnr.udp
Inherited from RawEnr.udp
- Defined in packages/enr/src/raw_enr.ts:83
set udp(port): void
Parameters
- port: undefined | number
Returns void
Implementation of IEnr.udp
Inherited from RawEnr.udp
- Defined in packages/enr/src/raw_enr.ts:87

udp6

get udp6(): undefined | number
Returns undefined | number
Implementation of IEnr.udp6
Inherited from RawEnr.udp6
- Defined in packages/enr/src/raw_enr.ts:107
set udp6(port): void
Parameters
- port: undefined | number
Returns void
Implementation of IEnr.udp6
Inherited from RawEnr.udp6
- Defined in packages/enr/src/raw_enr.ts:111

waku2

get waku2(): undefined | Waku2
Get the waku2 field from ENR.

Returns undefined | Waku2
Implementation of IEnr.waku2
Inherited from RawEnr.waku2
- Defined in packages/enr/src/raw_enr.ts:154
set waku2(waku2): void
Set the waku2 field on the ENR.
Parameters
- waku2: undefined | Waku2
Returns void
Implementation of IEnr.waku2
Inherited from RawEnr.waku2
- Defined in packages/enr/src/raw_enr.ts:164

Methods

[iterator]

[iterator](): IterableIterator<[string, Uint8Array]>
Returns an iterable of entries in the map.

Returns IterableIterator<[string, Uint8Array]>
Implementation of IEnr.[iterator]
Inherited from RawEnr.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

clear

clear(): void
Returns void
Implementation of IEnr.clear
Inherited from RawEnr.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20

delete

delete(key): boolean
Parameters
- key: string
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Implementation of IEnr.delete
Inherited from RawEnr.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24

entries

entries(): IterableIterator<[string, Uint8Array]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[string, Uint8Array]>
Implementation of IEnr.entries
Inherited from RawEnr.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

forEach

forEach(callbackfn, thisArg?): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value, key, map) => void)
  - - (value, key, map): void
    - Parameters
      value: Uint8Array
      key: string
      map: Map<string, Uint8Array>
      Returns void
- Optional thisArg: any
Returns void
Implementation of IEnr.forEach
Inherited from RawEnr.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get(key): undefined | Uint8Array
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: string
Returns undefined | Uint8Array
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Implementation of IEnr.get
Inherited from RawEnr.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:33

getAllLocationMultiaddrs

getAllLocationMultiaddrs(): Multiaddr[]
Returns Multiaddr[]
- Defined in packages/enr/src/enr.ts:98

getFullMultiaddr

getFullMultiaddr(protocol): undefined | Multiaddr
Returns the full multiaddr from the ENR fields matching the provided protocol parameter. To return full multiaddrs from the multiaddrs ENR field, use ENR.getFullMultiaddrs.
Parameters
- protocol: TransportProtocol | TransportProtocolPerIpVersion
Returns undefined | Multiaddr
- Defined in packages/enr/src/enr.ts:135

getFullMultiaddrs

getFullMultiaddrs(): Multiaddr[]
Returns the full multiaddrs from the multiaddrs ENR field.

Returns Multiaddr[]
Implementation of IEnr.getFullMultiaddrs
- Defined in packages/enr/src/enr.ts:150

has

has(key): boolean
Parameters
- key: string
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Implementation of IEnr.has
Inherited from RawEnr.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:37

keys

keys(): IterableIterator<string>
Returns an iterable of keys in the map

Returns IterableIterator<string>
Implementation of IEnr.keys
Inherited from RawEnr.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

set

set(k, v): this
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- k: string
- v: Uint8Array
Returns this
Implementation of IEnr.set
Inherited from RawEnr.set
- Defined in packages/enr/src/raw_enr.ts:34

setLocationMultiaddr

setLocationMultiaddr(multiaddr): void
Parameters
- multiaddr: Multiaddr
Returns void
- Defined in packages/enr/src/enr.ts:74

sign

sign(data, privateKey): Promise<Uint8Array>
Parameters
- data: Uint8Array
- privateKey: Uint8Array
Returns Promise<Uint8Array>
- Defined in packages/enr/src/enr.ts:170

values

values(): IterableIterator<Uint8Array>
Returns an iterable of values in the map

Returns IterableIterator<Uint8Array>
Implementation of IEnr.values
Inherited from RawEnr.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

verify

verify(data, signature): boolean
Parameters
- data: Uint8Array
- signature: Uint8Array
Returns boolean
- Defined in packages/enr/src/enr.ts:160

`Static` create

create(kvs?, seq?, signature?): Promise<ENR>
Parameters
- kvs: Record<string, Uint8Array> = {}
- seq: bigint = ...
- Optional signature: Uint8Array
Returns Promise<ENR>
- Defined in packages/enr/src/enr.ts:37

Class ENR

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Parameters

Returns ENR

Properties

Readonly [toStringTag]

getLocationMultiaddr

Type declaration

Parameters

Returns undefined | Multiaddr

Optional peerId

seq

Optional signature

Readonly size

Returns

Static Readonly RECORD_PREFIX

Static Readonly [species]

Accessors

id

Returns string

ip

Returns undefined | string

Parameters

Returns void

ip6

Returns undefined | string

Parameters

Returns void

multiaddrs

Returns undefined | Multiaddr[]

Parameters

Returns void

nodeId

Returns undefined | string

peerInfo

Returns undefined | PeerInfo

publicKey

Returns undefined | Uint8Array

rs

Returns undefined | ShardInfo

rsv

Returns undefined | ShardInfo

shardInfo

Returns undefined | ShardInfo

tcp

Returns undefined | number

Parameters

Returns void

tcp6

Returns undefined | number

Parameters

Returns void

udp

Returns undefined | number

Parameters

Returns void

udp6

Returns undefined | number

Parameters

Returns void

waku2

Returns undefined | Waku2

Parameters

Returns void

Methods

[iterator]

Returns IterableIterator<[string, Uint8Array]>

clear

Returns void

delete

Parameters

Returns boolean

`Protected` constructor

`Readonly` [toStringTag]

`Optional` peerId

`Optional` signature

`Readonly` size

`Static` `Readonly` RECORD_PREFIX

`Static` `Readonly` [species]

`Static` create