mirror of
https://github.com/fluencelabs/rust-libp2p
synced 2025-05-21 23:21:19 +00:00
0c85839dab
We refactor our continuous integration workflow with the following goals in mind: - Run as few jobs as possible - Have the jobs finish as fast as possible - Have the jobs redo as little work as possible There are only so many jobs that GitHub Actions will run in parallel. Thus, it makes sense to not create massive matrices but instead group things together meaningfully. The new `test` job will: - Run once for each crate - Ensure that the crate compiles on its specified MSRV - Ensure that the tests pass - Ensure that there are no semver violations This is an improvement to before because we are running all of these in parallel which speeds up execution and highlights more errors at once. Previously, tests run later in the pipeline would not get run at all until you make sure the "first" one passes. We also previously did not verify the MSRV of each crate, making the setting in the `Cargo.toml` rather pointless. The new `cross` job supersedes the existing `wasm` job. This is an improvement because we now also compile the crate for windows and MacOS. Something that wasn't checked before. We assume that checking MSRV and the tests under Linux is good enough. Hence, this job only checks for compile-errors. The new `feature_matrix` ensures we compile correctly with certain feature combinations. `libp2p` exposes a fair few feature-flags. Some of the combinations are worth checking independently. For the moment, this concerns only the executor related transports together with the executor flags but this list can easily be extended. The new `clippy` job runs for `stable` and `beta` rust. Clippy gets continuously extended with new lints. Up until now, we would only learn about those as soon as a new version of Rust is released and CI would run the new lints. This leads to unrelated failures in CI. Running clippy on with `beta` Rust gives us a heads-up of 6 weeks before these lints land on stable. Fixes #2951.
276 lines
9.3 KiB
Rust
276 lines
9.3 KiB
Rust
// Copyright 2018 Parity Technologies (UK) Ltd.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the "Software"),
|
|
// to deal in the Software without restriction, including without limitation
|
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
// and/or sell copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
|
|
//! libp2p is a modular peer-to-peer networking framework.
|
|
//!
|
|
//! To learn more about the general libp2p multi-language framework visit
|
|
//! [libp2p.io](https://libp2p.io/).
|
|
//!
|
|
//! To get started with this libp2p implementation in Rust, please take a look
|
|
//! at the [`tutorials`](crate::tutorials). Further examples can be found in the
|
|
//! [examples] directory.
|
|
//!
|
|
//! [examples]: https://github.com/libp2p/rust-libp2p/tree/master/examples
|
|
|
|
#![doc(html_logo_url = "https://libp2p.io/img/logo_small.png")]
|
|
#![doc(html_favicon_url = "https://libp2p.io/img/favicon.png")]
|
|
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
|
|
|
|
pub use bytes;
|
|
pub use futures;
|
|
#[doc(inline)]
|
|
pub use libp2p_core::multihash;
|
|
#[doc(inline)]
|
|
pub use multiaddr;
|
|
|
|
#[cfg(feature = "autonat")]
|
|
#[doc(inline)]
|
|
pub use libp2p_autonat as autonat;
|
|
#[doc(inline)]
|
|
pub use libp2p_core as core;
|
|
#[cfg(feature = "dcutr")]
|
|
#[doc(inline)]
|
|
pub use libp2p_dcutr as dcutr;
|
|
#[cfg(feature = "deflate")]
|
|
#[cfg(not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")))]
|
|
#[doc(inline)]
|
|
pub use libp2p_deflate as deflate;
|
|
#[cfg(feature = "dns")]
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "dns")))]
|
|
#[cfg(not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")))]
|
|
#[doc(inline)]
|
|
pub use libp2p_dns as dns;
|
|
#[cfg(feature = "floodsub")]
|
|
#[doc(inline)]
|
|
pub use libp2p_floodsub as floodsub;
|
|
#[cfg(feature = "gossipsub")]
|
|
#[cfg(not(target_os = "unknown"))]
|
|
#[doc(inline)]
|
|
pub use libp2p_gossipsub as gossipsub;
|
|
#[cfg(feature = "identify")]
|
|
#[doc(inline)]
|
|
pub use libp2p_identify as identify;
|
|
#[cfg(feature = "kad")]
|
|
#[doc(inline)]
|
|
pub use libp2p_kad as kad;
|
|
#[cfg(feature = "mdns")]
|
|
#[cfg(not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")))]
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "mdns")))]
|
|
#[doc(inline)]
|
|
pub use libp2p_mdns as mdns;
|
|
#[cfg(feature = "metrics")]
|
|
#[doc(inline)]
|
|
pub use libp2p_metrics as metrics;
|
|
#[cfg(feature = "mplex")]
|
|
#[doc(inline)]
|
|
pub use libp2p_mplex as mplex;
|
|
#[cfg(feature = "noise")]
|
|
#[doc(inline)]
|
|
pub use libp2p_noise as noise;
|
|
#[cfg(feature = "ping")]
|
|
#[doc(inline)]
|
|
pub use libp2p_ping as ping;
|
|
#[cfg(feature = "plaintext")]
|
|
#[doc(inline)]
|
|
pub use libp2p_plaintext as plaintext;
|
|
#[cfg(feature = "pnet")]
|
|
#[doc(inline)]
|
|
pub use libp2p_pnet as pnet;
|
|
#[cfg(feature = "quic")]
|
|
#[cfg(not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")))]
|
|
pub mod quic {
|
|
#[doc(inline)]
|
|
pub use libp2p_quic::*;
|
|
}
|
|
#[cfg(feature = "relay")]
|
|
#[doc(inline)]
|
|
pub use libp2p_relay as relay;
|
|
#[cfg(feature = "rendezvous")]
|
|
#[doc(inline)]
|
|
pub use libp2p_rendezvous as rendezvous;
|
|
#[cfg(feature = "request-response")]
|
|
#[doc(inline)]
|
|
pub use libp2p_request_response as request_response;
|
|
#[doc(inline)]
|
|
pub use libp2p_swarm as swarm;
|
|
#[cfg(feature = "tcp")]
|
|
#[cfg(not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")))]
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "tcp")))]
|
|
#[doc(inline)]
|
|
pub use libp2p_tcp as tcp;
|
|
#[cfg(feature = "tls")]
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "tls")))]
|
|
#[cfg(not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")))]
|
|
#[doc(inline)]
|
|
pub use libp2p_tls as tls;
|
|
#[cfg(feature = "uds")]
|
|
#[doc(inline)]
|
|
pub use libp2p_uds as uds;
|
|
#[cfg(feature = "wasm-ext")]
|
|
#[doc(inline)]
|
|
pub use libp2p_wasm_ext as wasm_ext;
|
|
#[cfg(feature = "webrtc")]
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "webrtc")))]
|
|
#[cfg(not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")))]
|
|
#[doc(inline)]
|
|
pub use libp2p_webrtc as webrtc;
|
|
#[cfg(feature = "websocket")]
|
|
#[cfg(not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")))]
|
|
#[doc(inline)]
|
|
pub use libp2p_websocket as websocket;
|
|
#[cfg(feature = "yamux")]
|
|
#[doc(inline)]
|
|
pub use libp2p_yamux as yamux;
|
|
|
|
mod transport_ext;
|
|
|
|
pub mod bandwidth;
|
|
pub mod simple;
|
|
|
|
#[cfg(doc)]
|
|
pub mod tutorials;
|
|
|
|
pub use self::core::{
|
|
identity,
|
|
transport::TransportError,
|
|
upgrade::{InboundUpgrade, InboundUpgradeExt, OutboundUpgrade, OutboundUpgradeExt},
|
|
PeerId, Transport,
|
|
};
|
|
pub use self::multiaddr::{multiaddr as build_multiaddr, Multiaddr};
|
|
pub use self::simple::SimpleProtocol;
|
|
pub use self::swarm::Swarm;
|
|
pub use self::transport_ext::TransportExt;
|
|
|
|
/// Builds a `Transport` based on TCP/IP that supports the most commonly-used features of libp2p:
|
|
///
|
|
/// * DNS resolution.
|
|
/// * Noise protocol encryption.
|
|
/// * Websockets.
|
|
/// * Both Yamux and Mplex for substream multiplexing.
|
|
///
|
|
/// All async I/O of the transport is based on `async-std`.
|
|
///
|
|
/// > **Note**: This `Transport` is not suitable for production usage, as its implementation
|
|
/// > reserves the right to support additional protocols or remove deprecated protocols.
|
|
#[cfg(all(
|
|
not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")),
|
|
any(
|
|
all(feature = "tcp-async-io", feature = "dns-async-std"),
|
|
all(feature = "tcp", feature = "dns", feature = "async-std")
|
|
),
|
|
feature = "websocket",
|
|
feature = "noise",
|
|
feature = "mplex",
|
|
feature = "yamux"
|
|
))]
|
|
#[cfg_attr(
|
|
all(
|
|
any(feature = "tcp-async-io", feature = "dns-async-std"),
|
|
not(feature = "async-std")
|
|
),
|
|
deprecated(
|
|
since = "0.49.0",
|
|
note = "The `tcp-async-io` and `dns-async-std` features are deprecated. Use the new `tcp` and `dns` features together with the `async-std` feature."
|
|
)
|
|
)]
|
|
pub async fn development_transport(
|
|
keypair: identity::Keypair,
|
|
) -> std::io::Result<core::transport::Boxed<(PeerId, core::muxing::StreamMuxerBox)>> {
|
|
let transport = {
|
|
let dns_tcp = dns::DnsConfig::system(tcp::async_io::Transport::new(
|
|
tcp::Config::new().nodelay(true),
|
|
))
|
|
.await?;
|
|
let ws_dns_tcp = websocket::WsConfig::new(
|
|
dns::DnsConfig::system(tcp::async_io::Transport::new(
|
|
tcp::Config::new().nodelay(true),
|
|
))
|
|
.await?,
|
|
);
|
|
dns_tcp.or_transport(ws_dns_tcp)
|
|
};
|
|
|
|
Ok(transport
|
|
.upgrade(core::upgrade::Version::V1)
|
|
.authenticate(noise::NoiseAuthenticated::xx(&keypair).unwrap())
|
|
.multiplex(core::upgrade::SelectUpgrade::new(
|
|
yamux::YamuxConfig::default(),
|
|
mplex::MplexConfig::default(),
|
|
))
|
|
.timeout(std::time::Duration::from_secs(20))
|
|
.boxed())
|
|
}
|
|
|
|
/// Builds a `Transport` based on TCP/IP that supports the most commonly-used features of libp2p:
|
|
///
|
|
/// * DNS resolution.
|
|
/// * Noise protocol encryption.
|
|
/// * Websockets.
|
|
/// * Both Yamux and Mplex for substream multiplexing.
|
|
///
|
|
/// All async I/O of the transport is based on `tokio`.
|
|
///
|
|
/// > **Note**: This `Transport` is not suitable for production usage, as its implementation
|
|
/// > reserves the right to support additional protocols or remove deprecated protocols.
|
|
#[cfg(all(
|
|
not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")),
|
|
any(
|
|
all(feature = "tcp-tokio", feature = "dns-tokio"),
|
|
all(feature = "tcp", feature = "dns", feature = "tokio")
|
|
),
|
|
feature = "websocket",
|
|
feature = "noise",
|
|
feature = "mplex",
|
|
feature = "yamux"
|
|
))]
|
|
#[cfg_attr(
|
|
all(
|
|
any(feature = "tcp-tokio", feature = "dns-tokio"),
|
|
not(feature = "tokio")
|
|
),
|
|
deprecated(
|
|
since = "0.49.0",
|
|
note = "The `tcp-tokio` and `dns-tokio` features are deprecated. Use the new `tcp` and `dns` feature together with the `tokio` feature."
|
|
)
|
|
)]
|
|
pub fn tokio_development_transport(
|
|
keypair: identity::Keypair,
|
|
) -> std::io::Result<core::transport::Boxed<(PeerId, core::muxing::StreamMuxerBox)>> {
|
|
let transport = {
|
|
let dns_tcp = dns::TokioDnsConfig::system(tcp::tokio::Transport::new(
|
|
tcp::Config::new().nodelay(true),
|
|
))?;
|
|
let ws_dns_tcp = websocket::WsConfig::new(dns::TokioDnsConfig::system(
|
|
tcp::tokio::Transport::new(tcp::Config::new().nodelay(true)),
|
|
)?);
|
|
dns_tcp.or_transport(ws_dns_tcp)
|
|
};
|
|
|
|
Ok(transport
|
|
.upgrade(core::upgrade::Version::V1)
|
|
.authenticate(noise::NoiseAuthenticated::xx(&keypair).unwrap())
|
|
.multiplex(core::upgrade::SelectUpgrade::new(
|
|
yamux::YamuxConfig::default(),
|
|
mplex::MplexConfig::default(),
|
|
))
|
|
.timeout(std::time::Duration::from_secs(20))
|
|
.boxed())
|
|
}
|