Skip to content
libp2p implementation in Go
Go Makefile
Branch: master
Clone or download

README.md

libp2p hex logo

The Go implementation of the libp2p Networking Stack.



Table of Contents

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.

We will be writing a set of docs, posts, tutorials, and talks to explain what p2p is, why it is tremendously useful, and how it can help your existing and new projects. But in the meantime, check out

Usage

This repository (go-libp2p) serves as the entrypoint to the universe of modules that compose the Go implementation of the libp2p stack. Libp2p requires go 1.12+.

We mainly use Go modules for our dependency and release management (and thus require go >= 1.12+). In order to get the best developer experience, we recommend you do too. Otherwise, you may ocassionally encounter a breaking build as you'll be running off master (which, by definition, is not guaranteed to be stable).

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"

The next time you run go get or go build, the Go build tools will look for available releases, and will pick the highest available one.

As new releases of go-libp2p are made available, you can upgrade your application by manually editing your go.mod file, or using the Go tools to maintain module requirements.

API

GoDoc

Examples

Examples can be found in the examples repo.

Development

Using the libp2p Workspace

While developing, you may need to make changes to several modules at once, or you may want changes made locally in one module to be available for import by another.

The go libp2p workspace provides a developer-oriented view of the modules that comprise go-libp2p.

Using the tooling in the workspace repository, you can checkout all of go-libp2p's module repos and enter "local mode", which adds replace directives to the go.mod files in each local working copy. When you build locally, the libp2p depdendencies will be resolved from your local working copies.

Once you've committed your changes, you can switch back to "remote mode", which removes the replace directives and pulls imports from the main go module cache.

See the workspace repo for more information.

About gx

Before adopting gomod, libp2p used gx to manage dependencies using IPFS.

Due to the difficulties in keeping both dependency management solutions up-to-date, gx support was ended in April 2019.

Ending gx support does not mean that existing gx builds will break. Because gx references dependencies by their immutable IPFS hash, any currently working gx builds will continue to work for as long as the dependencies are resolvable in IPFS.

However, new changes to go-libp2p will not be published via gx, and users are encouraged to adopt gomod to stay up-to-date.

If you experience any issues migrating from gx to gomod, please join the discussion at the libp2p forums.

Tests

go test ./... will run all tests in the repo.

Packages

This table is generated using the module package-table with package-table --data=package-list.json.

List of packages currently in existence for libp2p:

Name CI/Travis Coverage Description
Libp2p
go-libp2p Travis CI codecov go-libp2p entry point
go-libp2p-core Travis CI codecov core interfaces, types, and abstractions
go-libp2p-blankhost Travis CI codecov minimal implementation of the "host" interface
Network
go-libp2p-swarm Travis CI codecov reference implementation of network state machine
Transport
go-ws-transport Travis CI codecov WebSocket transport
go-tcp-transport Travis CI codecov TCP transport
go-libp2p-quic-transport Travis CI codecov QUIC transport
go-udp-transport Travis CI codecov UDP transport
go-utp-transport Travis CI codecov uTorrent transport (UTP)
go-libp2p-circuit Travis CI codecov relay transport
go-libp2p-transport-upgrader Travis CI codecov upgrades multiaddr-net connections into full libp2p transports
go-libp2p-reuseport-transport Travis CI codecov partial transport for building transports that reuse ports
Encrypted Channels
go-libp2p-secio Travis CI codecov SecIO crypto channel
go-libp2p-tls Travis CI codecov TLS 1.3+ crypto channel
go-conn-security-multistream Travis CI codecov multistream multiplexed meta crypto channel
Private Network
go-libp2p-pnet Travis CI codecov reference private networking implementation
Stream Muxers
go-libp2p-yamux Travis CI codecov YAMUX stream multiplexer
go-libp2p-mplex Travis CI codecov MPLEX stream multiplexer
NAT Traversal
go-libp2p-nat Travis CI codecov
Peerstore
go-libp2p-peerstore Travis CI codecov reference implementation of peer metadata storage component
Connection Manager
go-libp2p-connmgr Travis CI codecov reference implementation of connection manager
Routing
go-libp2p-record Travis CI codecov record type and validator logic
go-libp2p-kad-dht Travis CI codecov Kademlia-like router
go-libp2p-kbucket Travis CI codecov Kademlia routing table helper types
go-libp2p-coral-dht Travis CI codecov Router based on Coral DHT
go-libp2p-pubsub-router Travis CI codecov record-store over pubsub adapter
Consensus
go-libp2p-consensus Travis CI codecov consensus protocols interfaces
go-libp2p-raft Travis CI codecov consensus implementation over raft
Pubsub
go-libp2p-pubsub Travis CI codecov multiple pubsub over libp2p implementations
RPC
go-libp2p-gorpc Travis CI codecov a simple RPC library for libp2p
Utilities/miscellaneous
go-libp2p-loggables Travis CI codecov logging helpers
go-maddr-filter Travis CI codecov multiaddr filtering helpers
go-libp2p-netutil Travis CI codecov misc utilities
go-msgio Travis CI codecov length prefixed data channel
go-addr-util Travis CI codecov address utilities for libp2p swarm
go-buffer-pool Travis CI codecov a variable size buffer pool for go
go-libp2p-routing-helpers Travis CI codecov routing helpers
go-reuseport Travis CI codecov enables reuse of addresses
go-sockaddr Travis CI codecov utils for sockaddr conversions
go-flow-metrics Travis CI codecov metrics library
go-libp2p-gostream Travis CI codecov Go 'net' wrappers for libp2p
go-libp2p-http Travis CI codecov HTTP on top of libp2p streams
Testing and examples
go-libp2p-testing Travis CI codecov a collection of testing utilities for libp2p
go-libp2p-examples Travis CI codecov go-libp2p examples and tutorials
Deprecated
go-conn-security Travis CI codecov absorbed into go-libp2p-core
go-peerstream Travis CI codecov early work that informed libp2p design
go-stream-muxer Travis CI codecov absorbed into go-libp2p-core
go-testutil Travis CI codecov replaced by go-libp2p-testing
go-libp2p-circuit-progs Travis CI codecov testing programs for go-libp2p-circuit
go-libp2p-crypto Travis CI codecov absorbed into go-libp2p-core
go-libp2p-conn Travis CI codecov replaced by go-libp2p-swarm and go-libp2p-transport-upgrader
go-libp2p-discovery Travis CI codecov absorbed into go-libp2p-core
go-libp2p-dummy-conn Travis CI codecov implempentation of deprecated interface
go-libp2p-host Travis CI codecov absorbed into go-libp2p-core
go-libp2p-identify Travis CI codecov moved to go-libp2p
go-libp2p-interface-conn Travis CI codecov absorbed into go-libp2p-core
go-libp2p-interface-connmgr Travis CI codecov absorbed into go-libp2p-core
go-libp2p-interface-pnet Travis CI codecov absorbed into go-libp2p-core
go-libp2p-metrics Travis CI codecov absorbed into go-libp2p-core
go-libp2p-net Travis CI codecov absorbed into go-libp2p-core
go-libp2p-peer Travis CI codecov absorbed into go-libp2p-core
go-libp2p-ping Travis CI codecov moved to go-libp2p
go-libp2p-protocol Travis CI codecov absorbed into go-libp2p-core
go-libp2p-transport Travis CI codecov absorbed into go-libp2p-core

Contribute

go-libp2p is part of The IPFS Project, and 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
  • please make branches + pull-request, even if working on the main repository
  • ask questions or talk about things in Issues, our discussion forums, or #libp2p or #ipfs on freenode.
  • ensure you are able to contribute (no legal issues please-- we use the DCO)
  • run go fmt before pushing any code
  • run golint and go vet too -- some things (like protobuf files) are expected to fail.
  • get in touch with @jbenet and @diasdavid about how best to contribute
  • have fun!

There's a few things you can do right now to help out:

  • 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 infrasture 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.
  • Add tests. There can never be enough tests.

The last gx published version of this module was: 6.0.41: QmTRN7hRxvGkxKxDdeudty7sRet4L7ZKZCqKsXHa79wmAc

You can’t perform that action at this time.