libp2p

README

LibP2PX ☄️

About · Goals · Differences From LibP2P · Repository Structure · License ·

About

status: work in progress, not recomended for use in production

libp2px is a complete fork of the libp2p stack, intended for use with TemporalX's enterprise IPFS node, buit suitable for people who need a [performance focused alternative to existing libp2p implementations. We will try to remain backwards compatable as much as possible with go-libp2p, and the rest of the network, but this is neither a design goal, nor an outright priority. This does not currently contain a version of go-libp2p-kad-dht so you'll need to BYOD, and use an existing implementation. For now we recommend using go-libp2p-kad-dht.

We have a fully fork version of libp2p/go-libp2p-core at RTradeLtd/libp2px-core, and a fully forked version of libp2p/go-openssl at RTradeLtd/libp2px-openssl.

Goals

• A more maintainable and approachable codebase
• Thoroughly tested code base
• Performance and efficiency
• Privacy as long as it doesn't compromise performance
  • To this end we have disabled the built-in identify, and ping service. Eventually these will be available as modules

Differences From LibP2P

• No default ping and identify service
• Complete removal of goprocess which at scale becomes a significant resource hog.
  • We replace this with idomatic, and stdlib friendly context usage
• Removal of go-log replaced with pure zap logging
• Transports have no logging as they were relying on gobally initialized loggers
  • With the current method of using transports, it's impossible to use logging there with non-global loggers, at some point in time this may be refactored and changed.
• All libp2p dependencies from the libp2p organization have been forked, and stored in this repository as a "mono repo"
  • The exceptions to this are the core, and openssl repos.

Compatability Issues

Confirmed

None

Suspected

secp256k1 issues

One possible compatability issue is with secp256k1 keys being incompatible between libp2px and go-libp2p. The reason being is that during the fork of libp2p/go-libp2p-core tests broke when using the pre-generated secp256k1 test data, and we needed to regenerate it to fix.

Needs Investigation

TestStBackpressureStreamWrite TestProtoDowngrade,TestHostProtoPreference, TestDefaultListenAddrs, TestNewDialOld Failures

Notice that in this commit the TravisCI builds passed. The important thing to take note of is that this commit uses the IPFS ci helper scripts. However if you notice in this commit when we switched to a different method of executing golang test tooling, we encounter build failures. I'm not yet sure why but this is repatable behavior. This needs investigation.

The names of all tests that fail when not using the ipfs ci helper script are listed in this markdown header. All but

Support

In terms of support for using this library from RTrade, we will be more than happy to address github issues for deficiencies in functionality that impact performance, but that is where the level of support will end. If you have issues with integrating this code, want explanations about the code, etc... that isn't publicly available please contact us privately.

Repository Structure

• pkg is where all the extra libp2p repositories are. For example things like go-libp2p-loggables, go-libp2p-buffer-pool, and all transports are here.
• p2p is equivalent

License

All original code is licensed under MIT+Apache, and we've included all the previous licenses. New code (aka, newly added transports, etc...) will be added with AGPLv3 licenses.

Documentation

Index

• Variables
• func New(ctx context.Context, logger *zap.Logger, opts ...Option) (host.Host, error)
• func NewWithoutDefaults(ctx context.Context, logger *zap.Logger, opts ...Option) (host.Host, error)
• type Config
• type Option
  • func AddrsFactory(factory config.AddrsFactory) Option
  • func BandwidthReporter(rep metrics.Reporter) Option
  • func ChainOptions(opts ...Option) Option
  • func ConnectionManager(connman connmgr.ConnManager) Option
  • func DefaultStaticRelays() Option
  • func DisableRelay() Option
  • func EnableAutoRelay() Option
  • func EnableRelay(options ...circuit.Opt) Option
  • func FilterAddresses(addrs ...*net.IPNet) Option
  • func Filters(filters *filter.Filters) Option
  • func Identity(sk crypto.PrivKey) Option
  • func ListenAddrStrings(s ...string) Option
  • func ListenAddrs(addrs ...ma.Multiaddr) Option
  • func Muxer(name string, tpt interface{}) Option
  • func NATManager(nm config.NATManagerC) Option
  • func NATPortMap() Option
  • func Peerstore(ps peerstore.Peerstore) Option
  • func Ping(enable bool) Option
  • func PrivateNetwork(prot pnet.Protector) Option
  • func Routing(rt config.RoutingC) Option
  • func Security(name string, tpt interface{}) Option
  • func StaticRelays(relays []peer.AddrInfo) Option
  • func Transport(tpt interface{}) Option
  • func UserAgent(userAgent string) Option

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 = Security(secio.ID, secio.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)

Functions

func New

func New(ctx context.Context, logger *zap.Logger, 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 secio encrypted transport to encrypt all traffic;

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

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

Canceling the passed context will stop the returned libp2p node.

func NewWithoutDefaults

func NewWithoutDefaults(ctx context.Context, logger *zap.Logger, 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.

Types

type Config

type Config = config.Config

Config describes a set of settings for a libp2p node

type Option

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

func AddrsFactory(factory config.AddrsFactory) Option

AddrsFactory configures libp2p to use the given address factory.

func BandwidthReporter

func BandwidthReporter(rep metrics.Reporter) Option

BandwidthReporter configures libp2p to use the given bandwidth reporter.

func ChainOptions

func ChainOptions(opts ...Option) Option

ChainOptions chains multiple options into a single option.

func ConnectionManager

func ConnectionManager(connman connmgr.ConnManager) Option

ConnectionManager configures libp2p to use the given connection manager.

func DefaultStaticRelays

func DefaultStaticRelays() Option

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

func DisableRelay

func DisableRelay() Option

DisableRelay configures libp2p to disable the relay transport.

func EnableAutoRelay

func EnableAutoRelay() Option

EnableAutoRelay configures libp2p to enable the AutoRelay subsystem. It is an error to enable AutoRelay without enabling relay (enabled by default) and routing (not enabled by default).

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 EnableRelay

func EnableRelay(options ...circuit.Opt) 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

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.

func Filters

func Filters(filters *filter.Filters) Option

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

func Identity

func Identity(sk crypto.PrivKey) Option

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

func ListenAddrStrings

func ListenAddrStrings(s ...string) Option

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

func ListenAddrs

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

ListenAddrs configures libp2p to listen on the given addresses.

func Muxer

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

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

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

func Peerstore(ps peerstore.Peerstore) Option

Peerstore configures libp2p to use the given peerstore.

func Ping

func Ping(enable bool) Option

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

func PrivateNetwork

func PrivateNetwork(prot pnet.Protector) Option

PrivateNetwork configures libp2p to use the given private network protector.

func Routing

func Routing(rt config.RoutingC) Option

Routing will configure libp2p to use routing.

func Security

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

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

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

func UserAgent(userAgent string) Option

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