p2pfacade

package module

v0.1.6 Latest Latest Go to latest Published: Aug 8, 2022 License: MIT Imports: 26 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/amirylm/libp2p-facade

Links

Open Source Insights

README ¶

libp2p-facade

Utilities plus a facade interface on top of libp2p host and major components:

Streams were simplfied into a Request and Handle procedues
Pubsub can be used with a simpler api to avoid topic management
Config has a simple and extensible structure
Metrics (prometheus)

Install

go get github.com/amirylm/libp2p-facade

Documentation ¶

Index ¶

func NewKadDHT(ctx context.Context, host host.Host, protocolPrefix protocol.ID, ...) (routing.Routing, discovery.Discovery, error)
func NewMdns(ctx context.Context, connect ConnectQueue, host host.Host, serviceTag string) mdns.Service
func Notiffee(net libp2pnetwork.Network) (*libp2pnetwork.NotifyBundle, func())
type ConnectQueue
type Facade
- func New(ctx context.Context, cfg *config.Config, opts ...libp2p.Option) (Facade, error)
- func StartNodes(ctx context.Context, cfgs []*config.Config) ([]Facade, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewKadDHT ¶ added in v0.1.1

func NewKadDHT(ctx context.Context, host host.Host, protocolPrefix protocol.ID,
	mode dht.ModeOpt, bootstrappers []peer.AddrInfo) (routing.Routing, discovery.Discovery, error)

NewKadDHT creates a new kademlia DHT and a corresponding discovery service

func NewMdns ¶

func NewMdns(ctx context.Context, connect ConnectQueue, host host.Host, serviceTag string) mdns.Service

New creates a new mdns service

func Notiffee ¶

func Notiffee(net libp2pnetwork.Network) (*libp2pnetwork.NotifyBundle, func())

Types ¶

type ConnectQueue ¶

type ConnectQueue chan peer.AddrInfo

type Facade ¶

type Facade interface {
	Start(connectQ ConnectQueue) error
	Host() host.Host
	pubsub.PubsubService
	io.Closer
}

Facade is an interface on top of libp2p

func New ¶

func New(ctx context.Context, cfg *config.Config, opts ...libp2p.Option) (Facade, error)

New creates a new p2p facade with the given config, if options were provided they will be used instead.

func StartNodes ¶

func StartNodes(ctx context.Context, cfgs []*config.Config) ([]Facade, error)

StartNodes spins up nodes according to given config

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
commons
config
pubsub
streams

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL