use std::{collections::BTreeSet, fmt::Debug};
use async_graphql::SimpleObject;
use linera_base::{
crypto::{BcsHashable, CryptoHash},
data_types::{BlockHeight, Event, OracleResponse, Timestamp},
hashed::Hashed,
identifiers::{BlobId, BlobType, ChainId, MessageId, Owner},
};
use linera_execution::{committee::Epoch, BlobState, Operation, SystemOperation};
use serde::{ser::SerializeStruct, Deserialize, Serialize};
use thiserror::Error;
use crate::{
data_types::{
BlockExecutionOutcome, ExecutedBlock, IncomingBundle, Medium, MessageBundle,
OutgoingMessage, ProposedBlock,
},
types::CertificateValue,
ChainError,
};
#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
#[serde(transparent)]
pub struct ValidatedBlock(Hashed<Block>);
impl ValidatedBlock {
pub fn new(block: ExecutedBlock) -> Self {
Self(Hashed::new(Block::new(block.block, block.outcome)))
}
pub fn from_hashed(block: Hashed<Block>) -> Self {
Self(block)
}
pub fn inner(&self) -> &Hashed<Block> {
&self.0
}
pub fn block(&self) -> &Block {
self.0.inner()
}
pub fn into_inner(self) -> Block {
self.0.into_inner()
}
pub fn to_log_str(&self) -> &'static str {
"validated_block"
}
pub fn chain_id(&self) -> ChainId {
self.0.inner().header.chain_id
}
pub fn height(&self) -> BlockHeight {
self.0.inner().header.height
}
pub fn epoch(&self) -> Epoch {
self.0.inner().header.epoch
}
}
impl<'de> BcsHashable<'de> for ValidatedBlock {}
#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
#[serde(transparent)]
pub struct ConfirmedBlock(Hashed<Block>);
#[async_graphql::Object(cache_control(no_cache))]
impl ConfirmedBlock {
#[graphql(derived(name = "block"))]
async fn _block(&self) -> Block {
self.0.inner().clone()
}
async fn status(&self) -> String {
"confirmed".to_string()
}
}
impl<'de> BcsHashable<'de> for ConfirmedBlock {}
impl ConfirmedBlock {
pub fn new(block: ExecutedBlock) -> Self {
Self(Hashed::new(Block::new(block.block, block.outcome)))
}
pub fn from_hashed(block: Hashed<Block>) -> Self {
Self(block)
}
pub fn inner(&self) -> &Hashed<Block> {
&self.0
}
pub fn into_inner(self) -> Hashed<Block> {
self.0
}
pub fn block(&self) -> &Block {
self.0.inner()
}
pub fn into_block(self) -> Block {
self.0.into_inner()
}
pub fn chain_id(&self) -> ChainId {
self.0.inner().header.chain_id
}
pub fn height(&self) -> BlockHeight {
self.0.inner().header.height
}
pub fn to_log_str(&self) -> &'static str {
"confirmed_block"
}
pub fn with_hash_unchecked(self, hash: CryptoHash) -> Hashed<ConfirmedBlock> {
Hashed::unchecked_new(self, hash)
}
fn with_hash(self) -> Hashed<Self> {
let hash = CryptoHash::new(&self);
Hashed::unchecked_new(self, hash)
}
pub fn with_hash_checked(self, hash: CryptoHash) -> Result<Hashed<ConfirmedBlock>, ChainError> {
let hashed_certificate_value = self.with_hash();
if hashed_certificate_value.hash() == hash {
Ok(hashed_certificate_value)
} else {
Err(ChainError::CertificateValueHashMismatch {
expected: hash,
actual: hashed_certificate_value.hash(),
})
}
}
pub fn matches_proposed_block(&self, block: &ProposedBlock) -> bool {
let ProposedBlock {
chain_id,
epoch,
incoming_bundles,
operations,
height,
timestamp,
authenticated_signer,
previous_block_hash,
} = block;
*chain_id == self.chain_id()
&& *epoch == self.epoch()
&& *incoming_bundles == self.block().body.incoming_bundles
&& *operations == self.block().body.operations
&& *height == self.block().header.height
&& *timestamp == self.block().header.timestamp
&& *authenticated_signer == self.block().header.authenticated_signer
&& *previous_block_hash == self.block().header.previous_block_hash
}
pub fn to_blob_state(&self) -> BlobState {
BlobState {
last_used_by: self.0.hash(),
chain_id: self.chain_id(),
block_height: self.height(),
epoch: self.epoch(),
}
}
}
#[derive(Debug, PartialEq, Eq, Hash, Clone, Deserialize, Serialize)]
pub struct Timeout {
pub chain_id: ChainId,
pub height: BlockHeight,
pub epoch: Epoch,
}
impl Timeout {
pub fn new(chain_id: ChainId, height: BlockHeight, epoch: Epoch) -> Self {
Self {
chain_id,
height,
epoch,
}
}
pub fn to_log_str(&self) -> &'static str {
"timeout"
}
pub fn chain_id(&self) -> ChainId {
self.chain_id
}
pub fn height(&self) -> BlockHeight {
self.height
}
pub fn epoch(&self) -> Epoch {
self.epoch
}
}
impl<'de> BcsHashable<'de> for Timeout {}
#[derive(Clone, Copy, Debug, Error)]
pub enum ConversionError {
#[error("Expected a `ConfirmedBlockCertificate` value")]
ConfirmedBlock,
#[error("Expected a `ValidatedBlockCertificate` value")]
ValidatedBlock,
#[error("Expected a `TimeoutCertificate` value")]
Timeout,
}
#[derive(Debug, PartialEq, Eq, Hash, Clone, SimpleObject)]
pub struct Block {
pub header: BlockHeader,
pub body: BlockBody,
}
impl Serialize for Block {
fn serialize<S: serde::ser::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
let mut state = serializer.serialize_struct("Block", 2)?;
let header = SerializedHeader {
chain_id: self.header.chain_id,
epoch: self.header.epoch,
height: self.header.height,
timestamp: self.header.timestamp,
state_hash: self.header.state_hash,
previous_block_hash: self.header.previous_block_hash,
authenticated_signer: self.header.authenticated_signer,
};
state.serialize_field("header", &header)?;
state.serialize_field("body", &self.body)?;
state.end()
}
}
impl<'de> Deserialize<'de> for Block {
fn deserialize<D: serde::de::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
#[derive(Deserialize)]
#[serde(rename = "Block")]
struct Inner {
header: SerializedHeader,
body: BlockBody,
}
let inner = Inner::deserialize(deserializer)?;
let bundles_hash = hashing::hash_vec(&inner.body.incoming_bundles);
let messages_hash = hashing::hash_vec_vec(&inner.body.messages);
let operations_hash = hashing::hash_vec(&inner.body.operations);
let oracle_responses_hash = hashing::hash_vec_vec(&inner.body.oracle_responses);
let events_hash = hashing::hash_vec_vec(&inner.body.events);
let header = BlockHeader {
chain_id: inner.header.chain_id,
epoch: inner.header.epoch,
height: inner.header.height,
timestamp: inner.header.timestamp,
state_hash: inner.header.state_hash,
previous_block_hash: inner.header.previous_block_hash,
authenticated_signer: inner.header.authenticated_signer,
bundles_hash,
operations_hash,
messages_hash,
oracle_responses_hash,
events_hash,
};
Ok(Self {
header,
body: inner.body,
})
}
}
#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize, SimpleObject)]
pub struct BlockHeader {
pub chain_id: ChainId,
pub epoch: Epoch,
pub height: BlockHeight,
pub timestamp: Timestamp,
pub state_hash: CryptoHash,
pub previous_block_hash: Option<CryptoHash>,
pub authenticated_signer: Option<Owner>,
pub bundles_hash: CryptoHash,
pub operations_hash: CryptoHash,
pub messages_hash: CryptoHash,
pub oracle_responses_hash: CryptoHash,
pub events_hash: CryptoHash,
}
#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize, SimpleObject)]
pub struct BlockBody {
pub incoming_bundles: Vec<IncomingBundle>,
pub operations: Vec<Operation>,
pub messages: Vec<Vec<OutgoingMessage>>,
pub oracle_responses: Vec<Vec<OracleResponse>>,
pub events: Vec<Vec<Event>>,
}
impl Block {
pub fn new(block: ProposedBlock, outcome: BlockExecutionOutcome) -> Self {
let bundles_hash = hashing::hash_vec(&block.incoming_bundles);
let messages_hash = hashing::hash_vec_vec(&outcome.messages);
let operations_hash = hashing::hash_vec(&block.operations);
let oracle_responses_hash = hashing::hash_vec_vec(&outcome.oracle_responses);
let events_hash = hashing::hash_vec_vec(&outcome.events);
let header = BlockHeader {
chain_id: block.chain_id,
epoch: block.epoch,
height: block.height,
timestamp: block.timestamp,
state_hash: outcome.state_hash,
previous_block_hash: block.previous_block_hash,
authenticated_signer: block.authenticated_signer,
bundles_hash,
operations_hash,
messages_hash,
oracle_responses_hash,
events_hash,
};
let body = BlockBody {
incoming_bundles: block.incoming_bundles,
operations: block.operations,
messages: outcome.messages,
oracle_responses: outcome.oracle_responses,
events: outcome.events,
};
Self { header, body }
}
pub fn message_bundles_for<'a>(
&'a self,
medium: &'a Medium,
recipient: ChainId,
certificate_hash: CryptoHash,
) -> impl Iterator<Item = (Epoch, MessageBundle)> + 'a {
let mut index = 0u32;
let block_height = self.header.height;
let block_timestamp = self.header.timestamp;
let block_epoch = self.header.epoch;
(0u32..)
.zip(self.messages())
.filter_map(move |(transaction_index, txn_messages)| {
let messages = (index..)
.zip(txn_messages)
.filter(|(_, message)| message.has_destination(medium, recipient))
.map(|(idx, message)| message.clone().into_posted(idx))
.collect::<Vec<_>>();
index += txn_messages.len() as u32;
(!messages.is_empty()).then(|| {
let bundle = MessageBundle {
height: block_height,
timestamp: block_timestamp,
certificate_hash,
transaction_index,
messages,
};
(block_epoch, bundle)
})
})
}
pub fn message_id_for_operation(
&self,
operation_index: usize,
message_index: u32,
) -> Option<MessageId> {
let block = &self.body;
let transaction_index = block.incoming_bundles.len().checked_add(operation_index)?;
if message_index >= u32::try_from(self.body.messages.get(transaction_index)?.len()).ok()? {
return None;
}
let first_message_index = u32::try_from(
self.body
.messages
.iter()
.take(transaction_index)
.map(Vec::len)
.sum::<usize>(),
)
.ok()?;
let index = first_message_index.checked_add(message_index)?;
Some(self.message_id(index))
}
pub fn message_id(&self, index: u32) -> MessageId {
MessageId {
chain_id: self.header.chain_id,
height: self.header.height,
index,
}
}
pub fn message_by_id(&self, message_id: &MessageId) -> Option<&OutgoingMessage> {
let MessageId {
chain_id,
height,
index,
} = message_id;
if self.header.chain_id != *chain_id || self.header.height != *height {
return None;
}
let mut index = usize::try_from(*index).ok()?;
for messages in self.messages() {
if let Some(message) = messages.get(index) {
return Some(message);
}
index -= messages.len();
}
None
}
pub fn required_blob_ids(&self) -> BTreeSet<BlobId> {
let mut blob_ids = self.oracle_blob_ids();
blob_ids.extend(self.published_blob_ids());
blob_ids
}
pub fn requires_blob(&self, blob_id: &BlobId) -> bool {
self.oracle_blob_ids().contains(blob_id) || self.published_blob_ids().contains(blob_id)
}
fn published_blob_ids(&self) -> BTreeSet<BlobId> {
let mut blob_ids = BTreeSet::new();
for operation in &self.body.operations {
if let Operation::System(SystemOperation::PublishDataBlob { blob_hash }) = operation {
blob_ids.insert(BlobId::new(*blob_hash, BlobType::Data));
}
if let Operation::System(SystemOperation::PublishBytecode { bytecode_id }) = operation {
blob_ids.extend([
BlobId::new(bytecode_id.contract_blob_hash, BlobType::ContractBytecode),
BlobId::new(bytecode_id.service_blob_hash, BlobType::ServiceBytecode),
]);
}
}
blob_ids
}
pub fn oracle_blob_ids(&self) -> BTreeSet<BlobId> {
let mut required_blob_ids = BTreeSet::new();
for responses in &self.body.oracle_responses {
for response in responses {
if let OracleResponse::Blob(blob_id) = response {
required_blob_ids.insert(*blob_id);
}
}
}
required_blob_ids
}
pub fn messages(&self) -> &Vec<Vec<OutgoingMessage>> {
&self.body.messages
}
}
impl From<Block> for ExecutedBlock {
fn from(block: Block) -> Self {
let Block {
header:
BlockHeader {
chain_id,
epoch,
height,
timestamp,
state_hash,
previous_block_hash,
authenticated_signer,
bundles_hash: _,
operations_hash: _,
messages_hash: _,
oracle_responses_hash: _,
events_hash: _,
},
body:
BlockBody {
incoming_bundles,
operations,
messages,
oracle_responses,
events,
},
} = block;
let block = ProposedBlock {
chain_id,
epoch,
height,
timestamp,
incoming_bundles,
operations,
authenticated_signer,
previous_block_hash,
};
let outcome = BlockExecutionOutcome {
state_hash,
messages,
oracle_responses,
events,
};
ExecutedBlock { block, outcome }
}
}
impl<'de> BcsHashable<'de> for Block {}
#[derive(Serialize, Deserialize)]
#[serde(rename = "BlockHeader")]
struct SerializedHeader {
chain_id: ChainId,
epoch: Epoch,
height: BlockHeight,
timestamp: Timestamp,
state_hash: CryptoHash,
previous_block_hash: Option<CryptoHash>,
authenticated_signer: Option<Owner>,
}
mod hashing {
use linera_base::crypto::{BcsHashable, CryptoHash, CryptoHashVec};
pub(super) fn hash_vec<'de, T: BcsHashable<'de>>(it: impl AsRef<[T]>) -> CryptoHash {
let v = CryptoHashVec(it.as_ref().iter().map(CryptoHash::new).collect::<Vec<_>>());
CryptoHash::new(&v)
}
pub(super) fn hash_vec_vec<'de, T: BcsHashable<'de>>(it: impl AsRef<[Vec<T>]>) -> CryptoHash {
let v = CryptoHashVec(it.as_ref().iter().map(hash_vec).collect::<Vec<_>>());
CryptoHash::new(&v)
}
}