cerc-io/lighthouse
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Tidy comments

Browse Source
This commit is contained in:
Paul Hauner 2019-08-10 17:36:53 +10:00
parent 1beab66078
commit 963fb7bc87
No known key found for this signature in database
GPG Key ID: 303E4494BB28068C
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
beacon_node/beacon_chain/src/beacon_chain.rs
View File

@ -506,8 +506,16 @@ impl<T: BeaconChainTypes> BeaconChain<T> {
/// Accept a new, potentially invalid attestation from the network. /// Accept a new, potentially invalid attestation from the network.
/// ///
/// If valid, the attestation is added to the `op_pool` and aggregated with another attestation /// If valid, the attestation is added to `self.op_pool` and `self.fork_choice`.
/// if possible. ///
/// Returns an `Ok(AttestationProcessingOutcome)` if the chain was able to make a determination
/// about the `attestation` (wether it was invalid or not). Returns an `Err` if the was an
/// error during this process and no determination was able to be made.
///
/// ## Notes
///
/// - Whilst the `attestation` is added to fork choice, the head is not updated. That must be
/// done separately.
pub fn process_attestation( pub fn process_attestation(
&self, &self,
attestation: Attestation<T::EthSpec>, attestation: Attestation<T::EthSpec>,
@ -538,6 +546,9 @@ impl<T: BeaconChainTypes> BeaconChain<T> {
// the block doesn't necessarily need to be in the same epoch as the attestation // the block doesn't necessarily need to be in the same epoch as the attestation
// (e.g., if there are skip slots between the epoch the block was created in and // (e.g., if there are skip slots between the epoch the block was created in and
// the epoch for the attestation). // the epoch for the attestation).
//
// This check also ensures that the slot for `data.beacon_block_root` is not higher
// than `state.root` by ensuring that the block is in the history of `state`.
if state.current_epoch() == attestation.data.target.epoch if state.current_epoch() == attestation.data.target.epoch
&& (attestation.data.beacon_block_root == self.head().beacon_block_root && (attestation.data.beacon_block_root == self.head().beacon_block_root
|| state || state
@ -638,9 +649,8 @@ impl<T: BeaconChainTypes> BeaconChain<T> {
/// ///
/// - `state` corresponds to the `block.state_root` identified by /// - `state` corresponds to the `block.state_root` identified by
/// `attestation.data.beacon_block_root`. (Viz., `attestation` was created using `state`. /// `attestation.data.beacon_block_root`. (Viz., `attestation` was created using `state`.
/// - `state.slot` is in the same epoch as `block.slot` and /// - `state.slot` is in the same epoch as `data.target.epoch` and
/// `attestation.data.beacon_block_root` is in `state.block_roots`. (Viz., the attestation was /// `attestation.data.beacon_block_root` is in the history of `state`.
/// attesting to an ancestor of `state` from the same epoch as `state`.
/// ///
/// Additionally, `attestation.data.beacon_block_root` **must** be available to read in /// Additionally, `attestation.data.beacon_block_root` **must** be available to read in
/// `self.store` _and_ be the root of the given `block`. /// `self.store` _and_ be the root of the given `block`.