Compare commits

...

251 Commits

Author SHA1 Message Date
7678156cf3 chore: release 0.37.0 (#1178)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2022-05-16 12:10:31 +01:00
f2fd4e30ff docs: add migration guide (#1214)
Adds migration guide for `libp2p@0.37.x`
2022-05-16 10:58:56 +01:00
31480603f3 fix: simplify pnet exports (#1213)
Export the key generator from `libp2p/pnet`
2022-05-16 10:07:32 +01:00
4837430d8b fix: encode enums correctly (#1210)
Updates protons and regenerates protobuf code to encode enums correctly
2022-05-10 12:35:33 +01:00
da3d19b309 fix: update interfaces (#1207)
Update to the latest interfaces version
2022-05-04 16:03:43 +01:00
a15254fdd4 fix: update to new interfaces (#1206)
Notably removes the `Dialer` interface as the `ConnectionManager` is now in charge of managing connections.
2022-05-04 10:19:04 +01:00
d16817ca44 fix: emit peer:connect after all (#1171)
**Motivation**

In lodestar, when we handle "peer:connect" event, we dial the peer which gives another "peer:connect" event and it causes other issues

**Motivation**

In `onConnect` function, "peer:connect" event should be emitted after we add connection to the `connections` map so that when app dial the peer in "peer:connect" event handler, it uses the same/existing connection
2022-04-22 20:56:47 +01:00
fab4f1385c fix: update pubsub interfaces (#1194)
Update to latest version of pubsub interface
2022-04-22 20:49:35 +01:00
5397137c65 fix: use placeholder dht/pubsub (#1193)
Instead of making the `.dht` and `.pubsub` properties optional, use dummy implementations that throw exceptions if they are not configured.

This way we don't have to null guard everywhere they are accessed.
2022-04-21 15:46:06 +01:00
147304449e fix: expose getPublicKey (#1188)
This is used externally by IPFS so expose the method
2022-04-14 18:00:21 +01:00
1b9bab68ed chore: update deps (#1190) 2022-04-14 08:05:43 +01:00
c64a586a20 chore: update aegir to the latest version (#1186)
Removes boilerplate config that is no longer necessary
2022-04-09 09:26:25 +01:00
64bfcee509 fix: expose metrics and registrar, use dht for peer discovery (#1183)
Exposes fields used by bitswap and also uses dht for peer discovery which was missed.
2022-04-02 10:11:01 +01:00
cc60cfde1a fix: add transport manager to exports map and fix docs (#1182)
Addresses PR comments from #1172 - fixes syntax of examples in docs, adds the transport manager to the exports map and renames fault tolerance enum for consistency.
2022-03-29 15:39:50 +01:00
8cca8e4bfc fix: update deps (#1181)
Update to released versions of interop suite and webrtc-direct
2022-03-28 16:09:43 +01:00
199395de4d feat: convert to typescript (#1172)
Converts this module to typescript.

- Ecosystem modules renamed from (e.g.) `libp2p-tcp` to `@libp2p/tcp`
- Ecosystem module now have named exports
- Configuration has been updated, now pass instances of modules instead of classes:
- Some configuration keys have been renamed to make them more descriptive.  `transport` -> `transports`, `connEncryption` -> `connectionEncryption`.  In general where we pass multiple things, the key is now plural, e.g. `streamMuxer` -> `streamMuxers`, `contentRouting` -> `contentRouters`, etc.  Where we are configuring a singleton the config key is singular, e.g. `connProtector` -> `connectionProtector` etc.
- Properties of the `modules` config key have been moved to the root
- Properties of the `config` config key have been moved to the root
```js
// before
import Libp2p from 'libp2p'
import TCP from 'libp2p-tcp'

await Libp2p.create({
  modules: {
    transport: [
      TCP
    ],
  }
  config: {
    transport: {
      [TCP.tag]: {
        foo: 'bar'
      }
    },
    relay: {
      enabled: true,
      hop: {
        enabled: true,
        active: true
      }
    }
  }
})
```
```js
// after
import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'

await createLibp2p({
  transports: [
    new TCP({ foo: 'bar' })
  ],
  relay: {
    enabled: true,
    hop: {
      enabled: true,
      active: true
    }
  }
})
```
- Use of `enabled` flag has been reduced - previously you could pass a module but disable it with config.  Now if you don't want a feature, just don't pass an implementation.   Eg:
```js
// before
await Libp2p.create({
  modules: {
    transport: [
      TCP
    ],
    pubsub: Gossipsub
  },
  config: {
    pubsub: {
      enabled: false
    }
  }
})
```
```js
// after
await createLibp2p({
  transports: [
    new TCP()
  ]
})
```
- `.multiaddrs` renamed to `.getMultiaddrs()` because it's not a property accessor, work is done by that method to calculate announce addresses, observed addresses, etc
- `/p2p/${peerId}` is now appended to all addresses returned by `.getMultiaddrs()` so they can be used opaquely (every consumer has to append the peer ID to the address to actually use it otherwise).  If you need low-level unadulterated addresses, call methods on the address manager.

BREAKING CHANGE: types are no longer hand crafted, this module is now ESM only
2022-03-28 14:30:27 +01:00
3cfe4bbfac docs: update auto relay example code usage (#1163)
Co-authored-by: aomini daiki <rakesh.shrestha@hazesoft.co>
2022-02-28 17:46:56 +01:00
6a3e37f250 chore: update js-interfaces URL in examples/transports README (#1150) 2022-02-01 10:11:19 +01:00
bad9e8c0ff chore: release 0.36.2 (#1147)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2022-01-26 11:03:09 +00:00
902f10d58d fix: reject connections when not running (#1146)
When the node is shutting down, new connections can still be received.

If this happens we can end up writing into the datastore when it's
been closed which throws an error.

Instead, if we're not running, have the connection manager close new
incoming connections.
2022-01-26 10:52:23 +00:00
fc12973344 chore: release 0.36.1 (#1145)
### [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](d44bd9094f))
---

This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2022-01-25 20:09:03 +00:00
d44bd9094f fix: await unhandle of protocols (#1144)
To allow us to shut down cleanly, we must wait the unhandling of protocols - this is because they write the new list of protocols into the datastore which might also be in the process of shutting down.
2022-01-25 19:56:56 +00:00
831ed39701 chore: release 0.36.0 (#1127)
## [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](d8ceb0bc66))
* async peerstore backed by datastores ([#1058](https://www.github.com/libp2p/js-libp2p/issues/1058)) ([978eb36](978eb3676f))
* connection gater ([#1142](https://www.github.com/libp2p/js-libp2p/issues/1142)) ([ff32eba](ff32eba6a0))


### Bug Fixes

* cache build artefacts ([#1091](https://www.github.com/libp2p/js-libp2p/issues/1091)) ([5043cd5](5043cd5643))
* catch errors during identify ([#1138](https://www.github.com/libp2p/js-libp2p/issues/1138)) ([12f1bb0](12f1bb0aee))
* import uint8arrays package in example ([#1083](https://www.github.com/libp2p/js-libp2p/issues/1083)) ([c3700f5](c3700f55d5))
* make tests more reliable ([#1139](https://www.github.com/libp2p/js-libp2p/issues/1139)) ([b7e8706](b7e87066a6))
* prevent auto-dialer from dialing self ([#1104](https://www.github.com/libp2p/js-libp2p/issues/1104)) ([9b22c6e](9b22c6e2f9))
* remove abort-controller dep ([#1095](https://www.github.com/libp2p/js-libp2p/issues/1095)) ([0a4dc54](0a4dc54d08))
* try all peer addresses when dialing a relay ([#1140](https://www.github.com/libp2p/js-libp2p/issues/1140)) ([63aa480](63aa480800))
* update any-signal and timeout-abort-controller ([#1128](https://www.github.com/libp2p/js-libp2p/issues/1128)) ([e0354b4](e0354b4c6b))
* update multistream select ([#1136](https://www.github.com/libp2p/js-libp2p/issues/1136)) ([00e4959](00e49592a3))
* update node-forge ([#1133](https://www.github.com/libp2p/js-libp2p/issues/1133)) ([a4bba35](a4bba35948))
---

This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2022-01-25 16:43:46 +00:00
ff32eba6a0 feat: connection gater (#1142)
Port of https://github.com/libp2p/go-libp2p-core/blob/master/connmgr/gater.go

Adds a new configuration key `connectionGater` which allows denying the dialing of certain peers, individual multiaddrs and the creation of connections at certain points in the connection flow.

Fixes: https://github.com/libp2p/js-libp2p/issues/175
Refs: https://github.com/libp2p/js-libp2p/issues/744
Refs: https://github.com/libp2p/js-libp2p/issues/769

Co-authored-by: mzdws <8580712+mzdws@user.noreply.gitee.com>
2022-01-25 16:27:01 +00:00
9b22c6e2f9 fix: prevent auto-dialer from dialing self (#1104)
Co-authored-by: Robert Kiel <robert.kiel@hoprnet.io>
Co-authored-by: achingbrain <alex@achingbrain.net>
2022-01-24 17:59:14 +00:00
d8ceb0bc66 feat: add fetch protocol (#1036)
Adds three methods to implement the `/libp2p/fetch/0.0.1` protocol:

* `libp2p.fetch(peerId, key) => Promise<Uint8Array>`
* `libp2p.fetchService.registerLookupFunction(prefix, lookupFunction)`
* `libp2p.fetchService.unRegisterLookupFunction(prefix, [lookupFunction])`

Co-authored-by: achingbrain <alex@achingbrain.net>
2022-01-24 17:07:11 +00:00
00e49592a3 fix: update multistream select (#1136)
It has types now so the ignore can be removed.
2022-01-21 18:13:33 +00:00
63aa480800 fix: try all peer addresses when dialing a relay (#1140)
The order of the addresses can affect our success rate in dialing a
relay - if it's a loopback address or similar it won't work.

Instead try dialing every address.
2022-01-21 11:57:09 -06:00
b7e87066a6 fix: make tests more reliable (#1139)
Try to use only public functions and properties to verify test behaviour
2022-01-21 12:58:31 +00:00
4c3bf01f35 chore: fix flaky tests (#1137)
These tests are flaky in CI, probably due to differences in timing introduced by #1058

Fixes #1134
2022-01-21 08:44:13 +00:00
12f1bb0aee fix: catch errors during identify (#1138)
Sometimes identify can be started while we are shutting down (for
example) - we should just log these errors.
2022-01-21 08:26:21 +00:00
a4bba35948 fix: update node-forge (#1133)
Upgrade to 1v of node-forge
2022-01-20 19:23:24 +00:00
fc43db750d chore: fix build on webworkers 2022-01-20 17:33:58 +00:00
bf1fc325b6 chore: add registry 2022-01-20 17:21:48 +00:00
79b356a313 chore: update var name 2022-01-20 16:52:30 +00:00
54e77221eb chore: fix publish command 2022-01-20 16:27:01 +00:00
85e23eb1cb chore: unpack node_module cache before rc publish (#1132) 2022-01-20 15:21:42 +00:00
cbd9bad86d chore: run test after build (#1130)
Run CI tests and check at the same time
2022-01-20 14:52:31 +00:00
75b922dc21 chore: checkout code and set up node for publishing rc (#1131)
Need to run the checkout and setup-node actions before publishing an RC.
2022-01-20 14:52:12 +00:00
280bb1b1f6 chore: autopublish next version (#1129)
If we aren't releasing a version on a given release run, publish an rc under the `next` tag instead.
2022-01-20 14:24:06 +00:00
e0354b4c6b fix: update any-signal and timeout-abort-controller (#1128)
Updates deps to remove abort controller dep

BREAKING CHANGE: abort-controller dep is gone from dependency tree
2022-01-20 14:17:41 +00:00
0264eb62ee chore: update example tests (#1126)
Remove some of the redundancy in the example tests
2022-01-20 13:33:01 +00:00
a0bfe8b534 chore: restore correct cache 2022-01-20 13:32:25 +00:00
2963b852db chore: add automated releases (#1124)
Adds release-please github action to create gated releases and a release issue that tracks all issues that will be in a release.
2022-01-20 13:19:38 +00:00
13d45de376 chore: add missing cache dir (#1125)
Fixes ci config
2022-01-20 12:37:52 +00:00
978eb3676f feat: async peerstore backed by datastores (#1058)
We have a peerstore that keeps all data for all observed peers in memory with no eviction.

This is fine when you don't discover many peers but when using the DHT you encounter a significant number of peers so our peer storage grows and grows over time.

We have a persistent peer store, but it just periodically writes peers into the datastore to be read at startup, still keeping them in memory.

It also means a restart doesn't give you any temporary reprieve from the memory leak as the previously observed peer data is read into memory at startup.

This change refactors the peerstore to use a datastore by default, reading and writing peer info as it arrives.  It can be configured with a MemoryDatastore if desired.

It was necessary to change the peerstore and *book interfaces to be asynchronous since the datastore api is asynchronous.

BREAKING CHANGE: `libp2p.handle`, `libp2p.registrar.register` and the peerstore methods have become async
2022-01-20 12:03:35 +00:00
0a4dc54d08 fix: remove abort-controller dep (#1095)
The `AbortController` class is supported by browsers and node 14+ - we only support node 16+ (e.g. LTS+Current) so the `abort-controller` module isn't needed any more.
2022-01-20 12:02:13 +00:00
c3700f55d5 fix: import uint8arrays package in example (#1083) 2022-01-14 16:33:17 +01:00
96d3461393 docs: Include loadkeychain in the index (#1087) 2022-01-10 11:56:08 +01:00
5e5d11ec19 docs: fix import of datastore-level (#1086) 2022-01-08 17:57:37 +01:00
4cadbad102 chore: remove pubsub dev deps (#1107) 2022-01-07 11:40:05 +01:00
5043cd5643 fix: cache build artefacts (#1091)
To speed up the build and make it more reliable, cache the node_modules
folder, dist, etc and re-use on each step.
2021-12-29 15:06:58 +01:00
ef54e0a10e chore: release version v0.35.8 2021-12-29 11:00:11 +01:00
61bf546c46 chore: update contributors 2021-12-29 11:00:11 +01:00
d2b7ec0f6b fix: look for final peer event instead of peer response (#1092)
`FINAL_PEER` means we found the peer, `PEER_RESPONSE` means a peer
responded to our query.
2021-12-29 10:56:56 +01:00
79b3cfc6ad fix: do not wait for autodial start (#1089)
When we've previously seen loads of peers and stored them in the
datastore we'll try to dial them as part of starting the autodial
component.

If we or our peers have bad network connections this can make
starting a libp2p node take ages so don't wait for a round of auto
dialing before considering the component started.
2021-12-29 10:55:48 +01:00
f18fc80b70 fix: increase listeners on any-signal (#1084)
Increase the number of listeners we allow on the actual signal we pass along, instead of the signal we pass into any-signal.
2021-12-29 10:51:26 +01:00
b4b432406e fix: record tracked map clears (#1085)
Record the size of a map after we `.clear()` it.
2021-12-27 07:14:27 +01:00
bbdd559a02 chore: release version v0.35.7 2021-12-24 14:51:51 +00:00
4070dcdf55 chore: update contributors 2021-12-24 14:51:51 +00:00
cb0d7d6c99 fix: type definitions for big dialrequest and persistent peerstore (#1078)
Signed-off-by: Tuyen Nguyen <vutuyen2636@gmail.com>
2021-12-24 15:46:00 +01:00
d1c48dcbed fix: main ci (#1079) 2021-12-24 11:18:09 +01:00
c4a442788b docs: update example config ipfs links (#1077) 2021-12-22 17:03:03 +01:00
70a4bb9451 docs: peerstore configuration datastore fixed 2021-12-22 14:15:18 +01:00
a0516ebc85 docs: update node and npm version badge according to package.json (#1074) 2021-12-22 14:01:54 +01:00
b425fa1230 fix: add tracked map (#1069)
Small refactor of the component stats - adds a `TrackedMap` which encapsulates updating the metrics and means we don't need to null guard on `this._metrics` everywhere.

If metrics are not enabled a regular `Map` is used.
2021-12-21 15:51:06 +01:00
0a485d07b3 chore: release version v0.35.6 2021-12-18 07:55:27 +01:00
0c3ed0a4ac chore: update contributors 2021-12-18 07:55:26 +01:00
09a0f940df fix: increase the maxlisteners for timeout controllers (#1065)
We use timeout controllers to ensure we're not dialling peers forever but we can end up registering lots of listeners for the `abort` event when peers have a lot of addresses.

In node this means we see an unhelpful `MaxListenersExceededWarning` in the console warning of a potential memory leak.

Increase the max number of listeners on the signal to silence the warning.
2021-12-18 07:34:27 +01:00
a642ad2a03 chore(deps-dev): bump libp2p-floodsub from 0.27.1 to 0.28.0 (#1062)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-12-15 09:30:49 +00:00
8ce2f08589 chore: release version v0.35.5 2021-12-15 09:28:05 +00:00
fe0d9828bb chore: update contributors 2021-12-15 09:28:04 +00:00
c8e1b08c19 chore: typo 2021-12-15 09:25:40 +00:00
faf1f89d9e chore: release version v0.35.4 2021-12-15 08:18:44 +00:00
76f4ea5e8a chore: update contributors 2021-12-15 08:18:44 +00:00
2f0b311df7 feat: allow per-component metrics to be collected (#1061)
Implements the idea from #1060 - allows us to get some insight into what's happening in a libp2p node out side of just bandwidth stats.

Configures a few default metrics if metrics are enabled - current connections, the state of the dial queue, etc.

Also makes the `Metrics` class not depend on the `ConnectionManager` class, otherwise we can't collect simple metrics from the connection manager class due to the circular dependency.
2021-12-15 08:03:09 +00:00
d172d0d952 chore: release version v0.35.3 2021-12-13 09:03:54 +00:00
f8e8023aed chore: update contributors 2021-12-13 09:03:54 +00:00
bdc9f16d0c fix: clean up pending dial targets (#1059)
If the `Promise.race` throws, execution of the function is terminated so the pending dial target is never removed from the map and we leak memory.

This can happen when there are invalid multiaddrs or when a peer reports more dialable addresses than the threshold.

Instead wrap the `Promise.race` in a `try/finally` which will always remove the pending dial target in the event of success or failure.
2021-12-10 12:42:09 +00:00
1b46f47fdb chore: run node tests in ci (#1057)
Looks like this project stopped running the `test:node` npm script when it was migrated to gh actions.

Re-enable it and fix all the related test failures.
2021-12-08 08:38:17 +00:00
b539f9b655 chore(deps-dev): bump libp2p-gossipsub from 0.11.4 to 0.12.1 (#1045)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-12-07 21:06:06 +00:00
103818733e chore(deps-dev): bump @chainsafe/libp2p-noise from 4.1.1 to 5.0.0 (#1053)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-12-07 21:05:53 +00:00
1f1bbc0ee6 docs: naming error in the documentation (#1056)
Changed LevelStore to LevelDatastore
2021-12-07 21:05:33 +00:00
3b683e7156 fix: fix uncaught promise rejection when finding peers (#1044)
Do not abort all attempts to find peers when `findPeers` on one router throws synchronously

Co-authored-by: Robert Kiel <robert.kiel@hoprnet.io>
Co-authored-by: achingbrain <alex@achingbrain.net>
2021-12-07 17:51:48 +00:00
b25e0fe531 fix: make error codes consistent (#1054)
Sometimes they are `NOT_FOUND`, sometimes `ERR_NOT_FOUND`, etc.

Move all error codes into `errors.js` and reference them from there.
2021-12-07 14:42:10 +00:00
cbaa5a2ef3 chore: switch to nat api (#1052)
@motrix/nat-api is a fork, nat-api has the fix from https://github.com/alxhotel/nat-api/pull/25
2021-12-07 09:37:12 +00:00
51dabb1724 chore: pubsub example subscribe returns void (#1048)
Seems like the correct return type of `Libp2p.pubsub.subscribe` is `void`, so the `await` can be removed: ae21299ade/src/pubsub-adapter.js (L29)
2021-12-06 21:12:38 +01:00
b9339bccaa chore: release version v0.35.2 2021-12-06 21:07:39 +01:00
9b21893b64 chore: update contributors 2021-12-06 21:07:38 +01:00
b70fb43427 fix: increase maxlisteners on event target (#1050)
Sometimes you encounter peers with lots of addresses. When this happens
you can attach more than 10x event listeners to the abort signal we
use to abort all the dials - this causes node to print a warning
which is misleading.

This PR increases the default number of listeners on the signal.

Fixes #900
2021-12-06 20:54:44 +01:00
ae21299ade chore: release version v0.35.1 2021-12-03 16:24:14 +00:00
149120bebc chore: update contributors 2021-12-03 16:24:13 +00:00
91c2ec9856 fix: do not let closest peers run forever (#1047)
The DHT takes a `signal` not a timeout so if a timeout is passed,
create a `TimeoutController` that will abort the query after the
timeout.
2021-12-03 15:47:30 +00:00
6d0ac819f1 chore: release version v0.35.0 2021-12-02 10:44:07 +00:00
15a0b1dbf2 chore: update contributors 2021-12-02 10:44:07 +00:00
9cbf36fcb5 chore: update peer id and libp2p crypto (#1042)
BREAKING CHANGE: requires node 15+
2021-12-02 10:11:23 +00:00
3a9d5f64d9 fix: stop dht before connection manager (#1041)
Stop the dht before the connection manager, otherwise in-flight eviction pings fail and we move on to the next one when we should just abort them all.

Also pulls in the fix from #1039 and splits the auto-dialler out from the connection manager as during shutdown it can get into a weird state where it's simultaneously killing and creating connections so stop auto-dialling things before we cause connections to dip below the low watermark by killing existing connections.

Fixes: https://github.com/ipfs/js-ipfs/issues/3923
2021-11-30 18:07:57 +00:00
eacd7e8f76 chore: update deps (#1038) 2021-11-26 16:00:47 +00:00
7f2cc4dc44 chore(deps-dev): bump ipfs-http-client from 52.0.5 to 54.0.2 (#1035)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-11-26 14:26:26 +00:00
5cc5a8749a chore: release version v0.34.0 2021-11-25 16:49:46 +00:00
ee60e18213 chore: update contributors 2021-11-25 16:49:46 +00:00
a4a2fac41e chore: node_modules is not required 2021-11-25 16:48:41 +00:00
2f598eba09 feat: update dht (#1009)
Changes dht creation to use factory function and updates docs

BREAKING CHANGE: libp2p-kad-dht has a new event-based API which is exposed as `_dht`
2021-11-25 16:32:19 +00:00
443a102528 docs: minor corrections to discovery-mechanisms readme (#1030) 2021-11-21 23:18:45 +01:00
3bed7b4cb2 chore: update aegir (#1027)
Updates aegir, fixes all new linting errors.
2021-11-19 08:02:24 +00:00
3fb424914f chore: fix examples (#1026)
Uses npm to install deps for examples.

We can put yarn back when we remove `node-fetch@2.x` from ipfs-utils, or when
yarn can download tarball dependencies reliably.

This either needs:

1. https://github.com/node-fetch/node-fetch/pull/1172 merging
2. Swap node-fetch for undici
3. Drop CJS support (node-fetch 3 has the above fix but is ESM-only)
2021-11-19 07:26:38 +00:00
bb0ca28195 docs: update connection link in API docs (#1024)
Fixes #1018

The issue was caused when the repo [js-libp2p-interfaces](https://github.com/libp2p/js-libp2p-interfaces) was renamed and refactored in this [commit](946348f7f8)
2021-11-16 15:55:00 +00:00
01a8b8da9b chore: example docs for auto-relay with correct port 2021-11-12 10:50:11 +01:00
77d7cb8f08 fix: private ip ts compile has no call signatures (#1020) 2021-11-12 10:34:44 +01:00
a335fda852 docs: fix datastore link (#999) 2021-09-27 12:42:53 +02:00
43e3af0c12 chore: add migration guide to 0.33 (#997) 2021-09-24 11:33:59 +02:00
2c9c3cf6d5 chore: release version v0.33.0 2021-09-24 10:32:46 +02:00
4d6587539c chore: update contributors 2021-09-24 10:32:45 +02:00
83734ef520 chore: update datastore (#990)
`interface-datastore` now only contains the interface definition,
`datastore-core` has the various implementations.

BREAKING CHANGE: datastore implementations provided to libp2p must be compliant with interface-datastore@6.0.0
2021-09-24 10:24:29 +02:00
1c2e4d89ac chore: release version v0.32.5 2021-09-21 09:47:01 +02:00
c635b08d2f chore: update contributors 2021-09-21 09:47:01 +02:00
3aedf55115 chore(deps): bump es6-promisify from 6.1.1 to 7.0.0 (#974)
Bumps [es6-promisify](https://github.com/mikehall314/es6-promisify) from 6.1.1 to 7.0.0.
- [Release notes](https://github.com/mikehall314/es6-promisify/releases)
- [Commits](https://github.com/mikehall314/es6-promisify/compare/v6.1.1...v7.0.0)

---
updated-dependencies:
- dependency-name: es6-promisify
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-09-21 09:40:36 +02:00
ede653cad9 chore(deps-dev): bump into-stream from 6.0.0 to 7.0.0 (#972)
Bumps [into-stream](https://github.com/sindresorhus/into-stream) from 6.0.0 to 7.0.0.
- [Release notes](https://github.com/sindresorhus/into-stream/releases)
- [Commits](https://github.com/sindresorhus/into-stream/compare/v6.0.0...v7.0.0)

---
updated-dependencies:
- dependency-name: into-stream
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-09-21 09:39:58 +02:00
2ab811d708 chore(deps-dev): bump libp2p-kad-dht from 0.23.4 to 0.24.2 (#991)
Bumps [libp2p-kad-dht](https://github.com/libp2p/js-libp2p-kad-dht) from 0.23.4 to 0.24.2.
- [Release notes](https://github.com/libp2p/js-libp2p-kad-dht/releases)
- [Changelog](https://github.com/libp2p/js-libp2p-kad-dht/blob/master/CHANGELOG.md)
- [Commits](https://github.com/libp2p/js-libp2p-kad-dht/compare/v0.23.4...v0.24.2)

---
updated-dependencies:
- dependency-name: libp2p-kad-dht
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-09-21 09:39:25 +02:00
122c89dd0d fix: move abortable-iterator to dependencies (#992)
fix #986
2021-09-21 09:36:37 +02:00
97107c4ef7 chore: update datastore usage in CONFIGURATION.md (#982)
Co-authored-by: Vasco Santos <vasco.santos@ua.pt>
2021-08-31 11:51:51 +02:00
d3f78edffe chore(deps-dev): bump ipfs-http-client from 50.1.2 to 52.0.2 (#973)
Bumps [ipfs-http-client](https://github.com/ipfs/js-ipfs) from 50.1.2 to 52.0.2.
- [Release notes](https://github.com/ipfs/js-ipfs/releases)
- [Changelog](https://github.com/ipfs/js-ipfs/blob/master/CHANGELOG.md)
- [Commits](https://github.com/ipfs/js-ipfs/compare/ipfs-http-client@50.1.2...ipfs-http-client@52.0.2)

---
updated-dependencies:
- dependency-name: ipfs-http-client
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-08-26 12:28:44 +02:00
f8e3cf10b0 chore: add dependabot (#968) 2021-08-26 12:02:28 +02:00
f342c1ff50 docs: update package list (#969) 2021-08-26 12:02:17 +02:00
fe63990a16 chore: libp2p interop job needs exit for aegir (#971) 2021-08-26 11:19:13 +02:00
e82b6e414b chore: release version v0.32.4 2021-08-20 09:25:15 +02:00
1d62ead8e5 chore: update contributors 2021-08-20 09:25:14 +02:00
3d25ff7fd0 chore: use new libp2p-noise 2021-08-20 09:13:21 +02:00
0f389a7828 chore: update uint8arrays 2021-08-20 09:13:21 +02:00
9f0582f372 chore: remove unused dev dep (#966) 2021-08-19 09:38:39 +02:00
266f2c3c86 chore: release version v0.32.3 2021-08-16 18:20:41 +02:00
7783edb059 chore: update contributors 2021-08-16 18:20:40 +02:00
ba2b4d4b28 fix: uint8arrays is a dep (#964) 2021-08-16 17:54:24 +02:00
06c3a6d407 chore: release version v0.32.2 2021-08-13 17:02:52 +02:00
833f789714 chore: update contributors 2021-08-13 17:02:51 +02:00
ef24fabf02 feat: custom protocol name (#962)
Co-authored-by: mzdws <8580712+mzdws@user.noreply.gitee.com>
2021-08-13 16:21:50 +02:00
3b33fb4b73 fix: browser example ci 2021-08-12 15:15:13 +02:00
a07fb7960b chore: update action setup node 2021-08-12 15:15:13 +02:00
b11126ca89 chore: release version v0.32.1 2021-07-22 11:51:39 +02:00
df53ab4e65 chore: update contributors 2021-07-22 11:51:39 +02:00
0701de40b1 fix: turn compliance tests into devDependency (#960)
Co-authored-by: Robert Kiel <robert.kiel@hoprnet.io>
2021-07-22 11:42:04 +02:00
d6bb967243 chore: release version v0.32.0 2021-07-15 13:14:37 +02:00
d48005b8b7 chore: update contributors 2021-07-15 13:14:36 +02:00
67b97e32da chore: add migration guide to 0.32 (#957) 2021-07-15 12:34:15 +02:00
664ba2d1e7 chore: release version v0.32.0-rc.0 2021-07-09 09:01:25 +02:00
608564b033 chore: update contributors 2021-07-09 09:01:24 +02:00
af723b355e fix: do not allow dial to large number of multiaddrs (#954) 2021-07-09 08:46:24 +02:00
13cf476148 chore: update to new multiformats (#948)
BREAKING CHANGE: uses the CID class from the new multiformats module

Co-authored-by: Vasco Santos <vasco.santos@moxy.studio>
2021-07-09 08:43:34 +02:00
39b03586e8 chore: use libp2p-tcp with types (#952) 2021-06-16 09:09:26 +02:00
f7183e8afd chore: release version v0.31.7 2021-06-14 09:56:53 +02:00
b9988adce9 chore: update contributors 2021-06-14 09:56:53 +02:00
b291bc06ec fix: dialer leaking resources after stopping (#947)
* fix: dialer leaking resources after stopping

* chore: add error code to test
2021-06-14 09:19:23 +02:00
755eb909f2 chore: update gossipsub dep for example 2021-06-13 21:42:36 +02:00
afe0f854e8 chore: use node 16 2021-06-13 21:42:36 +02:00
50f7f32e53 chore: update branch 2021-06-13 21:42:36 +02:00
052aad4e06 chore: use node 15 in ci 2021-06-13 21:42:36 +02:00
2c4b567b00 chore: restructure pubsub tests 2021-06-13 21:42:36 +02:00
2a6a635f13 chore: remove ipfs-utils dep (#953)
* chore: remove ipfs-utils dep

We only use it for the env detection, so use [wherearewe](https://www.npmjs.com/package/wherearewe)
instead which is that, but pulled out into a tiny module.

The `TextDecoder` class is global everywhere we support so we don't
need to pull it in from `ipfs-utils` and it's been removed from v8
anyway.

* chore: update ipfs-http-client
2021-06-11 10:01:40 +02:00
cd152f122f chore: add secure websockets example (#930)
* Add Secure WebSockets example

* Make dial accept self-signed cert
2021-06-11 09:45:47 +02:00
2959794796 chore: add more details on DHT configuration in CONFIGURATION.md (#951) 2021-06-10 09:06:26 +02:00
2068c845cb chore: configuration format fix 2021-06-07 11:50:21 +02:00
d8ba284883 fix: chat example with new multiaddr (#946) 2021-05-28 13:46:08 +02:00
869d35d852 chore: release version v0.31.6 2021-05-27 10:48:26 +02:00
d6540bf01d chore: update contributors 2021-05-27 10:48:26 +02:00
478963ad2d feat: keychain rotate passphrase (#944)
Co-authored-by: Vasco Santos <vasco.santos@ua.pt>
2021-05-27 10:30:19 +02:00
d22ad83890 chore: update libp2p interop (#940) 2021-05-21 10:22:11 +02:00
538f296b0a chore: release version v0.31.5 2021-05-12 19:17:23 +02:00
7bac2045cc chore: update contributors 2021-05-12 19:17:22 +02:00
818d2b2a98 fix: store remote agent and protocol version during identify (#943) 2021-05-12 19:11:17 +02:00
d163ffd224 chore: release version v0.31.4 2021-05-12 17:05:35 +02:00
b29d6c9304 chore: update contributors 2021-05-12 17:05:35 +02:00
890dd05941 replaced libp2p with node (#942)
Co-authored-by: zeim839 <kassissahil@gmail.com>
2021-05-12 16:47:29 +02:00
a79c6b50d7 fix: peerRouting.findPeer() trying to find self (#941)
* throw error if node attempts to find itself

Co-authored-by: Vasco Santos <vasco.santos@ua.pt>
2021-05-12 16:46:20 +02:00
d372a68692 chore: add github issue templates (#938) 2021-05-05 15:06:56 +02:00
4e3fc19623 chore: release version v0.31.3 2021-05-04 12:23:58 +02:00
2fa82b387c chore: update contributors 2021-05-04 12:23:57 +02:00
8fc6f8af81 chore: update ipfs-utils dep (#937) 2021-05-04 12:14:11 +02:00
924585b143 chore: release version v0.31.2 2021-04-30 15:45:45 +02:00
556f0203db chore: update contributors 2021-04-30 15:45:44 +02:00
b5a9eb2087 fix: moving averages record types (#935) 2021-04-30 15:42:34 +02:00
e5187d02ba chore: release version v0.31.1 2021-04-30 13:40:29 +02:00
150e4f97c1 chore: update contributors 2021-04-30 13:40:28 +02:00
302bb90058 fix: event emitter and interfaces types for discovery and routing (#934) 2021-04-30 13:20:12 +02:00
f860ffb3e7 chore: add migration guide to 0.31 (#912) 2021-04-30 09:30:41 +02:00
2572f3e034 chore: update libp2p dht and gossipsub to releases (#933) 2021-04-29 10:10:57 +02:00
d76356e56a chore: release version v0.31.0 2021-04-28 15:39:48 +02:00
e9543eb2e1 chore: update contributors 2021-04-28 15:39:48 +02:00
5282708263 chore: release version v0.31.0-rc.7 2021-04-27 17:18:12 +02:00
ed494f03ae chore: update contributors 2021-04-27 17:18:12 +02:00
ac370fc967 fix: address book guarantees no replicated entries are added (#927) 2021-04-27 17:14:48 +02:00
ef4393649f chore: remove chai deps (#929) 2021-04-27 17:13:34 +02:00
f23fd4b7c7 chore: update noise (#926) 2021-04-27 13:24:31 +02:00
5372f7af2f chore: release version v0.31.0-rc.6 2021-04-22 10:09:18 +02:00
97da0ba740 chore: update contributors 2021-04-22 10:09:18 +02:00
88b04156bf fix: keychain optional pw and use interfaces for validators and selectors instead (#924) 2021-04-22 09:53:55 +02:00
64f3af897b chore: release version v0.31.0-rc.5 2021-04-21 15:01:31 +02:00
54e502afcb chore: update contributors 2021-04-21 15:01:31 +02:00
086b0ec0df fix: demand pubsub subclass instead of pubsub instance (#922)
Changes the `Libp2pModules.pubsub` property to be a class that maybe
extends `PubsubBaseProtocol` instead of an instance of that class.
2021-04-21 14:55:21 +02:00
cc1f4af879 fix: dht configuration selectors and validators (#919) 2021-04-21 13:28:37 +02:00
6456a0fff8 chore: browser example dependencies must be installed at the root first (#921)
Fixes #920
2021-04-21 10:45:50 +02:00
44463b9145 fix: address book should not emit peer event if no addresses are known #887 2021-04-21 09:14:01 +02:00
7eb2cea570 chore: release version v0.31.0-rc.4 2021-04-20 17:14:17 +02:00
c381be3510 chore: update contributors 2021-04-20 17:14:16 +02:00
975e77991e fix: add clientMode dht arg and upgrade interface-datastore (#918) 2021-04-20 17:11:23 +02:00
b043bca607 fix: specify pbjs root (#917) 2021-04-20 16:25:48 +02:00
3ffeb4ebe6 chore: apply suggestions from code review
Co-authored-by: Irakli Gozalishvili <contact@gozala.io>
2021-04-20 11:41:50 +02:00
06e8f3dd42 fix: do not add abort signals to useless addresses (#913) 2021-04-20 09:31:16 +02:00
3f7dde3e13 chore: release version v0.31.0-rc.3 2021-04-19 14:12:25 +02:00
6f4e7ceeac chore: update contributors 2021-04-19 14:12:25 +02:00
2af692fb4d fix: remove inline arg types from function definitions (#916)
Co-authored-by: Vasco Santos <vasco.santos@moxy.studio>
2021-04-19 14:08:00 +02:00
906315ce73 chore: release version v0.31.0-rc.2 2021-04-16 17:12:57 +02:00
49f04cbe70 chore: update contributors 2021-04-16 17:12:57 +02:00
3d0a79eff3 fix: metrics stats and moving averages types (#915)
* fix: give stats initial values

Otherwise the compiler cannot derive the type and thinks `stats.snapshot` returns `{}`

* fix: add type shape to moving averages as well
2021-04-16 17:10:22 +02:00
55ee332907 chore: release version v0.31.0-rc.1 2021-04-16 15:55:22 +02:00
ffe122d47e chore: update contributors 2021-04-16 15:55:22 +02:00
21c9aeecb1 fix: dial protocol should throw if no protocol is provided (#914)
BREAKING CHANGE: dialProtocol does not return connection when no protocols are provided
2021-04-16 15:49:57 +02:00
a93cca9178 chore: update release template with examples testing (#911) 2021-04-16 09:27:44 +02:00
828a32d4f5 chore: add jsdoc 2021-04-15 14:38:25 +02:00
b4fb9b7bf2 fix: address book should not emit peer event if no addresses are known 2021-04-15 14:19:59 +02:00
0aed9fe1b3 chore: release version v0.31.0-rc.0 2021-04-15 09:52:56 +02:00
9d1b917e8a chore: update contributors 2021-04-15 09:52:55 +02:00
8506414ea1 chore: config types and dependencies update (#904)
BREAKING CHANGES:

top level types were updated, multiaddr@9.0.0 is used, dialer and keychain internal property names changed and connectionManager minPeers is not supported anymore
2021-04-15 09:40:02 +02:00
8e1743cac4 chore: release version v0.30.12 2021-03-27 13:43:36 +01:00
3ea95ce642 chore: update contributors 2021-03-27 13:43:35 +01:00
c4cae29ef3 chore: do not look up external IP during test (#906)
The NAT manager test will throw if the current computer is behind a
double NAT as at runtime it won't be possible to map external ports.

We don't care about that during the test so configure a fake external
IP so the test will still test the shut-down functionality on a computer
that is behind a double NAT.
2021-03-27 13:15:35 +01:00
a7128f07ec fix: the API of es6-promisify is not the same as promisify-es6 (#905) 2021-03-26 18:13:07 +01:00
c3e147df6b chore: delegates config md properties for client (#903) 2021-03-24 09:35:17 +01:00
b89445274d chore: release version v0.30.11 2021-03-23 09:51:32 +01:00
b9e3bcd91e chore: update contributors 2021-03-23 09:51:32 +01:00
f5c1cd1fb0 fix: interface-datastore update 2021-03-23 09:39:28 +01:00
975e4b0fe0 chore: increase bundle size 2021-03-23 09:39:28 +01:00
9504f1951a fix: connection direction should be only inbound or outbound 2021-03-23 09:39:28 +01:00
8e1fc78353 chore: release version v0.30.10 2021-03-09 18:52:37 +01:00
8895a092b6 chore: update contributors 2021-03-09 18:52:37 +01:00
f2f361998d chore: swap promisify to maintained package (#896)
Co-authored-by: Vasco Santos <vasco.santos@moxy.studio>
2021-03-09 16:55:38 +01:00
5f702f3481 fix: conn mgr access to moving averages record object (#897)
* fix: conn mgr access to moving averages record object

* chore: remove node 12

* chore: add parcel workaround
2021-03-09 16:51:41 +01:00
03b34cac7d docs: fix link to connection encryption example (#894) 2021-03-02 13:07:52 +01:00
9c67364caa Add an example of webrtc-direct (#868)
Co-authored-by: Vasco Santos <vasco.santos@moxy.studio>
2021-02-25 16:34:02 +01:00
a1424826e7 chore: release version v0.30.9 2021-02-25 15:31:26 +01:00
3d5bba070b chore: update contributors 2021-02-25 15:31:26 +01:00
3f314d5e90 fix: transport manager fault tolerance should include tolerance to transport listen fail (#893) 2021-02-25 15:23:07 +01:00
4ee3e1973b chore: minor grammar fixes on discovery example (#890) 2021-02-18 11:36:35 +01:00
fc6558b897 chore: release version v0.30.8 2021-02-11 14:57:43 +01:00
3e302570e5 chore: update contributors 2021-02-11 14:57:43 +01:00
a34d2bbcc3 fix: routers should only use dht if enabled (#885) 2021-02-11 14:37:34 +01:00
9941414a91 chore: update delegates config docs to use http client (#853) 2021-02-11 11:42:10 +01:00
46cb46188a chore: add discovery example with relay and pubsub discovery (#855) 2021-02-11 11:37:11 +01:00
1af8472dc6 chore: add transports example (#851) 2021-02-11 11:12:23 +01:00
f6a4cad827 chore: add pubsub example tests (#850) 2021-02-10 21:00:40 +01:00
b1079474de chore: add protocol and stream muxing example tests (#849) 2021-02-10 15:40:19 +01:00
a150ea60c5 chore: add peer and content routing example tests (#848) 2021-02-08 11:03:42 +01:00
356 changed files with 21698 additions and 21850 deletions

View File

@ -1,30 +1,39 @@
'use strict' import { WebSockets } from '@libp2p/websockets'
import { Mplex } from '@libp2p/mplex'
import { NOISE } from '@chainsafe/libp2p-noise'
import { pipe } from 'it-pipe'
import { createFromJSON } from '@libp2p/peer-id-factory'
const Libp2p = require('./src') /** @type {import('aegir').PartialOptions} */
const { MULTIADDRS_WEBSOCKETS } = require('./test/fixtures/browser') export default {
const Peers = require('./test/fixtures/peers') build: {
const PeerId = require('peer-id') bundlesizeMax: '147kB'
const WebSockets = require('libp2p-websockets') },
const Muxer = require('libp2p-mplex') test: {
const { NOISE: Crypto } = require('libp2p-noise') before: async () => {
const pipe = require('it-pipe') // use dynamic import because we only want to reference these files during the test run, e.g. after building
let libp2p const { createLibp2p } = await import('./dist/src/index.js')
const { MULTIADDRS_WEBSOCKETS } = await import('./dist/test/fixtures/browser.js')
const { Plaintext } = await import('./dist/src/insecure/index.js')
const { default: Peers } = await import('./dist/test/fixtures/peers.js')
const before = async () => {
// Use the last peer // Use the last peer
const peerId = await PeerId.createFromJSON(Peers[Peers.length - 1]) const peerId = await createFromJSON(Peers[Peers.length - 1])
const libp2p = await createLibp2p({
libp2p = new Libp2p({
addresses: { addresses: {
listen: [MULTIADDRS_WEBSOCKETS[0]] listen: [MULTIADDRS_WEBSOCKETS[0]]
}, },
peerId, peerId,
modules: { transports: [
transport: [WebSockets], new WebSockets()
streamMuxer: [Muxer], ],
connEncryption: [Crypto] streamMuxers: [
}, new Mplex()
config: { ],
connectionEncryption: [
NOISE,
new Plaintext()
],
relay: { relay: {
enabled: true, enabled: true,
hop: { hop: {
@ -35,28 +44,20 @@ const before = async () => {
nat: { nat: {
enabled: false enabled: false
} }
}
}) })
// Add the echo protocol // Add the echo protocol
libp2p.handle('/echo/1.0.0', ({ stream }) => pipe(stream, stream)) 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() await libp2p.start()
}
const after = async () => { return {
await libp2p.stop() libp2p
} }
module.exports = {
bundlesize: { maxSize: '215kB' },
hooks: {
pre: before,
post: after
}, },
webpack: { after: async (_, before) => {
node: { await before.libp2p.stop()
// needed by bcrypto
Buffer: true
} }
} }
} }

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: libp2p Official Forum
url: https://discuss.libp2p.io
about: For general questions, support requests and discussions

55
.github/ISSUE_TEMPLATE/open_an_issue.md vendored Normal file
View File

@ -0,0 +1,55 @@
---
name: Open an issue
about: For reporting bugs or errors in the JavaScript libp2p implementation
title: ''
labels: need/triage
assignees: ''
---
<!--
Thank you for reporting an issue.
This issue tracker is for bugs found within the JavaScript implementation of libp2p.
If you are asking a question about how to use libp2p, please ask on https://discuss.libp2p.io
Otherwise please fill in as much of the template below as possible.
-->
- **Version**:
<!--
Check package.json version
-->
- **Platform**:
<!--
Output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows). If using in a Browser, please share the browser version as well
-->
- **Subsystem**:
<!--
If known, please specify affected core module name (e.g Dialer, Pubsub, Relay etc)
-->
#### Severity:
<!--
One of following:
Critical - System crash, application panic.
High - The main functionality of the application does not work, API breakage, repo format breakage, etc.
Medium - A non-essential functionality does not work, performance issues, etc.
Low - An optional functionality does not work.
Very Low - Translation or documentation mistake. Something that won't give anyone a bad day.
-->
#### Description:
<!--
- What you did
- What happened
- What you expected to happen
-->
#### Steps to reproduce the error:
<!--
If possible, please provide code that demonstrates the problem, keeping it as simple and free of external dependencies as you are able
-->

View File

@ -25,8 +25,6 @@
- [ ] [js-ipfs](https://github.com/ipfs/js-ipfs) - [ ] [js-ipfs](https://github.com/ipfs/js-ipfs)
- Documentation - Documentation
- [ ] Ensure that README.md is up to date - [ ] Ensure that README.md is up to date
- [ ] Ensure that all the examples run
- [ ] Ensure [libp2p/js-libp2p-examples](https://github.com/libp2p/js-libp2p-examples) is updated
- [ ] Ensure that [libp2p/docs](https://github.com/libp2p/docs) is updated - [ ] Ensure that [libp2p/docs](https://github.com/libp2p/docs) is updated
- Communication - Communication
- [ ] Create the release issue - [ ] Create the release issue

8
.github/dependabot.yml vendored Normal file
View File

@ -0,0 +1,8 @@
version: 2
updates:
- package-ecosystem: npm
directory: "/"
schedule:
interval: daily
time: "10:00"
open-pull-requests-limit: 10

66
.github/workflows/examples.yml vendored Normal file
View File

@ -0,0 +1,66 @@
name: examples
on:
push:
branches:
- master
pull_request:
branches:
- '**'
jobs:
build:
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
with:
directories: |
./examples/node_modules
~/.cache
build: |
cd examples
npm i
npx playwright install
cache_name: cache-examples
test-example:
needs: build
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:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: lts/*
- uses: ipfs/aegir/actions/cache-node-modules@master
with:
directories: |
./examples/node_modules
~/.cache
build: |
cd examples
npm i
npx playwright install
cache_name: cache-examples
- run: |
cd examples
npm run test -- ${{ matrix.example }}

View File

@ -8,102 +8,165 @@ on:
- '**' - '**'
jobs: jobs:
check: check:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- run: yarn - uses: actions/setup-node@v2
- run: yarn lint
- uses: gozala/typescript-error-reporter-action@v1.0.8
- run: yarn build
- run: yarn aegir dep-check
- uses: ipfs/aegir/actions/bundle-size@master
name: size
with: with:
github_token: ${{ secrets.GITHUB_TOKEN }} node-version: lts/*
- uses: ipfs/aegir/actions/cache-node-modules@master
- run: npm run --if-present lint
- run: npm run --if-present dep-check
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: [12, 14] node: [16]
fail-fast: true fail-fast: true
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- uses: actions/setup-node@v1 - uses: actions/setup-node@v2
with: with:
node-version: ${{ matrix.node }} node-version: ${{ matrix.node }}
- run: yarn - uses: ipfs/aegir/actions/cache-node-modules@master
- run: npx nyc --reporter=lcov aegir test -t node -- --bail - run: npm run --if-present test:node
- uses: codecov/codecov-action@v1 - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
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
- run: yarn - uses: actions/setup-node@v2
- run: npx aegir test -t browser -t webworker --bail with:
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
- run: yarn - uses: actions/setup-node@v2
- run: npx aegir test -t browser -t webworker --bail -- --browsers FirefoxHeadless with:
node-version: lts/*
- 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
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: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
- run: yarn - uses: actions/setup-node@v2
- run: cd node_modules/interop-libp2p && yarn && LIBP2P_JS=${GITHUB_WORKSPACE}/src/index.js npx aegir test -t node --bail with:
test-auto-relay-example: node-version: lts/*
needs: check - uses: ipfs/aegir/actions/cache-node-modules@master
- run: npm run test:interop -- --bail
release:
runs-on: ubuntu-latest 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: 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/checkout@v2
- run: yarn - uses: actions/setup-node@v2
- run: cd examples && yarn && npm run test -- auto-relay with:
test-chat-example: node-version: lts/*
needs: check registry-url: 'https://registry.npmjs.org'
runs-on: ubuntu-latest - uses: ipfs/aegir/actions/cache-node-modules@master
steps: - if: ${{ steps.release.outputs.release_created }}
- uses: actions/checkout@v2 name: Run release version
- run: yarn run: npm publish
- run: cd examples && yarn && npm run test -- chat env:
test-connection-encryption-example: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
needs: check - if: ${{ !steps.release.outputs.release_created }}
runs-on: ubuntu-latest name: Run release rc
steps: run: |
- uses: actions/checkout@v2 npm version `node -p -e "require('./package.json').version"`-`git rev-parse --short HEAD` --no-git-tag-version
- run: yarn npm publish --tag next
- run: cd examples && yarn && npm run test -- connection-encryption env:
test-echo-example: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
needs: check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: yarn
- run: cd examples && yarn && npm run test -- echo
test-libp2p-in-the-browser-example:
needs: check
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- run: yarn
- run: cd examples && yarn && npm run test -- libp2p-in-the-browser
test-discovery-mechanisms-example:
needs: check
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- run: yarn
- run: cd examples && yarn && npm run test -- discovery-mechanisms
test-pnet-example:
needs: check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: yarn
- run: cd examples && yarn && npm run test -- pnet

1
.gitignore vendored
View File

@ -4,6 +4,7 @@ docs
test/repo-tests* test/repo-tests*
**/bundle.js **/bundle.js
.cache .cache
.parcel-cache
# Logs # Logs
logs logs

View File

@ -1,3 +1,480 @@
## [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.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)
### chore
* update datastore ([#990](https://github.com/libp2p/js-libp2p/issues/990)) ([83734ef](https://github.com/libp2p/js-libp2p/commit/83734ef52061ad61ddb5ca49aae27e3a8b937058))
### BREAKING CHANGES
* datastore implementations provided to libp2p must be compliant with interface-datastore@6.0.0
## [0.32.5](https://github.com/libp2p/js-libp2p/compare/v0.32.4...v0.32.5) (2021-09-21)
### Bug Fixes
* move abortable-iterator to dependencies ([#992](https://github.com/libp2p/js-libp2p/issues/992)) ([122c89d](https://github.com/libp2p/js-libp2p/commit/122c89dd0df55a59edaae078e3dc7c31b5603715)), closes [#986](https://github.com/libp2p/js-libp2p/issues/986)
## [0.32.4](https://github.com/libp2p/js-libp2p/compare/v0.32.3...v0.32.4) (2021-08-20)
## [0.32.3](https://github.com/libp2p/js-libp2p/compare/v0.32.2...v0.32.3) (2021-08-16)
### Bug Fixes
* uint8arrays is a dep ([#964](https://github.com/libp2p/js-libp2p/issues/964)) ([ba2b4d4](https://github.com/libp2p/js-libp2p/commit/ba2b4d4b28f1d9940b457de344aed44537f9eabd))
## [0.32.2](https://github.com/libp2p/js-libp2p/compare/v0.32.1...v0.32.2) (2021-08-13)
### Bug Fixes
* browser example ci ([3b33fb4](https://github.com/libp2p/js-libp2p/commit/3b33fb4b73ba8065e432fb59f758fe138fd23d9e))
### Features
* custom protocol name ([#962](https://github.com/libp2p/js-libp2p/issues/962)) ([ef24fab](https://github.com/libp2p/js-libp2p/commit/ef24fabf0269fd079888e92eedb458e23ef1c733))
## [0.32.1](https://github.com/libp2p/js-libp2p/compare/v0.32.0...v0.32.1) (2021-07-22)
### Bug Fixes
* turn compliance tests into devDependency ([#960](https://github.com/libp2p/js-libp2p/issues/960)) ([0701de4](https://github.com/libp2p/js-libp2p/commit/0701de40b1ebdf319959846d8c4fdd30b3cf34a4))
# [0.32.0](https://github.com/libp2p/js-libp2p/compare/v0.32.0-rc.0...v0.32.0) (2021-07-15)
# [0.32.0-rc.0](https://github.com/libp2p/js-libp2p/compare/v0.31.7...v0.32.0-rc.0) (2021-07-09)
### Bug Fixes
* do not allow dial to large number of multiaddrs ([#954](https://github.com/libp2p/js-libp2p/issues/954)) ([af723b3](https://github.com/libp2p/js-libp2p/commit/af723b355e1ddf4aecf439f81c3aa67613d45fa4))
### chore
* update to new multiformats ([#948](https://github.com/libp2p/js-libp2p/issues/948)) ([13cf476](https://github.com/libp2p/js-libp2p/commit/13cf4761489d59b22924bb8ec2ec6dbe207b280c))
### BREAKING CHANGES
* uses the CID class from the new multiformats module
Co-authored-by: Vasco Santos <vasco.santos@moxy.studio>
## [0.31.7](https://github.com/libp2p/js-libp2p/compare/v0.31.6...v0.31.7) (2021-06-14)
### Bug Fixes
* chat example with new multiaddr ([#946](https://github.com/libp2p/js-libp2p/issues/946)) ([d8ba284](https://github.com/libp2p/js-libp2p/commit/d8ba2848833d9fb8a963d1b7c8d27062c6f829da))
* dialer leaking resources after stopping ([#947](https://github.com/libp2p/js-libp2p/issues/947)) ([b291bc0](https://github.com/libp2p/js-libp2p/commit/b291bc06ec13feeb6e010730edfad754a3b2dc1b))
## [0.31.6](https://github.com/libp2p/js-libp2p/compare/v0.31.5...v0.31.6) (2021-05-27)
### Features
* keychain rotate passphrase ([#944](https://github.com/libp2p/js-libp2p/issues/944)) ([478963a](https://github.com/libp2p/js-libp2p/commit/478963ad2d195444494c0acc54cb3847a29e117c))
## [0.31.5](https://github.com/libp2p/js-libp2p/compare/v0.31.4...v0.31.5) (2021-05-12)
### Bug Fixes
* store remote agent and protocol version during identify ([#943](https://github.com/libp2p/js-libp2p/issues/943)) ([818d2b2](https://github.com/libp2p/js-libp2p/commit/818d2b2a98736f4242694479089396f6070cdad5))
## [0.31.4](https://github.com/libp2p/js-libp2p/compare/v0.31.3...v0.31.4) (2021-05-12)
### Bug Fixes
* peerRouting.findPeer() trying to find self ([#941](https://github.com/libp2p/js-libp2p/issues/941)) ([a79c6b5](https://github.com/libp2p/js-libp2p/commit/a79c6b50d7fddbcdb1af53efae922cecad4c9a83))
## [0.31.3](https://github.com/libp2p/js-libp2p/compare/v0.31.2...v0.31.3) (2021-05-04)
## [0.31.2](https://github.com/libp2p/js-libp2p/compare/v0.31.1...v0.31.2) (2021-04-30)
### Bug Fixes
* moving averages record types ([#935](https://github.com/libp2p/js-libp2p/issues/935)) ([b5a9eb2](https://github.com/libp2p/js-libp2p/commit/b5a9eb208763efa027d0b4caae87c515b6f5869b))
## [0.31.1](https://github.com/libp2p/js-libp2p/compare/v0.31.0...v0.31.1) (2021-04-30)
### Bug Fixes
* event emitter and interfaces types for discovery and routing ([#934](https://github.com/libp2p/js-libp2p/issues/934)) ([302bb90](https://github.com/libp2p/js-libp2p/commit/302bb9005891aa06b70a5f354bfac6b2d5a3c3b8))
# [0.31.0](https://github.com/libp2p/js-libp2p/compare/v0.31.0-rc.7...v0.31.0) (2021-04-28)
# [0.31.0-rc.7](https://github.com/libp2p/js-libp2p/compare/v0.31.0-rc.6...v0.31.0-rc.7) (2021-04-27)
### Bug Fixes
* address book guarantees no replicated entries are added ([#927](https://github.com/libp2p/js-libp2p/issues/927)) ([ac370fc](https://github.com/libp2p/js-libp2p/commit/ac370fc9679b51da8cee3791b6dd268d0695d136))
# [0.31.0-rc.6](https://github.com/libp2p/js-libp2p/compare/v0.31.0-rc.5...v0.31.0-rc.6) (2021-04-22)
### Bug Fixes
* keychain optional pw and use interfaces for validators and selectors instead ([#924](https://github.com/libp2p/js-libp2p/issues/924)) ([88b0415](https://github.com/libp2p/js-libp2p/commit/88b04156bf614650c2b14d49b12e969c5eecf04d))
# [0.31.0-rc.5](https://github.com/libp2p/js-libp2p/compare/v0.31.0-rc.4...v0.31.0-rc.5) (2021-04-21)
### Bug Fixes
* address book should not emit peer event if no addresses are known ([b4fb9b7](https://github.com/libp2p/js-libp2p/commit/b4fb9b7bf266ba03c4462c0a41b1c2691e4e88d4))
* demand pubsub subclass instead of pubsub instance ([#922](https://github.com/libp2p/js-libp2p/issues/922)) ([086b0ec](https://github.com/libp2p/js-libp2p/commit/086b0ec0df2fac93845d0a0a6b2e2464e869afcd))
* dht configuration selectors and validators ([#919](https://github.com/libp2p/js-libp2p/issues/919)) ([cc1f4af](https://github.com/libp2p/js-libp2p/commit/cc1f4af879a58e94538591851d0085ff98cd2641))
# [0.31.0-rc.4](https://github.com/libp2p/js-libp2p/compare/v0.31.0-rc.3...v0.31.0-rc.4) (2021-04-20)
### Bug Fixes
* add clientMode dht arg and upgrade interface-datastore ([#918](https://github.com/libp2p/js-libp2p/issues/918)) ([975e779](https://github.com/libp2p/js-libp2p/commit/975e77991e67dd9bff790b83df7bd6fa5ddcfc67))
* do not add abort signals to useless addresses ([#913](https://github.com/libp2p/js-libp2p/issues/913)) ([06e8f3d](https://github.com/libp2p/js-libp2p/commit/06e8f3dd42432e4b37ab7904b02abde7d1cadda3))
* specify pbjs root ([#917](https://github.com/libp2p/js-libp2p/issues/917)) ([b043bca](https://github.com/libp2p/js-libp2p/commit/b043bca607565cf534771e6cf975288a8ff3030b))
# [0.31.0-rc.3](https://github.com/libp2p/js-libp2p/compare/v0.31.0-rc.2...v0.31.0-rc.3) (2021-04-19)
### Bug Fixes
* remove inline arg types from function definitions ([#916](https://github.com/libp2p/js-libp2p/issues/916)) ([2af692f](https://github.com/libp2p/js-libp2p/commit/2af692fb4de572168524ae684608fc6526de4ef7))
# [0.31.0-rc.2](https://github.com/libp2p/js-libp2p/compare/v0.31.0-rc.1...v0.31.0-rc.2) (2021-04-16)
### Bug Fixes
* metrics stats and moving averages types ([#915](https://github.com/libp2p/js-libp2p/issues/915)) ([3d0a79e](https://github.com/libp2p/js-libp2p/commit/3d0a79eff3bc34a5bdc8ffa31e9b09345a02ad9d))
# [0.31.0-rc.1](https://github.com/libp2p/js-libp2p/compare/v0.31.0-rc.0...v0.31.0-rc.1) (2021-04-16)
### Bug Fixes
* dial protocol should throw if no protocol is provided ([#914](https://github.com/libp2p/js-libp2p/issues/914)) ([21c9aee](https://github.com/libp2p/js-libp2p/commit/21c9aeecb13440238aa6b0fb5a6731d2f87d4938))
### BREAKING CHANGES
* dialProtocol does not return connection when no protocols are provided
# [0.31.0-rc.0](https://github.com/libp2p/js-libp2p/compare/v0.30.12...v0.31.0-rc.0) (2021-04-15)
## [0.30.12](https://github.com/libp2p/js-libp2p/compare/v0.30.11...v0.30.12) (2021-03-27)
### Bug Fixes
* the API of es6-promisify is not the same as promisify-es6 ([#905](https://github.com/libp2p/js-libp2p/issues/905)) ([a7128f0](https://github.com/libp2p/js-libp2p/commit/a7128f07ec8d4b729145ecfc6ad1d585ffddea46))
## [0.30.11](https://github.com/libp2p/js-libp2p/compare/v0.30.10...v0.30.11) (2021-03-23)
### Bug Fixes
* connection direction should be only inbound or outbound ([9504f19](https://github.com/libp2p/js-libp2p/commit/9504f1951a3cca55bb7b4e25e4934e4024034ee8))
* interface-datastore update ([f5c1cd1](https://github.com/libp2p/js-libp2p/commit/f5c1cd1fb07bc73cf9d9da3c2eb4327bed4279a4))
## [0.30.10](https://github.com/libp2p/js-libp2p/compare/v0.30.9...v0.30.10) (2021-03-09)
### Bug Fixes
* conn mgr access to moving averages record object ([#897](https://github.com/libp2p/js-libp2p/issues/897)) ([5f702f3](https://github.com/libp2p/js-libp2p/commit/5f702f3481afd4ad4fbc89f0e9b75a6d56b03520))
## [0.30.9](https://github.com/libp2p/js-libp2p/compare/v0.30.8...v0.30.9) (2021-02-25)
### Bug Fixes
* transport manager fault tolerance should include tolerance to transport listen fail ([#893](https://github.com/libp2p/js-libp2p/issues/893)) ([3f314d5](https://github.com/libp2p/js-libp2p/commit/3f314d5e90f74583b721386d0c9c5d8363cd4de7))
## [0.30.8](https://github.com/libp2p/js-libp2p/compare/v0.30.7...v0.30.8) (2021-02-11)
### Bug Fixes
* routers should only use dht if enabled ([#885](https://github.com/libp2p/js-libp2p/issues/885)) ([a34d2bb](https://github.com/libp2p/js-libp2p/commit/a34d2bbcc3d69ec3006137a909a7e8c53b9d378e))
## [0.30.7](https://github.com/libp2p/js-libp2p/compare/v0.30.6...v0.30.7) (2021-02-01) ## [0.30.7](https://github.com/libp2p/js-libp2p/compare/v0.30.6...v0.30.7) (2021-02-01)
@ -1352,6 +1829,3 @@ 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
View File

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

5
LICENSE-APACHE Normal file
View File

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

19
LICENSE-MIT Normal file
View File

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

View File

@ -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%3D6.0.0-orange.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/Node.js-%3E%3D12.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>
<br> <br>
</p> </p>
@ -39,26 +39,22 @@ If you are looking for the documentation of the latest release, you can view the
**Want to update libp2p in your project?** Check our [migrations folder](./doc/migrations). **Want to update libp2p in your project?** Check our [migrations folder](./doc/migrations).
[**`Weekly Core Dev Calls`**](https://github.com/libp2p/team-mgmt/issues/16) ## Table of Contents <!-- omit in toc -->
## Lead Maintainer
[Jacob Heun](https://github.com/jacobheun/)
## Table of Contents
- [Background](#background) - [Background](#background)
- [Install](#install) - [Install](#install)
- [Usage](#usage) - [Usage](#usage)
- [Configuration](#configuration) - [Configuration](#configuration)
- [API](#api) - [API](#api)
- [Getting Started](#getting-started) - [Getting started](#getting-started)
- [Tutorials and Examples](#tutorials-and-examples) - [Tutorials and Examples](#tutorials-and-examples)
- [Development](#development) - [Development](#development)
- [Tests](#tests) - [Tests](#tests)
- [Run unit tests](#run-unit-tests)
- [Packages](#packages) - [Packages](#packages)
- [Contribute](#contribute) - [Contribute](#contribute)
- [License](#license) - [License](#license)
- [Contribution](#contribution)
## Background ## Background
@ -123,7 +119,7 @@ You can find multiple examples on the [examples folder](./examples) that will gu
> npm run test:node > npm run test:node
# run just Browser tests (Chrome) # run just Browser tests (Chrome)
> npm run test:browser > npm run test:chrome
``` ```
### Packages ### Packages
@ -163,9 +159,9 @@ List of packages currently in existence for libp2p
| [`libp2p-kad-dht`](//github.com/libp2p/js-libp2p-kad-dht) | [![npm](https://img.shields.io/npm/v/libp2p-kad-dht.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-kad-dht/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-kad-dht.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-kad-dht) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-kad-dht/master)](https://travis-ci.com/libp2p/js-libp2p-kad-dht) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-kad-dht/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-kad-dht) | [Vasco Santos](mailto:vasco.santos@moxy.studio) | | [`libp2p-kad-dht`](//github.com/libp2p/js-libp2p-kad-dht) | [![npm](https://img.shields.io/npm/v/libp2p-kad-dht.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-kad-dht/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-kad-dht.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-kad-dht) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-kad-dht/master)](https://travis-ci.com/libp2p/js-libp2p-kad-dht) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-kad-dht/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-kad-dht) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
| **utilities** | | **utilities** |
| [`libp2p-crypto`](//github.com/libp2p/js-libp2p-crypto) | [![npm](https://img.shields.io/npm/v/libp2p-crypto.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-crypto/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-crypto.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-crypto) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-crypto/master)](https://travis-ci.com/libp2p/js-libp2p-crypto) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-crypto/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-crypto) | [Jacob Heun](mailto:jacobheun@gmail.com) | | [`libp2p-crypto`](//github.com/libp2p/js-libp2p-crypto) | [![npm](https://img.shields.io/npm/v/libp2p-crypto.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-crypto/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-crypto.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-crypto) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-crypto/master)](https://travis-ci.com/libp2p/js-libp2p-crypto) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-crypto/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-crypto) | [Jacob Heun](mailto:jacobheun@gmail.com) |
| [`libp2p-crypto-secp256k1`](//github.com/libp2p/js-libp2p-crypto-secp256k1) | [![npm](https://img.shields.io/npm/v/libp2p-crypto-secp256k1.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-crypto-secp256k1/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-crypto-secp256k1.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-crypto-secp256k1) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-crypto-secp256k1/master)](https://travis-ci.com/libp2p/js-libp2p-crypto-secp256k1) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-crypto-secp256k1/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-crypto-secp256k1) | [Friedel Ziegelmayer](mailto:dignifiedquire@gmail.com) |
| **data types** | | **data types** |
| [`peer-id`](//github.com/libp2p/js-peer-id) | [![npm](https://img.shields.io/npm/v/peer-id.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-peer-id/releases) | [![Deps](https://david-dm.org/libp2p/js-peer-id.svg?style=flat-square)](https://david-dm.org/libp2p/js-peer-id) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-peer-id/master)](https://travis-ci.com/libp2p/js-peer-id) | [![codecov](https://codecov.io/gh/libp2p/js-peer-id/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-peer-id) | [Vasco Santos](mailto:santos.vasco10@gmail.com) | | [`peer-id`](//github.com/libp2p/js-peer-id) | [![npm](https://img.shields.io/npm/v/peer-id.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-peer-id/releases) | [![Deps](https://david-dm.org/libp2p/js-peer-id.svg?style=flat-square)](https://david-dm.org/libp2p/js-peer-id) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-peer-id/master)](https://travis-ci.com/libp2p/js-peer-id) | [![codecov](https://codecov.io/gh/libp2p/js-peer-id/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-peer-id) | [Vasco Santos](mailto:santos.vasco10@gmail.com) |
| [`libp2p-record`](//github.com/libp2p/js-libp2p-record) | [![npm](https://img.shields.io/npm/v/libp2p-record.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-record/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-record.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-record) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-record/master)](https://travis-ci.com/libp2p/js-libp2p-record) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-record/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-record) | [Jacob Heun](mailto:santos.vasco10@gmail.com) |
| **pubsub** | | **pubsub** |
| [`libp2p-floodsub`](//github.com/libp2p/js-libp2p-floodsub) | [![npm](https://img.shields.io/npm/v/libp2p-floodsub.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-floodsub/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-floodsub.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-floodsub) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-floodsub/master)](https://travis-ci.com/libp2p/js-libp2p-floodsub) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-floodsub/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-floodsub) | [Vasco Santos](mailto:vasco.santos@moxy.studio) | | [`libp2p-floodsub`](//github.com/libp2p/js-libp2p-floodsub) | [![npm](https://img.shields.io/npm/v/libp2p-floodsub.svg?maxAge=86400&style=flat-square)](//github.com/libp2p/js-libp2p-floodsub/releases) | [![Deps](https://david-dm.org/libp2p/js-libp2p-floodsub.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-floodsub) | [![Travis CI](https://flat.badgen.net/travis/libp2p/js-libp2p-floodsub/master)](https://travis-ci.com/libp2p/js-libp2p-floodsub) | [![codecov](https://codecov.io/gh/libp2p/js-libp2p-floodsub/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-floodsub) | [Vasco Santos](mailto:vasco.santos@moxy.studio) |
| [`libp2p-gossipsub`](//github.com/ChainSafe/js-libp2p-gossipsub) | [![npm](https://img.shields.io/npm/v/libp2p-gossipsub.svg?maxAge=86400&style=flat-square)](//github.com/ChainSafe/js-libp2p-gossipsub/releases) | [![Deps](https://david-dm.org/ChainSafe/js-libp2p-gossipsub.svg?style=flat-square)](https://david-dm.org/ChainSafe/js-libp2p-gossipsub) | [![Travis CI](https://flat.badgen.net/travis/ChainSafe/js-libp2p-gossipsub/master)](https://travis-ci.com/ChainSafe/js-libp2p-gossipsub) | [![codecov](https://codecov.io/gh/ChainSafe/js-libp2p-gossipsub/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ChainSafe/js-libp2p-gossipsub) | [Cayman Nava](mailto:caymannava@gmail.com) | | [`libp2p-gossipsub`](//github.com/ChainSafe/js-libp2p-gossipsub) | [![npm](https://img.shields.io/npm/v/libp2p-gossipsub.svg?maxAge=86400&style=flat-square)](//github.com/ChainSafe/js-libp2p-gossipsub/releases) | [![Deps](https://david-dm.org/ChainSafe/js-libp2p-gossipsub.svg?style=flat-square)](https://david-dm.org/ChainSafe/js-libp2p-gossipsub) | [![Travis CI](https://flat.badgen.net/travis/ChainSafe/js-libp2p-gossipsub/master)](https://travis-ci.com/ChainSafe/js-libp2p-gossipsub) | [![codecov](https://codecov.io/gh/ChainSafe/js-libp2p-gossipsub/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ChainSafe/js-libp2p-gossipsub) | [Cayman Nava](mailto:caymannava@gmail.com) |
@ -183,4 +179,11 @@ The libp2p implementation in JavaScript is a work in progress. As such, there ar
## License ## License
[MIT](LICENSE) © Protocol Labs Licensed under either of
* Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
* MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

View File

@ -3,6 +3,7 @@
* [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)
@ -11,6 +12,9 @@
* [`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)
@ -115,23 +119,21 @@ For Libp2p configurations and modules details read the [Configuration Document](
#### Example #### Example
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
async function main () { async function main () {
// specify options // specify options
const options = { const options = {
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
}
} }
// create libp2p // create libp2p
const libp2p = await Libp2p.create(options) const libp2p = await createLibp2p(options)
} }
main() main()
@ -145,11 +147,11 @@ As an alternative, it is possible to create a Libp2p instance with the construct
#### Example #### Example
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const PeerId = require('peer-id')
async function main () { async function main () {
const peerId = await PeerId.create(); const peerId = await PeerId.create();
@ -158,11 +160,9 @@ async function main () {
// peerId is required when Libp2p is instantiated via the constructor // peerId is required when Libp2p is instantiated via the constructor
const options = { const options = {
peerId, peerId,
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
}
} }
// create libp2p // create libp2p
@ -196,11 +196,11 @@ Load keychain keys from the datastore, importing the private key as 'self', if n
#### Example #### Example
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
// ... // ...
const libp2p = await Libp2p.create({ const libp2p = await createLibp2p({
// ... // ...
keychain: { keychain: {
pass: '0123456789pass1234567890' pass: '0123456789pass1234567890'
@ -226,11 +226,11 @@ Starts the libp2p node.
#### Example #### Example
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
// ... // ...
const libp2p = await Libp2p.create(options) const libp2p = await createLibp2p(options)
// start libp2p // start libp2p
await libp2p.start() await libp2p.start()
@ -251,10 +251,10 @@ Stops the libp2p node.
#### Example #### Example
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
// ... // ...
const libp2p = await Libp2p.create(options) const libp2p = await createLibp2p(options)
// ... // ...
// stop libp2p // stop libp2p
@ -350,7 +350,7 @@ Dials to another peer in the network and selects a protocol to communicate with
```js ```js
// ... // ...
const pipe = require('it-pipe') import { pipe } from 'it-pipe'
const { stream, protocol } = await libp2p.dialProtocol(remotePeerId, protocols) const { stream, protocol } = await libp2p.dialProtocol(remotePeerId, protocols)
@ -454,6 +454,72 @@ 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
@ -2086,7 +2152,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-interfaces/tree/master/src/connection [connection]: https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/interfaces/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

View File

@ -1,6 +1,5 @@
# Configuration #
- [Configuration](#configuration)
- [Overview](#overview) - [Overview](#overview)
- [Modules](#modules) - [Modules](#modules)
- [Transport](#transport) - [Transport](#transport)
@ -24,6 +23,9 @@
- [Setup with Keychain](#setup-with-keychain) - [Setup with Keychain](#setup-with-keychain)
- [Configuring Dialing](#configuring-dialing) - [Configuring Dialing](#configuring-dialing)
- [Configuring Connection Manager](#configuring-connection-manager) - [Configuring Connection Manager](#configuring-connection-manager)
- [Configuring Connection Gater](#configuring-connection-gater)
- [Outgoing connections](#outgoing-connections)
- [Incoming connections](#incoming-connections)
- [Configuring Transport Manager](#configuring-transport-manager) - [Configuring Transport Manager](#configuring-transport-manager)
- [Configuring Metrics](#configuring-metrics) - [Configuring Metrics](#configuring-metrics)
- [Configuring PeerStore](#configuring-peerstore) - [Configuring PeerStore](#configuring-peerstore)
@ -31,6 +33,7 @@
- [Configuring the NAT Manager](#configuring-the-nat-manager) - [Configuring the NAT Manager](#configuring-the-nat-manager)
- [Browser support](#browser-support) - [Browser support](#browser-support)
- [UPnP and NAT-PMP](#upnp-and-nat-pmp) - [UPnP and NAT-PMP](#upnp-and-nat-pmp)
- [Configuring protocol name](#configuring-protocol-name)
- [Configuration examples](#configuration-examples) - [Configuration examples](#configuration-examples)
## Overview ## Overview
@ -196,9 +199,9 @@ When [creating a libp2p node](./API.md#create), the modules needed should be spe
```js ```js
const modules = { const modules = {
transport: [], transports: [],
streamMuxer: [], streamMuxers: [],
connEncryption: [], connectionEncryption: [],
contentRouting: [], contentRouting: [],
peerRouting: [], peerRouting: [],
peerDiscovery: [], peerDiscovery: [],
@ -210,7 +213,7 @@ const modules = {
Moreover, the majority of the modules can be customized via option parameters. This way, it is also possible to provide this options through a `config` object. This config object should have the property name of each building block to configure, the same way as the modules specification. Moreover, the majority of the modules can be customized via option parameters. This way, it is also possible to provide this options through a `config` object. This config object should have the property name of each building block to configure, the same way as the modules specification.
Besides the `modules` and `config`, libp2p allows other internal options and configurations: Besides the `modules` and `config`, libp2p allows other internal options and configurations:
- `datastore`: an instance of [ipfs/interface-datastore](https://github.com/ipfs/interface-datastore/) modules. - `datastore`: an instance of [ipfs/interface-datastore](https://github.com/ipfs/js-ipfs-interfaces/tree/master/packages/interface-datastore) modules.
- This is used in modules such as the DHT. If it is not provided, `js-libp2p` will use an in memory datastore. - This is used in modules such as the DHT. If it is not provided, `js-libp2p` will use an in memory datastore.
- `peerId`: the identity of the node, an instance of [libp2p/js-peer-id](https://github.com/libp2p/js-peer-id). - `peerId`: the identity of the node, an instance of [libp2p/js-peer-id](https://github.com/libp2p/js-peer-id).
- This is particularly useful if you want to reuse the same `peer-id`, as well as for modules like `libp2p-delegated-content-routing`, which need a `peer-id` in their instantiation. - This is particularly useful if you want to reuse the same `peer-id`, as well as for modules like `libp2p-delegated-content-routing`, which need a `peer-id` in their instantiation.
@ -232,67 +235,59 @@ Besides the `modules` and `config`, libp2p allows other internal options and con
// dht: kad-dht // dht: kad-dht
// pubsub: gossipsub // pubsub: gossipsub
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const WS = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MulticastDNS = require('libp2p-mdns') import { MulticastDNS } from '@libp2p/mdns'
const DHT = require('libp2p-kad-dht') import { KadDHT } from '@libp2p/kad-dht'
const GossipSub = require('libp2p-gossipsub') import { GossipSub } from 'libp2p-gossipsub'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [ new TCP(),
TCP, new WS()
new WS() // It can take instances too!
], ],
streamMuxer: [MPLEX], streamMuxers: [new Mplex()],
connEncryption: [NOISE], connectionEncryption: [new Noise()],
peerDiscovery: [MulticastDNS], peerDiscovery: [MulticastDNS],
dht: DHT, dht: DHT,
pubsub: GossipSub pubsub: GossipSub
}
}) })
``` ```
#### Customizing Peer Discovery #### Customizing Peer Discovery
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MulticastDNS = require('libp2p-mdns') import { MulticastDNS } from '@libp2p/mdns'
const Bootstrap = require('libp2p-bootstrap') import { Bootstrap } from '@libp2p/bootstrap'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE], peerDiscovery: [
peerDiscovery: [MulticastDNS, Bootstrap] new MulticastDNS({
}, interval: 1000
config: { }),
peerDiscovery: { new Bootstrap(
autoDial: true, // Auto connect to discovered peers (limited by ConnectionManager minConnections)
// 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.
[MulticastDNS.tag]: {
interval: 1000,
enabled: true
},
[Bootstrap.tag:] {
list: [ // A list of bootstrap peers to connect to starting up the node list: [ // A list of bootstrap peers to connect to starting up the node
"/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ", "/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ",
"/dnsaddr/bootstrap.libp2p.io/ipfs/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN", "/dnsaddr/bootstrap.libp2p.io/ipfs/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN",
"/dnsaddr/bootstrap.libp2p.io/ipfs/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa", "/dnsaddr/bootstrap.libp2p.io/ipfs/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa",
], ],
interval: 2000, interval: 2000
enabled: true )
} ],
// .. other discovery module options. 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.
} }
}) })
``` ```
@ -300,56 +295,50 @@ const node = await Libp2p.create({
#### Setup webrtc transport and discovery #### Setup webrtc transport and discovery
```js ```js
import { createLibp2p } from 'libp2p'
import { WebSockets } from '@libp2p/websockets'
import { WebRTCStar } from '@libp2p/webrtc-star'
import { Mplex } from '@libp2p/mplex'
import { Noise } from '@chainsafe/libp2p-noise'
const Libp2p = require('libp2p') const node = await createLibp2p({
const WS = require('libp2p-websockets') transports: [
const WebRTCStar = require('libp2p-webrtc-star') new WebSockets(),
const MPLEX = require('libp2p-mplex') new WebRTCStar()
const { NOISE } = require('libp2p-noise')
const node = await Libp2p.create({
modules: {
transport: [
WS,
WebRTCStar
], ],
streamMuxer: [MPLEX], streamMuxers: [
connEncryption: [NOISE], new Mplex()
}, ],
config: { connectionEncryption: [
peerDiscovery: { new Noise()
[WebRTCStar.tag]: { ]
enabled: true
}
}
}
}) })
``` ```
#### Customizing Pubsub #### Customizing Pubsub
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const GossipSub = require('libp2p-gossipsub') import { GossipSub } from 'libp2p-gossipsub'
import { SignaturePolicy } from '@libp2p/interfaces/pubsub'
const { SignaturePolicy } = require('libp2p-interfaces/src/pubsub/signature-policy') const node = await createLibp2p({
transports: [
const node = await Libp2p.create({ new TCP()
modules: { ],
transport: [TCP], streamMuxers: [
streamMuxer: [MPLEX], new Mplex()
connEncryption: [NOISE], ],
pubsub: GossipSub connectionEncryption: [
}, new Noise()
config: { ],
pubsub: { // The pubsub options (and defaults) can be found in the pubsub router documentation pubsub: new GossipSub({
enabled: true,
emitSelf: false, // whether the node should emit to self on publish emitSelf: false, // whether the node should emit to self on publish
globalSignaturePolicy: SignaturePolicy.StrictSign // message signing policy globalSignaturePolicy: SignaturePolicy.StrictSign // message signing policy
} })
} }
}) })
``` ```
@ -357,59 +346,66 @@ const node = await Libp2p.create({
#### Customizing DHT #### Customizing DHT
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const DHT = require('libp2p-kad-dht') import { KadDHT } from '@libp2p/kad-dht'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [TCP], new TCP()
streamMuxer: [MPLEX], ],
connEncryption: [NOISE], streamMuxers: [
dht: DHT new Mplex()
}, ],
config: { connectionEncryption: [
dht: { // The DHT options (and defaults) can be found in its documentation new Noise()
],
dht: new KadDHT({
kBucketSize: 20, kBucketSize: 20,
enabled: true, clientMode: false // Whether to run the WAN DHT in client or server mode (default: client mode)
randomWalk: { })
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
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const DelegatedPeerRouter = require('libp2p-delegated-peer-routing') import { create as ipfsHttpClient } from 'ipfs-http-client'
const DelegatedContentRouter = require('libp2p-delegated-content-routing') import { DelegatedPeerRouting } from '@libp2p/delegated-peer-routing'
const PeerId = require('peer-id') import { DelegatedContentRouting} from '@libp2p/delegated-content-routing'
// create a peerId // create a peerId
const peerId = await PeerId.create() const peerId = await PeerId.create()
const node = await Libp2p.create({ const delegatedPeerRouting = new DelegatedPeerRouting(ipfsHttpClient.create({
modules: { host: 'node0.delegate.ipfs.io', // In production you should setup your own delegates
transport: [TCP], protocol: 'https',
streamMuxer: [MPLEX], port: 443
connEncryption: [NOISE], }))
const delegatedContentRouting = new DelegatedContentRouting(peerId, ipfsHttpClient.create({
host: 'node0.delegate.ipfs.io', // In production you should setup your own delegates
protocol: 'https',
port: 443
}))
const node = await createLibp2p({
transports: [new TCP()],
streamMuxers: [new Mplex()],
connectionEncryption: [new Noise()],
contentRouting: [ contentRouting: [
new DelegatedContentRouter(peerId) delegatedContentRouting
], ],
peerRouting: [ peerRouting: [
new DelegatedPeerRouter() 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
@ -424,18 +420,15 @@ const node = await Libp2p.create({
#### Setup with Relay #### Setup with Relay
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE]
},
config: {
relay: { // Circuit Relay options (this config is part of libp2p core configurations) relay: { // Circuit Relay options (this config is part of libp2p core configurations)
enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay. enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay.
hop: { hop: {
@ -448,25 +441,21 @@ const node = await Libp2p.create({
ttl: 30 * 60 * 1000 // Delay Between HOP relay service advertisements on the network ttl: 30 * 60 * 1000 // Delay Between HOP relay service advertisements on the network
} }
} }
}
}) })
``` ```
#### Setup with Auto Relay #### Setup with Auto Relay
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
},
config: {
relay: { // Circuit Relay options (this config is part of libp2p core configurations) relay: { // Circuit Relay options (this config is part of libp2p core configurations)
enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay. enabled: true, // Allows you to dial and accept relayed connections. Does not make you a relay.
autoRelay: { autoRelay: {
@ -474,7 +463,6 @@ const node = await Libp2p.create({
maxListeners: 2 // Configure maximum number of HOP relays to use maxListeners: 2 // Configure maximum number of HOP relays to use
} }
} }
}
}) })
``` ```
@ -488,25 +476,26 @@ Libp2p allows you to setup a secure keychain to manage your keys. The keychain c
| datastore | `object` | must implement [ipfs/interface-datastore](https://github.com/ipfs/interface-datastore) | | datastore | `object` | must implement [ipfs/interface-datastore](https://github.com/ipfs/interface-datastore) |
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const LevelStore = require('datastore-level') import { LevelDatastore } from 'datastore-level'
const node = await Libp2p.create({ const datastore = new LevelDatastore('path/to/store')
modules: { await datastore.open()
transport: [TCP],
streamMuxer: [MPLEX], const node = await createLibp2p({
connEncryption: [NOISE] transports: [new TCP()],
}, streamMuxers: [new Mplex()],
connectionEncryption: [new Noise()],
keychain: { keychain: {
pass: 'notsafepassword123456789', pass: 'notsafepassword123456789',
datastore: new LevelStore('path/to/store') datastore: dsInstant,
} }
}) })
await libp2p.loadKeychain() await node.loadKeychain()
``` ```
#### Configuring Dialing #### Configuring Dialing
@ -516,6 +505,7 @@ Dialing in libp2p can be configured to limit the rate of dialing, and how long d
| Name | Type | Description | | Name | Type | Description |
|------|------|-------------| |------|------|-------------|
| maxParallelDials | `number` | How many multiaddrs we can dial in parallel. | | maxParallelDials | `number` | How many multiaddrs we can dial in parallel. |
| maxAddrsToDial | `number` | How many multiaddrs is the dial allowed to dial for a single peer. |
| maxDialsPerPeer | `number` | How many multiaddrs we can dial per peer, in parallel. | | maxDialsPerPeer | `number` | How many multiaddrs we can dial per peer, in parallel. |
| dialTimeout | `number` | Second dial timeout per peer in ms. | | dialTimeout | `number` | Second dial timeout per peer in ms. |
| resolvers | `object` | Dial [Resolvers](https://github.com/multiformats/js-multiaddr/blob/master/src/resolvers/index.js) for resolving multiaddrs | | resolvers | `object` | Dial [Resolvers](https://github.com/multiformats/js-multiaddr/blob/master/src/resolvers/index.js) for resolving multiaddrs |
@ -524,22 +514,21 @@ Dialing in libp2p can be configured to limit the rate of dialing, and how long d
The below configuration example shows how the dialer should be configured, with the current defaults: The below configuration example shows how the dialer should be configured, with the current defaults:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const { dnsaddrResolver } = require('multiaddr/src/resolvers') import { dnsaddrResolver } from '@multiformats/multiaddr/resolvers'
const { publicAddressesFirst } = require('libp2p-utils/src/address-sort') import { publicAddressesFirst } from '@libp2p-utils/address-sort'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE]
},
dialer: { dialer: {
maxParallelDials: 100, maxParallelDials: 100,
maxAddrsToDial: 25,
maxDialsPerPeer: 4, maxDialsPerPeer: 4,
dialTimeout: 30e3, dialTimeout: 30e3,
resolvers: { resolvers: {
@ -554,17 +543,15 @@ const node = await Libp2p.create({
The Connection Manager prunes Connections in libp2p whenever certain limits are exceeded. If Metrics are enabled, you can also configure the Connection Manager to monitor the bandwidth of libp2p and prune connections as needed. You can read more about what Connection Manager does at [./CONNECTION_MANAGER.md](./CONNECTION_MANAGER.md). The configuration values below show the defaults for Connection Manager. See [./CONNECTION_MANAGER.md](./CONNECTION_MANAGER.md#options) for a full description of the parameters. The Connection Manager prunes Connections in libp2p whenever certain limits are exceeded. If Metrics are enabled, you can also configure the Connection Manager to monitor the bandwidth of libp2p and prune connections as needed. You can read more about what Connection Manager does at [./CONNECTION_MANAGER.md](./CONNECTION_MANAGER.md). The configuration values below show the defaults for Connection Manager. See [./CONNECTION_MANAGER.md](./CONNECTION_MANAGER.md#options) for a full description of the parameters.
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()],
connEncryption: [NOISE]
},
connectionManager: { connectionManager: {
maxConnections: Infinity, maxConnections: Infinity,
minConnections: 0, minConnections: 0,
@ -580,24 +567,142 @@ const node = await Libp2p.create({
}) })
``` ```
#### Configuring Transport Manager #### Configuring Connection Gater
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: 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 ```js
const Libp2p = require('libp2p') const node = await createLibp2p({
const TCP = require('libp2p-tcp') // .. other config
const MPLEX = require('libp2p-mplex') connectionGater: {
const { NOISE } = require('libp2p-noise') /**
* 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>
const { FaultTolerance } = require('libp2p/src/transport-manager')} /**
* 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>
const node = await Libp2p.create({ /**
modules: { * denyInboundConnection tests whether an incipient inbound connection is allowed.
transport: [TCP], *
streamMuxer: [MPLEX], * This is called by the upgrader, or by the transport directly (e.g. QUIC,
connEncryption: [NOISE] * 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
The Transport Manager is responsible for managing the libp2p transports life cycle. This includes starting listeners for the provided listen addresses, closing these listeners and dialing using the provided transports. By default, if a libp2p node has a list of multiaddrs for listening on and there are no valid transports for those multiaddrs, libp2p will throw an error on startup and shutdown. However, for some applications it is perfectly acceptable for libp2p nodes to start in dial only mode if all the listen multiaddrs failed. This error tolerance can be enabled as follows:
```js
import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'
import { Mplex } from '@libp2p/mplex'
import { Noise } from '@chainsafe/libp2p-noise'
import { FaultTolerance } from 'libp2p/transport-manager'
const node = await createLibp2p({
transports: [new TCP()],
streamMuxers: [new Mplex()],
connectionEncryption: [new Noise()],
transportManager: { transportManager: {
faultTolerance: FaultTolerance.NO_FATAL faultTolerance: FaultTolerance.NO_FATAL
} }
@ -619,17 +724,15 @@ Metrics are disabled in libp2p by default. You can enable and configure them as
The below configuration example shows how the metrics should be configured. Aside from enabled being `false` by default, the following default configuration options are listed below: The below configuration example shows how the metrics should be configured. Aside from enabled being `false` by default, the following default configuration options are listed below:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX], connectionEncryption: [new Noise()]
connEncryption: [NOISE]
},
metrics: { metrics: {
enabled: true, enabled: true,
computeThrottleMaxQueueSize: 1000, computeThrottleMaxQueueSize: 1000,
@ -658,20 +761,20 @@ The threshold number represents the maximum number of "dirty peers" allowed in t
The below configuration example shows how the PeerStore should be configured. Aside from persistence being `false` by default, the following default configuration options are listed below: The below configuration example shows how the PeerStore should be configured. Aside from persistence being `false` by default, the following default configuration options are listed below:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
import { LevelDatastore } from 'datastore-level'
const LevelStore = require('datastore-level') const datastore = new LevelDatastore('path/to/store')
await datastore.open() // level database must be ready before node boot
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { datastore, // pass the opened datastore
transport: [TCP], transports: [new TCP()],
streamMuxer: [MPLEX], streamMuxers: [new Mplex()],
connEncryption: [NOISE] connectionEncryption: [new Noise()],
},
datastore: new LevelStore('path/to/store'),
peerStore: { peerStore: {
persistence: true, persistence: true,
threshold: 5 threshold: 5
@ -684,19 +787,23 @@ const node = await Libp2p.create({
Some Transports can be passed additional options when they are created. For example, `libp2p-webrtc-star` accepts an optional, custom `wrtc` implementation. In addition to libp2p passing itself and an `Upgrader` to handle connection upgrading, libp2p will also pass the options, if they are provided, from `config.transport`. Some Transports can be passed additional options when they are created. For example, `libp2p-webrtc-star` accepts an optional, custom `wrtc` implementation. In addition to libp2p passing itself and an `Upgrader` to handle connection upgrading, libp2p will also pass the options, if they are provided, from `config.transport`.
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const WebRTCStar = require('libp2p-webrtc-star') import { WebRTCStar } from '@libp2p/webrtc-star'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const wrtc = require('wrtc') import wrtc from 'wrtc'
const transportKey = WebRTCStar.prototype[Symbol.toStringTag] const transportKey = WebRTCStar.prototype[Symbol.toStringTag]
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [WebRTCStar], new WebRTCStar()
streamMuxer: [MPLEX], ],
connEncryption: [NOISE] streamMuxers: [
}, new Mplex()
],
connectionEncryption: [
new Noise()
],
config: { config: {
transport: { transport: {
[transportKey]: { [transportKey]: {
@ -711,12 +818,16 @@ During Libp2p startup, transport listeners will be created for the configured li
```js ```js
const transportKey = WebRTCStar.prototype[Symbol.toStringTag] const transportKey = WebRTCStar.prototype[Symbol.toStringTag]
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [WebRTCStar], new WebRTCStar()
streamMuxer: [MPLEX], ],
connEncryption: [NOISE] streamMuxers: [
}, new Mplex()
],
connectionEncryption: [
new Noise()
],
addresses: { addresses: {
listen: ['/dns4/your-wrtc-star.pub/tcp/443/wss/p2p-webrtc-star'] // your webrtc dns multiaddr listen: ['/dns4/your-wrtc-star.pub/tcp/443/wss/p2p-webrtc-star'] // your webrtc dns multiaddr
}, },
@ -743,18 +854,16 @@ Network Address Translation (NAT) is a function performed by your router to enab
The NAT manager can be configured as follows: The NAT manager can be configured as follows:
```js ```js
const node = await Libp2p.create({ const node = await createLibp2p({
config: { config: {
nat: { nat: {
description: 'my-node', // set as the port mapping description on the router, defaults the current libp2p version and your peer id description: 'my-node', // set as the port mapping description on the router, defaults the current libp2p version and your peer id
enabled: true, // defaults to true enabled: true, // defaults to true
gateway: '192.168.1.1', // leave unset to auto-discover gateway: '192.168.1.1', // leave unset to auto-discover
externalIp: '80.1.1.1', // leave unset to auto-discover externalIp: '80.1.1.1', // leave unset to auto-discover
localAddress: '129.168.1.123', // leave unset to auto-discover
ttl: 7200, // TTL for port mappings (min 20 minutes) ttl: 7200, // TTL for port mappings (min 20 minutes)
keepAlive: true, // Refresh port mapping after TTL expires keepAlive: true, // Refresh port mapping after TTL expires
pmp: {
enabled: false, // defaults to false
}
} }
} }
}) })
@ -770,12 +879,29 @@ By default under nodejs libp2p will attempt to use [UPnP](https://en.wikipedia.o
[NAT-PMP](http://miniupnp.free.fr/nat-pmp.html) is a feature of some modern routers which performs a similar job to UPnP. NAT-PMP is disabled by default, if enabled libp2p will try to use NAT-PMP and will fall back to UPnP if it fails. [NAT-PMP](http://miniupnp.free.fr/nat-pmp.html) is a feature of some modern routers which performs a similar job to UPnP. NAT-PMP is disabled by default, if enabled libp2p will try to use NAT-PMP and will fall back to UPnP if it fails.
#### Configuring protocol name
Changing the protocol name prefix can isolate default public network (IPFS) for custom purposes.
```js
const node = await createLibp2p({
protocolPrefix: 'ipfs' // default
})
/*
protocols: [
"/ipfs/id/1.0.0", // identify service protocol (if we have multiplexers)
"/ipfs/id/push/1.0.0", // identify service push protocol (if we have multiplexers)
"/ipfs/ping/1.0.0", // built-in ping protocol
]
*/
```
## 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/src/core/runtime/libp2p-nodejs.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-core-config/src/libp2p.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/src/core/runtime/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-core-config/src/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.

View File

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

View File

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

View File

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

View File

@ -4,6 +4,8 @@ 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)
- [Table of Contents](#table-of-contents)
- [Migrating from callbacks](#migrating-from-callbacks) - [Migrating from callbacks](#migrating-from-callbacks)
- [Pull Streams to Streaming Iterables](#pull-streams-to-streaming-iterables) - [Pull Streams to Streaming Iterables](#pull-streams-to-streaming-iterables)
- [Sample API Migrations](#sample-api-migrations) - [Sample API Migrations](#sample-api-migrations)

View File

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

View File

@ -5,7 +5,11 @@ 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)
- [Table of Contents](#table-of-contents)
- [API](#api) - [API](#api)
- [Pubsub](#pubsub)
- [Addresses](#addresses)
- [Development and Testing](#development-and-testing) - [Development and Testing](#development-and-testing)
- [Module Updates](#module-updates) - [Module Updates](#module-updates)
@ -20,8 +24,8 @@ Now `js-libp2p` does not overwrite the pubsub router options anymore. Upstream p
**Before** **Before**
```js ```js
const Gossipsub = require('libp2p-gossipsub') const Gossipsub from 'libp2p-gossipsub')
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
modules: { modules: {
@ -34,8 +38,8 @@ const libp2p = await Libp2p.create({
**After** **After**
```js ```js
const Gossipsub = require('libp2p-gossipsub') const Gossipsub from 'libp2p-gossipsub')
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
modules: { modules: {
@ -57,8 +61,8 @@ The signing property is now based on a `globalSignaturePolicy` option instead of
**Before** **Before**
```js ```js
const Gossipsub = require('libp2p-gossipsub') const Gossipsub from 'libp2p-gossipsub')
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
modules: { modules: {
@ -77,9 +81,9 @@ const libp2p = await Libp2p.create({
**After** **After**
```js ```js
const Gossipsub = require('libp2p-gossipsub') const Gossipsub from 'libp2p-gossipsub')
const { SignaturePolicy } = require('libp2p-interfaces/src/pubsub/signature-policy') const { SignaturePolicy } from 'libp2p-interfaces/src/pubsub/signature-policy')
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
modules: { modules: {
@ -101,7 +105,7 @@ Libp2p has supported `noAnnounce` addresses configuration for some time now. How
**Before** **Before**
```js ```js
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
addresses: { addresses: {
@ -115,10 +119,10 @@ const libp2p = await Libp2p.create({
**After** **After**
```js ```js
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
// Libp2p utils has several multiaddr utils you can leverage // Libp2p utils has several multiaddr utils you can leverage
const isPrivate = require('libp2p-utils/src/multiaddr/is-private') const isPrivate from 'libp2p-utils/src/multiaddr/is-private')
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({
addresses: { addresses: {
@ -145,9 +149,9 @@ While this is not an API breaking change, there was a behavioral breaking change
With this new behavior, if you need to use non DNS addresses, you can configure your libp2p node as follows: With this new behavior, if you need to use non DNS addresses, you can configure your libp2p node as follows:
```js ```js
const Websockets = require('libp2p-websockets') const Websockets from 'libp2p-websockets')
const filters = require('libp2p-websockets/src/filters') const filters from 'libp2p-websockets/src/filters')
const Libp2p = require('libp2p') const Libp2p from 'libp2p')
const transportKey = Websockets.prototype[Symbol.toStringTag] const transportKey = Websockets.prototype[Symbol.toStringTag]
const libp2p = await Libp2p.create({ const libp2p = await Libp2p.create({

View File

@ -0,0 +1,123 @@
<!--Specify versions for migration below-->
# Migrating to libp2p@31
A migration guide for refactoring your application code from libp2p v0.30.x to v0.31.0.
## Table of Contents
- [Types](#types)
- [API](#api)
- [Module Updates](#module-updates)
## Types
Most of the type definitions in the libp2p configuration were `any` or were not included before this release. This might cause breaking changes on upstream projects relying on the previous provided types, as well as to libp2p modules implemented by the libp2p community.
## API
### Core API
`libp2p.dialProtocol` does not accept empty or null protocols returning a connection anymore and `dial` must be used instead.
```js
const connection = await libp2p.dialProtocol(peerId)
```
**After**
```js
const connection = await libp2p.dial(peerId)
```
### Connection Manager Options
We updated the connection manager options naming in `libp2p@0.29` but kept it backward compatible until now.
**Before**
```js
const node = await Libp2p.create({
connectionManager: {
minPeers: 0
}
})
```
**After**
```js
const node = await Libp2p.create({
connectionManager: {
minConnections: 0
}
})
```
You can see full details on how to configure the connection manager [here](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md#configuring-connection-manager).
### Dialer and Keychain components
Internal property names to create a libp2p `Dialer` and `Keychain` were updated to reflect the properties naming in the libp2p configuration. These are internal modules of libp2p core and should not impact most of the users, but as it is possible to use them separately here follow the changes:
***Before**
```js
const dialer = new Dialer({
transportManager,
peerStore,
concurrency,
perPeerLimit,
timeout,
resolvers,
addressSorter
})
const keychain = new Keychain(datastore, {
passPhrase
})
```
**After**
```js
this.dialer = new Dialer({
transportManager,
peerStore,
maxParallelDials,
maxDialsPerPeer,
dialTimeout,
resolvers,
addressSorter
})
const keychain = new Keychain(datastore, {
pass
})
```
## Module Updates
With this release you should update the following libp2p modules if you are relying on them:
<!--Specify module versions in JSON for migration below.
It's recommended to check package.json changes for this:
`git diff <release> <prev> -- package.json`
-->
```json
"libp2p-bootstrap": "^0.12.3",
"libp2p-crypto": "^0.19.4",
"libp2p-interfaces": "^0.10.0",
"libp2p-delegated-content-routing": "^0.10.0",
"libp2p-delegated-peer-routing": "^0.9.0",
"libp2p-floodsub": "^0.25.1",
"libp2p-gossipsub": "^0.9.0",
"libp2p-kad-dht": "^0.22.0",
"libp2p-mdns": "^0.16.0",
"libp2p-noise": "^3.0.0",
"libp2p-tcp": "^0.15.4",
"libp2p-webrtc-star": "^0.22.2",
"libp2p-websockets": "^0.15.6"
```
One of the main changes in this new release is the update to `multiaddr@9.0.0`. This should also be updated in upstream projects to avoid several multiaddr versions in the bundle and to avoid potential problems when libp2p interacts with provided outdated multiaddr instances.

View File

@ -0,0 +1,36 @@
<!--Specify versions for migration below-->
# Migrating to libp2p@32
A migration guide for refactoring your application code from libp2p v0.31.x to v0.32.0.
## Table of Contents
- [Module Updates](#module-updates)
## Module Updates
With this release you should update the following libp2p modules if you are relying on them:
<!--Specify module versions in JSON for migration below.
It's recommended to check package.json changes for this:
`git diff <release> <prev> -- package.json`
-->
```json
"libp2p-bootstrap": "^0.13.0",
"libp2p-crypto": "^0.19.4",
"libp2p-interfaces": "^1.0.0",
"libp2p-delegated-content-routing": "^0.11.0",
"libp2p-delegated-peer-routing": "^0.10.0",
"libp2p-floodsub": "^0.27.0",
"libp2p-gossipsub": "^0.11.0",
"libp2p-kad-dht": "^0.23.0",
"libp2p-mdns": "^0.17.0",
"libp2p-noise": "^4.0.0",
"libp2p-tcp": "^0.17.0",
"libp2p-webrtc-direct": "^0.7.0",
"libp2p-webrtc-star": "^0.23.0",
"libp2p-websockets": "^0.16.0"
```
One of the main changes in this new release is the update to `multiaddr@10.0.0`. This should also be updated in upstream projects to avoid several multiaddr versions in the bundle and to avoid potential problems when libp2p interacts with provided outdated multiaddr instances.

View File

@ -0,0 +1,14 @@
<!--Specify versions for migration below-->
# Migrating to libp2p@33
A migration guide for refactoring your application code from libp2p v0.32.x to v0.33.0.
## Table of Contents
- [Module Updates](#module-updates)
## Module Updates
Libp2p uses a datastore implementation for Peerstore persistence and for the DHT state. While libp2p defaults to a datastore implementation, it can receive any implementation of a datastore compliant with the [interface-datastore](https://github.com/ipfs/js-ipfs-interfaces/tree/master/packages/interface-datastore) via its configuration.
In this release, we updated to `interface-datastore@6.0.0`. As a result, libp2p users relying on a configured datastore should update it to a compliant implementation for updating libp2p.

View File

@ -0,0 +1,256 @@
<!--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)
## 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
**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
]
},
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
})
]
})
```
## 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)
```

View File

@ -8,7 +8,7 @@ Let us know if you find any issues, or if you want to contribute and add a new t
- [Transports](./transports) - [Transports](./transports)
- [Protocol and Stream Muxing](./protocol-and-stream-muxing) - [Protocol and Stream Muxing](./protocol-and-stream-muxing)
- [Encrypted Communications](./encrypted-communications) - [Connection Encryption](./connection-encryption)
- [Discovery Mechanisms](./discovery-mechanisms) - [Discovery Mechanisms](./discovery-mechanisms)
- [Peer and Content Routing](./peer-and-content-routing) - [Peer and Content Routing](./peer-and-content-routing)
- [PubSub](./pubsub) - [PubSub](./pubsub)

View File

@ -16,23 +16,20 @@ In the first step of this example, we need to configure and run a relay node in
The relay node will need to have its relay subsystem enabled, as well as its HOP capability. It can be configured as follows: The relay node will need to have its relay subsystem enabled, as well as its HOP capability. It can be configured as follows:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Websockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new WebSockets()],
transport: [Websockets], connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()]
streamMuxer: [MPLEX]
},
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0/ws'] listen: ['/ip4/0.0.0.0/tcp/0/ws']
// TODO check "What is next?" section // TODO check "What is next?" section
// announce: ['/dns4/auto-relay.libp2p.io/tcp/443/wss/p2p/QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3'] // announce: ['/dns4/auto-relay.libp2p.io/tcp/443/wss/p2p/QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3']
}, },
config: {
relay: { relay: {
enabled: true, enabled: true,
hop: { hop: {
@ -42,7 +39,6 @@ const node = await Libp2p.create({
enabled: true, enabled: true,
} }
} }
}
}) })
await node.start() await node.start()
@ -74,23 +70,20 @@ Listening on:
One of the typical use cases for Auto Relay is nodes behind a NAT or browser nodes due to their inability to expose a public address. For running a libp2p node that automatically binds itself to connected HOP relays, you can see the following: One of the typical use cases for Auto Relay is nodes behind a NAT or browser nodes due to their inability to expose a public address. For running a libp2p node that automatically binds itself to connected HOP relays, you can see the following:
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Websockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const relayAddr = process.argv[2] const relayAddr = process.argv[2]
if (!relayAddr) { if (!relayAddr) {
throw new Error('the relay address needs to be specified as a parameter') throw new Error('the relay address needs to be specified as a parameter')
} }
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new WebSockets()],
transport: [Websockets], connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()],
streamMuxer: [MPLEX]
},
config: {
relay: { relay: {
enabled: true, enabled: true,
autoRelay: { autoRelay: {
@ -98,7 +91,6 @@ const node = await Libp2p.create({
maxListeners: 2 maxListeners: 2
} }
} }
}
}) })
await node.start() await node.start()
@ -106,18 +98,15 @@ 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
await new Promise((resolve) => {
node.peerStore.on('change:multiaddrs', ({ peerId }) => { node.peerStore.on('change:multiaddrs', ({ peerId }) => {
// Updated self multiaddrs? // Updated self multiaddrs?
if (peerId.equals(node.peerId)) { if (peerId.equals(node.peerId)) {
resolve() console.log(`Advertising with a relay address of ${node.multiaddrs[0].toString()}/p2p/${node.peerId.toB58String()}`)
} }
}) })
})
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.
@ -125,7 +114,7 @@ As you can see in the code, we need to provide the relay address, `relayAddr`, a
You should now run the following to start the node running Auto Relay: You should now run the following to start the node running Auto Relay:
```sh ```sh
node listener.js /ip4/192.168.1.120/tcp/58941/ws/p2p/QmQKCBm87HQMbFqy14oqC85pMmnRrj6iD46ggM6reqNpsd node listener.js /ip4/192.168.1.120/tcp/61592/ws/p2p/QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3
``` ```
This should print out something similar to the following: This should print out something similar to the following:
@ -145,22 +134,20 @@ Instead of dialing this relay manually, you could set up this node with the Boot
Now that you have a relay node and a node bound to that relay, you can test connecting to the auto relay node via the relay. Now that you have a relay node and a node bound to that relay, you can test connecting to the auto relay node via the relay.
```js ```js
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Websockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const autoRelayNodeAddr = process.argv[2] const autoRelayNodeAddr = process.argv[2]
if (!autoRelayNodeAddr) { if (!autoRelayNodeAddr) {
throw new Error('the auto relay node address needs to be specified') throw new Error('the auto relay node address needs to be specified')
} }
const node = await Libp2p.create({ const node = await createLibp2p({
modules: { transports: [new WebSockets()],
transport: [Websockets], connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()]
streamMuxer: [MPLEX]
}
}) })
await node.start() await node.start()
@ -173,7 +160,7 @@ console.log(`Connected to the auto relay node via ${conn.remoteAddr.toString()}`
You should now run the following to start the relay node using the listen address from step 2: You should now run the following to start the relay node using the listen address from step 2:
```sh ```sh
node dialer.js /ip4/192.168.1.120/tcp/58941/ws/p2p/QmQKCBm87HQMbFqy14oqC85pMmnRrj6iD46ggM6reqNpsd node dialer.js /ip4/192.168.1.120/tcp/61592/ws/p2p/QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3
``` ```
Once you start your test node, it should print out something similar to the following: Once you start your test node, it should print out something similar to the following:

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -8,22 +8,22 @@ A byproduct of having these encrypted communications modules is that we can auth
# 1. Set up encrypted communications # 1. Set up encrypted communications
We will build this example on top of example for [Protocol and Stream Multiplexing](../protocol-and-stream-multiplexing). You will need the `libp2p-noise` module to complete it, go ahead and `npm install libp2p-noise`. We will build this example on top of example for [Protocol and Stream Multiplexing](../protocol-and-stream-multiplexing). You will need the `@chainsafe/libp2p-noise` module to complete it, go ahead and `npm install @chainsafe/libp2p-noise`.
To add them to your libp2p configuration, all you have to do is: To add them to your libp2p configuration, all you have to do is:
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const { NOISE } = require('libp2p-noise') import { TCP } from '@libp2p/tcp'
import { Mplex } from '@libp2p/mplex'
import { Noise } from '@chainsafe/libp2p-noise'
const createNode = () => { const createNode = async () => {
return Libp2p.create({ return await createLibp2p({
modules: { transports: [ new TCP() ],
transport: [ TCP ], streamMuxers: [ new Mplex() ],
streamMuxer: [ Mplex ],
// Attach noise as the crypto channel to use // Attach noise as the crypto channel to use
connEncryption: [ NOISE ] conectionEncrypters: [ new Noise() ]
}
}) })
} }
``` ```

View File

@ -1,30 +1,14 @@
'use strict'
const path = require('path') import path from 'path'
const execa = require('execa') import { waitForOutput } from '../utils.js'
const pDefer = require('p-defer') import { fileURLToPath } from 'url'
const uint8ArrayToString = require('uint8arrays/to-string')
async function test () { const __dirname = path.dirname(fileURLToPath(import.meta.url))
const messageReceived = pDefer()
export async function test () {
process.stdout.write('1.js\n') process.stdout.write('1.js\n')
const proc = execa('node', [path.join(__dirname, '1.js')], { await waitForOutput('This information is sent out encrypted to the other peer', 'node', [path.join(__dirname, '1.js')], {
cwd: path.resolve(__dirname), cwd: __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

View File

@ -3,19 +3,18 @@
"version": "0.1.0", "version": "0.1.0",
"private": true, "private": true,
"dependencies": { "dependencies": {
"ipfs": "~0.34.4", "@chainsafe/libp2p-noise": "^6.1.1",
"libp2p": "github:libp2p/js-libp2p#master", "ipfs-core": "^0.14.1",
"libp2p-delegated-content-routing": "~0.2.2", "libp2p": "../../",
"libp2p-delegated-peer-routing": "~0.2.2", "@libp2p/delegated-content-routing": "^1.0.1",
"libp2p-kad-dht": "~0.14.12", "@libp2p/delegated-peer-routing": "^1.0.1",
"libp2p-mplex": "~0.8.5", "@libp2p/kad-dht": "^1.0.9",
"libp2p-secio": "~0.11.1", "@libp2p/mplex": "^1.0.4",
"libp2p-webrtc-star": "~0.15.8", "@libp2p/webrtc-star": "^1.0.8",
"libp2p-websocket-star": "~0.10.2", "@libp2p/websockets": "^1.0.7",
"libp2p-websockets": "~0.12.2", "react": "^17.0.2",
"react": "^16.8.6", "react-dom": "^17.0.2",
"react-dom": "^16.8.6", "react-scripts": "5.0.0"
"react-scripts": "2.1.8"
}, },
"scripts": { "scripts": {
"start": "react-scripts start" "start": "react-scripts start"

View File

@ -2,7 +2,7 @@
'use strict' 'use strict'
import React from 'react' import React from 'react'
import Ipfs from 'ipfs' import Ipfs from 'ipfs-core'
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 = new Ipfs({ window.ipfs = this.ipfs = Ipfs.create({
config: { config: {
Addresses: { Addresses: {
Swarm: [] Swarm: []

View File

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

View File

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

View File

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

View File

@ -0,0 +1,80 @@
/* eslint-disable no-console */
import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'
import { Mplex } from '@libp2p/mplex'
import { Noise } from '@chainsafe/libp2p-noise'
import { FloodSub } from '@libp2p/floodsub'
import { Bootstrap } from '@libp2p/bootstrap'
import { PubSubPeerDiscovery } from '@libp2p/pubsub-peer-discovery'
const createNode = async (bootstrappers) => {
const node = await createLibp2p({
addresses: {
listen: ['/ip4/0.0.0.0/tcp/0']
},
transports: [new TCP()],
streamMuxers: [new Mplex()],
connectionEncryption: [new Noise()],
pubsub: new FloodSub(),
peerDiscovery: [
new Bootstrap({
list: bootstrappers
}),
new PubSubPeerDiscovery({
interval: 1000
})
]
})
return node
}
;(async () => {
const relay = await createLibp2p({
addresses: {
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()}`)
await relay.start()
const relayMultiaddrs = relay.getMultiaddrs().map((m) => m.toString())
const [node1, node2] = await Promise.all([
createNode(relayMultiaddrs),
createNode(relayMultiaddrs)
])
node1.addEventListener('peer:discovery', (evt) => {
const peer = evt.detail
console.log(`Peer ${node1.peerId.toString()} discovered: ${peer.id.toString()}`)
})
node2.addEventListener('peer:discovery',(evt) => {
const peer = evt.detail
console.log(`Peer ${node2.peerId.toString()} discovered: ${peer.id.toString()}`)
})
;[node1, node2].forEach((node, index) => console.log(`Node ${index} starting with id: ${node.peerId.toString()}`))
await Promise.all([
node1.start(),
node2.start()
])
})();

View File

@ -2,36 +2,36 @@
A Peer Discovery module enables libp2p to find peers to connect to. Think of these mechanisms as ways to join the rest of the network, as railing points. A Peer Discovery module enables libp2p to find peers to connect to. Think of these mechanisms as ways to join the rest of the network, as railing points.
With these system, a libp2p node can both have a set of nodes to always connect on boot (bootstraper nodes), discover nodes through locality (e.g connected in the same LAN) or through serendipity (random walks on a DHT). With this system, a libp2p node can both have a set of nodes to always connect on boot (bootstraper nodes), discover nodes through locality (e.g connected in the same LAN) or through serendipity (random walks on a DHT).
These mechanisms save configuration and enable a node to operate without any explicit dials, it will just work. Once new peers are discovered, their known data is stored in the peer's PeerStore. These mechanisms save configuration and enable a node to operate without any explicit dials, it will just work. Once new peers are discovered, their known data is stored in the peer's PeerStore.
## 1. Bootstrap list of Peers when booting a node ## 1. Bootstrap list of Peers when booting a node
For this demo, we will connect to IPFS default bootstrapper nodes and so, we will need to support the same set of features those nodes have, that are: TCP, mplex and NOISE. You can see the complete example at [1.js](./1.js). For this demo, we will connect to IPFS default bootstrapper nodes and so, we will need to support the same set of features those nodes have, that are: TCP, mplex, and NOISE. You can see the complete example at [1.js](./1.js).
First, we create our libp2p node. First, we create our libp2p node.
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Bootstrap = require('libp2p-bootstrap') import { Bootstrap } from '@libp2p/bootstrap'
const node = Libp2p.create({ const node = await createLibp2p({
modules: { transports: [
transport: [ TCP ], new TCP()
streamMuxer: [ Mplex ], ],
connEncryption: [ NOISE ], streamMuxers: [
peerDiscovery: [ Bootstrap ] new Mplex()
}, ],
config: { connectionEncryption: [
peerDiscovery: { new Noise()
bootstrap: { ],
peerDiscovery: [
new Bootstrap({
interval: 60e3, interval: 60e3,
enabled: true,
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 Libp2p.create({ const node = await createLibp2p({
peerId, peerId,
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}
modules: {
transport: [ TCP ],
streamMuxer: [ Mplex ],
connEncryption: [ NOISE ],
peerDiscovery: [ Bootstrap ]
}, },
config: { transports: [
peerDiscovery: { new TCP()
bootstrap: { ],
streamMuxers: [
new Mplex()
],
connectionEncryption: [
new Noise()
],
peerDiscovery: [
new Bootstrap({
interval: 60e3, interval: 60e3,
enabled: true,
list: bootstrapers list: bootstrapers
} })
} ]
}
}) })
node.connectionManager.on('peer:connect', (connection) => { node.connectionManager.on('peer:connect', (connection) => {
@ -110,28 +110,28 @@ For this example, we need `libp2p-mdns`, go ahead and `npm install` it. You can
Update your libp2p configuration to include MulticastDNS. Update your libp2p configuration to include MulticastDNS.
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const MulticastDNS = require('libp2p-mdns') import { MulticastDNS } from '@libp2p/mdns'
const createNode = () => { const createNode = () => {
return Libp2p.create({ return Libp2p.create({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}
modules: {
transport: [ TCP ],
streamMuxer: [ Mplex ],
connEncryption: [ NOISE ],
peerDiscovery: [ MulticastDNS ]
}, },
config: { transports: [
peerDiscovery: { new TCP()
mdns: { ],
interval: 20e3, streamMuxers: [
enabled: true new Mplex()
} ],
} connectionEncryption: [
} new Noise()
],
peerDiscovery: [
new MulticastDNS({
interval: 20e3
})
]
}) })
} }
``` ```
@ -144,8 +144,13 @@ const [node1, node2] = await Promise.all([
createNode() createNode()
]) ])
node1.on('peer:discovery', (peer) => console.log('Discovered:', peer.id.toB58String())) node1.on('peer:discovery', (peer) => console.log('Discovered:', peerId.toB58String()))
node2.on('peer:discovery', (peer) => console.log('Discovered:', peer.id.toB58String())) node2.on('peer:discovery', (peer) => console.log('Discovered:', peerId.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.
@ -156,10 +161,103 @@ Discovered: QmSSbQpuKrxkoXHm1v4Pi35hPN5hUHMZoBoawEs2Nhvi8m
Discovered: QmRcXXhtG8vTqwVBRonKWtV4ovDoC1Fe56WYtcrw694eiJ Discovered: QmRcXXhtG8vTqwVBRonKWtV4ovDoC1Fe56WYtcrw694eiJ
``` ```
## 3. Where to find other Peer Discovery Mechanisms ## 3. Pubsub based Peer Discovery
For this example, we need [`libp2p-pubsub-peer-discovery`](https://github.com/libp2p/js-libp2p-pubsub-peer-discovery/), go ahead and `npm install` it. You also need to spin up a set of [`libp2p-relay-servers`](https://github.com/libp2p/js-libp2p-relay-server). These servers act as relay servers and a peer discovery source.
In the context of this example, we will create and run the `libp2p-relay-server` in the same code snippet. You can find the complete solution at [3.js](./3.js).
You can create your libp2p nodes as follows:
```js
import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'
import { Mplex } from '@libp2p/mplex'
import { Noise } from '@chainsafe/libp2p-noise'
import { Gossipsub } from 'libp2p-gossipsub'
import { Bootstrap } from '@libp2p/bootstrap'
const PubsubPeerDiscovery from 'libp2p-pubsub-peer-discovery')
const createNode = async (bootstrapers) => {
const node = await createLibp2p({
addresses: {
listen: ['/ip4/0.0.0.0/tcp/0']
},
transports: [
new TCP()
],
streamMuxers: [
new Mplex()
],
connectionEncryption: [
new Noise()
],
peerDiscovery: [
new Bootstrap({
interval: 60e3,
list: bootstrapers
}),
new PubsubPeerDiscovery({
interval: 1000
})
])
return node
}
```
We will use the `libp2p-relay-server` as bootstrap nodes for the libp2p nodes, so that they establish a connection with the relay after starting. As a result, after they establish a connection with the relay, the pubsub discovery will kick in and the relay will advertise them.
```js
const relay = await createRelayServer({
addresses: {
listen: ['/ip4/0.0.0.0/tcp/0']
}
})
console.log(`libp2p relay starting with id: ${relay.peerId.toB58String()}`)
await relay.start()
const relayMultiaddrs = relay.multiaddrs.map((m) => `${m.toString()}/p2p/${relay.peerId.toB58String()}`)
const [node1, node2] = await Promise.all([
createNode(relayMultiaddrs),
createNode(relayMultiaddrs)
])
node1.on('peer:discovery', (peerId) => {
console.log(`Peer ${node1.peerId.toB58String()} discovered: ${peerId.toB58String()}`)
})
node2.on('peer:discovery', (peerId) => {
console.log(`Peer ${node2.peerId.toB58String()} discovered: ${peerId.toB58String()}`)
})
;[node1, node2].forEach((node, index) => console.log(`Node ${index} starting with id: ${node.peerId.toB58String()}`))
await Promise.all([
node1.start(),
node2.start()
])
```
If you run this example, you will see the other peers being discovered.
```bash
> node 3.js
libp2p relay starting with id: QmW6FqVV6RsyoGC5zaeFGW9gSWA3LcBRVZrjkKMruh38Bo
Node 0 starting with id: QmezqDTmEjZ5BfMgVqjSpLY19mVVLTQ9bE9mRpZwtGxL8N
Node 1 starting with id: QmYWeom2odTkm79DzB68NHULqVHDaNDqHhoyqLdcV1fqdv
Peer QmezqDTmEjZ5BfMgVqjSpLY19mVVLTQ9bE9mRpZwtGxL8N discovered: QmW6FqVV6RsyoGC5zaeFGW9gSWA3LcBRVZrjkKMruh38Bo
Peer QmYWeom2odTkm79DzB68NHULqVHDaNDqHhoyqLdcV1fqdv discovered: QmW6FqVV6RsyoGC5zaeFGW9gSWA3LcBRVZrjkKMruh38Bo
Peer QmYWeom2odTkm79DzB68NHULqVHDaNDqHhoyqLdcV1fqdv discovered: QmezqDTmEjZ5BfMgVqjSpLY19mVVLTQ9bE9mRpZwtGxL8N
Peer QmezqDTmEjZ5BfMgVqjSpLY19mVVLTQ9bE9mRpZwtGxL8N discovered: QmYWeom2odTkm79DzB68NHULqVHDaNDqHhoyqLdcV1fqdv
```
Taking into account the output, after the relay and both libp2p nodes start, both libp2p nodes will discover the bootstrap node (relay) and connect with it. After establishing a connection with the relay, they will discover each other.
This is really useful when running libp2p in constrained environments like a browser. You can run a set of `libp2p-relay-server` nodes that will be responsible for both relaying websocket connections between browser nodes and for discovering other browser peers.
## 4. Where to find other Peer Discovery Mechanisms
There are plenty more Peer Discovery Mechanisms out there, you can: There are plenty more Peer Discovery Mechanisms out there, you can:
- Find one in [libp2p-webrtc-star](https://github.com/libp2p/js-libp2p-webrtc-star). Yes, a transport with discovery capabilities! This happens because WebRTC requires a rendezvous point for peers to exchange [SDP](https://tools.ietf.org/html/rfc4317) offer, which means we have one or more points that can introduce peers to each other. Think of it as MulticastDNS for the Web, as in MulticastDNS only works in LAN. - Find one in [libp2p-webrtc-star](https://github.com/libp2p/js-libp2p-webrtc-star). Yes, a transport with discovery capabilities! This happens because WebRTC requires a rendezvous point for peers to exchange [SDP](https://tools.ietf.org/html/rfc4317) offer, which means we have one or more points that can introduce peers to each other. Think of it as MulticastDNS for the Web, as in MulticastDNS only works in LAN.
- Any DHT will offer you a discovery capability. You can simple _random-walk_ the routing tables to find other peers to connect to. For example [libp2p-kad-dht](https://github.com/libp2p/js-libp2p-kad-dht) can be used for peer discovery. An example how to configure it to enable random walks can be found [here](https://github.com/libp2p/js-libp2p/blob/v0.28.4/doc/CONFIGURATION.md#customizing-dht). - Any DHT will offer you a discovery capability. You can simple _random-walk_ the routing tables to find other peers to connect to. For example [libp2p-kad-dht](https://github.com/libp2p/js-libp2p-kad-dht) can be used for peer discovery. An example of how to configure it to enable random walks can be found [here](https://github.com/libp2p/js-libp2p/blob/v0.28.4/doc/CONFIGURATION.md#customizing-dht).
- You can create your own Discovery service, a registry, a list, a radio beacon, you name it! - You can create your own Discovery service, a registry, a list, a radio beacon, you name it!

View File

@ -1,13 +1,9 @@
'use strict' // Find this list at: https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core-config/src/config.js
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

View File

@ -1,42 +1,13 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const execa = require('execa')
const pWaitFor = require('p-wait-for')
const 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')
const proc = execa('node', [path.join(__dirname, '1.js')], { await waitForOutput('Connection established to:', 'node', [path.join(__dirname, '1.js')], {
cwd: path.resolve(__dirname), cwd: __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

View File

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

View File

@ -0,0 +1,33 @@
import path from 'path'
import execa from 'execa'
import pWaitFor from 'p-wait-for'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fileURLToPath } from 'url'
const __dirname = path.dirname(fileURLToPath(import.meta.url))
export async function test () {
let discoveredNodes = 0
process.stdout.write('3.js\n')
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 str = uint8ArrayToString(data)
str.split('\n').forEach(line => {
if (line.includes('discovered:')) {
discoveredNodes++
}
})
})
await pWaitFor(() => discoveredNodes > 3)
proc.kill()
}

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -1,4 +0,0 @@
{
"presets": ["@babel/preset-env"],
"plugins": ["syntax-async-functions","transform-regenerator"]
}

View File

@ -4,9 +4,13 @@ This example leverages the [Parcel.js bundler](https://parceljs.org/) to compile
## Setup ## Setup
In order to run the example, first install the dependencies from same directory as this README: In order to run the example:
- Install dependencey at the root of the js-libp2p repository (if not already done),
- then, install the dependencies from same directory as this README:
``` ```
npm install
cd ./examples/libp2p-in-the-browser cd ./examples/libp2p-in-the-browser
npm install npm install
``` ```

View File

@ -16,7 +16,7 @@
<pre id="output"></pre> <pre id="output"></pre>
</main> </main>
<script src="./index.js"></script> <script type="module" src="./index.js"></script>
</body> </body>

View File

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

View File

@ -2,33 +2,21 @@
"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",
"main": "index.js", "type": "module",
"browserslist": [
"last 2 Chrome versions"
],
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1", "test": "echo \"Error: no test specified\" && exit 1",
"build": "parcel build index.html", "start": "vite"
"start": "parcel index.html"
}, },
"keywords": [],
"author": "",
"license": "ISC", "license": "ISC",
"dependencies": { "dependencies": {
"@babel/preset-env": "^7.8.3", "@chainsafe/libp2p-noise": "^6.1.1",
"libp2p": "../../", "@libp2p/bootstrap": "^1.0.4",
"libp2p-bootstrap": "^0.12.1", "@libp2p/mplex": "^1.0.4",
"libp2p-mplex": "^0.10.0", "@libp2p/webrtc-star": "^1.0.8",
"libp2p-noise": "^2.0.0", "@libp2p/websockets": "^1.0.7",
"libp2p-webrtc-star": "^0.20.0", "libp2p": "../../"
"libp2p-websockets": "^0.14.0"
}, },
"devDependencies": { "devDependencies": {
"@babel/cli": "^7.8.3", "vite": "^2.8.6"
"@babel/core": "^7.8.3",
"babel-plugin-syntax-async-functions": "^6.13.0",
"babel-plugin-transform-regenerator": "^6.26.0",
"babel-polyfill": "^6.26.0",
"parcel-bundler": "^1.12.4"
} }
} }

View File

@ -1,11 +1,14 @@
'use strict' import execa from 'execa'
import { chromium } from 'playwright'
import path from 'path'
import { fileURLToPath } from 'url'
const execa = require('execa') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const { chromium } = require('playwright');
async function run() { export async function test () {
let url = '' let url = 'http://localhost:3000'
const proc = execa('parcel', ['./index.html'], {
const proc = execa('vite', [], {
preferLocal: true, preferLocal: true,
localDir: __dirname, localDir: __dirname,
cwd: __dirname, cwd: __dirname,
@ -16,11 +19,7 @@ async function run() {
/**@type {string} */ /**@type {string} */
const out = chunk.toString() const out = chunk.toString()
if (out.includes('Server running at')) { if (out.includes('ready in')) {
url = out.replace('Server running at ', '')
}
if (out.includes('✨ Built in ')) {
try { try {
const browser = await chromium.launch(); const browser = await chromium.launch();
const page = await browser.newPage(); const page = await browser.newPage();
@ -36,8 +35,7 @@ async function run() {
'#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)
@ -46,7 +44,4 @@ async function run() {
} }
} }
}) })
} }
module.exports = run

View File

@ -0,0 +1,5 @@
export default {
build: {
target: 'es2020'
}
}

View File

@ -2,18 +2,24 @@
"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",
"execa": "^2.1.0", "execa": "^2.1.0",
"fs-extra": "^8.1.0", "fs-extra": "^8.1.0",
"libp2p": "../",
"p-defer": "^3.0.0", "p-defer": "^3.0.0",
"uint8arrays": "^3.0.0",
"which": "^2.0.1" "which": "^2.0.1"
}, },
"devDependencies": { "devDependencies": {
"https": "^1.0.0",
"playwright": "^1.7.1" "playwright": "^1.7.1"
} }
} }

View File

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

View File

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

View File

@ -13,26 +13,24 @@ This example builds on top of the [Protocol and Stream Muxing](../protocol-and-s
First, let's update our config to support Peer Routing and Content Routing. First, let's update our config to support Peer Routing and Content Routing.
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const KadDHT = require('libp2p-kad-dht') import { KadDHT } from '@libp2p/kad-dht'
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [
transport: [ TCP ], new TCP()
streamMuxer: [ Mplex ], ],
connEncryption: [ NOISE ], streamMuxers: [
new Mplex()
],
connEncryption: [
new Noise()
],
// we add the DHT module that will enable Peer and Content Routing // we add the DHT module that will enable Peer and Content Routing
dht: KadDHT dht: KadDHT
},
config: {
dht: {
// dht must be enabled
enabled: true
}
}
}) })
``` ```
@ -43,8 +41,8 @@ const node1 = nodes[0]
const node2 = nodes[1] const node2 = nodes[1]
const node3 = nodes[2] const node3 = nodes[2]
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs) await node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
await Promise.all([ await Promise.all([
node1.dial(node2.peerId), node1.dial(node2.peerId),
@ -81,7 +79,7 @@ Instead of calling `peerRouting.findPeer`, we will use `contentRouting.provide`
```JavaScript ```JavaScript
await node1.contentRouting.provide(cid) await node1.contentRouting.provide(cid)
console.log('Node %s is providing %s', node1.peerId.toB58String(), cid.toBaseEncodedString()) console.log('Node %s is providing %s', node1.peerId.toB58String(), cid.toString())
const provs = await all(node3.contentRouting.findProviders(cid, { timeout: 5000 })) const provs = await all(node3.contentRouting.findProviders(cid, { timeout: 5000 }))

View File

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

View File

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

View File

@ -0,0 +1,7 @@
import { test as test1 } from './test-1.js'
import { test as test2 } from './test-2.js'
export async function test() {
await test1()
await test2()
}

View File

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

View File

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

View File

@ -1,30 +1,12 @@
'use strict' import path from 'path'
import { waitForOutput } from '../utils.js'
import { fileURLToPath } from 'url'
const path = require('path') const __dirname = path.dirname(fileURLToPath(import.meta.url))
const execa = require('execa')
const pDefer = require('p-defer')
const uint8ArrayToString = require('uint8arrays/to-string')
async function test () { export async function test () {
const messageReceived = pDefer() await waitForOutput('This message is sent on a private network', 'node', [path.join(__dirname, 'index.js')], {
process.stdout.write('index.js\n') cwd: __dirname
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

View File

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

View File

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

View File

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

View File

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

View File

@ -11,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
const pipe = require('it-pipe') import { pipe } from 'it-pipe'
const { map } = require('streaming-iterables') const { map } from 'streaming-iterables')
const { toBuffer } = require('it-buffer') const { toBuffer } from 'it-buffer')
// ... // ...
const node1 = nodes[0] const node1 = nodes[0]
const node2 = nodes[1] const node2 = nodes[1]
// Add node's 2 data to the PeerStore // Add node's 2 data to the PeerStore
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await 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,17 +102,19 @@ Stream multiplexing is an old concept, in fact it happens in many of the layers
Currently, we have [libp2p-mplex](https://github.com/libp2p/js-libp2p-mplex) and pluging it in is as easy as adding a transport. Let's revisit our libp2p configuration. Currently, we have [libp2p-mplex](https://github.com/libp2p/js-libp2p-mplex) and pluging it in is as easy as adding a transport. Let's revisit our libp2p configuration.
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
//... //...
const createNode = () => { const createNode = () => {
return Libp2p.create({ return Libp2p.create({
modules: { transports: [
transport: [ TCP ], new TCP()
streamMuxer: [ Mplex ] ],
} streamMuxers: [
new Mplex()
]
}) })
} }
``` ```

View File

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

View File

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

View File

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

View File

@ -0,0 +1,9 @@
import { test as test1 } from './test-1.js'
import { test as test2 } from './test-2.js'
import { test as test3 } from './test-3.js'
export async function test() {
await test1()
await test2()
await test3()
}

View File

@ -1,25 +1,22 @@
/* eslint-disable no-console */ /* eslint-disable no-console */
'use strict'
const Libp2p = require('../../') import { createLibp2p } from 'libp2p'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const Mplex = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
const { NOISE } = require('libp2p-noise') import { Noise } from '@chainsafe/libp2p-noise'
const Gossipsub = require('libp2p-gossipsub') import { FloodSub } from '@libp2p/floodsub'
const uint8ArrayFromString = require('uint8arrays/from-string') import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
const uint8ArrayToString = require('uint8arrays/to-string') import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], streamMuxers: [new Mplex()],
streamMuxer: [Mplex], connectionEncryption: [new Noise()],
connEncryption: [NOISE], pubsub: new FloodSub()
pubsub: Gossipsub
}
}) })
await node.start() await node.start()
@ -35,22 +32,24 @@ const createNode = async () => {
]) ])
// Add node's 2 data to the PeerStore // Add node's 2 data to the PeerStore
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.getMultiaddrs())
await node1.dial(node2.peerId) await node1.dial(node2.peerId)
node1.pubsub.on(topic, (msg) => { node1.pubsub.subscribe(topic)
console.log(`node1 received: ${uint8ArrayToString(msg.data)}`) node1.pubsub.addEventListener('message', (evt) => {
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.on(topic, (msg) => { node2.pubsub.subscribe(topic)
console.log(`node2 received: ${uint8ArrayToString(msg.data)}`) node2.pubsub.addEventListener('message', (evt) => {
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!')) node2.pubsub.publish(topic, uint8ArrayFromString('Bird bird bird, bird is the word!')).catch(err => {
console.error(err)
})
}, 1000) }, 1000)
})() })()

View File

@ -8,6 +8,10 @@ We've seen many interesting use cases appear with this, here are some highlights
- [IPFS PubSub (using libp2p-floodsub) for IoT](https://www.youtube.com/watch?v=qLpM5pBDGiE). - [IPFS PubSub (using libp2p-floodsub) for IoT](https://www.youtube.com/watch?v=qLpM5pBDGiE).
- [Real Time distributed Applications](https://www.youtube.com/watch?v=vQrbxyDPSXg) - [Real Time distributed Applications](https://www.youtube.com/watch?v=vQrbxyDPSXg)
## 0. Set up the example
Before moving into the examples, you should run `npm install` on the top level `js-libp2p` folder, in order to install all the dependencies needed for this example. In addition, you will need to install the example related dependencies by doing `cd examples && npm install`. Once the install finishes, you should move into the example folder with `cd pubsub`.
## 1. Setting up a simple PubSub network on top of libp2p ## 1. Setting up a simple PubSub network on top of libp2p
For this example, we will use MulticastDNS for automatic Peer Discovery. This example is based the previous examples found in [Discovery Mechanisms](../discovery-mechanisms). You can find the complete version at [1.js](./1.js). For this example, we will use MulticastDNS for automatic Peer Discovery. This example is based the previous examples found in [Discovery Mechanisms](../discovery-mechanisms). You can find the complete version at [1.js](./1.js).
@ -17,49 +21,57 @@ Using PubSub is super simple, you only need to provide the implementation of you
First, let's update our libp2p configuration with a pubsub implementation. First, let's update our libp2p configuration with a pubsub implementation.
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Gossipsub = require('libp2p-gossipsub') import { Gossipsub } from 'libp2p-gossipsub'
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [
transport: [ TCP ], new TCP()
streamMuxer: [ Mplex ], ],
connEncryption: [ NOISE ], streamMuxers: [
new Mplex()
],
connectionEncryption: [
new Noise()
],
// we add the Pubsub module we want // we add the Pubsub module we want
pubsub: Gossipsub 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
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await 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: ${uint8ArrayToString(msg.data)}`) console.log(`node1 received: ${toString(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: ${uint8ArrayToString(msg.data)}`) console.log(`node2 received: ${toString(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, uint8ArrayFromString('Bird bird bird, bird is the word!')) node2.pubsub.publish(topic, fromString('Bird bird bird, bird is the word!')).catch(err => {
console.error(err)
})
}, 1000) }, 1000)
``` ```

View File

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

View File

@ -7,19 +7,23 @@ To prevent undesired data from being propagated on the network, we can apply a f
First, let's update our libp2p configuration with a pubsub implementation. First, let's update our libp2p configuration with a pubsub implementation.
```JavaScript ```JavaScript
const Libp2p = require('libp2p') import { createLibp2p } from 'libp2p'
const Gossipsub = require('libp2p-gossipsub') import { Gossipsub } from 'libp2p-gossipsub'
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [
transport: [ TCP ], new TCP()
streamMuxer: [ Mplex ], ],
connEncryption: [ NOISE ], streamMuxers: [
pubsub: Gossipsub new Mplex()
} ],
connectionEncryption: [
new Noise()
],
pubsub: new Gossipsub()
}) })
``` ```
@ -32,10 +36,10 @@ const [node1, node2, node3] = await Promise.all([
createNode(), createNode(),
]) ])
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
await node1.dial(node2.peerId) await node1.dial(node2.peerId)
node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs) await node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
await node2.dial(node3.peerId) await node2.dial(node3.peerId)
``` ```
@ -84,7 +88,9 @@ 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])) node1.pubsub.publish(topic, new TextEncoder().encode(myFruits[count])).catch(err => {
console.error(err)
})
count++ count++
if (count == myFruits.length) { if (count == myFruits.length) {
count = 0 count = 0

View File

@ -0,0 +1,66 @@
import path from 'path'
import execa from 'execa'
import pDefer from 'p-defer'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fileURLToPath } from 'url'
const __dirname = path.dirname(fileURLToPath(import.meta.url))
const stdout = [
{
topic: 'banana',
messageCount: 2
},
{
topic: 'apple',
messageCount: 2
},
{
topic: 'car',
messageCount: 0
},
{
topic: 'orange',
messageCount: 2
},
]
export async function test () {
const defer = pDefer()
let topicCount = 0
let topicMessageCount = 0
process.stdout.write('message-filtering/1.js\n')
const proc = execa('node', [path.join(__dirname, '1.js')], {
cwd: path.resolve(__dirname),
all: true
})
proc.all.on('data', async (data) => {
// End
if (topicCount === stdout.length) {
defer.resolve()
proc.all.removeAllListeners('data')
}
process.stdout.write(data)
const line = uint8ArrayToString(data)
if (stdout[topicCount] && line.includes(stdout[topicCount].topic)) {
// Validate previous number of messages
if (topicCount > 0 && topicMessageCount > stdout[topicCount - 1].messageCount) {
defer.reject()
throw new Error(`topic ${stdout[topicCount - 1].topic} had ${topicMessageCount} messages instead of ${stdout[topicCount - 1].messageCount}`)
}
topicCount++
topicMessageCount = 0
} else {
topicMessageCount++
}
})
await defer.promise
proc.kill()
}

29
examples/pubsub/test-1.js Normal file
View File

@ -0,0 +1,29 @@
import path from 'path'
import execa from 'execa'
import pDefer from 'p-defer'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fileURLToPath } from 'url'
const __dirname = path.dirname(fileURLToPath(import.meta.url))
export async function test () {
const defer = pDefer()
process.stdout.write('1.js\n')
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)
if (line.includes('node1 received: Bird bird bird, bird is the word!')) {
defer.resolve()
}
})
await defer.promise
proc.kill()
}

7
examples/pubsub/test.js Normal file
View File

@ -0,0 +1,7 @@
import { test as test1 } from './test-1.js'
import { test as testMessageFiltering } from './message-filtering/test.js'
export async function test() {
await test1()
await testMessageFiltering()
}

View File

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

View File

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

View File

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

View File

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

View File

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

86
examples/transports/4.js Normal file
View File

@ -0,0 +1,86 @@
/* eslint-disable no-console */
import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'
import { WebSockets } from '@libp2p/websockets'
import { Noise } from '@chainsafe/libp2p-noise'
import { Mplex } from '@libp2p/mplex'
import fs from 'fs'
import https from 'https'
import { pipe } from 'it-pipe'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
const httpServer = https.createServer({
cert: fs.readFileSync('./test_certs/cert.pem'),
key: fs.readFileSync('./test_certs/key.pem'),
});
const createNode = async (addresses = []) => {
if (!Array.isArray(addresses)) {
addresses = [addresses]
}
const node = await createLibp2p({
addresses: {
listen: addresses
},
transports: [
new TCP(),
new WebSockets({
server: httpServer,
websocket: {
rejectUnauthorized: false
}
})
],
connectionEncryption: [new Noise()],
streamMuxers: [new Mplex()],
connectionManager: {
// Disable autoDial as it would fail because we are using a self-signed cert.
// `dialProtocol` does not fail because we pass `rejectUnauthorized: false`.
autoDial: false
}
})
await node.start()
return node
}
function printAddrs(node, number) {
console.log('node %s is listening on:', number)
node.getMultiaddrs().forEach((ma) => console.log(ma.toString()))
}
function print ({ stream }) {
pipe(
stream,
async function (source) {
for await (const msg of source) {
console.log(uint8ArrayToString(msg))
}
}
)
}
;(async () => {
const [node1, node2] = await Promise.all([
createNode('/ip4/127.0.0.1/tcp/10000/wss'),
createNode([])
])
printAddrs(node1, '1')
printAddrs(node2, '2')
node1.handle('/print', print)
node2.handle('/print', print)
const targetAddr = node1.getMultiaddrs()[0];
// node 2 (Secure WebSockets) dials to node 1 (Secure Websockets)
const { stream } = await node2.dialProtocol(targetAddr, '/print')
await pipe(
[uint8ArrayFromString('node 2 dialed to node 1 successfully')],
stream
)
})();

View File

@ -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](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. 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.
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: 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:
[![](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png)](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png) ![][interface-transport badge]
## 1. Creating a libp2p node with TCP ## 1. Creating a libp2p node with TCP
@ -13,7 +13,7 @@ When using libp2p, you need properly configure it, that is, pick your set of mod
You will need 4 dependencies total, so go ahead and install all of them with: You will need 4 dependencies total, so go ahead and install all of them with:
```bash ```bash
> npm install libp2p libp2p-tcp libp2p-noise > npm install libp2p libp2p-tcp @chainsafe/libp2p-noise
``` ```
Then, in your favorite text editor create a file with the `.js` extension. I've called mine `1.js`. Then, in your favorite text editor create a file with the `.js` extension. I've called mine `1.js`.
@ -21,23 +21,23 @@ Then, in your favorite text editor create a file with the `.js` extension. I've
First thing is to create our own libp2p node! Insert: First thing is to create our own libp2p node! Insert:
```JavaScript ```JavaScript
'use strict' import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'
const Libp2p = require('libp2p') import { Noise } from '@chainsafe/libp2p-noise'
const TCP = require('libp2p-tcp')
const { NOISE } = require('libp2p-noise')
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
// To signal the addresses we want to be available, we use // To signal the addresses we want to be available, we use
// the multiaddr format, a self describable address // the multiaddr format, a self describable address
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [
transport: [ TCP ], new TCP()
connEncryption: [ NOISE ] ],
} connectionEncryption: [
new Noise()
]
}) })
await node.start() await node.start()
@ -80,31 +80,29 @@ Now that we have our `createNode` function, let's create two nodes and make them
For this step, we will need some more dependencies. For this step, we will need some more dependencies.
```bash ```bash
> npm install it-pipe it-concat libp2p-mplex > npm install it-pipe it-to-buffer @libp2p/mplex
``` ```
And we also need to import the modules on our .js file: And we also need to import the modules on our .js file:
```js ```js
const pipe = require('it-pipe') import { pipe } from 'it-pipe'
const concat = require('it-concat') import toBuffer from 'it-to-buffer'
const MPLEX = require('libp2p-mplex') import { Mplex } from '@libp2p/mplex'
``` ```
We are going to reuse the `createNode` function from step 1, but this time add a stream multiplexer from `libp2p-mplex`. We are going to reuse the `createNode` function from step 1, but this time add a stream multiplexer from `libp2p-mplex`.
```js ```js
const createNode = async () => { const createNode = async () => {
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
// To signal the addresses we want to be available, we use // To signal the addresses we want to be available, we use
// the multiaddr format, a self describable address // the multiaddr format, a self describable address
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0']
}, },
modules: { transports: [new TCP()],
transport: [TCP], connectionEncryption: [new Noise()],
connEncryption: [NOISE], streamMuxers: [new Mplex()] // <--- Add this line
streamMuxer: [MPLEX] // <--- Add this line
}
}) })
await node.start() await node.start()
@ -135,12 +133,12 @@ Then add,
node2.handle('/print', async ({ stream }) => { node2.handle('/print', async ({ stream }) => {
const result = await pipe( const result = await pipe(
stream, stream,
concat toBuffer
) )
console.log(result.toString()) console.log(result.toString())
}) })
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await 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(
@ -186,15 +184,13 @@ const createNode = async (transports, addresses = []) => {
addresses = [addresses] addresses = [addresses]
} }
const node = await Libp2p.create({ const node = await createLibp2p({
addresses: { addresses: {
listen: addresses listen: addresses
}, },
modules: {
transport: transports, transport: transports,
connEncryption: [NOISE], connectionEncryption: [new Noise()],
streamMuxer: [MPLEX] streamMuxers: [new Mplex()]
}
}) })
await node.start() await node.start()
@ -207,8 +203,8 @@ As a rule, a libp2p node will only be capable of using a transport if: a) it has
Let's update our flow to create nodes and see how they behave when dialing to each other: Let's update our flow to create nodes and see how they behave when dialing to each other:
```JavaScript ```JavaScript
const WebSockets = require('libp2p-websockets') import { WebSockets } from '@libp2p/websockets'
const TCP = require('libp2p-tcp') import { TCP } from '@libp2p/tcp'
const [node1, node2, node3] = await Promise.all([ const [node1, node2, node3] = await Promise.all([
createNode([TCP], '/ip4/0.0.0.0/tcp/0'), createNode([TCP], '/ip4/0.0.0.0/tcp/0'),
@ -224,9 +220,9 @@ node1.handle('/print', print)
node2.handle('/print', print) node2.handle('/print', print)
node3.handle('/print', print) node3.handle('/print', print)
node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs) await node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs) await node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
node3.peerStore.addressBook.set(node1.peerId, node1.multiaddrs) await 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')
@ -288,10 +284,15 @@ 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](https://github.com/libp2p/js-interfaces/tree/master/src/transport#modules-that-implement-the-interface) list. Today there are already several transports available and plenty to come. You can find these at [interface-transport implementations] 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](https://github.com/libp2p/js-interfaces/tree/master/src/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][interface-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

View File

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

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