README
¶
libp2p Daemon
A standalone deployment of a libp2p host, running in its own OS process and installing a set of virtual endpoints to enable co-local applications to: communicate with peers, handle protocols, interact with the DHT, participate in pubsub, etc. no matter the language they are developed in, nor whether a native libp2p implementation exists in that language.
Maintainance
The learning-at-home team maintains this fork because the upstream repository (libp2p/go-libp2p-daemon) is not maintained by its original developers anymore.
This fork is used for all networking in Hivemind and Petals projects. This allows us to have protocol-agnostic networking with NAT traversal & libp2p relay features.
Install
This repo uses Go modules. Note that go >=1.12 is required.
$ # outside your GOPATH
$ git clone https://github.com/learning-at-home/go-libp2p-daemon
$ cd go-libp2p-daemon
$ git checkout <release tag, e.g. v0.0.1>
$ go get ./...
$ go install ./...
$ p2pd
See available releases.
Usage
Check out the GoDocs.
Language Bindings
Daemon bindings enable applications written in other languages to interact with the libp2p daemon process programmatically, by exposing an idiomatic API that handles the socket dynamics and control protocol.
The following bindings exist so far (if you want yours added, please send a PR):
- Go (reference implementation): see the p2pclient package in this repo.
- Python: py-libp2p-daemon-bindings.
- Gerbil: gerbil-libp2p.
- Nim: nim-libp2p
- Elixir: elixir-libp2p
If you wish to implement bindings in a new language, refer to the spec for the daemon control protocol and API.
Contribute
Feel free to join in. All welcome. Open an issue!
This repository falls under the IPFS Code of Conduct.
License
MIT
The last gx published version of this module was: 0.0.20: QmVBYP5AGurRJGiyTcyoUf5Etyvf2vwxKd8DMaQgbpJF58
Documentation
¶
Index ¶
- Constants
- Variables
- func BeginRelayDiscovery(h host.Host, dht *dht.IpfsDHT, trustedRelays []string, ...) context.CancelFunc
- func ConfigureRelayService(opts []libp2p.Option, maxCircuits int, maxReservations int, ...) []libp2p.Option
- func MaybeConfigureAutoRelay(opts []libp2p.Option, relayDiscovery bool, trustedRelays []string) ([]libp2p.Option, chan peer.AddrInfo)
- func ReadIdentity(path string) (crypto.PrivKey, error)
- func WriteIdentity(k crypto.PrivKey, path string) error
- type Daemon
- func (d *Daemon) Addrs() []ma.Multiaddr
- func (d *Daemon) Bootstrap() error
- func (d *Daemon) Close() error
- func (d *Daemon) DHTRoutingFactory(opts []dhtopts.Option) func(host.Host) (routing.PeerRouting, error)
- func (d *Daemon) EnablePubsub(router string, sign, strict bool) error
- func (d *Daemon) EnableRelayV2() error
- func (d *Daemon) ID() peer.ID
- func (d *Daemon) KillOnTimeout(timeout time.Duration)
- func (d *Daemon) Listener() manet.Listener
- func (d *Daemon) Serve() error
Constants ¶
const BootstrapConnections = 4
const DefaultTimeout = 60 * time.Second
Variables ¶
var BootstrapPeers = dht.DefaultBootstrapPeers
Functions ¶
func BeginRelayDiscovery ¶
func ConfigureRelayService ¶
func MaybeConfigureAutoRelay ¶
Types ¶
type Daemon ¶
type Daemon struct {
// contains filtered or unexported fields
}
Source Files
Directories