config

Documentation

Index

• type Config
  • func (cfg *Config) Apply(opts ...Option) error
  • func (cfg *Config) NewNode(privatekeyPath string) (core.P2P, error)
• type Option

Types

type Config

type Config struct {
	Workspace   string
	ListenAddrs ma.Multiaddr
	ConnManager connmgr.ConnManager
	BootPeers   []string
}

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 (*Config) Apply

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

Apply applies the given options to the config, returning the first error encountered (if any).

func (*Config) NewNode

func (cfg *Config) NewNode(privatekeyPath string) (core.P2P, error)

NewNode constructs a new libp2p Host from the Config.

This function consumes the config. Do not reuse it (really!).

type Option

type Option func(cfg *Config) error

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