diff --git a/libp2p.go b/libp2p.go index 936b2220d0b5616f6cba8630342842868b2ed6ff..7d0621c94cb5212445fe1a9e510f7c8ead510a19 100644 --- a/libp2p.go +++ b/libp2p.go @@ -27,8 +27,27 @@ func ChainOptions(opts ...Option) Option { } } -// New constructs a new libp2p node with the given options (falling back on -// reasonable defaults). +// 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 TPC 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 New(ctx context.Context, opts ...Option) (host.Host, error) {