libp2p

package
v0.18.0-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 13, 2022 License: Apache-2.0, MIT, Apache-2.0, + 1 more Imports: 75 Imported by: 41

Documentation

Index

Constants

View Source 
const NetLimitDefaultFilename = "limit.json"
View Source 
const NetLimitTraceFilename = "rcmgr.json.gz"

Variables

View Source 
var (
	DHTOption       RoutingOption = constructDHTRouting(dht.ModeAuto)
	DHTClientOption               = constructDHTRouting(dht.ModeClient)
	DHTServerOption               = constructDHTRouting(dht.ModeServer)
	NilRouterOption               = constructNilRouting
)
View Source 
var ErrNoResourceMgr = fmt.Errorf("missing ResourceMgr: make sure the daemon is running with Swarm.ResourceMgr.Enabled")
View Source 
var NatPortMap = simpleOpt(libp2p.NATPortMap())

Functions

func AddrFilters 

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

func AddrsFactory 

func AddrsFactory(announce []string, appendAnnouce []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 ConstructDefaultRouting added in v0.18.0 

func ConstructDefaultRouting(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)

ConstructDefaultRouting returns routers used when Routing.Type is unset or set to "auto"

func ConstructDelegatedRouting added in v0.16.0 

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)

ConstructDelegatedRouting is used when Routing.Type = "custom"

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 added in v0.16.0 

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

func NetLimit 

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

func NetResetLimit added in v0.17.0 

func NetResetLimit(mgr network.ResourceManager, repo repo.Repo, scope string) (rcmgr.BaseLimit, error)

NetResetLimit resets ResourceManager limits to defaults. The limits take effect immediately, and are also persisted to the repo config.

func NetSetLimit 

func NetSetLimit(mgr network.ResourceManager, repo repo.Repo, scope string, limit rcmgr.BaseLimit) error

NetSetLimit sets new ResourceManager limits for the given scope. The limits take effect immediately, and are also persisted to the repo config.

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, error)

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(useMdns bool) 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{}

func UserAgent 

func UserAgent() func() (opts Libp2pOpts, err error)

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 added in v0.17.0 

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)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.