feat: convert to typescript (#1172)

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
This commit is contained in:
Alex Potsides
2022-03-28 14:30:27 +01:00
committed by GitHub
parent 3cfe4bbfac
commit 199395de4d
341 changed files with 17035 additions and 23548 deletions

63
.aegir.cjs Normal file
View File

@ -0,0 +1,63 @@
'use strict'
/** @type {import('aegir').PartialOptions} */
module.exports = {
build: {
bundlesizeMax: '253kB'
},
test: {
before: async () => {
const { createLibp2p } = await import('./dist/src/index.js')
const { MULTIADDRS_WEBSOCKETS } = await import('./dist/test/fixtures/browser.js')
const { default: Peers } = await import('./dist/test/fixtures/peers.js')
const { WebSockets } = await import('@libp2p/websockets')
const { Mplex } = await import('@libp2p/mplex')
const { NOISE } = await import('@chainsafe/libp2p-noise')
const { Plaintext } = await import('./dist/src/insecure/index.js')
const { pipe } = await import('it-pipe')
const { createFromJSON } = await import('@libp2p/peer-id-factory')
// Use the last peer
const peerId = await createFromJSON(Peers[Peers.length - 1])
const libp2p = await createLibp2p({
addresses: {
listen: [MULTIADDRS_WEBSOCKETS[0]]
},
peerId,
transports: [
new WebSockets()
],
streamMuxers: [
new Mplex()
],
connectionEncryption: [
NOISE,
new Plaintext()
],
relay: {
enabled: true,
hop: {
enabled: true,
active: false
}
},
nat: {
enabled: false
}
})
// Add the echo protocol
await libp2p.handle('/echo/1.0.0', ({ stream }) => {
pipe(stream, stream)
.catch() // sometimes connections are closed before multistream-select finishes which causes an error
})
await libp2p.start()
return {
libp2p
}
},
after: async (_, before) => {
await before.libp2p.stop()
}
}
}

View File

@ -1,70 +0,0 @@
'use strict'
const path = require('path')
const Libp2p = require('./src')
const { MULTIADDRS_WEBSOCKETS } = require('./test/fixtures/browser')
const Peers = require('./test/fixtures/peers')
const PeerId = require('peer-id')
const WebSockets = require('libp2p-websockets')
const Muxer = require('libp2p-mplex')
const { NOISE: Crypto } = require('@chainsafe/libp2p-noise')
const pipe = require('it-pipe')
let libp2p
const before = async () => {
// Use the last peer
const peerId = await PeerId.createFromJSON(Peers[Peers.length - 1])
libp2p = new Libp2p({
addresses: {
listen: [MULTIADDRS_WEBSOCKETS[0]]
},
peerId,
modules: {
transport: [WebSockets],
streamMuxer: [Muxer],
connEncryption: [Crypto]
},
config: {
relay: {
enabled: true,
hop: {
enabled: true,
active: false
}
},
nat: {
enabled: false
}
}
})
// Add the echo protocol
libp2p.handle('/echo/1.0.0', ({ stream }) => pipe(stream, stream))
await libp2p.start()
}
const after = async () => {
await libp2p.stop()
}
/** @type {import('aegir').Options["build"]["config"]} */
const esbuild = {
inject: [path.join(__dirname, './scripts/node-globals.js')]
}
/** @type {import('aegir').PartialOptions} */
module.exports = {
build: {
bundlesizeMax: '253kB'
},
test: {
before,
after,
browser: {
config: {
buildConfig: esbuild
}
}
}
}

View File

@ -4,5 +4,5 @@ updates:
directory: "/" directory: "/"
schedule: schedule:
interval: daily interval: daily
time: "11:00" time: "10:00"
open-pull-requests-limit: 10 open-pull-requests-limit: 10

View File

@ -8,21 +8,8 @@ on:
- '**' - '**'
jobs: jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest]
node: [16]
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 16
- uses: ipfs/aegir/actions/cache-node-modules@master
check: check:
needs: build
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
@ -30,15 +17,11 @@ jobs:
with: with:
node-version: lts/* node-version: lts/*
- uses: ipfs/aegir/actions/cache-node-modules@master - uses: ipfs/aegir/actions/cache-node-modules@master
- run: npx aegir lint - run: npm run --if-present lint
- run: npx aegir dep-check - run: npm run --if-present dep-check
- uses: ipfs/aegir/actions/bundle-size@master
name: size
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
test-node: test-node:
needs: build needs: check
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
strategy: strategy:
matrix: matrix:
@ -51,14 +34,14 @@ jobs:
with: with:
node-version: ${{ matrix.node }} node-version: ${{ matrix.node }}
- uses: ipfs/aegir/actions/cache-node-modules@master - uses: ipfs/aegir/actions/cache-node-modules@master
- run: npm run test:node -- --cov --bail - run: npm run --if-present test:node
- uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
with: with:
directory: ./.nyc_output directory: ./.nyc_output
flags: node flags: node
test-chrome: test-chrome:
needs: build needs: check
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
@ -66,14 +49,14 @@ jobs:
with: with:
node-version: lts/* node-version: lts/*
- uses: ipfs/aegir/actions/cache-node-modules@master - uses: ipfs/aegir/actions/cache-node-modules@master
- run: npm run test:browser -- -t browser --cov --bail - run: npm run --if-present test:chrome
- uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
with: with:
directory: ./.nyc_output directory: ./.nyc_output
flags: chrome flags: chrome
test-chrome-webworker: test-chrome-webworker:
needs: build needs: check
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
@ -81,14 +64,14 @@ jobs:
with: with:
node-version: lts/* node-version: lts/*
- uses: ipfs/aegir/actions/cache-node-modules@master - uses: ipfs/aegir/actions/cache-node-modules@master
- run: npm run test:browser -- -t webworker --bail - run: npm run --if-present test:chrome-webworker
- uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
with: with:
directory: ./.nyc_output directory: ./.nyc_output
flags: chrome-webworker flags: chrome-webworker
test-firefox: test-firefox:
needs: build needs: check
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
@ -96,14 +79,14 @@ jobs:
with: with:
node-version: lts/* node-version: lts/*
- uses: ipfs/aegir/actions/cache-node-modules@master - uses: ipfs/aegir/actions/cache-node-modules@master
- run: npm run test:browser -- -t browser --bail -- --browser firefox - run: npm run --if-present test:firefox
- uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
with: with:
directory: ./.nyc_output directory: ./.nyc_output
flags: firefox flags: firefox
test-firefox-webworker: test-firefox-webworker:
needs: build needs: check
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
@ -111,14 +94,14 @@ jobs:
with: with:
node-version: lts/* node-version: lts/*
- uses: ipfs/aegir/actions/cache-node-modules@master - uses: ipfs/aegir/actions/cache-node-modules@master
- run: npm run test:browser -- -t webworker --bail -- --browser firefox - run: npm run --if-present test:firefox-webworker
- uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0 - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
with: with:
directory: ./.nyc_output directory: ./.nyc_output
flags: firefox-webworker flags: firefox-webworker
test-ts: test-electron-main:
needs: build needs: check
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
@ -126,10 +109,29 @@ jobs:
with: with:
node-version: lts/* node-version: lts/*
- uses: ipfs/aegir/actions/cache-node-modules@master - uses: ipfs/aegir/actions/cache-node-modules@master
- run: npm run test:ts - run: npx xvfb-maybe npm run --if-present test:electron-main
- uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
with:
directory: ./.nyc_output
flags: electron-main
test-electron-renderer:
needs: check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: lts/*
- uses: ipfs/aegir/actions/cache-node-modules@master
- run: npx xvfb-maybe npm run --if-present test:electron-renderer
- uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
with:
directory: ./.nyc_output
flags: electron-renderer
test-interop: test-interop:
needs: build needs: check
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
@ -137,11 +139,11 @@ jobs:
with: with:
node-version: lts/* node-version: lts/*
- uses: ipfs/aegir/actions/cache-node-modules@master - uses: ipfs/aegir/actions/cache-node-modules@master
- run: npm run test:interop -- --bail -- --exit - run: npm run test:interop -- --bail
release: release:
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: [test-node, test-chrome, test-chrome-webworker, test-firefox, test-firefox-webworker, test-ts, test-interop] needs: [test-node, test-chrome, test-chrome-webworker, test-firefox, test-firefox-webworker, test-electron-main, test-electron-renderer, test-interop]
if: github.event_name == 'push' && github.ref == 'refs/heads/master' if: github.event_name == 'push' && github.ref == 'refs/heads/master'
steps: steps:
- uses: GoogleCloudPlatform/release-please-action@v2 - uses: GoogleCloudPlatform/release-please-action@v2

24
LICENSE
View File

@ -1,22 +1,4 @@
The MIT License (MIT) This project is dual licensed under MIT and Apache-2.0.
Copyright (c) 2015 David Dias
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
MIT: https://www.opensource.org/licenses/mit
Apache-2.0: https://www.apache.org/licenses/license-2.0

5
LICENSE-APACHE Normal file
View File

@ -0,0 +1,5 @@
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

19
LICENSE-MIT Normal file
View File

@ -0,0 +1,19 @@
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

View File

@ -39,26 +39,22 @@ If you are looking for the documentation of the latest release, you can view the
**Want to update libp2p in your project?** Check our [migrations folder](./doc/migrations). **Want to update libp2p in your project?** Check our [migrations folder](./doc/migrations).
[**`Weekly Core Dev Calls`**](https://github.com/libp2p/team-mgmt/issues/16) ## Table of Contents <!-- omit in toc -->
## Lead Maintainer
[Jacob Heun](https://github.com/jacobheun/)
## Table of Contents
- [Background](#background) - [Background](#background)
- [Install](#install) - [Install](#install)
- [Usage](#usage) - [Usage](#usage)
- [Configuration](#configuration) - [Configuration](#configuration)
- [API](#api) - [API](#api)
- [Getting Started](#getting-started) - [Getting started](#getting-started)
- [Tutorials and Examples](#tutorials-and-examples) - [Tutorials and Examples](#tutorials-and-examples)
- [Development](#development) - [Development](#development)
- [Tests](#tests) - [Tests](#tests)
- [Run unit tests](#run-unit-tests)
- [Packages](#packages) - [Packages](#packages)
- [Contribute](#contribute) - [Contribute](#contribute)
- [License](#license) - [License](#license)
- [Contribution](#contribution)
## Background ## Background
@ -123,7 +119,7 @@ You can find multiple examples on the [examples folder](./examples) that will gu
> npm run test:node > npm run test:node
# run just Browser tests (Chrome) # run just Browser tests (Chrome)
> npm run test:browser > npm run test:chrome
``` ```
### Packages ### Packages
@ -183,4 +179,11 @@ The libp2p implementation in JavaScript is a work in progress. As such, there ar
## License ## License
[MIT](LICENSE) © Protocol Labs Licensed under either of
* Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
* MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

View File

@ -119,23 +119,21 @@ For Libp2p configurations and modules details read the [Configuration Document](
#### Example #### Example
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
async function main () { async function main () {
// specify options // specify options
const options = { const options = {
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
}
} }
// create libp2p // create libp2p
const libp2p = await Libp2p.create(options) const libp2p = await createLibp2p(options)
} }
main() main()
@ -149,11 +147,11 @@ As an alternative, it is possible to create a Libp2p instance with the construct
#### Example #### Example
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const PeerId = require('peer-id')
async function main () { async function main () {
const peerId = await PeerId.create(); const peerId = await PeerId.create();
@ -162,11 +160,9 @@ async function main () {
// peerId is required when Libp2p is instantiated via the constructor // peerId is required when Libp2p is instantiated via the constructor
const options = { const options = {
peerId, peerId,
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
}
} }
// create libp2p // create libp2p
@ -200,11 +196,11 @@ Load keychain keys from the datastore, importing the private key as 'self', if n
#### Example #### Example
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
// ... // ...
const libp2p = await Libp2p.create({ const libp2p = await createLibp2p({
// ... // ...
keychain: { keychain: {
pass: '0123456789pass1234567890' pass: '0123456789pass1234567890'
@ -230,11 +226,11 @@ Starts the libp2p node.
#### Example #### Example
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
// ... // ...
const libp2p = await Libp2p.create(options) const libp2p = await createLibp2p(options)
// start libp2p // start libp2p
await libp2p.start() await libp2p.start()
@ -255,10 +251,10 @@ Stops the libp2p node.
#### Example #### Example
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
// ... // ...
const libp2p = await Libp2p.create(options) const libp2p = await createLibp2p(options)
// ... // ...
// stop libp2p // stop libp2p
@ -354,7 +350,7 @@ Dials to another peer in the network and selects a protocol to communicate with
```js ```js
// ... // ...
const pipe = require('it-pipe') import { pipe } from 'it-pipe'
const { stream, protocol } = await libp2p.dialProtocol(remotePeerId, protocols) const { stream, protocol } = await libp2p.dialProtocol(remotePeerId, protocols)

View File

@ -199,9 +199,9 @@ When [creating a libp2p node](./API.md#create), the modules needed should be spe
```js ```js
const modules = { const modules = {
transport: [], transports: [],
streamMuxer: [], streamMuxers: [],
connEncryption: [], connectionEncryption: [],
contentRouting: [], contentRouting: [],
peerRouting: [], peerRouting: [],
peerDiscovery: [], peerDiscovery: [],
@ -235,67 +235,59 @@ Besides the `modules` and `config`, libp2p allows other internal options and con
// dht: kad-dht // dht: kad-dht
// pubsub: gossipsub // pubsub: gossipsub
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const WS = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MulticastDNS = require('libp2p-mdns') import { MulticastDNS } from '@libp2p/mdns'
const DHT = require('libp2p-kad-dht') import { KadDHT } from '@libp2p/kad-dht'
const GossipSub = require('libp2p-gossipsub') import { GossipSub } from 'libp2p-gossipsub'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [ TCP,
TCP, new WS() // It can take instances too!
new WS() // It can take instances too! ],
], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE], peerDiscovery: [MulticastDNS],
peerDiscovery: [MulticastDNS], dht: DHT,
dht: DHT, pubsub: GossipSub
pubsub: GossipSub
}
}) })
``` ```
#### Customizing Peer Discovery #### Customizing Peer Discovery
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MulticastDNS = require('libp2p-mdns') import { MulticastDNS } from '@libp2p/mdns'
const Bootstrap = require('libp2p-bootstrap') import { Bootstrap } from '@libp2p/bootstrap'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE], peerDiscovery: [
peerDiscovery: [MulticastDNS, Bootstrap] new MulticastDNS({
}, interval: 1000
config: { }),
peerDiscovery: { new Bootstrap(
autoDial: true, // Auto connect to discovered peers (limited by ConnectionManager minConnections) list: [ // A list of bootstrap peers to connect to starting up the node
// The `tag` property will be searched when creating the instance of your Peer Discovery service. "/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ",
// The associated object, will be passed to the service when it is instantiated. "/dnsaddr/bootstrap.libp2p.io/ipfs/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN",
[MulticastDNS.tag]: { "/dnsaddr/bootstrap.libp2p.io/ipfs/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa",
interval: 1000, ],
enabled: true interval: 2000
}, )
[Bootstrap.tag]: { ],
list: [ // A list of bootstrap peers to connect to starting up the node connectionManager: {
"/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ", autoDial: true // Auto connect to discovered peers (limited by ConnectionManager minConnections)
"/dnsaddr/bootstrap.libp2p.io/ipfs/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN", // The `tag` property will be searched when creating the instance of your Peer Discovery service.
"/dnsaddr/bootstrap.libp2p.io/ipfs/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa", // The associated object, will be passed to the service when it is instantiated.
],
interval: 2000,
enabled: true
}
// .. other discovery module options.
}
} }
}) })
``` ```
@ -303,56 +295,50 @@ const node = await Libp2p.create({
#### Setup webrtc transport and discovery #### Setup webrtc transport and discovery
```js ```js
import { createLibp2p } from 'libp2p'
import { WebSockets } from '@libp2p/websockets'
import { WebRTCStar } from '@libp2p/webrtc-star'
import { Mplex } from '@libp2p/mplex'
import { Noise } from '@chainsafe/libp2p-noise'
const Libp2p = require('libp2p') const node = await createLibp2p({
const WS = require('libp2p-websockets') transports: [
const WebRTCStar = require('libp2p-webrtc-star') new WebSockets(),
const MPLEX = require('libp2p-mplex') new WebRTCStar()
const { NOISE } = require('libp2p-noise') ],
streamMuxers: [
const node = await Libp2p.create({ new Mplex()
modules: { ],
transport: [ connectionEncryption: [
WS, new Noise()
WebRTCStar ]
],
streamMuxer: [MPLEX],
connEncryption: [NOISE],
},
config: {
peerDiscovery: {
[WebRTCStar.tag]: {
enabled: true
}
}
}
}) })
``` ```
#### Customizing Pubsub #### Customizing Pubsub
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const GossipSub = require('libp2p-gossipsub') import { GossipSub } from 'libp2p-gossipsub'
import { SignaturePolicy } from '@libp2p/interfaces/pubsub'
const { SignaturePolicy } = require('libp2p-interfaces/src/pubsub/signature-policy') const node = await createLibp2p({
transports: [
const node = await Libp2p.create({ new TCP()
modules: { ],
transport: [TCP], streamMuxers: [
streamMuxer: [MPLEX], new Mplex()
connEncryption: [NOISE], ],
pubsub: GossipSub connectionEncryption: [
}, new Noise()
config: { ],
pubsub: { // The pubsub options (and defaults) can be found in the pubsub router documentation pubsub: new GossipSub({
enabled: true,
emitSelf: false, // whether the node should emit to self on publish emitSelf: false, // whether the node should emit to self on publish
globalSignaturePolicy: SignaturePolicy.StrictSign // message signing policy globalSignaturePolicy: SignaturePolicy.StrictSign // message signing policy
} })
} }
}) })
``` ```
@ -360,64 +346,66 @@ const node = await Libp2p.create({
#### Customizing DHT #### Customizing DHT
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const DHT = require('libp2p-kad-dht') import { KadDHT } from '@libp2p/kad-dht'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [TCP], new TCP()
streamMuxer: [MPLEX], ],
connEncryption: [NOISE], streamMuxers: [
dht: DHT new Mplex()
}, ],
config: { connectionEncryption: [
dht: { // The DHT options (and defaults) can be found in its documentation new Noise()
kBucketSize: 20, ],
enabled: true, // This flag is required for DHT to run (disabled by default) dht: new KadDHT({
clientMode: false // Whether to run the WAN DHT in client or server mode (default: client mode) kBucketSize: 20,
} clientMode: false // Whether to run the WAN DHT in client or server mode (default: client mode)
} })
}) })
``` ```
#### Setup with Content and Peer Routing #### Setup with Content and Peer Routing
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const ipfsHttpClient = require('ipfs-http-client') import { create as ipfsHttpClient } from 'ipfs-http-client'
const DelegatedPeerRouter = require('libp2p-delegated-peer-routing') import { DelegatedPeerRouting } from '@libp2p/delegated-peer-routing'
const DelegatedContentRouter = require('libp2p-delegated-content-routing') import { DelegatedContentRouting} from '@libp2p/delegated-content-routing'
const PeerId = require('peer-id')
// create a peerId // create a peerId
const peerId = await PeerId.create() const peerId = await PeerId.create()
const delegatedPeerRouting = new DelegatedPeerRouter(ipfsHttpClient.create({ const delegatedPeerRouting = new DelegatedPeerRouting(ipfsHttpClient.create({
host: 'node0.delegate.ipfs.io', // In production you should setup your own delegates host: 'node0.delegate.ipfs.io', // In production you should setup your own delegates
protocol: 'https', protocol: 'https',
port: 443 port: 443
})) }))
const delegatedContentRouting = new DelegatedContentRouter(peerId, ipfsHttpClient.create({ const delegatedContentRouting = new DelegatedContentRouting(peerId, ipfsHttpClient.create({
host: 'node0.delegate.ipfs.io', // In production you should setup your own delegates host: 'node0.delegate.ipfs.io', // In production you should setup your own delegates
protocol: 'https', protocol: 'https',
port: 443 port: 443
})) }))
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE], contentRouting: [
contentRouting: [delegatedContentRouting], delegatedContentRouting
peerRouting: [delegatedPeerRouting], ],
}, peerRouting: [
delegatedPeerRouting
],
peerId, peerId,
peerRouting: { // Peer routing configuration peerRouting: { // Peer routing configuration
refreshManager: { // Refresh known and connected closest peers refreshManager: { // Refresh known and connected closest peers
@ -432,29 +420,25 @@ const node = await Libp2p.create({
#### Setup with Relay #### Setup with Relay
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE] relay: { // Circuit Relay options (this config is part of libp2p core configurations)
}, enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay.
config: { hop: {
relay: { // Circuit Relay options (this config is part of libp2p core configurations) enabled: true, // Allows you to be a relay for other peers
enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay. active: true // You will attempt to dial destination peers if you are not connected to them
hop: { },
enabled: true, // Allows you to be a relay for other peers advertise: {
active: true // You will attempt to dial destination peers if you are not connected to them bootDelay: 15 * 60 * 1000, // Delay before HOP relay service is advertised on the network
}, enabled: true, // Allows you to disable the advertise of the Hop service
advertise: { ttl: 30 * 60 * 1000 // Delay Between HOP relay service advertisements on the network
bootDelay: 15 * 60 * 1000, // Delay before HOP relay service is advertised on the network
enabled: true, // Allows you to disable the advertise of the Hop service
ttl: 30 * 60 * 1000 // Delay Between HOP relay service advertisements on the network
}
} }
} }
}) })
@ -463,24 +447,20 @@ const node = await Libp2p.create({
#### Setup with Auto Relay #### Setup with Auto Relay
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()]
connEncryption: [NOISE] relay: { // Circuit Relay options (this config is part of libp2p core configurations)
}, enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay.
config: { autoRelay: {
relay: { // Circuit Relay options (this config is part of libp2p core configurations) enabled: true, // Allows you to bind to relays with HOP enabled for improving node dialability
enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay. maxListeners: 2 // Configure maximum number of HOP relays to use
autoRelay: {
enabled: true, // Allows you to bind to relays with HOP enabled for improving node dialability
maxListeners: 2 // Configure maximum number of HOP relays to use
}
} }
} }
}) })
@ -496,21 +476,19 @@ Libp2p allows you to setup a secure keychain to manage your keys. The keychain c
| datastore | `object` | must implement [ipfs/interface-datastore](https://github.com/ipfs/interface-datastore) | | datastore | `object` | must implement [ipfs/interface-datastore](https://github.com/ipfs/interface-datastore) |
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const { LevelDatastore } = require('datastore-level') import { LevelDatastore } from 'datastore-level'
const datastore = new LevelDatastore('path/to/store') const datastore = new LevelDatastore('path/to/store')
await datastore.open() await datastore.open()
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE]
},
keychain: { keychain: {
pass: 'notsafepassword123456789', pass: 'notsafepassword123456789',
datastore: dsInstant, datastore: dsInstant,
@ -536,20 +514,18 @@ Dialing in libp2p can be configured to limit the rate of dialing, and how long d
The below configuration example shows how the dialer should be configured, with the current defaults: The below configuration example shows how the dialer should be configured, with the current defaults:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const { dnsaddrResolver } = require('multiaddr/src/resolvers') import { dnsaddrResolver } from '@multiformats/multiaddr/resolvers'
const { publicAddressesFirst } = require('libp2p-utils/src/address-sort') import { publicAddressesFirst } from '@libp2p-utils/address-sort'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE]
},
dialer: { dialer: {
maxParallelDials: 100, maxParallelDials: 100,
maxAddrsToDial: 25, maxAddrsToDial: 25,
@ -567,17 +543,15 @@ const node = await Libp2p.create({
The Connection Manager prunes Connections in libp2p whenever certain limits are exceeded. If Metrics are enabled, you can also configure the Connection Manager to monitor the bandwidth of libp2p and prune connections as needed. You can read more about what Connection Manager does at [./CONNECTION_MANAGER.md](./CONNECTION_MANAGER.md). The configuration values below show the defaults for Connection Manager. See [./CONNECTION_MANAGER.md](./CONNECTION_MANAGER.md#options) for a full description of the parameters. The Connection Manager prunes Connections in libp2p whenever certain limits are exceeded. If Metrics are enabled, you can also configure the Connection Manager to monitor the bandwidth of libp2p and prune connections as needed. You can read more about what Connection Manager does at [./CONNECTION_MANAGER.md](./CONNECTION_MANAGER.md). The configuration values below show the defaults for Connection Manager. See [./CONNECTION_MANAGER.md](./CONNECTION_MANAGER.md#options) for a full description of the parameters.
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE]
},
connectionManager: { connectionManager: {
maxConnections: Infinity, maxConnections: Infinity,
minConnections: 0, minConnections: 0,
@ -615,7 +589,7 @@ The order in which methods are called is as follows:
3. `connectionGater.denyInboundUpgradedConnection(...)` 3. `connectionGater.denyInboundUpgradedConnection(...)`
```js ```js
const node = await Libp2p.create({ const node = await createLibp2p({
// .. other config // .. other config
connectionGater: { connectionGater: {
/** /**
@ -719,19 +693,17 @@ const node = await Libp2p.create({
The Transport Manager is responsible for managing the libp2p transports life cycle. This includes starting listeners for the provided listen addresses, closing these listeners and dialing using the provided transports. By default, if a libp2p node has a list of multiaddrs for listening on and there are no valid transports for those multiaddrs, libp2p will throw an error on startup and shutdown. However, for some applications it is perfectly acceptable for libp2p nodes to start in dial only mode if all the listen multiaddrs failed. This error tolerance can be enabled as follows: The Transport Manager is responsible for managing the libp2p transports life cycle. This includes starting listeners for the provided listen addresses, closing these listeners and dialing using the provided transports. By default, if a libp2p node has a list of multiaddrs for listening on and there are no valid transports for those multiaddrs, libp2p will throw an error on startup and shutdown. However, for some applications it is perfectly acceptable for libp2p nodes to start in dial only mode if all the listen multiaddrs failed. This error tolerance can be enabled as follows:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const { FaultTolerance } = require('libp2p/src/transport-manager') const { FaultTolerance } from 'libp2p/src/transport-manager')
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE]
},
transportManager: { transportManager: {
faultTolerance: FaultTolerance.NO_FATAL faultTolerance: FaultTolerance.NO_FATAL
} }
@ -753,17 +725,15 @@ Metrics are disabled in libp2p by default. You can enable and configure them as
The below configuration example shows how the metrics should be configured. Aside from enabled being `false` by default, the following default configuration options are listed below: The below configuration example shows how the metrics should be configured. Aside from enabled being `false` by default, the following default configuration options are listed below:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
},
metrics: { metrics: {
enabled: true, enabled: true,
computeThrottleMaxQueueSize: 1000, computeThrottleMaxQueueSize: 1000,
@ -792,22 +762,20 @@ The threshold number represents the maximum number of "dirty peers" allowed in t
The below configuration example shows how the PeerStore should be configured. Aside from persistence being `false` by default, the following default configuration options are listed below: The below configuration example shows how the PeerStore should be configured. Aside from persistence being `false` by default, the following default configuration options are listed below:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const LevelDatastore = require('datastore-level') import { LevelDatastore } from 'datastore-level'
const datastore = new LevelDatastore('path/to/store') const datastore = new LevelDatastore('path/to/store')
await datastore.open() // level database must be ready before node boot await datastore.open() // level database must be ready before node boot
const node = await Libp2p.create({ const node = await createLibp2p({
datastore, // pass the opened datastore datastore, // pass the opened datastore
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE]
},
peerStore: { peerStore: {
persistence: true, persistence: true,
threshold: 5 threshold: 5
@ -820,19 +788,23 @@ const node = await Libp2p.create({
Some Transports can be passed additional options when they are created. For example, `libp2p-webrtc-star` accepts an optional, custom `wrtc` implementation. In addition to libp2p passing itself and an `Upgrader` to handle connection upgrading, libp2p will also pass the options, if they are provided, from `config.transport`. Some Transports can be passed additional options when they are created. For example, `libp2p-webrtc-star` accepts an optional, custom `wrtc` implementation. In addition to libp2p passing itself and an `Upgrader` to handle connection upgrading, libp2p will also pass the options, if they are provided, from `config.transport`.
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const WebRTCStar = require('libp2p-webrtc-star') import { WebRTCStar } from '@libp2p/webrtc-star'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const wrtc = require('wrtc') import wrtc from 'wrtc'
const transportKey = WebRTCStar.prototype[Symbol.toStringTag] const transportKey = WebRTCStar.prototype[Symbol.toStringTag]
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [WebRTCStar], new WebRTCStar()
streamMuxer: [MPLEX], ],
connEncryption: [NOISE] streamMuxers: [
}, new Mplex()
],
connectionEncryption: [
new Noise()
],
config: { config: {
transport: { transport: {
[transportKey]: { [transportKey]: {
@ -847,12 +819,16 @@ During Libp2p startup, transport listeners will be created for the configured li
```js ```js
const transportKey = WebRTCStar.prototype[Symbol.toStringTag] const transportKey = WebRTCStar.prototype[Symbol.toStringTag]
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [WebRTCStar], new WebRTCStar()
streamMuxer: [MPLEX], ],
connEncryption: [NOISE] streamMuxers: [
}, new Mplex()
],
connectionEncryption: [
new Noise()
],
addresses: { addresses: {
listen: ['/dns4/your-wrtc-star.pub/tcp/443/wss/p2p-webrtc-star'] // your webrtc dns multiaddr listen: ['/dns4/your-wrtc-star.pub/tcp/443/wss/p2p-webrtc-star'] // your webrtc dns multiaddr
}, },
@ -879,18 +855,16 @@ Network Address Translation (NAT) is a function performed by your router to enab
The NAT manager can be configured as follows: The NAT manager can be configured as follows:
```js ```js
const node = await Libp2p.create({ const node = await createLibp2p({
config: { config: {
nat: { nat: {
description: 'my-node', // set as the port mapping description on the router, defaults the current libp2p version and your peer id description: 'my-node', // set as the port mapping description on the router, defaults the current libp2p version and your peer id
enabled: true, // defaults to true enabled: true, // defaults to true
gateway: '192.168.1.1', // leave unset to auto-discover gateway: '192.168.1.1', // leave unset to auto-discover
externalIp: '80.1.1.1', // leave unset to auto-discover externalIp: '80.1.1.1', // leave unset to auto-discover
localAddress: '129.168.1.123', // leave unset to auto-discover
ttl: 7200, // TTL for port mappings (min 20 minutes) ttl: 7200, // TTL for port mappings (min 20 minutes)
keepAlive: true, // Refresh port mapping after TTL expires keepAlive: true, // Refresh port mapping after TTL expires
pmp: {
enabled: false, // defaults to false
}
} }
} }
}) })
@ -911,10 +885,8 @@ By default under nodejs libp2p will attempt to use [UPnP](https://en.wikipedia.o
Changing the protocol name prefix can isolate default public network (IPFS) for custom purposes. Changing the protocol name prefix can isolate default public network (IPFS) for custom purposes.
```js ```js
const node = await Libp2p.create({ const node = await createLibp2p({
config: { protocolPrefix: 'ipfs' // default
protocolPrefix: 'ipfs' // default
}
}) })
/* /*
protocols: [ protocols: [
@ -925,7 +897,6 @@ protocols: [
*/ */
``` ```
## Configuration examples ## Configuration examples
As libp2p is designed to be a modular networking library, its usage will vary based on individual project needs. We've included links to some existing project configurations for your reference, in case you wish to replicate their configuration: As libp2p is designed to be a modular networking library, its usage will vary based on individual project needs. We've included links to some existing project configurations for your reference, in case you wish to replicate their configuration:

View File

@ -12,7 +12,6 @@ Welcome to libp2p! This guide will walk you through setting up a fully functiona
- [Running Libp2p](#running-libp2p) - [Running Libp2p](#running-libp2p)
- [Custom setup](#custom-setup) - [Custom setup](#custom-setup)
- [Peer Discovery](#peer-discovery) - [Peer Discovery](#peer-discovery)
- [Pubsub](#pubsub)
- [What is next](#what-is-next) - [What is next](#what-is-next)
## Install ## Install
@ -46,13 +45,11 @@ npm install libp2p-websockets
Now that we have the module installed, let's configure libp2p to use the Transport. We'll use the [`Libp2p.create`](./API.md#create) method, which takes a single configuration object as its only parameter. We can add the Transport by passing it into the `modules.transport` array: Now that we have the module installed, let's configure libp2p to use the Transport. We'll use the [`Libp2p.create`](./API.md#create) method, which takes a single configuration object as its only parameter. We can add the Transport by passing it into the `modules.transport` array:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const WebSockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new WebSockets()]
transport: [WebSockets]
}
}) })
``` ```
@ -78,15 +75,13 @@ npm install libp2p-noise
With `libp2p-noise` installed, we can add it to our existing configuration by importing it and adding it to the `modules.connEncryption` array: With `libp2p-noise` installed, we can add it to our existing configuration by importing it and adding it to the `modules.connEncryption` array:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const WebSockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new WebSockets()],
transport: [WebSockets], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
}
}) })
``` ```
@ -110,17 +105,15 @@ npm install libp2p-mplex
``` ```
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const WebSockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new WebSockets()],
transport: [WebSockets], connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()]
streamMuxer: [MPLEX]
}
}) })
``` ```
@ -137,20 +130,18 @@ If you want to know more about libp2p stream multiplexing, you should read the f
Now that you have configured a [**Transport**][transport], [**Crypto**][crypto] and [**Stream Multiplexer**](streamMuxer) module, you can start your libp2p node. We can start and stop libp2p using the [`libp2p.start()`](./API.md#start) and [`libp2p.stop()`](./API.md#stop) methods. Now that you have configured a [**Transport**][transport], [**Crypto**][crypto] and [**Stream Multiplexer**](streamMuxer) module, you can start your libp2p node. We can start and stop libp2p using the [`libp2p.start()`](./API.md#start) and [`libp2p.stop()`](./API.md#stop) methods.
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const WebSockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/127.0.0.1/tcp/8000/ws'] listen: ['/ip4/127.0.0.1/tcp/8000/ws']
}, },
modules: { transports: [new WebSockets()],
transport: [WebSockets], connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()]
streamMuxer: [MPLEX]
}
}) })
// start libp2p // start libp2p
@ -195,12 +186,12 @@ npm install libp2p-bootstrap
We can provide specific configurations for each protocol within a `config.peerDiscovery` property in the options as shown below. We can provide specific configurations for each protocol within a `config.peerDiscovery` property in the options as shown below.
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const WebSockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const Bootstrap = require('libp2p-bootstrap') import { Bootstrap } from '@libp2p/bootstrap'
// Known peers addresses // Known peers addresses
const bootstrapMultiaddrs = [ const bootstrapMultiaddrs = [
@ -208,23 +199,25 @@ const bootstrapMultiaddrs = [
'/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN' '/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN'
] ]
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [WebSockets], new WebSockets()
connEncryption: [NOISE], ],
streamMuxer: [MPLEX], connectionEncryption: [
peerDiscovery: [Bootstrap] new Noise()
}, ],
config: { streamMuxers: [
peerDiscovery: { new Mplex()
autoDial: true, // Auto connect to discovered peers (limited by ConnectionManager minConnections) ],
// The `tag` property will be searched when creating the instance of your Peer Discovery service. peerDiscovery: [
// The associated object, will be passed to the service when it is instantiated. new Bootstrap({
[Bootstrap.tag]: { list: bootstrapMultiaddrs // provide array of multiaddrs
enabled: true, })
list: bootstrapMultiaddrs // provide array of multiaddrs ],
} connectionManager: {
} autoDial: true, // Auto connect to discovered peers (limited by ConnectionManager minConnections)
// The `tag` property will be searched when creating the instance of your Peer Discovery service.
// The associated object, will be passed to the service when it is instantiated.
} }
}) })

View File

@ -3,7 +3,7 @@
**Synopsis**: **Synopsis**:
* All peers discovered are emitted via `peer:discovery` so applications can take any desired action. * All peers discovered are emitted via `peer:discovery` so applications can take any desired action.
* Libp2p defaults to automatically connecting to new peers, when under the [ConnectionManager](https://github.com/libp2p/js-libp2p-connection-manager) low watermark (minimum peers). * Libp2p defaults to automatically connecting to new peers, when under the [ConnectionManager](https://github.com/libp2p/js-libp2p-connection-manager) low watermark (minimum peers).
* Applications can disable this via the `peerDiscovery.autoDial` config property, and handle connections themselves. * Applications can disable this via the `connectionManager.autoDial` config property, and handle connections themselves.
* Applications who have not disabled this should **never** connect on peer discovery. Applications should use the `peer:connect` event if they wish to take a specific action on new peers. * Applications who have not disabled this should **never** connect on peer discovery. Applications should use the `peer:connect` event if they wish to take a specific action on new peers.
## Scenarios ## Scenarios

View File

@ -22,8 +22,8 @@
Sometimes you may need to wrap an existing duplex stream in order to perform incoming and outgoing [transforms](#transform) on data. This type of wrapping is commonly used in stream encryption/decryption. Using [it-pair][it-pair] and [it-pipe][it-pipe], we can do this rather easily, given an existing [duplex iterable](#duplex). Sometimes you may need to wrap an existing duplex stream in order to perform incoming and outgoing [transforms](#transform) on data. This type of wrapping is commonly used in stream encryption/decryption. Using [it-pair][it-pair] and [it-pipe][it-pipe], we can do this rather easily, given an existing [duplex iterable](#duplex).
```js ```js
const duplexPair = require('it-pair/duplex') const duplexPair from 'it-pair/duplex')
const pipe = require('it-pipe') import { pipe } from 'it-pipe'
// Wrapper is what we will write and read from // Wrapper is what we will write and read from
// This gives us two duplex iterables that are internally connected // This gives us two duplex iterables that are internally connected

View File

@ -4,16 +4,18 @@ A migration guide for refactoring your application code from libp2p v0.26.x to v
## Table of Contents ## Table of Contents
- [Migrating from callbacks](#migrating-from-callbacks) - [Migrating to the libp2p@0.27 API](#migrating-to-the-libp2p027-api)
- [Pull Streams to Streaming Iterables](#pull-streams-to-streaming-iterables) - [Table of Contents](#table-of-contents)
- [Sample API Migrations](#sample-api-migrations) - [Migrating from callbacks](#migrating-from-callbacks)
- [Registering Protocol Handlers](#registering-protocol-handlers) - [Pull Streams to Streaming Iterables](#pull-streams-to-streaming-iterables)
- [Dialing and Sending Data](#dialing-and-sending-data) - [Sample API Migrations](#sample-api-migrations)
- [Checking if a peer is connected](#checking-if-a-peer-is-connected) - [Registering Protocol Handlers](#registering-protocol-handlers)
- [Pinging another peer](#pinging-another-peer) - [Dialing and Sending Data](#dialing-and-sending-data)
- [Pubsub](#pubsub) - [Checking if a peer is connected](#checking-if-a-peer-is-connected)
- [Getting subscribers](#getting-subscribers) - [Pinging another peer](#pinging-another-peer)
- [Getting subscribed topics](#getting-subscribed-topics) - [Pubsub](#pubsub)
- [Getting subscribers](#getting-subscribers)
- [Getting subscribed topics](#getting-subscribed-topics)
## Migrating from callbacks ## Migrating from callbacks
@ -47,13 +49,13 @@ Protocol registration is very similar to how it previously was, however, the han
**Before** **Before**
```js ```js
const pull = require('pull-stream') const pull from 'pull-stream')
libp2p.handle('/echo/1.0.0', (protocol, conn) => pull(conn, conn)) libp2p.handle('/echo/1.0.0', (protocol, conn) => pull(conn, conn))
``` ```
**After** **After**
```js ```js
const pipe = require('it-pipe') const pipe from 'it-pipe')
libp2p.handle(['/echo/1.0.0'], ({ protocol, stream }) => pipe(stream, stream)) libp2p.handle(['/echo/1.0.0'], ({ protocol, stream }) => pipe(stream, stream))
``` ```
@ -63,7 +65,7 @@ libp2p.handle(['/echo/1.0.0'], ({ protocol, stream }) => pipe(stream, stream))
**Before** **Before**
```js ```js
const pull = require('pull-stream') const pull from 'pull-stream')
libp2p.dialProtocol(peerInfo, '/echo/1.0.0', (err, conn) => { libp2p.dialProtocol(peerInfo, '/echo/1.0.0', (err, conn) => {
if (err) { throw err } if (err) { throw err }
pull( pull(
@ -80,7 +82,7 @@ libp2p.dialProtocol(peerInfo, '/echo/1.0.0', (err, conn) => {
**After** **After**
```js ```js
const pipe = require('it-pipe') const pipe from 'it-pipe')
const { protocol, stream } = await libp2p.dialProtocol(peerInfo, '/echo/1.0.0') const { protocol, stream } = await libp2p.dialProtocol(peerInfo, '/echo/1.0.0')
await pipe( await pipe(
['hey'], ['hey'],

View File

@ -16,7 +16,7 @@ A migration guide for refactoring your application code from libp2p v0.27.x to v
In `libp2p@0.27` we integrated the PeerStore (former [peer-book](https://github.com/libp2p/js-peer-book)) into the codebase. By that time, it was not documented in the [API DOC](../API.md) since it kept the same API as the `peer-book` and it was expected to be completelly rewritten in `libp2p@0.28`. In `libp2p@0.27` we integrated the PeerStore (former [peer-book](https://github.com/libp2p/js-peer-book)) into the codebase. By that time, it was not documented in the [API DOC](../API.md) since it kept the same API as the `peer-book` and it was expected to be completelly rewritten in `libp2p@0.28`.
Moving towards a separation of concerns regarding known peers' data, as well as enabling PeerStore persistence, the PeerStore is now divided into four main components: `AddressBook`, `ProtoBook`, `KeyBook` and `MetadataBook`. This resulted in API changes in the PeerStore, since each type of peer data should now be added in an atomic fashion. Moving towards a separation of concerns regarding known peers' data, as well as enabling PeerStore persistence, the PeerStore is now divided into four main components: `AddressBook`, `ProtoBook`, `KeyBook` and `MetadataBook`. This resulted in API changes in the PeerStore, since each type of peer data should now be added in an atomic fashion.
### Adding a Peer ### Adding a Peer
@ -109,7 +109,7 @@ const peers = libp2p.peerStore.peers
Since this PeerInfo instances were navigating through the entire codebases, some data inconsistencies could be observed in libp2p. Different libp2p subsystems were running with different visions of the known peers data. For instance, a libp2p subsystem receives a copy of this instance with the peer multiaddrs and protocols, but if new data of the peer is obtained from other subsystem, it would not be updated on the former. Moreover, considering that several subsystems were modifying the peer data, libp2p had no way to determine the accurate data. Since this PeerInfo instances were navigating through the entire codebases, some data inconsistencies could be observed in libp2p. Different libp2p subsystems were running with different visions of the known peers data. For instance, a libp2p subsystem receives a copy of this instance with the peer multiaddrs and protocols, but if new data of the peer is obtained from other subsystem, it would not be updated on the former. Moreover, considering that several subsystems were modifying the peer data, libp2p had no way to determine the accurate data.
Considering the complete revamp of the libp2p PeerStore towards its second version, the PeerStore now acts as the single source of truth, we do not need to carry [`PeerInfo`][peer-info] instances around. This also solves all the problems stated above, since subsystems will report new observations to the PeerStore. Considering the complete revamp of the libp2p PeerStore towards its second version, the PeerStore now acts as the single source of truth, we do not need to carry [`PeerInfo`][peer-info] instances around. This also solves all the problems stated above, since subsystems will report new observations to the PeerStore.
### Create ### Create
@ -211,7 +211,7 @@ await libp2p.start()
#### Peer Dialing, Hangup and Ping #### Peer Dialing, Hangup and Ping
`libp2p.dial`, `libp2p.dialProtocol`, `libp2p.hangup` and `libp2p.ping` supported as the target parameter a [`PeerInfo`](peer-info), a [`PeerId`](peer-id), a [`Multiaddr`][multiaddr] and a string representation of the multiaddr. Considering that [`PeerInfo`](peer-info) is being removed from libp2p, all these methods will now support the other 3 possibilities. `libp2p.dial`, `libp2p.dialProtocol`, `libp2p.hangup` and `libp2p.ping` supported as the target parameter a [`PeerInfo`](peer-info), a [`PeerId`](peer-id), a [`Multiaddr`][multiaddr] and a string representation of the multiaddr. Considering that [`PeerInfo`](peer-info) is being removed from libp2p, all these methods will now support the other 3 possibilities.
There is one relevant aspect to consider with this change. When using a [`PeerId`](peer-id), the PeerStore **MUST** have known addresses for that peer in its AddressBook, so that it can perform the request. This was also true in the past, but it is important pointing it out because it might not be enough to switch from using [`PeerInfo`](peer-info) to [`PeerId`](peer-id). When using a [`PeerInfo`](peer-info), the PeerStore was not required to have the multiaddrs when they existed on the PeerInfo instance. There is one relevant aspect to consider with this change. When using a [`PeerId`](peer-id), the PeerStore **MUST** have known addresses for that peer in its AddressBook, so that it can perform the request. This was also true in the past, but it is important pointing it out because it might not be enough to switch from using [`PeerInfo`](peer-info) to [`PeerId`](peer-id). When using a [`PeerInfo`](peer-info), the PeerStore was not required to have the multiaddrs when they existed on the PeerInfo instance.

View File

@ -46,18 +46,18 @@ Publish uses `Uint8Array` data instead of `Buffer`.
const topic = 'topic' const topic = 'topic'
const data = Buffer.from('data') const data = Buffer.from('data')
await libp2p.pubsub.publish(topic, data) await libp2p.pubsub.publish(topic, data)
``` ```
**After** **After**
```js ```js
const uint8ArrayFromString = require('uint8arrays/from-string') const uint8ArrayFromString from 'uint8arrays/from-string')
const topic = 'topic' const topic = 'topic'
const data = uint8ArrayFromString('data') const data = uint8ArrayFromString('data')
await libp2p.pubsub.publish(topic, data) await libp2p.pubsub.publish(topic, data)
``` ```
#### Subscribe #### Subscribe
@ -79,7 +79,7 @@ libp2p.pubsub.subscribe(topic, handler)
**After** **After**
```js ```js
const uint8ArrayToString = require('uint8arrays/to-string') const uint8ArrayToString from 'uint8arrays/to-string')
const topic = 'topic' const topic = 'topic'
const handler = (msg) => { const handler = (msg) => {
@ -106,7 +106,7 @@ libp2p.pubsub.subscribe(topics, handler)
**After** **After**
```js ```js
const uint8ArrayToString = require('uint8arrays/to-string') const uint8ArrayToString from 'uint8arrays/to-string')
const topics = ['a', 'b'] const topics = ['a', 'b']
const handler = (msg) => { const handler = (msg) => {
@ -177,8 +177,8 @@ Aiming to improve libp2p browser support, we are moving away from node core modu
We use the [uint8arrays](https://www.npmjs.com/package/uint8arrays) utilities module to deal with `Uint8Arrays` easily and we recommend its usage in the application layer. Thanks for the module [@achingbrain](https://github.com/achingbrain)! It includes utilities like `compare`, `concat`, `equals`, `fromString` and `toString`. In this migration examples, we will be using the following: We use the [uint8arrays](https://www.npmjs.com/package/uint8arrays) utilities module to deal with `Uint8Arrays` easily and we recommend its usage in the application layer. Thanks for the module [@achingbrain](https://github.com/achingbrain)! It includes utilities like `compare`, `concat`, `equals`, `fromString` and `toString`. In this migration examples, we will be using the following:
```js ```js
const uint8ArrayFromString = require('uint8arrays/from-string') const uint8ArrayFromString from 'uint8arrays/from-string')
const uint8ArrayToString = require('uint8arrays/to-string') const uint8ArrayToString from 'uint8arrays/to-string')
``` ```
#### contentRouting.put #### contentRouting.put

View File

@ -5,9 +5,13 @@ A migration guide for refactoring your application code from libp2p v0.29.x to v
## Table of Contents ## Table of Contents
- [API](#api) - [Migrating to libp2p@30](#migrating-to-libp2p30)
- [Development and Testing](#development-and-testing) - [Table of Contents](#table-of-contents)
- [Module Updates](#module-updates) - [API](#api)
- [Pubsub](#pubsub)
- [Addresses](#addresses)
- [Development and Testing](#development-and-testing)
- [Module Updates](#module-updates)
## API ## API
@ -20,8 +24,8 @@ Now `js-libp2p` does not overwrite the pubsub router options anymore. Upstream p
**Before** **Before**
```js ```js
const Gossipsub = require('libp2p-gossipsub') const Gossipsub from 'libp2p-gossipsub')
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
modules: { modules: {
@ -34,8 +38,8 @@ const libp2p = await Libp2p.create({
**After** **After**
```js ```js
const Gossipsub = require('libp2p-gossipsub') const Gossipsub from 'libp2p-gossipsub')
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
modules: { modules: {
@ -57,8 +61,8 @@ The signing property is now based on a `globalSignaturePolicy` option instead of
**Before** **Before**
```js ```js
const Gossipsub = require('libp2p-gossipsub') const Gossipsub from 'libp2p-gossipsub')
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
modules: { modules: {
@ -77,9 +81,9 @@ const libp2p = await Libp2p.create({
**After** **After**
```js ```js
const Gossipsub = require('libp2p-gossipsub') const Gossipsub from 'libp2p-gossipsub')
const { SignaturePolicy } = require('libp2p-interfaces/src/pubsub/signature-policy') const { SignaturePolicy } from 'libp2p-interfaces/src/pubsub/signature-policy')
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
modules: { modules: {
@ -101,7 +105,7 @@ Libp2p has supported `noAnnounce` addresses configuration for some time now. How
**Before** **Before**
```js ```js
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
addresses: { addresses: {
@ -115,10 +119,10 @@ const libp2p = await Libp2p.create({
**After** **After**
```js ```js
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
// Libp2p utils has several multiaddr utils you can leverage // Libp2p utils has several multiaddr utils you can leverage
const isPrivate = require('libp2p-utils/src/multiaddr/is-private') const isPrivate from 'libp2p-utils/src/multiaddr/is-private')
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
addresses: { addresses: {
@ -131,7 +135,7 @@ const libp2p = await Libp2p.create({
``` ```
It is important pointing out another change regarding address advertising. This is not an API breaking change, but it might have influence on your libp2p setup. It is important pointing out another change regarding address advertising. This is not an API breaking change, but it might have influence on your libp2p setup.
Previously, when using the addresses `announce` property, its multiaddrs were concatenated with the `listen` multiaddrs and then they were filtered out by the `noAnnounce` multiaddrs, in order to create the list of multiaddrs to advertise. Previously, when using the addresses `announce` property, its multiaddrs were concatenated with the `listen` multiaddrs and then they were filtered out by the `noAnnounce` multiaddrs, in order to create the list of multiaddrs to advertise.
In `libp2p@0.30` the logic now operates as follows: In `libp2p@0.30` the logic now operates as follows:
- If `announce` addresses are provided, only they will be announced (no filters are applied) - If `announce` addresses are provided, only they will be announced (no filters are applied)
@ -145,9 +149,9 @@ While this is not an API breaking change, there was a behavioral breaking change
With this new behavior, if you need to use non DNS addresses, you can configure your libp2p node as follows: With this new behavior, if you need to use non DNS addresses, you can configure your libp2p node as follows:
```js ```js
const Websockets = require('libp2p-websockets') const Websockets from 'libp2p-websockets')
const filters = require('libp2p-websockets/src/filters') const filters from 'libp2p-websockets/src/filters')
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
const transportKey = Websockets.prototype[Symbol.toStringTag] const transportKey = Websockets.prototype[Symbol.toStringTag]
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
@ -170,7 +174,7 @@ const libp2p = await Libp2p.create({
With this release you should update the following libp2p modules if you are relying on them: With this release you should update the following libp2p modules if you are relying on them:
<!--Specify module versions in JSON for migration below. <!--Specify module versions in JSON for migration below.
It's recommended to check package.json changes for this: It's recommended to check package.json changes for this:
`git diff <release> <prev> -- package.json` `git diff <release> <prev> -- package.json`
--> -->

View File

@ -100,7 +100,7 @@ const keychain = new Keychain(datastore, {
With this release you should update the following libp2p modules if you are relying on them: With this release you should update the following libp2p modules if you are relying on them:
<!--Specify module versions in JSON for migration below. <!--Specify module versions in JSON for migration below.
It's recommended to check package.json changes for this: It's recommended to check package.json changes for this:
`git diff <release> <prev> -- package.json` `git diff <release> <prev> -- package.json`
--> -->

View File

@ -16,31 +16,27 @@ In the first step of this example, we need to configure and run a relay node in
The relay node will need to have its relay subsystem enabled, as well as its HOP capability. It can be configured as follows: The relay node will need to have its relay subsystem enabled, as well as its HOP capability. It can be configured as follows:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Websockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new WebSockets()],
transport: [Websockets], connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()]
streamMuxer: [MPLEX]
},
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0/ws'] listen: ['/ip4/0.0.0.0/tcp/0/ws']
// TODO check "What is next?" section // TODO check "What is next?" section
// announce: ['/dns4/auto-relay.libp2p.io/tcp/443/wss/p2p/QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3'] // announce: ['/dns4/auto-relay.libp2p.io/tcp/443/wss/p2p/QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3']
}, },
config: { relay: {
relay: { enabled: true,
hop: {
enabled: true
},
advertise: {
enabled: true, enabled: true,
hop: {
enabled: true
},
advertise: {
enabled: true,
}
} }
} }
}) })
@ -74,29 +70,25 @@ Listening on:
One of the typical use cases for Auto Relay is nodes behind a NAT or browser nodes due to their inability to expose a public address. For running a libp2p node that automatically binds itself to connected HOP relays, you can see the following: One of the typical use cases for Auto Relay is nodes behind a NAT or browser nodes due to their inability to expose a public address. For running a libp2p node that automatically binds itself to connected HOP relays, you can see the following:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Websockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const relayAddr = process.argv[2] const relayAddr = process.argv[2]
if (!relayAddr) { if (!relayAddr) {
throw new Error('the relay address needs to be specified as a parameter') throw new Error('the relay address needs to be specified as a parameter')
} }
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new WebSockets()],
transport: [Websockets], connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX] relay: {
}, enabled: true,
config: { autoRelay: {
relay: {
enabled: true, enabled: true,
autoRelay: { maxListeners: 2
enabled: true,
maxListeners: 2
}
} }
} }
}) })
@ -142,22 +134,20 @@ Instead of dialing this relay manually, you could set up this node with the Boot
Now that you have a relay node and a node bound to that relay, you can test connecting to the auto relay node via the relay. Now that you have a relay node and a node bound to that relay, you can test connecting to the auto relay node via the relay.
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Websockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const autoRelayNodeAddr = process.argv[2] const autoRelayNodeAddr = process.argv[2]
if (!autoRelayNodeAddr) { if (!autoRelayNodeAddr) {
throw new Error('the auto relay node address needs to be specified') throw new Error('the auto relay node address needs to be specified')
} }
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new WebSockets()],
transport: [Websockets], connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()]
streamMuxer: [MPLEX]
}
}) })
await node.start() await node.start()

View File

@ -1,9 +1,7 @@
'use strict' import { createLibp2p } from 'libp2p'
import { WebSockets } from '@libp2p/websockets'
const Libp2p = require('libp2p') import { Noise } from '@chainsafe/libp2p-noise'
const Websockets = require('libp2p-websockets') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('@chainsafe/libp2p-noise')
const MPLEX = require('libp2p-mplex')
async function main () { async function main () {
const autoRelayNodeAddr = process.argv[2] const autoRelayNodeAddr = process.argv[2]
@ -11,16 +9,20 @@ async function main () {
throw new Error('the auto relay node address needs to be specified') throw new Error('the auto relay node address needs to be specified')
} }
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [Websockets], new WebSockets()
connEncryption: [NOISE], ],
streamMuxer: [MPLEX] connectionEncryption: [
} new Noise()
],
streamMuxers: [
new Mplex()
]
}) })
await node.start() await node.start()
console.log(`Node started with id ${node.peerId.toB58String()}`) console.log(`Node started with id ${node.peerId.toString()}`)
const conn = await node.dial(autoRelayNodeAddr) const conn = await node.dial(autoRelayNodeAddr)
console.log(`Connected to the auto relay node via ${conn.remoteAddr.toString()}`) console.log(`Connected to the auto relay node via ${conn.remoteAddr.toString()}`)

View File

@ -1,9 +1,7 @@
'use strict' import { createLibp2p } from 'libp2p'
import { WebSockets } from '@libp2p/websockets'
const Libp2p = require('libp2p') import { Noise } from '@chainsafe/libp2p-noise'
const Websockets = require('libp2p-websockets') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('@chainsafe/libp2p-noise')
const MPLEX = require('libp2p-mplex')
async function main () { async function main () {
const relayAddr = process.argv[2] const relayAddr = process.argv[2]
@ -11,37 +9,41 @@ async function main () {
throw new Error('the relay address needs to be specified as a parameter') throw new Error('the relay address needs to be specified as a parameter')
} }
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [Websockets], new WebSockets()
connEncryption: [NOISE], ],
streamMuxer: [MPLEX] connectionEncryption: [
}, new Noise()
config: { ],
relay: { streamMuxers: [
new Mplex()
],
relay: {
enabled: true,
autoRelay: {
enabled: true, enabled: true,
autoRelay: { maxListeners: 2
enabled: true,
maxListeners: 2
}
} }
} }
}) })
await node.start() await node.start()
console.log(`Node started with id ${node.peerId.toB58String()}`) console.log(`Node started with id ${node.peerId.toString()}`)
const conn = await node.dial(relayAddr) const conn = await node.dial(relayAddr)
console.log(`Connected to the HOP relay ${conn.remotePeer.toString()}`) console.log(`Connected to the HOP relay ${conn.remotePeer.toString()}`)
// Wait for connection and relay to be bind for the example purpose // Wait for connection and relay to be bind for the example purpose
node.peerStore.on('change:multiaddrs', ({ peerId }) => { node.peerStore.addEventListener('change:multiaddrs', (evt) => {
const { peerId } = evt.detail
// Updated self multiaddrs? // Updated self multiaddrs?
if (peerId.equals(node.peerId)) { if (peerId.equals(node.peerId)) {
console.log(`Advertising with a relay address of ${node.multiaddrs[0].toString()}/p2p/${node.peerId.toB58String()}`) console.log(`Advertising with a relay address of ${node.getMultiaddrs()[0].toString()}`)
} }
}) })
} }
main() main()

View File

@ -1,40 +1,40 @@
'use strict' import { createLibp2p } from 'libp2p'
import { WebSockets } from '@libp2p/websockets'
const Libp2p = require('libp2p') import { Noise } from '@chainsafe/libp2p-noise'
const Websockets = require('libp2p-websockets') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('@chainsafe/libp2p-noise')
const MPLEX = require('libp2p-mplex')
async function main () { async function main () {
const node = await Libp2p.create({ const node = await createLibp2p({
modules: {
transport: [Websockets],
connEncryption: [NOISE],
streamMuxer: [MPLEX]
},
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0/ws'] listen: ['/ip4/0.0.0.0/tcp/0/ws']
// TODO check "What is next?" section // TODO check "What is next?" section
// announce: ['/dns4/auto-relay.libp2p.io/tcp/443/wss/p2p/QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3'] // announce: ['/dns4/auto-relay.libp2p.io/tcp/443/wss/p2p/QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3']
}, },
config: { transports: [
relay: { new WebSockets()
],
connectionEncryption: [
new Noise()
],
streamMuxers: [
new Mplex()
],
relay: {
enabled: true,
hop: {
enabled: true
},
advertise: {
enabled: true, enabled: true,
hop: {
enabled: true
},
advertise: {
enabled: true,
}
} }
} }
}) })
await node.start() await node.start()
console.log(`Node started with id ${node.peerId.toB58String()}`) console.log(`Node started with id ${node.peerId.toString()}`)
console.log('Listening on:') console.log('Listening on:')
node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`)) node.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
} }
main() main()

View File

@ -1,9 +1,10 @@
'use strict' import path from 'path'
import execa from 'execa'
import pDefer from 'p-defer'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const execa = require('execa')
const pDefer = require('p-defer')
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
function startProcess (name, args = []) { function startProcess (name, args = []) {
return execa('node', [path.join(__dirname, name), ...args], { return execa('node', [path.join(__dirname, name), ...args], {
@ -12,7 +13,7 @@ function startProcess (name, args = []) {
}) })
} }
async function test () { export async function test () {
let output1 = '' let output1 = ''
let output2 = '' let output2 = ''
let output3 = '' let output3 = ''
@ -50,7 +51,7 @@ async function test () {
output2 += uint8ArrayToString(data) output2 += uint8ArrayToString(data)
if (output2.includes('Advertising with a relay address of') && output2.includes('/p2p/')) { if (output2.includes('Advertising with a relay address of') && output2.includes('/p2p/')) {
autoRelayAddr = output2.trim().split('Advertising with a relay address of ')[1] autoRelayAddr = output2.trim().split('Advertising with a relay address of ')[1].trim()
proc2Ready.resolve() proc2Ready.resolve()
} }
}) })
@ -90,5 +91,3 @@ async function test () {
} }
}) })
} }
module.exports = test

View File

@ -1,15 +1,16 @@
'use strict'
/* eslint-disable no-console */ /* eslint-disable no-console */
const PeerId = require('peer-id') import { Multiaddr } from '@multiformats/multiaddr'
const { Multiaddr } = require('multiaddr') import { createLibp2p } from './libp2p.js'
const createLibp2p = require('./libp2p') import { stdinToStream, streamToConsole } from './stream.js'
const { stdinToStream, streamToConsole } = require('./stream') import { createFromJSON } from '@libp2p/peer-id-factory'
import peerIdDialerJson from './peer-id-dialer.js'
import peerIdListenerJson from './peer-id-listener.js'
async function run () { async function run () {
const [idDialer, idListener] = await Promise.all([ const [idDialer, idListener] = await Promise.all([
PeerId.createFromJSON(require('./peer-id-dialer')), createFromJSON(peerIdDialerJson),
PeerId.createFromJSON(require('./peer-id-listener')) createFromJSON(peerIdListenerJson)
]) ])
// Create a new libp2p node on localhost with a randomly chosen port // Create a new libp2p node on localhost with a randomly chosen port
@ -25,12 +26,12 @@ async function run () {
// Output this node's address // Output this node's address
console.log('Dialer ready, listening on:') console.log('Dialer ready, listening on:')
nodeDialer.multiaddrs.forEach((ma) => { nodeDialer.getMultiaddrs().forEach((ma) => {
console.log(ma.toString() + '/p2p/' + idDialer.toB58String()) console.log(ma.toString())
}) })
// Dial to the remote peer (the "listener") // Dial to the remote peer (the "listener")
const listenerMa = new Multiaddr(`/ip4/127.0.0.1/tcp/10333/p2p/${idListener.toB58String()}`) const listenerMa = new Multiaddr(`/ip4/127.0.0.1/tcp/10333/p2p/${idListener.toString()}`)
const { stream } = await nodeDialer.dialProtocol(listenerMa, '/chat/1.0.0') const { stream } = await nodeDialer.dialProtocol(listenerMa, '/chat/1.0.0')
console.log('Dialer dialed to listener on protocol: /chat/1.0.0') console.log('Dialer dialed to listener on protocol: /chat/1.0.0')

View File

@ -1,22 +1,23 @@
'use strict' import { TCP } from '@libp2p/tcp'
import { WebSockets } from '@libp2p/websockets'
import { Mplex } from '@libp2p/mplex'
import { Noise } from '@chainsafe/libp2p-noise'
import defaultsDeep from '@nodeutils/defaults-deep'
import { createLibp2p as create } from 'libp2p'
const TCP = require('libp2p-tcp') export async function createLibp2p(_options) {
const WS = require('libp2p-websockets')
const mplex = require('libp2p-mplex')
const { NOISE } = require('@chainsafe/libp2p-noise')
const defaultsDeep = require('@nodeutils/defaults-deep')
const libp2p = require('../../..')
async function createLibp2p(_options) {
const defaults = { const defaults = {
modules: { transports: [
transport: [TCP, WS], new TCP(),
streamMuxer: [mplex], new WebSockets()
connEncryption: [NOISE], ],
}, streamMuxers: [
new Mplex()
],
connectionEncryption: [
new Noise()
]
} }
return libp2p.create(defaultsDeep(_options, defaults)) return create(defaultsDeep(_options, defaults))
} }
module.exports = createLibp2p

View File

@ -1,13 +1,13 @@
'use strict'
/* eslint-disable no-console */ /* eslint-disable no-console */
const PeerId = require('peer-id') import { createLibp2p } from './libp2p.js'
const createLibp2p = require('./libp2p.js') import { stdinToStream, streamToConsole } from './stream.js'
const { stdinToStream, streamToConsole } = require('./stream') import { createFromJSON } from '@libp2p/peer-id-factory'
import peerIdListenerJson from './peer-id-listener.js'
async function run () { async function run () {
// Create a new libp2p node with the given multi-address // Create a new libp2p node with the given multi-address
const idListener = await PeerId.createFromJSON(require('./peer-id-listener')) const idListener = await createFromJSON(peerIdListenerJson)
const nodeListener = await createLibp2p({ const nodeListener = await createLibp2p({
peerId: idListener, peerId: idListener,
addresses: { addresses: {
@ -16,8 +16,9 @@ async function run () {
}) })
// Log a message when a remote peer connects to us // Log a message when a remote peer connects to us
nodeListener.connectionManager.on('peer:connect', (connection) => { nodeListener.connectionManager.addEventListener('peer:connect', (evt) => {
console.log('connected to: ', connection.remotePeer.toB58String()) const connection = evt.detail
console.log('connected to: ', connection.remotePeer.toString())
}) })
// Handle messages for the protocol // Handle messages for the protocol
@ -33,8 +34,8 @@ async function run () {
// Output listen addresses to the console // Output listen addresses to the console
console.log('Listener ready, listening on:') console.log('Listener ready, listening on:')
nodeListener.multiaddrs.forEach((ma) => { nodeListener.getMultiaddrs().forEach((ma) => {
console.log(ma.toString() + '/p2p/' + idListener.toB58String()) console.log(ma.toString())
}) })
} }

View File

@ -1,4 +1,4 @@
{ export default {
"id": "Qma3GsJmB47xYuyahPZPSadh1avvxfyYQwk8R3UnFrQ6aP", "id": "Qma3GsJmB47xYuyahPZPSadh1avvxfyYQwk8R3UnFrQ6aP",
"privKey": "CAASpwkwggSjAgEAAoIBAQCaNSDOjPz6T8HZsf7LDpxiQRiN2OjeyIHUS05p8QWOr3EFUCFsC31R4moihE5HN+FxNalUyyFZU//yjf1pdnlMJqrVByJSMa+y2y4x2FucpoCAO97Tx+iWzwlZ2UXEUXM1Y81mhPbeWXy+wP2xElTgIER0Tsn/thoA0SD2u9wJuVvM7dB7cBcHYmqV6JH+KWCedRTum6O1BssqP/4Lbm2+rkrbZ4+oVRoU2DRLoFhKqwqLtylrbuj4XOI3XykMXV5+uQXz1JzubNOB9lsc6K+eRC+w8hhhDuFMgzkZ4qomCnx3uhO67KaICd8yqqBa6PJ/+fBM5Xk4hjyR40bwcf41AgMBAAECggEAZnrCJ6IYiLyyRdr9SbKXCNDb4YByGYPEi/HT1aHgIJfFE1PSMjxcdytxfyjP4JJpVtPjiT9JFVU2ddoYu5qJN6tGwjVwgJEWg1UXmPaAw1T/drjS94kVsAs82qICtFmwp52Apg3dBZ0Qwq/8qE1XbG7lLyohIbfCBiL0tiPYMfkcsN9gnFT/kFCX0LVs2pa9fHCRMY9rqCc4/rWJa1w8sMuQ23y4lDaxKF9OZVvOHFQkbBDrkquWHE4r55fchCz/rJklkPJUNENuncBRu0/2X+p4IKFD1DnttXNwb8j4LPiSlLro1T0hiUr5gO2QmdYwXFF63Q3mjQy0+5I4eNbjjQKBgQDZvZy3gUKS/nQNkYfq9za80uLbIj/cWbO+ZZjXCsj0fNIcQFJcKMBoA7DjJvu2S/lf86/41YHkPdmrLAEQAkJ+5BBNOycjYK9minTEjIMMmZDTXXugZ62wnU6F46uLkgEChTqEP57Y6xwwV+JaEDFEsW5N1eE9lEVX9nGIr4phMwKBgQC1TazLuEt1WBx/iUT83ita7obXqoKNzwsS/MWfY2innzYZKDOqeSYZzLtt9uTtp4X4uLyPbYs0qFYhXLsUYMoGHNN8+NdjoyxCjQRJRBkMtaNR0lc5lVDWl3bTuJovjFCgAr9uqJrmI5OHcCIk/cDpdWb3nWaMihVlePmiTcTy9wKBgQCU0u7c1jKkudqks4XM6a+2HAYGdUBk4cLjLhnrUWnNAcuyl5wzdX8dGPi8KZb+IKuQE8WBNJ2VXVj7kBYh1QmSJVunDflQSvNYCOaKuOeRoxzD+y9Wkca74qkbBmPn/6FFEb7PSZTO+tPHjyodGNgz9XpJJRjQuBk1aDJtlF3m1QKBgE5SAr5ym65SZOU3UGUIOKRsfDW4Q/OsqDUImvpywCgBICaX9lHDShFFHwau7FA52ScL7vDquoMB4UtCOtLfyQYA9995w9oYCCurrVlVIJkb8jSLcADBHw3EmqF1kq3NqJqm9TmBfoDCh52vdCCUufxgKh33kfBOSlXuf7B8dgMbAoGAZ3r0/mBQX6S+s5+xCETMTSNv7TQzxgtURIpVs+ZVr2cMhWhiv+n0Omab9X9Z50se8cWl5lkvx8vn3D/XHHIPrMF6qk7RAXtvReb+PeitNvm0odqjFv0J2qki6fDs0HKwq4kojAXI1Md8Th0eobNjsy21fEEJT7uKMJdovI/SErI=", "privKey": "CAASpwkwggSjAgEAAoIBAQCaNSDOjPz6T8HZsf7LDpxiQRiN2OjeyIHUS05p8QWOr3EFUCFsC31R4moihE5HN+FxNalUyyFZU//yjf1pdnlMJqrVByJSMa+y2y4x2FucpoCAO97Tx+iWzwlZ2UXEUXM1Y81mhPbeWXy+wP2xElTgIER0Tsn/thoA0SD2u9wJuVvM7dB7cBcHYmqV6JH+KWCedRTum6O1BssqP/4Lbm2+rkrbZ4+oVRoU2DRLoFhKqwqLtylrbuj4XOI3XykMXV5+uQXz1JzubNOB9lsc6K+eRC+w8hhhDuFMgzkZ4qomCnx3uhO67KaICd8yqqBa6PJ/+fBM5Xk4hjyR40bwcf41AgMBAAECggEAZnrCJ6IYiLyyRdr9SbKXCNDb4YByGYPEi/HT1aHgIJfFE1PSMjxcdytxfyjP4JJpVtPjiT9JFVU2ddoYu5qJN6tGwjVwgJEWg1UXmPaAw1T/drjS94kVsAs82qICtFmwp52Apg3dBZ0Qwq/8qE1XbG7lLyohIbfCBiL0tiPYMfkcsN9gnFT/kFCX0LVs2pa9fHCRMY9rqCc4/rWJa1w8sMuQ23y4lDaxKF9OZVvOHFQkbBDrkquWHE4r55fchCz/rJklkPJUNENuncBRu0/2X+p4IKFD1DnttXNwb8j4LPiSlLro1T0hiUr5gO2QmdYwXFF63Q3mjQy0+5I4eNbjjQKBgQDZvZy3gUKS/nQNkYfq9za80uLbIj/cWbO+ZZjXCsj0fNIcQFJcKMBoA7DjJvu2S/lf86/41YHkPdmrLAEQAkJ+5BBNOycjYK9minTEjIMMmZDTXXugZ62wnU6F46uLkgEChTqEP57Y6xwwV+JaEDFEsW5N1eE9lEVX9nGIr4phMwKBgQC1TazLuEt1WBx/iUT83ita7obXqoKNzwsS/MWfY2innzYZKDOqeSYZzLtt9uTtp4X4uLyPbYs0qFYhXLsUYMoGHNN8+NdjoyxCjQRJRBkMtaNR0lc5lVDWl3bTuJovjFCgAr9uqJrmI5OHcCIk/cDpdWb3nWaMihVlePmiTcTy9wKBgQCU0u7c1jKkudqks4XM6a+2HAYGdUBk4cLjLhnrUWnNAcuyl5wzdX8dGPi8KZb+IKuQE8WBNJ2VXVj7kBYh1QmSJVunDflQSvNYCOaKuOeRoxzD+y9Wkca74qkbBmPn/6FFEb7PSZTO+tPHjyodGNgz9XpJJRjQuBk1aDJtlF3m1QKBgE5SAr5ym65SZOU3UGUIOKRsfDW4Q/OsqDUImvpywCgBICaX9lHDShFFHwau7FA52ScL7vDquoMB4UtCOtLfyQYA9995w9oYCCurrVlVIJkb8jSLcADBHw3EmqF1kq3NqJqm9TmBfoDCh52vdCCUufxgKh33kfBOSlXuf7B8dgMbAoGAZ3r0/mBQX6S+s5+xCETMTSNv7TQzxgtURIpVs+ZVr2cMhWhiv+n0Omab9X9Z50se8cWl5lkvx8vn3D/XHHIPrMF6qk7RAXtvReb+PeitNvm0odqjFv0J2qki6fDs0HKwq4kojAXI1Md8Th0eobNjsy21fEEJT7uKMJdovI/SErI=",
"pubKey": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCaNSDOjPz6T8HZsf7LDpxiQRiN2OjeyIHUS05p8QWOr3EFUCFsC31R4moihE5HN+FxNalUyyFZU//yjf1pdnlMJqrVByJSMa+y2y4x2FucpoCAO97Tx+iWzwlZ2UXEUXM1Y81mhPbeWXy+wP2xElTgIER0Tsn/thoA0SD2u9wJuVvM7dB7cBcHYmqV6JH+KWCedRTum6O1BssqP/4Lbm2+rkrbZ4+oVRoU2DRLoFhKqwqLtylrbuj4XOI3XykMXV5+uQXz1JzubNOB9lsc6K+eRC+w8hhhDuFMgzkZ4qomCnx3uhO67KaICd8yqqBa6PJ/+fBM5Xk4hjyR40bwcf41AgMBAAE=" "pubKey": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCaNSDOjPz6T8HZsf7LDpxiQRiN2OjeyIHUS05p8QWOr3EFUCFsC31R4moihE5HN+FxNalUyyFZU//yjf1pdnlMJqrVByJSMa+y2y4x2FucpoCAO97Tx+iWzwlZ2UXEUXM1Y81mhPbeWXy+wP2xElTgIER0Tsn/thoA0SD2u9wJuVvM7dB7cBcHYmqV6JH+KWCedRTum6O1BssqP/4Lbm2+rkrbZ4+oVRoU2DRLoFhKqwqLtylrbuj4XOI3XykMXV5+uQXz1JzubNOB9lsc6K+eRC+w8hhhDuFMgzkZ4qomCnx3uhO67KaICd8yqqBa6PJ/+fBM5Xk4hjyR40bwcf41AgMBAAE="

View File

@ -1,4 +1,4 @@
{ export default {
"id": "QmcrQZ6RJdpYuGvZqD5QEHAv6qX4BrQLJLQPQUrTrzdcgm", "id": "QmcrQZ6RJdpYuGvZqD5QEHAv6qX4BrQLJLQPQUrTrzdcgm",
"privKey": "CAASqAkwggSkAgEAAoIBAQDLZZcGcbe4urMBVlcHgN0fpBymY+xcr14ewvamG70QZODJ1h9sljlExZ7byLiqRB3SjGbfpZ1FweznwNxWtWpjHkQjTVXeoM4EEgDSNO/Cg7KNlU0EJvgPJXeEPycAZX9qASbVJ6EECQ40VR/7+SuSqsdL1hrmG1phpIju+D64gLyWpw9WEALfzMpH5I/KvdYDW3N4g6zOD2mZNp5y1gHeXINHWzMF596O72/6cxwyiXV1eJ000k1NVnUyrPjXtqWdVLRk5IU1LFpoQoXZU5X1hKj1a2qt/lZfH5eOrF/ramHcwhrYYw1txf8JHXWO/bbNnyemTHAvutZpTNrsWATfAgMBAAECggEAQj0obPnVyjxLFZFnsFLgMHDCv9Fk5V5bOYtmxfvcm50us6ye+T8HEYWGUa9RrGmYiLweuJD34gLgwyzE1RwptHPj3tdNsr4NubefOtXwixlWqdNIjKSgPlaGULQ8YF2tm/kaC2rnfifwz0w1qVqhPReO5fypL+0ShyANVD3WN0Fo2ugzrniCXHUpR2sHXSg6K+2+qWdveyjNWog34b7CgpV73Ln96BWae6ElU8PR5AWdMnRaA9ucA+/HWWJIWB3Fb4+6uwlxhu2L50Ckq1gwYZCtGw63q5L4CglmXMfIKnQAuEzazq9T4YxEkp+XDnVZAOgnQGUBYpetlgMmkkh9qQKBgQDvsEs0ThzFLgnhtC2Jy//ZOrOvIAKAZZf/mS08AqWH3L0/Rjm8ZYbLsRcoWU78sl8UFFwAQhMRDBP9G+RPojWVahBL/B7emdKKnFR1NfwKjFdDVaoX5uNvZEKSl9UubbC4WZJ65u/cd5jEnj+w3ir9G8n+P1gp/0yBz02nZXFgSwKBgQDZPQr4HBxZL7Kx7D49ormIlB7CCn2i7mT11Cppn5ifUTrp7DbFJ2t9e8UNk6tgvbENgCKXvXWsmflSo9gmMxeEOD40AgAkO8Pn2R4OYhrwd89dECiKM34HrVNBzGoB5+YsAno6zGvOzLKbNwMG++2iuNXqXTk4uV9GcI8OnU5ZPQKBgCZUGrKSiyc85XeiSGXwqUkjifhHNh8yH8xPwlwGUFIZimnD4RevZI7OEtXw8iCWpX2gg9XGuyXOuKORAkF5vvfVriV4e7c9Ad4Igbj8mQFWz92EpV6NHXGCpuKqRPzXrZrNOA9PPqwSs+s9IxI1dMpk1zhBCOguWx2m+NP79NVhAoGBAI6WSoTfrpu7ewbdkVzTWgQTdLzYNe6jmxDf2ZbKclrf7lNr/+cYIK2Ud5qZunsdBwFdgVcnu/02czeS42TvVBgs8mcgiQc/Uy7yi4/VROlhOnJTEMjlU2umkGc3zLzDgYiRd7jwRDLQmMrYKNyEr02HFKFn3w8kXSzW5I8rISnhAoGBANhchHVtJd3VMYvxNcQb909FiwTnT9kl9pkjhwivx+f8/K8pDfYCjYSBYCfPTM5Pskv5dXzOdnNuCj6Y2H/9m2SsObukBwF0z5Qijgu1DsxvADVIKZ4rzrGb4uSEmM6200qjJ/9U98fVM7rvOraakrhcf9gRwuspguJQnSO9cLj6", "privKey": "CAASqAkwggSkAgEAAoIBAQDLZZcGcbe4urMBVlcHgN0fpBymY+xcr14ewvamG70QZODJ1h9sljlExZ7byLiqRB3SjGbfpZ1FweznwNxWtWpjHkQjTVXeoM4EEgDSNO/Cg7KNlU0EJvgPJXeEPycAZX9qASbVJ6EECQ40VR/7+SuSqsdL1hrmG1phpIju+D64gLyWpw9WEALfzMpH5I/KvdYDW3N4g6zOD2mZNp5y1gHeXINHWzMF596O72/6cxwyiXV1eJ000k1NVnUyrPjXtqWdVLRk5IU1LFpoQoXZU5X1hKj1a2qt/lZfH5eOrF/ramHcwhrYYw1txf8JHXWO/bbNnyemTHAvutZpTNrsWATfAgMBAAECggEAQj0obPnVyjxLFZFnsFLgMHDCv9Fk5V5bOYtmxfvcm50us6ye+T8HEYWGUa9RrGmYiLweuJD34gLgwyzE1RwptHPj3tdNsr4NubefOtXwixlWqdNIjKSgPlaGULQ8YF2tm/kaC2rnfifwz0w1qVqhPReO5fypL+0ShyANVD3WN0Fo2ugzrniCXHUpR2sHXSg6K+2+qWdveyjNWog34b7CgpV73Ln96BWae6ElU8PR5AWdMnRaA9ucA+/HWWJIWB3Fb4+6uwlxhu2L50Ckq1gwYZCtGw63q5L4CglmXMfIKnQAuEzazq9T4YxEkp+XDnVZAOgnQGUBYpetlgMmkkh9qQKBgQDvsEs0ThzFLgnhtC2Jy//ZOrOvIAKAZZf/mS08AqWH3L0/Rjm8ZYbLsRcoWU78sl8UFFwAQhMRDBP9G+RPojWVahBL/B7emdKKnFR1NfwKjFdDVaoX5uNvZEKSl9UubbC4WZJ65u/cd5jEnj+w3ir9G8n+P1gp/0yBz02nZXFgSwKBgQDZPQr4HBxZL7Kx7D49ormIlB7CCn2i7mT11Cppn5ifUTrp7DbFJ2t9e8UNk6tgvbENgCKXvXWsmflSo9gmMxeEOD40AgAkO8Pn2R4OYhrwd89dECiKM34HrVNBzGoB5+YsAno6zGvOzLKbNwMG++2iuNXqXTk4uV9GcI8OnU5ZPQKBgCZUGrKSiyc85XeiSGXwqUkjifhHNh8yH8xPwlwGUFIZimnD4RevZI7OEtXw8iCWpX2gg9XGuyXOuKORAkF5vvfVriV4e7c9Ad4Igbj8mQFWz92EpV6NHXGCpuKqRPzXrZrNOA9PPqwSs+s9IxI1dMpk1zhBCOguWx2m+NP79NVhAoGBAI6WSoTfrpu7ewbdkVzTWgQTdLzYNe6jmxDf2ZbKclrf7lNr/+cYIK2Ud5qZunsdBwFdgVcnu/02czeS42TvVBgs8mcgiQc/Uy7yi4/VROlhOnJTEMjlU2umkGc3zLzDgYiRd7jwRDLQmMrYKNyEr02HFKFn3w8kXSzW5I8rISnhAoGBANhchHVtJd3VMYvxNcQb909FiwTnT9kl9pkjhwivx+f8/K8pDfYCjYSBYCfPTM5Pskv5dXzOdnNuCj6Y2H/9m2SsObukBwF0z5Qijgu1DsxvADVIKZ4rzrGb4uSEmM6200qjJ/9U98fVM7rvOraakrhcf9gRwuspguJQnSO9cLj6",
"pubKey": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDLZZcGcbe4urMBVlcHgN0fpBymY+xcr14ewvamG70QZODJ1h9sljlExZ7byLiqRB3SjGbfpZ1FweznwNxWtWpjHkQjTVXeoM4EEgDSNO/Cg7KNlU0EJvgPJXeEPycAZX9qASbVJ6EECQ40VR/7+SuSqsdL1hrmG1phpIju+D64gLyWpw9WEALfzMpH5I/KvdYDW3N4g6zOD2mZNp5y1gHeXINHWzMF596O72/6cxwyiXV1eJ000k1NVnUyrPjXtqWdVLRk5IU1LFpoQoXZU5X1hKj1a2qt/lZfH5eOrF/ramHcwhrYYw1txf8JHXWO/bbNnyemTHAvutZpTNrsWATfAgMBAAE=" "pubKey": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDLZZcGcbe4urMBVlcHgN0fpBymY+xcr14ewvamG70QZODJ1h9sljlExZ7byLiqRB3SjGbfpZ1FweznwNxWtWpjHkQjTVXeoM4EEgDSNO/Cg7KNlU0EJvgPJXeEPycAZX9qASbVJ6EECQ40VR/7+SuSqsdL1hrmG1phpIju+D64gLyWpw9WEALfzMpH5I/KvdYDW3N4g6zOD2mZNp5y1gHeXINHWzMF596O72/6cxwyiXV1eJ000k1NVnUyrPjXtqWdVLRk5IU1LFpoQoXZU5X1hKj1a2qt/lZfH5eOrF/ramHcwhrYYw1txf8JHXWO/bbNnyemTHAvutZpTNrsWATfAgMBAAE="

View File

@ -1,15 +1,19 @@
'use strict'
/* eslint-disable no-console */ /* eslint-disable no-console */
const pipe = require('it-pipe') import { pipe } from 'it-pipe'
const lp = require('it-length-prefixed') import * as lp from 'it-length-prefixed'
import map from 'it-map'
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
function stdinToStream(stream) { export function stdinToStream(stream) {
// Read utf-8 from stdin // Read utf-8 from stdin
process.stdin.setEncoding('utf8') process.stdin.setEncoding('utf8')
pipe( pipe(
// Read from stdin (the source) // Read from stdin (the source)
process.stdin, process.stdin,
// Turn strings into buffers
(source) => map(source, (string) => uint8ArrayFromString(string)),
// Encode with length prefix (so receiving side knows how much data is coming) // Encode with length prefix (so receiving side knows how much data is coming)
lp.encode(), lp.encode(),
// Write to the stream (the sink) // Write to the stream (the sink)
@ -17,12 +21,14 @@ function stdinToStream(stream) {
) )
} }
function streamToConsole(stream) { export function streamToConsole(stream) {
pipe( pipe(
// Read from the stream (the source) // Read from the stream (the source)
stream.source, stream.source,
// Decode length-prefixed data // Decode length-prefixed data
lp.decode(), lp.decode(),
// Turn buffers into strings
(source) => map(source, (buf) => uint8ArrayToString(buf)),
// Sink function // Sink function
async function (source) { async function (source) {
// For each chunk of data // For each chunk of data
@ -33,8 +39,3 @@ function streamToConsole(stream) {
} }
) )
} }
module.exports = {
stdinToStream,
streamToConsole
}

View File

@ -1,9 +1,10 @@
'use strict' import path from 'path'
import execa from 'execa'
import pDefer from 'p-defer'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const execa = require('execa')
const pDefer = require('p-defer')
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
function startProcess(name) { function startProcess(name) {
return execa('node', [path.join(__dirname, name)], { return execa('node', [path.join(__dirname, name)], {
@ -12,7 +13,7 @@ function startProcess(name) {
}) })
} }
async function test () { export async function test () {
const message = 'test message' const message = 'test message'
let listenerOutput = '' let listenerOutput = ''
let dialerOutput = '' let dialerOutput = ''
@ -73,5 +74,3 @@ async function test () {
} }
}) })
} }
module.exports = test

View File

@ -1,22 +1,19 @@
'use strict' import { createLibp2p } from '../../dist/src/index.js'
import { TCP } from '@libp2p/tcp'
const Libp2p = require('../..') import { Mplex } from '@libp2p/mplex'
const TCP = require('libp2p-tcp') import { Noise } from '@chainsafe/libp2p-noise'
const Mplex = require('libp2p-mplex') import { pipe } from 'it-pipe'
const { NOISE } = require('@chainsafe/libp2p-noise') import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
const pipe = require('it-pipe')
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [Mplex], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
}
}) })
await node.start() await node.start()
@ -30,14 +27,14 @@ const createNode = async () => {
createNode() createNode()
]) ])
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
node2.handle('/a-protocol', ({ stream }) => { node2.handle('/a-protocol', ({ stream }) => {
pipe( pipe(
stream, stream,
async function (source) { async function (source) {
for await (const msg of source) { for await (const msg of source) {
console.log(msg.toString()) console.log(uint8ArrayToString(msg))
} }
} }
) )
@ -46,7 +43,7 @@ const createNode = async () => {
const { stream } = await node1.dialProtocol(node2.peerId, '/a-protocol') const { stream } = await node1.dialProtocol(node2.peerId, '/a-protocol')
await pipe( await pipe(
['This information is sent out encrypted to the other peer'], [uint8ArrayFromString('This information is sent out encrypted to the other peer')],
stream stream
) )
})(); })();

View File

@ -13,17 +13,17 @@ We will build this example on top of example for [Protocol and Stream Multiplexi
To add them to your libp2p configuration, all you have to do is: To add them to your libp2p configuration, all you have to do is:
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const { NOISE } = require('@chainsafe/libp2p-noise') import { TCP } from '@libp2p/tcp'
import { Mplex } from '@libp2p/mplex'
import { Noise } from '@chainsafe/libp2p-noise'
const createNode = () => { const createNode = async () => {
return Libp2p.create({ return await createLibp2p({
modules: { transports: [ new TCP() ],
transport: [ TCP ], streamMuxers: [ new Mplex() ],
streamMuxer: [ Mplex ], // Attach noise as the crypto channel to use
// Attach noise as the crypto channel to use conectionEncrypters: [ new Noise() ]
connEncryption: [ NOISE ]
}
}) })
} }
``` ```

View File

@ -1,14 +1,14 @@
'use strict'
const path = require('path') import path from 'path'
const { waitForOutput } = require('../utils') import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
async function test () { const __dirname = path.dirname(fileURLToPath(import.meta.url))
export async function test () {
process.stdout.write('1.js\n') process.stdout.write('1.js\n')
await waitForOutput('This information is sent out encrypted to the other peer', 'node', [path.join(__dirname, '1.js')], { await waitForOutput('This information is sent out encrypted to the other peer', 'node', [path.join(__dirname, '1.js')], {
cwd: __dirname cwd: __dirname
}) })
} }
module.exports = test

View File

@ -3,19 +3,18 @@
"version": "0.1.0", "version": "0.1.0",
"private": true, "private": true,
"dependencies": { "dependencies": {
"@chainsafe/libp2p-noise": "^5.0.2", "@chainsafe/libp2p-noise": "^6.0.1",
"ipfs-core": "^0.13.0", "ipfs-core": "^0.14.1",
"libp2p": "../../", "libp2p": "../../",
"libp2p-delegated-content-routing": "^0.11.0", "@libp2p/delegated-content-routing": "^1.0.1",
"libp2p-delegated-peer-routing": "^0.11.1", "@libp2p/delegated-peer-routing": "^1.0.1",
"libp2p-kad-dht": "^0.28.6", "@libp2p/kad-dht": "^1.0.1",
"libp2p-mplex": "^0.10.4", "@libp2p/mplex": "^1.0.2",
"libp2p-webrtc-star": "^0.25.0", "@libp2p/webrtc-star": "^1.0.6",
"libp2p-websocket-star": "^0.10.2", "@libp2p/websockets": "^1.0.3",
"libp2p-websockets": "^0.16.2", "react": "^17.0.2",
"react": "^16.8.6", "react-dom": "^17.0.2",
"react-dom": "^16.8.6", "react-scripts": "5.0.0"
"react-scripts": "2.1.8"
}, },
"scripts": { "scripts": {
"start": "react-scripts start" "start": "react-scripts start"

View File

@ -1,26 +1,23 @@
// eslint-disable-next-line // eslint-disable-next-line
'use strict' 'use strict'
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Websockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const WebSocketStar = require('libp2p-websocket-star') import { WebRTCStar } from '@libp2p/webrtc-star'
const WebRTCStar = require('libp2p-webrtc-star') import { Mplex } from '@libp2p/mplex'
const MPLEX = require('libp2p-mplex') import { Noise } from '@chainsafe/libp2p-noise'
const { NOISE } = require('@chainsafe/libp2p-noise') import { DelegatedPeerRouting } from '@libp2p/delegated-peer-routing'
const KadDHT = require('libp2p-kad-dht') import { DelegatedContentRouting } from '@libp2p/delegated-content-routing'
const DelegatedPeerRouter = require('libp2p-delegated-peer-routing')
const DelegatedContentRouter = require('libp2p-delegated-content-routing')
export default function Libp2pBundle ({peerInfo, peerBook}) { export default function Libp2pBundle ({peerInfo, peerBook}) {
const wrtcstar = new WebRTCStar({id: peerInfo.id}) const wrtcstar = new WebRTCStar()
const wsstar = new WebSocketStar({id: peerInfo.id})
const delegatedApiOptions = { const delegatedApiOptions = {
host: '0.0.0.0', host: '0.0.0.0',
protocol: 'http', protocol: 'http',
port: '8080' port: '8080'
} }
return new Libp2p({ return createLibp2p({
peerInfo, peerInfo,
peerBook, peerBook,
// Lets limit the connection managers peers and have it check peer health less frequently // Lets limit the connection managers peers and have it check peer health less frequently
@ -28,48 +25,29 @@ export default function Libp2pBundle ({peerInfo, peerBook}) {
maxPeers: 10, maxPeers: 10,
pollInterval: 5000 pollInterval: 5000
}, },
modules: { contentRouting: [
contentRouting: [ new DelegatedPeerRouting(peerInfo.id, delegatedApiOptions)
new DelegatedContentRouter(peerInfo.id, delegatedApiOptions) ],
], peerRouting: [
peerRouting: [ new DelegatedContentRouting(delegatedApiOptions)
new DelegatedPeerRouter(delegatedApiOptions) ],
], transports: [
peerDiscovery: [ wrtcstar,
wrtcstar.discovery, new WebSockets()
wsstar.discovery ],
], streamMuxers: [
transport: [ new Mplex()
wrtcstar, ],
wsstar, connectionEncryption: [
Websockets new Noise()
], ],
streamMuxer: [ connectionManager: {
MPLEX autoDial: false
],
connEncryption: [
NOISE
],
dht: KadDHT
}, },
config: { relay: {
peerDiscovery: { enabled: true,
autoDial: false, hop: {
webrtcStar: {
enabled: false
},
websocketStar: {
enabled: false
}
},
dht: {
enabled: false enabled: false
},
relay: {
enabled: true,
hop: {
enabled: false
}
} }
} }
}) })

View File

@ -1,43 +1,37 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../../') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const Mplex = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const Bootstrap = require('libp2p-bootstrap') import { Bootstrap } from '@libp2p/bootstrap'
import bootstrapers from './bootstrappers.js'
const bootstrapers = require('./bootstrapers')
;(async () => { ;(async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [Mplex], connectionEncryption: [new Noise()],
connEncryption: [NOISE], peerDiscovery: [
peerDiscovery: [Bootstrap] new Bootstrap({
}, interval: 60e3,
config: { list: bootstrapers
peerDiscovery: { })
bootstrap: { ]
interval: 60e3,
enabled: true,
list: bootstrapers
}
}
}
}) })
node.connectionManager.on('peer:connect', (connection) => { node.connectionManager.addEventListener('peer:connect', (evt) => {
console.log('Connection established to:', connection.remotePeer.toB58String()) // Emitted when a peer has been found const connection = evt.detail
console.log('Connection established to:', connection.remotePeer.toString()) // Emitted when a peer has been found
}) })
node.on('peer:discovery', (peerId) => { node.addEventListener('peer:discovery', (evt) => {
const peer = evt.detail
// No need to dial, autoDial is on // No need to dial, autoDial is on
console.log('Discovered:', peerId.toB58String()) console.log('Discovered:', peer.id.toString())
}) })
await node.start() await node.start()

View File

@ -1,31 +1,30 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../../') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const Mplex = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MulticastDNS = require('libp2p-mdns') import { MulticastDNS } from '@libp2p/mdns'
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [
transport: [TCP], new TCP()
streamMuxer: [Mplex], ],
connEncryption: [NOISE], streamMuxers: [
peerDiscovery: [MulticastDNS] new Mplex()
}, ],
config: { connectionEncryption: [
peerDiscovery: { new Noise()
[MulticastDNS.tag]: { ],
interval: 20e3, peerDiscovery: [
enabled: true new MulticastDNS({
} interval: 20e3
} })
} ]
}) })
return node return node
@ -37,8 +36,8 @@ const createNode = async () => {
createNode() createNode()
]) ])
node1.on('peer:discovery', (peerId) => console.log('Discovered:', peerId.toB58String())) node1.addEventListener('peer:discovery', (evt) => console.log('Discovered:', evt.detail.id.toString()))
node2.on('peer:discovery', (peerId) => console.log('Discovered:', peerId.toB58String())) node2.addEventListener('peer:discovery', (evt) => console.log('Discovered:', evt.detail.id.toString()))
await Promise.all([ await Promise.all([
node1.start(), node1.start(),

View File

@ -1,66 +1,78 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../../') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const Mplex = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const Gossipsub = require('@achingbrain/libp2p-gossipsub') import { Gossipsub } from '@achingbrain/libp2p-gossipsub'
const Bootstrap = require('libp2p-bootstrap') import { Bootstrap } from '@libp2p/bootstrap'
const PubsubPeerDiscovery = require('libp2p-pubsub-peer-discovery') import { PubSubPeerDiscovery } from '@libp2p/pubsub-peer-discovery'
const createRelayServer = require('libp2p-relay-server') const createNode = async (bootstrappers) => {
const node = await createLibp2p({
const createNode = async (bootstrapers) => {
const node = await Libp2p.create({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [Mplex], connectionEncryption: [new Noise()],
connEncryption: [NOISE], pubsub: new Gossipsub(),
pubsub: Gossipsub, peerDiscovery: [
peerDiscovery: [Bootstrap, PubsubPeerDiscovery] new Bootstrap({
}, list: bootstrappers
config: { }),
peerDiscovery: { new PubSubPeerDiscovery({
[PubsubPeerDiscovery.tag]: { interval: 1000
interval: 1000, })
enabled: true ]
},
[Bootstrap.tag]: {
enabled: true,
list: bootstrapers
}
}
}
}) })
return node return node
} }
;(async () => { ;(async () => {
const relay = await createRelayServer({ const relay = await createLibp2p({
listenAddresses: ['/ip4/0.0.0.0/tcp/0'] addresses: {
listen: [
'/ip4/0.0.0.0/tcp/0'
]
},
transports: [new TCP()],
streamMuxers: [new Mplex()],
connectionEncryption: [new Noise()],
pubsub: new Gossipsub(),
peerDiscovery: [
new PubSubPeerDiscovery({
interval: 1000
})
],
relay: {
enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay.
hop: {
enabled: true // Allows you to be a relay for other peers
}
}
}) })
console.log(`libp2p relay starting with id: ${relay.peerId.toB58String()}`) console.log(`libp2p relay starting with id: ${relay.peerId.toString()}`)
await relay.start() await relay.start()
const relayMultiaddrs = relay.multiaddrs.map((m) => `${m.toString()}/p2p/${relay.peerId.toB58String()}`)
const relayMultiaddrs = relay.getMultiaddrs().map((m) => m.toString())
const [node1, node2] = await Promise.all([ const [node1, node2] = await Promise.all([
createNode(relayMultiaddrs), createNode(relayMultiaddrs),
createNode(relayMultiaddrs) createNode(relayMultiaddrs)
]) ])
node1.on('peer:discovery', (peerId) => { node1.addEventListener('peer:discovery', (evt) => {
console.log(`Peer ${node1.peerId.toB58String()} discovered: ${peerId.toB58String()}`) const peer = evt.detail
console.log(`Peer ${node1.peerId.toString()} discovered: ${peer.id.toString()}`)
}) })
node2.on('peer:discovery', (peerId) => { node2.addEventListener('peer:discovery',(evt) => {
console.log(`Peer ${node2.peerId.toB58String()} discovered: ${peerId.toB58String()}`) const peer = evt.detail
console.log(`Peer ${node2.peerId.toString()} discovered: ${peer.id.toString()}`)
}) })
;[node1, node2].forEach((node, index) => console.log(`Node ${index} starting with id: ${node.peerId.toB58String()}`)) ;[node1, node2].forEach((node, index) => console.log(`Node ${index} starting with id: ${node.peerId.toString()}`))
await Promise.all([ await Promise.all([
node1.start(), node1.start(),
node2.start() node2.start()

View File

@ -13,25 +13,25 @@ For this demo, we will connect to IPFS default bootstrapper nodes and so, we wil
First, we create our libp2p node. First, we create our libp2p node.
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Bootstrap = require('libp2p-bootstrap') import { Bootstrap } from '@libp2p/bootstrap'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [ TCP ], new TCP()
streamMuxer: [ Mplex ], ],
connEncryption: [ NOISE ], streamMuxers: [
peerDiscovery: [ Bootstrap ] new Mplex()
}, ],
config: { connectionEncryption: [
peerDiscovery: { new Noise()
bootstrap: { ],
interval: 60e3, peerDiscovery: [
enabled: true, new Bootstrap({
list: bootstrapers interval: 60e3,
} list: bootstrapers
} })
} ]
}) })
``` ```
@ -51,26 +51,26 @@ const bootstrapers = [
Now, once we create and start the node, we can listen for events such as `peer:discovery` and `peer:connect`, these events tell us when we found a peer, independently of the discovery mechanism used and when we actually dialed to that peer. Now, once we create and start the node, we can listen for events such as `peer:discovery` and `peer:connect`, these events tell us when we found a peer, independently of the discovery mechanism used and when we actually dialed to that peer.
```JavaScript ```JavaScript
const node = await Libp2p.create({ const node = await createLibp2p({
peerId, peerId,
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [
transport: [ TCP ], new TCP()
streamMuxer: [ Mplex ], ],
connEncryption: [ NOISE ], streamMuxers: [
peerDiscovery: [ Bootstrap ] new Mplex()
}, ],
config: { connectionEncryption: [
peerDiscovery: { new Noise()
bootstrap: { ],
interval: 60e3, peerDiscovery: [
enabled: true, new Bootstrap({
list: bootstrapers interval: 60e3,
} list: bootstrapers
} })
} ]
}) })
node.connectionManager.on('peer:connect', (connection) => { node.connectionManager.on('peer:connect', (connection) => {
@ -110,28 +110,28 @@ For this example, we need `libp2p-mdns`, go ahead and `npm install` it. You can
Update your libp2p configuration to include MulticastDNS. Update your libp2p configuration to include MulticastDNS.
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const MulticastDNS = require('libp2p-mdns') import { MulticastDNS } from '@libp2p/mdns'
const createNode = () => { const createNode = () => {
return Libp2p.create({ return Libp2p.create({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [
transport: [ TCP ], new TCP()
streamMuxer: [ Mplex ], ],
connEncryption: [ NOISE ], streamMuxers: [
peerDiscovery: [ MulticastDNS ] new Mplex()
}, ],
config: { connectionEncryption: [
peerDiscovery: { new Noise()
mdns: { ],
interval: 20e3, peerDiscovery: [
enabled: true new MulticastDNS({
} interval: 20e3
} })
} ]
}) })
} }
``` ```
@ -170,39 +170,37 @@ In the context of this example, we will create and run the `libp2p-relay-server`
You can create your libp2p nodes as follows: You can create your libp2p nodes as follows:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const Mplex = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const Gossipsub = require('libp2p-gossipsub') import { Gossipsub } from 'libp2p-gossipsub'
const Bootstrap = require('libp2p-bootstrap') import { Bootstrap } from '@libp2p/bootstrap'
const PubsubPeerDiscovery = require('libp2p-pubsub-peer-discovery') const PubsubPeerDiscovery from 'libp2p-pubsub-peer-discovery')
const createNode = async (bootstrapers) => { const createNode = async (bootstrapers) => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [
transport: [TCP], new TCP()
streamMuxer: [Mplex], ],
connEncryption: [NOISE], streamMuxers: [
pubsub: Gossipsub, new Mplex()
peerDiscovery: [Bootstrap, PubsubPeerDiscovery] ],
}, connectionEncryption: [
config: { new Noise()
peerDiscovery: { ],
[PubsubPeerDiscovery.tag]: { peerDiscovery: [
interval: 1000, new Bootstrap({
enabled: true interval: 60e3,
}, list: bootstrapers
[Bootstrap.tag]: { }),
enabled: true, new PubsubPeerDiscovery({
list: bootstrapers interval: 1000
} })
} ])
}
})
return node return node
} }
@ -212,7 +210,9 @@ We will use the `libp2p-relay-server` as bootstrap nodes for the libp2p nodes, s
```js ```js
const relay = await createRelayServer({ const relay = await createRelayServer({
listenAddresses: ['/ip4/0.0.0.0/tcp/0'] addresses: {
listen: ['/ip4/0.0.0.0/tcp/0']
}
}) })
console.log(`libp2p relay starting with id: ${relay.peerId.toB58String()}`) console.log(`libp2p relay starting with id: ${relay.peerId.toB58String()}`)
await relay.start() await relay.start()

View File

@ -1,7 +1,5 @@
'use strict'
// Find this list at: https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core-config/src/config.js // Find this list at: https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core-config/src/config.js
const bootstrapers = [ export default [
'/ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ', '/ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ',
'/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN', '/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN',
'/dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb', '/dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb',
@ -9,5 +7,3 @@ const bootstrapers = [
'/dnsaddr/bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa', '/dnsaddr/bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa',
'/dnsaddr/bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt', '/dnsaddr/bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt',
] ]
module.exports = bootstrapers

View File

@ -1,14 +1,13 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { waitForOutput } = require('../utils')
async function test () { export async function test () {
process.stdout.write('1.js\n') process.stdout.write('1.js\n')
await waitForOutput('Connection established to:', 'node', [path.join(__dirname, '1.js')], { await waitForOutput('Connection established to:', 'node', [path.join(__dirname, '1.js')], {
cwd: __dirname cwd: __dirname
}) })
} }
module.exports = test

View File

@ -1,14 +1,13 @@
'use strict' import path from 'path'
import execa from 'execa'
import pWaitFor from 'p-wait-for'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const execa = require('execa')
const pWaitFor = require('p-wait-for')
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
const discoveredCopy = 'Discovered:' export async function test () {
let discoveredNodes = 0
async function test() {
const discoveredNodes = []
process.stdout.write('2.js\n') process.stdout.write('2.js\n')
@ -19,17 +18,16 @@ async function test() {
proc.all.on('data', async (data) => { proc.all.on('data', async (data) => {
process.stdout.write(data) process.stdout.write(data)
const line = uint8ArrayToString(data) const str = uint8ArrayToString(data)
if (line.includes(discoveredCopy)) { str.split('\n').forEach(line => {
const id = line.trim().split(discoveredCopy)[1] if (line.includes('Discovered:')) {
discoveredNodes.push(id) discoveredNodes++
} }
})
}) })
await pWaitFor(() => discoveredNodes.length === 2) await pWaitFor(() => discoveredNodes > 1)
proc.kill() proc.kill()
} }
module.exports = test

View File

@ -1,14 +1,13 @@
'use strict' import path from 'path'
import execa from 'execa'
import pWaitFor from 'p-wait-for'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const execa = require('execa')
const pWaitFor = require('p-wait-for')
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
const discoveredCopy = 'discovered:' export async function test () {
let discoveredNodes = 0
async function test() {
let discoverCount = 0
process.stdout.write('3.js\n') process.stdout.write('3.js\n')
@ -19,17 +18,16 @@ async function test() {
proc.all.on('data', async (data) => { proc.all.on('data', async (data) => {
process.stdout.write(data) process.stdout.write(data)
const line = uint8ArrayToString(data) const str = uint8ArrayToString(data)
// Discovered or Connected str.split('\n').forEach(line => {
if (line.includes(discoveredCopy)) { if (line.includes('discovered:')) {
discoverCount++ discoveredNodes++
} }
})
}) })
await pWaitFor(() => discoverCount === 4) await pWaitFor(() => discoveredNodes > 3)
proc.kill() proc.kill()
} }
module.exports = test

View File

@ -1,13 +1,9 @@
'use strict' import { test as test1 } from './test-1.js'
import { test as test2 } from './test-2.js'
import { test as test3 } from './test-3.js'
const test1 = require('./test-1') export async function test () {
const test2 = require('./test-2')
const test3 = require('./test-3')
async function test () {
await test1() await test1()
await test2() await test2()
await test3() await test3()
} }
module.exports = test

View File

@ -1,18 +1,21 @@
'use strict'
/* eslint-disable no-console */ /* eslint-disable no-console */
/* /*
* Dialer Node * Dialer Node
*/ */
const PeerId = require('peer-id') import { createLibp2p } from './libp2p.js'
const createLibp2p = require('./libp2p') import { pipe } from 'it-pipe'
const pipe = require('it-pipe') import idd from './id-d.js'
import idl from './id-l.js'
import { createFromJSON } from '@libp2p/peer-id-factory'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
async function run() { async function run() {
const [dialerId, listenerId] = await Promise.all([ const [dialerId, listenerId] = await Promise.all([
PeerId.createFromJSON(require('./id-d')), createFromJSON(idd),
PeerId.createFromJSON(require('./id-l')) createFromJSON(idl)
]) ])
// Dialer // Dialer
@ -24,14 +27,13 @@ async function run() {
}) })
// Add peer to Dial (the listener) into the PeerStore // Add peer to Dial (the listener) into the PeerStore
const listenerMultiaddr = '/ip4/127.0.0.1/tcp/10333/p2p/' + listenerId.toB58String() const listenerMultiaddr = '/ip4/127.0.0.1/tcp/10333/p2p/' + listenerId.toString()
// Start the dialer libp2p node // Start the dialer libp2p node
await dialerNode.start() await dialerNode.start()
console.log('Dialer ready, listening on:') console.log('Dialer ready, listening on:')
dialerNode.multiaddrs.forEach((ma) => console.log(ma.toString() + dialerNode.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
'/p2p/' + dialerId.toB58String()))
// Dial the listener node // Dial the listener node
console.log('Dialing to peer:', listenerMultiaddr) console.log('Dialing to peer:', listenerMultiaddr)
@ -41,7 +43,7 @@ async function run() {
pipe( pipe(
// Source data // Source data
['hey'], [uint8ArrayFromString('hey')],
// Write to the stream, and pass its output to the next function // Write to the stream, and pass its output to the next function
stream, stream,
// Sink function // Sink function
@ -49,7 +51,7 @@ async function run() {
// For each chunk of data // For each chunk of data
for await (const data of source) { for await (const data of source) {
// Output the data // Output the data
console.log('received echo:', data.toString()) console.log('received echo:', uint8ArrayToString(data))
} }
} }
) )

View File

@ -1,4 +1,4 @@
{ export default {
"id": "Qma3GsJmB47xYuyahPZPSadh1avvxfyYQwk8R3UnFrQ6aP", "id": "Qma3GsJmB47xYuyahPZPSadh1avvxfyYQwk8R3UnFrQ6aP",
"privKey": "CAASpwkwggSjAgEAAoIBAQCaNSDOjPz6T8HZsf7LDpxiQRiN2OjeyIHUS05p8QWOr3EFUCFsC31R4moihE5HN+FxNalUyyFZU//yjf1pdnlMJqrVByJSMa+y2y4x2FucpoCAO97Tx+iWzwlZ2UXEUXM1Y81mhPbeWXy+wP2xElTgIER0Tsn/thoA0SD2u9wJuVvM7dB7cBcHYmqV6JH+KWCedRTum6O1BssqP/4Lbm2+rkrbZ4+oVRoU2DRLoFhKqwqLtylrbuj4XOI3XykMXV5+uQXz1JzubNOB9lsc6K+eRC+w8hhhDuFMgzkZ4qomCnx3uhO67KaICd8yqqBa6PJ/+fBM5Xk4hjyR40bwcf41AgMBAAECggEAZnrCJ6IYiLyyRdr9SbKXCNDb4YByGYPEi/HT1aHgIJfFE1PSMjxcdytxfyjP4JJpVtPjiT9JFVU2ddoYu5qJN6tGwjVwgJEWg1UXmPaAw1T/drjS94kVsAs82qICtFmwp52Apg3dBZ0Qwq/8qE1XbG7lLyohIbfCBiL0tiPYMfkcsN9gnFT/kFCX0LVs2pa9fHCRMY9rqCc4/rWJa1w8sMuQ23y4lDaxKF9OZVvOHFQkbBDrkquWHE4r55fchCz/rJklkPJUNENuncBRu0/2X+p4IKFD1DnttXNwb8j4LPiSlLro1T0hiUr5gO2QmdYwXFF63Q3mjQy0+5I4eNbjjQKBgQDZvZy3gUKS/nQNkYfq9za80uLbIj/cWbO+ZZjXCsj0fNIcQFJcKMBoA7DjJvu2S/lf86/41YHkPdmrLAEQAkJ+5BBNOycjYK9minTEjIMMmZDTXXugZ62wnU6F46uLkgEChTqEP57Y6xwwV+JaEDFEsW5N1eE9lEVX9nGIr4phMwKBgQC1TazLuEt1WBx/iUT83ita7obXqoKNzwsS/MWfY2innzYZKDOqeSYZzLtt9uTtp4X4uLyPbYs0qFYhXLsUYMoGHNN8+NdjoyxCjQRJRBkMtaNR0lc5lVDWl3bTuJovjFCgAr9uqJrmI5OHcCIk/cDpdWb3nWaMihVlePmiTcTy9wKBgQCU0u7c1jKkudqks4XM6a+2HAYGdUBk4cLjLhnrUWnNAcuyl5wzdX8dGPi8KZb+IKuQE8WBNJ2VXVj7kBYh1QmSJVunDflQSvNYCOaKuOeRoxzD+y9Wkca74qkbBmPn/6FFEb7PSZTO+tPHjyodGNgz9XpJJRjQuBk1aDJtlF3m1QKBgE5SAr5ym65SZOU3UGUIOKRsfDW4Q/OsqDUImvpywCgBICaX9lHDShFFHwau7FA52ScL7vDquoMB4UtCOtLfyQYA9995w9oYCCurrVlVIJkb8jSLcADBHw3EmqF1kq3NqJqm9TmBfoDCh52vdCCUufxgKh33kfBOSlXuf7B8dgMbAoGAZ3r0/mBQX6S+s5+xCETMTSNv7TQzxgtURIpVs+ZVr2cMhWhiv+n0Omab9X9Z50se8cWl5lkvx8vn3D/XHHIPrMF6qk7RAXtvReb+PeitNvm0odqjFv0J2qki6fDs0HKwq4kojAXI1Md8Th0eobNjsy21fEEJT7uKMJdovI/SErI=", "privKey": "CAASpwkwggSjAgEAAoIBAQCaNSDOjPz6T8HZsf7LDpxiQRiN2OjeyIHUS05p8QWOr3EFUCFsC31R4moihE5HN+FxNalUyyFZU//yjf1pdnlMJqrVByJSMa+y2y4x2FucpoCAO97Tx+iWzwlZ2UXEUXM1Y81mhPbeWXy+wP2xElTgIER0Tsn/thoA0SD2u9wJuVvM7dB7cBcHYmqV6JH+KWCedRTum6O1BssqP/4Lbm2+rkrbZ4+oVRoU2DRLoFhKqwqLtylrbuj4XOI3XykMXV5+uQXz1JzubNOB9lsc6K+eRC+w8hhhDuFMgzkZ4qomCnx3uhO67KaICd8yqqBa6PJ/+fBM5Xk4hjyR40bwcf41AgMBAAECggEAZnrCJ6IYiLyyRdr9SbKXCNDb4YByGYPEi/HT1aHgIJfFE1PSMjxcdytxfyjP4JJpVtPjiT9JFVU2ddoYu5qJN6tGwjVwgJEWg1UXmPaAw1T/drjS94kVsAs82qICtFmwp52Apg3dBZ0Qwq/8qE1XbG7lLyohIbfCBiL0tiPYMfkcsN9gnFT/kFCX0LVs2pa9fHCRMY9rqCc4/rWJa1w8sMuQ23y4lDaxKF9OZVvOHFQkbBDrkquWHE4r55fchCz/rJklkPJUNENuncBRu0/2X+p4IKFD1DnttXNwb8j4LPiSlLro1T0hiUr5gO2QmdYwXFF63Q3mjQy0+5I4eNbjjQKBgQDZvZy3gUKS/nQNkYfq9za80uLbIj/cWbO+ZZjXCsj0fNIcQFJcKMBoA7DjJvu2S/lf86/41YHkPdmrLAEQAkJ+5BBNOycjYK9minTEjIMMmZDTXXugZ62wnU6F46uLkgEChTqEP57Y6xwwV+JaEDFEsW5N1eE9lEVX9nGIr4phMwKBgQC1TazLuEt1WBx/iUT83ita7obXqoKNzwsS/MWfY2innzYZKDOqeSYZzLtt9uTtp4X4uLyPbYs0qFYhXLsUYMoGHNN8+NdjoyxCjQRJRBkMtaNR0lc5lVDWl3bTuJovjFCgAr9uqJrmI5OHcCIk/cDpdWb3nWaMihVlePmiTcTy9wKBgQCU0u7c1jKkudqks4XM6a+2HAYGdUBk4cLjLhnrUWnNAcuyl5wzdX8dGPi8KZb+IKuQE8WBNJ2VXVj7kBYh1QmSJVunDflQSvNYCOaKuOeRoxzD+y9Wkca74qkbBmPn/6FFEb7PSZTO+tPHjyodGNgz9XpJJRjQuBk1aDJtlF3m1QKBgE5SAr5ym65SZOU3UGUIOKRsfDW4Q/OsqDUImvpywCgBICaX9lHDShFFHwau7FA52ScL7vDquoMB4UtCOtLfyQYA9995w9oYCCurrVlVIJkb8jSLcADBHw3EmqF1kq3NqJqm9TmBfoDCh52vdCCUufxgKh33kfBOSlXuf7B8dgMbAoGAZ3r0/mBQX6S+s5+xCETMTSNv7TQzxgtURIpVs+ZVr2cMhWhiv+n0Omab9X9Z50se8cWl5lkvx8vn3D/XHHIPrMF6qk7RAXtvReb+PeitNvm0odqjFv0J2qki6fDs0HKwq4kojAXI1Md8Th0eobNjsy21fEEJT7uKMJdovI/SErI=",
"pubKey": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCaNSDOjPz6T8HZsf7LDpxiQRiN2OjeyIHUS05p8QWOr3EFUCFsC31R4moihE5HN+FxNalUyyFZU//yjf1pdnlMJqrVByJSMa+y2y4x2FucpoCAO97Tx+iWzwlZ2UXEUXM1Y81mhPbeWXy+wP2xElTgIER0Tsn/thoA0SD2u9wJuVvM7dB7cBcHYmqV6JH+KWCedRTum6O1BssqP/4Lbm2+rkrbZ4+oVRoU2DRLoFhKqwqLtylrbuj4XOI3XykMXV5+uQXz1JzubNOB9lsc6K+eRC+w8hhhDuFMgzkZ4qomCnx3uhO67KaICd8yqqBa6PJ/+fBM5Xk4hjyR40bwcf41AgMBAAE=" "pubKey": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCaNSDOjPz6T8HZsf7LDpxiQRiN2OjeyIHUS05p8QWOr3EFUCFsC31R4moihE5HN+FxNalUyyFZU//yjf1pdnlMJqrVByJSMa+y2y4x2FucpoCAO97Tx+iWzwlZ2UXEUXM1Y81mhPbeWXy+wP2xElTgIER0Tsn/thoA0SD2u9wJuVvM7dB7cBcHYmqV6JH+KWCedRTum6O1BssqP/4Lbm2+rkrbZ4+oVRoU2DRLoFhKqwqLtylrbuj4XOI3XykMXV5+uQXz1JzubNOB9lsc6K+eRC+w8hhhDuFMgzkZ4qomCnx3uhO67KaICd8yqqBa6PJ/+fBM5Xk4hjyR40bwcf41AgMBAAE="

View File

@ -1,4 +1,4 @@
{ export default {
"id": "QmcrQZ6RJdpYuGvZqD5QEHAv6qX4BrQLJLQPQUrTrzdcgm", "id": "QmcrQZ6RJdpYuGvZqD5QEHAv6qX4BrQLJLQPQUrTrzdcgm",
"privKey": "CAASqAkwggSkAgEAAoIBAQDLZZcGcbe4urMBVlcHgN0fpBymY+xcr14ewvamG70QZODJ1h9sljlExZ7byLiqRB3SjGbfpZ1FweznwNxWtWpjHkQjTVXeoM4EEgDSNO/Cg7KNlU0EJvgPJXeEPycAZX9qASbVJ6EECQ40VR/7+SuSqsdL1hrmG1phpIju+D64gLyWpw9WEALfzMpH5I/KvdYDW3N4g6zOD2mZNp5y1gHeXINHWzMF596O72/6cxwyiXV1eJ000k1NVnUyrPjXtqWdVLRk5IU1LFpoQoXZU5X1hKj1a2qt/lZfH5eOrF/ramHcwhrYYw1txf8JHXWO/bbNnyemTHAvutZpTNrsWATfAgMBAAECggEAQj0obPnVyjxLFZFnsFLgMHDCv9Fk5V5bOYtmxfvcm50us6ye+T8HEYWGUa9RrGmYiLweuJD34gLgwyzE1RwptHPj3tdNsr4NubefOtXwixlWqdNIjKSgPlaGULQ8YF2tm/kaC2rnfifwz0w1qVqhPReO5fypL+0ShyANVD3WN0Fo2ugzrniCXHUpR2sHXSg6K+2+qWdveyjNWog34b7CgpV73Ln96BWae6ElU8PR5AWdMnRaA9ucA+/HWWJIWB3Fb4+6uwlxhu2L50Ckq1gwYZCtGw63q5L4CglmXMfIKnQAuEzazq9T4YxEkp+XDnVZAOgnQGUBYpetlgMmkkh9qQKBgQDvsEs0ThzFLgnhtC2Jy//ZOrOvIAKAZZf/mS08AqWH3L0/Rjm8ZYbLsRcoWU78sl8UFFwAQhMRDBP9G+RPojWVahBL/B7emdKKnFR1NfwKjFdDVaoX5uNvZEKSl9UubbC4WZJ65u/cd5jEnj+w3ir9G8n+P1gp/0yBz02nZXFgSwKBgQDZPQr4HBxZL7Kx7D49ormIlB7CCn2i7mT11Cppn5ifUTrp7DbFJ2t9e8UNk6tgvbENgCKXvXWsmflSo9gmMxeEOD40AgAkO8Pn2R4OYhrwd89dECiKM34HrVNBzGoB5+YsAno6zGvOzLKbNwMG++2iuNXqXTk4uV9GcI8OnU5ZPQKBgCZUGrKSiyc85XeiSGXwqUkjifhHNh8yH8xPwlwGUFIZimnD4RevZI7OEtXw8iCWpX2gg9XGuyXOuKORAkF5vvfVriV4e7c9Ad4Igbj8mQFWz92EpV6NHXGCpuKqRPzXrZrNOA9PPqwSs+s9IxI1dMpk1zhBCOguWx2m+NP79NVhAoGBAI6WSoTfrpu7ewbdkVzTWgQTdLzYNe6jmxDf2ZbKclrf7lNr/+cYIK2Ud5qZunsdBwFdgVcnu/02czeS42TvVBgs8mcgiQc/Uy7yi4/VROlhOnJTEMjlU2umkGc3zLzDgYiRd7jwRDLQmMrYKNyEr02HFKFn3w8kXSzW5I8rISnhAoGBANhchHVtJd3VMYvxNcQb909FiwTnT9kl9pkjhwivx+f8/K8pDfYCjYSBYCfPTM5Pskv5dXzOdnNuCj6Y2H/9m2SsObukBwF0z5Qijgu1DsxvADVIKZ4rzrGb4uSEmM6200qjJ/9U98fVM7rvOraakrhcf9gRwuspguJQnSO9cLj6", "privKey": "CAASqAkwggSkAgEAAoIBAQDLZZcGcbe4urMBVlcHgN0fpBymY+xcr14ewvamG70QZODJ1h9sljlExZ7byLiqRB3SjGbfpZ1FweznwNxWtWpjHkQjTVXeoM4EEgDSNO/Cg7KNlU0EJvgPJXeEPycAZX9qASbVJ6EECQ40VR/7+SuSqsdL1hrmG1phpIju+D64gLyWpw9WEALfzMpH5I/KvdYDW3N4g6zOD2mZNp5y1gHeXINHWzMF596O72/6cxwyiXV1eJ000k1NVnUyrPjXtqWdVLRk5IU1LFpoQoXZU5X1hKj1a2qt/lZfH5eOrF/ramHcwhrYYw1txf8JHXWO/bbNnyemTHAvutZpTNrsWATfAgMBAAECggEAQj0obPnVyjxLFZFnsFLgMHDCv9Fk5V5bOYtmxfvcm50us6ye+T8HEYWGUa9RrGmYiLweuJD34gLgwyzE1RwptHPj3tdNsr4NubefOtXwixlWqdNIjKSgPlaGULQ8YF2tm/kaC2rnfifwz0w1qVqhPReO5fypL+0ShyANVD3WN0Fo2ugzrniCXHUpR2sHXSg6K+2+qWdveyjNWog34b7CgpV73Ln96BWae6ElU8PR5AWdMnRaA9ucA+/HWWJIWB3Fb4+6uwlxhu2L50Ckq1gwYZCtGw63q5L4CglmXMfIKnQAuEzazq9T4YxEkp+XDnVZAOgnQGUBYpetlgMmkkh9qQKBgQDvsEs0ThzFLgnhtC2Jy//ZOrOvIAKAZZf/mS08AqWH3L0/Rjm8ZYbLsRcoWU78sl8UFFwAQhMRDBP9G+RPojWVahBL/B7emdKKnFR1NfwKjFdDVaoX5uNvZEKSl9UubbC4WZJ65u/cd5jEnj+w3ir9G8n+P1gp/0yBz02nZXFgSwKBgQDZPQr4HBxZL7Kx7D49ormIlB7CCn2i7mT11Cppn5ifUTrp7DbFJ2t9e8UNk6tgvbENgCKXvXWsmflSo9gmMxeEOD40AgAkO8Pn2R4OYhrwd89dECiKM34HrVNBzGoB5+YsAno6zGvOzLKbNwMG++2iuNXqXTk4uV9GcI8OnU5ZPQKBgCZUGrKSiyc85XeiSGXwqUkjifhHNh8yH8xPwlwGUFIZimnD4RevZI7OEtXw8iCWpX2gg9XGuyXOuKORAkF5vvfVriV4e7c9Ad4Igbj8mQFWz92EpV6NHXGCpuKqRPzXrZrNOA9PPqwSs+s9IxI1dMpk1zhBCOguWx2m+NP79NVhAoGBAI6WSoTfrpu7ewbdkVzTWgQTdLzYNe6jmxDf2ZbKclrf7lNr/+cYIK2Ud5qZunsdBwFdgVcnu/02czeS42TvVBgs8mcgiQc/Uy7yi4/VROlhOnJTEMjlU2umkGc3zLzDgYiRd7jwRDLQmMrYKNyEr02HFKFn3w8kXSzW5I8rISnhAoGBANhchHVtJd3VMYvxNcQb909FiwTnT9kl9pkjhwivx+f8/K8pDfYCjYSBYCfPTM5Pskv5dXzOdnNuCj6Y2H/9m2SsObukBwF0z5Qijgu1DsxvADVIKZ4rzrGb4uSEmM6200qjJ/9U98fVM7rvOraakrhcf9gRwuspguJQnSO9cLj6",
"pubKey": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDLZZcGcbe4urMBVlcHgN0fpBymY+xcr14ewvamG70QZODJ1h9sljlExZ7byLiqRB3SjGbfpZ1FweznwNxWtWpjHkQjTVXeoM4EEgDSNO/Cg7KNlU0EJvgPJXeEPycAZX9qASbVJ6EECQ40VR/7+SuSqsdL1hrmG1phpIju+D64gLyWpw9WEALfzMpH5I/KvdYDW3N4g6zOD2mZNp5y1gHeXINHWzMF596O72/6cxwyiXV1eJ000k1NVnUyrPjXtqWdVLRk5IU1LFpoQoXZU5X1hKj1a2qt/lZfH5eOrF/ramHcwhrYYw1txf8JHXWO/bbNnyemTHAvutZpTNrsWATfAgMBAAE=" "pubKey": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDLZZcGcbe4urMBVlcHgN0fpBymY+xcr14ewvamG70QZODJ1h9sljlExZ7byLiqRB3SjGbfpZ1FweznwNxWtWpjHkQjTVXeoM4EEgDSNO/Cg7KNlU0EJvgPJXeEPycAZX9qASbVJ6EECQ40VR/7+SuSqsdL1hrmG1phpIju+D64gLyWpw9WEALfzMpH5I/KvdYDW3N4g6zOD2mZNp5y1gHeXINHWzMF596O72/6cxwyiXV1eJ000k1NVnUyrPjXtqWdVLRk5IU1LFpoQoXZU5X1hKj1a2qt/lZfH5eOrF/ramHcwhrYYw1txf8JHXWO/bbNnyemTHAvutZpTNrsWATfAgMBAAE="

View File

@ -1,23 +1,23 @@
'use strict' import { TCP } from '@libp2p/tcp'
import { WebSockets } from '@libp2p/websockets'
import { Mplex } from '@libp2p/mplex'
import { Noise } from '@chainsafe/libp2p-noise'
import defaultsDeep from '@nodeutils/defaults-deep'
import { createLibp2p as createNode } from 'libp2p'
const TCP = require('libp2p-tcp') export async function createLibp2p(_options) {
const WS = require('libp2p-websockets')
const mplex = require('libp2p-mplex')
const { NOISE } = require('@chainsafe/libp2p-noise')
const defaultsDeep = require('@nodeutils/defaults-deep')
const libp2p = require('../../..')
async function createLibp2p(_options) {
const defaults = { const defaults = {
modules: { transports: [
transport: [TCP, WS], new TCP(),
streamMuxer: [mplex], new WebSockets()
connEncryption: [NOISE], ],
}, streamMuxers: [
new Mplex()
],
connectionEncryption: [
new Noise()
]
} }
return libp2p.create(defaultsDeep(_options, defaults)) return createNode(defaultsDeep(_options, defaults))
} }
module.exports = createLibp2p

View File

@ -1,16 +1,16 @@
'use strict'
/* eslint-disable no-console */ /* eslint-disable no-console */
/* /*
* Listener Node * Listener Node
*/ */
const PeerId = require('peer-id') import { createLibp2p } from './libp2p.js'
const createLibp2p = require('./libp2p') import { pipe } from 'it-pipe'
const pipe = require('it-pipe') import { createFromJSON } from '@libp2p/peer-id-factory'
import idl from './id-l.js'
async function run() { async function run() {
const listenerId = await PeerId.createFromJSON(require('./id-l')) const listenerId = await createFromJSON(idl)
// Listener libp2p node // Listener libp2p node
const listenerNode = await createLibp2p({ const listenerNode = await createLibp2p({
@ -21,8 +21,9 @@ async function run() {
}) })
// Log a message when we receive a connection // Log a message when we receive a connection
listenerNode.connectionManager.on('peer:connect', (connection) => { listenerNode.connectionManager.addEventListener('peer:connect', (evt) => {
console.log('received dial to me from:', connection.remotePeer.toB58String()) const connection = evt.detail
console.log('received dial to me from:', connection.remotePeer.toString())
}) })
// Handle incoming connections for the protocol by piping from the stream // Handle incoming connections for the protocol by piping from the stream
@ -33,8 +34,8 @@ async function run() {
await listenerNode.start() await listenerNode.start()
console.log('Listener ready, listening on:') console.log('Listener ready, listening on:')
listenerNode.multiaddrs.forEach((ma) => { listenerNode.getMultiaddrs().forEach((ma) => {
console.log(ma.toString() + '/p2p/' + listenerId.toB58String()) console.log(ma.toString())
}) })
} }

View File

@ -1,9 +1,10 @@
'use strict' import path from 'path'
import execa from 'execa'
import pDefer from 'p-defer'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const execa = require('execa')
const pDefer = require('p-defer')
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
function startProcess(name) { function startProcess(name) {
return execa('node', [path.join(__dirname, name)], { return execa('node', [path.join(__dirname, name)], {
@ -12,7 +13,7 @@ function startProcess(name) {
}) })
} }
async function test () { export async function test () {
const listenerReady = pDefer() const listenerReady = pDefer()
const messageReceived = pDefer() const messageReceived = pDefer()
@ -57,5 +58,3 @@ async function test () {
} }
}) })
} }
module.exports = test

View File

@ -1,3 +0,0 @@
{
"plugins": ["syntax-async-functions","transform-regenerator"]
}

View File

@ -1,14 +1,15 @@
import 'babel-polyfill' import { createLibp2p } from 'libp2p'
import Libp2p from 'libp2p' import { WebSockets } from '@libp2p/websockets'
import Websockets from 'libp2p-websockets' import { WebRTCStar } from '@libp2p/webrtc-star'
import WebRTCStar from 'libp2p-webrtc-star' import { Noise } from '@chainsafe/libp2p-noise'
import { NOISE } from '@chainsafe/libp2p-noise' import { Mplex } from '@libp2p/mplex'
import Mplex from 'libp2p-mplex' import { Bootstrap } from '@libp2p/bootstrap'
import Bootstrap from 'libp2p-bootstrap'
document.addEventListener('DOMContentLoaded', async () => { document.addEventListener('DOMContentLoaded', async () => {
const webRtcStar = new WebRTCStar()
// Create our libp2p node // Create our libp2p node
const libp2p = await Libp2p.create({ const libp2p = await createLibp2p({
addresses: { addresses: {
// Add the signaling server address, along with our PeerId to our multiaddrs list // Add the signaling server address, along with our PeerId to our multiaddrs list
// libp2p will automatically attempt to dial to the signaling server so that it can // libp2p will automatically attempt to dial to the signaling server so that it can
@ -18,28 +19,24 @@ document.addEventListener('DOMContentLoaded', async () => {
'/dns4/wrtc-star2.sjc.dwebops.pub/tcp/443/wss/p2p-webrtc-star' '/dns4/wrtc-star2.sjc.dwebops.pub/tcp/443/wss/p2p-webrtc-star'
] ]
}, },
modules: { transports: [
transport: [Websockets, WebRTCStar], new WebSockets(),
connEncryption: [NOISE], webRtcStar
streamMuxer: [Mplex], ],
peerDiscovery: [Bootstrap] connectionEncryption: [new Noise()],
}, streamMuxers: [new Mplex()],
config: { peerDiscovery: [
peerDiscovery: { webRtcStar.discovery,
// The `tag` property will be searched when creating the instance of your Peer Discovery service. new Bootstrap({
// The associated object, will be passed to the service when it is instantiated. list: [
[Bootstrap.tag]: { '/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN',
enabled: true, '/dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb',
list: [ '/dnsaddr/bootstrap.libp2p.io/p2p/QmZa1sAxajnQjVM8WjWXoMbmPd7NsWhfKsPkErzpm9wGkp',
'/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN', '/dnsaddr/bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa',
'/dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb', '/dnsaddr/bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt'
'/dnsaddr/bootstrap.libp2p.io/p2p/QmZa1sAxajnQjVM8WjWXoMbmPd7NsWhfKsPkErzpm9wGkp', ]
'/dnsaddr/bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa', })
'/dnsaddr/bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt' ]
]
}
}
}
}) })
// UI elements // UI elements
@ -54,23 +51,26 @@ document.addEventListener('DOMContentLoaded', async () => {
} }
// Listen for new peers // Listen for new peers
libp2p.on('peer:discovery', (peerId) => { libp2p.addEventListener('peer:discovery', (evt) => {
log(`Found peer ${peerId.toB58String()}`) const peer = evt.detail
log(`Found peer ${peer.id.toString()}`)
}) })
// Listen for new connections to peers // Listen for new connections to peers
libp2p.connectionManager.on('peer:connect', (connection) => { libp2p.connectionManager.addEventListener('peer:connect', (evt) => {
log(`Connected to ${connection.remotePeer.toB58String()}`) const connection = evt.detail
log(`Connected to ${connection.remotePeer.toString()}`)
}) })
// Listen for peers disconnecting // Listen for peers disconnecting
libp2p.connectionManager.on('peer:disconnect', (connection) => { libp2p.connectionManager.addEventListener('peer:disconnect', (evt) => {
log(`Disconnected from ${connection.remotePeer.toB58String()}`) const connection = evt.detail
log(`Disconnected from ${connection.remotePeer.toString()}`)
}) })
await libp2p.start() await libp2p.start()
status.innerText = 'libp2p started!' status.innerText = 'libp2p started!'
log(`libp2p id is ${libp2p.peerId.toB58String()}`) log(`libp2p id is ${libp2p.peerId.toString()}`)
// Export libp2p to the window so you can play with the API // Export libp2p to the window so you can play with the API
window.libp2p = libp2p window.libp2p = libp2p

View File

@ -2,31 +2,24 @@
"name": "libp2p-in-browser", "name": "libp2p-in-browser",
"version": "1.0.0", "version": "1.0.0",
"description": "A libp2p node running in the browser", "description": "A libp2p node running in the browser",
"type": "module",
"browserslist": [ "browserslist": [
"last 2 Chrome versions" "last 2 Chrome versions"
], ],
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1", "test": "echo \"Error: no test specified\" && exit 1",
"build": "parcel build index.html", "start": "vite"
"start": "parcel index.html"
}, },
"keywords": [],
"author": "",
"license": "ISC", "license": "ISC",
"dependencies": { "dependencies": {
"@chainsafe/libp2p-noise": "^5.0.2", "@chainsafe/libp2p-noise": "^6.0.1",
"libp2p": "../../", "@libp2p/bootstrap": "^1.0.1",
"libp2p-bootstrap": "^0.14.0", "@libp2p/mplex": "^1.0.2",
"libp2p-mplex": "^0.10.4", "@libp2p/webrtc-star": "^1.0.6",
"libp2p-webrtc-star": "^0.25.0", "@libp2p/websockets": "^1.0.3",
"libp2p-websockets": "^0.16.1" "libp2p": "../../"
}, },
"devDependencies": { "devDependencies": {
"@babel/cli": "^7.13.10", "vite": "^2.8.6"
"@babel/core": "^7.13.0",
"babel-plugin-syntax-async-functions": "^6.13.0",
"babel-plugin-transform-regenerator": "^6.26.0",
"babel-polyfill": "^6.26.0",
"parcel": "^2.0.1"
} }
} }

View File

@ -1,11 +1,14 @@
'use strict' import execa from 'execa'
import { chromium } from 'playwright'
import path from 'path'
import { fileURLToPath } from 'url'
const execa = require('execa') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { chromium } = require('playwright');
async function run() { export async function test () {
let url = '' let url = 'http://localhost:3000'
const proc = execa('parcel', ['./index.html'], {
const proc = execa('vite', [], {
preferLocal: true, preferLocal: true,
localDir: __dirname, localDir: __dirname,
cwd: __dirname, cwd: __dirname,
@ -16,11 +19,7 @@ async function run() {
/**@type {string} */ /**@type {string} */
const out = chunk.toString() const out = chunk.toString()
if (out.includes('Server running at')) { if (out.includes('ready in')) {
url = out.split('Server running at ')[1]
}
if (out.includes('Built in')) {
try { try {
const browser = await chromium.launch(); const browser = await chromium.launch();
const page = await browser.newPage(); const page = await browser.newPage();
@ -36,9 +35,8 @@ async function run() {
'#output', '#output',
{ timeout: 5000 } { timeout: 5000 }
) )
await browser.close(); await browser.close()
} catch (err) {
} catch (/** @type {any} */ err) {
console.error(err) console.error(err)
process.exit(1) process.exit(1)
} finally { } finally {
@ -46,7 +44,4 @@ async function run() {
} }
} }
}) })
} }
module.exports = run

View File

@ -2,18 +2,18 @@
"name": "libp2p-examples", "name": "libp2p-examples",
"version": "1.0.0", "version": "1.0.0",
"description": "Examples of how to use libp2p", "description": "Examples of how to use libp2p",
"type": "module",
"scripts": { "scripts": {
"test": "node ./test.js", "test": "node ./test.js",
"test:all": "node ./test-all.js" "test:all": "node ./test-all.js"
}, },
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@achingbrain/libp2p-gossipsub": "^0.12.2", "@achingbrain/libp2p-gossipsub": "^0.13.5",
"@libp2p/pubsub-peer-discovery": "^5.0.1",
"execa": "^2.1.0", "execa": "^2.1.0",
"fs-extra": "^8.1.0", "fs-extra": "^8.1.0",
"libp2p": "../src", "libp2p": "../",
"libp2p-pubsub-peer-discovery": "^4.0.0",
"libp2p-relay-server": "^0.3.0",
"p-defer": "^3.0.0", "p-defer": "^3.0.0",
"uint8arrays": "^3.0.0", "uint8arrays": "^3.0.0",
"which": "^2.0.1" "which": "^2.0.1"

View File

@ -1,30 +1,21 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../../') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const Mplex = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const KadDHT = require('libp2p-kad-dht') import { KadDHT } from '@libp2p/kad-dht'
import delay from 'delay'
const delay = require('delay')
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [Mplex], connectionEncryption: [new Noise()],
connEncryption: [NOISE], dht: new KadDHT()
dht: KadDHT
},
config: {
dht: {
enabled: true
}
}
}) })
await node.start() await node.start()
@ -38,8 +29,8 @@ const createNode = async () => {
createNode() createNode()
]) ])
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
await node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs) await node2.peerStore.addressBook.set(node3.peerId, node3.getMultiaddrs())
await Promise.all([ await Promise.all([
node1.dial(node2.peerId), node1.dial(node2.peerId),
@ -52,5 +43,5 @@ const createNode = async () => {
const peer = await node1.peerRouting.findPeer(node3.peerId) const peer = await node1.peerRouting.findPeer(node3.peerId)
console.log('Found it, multiaddrs are:') console.log('Found it, multiaddrs are:')
peer.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${peer.id.toB58String()}`)) peer.multiaddrs.forEach((ma) => console.log(ma.toString()))
})(); })();

View File

@ -1,32 +1,23 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../../') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const Mplex = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const { CID } = require('multiformats/cid') import { CID } from 'multiformats/cid'
const KadDHT = require('libp2p-kad-dht') import { KadDHT } from '@libp2p/kad-dht'
import all from 'it-all'
const all = require('it-all') import delay from 'delay'
const delay = require('delay')
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [Mplex], connectionEncryption: [new Noise()],
connEncryption: [NOISE], dht: new KadDHT()
dht: KadDHT
},
config: {
dht: {
enabled: true
}
}
}) })
await node.start() await node.start()
@ -40,8 +31,8 @@ const createNode = async () => {
createNode() createNode()
]) ])
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
await node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs) await node2.peerStore.addressBook.set(node3.peerId, node3.getMultiaddrs())
await Promise.all([ await Promise.all([
node1.dial(node2.peerId), node1.dial(node2.peerId),
@ -54,12 +45,12 @@ const createNode = async () => {
const cid = CID.parse('QmTp9VkYvnHyrqKQuFPiuZkiX9gPcqj6x5LJ1rmWuSySnL') const cid = CID.parse('QmTp9VkYvnHyrqKQuFPiuZkiX9gPcqj6x5LJ1rmWuSySnL')
await node1.contentRouting.provide(cid) await node1.contentRouting.provide(cid)
console.log('Node %s is providing %s', node1.peerId.toB58String(), cid.toString()) console.log('Node %s is providing %s', node1.peerId.toString(), cid.toString())
// wait for propagation // wait for propagation
await delay(300) await delay(300)
const providers = await all(node3.contentRouting.findProviders(cid, { timeout: 3000 })) const providers = await all(node3.contentRouting.findProviders(cid, { timeout: 3000 }))
console.log('Found provider:', providers[0].id.toB58String()) console.log('Found provider:', providers[0].id.toString())
})(); })();

View File

@ -13,26 +13,24 @@ This example builds on top of the [Protocol and Stream Muxing](../protocol-and-s
First, let's update our config to support Peer Routing and Content Routing. First, let's update our config to support Peer Routing and Content Routing.
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const KadDHT = require('libp2p-kad-dht') import { KadDHT } from '@libp2p/kad-dht'
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [
transport: [ TCP ], new TCP()
streamMuxer: [ Mplex ], ],
connEncryption: [ NOISE ], streamMuxers: [
// we add the DHT module that will enable Peer and Content Routing new Mplex()
dht: KadDHT ],
}, connEncryption: [
config: { new Noise()
dht: { ],
// dht must be enabled // we add the DHT module that will enable Peer and Content Routing
enabled: true dht: KadDHT
}
}
}) })
``` ```

View File

@ -1,14 +1,13 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { waitForOutput } = require('../utils')
async function test () { export async function test () {
process.stdout.write('1.js\n') process.stdout.write('1.js\n')
await waitForOutput('Found it, multiaddrs are:', 'node', [path.join(__dirname, '1.js')], { await waitForOutput('Found it, multiaddrs are:', 'node', [path.join(__dirname, '1.js')], {
cwd: __dirname cwd: __dirname
}) })
} }
module.exports = test

View File

@ -1,14 +1,13 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { waitForOutput } = require('../utils')
async function test () { export async function test () {
process.stdout.write('2.js\n') process.stdout.write('2.js\n')
await waitForOutput('Found provider:', 'node', [path.join(__dirname, '2.js')], { await waitForOutput('Found provider:', 'node', [path.join(__dirname, '2.js')], {
cwd: __dirname cwd: __dirname
}) })
} }
module.exports = test

View File

@ -1,11 +1,7 @@
'use strict' import { test as test1 } from './test-1.js'
import { test as test2 } from './test-2.js'
const test1 = require('./test-1') export async function test() {
const test2 = require('./test-2')
async function test() {
await test1() await test1()
await test2() await test2()
} }
module.exports = test

View File

@ -1,10 +1,10 @@
/* eslint no-console: ["off"] */ /* eslint no-console: ["off"] */
'use strict'
const { generate } = require('libp2p/src/pnet') import { generate } from 'libp2p/pnet/generate'
const privateLibp2pNode = require('./libp2p-node') import { privateLibp2pNode } from './libp2p-node.js'
import { pipe } from 'it-pipe'
const pipe = require('it-pipe') import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
// Create a Uint8Array and write the swarm key to it // Create a Uint8Array and write the swarm key to it
const swarmKey = new Uint8Array(95) const swarmKey = new Uint8Array(95)
@ -29,7 +29,7 @@ generate(otherSwarmKey)
console.log('nodes started...') console.log('nodes started...')
// Add node 2 data to node1's PeerStore // Add node 2 data to node1's PeerStore
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
await node1.dial(node2.peerId) await node1.dial(node2.peerId)
node2.handle('/private', ({ stream }) => { node2.handle('/private', ({ stream }) => {
@ -37,7 +37,7 @@ generate(otherSwarmKey)
stream, stream,
async function (source) { async function (source) {
for await (const msg of source) { for await (const msg of source) {
console.log(msg.toString()) console.log(uint8ArrayToString(msg))
} }
} }
) )
@ -46,7 +46,7 @@ generate(otherSwarmKey)
const { stream } = await node1.dialProtocol(node2.peerId, '/private') const { stream } = await node1.dialProtocol(node2.peerId, '/private')
await pipe( await pipe(
['This message is sent on a private network'], [uint8ArrayFromString('This message is sent on a private network')],
stream stream
) )
})() })()

View File

@ -1,38 +1,31 @@
'use strict' import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'
const Libp2p = require('libp2p') import { Mplex } from '@libp2p/mplex'
const TCP = require('libp2p-tcp') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { PreSharedKeyConnectionProtector } from 'libp2p/pnet'
const { NOISE } = require('@chainsafe/libp2p-noise')
const Protector = require('libp2p/src/pnet')
/** /**
* privateLibp2pNode returns a libp2p node function that will use the swarm * privateLibp2pNode returns a libp2p node function that will use the swarm
* key with the given `swarmKey` to create the Protector * key with the given `swarmKey` to create the Protector
*
* @param {Uint8Array} swarmKey
* @returns {Promise<libp2p>} Returns a libp2pNode function for use in IPFS creation
*/ */
const privateLibp2pNode = async (swarmKey) => { export async function privateLibp2pNode (swarmKey) {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()], // We're only using the TCP transport for this example
transport: [TCP], // We're only using the TCP transport for this example streamMuxers: [new Mplex()], // We're only using mplex muxing
streamMuxer: [MPLEX], // We're only using mplex muxing // Let's make sure to use identifying crypto in our pnet since the protector doesn't
// Let's make sure to use identifying crypto in our pnet since the protector doesn't // care about node identity, and only the presence of private keys
// care about node identity, and only the presence of private keys connectionEncryption: [new Noise()],
connEncryption: [NOISE], // Leave peer discovery empty, we don't want to find peers. We could omit the property, but it's
// Leave peer discovery empty, we don't want to find peers. We could omit the property, but it's // being left in for explicit readability.
// being left in for explicit readability. // We should explicitly dial pnet peers, or use a custom discovery service for finding nodes in our pnet
// We should explicitly dial pnet peers, or use a custom discovery service for finding nodes in our pnet peerDiscovery: [],
peerDiscovery: [], connectionProtector: new PreSharedKeyConnectionProtector({
connProtector: new Protector(swarmKey) psk: swarmKey
} })
}) })
return node return node
} }
module.exports = privateLibp2pNode

View File

@ -1,13 +1,12 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { waitForOutput } = require('../utils')
async function test () { export async function test () {
await waitForOutput('This message is sent on a private network', 'node', [path.join(__dirname, 'index.js')], { await waitForOutput('This message is sent on a private network', 'node', [path.join(__dirname, 'index.js')], {
cwd: __dirname cwd: __dirname
}) })
} }
module.exports = test

View File

@ -1,6 +1,6 @@
'use strict' 'use strict'
const fs = require('fs') const fs from 'fs')
const path = require('path') import path from 'path'
/** /**
* mkdirp recursively creates needed folders for the given dir path * mkdirp recursively creates needed folders for the given dir path

View File

@ -1,22 +1,19 @@
'use strict' import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'
const Libp2p = require('../../') import { Mplex } from '@libp2p/mplex'
const TCP = require('libp2p-tcp') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { pipe } from 'it-pipe'
const { NOISE } = require('@chainsafe/libp2p-noise') import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
const pipe = require('it-pipe')
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
}
}) })
await node.start() await node.start()
@ -31,7 +28,7 @@ const createNode = async () => {
]) ])
// Add node's 2 data to the PeerStore // Add node's 2 data to the PeerStore
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
// exact matching // exact matching
node2.handle('/your-protocol', ({ stream }) => { node2.handle('/your-protocol', ({ stream }) => {
@ -39,7 +36,7 @@ const createNode = async () => {
stream, stream,
async function (source) { async function (source) {
for await (const msg of source) { for await (const msg of source) {
console.log(msg.toString()) console.log(uint8ArrayToString(msg))
} }
} }
) )
@ -56,7 +53,7 @@ const createNode = async () => {
stream, stream,
async function (source) { async function (source) {
for await (const msg of source) { for await (const msg of source) {
console.log(msg.toString()) console.log(uint8ArrayToString(msg))
} }
} }
) )
@ -65,7 +62,7 @@ const createNode = async () => {
const { stream } = await node1.dialProtocol(node2.peerId, ['/your-protocol']) const { stream } = await node1.dialProtocol(node2.peerId, ['/your-protocol'])
await pipe( await pipe(
['my own protocol, wow!'], [uint8ArrayFromString('my own protocol, wow!')],
stream stream
) )

View File

@ -1,22 +1,19 @@
'use strict' import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'
const Libp2p = require('../../') import { Mplex } from '@libp2p/mplex'
const TCP = require('libp2p-tcp') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { pipe } from 'it-pipe'
const { NOISE } = require('@chainsafe/libp2p-noise') import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
const pipe = require('it-pipe')
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
}
}) })
await node.start() await node.start()
@ -31,14 +28,14 @@ const createNode = async () => {
]) ])
// Add node's 2 data to the PeerStore // Add node's 2 data to the PeerStore
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
node2.handle(['/a', '/b'], ({ protocol, stream }) => { node2.handle(['/a', '/b'], ({ protocol, stream }) => {
pipe( pipe(
stream, stream,
async function (source) { async function (source) {
for await (const msg of source) { for await (const msg of source) {
console.log(`from: ${protocol}, msg: ${msg.toString()}`) console.log(`from: ${protocol}, msg: ${uint8ArrayToString(msg)}`)
} }
} }
) )
@ -46,19 +43,19 @@ const createNode = async () => {
const { stream: stream1 } = await node1.dialProtocol(node2.peerId, ['/a']) const { stream: stream1 } = await node1.dialProtocol(node2.peerId, ['/a'])
await pipe( await pipe(
['protocol (a)'], [uint8ArrayFromString('protocol (a)')],
stream1 stream1
) )
const { stream: stream2 } = await node1.dialProtocol(node2.peerId, ['/b']) const { stream: stream2 } = await node1.dialProtocol(node2.peerId, ['/b'])
await pipe( await pipe(
['protocol (b)'], [uint8ArrayFromString('protocol (b)')],
stream2 stream2
) )
const { stream: stream3 } = await node1.dialProtocol(node2.peerId, ['/b']) const { stream: stream3 } = await node1.dialProtocol(node2.peerId, ['/b'])
await pipe( await pipe(
['another stream on protocol (b)'], [uint8ArrayFromString('another stream on protocol (b)')],
stream3 stream3
) )
})(); })();

View File

@ -1,23 +1,21 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../../') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
import { pipe } from 'it-pipe'
const pipe = require('it-pipe') import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
}
}) })
await node.start() await node.start()
@ -32,14 +30,14 @@ const createNode = async () => {
]) ])
// Add node's 2 data to the PeerStore // Add node's 2 data to the PeerStore
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
node1.handle('/node-1', ({ stream }) => { node1.handle('/node-1', ({ stream }) => {
pipe( pipe(
stream, stream,
async function (source) { async function (source) {
for await (const msg of source) { for await (const msg of source) {
console.log(msg.toString()) console.log(uint8ArrayToString(msg))
} }
} }
) )
@ -50,7 +48,7 @@ const createNode = async () => {
stream, stream,
async function (source) { async function (source) {
for await (const msg of source) { for await (const msg of source) {
console.log(msg.toString()) console.log(uint8ArrayToString(msg))
} }
} }
) )
@ -58,13 +56,13 @@ const createNode = async () => {
const { stream: stream1 } = await node1.dialProtocol(node2.peerId, ['/node-2']) const { stream: stream1 } = await node1.dialProtocol(node2.peerId, ['/node-2'])
await pipe( await pipe(
['from 1 to 2'], [uint8ArrayFromString('from 1 to 2')],
stream1 stream1
) )
const { stream: stream2 } = await node2.dialProtocol(node1.peerId, ['/node-1']) const { stream: stream2 } = await node2.dialProtocol(node1.peerId, ['/node-1'])
await pipe( await pipe(
['from 2 to 1'], [uint8ArrayFromString('from 2 to 1')],
stream2 stream2
) )
})(); })();

View File

@ -11,9 +11,9 @@ Let's see _protocol multiplexing_ in action! You will need the following modules
After creating the nodes, we need to tell libp2p which protocols to handle. After creating the nodes, we need to tell libp2p which protocols to handle.
```JavaScript ```JavaScript
const pipe = require('it-pipe') import { pipe } from 'it-pipe'
const { map } = require('streaming-iterables') const { map } from 'streaming-iterables')
const { toBuffer } = require('it-buffer') const { toBuffer } from 'it-buffer')
// ... // ...
const node1 = nodes[0] const node1 = nodes[0]
@ -102,17 +102,19 @@ Stream multiplexing is an old concept, in fact it happens in many of the layers
Currently, we have [libp2p-mplex](https://github.com/libp2p/js-libp2p-mplex) and pluging it in is as easy as adding a transport. Let's revisit our libp2p configuration. Currently, we have [libp2p-mplex](https://github.com/libp2p/js-libp2p-mplex) and pluging it in is as easy as adding a transport. Let's revisit our libp2p configuration.
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
//... //...
const createNode = () => { const createNode = () => {
return Libp2p.create({ return Libp2p.create({
modules: { transports: [
transport: [ TCP ], new TCP()
streamMuxer: [ Mplex ] ],
} streamMuxers: [
new Mplex()
]
}) })
} }
``` ```

View File

@ -1,14 +1,13 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { waitForOutput } = require('../utils')
async function test () { export async function test () {
process.stdout.write('1.js\n') process.stdout.write('1.js\n')
await waitForOutput('my own protocol, wow!', 'node', [path.join(__dirname, '1.js')], { await waitForOutput('my own protocol, wow!', 'node', [path.join(__dirname, '1.js')], {
cwd: __dirname cwd: __dirname
}) })
} }
module.exports = test

View File

@ -1,14 +1,13 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { waitForOutput } = require('../utils')
async function test () { export async function test () {
process.stdout.write('2.js\n') process.stdout.write('2.js\n')
await waitForOutput('another stream on protocol (b)', 'node', [path.join(__dirname, '2.js')], { await waitForOutput('another stream on protocol (b)', 'node', [path.join(__dirname, '2.js')], {
cwd: __dirname cwd: __dirname
}) })
} }
module.exports = test

View File

@ -1,14 +1,13 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { waitForOutput } = require('../utils')
async function test () { export async function test () {
process.stdout.write('3.js\n') process.stdout.write('3.js\n')
await waitForOutput('from 2 to 1', 'node', [path.join(__dirname, '3.js')], { await waitForOutput('from 2 to 1', 'node', [path.join(__dirname, '3.js')], {
cwd: __dirname cwd: __dirname
}) })
} }
module.exports = test

View File

@ -1,13 +1,9 @@
'use strict' import { test as test1 } from './test-1.js'
import { test as test2 } from './test-2.js'
import { test as test3 } from './test-3.js'
const test1 = require('./test-1') export async function test() {
const test2 = require('./test-2')
const test3 = require('./test-3')
async function test() {
await test1() await test1()
await test2() await test2()
await test3() await test3()
} }
module.exports = test

View File

@ -1,25 +1,23 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../../') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const Mplex = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const Gossipsub = require('@achingbrain/libp2p-gossipsub') import { Gossipsub } from '@achingbrain/libp2p-gossipsub'
const { fromString: uint8ArrayFromString } = require('uint8arrays/from-string') import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
const { toString: uint8ArrayToString } = require('uint8arrays/to-string') import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { CustomEvent } from '@libp2p/interfaces'
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [Mplex], connectionEncryption: [new Noise()],
connEncryption: [NOISE], pubsub: new Gossipsub()
pubsub: Gossipsub
}
}) })
await node.start() await node.start()
@ -35,22 +33,20 @@ const createNode = async () => {
]) ])
// Add node's 2 data to the PeerStore // Add node's 2 data to the PeerStore
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
await node1.dial(node2.peerId) await node1.dial(node2.peerId)
node1.pubsub.on(topic, (msg) => { node1.pubsub.addEventListener(topic, (evt) => {
console.log(`node1 received: ${uint8ArrayToString(msg.data)}`) console.log(`node1 received: ${uint8ArrayToString(evt.detail.data)}`)
}) })
node1.pubsub.subscribe(topic)
// Will not receive own published messages by default // Will not receive own published messages by default
node2.pubsub.on(topic, (msg) => { node2.pubsub.addEventListener(topic, (evt) => {
console.log(`node2 received: ${uint8ArrayToString(msg.data)}`) console.log(`node2 received: ${uint8ArrayToString(evt.detail.data)}`)
}) })
node2.pubsub.subscribe(topic)
// node2 publishes "news" every second // node2 publishes "news" every second
setInterval(() => { setInterval(() => {
node2.pubsub.publish(topic, uint8ArrayFromString('Bird bird bird, bird is the word!')) node2.pubsub.dispatchEvent(new CustomEvent(topic, { detail: uint8ArrayFromString('Bird bird bird, bird is the word!') }))
}, 1000) }, 1000)
})() })()

View File

@ -21,28 +21,32 @@ Using PubSub is super simple, you only need to provide the implementation of you
First, let's update our libp2p configuration with a pubsub implementation. First, let's update our libp2p configuration with a pubsub implementation.
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Gossipsub = require('libp2p-gossipsub') import { Gossipsub } from 'libp2p-gossipsub'
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [
transport: [ TCP ], new TCP()
streamMuxer: [ Mplex ], ],
connEncryption: [ NOISE ], streamMuxers: [
// we add the Pubsub module we want new Mplex()
pubsub: Gossipsub ],
} connectionEncryption: [
new Noise()
],
// we add the Pubsub module we want
pubsub: new Gossipsub()
}) })
``` ```
Once that is done, we only need to create a few libp2p nodes, connect them and everything is ready to start using pubsub. Once that is done, we only need to create a few libp2p nodes, connect them and everything is ready to start using pubsub.
```JavaScript ```JavaScript
const { fromString } = require('uint8arrays/from-string') const { fromString } from 'uint8arrays/from-string')
const { toString } = require('uint8arrays/to-string') const { toString } from 'uint8arrays/to-string')
const topic = 'news' const topic = 'news'
const node1 = nodes[0] const node1 = nodes[0]

View File

@ -1,25 +1,23 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../../../') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const Mplex = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const Gossipsub = require('@achingbrain/libp2p-gossipsub') import { Gossipsub } from '@achingbrain/libp2p-gossipsub'
const { fromString: uint8ArrayFromString } = require('uint8arrays/from-string') import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
const { toString: uint8ArrayToString } = require('uint8arrays/to-string') import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { CustomEvent } from '@libp2p/interfaces'
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [Mplex], connectionEncryption: [new Noise()],
connEncryption: [NOISE], pubsub: new Gossipsub()
pubsub: Gossipsub
}
}) })
await node.start() await node.start()
@ -36,28 +34,26 @@ const createNode = async () => {
]) ])
// node1 conect to node2 and node2 conect to node3 // node1 conect to node2 and node2 conect to node3
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
await node1.dial(node2.peerId) await node1.dial(node2.peerId)
await node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs) await node2.peerStore.addressBook.set(node3.peerId, node3.getMultiaddrs())
await node2.dial(node3.peerId) await node2.dial(node3.peerId)
//subscribe //subscribe
node1.pubsub.on(topic, (msg) => { node1.pubsub.addEventListener(topic, (evt) => {
// Will not receive own published messages by default // Will not receive own published messages by default
console.log(`node1 received: ${uint8ArrayToString(msg.data)}`) console.log(`node1 received: ${uint8ArrayToString(evt.detail.data)}`)
}) })
await node1.pubsub.subscribe(topic) await node1.pubsub.subscribe(topic)
node2.pubsub.on(topic, (msg) => { node2.pubsub.addEventListener(topic, (evt) => {
console.log(`node2 received: ${uint8ArrayToString(msg.data)}`) console.log(`node2 received: ${uint8ArrayToString(evt.detail.data)}`)
}) })
await node2.pubsub.subscribe(topic)
node3.pubsub.on(topic, (msg) => { node3.pubsub.addEventListener(topic, (evt) => {
console.log(`node3 received: ${uint8ArrayToString(msg.data)}`) console.log(`node3 received: ${uint8ArrayToString(evt.detail.data)}`)
}) })
await node3.pubsub.subscribe(topic)
const validateFruit = (msgTopic, msg) => { const validateFruit = (msgTopic, msg) => {
const fruit = uint8ArrayToString(msg.data) const fruit = uint8ArrayToString(msg.data)
@ -79,7 +75,7 @@ const createNode = async () => {
// car is not a fruit ! // car is not a fruit !
setInterval(() => { setInterval(() => {
console.log('############## fruit ' + myFruits[count] + ' ##############') console.log('############## fruit ' + myFruits[count] + ' ##############')
node1.pubsub.publish(topic, uint8ArrayFromString(myFruits[count])) node1.pubsub.dispatchEvent(new CustomEvent<Uint8Array>(topic, { detail: uint8ArrayFromString(myFruits[count]) }))
count++ count++
if (count == myFruits.length) { if (count == myFruits.length) {
count = 0 count = 0

View File

@ -7,19 +7,23 @@ To prevent undesired data from being propagated on the network, we can apply a f
First, let's update our libp2p configuration with a pubsub implementation. First, let's update our libp2p configuration with a pubsub implementation.
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Gossipsub = require('libp2p-gossipsub') import { Gossipsub } from 'libp2p-gossipsub'
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [
transport: [ TCP ], new TCP()
streamMuxer: [ Mplex ], ],
connEncryption: [ NOISE ], streamMuxers: [
pubsub: Gossipsub new Mplex()
} ],
connectionEncryption: [
new Noise()
],
pubsub: new Gossipsub()
}) })
``` ```

View File

@ -1,9 +1,10 @@
'use strict' import path from 'path'
import execa from 'execa'
import pDefer from 'p-defer'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const execa = require('execa')
const pDefer = require('p-defer')
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
const stdout = [ const stdout = [
{ {
@ -24,7 +25,7 @@ const stdout = [
}, },
] ]
async function test () { export async function test () {
const defer = pDefer() const defer = pDefer()
let topicCount = 0 let topicCount = 0
let topicMessageCount = 0 let topicMessageCount = 0
@ -63,5 +64,3 @@ async function test () {
await defer.promise await defer.promise
proc.kill() proc.kill()
} }
module.exports = test

View File

@ -1,11 +1,12 @@
'use strict' import path from 'path'
import execa from 'execa'
import pDefer from 'p-defer'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const execa = require('execa')
const pDefer = require('p-defer')
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
async function test () { export async function test () {
const defer = pDefer() const defer = pDefer()
process.stdout.write('1.js\n') process.stdout.write('1.js\n')
@ -26,5 +27,3 @@ async function test () {
await defer.promise await defer.promise
proc.kill() proc.kill()
} }
module.exports = test

View File

@ -1,11 +1,7 @@
'use strict' import { test as test1 } from './test-1.js'
import { test as testMessageFiltering } from './message-filtering/test.js'
const test1 = require('./test-1') export async function test() {
const testMessageFiltering = require('./message-filtering/test')
async function test() {
await test1() await test1()
await testMessageFiltering() await testMessageFiltering()
} }
module.exports = test

View File

@ -1,4 +1,3 @@
'use strict'
process.on('unhandedRejection', (err) => { process.on('unhandedRejection', (err) => {
console.error(err) console.error(err)
@ -6,11 +5,14 @@ process.on('unhandedRejection', (err) => {
process.exit(1) process.exit(1)
}) })
const path = require('path') import path from 'path'
const fs = require('fs') import fs from 'fs'
const { import {
waitForOutput waitForOutput
} = require('./utils') } from './utils.js'
import { fileURLToPath } from 'url'
const __dirname = path.dirname(fileURLToPath(import.meta.url))
async function testAll () { async function testAll () {
for (const dir of fs.readdirSync(__dirname)) { for (const dir of fs.readdirSync(__dirname)) {
@ -24,7 +26,7 @@ async function testAll () {
continue continue
} }
await waitForOutput('npm info ok', 'npm', ['test', '--', dir], { await waitForOutput('npm info ok', 'npm', ['--loglevel', 'info', 'run', 'test', '--', dir], {
cwd: __dirname cwd: __dirname
}) })
} }

View File

@ -1,11 +1,12 @@
'use strict'
process.env.NODE_ENV = 'test' process.env.NODE_ENV = 'test'
process.env.CI = true // needed for some "clever" build tools process.env.CI = true // needed for some "clever" build tools
const fs = require('fs-extra') import fs from 'fs-extra'
const path = require('path') import path from 'path'
const execa = require('execa') import execa from 'execa'
import { fileURLToPath } from 'url'
const __dirname = path.dirname(fileURLToPath(import.meta.url))
const dir = path.join(__dirname, process.argv[2]) const dir = path.join(__dirname, process.argv[2])
testExample(dir) testExample(dir)
@ -53,7 +54,7 @@ async function build (dir) {
return return
} }
const pkg = require(pkgJson) const pkg = JSON.parse(fs.readFileSync(pkgJson))
let build let build
if (pkg.scripts.bundle) { if (pkg.scripts.bundle) {
@ -88,7 +89,7 @@ async function runTest (dir) {
return return
} }
const test = require(testFile) const { test } = await import(testFile)
await test() await test()
} }

View File

@ -1,21 +1,24 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../..') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
// To signal the addresses we want to be available, we use // To signal the addresses we want to be available, we use
// the multiaddr format, a self describable address // the multiaddr format, a self describable address
listen: ['/ip4/0.0.0.0/tcp/0'] listen: [
'/ip4/0.0.0.0/tcp/0'
]
}, },
modules: { transports: [
transport: [TCP], new TCP()
connEncryption: [NOISE] ],
} connectionEncryption: [
new Noise()
]
}) })
await node.start() await node.start()
@ -27,5 +30,5 @@ const createNode = async () => {
console.log('node has started (true/false):', node.isStarted()) console.log('node has started (true/false):', node.isStarted())
console.log('listening on:') console.log('listening on:')
node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`)) node.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
})(); })();

View File

@ -1,26 +1,24 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../..') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
const pipe = require('it-pipe') import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
const concat = require('it-concat') import { pipe } from 'it-pipe'
import toBuffer from 'it-to-buffer'
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
// To signal the addresses we want to be available, we use // To signal the addresses we want to be available, we use
// the multiaddr format, a self describable address // the multiaddr format, a self describable address
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()]
streamMuxer: [MPLEX]
}
}) })
await node.start() await node.start()
@ -29,7 +27,7 @@ const createNode = async () => {
function printAddrs (node, number) { function printAddrs (node, number) {
console.log('node %s is listening on:', number) console.log('node %s is listening on:', number)
node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`)) node.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
} }
;(async () => { ;(async () => {
@ -44,16 +42,16 @@ function printAddrs (node, number) {
node2.handle('/print', async ({ stream }) => { node2.handle('/print', async ({ stream }) => {
const result = await pipe( const result = await pipe(
stream, stream,
concat toBuffer
) )
console.log(result.toString()) console.log(uint8ArrayToString(result))
}) })
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
const { stream } = await node1.dialProtocol(node2.peerId, '/print') const { stream } = await node1.dialProtocol(node2.peerId, '/print')
await pipe( await pipe(
['Hello', ' ', 'p2p', ' ', 'world', '!'], ['Hello', ' ', 'p2p', ' ', 'world', '!'].map(str => uint8ArrayFromString(str)),
stream stream
) )
})(); })();

View File

@ -1,28 +1,26 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../..') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const WebSockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
import { pipe } from 'it-pipe'
const pipe = require('it-pipe') import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
const createNode = async (transports, addresses = []) => { const createNode = async (transports, addresses = []) => {
if (!Array.isArray(addresses)) { if (!Array.isArray(addresses)) {
addresses = [addresses] addresses = [addresses]
} }
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: addresses listen: addresses
}, },
modules: { transports: transports,
transport: transports, connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()]
streamMuxer: [MPLEX]
}
}) })
await node.start() await node.start()
@ -31,7 +29,7 @@ const createNode = async (transports, addresses = []) => {
function printAddrs(node, number) { function printAddrs(node, number) {
console.log('node %s is listening on:', number) console.log('node %s is listening on:', number)
node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`)) node.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
} }
function print ({ stream }) { function print ({ stream }) {
@ -39,7 +37,7 @@ function print ({ stream }) {
stream, stream,
async function (source) { async function (source) {
for await (const msg of source) { for await (const msg of source) {
console.log(msg.toString()) console.log(uint8ArrayToString(msg))
} }
} }
) )
@ -47,9 +45,9 @@ function print ({ stream }) {
;(async () => { ;(async () => {
const [node1, node2, node3] = await Promise.all([ const [node1, node2, node3] = await Promise.all([
createNode([TCP], '/ip4/0.0.0.0/tcp/0'), createNode([new TCP()], '/ip4/0.0.0.0/tcp/0'),
createNode([TCP, WebSockets], ['/ip4/0.0.0.0/tcp/0', '/ip4/127.0.0.1/tcp/10000/ws']), createNode([new TCP(), new WebSockets()], ['/ip4/0.0.0.0/tcp/0', '/ip4/127.0.0.1/tcp/10000/ws']),
createNode([WebSockets], '/ip4/127.0.0.1/tcp/20000/ws') createNode([new WebSockets()], '/ip4/127.0.0.1/tcp/20000/ws')
]) ])
printAddrs(node1, '1') printAddrs(node1, '1')
@ -60,28 +58,28 @@ function print ({ stream }) {
node2.handle('/print', print) node2.handle('/print', print)
node3.handle('/print', print) node3.handle('/print', print)
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
await node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs) await node2.peerStore.addressBook.set(node3.peerId, node3.getMultiaddrs())
await node3.peerStore.addressBook.set(node1.peerId, node1.multiaddrs) await node3.peerStore.addressBook.set(node1.peerId, node1.getMultiaddrs())
// node 1 (TCP) dials to node 2 (TCP+WebSockets) // node 1 (TCP) dials to node 2 (TCP+WebSockets)
const { stream } = await node1.dialProtocol(node2.peerId, '/print') const { stream } = await node1.dialProtocol(node2.peerId, '/print')
await pipe( await pipe(
['node 1 dialed to node 2 successfully'], [uint8ArrayFromString('node 1 dialed to node 2 successfully')],
stream stream
) )
// node 2 (TCP+WebSockets) dials to node 2 (WebSockets) // node 2 (TCP+WebSockets) dials to node 2 (WebSockets)
const { stream: stream2 } = await node2.dialProtocol(node3.peerId, '/print') const { stream: stream2 } = await node2.dialProtocol(node3.peerId, '/print')
await pipe( await pipe(
['node 2 dialed to node 3 successfully'], [uint8ArrayFromString('node 2 dialed to node 3 successfully')],
stream2 stream2
) )
// node 3 (listening WebSockets) can dial node 1 (TCP) // node 3 (listening WebSockets) can dial node 1 (TCP)
try { try {
await node3.dialProtocol(node1.peerId, '/print') await node3.dialProtocol(node1.peerId, '/print')
} catch (/** @type {any} */ err) { } catch (err) {
console.log('node 3 failed to dial to node 1 with:', err.message) console.log('node 3 failed to dial to node 1 with:', err.message)
} }
})(); })();

View File

@ -1,17 +1,15 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../..') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const WebSockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
import fs from 'fs'
const fs = require('fs'); import https from 'https'
const https = require('https'); import { pipe } from 'it-pipe'
const pipe = require('it-pipe') import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
const transportKey = WebSockets.prototype[Symbol.toStringTag];
const httpServer = https.createServer({ const httpServer = https.createServer({
cert: fs.readFileSync('./test_certs/cert.pem'), cert: fs.readFileSync('./test_certs/cert.pem'),
@ -23,26 +21,25 @@ const createNode = async (addresses = []) => {
addresses = [addresses] addresses = [addresses]
} }
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: addresses listen: addresses
}, },
modules: { transports: [
transport: [WebSockets], new TCP(),
connEncryption: [NOISE], new WebSockets({
streamMuxer: [MPLEX] server: httpServer,
}, websocket: {
config: { rejectUnauthorized: false
peerDiscovery: { }
// Disable autoDial as it would fail because we are using a self-signed cert. })
// `dialProtocol` does not fail because we pass `rejectUnauthorized: false`. ],
autoDial: false connectionEncryption: [new Noise()],
}, streamMuxers: [new Mplex()],
transport: { connectionManager: {
[transportKey]: { // Disable autoDial as it would fail because we are using a self-signed cert.
listenerOptions: { server: httpServer }, // `dialProtocol` does not fail because we pass `rejectUnauthorized: false`.
}, autoDial: false
},
} }
}) })
@ -52,7 +49,7 @@ const createNode = async (addresses = []) => {
function printAddrs(node, number) { function printAddrs(node, number) {
console.log('node %s is listening on:', number) console.log('node %s is listening on:', number)
node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`)) node.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
} }
function print ({ stream }) { function print ({ stream }) {
@ -60,7 +57,7 @@ function print ({ stream }) {
stream, stream,
async function (source) { async function (source) {
for await (const msg of source) { for await (const msg of source) {
console.log(msg.toString()) console.log(uint8ArrayToString(msg))
} }
} }
) )
@ -78,12 +75,12 @@ function print ({ stream }) {
node1.handle('/print', print) node1.handle('/print', print)
node2.handle('/print', print) node2.handle('/print', print)
const targetAddr = `${node1.multiaddrs[0]}/p2p/${node1.peerId.toB58String()}`; const targetAddr = node1.getMultiaddrs()[0];
// node 2 (Secure WebSockets) dials to node 1 (Secure Websockets) // node 2 (Secure WebSockets) dials to node 1 (Secure Websockets)
const { stream } = await node2.dialProtocol(targetAddr, '/print', { websocket: { rejectUnauthorized: false } }) const { stream } = await node2.dialProtocol(targetAddr, '/print')
await pipe( await pipe(
['node 2 dialed to node 1 successfully'], [uint8ArrayFromString('node 2 dialed to node 1 successfully')],
stream stream
) )
})(); })();

View File

@ -21,23 +21,23 @@ Then, in your favorite text editor create a file with the `.js` extension. I've
First thing is to create our own libp2p node! Insert: First thing is to create our own libp2p node! Insert:
```JavaScript ```JavaScript
'use strict' import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'
const Libp2p = require('libp2p') import { Noise } from '@chainsafe/libp2p-noise'
const TCP = require('libp2p-tcp')
const { NOISE } = require('@chainsafe/libp2p-noise')
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
// To signal the addresses we want to be available, we use // To signal the addresses we want to be available, we use
// the multiaddr format, a self describable address // the multiaddr format, a self describable address
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [
transport: [ TCP ], new TCP()
connEncryption: [ NOISE ] ],
} connectionEncryption: [
new Noise()
]
}) })
await node.start() await node.start()
@ -80,31 +80,29 @@ Now that we have our `createNode` function, let's create two nodes and make them
For this step, we will need some more dependencies. For this step, we will need some more dependencies.
```bash ```bash
> npm install it-pipe it-concat libp2p-mplex > npm install it-pipe it-to-buffer @libp2p/mplex
``` ```
And we also need to import the modules on our .js file: And we also need to import the modules on our .js file:
```js ```js
const pipe = require('it-pipe') import { pipe } from 'it-pipe'
const concat = require('it-concat') import toBuffer from 'it-to-buffer'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
``` ```
We are going to reuse the `createNode` function from step 1, but this time add a stream multiplexer from `libp2p-mplex`. We are going to reuse the `createNode` function from step 1, but this time add a stream multiplexer from `libp2p-mplex`.
```js ```js
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
// To signal the addresses we want to be available, we use // To signal the addresses we want to be available, we use
// the multiaddr format, a self describable address // the multiaddr format, a self describable address
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()] // <--- Add this line
streamMuxer: [MPLEX] // <--- Add this line
}
}) })
await node.start() await node.start()
@ -135,7 +133,7 @@ Then add,
node2.handle('/print', async ({ stream }) => { node2.handle('/print', async ({ stream }) => {
const result = await pipe( const result = await pipe(
stream, stream,
concat toBuffer
) )
console.log(result.toString()) console.log(result.toString())
}) })
@ -186,15 +184,13 @@ const createNode = async (transports, addresses = []) => {
addresses = [addresses] addresses = [addresses]
} }
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: addresses listen: addresses
}, },
modules: { transport: transports,
transport: transports, connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()]
streamMuxer: [MPLEX]
}
}) })
await node.start() await node.start()
@ -207,8 +203,8 @@ As a rule, a libp2p node will only be capable of using a transport if: a) it has
Let's update our flow to create nodes and see how they behave when dialing to each other: Let's update our flow to create nodes and see how they behave when dialing to each other:
```JavaScript ```JavaScript
const WebSockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const [node1, node2, node3] = await Promise.all([ const [node1, node2, node3] = await Promise.all([
createNode([TCP], '/ip4/0.0.0.0/tcp/0'), createNode([TCP], '/ip4/0.0.0.0/tcp/0'),

View File

@ -1,14 +1,13 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { waitForOutput } = require('../utils')
async function test () { export async function test () {
process.stdout.write('1.js\n') process.stdout.write('1.js\n')
await waitForOutput('/p2p/', 'node', [path.join(__dirname, '1.js')], { await waitForOutput('/p2p/', 'node', [path.join(__dirname, '1.js')], {
cwd: __dirname cwd: __dirname
}) })
} }
module.exports = test

View File

@ -1,14 +1,13 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { waitForOutput } = require('../utils')
async function test () { export async function test () {
process.stdout.write('2.js\n') process.stdout.write('2.js\n')
await waitForOutput('Hello p2p world!', 'node', [path.join(__dirname, '2.js')], { await waitForOutput('Hello p2p world!', 'node', [path.join(__dirname, '2.js')], {
cwd: __dirname cwd: __dirname
}) })
} }
module.exports = test

View File

@ -1,14 +1,13 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { waitForOutput } = require('../utils')
async function test () { export async function test () {
process.stdout.write('3.js\n') process.stdout.write('3.js\n')
await waitForOutput('node 3 failed to dial to node 1 with:', 'node', [path.join(__dirname, '3.js')], { await waitForOutput('node 3 failed to dial to node 1 with:', 'node', [path.join(__dirname, '3.js')], {
cwd: __dirname cwd: __dirname
}) })
} }
module.exports = test

View File

@ -1,14 +1,13 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { waitForOutput } = require('../utils')
async function test () { export async function test () {
process.stdout.write('4.js\n') process.stdout.write('4.js\n')
await waitForOutput('node 2 dialed to node 1 successfully', 'node', [path.join(__dirname, '4.js')], { await waitForOutput('node 2 dialed to node 1 successfully', 'node', [path.join(__dirname, '4.js')], {
cwd: __dirname cwd: __dirname
}) })
} }
module.exports = test

View File

@ -1,15 +1,11 @@
'use strict' import { test as test1 } from './test-1.js'
import { test as test2 } from './test-2.js'
import { test as test3 } from './test-3.js'
import { test as test4 } from './test-4.js'
const test1 = require('./test-1') export async function test() {
const test2 = require('./test-2')
const test3 = require('./test-3')
const test4 = require('./test-4')
async function test() {
await test1() await test1()
await test2() await test2()
await test3() await test3()
await test4() await test4()
} }
module.exports = test

View File

@ -1,15 +1,13 @@
'use strict' import execa from 'execa'
import fs from 'fs-extra'
const execa = require('execa') import which from 'which'
const fs = require('fs-extra')
const which = require('which')
async function isExecutable (command) { async function isExecutable (command) {
try { try {
await fs.access(command, fs.constants.X_OK) await fs.access(command, fs.constants.X_OK)
return true return true
} catch (/** @type {any} */ err) { } catch (err) {
if (err.code === 'ENOENT') { if (err.code === 'ENOENT') {
return isExecutable(await which(command)) return isExecutable(await which(command))
} }
@ -22,7 +20,7 @@ async function isExecutable (command) {
} }
} }
async function waitForOutput (expectedOutput, command, args = [], opts = {}) { export async function waitForOutput (expectedOutput, command, args = [], opts = {}) {
if (!await isExecutable(command)) { if (!await isExecutable(command)) {
args.unshift(command) args.unshift(command)
command = 'node' command = 'node'
@ -49,13 +47,9 @@ async function waitForOutput (expectedOutput, command, args = [], opts = {}) {
try { try {
await proc await proc
} catch (/** @type {any} */ err) { } catch (err) {
if (!err.killed) { if (!err.killed) {
throw err throw err
} }
} }
} }
module.exports = {
waitForOutput
}

View File

@ -9,7 +9,7 @@ When in the root folder of this example, type `node listener.js` in terminal. Yo
incoming connections. Below is just an example of such address. In your case the suffix hash (`peerId`) will be different. incoming connections. Below is just an example of such address. In your case the suffix hash (`peerId`) will be different.
```bash ```bash
$ node listener.js $ node listener.js
Listening on: Listening on:
/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct/p2p/QmUKQCzEUhhhobcNSrXU5uzxTqbvF1BjMCGNGZzZU14Kgd /ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct/p2p/QmUKQCzEUhhhobcNSrXU5uzxTqbvF1BjMCGNGZzZU14Kgd
``` ```
@ -18,16 +18,15 @@ Listening on:
Confirm that the above address is the same as the field `list` in `public/dialer.js`: Confirm that the above address is the same as the field `list` in `public/dialer.js`:
```js ```js
peerDiscovery: { peerDiscovery: {
[Bootstrap.tag]: { new Bootstrap({
enabled: true,
// paste the address into `list` // paste the address into `list`
list: ['/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct/p2p/QmUKQCzEUhhhobcNSrXU5uzxTqbvF1BjMCGNGZzZU14Kgd'] list: ['/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct/p2p/QmUKQCzEUhhhobcNSrXU5uzxTqbvF1BjMCGNGZzZU14Kgd']
} })
} }
``` ```
## 2. Run a browser libp2p dialer ## 2. Run a browser libp2p dialer
When in the root folder of this example, type `npm run dev` in terminal. You should see an address where you can browse When in the root folder of this example, type `npm start` in terminal. You should see an address where you can browse
the running client. Open this address in your browser. In console the running client. Open this address in your browser. In console
logs you should see logs about successful connection with the node client. In the output of node client you should see logs you should see logs about successful connection with the node client. In the output of node client you should see
a log message about successful connection as well. a log message about successful connection as well.

View File

@ -1,28 +1,21 @@
import 'babel-polyfill' import { createLibp2p } from 'libp2p'
const Libp2p = require('libp2p') import { WebRTCDirect } from '@achingbrain/webrtc-direct'
const WebRTCDirect = require('libp2p-webrtc-direct') import { Mplex } from '@libp2p/mplex'
const Mplex = require('libp2p-mplex') import { Noise } from '@chainsafe/libp2p-noise'
const { NOISE } = require('@chainsafe/libp2p-noise') import { Bootstrap } from '@libp2p/bootstrap'
const Bootstrap = require('libp2p-bootstrap')
document.addEventListener('DOMContentLoaded', async () => { document.addEventListener('DOMContentLoaded', async () => {
// use the same peer id as in `listener.js` to avoid copy-pasting of listener's peer id into `peerDiscovery` // use the same peer id as in `listener.js` to avoid copy-pasting of listener's peer id into `peerDiscovery`
const hardcodedPeerId = '12D3KooWCuo3MdXfMgaqpLC5Houi1TRoFqgK9aoxok4NK5udMu8m' const hardcodedPeerId = '12D3KooWCuo3MdXfMgaqpLC5Houi1TRoFqgK9aoxok4NK5udMu8m'
const libp2p = await Libp2p.create({ const libp2p = await createLibp2p({
modules: { transports: [new WebRTCDirect()],
transport: [WebRTCDirect], streamMuxers: [new Mplex()],
streamMuxer: [Mplex], connectionEncryption: [new Noise()],
connEncryption: [NOISE], peerDiscovery: [
peerDiscovery: [Bootstrap] new Bootstrap({
}, list: [`/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct/p2p/${hardcodedPeerId}`]
config: { })
peerDiscovery: { ]
[Bootstrap.tag]: {
enabled: true,
list: [`/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct/p2p/${hardcodedPeerId}`]
}
}
}
}) })
const status = document.getElementById('status') const status = document.getElementById('status')
@ -36,22 +29,21 @@ document.addEventListener('DOMContentLoaded', async () => {
} }
// Listen for new peers // Listen for new peers
libp2p.on('peer:discovery', (peerId) => { libp2p.addEventListener('peer:discovery', (evt) => {
log(`Found peer ${peerId.toB58String()}`) log(`Found peer ${evt.detail.id.toString()}`)
}) })
// Listen for new connections to peers // Listen for new connections to peers
libp2p.connectionManager.on('peer:connect', (connection) => { libp2p.connectionManager.addEventListener('peer:connect', (evt) => {
log(`Connected to ${connection.remotePeer.toB58String()}`) log(`Connected to ${evt.detail.remotePeer.toString()}`)
}) })
// Listen for peers disconnecting // Listen for peers disconnecting
libp2p.connectionManager.on('peer:disconnect', (connection) => { libp2p.connectionManager.addEventListener('peer:disconnect', (evt) => {
log(`Disconnected from ${connection.remotePeer.toB58String()}`) log(`Disconnected from ${evt.detail.remotePeer.toString()}`)
}) })
await libp2p.start() await libp2p.start()
status.innerText = 'libp2p started!' status.innerText = 'libp2p started!'
log(`libp2p id is ${libp2p.peerId.toB58String()}`) log(`libp2p id is ${libp2p.peerId.toString()}`)
}) })

View File

@ -1,43 +1,34 @@
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Bootstrap = require('libp2p-bootstrap') import { WebRTCDirect } from '@achingbrain/webrtc-direct'
const WebRTCDirect = require('libp2p-webrtc-direct') import { Mplex } from '@libp2p/mplex'
const Mplex = require('libp2p-mplex') import { Noise } from '@chainsafe/libp2p-noise'
const { NOISE } = require('@chainsafe/libp2p-noise') import { createFromJSON } from '@libp2p/peer-id-factory'
const PeerId = require('peer-id') import wrtc from 'wrtc'
;(async () => { ;(async () => {
// hardcoded peer id to avoid copy-pasting of listener's peer id into the dialer's bootstrap list // hardcoded peer id to avoid copy-pasting of listener's peer id into the dialer's bootstrap list
// generated with cmd `peer-id --type=ed25519` // generated with cmd `peer-id --type=ed25519`
const hardcodedPeerId = await PeerId.createFromJSON({ const hardcodedPeerId = await createFromJSON({
"id": "12D3KooWCuo3MdXfMgaqpLC5Houi1TRoFqgK9aoxok4NK5udMu8m", "id": "12D3KooWCuo3MdXfMgaqpLC5Houi1TRoFqgK9aoxok4NK5udMu8m",
"privKey": "CAESQAG6Ld7ev6nnD0FKPs033/j0eQpjWilhxnzJ2CCTqT0+LfcWoI2Vr+zdc1vwk7XAVdyoCa2nwUR3RJebPWsF1/I=", "privKey": "CAESQAG6Ld7ev6nnD0FKPs033/j0eQpjWilhxnzJ2CCTqT0+LfcWoI2Vr+zdc1vwk7XAVdyoCa2nwUR3RJebPWsF1/I=",
"pubKey": "CAESIC33FqCNla/s3XNb8JO1wFXcqAmtp8FEd0SXmz1rBdfy" "pubKey": "CAESIC33FqCNla/s3XNb8JO1wFXcqAmtp8FEd0SXmz1rBdfy"
}) })
const node = await Libp2p.create({ const node = await createLibp2p({
peerId: hardcodedPeerId, peerId: hardcodedPeerId,
addresses: { addresses: {
listen: ['/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct'] listen: ['/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct']
}, },
modules: { transports: [new WebRTCDirect({ wrtc })],
transport: [WebRTCDirect], streamMuxers: [new Mplex()],
streamMuxer: [Mplex], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
},
config: {
peerDiscovery: {
[Bootstrap.tag]: {
enabled: false,
}
}
}
}) })
node.connectionManager.on('peer:connect', (connection) => { node.connectionManager.addEventListener('peer:connect', (evt) => {
console.info(`Connected to ${connection.remotePeer.toB58String()}!`) console.info(`Connected to ${evt.detail.remotePeer.toString()}!`)
}) })
await node.start() await node.start()
console.log('Listening on:') console.log('Listening on:')
node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`)) node.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
})() })()

View File

@ -2,32 +2,25 @@
"name": "webrtc-direct", "name": "webrtc-direct",
"version": "0.0.1", "version": "0.0.1",
"private": true, "private": true,
"description": "", "type": "module",
"browserslist": [
"last 2 Chrome versions"
],
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1", "test": "echo \"Error: no test specified\" && exit 1",
"build": "parcel build index.html", "start": "vite"
"start": "parcel index.html"
}, },
"license": "ISC", "license": "ISC",
"devDependencies": {
"@babel/cli": "^7.13.10",
"@babel/core": "^7.13.10",
"@mapbox/node-pre-gyp": "^1.0.8",
"babel-plugin-syntax-async-functions": "^6.13.0",
"babel-plugin-transform-regenerator": "^6.26.0",
"babel-polyfill": "^6.26.0",
"parcel": "^2.0.1",
"util": "^0.12.3"
},
"dependencies": { "dependencies": {
"@chainsafe/libp2p-noise": "^5.0.2", "@achingbrain/webrtc-direct": "^0.7.2",
"@chainsafe/libp2p-noise": "^6.0.1",
"@libp2p/bootstrap": "^1.0.1",
"@libp2p/mplex": "^1.0.2",
"libp2p": "../../", "libp2p": "../../",
"libp2p-bootstrap": "^0.14.0", "wrtc": "^0.4.7"
"libp2p-mplex": "^0.10.4",
"libp2p-webrtc-direct": "^0.7.0",
"peer-id": "^0.16.0"
}, },
"browser": { "devDependencies": {
"ipfs": "ipfs/dist/index.min.js" "@mapbox/node-pre-gyp": "^1.0.8",
"vite": "^2.8.6"
} }
} }

View File

@ -1,10 +1,11 @@
'use strict' import path from 'path'
import execa from 'execa'
import pDefer from 'p-defer'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { chromium } from 'playwright'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const execa = require('execa')
const pDefer = require('p-defer')
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
const { chromium } = require('playwright');
function startNode (name, args = []) { function startNode (name, args = []) {
return execa('node', [path.join(__dirname, name), ...args], { return execa('node', [path.join(__dirname, name), ...args], {
@ -13,8 +14,8 @@ function startNode (name, args = []) {
}) })
} }
function startBrowser (name, args = []) { function startBrowser () {
return execa('parcel', [path.join(__dirname, name), ...args], { return execa('vite', [], {
preferLocal: true, preferLocal: true,
localDir: __dirname, localDir: __dirname,
cwd: __dirname, cwd: __dirname,
@ -22,7 +23,7 @@ function startBrowser (name, args = []) {
}) })
} }
async function test () { export async function test () {
// Step 1, listener process // Step 1, listener process
const listenerProcReady = pDefer() const listenerProcReady = pDefer()
let listenerOutput = '' let listenerOutput = ''
@ -42,20 +43,14 @@ async function test () {
// Step 2, dialer process // Step 2, dialer process
process.stdout.write('dialer.js\n') process.stdout.write('dialer.js\n')
let dialerUrl = '' let dialerUrl = 'http://localhost:3000'
const dialerProc = startBrowser('index.html') const dialerProc = startBrowser()
dialerProc.all.on('data', async (chunk) => { dialerProc.all.on('data', async (chunk) => {
/**@type {string} */ /**@type {string} */
const out = chunk.toString() const out = chunk.toString()
if (out.includes('Server running at')) { if (out.includes('ready in')) {
dialerUrl = out.split('Server running at ')[1]
}
if (out.includes('Built in ')) {
try { try {
const browser = await chromium.launch(); const browser = await chromium.launch();
const page = await browser.newPage(); const page = await browser.newPage();
@ -71,25 +66,14 @@ async function test () {
'#output', '#output',
{ timeout: 10000 } { timeout: 10000 }
) )
await browser.close(); await browser.close()
} catch (/** @type {any} */ err) { } catch (err) {
console.error(err) console.error(err)
process.exit(1) process.exit(1)
} finally { } finally {
dialerProc.cancel() dialerProc.cancel()
listenerProc.kill() listenerProc.cancel()
} }
} }
}) })
await Promise.all([
listenerProc,
dialerProc,
]).catch((err) => {
if (err.signal !== 'SIGTERM') {
throw err
}
})
} }
module.exports = test

View File

@ -2,126 +2,146 @@
"name": "libp2p", "name": "libp2p",
"version": "0.36.2", "version": "0.36.2",
"description": "JavaScript implementation of libp2p, a modular peer to peer network stack", "description": "JavaScript implementation of libp2p, a modular peer to peer network stack",
"leadMaintainer": "Jacob Heun <jacobheun@gmail.com>", "license": "Apache-2.0 OR MIT",
"main": "src/index.js", "homepage": "https://github.com/libp2p/js-libp2p#readme",
"types": "dist/src/index.d.ts", "repository": {
"type": "git",
"url": "git+https://github.com/libp2p/js-libp2p.git"
},
"bugs": {
"url": "https://github.com/libp2p/js-libp2p/issues"
},
"keywords": [
"IPFS",
"libp2p",
"network",
"p2p",
"peer",
"peer-to-peer"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=7.0.0"
},
"type": "module",
"types": "./dist/src/index.d.ts",
"typesVersions": { "typesVersions": {
"*": { "*": {
"*": [
"*",
"dist/*",
"dist/src/*",
"dist/src/*/index"
],
"src/*": [ "src/*": [
"*",
"dist/*",
"dist/src/*", "dist/src/*",
"dist/src/*/index" "dist/src/*/index"
] ]
} }
}, },
"files": [ "files": [
"dist", "src",
"src" "dist/src",
"!dist/test",
"!**/*.tsbuildinfo"
], ],
"scripts": { "exports": {
"lint": "aegir lint", ".": {
"build": "aegir build", "import": "./dist/src/index.js"
"build:proto": "npm run build:proto:circuit && npm run build:proto:fetch && npm run build:proto:identify && npm run build:proto:plaintext && npm run build:proto:address-book && npm run build:proto:proto-book && npm run build:proto:peer && npm run build:proto:peer-record && npm run build:proto:envelope", },
"build:proto:circuit": "pbjs -t static-module -w commonjs -r libp2p-circuit --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/circuit/protocol/index.js ./src/circuit/protocol/index.proto", "./insecure": {
"build:proto:fetch": "pbjs -t static-module -w commonjs -r libp2p-fetch --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/fetch/proto.js ./src/fetch/proto.proto", "import": "./dist/src/insecure/index.js"
"build:proto:identify": "pbjs -t static-module -w commonjs -r libp2p-identify --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/identify/message.js ./src/identify/message.proto", },
"build:proto:plaintext": "pbjs -t static-module -w commonjs -r libp2p-plaintext --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/insecure/proto.js ./src/insecure/proto.proto", "./pnet": {
"build:proto:peer": "pbjs -t static-module -w commonjs -r libp2p-peer --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/peer-store/pb/peer.js ./src/peer-store/pb/peer.proto", "import": "./dist/src/pnet/index.js"
"build:proto:peer-record": "pbjs -t static-module -w commonjs -r libp2p-peer-record --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/record/peer-record/peer-record.js ./src/record/peer-record/peer-record.proto", },
"build:proto:envelope": "pbjs -t static-module -w commonjs -r libp2p-envelope --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/record/envelope/envelope.js ./src/record/envelope/envelope.proto", "./pnet/generate": {
"build:proto-types": "npm run build:proto-types:circuit && npm run build:proto-types:fetch && npm run build:proto-types:identify && npm run build:proto-types:plaintext && npm run build:proto-types:address-book && npm run build:proto-types:proto-book && npm run build:proto-types:peer && npm run build:proto-types:peer-record && npm run build:proto-types:envelope", "import": "./dist/src/pnet/key-generator.js"
"build:proto-types:circuit": "pbts -o src/circuit/protocol/index.d.ts src/circuit/protocol/index.js", }
"build:proto-types:fetch": "pbts -o src/fetch/proto.d.ts src/fetch/proto.js",
"build:proto-types:identify": "pbts -o src/identify/message.d.ts src/identify/message.js",
"build:proto-types:plaintext": "pbts -o src/insecure/proto.d.ts src/insecure/proto.js",
"build:proto-types:peer": "pbts -o src/peer-store/pb/peer.d.ts src/peer-store/pb/peer.js",
"build:proto-types:peer-record": "pbts -o src/record/peer-record/peer-record.d.ts src/record/peer-record/peer-record.js",
"build:proto-types:envelope": "pbts -o src/record/envelope/envelope.d.ts src/record/envelope/envelope.js",
"test": "aegir test",
"test:ts": "aegir build --no-bundle && npm run test --prefix test/ts-use",
"test:node": "aegir test -t node -f \"./test/**/*.{node,spec}.js\"",
"test:browser": "aegir test -t browser",
"test:examples": "cd examples && npm run test:all",
"test:interop": "LIBP2P_JS=$PWD npx aegir test -t node -f ./node_modules/libp2p-interop/test/*",
"prepare": "npm run build",
"coverage": "nyc --reporter=text --reporter=lcov npm run test:node"
},
"repository": {
"type": "git",
"url": "https://github.com/libp2p/js-libp2p.git"
},
"keywords": [
"libp2p",
"network",
"p2p",
"peer",
"peer-to-peer",
"IPFS"
],
"bugs": {
"url": "https://github.com/libp2p/js-libp2p/issues"
},
"homepage": "https://libp2p.io",
"license": "MIT",
"engines": {
"node": ">=15.0.0"
},
"browser": {
"nat-api": false
}, },
"eslintConfig": { "eslintConfig": {
"extends": "ipfs", "extends": "ipfs",
"parserOptions": {
"sourceType": "module"
},
"ignorePatterns": [ "ignorePatterns": [
"!.aegir.js", "!.aegir.js",
"test/ts-use", "test/ts-use",
"*.d.ts" "*.d.ts"
] ]
}, },
"scripts": {
"lint": "aegir lint",
"build": "tsc",
"postbuild": "mkdirp dist/src/circuit/pb dist/src/fetch/pb dist/src/identify/pb dist/src/insecure/pb && cp src/circuit/pb/*.js src/circuit/pb/*.d.ts dist/src/circuit/pb && cp src/fetch/pb/*.js src/fetch/pb/*.d.ts dist/src/fetch/pb && cp src/identify/pb/*.js src/identify/pb/*.d.ts dist/src/identify/pb && cp src/insecure/pb/*.js src/insecure/pb/*.d.ts dist/src/insecure/pb",
"generate": "run-s generate:proto:* generate:proto-types:*",
"generate:proto:circuit": "pbjs -t static-module -w es6 -r libp2p-circuit --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/circuit/protocol/index.js ./src/circuit/protocol/index.proto",
"generate:proto:fetch": "pbjs -t static-module -w es6 -r libp2p-fetch --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/fetch/proto.js ./src/fetch/proto.proto",
"generate:proto:identify": "pbjs -t static-module -w es6 -r libp2p-identify --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/identify/message.js ./src/identify/message.proto",
"generate:proto:plaintext": "pbjs -t static-module -w es6 -r libp2p-plaintext --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/insecure/proto.js ./src/insecure/proto.proto",
"generate:proto-types:circuit": "pbts -o src/circuit/protocol/index.d.ts src/circuit/protocol/index.js",
"generate:proto-types:fetch": "pbts -o src/fetch/proto.d.ts src/fetch/proto.js",
"generate:proto-types:identify": "pbts -o src/identify/message.d.ts src/identify/message.js",
"generate:proto-types:plaintext": "pbts -o src/insecure/proto.d.ts src/insecure/proto.js",
"pretest": "npm run build",
"test": "aegir test",
"test:node": "npm run test -- -t node -f \"./dist/test/**/*.{node,spec}.js\" --cov",
"test:chrome": "npm run test -- -t browser -f \"./dist/test/**/*.spec.js\" --cov",
"test:chrome-webworker": "npm run test -- -t webworker -f \"./dist/test/**/*.spec.js\"",
"test:firefox": "npm run test -- -t browser -f \"./dist/test/**/*.spec.js\" -- --browser firefox",
"test:firefox-webworker": "npm run test -- -t webworker -f \"./dist/test/**/*.spec.js\" -- --browser firefox",
"test:examples": "cd examples && npm run test:all",
"test:interop": "npm run test -- -t node -f dist/test/interop.js"
},
"dependencies": { "dependencies": {
"@vascosantos/moving-average": "^1.1.0", "@achingbrain/nat-port-mapper": "^1.0.0",
"abortable-iterator": "^3.0.0", "@libp2p/connection": "^1.1.4",
"aggregate-error": "^3.1.0", "@libp2p/crypto": "^0.22.9",
"@libp2p/interfaces": "^1.3.17",
"@libp2p/multistream-select": "^1.0.3",
"@libp2p/peer-id": "^1.1.8",
"@libp2p/peer-id-factory": "^1.0.8",
"@libp2p/peer-store": "^1.0.6",
"@libp2p/utils": "^1.0.9",
"@multiformats/mafmt": "^11.0.2",
"@multiformats/multiaddr": "^10.1.8",
"abortable-iterator": "^4.0.2",
"aggregate-error": "^4.0.0",
"any-signal": "^3.0.0", "any-signal": "^3.0.0",
"bignumber.js": "^9.0.1", "bignumber.js": "^9.0.1",
"class-is": "^1.1.0", "class-is": "^1.1.0",
"datastore-core": "^7.0.0", "datastore-core": "^7.0.0",
"debug": "^4.3.1", "debug": "^4.3.3",
"err-code": "^3.0.0", "err-code": "^3.0.1",
"es6-promisify": "^7.0.0",
"events": "^3.3.0", "events": "^3.3.0",
"hashlru": "^2.3.0", "hashlru": "^2.3.0",
"interface-datastore": "^6.0.2", "interface-datastore": "^6.1.0",
"it-all": "^1.0.4", "it-all": "^1.0.6",
"it-buffer": "^0.1.2", "it-drain": "^1.0.5",
"it-drain": "^1.0.3", "it-filter": "^1.0.3",
"it-filter": "^1.0.1", "it-first": "^1.0.6",
"it-first": "^1.0.4",
"it-foreach": "^0.1.1", "it-foreach": "^0.1.1",
"it-handshake": "^2.0.0", "it-handshake": "^3.0.1",
"it-length-prefixed": "^5.0.2", "it-length-prefixed": "^7.0.1",
"it-map": "^1.0.4", "it-map": "^1.0.6",
"it-merge": "^1.0.0", "it-merge": "^1.0.3",
"it-pipe": "^1.1.0", "it-pipe": "^2.0.3",
"it-sort": "^1.0.1", "it-sort": "^1.0.1",
"it-take": "^1.0.0", "it-stream-types": "^1.0.4",
"libp2p-crypto": "^0.21.2", "it-take": "^1.0.2",
"libp2p-interfaces": "^4.0.0", "it-to-buffer": "^2.0.2",
"libp2p-utils": "^0.4.0",
"mafmt": "^10.0.0",
"merge-options": "^3.0.4", "merge-options": "^3.0.4",
"mortice": "^2.0.1", "mortice": "^3.0.0",
"multiaddr": "^10.0.0", "multiformats": "^9.6.3",
"multiformats": "^9.0.0",
"multistream-select": "^3.0.0",
"mutable-proxy": "^1.0.0", "mutable-proxy": "^1.0.0",
"nat-api": "^0.3.1",
"node-forge": "^1.2.1", "node-forge": "^1.2.1",
"p-any": "^3.0.0",
"p-fifo": "^1.0.0", "p-fifo": "^1.0.0",
"p-retry": "^4.4.0", "p-retry": "^5.0.0",
"p-settle": "^4.1.1", "p-settle": "^5.0.0",
"peer-id": "^0.16.0", "private-ip": "^2.3.3",
"private-ip": "^2.1.0", "protobufjs": "^6.11.2",
"protobufjs": "^6.10.2",
"retimer": "^3.0.0", "retimer": "^3.0.0",
"sanitize-filename": "^1.6.3", "sanitize-filename": "^1.6.3",
"set-delayed-interval": "^1.0.0", "set-delayed-interval": "^1.0.0",
@ -133,121 +153,49 @@
"xsalsa20": "^1.1.0" "xsalsa20": "^1.1.0"
}, },
"devDependencies": { "devDependencies": {
"@chainsafe/libp2p-noise": "^5.0.0", "@achingbrain/libp2p-gossipsub": "^0.13.5",
"@chainsafe/libp2p-noise": "^6.0.1",
"@libp2p/bootstrap": "^1.0.2",
"@libp2p/daemon-client": "^0.0.2",
"@libp2p/daemon-server": "^0.0.2",
"@libp2p/delegated-content-routing": "^1.0.2",
"@libp2p/delegated-peer-routing": "^1.0.2",
"@libp2p/floodsub": "^1.0.2",
"@libp2p/interface-compliance-tests": "^1.1.20",
"@libp2p/interop": "^0.0.3",
"@libp2p/kad-dht": "^1.0.3",
"@libp2p/mdns": "^1.0.3",
"@libp2p/mplex": "^1.0.1",
"@libp2p/tcp": "^1.0.6",
"@libp2p/tracked-map": "^1.0.4",
"@libp2p/webrtc-star": "^1.0.3",
"@libp2p/websockets": "^1.0.3",
"@nodeutils/defaults-deep": "^1.1.0", "@nodeutils/defaults-deep": "^1.1.0",
"@types/es6-promisify": "^6.0.0", "@types/node": "^16.11.26",
"@types/node": "^16.0.1",
"@types/node-forge": "^1.0.0", "@types/node-forge": "^1.0.0",
"@types/p-fifo": "^1.0.0",
"@types/varint": "^6.0.0", "@types/varint": "^6.0.0",
"aegir": "^36.0.0", "@types/xsalsa20": "^1.1.0",
"aegir": "^36.1.3",
"buffer": "^6.0.3", "buffer": "^6.0.3",
"cborg": "^1.8.1",
"delay": "^5.0.0", "delay": "^5.0.0",
"into-stream": "^6.0.0", "go-libp2p": "^0.0.6",
"ipfs-http-client": "^54.0.2", "into-stream": "^7.0.0",
"it-concat": "^2.0.0", "ipfs-http-client": "^56.0.1",
"it-pair": "^1.0.0", "it-pair": "^2.0.2",
"it-pushable": "^1.4.0", "it-pushable": "^2.0.1",
"libp2p": ".",
"libp2p-bootstrap": "^0.14.0",
"libp2p-delegated-content-routing": "^0.11.0",
"libp2p-delegated-peer-routing": "^0.11.1",
"libp2p-interfaces-compliance-tests": "^4.0.8",
"libp2p-interop": "^0.7.1",
"libp2p-kad-dht": "^0.28.6",
"libp2p-mdns": "^0.18.0",
"libp2p-mplex": "^0.10.4",
"libp2p-tcp": "^0.17.0",
"libp2p-webrtc-star": "^0.25.0",
"libp2p-websockets": "^0.16.0",
"nock": "^13.0.3", "nock": "^13.0.3",
"p-defer": "^3.0.0", "npm-run-all": "^4.1.5",
"p-times": "^3.0.0", "p-defer": "^4.0.0",
"p-wait-for": "^3.2.0", "p-event": "^5.0.1",
"p-times": "^4.0.0",
"p-wait-for": "^4.1.0",
"rimraf": "^3.0.2", "rimraf": "^3.0.2",
"sinon": "^12.0.1", "sinon": "^13.0.1",
"util": "^0.12.3" "ts-sinon": "^2.0.2"
}, },
"contributors": [ "browser": {
"Vasco Santos <vasco.santos@moxy.studio>", "nat-api": false
"David Dias <daviddias.p@gmail.com>", }
"Jacob Heun <jacobheun@gmail.com>",
"Alex Potsides <alex@achingbrain.net>",
"Alan Shaw <alan@tableflip.io>",
"Cayman <caymannava@gmail.com>",
"Pedro Teixeira <i@pgte.me>",
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
"Maciej Krüger <mkg20001@gmail.com>",
"Hugo Dias <mail@hugodias.me>",
"dirkmc <dirkmdev@gmail.com>",
"Volker Mische <volker.mische@gmail.com>",
"Chris Dostert <chrisdostert@users.noreply.github.com>",
"zeim839 <50573884+zeim839@users.noreply.github.com>",
"Robert Kiel <robert.kiel@hoprnet.org>",
"Richard Littauer <richard.littauer@gmail.com>",
"a1300 <matthias-knopp@gmx.net>",
"Ryan Bell <ryan@piing.net>",
"ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>",
"Andrew Nesbitt <andrewnez@gmail.com>",
"Franck Royer <franck@royer.one>",
"Thomas Eizinger <thomas@eizinger.io>",
"Vít Habada <vithabada93@gmail.com>",
"Giovanni T. Parra <fiatjaf@gmail.com>",
"acolytec3 <17355484+acolytec3@users.noreply.github.com>",
"Alan Smithee <ggnore.alan.smithee@gmail.com>",
"Elven <mon.samuel@qq.com>",
"Samlior <samlior@foxmail.com>",
"Didrik Nordström <didrik.nordstrom@gmail.com>",
"Aditya Bose <13054902+adbose@users.noreply.github.com>",
"TJKoury <TJKoury@gmail.com>",
"TheStarBoys <41286328+TheStarBoys@users.noreply.github.com>",
"Tiago Alves <alvesjtiago@gmail.com>",
"Tim Daubenschütz <tim@daubenschuetz.de>",
"XiaoZhang <zxinmyth@gmail.com>",
"Yusef Napora <yusef@napora.org>",
"Zane Starr <zcstarr@gmail.com>",
"ebinks <elizabethjbinks@gmail.com>",
"greenSnot <greenSnot@users.noreply.github.com>",
"isan_rivkin <isanrivkin@gmail.com>",
"mayerwin <mayerwin@users.noreply.github.com>",
"mcclure <andi.m.mcclure@gmail.com>",
"patrickwoodhead <91056047+patrickwoodhead@users.noreply.github.com>",
"phillmac <phillmac@users.noreply.github.com>",
"robertkiel <robert.kiel@validitylabs.org>",
"shresthagrawal <34920931+shresthagrawal@users.noreply.github.com>",
"swedneck <40505480+swedneck@users.noreply.github.com>",
"tuyennhv <vutuyen2636@gmail.com>",
"Sönke Hahn <soenkehahn@gmail.com>",
"Aleksei <vozhdb@gmail.com>",
"Bernd Strehl <bernd.strehl@gmail.com>",
"Chris Bratlien <chrisbratlien@gmail.com>",
"Cindy Wu <ciindy.wu@gmail.com>",
"Daijiro Wachi <daijiro.wachi@gmail.com>",
"Diogo Silva <fsdiogo@gmail.com>",
"Dmitriy Ryajov <dryajov@gmail.com>",
"Ethan Lam <elmemphis2000@gmail.com>",
"Fei Liu <liu.feiwood@gmail.com>",
"Felipe Martins <felipebrasil93@gmail.com>",
"Florian-Merle <florian.david.merle@gmail.com>",
"Francis Gulotta <wizard@roborooter.com>",
"Guy Sviry <32539816+guysv@users.noreply.github.com>",
"Henrique Dias <hacdias@gmail.com>",
"Irakli Gozalishvili <rfobic@gmail.com>",
"Joel Gustafson <joelg@mit.edu>",
"John Rees <johnrees@users.noreply.github.com>",
"João Santos <joaosantos15@users.noreply.github.com>",
"Julien Bouquillon <contact@revolunet.com>",
"Kevin Kwok <antimatter15@gmail.com>",
"Kevin Lacker <lacker@gmail.com>",
"Lars Gierth <lgierth@users.noreply.github.com>",
"Leask Wong <i@leaskh.com>",
"Marcin Tojek <mtojek@users.noreply.github.com>",
"Marston Connell <34043723+TheMarstonConnell@users.noreply.github.com>",
"Michael Burns <5170+mburns@users.noreply.github.com>",
"Miguel Mota <miguelmota2@gmail.com>",
"Nuno Nogueira <nunofmn@gmail.com>",
"Philipp Muens <raute1337@gmx.de>",
"RasmusErik Voel Jensen <github@solsort.com>",
"Smite Chow <xiaopengyou@live.com>",
"Soeren <nikorpoulsen@gmail.com>"
]
} }

View File

@ -1,2 +0,0 @@
// @ts-nocheck
export const { Buffer } = require('buffer')

Some files were not shown because too many files have changed in this diff Show More