forked from ethereumjs/ethereumjs-monorepo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rlpx.ts
271 lines (227 loc) · 8.15 KB
/
rlpx.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
import * as net from 'net'
import * as os from 'os'
import ms from 'ms'
import { publicKeyCreate } from 'secp256k1'
import { EventEmitter } from 'events'
import { debug as createDebugLogger } from 'debug'
import LRUCache from 'lru-cache'
import Common from '@ethereumjs/common'
// note: relative path only valid in .js file in dist
const { version: pVersion } = require('../../package.json')
import { pk2id, createDeferred, formatLogId } from '../util'
import { Peer, DISCONNECT_REASONS, Capabilities } from './peer'
import { DPT, PeerInfo } from '../dpt'
const debug = createDebugLogger('devp2p:rlpx')
const verbose = createDebugLogger('verbose').enabled
export interface RLPxOptions {
clientId?: Buffer
timeout?: number
dpt: DPT
maxPeers: number
remoteClientIdFilter?: string[]
capabilities: Capabilities[]
common: Common
listenPort: number | null
}
export class RLPx extends EventEmitter {
_privateKey: Buffer
_id: Buffer
_timeout: number
_maxPeers: number
_clientId: Buffer
_remoteClientIdFilter?: string[]
_capabilities: Capabilities[]
_common: Common
_listenPort: number | null
_dpt: DPT
_peersLRU: LRUCache<string, boolean>
_peersQueue: { peer: PeerInfo; ts: number }[]
_server: net.Server | null
_peers: Map<string, net.Socket | Peer>
_refillIntervalId: NodeJS.Timeout
constructor(privateKey: Buffer, options: RLPxOptions) {
super()
this._privateKey = Buffer.from(privateKey)
this._id = pk2id(Buffer.from(publicKeyCreate(this._privateKey, false)))
// options
this._timeout = options.timeout || ms('10s')
this._maxPeers = options.maxPeers || 10
this._clientId = options.clientId
? Buffer.from(options.clientId)
: Buffer.from(`ethereumjs-devp2p/v${pVersion}/${os.platform()}-${os.arch()}/nodejs`)
this._remoteClientIdFilter = options.remoteClientIdFilter
this._capabilities = options.capabilities
this._common = options.common
this._listenPort = options.listenPort
// DPT
this._dpt = options.dpt || null
if (this._dpt !== null) {
this._dpt.on('peer:new', (peer: PeerInfo) => {
if (!peer.tcpPort) {
this._dpt.banPeer(peer, ms('5m'))
debug(`banning peer with missing tcp port: ${peer.address}`)
return
}
if (this._peersLRU.has(peer.id!.toString('hex'))) return
this._peersLRU.set(peer.id!.toString('hex'), true)
if (this._getOpenSlots() > 0) return this._connectToPeer(peer)
this._peersQueue.push({ peer: peer, ts: 0 }) // save to queue
})
this._dpt.on('peer:removed', (peer: any) => {
// remove from queue
this._peersQueue = this._peersQueue.filter((item: any) => !item.peer.id.equals(peer.id))
})
}
// internal
this._server = net.createServer()
this._server.once('listening', () => this.emit('listening'))
this._server.once('close', () => this.emit('close'))
this._server.on('error', (err) => this.emit('error', err))
this._server.on('connection', (socket) => this._onConnect(socket, null))
this._peers = new Map()
this._peersQueue = []
this._peersLRU = new LRUCache({ max: 25000 })
this._refillIntervalId = setInterval(() => this._refillConnections(), ms('10s'))
}
listen(...args: any[]) {
this._isAliveCheck()
debug('call .listen')
if (this._server) this._server.listen(...args)
}
destroy(...args: any[]) {
this._isAliveCheck()
debug('call .destroy')
clearInterval(this._refillIntervalId)
if (this._server) this._server.close(...args)
this._server = null
for (const peerKey of this._peers.keys()) this.disconnect(Buffer.from(peerKey, 'hex'))
}
async connect(peer: PeerInfo) {
if (!peer.tcpPort || !peer.address) return
this._isAliveCheck()
if (!Buffer.isBuffer(peer.id)) throw new TypeError('Expected peer.id as Buffer')
const peerKey = peer.id.toString('hex')
if (this._peers.has(peerKey)) throw new Error('Already connected')
if (this._getOpenSlots() === 0) throw new Error('Too many peers already connected')
debug(`connect to ${peer.address}:${peer.tcpPort} (id: ${formatLogId(peerKey, verbose)})`)
const deferred = createDeferred()
const socket = new net.Socket()
this._peers.set(peerKey, socket)
socket.once('close', () => {
this._peers.delete(peerKey)
this._refillConnections()
})
socket.once('error', deferred.reject)
socket.setTimeout(this._timeout, () => deferred.reject(new Error('Connection timeout')))
socket.connect(peer.tcpPort, peer.address, deferred.resolve)
await deferred.promise
this._onConnect(socket, peer.id)
}
getPeers() {
return Array.from(this._peers.values()).filter((item) => item instanceof Peer)
}
disconnect(id: Buffer) {
const peer = this._peers.get(id.toString('hex'))
if (peer instanceof Peer) peer.disconnect(DISCONNECT_REASONS.CLIENT_QUITTING)
}
_isAlive() {
return this._server !== null
}
_isAliveCheck() {
if (!this._isAlive()) throw new Error('Server already destroyed')
}
_getOpenSlots() {
return Math.max(this._maxPeers - this._peers.size, 0)
}
_connectToPeer(peer: PeerInfo) {
this.connect(peer).catch((err) => {
if (this._dpt === null) return
if (err.code === 'ECONNRESET' || err.toString().includes('Connection timeout')) {
this._dpt.banPeer(peer, ms('5m'))
}
})
}
_onConnect(socket: net.Socket, peerId: Buffer | null) {
debug(`connected to ${socket.remoteAddress}:${socket.remotePort}, handshake waiting..`)
const peer: Peer = new Peer({
socket: socket,
remoteId: peerId,
privateKey: this._privateKey,
id: this._id,
timeout: this._timeout,
clientId: this._clientId,
remoteClientIdFilter: this._remoteClientIdFilter,
capabilities: this._capabilities,
common: this._common,
port: this._listenPort,
})
peer.on('error', (err) => this.emit('peer:error', peer, err))
// handle incoming connection
if (peerId === null && this._getOpenSlots() === 0) {
peer.once('connect', () => peer.disconnect(DISCONNECT_REASONS.TOO_MANY_PEERS))
socket.once('error', () => {})
return
}
peer.once('connect', () => {
let msg = `handshake with ${socket.remoteAddress}:${socket.remotePort} was successful`
if (peer._eciesSession._gotEIP8Auth === true) {
msg += ` (peer eip8 auth)`
}
if (peer._eciesSession._gotEIP8Ack === true) {
msg += ` (peer eip8 ack)`
}
debug(msg)
const id = peer.getId()
if (id && id.equals(this._id)) {
return peer.disconnect(DISCONNECT_REASONS.SAME_IDENTITY)
}
const peerKey = id!.toString('hex')
const item = this._peers.get(peerKey)
if (item && item instanceof Peer) {
return peer.disconnect(DISCONNECT_REASONS.ALREADY_CONNECTED)
}
this._peers.set(peerKey, peer)
this.emit('peer:added', peer)
})
peer.once('close', (reason, disconnectWe) => {
if (disconnectWe) {
debug(
`disconnect from ${socket.remoteAddress}:${socket.remotePort}, reason: ${String(reason)}`
)
} else {
debug(`${socket.remoteAddress}:${socket.remotePort} disconnect, reason: ${String(reason)}`)
}
if (!disconnectWe && reason === DISCONNECT_REASONS.TOO_MANY_PEERS) {
// hack
this._peersQueue.push({
peer: {
id: peer.getId()!,
address: peer._socket.remoteAddress,
tcpPort: peer._socket.remotePort,
},
ts: (Date.now() + ms('5m')) as number,
})
}
const id = peer.getId()
if (id) {
const peerKey = id.toString('hex')
this._peers.delete(peerKey)
this.emit('peer:removed', peer, reason, disconnectWe)
}
})
}
_refillConnections() {
if (!this._isAlive()) return
debug(
`refill connections.. queue size: ${this._peersQueue.length}, peers: ${
this._peers.size
}, open slots: ${this._getOpenSlots()}`
)
this._peersQueue = this._peersQueue.filter((item: any) => {
if (this._getOpenSlots() === 0) return true
if (item.ts > Date.now()) return true
this._connectToPeer(item.peer)
return false
})
}
}