The Go implementation of the libp2p Networking Stack.
Table of Contents
- Background
- Usage
- Contribute
- Notable Users
Background
libp2p is a networking stack and library modularized out of The IPFS Project, and bundled separately for other tools to use.
libp2p is the product of a long, and arduous quest of understanding -- a deep dive into the internet's network stack, and plentiful peer-to-peer protocols from the past. Building large-scale peer-to-peer systems has been complex and difficult in the last 15 years, and libp2p is a way to fix that. It 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.
To learn more, check out the following resources:
- Our documentation
- Our community discussion forum
- The libp2p Specification
- js-libp2p implementation
- rust-libp2p implementation
Usage
This repository (go-libp2p) serves as the entrypoint to the universe of packages that compose the Go implementation of the libp2p stack.
You can start using go-libp2p in your Go application simply by adding imports from our repos, e.g.:
import "github.com/libp2p/go-libp2p"
Examples
Examples can be found in the examples folder.
Dashboards
We provide prebuilt Grafana dashboards so that applications can better monitor libp2p in production.
You can find the dashboard JSON files here.
We also have live Public Dashboards that you can check out to see real time monitoring in action.
Contribute
go-libp2p is MIT-licensed open source software. We welcome contributions big and small! Take a look at the community contributing notes. Please make sure to check the issues. Search the closed ones before reporting things, and help us with the open ones.
Guidelines:
- read the libp2p spec
- for general questions, use our discussion forum
- for bug reports, open an issue
- for development questions of go-libp2p itself, please join the mailing list
- chat at #libp2p on Libera Chat
- ensure you are able to contribute (no legal issues please -- we use the DCO)
- get in touch with @libp2p/go-libp2p-maintainers about how best to contribute
- No drive-by contributions seeking to collect airdrops.
- Many projects aim to reward contributors to common goods. Great. However,
this creates an unfortunate incentive for low-effort PRs, submitted solely to
claim rewards. These PRs consume maintainers’ time and energy to triage, with
little to no impact on end users. If we suspect this is the intent of a PR,
we may close it without comment. If you believe this was done in error,
contact us via email. Reference this README section and explain why your PR
is not a “drive-by contribution.”
- have fun!
There's a few things you can do right now to help out:
- Perform code reviews.
- Add tests. There can never be enough tests.
- Go through the modules below 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.
AI Assistance Notice
[!IMPORTANT]
If you are using any kind of AI assistance to contribute to libp2p,
it must be disclosed in the pull request.
If you are using any kind of AI assistance while contributing to libp2p,
this must be disclosed in the pull request, along with the extent to
which AI assistance was used (e.g. docs only vs. code generation).
If PR responses are being generated by an AI, disclose that as well.
As a small exception, trivial tab-completion doesn't need to be disclosed,
so long as it is limited to single keywords or short phrases.
An example disclosure:
This PR was written primarily by Claude Code.
Or a more detailed disclosure:
I consulted ChatGPT to understand the codebase but the solution
was fully authored manually by myself.
Failure to disclose this is first and foremost rude to the human operators
on the other end of the pull request, but it also makes it difficult to
determine how much scrutiny to apply to the contribution.
In a perfect world, AI assistance would produce equal or higher quality
work than any human. That isn't the world we live in today, and in most cases
it's generating slop. I say this despite being a fan of and using them
successfully myself (with heavy supervision)!
Please be respectful to maintainers and disclose AI assistance.
Supported Go Versions
We test against and support the two most recent major releases of Go. This is
informed by Go's own security policy.
Notable Users
Some notable users of go-libp2p are:
- Kubo - The original Go implementation of IPFS
- Lotus - An implementation of the Filecoin protocol
- Prysm - An Ethereum Beacon Chain consensus client built by Prysmatic Labs
- Berty - An open, secure, offline-first, peer-to-peer and zero trust messaging app.
- Wasp - A node that runs IOTA Smart Contracts built by the IOTA Foundation
- Mina - A lightweight, constant-sized blockchain that runs zero-knowledge smart contracts
- Polygon Edge - A modular, extensible framework for building Ethereum compatible networks
- Celestia Node - The Go implementation of Celestia's data availability nodes
- Status go - Status bindings for go-ethereum, built by Status.im
- Flow - A blockchain built to support games, apps, and digital assets built by Dapper Labs
- Swarm Bee - A client for connecting to the Swarm network
- MultiversX Node - The Go implementation of the MultiversX network protocol
- Sonr - A platform to integrate DID Documents, WebAuthn, and IPFS and manage digital identity and assets.
- EdgeVPN - A decentralized, immutable, portable VPN and reverse proxy over p2p.
- Kairos - A Kubernetes-focused, Cloud Native Linux meta-distribution.
- Oasis Core - The consensus and runtime layers of the Oasis protocol.
- Spacemesh - The Go implementation of the Spacemesh protocol, a novel layer one blockchain
- Tau - Open source distributed Platform as a Service (PaaS)
Please open a pull request if you want your project (min. 250 GitHub stars) to be added here.
