hive-p2p 1.0.6 → 1.0.8

package/core/crypto-codex.mjs

@@ -14,7 +14,8 @@ export class CryptoCodex {
     /** @type {Uint8Array} */ privateKey;
 
 	/** @param {string} [nodeId] If provided: used to generate a fake keypair > disable crypto operations */
-	constructor(nodeId) {
+	constructor(nodeId, verbose = NODE.DEFAULT_VERBOSE) {
+		this.verbose = verbose;
 		if (!nodeId) return; // IF NOT PROVIDED: generate() should be called.
 		this.AVOID_CRYPTO = true;
 		this.id = nodeId.padEnd(IDENTITY.ID_LENGTH, ' ').slice(0, IDENTITY.ID_LENGTH);
@@ -23,6 +24,13 @@ export class CryptoCodex {
 		for (let i = 0; i < IDENTITY.ID_LENGTH; i++) this.publicKey[i] = idBytes[i];
 	}
 
+	/** @param {boolean} asPublicNode Default: false @param {Uint8Array} seed PrivateKey *-optional* */
+	static async createCryptoCodex(asPublicNode, seed) {
+		const cryptoCodex = new CryptoCodex(undefined, this.verbose);
+		await cryptoCodex.generate(asPublicNode, seed);
+		return cryptoCodex;
+	}
+
 	// IDENTITY
 	/** @param {string} id Check the first character against the PUBLIC_PREFIX */
 	static isPublicNode(id) { return (IDENTITY.ARE_IDS_HEX ? Converter.hexToBits(id[0]) : id).startsWith(IDENTITY.PUBLIC_PREFIX); }

package/core/ice-offer-manager.mjs

@@ -84,7 +84,8 @@ export class OfferManager { // Manages the creation of SDP offers and handling o
 		this.offerInstanceByExpiration[expiration] = instance;
 	};
 	#createOffererInstance(expiration) {
-		const instance = new TRANSPORTS.PEER({ initiator: true, trickle: false, wrtc, config: { iceServers: this.stunUrls } });
+		const iceCompleteTimeout = TRANSPORTS.ICE_COMPLETE_TIMEOUT || 1_000;
+		const instance = new TRANSPORTS.PEER({ initiator: true, trickle: false, iceCompleteTimeout, wrtc, config: { iceServers: this.stunUrls } });
 		instance.on('error', error => this.#onError(error));
 		instance.on('signal', data => { // trickle: false => only one signal event with the full offer
 			const { candidate, type } = data; // with trickle, we need to adapt the approach.
@@ -158,7 +159,8 @@ export class OfferManager { // Manages the creation of SDP offers and handling o
 			}
 			
 			// type === 'offer' => CREATE ANSWERER INSTANCE
-			const instance = new TRANSPORTS.PEER({ initiator: false, trickle: false, wrtc, config: { iceServers: this.stunUrls } });
+			const iceCompleteTimeout = TRANSPORTS.ICE_COMPLETE_TIMEOUT || 1_000;
+			const instance = new TRANSPORTS.PEER({ initiator: false, trickle: false, iceCompleteTimeout, wrtc, config: { iceServers: this.stunUrls } });
 			instance.on('error', (error) => this.#onError(error));
 			instance.on('signal', (data) => this.onSignalAnswer(remoteId, data, offerHash));
 			instance.on('connect', () => this.onConnect(remoteId, instance));

package/core/node-services.mjs

@@ -73,7 +73,7 @@ export class NodeServices {
 	#startSTUNServer(host = 'localhost', port = NODE.SERVICE.PORT + 1) {
 		this.stunServer = dgram.createSocket('udp4');
 		this.stunServer.on('message', (msg, rinfo) => {
-			if (this.verbose > 1) console.log(`%cSTUN message from ${rinfo.address}:${rinfo.port} - ${msg.toString('hex')}`, 'color: blue;');
+			if (this.verbose > 2) console.log(`%cSTUN message from ${rinfo.address}:${rinfo.port} - ${msg.toString('hex')}`, 'color: blue;');
 			if (!this.#isValidSTUNRequest(msg)) return;
 			this.stunServer.send(this.#buildSTUNResponse(msg, rinfo), rinfo.port, rinfo.address);
 		});
@@ -102,7 +102,7 @@ export class NodeServices {
 		response.writeUInt16BE(rinfo.port, 26); // Port
 		response.writeUInt32BE(Converter.ipToInt(rinfo.address), 28); // IP
 		
-		if (this.verbose > 1) console.log(`%cSTUN Response: client will discover IP ${rinfo.address}:${rinfo.port}`, 'color: green;');
+		if (this.verbose > 2) console.log(`%cSTUN Response: client will discover IP ${rinfo.address}:${rinfo.port}`, 'color: green;');
 		return response;
 	}
 	/** @param {Array<{id: string, publicUrl: string}>} bootstraps */

package/core/node.mjs

@@ -8,6 +8,46 @@ import { Topologist } from './topologist.mjs';
 import { CryptoCodex } from './crypto-codex.mjs';
 import { NodeServices } from './node-services.mjs';
 
+/** Create and start a new PublicNodeP2P instance.
+ * @param {Object} options
+ * @param {Array<{id: string, publicUrl: string}>} options.bootstraps List of bootstrap nodes used as P2P network entry
+ * @param {boolean} [options.autoStart] If true, the node will automatically start after creation (default: true)
+ * @param {CryptoCodex} [options.cryptoCodex] Identity of the node; if not provided, a new one will be generated
+ * @param {string} [options.domain] If provided, the node will operate as a public node and start necessary services (e.g., WebSocket server)
+ * @param {number} [options.port] If provided, the node will listen on this port (default: NODE.SERVICE.PORT)
+ * @param {number} [options.verbose] Verbosity level for logging (default: NODE.DEFAULT_VERBOSE) */
+export async function createPublicNode(options) {		
+	const verbose = options.verbose !== undefined ? options.verbose : NODE.DEFAULT_VERBOSE;
+	const domain = options.domain || undefined;
+	const codex = options.cryptoCodex || new CryptoCodex(undefined, verbose);
+	if (!codex.publicKey) await codex.generate(domain ? true : false);
+	
+	const node = new NodeP2P(codex, options.bootstraps || [], verbose);
+	if (domain) {
+		node.services = new NodeServices(codex, node.peerStore, undefined, verbose);
+		node.services.start(domain, options.port || NODE.SERVICE.PORT);
+		node.topologist.services = node.services;
+	}
+	if (options.autoStart !== false) await node.start();
+	return node;
+}
+
+/** Create and start a new NodeP2P instance.
+ * @param {Object} options
+ * @param {Array<{id: string, publicUrl: string}>} options.bootstraps List of bootstrap nodes used as P2P network entry
+ * @param {CryptoCodex} [options.cryptoCodex] Identity of the node; if not provided, a new one will be generated
+ * @param {boolean} [options.autoStart] If true, the node will automatically start after creation (default: true)
+ * @param {number} [options.verbose] Verbosity level for logging (default: NODE.DEFAULT_VERBOSE) */
+export async function createNode(options = {}) {
+	const verbose = options.verbose !== undefined ? options.verbose : NODE.DEFAULT_VERBOSE;
+	const codex = options.cryptoCodex || new CryptoCodex(undefined, verbose);
+	if (!codex.publicKey) await codex.generate(false);
+
+	const node = new NodeP2P(codex, options.bootstraps || [], verbose);
+	if (options.autoStart !== false) await node.start();
+	return node;
+}
+
 export class NodeP2P {
 	started = false;
 	id; cryptoCodex; verbose; arbiter;
@@ -23,15 +63,16 @@ export class NodeP2P {
 	 * @param {Array<Record<string, string>>} bootstraps List of bootstrap nodes used as P2P network entry */
 	constructor(cryptoCodex, bootstraps = [], verbose = NODE.DEFAULT_VERBOSE) {
 		this.verbose = verbose;
+		if (this.topologist?.services) this.topologist.services.verbose = verbose;
 		this.cryptoCodex = cryptoCodex;
 		this.id = this.cryptoCodex.id;
-		const stunUrls = NodeServices.deriveSTUNServers(bootstraps);
+		const stunUrls = NodeServices.deriveSTUNServers(bootstraps || []);
 		this.offerManager = new OfferManager(this.id, stunUrls, verbose);
 		this.arbiter = new Arbiter(this.id, cryptoCodex, verbose);
 		this.peerStore = new PeerStore(this.id, this.cryptoCodex, this.offerManager, this.arbiter, verbose);
 		this.messager = new UnicastMessager(this.id, this.cryptoCodex, this.arbiter, this.peerStore, verbose);
 		this.gossip = new Gossip(this.id, this.cryptoCodex, this.arbiter, this.peerStore, verbose);
-		this.topologist = new Topologist(this.id, this.gossip, this.messager, this.peerStore, bootstraps);
+		this.topologist = new Topologist(this.id, this.gossip, this.messager, this.peerStore, bootstraps || []);
 		const { arbiter, peerStore, messager, gossip, topologist } = this;
 
 		// SETUP TRANSPORTS LISTENERS
@@ -95,21 +136,11 @@ export class NodeP2P {
 
 	// PUBLIC API
 	get publicUrl() { return this.services?.publicUrl; }
+	get publicIdentity() { return { id: this.id, publicUrl: this.publicUrl }; }
 
-	/** @param {Array<string>} bootstraps @param {CryptoCodex} [cryptoCodex] - Identity of the node; if not provided, a new one will be generated @param {boolean} [start] default: false @param {string} [domain] public node only, ex: 'localhost' @param {number} [port] public node only, ex: 8080 */
-	static async createNode(bootstraps, cryptoCodex, start = true, domain, port = NODE.SERVICE.PORT, verbose = NODE.DEFAULT_VERBOSE) {
-		const codex = cryptoCodex || new CryptoCodex();
-		if (!codex.publicKey) await codex.generate(domain ? true : false);
-
-		const node = new NodeP2P(codex, bootstraps, verbose);
-		if (domain) {
-			node.services = new NodeServices(codex, node.peerStore, undefined, verbose);
-			node.services.start(domain, port);
-			node.topologist.services = node.services;
-		}
-		if (start) await node.start();
-		return node;
-	}
+	onMessageData(callback) { this.messager.on('message', callback); }
+	onGossipData(callback) { this.gossip.on('gossip', callback); }
+	
 	async start() {
 		await CLOCK.sync(this.verbose);
 		this.started = true;

package/core/parameters.mjs

@@ -9,7 +9,7 @@ export const CLOCK = Clock.instance;
 export const SIMULATION = {
 	// FACILITIES TO SIMULATE NETWORK CONDITIONS AND SCENARIOS
 	AVOID_INTERVALS: false,			// avoid intervals for faster simulation | default: true
-	USE_TEST_TRANSPORTS: true, 		// enable simulation features
+	USE_TEST_TRANSPORTS: false, 		// enable simulation features
 	ICE_DELAY: { min: 250, max: 3000 }, // ICE candidates in ms | default: { min: 250, max: 3000 }
 	ICE_OFFER_FAILURE_RATE: .2, 	// default: .2, 20% offer failure
 	ICE_ANSWER_FAILURE_RATE: .15, 	// default: .15, 15% answer failure
@@ -40,7 +40,7 @@ export const NODE = {
 export const IDENTITY = {
 	DIFFICULTY: 0,					// number of leading CATEGORY_PREFIX in bits for anti-sybil | default: 0(disabled) | RECOMMENDED: 7 | ON APPLY IF ARE_IDS_HEX = TRUE
 	ARGON2_MEM: 2**17,				// Memory usage in KiB for Argon2 | default: 2**16 = 65_536 (64 MiB) | RECOMMENDED: 2**17 = 131_072 (128 MiB) | ON APPLY IF ARE_IDS_HEX = TRUE
-	ARE_IDS_HEX: false,				// Boolean to indicate if we use hex ids, default: true = hex | false = strings as Bytes (can involve in serialization failures)
+	ARE_IDS_HEX: true,				// Boolean to indicate if we use hex ids, default: true = hex | false = strings as Bytes (can involve in serialization failures)
 	PUBLIC_PREFIX: '0', 			// Identifier prefix for public nodes | default: '0'
 	STANDARD_PREFIX: '1', 			// Identifier prefix for standard nodes | default: '1'
 	ID_LENGTH: 16,					// !!EVEN NUMBER ONLY!! length of peer id | default: 16
@@ -50,7 +50,8 @@ export const IDENTITY = {
 }
 
 export const TRANSPORTS = {
-	MAX_SDP_OFFERS: 3, 				// max SDP offers to create in advance | default: 3
+	MAX_SDP_OFFERS: 2, 				// max SDP offers to create in advance | default: 3
+	ICE_COMPLETE_TIMEOUT: 1_000, 	// time to wait for ICE gathering to complete | default: 1_000 (1 second)
 	SIGNAL_CREATION_TIMEOUT: 8_000, // time to wait for signal before destroying WTRC connection | default: 8_000 (8 seconds) | note: SimplePeer have a internal timeout of 5 secondes, we should be above that
 	SDP_OFFER_EXPIRATION: 40_000, 	// duration to consider an SDP offer as valid | default: 40_000 (40 seconds)
 	WS_CLIENT: WebSocket,			// Simulation: patched with TestWsConnection (this one can be used as a server too)

package/index.mjs

@@ -1,3 +1,7 @@
-export { NodeP2P } from './core/node.mjs';
-export { CryptoCodex } from './core/crypto-codex.mjs';
-export { default as PARAMETERS } from './core/parameters.mjs';
+import { NodeP2P, createNode, createPublicNode } from "./core/node.mjs";
+import { CryptoCodex } from "./core/crypto-codex.mjs";
+import PARAMETERS from "./core/parameters.mjs";
+
+const HiveP2P = { NodeP2P, createNode, createPublicNode, CryptoCodex, PARAMETERS };
+export { NodeP2P, createNode, createPublicNode, CryptoCodex, PARAMETERS };
+export default HiveP2P;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hive-p2p",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "P2P networking library for browser and Node.js with WebRTC",
   "type": "module",
   "main": "./index.mjs",