github.com/libp2p/go-libp2p/p2p/test/reconnects

libp2p implementation in Go


Keywords
libp2p, networking-stack, p2p
License
MIT
Install
go get github.com/libp2p/go-libp2p/p2p/test/reconnects

Documentation

libp2p hex logo

The Go implementation of the libp2p Networking Stack.



Project status

Throughput Graph

Weekly Core Dev Calls

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

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

GoDoc

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 Travis CI jenkins codecov go-libp2p entry point
go-libp2p-host Travis CI N/A codecov libp2p "host" interface
go-libp2p-blankhost Travis CI N/A codecov minimal implementation of the "host" interface
Network
go-libp2p-net Travis CI N/A codecov libp2p connection and "network" interfaces
go-libp2p-swarm Travis CI jenkins codecov reference implementation
Transport
go-libp2p-transport Travis CI N/A codecov interfaces
go-ws-transport Travis CI N/A codecov WebSocket transport
go-tcp-transport Travis CI N/A codecov TCP transport
go-libp2p-quic-transport Travis CI N/A codecov QUIC transport
go-udp-transport Travis CI N/A codecov UDP transport
go-utp-transport Travis CI N/A codecov uTorrent transport (UTP)
go-libp2p-circuit Travis CI jenkins codecov relay transport
go-libp2p-transport-upgrader Travis CI N/A codecov upgrades multiaddr-net connections into full libp2p transports
go-libp2p-reuseport-transport Travis CI N/A codecov partial transport for building transports that reuse ports
Encrypted Channels
go-conn-security Travis CI N/A codecov interfaces
go-libp2p-secio Travis CI N/A codecov SecIO crypto channel
go-conn-security-multistream Travis CI N/A codecov multistream multiplexed meta crypto channel
Private Network
go-libp2p-interface-pnet Travis CI N/A codecov interfaces
go-libp2p-pnet Travis CI N/A codecov reference implementation
Stream Muxers
go-stream-muxer Travis CI N/A codecov interfaces
go-smux-yamux Travis CI N/A codecov YAMUX stream multiplexer
go-smux-mplex Travis CI N/A codecov MPLEX stream multiplexer
NAT Traversal
go-libp2p-nat Travis CI N/A codecov
go-libp2p-autonat Travis CI N/A codecov NAT autodetection (client)
go-libp2p-autonat-svc Travis CI N/A codecov NAT autodetection (service)
Peerstore
go-libp2p-peerstore Travis CI N/A codecov interfaces and reference implementation
Connection Manager
go-libp2p-interface-connmgr Travis CI N/A codecov interface
go-libp2p-connmgr Travis CI N/A codecov reference implementation
Routing
go-libp2p-routing Travis CI N/A codecov routing interfaces
go-libp2p-record Travis CI N/A codecov record type and validator logic
go-libp2p-routing-helpers Travis CI jenkins codecov helpers for composing routers
go-libp2p-kad-dht Travis CI jenkins codecov Kademlia-like router
go-libp2p-pubsub-router Travis CI jenkins codecov record-store over pubsub adapter
Discovery
go-libp2p-discovery Travis CI N/A codecov active peer disovery interface
Consensus
go-libp2p-consensus Travis CI N/A codecov consensus protocols interfaces
go-libp2p-raft Travis CI jenkins codecov consensus implementation over raft
Pubsub
go-libp2p-pubsub Travis CI jenkins codecov multiple pubsub over libp2p implementations
RPC
go-libp2p-gorpc Travis CI N/A codecov a simple RPC library for libp2p
Metrics
go-libp2p-metrics Travis CI N/A codecov libp2p metrics interfaces/collectors
Data Types
go-libp2p-peer Travis CI N/A codecov libp2p peer-ID datatype
go-libp2p-crypto Travis CI N/A codecov libp2p key types
go-libp2p-protocol Travis CI N/A codecov libp2p protocol datatype
go-libp2p-kbucket Travis CI N/A codecov Kademlia routing table helper types
Utilities/miscellaneous
go-libp2p-loggables Travis CI N/A codecov logging helpers
go-maddr-filter Travis CI N/A codecov multiaddr filtering helpers
go-libp2p-netutil Travis CI N/A codecov misc utilities
go-msgio Travis CI N/A codecov length prefixed data channel
go-addr-util Travis CI N/A codecov address utilities for libp2p swarm
go-buffer-pool Travis CI N/A codecov a variable size buffer pool for go
go-libp2p-routing-helpers Travis CI jenkins codecov routing helpers
go-reuseport Travis CI N/A codecov enables reuse of addresses
go-sockaddr Travis CI N/A codecov utils for sockaddr conversions
go-flow-metrics Travis CI N/A codecov metrics library
Testing and examples
go-testutil Travis CI N/A codecov a collection of testing utilities for ipfs and libp2p
go-libp2p-examples Travis CI jenkins codecov go-libp2p examples and tutorials
go-libp2p-circuit-progs Travis CI N/A codecov 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