ethereumjs-monorepo

@ethereumjs/devp2p

---

@ethereumjs/devp2p / Peer

Class: Peer

Defined in: packages/devp2p/src/rlpx/peer.ts:77

Constructors

Constructor

new Peer(options): Peer

Defined in: packages/devp2p/src/rlpx/peer.ts:111

Parameters

options

PeerOptions

Returns

Peer

Properties

_protocols

_protocols: ProtocolDescriptor[]

Defined in: packages/devp2p/src/rlpx/peer.ts:109

Subprotocols (e.g. ETH) derived from the exchange on capabilities

---

clientId

readonly clientId: Uint8Array

Defined in: packages/devp2p/src/rlpx/peer.ts:79

---

common

common: Common

Defined in: packages/devp2p/src/rlpx/peer.ts:81

---

events

events: EventEmitter

Defined in: packages/devp2p/src/rlpx/peer.ts:78

---

id

readonly id: Uint8Array

Defined in: packages/devp2p/src/rlpx/peer.ts:83

Methods

_addFirstPeerDebugger()

_addFirstPeerDebugger(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:720

Called once from the subprotocol (e.g. ETH) on the peer where a first successful STATUS msg exchange could be achieved.

Can be used together with the devp2p:FIRST_PEER debugger.

Returns

void

---

_getProtocol()

_getProtocol(code): undefined | ProtocolDescriptor

Defined in: packages/devp2p/src/rlpx/peer.ts:682

Returns either a protocol object with a protocol parameter reference to this Peer instance or to a subprotocol instance (e.g. ETH) (depending on the code provided)

Parameters

code

number

Returns

undefined | ProtocolDescriptor

---

_handleAck()

_handleAck(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:350

ACK message received

Returns

void

---

_handleAuth()

_handleAuth(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:327

AUTH message received

Returns

void

---

_handleBody()

_handleBody(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:544

Handle message body

Returns

void

---

_handleDisconnect()

_handleDisconnect(payload): void

Defined in: packages/devp2p/src/rlpx/peer.ts:464

DISCONNECT message received

Parameters

payload

any

Returns

void

---

_handleHeader()

_handleHeader(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:524

Handle message header

Returns

void

---

_handleHello()

_handleHello(payload): void

Defined in: packages/devp2p/src/rlpx/peer.ts:381

HELLO message received

Parameters

payload

any

Returns

void

---

_handleMessage()

_handleMessage(code, msg): void

Defined in: packages/devp2p/src/rlpx/peer.ts:504

Message handling, called from a SubProtocol context

Parameters

code

PREFIXES

msg

Uint8Array

Returns

void

---

_handlePing()

_handlePing(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:488

PING message received

Returns

void

---

_handlePong()

_handlePong(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:495

PONG message received

Returns

void

---

_onSocketClose()

_onSocketClose(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:669

React to socket being closed

Returns

void

---

_onSocketData()

_onSocketData(data): void

Defined in: packages/devp2p/src/rlpx/peer.ts:639

Process socket data

Parameters

data

Uint8Array

Returns

void

---

_sendAck()

_sendAck(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:186

Send ACK message

Returns

void

---

_sendAuth()

_sendAuth(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:164

Send AUTH message

Returns

void

---

_sendDisconnect()

_sendDisconnect(reason): void

Defined in: packages/devp2p/src/rlpx/peer.ts:271

Send DISCONNECT message

Parameters

reason

DISCONNECT_REASON

Returns

void

---

_sendHello()

_sendHello(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:233

Send HELLO message

Returns

void

---

_sendMessage()

_sendMessage(code, data): undefined | boolean

Defined in: packages/devp2p/src/rlpx/peer.ts:213

Create message HEADER and BODY and send to socket Also called from SubProtocol context

Parameters

code

number

data

Uint8Array

Returns

undefined | boolean

---

_sendPing()

_sendPing(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:292

Send PING message

Returns

void

---

_sendPong()

_sendPong(): void

Defined in: packages/devp2p/src/rlpx/peer.ts:312

Send PONG message

Returns

void

---

disconnect()

disconnect(reason): void

Defined in: packages/devp2p/src/rlpx/peer.ts:710

Parameters

reason

DISCONNECT_REASON = DISCONNECT_REASON.DISCONNECT_REQUESTED

Returns

void

---

getDisconnectPrefix()

getDisconnectPrefix(code): string

Defined in: packages/devp2p/src/rlpx/peer.ts:706

Parameters

code

DISCONNECT_REASON

Returns

string

---

getHelloMessage()

getHelloMessage(): null | Hello

Defined in: packages/devp2p/src/rlpx/peer.ts:694

Returns

null | Hello

---

getId()

getId(): null | Uint8Array<ArrayBufferLike>

Defined in: packages/devp2p/src/rlpx/peer.ts:689

Returns

null | Uint8Array<ArrayBufferLike>

---

getMsgPrefix()

getMsgPrefix(code): string

Defined in: packages/devp2p/src/rlpx/peer.ts:702

Parameters

code

PREFIXES

Returns

string

---

getProtocols()

getProtocols(): Protocol[]

Defined in: packages/devp2p/src/rlpx/peer.ts:698

Returns

Protocol[]