mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-05-28 18:21:20 +00:00

Go to file

{core,swarm}: Remove Network abstraction (#2492 )

This commit removes the `Network` abstraction, thus managing `Listeners`
and the connection `Pool` in `Swarm` directly. This is done under the
assumption that noone uses the `Network` abstraction directly, but
instead everyone always uses it through `Swarm`. Both `Listeners` and
`Pool` are moved from `libp2p-core` into `libp2p-swarm`. Given that they
are no longer exposed via `Network`, they can be treated as an
implementation detail of `libp2p-swarm` and `Swarm`.

This change does not include any behavioural changes.

This change has the followin benefits:

- Removal of `NetworkEvent`, which was mostly an isomorphism of
  `SwarmEvent`.
- Removal of the never-directly-used `Network` abstraction.
- Removal of now obsolete verbose `Peer` (`core/src/network/peer.rs`)
  construct.
- Removal of `libp2p-core` `DialOpts`, which is a direct mapping of
  `libp2p-swarm` `DialOpts`.
- Allowing breaking changes to the connection handling and `Swarm` API
  interface without a breaking change in `libp2p-core` and thus a
  without a breaking change in `/transport` protocols.

This change enables the following potential future changes:

- Removal of `NodeHandler` and `ConnectionHandler`. Thus allowing to
  rename `ProtocolsHandler` into `ConnectionHandler`.
- Moving `NetworkBehaviour` and `ProtocolsHandler` into `libp2p-core`,
  having `libp2p-xxx` protocol crates only depend on `libp2p-core` and
  thus allowing general breaking changes to `Swarm` without breaking all
  `libp2p-xxx` crates.

2022-02-13 21:57:38 +01:00

.cargo

.github/: Enforce no clippy warnings (#2148 )

2021-07-26 11:22:46 +02:00

.github

src/tutorials: Add hole punching tutorial (#2460 )

2022-02-10 16:36:20 +01:00

core

{core,swarm}: Remove Network abstraction (#2492 )

2022-02-13 21:57:38 +01:00

docs

docs/release: Only choose crate name not bench name (#1897 )

2020-12-18 11:35:39 +01:00

examples

protocols/kad: Require owned key in get_record (#2477 )

2022-02-07 22:56:30 +01:00

misc

{core,swarm}: Remove Network abstraction (#2492 )

2022-02-13 21:57:38 +01:00

muxers

*: Update multihash and multiaddr (#2469 )

2022-02-03 17:38:41 +01:00

protocols

protocols/gossipsub: Remove outdated warning (#2496 )

2022-02-09 16:24:08 +01:00

src

src/tutorials: Add hole punching tutorial (#2460 )

2022-02-10 16:36:20 +01:00

swarm

{core,swarm}: Remove Network abstraction (#2492 )

2022-02-13 21:57:38 +01:00

swarm-derive

swarm/src/behaviour: Merge inject_* paired methods (#2445 )

2022-02-09 16:08:28 +01:00

transports

{core,swarm}: Remove Network abstraction (#2492 )

2022-02-13 21:57:38 +01:00

.editorconfig

Update .editorconfig to align with rustfmt. (#162 )

2018-04-09 10:52:25 +02:00

.gitignore

initial commit: transport interfaces

2017-04-08 03:31:22 +02:00

Cargo.toml

protocols/: Implement Direct Connection Upgrade through Relay (DCUtR) (#2438 )

2022-02-08 15:56:35 +01:00

CHANGELOG.md

*: Update multihash and multiaddr (#2469 )

2022-02-03 17:38:41 +01:00

LICENSE

Some petty changes head of QUIC (#1854 )

2020-11-24 12:40:11 +01:00

README.md

README: Advertise biweekly community calls (#2454 )

2022-01-28 18:46:59 +01:00

README.md

Central repository for work on libp2p

This repository is the central place for Rust development of the libp2p spec.

Getting started

Main documentation can be found on https://docs.rs/libp2p.
The examples folder contains small binaries showcasing the many protocols in this repository.
For security related issues please reach out to security@ipfs.io. Please do not file a public issue on GitHub.
To report bugs, suggest improvements or request new features please open a GitHub issue on this repository.
For rust-libp2p specific questions please use the GitHub Discussions forum https://github.com/libp2p/rust-libp2p/discussions.
For discussions and questions related to multiple libp2p implementations please use the libp2p Discourse forum https://discuss.libp2p.io.
For general project updates and discussions join the biweekly libp2p Community Calls.

Repository Structure

The main components of this repository are structured as follows:

core/: The implementation of libp2p-core with its Network, Transport and StreamMuxer API on which almost all other crates depend.
transports/: Implementations of transport protocols (e.g. TCP) and protocol upgrades (e.g. for authenticated encryption, compression, ...) based on the libp2p-core Transport API .
muxers/: Implementations of the StreamMuxer interface of libp2p-core, e.g. (sub)stream multiplexing protocols on top of (typically TCP) connections. Multiplexing protocols are (mandatory) Transport upgrades.
swarm/: The implementation of libp2p-swarm building on libp2p-core with the central interfaces NetworkBehaviour and ProtocolsHandler used to implement application protocols (see protocols/).
protocols/: Implementations of application protocols based on the libp2p-swarm APIs.
misc/: Utility libraries.
examples/: Worked examples of built-in application protocols (see protocols/) with common Transport configurations.

Community Guidelines

The libp2p project operates under the IPFS Code of Conduct.

tl;dr

Be respectful.

We're here to help: abuse@ipfs.io

Abusive behavior is never tolerated.

Violations of this code may result in swift and permanent expulsion from the IPFS [and libp2p] community.

"Too long, didn't read" is not a valid excuse for not knowing what is in this document.

Maintainers

Max Inden (@mxinden)
Thomas Eizinger (@thomaseizinger)

Notable users

(open a pull request if you want your project to be added here)