mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-04-01 15:21: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
48 lines
1.3 KiB
TypeScript
48 lines
1.3 KiB
TypeScript
/* eslint-env mocha */
|
|
|
|
import { expect } from 'aegir/utils/chai.js'
|
|
import mergeOptions from 'merge-options'
|
|
import { validateConfig } from '../../src/config.js'
|
|
import { createLibp2pNode, Libp2pNode } from '../../src/libp2p.js'
|
|
import { baseOptions } from './utils.js'
|
|
|
|
describe('Protocol prefix is configurable', () => {
|
|
let libp2p: Libp2pNode
|
|
|
|
afterEach(async () => {
|
|
if (libp2p != null) {
|
|
await libp2p.stop()
|
|
}
|
|
})
|
|
|
|
it('protocolPrefix is provided', async () => {
|
|
const testProtocol = 'test-protocol'
|
|
libp2p = await createLibp2pNode(mergeOptions(baseOptions, {
|
|
protocolPrefix: testProtocol
|
|
}))
|
|
await libp2p.start()
|
|
|
|
const protocols = await libp2p.peerStore.protoBook.get(libp2p.peerId)
|
|
expect(protocols).to.include.members([
|
|
'/libp2p/fetch/0.0.1',
|
|
'/libp2p/circuit/relay/0.1.0',
|
|
`/${testProtocol}/id/1.0.0`,
|
|
`/${testProtocol}/id/push/1.0.0`,
|
|
`/${testProtocol}/ping/1.0.0`
|
|
])
|
|
})
|
|
|
|
it('protocolPrefix is not provided', async () => {
|
|
libp2p = await createLibp2pNode(validateConfig(baseOptions))
|
|
await libp2p.start()
|
|
|
|
const protocols = await libp2p.peerStore.protoBook.get(libp2p.peerId)
|
|
expect(protocols).to.include.members([
|
|
'/libp2p/circuit/relay/0.1.0',
|
|
'/ipfs/id/1.0.0',
|
|
'/ipfs/id/push/1.0.0',
|
|
'/ipfs/ping/1.0.0'
|
|
])
|
|
})
|
|
})
|