mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-03-30 22:31:03 +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
53 lines
1.5 KiB
JavaScript
53 lines
1.5 KiB
JavaScript
/* eslint-disable no-console */
|
|
|
|
import { createLibp2p } from 'libp2p'
|
|
import { TCP } from '@libp2p/tcp'
|
|
import { Mplex } from '@libp2p/mplex'
|
|
import { Noise } from '@chainsafe/libp2p-noise'
|
|
import { Gossipsub } from '@achingbrain/libp2p-gossipsub'
|
|
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
|
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
import { CustomEvent } from '@libp2p/interfaces'
|
|
|
|
const createNode = async () => {
|
|
const node = await createLibp2p({
|
|
addresses: {
|
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
|
},
|
|
transports: [new TCP()],
|
|
streamMuxers: [new Mplex()],
|
|
connectionEncryption: [new Noise()],
|
|
pubsub: new Gossipsub()
|
|
})
|
|
|
|
await node.start()
|
|
return node
|
|
}
|
|
|
|
;(async () => {
|
|
const topic = 'news'
|
|
|
|
const [node1, node2] = await Promise.all([
|
|
createNode(),
|
|
createNode()
|
|
])
|
|
|
|
// Add node's 2 data to the PeerStore
|
|
await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
|
|
await node1.dial(node2.peerId)
|
|
|
|
node1.pubsub.addEventListener(topic, (evt) => {
|
|
console.log(`node1 received: ${uint8ArrayToString(evt.detail.data)}`)
|
|
})
|
|
|
|
// Will not receive own published messages by default
|
|
node2.pubsub.addEventListener(topic, (evt) => {
|
|
console.log(`node2 received: ${uint8ArrayToString(evt.detail.data)}`)
|
|
})
|
|
|
|
// node2 publishes "news" every second
|
|
setInterval(() => {
|
|
node2.pubsub.dispatchEvent(new CustomEvent(topic, { detail: uint8ArrayFromString('Bird bird bird, bird is the word!') }))
|
|
}, 1000)
|
|
})()
|