mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-07-10 14:21:33 +00:00
Compare commits
1 Commits
v0.37.2
...
chore/use-
Author | SHA1 | Date | |
---|---|---|---|
7781075a7a |
115
.aegir.js
115
.aegir.js
@ -1,63 +1,70 @@
|
|||||||
import { WebSockets } from '@libp2p/websockets'
|
'use strict'
|
||||||
import { Mplex } from '@libp2p/mplex'
|
|
||||||
import { NOISE } from '@chainsafe/libp2p-noise'
|
const path = require('path')
|
||||||
import { pipe } from 'it-pipe'
|
const Libp2p = require('./src')
|
||||||
import { createFromJSON } from '@libp2p/peer-id-factory'
|
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} */
|
/** @type {import('aegir').PartialOptions} */
|
||||||
export default {
|
module.exports = {
|
||||||
build: {
|
build: {
|
||||||
bundlesizeMax: '147kB'
|
bundlesizeMax: '253kB'
|
||||||
},
|
},
|
||||||
test: {
|
test: {
|
||||||
before: async () => {
|
before,
|
||||||
// use dynamic import because we only want to reference these files during the test run, e.g. after building
|
after,
|
||||||
const { createLibp2p } = await import('./dist/src/index.js')
|
browser: {
|
||||||
const { MULTIADDRS_WEBSOCKETS } = await import('./dist/test/fixtures/browser.js')
|
config: {
|
||||||
const { Plaintext } = await import('./dist/src/insecure/index.js')
|
buildConfig: esbuild
|
||||||
const { default: Peers } = await import('./dist/test/fixtures/peers.js')
|
|
||||||
|
|
||||||
// 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()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
2
.github/dependabot.yml
vendored
2
.github/dependabot.yml
vendored
@ -4,5 +4,5 @@ updates:
|
|||||||
directory: "/"
|
directory: "/"
|
||||||
schedule:
|
schedule:
|
||||||
interval: daily
|
interval: daily
|
||||||
time: "10:00"
|
time: "11:00"
|
||||||
open-pull-requests-limit: 10
|
open-pull-requests-limit: 10
|
||||||
|
136
.github/workflows/examples.yml
vendored
136
.github/workflows/examples.yml
vendored
@ -8,59 +8,95 @@ on:
|
|||||||
- '**'
|
- '**'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
check:
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- uses: actions/setup-node@v2
|
- run: npm install
|
||||||
with:
|
- run: npx aegir lint
|
||||||
node-version: lts/*
|
- run: npx aegir ts -p check
|
||||||
- uses: ipfs/aegir/actions/cache-node-modules@master
|
- run: npx aegir build
|
||||||
with:
|
test-auto-relay-example:
|
||||||
directories: |
|
needs: check
|
||||||
./examples/node_modules
|
|
||||||
~/.cache
|
|
||||||
build: |
|
|
||||||
cd examples
|
|
||||||
npm i
|
|
||||||
npx playwright install
|
|
||||||
cache_name: cache-examples
|
|
||||||
|
|
||||||
test-example:
|
|
||||||
needs: build
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
example: [
|
|
||||||
chat,
|
|
||||||
connection-encryption,
|
|
||||||
discovery-mechanisms,
|
|
||||||
echo,
|
|
||||||
libp2p-in-the-browser,
|
|
||||||
peer-and-content-routing,
|
|
||||||
pnet,
|
|
||||||
protocol-and-stream-muxing,
|
|
||||||
pubsub,
|
|
||||||
transports,
|
|
||||||
webrtc-direct
|
|
||||||
]
|
|
||||||
fail-fast: true
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- uses: actions/setup-node@v2
|
- run: npm install
|
||||||
with:
|
- run: cd examples && npm install && npm run test -- auto-relay
|
||||||
node-version: lts/*
|
test-chat-example:
|
||||||
- uses: ipfs/aegir/actions/cache-node-modules@master
|
needs: check
|
||||||
with:
|
runs-on: ubuntu-latest
|
||||||
directories: |
|
steps:
|
||||||
./examples/node_modules
|
- uses: actions/checkout@v2
|
||||||
~/.cache
|
- run: npm install
|
||||||
build: |
|
- run: cd examples && npm install && npm run test -- chat
|
||||||
cd examples
|
test-connection-encryption-example:
|
||||||
npm i
|
needs: check
|
||||||
npx playwright install
|
runs-on: ubuntu-latest
|
||||||
cache_name: cache-examples
|
steps:
|
||||||
- run: |
|
- uses: actions/checkout@v2
|
||||||
cd examples
|
- run: npm install
|
||||||
npm run test -- ${{ matrix.example }}
|
- run: cd examples && npm install && npm run test -- connection-encryption
|
||||||
|
test-discovery-mechanisms-example:
|
||||||
|
needs: check
|
||||||
|
runs-on: macos-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- run: npm install
|
||||||
|
- run: cd examples && npm install && npm run test -- discovery-mechanisms
|
||||||
|
test-echo-example:
|
||||||
|
needs: check
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- run: npm install
|
||||||
|
- run: cd examples && npm install && npm run test -- echo
|
||||||
|
test-libp2p-in-the-browser-example:
|
||||||
|
needs: check
|
||||||
|
runs-on: macos-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- run: npm install
|
||||||
|
- run: cd examples && npm install && npm run test -- libp2p-in-the-browser
|
||||||
|
test-peer-and-content-routing-example:
|
||||||
|
needs: check
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- run: npm install
|
||||||
|
- run: cd examples && npm install && npm run test -- peer-and-content-routing
|
||||||
|
test-pnet-example:
|
||||||
|
needs: check
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- run: npm install
|
||||||
|
- run: cd examples && npm install && npm run test -- pnet
|
||||||
|
test-protocol-and-stream-muxing-example:
|
||||||
|
needs: check
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- run: npm install
|
||||||
|
- run: cd examples && npm install && npm run test -- protocol-and-stream-muxing
|
||||||
|
test-pubsub-example:
|
||||||
|
needs: check
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- run: npm install
|
||||||
|
- run: cd examples && npm install && npm run test -- pubsub
|
||||||
|
test-transports-example:
|
||||||
|
needs: check
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- run: npm install
|
||||||
|
- run: cd examples && npm install && npm run test -- transports
|
||||||
|
test-webrtc-direct-example:
|
||||||
|
needs: check
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- run: npm install
|
||||||
|
- run: cd examples && npm install && npm run test -- webrtc-direct
|
148
.github/workflows/main.yml
vendored
148
.github/workflows/main.yml
vendored
@ -8,165 +8,63 @@ on:
|
|||||||
- '**'
|
- '**'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
|
||||||
check:
|
check:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- uses: actions/setup-node@v2
|
- uses: actions/setup-node@v2
|
||||||
with:
|
with:
|
||||||
node-version: lts/*
|
node-version: 14
|
||||||
- uses: ipfs/aegir/actions/cache-node-modules@master
|
- run: npm install
|
||||||
- run: npm run --if-present lint
|
- run: npx aegir lint
|
||||||
- run: npm run --if-present dep-check
|
- uses: gozala/typescript-error-reporter-action@v1.0.8
|
||||||
|
- run: npx aegir build
|
||||||
|
- run: npx aegir dep-check
|
||||||
|
- uses: ipfs/aegir/actions/bundle-size@v32.1.0
|
||||||
|
name: size
|
||||||
|
with:
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
test-node:
|
test-node:
|
||||||
needs: check
|
needs: check
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [windows-latest, ubuntu-latest, macos-latest]
|
os: [windows-latest, ubuntu-latest, macos-latest]
|
||||||
node: [16]
|
node: [14, 16]
|
||||||
fail-fast: true
|
fail-fast: true
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- uses: actions/setup-node@v2
|
- uses: actions/setup-node@v2
|
||||||
with:
|
with:
|
||||||
node-version: ${{ matrix.node }}
|
node-version: ${{ matrix.node }}
|
||||||
- uses: ipfs/aegir/actions/cache-node-modules@master
|
- run: npm install
|
||||||
- run: npm run --if-present test:node
|
- run: npx aegir test -t node --cov --bail
|
||||||
- uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
|
- uses: codecov/codecov-action@v1
|
||||||
with:
|
|
||||||
directory: ./.nyc_output
|
|
||||||
flags: node
|
|
||||||
|
|
||||||
test-chrome:
|
test-chrome:
|
||||||
needs: check
|
needs: check
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- uses: actions/setup-node@v2
|
- run: npm install
|
||||||
with:
|
- run: npx aegir test -t browser -t webworker --bail
|
||||||
node-version: lts/*
|
|
||||||
- uses: ipfs/aegir/actions/cache-node-modules@master
|
|
||||||
- run: npm run --if-present test:chrome
|
|
||||||
- uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
|
|
||||||
with:
|
|
||||||
directory: ./.nyc_output
|
|
||||||
flags: chrome
|
|
||||||
|
|
||||||
test-chrome-webworker:
|
|
||||||
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: npm run --if-present test:chrome-webworker
|
|
||||||
- uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
|
|
||||||
with:
|
|
||||||
directory: ./.nyc_output
|
|
||||||
flags: chrome-webworker
|
|
||||||
|
|
||||||
test-firefox:
|
test-firefox:
|
||||||
needs: check
|
needs: check
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- uses: actions/setup-node@v2
|
- run: npm install
|
||||||
with:
|
- run: npx aegir test -t browser -t webworker --bail -- --browser firefox
|
||||||
node-version: lts/*
|
test-ts:
|
||||||
- uses: ipfs/aegir/actions/cache-node-modules@master
|
|
||||||
- run: npm run --if-present test:firefox
|
|
||||||
- uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
|
|
||||||
with:
|
|
||||||
directory: ./.nyc_output
|
|
||||||
flags: firefox
|
|
||||||
|
|
||||||
test-firefox-webworker:
|
|
||||||
needs: check
|
needs: check
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- uses: actions/setup-node@v2
|
- run: npm install
|
||||||
with:
|
- run: npm run test:ts
|
||||||
node-version: lts/*
|
|
||||||
- uses: ipfs/aegir/actions/cache-node-modules@master
|
|
||||||
- run: npm run --if-present test:firefox-webworker
|
|
||||||
- uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
|
|
||||||
with:
|
|
||||||
directory: ./.nyc_output
|
|
||||||
flags: firefox-webworker
|
|
||||||
|
|
||||||
test-electron-main:
|
|
||||||
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-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: check
|
needs: check
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- uses: actions/setup-node@v2
|
- run: npm install
|
||||||
with:
|
- run: cd node_modules/interop-libp2p && yarn && LIBP2P_JS=${GITHUB_WORKSPACE}/src/index.js npx aegir test -t node --bail -- --exit
|
||||||
node-version: lts/*
|
|
||||||
- uses: ipfs/aegir/actions/cache-node-modules@master
|
|
||||||
- run: npm run test:interop -- --bail
|
|
||||||
|
|
||||||
release:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
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'
|
|
||||||
steps:
|
|
||||||
- uses: GoogleCloudPlatform/release-please-action@v2
|
|
||||||
id: release
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
release-type: node
|
|
||||||
bump-minor-pre-major: true
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- uses: actions/setup-node@v2
|
|
||||||
with:
|
|
||||||
node-version: lts/*
|
|
||||||
registry-url: 'https://registry.npmjs.org'
|
|
||||||
- uses: ipfs/aegir/actions/cache-node-modules@master
|
|
||||||
- if: ${{ steps.release.outputs.release_created }}
|
|
||||||
name: Run release version
|
|
||||||
run: npm publish
|
|
||||||
env:
|
|
||||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
||||||
- if: ${{ !steps.release.outputs.release_created }}
|
|
||||||
name: Run release rc
|
|
||||||
run: |
|
|
||||||
npm version `node -p -e "require('./package.json').version"`-`git rev-parse --short HEAD` --no-git-tag-version
|
|
||||||
npm publish --tag next
|
|
||||||
env:
|
|
||||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
||||||
|
228
CHANGELOG.md
228
CHANGELOG.md
@ -1,228 +1,3 @@
|
|||||||
## [0.35.8](https://github.com/libp2p/js-libp2p/compare/v0.35.7...v0.35.8) (2021-12-29)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* do not wait for autodial start ([#1089](https://github.com/libp2p/js-libp2p/issues/1089)) ([79b3cfc](https://github.com/libp2p/js-libp2p/commit/79b3cfc6ad02ecc76fe23a3c3ff2d0b32a0ae4a8))
|
|
||||||
* increase listeners on any-signal ([#1084](https://github.com/libp2p/js-libp2p/issues/1084)) ([f18fc80](https://github.com/libp2p/js-libp2p/commit/f18fc80b70bf7b6b26fffa70b0a8d0502a6c4801))
|
|
||||||
* look for final peer event instead of peer response ([#1092](https://github.com/libp2p/js-libp2p/issues/1092)) ([d2b7ec0](https://github.com/libp2p/js-libp2p/commit/d2b7ec0f6be0ee80f2c963279a8ec2385059a889))
|
|
||||||
* record tracked map clears ([#1085](https://github.com/libp2p/js-libp2p/issues/1085)) ([b4b4324](https://github.com/libp2p/js-libp2p/commit/b4b432406ebc08ef2fc3a1922c64cde7c9060cae))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### [0.37.2](https://www.github.com/libp2p/js-libp2p/compare/v0.37.1...v0.37.2) (2022-05-31)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* reduce identify message size limit ([#1230](https://www.github.com/libp2p/js-libp2p/issues/1230)) ([824720f](https://www.github.com/libp2p/js-libp2p/commit/824720fb8f21f868ed88e881fbc3ce6b9459600d))
|
|
||||||
|
|
||||||
### [0.37.1](https://www.github.com/libp2p/js-libp2p/compare/v0.37.0...v0.37.1) (2022-05-25)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* do upnp hole punch after startup ([#1217](https://www.github.com/libp2p/js-libp2p/issues/1217)) ([d5386df](https://www.github.com/libp2p/js-libp2p/commit/d5386df68478a71ac269acb2d00d36a7a5c9ebc5))
|
|
||||||
* explicitly close streams when connnections close ([#1221](https://www.github.com/libp2p/js-libp2p/issues/1221)) ([b09eb8f](https://www.github.com/libp2p/js-libp2p/commit/b09eb8fc53ec1d8f6280d681c9ca6a467ec259b5))
|
|
||||||
* fix unintended aborts in dialer ([#1185](https://www.github.com/libp2p/js-libp2p/issues/1185)) ([35f9c0c](https://www.github.com/libp2p/js-libp2p/commit/35f9c0c79387232465848b450a47cafe841405e7))
|
|
||||||
* time out slow reads ([#1227](https://www.github.com/libp2p/js-libp2p/issues/1227)) ([a1220d2](https://www.github.com/libp2p/js-libp2p/commit/a1220d22f5affb64e64dec0cd6a92cd8241b26df))
|
|
||||||
|
|
||||||
## [0.37.0](https://www.github.com/libp2p/js-libp2p/compare/v0.36.2...v0.37.0) (2022-05-16)
|
|
||||||
|
|
||||||
|
|
||||||
### ⚠ BREAKING CHANGES
|
|
||||||
|
|
||||||
* types are no longer hand crafted, this module is now ESM only
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* convert to typescript ([#1172](https://www.github.com/libp2p/js-libp2p/issues/1172)) ([199395d](https://www.github.com/libp2p/js-libp2p/commit/199395de4d8139cc77d0b408626f37c9b8520d28))
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* add transport manager to exports map and fix docs ([#1182](https://www.github.com/libp2p/js-libp2p/issues/1182)) ([cc60cfd](https://www.github.com/libp2p/js-libp2p/commit/cc60cfde1a0907ca68f658f6de5362a708189222))
|
|
||||||
* emit peer:connect after all ([#1171](https://www.github.com/libp2p/js-libp2p/issues/1171)) ([d16817c](https://www.github.com/libp2p/js-libp2p/commit/d16817ca443443e88803ee8096d45debb14af91b))
|
|
||||||
* encode enums correctly ([#1210](https://www.github.com/libp2p/js-libp2p/issues/1210)) ([4837430](https://www.github.com/libp2p/js-libp2p/commit/4837430d8bcdbee0865eeba6fe694bc71fc6c9bb))
|
|
||||||
* expose getPublicKey ([#1188](https://www.github.com/libp2p/js-libp2p/issues/1188)) ([1473044](https://www.github.com/libp2p/js-libp2p/commit/147304449e5f8d3acb8b00bdd9588b56830667c6))
|
|
||||||
* expose metrics and registrar, use dht for peer discovery ([#1183](https://www.github.com/libp2p/js-libp2p/issues/1183)) ([64bfcee](https://www.github.com/libp2p/js-libp2p/commit/64bfcee5093b368df0b381f78afc2ddff3d339a9))
|
|
||||||
* simplify pnet exports ([#1213](https://www.github.com/libp2p/js-libp2p/issues/1213)) ([3148060](https://www.github.com/libp2p/js-libp2p/commit/31480603f3e17d838d2685573995218a1e678e7a))
|
|
||||||
* update deps ([#1181](https://www.github.com/libp2p/js-libp2p/issues/1181)) ([8cca8e4](https://www.github.com/libp2p/js-libp2p/commit/8cca8e4bfc6a339e58b5a5efa8a84fd891aa08ee))
|
|
||||||
* update interfaces ([#1207](https://www.github.com/libp2p/js-libp2p/issues/1207)) ([da3d19b](https://www.github.com/libp2p/js-libp2p/commit/da3d19b30977fd2c7e77d92aa8914b13e3179aaa))
|
|
||||||
* update pubsub interfaces ([#1194](https://www.github.com/libp2p/js-libp2p/issues/1194)) ([fab4f13](https://www.github.com/libp2p/js-libp2p/commit/fab4f1385cf61b7b16719b9aacdfe03146a3f260))
|
|
||||||
* update to new interfaces ([#1206](https://www.github.com/libp2p/js-libp2p/issues/1206)) ([a15254f](https://www.github.com/libp2p/js-libp2p/commit/a15254fdd478a336edf1e1196b721dc56888b2ea))
|
|
||||||
* use placeholder dht/pubsub ([#1193](https://www.github.com/libp2p/js-libp2p/issues/1193)) ([5397137](https://www.github.com/libp2p/js-libp2p/commit/5397137c654dfdec431e0c9ba4b1ff9dee19abf1))
|
|
||||||
|
|
||||||
### [0.36.2](https://www.github.com/libp2p/js-libp2p/compare/v0.36.1...v0.36.2) (2022-01-26)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* reject connections when not running ([#1146](https://www.github.com/libp2p/js-libp2p/issues/1146)) ([902f10d](https://www.github.com/libp2p/js-libp2p/commit/902f10d58d1062e812eb27aa0e2256e3fde5d3f6))
|
|
||||||
|
|
||||||
### [0.36.1](https://www.github.com/libp2p/js-libp2p/compare/v0.36.0...v0.36.1) (2022-01-25)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* await unhandle of protocols ([#1144](https://www.github.com/libp2p/js-libp2p/issues/1144)) ([d44bd90](https://www.github.com/libp2p/js-libp2p/commit/d44bd9094fe9545054eb8eff68f81bc52ece03e7))
|
|
||||||
|
|
||||||
## [0.36.0](https://www.github.com/libp2p/js-libp2p/compare/v0.35.8...v0.36.0) (2022-01-25)
|
|
||||||
|
|
||||||
|
|
||||||
### ⚠ BREAKING CHANGES
|
|
||||||
|
|
||||||
* abort-controller dep is gone from dependency tree
|
|
||||||
* `libp2p.handle`, `libp2p.registrar.register` and the peerstore methods have become async
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* add fetch protocol ([#1036](https://www.github.com/libp2p/js-libp2p/issues/1036)) ([d8ceb0b](https://www.github.com/libp2p/js-libp2p/commit/d8ceb0bc66fe225d1335d3f05b9a3a30983c2a57))
|
|
||||||
* async peerstore backed by datastores ([#1058](https://www.github.com/libp2p/js-libp2p/issues/1058)) ([978eb36](https://www.github.com/libp2p/js-libp2p/commit/978eb3676fad5d5d50ddb28d1a7868f448cbb20b))
|
|
||||||
* connection gater ([#1142](https://www.github.com/libp2p/js-libp2p/issues/1142)) ([ff32eba](https://www.github.com/libp2p/js-libp2p/commit/ff32eba6a0fa222af1a7a46775d5e0346ad6ebdf))
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* cache build artefacts ([#1091](https://www.github.com/libp2p/js-libp2p/issues/1091)) ([5043cd5](https://www.github.com/libp2p/js-libp2p/commit/5043cd56435a264e83db4fb8388d33e9a0442fff))
|
|
||||||
* catch errors during identify ([#1138](https://www.github.com/libp2p/js-libp2p/issues/1138)) ([12f1bb0](https://www.github.com/libp2p/js-libp2p/commit/12f1bb0aeec4b639bd2af05807215f3b4284e379))
|
|
||||||
* import uint8arrays package in example ([#1083](https://www.github.com/libp2p/js-libp2p/issues/1083)) ([c3700f5](https://www.github.com/libp2p/js-libp2p/commit/c3700f55d5a0b62182d683ca37258887b24065b9))
|
|
||||||
* make tests more reliable ([#1139](https://www.github.com/libp2p/js-libp2p/issues/1139)) ([b7e8706](https://www.github.com/libp2p/js-libp2p/commit/b7e87066a69970f1adca4ba552c7fdf624916a7e))
|
|
||||||
* prevent auto-dialer from dialing self ([#1104](https://www.github.com/libp2p/js-libp2p/issues/1104)) ([9b22c6e](https://www.github.com/libp2p/js-libp2p/commit/9b22c6e2f987a20c6639cd07f31fe9c824e24923))
|
|
||||||
* remove abort-controller dep ([#1095](https://www.github.com/libp2p/js-libp2p/issues/1095)) ([0a4dc54](https://www.github.com/libp2p/js-libp2p/commit/0a4dc54d084c901df47cce1788bd5922090ee037))
|
|
||||||
* try all peer addresses when dialing a relay ([#1140](https://www.github.com/libp2p/js-libp2p/issues/1140)) ([63aa480](https://www.github.com/libp2p/js-libp2p/commit/63aa480800974515f44d3b7e013da9c8ccaae8ad))
|
|
||||||
* update any-signal and timeout-abort-controller ([#1128](https://www.github.com/libp2p/js-libp2p/issues/1128)) ([e0354b4](https://www.github.com/libp2p/js-libp2p/commit/e0354b4c6b95bb90656b868849182eb3efddf096))
|
|
||||||
* update multistream select ([#1136](https://www.github.com/libp2p/js-libp2p/issues/1136)) ([00e4959](https://www.github.com/libp2p/js-libp2p/commit/00e49592a356e39b20c889d5f40b9bb37d4bf293))
|
|
||||||
* update node-forge ([#1133](https://www.github.com/libp2p/js-libp2p/issues/1133)) ([a4bba35](https://www.github.com/libp2p/js-libp2p/commit/a4bba35948e1cd8dbe5147f2c8d6385b1fbb6fae))
|
|
||||||
|
|
||||||
## [0.35.7](https://github.com/libp2p/js-libp2p/compare/v0.35.2...v0.35.7) (2021-12-24)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* add tracked map ([#1069](https://github.com/libp2p/js-libp2p/issues/1069)) ([b425fa1](https://github.com/libp2p/js-libp2p/commit/b425fa12304def2a007d43a0aa445c28b766ed02))
|
|
||||||
* clean up pending dial targets ([#1059](https://github.com/libp2p/js-libp2p/issues/1059)) ([bdc9f16](https://github.com/libp2p/js-libp2p/commit/bdc9f16d0cbe56ccf26822f11068e7795bcef046))
|
|
||||||
* fix uncaught promise rejection when finding peers ([#1044](https://github.com/libp2p/js-libp2p/issues/1044)) ([3b683e7](https://github.com/libp2p/js-libp2p/commit/3b683e715686163e229b7b5c3a892327dfd4fc63))
|
|
||||||
* increase the maxlisteners for timeout controllers ([#1065](https://github.com/libp2p/js-libp2p/issues/1065)) ([09a0f94](https://github.com/libp2p/js-libp2p/commit/09a0f940df7fdb4ece34604e85693709df5c213e))
|
|
||||||
* main ci ([#1079](https://github.com/libp2p/js-libp2p/issues/1079)) ([d1c48dc](https://github.com/libp2p/js-libp2p/commit/d1c48dcbeded828f2dd3044cc9aed3f17f02846d))
|
|
||||||
* make error codes consistent ([#1054](https://github.com/libp2p/js-libp2p/issues/1054)) ([b25e0fe](https://github.com/libp2p/js-libp2p/commit/b25e0fe5312db58a06c39500ae84c50fed3a93bd))
|
|
||||||
* type definitions for big dialrequest and persistent peerstore ([#1078](https://github.com/libp2p/js-libp2p/issues/1078)) ([cb0d7d6](https://github.com/libp2p/js-libp2p/commit/cb0d7d6c99d179498f04e76df76e70e4f7d41c4c))
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* allow per-component metrics to be collected ([#1061](https://github.com/libp2p/js-libp2p/issues/1061)) ([2f0b311](https://github.com/libp2p/js-libp2p/commit/2f0b311df7127aa44512c2008142d4ca30268986)), closes [#1060](https://github.com/libp2p/js-libp2p/issues/1060)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## [0.35.6](https://github.com/libp2p/js-libp2p/compare/v0.35.5...v0.35.6) (2021-12-18)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* increase the maxlisteners for timeout controllers ([#1065](https://github.com/libp2p/js-libp2p/issues/1065)) ([09a0f94](https://github.com/libp2p/js-libp2p/commit/09a0f940df7fdb4ece34604e85693709df5c213e))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## [0.35.5](https://github.com/libp2p/js-libp2p/compare/v0.35.4...v0.35.5) (2021-12-15)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## [0.35.4](https://github.com/libp2p/js-libp2p/compare/v0.35.3...v0.35.4) (2021-12-15)
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* allow per-component metrics to be collected ([#1061](https://github.com/libp2p/js-libp2p/issues/1061)) ([2f0b311](https://github.com/libp2p/js-libp2p/commit/2f0b311df7127aa44512c2008142d4ca30268986)), closes [#1060](https://github.com/libp2p/js-libp2p/issues/1060)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## [0.35.3](https://github.com/libp2p/js-libp2p/compare/v0.35.2...v0.35.3) (2021-12-13)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* clean up pending dial targets ([#1059](https://github.com/libp2p/js-libp2p/issues/1059)) ([bdc9f16](https://github.com/libp2p/js-libp2p/commit/bdc9f16d0cbe56ccf26822f11068e7795bcef046))
|
|
||||||
* fix uncaught promise rejection when finding peers ([#1044](https://github.com/libp2p/js-libp2p/issues/1044)) ([3b683e7](https://github.com/libp2p/js-libp2p/commit/3b683e715686163e229b7b5c3a892327dfd4fc63))
|
|
||||||
* make error codes consistent ([#1054](https://github.com/libp2p/js-libp2p/issues/1054)) ([b25e0fe](https://github.com/libp2p/js-libp2p/commit/b25e0fe5312db58a06c39500ae84c50fed3a93bd))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## [0.35.2](https://github.com/libp2p/js-libp2p/compare/v0.33.0...v0.35.2) (2021-12-06)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* do not let closest peers run forever ([#1047](https://github.com/libp2p/js-libp2p/issues/1047)) ([91c2ec9](https://github.com/libp2p/js-libp2p/commit/91c2ec9856a3e972b7b2c9c4d9a4eda1d431c7ef))
|
|
||||||
* increase maxlisteners on event target ([#1050](https://github.com/libp2p/js-libp2p/issues/1050)) ([b70fb43](https://github.com/libp2p/js-libp2p/commit/b70fb43427b47df079b55929ec8956f69cbda966)), closes [#900](https://github.com/libp2p/js-libp2p/issues/900)
|
|
||||||
* private ip ts compile has no call signatures ([#1020](https://github.com/libp2p/js-libp2p/issues/1020)) ([77d7cb8](https://github.com/libp2p/js-libp2p/commit/77d7cb8f0815f2cdd3bfdfa8b641a7a186fe9520))
|
|
||||||
* stop dht before connection manager ([#1041](https://github.com/libp2p/js-libp2p/issues/1041)) ([3a9d5f6](https://github.com/libp2p/js-libp2p/commit/3a9d5f64d96719ebb4d3b083c4f5832db4fa0816)), closes [#1039](https://github.com/libp2p/js-libp2p/issues/1039)
|
|
||||||
|
|
||||||
|
|
||||||
### chore
|
|
||||||
|
|
||||||
* update peer id and libp2p crypto ([#1042](https://github.com/libp2p/js-libp2p/issues/1042)) ([9cbf36f](https://github.com/libp2p/js-libp2p/commit/9cbf36fcb54099e6fed35ceccc4a2376f0926c1f))
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* update dht ([#1009](https://github.com/libp2p/js-libp2p/issues/1009)) ([2f598eb](https://github.com/libp2p/js-libp2p/commit/2f598eba09cff4301474af08196158065e3602d8))
|
|
||||||
|
|
||||||
|
|
||||||
### BREAKING CHANGES
|
|
||||||
|
|
||||||
* requires node 15+
|
|
||||||
* libp2p-kad-dht has a new event-based API which is exposed as `_dht`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## [0.35.1](https://github.com/libp2p/js-libp2p/compare/v0.35.0...v0.35.1) (2021-12-03)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* do not let closest peers run forever ([#1047](https://github.com/libp2p/js-libp2p/issues/1047)) ([91c2ec9](https://github.com/libp2p/js-libp2p/commit/91c2ec9856a3e972b7b2c9c4d9a4eda1d431c7ef))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.35.0](https://github.com/libp2p/js-libp2p/compare/v0.34.0...v0.35.0) (2021-12-02)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* stop dht before connection manager ([#1041](https://github.com/libp2p/js-libp2p/issues/1041)) ([3a9d5f6](https://github.com/libp2p/js-libp2p/commit/3a9d5f64d96719ebb4d3b083c4f5832db4fa0816)), closes [#1039](https://github.com/libp2p/js-libp2p/issues/1039)
|
|
||||||
|
|
||||||
|
|
||||||
### chore
|
|
||||||
|
|
||||||
* update peer id and libp2p crypto ([#1042](https://github.com/libp2p/js-libp2p/issues/1042)) ([9cbf36f](https://github.com/libp2p/js-libp2p/commit/9cbf36fcb54099e6fed35ceccc4a2376f0926c1f))
|
|
||||||
|
|
||||||
|
|
||||||
### BREAKING CHANGES
|
|
||||||
|
|
||||||
* requires node 15+
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.34.0](https://github.com/libp2p/js-libp2p/compare/v0.33.0...v0.34.0) (2021-11-25)
|
|
||||||
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
* private ip ts compile has no call signatures ([#1020](https://github.com/libp2p/js-libp2p/issues/1020)) ([77d7cb8](https://github.com/libp2p/js-libp2p/commit/77d7cb8f0815f2cdd3bfdfa8b641a7a186fe9520))
|
|
||||||
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
* update dht ([#1009](https://github.com/libp2p/js-libp2p/issues/1009)) ([2f598eb](https://github.com/libp2p/js-libp2p/commit/2f598eba09cff4301474af08196158065e3602d8))
|
|
||||||
|
|
||||||
|
|
||||||
### BREAKING CHANGES
|
|
||||||
|
|
||||||
* libp2p-kad-dht has a new event-based API which is exposed as `_dht`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# [0.33.0](https://github.com/libp2p/js-libp2p/compare/v0.32.5...v0.33.0) (2021-09-24)
|
# [0.33.0](https://github.com/libp2p/js-libp2p/compare/v0.32.5...v0.33.0) (2021-09-24)
|
||||||
|
|
||||||
|
|
||||||
@ -1846,3 +1621,6 @@ for subscribe to see how it should be used.
|
|||||||
|
|
||||||
<a name="0.5.5"></a>
|
<a name="0.5.5"></a>
|
||||||
## [0.5.5](https://github.com/libp2p/js-libp2p/compare/v0.5.4...v0.5.5) (2017-03-21)
|
## [0.5.5](https://github.com/libp2p/js-libp2p/compare/v0.5.4...v0.5.5) (2017-03-21)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
24
LICENSE
24
LICENSE
@ -1,4 +1,22 @@
|
|||||||
This project is dual licensed under MIT and Apache-2.0.
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
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
|
|
||||||
|
@ -1,5 +0,0 @@
|
|||||||
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
19
LICENSE-MIT
@ -1,19 +0,0 @@
|
|||||||
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.
|
|
27
README.md
27
README.md
@ -23,8 +23,8 @@
|
|||||||
<a href="https://david-dm.org/libp2p/js-libp2p"><img src="https://david-dm.org/libp2p/js-libp2p.svg?style=flat-square" /></a>
|
<a href="https://david-dm.org/libp2p/js-libp2p"><img src="https://david-dm.org/libp2p/js-libp2p.svg?style=flat-square" /></a>
|
||||||
<a href="https://github.com/feross/standard"><img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square"></a>
|
<a href="https://github.com/feross/standard"><img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square"></a>
|
||||||
<a href="https://github.com/RichardLitt/standard-readme"><img src="https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square" /></a>
|
<a href="https://github.com/RichardLitt/standard-readme"><img src="https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square" /></a>
|
||||||
<a href=""><img src="https://img.shields.io/badge/npm-%3E%3D7.0.0-orange.svg?style=flat-square" /></a>
|
<a href=""><img src="https://img.shields.io/badge/npm-%3E%3D6.0.0-orange.svg?style=flat-square" /></a>
|
||||||
<a href=""><img src="https://img.shields.io/badge/Node.js-%3E%3D15.0.0-orange.svg?style=flat-square" /></a>
|
<a href=""><img src="https://img.shields.io/badge/Node.js-%3E%3D12.0.0-orange.svg?style=flat-square" /></a>
|
||||||
<br>
|
<br>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@ -39,22 +39,26 @@ 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).
|
||||||
|
|
||||||
## Table of Contents <!-- omit in toc -->
|
[**`Weekly Core Dev Calls`**](https://github.com/libp2p/team-mgmt/issues/16)
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
@ -119,7 +123,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:chrome
|
> npm run test:browser
|
||||||
```
|
```
|
||||||
|
|
||||||
### Packages
|
### Packages
|
||||||
@ -179,11 +183,4 @@ The libp2p implementation in JavaScript is a work in progress. As such, there ar
|
|||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Licensed under either of
|
[MIT](LICENSE) © Protocol Labs
|
||||||
|
|
||||||
* 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.
|
|
||||||
|
126
doc/API.md
126
doc/API.md
@ -3,7 +3,6 @@
|
|||||||
* [Static Functions](#static-functions)
|
* [Static Functions](#static-functions)
|
||||||
* [`create`](#create)
|
* [`create`](#create)
|
||||||
* [Instance Methods](#libp2p-instance-methods)
|
* [Instance Methods](#libp2p-instance-methods)
|
||||||
* [`loadkeychain`](#loadkeychain)
|
|
||||||
* [`start`](#start)
|
* [`start`](#start)
|
||||||
* [`stop`](#stop)
|
* [`stop`](#stop)
|
||||||
* [`dial`](#dial)
|
* [`dial`](#dial)
|
||||||
@ -12,9 +11,6 @@
|
|||||||
* [`handle`](#handle)
|
* [`handle`](#handle)
|
||||||
* [`unhandle`](#unhandle)
|
* [`unhandle`](#unhandle)
|
||||||
* [`ping`](#ping)
|
* [`ping`](#ping)
|
||||||
* [`fetch`](#fetch)
|
|
||||||
* [`fetchService.registerLookupFunction`](#fetchserviceregisterlookupfunction)
|
|
||||||
* [`fetchService.unRegisterLookupFunction`](#fetchserviceunregisterlookupfunction)
|
|
||||||
* [`multiaddrs`](#multiaddrs)
|
* [`multiaddrs`](#multiaddrs)
|
||||||
* [`addressManager.getListenAddrs`](#addressmanagergetlistenaddrs)
|
* [`addressManager.getListenAddrs`](#addressmanagergetlistenaddrs)
|
||||||
* [`addressManager.getAnnounceAddrs`](#addressmanagergetannounceaddrs)
|
* [`addressManager.getAnnounceAddrs`](#addressmanagergetannounceaddrs)
|
||||||
@ -97,9 +93,7 @@ Creates an instance of Libp2p.
|
|||||||
| options.modules | [`Array<object>`](./CONFIGURATION.md#modules) | libp2p [modules](./CONFIGURATION.md#modules) to use |
|
| options.modules | [`Array<object>`](./CONFIGURATION.md#modules) | libp2p [modules](./CONFIGURATION.md#modules) to use |
|
||||||
| [options.addresses] | `{ listen: Array<string>, announce: Array<string>, announceFilter: (ma: Array<multiaddr>) => Array<multiaddr> }` | Addresses for transport listening and to advertise to the network |
|
| [options.addresses] | `{ listen: Array<string>, announce: Array<string>, announceFilter: (ma: Array<multiaddr>) => Array<multiaddr> }` | Addresses for transport listening and to advertise to the network |
|
||||||
| [options.config] | `object` | libp2p modules configuration and core configuration |
|
| [options.config] | `object` | libp2p modules configuration and core configuration |
|
||||||
| [options.identify] | `{ protocolPrefix: string, host: { agentVersion: string }, timeout: number, maxIdentifyMessageSize: number }` | libp2p identify protocol options |
|
| [options.host] | `{ agentVersion: string }` | libp2p host options |
|
||||||
| [options.ping] | `{ protocolPrefix: string }` | libp2p ping protocol options |
|
|
||||||
| [options.fetch] | `{ protocolPrefix: string }` | libp2p fetch protocol options |
|
|
||||||
| [options.connectionManager] | [`object`](./CONFIGURATION.md#configuring-connection-manager) | libp2p Connection Manager [configuration](./CONFIGURATION.md#configuring-connection-manager) |
|
| [options.connectionManager] | [`object`](./CONFIGURATION.md#configuring-connection-manager) | libp2p Connection Manager [configuration](./CONFIGURATION.md#configuring-connection-manager) |
|
||||||
| [options.transportManager] | [`object`](./CONFIGURATION.md#configuring-transport-manager) | libp2p transport manager [configuration](./CONFIGURATION.md#configuring-transport-manager) |
|
| [options.transportManager] | [`object`](./CONFIGURATION.md#configuring-transport-manager) | libp2p transport manager [configuration](./CONFIGURATION.md#configuring-transport-manager) |
|
||||||
| [options.datastore] | `object` | must implement [ipfs/interface-datastore](https://github.com/ipfs/interface-datastore) (in memory datastore will be used if not provided) |
|
| [options.datastore] | `object` | must implement [ipfs/interface-datastore](https://github.com/ipfs/interface-datastore) (in memory datastore will be used if not provided) |
|
||||||
@ -121,21 +115,23 @@ For Libp2p configurations and modules details read the [Configuration Document](
|
|||||||
#### Example
|
#### Example
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
|
|
||||||
async function main () {
|
async function main () {
|
||||||
// specify options
|
// specify options
|
||||||
const options = {
|
const options = {
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()]
|
streamMuxer: [MPLEX],
|
||||||
|
connEncryption: [NOISE]
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// create libp2p
|
// create libp2p
|
||||||
const libp2p = await createLibp2p(options)
|
const libp2p = await Libp2p.create(options)
|
||||||
}
|
}
|
||||||
|
|
||||||
main()
|
main()
|
||||||
@ -149,11 +145,11 @@ As an alternative, it is possible to create a Libp2p instance with the construct
|
|||||||
#### Example
|
#### Example
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
|
const PeerId = require('peer-id')
|
||||||
|
|
||||||
async function main () {
|
async function main () {
|
||||||
const peerId = await PeerId.create();
|
const peerId = await PeerId.create();
|
||||||
@ -162,9 +158,11 @@ 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,
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()]
|
streamMuxer: [MPLEX],
|
||||||
|
connEncryption: [NOISE]
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// create libp2p
|
// create libp2p
|
||||||
@ -198,11 +196,11 @@ Load keychain keys from the datastore, importing the private key as 'self', if n
|
|||||||
#### Example
|
#### Example
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
|
|
||||||
// ...
|
// ...
|
||||||
|
|
||||||
const libp2p = await createLibp2p({
|
const libp2p = await Libp2p.create({
|
||||||
// ...
|
// ...
|
||||||
keychain: {
|
keychain: {
|
||||||
pass: '0123456789pass1234567890'
|
pass: '0123456789pass1234567890'
|
||||||
@ -228,11 +226,11 @@ Starts the libp2p node.
|
|||||||
#### Example
|
#### Example
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
|
|
||||||
// ...
|
// ...
|
||||||
|
|
||||||
const libp2p = await createLibp2p(options)
|
const libp2p = await Libp2p.create(options)
|
||||||
|
|
||||||
// start libp2p
|
// start libp2p
|
||||||
await libp2p.start()
|
await libp2p.start()
|
||||||
@ -253,10 +251,10 @@ Stops the libp2p node.
|
|||||||
#### Example
|
#### Example
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
|
|
||||||
// ...
|
// ...
|
||||||
const libp2p = await createLibp2p(options)
|
const libp2p = await Libp2p.create(options)
|
||||||
// ...
|
// ...
|
||||||
|
|
||||||
// stop libp2p
|
// stop libp2p
|
||||||
@ -352,7 +350,7 @@ Dials to another peer in the network and selects a protocol to communicate with
|
|||||||
|
|
||||||
```js
|
```js
|
||||||
// ...
|
// ...
|
||||||
import { pipe } from 'it-pipe'
|
const pipe = require('it-pipe')
|
||||||
|
|
||||||
const { stream, protocol } = await libp2p.dialProtocol(remotePeerId, protocols)
|
const { stream, protocol } = await libp2p.dialProtocol(remotePeerId, protocols)
|
||||||
|
|
||||||
@ -456,72 +454,6 @@ Pings a given peer and get the operation's latency.
|
|||||||
const latency = await libp2p.ping(otherPeerId)
|
const latency = await libp2p.ping(otherPeerId)
|
||||||
```
|
```
|
||||||
|
|
||||||
## fetch
|
|
||||||
|
|
||||||
Fetch a value from a remote node
|
|
||||||
|
|
||||||
`libp2p.fetch(peer, key)`
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
|------|------|-------------|
|
|
||||||
| peer | [`PeerId`][peer-id]\|[`Multiaddr`][multiaddr]\|`string` | peer to ping |
|
|
||||||
| key | `string` | A key that corresponds to a value on the remote node |
|
|
||||||
|
|
||||||
#### Returns
|
|
||||||
|
|
||||||
| Type | Description |
|
|
||||||
|------|-------------|
|
|
||||||
| `Promise<Uint8Array | null>` | The value for the key or null if it cannot be found |
|
|
||||||
|
|
||||||
#### Example
|
|
||||||
|
|
||||||
```js
|
|
||||||
// ...
|
|
||||||
const value = await libp2p.fetch(otherPeerId, '/some/key')
|
|
||||||
```
|
|
||||||
|
|
||||||
## fetchService.registerLookupFunction
|
|
||||||
|
|
||||||
Register a function to look up values requested by remote nodes
|
|
||||||
|
|
||||||
`libp2p.fetchService.registerLookupFunction(prefix, lookup)`
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
|------|------|-------------|
|
|
||||||
| prefix | `string` | All queries below this prefix will be passed to the lookup function |
|
|
||||||
| lookup | `(key: string) => Promise<Uint8Array | null>` | A function that takes a key and returns a Uint8Array or null |
|
|
||||||
|
|
||||||
#### Example
|
|
||||||
|
|
||||||
```js
|
|
||||||
// ...
|
|
||||||
const value = await libp2p.fetchService.registerLookupFunction('/prefix', (key) => { ... })
|
|
||||||
```
|
|
||||||
|
|
||||||
## fetchService.unregisterLookupFunction
|
|
||||||
|
|
||||||
Removes the passed lookup function or any function registered for the passed prefix
|
|
||||||
|
|
||||||
`libp2p.fetchService.unregisterLookupFunction(prefix, lookup)`
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
|------|------|-------------|
|
|
||||||
| prefix | `string` | All queries below this prefix will be passed to the lookup function |
|
|
||||||
| lookup | `(key: string) => Promise<Uint8Array | null>` | Optional: A function that takes a key and returns a Uint8Array or null |
|
|
||||||
|
|
||||||
#### Example
|
|
||||||
|
|
||||||
```js
|
|
||||||
// ...
|
|
||||||
libp2p.fetchService.unregisterLookupFunction('/prefix')
|
|
||||||
```
|
|
||||||
|
|
||||||
## multiaddrs
|
## multiaddrs
|
||||||
|
|
||||||
Gets the multiaddrs the libp2p node announces to the network. This computes the advertising multiaddrs
|
Gets the multiaddrs the libp2p node announces to the network. This computes the advertising multiaddrs
|
||||||
@ -2154,7 +2086,7 @@ the NatManager performing NAT hole punching.
|
|||||||
|
|
||||||
[address]: https://github.com/libp2p/js-libp2p/tree/master/src/peer-store/address-book.js
|
[address]: https://github.com/libp2p/js-libp2p/tree/master/src/peer-store/address-book.js
|
||||||
[cid]: https://github.com/multiformats/js-cid
|
[cid]: https://github.com/multiformats/js-cid
|
||||||
[connection]: https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/interfaces/src/connection
|
[connection]: https://github.com/libp2p/js-interfaces/tree/master/src/connection
|
||||||
[multiaddr]: https://github.com/multiformats/js-multiaddr
|
[multiaddr]: https://github.com/multiformats/js-multiaddr
|
||||||
[peer-id]: https://github.com/libp2p/js-peer-id
|
[peer-id]: https://github.com/libp2p/js-peer-id
|
||||||
[keys]: https://github.com/libp2p/js-libp2p-crypto/tree/master/src/keys
|
[keys]: https://github.com/libp2p/js-libp2p-crypto/tree/master/src/keys
|
||||||
|
@ -1,40 +1,37 @@
|
|||||||
#
|
#
|
||||||
|
|
||||||
- [Overview](#overview)
|
- [Configuration](#configuration)
|
||||||
- [Modules](#modules)
|
- [Overview](#overview)
|
||||||
- [Transport](#transport)
|
- [Modules](#modules)
|
||||||
- [Stream Multiplexing](#stream-multiplexing)
|
- [Transport](#transport)
|
||||||
- [Connection Encryption](#connection-encryption)
|
- [Stream Multiplexing](#stream-multiplexing)
|
||||||
- [Peer Discovery](#peer-discovery)
|
- [Connection Encryption](#connection-encryption)
|
||||||
- [Content Routing](#content-routing)
|
- [Peer Discovery](#peer-discovery)
|
||||||
- [Peer Routing](#peer-routing)
|
- [Content Routing](#content-routing)
|
||||||
- [DHT](#dht)
|
- [Peer Routing](#peer-routing)
|
||||||
- [Pubsub](#pubsub)
|
- [DHT](#dht)
|
||||||
- [Customizing libp2p](#customizing-libp2p)
|
- [Pubsub](#pubsub)
|
||||||
- [Examples](#examples)
|
- [Customizing libp2p](#customizing-libp2p)
|
||||||
- [Basic setup](#basic-setup)
|
- [Examples](#examples)
|
||||||
- [Customizing Peer Discovery](#customizing-peer-discovery)
|
- [Basic setup](#basic-setup)
|
||||||
- [Setup webrtc transport and discovery](#setup-webrtc-transport-and-discovery)
|
- [Customizing Peer Discovery](#customizing-peer-discovery)
|
||||||
- [Customizing Pubsub](#customizing-pubsub)
|
- [Setup webrtc transport and discovery](#setup-webrtc-transport-and-discovery)
|
||||||
- [Customizing DHT](#customizing-dht)
|
- [Customizing Pubsub](#customizing-pubsub)
|
||||||
- [Setup with Content and Peer Routing](#setup-with-content-and-peer-routing)
|
- [Customizing DHT](#customizing-dht)
|
||||||
- [Setup with Relay](#setup-with-relay)
|
- [Setup with Content and Peer Routing](#setup-with-content-and-peer-routing)
|
||||||
- [Setup with Auto Relay](#setup-with-auto-relay)
|
- [Setup with Relay](#setup-with-relay)
|
||||||
- [Setup with Keychain](#setup-with-keychain)
|
- [Setup with Auto Relay](#setup-with-auto-relay)
|
||||||
- [Configuring Dialing](#configuring-dialing)
|
- [Setup with Keychain](#setup-with-keychain)
|
||||||
- [Configuring Connection Manager](#configuring-connection-manager)
|
- [Configuring Dialing](#configuring-dialing)
|
||||||
- [Configuring Connection Gater](#configuring-connection-gater)
|
- [Configuring Connection Manager](#configuring-connection-manager)
|
||||||
- [Outgoing connections](#outgoing-connections)
|
- [Configuring Transport Manager](#configuring-transport-manager)
|
||||||
- [Incoming connections](#incoming-connections)
|
- [Configuring Metrics](#configuring-metrics)
|
||||||
- [Configuring Transport Manager](#configuring-transport-manager)
|
- [Configuring PeerStore](#configuring-peerstore)
|
||||||
- [Configuring Metrics](#configuring-metrics)
|
- [Customizing Transports](#customizing-transports)
|
||||||
- [Configuring PeerStore](#configuring-peerstore)
|
- [Configuring the NAT Manager](#configuring-the-nat-manager)
|
||||||
- [Customizing Transports](#customizing-transports)
|
- [Browser support](#browser-support)
|
||||||
- [Configuring the NAT Manager](#configuring-the-nat-manager)
|
- [UPnP and NAT-PMP](#upnp-and-nat-pmp)
|
||||||
- [Browser support](#browser-support)
|
- [Configuration examples](#configuration-examples)
|
||||||
- [UPnP and NAT-PMP](#upnp-and-nat-pmp)
|
|
||||||
- [Configuring protocol name](#configuring-protocol-name)
|
|
||||||
- [Configuration examples](#configuration-examples)
|
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
@ -199,9 +196,9 @@ When [creating a libp2p node](./API.md#create), the modules needed should be spe
|
|||||||
|
|
||||||
```js
|
```js
|
||||||
const modules = {
|
const modules = {
|
||||||
transports: [],
|
transport: [],
|
||||||
streamMuxers: [],
|
streamMuxer: [],
|
||||||
connectionEncryption: [],
|
connEncryption: [],
|
||||||
contentRouting: [],
|
contentRouting: [],
|
||||||
peerRouting: [],
|
peerRouting: [],
|
||||||
peerDiscovery: [],
|
peerDiscovery: [],
|
||||||
@ -235,59 +232,67 @@ Besides the `modules` and `config`, libp2p allows other internal options and con
|
|||||||
// dht: kad-dht
|
// dht: kad-dht
|
||||||
// pubsub: gossipsub
|
// pubsub: gossipsub
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const WS = require('libp2p-websockets')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
import { MulticastDNS } from '@libp2p/mdns'
|
const MulticastDNS = require('libp2p-mdns')
|
||||||
import { KadDHT } from '@libp2p/kad-dht'
|
const DHT = require('libp2p-kad-dht')
|
||||||
import { GossipSub } from 'libp2p-gossipsub'
|
const GossipSub = require('libp2p-gossipsub')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [
|
modules: {
|
||||||
new TCP(),
|
transport: [
|
||||||
new WS()
|
TCP,
|
||||||
],
|
new WS() // It can take instances too!
|
||||||
streamMuxers: [new Mplex()],
|
],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [MPLEX],
|
||||||
peerDiscovery: [MulticastDNS],
|
connEncryption: [NOISE],
|
||||||
dht: DHT,
|
peerDiscovery: [MulticastDNS],
|
||||||
pubsub: GossipSub
|
dht: DHT,
|
||||||
|
pubsub: GossipSub
|
||||||
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Customizing Peer Discovery
|
#### Customizing Peer Discovery
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
import { MulticastDNS } from '@libp2p/mdns'
|
const MulticastDNS = require('libp2p-mdns')
|
||||||
import { Bootstrap } from '@libp2p/bootstrap'
|
const Bootstrap = require('libp2p-bootstrap')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [MPLEX],
|
||||||
peerDiscovery: [
|
connEncryption: [NOISE],
|
||||||
new MulticastDNS({
|
peerDiscovery: [MulticastDNS, Bootstrap]
|
||||||
interval: 1000
|
},
|
||||||
}),
|
config: {
|
||||||
new Bootstrap(
|
peerDiscovery: {
|
||||||
list: [ // A list of bootstrap peers to connect to starting up the node
|
autoDial: true, // Auto connect to discovered peers (limited by ConnectionManager minConnections)
|
||||||
"/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ",
|
// The `tag` property will be searched when creating the instance of your Peer Discovery service.
|
||||||
"/dnsaddr/bootstrap.libp2p.io/ipfs/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN",
|
// The associated object, will be passed to the service when it is instantiated.
|
||||||
"/dnsaddr/bootstrap.libp2p.io/ipfs/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa",
|
[MulticastDNS.tag]: {
|
||||||
],
|
interval: 1000,
|
||||||
interval: 2000
|
enabled: true
|
||||||
)
|
},
|
||||||
],
|
[Bootstrap.tag]: {
|
||||||
connectionManager: {
|
list: [ // A list of bootstrap peers to connect to starting up the node
|
||||||
autoDial: true // Auto connect to discovered peers (limited by ConnectionManager minConnections)
|
"/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ",
|
||||||
// The `tag` property will be searched when creating the instance of your Peer Discovery service.
|
"/dnsaddr/bootstrap.libp2p.io/ipfs/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN",
|
||||||
// The associated object, will be passed to the service when it is instantiated.
|
"/dnsaddr/bootstrap.libp2p.io/ipfs/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa",
|
||||||
|
],
|
||||||
|
interval: 2000,
|
||||||
|
enabled: true
|
||||||
|
}
|
||||||
|
// .. other discovery module options.
|
||||||
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
@ -295,50 +300,56 @@ const node = await createLibp2p({
|
|||||||
#### 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 node = await createLibp2p({
|
const Libp2p = require('libp2p')
|
||||||
transports: [
|
const WS = require('libp2p-websockets')
|
||||||
new WebSockets(),
|
const WebRTCStar = require('libp2p-webrtc-star')
|
||||||
new WebRTCStar()
|
const MPLEX = require('libp2p-mplex')
|
||||||
],
|
const { NOISE } = require('libp2p-noise')
|
||||||
streamMuxers: [
|
|
||||||
new Mplex()
|
const node = await Libp2p.create({
|
||||||
],
|
modules: {
|
||||||
connectionEncryption: [
|
transport: [
|
||||||
new Noise()
|
WS,
|
||||||
]
|
WebRTCStar
|
||||||
|
],
|
||||||
|
streamMuxer: [MPLEX],
|
||||||
|
connEncryption: [NOISE],
|
||||||
|
},
|
||||||
|
config: {
|
||||||
|
peerDiscovery: {
|
||||||
|
[WebRTCStar.tag]: {
|
||||||
|
enabled: true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Customizing Pubsub
|
#### Customizing Pubsub
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
import { GossipSub } from 'libp2p-gossipsub'
|
const GossipSub = require('libp2p-gossipsub')
|
||||||
import { SignaturePolicy } from '@libp2p/interfaces/pubsub'
|
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const { SignaturePolicy } = require('libp2p-interfaces/src/pubsub/signature-policy')
|
||||||
transports: [
|
|
||||||
new TCP()
|
const node = await Libp2p.create({
|
||||||
],
|
modules: {
|
||||||
streamMuxers: [
|
transport: [TCP],
|
||||||
new Mplex()
|
streamMuxer: [MPLEX],
|
||||||
],
|
connEncryption: [NOISE],
|
||||||
connectionEncryption: [
|
pubsub: GossipSub
|
||||||
new Noise()
|
},
|
||||||
],
|
config: {
|
||||||
pubsub: new GossipSub({
|
pubsub: { // The pubsub options (and defaults) can be found in the pubsub router documentation
|
||||||
|
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
|
||||||
})
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
@ -346,66 +357,68 @@ const node = await createLibp2p({
|
|||||||
#### Customizing DHT
|
#### Customizing DHT
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
import { KadDHT } from '@libp2p/kad-dht'
|
const DHT = require('libp2p-kad-dht')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [
|
modules: {
|
||||||
new TCP()
|
transport: [TCP],
|
||||||
],
|
streamMuxer: [MPLEX],
|
||||||
streamMuxers: [
|
connEncryption: [NOISE],
|
||||||
new Mplex()
|
dht: DHT
|
||||||
],
|
},
|
||||||
connectionEncryption: [
|
config: {
|
||||||
new Noise()
|
dht: { // The DHT options (and defaults) can be found in its documentation
|
||||||
],
|
kBucketSize: 20,
|
||||||
dht: new KadDHT({
|
enabled: true, // This flag is required for DHT to run (disabled by default)
|
||||||
kBucketSize: 20,
|
randomWalk: {
|
||||||
clientMode: false // Whether to run the WAN DHT in client or server mode (default: client mode)
|
enabled: true, // Allows to disable discovery (enabled by default)
|
||||||
})
|
interval: 300e3,
|
||||||
|
timeout: 10e3
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Setup with Content and Peer Routing
|
#### Setup with Content and Peer Routing
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
import { create as ipfsHttpClient } from 'ipfs-http-client'
|
const ipfsHttpClient = require('ipfs-http-client')
|
||||||
import { DelegatedPeerRouting } from '@libp2p/delegated-peer-routing'
|
const DelegatedPeerRouter = require('libp2p-delegated-peer-routing')
|
||||||
import { DelegatedContentRouting} from '@libp2p/delegated-content-routing'
|
const DelegatedContentRouter = require('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 DelegatedPeerRouting(ipfsHttpClient.create({
|
const delegatedPeerRouting = new DelegatedPeerRouter(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 DelegatedContentRouting(peerId, ipfsHttpClient.create({
|
const delegatedContentRouting = new DelegatedContentRouter(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 createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [MPLEX],
|
||||||
contentRouting: [
|
connEncryption: [NOISE],
|
||||||
delegatedContentRouting
|
contentRouting: [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
|
||||||
@ -420,25 +433,29 @@ const node = await createLibp2p({
|
|||||||
#### Setup with Relay
|
#### Setup with Relay
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [MPLEX],
|
||||||
relay: { // Circuit Relay options (this config is part of libp2p core configurations)
|
connEncryption: [NOISE]
|
||||||
enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay.
|
},
|
||||||
hop: {
|
config: {
|
||||||
enabled: true, // Allows you to be a relay for other peers
|
relay: { // Circuit Relay options (this config is part of libp2p core configurations)
|
||||||
active: true // You will attempt to dial destination peers if you are not connected to them
|
enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay.
|
||||||
},
|
hop: {
|
||||||
advertise: {
|
enabled: true, // Allows you to be a relay for other peers
|
||||||
bootDelay: 15 * 60 * 1000, // Delay before HOP relay service is advertised on the network
|
active: true // You will attempt to dial destination peers if you are not connected to them
|
||||||
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
|
advertise: {
|
||||||
|
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
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@ -447,20 +464,24 @@ const node = await createLibp2p({
|
|||||||
#### Setup with Auto Relay
|
#### Setup with Auto Relay
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()]
|
streamMuxer: [MPLEX],
|
||||||
relay: { // Circuit Relay options (this config is part of libp2p core configurations)
|
connEncryption: [NOISE]
|
||||||
enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay.
|
},
|
||||||
autoRelay: {
|
config: {
|
||||||
enabled: true, // Allows you to bind to relays with HOP enabled for improving node dialability
|
relay: { // Circuit Relay options (this config is part of libp2p core configurations)
|
||||||
maxListeners: 2 // Configure maximum number of HOP relays to use
|
enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay.
|
||||||
|
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
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@ -476,19 +497,21 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
import { LevelDatastore } from 'datastore-level'
|
const LevelStore = require('datastore-level')
|
||||||
|
|
||||||
const datastore = new LevelDatastore('path/to/store')
|
const datastore = new LevelStore('path/to/store')
|
||||||
await datastore.open()
|
await datastore.open()
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [MPLEX],
|
||||||
|
connEncryption: [NOISE]
|
||||||
|
},
|
||||||
keychain: {
|
keychain: {
|
||||||
pass: 'notsafepassword123456789',
|
pass: 'notsafepassword123456789',
|
||||||
datastore: dsInstant,
|
datastore: dsInstant,
|
||||||
@ -514,18 +537,20 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
|
|
||||||
import { dnsaddrResolver } from '@multiformats/multiaddr/resolvers'
|
const { dnsaddrResolver } = require('multiaddr/src/resolvers')
|
||||||
import { publicAddressesFirst } from '@libp2p-utils/address-sort'
|
const { publicAddressesFirst } = require('libp2p-utils/src/address-sort')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [MPLEX],
|
||||||
|
connEncryption: [NOISE]
|
||||||
|
},
|
||||||
dialer: {
|
dialer: {
|
||||||
maxParallelDials: 100,
|
maxParallelDials: 100,
|
||||||
maxAddrsToDial: 25,
|
maxAddrsToDial: 25,
|
||||||
@ -543,15 +568,17 @@ const node = await createLibp2p({
|
|||||||
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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [MPLEX],
|
||||||
|
connEncryption: [NOISE]
|
||||||
|
},
|
||||||
connectionManager: {
|
connectionManager: {
|
||||||
maxConnections: Infinity,
|
maxConnections: Infinity,
|
||||||
minConnections: 0,
|
minConnections: 0,
|
||||||
@ -567,142 +594,24 @@ const node = await createLibp2p({
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Configuring Connection Gater
|
|
||||||
|
|
||||||
The Connection Gater allows us to prevent making incoming and outgoing connections to peers and storing
|
|
||||||
multiaddrs in the address book.
|
|
||||||
|
|
||||||
The order in which methods are called is as follows:
|
|
||||||
|
|
||||||
##### Outgoing connections
|
|
||||||
|
|
||||||
1. `connectionGater.denyDialPeer(...)`
|
|
||||||
2. `connectionGater.denyDialMultiaddr(...)`
|
|
||||||
3. `connectionGater.denyOutboundConnection(...)`
|
|
||||||
4. `connectionGater.denyOutboundEncryptedConnection(...)`
|
|
||||||
5. `connectionGater.denyOutboundUpgradedConnection(...)`
|
|
||||||
|
|
||||||
##### Incoming connections
|
|
||||||
|
|
||||||
1. `connectionGater.denyInboundConnection(...)`
|
|
||||||
2. `connectionGater.denyInboundEncryptedConnection(...)`
|
|
||||||
3. `connectionGater.denyInboundUpgradedConnection(...)`
|
|
||||||
|
|
||||||
```js
|
|
||||||
const node = await createLibp2p({
|
|
||||||
// .. other config
|
|
||||||
connectionGater: {
|
|
||||||
/**
|
|
||||||
* denyDialMultiaddr tests whether we're permitted to Dial the
|
|
||||||
* specified peer.
|
|
||||||
*
|
|
||||||
* This is called by the dialer.connectToPeer implementation before
|
|
||||||
* dialling a peer.
|
|
||||||
*
|
|
||||||
* Return true to prevent dialing the passed peer.
|
|
||||||
*/
|
|
||||||
denyDialPeer: (peerId: PeerId) => Promise<boolean>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* denyDialMultiaddr tests whether we're permitted to dial the specified
|
|
||||||
* multiaddr for the given peer.
|
|
||||||
*
|
|
||||||
* This is called by the dialer.connectToPeer implementation after it has
|
|
||||||
* resolved the peer's addrs, and prior to dialling each.
|
|
||||||
*
|
|
||||||
* Return true to prevent dialing the passed peer on the passed multiaddr.
|
|
||||||
*/
|
|
||||||
denyDialMultiaddr: (peerId: PeerId, multiaddr: Multiaddr) => Promise<boolean>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* denyInboundConnection tests whether an incipient inbound connection is allowed.
|
|
||||||
*
|
|
||||||
* This is called by the upgrader, or by the transport directly (e.g. QUIC,
|
|
||||||
* Bluetooth), straight after it has accepted a connection from its socket.
|
|
||||||
*
|
|
||||||
* Return true to deny the incoming passed connection.
|
|
||||||
*/
|
|
||||||
denyInboundConnection: (maConn: MultiaddrConnection) => Promise<boolean>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* denyOutboundConnection tests whether an incipient outbound connection is allowed.
|
|
||||||
*
|
|
||||||
* This is called by the upgrader, or by the transport directly (e.g. QUIC,
|
|
||||||
* Bluetooth), straight after it has created a connection with its socket.
|
|
||||||
*
|
|
||||||
* Return true to deny the incoming passed connection.
|
|
||||||
*/
|
|
||||||
denyOutboundConnection: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* denyInboundEncryptedConnection tests whether a given connection, now encrypted,
|
|
||||||
* is allowed.
|
|
||||||
*
|
|
||||||
* This is called by the upgrader, after it has performed the security
|
|
||||||
* handshake, and before it negotiates the muxer, or by the directly by the
|
|
||||||
* transport, at the exact same checkpoint.
|
|
||||||
*
|
|
||||||
* Return true to deny the passed secured connection.
|
|
||||||
*/
|
|
||||||
denyInboundEncryptedConnection: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* denyOutboundEncryptedConnection tests whether a given connection, now encrypted,
|
|
||||||
* is allowed.
|
|
||||||
*
|
|
||||||
* This is called by the upgrader, after it has performed the security
|
|
||||||
* handshake, and before it negotiates the muxer, or by the directly by the
|
|
||||||
* transport, at the exact same checkpoint.
|
|
||||||
*
|
|
||||||
* Return true to deny the passed secured connection.
|
|
||||||
*/
|
|
||||||
denyOutboundEncryptedConnection: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* denyInboundUpgradedConnection tests whether a fully capable connection is allowed.
|
|
||||||
*
|
|
||||||
* This is called after encryption has been negotiated and the connection has been
|
|
||||||
* multiplexed, if a multiplexer is configured.
|
|
||||||
*
|
|
||||||
* Return true to deny the passed upgraded connection.
|
|
||||||
*/
|
|
||||||
denyInboundUpgradedConnection: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* denyOutboundUpgradedConnection tests whether a fully capable connection is allowed.
|
|
||||||
*
|
|
||||||
* This is called after encryption has been negotiated and the connection has been
|
|
||||||
* multiplexed, if a multiplexer is configured.
|
|
||||||
*
|
|
||||||
* Return true to deny the passed upgraded connection.
|
|
||||||
*/
|
|
||||||
denyOutboundUpgradedConnection: (peerId: PeerId, maConn: MultiaddrConnection) => Promise<boolean>
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Used by the address book to filter passed addresses.
|
|
||||||
*
|
|
||||||
* Return true to allow storing the passed multiaddr for the passed peer.
|
|
||||||
*/
|
|
||||||
filterMultiaddrForPeer: (peer: PeerId, multiaddr: Multiaddr) => Promise<boolean>
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Configuring Transport Manager
|
#### Configuring Transport Manager
|
||||||
|
|
||||||
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 listenning 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
import { FaultTolerance } from 'libp2p/transport-manager'
|
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const { FaultTolerance } = require('libp2p/src/transport-manager')
|
||||||
transports: [new TCP()],
|
|
||||||
streamMuxers: [new Mplex()],
|
const node = await Libp2p.create({
|
||||||
connectionEncryption: [new Noise()],
|
modules: {
|
||||||
|
transport: [TCP],
|
||||||
|
streamMuxer: [MPLEX],
|
||||||
|
connEncryption: [NOISE]
|
||||||
|
},
|
||||||
transportManager: {
|
transportManager: {
|
||||||
faultTolerance: FaultTolerance.NO_FATAL
|
faultTolerance: FaultTolerance.NO_FATAL
|
||||||
}
|
}
|
||||||
@ -724,15 +633,17 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()]
|
streamMuxer: [MPLEX],
|
||||||
|
connEncryption: [NOISE]
|
||||||
|
},
|
||||||
metrics: {
|
metrics: {
|
||||||
enabled: true,
|
enabled: true,
|
||||||
computeThrottleMaxQueueSize: 1000,
|
computeThrottleMaxQueueSize: 1000,
|
||||||
@ -761,20 +672,22 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
import { LevelDatastore } from 'datastore-level'
|
const LevelStore = require('datastore-level')
|
||||||
|
|
||||||
const datastore = new LevelDatastore('path/to/store')
|
const datastore = new LevelStore('path/to/store')
|
||||||
await datastore.open() // level database must be ready before node boot
|
const dsInstant = await datastore.open()
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
datastore, // pass the opened datastore
|
modules: {
|
||||||
transports: [new TCP()],
|
transport: [TCP],
|
||||||
streamMuxers: [new Mplex()],
|
streamMuxer: [MPLEX],
|
||||||
connectionEncryption: [new Noise()],
|
connEncryption: [NOISE]
|
||||||
|
},
|
||||||
|
datastore: dsInstant,
|
||||||
peerStore: {
|
peerStore: {
|
||||||
persistence: true,
|
persistence: true,
|
||||||
threshold: 5
|
threshold: 5
|
||||||
@ -787,23 +700,19 @@ const node = await createLibp2p({
|
|||||||
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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
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('libp2p-noise')
|
||||||
import wrtc from 'wrtc'
|
const wrtc = require('wrtc')
|
||||||
|
|
||||||
const transportKey = WebRTCStar.prototype[Symbol.toStringTag]
|
const transportKey = WebRTCStar.prototype[Symbol.toStringTag]
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [
|
modules: {
|
||||||
new WebRTCStar()
|
transport: [WebRTCStar],
|
||||||
],
|
streamMuxer: [MPLEX],
|
||||||
streamMuxers: [
|
connEncryption: [NOISE]
|
||||||
new Mplex()
|
},
|
||||||
],
|
|
||||||
connectionEncryption: [
|
|
||||||
new Noise()
|
|
||||||
],
|
|
||||||
config: {
|
config: {
|
||||||
transport: {
|
transport: {
|
||||||
[transportKey]: {
|
[transportKey]: {
|
||||||
@ -818,16 +727,12 @@ 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 createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [
|
modules: {
|
||||||
new WebRTCStar()
|
transport: [WebRTCStar],
|
||||||
],
|
streamMuxer: [MPLEX],
|
||||||
streamMuxers: [
|
connEncryption: [NOISE]
|
||||||
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
|
||||||
},
|
},
|
||||||
@ -854,16 +759,18 @@ 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 createLibp2p({
|
const node = await Libp2p.create({
|
||||||
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
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@ -881,14 +788,11 @@ By default under nodejs libp2p will attempt to use [UPnP](https://en.wikipedia.o
|
|||||||
|
|
||||||
#### Configuring protocol name
|
#### Configuring protocol name
|
||||||
|
|
||||||
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 createLibp2p({
|
const node = await Libp2p.create({
|
||||||
identify: {
|
config: {
|
||||||
protocolPrefix: 'ipfs' // default
|
|
||||||
},
|
|
||||||
ping: {
|
|
||||||
protocolPrefix: 'ipfs' // default
|
protocolPrefix: 'ipfs' // default
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@ -901,12 +805,13 @@ 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:
|
||||||
|
|
||||||
- [libp2p-ipfs-nodejs](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core-config/src/libp2p.js) - libp2p configuration used by js-ipfs when running in Node.js
|
- [libp2p-ipfs-nodejs](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs/src/core/runtime/libp2p-nodejs.js) - libp2p configuration used by js-ipfs when running in Node.js
|
||||||
- [libp2p-ipfs-browser](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core-config/src/libp2p.browser.js) - libp2p configuration used by js-ipfs when running in a Browser (that supports WebRTC)
|
- [libp2p-ipfs-browser](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs/src/core/runtime/libp2p-browser.js) - libp2p configuration used by js-ipfs when running in a Browser (that supports WebRTC)
|
||||||
|
|
||||||
If you have developed a project using `js-libp2p`, please consider submitting your configuration to this list so that it can be found easily by other users.
|
If you have developed a project using `js-libp2p`, please consider submitting your configuration to this list so that it can be found easily by other users.
|
||||||
|
|
||||||
|
@ -12,6 +12,7 @@ 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
|
||||||
@ -45,11 +46,13 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const WebSockets = require('libp2p-websockets')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new WebSockets()]
|
modules: {
|
||||||
|
transport: [WebSockets]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -75,13 +78,15 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const WebSockets = require('libp2p-websockets')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new WebSockets()],
|
modules: {
|
||||||
connectionEncryption: [new Noise()]
|
transport: [WebSockets],
|
||||||
|
connEncryption: [NOISE]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -105,15 +110,17 @@ npm install libp2p-mplex
|
|||||||
```
|
```
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const WebSockets = require('libp2p-websockets')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new WebSockets()],
|
modules: {
|
||||||
connectionEncryption: [new Noise()],
|
transport: [WebSockets],
|
||||||
streamMuxers: [new Mplex()]
|
connEncryption: [NOISE],
|
||||||
|
streamMuxer: [MPLEX]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -130,18 +137,20 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const WebSockets = require('libp2p-websockets')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/127.0.0.1/tcp/8000/ws']
|
listen: ['/ip4/127.0.0.1/tcp/8000/ws']
|
||||||
},
|
},
|
||||||
transports: [new WebSockets()],
|
modules: {
|
||||||
connectionEncryption: [new Noise()],
|
transport: [WebSockets],
|
||||||
streamMuxers: [new Mplex()]
|
connEncryption: [NOISE],
|
||||||
|
streamMuxer: [MPLEX]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
// start libp2p
|
// start libp2p
|
||||||
@ -186,12 +195,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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const WebSockets = require('libp2p-websockets')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('libp2p-noise')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
|
|
||||||
import { Bootstrap } from '@libp2p/bootstrap'
|
const Bootstrap = require('libp2p-bootstrap')
|
||||||
|
|
||||||
// Known peers addresses
|
// Known peers addresses
|
||||||
const bootstrapMultiaddrs = [
|
const bootstrapMultiaddrs = [
|
||||||
@ -199,25 +208,23 @@ const bootstrapMultiaddrs = [
|
|||||||
'/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN'
|
'/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN'
|
||||||
]
|
]
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [
|
modules: {
|
||||||
new WebSockets()
|
transport: [WebSockets],
|
||||||
],
|
connEncryption: [NOISE],
|
||||||
connectionEncryption: [
|
streamMuxer: [MPLEX],
|
||||||
new Noise()
|
peerDiscovery: [Bootstrap]
|
||||||
],
|
},
|
||||||
streamMuxers: [
|
config: {
|
||||||
new Mplex()
|
peerDiscovery: {
|
||||||
],
|
autoDial: true, // Auto connect to discovered peers (limited by ConnectionManager minConnections)
|
||||||
peerDiscovery: [
|
// 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: bootstrapMultiaddrs // provide array of multiaddrs
|
[Bootstrap.tag]: {
|
||||||
})
|
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.
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
@ -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 `connectionManager.autoDial` config property, and handle connections themselves.
|
* Applications can disable this via the `peerDiscovery.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
|
||||||
|
@ -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
|
||||||
import { duplexPair } from 'it-pair/duplex'
|
const duplexPair = require('it-pair/duplex')
|
||||||
import { pipe } from 'it-pipe'
|
const pipe = require('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
|
||||||
|
@ -4,18 +4,16 @@ A migration guide for refactoring your application code from libp2p v0.26.x to v
|
|||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Migrating to the libp2p@0.27 API](#migrating-to-the-libp2p027-api)
|
- [Migrating from callbacks](#migrating-from-callbacks)
|
||||||
- [Table of Contents](#table-of-contents)
|
- [Pull Streams to Streaming Iterables](#pull-streams-to-streaming-iterables)
|
||||||
- [Migrating from callbacks](#migrating-from-callbacks)
|
- [Sample API Migrations](#sample-api-migrations)
|
||||||
- [Pull Streams to Streaming Iterables](#pull-streams-to-streaming-iterables)
|
- [Registering Protocol Handlers](#registering-protocol-handlers)
|
||||||
- [Sample API Migrations](#sample-api-migrations)
|
- [Dialing and Sending Data](#dialing-and-sending-data)
|
||||||
- [Registering Protocol Handlers](#registering-protocol-handlers)
|
- [Checking if a peer is connected](#checking-if-a-peer-is-connected)
|
||||||
- [Dialing and Sending Data](#dialing-and-sending-data)
|
- [Pinging another peer](#pinging-another-peer)
|
||||||
- [Checking if a peer is connected](#checking-if-a-peer-is-connected)
|
- [Pubsub](#pubsub)
|
||||||
- [Pinging another peer](#pinging-another-peer)
|
- [Getting subscribers](#getting-subscribers)
|
||||||
- [Pubsub](#pubsub)
|
- [Getting subscribed topics](#getting-subscribed-topics)
|
||||||
- [Getting subscribers](#getting-subscribers)
|
|
||||||
- [Getting subscribed topics](#getting-subscribed-topics)
|
|
||||||
|
|
||||||
## Migrating from callbacks
|
## Migrating from callbacks
|
||||||
|
|
||||||
|
@ -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.
|
||||||
|
|
||||||
|
@ -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 from 'uint8arrays/from-string')
|
const uint8ArrayFromString = require('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 from 'uint8arrays/to-string')
|
const uint8ArrayToString = require('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 from 'uint8arrays/to-string')
|
const uint8ArrayToString = require('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 from 'uint8arrays/from-string')
|
const uint8ArrayFromString = require('uint8arrays/from-string')
|
||||||
const uint8ArrayToString from 'uint8arrays/to-string')
|
const uint8ArrayToString = require('uint8arrays/to-string')
|
||||||
```
|
```
|
||||||
|
|
||||||
#### contentRouting.put
|
#### contentRouting.put
|
||||||
|
@ -5,13 +5,9 @@ A migration guide for refactoring your application code from libp2p v0.29.x to v
|
|||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Migrating to libp2p@30](#migrating-to-libp2p30)
|
- [API](#api)
|
||||||
- [Table of Contents](#table-of-contents)
|
- [Development and Testing](#development-and-testing)
|
||||||
- [API](#api)
|
- [Module Updates](#module-updates)
|
||||||
- [Pubsub](#pubsub)
|
|
||||||
- [Addresses](#addresses)
|
|
||||||
- [Development and Testing](#development-and-testing)
|
|
||||||
- [Module Updates](#module-updates)
|
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
@ -24,8 +20,8 @@ Now `js-libp2p` does not overwrite the pubsub router options anymore. Upstream p
|
|||||||
**Before**
|
**Before**
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const Gossipsub from 'libp2p-gossipsub')
|
const Gossipsub = require('libp2p-gossipsub')
|
||||||
const Libp2p from 'libp2p')
|
const Libp2p = require('libp2p')
|
||||||
|
|
||||||
const libp2p = await Libp2p.create({
|
const libp2p = await Libp2p.create({
|
||||||
modules: {
|
modules: {
|
||||||
@ -38,8 +34,8 @@ const libp2p = await Libp2p.create({
|
|||||||
**After**
|
**After**
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const Gossipsub from 'libp2p-gossipsub')
|
const Gossipsub = require('libp2p-gossipsub')
|
||||||
const Libp2p from 'libp2p')
|
const Libp2p = require('libp2p')
|
||||||
|
|
||||||
const libp2p = await Libp2p.create({
|
const libp2p = await Libp2p.create({
|
||||||
modules: {
|
modules: {
|
||||||
@ -61,8 +57,8 @@ The signing property is now based on a `globalSignaturePolicy` option instead of
|
|||||||
**Before**
|
**Before**
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const Gossipsub from 'libp2p-gossipsub')
|
const Gossipsub = require('libp2p-gossipsub')
|
||||||
const Libp2p from 'libp2p')
|
const Libp2p = require('libp2p')
|
||||||
|
|
||||||
const libp2p = await Libp2p.create({
|
const libp2p = await Libp2p.create({
|
||||||
modules: {
|
modules: {
|
||||||
@ -81,9 +77,9 @@ const libp2p = await Libp2p.create({
|
|||||||
**After**
|
**After**
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const Gossipsub from 'libp2p-gossipsub')
|
const Gossipsub = require('libp2p-gossipsub')
|
||||||
const { SignaturePolicy } from 'libp2p-interfaces/src/pubsub/signature-policy')
|
const { SignaturePolicy } = require('libp2p-interfaces/src/pubsub/signature-policy')
|
||||||
const Libp2p from 'libp2p')
|
const Libp2p = require('libp2p')
|
||||||
|
|
||||||
const libp2p = await Libp2p.create({
|
const libp2p = await Libp2p.create({
|
||||||
modules: {
|
modules: {
|
||||||
@ -105,7 +101,7 @@ Libp2p has supported `noAnnounce` addresses configuration for some time now. How
|
|||||||
**Before**
|
**Before**
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const Libp2p from 'libp2p')
|
const Libp2p = require('libp2p')
|
||||||
|
|
||||||
const libp2p = await Libp2p.create({
|
const libp2p = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
@ -119,10 +115,10 @@ const libp2p = await Libp2p.create({
|
|||||||
**After**
|
**After**
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const Libp2p from 'libp2p')
|
const Libp2p = require('libp2p')
|
||||||
|
|
||||||
// Libp2p utils has several multiaddr utils you can leverage
|
// Libp2p utils has several multiaddr utils you can leverage
|
||||||
const isPrivate from 'libp2p-utils/src/multiaddr/is-private')
|
const isPrivate = require('libp2p-utils/src/multiaddr/is-private')
|
||||||
|
|
||||||
const libp2p = await Libp2p.create({
|
const libp2p = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
@ -135,7 +131,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)
|
||||||
@ -149,9 +145,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 from 'libp2p-websockets')
|
const Websockets = require('libp2p-websockets')
|
||||||
const filters from 'libp2p-websockets/src/filters')
|
const filters = require('libp2p-websockets/src/filters')
|
||||||
const Libp2p from 'libp2p')
|
const Libp2p = require('libp2p')
|
||||||
|
|
||||||
const transportKey = Websockets.prototype[Symbol.toStringTag]
|
const transportKey = Websockets.prototype[Symbol.toStringTag]
|
||||||
const libp2p = await Libp2p.create({
|
const libp2p = await Libp2p.create({
|
||||||
@ -174,7 +170,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`
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
@ -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`
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
@ -1,262 +0,0 @@
|
|||||||
<!--Specify versions for migration below-->
|
|
||||||
# Migrating to libp2p@37 <!-- omit in toc -->
|
|
||||||
|
|
||||||
A migration guide for refactoring your application code from libp2p v0.36.x to v0.37.0.
|
|
||||||
|
|
||||||
## Table of Contents <!-- omit in toc -->
|
|
||||||
|
|
||||||
- [ESM](#esm)
|
|
||||||
- [TypeScript](#typescript)
|
|
||||||
- [Config](#config)
|
|
||||||
- [Bundled modules](#bundled-modules)
|
|
||||||
- [Events](#events)
|
|
||||||
- [Pubsub](#pubsub)
|
|
||||||
|
|
||||||
## ESM
|
|
||||||
|
|
||||||
The biggest change to `libp2p@0.37.0` is that the module is now [ESM-only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
|
|
||||||
|
|
||||||
ESM is the module system for JavaScript, it allows us to structure our code in separate files without polluting a global namespace.
|
|
||||||
|
|
||||||
Other systems have tried to fill this gap, notably CommonJS, AMD, RequireJS and others, but ESM is [the official standard format](https://tc39.es/ecma262/#sec-modules) to package JavaScript code for reuse.
|
|
||||||
|
|
||||||
## TypeScript
|
|
||||||
|
|
||||||
The core `libp2p` module and all supporting modules have now been ported to TypeScript in a complete ground-up rewrite. This will not have a huge impact on most application code, but those that are type-aware, either by being written in TypeScript themselves or using JSDoc comments will notice full type completion and better error message when coding against the libp2p API.
|
|
||||||
|
|
||||||
To reflect the updated nature of these modules, all ecosystem modules have been moved to the `@libp2p` org on npm, so `libp2p-tcp` has become `@libp2p/tcp`, `libp2p-mplex` has become `@libp2p/mplex` and so on. `@chainsafe/libp2p-noise` and `libp2p-gossipsub` are unaffected.
|
|
||||||
|
|
||||||
## Config
|
|
||||||
|
|
||||||
Because libp2p is now fully typed it was necessary to refactor the configuration object passed to the libp2p constructor. The reason being, it previously accepted config objects to pass to the constructors of the various modules - to type those we'd need to know the types of all possible modules in advance which isn't possible.
|
|
||||||
|
|
||||||
The following changes have been made to the configuration object:
|
|
||||||
|
|
||||||
1. It now takes instances of modules rather than their classes
|
|
||||||
2. Keys from the `config` and `modules` objects have been migrated to the root of the object
|
|
||||||
3. Use of the `enabled` flag has been removed - if you don't want a particular feature enabled, don't pass a module implementing that feature
|
|
||||||
4. Some keys have been renamed = `transport` -> `transports`, `streamMuxer` -> `streamMuxers`, `connEncryption` -> `connectionEncryption`, etc
|
|
||||||
5. Keys from `config.dialer` have been moved to `config.connectionManager` as the connection manager is now responsible for managing connections
|
|
||||||
6. The `protocolPrefix` configuration option is now passed on a per-protocol basis for `identify`, `fetch` and `ping`
|
|
||||||
|
|
||||||
**Before**
|
|
||||||
|
|
||||||
```js
|
|
||||||
import Libp2p from 'libp2p'
|
|
||||||
import TCP from 'libp2p-tcp'
|
|
||||||
import Mplex from 'libp2p-mplex'
|
|
||||||
import { NOISE } from '@chainsafe/libp2p-noise'
|
|
||||||
import Gossipsub from 'libp2p-gossipsub'
|
|
||||||
import KadDHT from 'libp2p-kad-dht'
|
|
||||||
import Bootstrap from 'libp2p-bootstrap'
|
|
||||||
import MulticastDNS from 'libp2p-mdns'
|
|
||||||
|
|
||||||
const node = await Libp2p.create({
|
|
||||||
addresses: {
|
|
||||||
listen: ['/ip4/127.0.0.1/tcp/8000']
|
|
||||||
},
|
|
||||||
modules: {
|
|
||||||
transport: [
|
|
||||||
TCP
|
|
||||||
],
|
|
||||||
streamMuxer: [
|
|
||||||
Mplex
|
|
||||||
],
|
|
||||||
connEncryption: [
|
|
||||||
NOISE
|
|
||||||
],
|
|
||||||
dht: KadDHT,
|
|
||||||
pubsub: Gossipsub,
|
|
||||||
peerDiscovery: [
|
|
||||||
Bootstrap,
|
|
||||||
MulticastDNS
|
|
||||||
]
|
|
||||||
},
|
|
||||||
protocolPrefix: 'ipfs',
|
|
||||||
config: {
|
|
||||||
peerDiscovery: {
|
|
||||||
autoDial: true,
|
|
||||||
[MulticastDNS.tag]: {
|
|
||||||
interval: 1000,
|
|
||||||
enabled: true
|
|
||||||
},
|
|
||||||
[Bootstrap.tag]: {
|
|
||||||
list: [
|
|
||||||
// .. multiaddrs here
|
|
||||||
],
|
|
||||||
interval: 2000,
|
|
||||||
enabled: true
|
|
||||||
}
|
|
||||||
},
|
|
||||||
dialer: {
|
|
||||||
dialTimeout: 60000
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
**After**
|
|
||||||
|
|
||||||
```js
|
|
||||||
import { createLibp2p } from 'libp2p'
|
|
||||||
import { TCP } from '@libp2p/tcp'
|
|
||||||
import { Mplex } from '@libp2p/mplex'
|
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
|
||||||
import Gossipsub from '@chainsafe/libp2p-gossipsub'
|
|
||||||
import { KadDHT } from '@libp2p/kad-dht'
|
|
||||||
import { Bootstrap } from '@libp2p/bootstrap'
|
|
||||||
import { MulticastDNS } from '@libp2p/mdns'
|
|
||||||
|
|
||||||
const node = await createLibp2p({
|
|
||||||
addresses: {
|
|
||||||
listen: ['/ip4/127.0.0.1/tcp/8000']
|
|
||||||
},
|
|
||||||
addressManager: {
|
|
||||||
autoDial: true
|
|
||||||
},
|
|
||||||
connectionManager: {
|
|
||||||
dialTimeout: 60000
|
|
||||||
},
|
|
||||||
transports: [
|
|
||||||
new TCP()
|
|
||||||
],
|
|
||||||
streamMuxers: [
|
|
||||||
new Mplex()
|
|
||||||
],
|
|
||||||
connectionEncryption: [
|
|
||||||
new Noise()
|
|
||||||
],
|
|
||||||
dht: new KadDHT(),
|
|
||||||
pubsub: new Gossipsub(),
|
|
||||||
peerDiscovery: [
|
|
||||||
new Bootstrap({
|
|
||||||
list: [
|
|
||||||
// .. multiaddrs here
|
|
||||||
],
|
|
||||||
interval: 2000
|
|
||||||
}),
|
|
||||||
new MulticastDNS({
|
|
||||||
interval: 1000
|
|
||||||
})
|
|
||||||
],
|
|
||||||
identify: {
|
|
||||||
protocolPrefix: 'ipfs'
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
## Bundled modules
|
|
||||||
|
|
||||||
Previously you'd have to use deep import paths to get at bundled modules such as the private network module.
|
|
||||||
|
|
||||||
Access to these modules is now controlled by the package.json export map so your import paths will need to be updated:
|
|
||||||
|
|
||||||
**Before**
|
|
||||||
|
|
||||||
```js
|
|
||||||
import plaintext from 'libp2p/src/insecure/plaintext.js'
|
|
||||||
import Protector from 'libp2p/src/pnet/index.js'
|
|
||||||
import generateKey from 'libp2p/src/pnet/key-generator.js'
|
|
||||||
import TransportManager from 'libp2p/src/transport-manager.js'
|
|
||||||
```
|
|
||||||
|
|
||||||
**After**
|
|
||||||
|
|
||||||
```js
|
|
||||||
import { Plaintext } from 'libp2p/insecure'
|
|
||||||
import { PreSharedKeyConnectionProtector, generateKey } from 'libp2p/pnet'
|
|
||||||
import { TransportManager } from 'libp2p/transport-manager'
|
|
||||||
```
|
|
||||||
|
|
||||||
## Events
|
|
||||||
|
|
||||||
To reduce our dependency on Node.js internals, use of [EventEmitter](https://nodejs.org/api/events.html#class-eventemitter) has been replaced with the standard [EventTarget](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget).
|
|
||||||
|
|
||||||
The EventTarget API is very similar to [HTML DOM Events](https://developer.mozilla.org/en-US/docs/Web/API/Event) used by the browser.
|
|
||||||
|
|
||||||
All events are instances of the [CustomEvent](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent) class. Event-specific information can be accessed via the `.detail` property of the passed event.
|
|
||||||
|
|
||||||
They type of event emitted can be inferred from the types for each event emitter.
|
|
||||||
|
|
||||||
**Before**
|
|
||||||
|
|
||||||
```js
|
|
||||||
const handler = (peerInfo) => {
|
|
||||||
//...
|
|
||||||
}
|
|
||||||
|
|
||||||
// listen for event
|
|
||||||
libp2p.on('peer:discovery', handler)
|
|
||||||
|
|
||||||
// stop listening for event
|
|
||||||
libp2p.removeListener('peer:discovery', handler)
|
|
||||||
libp2p.off('peer:discovery', handler)
|
|
||||||
```
|
|
||||||
|
|
||||||
**After**
|
|
||||||
|
|
||||||
```js
|
|
||||||
const handler = (event) => {
|
|
||||||
const peerInfo = event.detail
|
|
||||||
//...
|
|
||||||
}
|
|
||||||
|
|
||||||
// listen for event
|
|
||||||
libp2p.addEventListener('peer:discovery', handler)
|
|
||||||
|
|
||||||
// stop listening for event
|
|
||||||
libp2p.removeEventListener('peer:discovery', handler)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Pubsub
|
|
||||||
|
|
||||||
Similar to the events refactor above, pubsub is now driven by the standard [EventTarget](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget) API.
|
|
||||||
|
|
||||||
You can still subscribe to events without a listener with `.subscribe` but all other uses now use the standard API.
|
|
||||||
|
|
||||||
Similar to the other events emitted by libp2p the event type is [CustomEvent](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent). This is part of the js language but at the time of writing Node.js [does not support](https://github.com/nodejs/node/issues/40678) `CustomEvent`, so a polyfill is supplied as part of the `@libp2p/interfaces`
|
|
||||||
|
|
||||||
**Before**
|
|
||||||
|
|
||||||
```js
|
|
||||||
const handler = (message: Message) => {
|
|
||||||
const topic = message.topic
|
|
||||||
|
|
||||||
//...
|
|
||||||
}
|
|
||||||
|
|
||||||
// listen for event
|
|
||||||
libp2p.pubsub.subscribe('my-topic')
|
|
||||||
libp2p.pubsub.on('my-topic', handler)
|
|
||||||
|
|
||||||
// send event
|
|
||||||
libp2p.pubsub.emit('my-topic', Uint8Array.from([0, 1, 2, 3]))
|
|
||||||
|
|
||||||
// stop listening for event
|
|
||||||
libp2p.unsubscribe('my-topic', handler)
|
|
||||||
libp2p.pubsub.off('my-topic', handler)
|
|
||||||
```
|
|
||||||
|
|
||||||
**After**
|
|
||||||
|
|
||||||
```js
|
|
||||||
import type { Message } from '@libp2p/interfaces/pubsub'
|
|
||||||
|
|
||||||
const handler = (event: CustomEvent<Message>) => {
|
|
||||||
const message = event.detail
|
|
||||||
const topic = message.topic
|
|
||||||
|
|
||||||
//...
|
|
||||||
}
|
|
||||||
|
|
||||||
// listen for event
|
|
||||||
libp2p.pubsub.subscribe('my-topic')
|
|
||||||
libp2p.pubsub.addEventListener('message', handler)
|
|
||||||
|
|
||||||
// send event
|
|
||||||
libp2p.pubsub.publish('my-topic', Uint8Array.from([0, 1, 2, 3]))
|
|
||||||
|
|
||||||
// stop listening for event
|
|
||||||
libp2p.pubsub.unsubscribe('my-topic')
|
|
||||||
libp2p.pubsub.removeEventListener('message', handler)
|
|
||||||
```
|
|
@ -16,27 +16,31 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const Websockets = require('libp2p-websockets')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new WebSockets()],
|
modules: {
|
||||||
connectionEncryption: [new Noise()],
|
transport: [Websockets],
|
||||||
streamMuxers: [new Mplex()]
|
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']
|
||||||
},
|
},
|
||||||
relay: {
|
config: {
|
||||||
enabled: true,
|
relay: {
|
||||||
hop: {
|
|
||||||
enabled: true
|
|
||||||
},
|
|
||||||
advertise: {
|
|
||||||
enabled: true,
|
enabled: true,
|
||||||
|
hop: {
|
||||||
|
enabled: true
|
||||||
|
},
|
||||||
|
advertise: {
|
||||||
|
enabled: true,
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@ -70,25 +74,29 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const Websockets = require('libp2p-websockets')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('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 createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new WebSockets()],
|
modules: {
|
||||||
connectionEncryption: [new Noise()],
|
transport: [Websockets],
|
||||||
streamMuxers: [new Mplex()],
|
connEncryption: [NOISE],
|
||||||
relay: {
|
streamMuxer: [MPLEX]
|
||||||
enabled: true,
|
},
|
||||||
autoRelay: {
|
config: {
|
||||||
|
relay: {
|
||||||
enabled: true,
|
enabled: true,
|
||||||
maxListeners: 2
|
autoRelay: {
|
||||||
|
enabled: true,
|
||||||
|
maxListeners: 2
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@ -98,15 +106,18 @@ console.log(`Node started with id ${node.peerId.toB58String()}`)
|
|||||||
|
|
||||||
const conn = await node.dial(relayAddr)
|
const conn = await node.dial(relayAddr)
|
||||||
|
|
||||||
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 }) => {
|
await new Promise((resolve) => {
|
||||||
// Updated self multiaddrs?
|
node.peerStore.on('change:multiaddrs', ({ peerId }) => {
|
||||||
if (peerId.equals(node.peerId)) {
|
// Updated self multiaddrs?
|
||||||
console.log(`Advertising with a relay address of ${node.multiaddrs[0].toString()}/p2p/${node.peerId.toB58String()}`)
|
if (peerId.equals(node.peerId)) {
|
||||||
}
|
resolve()
|
||||||
|
}
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
console.log(`Connected to the HOP relay ${conn.remotePeer.toString()}`)
|
||||||
|
console.log(`Advertising with a relay address of ${node.multiaddrs[0].toString()}/p2p/${node.peerId.toB58String()}`)
|
||||||
```
|
```
|
||||||
|
|
||||||
As you can see in the code, we need to provide the relay address, `relayAddr`, as a process argument. This node will dial the provided relay address and automatically bind to it.
|
As you can see in the code, we need to provide the relay address, `relayAddr`, as a process argument. This node will dial the provided relay address and automatically bind to it.
|
||||||
@ -134,20 +145,22 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const Websockets = require('libp2p-websockets')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('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 createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [new WebSockets()],
|
modules: {
|
||||||
connectionEncryption: [new Noise()],
|
transport: [Websockets],
|
||||||
streamMuxers: [new Mplex()]
|
connEncryption: [NOISE],
|
||||||
|
streamMuxer: [MPLEX]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -176,4 +189,4 @@ As you can see from the output, the remote address of the established connection
|
|||||||
|
|
||||||
Before moving into production, there are a few things that you should take into account.
|
Before moving into production, there are a few things that you should take into account.
|
||||||
|
|
||||||
A relay node should not advertise its private address in a real world scenario, as the node would not be reachable by others. You should provide an array of public addresses in the libp2p `addresses.announce` option. If you are using websockets, bear in mind that due to browser’s security policies you cannot establish unencrypted connection from secure context. The simplest solution is to setup SSL with nginx and proxy to the node and setup a domain name for the certificate.
|
A relay node should not advertise its private address in a real world scenario, as the node would not be reachable by others. You should provide an array of public addresses in the libp2p `addresses.announce` option. If you are using websockets, bear in mind that due to browser’s security policies you cannot establish unencrypted connection from secure context. The simplest solution is to setup SSL with nginx and proxy to the node and setup a domain name for the certificate.
|
||||||
|
@ -1,7 +1,9 @@
|
|||||||
import { createLibp2p } from 'libp2p'
|
'use strict'
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const Libp2p = require('libp2p')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Websockets = require('libp2p-websockets')
|
||||||
|
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]
|
||||||
@ -9,20 +11,16 @@ 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 createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [
|
modules: {
|
||||||
new WebSockets()
|
transport: [Websockets],
|
||||||
],
|
connEncryption: [NOISE],
|
||||||
connectionEncryption: [
|
streamMuxer: [MPLEX]
|
||||||
new Noise()
|
}
|
||||||
],
|
|
||||||
streamMuxers: [
|
|
||||||
new Mplex()
|
|
||||||
]
|
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
console.log(`Node started with id ${node.peerId.toString()}`)
|
console.log(`Node started with id ${node.peerId.toB58String()}`)
|
||||||
|
|
||||||
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()}`)
|
||||||
|
@ -1,7 +1,9 @@
|
|||||||
import { createLibp2p } from 'libp2p'
|
'use strict'
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const Libp2p = require('libp2p')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Websockets = require('libp2p-websockets')
|
||||||
|
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]
|
||||||
@ -9,41 +11,37 @@ 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 createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [
|
modules: {
|
||||||
new WebSockets()
|
transport: [Websockets],
|
||||||
],
|
connEncryption: [NOISE],
|
||||||
connectionEncryption: [
|
streamMuxer: [MPLEX]
|
||||||
new Noise()
|
},
|
||||||
],
|
config: {
|
||||||
streamMuxers: [
|
relay: {
|
||||||
new Mplex()
|
|
||||||
],
|
|
||||||
relay: {
|
|
||||||
enabled: true,
|
|
||||||
autoRelay: {
|
|
||||||
enabled: true,
|
enabled: true,
|
||||||
maxListeners: 2
|
autoRelay: {
|
||||||
|
enabled: true,
|
||||||
|
maxListeners: 2
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
console.log(`Node started with id ${node.peerId.toString()}`)
|
console.log(`Node started with id ${node.peerId.toB58String()}`)
|
||||||
|
|
||||||
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.addEventListener('change:multiaddrs', (evt) => {
|
node.peerStore.on('change:multiaddrs', ({ peerId }) => {
|
||||||
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.getMultiaddrs()[0].toString()}`)
|
console.log(`Advertising with a relay address of ${node.multiaddrs[0].toString()}/p2p/${node.peerId.toB58String()}`)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
main()
|
main()
|
||||||
|
@ -1,40 +1,40 @@
|
|||||||
import { createLibp2p } from 'libp2p'
|
'use strict'
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const Libp2p = require('libp2p')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Websockets = require('libp2p-websockets')
|
||||||
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
|
const MPLEX = require('libp2p-mplex')
|
||||||
|
|
||||||
async function main () {
|
async function main () {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
|
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']
|
||||||
},
|
},
|
||||||
transports: [
|
config: {
|
||||||
new WebSockets()
|
relay: {
|
||||||
],
|
|
||||||
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.toString()}`)
|
console.log(`Node started with id ${node.peerId.toB58String()}`)
|
||||||
console.log('Listening on:')
|
console.log('Listening on:')
|
||||||
node.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
|
node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`))
|
||||||
}
|
}
|
||||||
|
|
||||||
main()
|
main()
|
||||||
|
@ -1,10 +1,9 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import execa from 'execa'
|
|
||||||
import pDefer from 'p-defer'
|
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
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], {
|
||||||
@ -13,7 +12,7 @@ function startProcess (name, args = []) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function test () {
|
async function test () {
|
||||||
let output1 = ''
|
let output1 = ''
|
||||||
let output2 = ''
|
let output2 = ''
|
||||||
let output3 = ''
|
let output3 = ''
|
||||||
@ -51,7 +50,7 @@ export 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].trim()
|
autoRelayAddr = output2.trim().split('Advertising with a relay address of ')[1]
|
||||||
proc2Ready.resolve()
|
proc2Ready.resolve()
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@ -91,3 +90,5 @@ export async function test () {
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
@ -1,16 +1,15 @@
|
|||||||
|
'use strict'
|
||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
|
||||||
import { Multiaddr } from '@multiformats/multiaddr'
|
const PeerId = require('peer-id')
|
||||||
import { createLibp2p } from './libp2p.js'
|
const { Multiaddr } = require('multiaddr')
|
||||||
import { stdinToStream, streamToConsole } from './stream.js'
|
const createLibp2p = require('./libp2p')
|
||||||
import { createFromJSON } from '@libp2p/peer-id-factory'
|
const { stdinToStream, streamToConsole } = require('./stream')
|
||||||
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([
|
||||||
createFromJSON(peerIdDialerJson),
|
PeerId.createFromJSON(require('./peer-id-dialer')),
|
||||||
createFromJSON(peerIdListenerJson)
|
PeerId.createFromJSON(require('./peer-id-listener'))
|
||||||
])
|
])
|
||||||
|
|
||||||
// Create a new libp2p node on localhost with a randomly chosen port
|
// Create a new libp2p node on localhost with a randomly chosen port
|
||||||
@ -26,12 +25,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.getMultiaddrs().forEach((ma) => {
|
nodeDialer.multiaddrs.forEach((ma) => {
|
||||||
console.log(ma.toString())
|
console.log(ma.toString() + '/p2p/' + idDialer.toB58String())
|
||||||
})
|
})
|
||||||
|
|
||||||
// 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.toString()}`)
|
const listenerMa = new Multiaddr(`/ip4/127.0.0.1/tcp/10333/p2p/${idListener.toB58String()}`)
|
||||||
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')
|
||||||
|
@ -1,23 +1,22 @@
|
|||||||
import { TCP } from '@libp2p/tcp'
|
'use strict'
|
||||||
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'
|
|
||||||
|
|
||||||
export async function createLibp2p(_options) {
|
const TCP = require('libp2p-tcp')
|
||||||
|
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 = {
|
||||||
transports: [
|
modules: {
|
||||||
new TCP(),
|
transport: [TCP, WS],
|
||||||
new WebSockets()
|
streamMuxer: [mplex],
|
||||||
],
|
connEncryption: [NOISE],
|
||||||
streamMuxers: [
|
},
|
||||||
new Mplex()
|
|
||||||
],
|
|
||||||
connectionEncryption: [
|
|
||||||
new Noise()
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return create(defaultsDeep(_options, defaults))
|
return libp2p.create(defaultsDeep(_options, defaults))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = createLibp2p
|
||||||
|
@ -1,13 +1,13 @@
|
|||||||
|
'use strict'
|
||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
|
||||||
import { createLibp2p } from './libp2p.js'
|
const PeerId = require('peer-id')
|
||||||
import { stdinToStream, streamToConsole } from './stream.js'
|
const createLibp2p = require('./libp2p.js')
|
||||||
import { createFromJSON } from '@libp2p/peer-id-factory'
|
const { stdinToStream, streamToConsole } = require('./stream')
|
||||||
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 createFromJSON(peerIdListenerJson)
|
const idListener = await PeerId.createFromJSON(require('./peer-id-listener'))
|
||||||
const nodeListener = await createLibp2p({
|
const nodeListener = await createLibp2p({
|
||||||
peerId: idListener,
|
peerId: idListener,
|
||||||
addresses: {
|
addresses: {
|
||||||
@ -16,9 +16,8 @@ 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.addEventListener('peer:connect', (evt) => {
|
nodeListener.connectionManager.on('peer:connect', (connection) => {
|
||||||
const connection = evt.detail
|
console.log('connected to: ', connection.remotePeer.toB58String())
|
||||||
console.log('connected to: ', connection.remotePeer.toString())
|
|
||||||
})
|
})
|
||||||
|
|
||||||
// Handle messages for the protocol
|
// Handle messages for the protocol
|
||||||
@ -34,8 +33,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.getMultiaddrs().forEach((ma) => {
|
nodeListener.multiaddrs.forEach((ma) => {
|
||||||
console.log(ma.toString())
|
console.log(ma.toString() + '/p2p/' + idListener.toB58String())
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -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="
|
@ -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="
|
@ -1,19 +1,15 @@
|
|||||||
|
'use strict'
|
||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
|
||||||
import { pipe } from 'it-pipe'
|
const pipe = require('it-pipe')
|
||||||
import * as lp from 'it-length-prefixed'
|
const lp = require('it-length-prefixed')
|
||||||
import map from 'it-map'
|
|
||||||
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
||||||
|
|
||||||
export function stdinToStream(stream) {
|
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)
|
||||||
@ -21,14 +17,12 @@ export function stdinToStream(stream) {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
export function streamToConsole(stream) {
|
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
|
||||||
@ -39,3 +33,8 @@ export function streamToConsole(stream) {
|
|||||||
}
|
}
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
stdinToStream,
|
||||||
|
streamToConsole
|
||||||
|
}
|
||||||
|
@ -1,10 +1,9 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import execa from 'execa'
|
|
||||||
import pDefer from 'p-defer'
|
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
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)], {
|
||||||
@ -13,7 +12,7 @@ function startProcess(name) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function test () {
|
async function test () {
|
||||||
const message = 'test message'
|
const message = 'test message'
|
||||||
let listenerOutput = ''
|
let listenerOutput = ''
|
||||||
let dialerOutput = ''
|
let dialerOutput = ''
|
||||||
@ -74,3 +73,5 @@ export async function test () {
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,19 +1,22 @@
|
|||||||
import { createLibp2p } from '../../dist/src/index.js'
|
'use strict'
|
||||||
import { TCP } from '@libp2p/tcp'
|
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Libp2p = require('../..')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const TCP = require('libp2p-tcp')
|
||||||
import { pipe } from 'it-pipe'
|
const Mplex = require('libp2p-mplex')
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
|
||||||
|
const pipe = require('it-pipe')
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()]
|
streamMuxer: [Mplex],
|
||||||
|
connEncryption: [NOISE]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -27,14 +30,14 @@ const createNode = async () => {
|
|||||||
createNode()
|
createNode()
|
||||||
])
|
])
|
||||||
|
|
||||||
await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
|
|
||||||
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(uint8ArrayToString(msg))
|
console.log(msg.toString())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@ -43,7 +46,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(
|
||||||
[uint8ArrayFromString('This information is sent out encrypted to the other peer')],
|
['This information is sent out encrypted to the other peer'],
|
||||||
stream
|
stream
|
||||||
)
|
)
|
||||||
})();
|
})();
|
||||||
|
@ -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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = () => {
|
||||||
return await createLibp2p({
|
return Libp2p.create({
|
||||||
transports: [ new TCP() ],
|
modules: {
|
||||||
streamMuxers: [ new Mplex() ],
|
transport: [ TCP ],
|
||||||
// Attach noise as the crypto channel to use
|
streamMuxer: [ Mplex ],
|
||||||
conectionEncrypters: [ new Noise() ]
|
// Attach noise as the crypto channel to use
|
||||||
|
connEncryption: [ NOISE ]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -1,14 +1,30 @@
|
|||||||
|
'use strict'
|
||||||
|
|
||||||
import path from 'path'
|
const path = require('path')
|
||||||
import { waitForOutput } from '../utils.js'
|
const execa = require('execa')
|
||||||
import { fileURLToPath } from 'url'
|
const pDefer = require('p-defer')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
async function test () {
|
||||||
|
const messageReceived = pDefer()
|
||||||
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')], {
|
const proc = execa('node', [path.join(__dirname, '1.js')], {
|
||||||
cwd: __dirname
|
cwd: path.resolve(__dirname),
|
||||||
|
all: true
|
||||||
})
|
})
|
||||||
|
|
||||||
|
proc.all.on('data', async (data) => {
|
||||||
|
process.stdout.write(data)
|
||||||
|
|
||||||
|
const s = uint8ArrayToString(data)
|
||||||
|
if (s.includes('This information is sent out encrypted to the other peer')) {
|
||||||
|
messageReceived.resolve()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
await messageReceived.promise
|
||||||
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -3,18 +3,19 @@
|
|||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@chainsafe/libp2p-noise": "^6.2.0",
|
"ipfs": "~0.34.4",
|
||||||
"ipfs-core": "^0.14.1",
|
"libp2p": "github:libp2p/js-libp2p#master",
|
||||||
"libp2p": "../../",
|
"libp2p-delegated-content-routing": "~0.2.2",
|
||||||
"@libp2p/delegated-content-routing": "^1.0.1",
|
"libp2p-delegated-peer-routing": "~0.2.2",
|
||||||
"@libp2p/delegated-peer-routing": "^1.0.1",
|
"libp2p-kad-dht": "~0.14.12",
|
||||||
"@libp2p/kad-dht": "^1.0.9",
|
"libp2p-mplex": "~0.8.5",
|
||||||
"@libp2p/mplex": "^1.0.4",
|
"libp2p-secio": "~0.11.1",
|
||||||
"@libp2p/webrtc-star": "^1.0.8",
|
"libp2p-webrtc-star": "~0.15.8",
|
||||||
"@libp2p/websockets": "^1.0.7",
|
"libp2p-websocket-star": "~0.10.2",
|
||||||
"react": "^17.0.2",
|
"libp2p-websockets": "~0.12.2",
|
||||||
"react-dom": "^17.0.2",
|
"react": "^16.8.6",
|
||||||
"react-scripts": "5.0.0"
|
"react-dom": "^16.8.6",
|
||||||
|
"react-scripts": "2.1.8"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "react-scripts start"
|
"start": "react-scripts start"
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
import React from 'react'
|
import React from 'react'
|
||||||
import Ipfs from 'ipfs-core'
|
import Ipfs from 'ipfs'
|
||||||
import libp2pBundle from './libp2p-bundle'
|
import libp2pBundle from './libp2p-bundle'
|
||||||
const Component = React.Component
|
const Component = React.Component
|
||||||
|
|
||||||
@ -70,7 +70,7 @@ class App extends Component {
|
|||||||
}
|
}
|
||||||
|
|
||||||
componentDidMount () {
|
componentDidMount () {
|
||||||
window.ipfs = this.ipfs = Ipfs.create({
|
window.ipfs = this.ipfs = new Ipfs({
|
||||||
config: {
|
config: {
|
||||||
Addresses: {
|
Addresses: {
|
||||||
Swarm: []
|
Swarm: []
|
||||||
|
@ -1,23 +1,26 @@
|
|||||||
// eslint-disable-next-line
|
// eslint-disable-next-line
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const Websockets = require('libp2p-websockets')
|
||||||
import { WebRTCStar } from '@libp2p/webrtc-star'
|
const WebSocketStar = require('libp2p-websocket-star')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const WebRTCStar = require('libp2p-webrtc-star')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { DelegatedPeerRouting } from '@libp2p/delegated-peer-routing'
|
const SECIO = require('libp2p-secio')
|
||||||
import { DelegatedContentRouting } from '@libp2p/delegated-content-routing'
|
const KadDHT = require('libp2p-kad-dht')
|
||||||
|
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()
|
const wrtcstar = new WebRTCStar({id: peerInfo.id})
|
||||||
|
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 createLibp2p({
|
return new Libp2p({
|
||||||
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
|
||||||
@ -25,29 +28,48 @@ export default function Libp2pBundle ({peerInfo, peerBook}) {
|
|||||||
maxPeers: 10,
|
maxPeers: 10,
|
||||||
pollInterval: 5000
|
pollInterval: 5000
|
||||||
},
|
},
|
||||||
contentRouting: [
|
modules: {
|
||||||
new DelegatedPeerRouting(peerInfo.id, delegatedApiOptions)
|
contentRouting: [
|
||||||
],
|
new DelegatedContentRouter(peerInfo.id, delegatedApiOptions)
|
||||||
peerRouting: [
|
],
|
||||||
new DelegatedContentRouting(delegatedApiOptions)
|
peerRouting: [
|
||||||
],
|
new DelegatedPeerRouter(delegatedApiOptions)
|
||||||
transports: [
|
],
|
||||||
wrtcstar,
|
peerDiscovery: [
|
||||||
new WebSockets()
|
wrtcstar.discovery,
|
||||||
],
|
wsstar.discovery
|
||||||
streamMuxers: [
|
],
|
||||||
new Mplex()
|
transport: [
|
||||||
],
|
wrtcstar,
|
||||||
connectionEncryption: [
|
wsstar,
|
||||||
new Noise()
|
Websockets
|
||||||
],
|
],
|
||||||
connectionManager: {
|
streamMuxer: [
|
||||||
autoDial: false
|
MPLEX
|
||||||
|
],
|
||||||
|
connEncryption: [
|
||||||
|
SECIO
|
||||||
|
],
|
||||||
|
dht: KadDHT
|
||||||
},
|
},
|
||||||
relay: {
|
config: {
|
||||||
enabled: true,
|
peerDiscovery: {
|
||||||
hop: {
|
autoDial: false,
|
||||||
|
webrtcStar: {
|
||||||
|
enabled: false
|
||||||
|
},
|
||||||
|
websocketStar: {
|
||||||
|
enabled: false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
dht: {
|
||||||
enabled: false
|
enabled: false
|
||||||
|
},
|
||||||
|
relay: {
|
||||||
|
enabled: true,
|
||||||
|
hop: {
|
||||||
|
enabled: false
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
@ -1,37 +1,43 @@
|
|||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('../../')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
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')
|
||||||
import bootstrapers from './bootstrappers.js'
|
|
||||||
|
const bootstrapers = require('./bootstrapers')
|
||||||
|
|
||||||
;(async () => {
|
;(async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [Mplex],
|
||||||
peerDiscovery: [
|
connEncryption: [NOISE],
|
||||||
new Bootstrap({
|
peerDiscovery: [Bootstrap]
|
||||||
interval: 60e3,
|
},
|
||||||
list: bootstrapers
|
config: {
|
||||||
})
|
peerDiscovery: {
|
||||||
]
|
bootstrap: {
|
||||||
|
interval: 60e3,
|
||||||
|
enabled: true,
|
||||||
|
list: bootstrapers
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
node.connectionManager.addEventListener('peer:connect', (evt) => {
|
node.connectionManager.on('peer:connect', (connection) => {
|
||||||
const connection = evt.detail
|
console.log('Connection established to:', connection.remotePeer.toB58String()) // Emitted when a peer has been found
|
||||||
console.log('Connection established to:', connection.remotePeer.toString()) // Emitted when a peer has been found
|
|
||||||
})
|
})
|
||||||
|
|
||||||
node.addEventListener('peer:discovery', (evt) => {
|
node.on('peer:discovery', (peerId) => {
|
||||||
const peer = evt.detail
|
|
||||||
// No need to dial, autoDial is on
|
// No need to dial, autoDial is on
|
||||||
console.log('Discovered:', peer.id.toString())
|
console.log('Discovered:', peerId.toB58String())
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
|
@ -1,30 +1,31 @@
|
|||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('../../')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Mplex = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { MulticastDNS } from '@libp2p/mdns'
|
const MulticastDNS = require('libp2p-mdns')
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [
|
modules: {
|
||||||
new TCP()
|
transport: [TCP],
|
||||||
],
|
streamMuxer: [Mplex],
|
||||||
streamMuxers: [
|
connEncryption: [NOISE],
|
||||||
new Mplex()
|
peerDiscovery: [MulticastDNS]
|
||||||
],
|
},
|
||||||
connectionEncryption: [
|
config: {
|
||||||
new Noise()
|
peerDiscovery: {
|
||||||
],
|
[MulticastDNS.tag]: {
|
||||||
peerDiscovery: [
|
interval: 20e3,
|
||||||
new MulticastDNS({
|
enabled: true
|
||||||
interval: 20e3
|
}
|
||||||
})
|
}
|
||||||
]
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
return node
|
return node
|
||||||
@ -36,8 +37,8 @@ const createNode = async () => {
|
|||||||
createNode()
|
createNode()
|
||||||
])
|
])
|
||||||
|
|
||||||
node1.addEventListener('peer:discovery', (evt) => console.log('Discovered:', evt.detail.id.toString()))
|
node1.on('peer:discovery', (peerId) => console.log('Discovered:', peerId.toB58String()))
|
||||||
node2.addEventListener('peer:discovery', (evt) => console.log('Discovered:', evt.detail.id.toString()))
|
node2.on('peer:discovery', (peerId) => console.log('Discovered:', peerId.toB58String()))
|
||||||
|
|
||||||
await Promise.all([
|
await Promise.all([
|
||||||
node1.start(),
|
node1.start(),
|
||||||
|
@ -1,78 +1,66 @@
|
|||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('../../')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Mplex = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { FloodSub } from '@libp2p/floodsub'
|
const Gossipsub = require('libp2p-gossipsub')
|
||||||
import { Bootstrap } from '@libp2p/bootstrap'
|
const Bootstrap = require('libp2p-bootstrap')
|
||||||
import { PubSubPeerDiscovery } from '@libp2p/pubsub-peer-discovery'
|
const PubsubPeerDiscovery = require('libp2p-pubsub-peer-discovery')
|
||||||
|
|
||||||
const createNode = async (bootstrappers) => {
|
const createRelayServer = require('libp2p-relay-server')
|
||||||
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']
|
||||||
},
|
},
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [Mplex],
|
||||||
pubsub: new FloodSub(),
|
connEncryption: [NOISE],
|
||||||
peerDiscovery: [
|
pubsub: Gossipsub,
|
||||||
new Bootstrap({
|
peerDiscovery: [Bootstrap, PubsubPeerDiscovery]
|
||||||
list: bootstrappers
|
},
|
||||||
}),
|
config: {
|
||||||
new PubSubPeerDiscovery({
|
peerDiscovery: {
|
||||||
interval: 1000
|
[PubsubPeerDiscovery.tag]: {
|
||||||
})
|
interval: 1000,
|
||||||
]
|
enabled: true
|
||||||
|
},
|
||||||
|
[Bootstrap.tag]: {
|
||||||
|
enabled: true,
|
||||||
|
list: bootstrapers
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
return node
|
return node
|
||||||
}
|
}
|
||||||
|
|
||||||
;(async () => {
|
;(async () => {
|
||||||
const relay = await createLibp2p({
|
const relay = await createRelayServer({
|
||||||
addresses: {
|
listenAddresses: ['/ip4/0.0.0.0/tcp/0']
|
||||||
listen: [
|
|
||||||
'/ip4/0.0.0.0/tcp/0'
|
|
||||||
]
|
|
||||||
},
|
|
||||||
transports: [new TCP()],
|
|
||||||
streamMuxers: [new Mplex()],
|
|
||||||
connectionEncryption: [new Noise()],
|
|
||||||
pubsub: new FloodSub(),
|
|
||||||
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.toString()}`)
|
console.log(`libp2p relay starting with id: ${relay.peerId.toB58String()}`)
|
||||||
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.addEventListener('peer:discovery', (evt) => {
|
node1.on('peer:discovery', (peerId) => {
|
||||||
const peer = evt.detail
|
console.log(`Peer ${node1.peerId.toB58String()} discovered: ${peerId.toB58String()}`)
|
||||||
console.log(`Peer ${node1.peerId.toString()} discovered: ${peer.id.toString()}`)
|
|
||||||
})
|
})
|
||||||
node2.addEventListener('peer:discovery',(evt) => {
|
node2.on('peer:discovery', (peerId) => {
|
||||||
const peer = evt.detail
|
console.log(`Peer ${node2.peerId.toB58String()} discovered: ${peerId.toB58String()}`)
|
||||||
console.log(`Peer ${node2.peerId.toString()} discovered: ${peer.id.toString()}`)
|
|
||||||
})
|
})
|
||||||
|
|
||||||
;[node1, node2].forEach((node, index) => console.log(`Node ${index} starting with id: ${node.peerId.toString()}`))
|
;[node1, node2].forEach((node, index) => console.log(`Node ${index} starting with id: ${node.peerId.toB58String()}`))
|
||||||
await Promise.all([
|
await Promise.all([
|
||||||
node1.start(),
|
node1.start(),
|
||||||
node2.start()
|
node2.start()
|
||||||
|
@ -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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { Bootstrap } from '@libp2p/bootstrap'
|
const Bootstrap = require('libp2p-bootstrap')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
transports: [
|
modules: {
|
||||||
new TCP()
|
transport: [ TCP ],
|
||||||
],
|
streamMuxer: [ Mplex ],
|
||||||
streamMuxers: [
|
connEncryption: [ NOISE ],
|
||||||
new Mplex()
|
peerDiscovery: [ Bootstrap ]
|
||||||
],
|
},
|
||||||
connectionEncryption: [
|
config: {
|
||||||
new Noise()
|
peerDiscovery: {
|
||||||
],
|
bootstrap: {
|
||||||
peerDiscovery: [
|
interval: 60e3,
|
||||||
new Bootstrap({
|
enabled: true,
|
||||||
interval: 60e3,
|
list: bootstrapers
|
||||||
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 createLibp2p({
|
const node = await Libp2p.create({
|
||||||
peerId,
|
peerId,
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
|
}
|
||||||
|
modules: {
|
||||||
|
transport: [ TCP ],
|
||||||
|
streamMuxer: [ Mplex ],
|
||||||
|
connEncryption: [ NOISE ],
|
||||||
|
peerDiscovery: [ Bootstrap ]
|
||||||
},
|
},
|
||||||
transports: [
|
config: {
|
||||||
new TCP()
|
peerDiscovery: {
|
||||||
],
|
bootstrap: {
|
||||||
streamMuxers: [
|
interval: 60e3,
|
||||||
new Mplex()
|
enabled: true,
|
||||||
],
|
list: bootstrapers
|
||||||
connectionEncryption: [
|
}
|
||||||
new Noise()
|
}
|
||||||
],
|
}
|
||||||
peerDiscovery: [
|
|
||||||
new Bootstrap({
|
|
||||||
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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { MulticastDNS } from '@libp2p/mdns'
|
const MulticastDNS = require('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: {
|
||||||
|
transport: [ TCP ],
|
||||||
|
streamMuxer: [ Mplex ],
|
||||||
|
connEncryption: [ NOISE ],
|
||||||
|
peerDiscovery: [ MulticastDNS ]
|
||||||
},
|
},
|
||||||
transports: [
|
config: {
|
||||||
new TCP()
|
peerDiscovery: {
|
||||||
],
|
mdns: {
|
||||||
streamMuxers: [
|
interval: 20e3,
|
||||||
new Mplex()
|
enabled: true
|
||||||
],
|
}
|
||||||
connectionEncryption: [
|
}
|
||||||
new Noise()
|
}
|
||||||
],
|
|
||||||
peerDiscovery: [
|
|
||||||
new MulticastDNS({
|
|
||||||
interval: 20e3
|
|
||||||
})
|
|
||||||
]
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@ -144,13 +144,8 @@ const [node1, node2] = await Promise.all([
|
|||||||
createNode()
|
createNode()
|
||||||
])
|
])
|
||||||
|
|
||||||
node1.on('peer:discovery', (peer) => console.log('Discovered:', peerId.toB58String()))
|
node1.on('peer:discovery', (peer) => console.log('Discovered:', peer.id.toB58String()))
|
||||||
node2.on('peer:discovery', (peer) => console.log('Discovered:', peerId.toB58String()))
|
node2.on('peer:discovery', (peer) => console.log('Discovered:', peer.id.toB58String()))
|
||||||
|
|
||||||
await Promise.all([
|
|
||||||
node1.start(),
|
|
||||||
node2.start()
|
|
||||||
])
|
|
||||||
```
|
```
|
||||||
|
|
||||||
If you run this example, you will see the other peers being discovered.
|
If you run this example, you will see the other peers being discovered.
|
||||||
@ -170,37 +165,39 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Mplex = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { Gossipsub } from 'libp2p-gossipsub'
|
const Gossipsub = require('libp2p-gossipsub')
|
||||||
import { Bootstrap } from '@libp2p/bootstrap'
|
const Bootstrap = require('libp2p-bootstrap')
|
||||||
const PubsubPeerDiscovery from 'libp2p-pubsub-peer-discovery')
|
const PubsubPeerDiscovery = require('libp2p-pubsub-peer-discovery')
|
||||||
|
|
||||||
const createNode = async (bootstrapers) => {
|
const createNode = async (bootstrapers) => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [
|
modules: {
|
||||||
new TCP()
|
transport: [TCP],
|
||||||
],
|
streamMuxer: [Mplex],
|
||||||
streamMuxers: [
|
connEncryption: [NOISE],
|
||||||
new Mplex()
|
pubsub: Gossipsub,
|
||||||
],
|
peerDiscovery: [Bootstrap, PubsubPeerDiscovery]
|
||||||
connectionEncryption: [
|
},
|
||||||
new Noise()
|
config: {
|
||||||
],
|
peerDiscovery: {
|
||||||
peerDiscovery: [
|
[PubsubPeerDiscovery.tag]: {
|
||||||
new Bootstrap({
|
interval: 1000,
|
||||||
interval: 60e3,
|
enabled: true
|
||||||
list: bootstrapers
|
},
|
||||||
}),
|
[Bootstrap.tag]: {
|
||||||
new PubsubPeerDiscovery({
|
enabled: true,
|
||||||
interval: 1000
|
list: bootstrapers
|
||||||
})
|
}
|
||||||
])
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
return node
|
return node
|
||||||
}
|
}
|
||||||
@ -210,9 +207,7 @@ 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({
|
||||||
addresses: {
|
listenAddresses: ['/ip4/0.0.0.0/tcp/0']
|
||||||
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()
|
||||||
|
@ -1,9 +1,13 @@
|
|||||||
// Find this list at: https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core-config/src/config.js
|
'use strict'
|
||||||
export default [
|
|
||||||
|
// Find this list at: https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core/src/runtime/config-nodejs.js
|
||||||
|
const bootstrapers = [
|
||||||
'/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',
|
||||||
'/dnsaddr/bootstrap.libp2p.io/p2p/QmZa1sAxajnQjVM8WjWXoMbmPd7NsWhfKsPkErzpm9wGkp',
|
'/dnsaddr/bootstrap.libp2p.io/p2p/QmZa1sAxajnQjVM8WjWXoMbmPd7NsWhfKsPkErzpm9wGkp',
|
||||||
'/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
|
@ -1,13 +1,42 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import { waitForOutput } from '../utils.js'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pWaitFor = require('p-wait-for')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
const bootstrapers = require('./bootstrapers')
|
||||||
|
|
||||||
|
const discoveredCopy = 'Discovered:'
|
||||||
|
const connectedCopy = 'Connection established to:'
|
||||||
|
|
||||||
|
async function test () {
|
||||||
|
const discoveredNodes = []
|
||||||
|
const connectedNodes = []
|
||||||
|
|
||||||
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')], {
|
const proc = execa('node', [path.join(__dirname, '1.js')], {
|
||||||
cwd: __dirname
|
cwd: path.resolve(__dirname),
|
||||||
|
all: true
|
||||||
})
|
})
|
||||||
|
|
||||||
|
proc.all.on('data', async (data) => {
|
||||||
|
process.stdout.write(data)
|
||||||
|
const line = uint8ArrayToString(data)
|
||||||
|
|
||||||
|
// Discovered or Connected
|
||||||
|
if (line.includes(discoveredCopy)) {
|
||||||
|
const id = line.trim().split(discoveredCopy)[1]
|
||||||
|
discoveredNodes.push(id)
|
||||||
|
} else if (line.includes(connectedCopy)) {
|
||||||
|
const id = line.trim().split(connectedCopy)[1]
|
||||||
|
connectedNodes.push(id)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
await pWaitFor(() => discoveredNodes.length === bootstrapers.length && connectedNodes.length === bootstrapers.length)
|
||||||
|
|
||||||
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,13 +1,14 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import execa from 'execa'
|
|
||||||
import pWaitFor from 'p-wait-for'
|
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pWaitFor = require('p-wait-for')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
export async function test () {
|
const discoveredCopy = 'Discovered:'
|
||||||
let discoveredNodes = 0
|
|
||||||
|
async function test() {
|
||||||
|
const discoveredNodes = []
|
||||||
|
|
||||||
process.stdout.write('2.js\n')
|
process.stdout.write('2.js\n')
|
||||||
|
|
||||||
@ -18,16 +19,17 @@ export async function test () {
|
|||||||
|
|
||||||
proc.all.on('data', async (data) => {
|
proc.all.on('data', async (data) => {
|
||||||
process.stdout.write(data)
|
process.stdout.write(data)
|
||||||
const str = uint8ArrayToString(data)
|
const line = uint8ArrayToString(data)
|
||||||
|
|
||||||
str.split('\n').forEach(line => {
|
if (line.includes(discoveredCopy)) {
|
||||||
if (line.includes('Discovered:')) {
|
const id = line.trim().split(discoveredCopy)[1]
|
||||||
discoveredNodes++
|
discoveredNodes.push(id)
|
||||||
}
|
}
|
||||||
})
|
|
||||||
})
|
})
|
||||||
|
|
||||||
await pWaitFor(() => discoveredNodes > 1)
|
await pWaitFor(() => discoveredNodes.length === 2)
|
||||||
|
|
||||||
proc.kill()
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,13 +1,14 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import execa from 'execa'
|
|
||||||
import pWaitFor from 'p-wait-for'
|
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pWaitFor = require('p-wait-for')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
export async function test () {
|
const discoveredCopy = 'discovered:'
|
||||||
let discoveredNodes = 0
|
|
||||||
|
async function test() {
|
||||||
|
let discoverCount = 0
|
||||||
|
|
||||||
process.stdout.write('3.js\n')
|
process.stdout.write('3.js\n')
|
||||||
|
|
||||||
@ -18,16 +19,17 @@ export async function test () {
|
|||||||
|
|
||||||
proc.all.on('data', async (data) => {
|
proc.all.on('data', async (data) => {
|
||||||
process.stdout.write(data)
|
process.stdout.write(data)
|
||||||
const str = uint8ArrayToString(data)
|
const line = uint8ArrayToString(data)
|
||||||
|
|
||||||
str.split('\n').forEach(line => {
|
// Discovered or Connected
|
||||||
if (line.includes('discovered:')) {
|
if (line.includes(discoveredCopy)) {
|
||||||
discoveredNodes++
|
discoverCount++
|
||||||
}
|
}
|
||||||
})
|
|
||||||
})
|
})
|
||||||
|
|
||||||
await pWaitFor(() => discoveredNodes > 3)
|
await pWaitFor(() => discoverCount === 4)
|
||||||
|
|
||||||
proc.kill()
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,9 +1,13 @@
|
|||||||
import { test as test1 } from './test-1.js'
|
'use strict'
|
||||||
import { test as test2 } from './test-2.js'
|
|
||||||
import { test as test3 } from './test-3.js'
|
|
||||||
|
|
||||||
export async function test () {
|
const test1 = require('./test-1')
|
||||||
|
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
|
||||||
|
@ -1,21 +1,18 @@
|
|||||||
|
'use strict'
|
||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Dialer Node
|
* Dialer Node
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { createLibp2p } from './libp2p.js'
|
const PeerId = require('peer-id')
|
||||||
import { pipe } from 'it-pipe'
|
const createLibp2p = require('./libp2p')
|
||||||
import idd from './id-d.js'
|
const pipe = require('it-pipe')
|
||||||
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([
|
||||||
createFromJSON(idd),
|
PeerId.createFromJSON(require('./id-d')),
|
||||||
createFromJSON(idl)
|
PeerId.createFromJSON(require('./id-l'))
|
||||||
])
|
])
|
||||||
|
|
||||||
// Dialer
|
// Dialer
|
||||||
@ -27,13 +24,14 @@ 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.toString()
|
const listenerMultiaddr = '/ip4/127.0.0.1/tcp/10333/p2p/' + listenerId.toB58String()
|
||||||
|
|
||||||
// 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.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
|
dialerNode.multiaddrs.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)
|
||||||
@ -43,7 +41,7 @@ async function run() {
|
|||||||
|
|
||||||
pipe(
|
pipe(
|
||||||
// Source data
|
// Source data
|
||||||
[uint8ArrayFromString('hey')],
|
['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
|
||||||
@ -51,7 +49,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:', uint8ArrayToString(data))
|
console.log('received echo:', data.toString())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
@ -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="
|
@ -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="
|
@ -1,23 +1,23 @@
|
|||||||
import { TCP } from '@libp2p/tcp'
|
'use strict'
|
||||||
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'
|
|
||||||
|
|
||||||
export async function createLibp2p(_options) {
|
const TCP = require('libp2p-tcp')
|
||||||
|
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 = {
|
||||||
transports: [
|
modules: {
|
||||||
new TCP(),
|
transport: [TCP, WS],
|
||||||
new WebSockets()
|
streamMuxer: [mplex],
|
||||||
],
|
connEncryption: [NOISE],
|
||||||
streamMuxers: [
|
},
|
||||||
new Mplex()
|
|
||||||
],
|
|
||||||
connectionEncryption: [
|
|
||||||
new Noise()
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return createNode(defaultsDeep(_options, defaults))
|
return libp2p.create(defaultsDeep(_options, defaults))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = createLibp2p
|
||||||
|
@ -1,16 +1,16 @@
|
|||||||
|
'use strict'
|
||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Listener Node
|
* Listener Node
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { createLibp2p } from './libp2p.js'
|
const PeerId = require('peer-id')
|
||||||
import { pipe } from 'it-pipe'
|
const createLibp2p = require('./libp2p')
|
||||||
import { createFromJSON } from '@libp2p/peer-id-factory'
|
const pipe = require('it-pipe')
|
||||||
import idl from './id-l.js'
|
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const listenerId = await createFromJSON(idl)
|
const listenerId = await PeerId.createFromJSON(require('./id-l'))
|
||||||
|
|
||||||
// Listener libp2p node
|
// Listener libp2p node
|
||||||
const listenerNode = await createLibp2p({
|
const listenerNode = await createLibp2p({
|
||||||
@ -21,9 +21,8 @@ async function run() {
|
|||||||
})
|
})
|
||||||
|
|
||||||
// Log a message when we receive a connection
|
// Log a message when we receive a connection
|
||||||
listenerNode.connectionManager.addEventListener('peer:connect', (evt) => {
|
listenerNode.connectionManager.on('peer:connect', (connection) => {
|
||||||
const connection = evt.detail
|
console.log('received dial to me from:', connection.remotePeer.toB58String())
|
||||||
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
|
||||||
@ -34,8 +33,8 @@ async function run() {
|
|||||||
await listenerNode.start()
|
await listenerNode.start()
|
||||||
|
|
||||||
console.log('Listener ready, listening on:')
|
console.log('Listener ready, listening on:')
|
||||||
listenerNode.getMultiaddrs().forEach((ma) => {
|
listenerNode.multiaddrs.forEach((ma) => {
|
||||||
console.log(ma.toString())
|
console.log(ma.toString() + '/p2p/' + listenerId.toB58String())
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,10 +1,9 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import execa from 'execa'
|
|
||||||
import pDefer from 'p-defer'
|
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
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)], {
|
||||||
@ -13,7 +12,7 @@ function startProcess(name) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function test () {
|
async function test () {
|
||||||
const listenerReady = pDefer()
|
const listenerReady = pDefer()
|
||||||
const messageReceived = pDefer()
|
const messageReceived = pDefer()
|
||||||
|
|
||||||
@ -58,3 +57,5 @@ export async function test () {
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
4
examples/libp2p-in-the-browser/.babelrc
Normal file
4
examples/libp2p-in-the-browser/.babelrc
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"presets": ["@babel/preset-env"],
|
||||||
|
"plugins": ["syntax-async-functions","transform-regenerator"]
|
||||||
|
}
|
@ -1,15 +1,14 @@
|
|||||||
import { createLibp2p } from 'libp2p'
|
import 'babel-polyfill'
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
import Libp2p from 'libp2p'
|
||||||
import { WebRTCStar } from '@libp2p/webrtc-star'
|
import Websockets from 'libp2p-websockets'
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
import WebRTCStar from 'libp2p-webrtc-star'
|
||||||
import { Mplex } from '@libp2p/mplex'
|
import { NOISE } from '@chainsafe/libp2p-noise'
|
||||||
import { Bootstrap } from '@libp2p/bootstrap'
|
import Mplex from 'libp2p-mplex'
|
||||||
|
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 createLibp2p({
|
const libp2p = await Libp2p.create({
|
||||||
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
|
||||||
@ -19,24 +18,28 @@ 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'
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
transports: [
|
modules: {
|
||||||
new WebSockets(),
|
transport: [Websockets, WebRTCStar],
|
||||||
webRtcStar
|
connEncryption: [NOISE],
|
||||||
],
|
streamMuxer: [Mplex],
|
||||||
connectionEncryption: [new Noise()],
|
peerDiscovery: [Bootstrap]
|
||||||
streamMuxers: [new Mplex()],
|
},
|
||||||
peerDiscovery: [
|
config: {
|
||||||
webRtcStar.discovery,
|
peerDiscovery: {
|
||||||
new Bootstrap({
|
// The `tag` property will be searched when creating the instance of your Peer Discovery service.
|
||||||
list: [
|
// The associated object, will be passed to the service when it is instantiated.
|
||||||
'/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN',
|
[Bootstrap.tag]: {
|
||||||
'/dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb',
|
enabled: true,
|
||||||
'/dnsaddr/bootstrap.libp2p.io/p2p/QmZa1sAxajnQjVM8WjWXoMbmPd7NsWhfKsPkErzpm9wGkp',
|
list: [
|
||||||
'/dnsaddr/bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa',
|
'/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN',
|
||||||
'/dnsaddr/bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt'
|
'/dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb',
|
||||||
]
|
'/dnsaddr/bootstrap.libp2p.io/p2p/QmZa1sAxajnQjVM8WjWXoMbmPd7NsWhfKsPkErzpm9wGkp',
|
||||||
})
|
'/dnsaddr/bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa',
|
||||||
]
|
'/dnsaddr/bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt'
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
// UI elements
|
// UI elements
|
||||||
@ -51,26 +54,23 @@ document.addEventListener('DOMContentLoaded', async () => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Listen for new peers
|
// Listen for new peers
|
||||||
libp2p.addEventListener('peer:discovery', (evt) => {
|
libp2p.on('peer:discovery', (peerId) => {
|
||||||
const peer = evt.detail
|
log(`Found peer ${peerId.toB58String()}`)
|
||||||
log(`Found peer ${peer.id.toString()}`)
|
|
||||||
})
|
})
|
||||||
|
|
||||||
// Listen for new connections to peers
|
// Listen for new connections to peers
|
||||||
libp2p.connectionManager.addEventListener('peer:connect', (evt) => {
|
libp2p.connectionManager.on('peer:connect', (connection) => {
|
||||||
const connection = evt.detail
|
log(`Connected to ${connection.remotePeer.toB58String()}`)
|
||||||
log(`Connected to ${connection.remotePeer.toString()}`)
|
|
||||||
})
|
})
|
||||||
|
|
||||||
// Listen for peers disconnecting
|
// Listen for peers disconnecting
|
||||||
libp2p.connectionManager.addEventListener('peer:disconnect', (evt) => {
|
libp2p.connectionManager.on('peer:disconnect', (connection) => {
|
||||||
const connection = evt.detail
|
log(`Disconnected from ${connection.remotePeer.toB58String()}`)
|
||||||
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.toString()}`)
|
log(`libp2p id is ${libp2p.peerId.toB58String()}`)
|
||||||
|
|
||||||
// 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
|
||||||
|
@ -2,21 +2,32 @@
|
|||||||
"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": [
|
||||||
|
"last 2 Chrome versions"
|
||||||
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "echo \"Error: no test specified\" && exit 1",
|
"test": "echo \"Error: no test specified\" && exit 1",
|
||||||
"start": "vite"
|
"build": "parcel build index.html",
|
||||||
|
"start": "parcel index.html"
|
||||||
},
|
},
|
||||||
|
"keywords": [],
|
||||||
|
"author": "",
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@chainsafe/libp2p-noise": "^6.2.0",
|
"@babel/preset-env": "^7.13.0",
|
||||||
"@libp2p/bootstrap": "^1.0.4",
|
"libp2p": "../../",
|
||||||
"@libp2p/mplex": "^1.0.4",
|
"libp2p-bootstrap": "^0.13.0",
|
||||||
"@libp2p/webrtc-star": "^1.0.8",
|
"libp2p-mplex": "^0.10.4",
|
||||||
"@libp2p/websockets": "^1.0.7",
|
"@chainsafe/libp2p-noise": "^4.1.0",
|
||||||
"libp2p": "../../"
|
"libp2p-webrtc-star": "^0.23.0",
|
||||||
|
"libp2p-websockets": "^0.16.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"vite": "^2.8.6"
|
"@babel/cli": "^7.13.10",
|
||||||
|
"@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": "next"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,14 +1,11 @@
|
|||||||
import execa from 'execa'
|
'use strict'
|
||||||
import { chromium } from 'playwright'
|
|
||||||
import path from 'path'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const execa = require('execa')
|
||||||
|
const { chromium } = require('playwright');
|
||||||
|
|
||||||
export async function test () {
|
async function run() {
|
||||||
let url = 'http://localhost:3000'
|
let url = ''
|
||||||
|
const proc = execa('parcel', ['./index.html'], {
|
||||||
const proc = execa('vite', [], {
|
|
||||||
preferLocal: true,
|
preferLocal: true,
|
||||||
localDir: __dirname,
|
localDir: __dirname,
|
||||||
cwd: __dirname,
|
cwd: __dirname,
|
||||||
@ -19,7 +16,11 @@ export async function test () {
|
|||||||
/**@type {string} */
|
/**@type {string} */
|
||||||
const out = chunk.toString()
|
const out = chunk.toString()
|
||||||
|
|
||||||
if (out.includes('ready in')) {
|
if (out.includes('Server running at')) {
|
||||||
|
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();
|
||||||
@ -35,7 +36,8 @@ export async function test () {
|
|||||||
'#output',
|
'#output',
|
||||||
{ timeout: 5000 }
|
{ timeout: 5000 }
|
||||||
)
|
)
|
||||||
await browser.close()
|
await browser.close();
|
||||||
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
console.error(err)
|
console.error(err)
|
||||||
process.exit(1)
|
process.exit(1)
|
||||||
@ -44,4 +46,7 @@ export async function test () {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = run
|
||||||
|
@ -1,5 +0,0 @@
|
|||||||
export default {
|
|
||||||
build: {
|
|
||||||
target: 'es2020'
|
|
||||||
}
|
|
||||||
}
|
|
@ -2,19 +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": {
|
||||||
"@libp2p/pubsub-peer-discovery": "^5.0.2",
|
|
||||||
"@libp2p/floodsub": "^1.0.6",
|
|
||||||
"@nodeutils/defaults-deep": "^1.1.0",
|
|
||||||
"execa": "^2.1.0",
|
"execa": "^2.1.0",
|
||||||
"fs-extra": "^8.1.0",
|
"fs-extra": "^8.1.0",
|
||||||
"libp2p": "../",
|
"libp2p": "../src",
|
||||||
|
"libp2p-pubsub-peer-discovery": "^4.0.0",
|
||||||
|
"libp2p-relay-server": "^0.3.0",
|
||||||
|
"libp2p-gossipsub": "^0.11.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"
|
||||||
|
@ -1,21 +1,30 @@
|
|||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('../../')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Mplex = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { KadDHT } from '@libp2p/kad-dht'
|
const KadDHT = require('libp2p-kad-dht')
|
||||||
import delay from 'delay'
|
|
||||||
|
const delay = require('delay')
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [Mplex],
|
||||||
dht: new KadDHT()
|
connEncryption: [NOISE],
|
||||||
|
dht: KadDHT
|
||||||
|
},
|
||||||
|
config: {
|
||||||
|
dht: {
|
||||||
|
enabled: true
|
||||||
|
}
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -29,8 +38,8 @@ const createNode = async () => {
|
|||||||
createNode()
|
createNode()
|
||||||
])
|
])
|
||||||
|
|
||||||
await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
await node2.peerStore.addressBook.set(node3.peerId, node3.getMultiaddrs())
|
node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
|
||||||
|
|
||||||
await Promise.all([
|
await Promise.all([
|
||||||
node1.dial(node2.peerId),
|
node1.dial(node2.peerId),
|
||||||
@ -43,5 +52,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()))
|
peer.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${peer.id.toB58String()}`))
|
||||||
})();
|
})();
|
||||||
|
@ -1,23 +1,32 @@
|
|||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('../../')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Mplex = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { CID } from 'multiformats/cid'
|
const { CID } = require('multiformats/cid')
|
||||||
import { KadDHT } from '@libp2p/kad-dht'
|
const KadDHT = require('libp2p-kad-dht')
|
||||||
import all from 'it-all'
|
|
||||||
import delay from 'delay'
|
const all = require('it-all')
|
||||||
|
const delay = require('delay')
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [Mplex],
|
||||||
dht: new KadDHT()
|
connEncryption: [NOISE],
|
||||||
|
dht: KadDHT
|
||||||
|
},
|
||||||
|
config: {
|
||||||
|
dht: {
|
||||||
|
enabled: true
|
||||||
|
}
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -31,8 +40,8 @@ const createNode = async () => {
|
|||||||
createNode()
|
createNode()
|
||||||
])
|
])
|
||||||
|
|
||||||
await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
await node2.peerStore.addressBook.set(node3.peerId, node3.getMultiaddrs())
|
node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
|
||||||
|
|
||||||
await Promise.all([
|
await Promise.all([
|
||||||
node1.dial(node2.peerId),
|
node1.dial(node2.peerId),
|
||||||
@ -45,12 +54,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.toString(), cid.toString())
|
console.log('Node %s is providing %s', node1.peerId.toB58String(), 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.toString())
|
console.log('Found provider:', providers[0].id.toB58String())
|
||||||
})();
|
})();
|
||||||
|
@ -13,24 +13,26 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { KadDHT } from '@libp2p/kad-dht'
|
const KadDHT = require('libp2p-kad-dht')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [
|
modules: {
|
||||||
new TCP()
|
transport: [ TCP ],
|
||||||
],
|
streamMuxer: [ Mplex ],
|
||||||
streamMuxers: [
|
connEncryption: [ NOISE ],
|
||||||
new Mplex()
|
// we add the DHT module that will enable Peer and Content Routing
|
||||||
],
|
dht: KadDHT
|
||||||
connEncryption: [
|
},
|
||||||
new Noise()
|
config: {
|
||||||
],
|
dht: {
|
||||||
// we add the DHT module that will enable Peer and Content Routing
|
// dht must be enabled
|
||||||
dht: KadDHT
|
enabled: true
|
||||||
|
}
|
||||||
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -41,8 +43,8 @@ const node1 = nodes[0]
|
|||||||
const node2 = nodes[1]
|
const node2 = nodes[1]
|
||||||
const node3 = nodes[2]
|
const node3 = nodes[2]
|
||||||
|
|
||||||
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
await node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
|
node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
|
||||||
|
|
||||||
await Promise.all([
|
await Promise.all([
|
||||||
node1.dial(node2.peerId),
|
node1.dial(node2.peerId),
|
||||||
|
@ -1,13 +1,36 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import { waitForOutput } from '../utils.js'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pWaitFor = require('p-wait-for')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
export async function test () {
|
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')], {
|
const addrs = []
|
||||||
cwd: __dirname
|
let foundIt = false
|
||||||
|
const proc = execa('node', [path.join(__dirname, '1.js')], {
|
||||||
|
cwd: path.resolve(__dirname),
|
||||||
|
all: true
|
||||||
})
|
})
|
||||||
|
|
||||||
|
proc.all.on('data', async (data) => {
|
||||||
|
process.stdout.write(data)
|
||||||
|
|
||||||
|
const line = uint8ArrayToString(data)
|
||||||
|
|
||||||
|
// Discovered peer
|
||||||
|
if (!foundIt && line.includes('Found it, multiaddrs are:')) {
|
||||||
|
foundIt = true
|
||||||
|
}
|
||||||
|
|
||||||
|
addrs.push(line)
|
||||||
|
})
|
||||||
|
|
||||||
|
await pWaitFor(() => addrs.length === 2)
|
||||||
|
|
||||||
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,13 +1,40 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import { waitForOutput } from '../utils.js'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pDefer = require('p-defer')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
export async function test () {
|
const providedCopy = 'is providing'
|
||||||
|
const foundCopy = 'Found provider:'
|
||||||
|
|
||||||
|
async function test() {
|
||||||
process.stdout.write('2.js\n')
|
process.stdout.write('2.js\n')
|
||||||
|
const providedDefer = pDefer()
|
||||||
|
const foundDefer = pDefer()
|
||||||
|
|
||||||
await waitForOutput('Found provider:', 'node', [path.join(__dirname, '2.js')], {
|
const proc = execa('node', [path.join(__dirname, '2.js')], {
|
||||||
cwd: __dirname
|
cwd: path.resolve(__dirname),
|
||||||
|
all: true
|
||||||
})
|
})
|
||||||
|
|
||||||
|
proc.all.on('data', async (data) => {
|
||||||
|
process.stdout.write(data)
|
||||||
|
|
||||||
|
const line = uint8ArrayToString(data)
|
||||||
|
|
||||||
|
if (line.includes(providedCopy)) {
|
||||||
|
providedDefer.resolve()
|
||||||
|
} else if (line.includes(foundCopy)) {
|
||||||
|
foundDefer.resolve()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
await Promise.all([
|
||||||
|
providedDefer.promise,
|
||||||
|
foundDefer.promise
|
||||||
|
])
|
||||||
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,7 +1,11 @@
|
|||||||
import { test as test1 } from './test-1.js'
|
'use strict'
|
||||||
import { test as test2 } from './test-2.js'
|
|
||||||
|
|
||||||
export async function test() {
|
const test1 = require('./test-1')
|
||||||
|
const test2 = require('./test-2')
|
||||||
|
|
||||||
|
async function test() {
|
||||||
await test1()
|
await test1()
|
||||||
await test2()
|
await test2()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,18 +1,18 @@
|
|||||||
/* eslint no-console: ["off"] */
|
/* eslint no-console: ["off"] */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { generateKey } from 'libp2p/pnet'
|
const { generate } = require('libp2p/src/pnet')
|
||||||
import { privateLibp2pNode } from './libp2p-node.js'
|
const privateLibp2pNode = require('./libp2p-node')
|
||||||
import { pipe } from 'it-pipe'
|
|
||||||
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
const pipe = require('it-pipe')
|
||||||
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)
|
||||||
generateKey(swarmKey)
|
generate(swarmKey)
|
||||||
|
|
||||||
// This key is for testing a different key not working
|
// This key is for testing a different key not working
|
||||||
const otherSwarmKey = new Uint8Array(95)
|
const otherSwarmKey = new Uint8Array(95)
|
||||||
generateKey(otherSwarmKey)
|
generate(otherSwarmKey)
|
||||||
|
|
||||||
;(async () => {
|
;(async () => {
|
||||||
const node1 = await privateLibp2pNode(swarmKey)
|
const node1 = await privateLibp2pNode(swarmKey)
|
||||||
@ -29,7 +29,7 @@ generateKey(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.getMultiaddrs())
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
await node1.dial(node2.peerId)
|
await node1.dial(node2.peerId)
|
||||||
|
|
||||||
node2.handle('/private', ({ stream }) => {
|
node2.handle('/private', ({ stream }) => {
|
||||||
@ -37,7 +37,7 @@ generateKey(otherSwarmKey)
|
|||||||
stream,
|
stream,
|
||||||
async function (source) {
|
async function (source) {
|
||||||
for await (const msg of source) {
|
for await (const msg of source) {
|
||||||
console.log(uint8ArrayToString(msg))
|
console.log(msg.toString())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@ -46,7 +46,7 @@ generateKey(otherSwarmKey)
|
|||||||
const { stream } = await node1.dialProtocol(node2.peerId, '/private')
|
const { stream } = await node1.dialProtocol(node2.peerId, '/private')
|
||||||
|
|
||||||
await pipe(
|
await pipe(
|
||||||
[uint8ArrayFromString('This message is sent on a private network')],
|
['This message is sent on a private network'],
|
||||||
stream
|
stream
|
||||||
)
|
)
|
||||||
})()
|
})()
|
||||||
|
@ -1,31 +1,38 @@
|
|||||||
import { createLibp2p } from 'libp2p'
|
'use strict'
|
||||||
import { TCP } from '@libp2p/tcp'
|
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Libp2p = require('libp2p')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const TCP = require('libp2p-tcp')
|
||||||
import { PreSharedKeyConnectionProtector } from 'libp2p/pnet'
|
const MPLEX = require('libp2p-mplex')
|
||||||
|
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
|
||||||
*/
|
*/
|
||||||
export async function privateLibp2pNode (swarmKey) {
|
const privateLibp2pNode = async (swarmKey) => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [new TCP()], // We're only using the TCP transport for this example
|
modules: {
|
||||||
streamMuxers: [new Mplex()], // We're only using mplex muxing
|
transport: [TCP], // We're only using the TCP transport for this example
|
||||||
// Let's make sure to use identifying crypto in our pnet since the protector doesn't
|
streamMuxer: [MPLEX], // We're only using mplex muxing
|
||||||
// care about node identity, and only the presence of private keys
|
// Let's make sure to use identifying crypto in our pnet since the protector doesn't
|
||||||
connectionEncryption: [new Noise()],
|
// care about node identity, and only the presence of private keys
|
||||||
// Leave peer discovery empty, we don't want to find peers. We could omit the property, but it's
|
connEncryption: [NOISE],
|
||||||
// being left in for explicit readability.
|
// Leave peer discovery empty, we don't want to find peers. We could omit the property, but it's
|
||||||
// We should explicitly dial pnet peers, or use a custom discovery service for finding nodes in our pnet
|
// being left in for explicit readability.
|
||||||
peerDiscovery: [],
|
// We should explicitly dial pnet peers, or use a custom discovery service for finding nodes in our pnet
|
||||||
connectionProtector: new PreSharedKeyConnectionProtector({
|
peerDiscovery: [],
|
||||||
psk: swarmKey
|
connProtector: new Protector(swarmKey)
|
||||||
})
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
return node
|
return node
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = privateLibp2pNode
|
||||||
|
@ -1,12 +1,30 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import { waitForOutput } from '../utils.js'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pDefer = require('p-defer')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
export async function test () {
|
async function test () {
|
||||||
await waitForOutput('This message is sent on a private network', 'node', [path.join(__dirname, 'index.js')], {
|
const messageReceived = pDefer()
|
||||||
cwd: __dirname
|
process.stdout.write('index.js\n')
|
||||||
|
|
||||||
|
const proc = execa('node', [path.join(__dirname, 'index.js')], {
|
||||||
|
cwd: path.resolve(__dirname),
|
||||||
|
all: true
|
||||||
})
|
})
|
||||||
|
|
||||||
|
proc.all.on('data', async (data) => {
|
||||||
|
process.stdout.write(data)
|
||||||
|
|
||||||
|
const s = uint8ArrayToString(data)
|
||||||
|
if (s.includes('This message is sent on a private network')) {
|
||||||
|
messageReceived.resolve()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
await messageReceived.promise
|
||||||
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
'use strict'
|
'use strict'
|
||||||
const fs from 'fs')
|
const fs = require('fs')
|
||||||
import path from 'path'
|
const path = require('path')
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* mkdirp recursively creates needed folders for the given dir path
|
* mkdirp recursively creates needed folders for the given dir path
|
||||||
|
@ -1,19 +1,22 @@
|
|||||||
import { createLibp2p } from 'libp2p'
|
'use strict'
|
||||||
import { TCP } from '@libp2p/tcp'
|
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Libp2p = require('../../')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const TCP = require('libp2p-tcp')
|
||||||
import { pipe } from 'it-pipe'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
||||||
|
const pipe = require('it-pipe')
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()]
|
streamMuxer: [MPLEX],
|
||||||
|
connEncryption: [NOISE]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -28,7 +31,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.getMultiaddrs())
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
|
|
||||||
// exact matching
|
// exact matching
|
||||||
node2.handle('/your-protocol', ({ stream }) => {
|
node2.handle('/your-protocol', ({ stream }) => {
|
||||||
@ -36,7 +39,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(uint8ArrayToString(msg))
|
console.log(msg.toString())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@ -53,7 +56,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(uint8ArrayToString(msg))
|
console.log(msg.toString())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@ -62,7 +65,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(
|
||||||
[uint8ArrayFromString('my own protocol, wow!')],
|
['my own protocol, wow!'],
|
||||||
stream
|
stream
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -1,19 +1,22 @@
|
|||||||
import { createLibp2p } from 'libp2p'
|
'use strict'
|
||||||
import { TCP } from '@libp2p/tcp'
|
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Libp2p = require('../../')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const TCP = require('libp2p-tcp')
|
||||||
import { pipe } from 'it-pipe'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
||||||
|
const pipe = require('it-pipe')
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()]
|
streamMuxer: [MPLEX],
|
||||||
|
connEncryption: [NOISE]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -28,14 +31,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.getMultiaddrs())
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
|
|
||||||
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: ${uint8ArrayToString(msg)}`)
|
console.log(`from: ${protocol}, msg: ${msg.toString()}`)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@ -43,19 +46,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(
|
||||||
[uint8ArrayFromString('protocol (a)')],
|
['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(
|
||||||
[uint8ArrayFromString('protocol (b)')],
|
['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(
|
||||||
[uint8ArrayFromString('another stream on protocol (b)')],
|
['another stream on protocol (b)'],
|
||||||
stream3
|
stream3
|
||||||
)
|
)
|
||||||
})();
|
})();
|
||||||
|
@ -1,21 +1,23 @@
|
|||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('../../')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { pipe } from 'it-pipe'
|
|
||||||
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
const pipe = require('it-pipe')
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()]
|
streamMuxer: [MPLEX],
|
||||||
|
connEncryption: [NOISE]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -30,14 +32,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.getMultiaddrs())
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
|
|
||||||
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(uint8ArrayToString(msg))
|
console.log(msg.toString())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@ -48,7 +50,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(uint8ArrayToString(msg))
|
console.log(msg.toString())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@ -56,13 +58,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(
|
||||||
[uint8ArrayFromString('from 1 to 2')],
|
['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(
|
||||||
[uint8ArrayFromString('from 2 to 1')],
|
['from 2 to 1'],
|
||||||
stream2
|
stream2
|
||||||
)
|
)
|
||||||
})();
|
})();
|
||||||
|
@ -11,16 +11,16 @@ 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
|
||||||
import { pipe } from 'it-pipe'
|
const pipe = require('it-pipe')
|
||||||
const { map } from 'streaming-iterables')
|
const { map } = require('streaming-iterables')
|
||||||
const { toBuffer } from 'it-buffer')
|
const { toBuffer } = require('it-buffer')
|
||||||
|
|
||||||
// ...
|
// ...
|
||||||
const node1 = nodes[0]
|
const node1 = nodes[0]
|
||||||
const node2 = nodes[1]
|
const node2 = nodes[1]
|
||||||
|
|
||||||
// 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)
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
|
|
||||||
// Here we are telling libp2p that if someone dials this node to talk with the `/your-protocol`
|
// Here we are telling libp2p that if someone dials this node to talk with the `/your-protocol`
|
||||||
// multicodec, the protocol identifier, please call this handler and give it the stream
|
// multicodec, the protocol identifier, please call this handler and give it the stream
|
||||||
@ -102,19 +102,17 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
//...
|
//...
|
||||||
|
|
||||||
const createNode = () => {
|
const createNode = () => {
|
||||||
return Libp2p.create({
|
return Libp2p.create({
|
||||||
transports: [
|
modules: {
|
||||||
new TCP()
|
transport: [ TCP ],
|
||||||
],
|
streamMuxer: [ Mplex ]
|
||||||
streamMuxers: [
|
}
|
||||||
new Mplex()
|
|
||||||
]
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@ -167,105 +165,10 @@ There is one last trick on _protocol and stream multiplexing_ that libp2p uses t
|
|||||||
|
|
||||||
With the aid of both mechanisms, we can reuse an incomming connection to dial streams out too, this is specially useful when you are behind tricky NAT, firewalls or if you are running in a browser, where you can't have listening addrs, but you can dial out. By dialing out, you enable other peers to talk with you in Protocols that they want, simply by opening a new multiplexed stream.
|
With the aid of both mechanisms, we can reuse an incomming connection to dial streams out too, this is specially useful when you are behind tricky NAT, firewalls or if you are running in a browser, where you can't have listening addrs, but you can dial out. By dialing out, you enable other peers to talk with you in Protocols that they want, simply by opening a new multiplexed stream.
|
||||||
|
|
||||||
You can see this working on example [3.js](./3.js).
|
You can see this working on example [3.js](./3.js). The result should look like the following:
|
||||||
|
|
||||||
As we've seen earlier, we can create our node with this createNode function.
|
|
||||||
```js
|
|
||||||
const createNode = async () => {
|
|
||||||
const node = await Libp2p.create({
|
|
||||||
addresses: {
|
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
|
||||||
},
|
|
||||||
modules: {
|
|
||||||
transport: [TCP],
|
|
||||||
streamMuxer: [MPLEX],
|
|
||||||
connEncryption: [NOISE]
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
await node.start()
|
|
||||||
|
|
||||||
return node
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
We can now create our two nodes for this example.
|
|
||||||
```js
|
|
||||||
const [node1, node2] = await Promise.all([
|
|
||||||
createNode(),
|
|
||||||
createNode()
|
|
||||||
])
|
|
||||||
```
|
|
||||||
|
|
||||||
Since, we want to connect these nodes `node1` & `node2`, we add our `node2` multiaddr in key-value pair in `node1` peer store.
|
|
||||||
```js
|
|
||||||
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
|
||||||
```
|
|
||||||
|
|
||||||
You may notice that we are only adding `node2` to `node1` peer store. This is because we want to dial up a bidirectional connection between these two nodes.
|
|
||||||
|
|
||||||
Finally, let's create protocols for `node1` & `node2` and dial those protocols.
|
|
||||||
```js
|
|
||||||
node1.handle('/node-1', ({ stream }) => {
|
|
||||||
pipe(
|
|
||||||
stream,
|
|
||||||
async function (source) {
|
|
||||||
for await (const msg of source) {
|
|
||||||
console.log(msg.toString())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
node2.handle('/node-2', ({ stream }) => {
|
|
||||||
pipe(
|
|
||||||
stream,
|
|
||||||
async function (source) {
|
|
||||||
for await (const msg of source) {
|
|
||||||
console.log(msg.toString())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
// Dialing node2 from node1
|
|
||||||
const { stream: stream1 } = await node1.dialProtocol(node2.peerId, ['/node-2'])
|
|
||||||
await pipe(
|
|
||||||
['from 1 to 2'],
|
|
||||||
stream1
|
|
||||||
)
|
|
||||||
|
|
||||||
// Dialing node1 from node2
|
|
||||||
const { stream: stream2 } = await node2.dialProtocol(node1.peerId, ['/node-1'])
|
|
||||||
await pipe(
|
|
||||||
['from 2 to 1'],
|
|
||||||
stream2
|
|
||||||
)
|
|
||||||
```
|
|
||||||
|
|
||||||
If we run this code, the result should look like the following:
|
|
||||||
|
|
||||||
```Bash
|
```Bash
|
||||||
> node 3.js
|
> node 3.js
|
||||||
from 1 to 2
|
from 1 to 2
|
||||||
from 2 to 1
|
from 2 to 1
|
||||||
```
|
```
|
||||||
|
|
||||||
So, we have successfully set up a bidirectional connection with protocol muxing. But you should be aware that we were able to dial from `node2` to `node1` even we haven't added the `node1` peerId to node2 address book is because we dialed node2 from node1 first. Then, we just dialed back our stream out from `node2` to `node1`. So, if we dial from `node2` to `node1` before dialing from `node1` to `node2` we will get an error.
|
|
||||||
|
|
||||||
The code below will result into an error as `the dial address is not valid`.
|
|
||||||
```js
|
|
||||||
// Dialing from node2 to node1
|
|
||||||
const { stream: stream2 } = await node2.dialProtocol(node1.peerId, ['/node-1'])
|
|
||||||
await pipe(
|
|
||||||
['from 2 to 1'],
|
|
||||||
stream2
|
|
||||||
)
|
|
||||||
|
|
||||||
// Dialing from node1 to node2
|
|
||||||
const { stream: stream1 } = await node1.dialProtocol(node2.peerId, ['/node-2'])
|
|
||||||
await pipe(
|
|
||||||
['from 1 to 2'],
|
|
||||||
stream1
|
|
||||||
)
|
|
||||||
```
|
|
@ -1,13 +1,31 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import { waitForOutput } from '../utils.js'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pDefer = require('p-defer')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
export async function test () {
|
async function test() {
|
||||||
|
const messageDefer = pDefer()
|
||||||
process.stdout.write('1.js\n')
|
process.stdout.write('1.js\n')
|
||||||
|
|
||||||
await waitForOutput('my own protocol, wow!', 'node', [path.join(__dirname, '1.js')], {
|
const proc = execa('node', [path.join(__dirname, '1.js')], {
|
||||||
cwd: __dirname
|
cwd: path.resolve(__dirname),
|
||||||
|
all: true
|
||||||
})
|
})
|
||||||
|
|
||||||
|
proc.all.on('data', async (data) => {
|
||||||
|
process.stdout.write(data)
|
||||||
|
|
||||||
|
const line = uint8ArrayToString(data)
|
||||||
|
|
||||||
|
if (line.includes('my own protocol, wow!')) {
|
||||||
|
messageDefer.resolve()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
await messageDefer.promise
|
||||||
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,13 +1,38 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import { waitForOutput } from '../utils.js'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pWaitFor = require('p-wait-for')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
export async function test () {
|
const messages = [
|
||||||
|
'protocol (a)',
|
||||||
|
'protocol (b)',
|
||||||
|
'another stream on protocol (b)'
|
||||||
|
]
|
||||||
|
|
||||||
|
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')], {
|
let count = 0
|
||||||
cwd: __dirname
|
const proc = execa('node', [path.join(__dirname, '2.js')], {
|
||||||
|
cwd: path.resolve(__dirname),
|
||||||
|
all: true
|
||||||
})
|
})
|
||||||
|
|
||||||
|
proc.all.on('data', async (data) => {
|
||||||
|
process.stdout.write(data)
|
||||||
|
|
||||||
|
const line = uint8ArrayToString(data)
|
||||||
|
|
||||||
|
if (messages.find((m) => line.includes(m))) {
|
||||||
|
count += 1
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
await pWaitFor(() => count === messages.length)
|
||||||
|
|
||||||
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,13 +1,37 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import { waitForOutput } from '../utils.js'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pWaitFor = require('p-wait-for')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
export async function test () {
|
const messages = [
|
||||||
|
'from 1 to 2',
|
||||||
|
'from 2 to 1'
|
||||||
|
]
|
||||||
|
|
||||||
|
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')], {
|
let count = 0
|
||||||
cwd: __dirname
|
const proc = execa('node', [path.join(__dirname, '3.js')], {
|
||||||
|
cwd: path.resolve(__dirname),
|
||||||
|
all: true
|
||||||
})
|
})
|
||||||
|
|
||||||
|
proc.all.on('data', async (data) => {
|
||||||
|
process.stdout.write(data)
|
||||||
|
|
||||||
|
const line = uint8ArrayToString(data)
|
||||||
|
|
||||||
|
if (messages.find((m) => line.includes(m))) {
|
||||||
|
count += 1
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
await pWaitFor(() => count === messages.length)
|
||||||
|
|
||||||
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,9 +1,13 @@
|
|||||||
import { test as test1 } from './test-1.js'
|
'use strict'
|
||||||
import { test as test2 } from './test-2.js'
|
|
||||||
import { test as test3 } from './test-3.js'
|
|
||||||
|
|
||||||
export async function test() {
|
const test1 = require('./test-1')
|
||||||
|
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
|
||||||
|
@ -1,22 +1,25 @@
|
|||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('../../')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Mplex = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { FloodSub } from '@libp2p/floodsub'
|
const Gossipsub = require('libp2p-gossipsub')
|
||||||
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
const { fromString: uint8ArrayFromString } = require('uint8arrays/from-string')
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [Mplex],
|
||||||
pubsub: new FloodSub()
|
connEncryption: [NOISE],
|
||||||
|
pubsub: Gossipsub
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -32,24 +35,22 @@ 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.getMultiaddrs())
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
await node1.dial(node2.peerId)
|
await node1.dial(node2.peerId)
|
||||||
|
|
||||||
node1.pubsub.subscribe(topic)
|
node1.pubsub.on(topic, (msg) => {
|
||||||
node1.pubsub.addEventListener('message', (evt) => {
|
console.log(`node1 received: ${uint8ArrayToString(msg.data)}`)
|
||||||
console.log(`node1 received: ${uint8ArrayToString(evt.detail.data)} on topic ${evt.detail.topic}`)
|
|
||||||
})
|
})
|
||||||
|
await node1.pubsub.subscribe(topic)
|
||||||
|
|
||||||
// Will not receive own published messages by default
|
// Will not receive own published messages by default
|
||||||
node2.pubsub.subscribe(topic)
|
node2.pubsub.on(topic, (msg) => {
|
||||||
node2.pubsub.addEventListener('message', (evt) => {
|
console.log(`node2 received: ${uint8ArrayToString(msg.data)}`)
|
||||||
console.log(`node2 received: ${uint8ArrayToString(evt.detail.data)} on topic ${evt.detail.topic}`)
|
|
||||||
})
|
})
|
||||||
|
await 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!')).catch(err => {
|
node2.pubsub.publish(topic, uint8ArrayFromString('Bird bird bird, bird is the word!'))
|
||||||
console.error(err)
|
|
||||||
})
|
|
||||||
}, 1000)
|
}, 1000)
|
||||||
})()
|
})()
|
||||||
|
@ -21,57 +21,49 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { Gossipsub } from 'libp2p-gossipsub'
|
const Gossipsub = require('libp2p-gossipsub')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [
|
modules: {
|
||||||
new TCP()
|
transport: [ TCP ],
|
||||||
],
|
streamMuxer: [ Mplex ],
|
||||||
streamMuxers: [
|
connEncryption: [ NOISE ],
|
||||||
new Mplex()
|
// we add the Pubsub module we want
|
||||||
],
|
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 } from 'uint8arrays/from-string')
|
|
||||||
const { toString } from 'uint8arrays/to-string')
|
|
||||||
const topic = 'news'
|
const topic = 'news'
|
||||||
|
|
||||||
const node1 = nodes[0]
|
const node1 = nodes[0]
|
||||||
const node2 = nodes[1]
|
const node2 = nodes[1]
|
||||||
|
|
||||||
// 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)
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
await node1.dial(node2.peerId)
|
await node1.dial(node2.peerId)
|
||||||
|
|
||||||
node1.pubsub.on(topic, (msg) => {
|
node1.pubsub.on(topic, (msg) => {
|
||||||
console.log(`node1 received: ${toString(msg.data)}`)
|
console.log(`node1 received: ${uint8ArrayToString(msg.data)}`)
|
||||||
})
|
})
|
||||||
await node1.pubsub.subscribe(topic)
|
await 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.on(topic, (msg) => {
|
||||||
console.log(`node2 received: ${toString(msg.data)}`)
|
console.log(`node2 received: ${uint8ArrayToString(msg.data)}`)
|
||||||
})
|
})
|
||||||
await node2.pubsub.subscribe(topic)
|
await node2.pubsub.subscribe(topic)
|
||||||
|
|
||||||
// node2 publishes "news" every second
|
// node2 publishes "news" every second
|
||||||
setInterval(() => {
|
setInterval(() => {
|
||||||
node2.pubsub.publish(topic, fromString('Bird bird bird, bird is the word!')).catch(err => {
|
node2.pubsub.publish(topic, uint8ArrayFromString('Bird bird bird, bird is the word!'))
|
||||||
console.error(err)
|
|
||||||
})
|
|
||||||
}, 1000)
|
}, 1000)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -1,22 +1,25 @@
|
|||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('../../../')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const Mplex = require('libp2p-mplex')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { FloodSub } from '@libp2p/floodsub'
|
const Gossipsub = require('libp2p-gossipsub')
|
||||||
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
const { fromString: uint8ArrayFromString } = require('uint8arrays/from-string')
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [TCP],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [Mplex],
|
||||||
pubsub: new FloodSub()
|
connEncryption: [NOISE],
|
||||||
|
pubsub: Gossipsub
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -33,26 +36,28 @@ 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.getMultiaddrs())
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
await node1.dial(node2.peerId)
|
await node1.dial(node2.peerId)
|
||||||
|
|
||||||
await node2.peerStore.addressBook.set(node3.peerId, node3.getMultiaddrs())
|
node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
|
||||||
await node2.dial(node3.peerId)
|
await node2.dial(node3.peerId)
|
||||||
|
|
||||||
//subscribe
|
//subscribe
|
||||||
node1.pubsub.addEventListener(topic, (evt) => {
|
node1.pubsub.on(topic, (msg) => {
|
||||||
// Will not receive own published messages by default
|
// Will not receive own published messages by default
|
||||||
console.log(`node1 received: ${uint8ArrayToString(evt.detail.data)}`)
|
console.log(`node1 received: ${uint8ArrayToString(msg.data)}`)
|
||||||
})
|
})
|
||||||
node1.pubsub.subscribe(topic)
|
await node1.pubsub.subscribe(topic)
|
||||||
|
|
||||||
node2.pubsub.addEventListener(topic, (evt) => {
|
node2.pubsub.on(topic, (msg) => {
|
||||||
console.log(`node2 received: ${uint8ArrayToString(evt.detail.data)}`)
|
console.log(`node2 received: ${uint8ArrayToString(msg.data)}`)
|
||||||
})
|
})
|
||||||
|
await node2.pubsub.subscribe(topic)
|
||||||
|
|
||||||
node3.pubsub.addEventListener(topic, (evt) => {
|
node3.pubsub.on(topic, (msg) => {
|
||||||
console.log(`node3 received: ${uint8ArrayToString(evt.detail.data)}`)
|
console.log(`node3 received: ${uint8ArrayToString(msg.data)}`)
|
||||||
})
|
})
|
||||||
|
await node3.pubsub.subscribe(topic)
|
||||||
|
|
||||||
const validateFruit = (msgTopic, msg) => {
|
const validateFruit = (msgTopic, msg) => {
|
||||||
const fruit = uint8ArrayToString(msg.data)
|
const fruit = uint8ArrayToString(msg.data)
|
||||||
@ -74,9 +79,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])).catch(err => {
|
node1.pubsub.publish(topic, uint8ArrayFromString(myFruits[count]))
|
||||||
console.info(err)
|
|
||||||
})
|
|
||||||
count++
|
count++
|
||||||
if (count == myFruits.length) {
|
if (count == myFruits.length) {
|
||||||
count = 0
|
count = 0
|
||||||
|
@ -7,23 +7,19 @@ 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
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('libp2p')
|
||||||
import { Gossipsub } from 'libp2p-gossipsub'
|
const Gossipsub = require('libp2p-gossipsub')
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: ['/ip4/0.0.0.0/tcp/0']
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
},
|
},
|
||||||
transports: [
|
modules: {
|
||||||
new TCP()
|
transport: [ TCP ],
|
||||||
],
|
streamMuxer: [ Mplex ],
|
||||||
streamMuxers: [
|
connEncryption: [ NOISE ],
|
||||||
new Mplex()
|
pubsub: Gossipsub
|
||||||
],
|
}
|
||||||
connectionEncryption: [
|
|
||||||
new Noise()
|
|
||||||
],
|
|
||||||
pubsub: new Gossipsub()
|
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -36,10 +32,10 @@ const [node1, node2, node3] = await Promise.all([
|
|||||||
createNode(),
|
createNode(),
|
||||||
])
|
])
|
||||||
|
|
||||||
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
await node1.dial(node2.peerId)
|
await node1.dial(node2.peerId)
|
||||||
|
|
||||||
await node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
|
node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
|
||||||
await node2.dial(node3.peerId)
|
await node2.dial(node3.peerId)
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -88,9 +84,7 @@ const myFruits = ['banana', 'apple', 'car', 'orange'];
|
|||||||
|
|
||||||
setInterval(() => {
|
setInterval(() => {
|
||||||
console.log('############## fruit ' + myFruits[count] + ' ##############')
|
console.log('############## fruit ' + myFruits[count] + ' ##############')
|
||||||
node1.pubsub.publish(topic, new TextEncoder().encode(myFruits[count])).catch(err => {
|
node1.pubsub.publish(topic, new TextEncoder().encode(myFruits[count]))
|
||||||
console.error(err)
|
|
||||||
})
|
|
||||||
count++
|
count++
|
||||||
if (count == myFruits.length) {
|
if (count == myFruits.length) {
|
||||||
count = 0
|
count = 0
|
||||||
|
@ -1,10 +1,9 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import execa from 'execa'
|
|
||||||
import pDefer from 'p-defer'
|
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pDefer = require('p-defer')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
const stdout = [
|
const stdout = [
|
||||||
{
|
{
|
||||||
@ -25,7 +24,7 @@ const stdout = [
|
|||||||
},
|
},
|
||||||
]
|
]
|
||||||
|
|
||||||
export async function test () {
|
async function test () {
|
||||||
const defer = pDefer()
|
const defer = pDefer()
|
||||||
let topicCount = 0
|
let topicCount = 0
|
||||||
let topicMessageCount = 0
|
let topicMessageCount = 0
|
||||||
@ -64,3 +63,5 @@ export async function test () {
|
|||||||
await defer.promise
|
await defer.promise
|
||||||
proc.kill()
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,12 +1,11 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import execa from 'execa'
|
|
||||||
import pDefer from 'p-defer'
|
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pDefer = require('p-defer')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
export async function test () {
|
async function test () {
|
||||||
const defer = pDefer()
|
const defer = pDefer()
|
||||||
process.stdout.write('1.js\n')
|
process.stdout.write('1.js\n')
|
||||||
|
|
||||||
@ -27,3 +26,5 @@ export async function test () {
|
|||||||
await defer.promise
|
await defer.promise
|
||||||
proc.kill()
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,7 +1,11 @@
|
|||||||
import { test as test1 } from './test-1.js'
|
'use strict'
|
||||||
import { test as testMessageFiltering } from './message-filtering/test.js'
|
|
||||||
|
|
||||||
export async function test() {
|
const test1 = require('./test-1')
|
||||||
|
const testMessageFiltering = require('./message-filtering/test')
|
||||||
|
|
||||||
|
async function test() {
|
||||||
await test1()
|
await test1()
|
||||||
await testMessageFiltering()
|
await testMessageFiltering()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
'use strict'
|
||||||
|
|
||||||
process.on('unhandedRejection', (err) => {
|
process.on('unhandedRejection', (err) => {
|
||||||
console.error(err)
|
console.error(err)
|
||||||
@ -5,14 +6,11 @@ process.on('unhandedRejection', (err) => {
|
|||||||
process.exit(1)
|
process.exit(1)
|
||||||
})
|
})
|
||||||
|
|
||||||
import path from 'path'
|
const path = require('path')
|
||||||
import fs from 'fs'
|
const fs = require('fs')
|
||||||
import {
|
const {
|
||||||
waitForOutput
|
waitForOutput
|
||||||
} from './utils.js'
|
} = require('./utils')
|
||||||
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)) {
|
||||||
@ -26,7 +24,7 @@ async function testAll () {
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
await waitForOutput('npm info ok', 'npm', ['--loglevel', 'info', 'run', 'test', '--', dir], {
|
await waitForOutput('npm info ok', 'npm', ['test', '--', dir], {
|
||||||
cwd: __dirname
|
cwd: __dirname
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
@ -1,12 +1,11 @@
|
|||||||
|
'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
|
||||||
|
|
||||||
import fs from 'fs-extra'
|
const fs = require('fs-extra')
|
||||||
import path from 'path'
|
const path = require('path')
|
||||||
import execa from 'execa'
|
const execa = require('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)
|
||||||
@ -54,7 +53,7 @@ async function build (dir) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
const pkg = JSON.parse(fs.readFileSync(pkgJson))
|
const pkg = require(pkgJson)
|
||||||
let build
|
let build
|
||||||
|
|
||||||
if (pkg.scripts.bundle) {
|
if (pkg.scripts.bundle) {
|
||||||
@ -89,7 +88,7 @@ async function runTest (dir) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
const { test } = await import(testFile)
|
const test = require(testFile)
|
||||||
|
|
||||||
await test()
|
await test()
|
||||||
}
|
}
|
||||||
|
@ -1,24 +1,21 @@
|
|||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('../..')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
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: [
|
listen: ['/ip4/0.0.0.0/tcp/0']
|
||||||
'/ip4/0.0.0.0/tcp/0'
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
transports: [
|
modules: {
|
||||||
new TCP()
|
transport: [TCP],
|
||||||
],
|
connEncryption: [NOISE]
|
||||||
connectionEncryption: [
|
}
|
||||||
new Noise()
|
|
||||||
]
|
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -30,5 +27,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.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
|
node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`))
|
||||||
})();
|
})();
|
||||||
|
@ -1,24 +1,26 @@
|
|||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('../..')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
|
||||||
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
const pipe = require('it-pipe')
|
||||||
import { pipe } from 'it-pipe'
|
const concat = require('it-concat')
|
||||||
import toBuffer from 'it-to-buffer'
|
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
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']
|
||||||
},
|
},
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
connectionEncryption: [new Noise()],
|
transport: [TCP],
|
||||||
streamMuxers: [new Mplex()]
|
connEncryption: [NOISE],
|
||||||
|
streamMuxer: [MPLEX]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -27,7 +29,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.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
|
node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`))
|
||||||
}
|
}
|
||||||
|
|
||||||
;(async () => {
|
;(async () => {
|
||||||
@ -42,16 +44,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,
|
||||||
toBuffer
|
concat
|
||||||
)
|
)
|
||||||
console.log(uint8ArrayToString(result))
|
console.log(result.toString())
|
||||||
})
|
})
|
||||||
|
|
||||||
await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
const { stream } = await node1.dialProtocol(node2.peerId, '/print')
|
const { stream } = await node1.dialProtocol(node2.peerId, '/print')
|
||||||
|
|
||||||
await pipe(
|
await pipe(
|
||||||
['Hello', ' ', 'p2p', ' ', 'world', '!'].map(str => uint8ArrayFromString(str)),
|
['Hello', ' ', 'p2p', ' ', 'world', '!'],
|
||||||
stream
|
stream
|
||||||
)
|
)
|
||||||
})();
|
})();
|
||||||
|
@ -1,26 +1,28 @@
|
|||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('../..')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const WebSockets = require('libp2p-websockets')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import { pipe } from 'it-pipe'
|
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
const pipe = require('it-pipe')
|
||||||
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 createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: addresses
|
listen: addresses
|
||||||
},
|
},
|
||||||
transports: transports,
|
modules: {
|
||||||
connectionEncryption: [new Noise()],
|
transport: transports,
|
||||||
streamMuxers: [new Mplex()]
|
connEncryption: [NOISE],
|
||||||
|
streamMuxer: [MPLEX]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -29,7 +31,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.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
|
node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`))
|
||||||
}
|
}
|
||||||
|
|
||||||
function print ({ stream }) {
|
function print ({ stream }) {
|
||||||
@ -37,7 +39,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(uint8ArrayToString(msg))
|
console.log(msg.toString())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@ -45,9 +47,9 @@ function print ({ stream }) {
|
|||||||
|
|
||||||
;(async () => {
|
;(async () => {
|
||||||
const [node1, node2, node3] = await Promise.all([
|
const [node1, node2, node3] = await Promise.all([
|
||||||
createNode([new TCP()], '/ip4/0.0.0.0/tcp/0'),
|
createNode([TCP], '/ip4/0.0.0.0/tcp/0'),
|
||||||
createNode([new TCP(), new WebSockets()], ['/ip4/0.0.0.0/tcp/0', '/ip4/127.0.0.1/tcp/10000/ws']),
|
createNode([TCP, WebSockets], ['/ip4/0.0.0.0/tcp/0', '/ip4/127.0.0.1/tcp/10000/ws']),
|
||||||
createNode([new WebSockets()], '/ip4/127.0.0.1/tcp/20000/ws')
|
createNode([WebSockets], '/ip4/127.0.0.1/tcp/20000/ws')
|
||||||
])
|
])
|
||||||
|
|
||||||
printAddrs(node1, '1')
|
printAddrs(node1, '1')
|
||||||
@ -58,21 +60,21 @@ 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.getMultiaddrs())
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
await node2.peerStore.addressBook.set(node3.peerId, node3.getMultiaddrs())
|
node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
|
||||||
await node3.peerStore.addressBook.set(node1.peerId, node1.getMultiaddrs())
|
node3.peerStore.addressBook.set(node1.peerId, node1.multiaddrs)
|
||||||
|
|
||||||
// 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(
|
||||||
[uint8ArrayFromString('node 1 dialed to node 2 successfully')],
|
['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(
|
||||||
[uint8ArrayFromString('node 2 dialed to node 3 successfully')],
|
['node 2 dialed to node 3 successfully'],
|
||||||
stream2
|
stream2
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -1,15 +1,17 @@
|
|||||||
/* eslint-disable no-console */
|
/* eslint-disable no-console */
|
||||||
|
'use strict'
|
||||||
|
|
||||||
import { createLibp2p } from 'libp2p'
|
const Libp2p = require('../..')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('libp2p-tcp')
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const WebSockets = require('libp2p-websockets')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('libp2p-mplex')
|
||||||
import fs from 'fs'
|
|
||||||
import https from 'https'
|
const fs = require('fs');
|
||||||
import { pipe } from 'it-pipe'
|
const https = require('https');
|
||||||
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
|
const pipe = require('it-pipe')
|
||||||
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'),
|
||||||
@ -21,25 +23,26 @@ const createNode = async (addresses = []) => {
|
|||||||
addresses = [addresses]
|
addresses = [addresses]
|
||||||
}
|
}
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: addresses
|
listen: addresses
|
||||||
},
|
},
|
||||||
transports: [
|
modules: {
|
||||||
new TCP(),
|
transport: [WebSockets],
|
||||||
new WebSockets({
|
connEncryption: [NOISE],
|
||||||
server: httpServer,
|
streamMuxer: [MPLEX]
|
||||||
websocket: {
|
},
|
||||||
rejectUnauthorized: false
|
config: {
|
||||||
}
|
peerDiscovery: {
|
||||||
})
|
// Disable autoDial as it would fail because we are using a self-signed cert.
|
||||||
],
|
// `dialProtocol` does not fail because we pass `rejectUnauthorized: false`.
|
||||||
connectionEncryption: [new Noise()],
|
autoDial: false
|
||||||
streamMuxers: [new Mplex()],
|
},
|
||||||
connectionManager: {
|
transport: {
|
||||||
// Disable autoDial as it would fail because we are using a self-signed cert.
|
[transportKey]: {
|
||||||
// `dialProtocol` does not fail because we pass `rejectUnauthorized: false`.
|
listenerOptions: { server: httpServer },
|
||||||
autoDial: false
|
},
|
||||||
|
},
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@ -49,7 +52,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.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
|
node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`))
|
||||||
}
|
}
|
||||||
|
|
||||||
function print ({ stream }) {
|
function print ({ stream }) {
|
||||||
@ -57,7 +60,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(uint8ArrayToString(msg))
|
console.log(msg.toString())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@ -75,12 +78,12 @@ function print ({ stream }) {
|
|||||||
node1.handle('/print', print)
|
node1.handle('/print', print)
|
||||||
node2.handle('/print', print)
|
node2.handle('/print', print)
|
||||||
|
|
||||||
const targetAddr = node1.getMultiaddrs()[0];
|
const targetAddr = `${node1.multiaddrs[0]}/p2p/${node1.peerId.toB58String()}`;
|
||||||
|
|
||||||
// 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')
|
const { stream } = await node2.dialProtocol(targetAddr, '/print', { websocket: { rejectUnauthorized: false } })
|
||||||
await pipe(
|
await pipe(
|
||||||
[uint8ArrayFromString('node 2 dialed to node 1 successfully')],
|
['node 2 dialed to node 1 successfully'],
|
||||||
stream
|
stream
|
||||||
)
|
)
|
||||||
})();
|
})();
|
||||||
|
@ -1,10 +1,10 @@
|
|||||||
# [Transports](http://libp2p.io/implementations/#transports)
|
# [Transports](http://libp2p.io/implementations/#transports)
|
||||||
|
|
||||||
libp2p doesn't make assumptions for you, instead, it enables you as the developer of the application to pick the modules you need to run your application, which can vary depending on the runtime you are executing. A libp2p node can use one or more Transports to dial and listen for Connections. These transports are modules that offer a clean interface for dialing and listening, defined by the [interface-transport] specification. Some examples of possible transports are: TCP, UTP, WebRTC, QUIC, HTTP, Pigeon and so on.
|
libp2p doesn't make assumptions for you, instead, it enables you as the developer of the application to pick the modules you need to run your application, which can vary depending on the runtime you are executing. A libp2p node can use one or more Transports to dial and listen for Connections. These transports are modules that offer a clean interface for dialing and listening, defined by the [interface-transport](https://github.com/libp2p/js-interfaces/tree/master/src/transport) specification. Some examples of possible transports are: TCP, UTP, WebRTC, QUIC, HTTP, Pigeon and so on.
|
||||||
|
|
||||||
A more complete definition of what is a transport can be found on the [interface-transport] specification. A way to recognize a candidate transport is through the badge:
|
A more complete definition of what is a transport can be found on the [interface-transport](https://github.com/libp2p/js-interfaces/tree/master/src/transport) specification. A way to recognize a candidate transport is through the badge:
|
||||||
|
|
||||||
![][interface-transport badge]
|
[](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png)
|
||||||
|
|
||||||
## 1. Creating a libp2p node with TCP
|
## 1. Creating a libp2p node with TCP
|
||||||
|
|
||||||
@ -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
|
||||||
import { createLibp2p } from 'libp2p'
|
'use strict'
|
||||||
import { TCP } from '@libp2p/tcp'
|
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const Libp2p = require('libp2p')
|
||||||
|
const TCP = require('libp2p-tcp')
|
||||||
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
|
|
||||||
const createNode = async () => {
|
const createNode = async () => {
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
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']
|
||||||
},
|
},
|
||||||
transports: [
|
modules: {
|
||||||
new TCP()
|
transport: [ TCP ],
|
||||||
],
|
connEncryption: [ NOISE ]
|
||||||
connectionEncryption: [
|
}
|
||||||
new Noise()
|
|
||||||
]
|
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -80,29 +80,31 @@ 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-to-buffer @libp2p/mplex
|
> npm install it-pipe it-concat 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
|
||||||
import { pipe } from 'it-pipe'
|
const pipe = require('it-pipe')
|
||||||
import toBuffer from 'it-to-buffer'
|
const concat = require('it-concat')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const MPLEX = require('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 createLibp2p({
|
const node = await Libp2p.create({
|
||||||
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']
|
||||||
},
|
},
|
||||||
transports: [new TCP()],
|
modules: {
|
||||||
connectionEncryption: [new Noise()],
|
transport: [TCP],
|
||||||
streamMuxers: [new Mplex()] // <--- Add this line
|
connEncryption: [NOISE],
|
||||||
|
streamMuxer: [MPLEX] // <--- Add this line
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -133,12 +135,12 @@ Then add,
|
|||||||
node2.handle('/print', async ({ stream }) => {
|
node2.handle('/print', async ({ stream }) => {
|
||||||
const result = await pipe(
|
const result = await pipe(
|
||||||
stream,
|
stream,
|
||||||
toBuffer
|
concat
|
||||||
)
|
)
|
||||||
console.log(result.toString())
|
console.log(result.toString())
|
||||||
})
|
})
|
||||||
|
|
||||||
await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
const { stream } = await node1.dialProtocol(node2.peerId, '/print')
|
const { stream } = await node1.dialProtocol(node2.peerId, '/print')
|
||||||
|
|
||||||
await pipe(
|
await pipe(
|
||||||
@ -184,13 +186,15 @@ const createNode = async (transports, addresses = []) => {
|
|||||||
addresses = [addresses]
|
addresses = [addresses]
|
||||||
}
|
}
|
||||||
|
|
||||||
const node = await createLibp2p({
|
const node = await Libp2p.create({
|
||||||
addresses: {
|
addresses: {
|
||||||
listen: addresses
|
listen: addresses
|
||||||
},
|
},
|
||||||
transport: transports,
|
modules: {
|
||||||
connectionEncryption: [new Noise()],
|
transport: transports,
|
||||||
streamMuxers: [new Mplex()]
|
connEncryption: [NOISE],
|
||||||
|
streamMuxer: [MPLEX]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
await node.start()
|
await node.start()
|
||||||
@ -203,8 +207,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
|
||||||
import { WebSockets } from '@libp2p/websockets'
|
const WebSockets = require('libp2p-websockets')
|
||||||
import { TCP } from '@libp2p/tcp'
|
const TCP = require('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'),
|
||||||
@ -220,9 +224,9 @@ node1.handle('/print', print)
|
|||||||
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)
|
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
|
||||||
await node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
|
node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
|
||||||
await node3.peerStore.addressBook.set(node1.peerId, node1.multiaddrs)
|
node3.peerStore.addressBook.set(node1.peerId, node1.multiaddrs)
|
||||||
|
|
||||||
// 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')
|
||||||
@ -284,15 +288,10 @@ As expected, we created 3 nodes: node 1 with TCP, node 2 with TCP+WebSockets and
|
|||||||
|
|
||||||
## 4. How to create a new libp2p transport
|
## 4. How to create a new libp2p transport
|
||||||
|
|
||||||
Today there are already several transports available and plenty to come. You can find these at [interface-transport implementations] list.
|
Today there are already several transports available and plenty to come. You can find these at [interface-transport implementations](https://github.com/libp2p/js-interfaces/tree/master/src/transport#modules-that-implement-the-interface) list.
|
||||||
|
|
||||||
Adding more transports is done through the same way as you added TCP and WebSockets. Some transports might offer extra functionalities, but as far as libp2p is concerned, if it follows the interface defined in the [spec][interface-transport api] it will be able to use it.
|
Adding more transports is done through the same way as you added TCP and WebSockets. Some transports might offer extra functionalities, but as far as libp2p is concerned, if it follows the interface defined in the [spec](https://github.com/libp2p/js-interfaces/tree/master/src/transport#api) it will be able to use it.
|
||||||
|
|
||||||
If you decide to implement a transport yourself, please consider adding to the list so that others can use it as well.
|
If you decide to implement a transport yourself, please consider adding to the list so that others can use it as well.
|
||||||
|
|
||||||
Hope this tutorial was useful. We are always looking to improve it, so contributions are welcome!
|
Hope this tutorial was useful. We are always looking to improve it, so contributions are welcome!
|
||||||
|
|
||||||
[interface-transport]: https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport
|
|
||||||
[interface-transport badge]: https://raw.githubusercontent.com/libp2p/js-libp2p-interfaces/master/packages/libp2p-interfaces/src/transport/img/badge.png
|
|
||||||
[interface-transport implementations]: https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#modules-that-implement-the-interface
|
|
||||||
[interface-transport api]: https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#api
|
|
||||||
|
@ -1,13 +1,38 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import { waitForOutput } from '../utils.js'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pDefer = require('p-defer')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
|
async function test () {
|
||||||
|
const deferStarted = pDefer()
|
||||||
|
const deferListen = pDefer()
|
||||||
|
|
||||||
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')], {
|
const proc = execa('node', [path.join(__dirname, '1.js')], {
|
||||||
cwd: __dirname
|
cwd: path.resolve(__dirname),
|
||||||
|
all: true
|
||||||
})
|
})
|
||||||
|
|
||||||
|
proc.all.on('data', async (data) => {
|
||||||
|
process.stdout.write(data)
|
||||||
|
const line = uint8ArrayToString(data)
|
||||||
|
|
||||||
|
|
||||||
|
if (line.includes('node has started (true/false): true')) {
|
||||||
|
deferStarted.resolve()
|
||||||
|
} else if (line.includes('p2p')) {
|
||||||
|
deferListen.resolve()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
await Promise.all([
|
||||||
|
deferStarted.promise,
|
||||||
|
deferListen.promise
|
||||||
|
])
|
||||||
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,13 +1,30 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import { waitForOutput } from '../utils.js'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pDefer = require('p-defer')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
export async function test () {
|
async function test () {
|
||||||
|
const defer = pDefer()
|
||||||
process.stdout.write('2.js\n')
|
process.stdout.write('2.js\n')
|
||||||
|
|
||||||
await waitForOutput('Hello p2p world!', 'node', [path.join(__dirname, '2.js')], {
|
const proc = execa('node', [path.join(__dirname, '2.js')], {
|
||||||
cwd: __dirname
|
cwd: path.resolve(__dirname),
|
||||||
|
all: true
|
||||||
})
|
})
|
||||||
|
|
||||||
|
proc.all.on('data', async (data) => {
|
||||||
|
process.stdout.write(data)
|
||||||
|
const line = uint8ArrayToString(data)
|
||||||
|
|
||||||
|
if (line.includes('Hello p2p world!')) {
|
||||||
|
defer.resolve()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
await defer.promise
|
||||||
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,13 +1,41 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import { waitForOutput } from '../utils.js'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pDefer = require('p-defer')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
|
async function test () {
|
||||||
|
const deferNode1 = pDefer()
|
||||||
|
const deferNode2 = pDefer()
|
||||||
|
const deferNode3 = pDefer()
|
||||||
|
|
||||||
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')], {
|
const proc = execa('node', [path.join(__dirname, '3.js')], {
|
||||||
cwd: __dirname
|
cwd: path.resolve(__dirname),
|
||||||
|
all: true
|
||||||
})
|
})
|
||||||
|
|
||||||
|
proc.all.on('data', async (data) => {
|
||||||
|
process.stdout.write(data)
|
||||||
|
const line = uint8ArrayToString(data)
|
||||||
|
|
||||||
|
if (line.includes('node 1 dialed to node 2 successfully')) {
|
||||||
|
deferNode1.resolve()
|
||||||
|
} else if (line.includes('node 2 dialed to node 3 successfully')) {
|
||||||
|
deferNode2.resolve()
|
||||||
|
} else if (line.includes('node 3 failed to dial to node 1 with:')) {
|
||||||
|
deferNode3.resolve()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
await Promise.all([
|
||||||
|
deferNode1.promise,
|
||||||
|
deferNode2.promise,
|
||||||
|
deferNode3.promise
|
||||||
|
])
|
||||||
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,13 +1,33 @@
|
|||||||
import path from 'path'
|
'use strict'
|
||||||
import { waitForOutput } from '../utils.js'
|
|
||||||
import { fileURLToPath } from 'url'
|
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
const path = require('path')
|
||||||
|
const execa = require('execa')
|
||||||
|
const pDefer = require('p-defer')
|
||||||
|
const { toString: uint8ArrayToString } = require('uint8arrays/to-string')
|
||||||
|
|
||||||
|
async function test () {
|
||||||
|
const deferNode1 = pDefer()
|
||||||
|
|
||||||
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')], {
|
const proc = execa('node', [path.join(__dirname, '4.js')], {
|
||||||
cwd: __dirname
|
cwd: path.resolve(__dirname),
|
||||||
|
all: true
|
||||||
})
|
})
|
||||||
|
|
||||||
|
proc.all.on('data', async (data) => {
|
||||||
|
process.stdout.write(data)
|
||||||
|
const line = uint8ArrayToString(data)
|
||||||
|
|
||||||
|
if (line.includes('node 2 dialed to node 1 successfully')) {
|
||||||
|
deferNode1.resolve()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
await Promise.all([
|
||||||
|
deferNode1.promise,
|
||||||
|
])
|
||||||
|
proc.kill()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = test
|
||||||
|
@ -1,11 +1,15 @@
|
|||||||
import { test as test1 } from './test-1.js'
|
'use strict'
|
||||||
import { test as test2 } from './test-2.js'
|
|
||||||
import { test as test3 } from './test-3.js'
|
|
||||||
import { test as test4 } from './test-4.js'
|
|
||||||
|
|
||||||
export async function test() {
|
const test1 = require('./test-1')
|
||||||
|
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
|
||||||
|
@ -1,6 +1,8 @@
|
|||||||
import execa from 'execa'
|
'use strict'
|
||||||
import fs from 'fs-extra'
|
|
||||||
import which from 'which'
|
const execa = require('execa')
|
||||||
|
const fs = require('fs-extra')
|
||||||
|
const which = require('which')
|
||||||
|
|
||||||
async function isExecutable (command) {
|
async function isExecutable (command) {
|
||||||
try {
|
try {
|
||||||
@ -20,7 +22,7 @@ async function isExecutable (command) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function waitForOutput (expectedOutput, command, args = [], opts = {}) {
|
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'
|
||||||
@ -28,7 +30,7 @@ export async function waitForOutput (expectedOutput, command, args = [], opts =
|
|||||||
|
|
||||||
const proc = execa(command, args, opts)
|
const proc = execa(command, args, opts)
|
||||||
let output = ''
|
let output = ''
|
||||||
let time = 600000
|
let time = 120000
|
||||||
|
|
||||||
let timeout = setTimeout(() => {
|
let timeout = setTimeout(() => {
|
||||||
throw new Error(`Did not see "${expectedOutput}" in output from "${[command].concat(args).join(' ')}" after ${time/1000}s`)
|
throw new Error(`Did not see "${expectedOutput}" in output from "${[command].concat(args).join(' ')}" after ${time/1000}s`)
|
||||||
@ -53,3 +55,7 @@ export async function waitForOutput (expectedOutput, command, args = [], opts =
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
waitForOutput
|
||||||
|
}
|
||||||
|
@ -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,15 +18,16 @@ 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: {
|
||||||
new Bootstrap({
|
[Bootstrap.tag]: {
|
||||||
|
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 start` in terminal. You should see an address where you can browse
|
When in the root folder of this example, type `npm run dev` 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.
|
||||||
|
@ -1,21 +1,28 @@
|
|||||||
import { createLibp2p } from 'libp2p'
|
import 'babel-polyfill'
|
||||||
import { WebRTCDirect } from '@achingbrain/webrtc-direct'
|
const Libp2p = require('libp2p')
|
||||||
import { Mplex } from '@libp2p/mplex'
|
const WebRTCDirect = require('libp2p-webrtc-direct')
|
||||||
import { Noise } from '@chainsafe/libp2p-noise'
|
const Mplex = require('libp2p-mplex')
|
||||||
import { Bootstrap } from '@libp2p/bootstrap'
|
const { NOISE } = require('@chainsafe/libp2p-noise')
|
||||||
|
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 createLibp2p({
|
const libp2p = await Libp2p.create({
|
||||||
transports: [new WebRTCDirect()],
|
modules: {
|
||||||
streamMuxers: [new Mplex()],
|
transport: [WebRTCDirect],
|
||||||
connectionEncryption: [new Noise()],
|
streamMuxer: [Mplex],
|
||||||
peerDiscovery: [
|
connEncryption: [NOISE],
|
||||||
new Bootstrap({
|
peerDiscovery: [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')
|
||||||
@ -29,21 +36,22 @@ document.addEventListener('DOMContentLoaded', async () => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Listen for new peers
|
// Listen for new peers
|
||||||
libp2p.addEventListener('peer:discovery', (evt) => {
|
libp2p.on('peer:discovery', (peerId) => {
|
||||||
log(`Found peer ${evt.detail.id.toString()}`)
|
log(`Found peer ${peerId.toB58String()}`)
|
||||||
})
|
})
|
||||||
|
|
||||||
// Listen for new connections to peers
|
// Listen for new connections to peers
|
||||||
libp2p.connectionManager.addEventListener('peer:connect', (evt) => {
|
libp2p.connectionManager.on('peer:connect', (connection) => {
|
||||||
log(`Connected to ${evt.detail.remotePeer.toString()}`)
|
log(`Connected to ${connection.remotePeer.toB58String()}`)
|
||||||
})
|
})
|
||||||
|
|
||||||
// Listen for peers disconnecting
|
// Listen for peers disconnecting
|
||||||
libp2p.connectionManager.addEventListener('peer:disconnect', (evt) => {
|
libp2p.connectionManager.on('peer:disconnect', (connection) => {
|
||||||
log(`Disconnected from ${evt.detail.remotePeer.toString()}`)
|
log(`Disconnected from ${connection.remotePeer.toB58String()}`)
|
||||||
})
|
})
|
||||||
|
|
||||||
await libp2p.start()
|
await libp2p.start()
|
||||||
status.innerText = 'libp2p started!'
|
status.innerText = 'libp2p started!'
|
||||||
log(`libp2p id is ${libp2p.peerId.toString()}`)
|
log(`libp2p id is ${libp2p.peerId.toB58String()}`)
|
||||||
|
|
||||||
})
|
})
|
||||||
|
@ -12,6 +12,6 @@
|
|||||||
<main>
|
<main>
|
||||||
<pre id="output"></pre>
|
<pre id="output"></pre>
|
||||||
</main>
|
</main>
|
||||||
<script src="./dialer.js" type="module"></script>
|
<script src="./dialer.js"></script>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user