mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-03-15 23:20: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
96 lines
1.8 KiB
JavaScript
96 lines
1.8 KiB
JavaScript
process.env.NODE_ENV = 'test'
|
|
process.env.CI = true // needed for some "clever" build tools
|
|
|
|
import fs from 'fs-extra'
|
|
import path from 'path'
|
|
import execa from 'execa'
|
|
import { fileURLToPath } from 'url'
|
|
|
|
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
|
const dir = path.join(__dirname, process.argv[2])
|
|
|
|
testExample(dir)
|
|
.then(() => {}, (err) => {
|
|
if (err.exitCode) {
|
|
process.exit(err.exitCode)
|
|
}
|
|
|
|
console.error(err)
|
|
process.exit(1)
|
|
})
|
|
|
|
async function testExample (dir) {
|
|
await installDeps(dir)
|
|
await build(dir)
|
|
await runTest(dir)
|
|
}
|
|
|
|
async function installDeps (dir) {
|
|
if (!fs.existsSync(path.join(dir, 'package.json'))) {
|
|
console.info('Nothing to install in', dir)
|
|
return
|
|
}
|
|
|
|
if (fs.existsSync(path.join(dir, 'node_modules'))) {
|
|
console.info('Dependencies already installed in', dir)
|
|
return
|
|
}
|
|
|
|
const proc = execa.command('npm install', {
|
|
cwd: dir
|
|
})
|
|
proc.all.on('data', (data) => {
|
|
process.stdout.write(data)
|
|
})
|
|
|
|
await proc
|
|
}
|
|
|
|
async function build (dir) {
|
|
const pkgJson = path.join(dir, 'package.json')
|
|
|
|
if (!fs.existsSync(pkgJson)) {
|
|
console.info('Nothing to build in', dir)
|
|
return
|
|
}
|
|
|
|
const pkg = JSON.parse(fs.readFileSync(pkgJson))
|
|
let build
|
|
|
|
if (pkg.scripts.bundle) {
|
|
build = 'bundle'
|
|
}
|
|
|
|
if (pkg.scripts.build) {
|
|
build = 'build'
|
|
}
|
|
|
|
if (!build) {
|
|
console.info('No "build" or "bundle" script in', pkgJson)
|
|
return
|
|
}
|
|
|
|
const proc = execa('npm', ['run', build], {
|
|
cwd: dir
|
|
})
|
|
proc.all.on('data', (data) => {
|
|
process.stdout.write(data)
|
|
})
|
|
|
|
await proc
|
|
}
|
|
|
|
async function runTest (dir) {
|
|
console.info('Running node tests in', dir)
|
|
const testFile = path.join(dir, 'test.js')
|
|
|
|
if (!fs.existsSync(testFile)) {
|
|
console.info('Nothing to test in', dir)
|
|
return
|
|
}
|
|
|
|
const { test } = await import(testFile)
|
|
|
|
await test()
|
|
}
|