@savid/libp2p-peeper

Discover libp2p peers with the Node Discovery Protocol v5.

This package is adapted from the @chainsafe/discv5 project.

Requirements

• NodeJS v18+
• ESM only

Install

1npm install --save @savid/libp2p-peeper

Usage

Add bootnodes to begin;

1import peeper from '@savid/libp2p-peeper';
2
3const bootnodes = [
4  'enr:-Iq4QMCTfIMXnow27baRUb35Q8iiFHSIDBJh6hQM5Axohhf4b6Kr_cOCu0htQ5WvVqKvFgY28893DHAg8gnBAXsAVqmGAX53x8JggmlkgnY0gmlwhLKAlv6Jc2VjcDI1NmsxoQK6S-Cii_KmfFdUJL2TANL3ksaKUnNXvTCv1tLwXs0QgIN1ZHCCIyk',
5];
6
7try {
8  for await (const { error, enr } of peeper({ bootnodes })) {
9    if (error) throw error;
10    // https://ethereum.org/en/developers/docs/networking-layer/network-addresses/#enr
11    if (enr) console.log(enr);
12  }
13} catch (error) {
14  console.error(error);
15}

API

1async function* peeper(options: {
2  // list of EIP-778: Ethereum Node Records (ENR) bootnodes
3  bootnodes: string[];
4  // min number of candidate peers to retrieve from DNS records when attempting to discover new nodes
5  minConnections?: number;
6  // max number of candidate peers to retrieve from DNS records when attempting to discover new nodes
7  maxConnections?: number;
8}): AsyncGenerator<{
9  enr?: string | undefined;
10  error?: Error | undefined;
11}>;

License

MIT