libp2p
v3.1.2-05acd0c35TypeScript
JavaScript implementation of libp2p, a modular peer to peer network stack
0/weekUpdated 3 weeks agoApache-2.0 OR MITUnpacked: 2.6 MB
Published by achingbrain
npm install libp2p
The JavaScript implementation of the libp2p Networking Stack
Background
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.
We are in the process of writing better documentation, blog posts, tutorials and a formal specification. Today you can find:
- libp2p.io
- docs.libp2p.io
- Specification (WIP)
- Discussion Forums
- Talks
- libp2p <3 ethereum at DEVCON2
- Articles
- The overview of libp2p
To sum up, libp2p is a "network stack" -- a protocol suite -- that cleanly separates concerns, and enables sophisticated applications to only use the protocols they absolutely need, without giving up interoperability and upgradability. libp2p grew out of IPFS, but it is built so that lots of people can use it, for lots of different projects.
Roadmap
The js-libp2p roadmap can be found here:
It represents current projects the js-libp2p maintainers are focused on and provides an estimation of completion targets.
Usage
$3
For all the information on how you can configure libp2p see CONFIGURATION.md.
Limits
For help configuring your node to resist malicious network peers, see LIMITS.md
Getting started
If you are starting your journey with js-libp2p, read the GETTING\_STARTED.md guide.
Tutorials and Examples
You can find multiple examples on the examples repo that will guide you through using libp2p for several scenarios.
Development
Clone and install dependencies:
``sh`
> git clone https://github.com/libp2p/js-libp2p.git
> cd js-libp2p
> npm install
> npm run build
Tests
Run unit tests
`shrun all the unit tests
> npm test
run just Node.js tests
> npm run test:node
run just Browser tests (Chrome)
> npm run test:chrome
`
Packages
List of packages currently in existence for libp2p
> This table is generated using the module
with package-table --data=package-list.json.| Package | Version | Deps | CI | Coverage |
| ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| libp2p | | | | |
|
libp2p |  |  |  |  |
| @libp2p/interface |  |  |  |  |
| transports | | | | |
| @libp2p/memory |  |  |  |  |
| @libp2p/tcp |  |  |  |  |
| @libp2p/webrtc |  |  |  |  |
| @libp2p/websockets |  |  |  |  |
| @libp2p/webtransport |  |  |  |  |
| secure channels | | | | |
| @chainsafe/libp2p-noise |  |  |  |  |
| @libp2p/plaintext |  |  |  |  |
| @libp2p/tls |  |  |  |  |
| stream multiplexers | | | | |
| @chainsafe/libp2p-yamux |  |  |  |  |
| @libp2p/mplex |  |  |  |  |
| peer discovery | | | | |
| @libp2p/bootstrap |  |  |  |  |
| @libp2p/kad-dht |  |  |  |  |
| @libp2p/mdns |  |  |  |  |
| @chainsafe/discv5 |  |  |  |  |
| content routing | | | | |
| @libp2p/http-v1-content-routing |  |  |  |  |
| @libp2p/delegated-content-routing |  |  |  |  |
| @libp2p/kad-dht |  |  |  |  |
| peer routing | | | | |
| @libp2p/delegated-peer-routing |  |  |  |  |
| @libp2p/kad-dht |  |  |  |  |
| utilities | | | | |
| @libp2p/crypto |  |  |  |  |
| data types | | | | |
| @libp2p/peer-id |  |  |  |  |
| @libp2p/peer-record |  |  |  |  |
| pubsub | | | | |
| @chainsafe/libp2p-gossipsub |  |  |  |  |
| @libp2p/floodsub` |  |  |  |  |Used by
And many others...
Contribute
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:
- 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.
- Perform code reviews. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
- Add tests. There can never be enough tests.
API Docs
-
License
Licensed under either of
- Apache 2.0, (LICENSE-APACHE /
- MIT (LICENSE-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.