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
// 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::{marker::PhantomData, sync::Arc};
use anyhow::Result;
use async_broadcast::{Receiver, Sender};
use async_compatibility_layer::art::async_spawn;
use async_lock::RwLock;
#[cfg(async_executor_impl = "async-std")]
use async_std::task::spawn_blocking;
use async_trait::async_trait;
use hotshot_task::task::TaskState;
use hotshot_types::{
consensus::{Consensus, OuterConsensus, View},
data::{DaProposal, PackedBundle},
event::{Event, EventType},
message::{Proposal, UpgradeLock},
simple_certificate::DaCertificate,
simple_vote::{DaData, DaVote},
traits::{
block_contents::vid_commitment,
election::Membership,
network::ConnectedNetwork,
node_implementation::{ConsensusTime, NodeImplementation, NodeType, Versions},
signature_key::SignatureKey,
storage::Storage,
},
utils::ViewInner,
vote::HasViewNumber,
};
use sha2::{Digest, Sha256};
#[cfg(async_executor_impl = "tokio")]
use tokio::task::spawn_blocking;
use tracing::{debug, error, instrument, warn};
use crate::{
events::{HotShotEvent, HotShotTaskCompleted},
helpers::broadcast_event,
vote_collection::{handle_vote, VoteCollectorsMap},
};
/// Tracks state of a DA task
pub struct DaTaskState<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> {
/// Output events to application
pub output_event_stream: async_broadcast::Sender<Event<TYPES>>,
/// View number this view is executing in.
pub cur_view: TYPES::Time,
/// Reference to consensus. Leader will require a read lock on this.
pub consensus: OuterConsensus<TYPES>,
/// Membership for the DA committee
pub da_membership: Arc<TYPES::Membership>,
/// Membership for the quorum committee
/// We need this only for calculating the proper VID scheme
/// from the number of nodes in the quorum.
pub quorum_membership: Arc<TYPES::Membership>,
/// The underlying network
pub network: Arc<I::Network>,
/// A map of `DaVote` collector tasks.
pub vote_collectors: VoteCollectorsMap<TYPES, DaVote<TYPES>, DaCertificate<TYPES>, V>,
/// This Nodes public key
pub public_key: TYPES::SignatureKey,
/// This Nodes private key
pub private_key: <TYPES::SignatureKey as SignatureKey>::PrivateKey,
/// This state's ID
pub id: u64,
/// This node's storage ref
pub storage: Arc<RwLock<I::Storage>>,
/// Lock for a decided upgrade
pub upgrade_lock: UpgradeLock<TYPES, V>,
}
impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> DaTaskState<TYPES, I, V> {
/// main task event handler
#[instrument(skip_all, fields(id = self.id, view = *self.cur_view), name = "DA Main Task", level = "error", target = "DaTaskState")]
pub async fn handle(
&mut self,
event: Arc<HotShotEvent<TYPES>>,
event_stream: Sender<Arc<HotShotEvent<TYPES>>>,
) -> Option<HotShotTaskCompleted> {
match event.as_ref() {
HotShotEvent::DaProposalRecv(proposal, sender) => {
let sender = sender.clone();
debug!(
"DA proposal received for view: {:?}",
proposal.data.view_number()
);
// ED NOTE: Assuming that the next view leader is the one who sends DA proposal for this view
let view = proposal.data.view_number();
// Allow a DA proposal that is one view older, in case we have voted on a quorum
// proposal and updated the view.
// `self.cur_view` should be at least 1 since there is a view change before getting
// the `DaProposalRecv` event. Otherwise, the view number subtraction below will
// cause an overflow error.
// TODO ED Come back to this - we probably don't need this, but we should also never receive a DAC where this fails, investigate block ready so it doesn't make one for the genesis block
if self.cur_view != TYPES::Time::genesis() && view < self.cur_view - 1 {
warn!("Throwing away DA proposal that is more than one view older");
return None;
}
if self
.consensus
.read()
.await
.saved_payloads()
.contains_key(&view)
{
warn!("Received DA proposal for view {:?} but we already have a payload for that view. Throwing it away", view);
return None;
}
let encoded_transactions_hash = Sha256::digest(&proposal.data.encoded_transactions);
// ED Is this the right leader?
let view_leader_key = self.da_membership.leader(view);
if view_leader_key != sender {
error!("DA proposal doesn't have expected leader key for view {} \n DA proposal is: {:?}", *view, proposal.data.clone());
return None;
}
if !view_leader_key.validate(&proposal.signature, &encoded_transactions_hash) {
error!("Could not verify proposal.");
return None;
}
broadcast_event(
Arc::new(HotShotEvent::DaProposalValidated(proposal.clone(), sender)),
&event_stream,
)
.await;
}
HotShotEvent::DaProposalValidated(proposal, sender) => {
let curr_view = self.consensus.read().await.cur_view();
if curr_view > proposal.data.view_number() + 1 {
tracing::debug!("Validated DA proposal for prior view but it's too old now Current view {:?}, DA Proposal view {:?}", curr_view, proposal.data.view_number());
return None;
}
// Proposal is fresh and valid, notify the application layer
broadcast_event(
Event {
view_number: self.cur_view,
event: EventType::DaProposal {
proposal: proposal.clone(),
sender: sender.clone(),
},
},
&self.output_event_stream,
)
.await;
if !self.da_membership.has_stake(&self.public_key) {
debug!(
"We were not chosen for consensus committee on {:?}",
self.cur_view
);
return None;
}
if let Err(e) = self.storage.write().await.append_da(proposal).await {
error!(
"Failed to store DA Proposal with error {:?}, aborting vote",
e
);
return None;
}
let txns = Arc::clone(&proposal.data.encoded_transactions);
let num_nodes = self.quorum_membership.total_nodes();
let payload_commitment =
spawn_blocking(move || vid_commitment(&txns, num_nodes)).await;
#[cfg(async_executor_impl = "tokio")]
let payload_commitment = payload_commitment.unwrap();
let view_number = proposal.data.view_number();
// Generate and send vote
let Ok(vote) = DaVote::create_signed_vote(
DaData {
payload_commit: payload_commitment,
},
view_number,
&self.public_key,
&self.private_key,
&self.upgrade_lock,
)
.await
else {
error!("Failed to sign DA Vote!");
return None;
};
debug!("Sending vote to the DA leader {:?}", vote.view_number());
broadcast_event(Arc::new(HotShotEvent::DaVoteSend(vote)), &event_stream).await;
let mut consensus = self.consensus.write().await;
// Ensure this view is in the view map for garbage collection.
let view = View {
view_inner: ViewInner::Da { payload_commitment },
};
if let Err(e) = consensus.update_validated_state_map(view_number, view.clone()) {
tracing::trace!("{e:?}");
}
// Record the payload we have promised to make available.
if let Err(e) = consensus.update_saved_payloads(
view_number,
Arc::clone(&proposal.data.encoded_transactions),
) {
tracing::trace!("{e:?}");
}
// Optimistically calculate and update VID if we know that the primary network is down.
if self.network.is_primary_down() {
let consensus =
OuterConsensus::new(Arc::clone(&self.consensus.inner_consensus));
let membership = Arc::clone(&self.quorum_membership);
let pk = self.private_key.clone();
let public_key = self.public_key.clone();
let chan = event_stream.clone();
async_spawn(async move {
Consensus::calculate_and_update_vid(
OuterConsensus::new(Arc::clone(&consensus.inner_consensus)),
view_number,
membership,
&pk,
)
.await;
if let Some(Some(vid_share)) = consensus
.read()
.await
.vid_shares()
.get(&view_number)
.map(|shares| shares.get(&public_key).cloned())
{
broadcast_event(
Arc::new(HotShotEvent::VidShareRecv(vid_share.clone())),
&chan,
)
.await;
}
});
}
}
HotShotEvent::DaVoteRecv(ref vote) => {
debug!("DA vote recv, Main Task {:?}", vote.view_number());
// Check if we are the leader and the vote is from the sender.
let view = vote.view_number();
if self.da_membership.leader(view) != self.public_key {
error!("We are not the DA committee leader for view {} are we leader for next view? {}", *view, self.da_membership.leader(view + 1) == self.public_key);
return None;
}
handle_vote(
&mut self.vote_collectors,
vote,
self.public_key.clone(),
&self.da_membership,
self.id,
&event,
&event_stream,
&self.upgrade_lock,
)
.await;
}
HotShotEvent::ViewChange(view) => {
let view = *view;
if (*view != 0 || *self.cur_view > 0) && *self.cur_view >= *view {
return None;
}
if *view - *self.cur_view > 1 {
warn!("View changed by more than 1 going to view {:?}", view);
}
self.cur_view = view;
// If we are not the next leader (DA leader for this view) immediately exit
if self.da_membership.leader(self.cur_view + 1) != self.public_key {
return None;
}
debug!("Polling for DA votes for view {}", *self.cur_view + 1);
return None;
}
HotShotEvent::BlockRecv(packed_bundle) => {
let PackedBundle::<TYPES> {
encoded_transactions,
metadata,
view_number,
..
} = packed_bundle;
let view_number = *view_number;
// quick hash the encoded txns with sha256
let encoded_transactions_hash = Sha256::digest(encoded_transactions);
// sign the encoded transactions as opposed to the VID commitment
let Ok(signature) =
TYPES::SignatureKey::sign(&self.private_key, &encoded_transactions_hash)
else {
error!("Failed to sign block payload!");
return None;
};
let data: DaProposal<TYPES> = DaProposal {
encoded_transactions: Arc::clone(encoded_transactions),
metadata: metadata.clone(),
// Upon entering a new view we want to send a DA Proposal for the next view -> Is it always the case that this is cur_view + 1?
view_number,
};
let message = Proposal {
data,
signature,
_pd: PhantomData,
};
broadcast_event(
Arc::new(HotShotEvent::DaProposalSend(
message.clone(),
self.public_key.clone(),
)),
&event_stream,
)
.await;
}
HotShotEvent::Shutdown => {
error!("Shutting down because of shutdown signal!");
return Some(HotShotTaskCompleted);
}
_ => {}
}
None
}
}
#[async_trait]
/// task state implementation for DA Task
impl<TYPES: NodeType, I: NodeImplementation<TYPES>, V: Versions> TaskState
for DaTaskState<TYPES, I, V>
{
type Event = HotShotEvent<TYPES>;
async fn handle_event(
&mut self,
event: Arc<Self::Event>,
sender: &Sender<Arc<Self::Event>>,
_receiver: &Receiver<Arc<Self::Event>>,
) -> Result<()> {
self.handle(event, sender.clone()).await;
Ok(())
}
async fn cancel_subtasks(&mut self) {}
}