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
// 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/>.
use std::{
collections::{BTreeMap, BTreeSet},
sync::{
atomic::{AtomicBool, Ordering},
Arc,
},
time::Duration,
};
use async_broadcast::{Receiver, Sender};
use async_lock::RwLock;
use async_trait::async_trait;
use hotshot_task::{
dependency::{Dependency, EventDependency},
task::TaskState,
};
use hotshot_types::{
consensus::OuterConsensus,
traits::{
block_contents::BlockHeader,
election::Membership,
network::{ConnectedNetwork, DataRequest, RequestKind},
node_implementation::{ConsensusTime, NodeImplementation, NodeType},
signature_key::SignatureKey,
},
utils::epoch_from_block_number,
vote::HasViewNumber,
};
use rand::{seq::SliceRandom, thread_rng};
use sha2::{Digest, Sha256};
use tokio::{
spawn,
task::JoinHandle,
time::{sleep, timeout},
};
use tracing::instrument;
use utils::anytrace::Result;
use crate::{events::HotShotEvent, helpers::broadcast_event};
/// Amount of time to try for a request before timing out.
pub const REQUEST_TIMEOUT: Duration = Duration::from_millis(500);
/// Long running task which will request information after a proposal is received.
/// The task will wait a it's `delay` and then send a request iteratively to peers
/// for any data they don't have related to the proposal. For now it's just requesting VID
/// shares.
pub struct NetworkRequestState<TYPES: NodeType, I: NodeImplementation<TYPES>> {
/// Network to send requests over
/// The underlying network
pub network: Arc<I::Network>,
/// Consensus shared state so we can check if we've gotten the information
/// before sending a request
pub consensus: OuterConsensus<TYPES>,
/// Last seen view, we won't request for proposals before older than this view
pub view: TYPES::View,
/// Delay before requesting peers
pub delay: Duration,
/// Membership (Used here only for DA)
pub membership: Arc<RwLock<TYPES::Membership>>,
/// This nodes public key
pub public_key: TYPES::SignatureKey,
/// This nodes private/signing key, used to sign requests.
pub private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey,
/// The node's id
pub id: u64,
/// A flag indicating that `HotShotEvent::Shutdown` has been received
pub shutdown_flag: Arc<AtomicBool>,
/// A flag indicating that `HotShotEvent::Shutdown` has been received
pub spawned_tasks: BTreeMap<TYPES::View, Vec<JoinHandle<()>>>,
}
impl<TYPES: NodeType, I: NodeImplementation<TYPES>> Drop for NetworkRequestState<TYPES, I> {
fn drop(&mut self) {
self.cancel_subtasks();
}
}
/// Alias for a signature
type Signature<TYPES> =
<<TYPES as NodeType>::SignatureKey as SignatureKey>::PureAssembledSignatureType;
#[async_trait]
impl<TYPES: NodeType, I: NodeImplementation<TYPES>> TaskState for NetworkRequestState<TYPES, I> {
type Event = HotShotEvent<TYPES>;
#[instrument(skip_all, target = "NetworkRequestState", fields(id = self.id))]
async fn handle_event(
&mut self,
event: Arc<Self::Event>,
sender: &Sender<Arc<Self::Event>>,
receiver: &Receiver<Arc<Self::Event>>,
) -> Result<()> {
match event.as_ref() {
HotShotEvent::QuorumProposalValidated(proposal, _) => {
let prop_view = proposal.data.view_number();
let prop_epoch = TYPES::Epoch::new(epoch_from_block_number(
proposal.data.block_header.block_number(),
TYPES::EPOCH_HEIGHT,
));
// If we already have the VID shares for the next view, do nothing.
if prop_view >= self.view
&& !self
.consensus
.read()
.await
.vid_shares()
.contains_key(&prop_view)
{
self.spawn_requests(prop_view, prop_epoch, sender, receiver)
.await;
}
Ok(())
}
HotShotEvent::ViewChange(view, _) => {
let view = *view;
if view > self.view {
self.view = view;
}
Ok(())
}
_ => Ok(()),
}
}
fn cancel_subtasks(&mut self) {
self.shutdown_flag.store(true, Ordering::Relaxed);
while !self.spawned_tasks.is_empty() {
let Some((_, handles)) = self.spawned_tasks.pop_first() else {
break;
};
for handle in handles {
handle.abort();
}
}
}
}
impl<TYPES: NodeType, I: NodeImplementation<TYPES>> NetworkRequestState<TYPES, I> {
/// Creates and signs the payload, then will create a request task
async fn spawn_requests(
&mut self,
view: TYPES::View,
epoch: TYPES::Epoch,
sender: &Sender<Arc<HotShotEvent<TYPES>>>,
receiver: &Receiver<Arc<HotShotEvent<TYPES>>>,
) {
let request = RequestKind::Vid(view, self.public_key.clone());
// First sign the request for the VID shares.
if let Some(signature) = self.serialize_and_sign(&request) {
self.create_vid_request_task(
request,
signature,
sender.clone(),
receiver.clone(),
view,
epoch,
)
.await;
}
}
/// Creates a task that will request a VID share from a DA member and wait for the `HotShotEvent::VidResponseRecv`event
/// If we get the VID disperse share, broadcast `HotShotEvent::VidShareRecv` and terminate task
async fn create_vid_request_task(
&mut self,
request: RequestKind<TYPES>,
signature: Signature<TYPES>,
sender: Sender<Arc<HotShotEvent<TYPES>>>,
receiver: Receiver<Arc<HotShotEvent<TYPES>>>,
view: TYPES::View,
epoch: TYPES::Epoch,
) {
let consensus = OuterConsensus::new(Arc::clone(&self.consensus.inner_consensus));
let network = Arc::clone(&self.network);
let shutdown_flag = Arc::clone(&self.shutdown_flag);
let delay = self.delay;
let public_key = self.public_key.clone();
// Get the committee members for the view and the leader, if applicable
let membership_reader = self.membership.read().await;
let mut da_committee_for_view = membership_reader.da_committee_members(view, epoch);
if let Ok(leader) = membership_reader.leader(view, epoch) {
da_committee_for_view.insert(leader);
}
// Get committee members for view
let mut recipients: Vec<TYPES::SignatureKey> = membership_reader
.da_committee_members(view, epoch)
.into_iter()
.collect();
drop(membership_reader);
// Randomize the recipients so all replicas don't overload the same 1 recipients
// and so we don't implicitly rely on the same replica all the time.
recipients.shuffle(&mut thread_rng());
// prepare request
let data_request = DataRequest::<TYPES> {
request,
view,
signature,
};
let my_id = self.id;
let handle: JoinHandle<()> = spawn(async move {
// Do the delay only if primary is up and then start sending
if !network.is_primary_down() {
sleep(delay).await;
}
let mut recipients_it = recipients.iter();
// First check if we got the data before continuing
while !Self::cancel_vid_request_task(
&consensus,
&sender,
&public_key,
&view,
&shutdown_flag,
)
.await
{
// Cycle da members we send the request to each time
if let Some(recipient) = recipients_it.next() {
if *recipient == public_key {
// no need to send a message to ourselves.
// just check for the data at start of loop in `cancel_vid_request_task`
continue;
}
// If we got the data after we make the request then we are done
if Self::handle_vid_request_task(
&sender,
&receiver,
&data_request,
recipient,
&da_committee_for_view,
&public_key,
view,
)
.await
{
return;
}
} else {
// This shouldnt be possible `recipients_it.next()` should clone original and start over if `None`
tracing::warn!(
"Sent VID request to all available DA members and got no response for view: {:?}, my id: {:?}",
view,
my_id,
);
return;
}
}
});
self.spawned_tasks.entry(view).or_default().push(handle);
}
/// Handles main logic for the Request / Response of a vid share
/// Make the request to get VID share to a DA member and wait for the response.
/// Returns true if response received, otherwise false
async fn handle_vid_request_task(
sender: &Sender<Arc<HotShotEvent<TYPES>>>,
receiver: &Receiver<Arc<HotShotEvent<TYPES>>>,
data_request: &DataRequest<TYPES>,
recipient: &TYPES::SignatureKey,
da_committee_for_view: &BTreeSet<<TYPES as NodeType>::SignatureKey>,
public_key: &<TYPES as NodeType>::SignatureKey,
view: TYPES::View,
) -> bool {
// First send request to a random DA member for the view
broadcast_event(
HotShotEvent::VidRequestSend(
data_request.clone(),
public_key.clone(),
recipient.clone(),
)
.into(),
sender,
)
.await;
// Wait for a response
let result = timeout(
REQUEST_TIMEOUT,
Self::handle_event_dependency(receiver, da_committee_for_view.clone(), view),
)
.await;
// Check if we got a result, if not we timed out
if let Ok(Some(event)) = result {
if let HotShotEvent::VidResponseRecv(sender_pub_key, proposal) = event.as_ref() {
broadcast_event(
Arc::new(HotShotEvent::VidShareRecv(
sender_pub_key.clone(),
proposal.clone(),
)),
sender,
)
.await;
return true;
}
}
false
}
/// Create event dependency and wait for `VidResponseRecv` after we send out the request
/// Returns an optional with `VidResponseRecv` if received, otherwise None
async fn handle_event_dependency(
receiver: &Receiver<Arc<HotShotEvent<TYPES>>>,
da_members_for_view: BTreeSet<<TYPES as NodeType>::SignatureKey>,
view: TYPES::View,
) -> Option<Arc<HotShotEvent<TYPES>>> {
EventDependency::new(
receiver.clone(),
Box::new(move |event: &Arc<HotShotEvent<TYPES>>| {
let event = event.as_ref();
if let HotShotEvent::VidResponseRecv(sender_key, proposal) = event {
proposal.data.view_number() == view
&& da_members_for_view.contains(sender_key)
&& sender_key.validate(
&proposal.signature,
proposal.data.payload_commitment.as_ref(),
)
} else {
false
}
}),
)
.completed()
.await
}
/// Returns true if we got the data we wanted, a shutdown event was received, or the view has moved on.
async fn cancel_vid_request_task(
consensus: &OuterConsensus<TYPES>,
sender: &Sender<Arc<HotShotEvent<TYPES>>>,
public_key: &<TYPES as NodeType>::SignatureKey,
view: &TYPES::View,
shutdown_flag: &Arc<AtomicBool>,
) -> bool {
let consensus_reader = consensus.read().await;
let cancel = shutdown_flag.load(Ordering::Relaxed)
|| consensus_reader.vid_shares().contains_key(view)
|| consensus_reader.cur_view() > *view;
if cancel {
if let Some(Some(vid_share)) = consensus_reader
.vid_shares()
.get(view)
.map(|shares| shares.get(public_key).cloned())
{
broadcast_event(
Arc::new(HotShotEvent::VidShareRecv(
public_key.clone(),
vid_share.clone(),
)),
sender,
)
.await;
}
tracing::debug!(
"Canceling vid request for view {:?}, cur view is {:?}",
view,
consensus_reader.cur_view()
);
}
cancel
}
/// Sign the serialized version of the request
fn serialize_and_sign(&self, request: &RequestKind<TYPES>) -> Option<Signature<TYPES>> {
let Ok(data) = bincode::serialize(&request) else {
tracing::error!("Failed to serialize request!");
return None;
};
let Ok(signature) = TYPES::SignatureKey::sign(&self.private_key, &Sha256::digest(data))
else {
tracing::error!("Failed to sign Data Request");
return None;
};
Some(signature)
}
}