mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-03-16 23:50:51 +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
26 lines
575 B
JSON
26 lines
575 B
JSON
{
|
|
"name": "libp2p-examples",
|
|
"version": "1.0.0",
|
|
"description": "Examples of how to use libp2p",
|
|
"type": "module",
|
|
"scripts": {
|
|
"test": "node ./test.js",
|
|
"test:all": "node ./test-all.js"
|
|
},
|
|
"license": "MIT",
|
|
"dependencies": {
|
|
"@achingbrain/libp2p-gossipsub": "^0.13.5",
|
|
"@libp2p/pubsub-peer-discovery": "^5.0.1",
|
|
"execa": "^2.1.0",
|
|
"fs-extra": "^8.1.0",
|
|
"libp2p": "../",
|
|
"p-defer": "^3.0.0",
|
|
"uint8arrays": "^3.0.0",
|
|
"which": "^2.0.1"
|
|
},
|
|
"devDependencies": {
|
|
"https": "^1.0.0",
|
|
"playwright": "^1.7.1"
|
|
}
|
|
}
|