README.md

The Go implementation of the libp2p Networking Stack.

Project status

Weekly Core Dev Calls

Table of Contents

• Background
• Bundles
• Usage
  • Install
  • API
  • Examples
• Development
  • Tests
  • Packages
• Contribute
• License

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

• The libp2p Specification
• go-libp2p implementation
• js-libp2p implementation

Bundles

There is currently only one bundle of go-libp2p, this package. This bundle is used by go-ipfs.

Usage

go-libp2p repo is a place holder for the list of Go modules that compose Go libp2p, as well as its entry point.

Install

> go get -u -d github.com/libp2p/go-libp2p/...
> cd $GOPATH/src/github.com/libp2p/go-libp2p
> make
> make deps

API

Examples

Examples can be found in the examples repo.

Development

Dependencies

While developing, you need to use gx to install and link your dependencies, to do that, run:

> make deps

Before commiting and pushing to Github, make sure to rewind the gx'ify of dependencies. You can do that with:

> make publish

Tests

Running of individual tests is done through gx test <path to test>

$ cd $GOPATH/src/github.com/libp2p/go-libp2p
$ make deps
$ gx test ./p2p/<path of module you want to run tests for>

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 CI/Jenkins Coverage Description Libp2p

go-libp2p go-libp2p entry point go-libp2p-host N/A libp2p "host" interface go-libp2p-blankhost N/A minimal implementation of the "host" interface Network

go-libp2p-net N/A libp2p connection and "network" interfaces go-libp2p-swarm reference implementation Transport

go-libp2p-transport N/A interfaces go-ws-transport N/A WebSocket transport go-tcp-transport N/A TCP transport go-libp2p-quic-transport N/A QUIC transport go-udp-transport N/A UDP transport go-utp-transport N/A uTorrent transport (UTP) go-libp2p-circuit relay transport go-libp2p-transport-upgrader N/A upgrades multiaddr-net connections into full libp2p transports go-libp2p-reuseport-transport N/A partial transport for building transports that reuse ports Encrypted Channels

go-conn-security N/A interfaces go-libp2p-secio N/A SecIO crypto channel go-conn-security-multistream N/A multistream multiplexed meta crypto channel Private Network

go-libp2p-interface-pnet N/A interfaces go-libp2p-pnet N/A reference implementation Stream Muxers

go-stream-muxer N/A interfaces go-smux-yamux N/A YAMUX stream multiplexer go-smux-mplex N/A MPLEX stream multiplexer NAT Traversal

go-libp2p-nat N/A

Peerstore

go-libp2p-peerstore N/A interfaces and reference implementation Connection Manager

go-libp2p-interface-connmgr N/A interface go-libp2p-connmgr N/A reference implementation Routing

go-libp2p-routing N/A routing interfaces go-libp2p-record N/A record type and validator logic go-libp2p-routing-helpers N/A helpers for composing routers go-libp2p-kad-dht Kademlia-like router go-libp2p-pubsub-router N/A record-store over pubsub adapter Consensus

go-libp2p-consensus N/A consensus protocols interfaces go-libp2p-raft consensus implementation over raft Pubsub

go-floodsub basic implementation of pubsub driven by flooding Metrics

go-libp2p-metrics N/A libp2p metrics interfaces/collectors Data Types

go-libp2p-peer N/A libp2p peer-ID datatype go-libp2p-crypto N/A libp2p key types go-libp2p-protocol N/A libp2p protocol datatype go-libp2p-kbucket N/A Kademlia routing table helper types Utilities/miscellaneous

go-libp2p-loggables N/A logging helpers go-maddr-filter N/A multiaddr filtering helpers go-libp2p-netutil N/A misc utilities go-msgio N/A length prefixed data channel go-addr-util N/A address utilities for libp2p swarm go-buffer-pool N/A a variable size buffer pool for go go-libp2p-loggables N/A logging helpers go-libp2p-routing-helpers N/A routing helpers go-maddr-filter N/A a library to perform filtering of multiaddrs. go-reuseport N/A enables reuse of addresses go-sockaddr N/A utils for sockaddr conversions go-flow-metrics N/A metrics library Testing and examples

go-testutil N/A a collection of testing utilities for ipfs and libp2p go-libp2p-examples go-libp2p examples and tutorials go-libp2p-circuit-progs N/A testing programs for go-libp2p-circuit

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 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.

Modularizing go-libp2p

We have currently a work in progress of modularizing go-libp2p from a repo monolith to several packages in different repos that can be reused for other projects of swapped for custom libp2p builds.

We want to maintain history, so we'll use git-subtree for extracting packages. Find instructions below:

# 1) create the extracted tree (has the directory specified as -P as its root)
> cd go-libp2p/
> git subtree split -P p2p/crypto/secio/ -b libp2p-secio
62b0a5c21574bcbe06c422785cd5feff378ae5bd
# important to delete the tree now, so that outdated imports fail in step 5
> git rm -r p2p/crypto/secio/
> git commit
> cd ../

# 2) make the new repo
> mkdir go-libp2p-secio
> cd go-libp2p-secio/
> git init && git commit --allow-empty

# 3) fetch the extracted tree from the previous repo
> git remote add libp2p ../go-libp2p
> git fetch libp2p
> git reset --hard libp2p/libp2p-secio

# 4) update self import paths
> sed -someflagsidontknow 'go-libp2p/p2p/crypto/secio' 'golibp2p-secio'
> git commit

# 5) create package.json and check all imports are correct
> vim package.json
> gx --verbose install --global
> gx-go rewrite
> go test ./...
> gx-go rewrite --undo
> git commit

# 4) make the package ready
> vim README.md LICENSE
> git commit

# 5) bump the version separately
> vim package.json
> gx publish
> git add package.json .gx/
> git commit -m 'Publish 1.2.3'

# 6) clean up and push
> git remote rm libp2p
> git push origin master