@libp2p/bootstrap
TypeScript icon, indicating that this package has built-in type declarations

10.0.24 • Public • Published

@libp2p/bootstrap

libp2p.io Discuss codecov CI

Peer discovery via a list of bootstrap peers

About

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.

Example - Configuring a list of bootstrap nodes

import { createLibp2p } from 'libp2p'
import { bootstrap } from '@libp2p/bootstrap'

const libp2p = await createLibp2p({
  peerDiscovery: [
    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'
      ]
    })
  ]
})

libp2p.addEventListener('peer:discovery', (evt) => {
  console.log('found peer: ', evt.detail.toString())
})

Install

$ npm i @libp2p/bootstrap

Browser <script> tag

Loading this module through a script tag will make it's exports available as Libp2pBootstrap in the global namespace.

<script src="https://unpkg.com/@libp2p/bootstrap/dist/index.min.js"></script>

API Docs

License

Licensed under either of

Contribution

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.

Readme

Keywords

Package Sidebar

Install

npm i @libp2p/bootstrap

Weekly Downloads

7,689

Version

10.0.24

License

Apache-2.0 OR MIT

Unpacked Size

60.6 kB

Total Files

10

Last publish

Collaborators

  • jacobheun
  • npm-service-account-libp2p
  • alanshaw
  • vascosantos
  • achingbrain
  • daviddias