mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-05-27 17:51:20 +00:00

Go to file

clippy.toml: Create config and disallow unbounded channels (#2823 )

When using channels (e.g. `futures::channel::mpsc` or `std::sync::mpsc`)
always use the bounded variant, never use the unbounded variant. When
using a bounded channel, a slow consumer eventually slows down a fast
producer once the channel bound is reached, ideally granting the slow
consumer more system resources e.g. CPU time, keeping queues small and
thus latencies low.  When using an unbounded channel a fast producer
continues being a fast producer, growing the channel buffer
indefinitely, increasing latency until the illusion of unboundedness
breaks and the system runs out of memory.

One may use an unbounded channel if one enforces backpressure through an
out-of-band mechanism, e.g. the consumer granting the producer
send-tokens through a side-channel.

2022-08-20 07:31:45 +02:00

.cargo

*: Enforce no clippy warnings for examples (#2826 )

2022-08-20 05:48:22 +02:00

.github

build(deps): Update prost requirement from 0.10 to 0.11 (#2788 )

2022-08-16 08:49:09 +02:00

core

core/identity: Allow clippy::large-enum-variant on Keypair (#2827 )

2022-08-19 05:06:55 +02:00

docs

docs/coding-guidelines: Add document (#2780 )

2022-08-17 09:03:20 +02:00

examples

*: Enforce no clippy warnings for examples (#2826 )

2022-08-20 05:48:22 +02:00

misc

build(deps): Update prometheus-client requirement from 0.17.0 to 0.18.0 (#2822 )

2022-08-17 07:02:21 +02:00

muxers

core/muxing: Generalise StreamMuxer::poll_address_change to poll (#2797 )

2022-08-16 04:50:17 +02:00

protocols

build(deps): Update prometheus-client requirement from 0.17.0 to 0.18.0 (#2822 )

2022-08-17 07:02:21 +02:00

src

core/src/transport: Poll Transport directly, remove Transport::Listener (#2652 )

2022-07-04 04:16:57 +02:00

swarm

swarm/src/connection: Test max_negotiating_inbound_streams (#2785 )

2022-08-16 10:15:31 +02:00

swarm-derive

swarm-derive/: Derive Debug for generated OutEvent (#2821 )

2022-08-17 08:40:32 +02:00

transports

build(deps): Update prost requirement from 0.10 to 0.11 (#2788 )

2022-08-16 08:49:09 +02: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

swarm-derive/: Generate OutEvent if not provided (#2792 )

2022-08-08 07:18:32 +02:00

CHANGELOG.md

swarm-derive/: Generate OutEvent if not provided (#2792 )

2022-08-08 07:18:32 +02:00

clippy.toml

clippy.toml: Create config and disallow unbounded channels (#2823 )

2022-08-20 07:31:45 +02:00

LICENSE

Some petty changes head of QUIC (#1854 )

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

README.md

README: Point to security@libp2p.io (#2799 )

2022-08-08 10:57:11 +02:00

SECURITY.md

SECURITY.md: Document supported releases and security mail addr (#2800 )

2022-08-08 08:14:46 +02: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@libp2p.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 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 ConnectionHandler 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

(In alphabetical order.)

Elena Frank (@elenaf9)
Max Inden (@mxinden)
Thomas Eizinger (@thomaseizinger)

Notable users

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