mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-04-04 08:41:05 +00:00
199395de4d
Converts this module to typescript.
- Ecosystem modules renamed from (e.g.) `libp2p-tcp` to `@libp2p/tcp`
- Ecosystem module now have named exports
- Configuration has been updated, now pass instances of modules instead of classes:
- Some configuration keys have been renamed to make them more descriptive. `transport` -> `transports`, `connEncryption` -> `connectionEncryption`. In general where we pass multiple things, the key is now plural, e.g. `streamMuxer` -> `streamMuxers`, `contentRouting` -> `contentRouters`, etc. Where we are configuring a singleton the config key is singular, e.g. `connProtector` -> `connectionProtector` etc.
- Properties of the `modules` config key have been moved to the root
- Properties of the `config` config key have been moved to the root
```js
// before
import Libp2p from 'libp2p'
import TCP from 'libp2p-tcp'
await Libp2p.create({
modules: {
transport: [
TCP
],
}
config: {
transport: {
[TCP.tag]: {
foo: 'bar'
}
},
relay: {
enabled: true,
hop: {
enabled: true,
active: true
}
}
}
})
```
```js
// after
import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'
await createLibp2p({
transports: [
new TCP({ foo: 'bar' })
],
relay: {
enabled: true,
hop: {
enabled: true,
active: true
}
}
})
```
- Use of `enabled` flag has been reduced - previously you could pass a module but disable it with config. Now if you don't want a feature, just don't pass an implementation. Eg:
```js
// before
await Libp2p.create({
modules: {
transport: [
TCP
],
pubsub: Gossipsub
},
config: {
pubsub: {
enabled: false
}
}
})
```
```js
// after
await createLibp2p({
transports: [
new TCP()
]
})
```
- `.multiaddrs` renamed to `.getMultiaddrs()` because it's not a property accessor, work is done by that method to calculate announce addresses, observed addresses, etc
- `/p2p/${peerId}` is now appended to all addresses returned by `.getMultiaddrs()` so they can be used opaquely (every consumer has to append the peer ID to the address to actually use it otherwise). If you need low-level unadulterated addresses, call methods on the address manager.
BREAKING CHANGE: types are no longer hand crafted, this module is now ESM only
78 lines
2.5 KiB
JavaScript
78 lines
2.5 KiB
JavaScript
import { createLibp2p } from 'libp2p'
|
|
import { WebSockets } from '@libp2p/websockets'
|
|
import { WebRTCStar } from '@libp2p/webrtc-star'
|
|
import { Noise } from '@chainsafe/libp2p-noise'
|
|
import { Mplex } from '@libp2p/mplex'
|
|
import { Bootstrap } from '@libp2p/bootstrap'
|
|
|
|
document.addEventListener('DOMContentLoaded', async () => {
|
|
const webRtcStar = new WebRTCStar()
|
|
|
|
// Create our libp2p node
|
|
const libp2p = await createLibp2p({
|
|
addresses: {
|
|
// Add the signaling server address, along with our PeerId to our multiaddrs list
|
|
// libp2p will automatically attempt to dial to the signaling server so that it can
|
|
// receive inbound connections from other peers
|
|
listen: [
|
|
'/dns4/wrtc-star1.par.dwebops.pub/tcp/443/wss/p2p-webrtc-star',
|
|
'/dns4/wrtc-star2.sjc.dwebops.pub/tcp/443/wss/p2p-webrtc-star'
|
|
]
|
|
},
|
|
transports: [
|
|
new WebSockets(),
|
|
webRtcStar
|
|
],
|
|
connectionEncryption: [new Noise()],
|
|
streamMuxers: [new Mplex()],
|
|
peerDiscovery: [
|
|
webRtcStar.discovery,
|
|
new Bootstrap({
|
|
list: [
|
|
'/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN',
|
|
'/dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb',
|
|
'/dnsaddr/bootstrap.libp2p.io/p2p/QmZa1sAxajnQjVM8WjWXoMbmPd7NsWhfKsPkErzpm9wGkp',
|
|
'/dnsaddr/bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa',
|
|
'/dnsaddr/bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt'
|
|
]
|
|
})
|
|
]
|
|
})
|
|
|
|
// UI elements
|
|
const status = document.getElementById('status')
|
|
const output = document.getElementById('output')
|
|
|
|
output.textContent = ''
|
|
|
|
function log (txt) {
|
|
console.info(txt)
|
|
output.textContent += `${txt.trim()}\n`
|
|
}
|
|
|
|
// Listen for new peers
|
|
libp2p.addEventListener('peer:discovery', (evt) => {
|
|
const peer = evt.detail
|
|
log(`Found peer ${peer.id.toString()}`)
|
|
})
|
|
|
|
// Listen for new connections to peers
|
|
libp2p.connectionManager.addEventListener('peer:connect', (evt) => {
|
|
const connection = evt.detail
|
|
log(`Connected to ${connection.remotePeer.toString()}`)
|
|
})
|
|
|
|
// Listen for peers disconnecting
|
|
libp2p.connectionManager.addEventListener('peer:disconnect', (evt) => {
|
|
const connection = evt.detail
|
|
log(`Disconnected from ${connection.remotePeer.toString()}`)
|
|
})
|
|
|
|
await libp2p.start()
|
|
status.innerText = 'libp2p started!'
|
|
log(`libp2p id is ${libp2p.peerId.toString()}`)
|
|
|
|
// Export libp2p to the window so you can play with the API
|
|
window.libp2p = libp2p
|
|
})
|