mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-04-03 00:01:04 +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
107 lines
2.7 KiB
TypeScript
107 lines
2.7 KiB
TypeScript
/* eslint-env mocha */
|
|
|
|
import { expect } from 'aegir/utils/chai.js'
|
|
import mergeOptions from 'merge-options'
|
|
import pDefer from 'p-defer'
|
|
import delay from 'delay'
|
|
import { createLibp2p, Libp2p } from '../../src/index.js'
|
|
import { baseOptions, pubsubSubsystemOptions } from './utils.js'
|
|
import { createPeerId } from '../utils/creators/peer.js'
|
|
import { CustomEvent } from '@libp2p/interfaces'
|
|
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
|
import { FloodSub } from '@libp2p/floodsub'
|
|
import type { PubSub } from '@libp2p/interfaces/pubsub'
|
|
|
|
describe('Pubsub subsystem is configurable', () => {
|
|
let libp2p: Libp2p
|
|
|
|
afterEach(async () => {
|
|
if (libp2p != null) {
|
|
await libp2p.stop()
|
|
}
|
|
})
|
|
|
|
it('should not exist if no module is provided', async () => {
|
|
libp2p = await createLibp2p(baseOptions)
|
|
expect(libp2p.pubsub).to.not.exist()
|
|
})
|
|
|
|
it('should exist if the module is provided', async () => {
|
|
libp2p = await createLibp2p(pubsubSubsystemOptions)
|
|
expect(libp2p.pubsub).to.exist()
|
|
})
|
|
|
|
it('should start and stop by default once libp2p starts', async () => {
|
|
const peerId = await createPeerId()
|
|
|
|
const customOptions = mergeOptions(pubsubSubsystemOptions, {
|
|
peerId
|
|
})
|
|
|
|
libp2p = await createLibp2p(customOptions)
|
|
expect(libp2p.pubsub?.isStarted()).to.equal(false)
|
|
|
|
await libp2p.start()
|
|
expect(libp2p.pubsub?.isStarted()).to.equal(true)
|
|
|
|
await libp2p.stop()
|
|
expect(libp2p.pubsub?.isStarted()).to.equal(false)
|
|
})
|
|
})
|
|
|
|
describe('Pubsub subscription handlers adapter', () => {
|
|
let libp2p: Libp2p
|
|
|
|
beforeEach(async () => {
|
|
const peerId = await createPeerId()
|
|
|
|
libp2p = await createLibp2p(mergeOptions(pubsubSubsystemOptions, {
|
|
peerId,
|
|
pubsub: new FloodSub({
|
|
emitSelf: true
|
|
})
|
|
}))
|
|
|
|
await libp2p.start()
|
|
})
|
|
|
|
afterEach(async () => {
|
|
if (libp2p != null) {
|
|
await libp2p.stop()
|
|
}
|
|
})
|
|
|
|
it('extends pubsub with subscribe handler', async () => {
|
|
let countMessages = 0
|
|
const topic = 'topic'
|
|
const defer = pDefer()
|
|
|
|
const handler = () => {
|
|
countMessages++
|
|
defer.resolve()
|
|
}
|
|
|
|
const pubsub: PubSub | undefined = libp2p.pubsub
|
|
|
|
if (pubsub == null) {
|
|
throw new Error('Pubsub was not enabled')
|
|
}
|
|
|
|
pubsub.addEventListener(topic, handler)
|
|
pubsub.dispatchEvent(new CustomEvent<Uint8Array>(topic, {
|
|
detail: uint8ArrayFromString('useless-data')
|
|
}))
|
|
await defer.promise
|
|
|
|
pubsub.removeEventListener(topic, handler)
|
|
pubsub.dispatchEvent(new CustomEvent<Uint8Array>(topic, {
|
|
detail: uint8ArrayFromString('useless-data')
|
|
}))
|
|
|
|
// wait to guarantee that the handler is not called twice
|
|
await delay(100)
|
|
|
|
expect(countMessages).to.equal(1)
|
|
})
|
|
})
|