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 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
// Copyright (c) Zefchain Labs, Inc.
// SPDX-License-Identifier: Apache-2.0
//! # Chain manager
//!
//! This module contains the consensus mechanism for all microchains. Whenever a block is
//! confirmed, a new chain manager is created for the next block height. It manages the consensus
//! state until a new block is confirmed. As long as less than a third of the validators are faulty,
//! it guarantees that at most one `ConfirmedBlock` certificate will be created for this height.
//!
//! The protocol proceeds in rounds, until it reaches a round where a block gets confirmed.
//!
//! There are four kinds of rounds:
//!
//! * In `Round::Fast`, only super owners can propose blocks, and validators vote to confirm a
//! block immediately. Super owners must be careful to make only one block proposal, or else they
//! can permanently block the microchain. If there are no super owners, `Round::Fast` is skipped.
//! * In cooperative mode (`Round::MultiLeader`), all chain owners can propose blocks at any time.
//! The protocol is guaranteed to eventually confirm a block as long as no chain owner
//! continuously actively prevents progress.
//! * In leader rotation mode (`Round::SingleLeader`), chain owners take turns at proposing blocks.
//! It can make progress as long as at least one owner is honest, even if other owners try to
//! prevent it.
//! * In fallback/public mode (`Round::Validator`), validators take turns at proposing blocks.
//! It can always make progress under the standard assumption that there is a quorum of honest
//! validators.
//!
//! ## Safety, i.e. at most one block will be confirmed
//!
//! In all modes this is guaranteed as follows:
//!
//! * Validators (honest ones) never cast a vote if they have already cast any vote in a later
//! round.
//! * Validators never vote for a `ValidatedBlock` **A** in round **r** if they have voted for a
//! _different_ `ConfirmedBlock` **B** in an earlier round **s** ≤ **r**, unless there is a
//! `ValidatedBlock` certificate (with a quorum of validator signatures) for **A** in some round
//! between **s** and **r** included in the block proposal.
//! * Validators only vote for a `ConfirmedBlock` if there is a `ValidatedBlock` certificate for the
//! same block in the same round. (Or, in the `Fast` round, if there is a valid proposal.)
//!
//! This guarantees that once a quorum votes for some `ConfirmedBlock`, there can never be a
//! `ValidatedBlock` certificate (and thus also no `ConfirmedBlock` certificate) for a different
//! block in a later round. So if there are two different `ConfirmedBlock` certificates, they may
//! be from different rounds, but they are guaranteed to contain the same block.
//!
//! ## Liveness, i.e. some block will eventually be confirmed
//!
//! In `Round::Fast`, liveness depends on the super owners coordinating, and proposing at most one
//! block.
//!
//! If they propose none, and there are other owners, `Round::Fast` will eventually time out.
//!
//! In cooperative mode, if there is contention, the owners need to agree on a single owner as the
//! next proposer. That owner should then download all highest-round certificates and block
//! proposals known to the honest validators. They can then make a proposal in a round higher than
//! all previous proposals. If there is any `ValidatedBlock` certificate they must include the
//! highest one in their proposal, and propose that block. Otherwise they can propose a new block.
//! Now all honest validators are allowed to vote for that proposal, and eventually confirm it.
//!
//! If the owners fail to cooperate, any honest owner can initiate the last multi-leader round by
//! making a proposal there, then wait for it to time out, which starts the leader-based mode:
//!
//! In leader-based and fallback/public mode, an honest participant should subscribe to
//! notifications from all validators, and follow the chain. Whenever another leader's round takes
//! too long, they should request timeout votes from the validators to make the next round begin.
//! Once the honest participant becomes the round leader, they should update all validators, so
//! that they all agree on the current round. Then they download the highest `ValidatedBlock`
//! certificate known to any honest validator and include that in their block proposal, just like
//! in the cooperative case.
use std::collections::BTreeMap;
use async_graphql::{ComplexObject, SimpleObject};
use custom_debug_derive::Debug;
use futures::future::Either;
use linera_base::{
crypto::{AccountPublicKey, ValidatorSecretKey},
data_types::{Blob, BlockHeight, Round, Timestamp},
ensure,
hashed::Hashed,
identifiers::{BlobId, ChainId, Owner},
ownership::ChainOwnership,
};
use linera_execution::{committee::Epoch, ExecutionRuntimeContext};
use linera_views::{
context::Context,
map_view::MapView,
register_view::RegisterView,
views::{ClonableView, View, ViewError},
};
use rand_chacha::{rand_core::SeedableRng, ChaCha8Rng};
use rand_distr::{Distribution, WeightedAliasIndex};
use serde::{Deserialize, Serialize};
use crate::{
block::{ConfirmedBlock, Timeout, ValidatedBlock},
data_types::{BlockProposal, ExecutedBlock, LiteVote, ProposedBlock, Vote},
types::{TimeoutCertificate, ValidatedBlockCertificate},
ChainError,
};
/// The result of verifying a (valid) query.
#[derive(Eq, PartialEq)]
pub enum Outcome {
Accept,
Skip,
}
pub type ValidatedOrConfirmedVote<'a> = Either<&'a Vote<ValidatedBlock>, &'a Vote<ConfirmedBlock>>;
/// The latest block that validators may have voted to confirm: this is either the block proposal
/// from the fast round or a validated block certificate. Validators are allowed to vote for this
/// even if they have locked (i.e. voted to confirm) a different block earlier.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(with_testing, derive(Eq, PartialEq))]
pub enum LockingBlock {
/// A proposal in the `Fast` round.
Fast(BlockProposal),
/// A `ValidatedBlock` certificate in a round other than `Fast`.
Regular(ValidatedBlockCertificate),
}
impl LockingBlock {
/// Returns the locking block's round. To propose a different block, a `ValidatedBlock`
/// certificate from a higher round is needed.
pub fn round(&self) -> Round {
match self {
Self::Fast(_) => Round::Fast,
Self::Regular(certificate) => certificate.round,
}
}
pub fn chain_id(&self) -> ChainId {
match self {
Self::Fast(proposal) => proposal.content.block.chain_id,
Self::Regular(certificate) => certificate.value().inner().chain_id(),
}
}
}
/// The state of the certification process for a chain's next block.
#[derive(Debug, View, ClonableView, SimpleObject)]
#[graphql(complex)]
pub struct ChainManager<C>
where
C: Clone + Context + Send + Sync + 'static,
{
/// The public keys, weights and types of the chain's owners.
pub ownership: RegisterView<C, ChainOwnership>,
/// The seed for the pseudo-random number generator that determines the round leaders.
pub seed: RegisterView<C, u64>,
/// The probability distribution for choosing a round leader.
#[graphql(skip)] // Derived from ownership.
pub distribution: RegisterView<C, Option<WeightedAliasIndex<u64>>>,
/// The probability distribution for choosing a fallback round leader.
#[graphql(skip)] // Derived from validator weights.
pub fallback_distribution: RegisterView<C, Option<WeightedAliasIndex<u64>>>,
/// Highest-round authenticated block that we have received and checked. If there are multiple
/// proposals in the same round, this contains only the first one.
#[graphql(skip)]
pub proposed: RegisterView<C, Option<BlockProposal>>,
/// These are blobs published or read by the proposed block.
pub proposed_blobs: MapView<C, BlobId, Blob>,
/// Latest validated proposal that a validator may have voted to confirm. This is either the
/// latest `ValidatedBlock` we have seen, or the proposal from the `Fast` round.
#[graphql(skip)]
pub locking_block: RegisterView<C, Option<LockingBlock>>,
/// These are blobs published or read by the locking block.
pub locking_blobs: MapView<C, BlobId, Blob>,
/// Latest leader timeout certificate we have received.
#[graphql(skip)]
pub timeout: RegisterView<C, Option<TimeoutCertificate>>,
/// Latest vote we cast to confirm a block.
#[graphql(skip)]
pub confirmed_vote: RegisterView<C, Option<Vote<ConfirmedBlock>>>,
/// Latest vote we cast to validate a block.
#[graphql(skip)]
pub validated_vote: RegisterView<C, Option<Vote<ValidatedBlock>>>,
/// Latest timeout vote we cast.
#[graphql(skip)]
pub timeout_vote: RegisterView<C, Option<Vote<Timeout>>>,
/// Fallback vote we cast.
#[graphql(skip)]
pub fallback_vote: RegisterView<C, Option<Vote<Timeout>>>,
/// The time after which we are ready to sign a timeout certificate for the current round.
pub round_timeout: RegisterView<C, Option<Timestamp>>,
/// The lowest round where we can still vote to validate or confirm a block. This is
/// the round to which the timeout applies.
///
/// Having a leader timeout certificate in any given round causes the next one to become
/// current. Seeing a validated block certificate or a valid proposal in any round causes that
/// round to become current, unless a higher one already is.
#[graphql(skip)]
pub current_round: RegisterView<C, Round>,
/// The owners that take over in fallback mode.
pub fallback_owners: RegisterView<C, BTreeMap<Owner, u64>>,
}
#[ComplexObject]
impl<C> ChainManager<C>
where
C: Context + Clone + Send + Sync + 'static,
{
/// Returns the lowest round where we can still vote to validate or confirm a block. This is
/// the round to which the timeout applies.
///
/// Having a leader timeout certificate in any given round causes the next one to become
/// current. Seeing a validated block certificate or a valid proposal in any round causes that
/// round to become current, unless a higher one already is.
#[graphql(derived(name = "current_round"))]
async fn _current_round(&self) -> Round {
self.current_round()
}
}
impl<C> ChainManager<C>
where
C: Context + Clone + Send + Sync + 'static,
{
/// Replaces `self` with a new chain manager.
pub fn reset<'a>(
&mut self,
ownership: ChainOwnership,
height: BlockHeight,
local_time: Timestamp,
fallback_owners: impl Iterator<Item = (AccountPublicKey, u64)> + 'a,
) -> Result<(), ChainError> {
let distribution = if !ownership.owners.is_empty() {
let weights = ownership.owners.values().copied().collect();
Some(WeightedAliasIndex::new(weights)?)
} else {
None
};
let fallback_owners = fallback_owners
.map(|(pub_key, weight)| (Owner::from(pub_key), weight))
.collect::<BTreeMap<_, _>>();
let fallback_distribution = if !fallback_owners.is_empty() {
let weights = fallback_owners.values().copied().collect();
Some(WeightedAliasIndex::new(weights)?)
} else {
None
};
let current_round = ownership.first_round();
let round_duration = ownership.round_timeout(current_round);
let round_timeout = round_duration.map(|rd| local_time.saturating_add(rd));
self.clear();
self.seed.set(height.0);
self.ownership.set(ownership);
self.distribution.set(distribution);
self.fallback_distribution.set(fallback_distribution);
self.fallback_owners.set(fallback_owners);
self.current_round.set(current_round);
self.round_timeout.set(round_timeout);
Ok(())
}
/// Returns the most recent confirmed vote we cast.
pub fn confirmed_vote(&self) -> Option<&Vote<ConfirmedBlock>> {
self.confirmed_vote.get().as_ref()
}
/// Returns the most recent validated vote we cast.
pub fn validated_vote(&self) -> Option<&Vote<ValidatedBlock>> {
self.validated_vote.get().as_ref()
}
/// Returns the most recent timeout vote we cast.
pub fn timeout_vote(&self) -> Option<&Vote<Timeout>> {
self.timeout_vote.get().as_ref()
}
/// Returns the most recent fallback vote we cast.
pub fn fallback_vote(&self) -> Option<&Vote<Timeout>> {
self.fallback_vote.get().as_ref()
}
/// Returns the lowest round where we can still vote to validate or confirm a block. This is
/// the round to which the timeout applies.
///
/// Having a leader timeout certificate in any given round causes the next one to become
/// current. Seeing a validated block certificate or a valid proposal in any round causes that
/// round to become current, unless a higher one already is.
pub fn current_round(&self) -> Round {
*self.current_round.get()
}
/// Verifies that a proposed block is relevant and should be handled.
pub fn check_proposed_block(&self, proposal: &BlockProposal) -> Result<Outcome, ChainError> {
let new_block = &proposal.content.block;
let new_round = proposal.content.round;
if let Some(old_proposal) = self.proposed.get() {
if old_proposal.content == proposal.content {
return Ok(Outcome::Skip); // We have already seen this proposal; nothing to do.
}
}
// When a block is certified, incrementing its height must succeed.
ensure!(
new_block.height < BlockHeight::MAX,
ChainError::InvalidBlockHeight
);
let current_round = self.current_round();
match new_round {
// The proposal from the fast round may still be relevant as a locking block, so
// we don't compare against the current round here.
Round::Fast => {}
Round::MultiLeader(_) | Round::SingleLeader(0) => {
// If the fast round has not timed out yet, only a super owner is allowed to open
// a later round by making a proposal.
ensure!(
self.is_super(&proposal.public_key.into()) || !current_round.is_fast(),
ChainError::WrongRound(current_round)
);
// After the fast round, proposals older than the current round are obsolete.
ensure!(
new_round >= current_round,
ChainError::InsufficientRound(new_round)
);
}
Round::SingleLeader(_) | Round::Validator(_) => {
// After the first single-leader round, only proposals from the current round are relevant.
ensure!(
new_round == current_round,
ChainError::WrongRound(current_round)
);
}
}
// The round of our validation votes is only allowed to increase.
if let Some(vote) = self.validated_vote() {
ensure!(
new_round > vote.round,
ChainError::InsufficientRoundStrict(vote.round)
);
}
// A proposal that isn't newer than the locking block is not relevant anymore.
if let Some(locking_block) = self.locking_block.get() {
ensure!(
locking_block.round() < new_round,
ChainError::MustBeNewerThanLockingBlock(new_block.height, locking_block.round())
);
}
// If we have voted to confirm we cannot vote to validate a different block anymore, except
// if there is a validated block certificate from a later round.
if let Some(vote) = self.confirmed_vote() {
ensure!(
if let Some(validated_cert) = proposal.validated_block_certificate.as_ref() {
vote.round <= validated_cert.round
} else {
vote.round.is_fast() && vote.value().inner().matches_proposed_block(new_block)
},
ChainError::HasIncompatibleConfirmedVote(new_block.height, vote.round)
);
}
Ok(Outcome::Accept)
}
/// Checks if the current round has timed out, and signs a `Timeout`.
pub fn vote_timeout(
&mut self,
chain_id: ChainId,
height: BlockHeight,
epoch: Epoch,
key_pair: Option<&ValidatorSecretKey>,
local_time: Timestamp,
) -> bool {
let Some(key_pair) = key_pair else {
return false; // We are not a validator.
};
let Some(round_timeout) = *self.round_timeout.get() else {
return false; // The current round does not time out.
};
if local_time < round_timeout || self.ownership.get().owners.is_empty() {
return false; // Round has not timed out yet, or there are no regular owners.
}
let current_round = self.current_round();
if let Some(vote) = self.timeout_vote.get() {
if vote.round == current_round {
return false; // We already signed this timeout.
}
}
let value = Hashed::new(Timeout::new(chain_id, height, epoch));
self.timeout_vote
.set(Some(Vote::new(value, current_round, key_pair)));
true
}
/// Signs a `Timeout` certificate to switch to fallback mode.
///
/// This must only be called after verifying that the condition for fallback mode is
/// satisfied locally.
pub fn vote_fallback(
&mut self,
chain_id: ChainId,
height: BlockHeight,
epoch: Epoch,
key_pair: Option<&ValidatorSecretKey>,
) -> bool {
let Some(key_pair) = key_pair else {
return false; // We are not a validator.
};
if self.fallback_vote.get().is_some() || self.current_round() >= Round::Validator(0) {
return false; // We already signed this or are already in fallback mode.
}
let value = Hashed::new(Timeout::new(chain_id, height, epoch));
let last_regular_round = Round::SingleLeader(u32::MAX);
self.fallback_vote
.set(Some(Vote::new(value, last_regular_round, key_pair)));
true
}
/// Verifies that a validated block is still relevant and should be handled.
pub fn check_validated_block(
&self,
certificate: &ValidatedBlockCertificate,
) -> Result<Outcome, ChainError> {
let new_block = certificate.block();
let new_round = certificate.round;
if let Some(Vote { value, round, .. }) = self.confirmed_vote.get() {
if value.inner().block() == new_block && *round == new_round {
return Ok(Outcome::Skip); // We already voted to confirm this block.
}
}
// Check if we already voted to validate in a later round.
if let Some(Vote { round, .. }) = self.validated_vote.get() {
ensure!(new_round >= *round, ChainError::InsufficientRound(*round))
}
if let Some(locking) = self.locking_block.get() {
if let LockingBlock::Regular(locking_cert) = locking {
if locking_cert.hash() == certificate.hash() && locking.round() == new_round {
return Ok(Outcome::Skip); // We already handled this certificate.
}
}
ensure!(
new_round > locking.round(),
ChainError::InsufficientRoundStrict(locking.round())
);
}
Ok(Outcome::Accept)
}
/// Signs a vote to validate the proposed block.
pub fn create_vote(
&mut self,
proposal: BlockProposal,
executed_block: ExecutedBlock,
key_pair: Option<&ValidatorSecretKey>,
local_time: Timestamp,
blobs: BTreeMap<BlobId, Blob>,
) -> Result<Option<ValidatedOrConfirmedVote>, ChainError> {
let round = proposal.content.round;
// If the validated block certificate is more recent, update our locking block.
if let Some(lite_cert) = &proposal.validated_block_certificate {
if self
.locking_block
.get()
.as_ref()
.map_or(true, |locking| locking.round() < lite_cert.round)
{
let value = Hashed::new(ValidatedBlock::new(executed_block.clone()));
if let Some(certificate) = lite_cert.clone().with_value(value) {
self.update_locking(LockingBlock::Regular(certificate), blobs.clone())?;
}
}
} else if round.is_fast() && self.locking_block.get().is_none() {
// The fast block also counts as locking.
self.update_locking(LockingBlock::Fast(proposal.clone()), blobs.clone())?;
}
// We record the proposed block, in case it affects the current round number.
self.update_proposed(proposal.clone(), blobs)?;
self.update_current_round(local_time);
let Some(key_pair) = key_pair else {
// Not a validator.
return Ok(None);
};
// If this is a fast block, vote to confirm. Otherwise vote to validate.
if round.is_fast() {
self.validated_vote.set(None);
let value = Hashed::new(ConfirmedBlock::new(executed_block));
let vote = Vote::new(value, round, key_pair);
Ok(Some(Either::Right(
self.confirmed_vote.get_mut().insert(vote),
)))
} else {
let value = Hashed::new(ValidatedBlock::new(executed_block));
let vote = Vote::new(value, round, key_pair);
Ok(Some(Either::Left(
self.validated_vote.get_mut().insert(vote),
)))
}
}
/// Signs a vote to confirm the validated block.
pub fn create_final_vote(
&mut self,
validated: ValidatedBlockCertificate,
key_pair: Option<&ValidatorSecretKey>,
local_time: Timestamp,
blobs: BTreeMap<BlobId, Blob>,
) -> Result<(), ViewError> {
let round = validated.round;
let confirmed_block = ConfirmedBlock::new(validated.inner().block().clone().into());
self.update_locking(LockingBlock::Regular(validated), blobs)?;
self.update_current_round(local_time);
if let Some(key_pair) = key_pair {
if self.current_round() != round {
return Ok(()); // We never vote in a past round.
}
// Vote to confirm.
let vote = Vote::new(Hashed::new(confirmed_block), round, key_pair);
// Ok to overwrite validation votes with confirmation votes at equal or higher round.
self.confirmed_vote.set(Some(vote));
self.validated_vote.set(None);
}
Ok(())
}
/// Returns the requested blob if it belongs to the proposal or the locking block.
pub async fn pending_blob(&self, blob_id: &BlobId) -> Result<Option<Blob>, ViewError> {
if let Some(blob) = self.proposed_blobs.get(blob_id).await? {
return Ok(Some(blob));
}
self.locking_blobs.get(blob_id).await
}
/// Updates `current_round` and `round_timeout` if necessary.
///
/// This must be after every change to `timeout`, `locking` or `proposed`.
fn update_current_round(&mut self, local_time: Timestamp) {
let current_round = self
.timeout
.get()
.iter()
.map(|certificate| {
self.ownership
.get()
.next_round(certificate.round)
.unwrap_or(Round::Validator(u32::MAX))
})
.chain(self.locking_block.get().as_ref().map(LockingBlock::round))
.chain(
self.proposed
.get()
.iter()
.map(|proposal| proposal.content.round),
)
.max()
.unwrap_or_default()
.max(self.ownership.get().first_round());
if current_round <= self.current_round() {
return;
}
let round_duration = self.ownership.get().round_timeout(current_round);
self.round_timeout
.set(round_duration.map(|rd| local_time.saturating_add(rd)));
self.current_round.set(current_round);
}
/// Updates the round number and timer if the timeout certificate is from a higher round than
/// any known certificate.
pub fn handle_timeout_certificate(
&mut self,
certificate: TimeoutCertificate,
local_time: Timestamp,
) {
let round = certificate.round;
if let Some(known_certificate) = self.timeout.get() {
if known_certificate.round >= round {
return;
}
}
self.timeout.set(Some(certificate));
self.update_current_round(local_time);
}
/// Returns whether the signer is a valid owner and allowed to propose a block in the
/// proposal's round.
pub fn verify_owner(&self, proposal: &BlockProposal) -> bool {
let owner = &proposal.public_key.into();
if self.ownership.get().super_owners.contains(owner) {
return true;
}
match proposal.content.round {
Round::Fast => {
false // Only super owners can propose in the first round.
}
Round::MultiLeader(_) => {
let ownership = self.ownership.get();
// Not in leader rotation mode; any owner is allowed to propose.
ownership.open_multi_leader_rounds || ownership.owners.contains_key(owner)
}
Round::SingleLeader(r) => {
let Some(index) = self.round_leader_index(r) else {
return false;
};
self.ownership.get().owners.keys().nth(index) == Some(owner)
}
Round::Validator(r) => {
let Some(index) = self.fallback_round_leader_index(r) else {
return false;
};
self.fallback_owners.get().keys().nth(index) == Some(owner)
}
}
}
/// Returns the leader who is allowed to propose a block in the given round, or `None` if every
/// owner is allowed to propose. Exception: In `Round::Fast`, only super owners can propose.
fn round_leader(&self, round: Round) -> Option<&Owner> {
match round {
Round::SingleLeader(r) => {
let index = self.round_leader_index(r)?;
self.ownership.get().owners.keys().nth(index)
}
Round::Validator(r) => {
let index = self.fallback_round_leader_index(r)?;
self.fallback_owners.get().keys().nth(index)
}
Round::Fast | Round::MultiLeader(_) => None,
}
}
/// Returns the index of the leader who is allowed to propose a block in the given round.
fn round_leader_index(&self, round: u32) -> Option<usize> {
let seed = u64::from(round)
.rotate_left(32)
.wrapping_add(*self.seed.get());
let mut rng = ChaCha8Rng::seed_from_u64(seed);
Some(self.distribution.get().as_ref()?.sample(&mut rng))
}
/// Returns the index of the fallback leader who is allowed to propose a block in the given
/// round.
fn fallback_round_leader_index(&self, round: u32) -> Option<usize> {
let seed = u64::from(round)
.rotate_left(32)
.wrapping_add(*self.seed.get());
let mut rng = ChaCha8Rng::seed_from_u64(seed);
Some(self.fallback_distribution.get().as_ref()?.sample(&mut rng))
}
/// Returns whether the owner is a super owner.
fn is_super(&self, owner: &Owner) -> bool {
self.ownership.get().super_owners.contains(owner)
}
/// Sets the proposed block, if it is newer than our known latest proposal.
fn update_proposed(
&mut self,
proposal: BlockProposal,
blobs: BTreeMap<BlobId, Blob>,
) -> Result<(), ViewError> {
if let Some(old_proposal) = self.proposed.get() {
if old_proposal.content.round >= proposal.content.round {
return Ok(());
}
}
self.proposed.set(Some(proposal));
self.proposed_blobs.clear();
for (blob_id, blob) in blobs {
self.proposed_blobs.insert(&blob_id, blob)?;
}
Ok(())
}
/// Sets the locking block and the associated blobs, if it is newer than the known one.
fn update_locking(
&mut self,
locking: LockingBlock,
blobs: BTreeMap<BlobId, Blob>,
) -> Result<(), ViewError> {
if let Some(old_locked) = self.locking_block.get() {
if old_locked.round() >= locking.round() {
return Ok(());
}
}
self.locking_block.set(Some(locking));
self.locking_blobs.clear();
for (blob_id, blob) in blobs {
self.locking_blobs.insert(&blob_id, blob)?;
}
Ok(())
}
}
/// Chain manager information that is included in `ChainInfo` sent to clients.
#[derive(Default, Clone, Debug, Serialize, Deserialize)]
#[cfg_attr(with_testing, derive(Eq, PartialEq))]
pub struct ChainManagerInfo {
/// The configuration of the chain's owners.
pub ownership: ChainOwnership,
/// Latest authenticated block that we have received, if requested.
#[debug(skip_if = Option::is_none)]
pub requested_proposed: Option<Box<BlockProposal>>,
/// Latest validated proposal that we have voted to confirm (or would have, if we are not a
/// validator).
#[debug(skip_if = Option::is_none)]
pub requested_locking: Option<Box<LockingBlock>>,
/// Latest timeout certificate we have seen.
#[debug(skip_if = Option::is_none)]
pub timeout: Option<Box<TimeoutCertificate>>,
/// Latest vote we cast (either to validate or to confirm a block).
#[debug(skip_if = Option::is_none)]
pub pending: Option<LiteVote>,
/// Latest timeout vote we cast.
#[debug(skip_if = Option::is_none)]
pub timeout_vote: Option<LiteVote>,
/// Fallback vote we cast.
#[debug(skip_if = Option::is_none)]
pub fallback_vote: Option<LiteVote>,
/// The value we voted for, if requested.
#[debug(skip_if = Option::is_none)]
pub requested_confirmed: Option<Box<Hashed<ConfirmedBlock>>>,
/// The value we voted for, if requested.
#[debug(skip_if = Option::is_none)]
pub requested_validated: Option<Box<Hashed<ValidatedBlock>>>,
/// The current round, i.e. the lowest round where we can still vote to validate a block.
pub current_round: Round,
/// The current leader, who is allowed to propose the next block.
/// `None` if everyone is allowed to propose.
#[debug(skip_if = Option::is_none)]
pub leader: Option<Owner>,
/// The timestamp when the current round times out.
#[debug(skip_if = Option::is_none)]
pub round_timeout: Option<Timestamp>,
}
impl<C> From<&ChainManager<C>> for ChainManagerInfo
where
C: Context + Clone + Send + Sync + 'static,
{
fn from(manager: &ChainManager<C>) -> Self {
let current_round = manager.current_round();
let pending = match (manager.confirmed_vote.get(), manager.validated_vote.get()) {
(None, None) => None,
(Some(confirmed_vote), Some(validated_vote))
if validated_vote.round > confirmed_vote.round =>
{
Some(validated_vote.lite())
}
(Some(vote), _) => Some(vote.lite()),
(None, Some(vote)) => Some(vote.lite()),
};
ChainManagerInfo {
ownership: manager.ownership.get().clone(),
requested_proposed: None,
requested_locking: None,
timeout: manager.timeout.get().clone().map(Box::new),
pending,
timeout_vote: manager.timeout_vote.get().as_ref().map(Vote::lite),
fallback_vote: manager.fallback_vote.get().as_ref().map(Vote::lite),
requested_confirmed: None,
requested_validated: None,
current_round,
leader: manager.round_leader(current_round).cloned(),
round_timeout: *manager.round_timeout.get(),
}
}
}
impl ChainManagerInfo {
/// Adds requested certificate values and proposals to the `ChainManagerInfo`.
pub fn add_values<C>(&mut self, manager: &ChainManager<C>)
where
C: Context + Clone + Send + Sync + 'static,
C::Extra: ExecutionRuntimeContext,
{
self.requested_proposed = manager.proposed.get().clone().map(Box::new);
self.requested_locking = manager.locking_block.get().clone().map(Box::new);
self.requested_confirmed = manager
.confirmed_vote
.get()
.as_ref()
.map(|vote| Box::new(vote.value.clone()));
self.requested_validated = manager
.validated_vote
.get()
.as_ref()
.map(|vote| Box::new(vote.value.clone()));
}
/// Returns whether the `identity` is allowed to propose a block in `round`.
/// This is dependent on the type of round and whether `identity` is a validator or (super)owner.
pub fn can_propose(&self, identity: &Owner, round: Round) -> bool {
match round {
Round::Fast => self.ownership.super_owners.contains(identity),
Round::MultiLeader(_) => true,
Round::SingleLeader(_) | Round::Validator(_) => self.leader.as_ref() == Some(identity),
}
}
/// Returns whether a proposal with this content was already handled.
pub fn already_handled_proposal(&self, round: Round, block: &ProposedBlock) -> bool {
self.requested_proposed.as_ref().is_some_and(|proposal| {
proposal.content.round == round && proposal.content.block == *block
})
}
/// Returns whether there is a locking block in the current round.
pub fn has_locking_block_in_current_round(&self) -> bool {
self.requested_locking
.as_ref()
.is_some_and(|locking| locking.round() == self.current_round)
}
}