dep2p

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 19, 2023 License: MIT Imports: 42 Imported by: 11

README

DeP2P

Go Reference Go

DeP2P(Decentralized peer-to-peer) 去中心化对等网络,是用 Go(golang)编写的一种 P2P 对等网络的便捷实现。

该项目目前正在积极开发中,处于 Alpha 状态。

这是一个完全独立的版本,将在底层架构进行更深层的内聚,更好的满足 web3.0 对于去中心化网络基础设施的需求。

文档

该文档正在编写中……

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DefaultConnectionManager = func(cfg *Config) error {
	mgr, err := connmgr.NewConnManager(160, 192)
	if err != nil {
		return err
	}

	return cfg.Apply(ConnectionManager(mgr))
}

DefaultConnectionManager creates a default connection manager

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

DefaultEnableRelay enables relay dialing and listening by default.

View Source
var DefaultListenAddrs = func(cfg *Config) error {
	addrs := []string{
		"/ip4/0.0.0.0/tcp/0",
		"/ip4/0.0.0.0/udp/0/quic-v1",
		"/ip4/0.0.0.0/udp/0/quic-v1/webtransport",
		"/ip6/::/tcp/0",
		"/ip6/::/udp/0/quic-v1",
		"/ip6/::/udp/0/quic-v1/webtransport",
	}
	listenAddrs := make([]multiaddr.Multiaddr, 0, len(addrs))
	for _, s := range addrs {
		addr, err := multiaddr.NewMultiaddr(s)
		if err != nil {
			return err
		}
		listenAddrs = append(listenAddrs, addr)
	}
	return cfg.Apply(ListenAddrs(listenAddrs...))
}

DefaultListenAddrs configures dep2p to use default listen address.

View Source
var DefaultMultiaddrResolver = func(cfg *Config) error {
	return cfg.Apply(MultiaddrResolver(madns.DefaultResolver))
}

DefaultMultiaddrResolver creates a default connection manager

DefaultMuxers configures dep2p to use the stream connection multiplexers.

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

View Source
var DefaultPrivateTransports = ChainOptions(
	Transport(tcp.NewTCPTransport),
	Transport(ws.New),
)

DefaultPrivateTransports are the default dep2p transports when a PSK is supplied.

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

View Source
var DefaultPrometheusRegisterer = func(cfg *Config) error {
	return cfg.Apply(PrometheusRegisterer(prometheus.DefaultRegisterer))
}

DefaultPrometheusRegisterer configures dep2p to use the default registerer

View Source
var DefaultResourceManager = func(cfg *Config) error {

	limits := rcmgr.DefaultLimits
	SetDefaultServiceLimits(&limits)
	mgr, err := rcmgr.NewResourceManager(rcmgr.NewFixedLimiter(limits.AutoScale()))
	if err != nil {
		return err
	}

	return cfg.Apply(ResourceManager(mgr))
}
View Source
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.

DefaultTransports are the default dep2p transports.

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

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

NoListenAddrs will configure dep2p to not listen by default.

This will both clear any configured listen addrs and prevent dep2p 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.

View Source
var NoTransports = func(cfg *Config) error {
	cfg.Transports = []fx.Option{}
	return nil
}

NoTransports will configure dep2p to not enable any transports.

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

View Source
var RandomIdentity = func(cfg *Config) error {
	priv, _, err := crypto.GenerateEd25519Key(rand.Reader)
	if err != nil {
		return err
	}
	return cfg.Apply(Identity(priv))
}

RandomIdentity generates a random identity. (default behaviour)

Functions

func New

func New(opts ...Option) (host.Host, error)

New constructs a new dep2p 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, websocket and QUIC transport protocols;

- If no multiplexer configuration is provided, the node is configured by default to use yamux;

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

- If no peer identity is provided, it generates a random Ed25519 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 dep2p node, the user needs to cancel the passed context and call `Close` on the returned Host.

func NewWithoutDefaults added in v0.1.0

func NewWithoutDefaults(opts ...Option) (host.Host, error)

NewWithoutDefaults constructs a new dep2p 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.

func SetDefaultServiceLimits added in v0.1.0

func SetDefaultServiceLimits(config *rcmgr.ScalingLimitConfig)

SetDefaultServiceLimits sets the default limits for bundled dep2p services

Types

type Config added in v0.1.0

type Config = config.Config

Config describes a set of settings for a dep2p node.

type Option

type Option = config.Option

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

var DefaultPeerstore Option = func(cfg *Config) error {
	ps, err := pstoremem.NewPeerstore()
	if err != nil {
		return err
	}
	return cfg.Apply(Peerstore(ps))
}

DefaultPeerstore configures dep2p 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 dep2p 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 dep2p 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 dep2p 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 added in v0.1.0

func AddrsFactory(factory config.AddrsFactory) Option

AddrsFactory configures dep2p to use the given address factory.

func AutoNATServiceRateLimit added in v0.1.0

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 added in v0.1.0

func BandwidthReporter(rep metrics.Reporter) Option

BandwidthReporter configures dep2p to use the given bandwidth reporter.

func ChainOptions added in v0.1.0

func ChainOptions(opts ...Option) Option

ChainOptions chains multiple options into a single option.

func ConnectionGater added in v0.1.0

func ConnectionGater(cg connmgr.ConnectionGater) Option

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

For more information, refer to dep2p/core.ConnectionGater.

func ConnectionManager added in v0.1.0

func ConnectionManager(connman connmgr.ConnManager) Option

ConnectionManager configures dep2p to use the given connection manager.

func DialRanker deprecated added in v0.1.0

func DialRanker(d network.DialRanker) Option

DialRanker configures dep2p to use d as the dial ranker. To enable smart dialing use `swarm.DefaultDialRanker`. use `swarm.NoDelayDialRanker` to disable smart dialing.

Deprecated: use SwarmOpts(swarm.WithDialRanker(d)) instead

func DisableMetrics added in v0.1.0

func DisableMetrics() Option

DisableMetrics configures dep2p to disable prometheus metrics

func DisableRelay added in v0.1.0

func DisableRelay() Option

DisableRelay configures dep2p to disable the relay transport.

func EnableAutoRelay deprecated added in v0.1.0

func EnableAutoRelay(opts ...autorelay.Option) Option

EnableAutoRelay configures dep2p to enable the AutoRelay subsystem.

Dependencies:

  • Relay (enabled by default)
  • Either: 1. A list of static relays 2. A PeerSource function that provides a chan of relays. See `autorelay.WithPeerSource`

This subsystem performs automatic address rewriting to advertise relay addresses when it detects that the node is publicly unreachable (e.g. behind a NAT).

Deprecated: Use EnableAutoRelayWithStaticRelays or EnableAutoRelayWithPeerSource

func EnableAutoRelayWithPeerSource added in v0.1.0

func EnableAutoRelayWithPeerSource(peerSource autorelay.PeerSource, opts ...autorelay.Option) Option

EnableAutoRelayWithPeerSource configures dep2p to enable the AutoRelay subsystem using the provided PeerSource callback to get more relay candidates. This subsystem performs automatic address rewriting to advertise relay addresses when it detects that the node is publicly unreachable (e.g. behind a NAT).

func EnableAutoRelayWithStaticRelays added in v0.1.0

func EnableAutoRelayWithStaticRelays(static []peer.AddrInfo, opts ...autorelay.Option) Option

EnableAutoRelayWithStaticRelays configures dep2p to enable the AutoRelay subsystem using the provided relays as relay candidates. This subsystem performs automatic address rewriting to advertise relay addresses when it detects that the node is publicly unreachable (e.g. behind a NAT).

func EnableHolePunching added in v0.1.0

func EnableHolePunching(opts ...holepunch.Option) Option

Experimental EnableHolePunching enables NAT traversal by enabling NATT'd peers to both initiate and respond to hole punching attempts to create direct/NAT-traversed connections with other peers. (default: disabled)

Dependencies:

  • Relay (enabled by default)

This subsystem performs two functions:

  1. On receiving an inbound Relay connection, it attempts to create a direct connection with the remote peer by initiating and co-ordinating a hole punch over the Relayed connection.
  2. If a peer sees a request to co-ordinate a hole punch on an outbound Relay connection, it will participate in the hole-punch to create a direct connection with the remote peer.

If the hole punch is successful, all new streams will thereafter be created on the hole-punched connection. The Relayed connection will eventually be closed after a grace period.

All existing indefinite long-lived streams on the Relayed connection will have to re-opened on the hole-punched connection by the user. Users can make use of the `Connected`/`Disconnected` notifications emitted by the Network for this purpose.

It is not mandatory but nice to also enable the `AutoRelay` option (See `EnableAutoRelay`) so the peer can discover and connect to Relay servers if it discovers that it is NATT'd and has private reachability via AutoNAT. This will then enable it to advertise Relay addresses which can be used to accept inbound Relay connections to then co-ordinate a hole punch.

If `EnableAutoRelay` is configured and the user is confident that the peer has private reachability/is NATT'd, the `ForceReachabilityPrivate` option can be configured to short-circuit reachability discovery via AutoNAT so the peer can immediately start connecting to Relay servers.

If `EnableAutoRelay` is configured, the `StaticRelays` option can be used to configure a static set of Relay servers for `AutoRelay` to connect to so that it does not need to discover Relay servers via Routing.

func EnableNATService added in v0.1.0

func EnableNATService() Option

EnableNATService configures dep2p 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 added in v0.1.0

func EnableRelay() Option

EnableRelay configures dep2p to enable the relay transport. This option only configures dep2p to accept inbound connections from relays and make outbound connections_through_ relays when requested by the remote peer. This option supports both circuit v1 and v2 connections. (default: enabled)

func EnableRelayService added in v0.1.0

func EnableRelayService(opts ...relayv2.Option) Option

EnableRelayService configures dep2p to run a circuit v2 relay, if we detect that we're publicly reachable.

func ForceReachabilityPrivate added in v0.1.0

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 added in v0.1.0

func ForceReachabilityPublic() Option

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

func Identity added in v0.1.0

func Identity(sk crypto.PrivKey) Option

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

func ListenAddrStrings added in v0.1.0

func ListenAddrStrings(s ...string) Option

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

func ListenAddrs added in v0.1.0

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

ListenAddrs configures dep2p to listen on the given addresses.

func MultiaddrResolver added in v0.1.0

func MultiaddrResolver(rslv *madns.Resolver) Option

MultiaddrResolver sets the dep2p dns resolver

func Muxer added in v0.1.0

func Muxer(name string, muxer network.Multiplexer) Option

Muxer configures dep2p to use the given stream multiplexer. name is the protocol name.

func NATManager added in v0.1.0

func NATManager(nm config.NATManagerC) Option

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

func NATPortMap added in v0.1.0

func NATPortMap() Option

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

func Peerstore added in v0.1.0

func Peerstore(ps peerstore.Peerstore) Option

Peerstore configures dep2p to use the given peerstore.

func Ping added in v0.1.0

func Ping(enable bool) Option

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

func PrivateNetwork added in v0.1.0

func PrivateNetwork(psk pnet.PSK) Option

PrivateNetwork configures dep2p to use the given private network protector.

func PrometheusRegisterer added in v0.1.0

func PrometheusRegisterer(reg prometheus.Registerer) Option

PrometheusRegisterer configures dep2p to use reg as the Registerer for all metrics subsystems

func ProtocolVersion added in v0.1.0

func ProtocolVersion(s string) Option

ProtocolVersion sets the protocolVersion string required by the dep2p Identify protocol.

func QUICReuse added in v0.1.0

func QUICReuse(constructor interface{}, opts ...quicreuse.Option) Option

func ResourceManager added in v0.1.0

func ResourceManager(rcmgr network.ResourceManager) Option

ResourceManager configures dep2p to use the given ResourceManager. When using the p2p/host/resource-manager implementation of the ResourceManager interface, it is recommended to set limits for dep2p protocol by calling SetDefaultServiceLimits.

func Routing added in v0.1.0

func Routing(rt config.RoutingC) Option

Routing will configure dep2p to use routing.

func Security added in v0.1.0

func Security(name string, constructor interface{}) Option

Security configures dep2p 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 dep2p node's: * Public key * Private key * Peer ID * Host * Network * Peerstore

func SwarmOpts added in v0.1.0

func SwarmOpts(opts ...swarm.Option) Option

SwarmOpts configures dep2p to use swarm with opts

func Transport added in v0.1.0

func Transport(constructor interface{}, opts ...interface{}) Option

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

The transport can be a constructed transport.Transport or a function taking any subset of this dep2p 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 added in v0.1.0

func UserAgent(userAgent string) Option

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

func WithDialTimeout added in v0.1.0

func WithDialTimeout(t time.Duration) Option

Directories

Path Synopsis
Package core provides convenient access to foundational, central dep2p primitives via type aliases.
Package core provides convenient access to foundational, central dep2p primitives via type aliases.
connmgr
Package connmgr provides connection tracking and management interfaces for dep2p.
Package connmgr provides connection tracking and management interfaces for dep2p.
crypto
Package crypto implements various cryptographic utilities used by dep2p.
Package crypto implements various cryptographic utilities used by dep2p.
discovery
Package discovery provides service advertisement and peer discovery interfaces for dep2p.
Package discovery provides service advertisement and peer discovery interfaces for dep2p.
event
Package event contains the abstractions for a local event bus, along with the standard events that dep2p subsystems may emit.
Package event contains the abstractions for a local event bus, along with the standard events that dep2p subsystems may emit.
host
Package host provides the core Host interface for dep2p.
Package host provides the core Host interface for dep2p.
metrics
Package metrics provides metrics collection and reporting interfaces for dep2p.
Package metrics provides metrics collection and reporting interfaces for dep2p.
network
Package network provides core networking abstractions for dep2p.
Package network provides core networking abstractions for dep2p.
network/mocks
Code generated by MockGen.
Code generated by MockGen.
peer
Package peer implements an object used to represent peers in the dep2p network.
Package peer implements an object used to represent peers in the dep2p network.
peerstore
Package peerstore provides types and interfaces for local storage of address information, metadata, and public key material about dep2p peers.
Package peerstore provides types and interfaces for local storage of address information, metadata, and public key material about dep2p peers.
pnet
Package pnet provides interfaces for private networking in dep2p.
Package pnet provides interfaces for private networking in dep2p.
protocol
Package protocol provides core interfaces for protocol routing and negotiation in dep2p.
Package protocol provides core interfaces for protocol routing and negotiation in dep2p.
routing
Package routing provides interfaces for peer routing and content routing in dep2p.
Package routing provides interfaces for peer routing and content routing in dep2p.
sec
Package sec provides secure connection and transport interfaces for dep2p.
Package sec provides secure connection and transport interfaces for dep2p.
sec/insecure
Package insecure provides an insecure, unencrypted implementation of the SecureConn and SecureTransport interfaces.
Package insecure provides an insecure, unencrypted implementation of the SecureConn and SecureTransport interfaces.
transport
Package transport provides the Transport interface, which represents the devices and network protocols used to send and receive data.
Package transport provides the Transport interface, which represents the devices and network protocols used to send and receive data.
dht
dual
Package dual provides an implementation of a split or "dual" dht, where two parallel instances are maintained for the global internet and the local LAN respectively.
Package dual provides an implementation of a split or "dual" dht, where two parallel instances are maintained for the global internet and the local LAN respectively.
pb
p2p
host/peerstore/pstoreds
Deprecated: The database-backed peerstore will be removed from dep2p in the future.
Deprecated: The database-backed peerstore will be removed from dep2p in the future.
host/resource-manager
Package rcmgr is the resource manager for dep2p.
Package rcmgr is the resource manager for dep2p.
host/resource-manager/obs
Package obs implements metrics tracing for resource manager
Package obs implements metrics tracing for resource manager
http
HTTP semantics with dep2p.
HTTP semantics with dep2p.
net/gostream
Package gostream allows to replace the standard net stack in Go with [DeP2P](https://github.com/dep2p/dep2p) streams.
Package gostream allows to replace the standard net stack in Go with [DeP2P](https://github.com/dep2p/dep2p) streams.
net/mock
Package mocknet provides a mock net.Network to test with.
Package mocknet provides a mock net.Network to test with.
net/reuseport
Package reuseport provides a basic transport for automatically (and intelligently) reusing TCP ports.
Package reuseport provides a basic transport for automatically (and intelligently) reusing TCP ports.
transport/webrtc
Package dep2pwebrtc implements the WebRTC transport for dep2p, as described in https://github.com/dep2p/specs/tree/master/webrtc.
Package dep2pwebrtc implements the WebRTC transport for dep2p, as described in https://github.com/dep2p/specs/tree/master/webrtc.
transport/websocket
Package websocket implements a websocket based transport for dep2p.
Package websocket implements a websocket based transport for dep2p.
util
asn
cid
Package cid implements the Content-IDentifiers specification (https://github.com/ipld/cid) in Go.
Package cid implements the Content-IDentifiers specification (https://github.com/ipld/cid) in Go.
cidranger
Package cidranger provides utility to store CIDR blocks and perform ip inclusion tests against it.
Package cidranger provides utility to store CIDR blocks and perform ip inclusion tests against it.
cidranger/net
Package net provides utility functions for working with IPs (net.IP).
Package net provides utility functions for working with IPs (net.IP).
kbucket
Package kbucket implements a kademlia 'k-bucket' routing table.
Package kbucket implements a kademlia 'k-bucket' routing table.
msgio/pbio
Package pbio reads and writes varint-prefix protobufs, using Google's Protobuf package.
Package pbio reads and writes varint-prefix protobufs, using Google's Protobuf package.
msgio/protoio
Adapted from gogo/protobuf to use multiformats/go-varint for efficient, interoperable length-prefixing.
Adapted from gogo/protobuf to use multiformats/go-varint for efficient, interoperable length-prefixing.
nat
Package nat implements NAT handling facilities
Package nat implements NAT handling facilities
netroute
Originally found in https://github.com/google/gopacket/blob/master/routing/routing.go
Originally found in https://github.com/google/gopacket/blob/master/routing/routing.go
path
Package path contains utilities to work with dep2p paths.
Package path contains utilities to work with dep2p paths.
pool
Package pool provides a sync.Pool equivalent that buckets incoming requests to one of 32 sub-pools, one for each power of 2, 0-32.
Package pool provides a sync.Pool equivalent that buckets incoming requests to one of 32 sub-pools, one for each power of 2, 0-32.
reuseport
Package reuseport provides Listen and Dial functions that set socket options in order to be able to reuse ports.
Package reuseport provides Listen and Dial functions that set socket options in order to be able to reuse ports.
routinghelpers/tracing
tracing provides high level method tracing for the [routing.Routing] API.
tracing provides high level method tracing for the [routing.Routing] API.
sha256
This package use build tags to select between github.com/minio/sha256-simd for go1.20 and bellow and crypto/sha256 for go1.21 and above.
This package use build tags to select between github.com/minio/sha256-simd for go1.20 and bellow and crypto/sha256 for go1.21 and above.
xor/kademlia
Package kademlia provides Kademlia routing-related facilities.
Package kademlia provides Kademlia routing-related facilities.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL