All files / src/utils sanitize.ts

97.06% Statements 66/68
94.44% Branches 34/36
100% Functions 19/19
96.72% Lines 59/61

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                            43x                           43x   43x       34278x                                     43x     17736x 4x               17732x   17732x                     641x           43x                 110654x   110654x     43x         477x 44x 4x     40x     477x   87x 6x     81x 36x     45x     45x   45x           477x   411x       411x 4x     407x 21x     386x     386x   386x           477x   61x 6x     55x 36x     19x 1x     18x 2x     16x     16x   16x                 477x 81x 8x     73x 36x     40x 3x     34x 2x     32x       32x     477x                
/*
 * 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.
 */
 
import {
	ConnectionKind,
	DEFAULT_PRODUCTIVITY,
	DEFAULT_REPUTATION_SCORE,
	PeerKind,
} from '../constants';
import {
	P2PEnhancedPeerInfo,
	P2PInternalState,
	P2PPeerInfo,
	PeerLists,
	ProtocolPeerInfo,
} from '../p2p_types';
 
import { constructPeerId, getNetgroup } from './misc';
 
export const assignInternalInfo = (
	peerInfo: P2PPeerInfo,
	secret: number,
): P2PInternalState =>
	peerInfo.internalState
		? peerInfo.internalState
		: {
				reputation: DEFAULT_REPUTATION_SCORE,
				netgroup: getNetgroup(peerInfo.ipAddress, secret),
				latency: 0,
				connectTime: Date.now(),
				rpcCounter: new Map(),
				rpcRates: new Map(),
				messageCounter: new Map(),
				messageRates: new Map(),
				wsMessageCount: 0,
				wsMessageRate: 0,
				productivity: { ...DEFAULT_PRODUCTIVITY },
				advertiseAddress: true,
				connectionKind: ConnectionKind.NONE,
				peerKind: PeerKind.NONE,
		  };
 
export const sanitizeIncomingPeerInfo = (
	rawPeerInfo: unknown,
): P2PPeerInfo | undefined => {
	if (!rawPeerInfo) {
		return undefined;
	}
 
	const {
		ipAddress,
		wsPort,
		height,
		...restOfPeerInfo
	} = rawPeerInfo as ProtocolPeerInfo;
 
	return {
		peerId: constructPeerId(ipAddress, wsPort),
		ipAddress,
		wsPort,
		sharedState: {
			height: typeof height === 'number' ? height : 0, // TODO: Remove the usage of height for choosing among peers having same ipAddress, instead use productivity and reputation
			...restOfPeerInfo,
		},
	};
};
 
export const sanitizeInitialPeerInfo = (peerInfo: ProtocolPeerInfo) => ({
	peerId: constructPeerId(peerInfo.ipAddress, peerInfo.wsPort),
	ipAddress: peerInfo.ipAddress,
	wsPort: peerInfo.wsPort,
});
 
export const sanitizeEnhancedPeerInfo = (
	peerInfo: P2PEnhancedPeerInfo,
): P2PPeerInfo => {
	const {
		dateAdded,
		numOfConnectionFailures,
		sourceAddress,
		bucketId,
		...sharedPeerInfo
	} = peerInfo;
 
	return sharedPeerInfo;
};
 
export const sanitizePeerLists = (
	lists: PeerLists,
	nodeInfo: P2PPeerInfo,
	secret: number,
): PeerLists => {
	const blacklistedIPs = lists.blacklistedIPs.filter(blacklistedIP => {
		if (blacklistedIP === nodeInfo.ipAddress) {
			return false;
		}
 
		return true;
	});
 
	const fixedPeers = lists.fixedPeers
		.filter(peerInfo => {
			if (peerInfo.ipAddress === nodeInfo.ipAddress) {
				return false;
			}
 
			if (blacklistedIPs.includes(peerInfo.ipAddress)) {
				return false;
			}
 
			return true;
		})
		.map(peer => {
			const peerInternalInfo = assignInternalInfo(peer, secret);
 
			return {
				...peer,
				internalState: { ...peerInternalInfo, peerKind: PeerKind.FIXED_PEER },
			};
		});
 
	const seedPeers = lists.seedPeers
		.filter(peerInfo => {
			Iif (peerInfo.ipAddress === nodeInfo.ipAddress) {
				return false;
			}
 
			if (blacklistedIPs.includes(peerInfo.ipAddress)) {
				return false;
			}
 
			if (fixedPeers.map(peer => peer.peerId).includes(peerInfo.peerId)) {
				return false;
			}
 
			return true;
		})
		.map(peer => {
			const peerInternalInfo = assignInternalInfo(peer, secret);
 
			return {
				...peer,
				internalState: { ...peerInternalInfo, peerKind: PeerKind.SEED_PEER },
			};
		});
 
	const whitelisted = lists.whitelisted
		.filter(peerInfo => {
			if (peerInfo.ipAddress === nodeInfo.ipAddress) {
				return false;
			}
 
			if (blacklistedIPs.includes(peerInfo.ipAddress)) {
				return false;
			}
 
			if (fixedPeers.map(peer => peer.peerId).includes(peerInfo.peerId)) {
				return false;
			}
 
			if (seedPeers.map(peer => peer.peerId).includes(peerInfo.peerId)) {
				return false;
			}
 
			return true;
		})
		.map(peer => {
			const peerInternalInfo = assignInternalInfo(peer, secret);
 
			return {
				...peer,
				internalState: {
					...peerInternalInfo,
					peerKind: PeerKind.WHITELISTED_PEER,
				},
			};
		});
 
	const previousPeers = lists.previousPeers.filter(peerInfo => {
		if (peerInfo.ipAddress === nodeInfo.ipAddress) {
			return false;
		}
 
		if (blacklistedIPs.includes(peerInfo.ipAddress)) {
			return false;
		}
 
		if (fixedPeers.map(peer => peer.peerId).includes(peerInfo.peerId)) {
			return false;
		}
 
		if (seedPeers.map(peer => peer.peerId).includes(peerInfo.peerId)) {
			return false;
		}
 
		Iif (whitelisted.map(peer => peer.peerId).includes(peerInfo.peerId)) {
			return false;
		}
 
		return true;
	});
 
	return {
		blacklistedIPs,
		seedPeers,
		fixedPeers,
		whitelisted,
		previousPeers,
	};
};