mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 18:07:58 +00:00
klbrvik
2453e25fb8
* expose transport, peer_info and discovery in sc-network * fix fmt * add missing module docs
107 lines
4.1 KiB
Rust
107 lines
4.1 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
|
|
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
//! Transport that serves as a common ground for all connections.
|
|
|
|
use either::Either;
|
|
use libp2p::{
|
|
core::{
|
|
muxing::StreamMuxerBox,
|
|
transport::{Boxed, OptionalTransport},
|
|
upgrade,
|
|
},
|
|
dns, identity, noise, tcp, websocket, PeerId, Transport, TransportExt,
|
|
};
|
|
use std::{sync::Arc, time::Duration};
|
|
|
|
pub use libp2p::bandwidth::BandwidthSinks;
|
|
|
|
/// Builds the transport that serves as a common ground for all connections.
|
|
///
|
|
/// If `memory_only` is true, then only communication within the same process are allowed. Only
|
|
/// addresses with the format `/memory/...` are allowed.
|
|
///
|
|
/// `yamux_window_size` is the maximum size of the Yamux receive windows. `None` to leave the
|
|
/// default (256kiB).
|
|
///
|
|
/// `yamux_maximum_buffer_size` is the maximum allowed size of the Yamux buffer. This should be
|
|
/// set either to the maximum of all the maximum allowed sizes of messages frames of all
|
|
/// high-level protocols combined, or to some generously high value if you are sure that a maximum
|
|
/// size is enforced on all high-level protocols.
|
|
///
|
|
/// Returns a `BandwidthSinks` object that allows querying the average bandwidth produced by all
|
|
/// the connections spawned with this transport.
|
|
pub fn build_transport(
|
|
keypair: identity::Keypair,
|
|
memory_only: bool,
|
|
yamux_window_size: Option<u32>,
|
|
yamux_maximum_buffer_size: usize,
|
|
) -> (Boxed<(PeerId, StreamMuxerBox)>, Arc<BandwidthSinks>) {
|
|
// Build the base layer of the transport.
|
|
let transport = if !memory_only {
|
|
// Main transport: DNS(TCP)
|
|
let tcp_config = tcp::Config::new().nodelay(true);
|
|
let tcp_trans = tcp::tokio::Transport::new(tcp_config.clone());
|
|
let dns_init = dns::TokioDnsConfig::system(tcp_trans);
|
|
|
|
Either::Left(if let Ok(dns) = dns_init {
|
|
// WS + WSS transport
|
|
//
|
|
// Main transport can't be used for `/wss` addresses because WSS transport needs
|
|
// unresolved addresses (BUT WSS transport itself needs an instance of DNS transport to
|
|
// resolve and dial addresses).
|
|
let tcp_trans = tcp::tokio::Transport::new(tcp_config);
|
|
let dns_for_wss = dns::TokioDnsConfig::system(tcp_trans)
|
|
.expect("same system_conf & resolver to work");
|
|
Either::Left(websocket::WsConfig::new(dns_for_wss).or_transport(dns))
|
|
} else {
|
|
// In case DNS can't be constructed, fallback to TCP + WS (WSS won't work)
|
|
let tcp_trans = tcp::tokio::Transport::new(tcp_config.clone());
|
|
let desktop_trans = websocket::WsConfig::new(tcp_trans)
|
|
.or_transport(tcp::tokio::Transport::new(tcp_config));
|
|
Either::Right(desktop_trans)
|
|
})
|
|
} else {
|
|
Either::Right(OptionalTransport::some(libp2p::core::transport::MemoryTransport::default()))
|
|
};
|
|
|
|
let authentication_config = noise::Config::new(&keypair).expect("Can create noise config. qed");
|
|
let multiplexing_config = {
|
|
let mut yamux_config = libp2p::yamux::Config::default();
|
|
// Enable proper flow-control: window updates are only sent when
|
|
// buffered data has been consumed.
|
|
yamux_config.set_window_update_mode(libp2p::yamux::WindowUpdateMode::on_read());
|
|
yamux_config.set_max_buffer_size(yamux_maximum_buffer_size);
|
|
|
|
if let Some(yamux_window_size) = yamux_window_size {
|
|
yamux_config.set_receive_window_size(yamux_window_size);
|
|
}
|
|
|
|
yamux_config
|
|
};
|
|
|
|
let transport = transport
|
|
.upgrade(upgrade::Version::V1Lazy)
|
|
.authenticate(authentication_config)
|
|
.multiplex(multiplexing_config)
|
|
.timeout(Duration::from_secs(20))
|
|
.boxed();
|
|
|
|
transport.with_bandwidth_logging()
|
|
}
|