feat(libp2p): add `SwarmBuilder` #4120

mxinden · 2023-06-26T12:49:37Z

Description

Introduce the new libp2p::SwarmBuilder. Users should use the new libp2p::SwarmBuilder instead of the now deprecated libp2p::swarm::SwarmBuilder. See libp2p::SwarmBuilder docs on how to use the new builder.

Fixes #3657.
Fixes #3563.
Fixes #3179.

Notes & open questions

Change checklist

I have performed a self-review of my own code
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
A changelog entry has been made in the appropriate crates

mxinden · 2023-06-30T02:03:42Z

//CC @DougAnderson444 since this is related to https://github.com/DougAnderson444/libp2peasy.

libp2p/src/builder.rs

thomaseizinger

Great work Max!

Before you continue supporting more transports, I'd appreciate some exploration on how this can be turned into a SwarmBuilder.

Specifically, we should make it possible to pass the identity in there but also generate a new one and then pass it to the Swarm as well.

libp2p/src/builder.rs

- Allow providing or generating identity - Use V1Lazy - Make NetworkBehaviour constructor take relay Behaviour in case with_relay was called - Rename to AuthenticatedMultiplexedTransport

mxinden · 2023-07-01T12:36:17Z

Thank you for the input @thomaseizinger. What do you think of the most recent commit?

thomaseizinger

This is looking very nice already. I'd say that is worth a blog-post once we ship it :)

Some good content for TWIR!

libp2p/src/builder.rs

I suggest shipping a minimal Builder at first. Users that need advanced features can use the `with_other_transport` method or build a `Transport` without the builder.

- Make tls and noise configurable. - Prevent accidental behavior change through feature change. E.g. enabling "noise" feature should not make ones transport automatically offer noise. Instead one needs to explicitly call `with_noise` and `without_noise`.

core/src/upgrade/map.rs

libp2p/src/builder.rs

examples/dcutr/src/main.rs

mxinden · 2023-08-03T12:08:38Z

In regards to the recent comments, happy to add shortcut methods to the various *Builder structs, e.g. with_dns on the OtherTransportBuilder.

…inter

…ransport-builder

Support for QUIC draft 29 was removed with libp2p#4467. libp2p#4120 reintroduced it as a faulty merge. This commit removes it again.

mxinden · 2023-10-10T13:03:13Z

interop-tests/src/arch.rs

-                    .with_websocket(tls::Config::new, mplex::MplexConfig::default)
+                    .with_websocket(noise::Config::new, mplex::MplexConfig::default)


Once more, great catch @thomaseizinger.

Interop tests made this one easy :)

mxinden · 2023-10-10T13:04:08Z

Thank you @thomaseizinger for the last commits and the reviews in general. As always, very helpful.

Support for QUIC draft 29 was removed with #4467. #4120 reintroduced it as a faulty merge. This commit removes it again. Pull-Request: #4622.

Version bump missed in libp2p#4120.

Version bump missed in #4120. Pull-Request: #4683.

This was an oversight in #4120, where we changed the creation of `Swarm`. Thus, all usages of the new `SwarmBuilder` did not actually hit this log line. Pull-Request: #4671.

feat(libp2p): add TransportBuilder

557d052

mxinden added 4 commits June 30, 2023 19:24

Introduce BuildableTransport abstraction

90e53c0

Feature flag

fe1f3d3

Add OtherTransportBuilder

a42f09a

Fix order

321f588

mxinden commented Jun 30, 2023

View reviewed changes

libp2p/src/builder.rs Outdated Show resolved Hide resolved

thomaseizinger reviewed Jun 30, 2023

View reviewed changes

libp2p/src/builder.rs Outdated Show resolved Hide resolved

libp2p/src/builder.rs Outdated Show resolved Hide resolved

libp2p/src/builder.rs Outdated Show resolved Hide resolved

Introduce SwarmBuilder

4c11afc

- Allow providing or generating identity - Use V1Lazy - Make NetworkBehaviour constructor take relay Behaviour in case with_relay was called - Rename to AuthenticatedMultiplexedTransport

thomaseizinger reviewed Jul 3, 2023

View reviewed changes

mxinden added 12 commits July 8, 2023 12:06

Add with_custom_tcp

f8e0fe7

Have with_other_transport take keypair closure

343ba2d

Fully qualify libp2p_swarm::NetworkBehaviour

be22008

Use SwwarmBuilder in DCUtR example

44b9ac4

Remove resolved TODO

eba4607

Remove custom TCP option

5c0593f

I suggest shipping a minimal Builder at first. Users that need advanced features can use the `with_other_transport` method or build a `Transport` without the builder.

Add without_tcp option

777542d

feat(core): add upgrade::Map

bcf36ae

Feature flag for relay

7acc531

refactor(examples/ping): use SwarmBuilder

493bc8d

Rename to without_any_other_transports

b5ed4ed

mxinden commented Jul 31, 2023

View reviewed changes

core/src/upgrade/map.rs Outdated Show resolved Hide resolved

thomaseizinger reviewed Jul 31, 2023

View reviewed changes

libp2p/src/builder.rs Outdated Show resolved Hide resolved

thomaseizinger reviewed Jul 31, 2023

View reviewed changes

libp2p/src/builder.rs Outdated Show resolved Hide resolved

thomaseizinger reviewed Jul 31, 2023

View reviewed changes

examples/dcutr/src/main.rs Outdated Show resolved Hide resolved

thomaseizinger reviewed Jul 31, 2023

View reviewed changes

examples/dcutr/src/main.rs Outdated Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

mxinden added 3 commits October 9, 2023 15:23

Document with_tcp with_relay_client with_websocket taking function po…

e0029e4

…inter

Merge branch 'master' of https://github.com/libp2p/rust-libp2p into t…

1df30f3

…ransport-builder

Fix intra-doc link

a015706

mxinden added the send-it label Oct 9, 2023

Merge branch 'master' into transport-builder

1adf920

This comment was marked as resolved.

Sign in to view

thomaseizinger added 5 commits October 10, 2023 13:36

Merge branch 'master' into transport-builder

a8351da

Reduce diff

59409d3

Reduce diff

4eee7af

Fix bug sec protocol selection

01fbf43

Configure idle-connection timeout

88d4361

This comment was marked as resolved.

Sign in to view

thomaseizinger added 2 commits October 10, 2023 16:42

Merge branch 'master' into transport-builder

e3cc656

Fix interop config bug

06ba925

mergify bot merged commit d605255 into libp2p:master Oct 10, 2023
73 checks passed

mxinden added a commit to mxinden/rust-libp2p that referenced this pull request Oct 10, 2023

fix(server): remove support_draft_29

fd65574

Support for QUIC draft 29 was removed with libp2p#4467. libp2p#4120 reintroduced it as a faulty merge. This commit removes it again.

mxinden mentioned this pull request Oct 10, 2023

fix(server): remove support_draft_29 #4622

Merged

4 tasks

mxinden commented Oct 10, 2023

View reviewed changes

mergify bot pushed a commit that referenced this pull request Oct 10, 2023

fix(server): remove support_draft_29

3a0f0c2

Support for QUIC draft 29 was removed with #4467. #4120 reintroduced it as a faulty merge. This commit removes it again. Pull-Request: #4622.

This was referenced Oct 12, 2023

chore: prepare libp2p v0.52.4 #4625

Merged

feat(SwarmBuilder): make with_bandwidth_logging chainable #4643

Open

This was referenced Oct 15, 2023

examples: Add example combining dns + tcp + quic + relay #3143

Closed

fix(swarm): log local peer ID correctly #4671

Merged

mxinden added a commit to mxinden/rust-libp2p that referenced this pull request Oct 18, 2023

chore(tcp): release v0.40.1

d6874e6

Version bump missed in libp2p#4120.

mxinden mentioned this pull request Oct 18, 2023

chore(tcp): release v0.40.1 #4683

Merged

4 tasks

mergify bot pushed a commit that referenced this pull request Oct 18, 2023

chore(tcp): release v0.40.1

51070da

Version bump missed in #4120. Pull-Request: #4683.

nazar-pc mentioned this pull request Oct 27, 2024

Upgrade libp2p from 0.52.4 to 0.54.1 paritytech/polkadot-sdk#6248

Open

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(libp2p): add `SwarmBuilder` #4120

feat(libp2p): add `SwarmBuilder` #4120

mxinden commented Jun 26, 2023 •

edited by thomaseizinger

Loading

mxinden commented Jun 30, 2023

thomaseizinger left a comment

mxinden commented Jul 1, 2023

thomaseizinger left a comment

mxinden commented Aug 3, 2023

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

mxinden Oct 10, 2023

thomaseizinger Oct 10, 2023

mxinden commented Oct 10, 2023

		.with_websocket(tls::Config::new, mplex::MplexConfig::default)
		.with_websocket(noise::Config::new, mplex::MplexConfig::default)

feat(libp2p): add SwarmBuilder #4120

feat(libp2p): add SwarmBuilder #4120

Conversation

mxinden commented Jun 26, 2023 • edited by thomaseizinger Loading

Description

Notes & open questions

Change checklist

mxinden commented Jun 30, 2023

thomaseizinger left a comment

Choose a reason for hiding this comment

mxinden commented Jul 1, 2023

thomaseizinger left a comment

Choose a reason for hiding this comment

mxinden commented Aug 3, 2023

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

mxinden Oct 10, 2023

Choose a reason for hiding this comment

thomaseizinger Oct 10, 2023

Choose a reason for hiding this comment

mxinden commented Oct 10, 2023

feat(libp2p): add `SwarmBuilder` #4120

feat(libp2p): add `SwarmBuilder` #4120

mxinden commented Jun 26, 2023 •

edited by thomaseizinger

Loading