README
¶
libp2p implementation in Go.
libp2p implementation in Go
Description
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 IPFS Network Spec, which grew into libp2p
- go-libp2p implementation
- js-libp2p implementation
Contribute
libp2p implementation in Go is a work in progress. As such, 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.
Usage
go-libp2p repo will be a place holder for the list of Go modules that compose Go libp2p, as well as its entry point.
Install
$ go get -d github.com/ipfs/go-libp2p
$ cd $GOPATH/src/github.com/ipfs/go-libp2p
$ make
Run tests
$ cd $GOPATH/src/github.com/ipfs/go-libp2p
$ make deps
$ go test ./p2p/<path of module you want to run tests for>
Links
Directories
¶
| Path | Synopsis |
|---|---|
|
Package loggables includes a bunch of transaltor functions for commonplace/stdlib objects.
|
Package loggables includes a bunch of transaltor functions for commonplace/stdlib objects. |
|
p2p
|
|
|
crypto
package crypto implements various cryptographic utilities used by ipfs.
|
package crypto implements various cryptographic utilities used by ipfs. |
|
crypto/pb
Package crypto_pb is a generated protocol buffer package.
|
Package crypto_pb is a generated protocol buffer package. |
|
crypto/secio
package secio handles establishing secure communication between two peers.
|
package secio handles establishing secure communication between two peers. |
|
crypto/secio/pb
Package spipe_pb is a generated protocol buffer package.
|
Package spipe_pb is a generated protocol buffer package. |
|
net/mock
Package mocknet provides a mock net.Network to test with.
|
Package mocknet provides a mock net.Network to test with. |
|
net/swarm
package swarm implements a connection muxer with a pair of channels to synchronize all network communication.
|
package swarm implements a connection muxer with a pair of channels to synchronize all network communication. |
|
peer
package peer implements an object used to represent peers in the ipfs network.
|
package peer implements an object used to represent peers in the ipfs network. |
|
peer/addr
Package addr provides utility functions to handle peer addresses.
|
Package addr provides utility functions to handle peer addresses. |
|
protocol/identify/pb
Package identify_pb is a generated protocol buffer package.
|
Package identify_pb is a generated protocol buffer package. |
|
test/reconnects
Package reconnect tests connect -> disconnect -> reconnect works
|
Package reconnect tests connect -> disconnect -> reconnect works |
|
ci
Package ci implements some helper functions to use during tests.
|
Package ci implements some helper functions to use during tests. |
|
ci/jenkins
Package jenkins implements some helper functions to use during tests.
|
Package jenkins implements some helper functions to use during tests. |
|
ci/travis
Package travis implements some helper functions to use during tests.
|
Package travis implements some helper functions to use during tests. |