mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-04-11 19:56: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
77 lines
2.0 KiB
TypeScript
77 lines
2.0 KiB
TypeScript
import { PubSubBaseProtocol } from '@libp2p/pubsub'
|
|
import { Plaintext } from '../../src/insecure/index.js'
|
|
import { Mplex } from '@libp2p/mplex'
|
|
import { WebSockets } from '@libp2p/websockets'
|
|
import * as filters from '@libp2p/websockets/filters'
|
|
import { MULTIADDRS_WEBSOCKETS } from '../fixtures/browser.js'
|
|
import mergeOptions from 'merge-options'
|
|
import type { Message, PubSubInit, PubSubRPC, PubSubRPCMessage } from '@libp2p/interfaces/pubsub'
|
|
import type { Libp2pInit, Libp2pOptions } from '../../src/index.js'
|
|
import type { PeerId } from '@libp2p/interfaces/peer-id'
|
|
import * as cborg from 'cborg'
|
|
import { peerIdFromString } from '@libp2p/peer-id'
|
|
|
|
const relayAddr = MULTIADDRS_WEBSOCKETS[0]
|
|
|
|
export const baseOptions: Partial<Libp2pInit> = {
|
|
peerId: peerIdFromString('12D3KooWJKCJW8Y26pRFNv78TCMGLNTfyN8oKaFswMRYXTzSbSst'),
|
|
transports: [new WebSockets()],
|
|
streamMuxers: [new Mplex()],
|
|
connectionEncryption: [new Plaintext()]
|
|
}
|
|
|
|
class MockPubSub extends PubSubBaseProtocol {
|
|
constructor (init?: PubSubInit) {
|
|
super({
|
|
multicodecs: ['/mock-pubsub'],
|
|
...init
|
|
})
|
|
}
|
|
|
|
decodeRpc (bytes: Uint8Array): PubSubRPC {
|
|
return cborg.decode(bytes)
|
|
}
|
|
|
|
encodeRpc (rpc: PubSubRPC): Uint8Array {
|
|
return cborg.encode(rpc)
|
|
}
|
|
|
|
decodeMessage (bytes: Uint8Array): PubSubRPCMessage {
|
|
return cborg.decode(bytes)
|
|
}
|
|
|
|
encodeMessage (rpc: PubSubRPCMessage): Uint8Array {
|
|
return cborg.encode(rpc)
|
|
}
|
|
|
|
async publishMessage (from: PeerId, message: Message): Promise<void> {
|
|
const peers = this.getSubscribers(message.topic)
|
|
|
|
if (peers == null || peers.length === 0) {
|
|
return
|
|
}
|
|
|
|
peers.forEach(id => {
|
|
if (this.components.getPeerId().equals(id)) {
|
|
return
|
|
}
|
|
|
|
if (id.equals(from)) {
|
|
return
|
|
}
|
|
|
|
this.send(id, { messages: [message] })
|
|
})
|
|
}
|
|
}
|
|
|
|
export const pubsubSubsystemOptions: Libp2pOptions = mergeOptions(baseOptions, {
|
|
pubsub: new MockPubSub(),
|
|
addresses: {
|
|
listen: [`${relayAddr.toString()}/p2p-circuit`]
|
|
},
|
|
transports: [
|
|
new WebSockets({ filter: filters.all })
|
|
]
|
|
})
|