@libp2p/bootstrap 2.0.0 → 3.0.0

package/README.md

@@ -14,7 +14,7 @@
 - [Usage](#usage)
 - [Contribute](#contribute)
 - [License](#license)
-- [Contribution](#contribution)
+- [Contribute](#contribute-1)
 
 ## Install
 
@@ -24,37 +24,49 @@ $ npm i @libp2p/bootstrap
 
 ## Usage
 
+The configured bootstrap peers will be discovered after the configured timeout. This will ensure
+there are some peers in the peer store for the node to use to discover other peers.
+
+They will be tagged with a tag with the name `'bootstrap'` tag, the value `50` and it will expire
+after two minutes which means the nodes connections may be closed if the maximum number of
+connections is reached.
+
+Clients that need constant connections to bootstrap nodes (e.g. browsers) can set the TTL to `Infinity`.
+
 ```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')
+import { createLibp2p } from 'libp2p'
+import { Bootstrap } from '@libp2p/bootstrap'
+import { TCP } from 'libp2p/tcp'
+import { Noise } from '@libp2p/noise'
+import { Mplex } from '@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
-            }
-        }
-    }
+  transports: [
+    new TCP()
+  ],
+  streamMuxers: [
+    new Mplex()
+  ],
+  connectionEncryption: [
+    new Noise()
+  ],
+  peerDiscovery: [
+    new Bootstrap({
+      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"
+      ],
+      timeout: 1000, // in ms,
+      tagName: 'bootstrap',
+      tagValue: 50,
+      tagTTL: 120000 // in ms
+    })
+  ]
 }
 
 async function start () {
-  let libp2p = await Libp2p.create(options)
+  let libp2p = await createLibp2p(options)
 
   libp2p.on('peer:discovery', function (peerId) {
     console.log('found peer: ', peerId.toB58String())
@@ -81,6 +93,6 @@ Licensed under either of
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribution
+## Contribute
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

package/dist/src/index.d.ts

@@ -1,25 +1,41 @@
 import { EventEmitter } from '@libp2p/interfaces/events';
 import type { PeerDiscovery, PeerDiscoveryEvents } from '@libp2p/interface-peer-discovery';
 import { symbol } from '@libp2p/interface-peer-discovery';
+import { Components, Initializable } from '@libp2p/components';
 export interface BootstrapOptions {
     /**
      * The list of peer addresses in multi-address format
      */
     list: string[];
     /**
-     * The interval between emitting addresses in milliseconds
+     * How long to wait before discovering bootstrap nodes
      */
-    interval?: number;
+    timeout?: number;
+    /**
+     * Tag a bootstrap peer with this name before "discovering" it (default: 'bootstrap')
+     */
+    tagName?: string;
+    /**
+     * The bootstrap peer tag will have this value (default: 50)
+     */
+    tagValue?: number;
+    /**
+     * Cause the bootstrap peer tag to be removed after this number of ms (default: 2 minutes)
+     */
+    tagTTL?: number;
 }
 /**
  * Emits 'peer' events on a regular interval for each peer in the provided list.
  */
-export declare class Bootstrap extends EventEmitter<PeerDiscoveryEvents> implements PeerDiscovery {
+export declare class Bootstrap extends EventEmitter<PeerDiscoveryEvents> implements PeerDiscovery, Initializable {
     static tag: string;
     private timer?;
     private readonly list;
-    private readonly interval;
+    private readonly timeout;
+    private components;
+    private readonly _init;
     constructor(options?: BootstrapOptions);
+    init(components: Components): void;
     get [symbol](): true;
     get [Symbol.toStringTag](): string;
     isStarted(): boolean;
@@ -30,7 +46,7 @@ export declare class Bootstrap extends EventEmitter<PeerDiscoveryEvents> impleme
     /**
      * Emit each address in the list as a PeerInfo
      */
-    _discoverBootstrapPeers(): void;
+    _discoverBootstrapPeers(): Promise<void>;
     /**
      * Stop emitting events
      */

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAe,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAErE,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAA;AAG1F,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AAIzD,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,YAAY,CAAC,mBAAmB,CAAE,YAAW,aAAa;IACvF,MAAM,CAAC,GAAG,SAAc;IAExB,OAAO,CAAC,KAAK,CAAC,CAAgC;IAC9C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAY;IACjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;gBAEpB,OAAO,GAAE,gBAA+B;IAiCrD,IAAI,CAAC,MAAM,CAAC,IAAK,IAAI,CAEpB;IAED,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,WAEvB;IAED,SAAS;IAIT;;OAEG;IACH,KAAK;IAUL;;OAEG;IACH,uBAAuB;IAUvB;;OAEG;IACH,IAAI;CAOL"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAe,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAErE,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAA;AAG1F,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAS9D,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAA;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,YAAY,CAAC,mBAAmB,CAAE,YAAW,aAAa,EAAE,aAAa;IACtG,MAAM,CAAC,GAAG,SAAc;IAExB,OAAO,CAAC,KAAK,CAAC,CAA+B;IAC7C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAY;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAQ;IAChC,OAAO,CAAC,UAAU,CAA+B;IACjD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAkB;gBAE3B,OAAO,GAAE,gBAA+B;IAmCrD,IAAI,CAAE,UAAU,EAAE,UAAU;IAI5B,IAAI,CAAC,MAAM,CAAC,IAAK,IAAI,CAEpB;IAED,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,WAEvB;IAED,SAAS;IAIT;;OAEG;IACH,KAAK;IAcL;;OAEG;IACG,uBAAuB;IAoB7B;;OAEG;IACH,IAAI;CAOL"}

package/dist/src/index.js

@@ -1,10 +1,15 @@
-import { Multiaddr } from '@multiformats/multiaddr';
+import { multiaddr } from '@multiformats/multiaddr';
 import { P2P } from '@multiformats/mafmt';
 import { CustomEvent, EventEmitter } from '@libp2p/interfaces/events';
 import { logger } from '@libp2p/logger';
 import { peerIdFromString } from '@libp2p/peer-id';
 import { symbol } from '@libp2p/interface-peer-discovery';
+import { Components } from '@libp2p/components';
 const log = logger('libp2p:bootstrap');
+const DEFAULT_BOOTSTRAP_TAG_NAME = 'bootstrap';
+const DEFAULT_BOOTSTRAP_TAG_VALUE = 50;
+const DEFAULT_BOOTSTRAP_TAG_TTL = 120000;
+const DEFAULT_BOOTSTRAP_DISCOVERY_TIMEOUT = 1000;
 /**
  * Emits 'peer' events on a regular interval for each peer in the provided list.
  */
@@ -14,14 +19,15 @@ export class Bootstrap extends EventEmitter {
             throw new Error('Bootstrap requires a list of peer addresses');
         }
         super();
-        this.interval = options.interval ?? 10000;
+        this.components = new Components();
+        this.timeout = options.timeout ?? DEFAULT_BOOTSTRAP_DISCOVERY_TIMEOUT;
         this.list = [];
         for (const candidate of options.list) {
             if (!P2P.matches(candidate)) {
                 log.error('Invalid multiaddr');
                 continue;
             }
-            const ma = new Multiaddr(candidate);
+            const ma = multiaddr(candidate);
             const peerIdStr = ma.getPeerId();
             if (peerIdStr == null) {
                 log.error('Invalid bootstrap multiaddr without peer id');
@@ -34,6 +40,10 @@ export class Bootstrap extends EventEmitter {
             };
             this.list.push(peerData);
         }
+        this._init = options;
+    }
+    init(components) {
+        this.components = components;
     }
     get [symbol]() {
         return true;
@@ -48,30 +58,42 @@ export class Bootstrap extends EventEmitter {
      * Start emitting events
      */
     start() {
-        if (this.timer != null) {
+        if (this.isStarted()) {
             return;
         }
-        this.timer = setInterval(() => this._discoverBootstrapPeers(), this.interval);
-        log('Starting bootstrap node discovery');
-        this._discoverBootstrapPeers();
+        log('Starting bootstrap node discovery, discovering peers after %s ms', this.timeout);
+        this.timer = setTimeout(() => {
+            void this._discoverBootstrapPeers()
+                .catch(err => {
+                log.error(err);
+            });
+        }, this.timeout);
     }
     /**
      * Emit each address in the list as a PeerInfo
      */
-    _discoverBootstrapPeers() {
+    async _discoverBootstrapPeers() {
         if (this.timer == null) {
             return;
         }
-        this.list.forEach((peerData) => {
+        for (const peerData of this.list) {
+            await this.components.getPeerStore().tagPeer(peerData.id, this._init.tagName ?? DEFAULT_BOOTSTRAP_TAG_NAME, {
+                value: this._init.tagValue ?? DEFAULT_BOOTSTRAP_TAG_VALUE,
+                ttl: this._init.tagTTL ?? DEFAULT_BOOTSTRAP_TAG_TTL
+            });
+            // check we are still running
+            if (this.timer == null) {
+                return;
+            }
             this.dispatchEvent(new CustomEvent('peer', { detail: peerData }));
-        });
+        }
     }
     /**
      * Stop emitting events
      */
     stop() {
         if (this.timer != null) {
-            clearInterval(this.timer);
+            clearTimeout(this.timer);
         }
         this.timer = undefined;
     }

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAGvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AAEzD,MAAM,GAAG,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAA;AActC;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,YAAiC;IAO9D,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,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAA;QACzC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QAEd,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,IAAI,EAAE;YACpC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;gBAC3B,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;gBAC9B,SAAQ;aACT;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,SAAQ;aACT;YAED,MAAM,QAAQ,GAAa;gBACzB,EAAE,EAAE,gBAAgB,CAAC,SAAS,CAAC;gBAC/B,UAAU,EAAE,CAAC,EAAE,CAAC;gBAChB,SAAS,EAAE,EAAE;aACd,CAAA;YAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;SACzB;IACH,CAAC;IAED,IAAI,CAAC,MAAM,CAAC;QACV,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACtB,OAAO,mBAAmB,CAAA;IAC5B,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,QAAQ,EAAE,EAAE;YAC7B,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAW,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAA;QAC7E,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;YACtB,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SAC1B;QAED,IAAI,CAAC,KAAK,GAAG,SAAS,CAAA;IACxB,CAAC;;AAtFM,aAAG,GAAG,WAAW,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACnD,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAGvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AACzD,OAAO,EAAE,UAAU,EAAiB,MAAM,oBAAoB,CAAA;AAE9D,MAAM,GAAG,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAA;AAEtC,MAAM,0BAA0B,GAAG,WAAW,CAAA;AAC9C,MAAM,2BAA2B,GAAG,EAAE,CAAA;AACtC,MAAM,yBAAyB,GAAG,MAAM,CAAA;AACxC,MAAM,mCAAmC,GAAG,IAAI,CAAA;AA6BhD;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,YAAiC;IAS9D,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;QAPD,eAAU,GAAe,IAAI,UAAU,EAAE,CAAA;QAS/C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,mCAAmC,CAAA;QACrE,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QAEd,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,IAAI,EAAE;YACpC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;gBAC3B,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;gBAC9B,SAAQ;aACT;YAED,MAAM,EAAE,GAAG,SAAS,CAAC,SAAS,CAAC,CAAA;YAC/B,MAAM,SAAS,GAAG,EAAE,CAAC,SAAS,EAAE,CAAA;YAEhC,IAAI,SAAS,IAAI,IAAI,EAAE;gBACrB,GAAG,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAA;gBACxD,SAAQ;aACT;YAED,MAAM,QAAQ,GAAa;gBACzB,EAAE,EAAE,gBAAgB,CAAC,SAAS,CAAC;gBAC/B,UAAU,EAAE,CAAC,EAAE,CAAC;gBAChB,SAAS,EAAE,EAAE;aACd,CAAA;YAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;SACzB;QAED,IAAI,CAAC,KAAK,GAAG,OAAO,CAAA;IACtB,CAAC;IAED,IAAI,CAAE,UAAsB;QAC1B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAED,IAAI,CAAC,MAAM,CAAC;QACV,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACtB,OAAO,mBAAmB,CAAA;IAC5B,CAAC;IAED,SAAS;QACP,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC5B,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE;YACpB,OAAM;SACP;QAED,GAAG,CAAC,kEAAkE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;QACrF,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC3B,KAAK,IAAI,CAAC,uBAAuB,EAAE;iBAChC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACX,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAChB,CAAC,CAAC,CAAA;QACN,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IAClB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,uBAAuB;QAC3B,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;YACtB,OAAM;SACP;QAED,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE;YAChC,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,0BAA0B,EAAE;gBAC1G,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,2BAA2B;gBACzD,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,yBAAyB;aACpD,CAAC,CAAA;YAEF,6BAA6B;YAC7B,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;gBACtB,OAAM;aACP;YAED,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAW,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAA;SAC5E;IACH,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;YACtB,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SACzB;QAED,IAAI,CAAC,KAAK,GAAG,SAAS,CAAA;IACxB,CAAC;;AA5GM,aAAG,GAAG,WAAW,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/bootstrap",
-  "version": "2.0.0",
+  "version": "3.0.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",
@@ -65,15 +65,15 @@
               "release": "patch"
             },
             {
-              "type": "chore",
+              "type": "docs",
               "release": "patch"
             },
             {
-              "type": "docs",
+              "type": "test",
               "release": "patch"
             },
             {
-              "type": "test",
+              "type": "deps",
               "release": "patch"
             },
             {
@@ -103,7 +103,11 @@
               },
               {
                 "type": "docs",
-                "section": "Trivial Changes"
+                "section": "Documentation"
+              },
+              {
+                "type": "deps",
+                "section": "Dependencies"
               },
               {
                 "type": "test",
@@ -134,17 +138,21 @@
     "release": "aegir release"
   },
   "dependencies": {
-    "@libp2p/interface-peer-discovery": "^1.0.0",
-    "@libp2p/interface-peer-info": "^1.0.1",
-    "@libp2p/interfaces": "^3.0.2",
-    "@libp2p/logger": "^2.0.0",
-    "@libp2p/peer-id": "^1.1.9",
-    "@multiformats/mafmt": "^11.0.2",
-    "@multiformats/multiaddr": "^10.1.7"
+    "@libp2p/components": "^2.0.0",
+    "@libp2p/interface-peer-discovery": "^1.0.1",
+    "@libp2p/interface-peer-info": "^1.0.3",
+    "@libp2p/interfaces": "^3.0.3",
+    "@libp2p/logger": "^2.0.1",
+    "@libp2p/peer-id": "^1.1.15",
+    "@multiformats/mafmt": "^11.0.3",
+    "@multiformats/multiaddr": "^11.0.0"
   },
   "devDependencies": {
-    "@libp2p/interface-peer-discovery-compliance-tests": "^1.0.0",
-    "@libp2p/interface-peer-id": "^1.0.2",
-    "aegir": "^37.2.0"
+    "@libp2p/interface-peer-discovery-compliance-tests": "^1.0.2",
+    "@libp2p/interface-peer-id": "^1.0.4",
+    "@libp2p/peer-store": "^3.1.5",
+    "aegir": "^37.5.3",
+    "datastore-core": "^8.0.1",
+    "delay": "^5.0.0"
   }
 }

package/src/index.ts

@@ -1,4 +1,4 @@
-import { Multiaddr } from '@multiformats/multiaddr'
+import { multiaddr } from '@multiformats/multiaddr'
 import { P2P } from '@multiformats/mafmt'
 import { CustomEvent, EventEmitter } from '@libp2p/interfaces/events'
 import { logger } from '@libp2p/logger'
@@ -6,9 +6,15 @@ import type { PeerDiscovery, PeerDiscoveryEvents } from '@libp2p/interface-peer-
 import type { PeerInfo } from '@libp2p/interface-peer-info'
 import { peerIdFromString } from '@libp2p/peer-id'
 import { symbol } from '@libp2p/interface-peer-discovery'
+import { Components, Initializable } from '@libp2p/components'
 
 const log = logger('libp2p:bootstrap')
 
+const DEFAULT_BOOTSTRAP_TAG_NAME = 'bootstrap'
+const DEFAULT_BOOTSTRAP_TAG_VALUE = 50
+const DEFAULT_BOOTSTRAP_TAG_TTL = 120000
+const DEFAULT_BOOTSTRAP_DISCOVERY_TIMEOUT = 1000
+
 export interface BootstrapOptions {
   /**
    * The list of peer addresses in multi-address format
@@ -16,20 +22,37 @@ export interface BootstrapOptions {
   list: string[]
 
   /**
-   * The interval between emitting addresses in milliseconds
+   * How long to wait before discovering bootstrap nodes
+   */
+  timeout?: number
+
+  /**
+   * Tag a bootstrap peer with this name before "discovering" it (default: 'bootstrap')
+   */
+  tagName?: string
+
+  /**
+   * The bootstrap peer tag will have this value (default: 50)
+   */
+  tagValue?: number
+
+  /**
+   * Cause the bootstrap peer tag to be removed after this number of ms (default: 2 minutes)
    */
-  interval?: number
+  tagTTL?: number
 }
 
 /**
  * Emits 'peer' events on a regular interval for each peer in the provided list.
  */
-export class Bootstrap extends EventEmitter<PeerDiscoveryEvents> implements PeerDiscovery {
+export class Bootstrap extends EventEmitter<PeerDiscoveryEvents> implements PeerDiscovery, Initializable {
   static tag = 'bootstrap'
 
-  private timer?: ReturnType<typeof setInterval>
+  private timer?: ReturnType<typeof setTimeout>
   private readonly list: PeerInfo[]
-  private readonly interval: number
+  private readonly timeout: number
+  private components: Components = new Components()
+  private readonly _init: BootstrapOptions
 
   constructor (options: BootstrapOptions = { list: [] }) {
     if (options.list == null || options.list.length === 0) {
@@ -37,7 +60,7 @@ export class Bootstrap extends EventEmitter<PeerDiscoveryEvents> implements Peer
     }
     super()
 
-    this.interval = options.interval ?? 10000
+    this.timeout = options.timeout ?? DEFAULT_BOOTSTRAP_DISCOVERY_TIMEOUT
     this.list = []
 
     for (const candidate of options.list) {
@@ -46,7 +69,7 @@ export class Bootstrap extends EventEmitter<PeerDiscoveryEvents> implements Peer
         continue
       }
 
-      const ma = new Multiaddr(candidate)
+      const ma = multiaddr(candidate)
       const peerIdStr = ma.getPeerId()
 
       if (peerIdStr == null) {
@@ -62,6 +85,12 @@ export class Bootstrap extends EventEmitter<PeerDiscoveryEvents> implements Peer
 
       this.list.push(peerData)
     }
+
+    this._init = options
+  }
+
+  init (components: Components) {
+    this.components = components
   }
 
   get [symbol] (): true {
@@ -80,26 +109,40 @@ export class Bootstrap extends EventEmitter<PeerDiscoveryEvents> implements Peer
    * Start emitting events
    */
   start () {
-    if (this.timer != null) {
+    if (this.isStarted()) {
       return
     }
 
-    this.timer = setInterval(() => this._discoverBootstrapPeers(), this.interval)
-    log('Starting bootstrap node discovery')
-    this._discoverBootstrapPeers()
+    log('Starting bootstrap node discovery, discovering peers after %s ms', this.timeout)
+    this.timer = setTimeout(() => {
+      void this._discoverBootstrapPeers()
+        .catch(err => {
+          log.error(err)
+        })
+    }, this.timeout)
   }
 
   /**
    * Emit each address in the list as a PeerInfo
    */
-  _discoverBootstrapPeers () {
+  async _discoverBootstrapPeers () {
     if (this.timer == null) {
       return
     }
 
-    this.list.forEach((peerData) => {
+    for (const peerData of this.list) {
+      await this.components.getPeerStore().tagPeer(peerData.id, this._init.tagName ?? DEFAULT_BOOTSTRAP_TAG_NAME, {
+        value: this._init.tagValue ?? DEFAULT_BOOTSTRAP_TAG_VALUE,
+        ttl: this._init.tagTTL ?? DEFAULT_BOOTSTRAP_TAG_TTL
+      })
+
+      // check we are still running
+      if (this.timer == null) {
+        return
+      }
+
       this.dispatchEvent(new CustomEvent<PeerInfo>('peer', { detail: peerData }))
-    })
+    }
   }
 
   /**
@@ -107,7 +150,7 @@ export class Bootstrap extends EventEmitter<PeerDiscoveryEvents> implements Peer
    */
   stop () {
     if (this.timer != null) {
-      clearInterval(this.timer)
+      clearTimeout(this.timer)
     }
 
     this.timer = undefined