libp2p 1.0.0-551622a96 → 1.0.0-8e4fbe13a
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -39
- package/dist/index.min.js +20 -20
- package/dist/src/connection-manager/index.d.ts.map +1 -1
- package/dist/src/connection-manager/index.js +1 -2
- package/dist/src/connection-manager/index.js.map +1 -1
- package/dist/src/libp2p.d.ts +1 -1
- package/dist/src/libp2p.d.ts.map +1 -1
- package/dist/src/libp2p.js +1 -2
- package/dist/src/libp2p.js.map +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/src/version.js +1 -1
- package/package.json +27 -27
- package/src/connection-manager/index.ts +1 -2
- package/src/libp2p.ts +2 -2
- package/src/version.ts +1 -1
package/README.md
CHANGED
|
@@ -42,6 +42,17 @@ const node = await createLibp2p({
|
|
|
42
42
|
})
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
+
# Project status
|
|
46
|
+
|
|
47
|
+
We've come a long way, but this project is still in Alpha, lots of development is happening, API might change, beware of the Dragons 🐉..
|
|
48
|
+
|
|
49
|
+
The documentation in the master branch may contain changes from a pre-release.
|
|
50
|
+
If you are looking for the documentation of the latest release, you can view the latest release on [**npm**](https://www.npmjs.com/package/libp2p), or select the tag in github that matches the version you are looking for.
|
|
51
|
+
|
|
52
|
+
**Want to get started?** Check our [GETTING\_STARTED.md](./doc/GETTING_STARTED.md) guide and [examples repo](https://github.com/libp2p/js-libp2p-examples).
|
|
53
|
+
|
|
54
|
+
**Want to update libp2p in your project?** Check our [migrations folder](./doc/migrations).
|
|
55
|
+
|
|
45
56
|
# Background
|
|
46
57
|
|
|
47
58
|
libp2p is the product of a long and arduous quest to understand the evolution of the Internet networking stack. In order to build P2P applications, devs have long had to make custom ad-hoc solutions to fit their needs, sometimes making some hard assumptions about their runtimes and the state of the network at the time of their development. Today, looking back more than 20 years, we see a clear pattern in the types of mechanisms built around the Internet Protocol, IP, which can be found throughout many layers of the OSI layer system, libp2p distils these mechanisms into flat categories and defines clear interfaces that once exposed, enable other protocols and applications to use and swap them, enabling upgradability and adaptability for the runtime, without breaking the API.
|
|
@@ -117,42 +128,42 @@ List of packages currently in existence for libp2p
|
|
|
117
128
|
|
|
118
129
|
> This table is generated using the module `package-table` with `package-table --data=package-list.json`.
|
|
119
130
|
|
|
120
|
-
| Package
|
|
121
|
-
|
|
|
122
|
-
| **libp2p**
|
|
123
|
-
| [`libp2p`](//github.com/libp2p/js-libp2p)
|
|
124
|
-
| [`@libp2p/interface`](//github.com/libp2p/js-libp2p/tree/main/packages/interface)
|
|
125
|
-
| **transports**
|
|
126
|
-
| [`@libp2p/tcp`](//github.com/libp2p/js-libp2p/tree/main/packages/transport-tcp)
|
|
127
|
-
| [`@libp2p/webrtc`](//github.com/libp2p/js-libp2p/tree/main/packages/transport-webrtc)
|
|
128
|
-
| [`@libp2p/websockets`](//github.com/libp2p/js-libp2p/tree/main/packages/transport-websockets)
|
|
129
|
-
| [`@libp2p/webtransport`](//github.com/libp2p/js-libp2p/tree/main/packages/transport-webtransport)
|
|
130
|
-
| **secure channels**
|
|
131
|
-
| [`@chainsafe/libp2p-noise`](//github.com/ChainSafe/js-libp2p-noise)
|
|
132
|
-
| [`@libp2p/plaintext`](//github.com/libp2p/js-libp2p/tree/main/packages/connection-encrypter-plaintext) | [
|
|
135
|
-
| [`@chainsafe/libp2p-yamux`](//github.com/ChainSafe/js-libp2p-yamux)
|
|
136
|
-
| **peer discovery**
|
|
137
|
-
| [`@libp2p/bootstrap`](//github.com/libp2p/js-libp2p/tree/main/packages/peer-discovery-bootstrap)
|
|
138
|
-
| [`@libp2p/kad-dht`](//github.com/libp2p/js-libp2p/tree/main/packages/kad-dht)
|
|
139
|
-
| [`@libp2p/mdns`](//github.com/libp2p/js-libp2p/tree/main/packages/peer-discovery-mdns)
|
|
140
|
-
| [`@chainsafe/discv5`](//github.com/ChainSafe/discv5)
|
|
141
|
-
| **content routing**
|
|
142
|
-
| [`@libp2p/http-v1-content-routing`](//github.com/libp2p/js-http-v1-content-routing)
|
|
143
|
-
| [`@libp2p/delegated-content-routing`](//github.com/libp2p/js-libp2p-delegated-content-routing)
|
|
144
|
-
| [`@libp2p/kad-dht`](//github.com/libp2p/js-libp2p/tree/main/packages/kad-dht)
|
|
145
|
-
| **peer routing**
|
|
146
|
-
| [`@libp2p/delegated-peer-routing`](//github.com/libp2p/js-libp2p-delegated-peer-routing)
|
|
147
|
-
| [`@libp2p/kad-dht`](//github.com/libp2p/js-libp2p/tree/main/packages/kad-dht)
|
|
148
|
-
| **utilities**
|
|
149
|
-
| [`@libp2p/crypto`](//github.com/libp2p/js-libp2p/tree/main/packages/crypto)
|
|
150
|
-
| **data types**
|
|
151
|
-
| [`@libp2p/peer-id`](//github.com/libp2p/js-libp2p/tree/main/packages/peer-id)
|
|
152
|
-
| [`@libp2p/peer-record`](//github.com/libp2p/js-libp2p/tree/main/packages/peer-record)
|
|
153
|
-
| **pubsub**
|
|
154
|
-
| [`@ChainSafe/libp2p-gossipsub`](//github.com/ChainSafe/js-libp2p-gossipsub)
|
|
155
|
-
| [`@libp2p/floodsub`](//github.com/libp2p/js-libp2p/tree/main/packages/pubsub-floodsub)
|
|
131
|
+
| Package | Version | Deps | CI | Coverage |
|
|
132
|
+
| ---------|---------|---------|---------|--------- |
|
|
133
|
+
| **libp2p** |
|
|
134
|
+
| [`libp2p`](//github.com/libp2p/js-libp2p) | [](//github.com/libp2p/js-libp2p/releases) | [](//libraries.io/npm/libp2p) | [](//github.com/libp2p/js-libp2p/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p) |
|
|
135
|
+
| [`@libp2p/interface`](//github.com/libp2p/js-libp2p/tree/main/packages/interface) | [](//github.com/libp2p/js-libp2p/tree/main/packages/interface/releases) | [](//libraries.io/npm/%40libp2p%2Finterface) | [](//github.com/libp2p/js-libp2p/tree/main/packages/interface/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/interface) |
|
|
136
|
+
| **transports** |
|
|
137
|
+
| [`@libp2p/tcp`](//github.com/libp2p/js-libp2p/tree/main/packages/transport-tcp) | [](//github.com/libp2p/js-libp2p/tree/main/packages/transport-tcp/releases) | [](//libraries.io/npm/%40libp2p%2Ftcp) | [](//github.com/libp2p/js-libp2p/tree/main/packages/transport-tcp/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/transport-tcp) |
|
|
138
|
+
| [`@libp2p/webrtc`](//github.com/libp2p/js-libp2p/tree/main/packages/transport-webrtc) | [](//github.com/libp2p/js-libp2p/tree/main/packages/transport-webrtc/releases) | [](//libraries.io/npm/%40libp2p%2Fwebrtc) | [](//github.com/libp2p/js-libp2p/tree/main/packages/transport-webrtc/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/transport-webrtc) |
|
|
139
|
+
| [`@libp2p/websockets`](//github.com/libp2p/js-libp2p/tree/main/packages/transport-websockets) | [](//github.com/libp2p/js-libp2p/tree/main/packages/transport-websockets/releases) | [](//libraries.io/npm/%40libp2p%2Fwebsockets) | [](//github.com/libp2p/js-libp2p/tree/main/packages/transport-websockets/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/transport-websockets) |
|
|
140
|
+
| [`@libp2p/webtransport`](//github.com/libp2p/js-libp2p/tree/main/packages/transport-webtransport) | [](//github.com/libp2p/js-libp2p/tree/main/packages/transport-webtransport/releases) | [](//libraries.io/npm/%40libp2p%2Fwebtransport) | [](//github.com/libp2p/js-libp2p/tree/main/packages/transport-webtransport/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/transport-webtransport) |
|
|
141
|
+
| **secure channels** |
|
|
142
|
+
| [`@chainsafe/libp2p-noise`](//github.com/ChainSafe/js-libp2p-noise) | [](//github.com/ChainSafe/js-libp2p-noise/releases) | [](//libraries.io/npm/%40chainsafe%2Flibp2p-noise) | [](//github.com/ChainSafe/js-libp2p-noise/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/ChainSafe/js-libp2p-noise) |
|
|
143
|
+
| [`@libp2p/plaintext`](//github.com/libp2p/js-libp2p/tree/main/packages/connection-encrypter-plaintext) | [](//github.com/libp2p/js-libp2p/tree/main/packages/connection-encrypter-plaintext/releases) | [](//libraries.io/npm/%40libp2p%2Fplaintext) | [](//github.com/libp2p/js-libp2p/tree/main/packages/connection-encrypter-plaintext/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/connection-encrypter-plaintext) |
|
|
144
|
+
| **stream multiplexers** |
|
|
145
|
+
| [`@libp2p/mplex`](//github.com/libp2p/js-libp2p/tree/main/packages/stream-multiplexer-mplex) | [](//github.com/libp2p/js-libp2p/tree/main/packages/stream-multiplexer-mplex/releases) | [](//libraries.io/npm/%40libp2p%2Fmplex) | [](//github.com/libp2p/js-libp2p/tree/main/packages/stream-multiplexer-mplex/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/stream-multiplexer-mplex) |
|
|
146
|
+
| [`@chainsafe/libp2p-yamux`](//github.com/ChainSafe/js-libp2p-yamux) | [](//github.com/ChainSafe/js-libp2p-yamux/releases) | [](//libraries.io/npm/%40chainsafe%2Flibp2p-yamux) | [](//github.com/ChainSafe/js-libp2p-yamux/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/ChainSafe/js-libp2p-yamux) |
|
|
147
|
+
| **peer discovery** |
|
|
148
|
+
| [`@libp2p/bootstrap`](//github.com/libp2p/js-libp2p/tree/main/packages/peer-discovery-bootstrap) | [](//github.com/libp2p/js-libp2p/tree/main/packages/peer-discovery-bootstrap/releases) | [](//libraries.io/npm/%40libp2p%2Fbootstrap) | [](//github.com/libp2p/js-libp2p/tree/main/packages/peer-discovery-bootstrap/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/peer-discovery-bootstrap) |
|
|
149
|
+
| [`@libp2p/kad-dht`](//github.com/libp2p/js-libp2p/tree/main/packages/kad-dht) | [](//github.com/libp2p/js-libp2p/tree/main/packages/kad-dht/releases) | [](//libraries.io/npm/%40libp2p%2Fkad-dht) | [](//github.com/libp2p/js-libp2p/tree/main/packages/kad-dht/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/kad-dht) |
|
|
150
|
+
| [`@libp2p/mdns`](//github.com/libp2p/js-libp2p/tree/main/packages/peer-discovery-mdns) | [](//github.com/libp2p/js-libp2p/tree/main/packages/peer-discovery-mdns/releases) | [](//libraries.io/npm/%40libp2p%2Fmdns) | [](//github.com/libp2p/js-libp2p/tree/main/packages/peer-discovery-mdns/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/peer-discovery-mdns) |
|
|
151
|
+
| [`@chainsafe/discv5`](//github.com/ChainSafe/discv5) | [](//github.com/ChainSafe/discv5/releases) | [](//libraries.io/npm/%40chainsafe%2Fdiscv5) | [](//github.com/ChainSafe/discv5/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/ChainSafe/discv5) |
|
|
152
|
+
| **content routing** |
|
|
153
|
+
| [`@libp2p/http-v1-content-routing`](//github.com/libp2p/js-http-v1-content-routing) | [](//github.com/libp2p/js-http-v1-content-routing/releases) | [](//libraries.io/npm/%40libp2p%2Fhttp-v1-content-routing) | [](//github.com/libp2p/js-http-v1-content-routing/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-http-v1-content-routing) |
|
|
154
|
+
| [`@libp2p/delegated-content-routing`](//github.com/libp2p/js-libp2p-delegated-content-routing) | [](//github.com/libp2p/js-libp2p-delegated-content-routing/releases) | [](//libraries.io/npm/%40libp2p%2Fdelegated-content-routing) | [](//github.com/libp2p/js-libp2p-delegated-content-routing/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-delegated-content-routing) |
|
|
155
|
+
| [`@libp2p/kad-dht`](//github.com/libp2p/js-libp2p/tree/main/packages/kad-dht) | [](//github.com/libp2p/js-libp2p/tree/main/packages/kad-dht/releases) | [](//libraries.io/npm/%40libp2p%2Fkad-dht) | [](//github.com/libp2p/js-libp2p/tree/main/packages/kad-dht/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/kad-dht) |
|
|
156
|
+
| **peer routing** |
|
|
157
|
+
| [`@libp2p/delegated-peer-routing`](//github.com/libp2p/js-libp2p-delegated-peer-routing) | [](//github.com/libp2p/js-libp2p-delegated-peer-routing/releases) | [](//libraries.io/npm/%40libp2p%2Fdelegated-peer-routing) | [](//github.com/libp2p/js-libp2p-delegated-peer-routing/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-delegated-peer-routing) |
|
|
158
|
+
| [`@libp2p/kad-dht`](//github.com/libp2p/js-libp2p/tree/main/packages/kad-dht) | [](//github.com/libp2p/js-libp2p/tree/main/packages/kad-dht/releases) | [](//libraries.io/npm/%40libp2p%2Fkad-dht) | [](//github.com/libp2p/js-libp2p/tree/main/packages/kad-dht/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/kad-dht) |
|
|
159
|
+
| **utilities** |
|
|
160
|
+
| [`@libp2p/crypto`](//github.com/libp2p/js-libp2p/tree/main/packages/crypto) | [](//github.com/libp2p/js-libp2p/tree/main/packages/crypto/releases) | [](//libraries.io/npm/%40libp2p%2Fcrypto) | [](//github.com/libp2p/js-libp2p/tree/main/packages/crypto/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/crypto) |
|
|
161
|
+
| **data types** |
|
|
162
|
+
| [`@libp2p/peer-id`](//github.com/libp2p/js-libp2p/tree/main/packages/peer-id) | [](//github.com/libp2p/js-libp2p/tree/main/packages/peer-id/releases) | [](//libraries.io/npm/%40libp2p%2Fpeer-id) | [](//github.com/libp2p/js-libp2p/tree/main/packages/peer-id/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/peer-id) |
|
|
163
|
+
| [`@libp2p/peer-record`](//github.com/libp2p/js-libp2p/tree/main/packages/peer-record) | [](//github.com/libp2p/js-libp2p/tree/main/packages/peer-record/releases) | [](//libraries.io/npm/%40libp2p%2Fpeer-record) | [](//github.com/libp2p/js-libp2p/tree/main/packages/peer-record/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/peer-record) |
|
|
164
|
+
| **pubsub** |
|
|
165
|
+
| [`@ChainSafe/libp2p-gossipsub`](//github.com/ChainSafe/js-libp2p-gossipsub) | [](//github.com/ChainSafe/js-libp2p-gossipsub/releases) | [](//libraries.io/npm/%40ChainSafe%2Flibp2p-gossipsub) | [](//github.com/ChainSafe/js-libp2p-gossipsub/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/ChainSafe/js-libp2p-gossipsub) |
|
|
166
|
+
| [`@libp2p/floodsub`](//github.com/libp2p/js-libp2p/tree/main/packages/pubsub-floodsub) | [](//github.com/libp2p/js-libp2p/tree/main/packages/pubsub-floodsub/releases) | [](//libraries.io/npm/%40libp2p%2Ffloodsub) | [](//github.com/libp2p/js-libp2p/tree/main/packages/pubsub-floodsub/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p/tree/main/packages/pubsub-floodsub) |
|
|
156
167
|
|
|
157
168
|
# Used by
|
|
158
169
|
|
|
@@ -160,9 +171,7 @@ List of packages currently in existence for libp2p
|
|
|
160
171
|
<p align="middle">
|
|
161
172
|
<a href="https://lodestar.chainsafe.io/"><img width="300" src="https://github.com/ChainSafe/lodestar/blob/unstable/assets/lodestar_icon_text_black_stroke.png?raw=true"></a>
|
|
162
173
|
<a href="https://hoprnet.org/"><img width="150" src="https://github.com/hoprnet/hopr-assets/blob/master/v1/logo/hopr_logo_padded.png?raw=true" alt="HOPR Logo">
|
|
163
|
-
<a href="https://
|
|
164
|
-
<a href="https://github.com/orbitdb/orbitdb"><img src="https://avatars.githubusercontent.com/u/25079463?s=200&v=4" alt="OrbitDB logo" width="150" /></a>
|
|
165
|
-
<a href="https://waku.org/"><img src="https://avatars.githubusercontent.com/u/107703624?s=200&v=4" alt="Waku" width="150" /></a>
|
|
174
|
+
<a href="https://js.ipfs.io/"><img src="https://ipfs.io/ipfs/Qme6KJdKcp85TYbLxuLV7oQzMiLremD7HMoXLZEmgo6Rnh/js-ipfs-sticker.png" alt="IPFS in JavaScript logo" width="150" /></a>
|
|
166
175
|
</p>
|
|
167
176
|
</div>
|
|
168
177
|
|