Preferred way to instantiate Libp2p bundle? Inherit or static create?

[a1300]

• Version: 0.29.3
• Platform: Linux
• Subsystem:

Type: Question

I found in the examples both the new Libp2p() and Libp2p.create() methods. In the API documentation only the new Libp2p() way is shown.

Are they the same? Is it safe to inherit from Libp2p and add extra methods?

Example with Libp2p.create()

js-libp2p/examples/discovery-mechanisms/1.js

Lines 24 to 27 in d0a9fad

	const node = await Libp2p.create({
	addresses: {
	listen: ['/ip4/0.0.0.0/tcp/0']
	},

Example with new Libp2p()

js-libp2p/examples/chat/src/dialer.js

Lines 16 to 21 in d0a9fad

	const nodeDialer = new Node({
	peerId: idDialer,
	addresses: {
	listen: ['/ip4/0.0.0.0/tcp/0']
	}
	})

[vasco-santos]

Hello @a1300

The preferred way to instantiate Libp2p is using Libp2p.create. When you create Libp2p via its constructor a PeerId must be provided, while create is a more out of the box solution that can receive the peerId or not. If you would like to PR the example dialer to use Libp2p.create, it would be welcome.

Regarding the docs, we actually have both documented in https://github.com/libp2p/js-libp2p/blob/master/doc/API.md#create . The new Libp2p is documented in a toggle that says alternative, as we really don't want people to use that. However, the class being exported enables some use cases where we want to create a Libp2p node but extend it with some behaviour.

[a1300]

Hi @vasco-santos
thanks for the fast answer! Didn't saw the alternative toggle. I think the alternative example (new Libp2p()) is missing a comment that specifies that a peerId is required.

Will send a PR for the dialer example

[vasco-santos]

I think the alternative example (new Libp2p)) is missing a comment that specifies that a peerId is required.

If you would like to also PR this change, feel free to do it :)

[a1300]

Update docs examples in PR: #814