#[cfg(test)]
use std::iter;
use std::{
array::TryFromSliceError,
error::Error as StdError,
fmt::{self, Debug, Display, Formatter},
hash::Hash,
};
use blake2::{
digest::{Update, VariableOutput},
VarBlake2b,
};
use datasize::DataSize;
use hex::FromHexError;
use hex_fmt::{HexFmt, HexList};
#[cfg(test)]
use rand::Rng;
use serde::{Deserialize, Serialize};
use thiserror::Error;
#[cfg(test)]
use casper_types::auction::BLOCK_REWARD;
use super::{Item, Tag, Timestamp};
use crate::{
components::{
consensus::{self, EraId},
storage::{Value, WithBlockHeight},
},
crypto::{
asymmetric_key::{PublicKey, Signature},
hash::{self, Digest},
},
types::DeployHash,
utils::DisplayIter,
};
#[cfg(test)]
use crate::{
crypto::asymmetric_key::{self, SecretKey},
testing::TestRng,
};
#[derive(Debug, Error)]
pub enum Error {
#[error("encoding to JSON: {0}")]
EncodeToJson(#[from] serde_json::Error),
#[error("decoding from JSON: {0}")]
DecodeFromJson(Box<dyn StdError>),
}
impl From<FromHexError> for Error {
fn from(error: FromHexError) -> Self {
Error::DecodeFromJson(Box::new(error))
}
}
impl From<TryFromSliceError> for Error {
fn from(error: TryFromSliceError) -> Self {
Error::DecodeFromJson(Box::new(error))
}
}
pub trait BlockLike: Eq + Hash {
fn deploys(&self) -> &Vec<DeployHash>;
}
#[derive(
Copy,
Clone,
DataSize,
Ord,
PartialOrd,
Eq,
PartialEq,
Hash,
Serialize,
Deserialize,
Debug,
Default,
)]
pub struct ProtoBlockHash(Digest);
impl ProtoBlockHash {
pub fn new(hash: Digest) -> Self {
ProtoBlockHash(hash)
}
pub fn from_parts(deploys: &[DeployHash], random_bit: bool) -> Self {
ProtoBlockHash::new(hash::hash(
&bincode::serialize(&(deploys, random_bit)).expect("serialize ProtoBlock"),
))
}
pub fn inner(&self) -> &Digest {
&self.0
}
pub(crate) fn is_empty(self) -> bool {
self == ProtoBlock::empty_random_bit_false() || self == ProtoBlock::empty_random_bit_true()
}
}
impl Display for ProtoBlockHash {
fn fmt(&self, formatter: &mut Formatter) -> fmt::Result {
write!(formatter, "proto-block-hash({})", self.0)
}
}
#[derive(Clone, DataSize, Debug, PartialOrd, Ord, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct ProtoBlock {
hash: ProtoBlockHash,
deploys: Vec<DeployHash>,
random_bit: bool,
}
impl ProtoBlock {
pub(crate) fn new(deploys: Vec<DeployHash>, random_bit: bool) -> Self {
let hash = ProtoBlockHash::new(hash::hash(
&bincode::serialize(&(&deploys, random_bit)).expect("serialize ProtoBlock"),
));
ProtoBlock {
hash,
deploys,
random_bit,
}
}
pub(crate) fn hash(&self) -> &ProtoBlockHash {
&self.hash
}
pub(crate) fn deploys(&self) -> &Vec<DeployHash> {
&self.deploys
}
pub(crate) fn random_bit(&self) -> bool {
self.random_bit
}
pub(crate) fn destructure(self) -> (ProtoBlockHash, Vec<DeployHash>, bool) {
(self.hash, self.deploys, self.random_bit)
}
pub(crate) fn empty_random_bit_false() -> ProtoBlockHash {
*ProtoBlock::new(vec![], false).hash()
}
pub(crate) fn empty_random_bit_true() -> ProtoBlockHash {
*ProtoBlock::new(vec![], true).hash()
}
}
impl Display for ProtoBlock {
fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result {
write!(
formatter,
"proto block {}, deploys [{}], random bit {}",
self.hash.inner(),
DisplayIter::new(self.deploys.iter()),
self.random_bit(),
)
}
}
impl BlockLike for ProtoBlock {
fn deploys(&self) -> &Vec<DeployHash> {
self.deploys()
}
}
pub type EraEnd = consensus::EraEnd<PublicKey>;
impl Display for EraEnd {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
let slashings = DisplayIter::new(&self.equivocators);
let rewards = DisplayIter::new(
self.rewards
.iter()
.map(|(public_key, amount)| format!("{}: {}", public_key, amount)),
);
write!(f, "era end: slash {}, reward {}", slashings, rewards)
}
}
#[derive(Clone, DataSize, Debug, PartialOrd, Ord, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct FinalizedBlock {
proto_block: ProtoBlock,
timestamp: Timestamp,
era_end: Option<EraEnd>,
era_id: EraId,
height: u64,
proposer: PublicKey,
}
impl FinalizedBlock {
pub(crate) fn new(
proto_block: ProtoBlock,
timestamp: Timestamp,
era_end: Option<EraEnd>,
era_id: EraId,
height: u64,
proposer: PublicKey,
) -> Self {
FinalizedBlock {
proto_block,
timestamp,
era_end,
era_id,
height,
proposer,
}
}
pub(crate) fn proto_block(&self) -> &ProtoBlock {
&self.proto_block
}
pub(crate) fn timestamp(&self) -> Timestamp {
self.timestamp
}
pub(crate) fn era_end(&self) -> &Option<EraEnd> {
&self.era_end
}
pub(crate) fn era_id(&self) -> EraId {
self.era_id
}
pub(crate) fn height(&self) -> u64 {
self.height
}
pub(crate) fn is_genesis_child(&self) -> bool {
self.era_id() == EraId(0) && self.height() == 0
}
pub(crate) fn proposer(&self) -> PublicKey {
self.proposer
}
#[cfg(test)]
pub fn random(rng: &mut TestRng) -> Self {
let deploy_count = rng.gen_range(0, 11);
let deploy_hashes = iter::repeat_with(|| DeployHash::new(Digest::random(rng)))
.take(deploy_count)
.collect();
let random_bit = rng.gen();
let proto_block = ProtoBlock::new(deploy_hashes, random_bit);
let timestamp = Timestamp::now();
let era_end = if rng.gen_bool(0.1) {
let equivocators_count = rng.gen_range(0, 5);
let rewards_count = rng.gen_range(0, 5);
Some(EraEnd {
equivocators: iter::repeat_with(|| {
PublicKey::from(&SecretKey::new_ed25519(rng.gen()))
})
.take(equivocators_count)
.collect(),
rewards: iter::repeat_with(|| {
let pub_key = PublicKey::from(&SecretKey::new_ed25519(rng.gen()));
let reward = rng.gen_range(1, BLOCK_REWARD + 1);
(pub_key, reward)
})
.take(rewards_count)
.collect(),
})
} else {
None
};
let era = rng.gen_range(0, 5);
let secret_key: SecretKey = SecretKey::new_ed25519(rng.gen());
let public_key = PublicKey::from(&secret_key);
FinalizedBlock::new(
proto_block,
timestamp,
era_end,
EraId(era),
era * 10 + rng.gen_range(0, 10),
public_key,
)
}
}
impl From<BlockHeader> for FinalizedBlock {
fn from(header: BlockHeader) -> Self {
let proto_block = ProtoBlock::new(header.deploy_hashes().clone(), header.random_bit);
FinalizedBlock {
proto_block,
timestamp: header.timestamp,
era_end: header.era_end,
era_id: header.era_id,
height: header.height,
proposer: header.proposer,
}
}
}
impl Display for FinalizedBlock {
fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result {
write!(
formatter,
"finalized block {:10} in era {:?}, height {}, deploys {:10}, random bit {}, \
timestamp {}",
HexFmt(self.proto_block.hash().inner()),
self.era_id,
self.height,
HexList(&self.proto_block.deploys),
self.proto_block.random_bit,
self.timestamp,
)?;
if let Some(ee) = &self.era_end {
write!(formatter, ", era_end: {}", ee)?;
}
Ok(())
}
}
#[derive(
Copy, Clone, DataSize, Ord, PartialOrd, Eq, PartialEq, Hash, Serialize, Deserialize, Debug,
)]
pub struct BlockHash(Digest);
impl BlockHash {
pub fn new(hash: Digest) -> Self {
BlockHash(hash)
}
pub fn inner(&self) -> &Digest {
&self.0
}
}
impl Display for BlockHash {
fn fmt(&self, formatter: &mut Formatter) -> fmt::Result {
write!(formatter, "block-hash({})", self.0,)
}
}
impl From<Digest> for BlockHash {
fn from(digest: Digest) -> Self {
Self(digest)
}
}
impl AsRef<[u8]> for BlockHash {
fn as_ref(&self) -> &[u8] {
self.0.as_ref()
}
}
#[derive(Clone, DataSize, Ord, PartialOrd, Eq, PartialEq, Hash, Serialize, Deserialize, Debug)]
pub struct BlockHeader {
parent_hash: BlockHash,
state_root_hash: Digest,
body_hash: Digest,
deploy_hashes: Vec<DeployHash>,
random_bit: bool,
accumulated_seed: Digest,
era_end: Option<EraEnd>,
timestamp: Timestamp,
era_id: EraId,
height: u64,
proposer: PublicKey,
}
impl BlockHeader {
pub fn parent_hash(&self) -> &BlockHash {
&self.parent_hash
}
pub fn state_root_hash(&self) -> &Digest {
&self.state_root_hash
}
pub fn body_hash(&self) -> &Digest {
&self.body_hash
}
pub fn deploy_hashes(&self) -> &Vec<DeployHash> {
&self.deploy_hashes
}
pub fn random_bit(&self) -> bool {
self.random_bit
}
pub fn accumulated_seed(&self) -> Digest {
self.accumulated_seed
}
pub fn timestamp(&self) -> Timestamp {
self.timestamp
}
pub fn era_end(&self) -> Option<&EraEnd> {
self.era_end.as_ref()
}
pub fn switch_block(&self) -> bool {
self.era_end.is_some()
}
pub fn era_id(&self) -> EraId {
self.era_id
}
pub fn height(&self) -> u64 {
self.height
}
pub fn proposer(&self) -> &PublicKey {
&self.proposer
}
pub(crate) fn is_genesis_child(&self) -> bool {
self.era_id() == EraId(0) && self.height() == 0
}
fn serialize(&self) -> Result<Vec<u8>, bincode::Error> {
bincode::serialize(self)
}
pub fn hash(&self) -> BlockHash {
let serialized_header = Self::serialize(&self)
.unwrap_or_else(|error| panic!("should serialize block header: {}", error));
BlockHash::new(hash::hash(&serialized_header))
}
}
impl Display for BlockHeader {
fn fmt(&self, formatter: &mut Formatter) -> fmt::Result {
write!(
formatter,
"block header parent hash {}, post-state hash {}, body hash {}, deploys [{}], \
random bit {}, accumulated seed {}, timestamp {}",
self.parent_hash.inner(),
self.state_root_hash,
self.body_hash,
DisplayIter::new(self.deploy_hashes.iter()),
self.random_bit,
self.accumulated_seed,
self.timestamp,
)?;
if let Some(ee) = &self.era_end {
write!(formatter, ", era_end: {}", ee)?;
}
Ok(())
}
}
#[derive(Debug)]
pub enum BlockValidationError {
SerializationError(bincode::Error),
UnexpectedBodyHash {
expected_by_block_header: Digest,
actual: Digest,
},
UnexpectedBlockHash {
expected_by_block: BlockHash,
actual: BlockHash,
},
}
impl Display for BlockValidationError {
fn fmt(&self, formatter: &mut Formatter) -> fmt::Result {
write!(formatter, "{:?}", self)
}
}
impl From<bincode::Error> for BlockValidationError {
fn from(err: bincode::Error) -> Self {
BlockValidationError::SerializationError(err)
}
}
#[derive(DataSize, Clone, Debug, PartialOrd, Ord, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Block {
hash: BlockHash,
header: BlockHeader,
body: (),
proofs: Vec<Signature>,
}
impl Block {
pub(crate) fn new(
parent_hash: BlockHash,
parent_seed: Digest,
state_root_hash: Digest,
finalized_block: FinalizedBlock,
) -> Self {
let body = ();
let serialized_body = Self::serialize_body(&body)
.unwrap_or_else(|error| panic!("should serialize block body: {}", error));
let body_hash = hash::hash(&serialized_body);
let era_id = finalized_block.era_id();
let height = finalized_block.height();
let mut accumulated_seed = [0; Digest::LENGTH];
let mut hasher = VarBlake2b::new(Digest::LENGTH).expect("should create hasher");
hasher.update(parent_seed);
hasher.update([finalized_block.proto_block.random_bit as u8]);
hasher.finalize_variable(|slice| {
accumulated_seed.copy_from_slice(slice);
});
let header = BlockHeader {
parent_hash,
state_root_hash,
body_hash,
deploy_hashes: finalized_block.proto_block.deploys,
random_bit: finalized_block.proto_block.random_bit,
accumulated_seed: accumulated_seed.into(),
era_end: finalized_block.era_end,
timestamp: finalized_block.timestamp,
era_id,
height,
proposer: finalized_block.proposer,
};
let hash = header.hash();
Block {
hash,
header,
body,
proofs: vec![],
}
}
pub(crate) fn header(&self) -> &BlockHeader {
&self.header
}
pub(crate) fn take_header(self) -> BlockHeader {
self.header
}
pub fn hash(&self) -> &BlockHash {
&self.hash
}
pub(crate) fn state_root_hash(&self) -> &Digest {
self.header.state_root_hash()
}
pub fn deploy_hashes(&self) -> &Vec<DeployHash> {
self.header.deploy_hashes()
}
pub fn height(&self) -> u64 {
self.header.height()
}
pub(crate) fn append_proof(&mut self, proof: Signature) {
self.proofs.push(proof)
}
fn serialize_body(body: &()) -> Result<Vec<u8>, bincode::Error> {
bincode::serialize(body)
}
pub fn verify(&self) -> Result<(), BlockValidationError> {
let serialized_body = Block::serialize_body(&self.body)?;
let actual_body_hash = hash::hash(&serialized_body);
if self.header.body_hash != actual_body_hash {
return Err(BlockValidationError::UnexpectedBodyHash {
expected_by_block_header: self.header.body_hash,
actual: actual_body_hash,
});
}
let actual_header_hash = self.header.hash();
if self.hash != actual_header_hash {
return Err(BlockValidationError::UnexpectedBlockHash {
expected_by_block: self.hash,
actual: actual_header_hash,
});
}
Ok(())
}
#[cfg(test)]
pub fn random(rng: &mut TestRng) -> Self {
let parent_hash = BlockHash::new(Digest::random(rng));
let state_root_hash = Digest::random(rng);
let finalized_block = FinalizedBlock::random(rng);
let parent_seed = Digest::random(rng);
let mut block = Block::new(parent_hash, parent_seed, state_root_hash, finalized_block);
let signatures_count = rng.gen_range(0, 11);
for _ in 0..signatures_count {
let secret_key = SecretKey::random(rng);
let public_key = PublicKey::from(&secret_key);
let signature = asymmetric_key::sign(block.hash.inner(), &secret_key, &public_key, rng);
block.append_proof(signature);
}
block
}
}
impl Display for Block {
fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result {
write!(
formatter,
"executed block {}, parent hash {}, post-state hash {}, body hash {}, deploys [{}], \
random bit {}, timestamp {}, era_id {}, height {}, proofs count {}",
self.hash.inner(),
self.header.parent_hash.inner(),
self.header.state_root_hash,
self.header.body_hash,
DisplayIter::new(self.header.deploy_hashes.iter()),
self.header.random_bit,
self.header.timestamp,
self.header.era_id.0,
self.header.height,
self.proofs.len()
)?;
if let Some(ee) = &self.header.era_end {
write!(formatter, ", era_end: {}", ee)?;
}
Ok(())
}
}
impl BlockLike for Block {
fn deploys(&self) -> &Vec<DeployHash> {
self.deploy_hashes()
}
}
impl BlockLike for BlockHeader {
fn deploys(&self) -> &Vec<DeployHash> {
self.deploy_hashes()
}
}
impl Value for Block {
type Id = BlockHash;
type Header = BlockHeader;
fn id(&self) -> &Self::Id {
&self.hash
}
fn header(&self) -> &Self::Header {
&self.header
}
fn take_header(self) -> Self::Header {
self.header
}
}
impl WithBlockHeight for Block {
fn height(&self) -> u64 {
self.height()
}
}
impl Item for Block {
type Id = BlockHash;
const TAG: Tag = Tag::Block;
const ID_IS_COMPLETE_ITEM: bool = false;
fn id(&self) -> Self::Id {
*self.hash()
}
}
#[derive(Clone, Debug, PartialOrd, Ord, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum BlockByHeight {
Absent(u64),
Block(Box<Block>),
}
impl From<Block> for BlockByHeight {
fn from(block: Block) -> Self {
BlockByHeight::new(block)
}
}
impl BlockByHeight {
pub fn new(block: Block) -> Self {
BlockByHeight::Block(Box::new(block))
}
pub fn height(&self) -> u64 {
match self {
BlockByHeight::Absent(height) => *height,
BlockByHeight::Block(block) => block.height(),
}
}
}
impl Display for BlockByHeight {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
match self {
BlockByHeight::Absent(height) => write!(f, "Block at height {} was absent.", height),
BlockByHeight::Block(block) => {
let hash: BlockHash = block.header().hash();
write!(f, "Block at {} with hash {} found.", block.height(), hash)
}
}
}
}
impl Item for BlockByHeight {
type Id = u64;
const TAG: Tag = Tag::BlockByHeight;
const ID_IS_COMPLETE_ITEM: bool = false;
fn id(&self) -> Self::Id {
self.height()
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::testing::TestRng;
#[test]
fn json_block_roundtrip() {
let mut rng = TestRng::new();
let block = Block::random(&mut rng);
let json_string = serde_json::to_string_pretty(&block).unwrap();
let decoded = serde_json::from_str(&json_string).unwrap();
assert_eq!(block, decoded);
}
#[test]
fn json_finalized_block_roundtrip() {
let mut rng = TestRng::new();
let finalized_block = FinalizedBlock::random(&mut rng);
let json_string = serde_json::to_string_pretty(&finalized_block).unwrap();
let decoded = serde_json::from_str(&json_string).unwrap();
assert_eq!(finalized_block, decoded);
}
#[test]
fn random_block_check() {
let mut rng = TestRng::from_seed([1u8; 16]);
let loop_iterations = 50;
for _ in 0..loop_iterations {
Block::random(&mut rng)
.verify()
.expect("block hash should check");
}
}
#[test]
fn block_check_bad_body_hash_sad_path() {
let mut rng = TestRng::from_seed([2u8; 16]);
let mut block = Block::random(&mut rng);
let bogus_block_hash = hash::hash(&[0xde, 0xad, 0xbe, 0xef]);
block.header.body_hash = bogus_block_hash;
let serialized_body =
Block::serialize_body(&block.body).expect("Could not serialize block body");
let actual_body_hash = hash::hash(&serialized_body);
match block.verify() {
Err(BlockValidationError::UnexpectedBodyHash {
expected_by_block_header,
actual,
}) if expected_by_block_header == bogus_block_hash && actual == actual_body_hash => {}
unexpected => panic!("Bad check response: {:?}", unexpected),
}
}
#[test]
fn block_check_bad_block_hash_sad_path() {
let mut rng = TestRng::from_seed([3u8; 16]);
let mut block = Block::random(&mut rng);
let bogus_block_hash: BlockHash = hash::hash(&[0xde, 0xad, 0xbe, 0xef]).into();
block.hash = bogus_block_hash;
let actual_block_hash = block.header.hash();
match block.verify() {
Err(BlockValidationError::UnexpectedBlockHash {
expected_by_block,
actual,
}) if expected_by_block == bogus_block_hash && actual == actual_block_hash => {}
unexpected => panic!("Bad check response: {:?}", unexpected),
}
}
}