p2p

README

p2p

This subpackage contains helper functions for use with go-ma. They MUST NOT be required by any other subpackage. It's an aid for simple p2p communication, but users should be able to use go-ma without it.

2023-11-19: bahner

Documentation

Index

• Variables
• type DHT
  • func NewDHT(h host.Host, cg *connmgr.ConnectionGater, dhtOpts ...p2pDHT.Option) (*DHT, error)
  • func (d *DHT) Bootstrap(ctx context.Context) error
• type MDNS
• type Options
  • func DefaultOptions() Options
• type P2P
  • func Get() *P2P
  • func Init(opts Options) (*P2P, error)
  • func (p *P2P) AllConnectedPeers() p2peer.IDSlice
  • func (p *P2P) ConnectedProctectedPeersNickList() []string
  • func (p *P2P) ConnectedProtectedPeers() p2peer.IDSlice
  • func (p *P2P) ConnectedProtectedPeersAddrInfo() map[string]p2peer.AddrInfo
  • func (p *P2P) ConnectedUnprotectedPeers() p2peer.IDSlice
  • func (p *P2P) StartDiscoveryLoop(ctx context.Context) error

Variables

var (
	ErrFailedToCreateRoutingDiscovery = fmt.Errorf("failed to create routing discovery")
)

Types

type DHT

type DHT struct {
	*p2pDHT.IpfsDHT
	Host            host.Host
	ConnectionGater *connmgr.ConnectionGater
}

func NewDHT

func NewDHT(h host.Host, cg *connmgr.ConnectionGater, dhtOpts ...p2pDHT.Option) (*DHT, error)

func (*DHT) Bootstrap

func (d *DHT) Bootstrap(ctx context.Context) error

You should only call this once. It bootstraps the DHT to the network.

type MDNS

type MDNS struct {
	PeerChan chan p2peer.AddrInfo
	// contains filtered or unexported fields
}

type Options

type Options struct {
	DHT     []p2pDHT.Option
	P2P     []libp2p.Option
	Connmgr []connmgr.Option
}

func DefaultOptions

func DefaultOptions() Options

type P2P

type P2P struct {
	PubSub   *p2ppubsub.PubSub
	DHT      *DHT
	MDNS     *MDNS
	Host     host.Host
	AddrInfo p2peer.AddrInfo
}

This is not a normal libp2p node, it's a wrapper around it. And it is specific to this project. It contains a libp2p node, a pubsub service and a DHT instance. It also contains a list of connected peers.

func Get

func Get() *P2P

Get the P2P instance. This is a singleton.

func Init

func Init(opts Options) (*P2P, error)

Initialise everything needed for p2p communication. The function forces use of a specific IPNS key. Taken from the config package. It would be an error to initialise the node with a different key. The input is derived from Config() in the config package.

func (*P2P) AllConnectedPeers

func (p *P2P) AllConnectedPeers() p2peer.IDSlice

AllConnectedPeers returns a slice of p2peer.ID for all connected peers of the given host.

func (*P2P) ConnectedProctectedPeersNickList

func (p *P2P) ConnectedProctectedPeersNickList() []string

func (*P2P) ConnectedProtectedPeers

func (p *P2P) ConnectedProtectedPeers() p2peer.IDSlice

ConnectedProtectedPeers returns a slice of p2peer.ID for all protected connected peers.

func (*P2P) ConnectedProtectedPeersAddrInfo

func (p *P2P) ConnectedProtectedPeersAddrInfo() map[string]p2peer.AddrInfo

ConnectedProtectedPeersAddrInfo returns a map of p2peer.ID to AddrInfo for all protected connected peers.

func (*P2P) ConnectedUnprotectedPeers

func (p *P2P) ConnectedUnprotectedPeers() p2peer.IDSlice

ConnectedUnprotectedPeers returns a slice of p2peer.ID for all unprotected connected peers.

func (*P2P) StartDiscoveryLoop

func (p *P2P) StartDiscoveryLoop(ctx context.Context) error