mirror of
https://github.com/sigp/lighthouse.git
synced 2026-03-10 04:01:51 +00:00
53e73fa376
Part of a fork-choice tech debt clean-up https://github.com/sigp/lighthouse/issues/8325 https://github.com/sigp/lighthouse/issues/7089 (non-finalized checkpoint sync) changes the meaning of the checkpoints inside fork-choice. It turns out that we persist the justified and finalized checkpoints **twice** in fork-choice 1. Inside the fork-choice store 2. Inside the proto-array There's no reason for 2. except for making the function signature of some methods smallers. It's not consistent with the rest of the crate, because in some functions we pass the external variable of time (current_slot) via args, but then read the finalized checkpoint from the internal state. Passing both variables as args makes fork-choice easier to reason about at the cost of a few extra lines. Remove the unnecessary state (`justified_checkpoint`, `finalized_checkpoint`) inside `ProtoArray`, to make it easier to reason about. Co-Authored-By: dapplion <35266934+dapplion@users.noreply.github.com> Co-Authored-By: Michael Sproul <michaelsproul@users.noreply.github.com>
107 lines
3.4 KiB
Rust
107 lines
3.4 KiB
Rust
use crate::proto_array::ProposerBoost;
|
|
use crate::{
|
|
Error, JustifiedBalances,
|
|
proto_array::{ProtoArray, ProtoNodeV17},
|
|
proto_array_fork_choice::{ElasticList, ProtoArrayForkChoice, VoteTracker},
|
|
};
|
|
use ssz::{Encode, four_byte_option_impl};
|
|
use ssz_derive::{Decode, Encode};
|
|
use std::collections::HashMap;
|
|
use superstruct::superstruct;
|
|
use types::{Checkpoint, Hash256};
|
|
|
|
// Define a "legacy" implementation of `Option<usize>` which uses four bytes for encoding the union
|
|
// selector.
|
|
four_byte_option_impl!(four_byte_option_checkpoint, Checkpoint);
|
|
|
|
pub type SszContainer = SszContainerV28;
|
|
|
|
#[superstruct(
|
|
variants(V17, V28),
|
|
variant_attributes(derive(Encode, Decode, Clone)),
|
|
no_enum
|
|
)]
|
|
pub struct SszContainer {
|
|
pub votes: Vec<VoteTracker>,
|
|
#[superstruct(only(V17))]
|
|
pub balances: Vec<u64>,
|
|
pub prune_threshold: usize,
|
|
// Deprecated, remove in a future schema migration
|
|
justified_checkpoint: Checkpoint,
|
|
// Deprecated, remove in a future schema migration
|
|
finalized_checkpoint: Checkpoint,
|
|
pub nodes: Vec<ProtoNodeV17>,
|
|
pub indices: Vec<(Hash256, usize)>,
|
|
pub previous_proposer_boost: ProposerBoost,
|
|
}
|
|
|
|
impl SszContainer {
|
|
pub fn from_proto_array(
|
|
from: &ProtoArrayForkChoice,
|
|
justified_checkpoint: Checkpoint,
|
|
finalized_checkpoint: Checkpoint,
|
|
) -> Self {
|
|
let proto_array = &from.proto_array;
|
|
|
|
Self {
|
|
votes: from.votes.0.clone(),
|
|
prune_threshold: proto_array.prune_threshold,
|
|
justified_checkpoint,
|
|
finalized_checkpoint,
|
|
nodes: proto_array.nodes.clone(),
|
|
indices: proto_array.indices.iter().map(|(k, v)| (*k, *v)).collect(),
|
|
previous_proposer_boost: proto_array.previous_proposer_boost,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl TryFrom<(SszContainer, JustifiedBalances)> for ProtoArrayForkChoice {
|
|
type Error = Error;
|
|
|
|
fn try_from((from, balances): (SszContainer, JustifiedBalances)) -> Result<Self, Error> {
|
|
let proto_array = ProtoArray {
|
|
prune_threshold: from.prune_threshold,
|
|
nodes: from.nodes,
|
|
indices: from.indices.into_iter().collect::<HashMap<_, _>>(),
|
|
previous_proposer_boost: from.previous_proposer_boost,
|
|
};
|
|
|
|
Ok(Self {
|
|
proto_array,
|
|
votes: ElasticList(from.votes),
|
|
balances,
|
|
})
|
|
}
|
|
}
|
|
|
|
// Convert V17 to V28 by dropping balances.
|
|
impl From<SszContainerV17> for SszContainerV28 {
|
|
fn from(v17: SszContainerV17) -> Self {
|
|
Self {
|
|
votes: v17.votes,
|
|
prune_threshold: v17.prune_threshold,
|
|
justified_checkpoint: v17.justified_checkpoint,
|
|
finalized_checkpoint: v17.finalized_checkpoint,
|
|
nodes: v17.nodes,
|
|
indices: v17.indices,
|
|
previous_proposer_boost: v17.previous_proposer_boost,
|
|
}
|
|
}
|
|
}
|
|
|
|
// Convert V28 to V17 by re-adding balances.
|
|
impl From<(SszContainerV28, JustifiedBalances)> for SszContainerV17 {
|
|
fn from((v28, balances): (SszContainerV28, JustifiedBalances)) -> Self {
|
|
Self {
|
|
votes: v28.votes,
|
|
balances: balances.effective_balances.clone(),
|
|
prune_threshold: v28.prune_threshold,
|
|
justified_checkpoint: v28.justified_checkpoint,
|
|
finalized_checkpoint: v28.finalized_checkpoint,
|
|
nodes: v28.nodes,
|
|
indices: v28.indices,
|
|
previous_proposer_boost: v28.previous_proposer_boost,
|
|
}
|
|
}
|
|
}
|