mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-04-25 18:42:15 +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
76 lines
2.3 KiB
TypeScript
76 lines
2.3 KiB
TypeScript
/* eslint-env mocha */
|
|
|
|
import { expect } from 'aegir/utils/chai.js'
|
|
import pTimes from 'p-times'
|
|
import { pipe } from 'it-pipe'
|
|
import { createNode, populateAddressBooks } from '../utils/creators/peer.js'
|
|
import { createBaseOptions } from '../utils/base-options.js'
|
|
import { PROTOCOL } from '../../src/ping/constants.js'
|
|
import { Multiaddr } from '@multiformats/multiaddr'
|
|
import pDefer from 'p-defer'
|
|
import type { Libp2pNode } from '../../src/libp2p.js'
|
|
|
|
describe('ping', () => {
|
|
let nodes: Libp2pNode[]
|
|
|
|
beforeEach(async () => {
|
|
nodes = await Promise.all([
|
|
createNode({ config: createBaseOptions() }),
|
|
createNode({ config: createBaseOptions() }),
|
|
createNode({ config: createBaseOptions() })
|
|
])
|
|
await populateAddressBooks(nodes)
|
|
|
|
await nodes[0].components.getPeerStore().addressBook.set(nodes[1].peerId, nodes[1].getMultiaddrs())
|
|
await nodes[1].components.getPeerStore().addressBook.set(nodes[0].peerId, nodes[0].getMultiaddrs())
|
|
})
|
|
|
|
afterEach(async () => await Promise.all(nodes.map(async n => await n.stop())))
|
|
|
|
it('ping once from peer0 to peer1 using a multiaddr', async () => {
|
|
const ma = new Multiaddr(`${nodes[2].getMultiaddrs()[0].toString()}/p2p/${nodes[2].peerId.toString()}`)
|
|
const latency = await nodes[0].ping(ma)
|
|
|
|
expect(latency).to.be.a('Number')
|
|
})
|
|
|
|
it('ping once from peer0 to peer1 using a peerId', async () => {
|
|
const latency = await nodes[0].ping(nodes[1].peerId)
|
|
|
|
expect(latency).to.be.a('Number')
|
|
})
|
|
|
|
it('ping several times for getting an average', async () => {
|
|
const latencies = await pTimes(5, async () => await nodes[1].ping(nodes[0].peerId))
|
|
|
|
const averageLatency = latencies.reduce((p, c) => p + c, 0) / latencies.length
|
|
expect(averageLatency).to.be.a('Number')
|
|
})
|
|
|
|
it('only waits for the first response to arrive', async () => {
|
|
const defer = pDefer()
|
|
|
|
await nodes[1].unhandle(PROTOCOL)
|
|
await nodes[1].handle(PROTOCOL, ({ stream }) => {
|
|
void pipe(
|
|
stream,
|
|
async function * (stream) {
|
|
for await (const data of stream) {
|
|
yield data
|
|
|
|
// something longer than the test timeout
|
|
await defer.promise
|
|
}
|
|
},
|
|
stream
|
|
)
|
|
})
|
|
|
|
const latency = await nodes[0].ping(nodes[1].peerId)
|
|
|
|
expect(latency).to.be.a('Number')
|
|
|
|
defer.resolve()
|
|
})
|
|
})
|