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
// 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::{sync::Arc, time::Duration};
use async_broadcast::{Receiver, Sender};
use async_lock::RwLock;
use committable::Committable;
use hotshot_types::{
consensus::{Consensus, LockedConsensusState, OuterConsensus},
data::VidDisperseShare2,
message::Proposal,
traits::{
election::Membership, network::DataRequest, node_implementation::NodeType,
signature_key::SignatureKey,
},
};
use sha2::{Digest, Sha256};
use tokio::{spawn, task::JoinHandle, time::sleep};
use tracing::instrument;
use crate::{events::HotShotEvent, helpers::broadcast_event};
/// Time to wait for txns before sending `ResponseMessage::NotFound`
const TXNS_TIMEOUT: Duration = Duration::from_millis(100);
/// Task state for the Network Request Task. The task is responsible for handling
/// requests sent to this node by the network. It will validate the sender,
/// parse the request, and try to find the data request in the consensus stores.
pub struct NetworkResponseState<TYPES: NodeType> {
/// Locked consensus state
consensus: LockedConsensusState<TYPES>,
/// Quorum membership for checking if requesters have state
membership: Arc<RwLock<TYPES::Membership>>,
/// This replicas public key
pub_key: TYPES::SignatureKey,
/// This replicas private key
private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey,
/// The node's id
id: u64,
}
impl<TYPES: NodeType> NetworkResponseState<TYPES> {
/// Create the network request state with the info it needs
pub fn new(
consensus: LockedConsensusState<TYPES>,
membership: Arc<RwLock<TYPES::Membership>>,
pub_key: TYPES::SignatureKey,
private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey,
id: u64,
) -> Self {
Self {
consensus,
membership,
pub_key,
private_key,
id,
}
}
/// Process request events or loop until a `HotShotEvent::Shutdown` is received.
async fn run_response_loop(
self,
mut receiver: Receiver<Arc<HotShotEvent<TYPES>>>,
event_sender: Sender<Arc<HotShotEvent<TYPES>>>,
) {
loop {
match receiver.recv_direct().await {
Ok(event) => {
// break loop when false, this means shutdown received
match event.as_ref() {
HotShotEvent::VidRequestRecv(request, sender) => {
let cur_epoch = self.consensus.read().await.cur_epoch();
// Verify request is valid
if !self.valid_sender(sender, cur_epoch).await
|| !valid_signature::<TYPES>(request, sender)
{
continue;
}
if let Some(proposal) =
self.get_or_calc_vid_share(request.view, sender).await
{
broadcast_event(
HotShotEvent::VidResponseSend(
self.pub_key.clone(),
sender.clone(),
proposal,
)
.into(),
&event_sender,
)
.await;
}
}
HotShotEvent::QuorumProposalRequestRecv(req, signature) => {
// Make sure that this request came from who we think it did
if !req.key.validate(signature, req.commit().as_ref()) {
tracing::warn!("Invalid signature key on proposal request.");
return;
}
let quorum_proposal_result = self
.consensus
.read()
.await
.last_proposals()
.get(&req.view_number)
.cloned();
if let Some(quorum_proposal) = quorum_proposal_result {
broadcast_event(
HotShotEvent::QuorumProposalResponseSend(
req.key.clone(),
quorum_proposal,
)
.into(),
&event_sender,
)
.await;
}
}
HotShotEvent::Shutdown => {
return;
}
_ => {}
}
}
Err(e) => {
tracing::error!("Failed to receive event. {:?}", e);
}
}
}
}
/// Get the VID share from consensus storage, or calculate it from the payload for
/// the view, if we have the payload. Stores all the shares calculated from the payload
/// if the calculation was done
#[instrument(skip_all, target = "NetworkResponseState", fields(id = self.id))]
async fn get_or_calc_vid_share(
&self,
view: TYPES::View,
key: &TYPES::SignatureKey,
) -> Option<Proposal<TYPES, VidDisperseShare2<TYPES>>> {
let consensus_reader = self.consensus.read().await;
if let Some(view) = consensus_reader.vid_shares().get(&view) {
if let Some(share) = view.get(key) {
return Some(share.clone());
}
}
drop(consensus_reader);
if Consensus::calculate_and_update_vid(
OuterConsensus::new(Arc::clone(&self.consensus)),
view,
Arc::clone(&self.membership),
&self.private_key,
)
.await
.is_none()
{
// Sleep in hope we receive txns in the meantime
sleep(TXNS_TIMEOUT).await;
Consensus::calculate_and_update_vid(
OuterConsensus::new(Arc::clone(&self.consensus)),
view,
Arc::clone(&self.membership),
&self.private_key,
)
.await?;
}
return self
.consensus
.read()
.await
.vid_shares()
.get(&view)?
.get(key)
.cloned();
}
/// Makes sure the sender is allowed to send a request in the given epoch.
async fn valid_sender(&self, sender: &TYPES::SignatureKey, epoch: TYPES::Epoch) -> bool {
self.membership.read().await.has_stake(sender, epoch)
}
}
/// Check the signature
fn valid_signature<TYPES: NodeType>(
req: &DataRequest<TYPES>,
sender: &TYPES::SignatureKey,
) -> bool {
let Ok(data) = bincode::serialize(&req.request) else {
return false;
};
sender.validate(&req.signature, &Sha256::digest(data))
}
/// Spawn the network response task to handle incoming request for data
/// from other nodes. It will shutdown when it gets `HotshotEvent::Shutdown`
/// on the `event_stream` arg.
pub fn run_response_task<TYPES: NodeType>(
task_state: NetworkResponseState<TYPES>,
event_stream: Receiver<Arc<HotShotEvent<TYPES>>>,
sender: Sender<Arc<HotShotEvent<TYPES>>>,
) -> JoinHandle<()> {
spawn(task_state.run_response_loop(event_stream, sender))
}