24e941d175
* Update to spec v0.9.0 * Update to v0.9.1 * Bump spec tags for v0.9.1 * Formatting, fix CI failures * Resolve accidental KeyPair merge conflict * Document new BeaconState functions * Fix incorrect cache drops in `advance_caches` * Update fork choice for v0.9.1 * Clean up some FIXMEs * Fix a few docs/logs
413 lines
17 KiB
Rust
413 lines
17 KiB
Rust
use crate::helpers::{
|
|
check_content_type_for_json, get_beacon_chain_from_request, get_logger_from_request,
|
|
parse_pubkey, publish_attestation_to_network, publish_beacon_block_to_network,
|
|
};
|
|
use crate::response_builder::ResponseBuilder;
|
|
use crate::{ApiError, ApiResult, BoxFut, UrlQuery};
|
|
use beacon_chain::{AttestationProcessingOutcome, BeaconChainTypes, BlockProcessingOutcome};
|
|
use bls::{AggregateSignature, PublicKey, Signature};
|
|
use futures::future::Future;
|
|
use futures::stream::Stream;
|
|
use hyper::{Body, Request};
|
|
use network::NetworkMessage;
|
|
use parking_lot::RwLock;
|
|
use serde::{Deserialize, Serialize};
|
|
use slog::{info, trace, warn};
|
|
use std::sync::Arc;
|
|
use tokio;
|
|
use tokio::sync::mpsc;
|
|
use types::beacon_state::EthSpec;
|
|
use types::{Attestation, BeaconBlock, BitList, CommitteeIndex, Epoch, RelativeEpoch, Slot};
|
|
|
|
#[derive(Debug, Serialize, Deserialize)]
|
|
pub struct ValidatorDuty {
|
|
/// The validator's BLS public key, uniquely identifying them. _48-bytes, hex encoded with 0x prefix, case insensitive._
|
|
pub validator_pubkey: String,
|
|
/// The slot at which the validator must attest.
|
|
pub attestation_slot: Option<Slot>,
|
|
/// The index of the committee within `slot` of which the validator is a member.
|
|
pub attestation_committee_index: Option<CommitteeIndex>,
|
|
/// The slot in which a validator must propose a block, or `null` if block production is not required.
|
|
pub block_proposal_slot: Option<Slot>,
|
|
}
|
|
|
|
impl ValidatorDuty {
|
|
pub fn new() -> ValidatorDuty {
|
|
ValidatorDuty {
|
|
validator_pubkey: "".to_string(),
|
|
attestation_slot: None,
|
|
attestation_committee_index: None,
|
|
block_proposal_slot: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// HTTP Handler to retrieve a the duties for a set of validators during a particular epoch
|
|
pub fn get_validator_duties<T: BeaconChainTypes + 'static>(req: Request<Body>) -> ApiResult {
|
|
let log = get_logger_from_request(&req);
|
|
slog::trace!(log, "Validator duties requested of API: {:?}", &req);
|
|
let beacon_chain = get_beacon_chain_from_request::<T>(&req)?;
|
|
let mut head_state = beacon_chain.head().beacon_state;
|
|
|
|
slog::trace!(log, "Got head state from request.");
|
|
// Parse and check query parameters
|
|
let query = UrlQuery::from_request(&req)?;
|
|
let current_epoch = head_state.current_epoch();
|
|
let epoch = match query.first_of(&["epoch"]) {
|
|
Ok((_, v)) => {
|
|
slog::trace!(log, "Requested epoch {:?}", v);
|
|
Epoch::new(v.parse::<u64>().map_err(|e| {
|
|
slog::info!(log, "Invalid epoch {:?}", e);
|
|
ApiError::BadRequest(format!("Invalid epoch parameter, must be a u64. {:?}", e))
|
|
})?)
|
|
}
|
|
Err(_) => {
|
|
// epoch not supplied, use the current epoch
|
|
slog::info!(log, "Using default epoch {:?}", current_epoch);
|
|
current_epoch
|
|
}
|
|
};
|
|
let relative_epoch = RelativeEpoch::from_epoch(current_epoch, epoch).map_err(|e| {
|
|
slog::info!(log, "Requested epoch out of range.");
|
|
ApiError::BadRequest(format!(
|
|
"Cannot get RelativeEpoch, epoch out of range: {:?}",
|
|
e
|
|
))
|
|
})?;
|
|
let validators: Vec<PublicKey> = query
|
|
.all_of("validator_pubkeys")?
|
|
.iter()
|
|
.map(|pk| parse_pubkey(pk))
|
|
.collect::<Result<Vec<_>, _>>()?;
|
|
let mut duties: Vec<ValidatorDuty> = Vec::new();
|
|
|
|
// Build cache for the requested epoch
|
|
head_state
|
|
.build_committee_cache(relative_epoch, &beacon_chain.spec)
|
|
.map_err(|e| ApiError::ServerError(format!("Unable to build committee cache: {:?}", e)))?;
|
|
// Get a list of all validators for this epoch
|
|
let validator_proposers: Vec<usize> = epoch
|
|
.slot_iter(T::EthSpec::slots_per_epoch())
|
|
.map(|slot| {
|
|
head_state
|
|
.get_beacon_proposer_index(slot, &beacon_chain.spec)
|
|
.map_err(|e| {
|
|
ApiError::ServerError(format!(
|
|
"Unable to get proposer index for validator: {:?}",
|
|
e
|
|
))
|
|
})
|
|
})
|
|
.collect::<Result<Vec<usize>, _>>()?;
|
|
|
|
// Look up duties for each validator
|
|
for val_pk in validators {
|
|
let mut duty = ValidatorDuty::new();
|
|
duty.validator_pubkey = val_pk.as_hex_string();
|
|
|
|
// Get the validator index
|
|
// If it does not exist in the index, just add a null duty and move on.
|
|
let val_index: usize = match head_state.get_validator_index(&val_pk) {
|
|
Ok(Some(i)) => i,
|
|
Ok(None) => {
|
|
duties.append(&mut vec![duty]);
|
|
continue;
|
|
}
|
|
Err(e) => {
|
|
return Err(ApiError::ServerError(format!(
|
|
"Unable to read validator index cache. {:?}",
|
|
e
|
|
)));
|
|
}
|
|
};
|
|
|
|
// Set attestation duties
|
|
match head_state.get_attestation_duties(val_index, relative_epoch) {
|
|
Ok(Some(d)) => {
|
|
duty.attestation_slot = Some(d.slot);
|
|
duty.attestation_committee_index = Some(d.index);
|
|
}
|
|
Ok(None) => {}
|
|
Err(e) => {
|
|
return Err(ApiError::ServerError(format!(
|
|
"unable to read cache for attestation duties: {:?}",
|
|
e
|
|
)))
|
|
}
|
|
};
|
|
|
|
// If the validator is to propose a block, identify the slot
|
|
if let Some(slot) = validator_proposers.iter().position(|&v| val_index == v) {
|
|
duty.block_proposal_slot = Some(Slot::new(
|
|
relative_epoch
|
|
.into_epoch(current_epoch)
|
|
.start_slot(T::EthSpec::slots_per_epoch())
|
|
.as_u64()
|
|
+ slot as u64,
|
|
));
|
|
}
|
|
|
|
duties.append(&mut vec![duty]);
|
|
}
|
|
ResponseBuilder::new(&req)?.body_no_ssz(&duties)
|
|
}
|
|
|
|
/// HTTP Handler to produce a new BeaconBlock from the current state, ready to be signed by a validator.
|
|
pub fn get_new_beacon_block<T: BeaconChainTypes + 'static>(req: Request<Body>) -> ApiResult {
|
|
let beacon_chain = get_beacon_chain_from_request::<T>(&req)?;
|
|
|
|
let query = UrlQuery::from_request(&req)?;
|
|
let slot = query
|
|
.first_of(&["slot"])
|
|
.map(|(_key, value)| value)?
|
|
.parse::<u64>()
|
|
.map(Slot::from)
|
|
.map_err(|e| {
|
|
ApiError::BadRequest(format!("Invalid slot parameter, must be a u64. {:?}", e))
|
|
})?;
|
|
let randao_bytes = query
|
|
.first_of(&["randao_reveal"])
|
|
.map(|(_key, value)| value)
|
|
.map(hex::decode)?
|
|
.map_err(|e| {
|
|
ApiError::BadRequest(format!("Invalid hex string for randao_reveal: {:?}", e))
|
|
})?;
|
|
let randao_reveal = Signature::from_bytes(randao_bytes.as_slice()).map_err(|e| {
|
|
ApiError::BadRequest(format!("randao_reveal is not a valid signature: {:?}", e))
|
|
})?;
|
|
|
|
let (new_block, _state) = beacon_chain
|
|
.produce_block(randao_reveal, slot)
|
|
.map_err(|e| {
|
|
ApiError::ServerError(format!(
|
|
"Beacon node is not able to produce a block: {:?}",
|
|
e
|
|
))
|
|
})?;
|
|
|
|
ResponseBuilder::new(&req)?.body(&new_block)
|
|
}
|
|
|
|
/// HTTP Handler to publish a BeaconBlock, which has been signed by a validator.
|
|
pub fn publish_beacon_block<T: BeaconChainTypes + 'static>(req: Request<Body>) -> BoxFut {
|
|
try_future!(check_content_type_for_json(&req));
|
|
let log = get_logger_from_request(&req);
|
|
let beacon_chain = try_future!(get_beacon_chain_from_request::<T>(&req));
|
|
// Get the network sending channel from the request, for later transmission
|
|
let network_chan = req
|
|
.extensions()
|
|
.get::<Arc<RwLock<mpsc::UnboundedSender<NetworkMessage>>>>()
|
|
.expect("Should always get the network channel from the request, since we put it in there.")
|
|
.clone();
|
|
|
|
let response_builder = ResponseBuilder::new(&req);
|
|
|
|
let body = req.into_body();
|
|
trace!(
|
|
log,
|
|
"Got the request body, now going to parse it into a block."
|
|
);
|
|
Box::new(body
|
|
.concat2()
|
|
.map_err(|e| ApiError::ServerError(format!("Unable to get request body: {:?}",e)))
|
|
.map(|chunk| chunk.iter().cloned().collect::<Vec<u8>>())
|
|
.and_then(|chunks| {
|
|
serde_json::from_slice(&chunks.as_slice()).map_err(|e| {
|
|
ApiError::BadRequest(format!(
|
|
"Unable to deserialize JSON into a BeaconBlock: {:?}",
|
|
e
|
|
))
|
|
})
|
|
})
|
|
.and_then(move |block: BeaconBlock<T::EthSpec>| {
|
|
let slot = block.slot;
|
|
match beacon_chain.process_block(block.clone()) {
|
|
Ok(BlockProcessingOutcome::Processed { block_root }) => {
|
|
// Block was processed, publish via gossipsub
|
|
info!(log, "Processed valid block from API, transmitting to network."; "block_slot" => slot, "block_root" => format!("{}", block_root));
|
|
publish_beacon_block_to_network::<T>(network_chan, block)
|
|
}
|
|
Ok(outcome) => {
|
|
warn!(log, "BeaconBlock could not be processed, but is being sent to the network anyway."; "outcome" => format!("{:?}", outcome));
|
|
publish_beacon_block_to_network::<T>(network_chan, block)?;
|
|
Err(ApiError::ProcessingError(format!(
|
|
"The BeaconBlock could not be processed, but has still been published: {:?}",
|
|
outcome
|
|
)))
|
|
}
|
|
Err(e) => {
|
|
Err(ApiError::ServerError(format!(
|
|
"Error while processing block: {:?}",
|
|
e
|
|
)))
|
|
}
|
|
}
|
|
}).and_then(|_| {
|
|
response_builder?.body_no_ssz(&())
|
|
}))
|
|
}
|
|
|
|
/// HTTP Handler to produce a new Attestation from the current state, ready to be signed by a validator.
|
|
pub fn get_new_attestation<T: BeaconChainTypes + 'static>(req: Request<Body>) -> ApiResult {
|
|
let beacon_chain = get_beacon_chain_from_request::<T>(&req)?;
|
|
let mut head_state = beacon_chain.head().beacon_state;
|
|
|
|
let query = UrlQuery::from_request(&req)?;
|
|
let val_pk_str = query
|
|
.first_of(&["validator_pubkey"])
|
|
.map(|(_key, value)| value)?;
|
|
let val_pk = parse_pubkey(val_pk_str.as_str())?;
|
|
|
|
head_state
|
|
.update_pubkey_cache()
|
|
.map_err(|e| ApiError::ServerError(format!("Unable to build pubkey cache: {:?}", e)))?;
|
|
// Get the validator index from the supplied public key
|
|
// If it does not exist in the index, we cannot continue.
|
|
let val_index = head_state
|
|
.get_validator_index(&val_pk)
|
|
.map_err(|e| {
|
|
ApiError::ServerError(format!("Unable to read validator index cache. {:?}", e))
|
|
})?
|
|
.ok_or_else(|| {
|
|
ApiError::BadRequest(
|
|
"The provided validator public key does not correspond to a validator index."
|
|
.into(),
|
|
)
|
|
})?;
|
|
|
|
// Build cache for the requested epoch
|
|
head_state
|
|
.build_committee_cache(RelativeEpoch::Current, &beacon_chain.spec)
|
|
.map_err(|e| ApiError::ServerError(format!("Unable to build committee cache: {:?}", e)))?;
|
|
// Get the duties of the validator, to make sure they match up.
|
|
// If they don't have duties this epoch, then return an error
|
|
let val_duty = head_state
|
|
.get_attestation_duties(val_index, RelativeEpoch::Current)
|
|
.map_err(|e| {
|
|
ApiError::ServerError(format!(
|
|
"unable to read cache for attestation duties: {:?}",
|
|
e
|
|
))
|
|
})?
|
|
.ok_or_else(|| ApiError::BadRequest("No validator duties could be found for the requested validator. Cannot provide valid attestation.".into()))?;
|
|
|
|
// Check that we are requesting an attestation during the slot where it is relevant.
|
|
let present_slot = beacon_chain.slot().map_err(|e| ApiError::ServerError(
|
|
format!("Beacon node is unable to determine present slot, either the state isn't generated or the chain hasn't begun. {:?}", e)
|
|
))?;
|
|
if val_duty.slot != present_slot {
|
|
return Err(ApiError::BadRequest(format!("Validator is only able to request an attestation during the slot they are allocated. Current slot: {:?}, allocated slot: {:?}", head_state.slot, val_duty.slot)));
|
|
}
|
|
|
|
// Parse the POC bit and insert it into the aggregation bits
|
|
let poc_bit = query
|
|
.first_of(&["poc_bit"])
|
|
.map(|(_key, value)| value)?
|
|
.parse::<bool>()
|
|
.map_err(|e| {
|
|
ApiError::BadRequest(format!("Invalid slot parameter, must be a u64. {:?}", e))
|
|
})?;
|
|
|
|
let mut aggregation_bits = BitList::with_capacity(val_duty.committee_len)
|
|
.expect("An empty BitList should always be created, or we have bigger problems.");
|
|
aggregation_bits
|
|
.set(val_duty.committee_position, poc_bit)
|
|
.map_err(|e| {
|
|
ApiError::ServerError(format!(
|
|
"Unable to set aggregation bits for the attestation: {:?}",
|
|
e
|
|
))
|
|
})?;
|
|
|
|
// Allow a provided slot parameter to check against the expected slot as a sanity check only.
|
|
// Presently, we don't support attestations at future or past slots.
|
|
let requested_slot = query
|
|
.first_of(&["slot"])
|
|
.map(|(_key, value)| value)?
|
|
.parse::<u64>()
|
|
.map(Slot::from)
|
|
.map_err(|e| {
|
|
ApiError::BadRequest(format!("Invalid slot parameter, must be a u64. {:?}", e))
|
|
})?;
|
|
let current_slot = beacon_chain.head().beacon_state.slot.as_u64();
|
|
if requested_slot != current_slot {
|
|
return Err(ApiError::BadRequest(format!("Attestation data can only be requested for the current slot ({:?}), not your requested slot ({:?})", current_slot, requested_slot)));
|
|
}
|
|
|
|
let index = query
|
|
.first_of(&["index"])
|
|
.map(|(_key, value)| value)?
|
|
.parse::<u64>()
|
|
.map_err(|e| ApiError::BadRequest(format!("Index is not a valid u64 value: {:?}", e)))?;
|
|
|
|
let attestation_data = beacon_chain
|
|
.produce_attestation_data(current_slot.into(), index)
|
|
.map_err(|e| ApiError::ServerError(format!("Could not produce an attestation: {:?}", e)))?;
|
|
|
|
let attestation: Attestation<T::EthSpec> = Attestation {
|
|
aggregation_bits,
|
|
data: attestation_data,
|
|
signature: AggregateSignature::new(),
|
|
};
|
|
|
|
ResponseBuilder::new(&req)?.body(&attestation)
|
|
}
|
|
|
|
/// HTTP Handler to publish an Attestation, which has been signed by a validator.
|
|
pub fn publish_attestation<T: BeaconChainTypes + 'static>(req: Request<Body>) -> BoxFut {
|
|
try_future!(check_content_type_for_json(&req));
|
|
let log = get_logger_from_request(&req);
|
|
let beacon_chain = try_future!(get_beacon_chain_from_request::<T>(&req));
|
|
// Get the network sending channel from the request, for later transmission
|
|
let network_chan = req
|
|
.extensions()
|
|
.get::<Arc<RwLock<mpsc::UnboundedSender<NetworkMessage>>>>()
|
|
.expect("Should always get the network channel from the request, since we put it in there.")
|
|
.clone();
|
|
|
|
let response_builder = ResponseBuilder::new(&req);
|
|
|
|
let body = req.into_body();
|
|
trace!(
|
|
log,
|
|
"Got the request body, now going to parse it into an attesation."
|
|
);
|
|
Box::new(body
|
|
.concat2()
|
|
.map_err(|e| ApiError::ServerError(format!("Unable to get request body: {:?}",e)))
|
|
.map(|chunk| chunk.iter().cloned().collect::<Vec<u8>>())
|
|
.and_then(|chunks| {
|
|
serde_json::from_slice(&chunks.as_slice()).map_err(|e| {
|
|
ApiError::BadRequest(format!(
|
|
"Unable to deserialize JSON into a BeaconBlock: {:?}",
|
|
e
|
|
))
|
|
})
|
|
})
|
|
.and_then(move |attestation: Attestation<T::EthSpec>| {
|
|
match beacon_chain.process_attestation(attestation.clone()) {
|
|
Ok(AttestationProcessingOutcome::Processed) => {
|
|
// Block was processed, publish via gossipsub
|
|
info!(log, "Processed valid attestation from API, transmitting to network.");
|
|
publish_attestation_to_network::<T>(network_chan, attestation)
|
|
}
|
|
Ok(outcome) => {
|
|
warn!(log, "Attestation could not be processed, but is being sent to the network anyway."; "outcome" => format!("{:?}", outcome));
|
|
publish_attestation_to_network::<T>(network_chan, attestation)?;
|
|
Err(ApiError::ProcessingError(format!(
|
|
"The Attestation could not be processed, but has still been published: {:?}",
|
|
outcome
|
|
)))
|
|
}
|
|
Err(e) => {
|
|
Err(ApiError::ServerError(format!(
|
|
"Error while processing attestation: {:?}",
|
|
e
|
|
)))
|
|
}
|
|
}
|
|
}).and_then(|_| {
|
|
response_builder?.body_no_ssz(&())
|
|
}))
|
|
}
|