libp2p 0.45.9-05abd49f → 0.45.9-06f4901a
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 +96 -77
- package/dist/index.min.js +12 -12
- package/dist/src/autonat/index.js +3 -3
- package/dist/src/circuit-relay/server/index.js +8 -8
- package/dist/src/circuit-relay/transport/index.js +5 -5
- package/dist/src/circuit-relay/transport/listener.js +1 -1
- package/dist/src/circuit-relay/transport/reservation-store.js +1 -1
- package/dist/src/connection-manager/dial-queue.js +5 -5
- package/dist/src/connection-manager/index.js +4 -4
- package/dist/src/connection-manager/index.js.map +1 -1
- package/dist/src/identify/identify.d.ts +4 -4
- package/dist/src/identify/identify.d.ts.map +1 -1
- package/dist/src/identify/identify.js +12 -8
- package/dist/src/identify/identify.js.map +1 -1
- package/dist/src/identify/index.d.ts +18 -3
- package/dist/src/identify/index.d.ts.map +1 -1
- package/dist/src/identify/index.js.map +1 -1
- package/dist/src/transport-manager.js +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/src/version.js +1 -1
- package/package.json +23 -23
- package/src/autonat/index.ts +3 -3
- package/src/circuit-relay/server/index.ts +8 -8
- package/src/circuit-relay/transport/index.ts +5 -5
- package/src/circuit-relay/transport/listener.ts +1 -1
- package/src/circuit-relay/transport/reservation-store.ts +1 -1
- package/src/connection-manager/dial-queue.ts +5 -5
- package/src/connection-manager/index.ts +4 -4
- package/src/identify/identify.ts +16 -11
- package/src/identify/index.ts +21 -2
- package/src/transport-manager.ts +1 -1
- package/src/version.ts +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,48 @@
|
|
|
1
|
+
# libp2p <!-- omit in toc -->
|
|
2
|
+
|
|
3
|
+
[](http://libp2p.io/)
|
|
4
|
+
[](https://discuss.libp2p.io)
|
|
5
|
+
[](https://codecov.io/gh/libp2p/js-libp2p)
|
|
6
|
+
[](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amaster)
|
|
7
|
+
|
|
8
|
+
> JavaScript implementation of libp2p, a modular peer to peer network stack
|
|
9
|
+
|
|
10
|
+
## Table of contents <!-- omit in toc -->
|
|
11
|
+
|
|
12
|
+
- [Install](#install)
|
|
13
|
+
- [Browser `<script>` tag](#browser-script-tag)
|
|
14
|
+
- [Project status](#project-status)
|
|
15
|
+
- [Background](#background)
|
|
16
|
+
- [Roadmap](#roadmap)
|
|
17
|
+
- [Usage](#usage)
|
|
18
|
+
- [Configuration](#configuration)
|
|
19
|
+
- [Limits](#limits)
|
|
20
|
+
- [Getting started](#getting-started)
|
|
21
|
+
- [Tutorials and Examples](#tutorials-and-examples)
|
|
22
|
+
- [Development](#development)
|
|
23
|
+
- [Tests](#tests)
|
|
24
|
+
- [Run unit tests](#run-unit-tests)
|
|
25
|
+
- [Packages](#packages)
|
|
26
|
+
- [Used by](#used-by)
|
|
27
|
+
- [Contribute](#contribute)
|
|
28
|
+
- [API Docs](#api-docs)
|
|
29
|
+
- [License](#license)
|
|
30
|
+
- [Contribution](#contribution)
|
|
31
|
+
|
|
32
|
+
## Install
|
|
33
|
+
|
|
34
|
+
```console
|
|
35
|
+
$ npm i libp2p
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Browser `<script>` tag
|
|
39
|
+
|
|
40
|
+
Loading this module through a script tag will make it's exports available as `Libp2p` in the global namespace.
|
|
41
|
+
|
|
42
|
+
```html
|
|
43
|
+
<script src="https://unpkg.com/libp2p/dist/index.min.js"></script>
|
|
44
|
+
```
|
|
45
|
+
|
|
1
46
|
<h1 align="center">
|
|
2
47
|
<a href="https://libp2p.io"><img width="250" src="https://github.com/libp2p/js-libp2p/blob/master/img/libp2p.png?raw=true" alt="libp2p hex logo" /></a>
|
|
3
48
|
</h1>
|
|
@@ -33,30 +78,10 @@ We've come a long way, but this project is still in Alpha, lots of development i
|
|
|
33
78
|
The documentation in the master branch may contain changes from a pre-release.
|
|
34
79
|
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.
|
|
35
80
|
|
|
36
|
-
**Want to get started?** Check our [
|
|
81
|
+
**Want to get started?** Check our [GETTING\_STARTED.md](./doc/GETTING_STARTED.md) guide and [examples folder](/examples).
|
|
37
82
|
|
|
38
83
|
**Want to update libp2p in your project?** Check our [migrations folder](./doc/migrations).
|
|
39
84
|
|
|
40
|
-
## Table of Contents <!-- omit in toc -->
|
|
41
|
-
|
|
42
|
-
- [Background](#background)
|
|
43
|
-
- [Roadmap](#roadmap)
|
|
44
|
-
- [Install](#install)
|
|
45
|
-
- [Usage](#usage)
|
|
46
|
-
- [Configuration](#configuration)
|
|
47
|
-
- [Limits](#limits)
|
|
48
|
-
- [API Docs](#api-docs)
|
|
49
|
-
- [Getting started](#getting-started)
|
|
50
|
-
- [Tutorials and Examples](#tutorials-and-examples)
|
|
51
|
-
- [Development](#development)
|
|
52
|
-
- [Tests](#tests)
|
|
53
|
-
- [Run unit tests](#run-unit-tests)
|
|
54
|
-
- [Packages](#packages)
|
|
55
|
-
- [Used by](#used-by)
|
|
56
|
-
- [Contribute](#contribute)
|
|
57
|
-
- [License](#license)
|
|
58
|
-
- [Contribution](#contribution)
|
|
59
|
-
|
|
60
85
|
## Background
|
|
61
86
|
|
|
62
87
|
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.
|
|
@@ -76,17 +101,11 @@ To sum up, libp2p is a "network stack" -- a protocol suite -- that cleanly separ
|
|
|
76
101
|
|
|
77
102
|
## Roadmap
|
|
78
103
|
|
|
79
|
-
The js-libp2p roadmap can be found here: https://github.com/libp2p/js-libp2p/blob/master/ROADMAP.md
|
|
104
|
+
The js-libp2p roadmap can be found here: <https://github.com/libp2p/js-libp2p/blob/master/ROADMAP.md>
|
|
80
105
|
|
|
81
106
|
It represents current projects the js-libp2p maintainers are focused on and provides an estimation of completion targets.
|
|
82
107
|
|
|
83
|
-
It is complementary to the overarching libp2p project roadmap: https://github.com/libp2p/specs/blob/master/ROADMAP.md
|
|
84
|
-
|
|
85
|
-
## Install
|
|
86
|
-
|
|
87
|
-
```sh
|
|
88
|
-
npm install libp2p
|
|
89
|
-
```
|
|
108
|
+
It is complementary to the overarching libp2p project roadmap: <https://github.com/libp2p/specs/blob/master/ROADMAP.md>
|
|
90
109
|
|
|
91
110
|
## Usage
|
|
92
111
|
|
|
@@ -98,13 +117,9 @@ For all the information on how you can configure libp2p see [CONFIGURATION.md](.
|
|
|
98
117
|
|
|
99
118
|
For help configuring your node to resist malicious network peers, see [LIMITS.md](./doc/LIMITS.md)
|
|
100
119
|
|
|
101
|
-
### API Docs
|
|
102
|
-
|
|
103
|
-
- <https://libp2p.github.io/js-libp2p>
|
|
104
|
-
|
|
105
120
|
### Getting started
|
|
106
121
|
|
|
107
|
-
If you are starting your journey with `js-libp2p`, read the [
|
|
122
|
+
If you are starting your journey with `js-libp2p`, read the [GETTING\_STARTED.md](./doc/GETTING_STARTED.md) guide.
|
|
108
123
|
|
|
109
124
|
### Tutorials and Examples
|
|
110
125
|
|
|
@@ -142,43 +157,43 @@ List of packages currently in existence for libp2p
|
|
|
142
157
|
|
|
143
158
|
> This table is generated using the module `package-table` with `package-table --data=package-list.json`.
|
|
144
159
|
|
|
145
|
-
| Package
|
|
146
|
-
|
|
|
147
|
-
| **libp2p**
|
|
148
|
-
| [`libp2p`](//github.com/libp2p/js-libp2p)
|
|
149
|
-
| [`@libp2p/interface`](//github.com/libp2p/js-libp2p-interfaces)
|
|
150
|
-
| **transports**
|
|
151
|
-
| [`@libp2p/tcp`](//github.com/libp2p/js-libp2p-tcp)
|
|
152
|
-
| [`@libp2p/webrtc`](//github.com/libp2p/js-libp2p-webrtc)
|
|
153
|
-
| [`@libp2p/websockets`](//github.com/libp2p/js-libp2p-websockets)
|
|
154
|
-
| [`@libp2p/webtransport`](//github.com/libp2p/js-libp2p-webtransport)
|
|
155
|
-
| **secure channels**
|
|
156
|
-
| [`@chainsafe/libp2p-noise`](//github.com/ChainSafe/js-libp2p-noise)
|
|
157
|
-
| **stream multiplexers**
|
|
158
|
-
| [`@libp2p/mplex`](//github.com/libp2p/js-libp2p-mplex)
|
|
159
|
-
| [`@chainsafe/libp2p-yamux`](//github.com/ChainSafe/js-libp2p-yamux)
|
|
160
|
-
| **peer discovery**
|
|
161
|
-
| [`@libp2p/bootstrap`](//github.com/libp2p/js-libp2p-bootstrap)
|
|
162
|
-
| [`@libp2p/kad-dht`](//github.com/libp2p/js-libp2p-kad-dht)
|
|
163
|
-
| [`@libp2p/mdns`](//github.com/libp2p/js-libp2p-mdns)
|
|
164
|
-
| [`@chainsafe/discv5`](//github.com/ChainSafe/discv5)
|
|
165
|
-
| **content routing**
|
|
166
|
-
| [`@libp2p/reframe-content-routing`](//github.com/libp2p/js-reframe-content-routing)
|
|
167
|
-
| [`@libp2p/ipni-content-routing`](//github.com/libp2p/js-ipni-content-routing)
|
|
168
|
-
| [`@libp2p/delegated-content-routing`](//github.com/libp2p/js-libp2p-delegated-content-routing) | [
|
|
170
|
-
| **peer routing**
|
|
171
|
-
| [`@libp2p/delegated-peer-routing`](//github.com/libp2p/js-libp2p-delegated-peer-routing)
|
|
172
|
-
| [`@libp2p/kad-dht`](//github.com/libp2p/js-libp2p-kad-dht)
|
|
173
|
-
| **utilities**
|
|
174
|
-
| [`@libp2p/crypto`](//github.com/libp2p/js-libp2p-crypto)
|
|
175
|
-
| **data types**
|
|
176
|
-
| [`@libp2p/peer-id`](//github.com/libp2p/js-libp2p-peer-id)
|
|
177
|
-
| [`@libp2p/record`](//github.com/libp2p/js-libp2p-record)
|
|
178
|
-
| [`@libp2p/peer-record`](//github.com/libp2p/js-libp2p-peer-record)
|
|
179
|
-
| **pubsub**
|
|
180
|
-
| [`@ChainSafe/libp2p-gossipsub`](//github.com/ChainSafe/js-libp2p-gossipsub)
|
|
181
|
-
| [`@libp2p/floodsub`](//github.com/libp2p/js-libp2p-floodsub)
|
|
160
|
+
| Package | Version | Deps | CI | Coverage |
|
|
161
|
+
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
162
|
+
| **libp2p** | | | | |
|
|
163
|
+
| [`libp2p`](//github.com/libp2p/js-libp2p) | [](//github.com/libp2p/js-libp2p/releases) | [](//libraries.io/npm/libp2p) | [](//github.com/libp2p/js-libp2p/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p) |
|
|
164
|
+
| [`@libp2p/interface`](//github.com/libp2p/js-libp2p-interfaces) | [](//github.com/libp2p/js-libp2p-interfaces/releases) | [](//libraries.io/npm/%40libp2p%2Finterface-libp2p) | [](//github.com/libp2p/js-libp2p-interfaces/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-interfaces) |
|
|
165
|
+
| **transports** | | | | |
|
|
166
|
+
| [`@libp2p/tcp`](//github.com/libp2p/js-libp2p-tcp) | [](//github.com/libp2p/js-libp2p-tcp/releases) | [](//libraries.io/npm/%40libp2p%2Ftcp) | [](//github.com/libp2p/js-libp2p-tcp/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-tcp) |
|
|
167
|
+
| [`@libp2p/webrtc`](//github.com/libp2p/js-libp2p-webrtc) | [](//github.com/libp2p/js-libp2p-webrtc/releases) | [](//libraries.io/npm/%40libp2p%2Fwebrtc) | [](//github.com/libp2p/js-libp2p-webrtc/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-webrtc) |
|
|
168
|
+
| [`@libp2p/websockets`](//github.com/libp2p/js-libp2p-websockets) | [](//github.com/libp2p/js-libp2p-websockets/releases) | [](//libraries.io/npm/%40libp2p%2Fwebsockets) | [](//github.com/libp2p/js-libp2p-websockets/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-websockets) |
|
|
169
|
+
| [`@libp2p/webtransport`](//github.com/libp2p/js-libp2p-webtransport) | [](//github.com/libp2p/js-libp2p-webtransport/releases) | [](//libraries.io/npm/%40libp2p%2Fwebtransport) | [](//github.com/libp2p/js-libp2p-webtransport/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-webtransport) |
|
|
170
|
+
| **secure channels** | | | | |
|
|
171
|
+
| [`@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) |
|
|
172
|
+
| **stream multiplexers** | | | | |
|
|
173
|
+
| [`@libp2p/mplex`](//github.com/libp2p/js-libp2p-mplex) | [](//github.com/libp2p/js-libp2p-mplex/releases) | [](//libraries.io/npm/%40libp2p%2Fmplex) | [](//github.com/libp2p/js-libp2p-mplex/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-mplex) |
|
|
174
|
+
| [`@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) |
|
|
175
|
+
| **peer discovery** | | | | |
|
|
176
|
+
| [`@libp2p/bootstrap`](//github.com/libp2p/js-libp2p-bootstrap) | [](//github.com/libp2p/js-libp2p-bootstrap/releases) | [](//libraries.io/npm/%40libp2p%2Fbootstrap) | [](//github.com/libp2p/js-libp2p-bootstrap/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-bootstrap) |
|
|
177
|
+
| [`@libp2p/kad-dht`](//github.com/libp2p/js-libp2p-kad-dht) | [](//github.com/libp2p/js-libp2p-kad-dht/releases) | [](//libraries.io/npm/%40libp2p%2Fkad-dht) | [](//github.com/libp2p/js-libp2p-kad-dht/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-kad-dht) |
|
|
178
|
+
| [`@libp2p/mdns`](//github.com/libp2p/js-libp2p-mdns) | [](//github.com/libp2p/js-libp2p-mdns/releases) | [](//libraries.io/npm/%40libp2p%2Fmdns) | [](//github.com/libp2p/js-libp2p-mdns/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-mdns) |
|
|
179
|
+
| [`@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) |
|
|
180
|
+
| **content routing** | | | | |
|
|
181
|
+
| [`@libp2p/reframe-content-routing`](//github.com/libp2p/js-reframe-content-routing) | [](//github.com/libp2p/js-reframe-content-routing/releases) | [](//libraries.io/npm/%40libp2p%2Freframe-content-routing) | [](//github.com/libp2p/js-reframe-content-routing/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-reframe-content-routing) |
|
|
182
|
+
| [`@libp2p/ipni-content-routing`](//github.com/libp2p/js-ipni-content-routing) | [](//github.com/libp2p/js-ipni-content-routing/releases) | [](//libraries.io/npm/%40libp2p%2Fipni-content-routing) | [](//github.com/libp2p/js-ipni-content-routing/actions?query=branch%3Amain+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-ipni-content-routing) |
|
|
183
|
+
| [`@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) |
|
|
184
|
+
| [`@libp2p/kad-dht`](//github.com/libp2p/js-libp2p-kad-dht) | [](//github.com/libp2p/js-libp2p-kad-dht/releases) | [](//libraries.io/npm/%40libp2p%2Fkad-dht) | [](//github.com/libp2p/js-libp2p-kad-dht/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-kad-dht) |
|
|
185
|
+
| **peer routing** | | | | |
|
|
186
|
+
| [`@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) |
|
|
187
|
+
| [`@libp2p/kad-dht`](//github.com/libp2p/js-libp2p-kad-dht) | [](//github.com/libp2p/js-libp2p-kad-dht/releases) | [](//libraries.io/npm/%40libp2p%2Fkad-dht) | [](//github.com/libp2p/js-libp2p-kad-dht/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-kad-dht) |
|
|
188
|
+
| **utilities** | | | | |
|
|
189
|
+
| [`@libp2p/crypto`](//github.com/libp2p/js-libp2p-crypto) | [](//github.com/libp2p/js-libp2p-crypto/releases) | [](//libraries.io/npm/%40libp2p%2Fcrypto) | [](//github.com/libp2p/js-libp2p-crypto/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-crypto) |
|
|
190
|
+
| **data types** | | | | |
|
|
191
|
+
| [`@libp2p/peer-id`](//github.com/libp2p/js-libp2p-peer-id) | [](//github.com/libp2p/js-libp2p-peer-id/releases) | [](//libraries.io/npm/%40libp2p%2Fpeer-id) | [](//github.com/libp2p/js-libp2p-peer-id/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-peer-id) |
|
|
192
|
+
| [`@libp2p/record`](//github.com/libp2p/js-libp2p-record) | [](//github.com/libp2p/js-libp2p-record/releases) | [](//libraries.io/npm/%40libp2p%2Frecord) | [](//github.com/libp2p/js-libp2p-record/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-record) |
|
|
193
|
+
| [`@libp2p/peer-record`](//github.com/libp2p/js-libp2p-peer-record) | [](//github.com/libp2p/js-libp2p-peer-record/releases) | [](//libraries.io/npm/%40libp2p%2Fpeer-record) | [](//github.com/libp2p/js-libp2p-peer-record/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-peer-record) |
|
|
194
|
+
| **pubsub** | | | | |
|
|
195
|
+
| [`@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) |
|
|
196
|
+
| [`@libp2p/floodsub`](//github.com/libp2p/js-libp2p-floodsub) | [](//github.com/libp2p/js-libp2p-floodsub/releases) | [](//libraries.io/npm/%40libp2p%2Ffloodsub) | [](//github.com/libp2p/js-libp2p-floodsub/actions?query=branch%3Amaster+workflow%3Aci+) | [](https://codecov.io/gh/libp2p/js-libp2p-floodsub) |
|
|
182
197
|
|
|
183
198
|
## Used by
|
|
184
199
|
|
|
@@ -196,17 +211,21 @@ And [many others...](https://github.com/libp2p/js-libp2p/network/dependents)
|
|
|
196
211
|
|
|
197
212
|
The libp2p implementation in JavaScript is a work in progress. As such, there are a few things you can do right now to help out:
|
|
198
213
|
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
214
|
+
- Go through the modules and **check out existing issues**. This would be especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
|
|
215
|
+
- **Perform code reviews**. Most of this has been developed by @diasdavid, which means that more eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
|
|
216
|
+
- **Add tests**. There can never be enough tests.
|
|
217
|
+
|
|
218
|
+
## API Docs
|
|
219
|
+
|
|
220
|
+
- <https://libp2p.github.io/js-libp2p/modules/libp2p.html>
|
|
202
221
|
|
|
203
222
|
## License
|
|
204
223
|
|
|
205
224
|
Licensed under either of
|
|
206
225
|
|
|
207
|
-
|
|
208
|
-
|
|
226
|
+
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
|
|
227
|
+
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
|
|
209
228
|
|
|
210
|
-
|
|
229
|
+
## Contribution
|
|
211
230
|
|
|
212
231
|
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.
|