go-libp2p: github.com/libp2p/go-libp2p Index | Files | Directories

package libp2p

import "github.com/libp2p/go-libp2p"

Index

Package Files

defaults.go error_util.go libp2p.go options.go options_filter.go

Variables

❖
var DefaultEnableRelay = func(cfg *Config) error {
    return cfg.Apply(EnableRelay())
}

DefaultEnableRelay enables relay dialing and listening by default.

❖
var DefaultListenAddrs = func(cfg *Config) error {
    defaultIP4ListenAddr, err := multiaddr.NewMultiaddr("/ip4/0.0.0.0/tcp/0")
    if err != nil {
        return err
    }

    defaultIP6ListenAddr, err := multiaddr.NewMultiaddr("/ip6/::/tcp/0")
    if err != nil {
        return err
    }
    return cfg.Apply(ListenAddrs(
        defaultIP4ListenAddr,
        defaultIP6ListenAddr,
    ))
}

DefaultListenAddrs configures libp2p to use default listen address.

❖
var DefaultMuxers = ChainOptions(
    Muxer("/yamux/1.0.0", yamux.DefaultTransport),
    Muxer("/mplex/6.7.0", mplex.DefaultTransport),
)

DefaultMuxers configures libp2p to use the stream connection multiplexers.

Use this option when you want to *extend* the set of multiplexers used by libp2p instead of replacing them.

❖
var DefaultSecurity = ChainOptions(
    Security(noise.ID, noise.New),
    Security(tls.ID, tls.New),
)

DefaultSecurity is the default security option.

Useful when you want to extend, but not replace, the supported transport security protocols.

❖
var DefaultTransports = ChainOptions(
    Transport(tcp.NewTCPTransport),
    Transport(ws.New),
)

DefaultTransports are the default libp2p transports.

Use this option when you want to *extend* the set of transports used by libp2p instead of replacing them.

❖
var NoListenAddrs = func(cfg *Config) error {
    cfg.ListenAddrs = []ma.Multiaddr{}
    if !cfg.RelayCustom {
        cfg.RelayCustom = true
        cfg.Relay = false
    }
    return nil
}

NoListenAddrs will configure libp2p to not listen by default.

This will both clear any configured listen addrs and prevent libp2p from applying the default listen address option. It also disables relay, unless the user explicitly specifies with an option, as the transport creates an implicit listen address that would make the node dialable through any relay it was connected to.

❖
var NoTransports = func(cfg *Config) error {
    cfg.Transports = []config.TptC{}
    return nil
}

NoTransports will configure libp2p to not enable any transports.

This will both clear any configured transports (specified in prior libp2p options) and prevent libp2p from applying the default transports.

❖
var RandomIdentity = func(cfg *Config) error {
    priv, _, err := crypto.GenerateKeyPairWithReader(crypto.RSA, 2048, rand.Reader)
    if err != nil {
        return err
    }
    return cfg.Apply(Identity(priv))
}

RandomIdentity generates a random identity. (default behaviour)

func New Uses

❖
func New(ctx context.Context, opts ...Option) (host.Host, error)

New constructs a new libp2p node with the given options, falling back on reasonable defaults. The defaults are:

- If no transport and listen addresses are provided, the node listens to the multiaddresses "/ip4/0.0.0.0/tcp/0" and "/ip6/::/tcp/0";

- If no transport options are provided, the node uses TCP and websocket transport protocols;

- If no multiplexer configuration is provided, the node is configured by default to use the "yamux/1.0.0" and "mplux/6.7.0" stream connection multiplexers;

- If no security transport is provided, the host uses the go-libp2p's noise and/or tls encrypted transport to encrypt all traffic;

- If no peer identity is provided, it generates a random RSA 2048 key-pair and derives a new identity from it;

- If no peerstore is provided, the host is initialized with an empty peerstore.

To stop/shutdown the returned libp2p node, the user needs to cancel the passed context and call `Close` on the returned Host.

func NewWithoutDefaults Uses

❖
func NewWithoutDefaults(ctx context.Context, opts ...Option) (host.Host, error)

NewWithoutDefaults constructs a new libp2p node with the given options but *without* falling back on reasonable defaults.

Warning: This function should not be considered a stable interface. We may choose to add required services at any time and, by using this function, you opt-out of any defaults we may provide.

type Config Uses

❖
type Config = config.Config

Config describes a set of settings for a libp2p node.

type Option Uses

❖
type Option = config.Option

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

❖
var DefaultPeerstore Option = func(cfg *Config) error {
    return cfg.Apply(Peerstore(pstoremem.NewPeerstore()))
}

DefaultPeerstore configures libp2p to use the default peerstore.

❖
var Defaults Option = func(cfg *Config) error {
    for _, def := range defaults {
        if err := cfg.Apply(def.opt); err != nil {
            return err
        }
    }
    return nil
}

Defaults configures libp2p to use the default options. Can be combined with other options to *extend* the default options.

❖
var FallbackDefaults Option = func(cfg *Config) error {
    for _, def := range defaults {
        if !def.fallback(cfg) {
            continue
        }
        if err := cfg.Apply(def.opt); err != nil {
            return err
        }
    }
    return nil
}

FallbackDefaults applies default options to the libp2p node if and only if no other relevant options have been applied. will be appended to the options passed into New.

❖
var NoSecurity Option = func(cfg *Config) error {
    if len(cfg.SecurityTransports) > 0 {
        return fmt.Errorf("cannot use security transports with an insecure libp2p configuration")
    }
    cfg.Insecure = true
    return nil
}

NoSecurity is an option that completely disables all transport security. It's incompatible with all other transport security protocols.

func AddrsFactory Uses

❖
func AddrsFactory(factory config.AddrsFactory) Option

AddrsFactory configures libp2p to use the given address factory.

func AutoNATServiceRateLimit Uses

❖
func AutoNATServiceRateLimit(global, perPeer int, interval time.Duration) Option

AutoNATServiceRateLimit changes the default rate limiting configured in helping other peers determine their reachability status. When set, the host will limit the number of requests it responds to in each 60 second period to the set numbers. A value of '0' disables throttling.

func BandwidthReporter Uses

❖
func BandwidthReporter(rep metrics.Reporter) Option

BandwidthReporter configures libp2p to use the given bandwidth reporter.

func ChainOptions Uses

❖
func ChainOptions(opts ...Option) Option

ChainOptions chains multiple options into a single option.

func ConnectionGater Uses

❖
func ConnectionGater(cg connmgr.ConnectionGater) Option

ConnectionGater configures libp2p to use the given ConnectionGater to actively reject inbound/outbound connections based on the lifecycle stage of the connection.

For more information, refer to go-libp2p-core.ConnectionGater.

func ConnectionManager Uses

❖
func ConnectionManager(connman connmgr.ConnManager) Option

ConnectionManager configures libp2p to use the given connection manager.

func DefaultStaticRelays Uses

❖
func DefaultStaticRelays() Option

DefaultStaticRelays configures the static relays to use the known PL-operated relays.

func DisableRelay Uses

❖
func DisableRelay() Option

DisableRelay configures libp2p to disable the relay transport.

func EnableAutoRelay Uses

❖
func EnableAutoRelay() Option

EnableAutoRelay configures libp2p to enable the AutoRelay subsystem.

Dependencies: 

* Relay (enabled by default)
* Routing (to find relays), or StaticRelays/DefaultStaticRelays.

This subsystem performs two functions:

1. When this libp2p node is configured to act as a relay "hop" 

(circuit.OptHop is passed to EnableRelay), this node will advertise itself
as a public relay using the provided routing system.

2. When this libp2p node is _not_ configured as a relay "hop", it will 

automatically detect if it is unreachable (e.g., behind a NAT). If so, it will
find, configure, and announce a set of public relays.

func EnableNATService Uses

❖
func EnableNATService() Option

EnableNATService configures libp2p to provide a service to peers for determining their reachability status. When enabled, the host will attempt to dial back to peers, and then tell them if it was successful in making such connections.

func EnableRelay Uses

❖
func EnableRelay(options ...circuit.RelayOpt) Option

EnableRelay configures libp2p to enable the relay transport with configuration options. By default, this option only configures libp2p to accept inbound connections from relays and make outbound connections _through_ relays when requested by the remote peer. (default: enabled)

To _act_ as a relay, pass the circuit.OptHop option.

func FilterAddresses Uses

❖
func FilterAddresses(addrs ...*net.IPNet) Option

FilterAddresses configures libp2p to never dial nor accept connections from the given addresses. FilterAddresses should be used for cases where the addresses you want to deny are known ahead of time.

Note: Using Filter + FilterAddresses at the same time is fine, but you cannot configure a both ConnectionGater and filtered addresses.

Deprecated: Please use ConnectionGater() instead.

func Filters Uses

❖
func Filters(filters *ma.Filters) Option

Filters configures libp2p to use the given filters for accepting/denying certain addresses. Filters offers more control and should be used when the addresses you want to accept/deny are not known ahead of time and can dynamically change.

Note: You cannot configure both a ConnectionGater and a Filter at the same time. Under the hood, the Filters object is converted to a ConnectionGater.

Deprecated: use ConnectionGater() instead.

func ForceReachabilityPrivate Uses

❖
func ForceReachabilityPrivate() Option

ForceReachabilityPrivate overrides automatic reachability detection in the AutoNAT subsystem, forceing the local node to believe it is behind a NAT and not reachable externally.

func ForceReachabilityPublic Uses

❖
func ForceReachabilityPublic() Option

ForceReachabilityPublic overrides automatic reachability detection in the AutoNAT subsystem, forcing the local node to believe it is reachable externally.

func Identity Uses

❖
func Identity(sk crypto.PrivKey) Option

Identity configures libp2p to use the given private key to identify itself.

func ListenAddrStrings Uses

❖
func ListenAddrStrings(s ...string) Option

ListenAddrStrings configures libp2p to listen on the given (unparsed) addresses.

func ListenAddrs Uses

❖
func ListenAddrs(addrs ...ma.Multiaddr) Option

ListenAddrs configures libp2p to listen on the given addresses.

func Muxer Uses

❖
func Muxer(name string, tpt interface{}) Option

Muxer configures libp2p to use the given stream multiplexer (or stream multiplexer constructor).

Name is the protocol name.

The transport can be a constructed mux.Transport or a function taking any subset of this libp2p node's: * Peer ID * Host * Network * Peerstore

func NATManager Uses

❖
func NATManager(nm config.NATManagerC) Option

NATManager will configure libp2p to use the requested NATManager. This function should be passed a NATManager *constructor* that takes a libp2p Network.

func NATPortMap Uses

❖
func NATPortMap() Option

NATPortMap configures libp2p to use the default NATManager. The default NATManager will attempt to open a port in your network's firewall using UPnP.

func Peerstore Uses

❖
func Peerstore(ps peerstore.Peerstore) Option

Peerstore configures libp2p to use the given peerstore.

func Ping Uses

❖
func Ping(enable bool) Option

Ping will configure libp2p to support the ping service; enable by default.

func PrivateNetwork Uses

❖
func PrivateNetwork(psk pnet.PSK) Option

PrivateNetwork configures libp2p to use the given private network protector.

func Routing Uses

❖
func Routing(rt config.RoutingC) Option

Routing will configure libp2p to use routing.

func Security Uses

❖
func Security(name string, tpt interface{}) Option

Security configures libp2p to use the given security transport (or transport constructor).

Name is the protocol name.

The transport can be a constructed security.Transport or a function taking any subset of this libp2p node's: * Public key * Private key * Peer ID * Host * Network * Peerstore

func StaticRelays Uses

❖
func StaticRelays(relays []peer.AddrInfo) Option

StaticRelays configures known relays for autorelay; when this option is enabled then the system will use the configured relays instead of querying the DHT to discover relays.

func Transport Uses

❖
func Transport(tpt interface{}) Option

Transport configures libp2p to use the given transport (or transport constructor).

The transport can be a constructed transport.Transport or a function taking any subset of this libp2p node's: * Transport Upgrader (*tptu.Upgrader) * Host * Stream muxer (muxer.Transport) * Security transport (security.Transport) * Private network protector (pnet.Protector) * Peer ID * Private Key * Public Key * Address filter (filter.Filter) * Peerstore

func UserAgent Uses

❖
func UserAgent(userAgent string) Option

UserAgent sets the libp2p user-agent sent along with the identify protocol

Directories

PathSynopsis
config
p2p/discovery
p2p/host/basic
p2p/host/relayThe relay package contains the components necessary to implement the "autorelay" feature.
p2p/host/routed
p2p/net/conngater
p2p/net/mockPackage mocknet provides a mock net.Network to test with.
p2p/protocol/identify
p2p/protocol/identify/pb
p2p/protocol/ping
p2p/test/backpressure
p2p/test/reconnectsPackage reconnect tests connect -> disconnect -> reconnect works

Package libp2p imports 28 packages (graph) and is imported by 189 packages. Updated 2021-01-19. Refresh now. Tools for package owners.