js-libp2p：libp2p网络堆栈JavaScript实现

<h1 align="center"> <a href="libp2p.io" rel='nofollow' onclick='return false;'><img width="250" src="https://github.com/libp2p/libp2p/blob/master/logo/black-bg-2.png?raw=true" alt="libp2p hex logo" /></a> </h1> <h3 align="center">The JavaScript implementation of the libp2p Networking Stack.</h3> <p align="center"> <a href="http://protocol.ai" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square" /></a> <a href="http://libp2p.io/" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square" /></a> <a href="http://webchat.freenode.net/?channels=%23libp2p" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square" /></a> <a href="https://riot.im/app/#/room/#libp2p:matrix.org" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/badge/matrix-%23libp2p%3Apermaweb.io-blue.svg?style=flat-square" /> </a> <a href="https://discord.gg/66KBrm2" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/discord/475789330380488707?color=blueviolet&label=discord&style=flat-square" /></a> <a href="https://discuss.libp2p.io" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg" /></a> <a href="https://www.npmjs.com/package/libp2p" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/npm/dm/libp2p.svg" /></a> <a href="https://www.jsdelivr.com/package/npm/libp2p" rel='nofollow' onclick='return false;'><img src="https://data.jsdelivr.com/v1/package/npm/libp2p/badge"/></a> </p> <p align="center"> <a href="https://github.com/libp2p/js-libp2p/actions?query=branch%3Amaster+workflow%3Aci+" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/github/workflow/status/libp2p/js-libp2p/ci?label=ci&style=flat-square" /></a> <a href="https://codecov.io/gh/libp2p/js-libp2p" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/codecov/c/github/libp2p/js-libp2p/master.svg?style=flat-square"></a> <a href="https://bundlephobia.com/result?p=ipfsd-ctl" rel='nofollow' onclick='return false;'><img src="https://flat.badgen.net/bundlephobia/minzip/ipfsd-ctl"></a> <br> <a href="https://david-dm.org/libp2p/js-libp2p" rel='nofollow' onclick='return false;'><img src="https://david-dm.org/libp2p/js-libp2p.svg?style=flat-square" /></a> <a href="https://github.com/feross/standard" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square"></a> <a href="https://github.com/RichardLitt/standard-readme" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square" /></a> <a href="" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/badge/npm-%3E%3D6.0.0-orange.svg?style=flat-square" /></a> <a href="" rel='nofollow' onclick='return false;'><img src="https://img.shields.io/badge/Node.js-%3E%3D12.0.0-orange.svg?style=flat-square" /></a> <br> </p> ### Project status 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 🐉.. The documentation in the master branch may contain changes from a pre-release. 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. **Want to get started?** Check our [GETTING_STARTED.md](./doc/GETTING_STARTED.md) guide and [examples folder](/examples). **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) ## Lead Maintainer [Jacob Heun](https://github.com/jacobheun/) ## Table of Contents - [Background](#background) - [Install](#install) - [Usage](#usage) - [Configuration](#configuration) - [API](#api) - [Getting Started](#getting-started) - [Tutorials and Examples](#tutorials-and-examples) - [Development](#development) - [Tests](#tests) - [Packages](#packages) - [Contribute](#contribute) - [License](#license) ## 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](https://libp2p.io) - [docs.libp2p.io](https://docs.libp2p.io) - [Specification (WIP)](https://github.com/libp2p/specs) - [Discussion Forums](https://discuss.libp2p.io) - Talks - [`libp2p <3 ethereum` at DEVCON2](https://ethereumfoundation.org/devcon/?session=libp2p) [📼 video](https://www.youtube.com/watch?v=HxueJbeMVG4) [slides](https://ethereumfoundation.org/devcon/wp-content/uploads/2016/10/libp2p-HEART-devp2p-IPFS-PLUS-Ethereum-networking.pdf) [📼 demo-1](https://ethereumfoundation.org/devcon/wp-content/uploads/2016/10/libp2p_demo1-1.mp4) [📼 demo-2](https://ethereumfoundation.org/devcon/wp-content/uploads/2016/10/libp2p_demo2-1.mp4) - Articles - [The overview of libp2p](https://github.com/libp2p/libp2p#description) 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 upgradeability. libp2p grew out of IPFS, but it is built so that lots of people can use it, for lots of different projects. ## Install ```sh npm install libp2p ``` ## Usage ### Configuration For all the information on how you can configure libp2p see [CONFIGURATION.md](./doc/CONFIGURATION.md). ### API The specification is available on [API.md](./doc/API.md). ### Getting started If you are starting your journey with `js-libp2p`, read the [GETTING_STARTED.md](./doc/GETTING_STARTED.md) guide. ### Tutorials and Examples You can find multiple examples on the [examples folder](./examples) 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 ``` ### Tests #### Run unit tests ```sh # run all the unit tsts > npm test # run just Node.js tests > npm run test:node # run just Browser tests (Chrome) > npm run test:browser ``` ### Packages List of packages currently in existence for libp2p > This table is generated using the module `package-table` with `package-table --data=package-list.json`. | Package | Version | Deps | CI | Coverage | Lead Maintainer | | ---------|---------|---------|---------|---------|--------- | | **libp2p** | | [`libp2p`](//github.com/libp2p/js-libp2p) | [](//github.com/libp2p/js-libp2p/releases) | [](https://david-dm.org/libp2p/js-libp2p) | [](https://travis-ci.com/libp2p/js-libp2p) | [](https://codecov.io/gh/libp2p/js-libp2p) | [Jacob Heun](mailto:jacobheun@gmail.com) | | [`libp2p-daemon`](//github.com/libp2p/js-libp2p-daemon) | [](//github.com/libp2p/js-libp2p-daemon/releases) | [](https://david-dm.org/libp2p/js-libp2p-daemon) | [](https://travis-ci.com/libp2p/js-libp2p-daemon) | [![codecov](https://codecov.io/gh/li