Press n or j to go to the next uncovered block, b, p or k for the previous block.
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 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 | 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 112x 112x 112x 112x 3543x 33x 33x 33x 33x 33x 33x 541x 541x 541x 541x 541x 541x 541x 541x 541x 541x 541x 541x 541x 541x 801x 541x 812x 541x 3198x 541x 408x 541x 509x 541x 928x 928x 928x 541x 401x 401x 401x 541x 502x 541x 20x 541x 1220x 541x 541x 3x 541x 541x 3x 541x 541x 480x 480x 480x 3x 6x 6x 6x 6x 3x 3x 3x 1104x 1104x 1104x 3x 3x 3x 3x 5x 5x 2x 3x 4x 4x 3x 1x 620x 620x 114x 506x 506x 506x 77x 77x 77x 506x 506x 506x 2493x 77x 2493x 11949x 2493x 561x 2493x 2493x 101x 2493x 2493x 1040x 486x 78x 408x 408x 21x 408x 408x 408x 408x 402x 408x 408x 1552x 139x 1413x 3239x 1413x 225x 1188x 1188x 1188x 1188x 1184x 1188x 3304x 11958x 6046x 5912x 5912x 167x 167x 167x 167x 808x 2438x 2438x 8499x 481x 301x 181x 181x 6x 3x 533x 507x 2256x 2162x 2162x 2159x 2159x 2162x 2162x 1x 1x 1x 1x 3284x 3284x 696x 3284x 3284x 1586x 1586x 101x 101x 500x 907x 500x 500x 32x 634x 32x 38x 32x 50x 32x 50x 32x 32x 623x 32x 220x 32x 521x 23x 23x 23x 23x 23x 23x 23x 23x 1596x 1596x 1596x 1596x 1596x 1596x 1596x 1596x 1596x 1596x 1596x 1596x 1596x 1596x 1596x 1596x 2159x 2159x 2159x 2159x 2159x 2159x 2159x 2159x 2159x 2159x 2159x 2159x 2159x 2159x | /* * Copyright © 2019 Lisk Foundation * * See the LICENSE file at the top-level directory of this distribution * for licensing information. * * Unless otherwise agreed in a custom licensing agreement with the Lisk Foundation, * no part of this software, including this file, may be copied, modified, * propagated, or distributed except according to the terms contained in the * LICENSE file. * * Removal or modification of this copyright notice is prohibited. * */ /** * The purpose of the PeerPool is to provide a simple interface for selecting, * interacting with and handling aggregated events from a collection of peers. */ import { EventEmitter } from 'events'; // tslint:disable-next-line no-require-imports import shuffle = require('lodash.shuffle'); import { SCServerSocket } from 'socketcluster-server'; import { ConnectionKind, DEFAULT_LOCALHOST_IP, EVICTED_PEER_CODE, INTENTIONAL_DISCONNECT_CODE, PeerKind, SEED_PEER_DISCONNECTION_REASON, } from './constants'; import { RequestFailError, SendFailError } from './errors'; import { EVENT_BAN_PEER, EVENT_CLOSE_INBOUND, EVENT_CLOSE_OUTBOUND, EVENT_CONNECT_ABORT_OUTBOUND, EVENT_CONNECT_OUTBOUND, EVENT_DISCOVERED_PEER, EVENT_FAILED_PEER_INFO_UPDATE, EVENT_FAILED_TO_COLLECT_PEER_DETAILS_ON_CONNECT, EVENT_FAILED_TO_FETCH_PEER_INFO, EVENT_FAILED_TO_FETCH_PEERS, EVENT_FAILED_TO_PUSH_NODE_INFO, EVENT_FAILED_TO_SEND_MESSAGE, EVENT_INBOUND_SOCKET_ERROR, EVENT_MESSAGE_RECEIVED, EVENT_OUTBOUND_SOCKET_ERROR, EVENT_REMOVE_PEER, EVENT_REQUEST_RECEIVED, EVENT_UNBAN_PEER, EVENT_UPDATED_PEER_INFO, REMOTE_EVENT_POST_NODE_INFO, } from './events'; import { P2PRequest } from './p2p_request'; import { P2PClosePacket, P2PMessagePacket, P2PNodeInfo, P2PPeerInfo, P2PPeersCount, P2PPeerSelectionForConnectionFunction, P2PPeerSelectionForRequestFunction, P2PPeerSelectionForSendFunction, P2PPenalty, P2PRequestPacket, P2PResponsePacket, PeerLists, } from './p2p_types'; import { ConnectionState, InboundPeer, OutboundPeer, Peer, PeerConfig, } from './peer'; interface FilterPeersOptions { readonly category: PROTECTION_CATEGORY; readonly percentage: number; readonly protectBy: PROTECT_BY; } export enum PROTECT_BY { HIGHEST = 'highest', LOWEST = 'lowest', } // Returns an array of peers to be protected export const filterPeersByCategory = ( peers: Peer[], options: FilterPeersOptions, ): Peer[] => { // tslint:disable-next-line no-magic-numbers Iif (options.percentage > 1 || options.percentage < 0) { return peers; } const numberOfProtectedPeers = Math.ceil(peers.length * options.percentage); const sign = options.protectBy === PROTECT_BY.HIGHEST ? -1 : 1; // tslint:disable-next-line no-any return peers .sort((peerA: any, peerB: any) => peerA.internalState[options.category] > peerB.internalState[options.category] ? sign : sign * -1, ) .slice(0, numberOfProtectedPeers); }; export enum PROTECTION_CATEGORY { NET_GROUP = 'netgroup', LATENCY = 'latency', RESPONSE_RATE = 'responseRate', CONNECT_TIME = 'connectTime', } export interface PeerPoolConfig { readonly ackTimeout?: number; readonly connectTimeout?: number; readonly wsMaxPayload?: number; readonly maxPeerInfoSize: number; readonly peerSelectionForSend: P2PPeerSelectionForSendFunction; readonly peerSelectionForRequest: P2PPeerSelectionForRequestFunction; readonly peerSelectionForConnection: P2PPeerSelectionForConnectionFunction; readonly sendPeerLimit: number; readonly peerBanTime: number; readonly maxOutboundConnections: number; readonly maxInboundConnections: number; readonly maxPeerDiscoveryResponseLength: number; readonly outboundShuffleInterval: number; readonly netgroupProtectionRatio: number; readonly latencyProtectionRatio: number; readonly productivityProtectionRatio: number; readonly longevityProtectionRatio: number; readonly wsMaxMessageRate: number; readonly wsMaxMessageRatePenalty: number; readonly rateCalculationInterval: number; readonly secret: number; readonly peerLists: PeerLists; } export class PeerPool extends EventEmitter { private readonly _peerMap: Map<string, Peer>; private readonly _peerPoolConfig: PeerPoolConfig; private readonly _handlePeerRPC: (request: P2PRequest) => void; private readonly _handlePeerMessage: (message: P2PMessagePacket) => void; private readonly _handleOutboundPeerConnect: (peerInfo: P2PPeerInfo) => void; private readonly _handleDiscoverPeer: (peerInfo: P2PPeerInfo) => void; private readonly _handleOutboundPeerConnectAbort: ( peerInfo: P2PPeerInfo, ) => void; private readonly _handlePeerCloseOutbound: ( closePacket: P2PClosePacket, ) => void; private readonly _handlePeerCloseInbound: ( closePacket: P2PClosePacket, ) => void; private readonly _handlePeerOutboundSocketError: (error: Error) => void; private readonly _handlePeerInboundSocketError: (error: Error) => void; private readonly _handlePeerInfoUpdate: (peerInfo: P2PPeerInfo) => void; private readonly _handleFailedPeerInfoUpdate: (error: Error) => void; private readonly _handleFailedToFetchPeerInfo: (error: Error) => void; private readonly _handleFailedToFetchPeers: (error: Error) => void; private readonly _handleFailedToCollectPeerDetails: (error: Error) => void; private readonly _handleBanPeer: (peerId: string) => void; private readonly _handleUnbanPeer: (peerId: string) => void; private _nodeInfo: P2PNodeInfo | undefined; private readonly _maxOutboundConnections: number; private readonly _maxInboundConnections: number; private readonly _peerSelectForSend: P2PPeerSelectionForSendFunction; private readonly _peerSelectForRequest: P2PPeerSelectionForRequestFunction; private readonly _peerSelectForConnection: P2PPeerSelectionForConnectionFunction; private readonly _sendPeerLimit: number; private readonly _outboundShuffleIntervalId: NodeJS.Timer | undefined; private readonly _unbanTimers: Array<NodeJS.Timer | undefined>; private readonly _peerConfig: PeerConfig; private readonly _peerLists: PeerLists; public constructor(peerPoolConfig: PeerPoolConfig) { super(); this._peerMap = new Map(); this._peerPoolConfig = peerPoolConfig; this._peerConfig = { connectTimeout: this._peerPoolConfig.connectTimeout, ackTimeout: this._peerPoolConfig.ackTimeout, wsMaxMessageRate: this._peerPoolConfig.wsMaxMessageRate, wsMaxMessageRatePenalty: this._peerPoolConfig.wsMaxMessageRatePenalty, maxPeerDiscoveryResponseLength: this._peerPoolConfig .maxPeerDiscoveryResponseLength, rateCalculationInterval: this._peerPoolConfig.rateCalculationInterval, wsMaxPayload: this._peerPoolConfig.wsMaxPayload, maxPeerInfoSize: this._peerPoolConfig.maxPeerInfoSize, secret: this._peerPoolConfig.secret, }; this._peerLists = peerPoolConfig.peerLists; this._peerSelectForSend = peerPoolConfig.peerSelectionForSend; this._peerSelectForRequest = peerPoolConfig.peerSelectionForRequest; this._peerSelectForConnection = peerPoolConfig.peerSelectionForConnection; this._maxOutboundConnections = peerPoolConfig.maxOutboundConnections; this._maxInboundConnections = peerPoolConfig.maxInboundConnections; this._sendPeerLimit = peerPoolConfig.sendPeerLimit; this._outboundShuffleIntervalId = setInterval(() => { this._evictPeer(OutboundPeer); }, peerPoolConfig.outboundShuffleInterval); this._unbanTimers = []; // This needs to be an arrow function so that it can be used as a listener. this._handlePeerRPC = (request: P2PRequest) => { // Re-emit the request to allow it to bubble up the class hierarchy. this.emit(EVENT_REQUEST_RECEIVED, request); }; // This needs to be an arrow function so that it can be used as a listener. this._handlePeerMessage = (message: P2PMessagePacket) => { // Re-emit the message to allow it to bubble up the class hierarchy. this.emit(EVENT_MESSAGE_RECEIVED, message); }; // This needs to be an arrow function so that it can be used as a listener. this._handleDiscoverPeer = (peerInfo: P2PPeerInfo) => { // Re-emit the message to allow it to bubble up the class hierarchy. this.emit(EVENT_DISCOVERED_PEER, peerInfo); }; this._handleOutboundPeerConnect = (peerInfo: P2PPeerInfo) => { // Re-emit the message to allow it to bubble up the class hierarchy. this.emit(EVENT_CONNECT_OUTBOUND, peerInfo); }; this._handleOutboundPeerConnectAbort = (peerInfo: P2PPeerInfo) => { // Re-emit the message to allow it to bubble up the class hierarchy. this.emit(EVENT_CONNECT_ABORT_OUTBOUND, peerInfo); }; this._handlePeerCloseOutbound = (closePacket: P2PClosePacket) => { const peerId = closePacket.peerInfo.peerId; this.removePeer( peerId, closePacket.code, `Outbound peer ${peerId} disconnected with reason: ${closePacket.reason || 'Unknown reason'}`, ); // Re-emit the message to allow it to bubble up the class hierarchy. this.emit(EVENT_CLOSE_OUTBOUND, closePacket); }; this._handlePeerCloseInbound = (closePacket: P2PClosePacket) => { const peerId = closePacket.peerInfo.peerId; this.removePeer( peerId, closePacket.code, `Inbound peer ${peerId} disconnected with reason: ${closePacket.reason || 'Unknown reason'}`, ); // Re-emit the message to allow it to bubble up the class hierarchy. this.emit(EVENT_CLOSE_INBOUND, closePacket); }; this._handlePeerOutboundSocketError = (error: Error) => { // Re-emit the error to allow it to bubble up the class hierarchy. this.emit(EVENT_OUTBOUND_SOCKET_ERROR, error); }; this._handlePeerInboundSocketError = (error: Error) => { // Re-emit the error to allow it to bubble up the class hierarchy. this.emit(EVENT_INBOUND_SOCKET_ERROR, error); }; this._handlePeerInfoUpdate = (peerInfo: P2PPeerInfo) => { // Re-emit the error to allow it to bubble up the class hierarchy. this.emit(EVENT_UPDATED_PEER_INFO, peerInfo); }; this._handleFailedPeerInfoUpdate = (error: Error) => { // Re-emit the error to allow it to bubble up the class hierarchy. this.emit(EVENT_FAILED_PEER_INFO_UPDATE, error); }; this._handleFailedToFetchPeerInfo = (error: Error) => { // Re-emit the error to allow it to bubble up the class hierarchy. this.emit(EVENT_FAILED_TO_FETCH_PEER_INFO, error); }; this._handleFailedToFetchPeers = (error: Error) => { // Re-emit the error to allow it to bubble up the class hierarchy. this.emit(EVENT_FAILED_TO_FETCH_PEERS, error); }; this._handleFailedToCollectPeerDetails = (error: Error) => { // Re-emit the error to allow it to bubble up the class hierarchy. this.emit(EVENT_FAILED_TO_COLLECT_PEER_DETAILS_ON_CONNECT, error); }; this._handleBanPeer = (peerId: string) => { // Unban peer after peerBanTime const unbanTimeout = setTimeout( this._handleUnbanPeer.bind(this, peerId), this._peerPoolConfig.peerBanTime, ); this._unbanTimers.push(unbanTimeout); // Re-emit the peerId to allow it to bubble up the class hierarchy. this.emit(EVENT_BAN_PEER, peerId); }; this._handleUnbanPeer = (peerId: string) => { // Re-emit the peerId to allow it to bubble up the class hierarchy. this.emit(EVENT_UNBAN_PEER, peerId); }; } public applyNodeInfo(nodeInfo: P2PNodeInfo): void { this._nodeInfo = nodeInfo; const peerList = this.getPeers(); peerList.forEach(peer => { this._applyNodeInfoOnPeer(peer); }); } public get nodeInfo(): P2PNodeInfo | undefined { return this._nodeInfo; } public get peerConfig(): PeerConfig { return { ...this._peerConfig }; } public async request(packet: P2PRequestPacket): Promise<P2PResponsePacket> { const outboundPeerInfos = this.getAllConnectedPeerInfos(OutboundPeer); const peerInfoForRequest = outboundPeerInfos.length === 0 ? this.getAllConnectedPeerInfos() : outboundPeerInfos; // This function can be customized so we should pass as much info as possible. const selectedPeers = this._peerSelectForRequest({ peers: peerInfoForRequest, nodeInfo: this._nodeInfo, peerLimit: 1, requestPacket: packet, }); if (selectedPeers.length <= 0) { throw new RequestFailError( 'Request failed due to no peers found in peer selection', ); } const selectedPeerId = selectedPeers[0].peerId; return this.requestFromPeer(packet, selectedPeerId); } public broadcast(message: P2PMessagePacket): void { [...this._peerMap.values()].forEach(peer => { const selectedPeerId = peer.peerInfo.peerId; try { this.sendToPeer(message, selectedPeerId); } catch (error) { this.emit(EVENT_FAILED_TO_SEND_MESSAGE, error); } }); } public send(message: P2PMessagePacket): void { const listOfPeerInfo: ReadonlyArray<P2PPeerInfo> = [ ...this._peerMap.values(), ].map(peer => ({ ...peer.peerInfo, internalState: { ...peer.peerInfo.internalState, advertiseAddress: peer.peerInfo.internalState ? peer.peerInfo.internalState.advertiseAddress : true, connectionKind: peer instanceof OutboundPeer ? ConnectionKind.OUTBOUND : ConnectionKind.INBOUND, }, })); // This function can be customized so we should pass as much info as possible. const selectedPeers = this._peerSelectForSend({ peers: listOfPeerInfo, nodeInfo: this._nodeInfo, peerLimit: this._sendPeerLimit, messagePacket: message, }); selectedPeers.forEach((peerInfo: P2PPeerInfo) => { const selectedPeerId = peerInfo.peerId; try { this.sendToPeer(message, selectedPeerId); } catch (error) { this.emit(EVENT_FAILED_TO_SEND_MESSAGE, error); } }); } public async requestFromPeer( packet: P2PRequestPacket, peerId: string, ): Promise<P2PResponsePacket> { const peer = this._peerMap.get(peerId); if (!peer) { throw new RequestFailError( `Request failed because a peer with id ${peerId} could not be found`, ); } return peer.request(packet); } public sendToPeer(message: P2PMessagePacket, peerId: string): void { const peer = this._peerMap.get(peerId); if (!peer) { throw new SendFailError( `Send failed because a peer with id ${peerId} could not be found`, ); } peer.send(message); } public discoverFromSeedPeers(): void { const freeOutboundSlots = this.getFreeOutboundSlots(); // LIP-0004 re-discovery SeedPeers when Outboundconnection < maxOutboundconnections if (freeOutboundSlots === 0 || this._peerLists.seedPeers.length === 0) { return; } // Looking after existing seed peer connection(s) this._peerLists.seedPeers.forEach(peer => { const isConnectedSeedPeer = this.getPeer(peer.peerId); if (isConnectedSeedPeer) { // tslint:disable-next-line: no-floating-promises (async () => { try { await isConnectedSeedPeer.discoverPeers(); // tslint:disable-next-line: no-empty } catch (error) {} })(); } }); const seedPeersForDiscovery = shuffle( this._peerLists.seedPeers.slice(0, freeOutboundSlots), ); // Add new seed peer connection(s) seedPeersForDiscovery.forEach(peer => { this._addOutboundPeer(peer, this._nodeInfo as P2PNodeInfo); }); } public triggerNewConnections( newPeers: ReadonlyArray<P2PPeerInfo>, triedPeers: ReadonlyArray<P2PPeerInfo>, ): void { // Try to connect to disconnected peers without including the fixed ones which are specially treated thereafter const disconnectedNewPeers = newPeers.filter( newPeer => !this._peerMap.has(newPeer.peerId), ); const disconnectedTriedPeers = triedPeers.filter( triedPeer => !this._peerMap.has(triedPeer.peerId), ); const disconnectedFixedPeers = this._peerLists.fixedPeers.filter( peer => !this._peerMap.has(peer.peerId), ); // Trigger new connections only if the maximum of outbound connections has not been reached // If the node is not yet connected to any of the fixed peers, enough slots should be saved for them const peerLimit = this.getFreeOutboundSlots(); if (peerLimit === 0) { this._disconnectFromSeedPeers(); } // This function can be customized so we should pass as much info as possible. const peersToConnect = this._peerSelectForConnection({ newPeers: disconnectedNewPeers, triedPeers: disconnectedTriedPeers, nodeInfo: this._nodeInfo, peerLimit, }); [ ...peersToConnect, ...disconnectedFixedPeers, ].forEach((peerInfo: P2PPeerInfo) => this._addOutboundPeer(peerInfo, this._nodeInfo as P2PNodeInfo), ); } public addInboundPeer(peerInfo: P2PPeerInfo, socket: SCServerSocket): Peer { // Throw an error because adding a peer multiple times is a common developer error which is very difficult to identify and debug. if (this._peerMap.has(peerInfo.peerId)) { throw new Error(`Peer ${peerInfo.peerId} was already in the peer pool`); } const inboundPeers = this.getPeers(InboundPeer); if (inboundPeers.length >= this._maxInboundConnections) { this._evictPeer(InboundPeer); } const peer = new InboundPeer(peerInfo, socket, { ...this._peerConfig, serverNodeInfo: this._nodeInfo, }); this._peerMap.set(peer.id, peer); this._bindHandlersToPeer(peer); if (this._nodeInfo) { this._applyNodeInfoOnPeer(peer); } peer.connect(); return peer; } private _addOutboundPeer( peerInfo: P2PPeerInfo, nodeInfo: P2PNodeInfo, ): boolean { if (this.hasPeer(peerInfo.peerId)) { return false; } // Check if we got already Outbound connection into the IP address of the Peer const outboundConnectedPeer = this.getPeers(OutboundPeer).find( p => p.ipAddress === peerInfo.ipAddress && p.ipAddress !== DEFAULT_LOCALHOST_IP, ); if (outboundConnectedPeer) { return false; } /* Inject our nodeInfo for validation during handshake on outbound peer connection */ const peer = new OutboundPeer(peerInfo, { ...this._peerConfig, serverNodeInfo: nodeInfo, }); this._peerMap.set(peer.id, peer); this._bindHandlersToPeer(peer); if (this._nodeInfo) { this._applyNodeInfoOnPeer(peer); } return true; } public getPeersCountPerKind(): P2PPeersCount { return [...this._peerMap.values()].reduce( (prev, peer) => { if (peer instanceof OutboundPeer) { return { outboundCount: prev.outboundCount + 1, inboundCount: prev.inboundCount, }; } Eif (peer instanceof InboundPeer) { return { outboundCount: prev.outboundCount, inboundCount: prev.inboundCount + 1, }; } throw new Error('A non-identified peer exists in the pool.'); }, { outboundCount: 0, inboundCount: 0 }, ); } public removeAllPeers(): void { // Clear periodic eviction of outbound peers for shuffling Eif (this._outboundShuffleIntervalId) { clearInterval(this._outboundShuffleIntervalId); } // Clear unban timeouts Iif (this._unbanTimers.length > 0) { this._unbanTimers.forEach(timer => { if (timer) { clearTimeout(timer); } }); } this._peerMap.forEach((peer: Peer) => { this.removePeer( peer.id, INTENTIONAL_DISCONNECT_CODE, `Intentionally removed peer ${peer.id}`, ); }); } public getPeers( kind?: typeof OutboundPeer | typeof InboundPeer, ): ReadonlyArray<Peer> { const peers = [...this._peerMap.values()]; if (kind) { return peers.filter(peer => peer instanceof kind); } return peers; } public getAllConnectedPeerInfos( kind?: typeof OutboundPeer | typeof InboundPeer, ): ReadonlyArray<P2PPeerInfo> { return this.getConnectedPeers(kind).map(peer => peer.peerInfo); } public getConnectedPeers( kind?: typeof OutboundPeer | typeof InboundPeer, ): ReadonlyArray<Peer> { const peers = [...this._peerMap.values()]; if (kind) { return peers.filter( peer => peer instanceof kind && peer.state === ConnectionState.OPEN, ); } return peers.filter(peer => peer.state === ConnectionState.OPEN); } public getPeer(peerId: string): Peer | undefined { return this._peerMap.get(peerId); } public hasPeer(peerId: string): boolean { return this._peerMap.has(peerId); } public removePeer(peerId: string, code: number, reason: string): boolean { const peer = this._peerMap.get(peerId); if (peer) { peer.disconnect(code, reason); this._unbindHandlersFromPeer(peer); } this.emit(EVENT_REMOVE_PEER, peerId); return this._peerMap.delete(peerId); } public applyPenalty(peerPenalty: P2PPenalty): void { const peer = this._peerMap.get(peerPenalty.peerId); Eif (peer) { peer.applyPenalty(peerPenalty.penalty); return; } throw new Error(`Peer not found: ${peerPenalty.peerId}`); } public getFreeOutboundSlots(): number { const { outboundCount } = this.getPeersCountPerKind(); const disconnectedFixedPeers = this._peerLists.fixedPeers.filter( peer => !this._peerMap.has(peer.peerId), ); // If the node is not yet connected to any of the fixed peers, enough slots should be saved for them const openOutboundSlots = this._maxOutboundConnections - disconnectedFixedPeers.length - outboundCount; return openOutboundSlots; } private _applyNodeInfoOnPeer(peer: Peer): void { try { peer.send({ event: REMOTE_EVENT_POST_NODE_INFO, data: this._nodeInfo, }); } catch (error) { this.emit(EVENT_FAILED_TO_PUSH_NODE_INFO, error); } } private _disconnectFromSeedPeers(): void { const outboundPeers = this.getPeers(OutboundPeer); outboundPeers.forEach((outboundPeer: Peer) => { const isFixedPeer = this._peerLists.fixedPeers.find( (peer: P2PPeerInfo) => peer.peerId === outboundPeer.id, ); const isSeedPeer = this._peerLists.seedPeers.find( (peer: P2PPeerInfo) => peer.peerId === outboundPeer.id, ); // From FixedPeers we should not disconnect Iif (isSeedPeer && !isFixedPeer) { this.removePeer( outboundPeer.id, INTENTIONAL_DISCONNECT_CODE, SEED_PEER_DISCONNECTION_REASON, ); } }); } private _selectPeersForEviction(): Peer[] { const peers = [...this.getPeers(InboundPeer)].filter( peer => !( peer.internalState.peerKind === PeerKind.WHITELISTED_PEER || peer.internalState.peerKind === PeerKind.FIXED_PEER ), ); // Cannot predict which netgroups will be protected const protectedPeersByNetgroup = this._peerPoolConfig .netgroupProtectionRatio ? filterPeersByCategory(peers, { category: PROTECTION_CATEGORY.NET_GROUP, percentage: this._peerPoolConfig.netgroupProtectionRatio, protectBy: PROTECT_BY.HIGHEST, }).map(peer => peer.id) : []; // Cannot manipulate without physically moving nodes closer to the target. const protectedPeersByLatency = this._peerPoolConfig.latencyProtectionRatio ? filterPeersByCategory(peers, { category: PROTECTION_CATEGORY.LATENCY, percentage: this._peerPoolConfig.latencyProtectionRatio, protectBy: PROTECT_BY.LOWEST, }).map(peer => peer.id) : []; // Cannot manipulate this metric without performing useful work. const protectedPeersByResponseRate = this._peerPoolConfig .productivityProtectionRatio ? filterPeersByCategory(peers, { category: PROTECTION_CATEGORY.RESPONSE_RATE, percentage: this._peerPoolConfig.productivityProtectionRatio, protectBy: PROTECT_BY.HIGHEST, }).map(peer => peer.id) : []; const uniqueProtectedPeers = new Set([ ...protectedPeersByNetgroup, ...protectedPeersByLatency, ...protectedPeersByResponseRate, ]); const unprotectedPeers = peers.filter( peer => !uniqueProtectedPeers.has(peer.id), ); // Protect *the remaining half* of peers by longevity, precludes attacks that start later. const protectedPeersByConnectTime = this._peerPoolConfig .longevityProtectionRatio ? new Set([ ...filterPeersByCategory(unprotectedPeers, { category: PROTECTION_CATEGORY.CONNECT_TIME, percentage: this._peerPoolConfig.longevityProtectionRatio, protectBy: PROTECT_BY.LOWEST, }).map(peer => peer.id), ]) : new Set(); return unprotectedPeers.filter( peer => !protectedPeersByConnectTime.has(peer.id), ); } private _evictPeer(kind: typeof InboundPeer | typeof OutboundPeer): void { const peers = this.getPeers(kind); Iif (peers.length < 1) { return; } // tslint:disable-next-line strict-comparisons Iif (kind === OutboundPeer) { const selectedPeer = shuffle( peers.filter( peer => peer.internalState.peerKind !== PeerKind.FIXED_PEER, ), )[0]; if (selectedPeer) { this.removePeer( selectedPeer.id, EVICTED_PEER_CODE, `Evicted outbound peer ${selectedPeer.id}`, ); } } // tslint:disable-next-line strict-comparisons Eif (kind === InboundPeer) { const evictionCandidates = this._selectPeersForEviction(); const peerToEvict = shuffle(evictionCandidates)[0]; Eif (peerToEvict) { this.removePeer( peerToEvict.id, EVICTED_PEER_CODE, `Evicted inbound peer ${peerToEvict.id}`, ); } } } private _bindHandlersToPeer(peer: Peer): void { peer.on(EVENT_REQUEST_RECEIVED, this._handlePeerRPC); peer.on(EVENT_MESSAGE_RECEIVED, this._handlePeerMessage); peer.on(EVENT_CONNECT_OUTBOUND, this._handleOutboundPeerConnect); peer.on(EVENT_CONNECT_ABORT_OUTBOUND, this._handleOutboundPeerConnectAbort); peer.on(EVENT_CLOSE_OUTBOUND, this._handlePeerCloseOutbound); peer.on(EVENT_CLOSE_INBOUND, this._handlePeerCloseInbound); peer.on(EVENT_OUTBOUND_SOCKET_ERROR, this._handlePeerOutboundSocketError); peer.on(EVENT_INBOUND_SOCKET_ERROR, this._handlePeerInboundSocketError); peer.on(EVENT_UPDATED_PEER_INFO, this._handlePeerInfoUpdate); peer.on(EVENT_FAILED_PEER_INFO_UPDATE, this._handleFailedPeerInfoUpdate); peer.on(EVENT_FAILED_TO_FETCH_PEER_INFO, this._handleFailedToFetchPeerInfo); peer.on(EVENT_FAILED_TO_FETCH_PEERS, this._handleFailedToFetchPeers); peer.on( EVENT_FAILED_TO_COLLECT_PEER_DETAILS_ON_CONNECT, this._handleFailedToCollectPeerDetails, ); peer.on(EVENT_BAN_PEER, this._handleBanPeer); peer.on(EVENT_UNBAN_PEER, this._handleUnbanPeer); peer.on(EVENT_DISCOVERED_PEER, this._handleDiscoverPeer); } private _unbindHandlersFromPeer(peer: Peer): void { peer.removeListener(EVENT_REQUEST_RECEIVED, this._handlePeerRPC); peer.removeListener(EVENT_MESSAGE_RECEIVED, this._handlePeerMessage); peer.removeListener( EVENT_CONNECT_OUTBOUND, this._handleOutboundPeerConnect, ); peer.removeListener( EVENT_CONNECT_ABORT_OUTBOUND, this._handleOutboundPeerConnectAbort, ); peer.removeListener(EVENT_CLOSE_OUTBOUND, this._handlePeerCloseOutbound); peer.removeListener(EVENT_CLOSE_INBOUND, this._handlePeerCloseInbound); peer.removeListener(EVENT_UPDATED_PEER_INFO, this._handlePeerInfoUpdate); peer.removeListener( EVENT_FAILED_TO_FETCH_PEER_INFO, this._handleFailedToFetchPeerInfo, ); peer.removeListener( EVENT_FAILED_TO_FETCH_PEERS, this._handleFailedToFetchPeers, ); peer.removeListener( EVENT_FAILED_PEER_INFO_UPDATE, this._handleFailedPeerInfoUpdate, ); peer.removeListener( EVENT_FAILED_TO_COLLECT_PEER_DETAILS_ON_CONNECT, this._handleFailedToCollectPeerDetails, ); peer.removeListener(EVENT_BAN_PEER, this._handleBanPeer); peer.removeListener(EVENT_UNBAN_PEER, this._handleUnbanPeer); peer.removeListener(EVENT_DISCOVERED_PEER, this._handleDiscoverPeer); } } |