@libp2p/bootstrap
![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=master&style=flat-square)
Peer discovery via a list of bootstrap peers
Table of contents
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>
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
.
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 = {
transports: [
tcp()
],
streamMuxers: [
mplex()
],
connectionEncryption: [
noise()
],
peerDiscovery: [
bootstrap({
list: [
"/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ",
"/dnsaddr/bootstrap.libp2p.io/ipfs/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN",
"/dnsaddr/bootstrap.libp2p.io/ipfs/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa"
],
timeout: 1000,
tagName: 'bootstrap',
tagValue: 50,
tagTTL: 120000
})
]
}
async function start () {
let libp2p = await createLibp2p(options)
libp2p.on('peer:discovery', function (peerId) {
console.log('found peer: ', peerId.toB58String())
})
await libp2p.start()
}
start()
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.