p2pd

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.

🚧 This project is under active development! 🚧

Check out the ROADMAP to see what's coming.

Install

Note that go1.11 is required.

$ go get github.com/libp2p/go-libp2p-daemon
$ cd $GOPATH/src/github.com/libp2p/go-libp2p-daemon
$ make
$ p2pd

Usage

Check out the GoDocs.

Implementing Language Bindings

See the spec for the daemon control protocol and API.

Reference implementations:

• Go bindings in the p2pclient package.
• Gerbil bindings in gerbil-libp2p.

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

License

MIT

Documentation

Index

• Constants
• Variables
• func ReadIdentity(path string) (crypto.PrivKey, error)
• func WriteIdentity(k crypto.PrivKey, path string) error
• type Daemon
  • func NewDaemon(ctx context.Context, maddr ma.Multiaddr, dhtEnabled bool, dhtClient bool, ...) (*Daemon, error)
  • func (d *Daemon) Addrs() []ma.Multiaddr
  • func (d *Daemon) Bootstrap() error
  • func (d *Daemon) DHTRoutingFactory(opts []dhtopts.Option) func(host.Host) (routing.PeerRouting, error)
  • func (d *Daemon) EnableAutoNAT(opts ...libp2p.Option) error
  • func (d *Daemon) EnablePubsub(router string, sign, strict bool) error
  • func (d *Daemon) ID() peer.ID
  • func (d *Daemon) Listener() manet.Listener

Constants

const BootstrapConnections = 4

const DefaultTimeout = 60 * time.Second

Variables

var BootstrapPeers = dht.DefaultBootstrapPeers

Functions

func ReadIdentity

func ReadIdentity(path string) (crypto.PrivKey, error)

func WriteIdentity

func WriteIdentity(k crypto.PrivKey, path string) error

Types

type Daemon

type Daemon struct {
	// contains filtered or unexported fields
}

func NewDaemon

func NewDaemon(ctx context.Context, maddr ma.Multiaddr, dhtEnabled bool, dhtClient bool, opts ...libp2p.Option) (*Daemon, error)

func (*Daemon) Addrs

func (d *Daemon) Addrs() []ma.Multiaddr

func (*Daemon) Bootstrap

func (d *Daemon) Bootstrap() error

func (*Daemon) DHTRoutingFactory

func (d *Daemon) DHTRoutingFactory(opts []dhtopts.Option) func(host.Host) (routing.PeerRouting, error)

func (*Daemon) EnableAutoNAT

func (d *Daemon) EnableAutoNAT(opts ...libp2p.Option) error

func (*Daemon) EnablePubsub

func (d *Daemon) EnablePubsub(router string, sign, strict bool) error

func (*Daemon) ID

func (d *Daemon) ID() peer.ID

func (*Daemon) Listener

func (d *Daemon) Listener() manet.Listener