Fix some typos (#4565)

This commit is contained in:
zhiqiangxu 2023-08-14 00:29:43 +00:00
parent 1fcada8a32
commit f1ac12f23a
9 changed files with 13 additions and 16 deletions

View File

@ -164,7 +164,7 @@ pub enum WhenSlotSkipped {
/// ///
/// This is how the HTTP API behaves. /// This is how the HTTP API behaves.
None, None,
/// If the slot it a skip slot, return the previous non-skipped block. /// If the slot is a skip slot, return the previous non-skipped block.
/// ///
/// This is generally how the specification behaves. /// This is generally how the specification behaves.
Prev, Prev,

View File

@ -135,7 +135,7 @@ impl BeaconProposerCache {
/// Compute the proposer duties using the head state without cache. /// Compute the proposer duties using the head state without cache.
pub fn compute_proposer_duties_from_head<T: BeaconChainTypes>( pub fn compute_proposer_duties_from_head<T: BeaconChainTypes>(
current_epoch: Epoch, request_epoch: Epoch,
chain: &BeaconChain<T>, chain: &BeaconChain<T>,
) -> Result<(Vec<usize>, Hash256, ExecutionStatus, Fork), BeaconChainError> { ) -> Result<(Vec<usize>, Hash256, ExecutionStatus, Fork), BeaconChainError> {
// Atomically collect information about the head whilst holding the canonical head `Arc` as // Atomically collect information about the head whilst holding the canonical head `Arc` as
@ -159,7 +159,7 @@ pub fn compute_proposer_duties_from_head<T: BeaconChainTypes>(
.ok_or(BeaconChainError::HeadMissingFromForkChoice(head_block_root))?; .ok_or(BeaconChainError::HeadMissingFromForkChoice(head_block_root))?;
// Advance the state into the requested epoch. // Advance the state into the requested epoch.
ensure_state_is_in_epoch(&mut state, head_state_root, current_epoch, &chain.spec)?; ensure_state_is_in_epoch(&mut state, head_state_root, request_epoch, &chain.spec)?;
let indices = state let indices = state
.get_beacon_proposer_indices(&chain.spec) .get_beacon_proposer_indices(&chain.spec)

View File

@ -76,7 +76,7 @@ const DEFAULT_SUGGESTED_FEE_RECIPIENT: [u8; 20] =
/// A payload alongside some information about where it came from. /// A payload alongside some information about where it came from.
pub enum ProvenancedPayload<P> { pub enum ProvenancedPayload<P> {
/// A good ol' fashioned farm-to-table payload from your local EE. /// A good old fashioned farm-to-table payload from your local EE.
Local(P), Local(P),
/// A payload from a builder (e.g. mev-boost). /// A payload from a builder (e.g. mev-boost).
Builder(P), Builder(P),

View File

@ -1426,10 +1426,10 @@ pub fn serve<T: BeaconChainTypes>(
); );
/* /*
* beacon/blocks * beacon/blinded_blocks
*/ */
// POST beacon/blocks // POST beacon/blinded_blocks
let post_beacon_blinded_blocks = eth_v1 let post_beacon_blinded_blocks = eth_v1
.and(warp::path("beacon")) .and(warp::path("beacon"))
.and(warp::path("blinded_blocks")) .and(warp::path("blinded_blocks"))
@ -3208,7 +3208,7 @@ pub fn serve<T: BeaconChainTypes>(
}, },
); );
// POST validator/duties/sync // POST validator/duties/sync/{epoch}
let post_validator_duties_sync = eth_v1 let post_validator_duties_sync = eth_v1
.and(warp::path("validator")) .and(warp::path("validator"))
.and(warp::path("duties")) .and(warp::path("duties"))

View File

@ -12,7 +12,7 @@ struct Initialization {
#[derive(Debug, Clone, Default)] #[derive(Debug, Clone, Default)]
pub struct RewardCache { pub struct RewardCache {
initialization: Option<Initialization>, initialization: Option<Initialization>,
/// `BitVec` of validator indices which don't have default participation flags for the prev. epoch. /// `BitVec` of validator indices which don't have default participation flags for the prev epoch.
/// ///
/// We choose to only track whether validators have *any* participation flag set because /// We choose to only track whether validators have *any* participation flag set because
/// it's impossible to include a new attestation which is better than the existing participation /// it's impossible to include a new attestation which is better than the existing participation

View File

@ -466,13 +466,10 @@ where
// for lower slots to account for skip slots. // for lower slots to account for skip slots.
.find(|(_, slot)| *slot <= ancestor_slot) .find(|(_, slot)| *slot <= ancestor_slot)
.map(|(root, _)| root)), .map(|(root, _)| root)),
Ordering::Less => Ok(Some(block_root)),
Ordering::Equal =>
// Root is older than queried slot, thus a skip slot. Return most recent root prior // Root is older than queried slot, thus a skip slot. Return most recent root prior
// to slot. // to slot.
{ Ordering::Less => Ok(Some(block_root)),
Ok(Some(block_root)) Ordering::Equal => Ok(Some(block_root)),
}
} }
} }

View File

@ -910,7 +910,7 @@ impl ProtoArray {
Ok(()) Ok(())
} }
/// Indicates if the node itself is viable for the head, or if it's best descendant is viable /// Indicates if the node itself is viable for the head, or if its best descendant is viable
/// for the head. /// for the head.
fn node_leads_to_viable_head<E: EthSpec>( fn node_leads_to_viable_head<E: EthSpec>(
&self, &self,

View File

@ -1021,7 +1021,7 @@ async fn fill_in_selection_proofs<T: SlotClock + 'static, E: EthSpec>(
/// 2. We won't miss a block if the duties for the current slot happen to change with this poll. /// 2. We won't miss a block if the duties for the current slot happen to change with this poll.
/// ///
/// This sounds great, but is it safe? Firstly, the additional notification will only contain block /// This sounds great, but is it safe? Firstly, the additional notification will only contain block
/// producers that were not included in the first notification. This should be safety enough. /// producers that were not included in the first notification. This should be safe enough.
/// However, we also have the slashing protection as a second line of defence. These two factors /// However, we also have the slashing protection as a second line of defence. These two factors
/// provide an acceptable level of safety. /// provide an acceptable level of safety.
/// ///

View File

@ -524,7 +524,7 @@ impl<T: EthSpec> ProductionValidatorClient<T> {
pub fn start_service(&mut self) -> Result<(), String> { pub fn start_service(&mut self) -> Result<(), String> {
// We use `SLOTS_PER_EPOCH` as the capacity of the block notification channel, because // We use `SLOTS_PER_EPOCH` as the capacity of the block notification channel, because
// we don't except notifications to be delayed by more than a single slot, let alone a // we don't expect notifications to be delayed by more than a single slot, let alone a
// whole epoch! // whole epoch!
let channel_capacity = T::slots_per_epoch() as usize; let channel_capacity = T::slots_per_epoch() as usize;
let (block_service_tx, block_service_rx) = mpsc::channel(channel_capacity); let (block_service_tx, block_service_rx) = mpsc::channel(channel_capacity);