config

type AddrsFactory ¶

type AddrsFactory = bhost.AddrsFactory

AddrsFactory is a function that takes a set of multiaddrs we're listening on and returns the set of multiaddrs we should advertise to the network.

type AutoNATConfig ¶ added in v0.8.0

type AutoNATConfig struct {
	ForceReachability   *network.Reachability
	EnableService       bool
	ThrottleGlobalLimit int
	ThrottlePeerLimit   int
	ThrottleInterval    time.Duration
}

AutoNATConfig defines the AutoNAT behavior for the libp2p host.

type Config ¶

type Config struct {
	// UserAgent is the identifier this node will send to other peers when
	// identifying itself, e.g. via the identify protocol.
	//
	// Set it via the UserAgent option function.
	UserAgent string

	PeerKey crypto.PrivKey

	Transports         []TptC
	Muxers             []MsMuxC
	SecurityTransports []MsSecC
	Insecure           bool
	PSK                pnet.PSK

	DialTimeout time.Duration

	RelayCustom bool
	Relay       bool // should the relay transport be used

	EnableRelayService bool // should we run a circuitv2 relay (if publicly reachable)
	RelayServiceOpts   []relayv2.Option

	ListenAddrs     []ma.Multiaddr
	AddrsFactory    bhost.AddrsFactory
	ConnectionGater connmgr.ConnectionGater

	ConnManager     connmgr.ConnManager
	ResourceManager network.ResourceManager

	NATManager NATManagerC
	Peerstore  peerstore.Peerstore
	Reporter   metrics.Reporter

	MultiaddrResolver *madns.Resolver

	DisablePing bool

	Routing RoutingC

	EnableAutoRelay bool
	AutoNATConfig
	StaticRelayOpt autorelay.StaticRelayOption

	EnableHolePunching  bool
	HolePunchingOptions []holepunch.Option
}

Config describes a set of settings for a libp2p node

This is *not* a stable interface. Use the options defined in the root package.

func (cfg *Config) Apply(opts ...Option) error

func (cfg *Config) NewNode() (host.Host, error)

type MsMuxC ¶

type MsMuxC struct {
	MuxC
	ID string
}

MsMuxC is a tuple containing a multiplex transport constructor and a protocol ID.

type MsSecC ¶

type MsSecC struct {
	SecC
	ID string
}

MsSecC is a tuple containing a security transport constructor and a protocol ID.

type MuxC ¶

type MuxC func(h host.Host) (network.Multiplexer, error)

MuxC is a stream multiplex transport constructor.

func MuxerConstructor(m interface{}) (MuxC, error)

type NATManagerC ¶

type NATManagerC func(network.Network) bhost.NATManager

NATManagerC is a NATManager constructor.

type Option ¶

type Option func(cfg *Config) error

Option is a libp2p config option that can be given to the libp2p constructor (`libp2p.New`).

type RoutingC ¶

type RoutingC func(host.Host) (routing.PeerRouting, error)

type SecC ¶

type SecC func(h host.Host) (sec.SecureTransport, error)

SecC is a security transport constructor.

func SecurityConstructor(security interface{}) (SecC, error)

type TptC ¶

type TptC func(host.Host, transport.Upgrader, pnet.PSK, connmgr.ConnectionGater, network.ResourceManager) (transport.Transport, error)

TptC is the type for libp2p transport constructors. You probably won't ever implement this function interface directly. Instead, pass your transport constructor to TransportConstructor.

func TransportConstructor(tpt interface{}, opts ...interface{}) (TptC, error)