ethereumjs-monorepo

@ethereumjs/devp2p


@ethereumjs/devp2p / DPT

Class: DPT

Defined in: packages/devp2p/src/dpt/dpt.ts:23

Constructors

Constructor

new DPT(privateKey, options): DPT

Defined in: packages/devp2p/src/dpt/dpt.ts:48

Parameters

privateKey

Uint8Array

options

DPTOptions

Returns

DPT

Properties

events

events: EventEmitter<DPTEvent>

Defined in: packages/devp2p/src/dpt/dpt.ts:24


id

readonly id: undefined | Uint8Array<ArrayBufferLike>

Defined in: packages/devp2p/src/dpt/dpt.ts:30

Methods

_addPeerBatch()

_addPeerBatch(peers): void

Defined in: packages/devp2p/src/dpt/dpt.ts:128

Parameters

peers

PeerInfo[]

Returns

void


_onKBucketPing()

_onKBucketPing(oldPeers, newPeer): void

Defined in: packages/devp2p/src/dpt/dpt.ts:106

Parameters

oldPeers

PeerInfo[]

newPeer

PeerInfo

Returns

void


addPeer()

addPeer(obj): Promise<PeerInfo>

Defined in: packages/devp2p/src/dpt/dpt.ts:157

Parameters

obj

PeerInfo

Returns

Promise<PeerInfo>


banPeer()

banPeer(obj, maxAge?): void

Defined in: packages/devp2p/src/dpt/dpt.ts:223

Parameters

obj
string PeerInfo Uint8Array<ArrayBufferLike>
maxAge?

number

Returns

void


bind()

bind(…args): void

Defined in: packages/devp2p/src/dpt/dpt.ts:97

Parameters

args

any[]

Returns

void


bootstrap()

bootstrap(peer): Promise<void>

Defined in: packages/devp2p/src/dpt/dpt.ts:141

Parameters

peer

PeerInfo

Returns

Promise<void>


confirmPeer()

confirmPeer(id): void

Defined in: packages/devp2p/src/dpt/dpt.ts:187

Add peer to a confirmed list of peers (peers meeting some level of quality, e.g. being on the same network) to allow for a more selective findNeighbours request and sending (with activated onlyConfirmed setting)

Parameters

id

string

Unprefixed hex id

Returns

void


destroy()

destroy(…args): void

Defined in: packages/devp2p/src/dpt/dpt.ts:101

Parameters

args

any[]

Returns

void


getClosestPeers()

getClosestPeers(id): PeerInfo[]

Defined in: packages/devp2p/src/dpt/dpt.ts:205

Parameters

id

Uint8Array

Returns

PeerInfo[]


getDnsPeers()

getDnsPeers(): Promise<PeerInfo[]>

Defined in: packages/devp2p/src/dpt/dpt.ts:228

Returns

Promise<PeerInfo[]>


getPeer()

getPeer(obj): null | PeerInfo

Defined in: packages/devp2p/src/dpt/dpt.ts:193

Parameters

obj
string PeerInfo Uint8Array<ArrayBufferLike>

Returns

null | PeerInfo


getPeers()

getPeers(): PeerInfo[]

Defined in: packages/devp2p/src/dpt/dpt.ts:197

Returns

PeerInfo[]


numPeers()

numPeers(): number

Defined in: packages/devp2p/src/dpt/dpt.ts:201

Returns

number


refresh()

refresh(): Promise<void>

Defined in: packages/devp2p/src/dpt/dpt.ts:232

Returns

Promise<void>


removePeer()

removePeer(obj): void

Defined in: packages/devp2p/src/dpt/dpt.ts:215

Parameters

obj
string PeerInfo Uint8Array<ArrayBufferLike>

Returns

void