lp2p

Documentation

Index

• Constants
• Variables
• func AddrsFactory(announce []string, noAnnounce []string) func() (opts Libp2pOpts, err error)
• func BaseRouting(lc fx.Lifecycle, in BaseIpfsRouting) (out p2pRouterOut, dr *dht.IpfsDHT)
• func ConnGater(ds dtypes.MetadataDS) (*conngater.BasicConnectionGater, error)
• func ConnectionManager(low, high uint, grace time.Duration, protected []string) func() (opts Libp2pOpts, err error)
• func DHTRouting(mode dht.ModeOpt) interface{}
• func Discovery(router BaseIpfsRouting) (coredisc.Discovery, error)
• func DiscoveryHandler(mctx helpers.MetricsCtx, lc fx.Lifecycle, host host.Host) *discoveryHandler
• func GossipSub(in GossipIn) (service *pubsub.PubSub, err error)
• func HashMsgId(m *pubsub_pb.Message) string
• func MakeAddrsFactory(announce []string, noAnnounce []string) (p2pbhost.AddrsFactory, error)
• func NoRelay() func() (opts Libp2pOpts, err error)
• func Peerstore() (peerstore.Peerstore, error)
• func PrivKey(ks types.KeyStore) (crypto.PrivKey, error)
• func PstoreAddSelfKeys(id peer.ID, sk crypto.PrivKey, ps peerstore.Peerstore) error
• func ResourceManager(connMgrHi uint) ...
• func RoutedHost(rh RawHost, r BaseIpfsRouting) host.Host
• func Routing(in p2pOnlineRoutingIn) routing.Routing
• func ScoreKeeper() *dtypes.ScoreKeeper
• func Security(enabled, preferTLS bool) interface{}
• func SmuxTransport() func() (opts Libp2pOpts, err error)
• func StartListening(addresses []string) func(host host.Host) error
• func UserAgentOption(agent string) func() (opts Libp2pOpts, err error)
• type BaseIpfsRouting
  • func NilRouting(mctx helpers.MetricsCtx) (BaseIpfsRouting, error)
• type GossipIn
• type Libp2pOpts
  • func BandwidthCounter() (opts Libp2pOpts, reporter metrics.Reporter)
  • func ConnGaterOption(cg *conngater.BasicConnectionGater) (opts Libp2pOpts, err error)
  • func ResourceManagerOption(mgr network.ResourceManager) Libp2pOpts
• type P2PHostIn
• type PeerScoreTracker
• type RawHost
  • func Host(mctx helpers.MetricsCtx, buildVersion build.BuildVersion, lc fx.Lifecycle, ...) (RawHost, error)
  • func MockHost(mn mocknet.Mocknet, id peer.ID, ps peerstore.Peerstore) (RawHost, error)
• type Router

Constants

const (
	KLibp2pHost                = "libp2p-host"
	KTLibp2pHost types.KeyType = KLibp2pHost
)

const (
	GossipScoreThreshold             = -500
	PublishScoreThreshold            = -1000
	GraylistScoreThreshold           = -2500
	AcceptPXScoreThreshold           = 1000
	OpportunisticGraftScoreThreshold = 3.5

	// Determines the max. number of configuration changes
	// that are allowed for the dynamic manifest.
	// If the manifest changes more than this number, the F3
	// message topic will be filtered
	MaxDynamicManifestChangesAllowed = 1000
)

Variables

var AutoNATService = simpleOpt(libp2p.EnableNATService())

var DefaultTransports = simpleOpt(libp2p.DefaultTransports)

var NatPortMap = simpleOpt(libp2p.NATPortMap())

var QUIC = simpleOpt(libp2p.Transport(libp2pquic.NewTransport))

Functions

func AddrsFactory

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

func BaseRouting

func BaseRouting(lc fx.Lifecycle, in BaseIpfsRouting) (out p2pRouterOut, dr *dht.IpfsDHT)

func ConnGater

func ConnGater(ds dtypes.MetadataDS) (*conngater.BasicConnectionGater, error)

func ConnectionManager

func ConnectionManager(low, high uint, grace time.Duration, protected []string) func() (opts Libp2pOpts, err error)

func DHTRouting

func DHTRouting(mode dht.ModeOpt) interface{}

func Discovery

func Discovery(router BaseIpfsRouting) (coredisc.Discovery, error)

TODO: should be use baseRouting or can we use higher level router here?

func DiscoveryHandler

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

func GossipSub

func GossipSub(in GossipIn) (service *pubsub.PubSub, err error)

func HashMsgId

func HashMsgId(m *pubsub_pb.Message) string

func MakeAddrsFactory

func MakeAddrsFactory(announce []string, noAnnounce []string) (p2pbhost.AddrsFactory, error)

func NoRelay

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

func Peerstore

func Peerstore() (peerstore.Peerstore, error)

func PrivKey

func PrivKey(ks types.KeyStore) (crypto.PrivKey, error)

func PstoreAddSelfKeys

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

func ResourceManager

func ResourceManager(connMgrHi uint) func(lc fx.Lifecycle, repo repo.LockedRepo, bs dtypes.BootstrapPeers) (network.ResourceManager, error)

func RoutedHost

func RoutedHost(rh RawHost, r BaseIpfsRouting) host.Host

func Routing

func Routing(in p2pOnlineRoutingIn) routing.Routing

func ScoreKeeper

func ScoreKeeper() *dtypes.ScoreKeeper

func Security

func Security(enabled, preferTLS bool) interface{}

func SmuxTransport

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

func StartListening

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

func UserAgentOption

func UserAgentOption(agent string) func() (opts Libp2pOpts, err error)

Types

type BaseIpfsRouting

type BaseIpfsRouting routing.Routing

func NilRouting

func NilRouting(mctx helpers.MetricsCtx) (BaseIpfsRouting, error)

type GossipIn

type GossipIn struct {
	fx.In
	Mctx helpers.MetricsCtx
	Lc   fx.Lifecycle
	Host host.Host
	Nn   dtypes.NetworkName
	Bp   dtypes.BootstrapPeers
	Db   dtypes.DrandBootstrap
	Cfg  *config.Pubsub
	Sk   *dtypes.ScoreKeeper
	Dr   dtypes.DrandSchedule
}

type Libp2pOpts

type Libp2pOpts struct {
	fx.Out

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

func BandwidthCounter

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

func ConnGaterOption

func ConnGaterOption(cg *conngater.BasicConnectionGater) (opts Libp2pOpts, err error)

func ResourceManagerOption

func ResourceManagerOption(mgr network.ResourceManager) Libp2pOpts

type P2PHostIn

type P2PHostIn struct {
	fx.In

	ID        peer.ID
	Peerstore peerstore.Peerstore

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

type PeerScoreTracker

type PeerScoreTracker interface {
	UpdatePeerScore(scores map[peer.ID]*pubsub.PeerScoreSnapshot)
}

type RawHost

type RawHost host.Host

func Host

func Host(mctx helpers.MetricsCtx, buildVersion build.BuildVersion, lc fx.Lifecycle, params P2PHostIn) (RawHost, error)

func MockHost

func MockHost(mn mocknet.Mocknet, id peer.ID, ps peerstore.Peerstore) (RawHost, error)

type Router

type Router struct {
	routing.Routing

	Priority int // less = more important
}