npm - @libp2p/bootstrap - Versions diffs - 0.14.0 - Mend

@libp2p/bootstrap 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0

package/README.md ADDED Viewed

@@ -0,0 +1,62 @@
+js-libp2p-bootstrap
+=================
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
+[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
+[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
+[![](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-bootstrap.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-bootstrap)
+[![](https://img.shields.io/travis/libp2p/js-libp2p-bootstrap.svg?style=flat-square)](https://travis-ci.com/libp2p/js-libp2p-bootstrap)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
+![](https://img.shields.io/badge/Node.js-%3E%3D14.0.0-orange.svg?style=flat-square)
+> JavaScript libp2p Implementation of the railing process of a Node through a bootstrap peer list
+## Lead Maintainer
+[Vasco Santos](https://github.com/vasco-santos).
+## Usage
+```JavaScript
+const Libp2p = require('libp2p')
+const Bootstrap = require('libp2p-bootstrap')
+const TCP = require('libp2p-tcp')
+const { NOISE } = require('libp2p-noise')
+const MPLEX = require('libp2p-mplex')
+let options = {
+    modules: {
+        transport: [ TCP ],
+        peerDiscovery: [ Bootstrap ],
+        streamMuxer: [ MPLEX ],
+        encryption: [ NOISE ]
+    },
+    config: {
+        peerDiscovery: {
+            [Bootstrap.tag]: {
+                list: [ // a list of bootstrap peer multiaddrs to connect to on node startup
+                  "/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ",
+                  "/dnsaddr/bootstrap.libp2p.io/ipfs/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN",
+                  "/dnsaddr/bootstrap.libp2p.io/ipfs/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa"
+                  ],
+                  interval: 5000 // default is 10 ms,
+                  enabled: true
+            }
+        }
+    }
+}
+async function start () {
+  let libp2p = await Libp2p.create(options)
+  libp2p.on('peer:discovery', function (peerId) {
+    console.log('found peer: ', peerId.toB58String())
+  })
+  await libp2p.start()
+}
+start()
+```

package/dist/src/index.d.ts ADDED Viewed

@@ -0,0 +1,37 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import type PeerDiscovery from '@libp2p/interfaces/peer-discovery';
+export interface BootstrapOptions {
+    /**
+     * The list of peer addresses in multi-address format
+     */
+    list: string[];
+    /**
+     * The interval between emitting addresses in milliseconds
+     */
+    interval?: number;
+}
+/**
+ * Emits 'peer' events on a regular interval for each peer in the provided list.
+ */
+export declare class Bootstrap extends EventEmitter implements PeerDiscovery {
+    static tag: string;
+    private timer;
+    private readonly list;
+    private readonly interval;
+    constructor(options?: BootstrapOptions);
+    isStarted(): boolean;
+    /**
+     * Start emitting events
+     */
+    start(): void;
+    /**
+     * Emit each address in the list as a PeerInfo
+     */
+    _discoverBootstrapPeers(): void;
+    /**
+     * Stop emitting events
+     */
+    stop(): void;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAErC,OAAO,KAAK,aAAa,MAAM,mCAAmC,CAAA;AAMlE,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,YAAa,YAAW,aAAa;IAClE,MAAM,CAAC,GAAG,SAAc;IAExB,OAAO,CAAC,KAAK,CAAqB;IAClC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAU;IAC/B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;gBAEpB,OAAO,GAAE,gBAA+B;IAWrD,SAAS;IAIT;;OAEG;IACH,KAAK;IAUL;;OAEG;IACH,uBAAuB;IA+BvB;;OAEG;IACH,IAAI;CAIL"}

package/dist/src/index.js ADDED Viewed

@@ -0,0 +1,75 @@
+import { PeerId } from '@libp2p/peer-id';
+import { Multiaddr } from '@multiformats/multiaddr';
+import { P2P } from '@multiformats/mafmt';
+import { EventEmitter } from 'events';
+import debug from 'debug';
+const log = Object.assign(debug('libp2p:bootstrap'), {
+    error: debug('libp2p:bootstrap:error')
+});
+/**
+ * Emits 'peer' events on a regular interval for each peer in the provided list.
+ */
+export class Bootstrap extends EventEmitter {
+    constructor(options = { list: [] }) {
+        if (options.list == null || options.list.length === 0) {
+            throw new Error('Bootstrap requires a list of peer addresses');
+        }
+        super();
+        this.list = options.list;
+        this.interval = options.interval ?? 10000;
+        this.timer = null;
+    }
+    isStarted() {
+        return Boolean(this.timer);
+    }
+    /**
+     * Start emitting events
+     */
+    start() {
+        if (this.timer != null) {
+            return;
+        }
+        this.timer = setInterval(() => this._discoverBootstrapPeers(), this.interval);
+        log('Starting bootstrap node discovery');
+        this._discoverBootstrapPeers();
+    }
+    /**
+     * Emit each address in the list as a PeerInfo
+     */
+    _discoverBootstrapPeers() {
+        if (this.timer == null) {
+            return;
+        }
+        this.list.forEach((candidate) => {
+            if (!P2P.matches(candidate)) {
+                return log.error('Invalid multiaddr');
+            }
+            const ma = new Multiaddr(candidate);
+            const peerIdStr = ma.getPeerId();
+            if (peerIdStr == null) {
+                log.error('Invalid bootstrap multiaddr without peer id');
+                return;
+            }
+            const peerId = PeerId.fromString(peerIdStr);
+            try {
+                this.emit('peer', {
+                    id: peerId,
+                    multiaddrs: [ma]
+                });
+            }
+            catch (err) {
+                log.error('Invalid bootstrap peer id', err);
+            }
+        });
+    }
+    /**
+     * Stop emitting events
+     */
+    stop() {
+        if (this.timer != null)
+            clearInterval(this.timer);
+        this.timer = null;
+    }
+}
+Bootstrap.tag = 'bootstrap';
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAA;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AACrC,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE;IACnD,KAAK,EAAE,KAAK,CAAC,wBAAwB,CAAC;CACvC,CAAC,CAAA;AAcF;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,YAAY;IAOzC,YAAa,UAA4B,EAAE,IAAI,EAAE,EAAE,EAAE;QACnD,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACrD,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;SAC/D;QACD,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;QACxB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAA;QACzC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACnB,CAAC;IAED,SAAS;QACP,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC5B,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;YACtB,OAAM;SACP;QAED,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC7E,GAAG,CAAC,mCAAmC,CAAC,CAAA;QACxC,IAAI,CAAC,uBAAuB,EAAE,CAAA;IAChC,CAAC;IAED;;OAEG;IACH,uBAAuB;QACrB,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;YACtB,OAAM;SACP;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC9B,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;gBAC3B,OAAO,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;aACtC;YAED,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,SAAS,CAAC,CAAA;YACnC,MAAM,SAAS,GAAG,EAAE,CAAC,SAAS,EAAE,CAAA;YAEhC,IAAI,SAAS,IAAI,IAAI,EAAE;gBACrB,GAAG,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAA;gBACxD,OAAM;aACP;YAED,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;YAE3C,IAAI;gBACF,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;oBAChB,EAAE,EAAE,MAAM;oBACV,UAAU,EAAE,CAAC,EAAE,CAAC;iBACjB,CAAC,CAAA;aACH;YAAC,OAAO,GAAG,EAAE;gBACZ,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;aAC5C;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI;YAAE,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACnB,CAAC;;AA1EM,aAAG,GAAG,WAAW,CAAA"}

package/package.json ADDED Viewed

@@ -0,0 +1,147 @@
+{
+  "name": "@libp2p/bootstrap",
+  "version": "0.14.0",
+  "description": "Node.js IPFS Implementation of the railing process of a Node through a bootstrap peer list",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/libp2p/js-libp2p-bootstrap#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/libp2p/js-libp2p-bootstrap.git"
+  },
+  "bugs": {
+    "url": "https://github.com/libp2p/js-libp2p-bootstrap/issues"
+  },
+  "keywords": [
+    "IPFS"
+  ],
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "src",
+    "dist/src",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/src/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "chore",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
+  "scripts": {
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check",
+    "build": "tsc",
+    "pretest": "npm run build",
+    "test": "aegir test -f ./dist/test",
+    "test:chrome": "npm run test -- -t browser --cov",
+    "test:chrome-webworker": "npm run test -- -t webworker",
+    "test:firefox": "npm run test -- -t browser -- --browser firefox",
+    "test:firefox-webworker": "npm run test -- -t webworker -- --browser firefox",
+    "test:node": "npm run test -- -t node --cov",
+    "test:electron-main": "npm run test -- -t electron-main",
+    "release": "semantic-release"
+  },
+  "dependencies": {
+    "@libp2p/peer-id": "^1.0.4",
+    "@multiformats/mafmt": "^11.0.2",
+    "@multiformats/multiaddr": "^10.1.2",
+    "debug": "^4.3.1"
+  },
+  "devDependencies": {
+    "@libp2p/interface-compliance-tests": "^1.0.8",
+    "@libp2p/interfaces": "^1.1.1",
+    "@types/debug": "^4.1.5",
+    "aegir": "^36.1.3"
+  }
+}

package/src/index.ts ADDED Viewed

@@ -0,0 +1,103 @@
+import { PeerId } from '@libp2p/peer-id'
+import { Multiaddr } from '@multiformats/multiaddr'
+import { P2P } from '@multiformats/mafmt'
+import { EventEmitter } from 'events'
+import debug from 'debug'
+import type PeerDiscovery from '@libp2p/interfaces/peer-discovery'
+const log = Object.assign(debug('libp2p:bootstrap'), {
+  error: debug('libp2p:bootstrap:error')
+})
+export interface BootstrapOptions {
+  /**
+   * The list of peer addresses in multi-address format
+   */
+  list: string[]
+  /**
+   * The interval between emitting addresses in milliseconds
+   */
+  interval?: number
+}
+/**
+ * Emits 'peer' events on a regular interval for each peer in the provided list.
+ */
+export class Bootstrap extends EventEmitter implements PeerDiscovery {
+  static tag = 'bootstrap'
+  private timer: NodeJS.Timer | null
+  private readonly list: string[]
+  private readonly interval: number
+  constructor (options: BootstrapOptions = { list: [] }) {
+    if (options.list == null || options.list.length === 0) {
+      throw new Error('Bootstrap requires a list of peer addresses')
+    }
+    super()
+    this.list = options.list
+    this.interval = options.interval ?? 10000
+    this.timer = null
+  }
+  isStarted () {
+    return Boolean(this.timer)
+  }
+  /**
+   * Start emitting events
+   */
+  start () {
+    if (this.timer != null) {
+      return
+    }
+    this.timer = setInterval(() => this._discoverBootstrapPeers(), this.interval)
+    log('Starting bootstrap node discovery')
+    this._discoverBootstrapPeers()
+  }
+  /**
+   * Emit each address in the list as a PeerInfo
+   */
+  _discoverBootstrapPeers () {
+    if (this.timer == null) {
+      return
+    }
+    this.list.forEach((candidate) => {
+      if (!P2P.matches(candidate)) {
+        return log.error('Invalid multiaddr')
+      }
+      const ma = new Multiaddr(candidate)
+      const peerIdStr = ma.getPeerId()
+      if (peerIdStr == null) {
+        log.error('Invalid bootstrap multiaddr without peer id')
+        return
+      }
+      const peerId = PeerId.fromString(peerIdStr)
+      try {
+        this.emit('peer', {
+          id: peerId,
+          multiaddrs: [ma]
+        })
+      } catch (err) {
+        log.error('Invalid bootstrap peer id', err)
+      }
+    })
+  }
+  /**
+   * Stop emitting events
+   */
+  stop () {
+    if (this.timer != null) clearInterval(this.timer)
+    this.timer = null
+  }
+}