1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
// Copyright (c) 2021-2024 Espresso Systems (espressosys.com)
// This file is part of the HotShot repository.
// You should have received a copy of the MIT License
// along with the HotShot repository. If not, see <https://mit-license.org/>.
//! Network access compatibility
//!
//! Contains types and traits used by `HotShot` to abstract over network access
use async_compatibility_layer::art::async_sleep;
use derivative::Derivative;
use dyn_clone::DynClone;
use futures::Future;
use thiserror::Error;
#[cfg(not(any(async_executor_impl = "async-std", async_executor_impl = "tokio")))]
compile_error! {"Either config option \"async-std\" or \"tokio\" must be enabled for this crate."}
use std::{
collections::{BTreeSet, HashMap},
fmt::{Debug, Display},
hash::Hash,
pin::Pin,
sync::Arc,
time::Duration,
};
use async_compatibility_layer::channel::TrySendError;
use async_trait::async_trait;
use futures::future::join_all;
use rand::{
distributions::{Bernoulli, Uniform},
prelude::Distribution,
};
use serde::{Deserialize, Serialize};
use super::{node_implementation::NodeType, signature_key::SignatureKey};
use crate::{
data::ViewNumber,
message::{MessagePurpose, SequencingMessage},
BoxSyncFuture,
};
/// Centralized server specific errors
#[derive(Debug, Error, Serialize, Deserialize)]
pub enum PushCdnNetworkError {}
/// the type of transmission
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum TransmitType<TYPES: NodeType> {
/// directly transmit
Direct(TYPES::SignatureKey),
/// broadcast the message to all
Broadcast,
/// broadcast to DA committee
DaCommitteeBroadcast,
/// broadcast to the leader and the DA
DaCommitteeAndLeaderBroadcast(TYPES::SignatureKey),
}
/// Errors that can occur in the network
#[derive(Debug, Error)]
pub enum NetworkError {
/// Multiple errors. Allows us to roll up multiple errors into one.
#[error("Multiple errors: {0:?}")]
Multiple(Vec<NetworkError>),
/// A configuration error
#[error("Configuration error: {0}")]
ConfigError(String),
/// An error occurred while sending a message
#[error("Failed to send message: {0}")]
MessageSendError(String),
/// An error occurred while receiving a message
#[error("Failed to receive message: {0}")]
MessageReceiveError(String),
/// The feature is unimplemented
#[error("Unimplemented")]
Unimplemented,
/// An error occurred while attempting to listen
#[error("Listen error: {0}")]
ListenError(String),
/// Failed to send over a channel
#[error("Channel send error: {0}")]
ChannelSendError(String),
/// Failed to receive over a channel
#[error("Channel receive error: {0}")]
ChannelReceiveError(String),
/// The network has been shut down and can no longer be used
#[error("Network has been shut down")]
ShutDown,
/// Failed to serialize
#[error("Failed to serialize: {0}")]
FailedToSerialize(String),
/// Failed to deserialize
#[error("Failed to deserialize: {0}")]
FailedToDeserialize(String),
/// Timed out performing an operation
#[error("Timeout: {0}")]
Timeout(String),
/// The network request had been cancelled before it could be fulfilled
#[error("The request was cancelled before it could be fulfilled")]
RequestCancelled,
/// The network was not ready yet
#[error("The network was not ready yet")]
NotReadyYet,
/// Failed to look up a node on the network
#[error("Node lookup failed: {0}")]
LookupError(String),
}
/// common traits we would like our network messages to implement
pub trait NetworkMsg:
Serialize + for<'a> Deserialize<'a> + Clone + Sync + Send + Debug + 'static
{
}
impl<T> NetworkMsg for T where
T: Serialize + for<'a> Deserialize<'a> + Clone + Sync + Send + Debug + 'static
{
}
/// Trait that bundles what we need from a request ID
pub trait Id: Eq + PartialEq + Hash {}
/// a message
pub trait ViewMessage<TYPES: NodeType> {
/// get the view out of the message
fn view_number(&self) -> TYPES::Time;
// TODO move out of this trait.
/// get the purpose of the message
fn purpose(&self) -> MessagePurpose;
}
/// A request for some data that the consensus layer is asking for.
#[derive(Serialize, Deserialize, Derivative, Clone, Debug, PartialEq, Eq, Hash)]
#[serde(bound(deserialize = ""))]
pub struct DataRequest<TYPES: NodeType> {
/// Request
pub request: RequestKind<TYPES>,
/// View this message is for
pub view: TYPES::Time,
/// signature of the Sha256 hash of the data so outsiders can't use know
/// public keys with stake.
pub signature: <TYPES::SignatureKey as SignatureKey>::PureAssembledSignatureType,
}
/// Underlying data request
#[derive(Serialize, Deserialize, Derivative, Clone, Debug, PartialEq, Eq, Hash)]
pub enum RequestKind<TYPES: NodeType> {
/// Request VID data by our key and the VID commitment
Vid(TYPES::Time, TYPES::SignatureKey),
/// Request a DA proposal for a certain view
DaProposal(TYPES::Time),
/// Request for quorum proposal for a view
Proposal(TYPES::Time),
}
/// A response for a request. `SequencingMessage` is the same as other network messages
/// The kind of message `M` is is determined by what we requested
#[derive(Serialize, Deserialize, Derivative, Clone, Debug, PartialEq, Eq, Hash)]
#[serde(bound(deserialize = ""))]
#[allow(clippy::large_enum_variant)]
/// TODO: Put `Found` content in a `Box` to make enum smaller
pub enum ResponseMessage<TYPES: NodeType> {
/// Peer returned us some data
Found(SequencingMessage<TYPES>),
/// Peer failed to get us data
NotFound,
/// The Request was denied
Denied,
}
#[derive(Debug, Clone, PartialEq, Eq)]
/// When a message should be broadcast to the network.
///
/// Network implementations may or may not respect this, at their discretion.
pub enum BroadcastDelay {
/// Broadcast the message immediately
None,
/// Delay the broadcast to a given view.
View(u64),
}
#[async_trait]
/// represents a networking implmentration
/// exposes low level API for interacting with a network
/// intended to be implemented for libp2p, the centralized server,
/// and memory network
pub trait ConnectedNetwork<K: SignatureKey + 'static>: Clone + Send + Sync + 'static {
/// Pauses the underlying network
fn pause(&self);
/// Resumes the underlying network
fn resume(&self);
/// Blocks until the network is successfully initialized
async fn wait_for_ready(&self);
/// Blocks until the network is shut down
fn shut_down<'a, 'b>(&'a self) -> BoxSyncFuture<'b, ()>
where
'a: 'b,
Self: 'b;
/// broadcast message to some subset of nodes
/// blocking
async fn broadcast_message(
&self,
message: Vec<u8>,
topic: Topic,
broadcast_delay: BroadcastDelay,
) -> Result<(), NetworkError>;
/// broadcast a message only to a DA committee
/// blocking
async fn da_broadcast_message(
&self,
message: Vec<u8>,
recipients: BTreeSet<K>,
broadcast_delay: BroadcastDelay,
) -> Result<(), NetworkError>;
/// send messages with vid shares to its recipients
/// blocking
async fn vid_broadcast_message(
&self,
messages: HashMap<K, Vec<u8>>,
) -> Result<(), NetworkError> {
let future_results = messages
.into_iter()
.map(|(recipient_key, message)| self.direct_message(message, recipient_key));
let results = join_all(future_results).await;
let errors: Vec<_> = results
.into_iter()
.filter_map(|r| match r {
Err(error) => Some(error),
_ => None,
})
.collect();
if errors.is_empty() {
Ok(())
} else {
Err(NetworkError::Multiple(errors))
}
}
/// Sends a direct message to a specific node
/// blocking
async fn direct_message(&self, message: Vec<u8>, recipient: K) -> Result<(), NetworkError>;
/// Receive one or many messages from the underlying network.
///
/// # Errors
/// If there is a network-related failure.
async fn recv_message(&self) -> Result<Vec<u8>, NetworkError>;
/// queues lookup of a node
///
/// # Errors
/// Does not error.
fn queue_node_lookup(
&self,
_view_number: ViewNumber,
_pk: K,
) -> Result<(), TrySendError<Option<(ViewNumber, K)>>> {
Ok(())
}
/// Update view can be used for any reason, but mostly it's for canceling tasks,
/// and looking up the address of the leader of a future view.
async fn update_view<'a, TYPES>(&'a self, _view: u64, _membership: &TYPES::Membership)
where
TYPES: NodeType<SignatureKey = K> + 'a,
{
}
/// Is primary network down? Makes sense only for combined network
fn is_primary_down(&self) -> bool {
false
}
}
/// A channel generator for types that need asynchronous execution
pub type AsyncGenerator<T> =
Pin<Box<dyn Fn(u64) -> Pin<Box<dyn Future<Output = T> + Send>> + Send + Sync>>;
/// Describes additional functionality needed by the test network implementation
pub trait TestableNetworkingImplementation<TYPES: NodeType>
where
Self: Sized,
{
/// generates a network given an expected node count
#[allow(clippy::type_complexity)]
fn generator(
expected_node_count: usize,
num_bootstrap: usize,
network_id: usize,
da_committee_size: usize,
is_da: bool,
reliability_config: Option<Box<dyn NetworkReliability>>,
secondary_network_delay: Duration,
) -> AsyncGenerator<Arc<Self>>;
/// Get the number of messages in-flight.
///
/// Some implementations will not be able to tell how many messages there are in-flight. These implementations should return `None`.
fn in_flight_message_count(&self) -> Option<usize>;
}
/// Changes that can occur in the network
#[derive(Debug)]
pub enum NetworkChange<P: SignatureKey> {
/// A node is connected
NodeConnected(P),
/// A node is disconnected
NodeDisconnected(P),
}
/// interface describing how reliable the network is
#[async_trait]
pub trait NetworkReliability: Debug + Sync + std::marker::Send + DynClone + 'static {
/// Sample from bernoulli distribution to decide whether
/// or not to keep a packet
/// # Panics
///
/// Panics if `self.keep_numerator > self.keep_denominator`
///
fn sample_keep(&self) -> bool {
true
}
/// sample from uniform distribution to decide whether
/// or not to keep a packet
fn sample_delay(&self) -> Duration {
std::time::Duration::ZERO
}
/// scramble the packet
fn scramble(&self, msg: Vec<u8>) -> Vec<u8> {
msg
}
/// number of times to repeat the packet
fn sample_repeat(&self) -> usize {
1
}
/// given a message and a way to send the message,
/// decide whether or not to send the message
/// how long to delay the message
/// whether or not to send duplicates
/// and whether or not to include noise with the message
/// then send the message
/// note: usually self is stored in a rwlock
/// so instead of doing the sending part, we just fiddle with the message
/// then return a future that does the sending and delaying
fn chaos_send_msg(
&self,
msg: Vec<u8>,
send_fn: Arc<dyn Send + Sync + 'static + Fn(Vec<u8>) -> BoxSyncFuture<'static, ()>>,
) -> BoxSyncFuture<'static, ()> {
let sample_keep = self.sample_keep();
let delay = self.sample_delay();
let repeats = self.sample_repeat();
let mut msgs = Vec::new();
for _idx in 0..repeats {
let scrambled = self.scramble(msg.clone());
msgs.push(scrambled);
}
let closure = async move {
if sample_keep {
async_sleep(delay).await;
for msg in msgs {
send_fn(msg).await;
}
}
};
Box::pin(closure)
}
}
// hack to get clone
dyn_clone::clone_trait_object!(NetworkReliability);
/// ideal network
#[derive(Clone, Copy, Debug, Default)]
pub struct PerfectNetwork {}
impl NetworkReliability for PerfectNetwork {}
/// A synchronous network. Packets may be delayed, but are guaranteed
/// to arrive within `timeout` ns
#[derive(Clone, Copy, Debug, Default)]
pub struct SynchronousNetwork {
/// Max value in milliseconds that a packet may be delayed
pub delay_high_ms: u64,
/// Lowest value in milliseconds that a packet may be delayed
pub delay_low_ms: u64,
}
impl NetworkReliability for SynchronousNetwork {
/// never drop a packet
fn sample_keep(&self) -> bool {
true
}
fn sample_delay(&self) -> Duration {
Duration::from_millis(
Uniform::new_inclusive(self.delay_low_ms, self.delay_high_ms)
.sample(&mut rand::thread_rng()),
)
}
}
/// An asynchronous network. Packets may be dropped entirely
/// or delayed for arbitrarily long periods
/// probability that packet is kept = `keep_numerator` / `keep_denominator`
/// packet delay is obtained by sampling from a uniform distribution
/// between `delay_low_ms` and `delay_high_ms`, inclusive
#[derive(Debug, Clone, Copy)]
pub struct AsynchronousNetwork {
/// numerator for probability of keeping packets
pub keep_numerator: u32,
/// denominator for probability of keeping packets
pub keep_denominator: u32,
/// lowest value in milliseconds that a packet may be delayed
pub delay_low_ms: u64,
/// highest value in milliseconds that a packet may be delayed
pub delay_high_ms: u64,
}
impl NetworkReliability for AsynchronousNetwork {
fn sample_keep(&self) -> bool {
Bernoulli::from_ratio(self.keep_numerator, self.keep_denominator)
.unwrap()
.sample(&mut rand::thread_rng())
}
fn sample_delay(&self) -> Duration {
Duration::from_millis(
Uniform::new_inclusive(self.delay_low_ms, self.delay_high_ms)
.sample(&mut rand::thread_rng()),
)
}
}
/// An partially synchronous network. Behaves asynchronously
/// until some arbitrary time bound, GST,
/// then synchronously after GST
#[allow(clippy::similar_names)]
#[derive(Debug, Clone, Copy)]
pub struct PartiallySynchronousNetwork {
/// asynchronous portion of network
pub asynchronous: AsynchronousNetwork,
/// synchronous portion of network
pub synchronous: SynchronousNetwork,
/// time when GST occurs
pub gst: std::time::Duration,
/// when the network was started
pub start: std::time::Instant,
}
impl NetworkReliability for PartiallySynchronousNetwork {
/// never drop a packet
fn sample_keep(&self) -> bool {
true
}
fn sample_delay(&self) -> Duration {
// act asynchronous before gst
if self.start.elapsed() < self.gst {
if self.asynchronous.sample_keep() {
self.asynchronous.sample_delay()
} else {
// assume packet was "dropped" and will arrive after gst
self.synchronous.sample_delay() + self.gst
}
} else {
// act synchronous after gst
self.synchronous.sample_delay()
}
}
}
impl Default for AsynchronousNetwork {
// disable all chance of failure
fn default() -> Self {
AsynchronousNetwork {
keep_numerator: 1,
keep_denominator: 1,
delay_low_ms: 0,
delay_high_ms: 0,
}
}
}
impl Default for PartiallySynchronousNetwork {
fn default() -> Self {
PartiallySynchronousNetwork {
synchronous: SynchronousNetwork::default(),
asynchronous: AsynchronousNetwork::default(),
gst: std::time::Duration::new(0, 0),
start: std::time::Instant::now(),
}
}
}
impl SynchronousNetwork {
/// create new `SynchronousNetwork`
#[must_use]
pub fn new(timeout: u64, delay_low_ms: u64) -> Self {
SynchronousNetwork {
delay_high_ms: timeout,
delay_low_ms,
}
}
}
impl AsynchronousNetwork {
/// create new `AsynchronousNetwork`
#[must_use]
pub fn new(
keep_numerator: u32,
keep_denominator: u32,
delay_low_ms: u64,
delay_high_ms: u64,
) -> Self {
AsynchronousNetwork {
keep_numerator,
keep_denominator,
delay_low_ms,
delay_high_ms,
}
}
}
impl PartiallySynchronousNetwork {
/// create new `PartiallySynchronousNetwork`
#[allow(clippy::similar_names)]
#[must_use]
pub fn new(
asynchronous: AsynchronousNetwork,
synchronous: SynchronousNetwork,
gst: std::time::Duration,
) -> Self {
PartiallySynchronousNetwork {
asynchronous,
synchronous,
gst,
start: std::time::Instant::now(),
}
}
}
/// A chaotic network using all the networking calls
#[derive(Debug, Clone)]
pub struct ChaosNetwork {
/// numerator for probability of keeping packets
pub keep_numerator: u32,
/// denominator for probability of keeping packets
pub keep_denominator: u32,
/// lowest value in milliseconds that a packet may be delayed
pub delay_low_ms: u64,
/// highest value in milliseconds that a packet may be delayed
pub delay_high_ms: u64,
/// lowest value of repeats for a message
pub repeat_low: usize,
/// highest value of repeats for a message
pub repeat_high: usize,
}
impl NetworkReliability for ChaosNetwork {
fn sample_keep(&self) -> bool {
Bernoulli::from_ratio(self.keep_numerator, self.keep_denominator)
.unwrap()
.sample(&mut rand::thread_rng())
}
fn sample_delay(&self) -> Duration {
Duration::from_millis(
Uniform::new_inclusive(self.delay_low_ms, self.delay_high_ms)
.sample(&mut rand::thread_rng()),
)
}
fn sample_repeat(&self) -> usize {
Uniform::new_inclusive(self.repeat_low, self.repeat_high).sample(&mut rand::thread_rng())
}
}
/// Used when broadcasting messages
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub enum Topic {
/// The `Global` topic goes out to all nodes
Global,
/// The `Da` topic goes out to only the DA committee
Da,
}
/// Libp2p topics require a string, so we need to convert our enum to a string
impl Display for Topic {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Topic::Global => write!(f, "global"),
Topic::Da => write!(f, "DA"),
}
}
}