libp2p

Documentation

Index

• Constants
• Variables
• func AddrFilters(filters []string) func() (*ma.Filters, Libp2pOpts, error)
• func AddrsFactory(announce []string, noAnnounce []string) func() (opts Libp2pOpts, err error)
• func AutoNATService(throttle *config.AutoNATThrottleConfig) func() Libp2pOpts
• func BaseRouting(experimentalDHTClient bool) interface{}
• func ConnectionManager(low, high int, grace time.Duration) func() (opts Libp2pOpts, err error)
• func ConstructDelegatedRouting(routers config.Routers, methods config.Methods, peerID string, addrs []string, ...) ...
• func ContentRouting(in p2pOnlineContentRoutingIn) routing.ContentRouting
• func DiscoveryHandler(mctx helpers.MetricsCtx, lc fx.Lifecycle, host host.Host) *discoveryHandler
• func FloodSub(pubsubOptions ...pubsub.Option) interface{}
• func ForceReachability(val *config.OptionalString) func() (opts Libp2pOpts, err error)
• func GossipSub(pubsubOptions ...pubsub.Option) interface{}
• func HolePunching(flag config.Flag, hasRelayClient bool) func() (opts Libp2pOpts, err error)
• func MaybeAutoRelay(staticRelays []string, cfgPeering config.Peering, enabled bool) fx.Option
• func NetLimit(mgr network.ResourceManager, scope string) (rcmgr.BaseLimit, error)
• func OfflineRouting(dstore ds.Datastore, validator record.Validator) p2pRouterOut
• func PNet(repo repo.Repo) (opts Libp2pOpts, fp PNetFingerprint, err error)
• func PNetChecker(repo repo.Repo, ph host.Host, lc fx.Lifecycle) error
• func Peerstore(lc fx.Lifecycle) peerstore.Peerstore
• func PeerstoreDs(lc fx.Lifecycle, repo repo.Repo) peerstore.Peerstore
• func PstoreAddSelfKeys(id peer.ID, sk crypto.PrivKey, ps peerstore.Peerstore) error
• func PubsubRouter(mctx helpers.MetricsCtx, lc fx.Lifecycle, in p2pPSRoutingIn) (p2pRouterOut, *namesys.PubsubValueStore, error)
• func RelayService(enable bool, relayOpts config.RelayService) func() (opts Libp2pOpts, err error)
• func RelayTransport(enableRelay bool) func() (opts Libp2pOpts, err error)
• func ResourceManager(cfg config.SwarmConfig) interface{}
• func Routing(in p2pOnlineRoutingIn) irouting.ProvideManyRouter
• func Security(enabled bool, tptConfig config.Transports) interface{}
• func SetupDiscovery(mdns bool, mdnsInterval int) func(helpers.MetricsCtx, fx.Lifecycle, host.Host, *discoveryHandler) error
• func SmuxTransport(tptConfig config.Transports) func() (opts Libp2pOpts, err error)
• func StartListening(addresses []string) func(host host.Host) error
• func TopicDiscovery() interface{}
• func Transports(tptConfig config.Transports) interface{}
• type AddrInfoChan
• type HostOption
• type Libp2pOpts
  • func BandwidthCounter() (opts Libp2pOpts, reporter *metrics.BandwidthCounter)
  • func MultiaddrResolver(rslv *madns.Resolver) (opts Libp2pOpts, err error)
• type NetStatOut
  • func NetLimitAll(mgr network.ResourceManager) (*NetStatOut, error)
  • func NetStat(mgr network.ResourceManager, scope string, percentage int) (NetStatOut, error)
• type P2PHostIn
• type P2PHostOut
  • func Host(mctx helpers.MetricsCtx, lc fx.Lifecycle, params P2PHostIn) (out P2PHostOut, err error)
• type PNetFingerprint
• type Router
• type RoutingOption

Constants

const NetLimitDefaultFilename = "limit.json"

const NetLimitTraceFilename = "rcmgr.json.gz"

Variables

var (
	DHTOption       RoutingOption = constructDHTRouting(dht.ModeAuto)
	DHTClientOption               = constructDHTRouting(dht.ModeClient)
	DHTServerOption               = constructDHTRouting(dht.ModeServer)
	NilRouterOption               = constructNilRouting
)

var ErrNoResourceMgr = fmt.Errorf("missing ResourceMgr: make sure the daemon is running with Swarm.ResourceMgr.Enabled")

var NatPortMap = simpleOpt(libp2p.NATPortMap())

var UserAgent = simpleOpt(libp2p.UserAgent(version.UserAgent))

Functions

func AddrFilters

func AddrFilters(filters []string) func() (*ma.Filters, Libp2pOpts, error)

func AddrsFactory

func AddrsFactory(announce []string, noAnnounce []string) func() (opts Libp2pOpts, err error)

func AutoNATService

func AutoNATService(throttle *config.AutoNATThrottleConfig) func() Libp2pOpts

func BaseRouting

func BaseRouting(experimentalDHTClient bool) interface{}

func ConnectionManager

func ConnectionManager(low, high int, grace time.Duration) func() (opts Libp2pOpts, err error)

func ConstructDelegatedRouting

func ConstructDelegatedRouting(routers config.Routers, methods config.Methods, peerID string, addrs []string, privKey string) func(
	ctx context.Context,
	host host.Host,
	dstore datastore.Batching,
	validator record.Validator,
	bootstrapPeers ...peer.AddrInfo,
) (routing.Routing, error)

func ContentRouting

func ContentRouting(in p2pOnlineContentRoutingIn) routing.ContentRouting

ContentRouting will get all routers that can do contentRouting and add them all together using a TieredRouter. It will be used for topic discovery.

func DiscoveryHandler

func DiscoveryHandler(mctx helpers.MetricsCtx, lc fx.Lifecycle, host host.Host) *discoveryHandler

func FloodSub

func FloodSub(pubsubOptions ...pubsub.Option) interface{}

func ForceReachability

func ForceReachability(val *config.OptionalString) func() (opts Libp2pOpts, err error)

func GossipSub

func GossipSub(pubsubOptions ...pubsub.Option) interface{}

func HolePunching

func HolePunching(flag config.Flag, hasRelayClient bool) func() (opts Libp2pOpts, err error)

func MaybeAutoRelay

func MaybeAutoRelay(staticRelays []string, cfgPeering config.Peering, enabled bool) fx.Option

func NetLimit

func NetLimit(mgr network.ResourceManager, scope string) (rcmgr.BaseLimit, error)

func OfflineRouting

func OfflineRouting(dstore ds.Datastore, validator record.Validator) p2pRouterOut

OfflineRouting provides a special Router to the routers list when we are creating a offline node.

func PNet

func PNet(repo repo.Repo) (opts Libp2pOpts, fp PNetFingerprint, err error)

func PNetChecker

func PNetChecker(repo repo.Repo, ph host.Host, lc fx.Lifecycle) error

func Peerstore

func Peerstore(lc fx.Lifecycle) peerstore.Peerstore

func PeerstoreDs

func PeerstoreDs(lc fx.Lifecycle, repo repo.Repo) peerstore.Peerstore

func PstoreAddSelfKeys

func PstoreAddSelfKeys(id peer.ID, sk crypto.PrivKey, ps peerstore.Peerstore) error

func PubsubRouter

func PubsubRouter(mctx helpers.MetricsCtx, lc fx.Lifecycle, in p2pPSRoutingIn) (p2pRouterOut, *namesys.PubsubValueStore, error)

func RelayService

func RelayService(enable bool, relayOpts config.RelayService) func() (opts Libp2pOpts, err error)

func RelayTransport

func RelayTransport(enableRelay bool) func() (opts Libp2pOpts, err error)

func ResourceManager

func ResourceManager(cfg config.SwarmConfig) interface{}

func Routing

func Routing(in p2pOnlineRoutingIn) irouting.ProvideManyRouter

Routing will get all routers obtained from different methods (delegated routers, pub-sub, and so on) and add them all together using a TieredRouter.

func Security

func Security(enabled bool, tptConfig config.Transports) interface{}

func SetupDiscovery

func SetupDiscovery(mdns bool, mdnsInterval int) func(helpers.MetricsCtx, fx.Lifecycle, host.Host, *discoveryHandler) error

func SmuxTransport

func SmuxTransport(tptConfig config.Transports) func() (opts Libp2pOpts, err error)

func StartListening

func StartListening(addresses []string) func(host host.Host) error

func TopicDiscovery

func TopicDiscovery() interface{}

func Transports

func Transports(tptConfig config.Transports) interface{}

Types

type AddrInfoChan

type AddrInfoChan chan peer.AddrInfo

type HostOption

type HostOption func(id peer.ID, ps peerstore.Peerstore, options ...libp2p.Option) (host.Host, error)

var DefaultHostOption HostOption = constructPeerHost

type Libp2pOpts

type Libp2pOpts struct {
	fx.Out

	Opts []libp2p.Option `group:"libp2p"`
}

func BandwidthCounter

func BandwidthCounter() (opts Libp2pOpts, reporter *metrics.BandwidthCounter)

func MultiaddrResolver

func MultiaddrResolver(rslv *madns.Resolver) (opts Libp2pOpts, err error)

type NetStatOut

type NetStatOut struct {
	System    *rcmgr.BaseLimit           `json:",omitempty"`
	Transient *rcmgr.BaseLimit           `json:",omitempty"`
	Services  map[string]rcmgr.BaseLimit `json:",omitempty"`
	Protocols map[string]rcmgr.BaseLimit `json:",omitempty"`
	Peers     map[string]rcmgr.BaseLimit `json:",omitempty"`
}

func NetLimitAll

func NetLimitAll(mgr network.ResourceManager) (*NetStatOut, error)

func NetStat

func NetStat(mgr network.ResourceManager, scope string, percentage int) (NetStatOut, error)

type P2PHostIn

type P2PHostIn struct {
	fx.In

	Repo          repo.Repo
	Validator     record.Validator
	HostOption    HostOption
	RoutingOption RoutingOption
	ID            peer.ID
	Peerstore     peerstore.Peerstore

	Opts [][]libp2p.Option `group:"libp2p"`
}

type P2PHostOut

type P2PHostOut struct {
	fx.Out

	Host    host.Host
	Routing routing.Routing `name:"initialrouting"`
}

func Host

func Host(mctx helpers.MetricsCtx, lc fx.Lifecycle, params P2PHostIn) (out P2PHostOut, err error)

type PNetFingerprint

type PNetFingerprint []byte

type Router

type Router struct {
	routing.Routing

	Priority int // less = more important
}

type RoutingOption

type RoutingOption func(
	context.Context,
	host.Host,
	datastore.Batching,
	record.Validator,
	...peer.AddrInfo,
) (routing.Routing, error)