Class ENR

Hierarchy

Map<ENRKey, ENRValue>
- ENR

Index

Constructors

`Private` constructor

new ENR(kvs?: Record<string, Uint8Array>, seq?: bigint, signature?: null | Uint8Array): ENR
Parameters
- kvs: Record<string, Uint8Array> = {}
- seq: bigint = ...
- signature: null | Uint8Array = null
Returns ENR
Overrides Map<ENRKey, ENRValue>.constructor
- Defined in packages/enr/src/enr.ts:45

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Optional` peerId

peerId?: PeerId

seq

seq: bigint

signature

signature: null | 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
- Defined in packages/enr/src/enr.ts:158

ip

get ip(): undefined | string
Returns undefined | string
- Defined in packages/enr/src/enr.ts:199
set ip(ip: undefined | string): void
Parameters
- ip: undefined | string
Returns void
- Defined in packages/enr/src/enr.ts:208

ip6

get ip6(): undefined | string
Returns undefined | string
- Defined in packages/enr/src/enr.ts:250
set ip6(ip: undefined | string): void
Parameters
- ip: undefined | string
Returns void
- Defined in packages/enr/src/enr.ts:259

keypair

get keypair(): undefined | IKeypair
Returns undefined | IKeypair
- Defined in packages/enr/src/enr.ts:182

keypairType

get keypairType(): KeypairType
Returns KeypairType
- Defined in packages/enr/src/enr.ts:164

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 getLocationMultiaddr should be preferred.

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

Returns undefined | Multiaddr[]
- Defined in packages/enr/src/enr.ts:313
set multiaddrs(multiaddrs: undefined | Multiaddr[]): 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 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
- Defined in packages/enr/src/enr.ts:333

nodeId

get nodeId(): undefined | string
Returns undefined | string
- Defined in packages/enr/src/enr.ts:190

publicKey

get publicKey(): undefined | Uint8Array
Returns undefined | Uint8Array
- Defined in packages/enr/src/enr.ts:173

tcp

get tcp(): undefined | number
Returns undefined | number
- Defined in packages/enr/src/enr.ts:216
set tcp(port: undefined | number): void
Parameters
- port: undefined | number
Returns void
- Defined in packages/enr/src/enr.ts:225

tcp6

get tcp6(): undefined | number
Returns undefined | number
- Defined in packages/enr/src/enr.ts:267
set tcp6(port: undefined | number): void
Parameters
- port: undefined | number
Returns void
- Defined in packages/enr/src/enr.ts:276

udp

get udp(): undefined | number
Returns undefined | number
- Defined in packages/enr/src/enr.ts:233
set udp(port: undefined | number): void
Parameters
- port: undefined | number
Returns void
- Defined in packages/enr/src/enr.ts:242

udp6

get udp6(): undefined | number
Returns undefined | number
- Defined in packages/enr/src/enr.ts:284
set udp6(port: undefined | number): void
Parameters
- port: undefined | number
Returns void
- Defined in packages/enr/src/enr.ts:293

waku2

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

Returns undefined | Waku2
- Defined in packages/enr/src/enr.ts:446
set waku2(waku2: undefined | Waku2): void
Set the waku2 field on the ENR.
Parameters
- waku2: undefined | Waku2
Returns void
- Defined in packages/enr/src/enr.ts:456

Methods

[iterator]

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

Returns IterableIterator<[string, Uint8Array]>
Inherited from Map.__@iterator@5332
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:121

clear

clear(): void
Returns void
Inherited from Map.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:23

delete

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

encode

encode(privateKey?: Uint8Array): Promise<Uint8Array>
Parameters
- Optional privateKey: Uint8Array
Returns Promise<Uint8Array>
- Defined in packages/enr/src/enr.ts:509

encodeToValues

encodeToValues(privateKey?: Uint8Array): Promise<(string | Uint8Array | number[])[]>
Parameters
- Optional privateKey: Uint8Array
Returns Promise<(string | Uint8Array | number[])[]>
- Defined in packages/enr/src/enr.ts:486

encodeTxt

encodeTxt(privateKey?: Uint8Array): Promise<string>
Parameters
- Optional privateKey: Uint8Array
Returns Promise<string>
- Defined in packages/enr/src/enr.ts:519

entries

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

Returns IterableIterator<[string, Uint8Array]>
Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:126

forEach

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

get

get(key: string): 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.

Returns
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Parameters
- key: string
Returns undefined | Uint8Array
Inherited from Map.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:36

getFullMultiaddr

getFullMultiaddr(protocol: "tcp" | "udp" | "tcp6" | "udp6" | "udp4" | "tcp4"): 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 getFullMultiaddrs.
Parameters
- protocol: "tcp" | "udp" | "tcp6" | "udp6" | "udp4" | "tcp4"
Returns undefined | Multiaddr
- Defined in packages/enr/src/enr.ts:418

getFullMultiaddrs

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

Returns Multiaddr[]
- Defined in packages/enr/src/enr.ts:433

getLocationMultiaddr

getLocationMultiaddr(protocol: "tcp" | "udp" | "tcp6" | "udp6" | "udp4" | "tcp4"): undefined | Multiaddr
Parameters
- protocol: "tcp" | "udp" | "tcp6" | "udp6" | "udp4" | "tcp4"
Returns undefined | Multiaddr
- Defined in packages/enr/src/enr.ts:342

has

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

keys

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

Returns IterableIterator<string>
Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:131

set

set(k: string, v: Uint8Array): ENR
Parameters
- k: string
- v: Uint8Array
Returns ENR
Overrides Map.set
- Defined in packages/enr/src/enr.ts:152

setLocationMultiaddr

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

sign

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

values

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

Returns IterableIterator<Uint8Array>
Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:136

verify

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

`Static` create

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

`Static` createFromPeerId

createFromPeerId(peerId: PeerId, kvs?: Record<string, Uint8Array>): Promise<ENR>
Parameters
- peerId: PeerId
- kvs: Record<string, Uint8Array> = {}
Returns Promise<ENR>
- Defined in packages/enr/src/enr.ts:89

`Static` createV4

createV4(publicKey: Uint8Array, kvs?: Record<string, Uint8Array>): Promise<ENR>
Parameters
- publicKey: Uint8Array
- kvs: Record<string, Uint8Array> = {}
Returns Promise<ENR>
- Defined in packages/enr/src/enr.ts:74

`Static` decode

decode(encoded: Uint8Array): Promise<ENR>
Parameters
- encoded: Uint8Array
Returns Promise<ENR>
- Defined in packages/enr/src/enr.ts:138

`Static` decodeFromValues

decodeFromValues(decoded: Uint8Array[]): Promise<ENR>
Parameters
- decoded: Uint8Array[]
Returns Promise<ENR>
- Defined in packages/enr/src/enr.ts:102

`Static` decodeTxt

decodeTxt(encoded: string): Promise<ENR>
Parameters
- encoded: string
Returns Promise<ENR>
- Defined in packages/enr/src/enr.ts:143

Class ENR

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

kvs: Record<string, Uint8Array> = {}

seq: bigint = ...

signature: null | Uint8Array = null

Returns ENR

Properties

Readonly [toStringTag]

Optional peerId

seq

signature

Readonly size

Returns

Static Readonly RECORD_PREFIX

Static Readonly [species]

Accessors

id

Returns string

ip

Returns undefined | string

Parameters

ip: undefined | string

Returns void

ip6

Returns undefined | string

Parameters

ip: undefined | string

Returns void

keypair

Returns undefined | IKeypair

keypairType

Returns KeypairType

multiaddrs

Returns undefined | Multiaddr[]

Parameters

multiaddrs: undefined | Multiaddr[]

Returns void

nodeId

Returns undefined | string

publicKey

Returns undefined | Uint8Array

tcp

Returns undefined | number

Parameters

port: undefined | number

Returns void

tcp6

Returns undefined | number

Parameters

port: undefined | number

Returns void

udp

Returns undefined | number

Parameters

port: undefined | number

Returns void

udp6

Returns undefined | number

Parameters

port: undefined | number

Returns void

waku2

Returns undefined | Waku2

Parameters

waku2: undefined | Waku2

Returns void

Methods

[iterator]

Returns IterableIterator<[string, Uint8Array]>

clear

Returns void

delete

`Private` constructor

`Readonly` [toStringTag]

`Optional` peerId

`Readonly` size

`Static` `Readonly` RECORD_PREFIX

`Static` `Readonly` [species]

`Optional` privateKey: Uint8Array

`Optional` privateKey: Uint8Array

`Optional` privateKey: Uint8Array

`Optional` thisArg: any