mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-04-01 07:11: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
62 lines
1.7 KiB
TypeScript
62 lines
1.7 KiB
TypeScript
/* eslint-env mocha */
|
|
|
|
import { expect } from 'aegir/utils/chai.js'
|
|
import { AutoDialler } from '../../src/connection-manager/auto-dialler.js'
|
|
import pWaitFor from 'p-wait-for'
|
|
import delay from 'delay'
|
|
import { createEd25519PeerId } from '@libp2p/peer-id-factory'
|
|
import { Components } from '@libp2p/interfaces/components'
|
|
import { stubInterface } from 'ts-sinon'
|
|
import type { ConnectionManager } from '@libp2p/interfaces/registrar'
|
|
import type { PeerStore, Peer } from '@libp2p/interfaces/peer-store'
|
|
import type { Dialer } from '@libp2p/interfaces/dialer'
|
|
|
|
describe('Auto-dialler', () => {
|
|
it('should not dial self', async () => {
|
|
// peers with protocols are dialled before peers without protocols
|
|
const self: Peer = {
|
|
id: await createEd25519PeerId(),
|
|
protocols: [
|
|
'/foo/bar'
|
|
],
|
|
addresses: [],
|
|
metadata: new Map()
|
|
}
|
|
const other: Peer = {
|
|
id: await createEd25519PeerId(),
|
|
protocols: [],
|
|
addresses: [],
|
|
metadata: new Map()
|
|
}
|
|
|
|
const peerStore = stubInterface<PeerStore>()
|
|
|
|
peerStore.all.returns(Promise.resolve([
|
|
self, other
|
|
]))
|
|
|
|
const connectionManager = stubInterface<ConnectionManager>()
|
|
connectionManager.getConnectionList.returns([])
|
|
const dialer = stubInterface<Dialer>()
|
|
|
|
const autoDialler = new AutoDialler(new Components({
|
|
peerId: self.id,
|
|
peerStore,
|
|
connectionManager,
|
|
dialer
|
|
}), {
|
|
minConnections: 10
|
|
})
|
|
|
|
await autoDialler.start()
|
|
|
|
await pWaitFor(() => dialer.dial.callCount === 1)
|
|
await delay(1000)
|
|
|
|
await autoDialler.stop()
|
|
|
|
expect(dialer.dial.callCount).to.equal(1)
|
|
expect(dialer.dial.calledWith(self.id)).to.be.false()
|
|
})
|
|
})
|