libp2p

Documentation

Index

• Variables
• func AddrFilters(filters []string) func() (*ma.Filters, Libp2pOpts, error)
• func AddrsFactory(announce []string, appendAnnouce []string, noAnnounce []string) func() (opts Libp2pOpts, err error)
• func AutoNATService(throttle *config.AutoNATThrottleConfig) func() Libp2pOpts
• func AutoRelay(addDefaultRelays bool) func() (opts Libp2pOpts, err error)
• func BaseRouting(experimentalDHTClient bool) interface{}
• func ConnectionManager(low, high int, grace time.Duration) func() (opts Libp2pOpts, err error)
• 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 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, error)
• 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 Routing(in p2pOnlineRoutingIn) routing.Routing
• func Security(enabled bool, tptConfig config.Transports) interface{}
• func SetupDiscovery(useMdns 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 StaticRelays(relays []string) func() (opts Libp2pOpts, err error)
• func TopicDiscovery() interface{}
• func Transports(tptConfig config.Transports) interface{}
• type BaseIpfsRouting
• type HostOption
• type Libp2pOpts
  • func BandwidthCounter() (opts Libp2pOpts, reporter *metrics.BandwidthCounter)
  • func MultiaddrResolver(rslv *madns.Resolver) (opts Libp2pOpts, err 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

Variables

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

var NatPortMap = simpleOpt(libp2p.NATPortMap())

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

Misc options

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 AutoRelay

func AutoRelay(addDefaultRelays bool) func() (opts Libp2pOpts, err error)

func BaseRouting

func BaseRouting(experimentalDHTClient bool) interface{}

func ConnectionManager

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

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 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 Routing

func Routing(in p2pOnlineRoutingIn) routing.Routing

func Security

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

func SetupDiscovery

func SetupDiscovery(useMdns 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 StaticRelays

func StaticRelays(relays []string) func() (opts Libp2pOpts, err error)

func TopicDiscovery

func TopicDiscovery() interface{}

func Transports

func Transports(tptConfig config.Transports) interface{}

Types

type BaseIpfsRouting

type BaseIpfsRouting routing.Routing

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