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 | import { noise } from '@chainsafe/libp2p-noise';
import { yamux } from '@chainsafe/libp2p-yamux';
import { autoNAT } from '@libp2p/autonat';
import { circuitRelayServer } from '@libp2p/circuit-relay-v2';
import { generateKeyPairFromSeed } from '@libp2p/crypto/keys';
import { identify } from '@libp2p/identify';
import type { Libp2p, PeerId, PrivateKey } from '@libp2p/interface';
import { ping } from '@libp2p/ping';
import { tcp } from '@libp2p/tcp';
import { webSockets } from '@libp2p/websockets';
import type { Multiaddr } from '@multiformats/multiaddr';
import { createLibp2p } from 'libp2p';
/**
* Fixed local ID for the relay server.
* This ensures the relay server always has the same PeerID across restarts,
* making it easier for clients to connect to a known relay address.
* The ID must be between 1-255 to generate a deterministic keypair.
*/
const RELAY_LOCAL_ID = 200;
/**
* A minimal logger interface for relay events.
*/
type RelayLogger = {
log: (message: string, ...args: unknown[]) => void;
};
/**
* Start the relay server.
*
* @param logger - The logger to use.
* @param options - Optional configuration.
* @param options.publicIp - Public IPv4 address that the relay should
* announce in addition to whatever libp2p auto-detects from local
* interfaces. Use on hosts (e.g., NAT-backed VPSes) where the public
* address is not bound to a local NIC and would otherwise be missing
* from `getMultiaddrs()`.
* @returns The libp2p instance.
*/
export async function startRelay(
logger: RelayLogger,
options: { publicIp?: string } = {},
): Promise<Libp2p> {
const tersePeers = new Map<string, string>();
let tersePeerIdx = 0;
const activePeers = new Set<string>();
const privateKey = await generateKeyPair(RELAY_LOCAL_ID);
const appendAnnounce = options.publicIp
? [
`/ip4/${options.publicIp}/tcp/9001/ws`,
`/ip4/${options.publicIp}/tcp/9002`,
]
: [];
const libp2p = await createLibp2p({
privateKey,
addresses: {
listen: [
'/ip4/0.0.0.0/tcp/9001/ws', // WebSocket for browser connections
'/ip4/0.0.0.0/tcp/9002', // TCP for server-to-server
],
appendAnnounce,
},
transports: [
webSockets(), // Required for browser connections
tcp(), // Optional for server connections
],
connectionEncrypters: [noise()],
streamMuxers: [yamux()],
connectionGater: {
// Allow private addresses for local testing
denyDialMultiaddr: async () => false,
},
services: {
identify: identify(),
ping: ping(),
autoNat: autoNAT(),
relay: circuitRelayServer({
// Allow unlimited reservations for testing
reservations: {
maxReservations: Infinity,
applyDefaultLimit: false,
},
// Reduce hop timeout to clean up stale connections faster
hopTimeout: 10 * 1000, // 10 seconds instead of default 30
}),
},
});
/**
* Produce a more legible peer ID string.
*
* @param peer - The peer ID we care about, either as a `PeerId` object
* (e.g. `connection.remotePeer`) or as the bare string form extracted
* from a multiaddr.
* @returns a terser form of `peer`.
*/
function tersePeer(peer: PeerId | string): string {
const peerId = typeof peer === 'string' ? peer : peer.toString();
if (tersePeers.has(peerId)) {
return tersePeers.get(peerId) as string;
}
tersePeerIdx += 1;
const terse = `<PEER-${tersePeerIdx}>`;
tersePeers.set(peerId, terse);
logger.log(`[PEER] ${terse} = ${peerId}`);
return terse;
}
/**
* Produce a more legible multiaddr string.
*
* @param multiaddr - The multiaddr we care about.
* @returns a terser form of `multiaddr`.
*/
function terseAddr(multiaddr: Multiaddr): string {
const raw = multiaddr.toString();
const slash = raw.lastIndexOf('/') + 1;
if (slash <= 0) {
return raw;
}
const prefix = raw.substring(0, slash);
const suffix = raw.substring(slash);
return `${prefix}${tersePeer(suffix)}`;
}
/**
*
*/
function dumpPeers(): void {
logger.log(`[ACTIVE] [${Array.from(activePeers.values()).join(' ')}]`);
}
// Set up connection event listeners for logging
libp2p.addEventListener('connection:open', (evt) => {
const connection = evt.detail;
const peer = tersePeer(connection.remotePeer);
activePeers.add(peer);
/*
logger.log(`[CONNECTION] New connection from ${peer}`);
logger.log(` Remote addr: ${terseAddr(connection.remoteAddr)}`);
logger.log(` Direction: ${connection.direction}`);
logger.log(` Status: ${connection.status}`);
*/
logger.log(
`[CONNECTION] New connection from ${terseAddr(connection.remoteAddr)}`,
);
dumpPeers();
});
libp2p.addEventListener('connection:close', (evt) => {
const connection = evt.detail;
const peer = tersePeer(connection.remotePeer);
logger.log(`[CONNECTION] Closed connection with ${peer}`);
activePeers.delete(peer);
dumpPeers();
});
/*
// Log peer discovery events
libp2p.addEventListener('peer:discovery', (evt) => {
const peerInfo = evt.detail;
logger.log(`[DISCOVERY] Found peer ${tersePeer(peerInfo.id)}`);
});
// Log circuit relay specific events
if (libp2p.services.relay) {
// Log when a reservation is made
libp2p.addEventListener('peer:connect', (evt) => {
const peerId = evt.detail;
logger.log(`[RELAY] Peer connected: ${tersePeer(peerId)}`);
});
libp2p.addEventListener('peer:disconnect', (evt) => {
const peerId = evt.detail;
logger.log(`[RELAY] Peer disconnected: ${tersePeer(peerId)}`);
});
}
*/
await new Promise<void>((resolve) => {
if (libp2p.status === 'started') {
resolve();
} else {
libp2p.addEventListener('start', () => resolve());
}
});
logger.log('========================================');
logger.log('Relay Server Started');
logger.log('PeerID: ', libp2p.peerId.toString());
logger.log('Multiaddrs: ', libp2p.getMultiaddrs());
logger.log('========================================');
return libp2p;
}
/**
* Generate the private key for a given localID.
*
* @param localId - The localID whose peerID is sought.
*
* @returns the private key for `localID`.
*/
async function generateKeyPair(
localId: number | undefined,
): Promise<PrivateKey> {
let seed;
// eslint-disable-next-line no-negated-condition
if (localId !== undefined) {
if (localId < 1 || localId > 255) {
throw new Error(`localId must be a Uint8 1<=255. Received: ${localId}`);
}
seed = new Uint8Array(32);
seed[0] = localId;
} else {
// eslint-disable-next-line n/no-unsupported-features/node-builtins
seed = globalThis.crypto.getRandomValues(new Uint8Array(32));
}
return await generateKeyPairFromSeed('Ed25519', seed);
}
|