linera_chain/data_types/

mod.rs

// Copyright (c) Facebook, Inc. and its affiliates.
// Copyright (c) Zefchain Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

use std::{
    collections::{BTreeMap, BTreeSet, HashSet},
    sync::Arc,
};

use allocative::Allocative;
use async_graphql::SimpleObject;
use custom_debug_derive::Debug;
use linera_base::{
    bcs,
    crypto::{
        AccountSignature, BcsHashable, BcsSignable, CryptoError, CryptoHash, Signer,
        ValidatorPublicKey, ValidatorSecretKey, ValidatorSignature,
    },
    data_types::{
        Amount, Blob, BlockHeight, Cursor, Epoch, Event, MessagePolicy, OracleResponse, Round,
        Timestamp,
    },
    doc_scalar, ensure, hex, hex_debug,
    identifiers::{
        Account, AccountOwner, ApplicationId, BlobId, ChainId, GenericApplicationId, StreamId,
    },
    time::Duration,
};
use linera_execution::{committee::Committee, Message, MessageKind, Operation, OutgoingMessage};
use serde::{Deserialize, Serialize};
use tracing::{info, instrument};

use crate::{
    block::{Block, ValidatedBlock},
    types::{
        CertificateKind, CertificateValue, GenericCertificate, LiteCertificate,
        ValidatedBlockCertificate,
    },
    ChainError,
};

pub mod metadata;

pub use metadata::*;

#[cfg(test)]
#[path = "../unit_tests/data_types_tests.rs"]
mod data_types_tests;

/// A block containing operations to apply on a given chain, as well as the
/// acknowledgment of a number of incoming messages from other chains.
/// * Incoming messages must be selected in the order they were
///   produced by the sending chain, but can be skipped.
/// * When a block is proposed to a validator, all cross-chain messages must have been
///   received ahead of time in the inbox of the chain.
/// * This constraint does not apply to the execution of confirmed blocks.
#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize, SimpleObject, Allocative)]
#[graphql(complex)]
pub struct ProposedBlock {
    /// The chain to which this block belongs.
    pub chain_id: ChainId,
    /// The number identifying the current configuration.
    pub epoch: Epoch,
    /// The transactions to execute in this block. Each transaction can be either
    /// incoming messages or an operation.
    #[debug(skip_if = Vec::is_empty)]
    #[graphql(skip)]
    pub transactions: Vec<Transaction>,
    /// The block height.
    pub height: BlockHeight,
    /// The timestamp when this block was created. This must be later than all messages received
    /// in this block, but no later than the current time.
    pub timestamp: Timestamp,
    /// The user signing for the operations in the block and paying for their execution
    /// fees. If set, this must be the `owner` in the block proposal. `None` means that
    /// the default account of the chain is used. This value is also used as recipient of
    /// potential refunds for the message grants created by the operations.
    #[debug(skip_if = Option::is_none)]
    pub authenticated_owner: Option<AccountOwner>,
    /// Certified hash (see `Certificate` below) of the previous block in the
    /// chain, if any.
    pub previous_block_hash: Option<CryptoHash>,
}

impl ProposedBlock {
    /// Returns all the published blob IDs in this block's operations.
    pub fn published_blob_ids(&self) -> BTreeSet<BlobId> {
        self.operations()
            .flat_map(Operation::published_blob_ids)
            .collect()
    }

    /// Returns whether the first transaction in this block is a
    /// `SystemOperation::Checkpoint`. Under the chain-level checkpoint preconditions
    /// this is equivalent to "the block is a checkpoint block", since Checkpoint must
    /// be the only transaction.
    pub fn starts_with_checkpoint(&self) -> bool {
        self.transactions
            .first()
            .is_some_and(Transaction::is_checkpoint)
    }

    /// Returns whether the block contains only rejected incoming messages, which
    /// makes it admissible even on closed chains.
    pub fn has_only_rejected_messages(&self) -> bool {
        self.transactions.iter().all(|txn| {
            matches!(
                txn,
                Transaction::ReceiveMessages(IncomingBundle {
                    action: MessageAction::Reject,
                    ..
                })
            )
        })
    }

    /// Returns all operations in this block.
    pub fn operations(&self) -> impl Iterator<Item = &Operation> {
        self.transactions.iter().filter_map(|tx| match tx {
            Transaction::ExecuteOperation(operation) => Some(operation),
            Transaction::ReceiveMessages(_) => None,
        })
    }

    /// Returns all incoming bundles in this block.
    pub fn incoming_bundles(&self) -> impl Iterator<Item = &IncomingBundle> {
        self.transactions.iter().filter_map(|tx| match tx {
            Transaction::ReceiveMessages(bundle) => Some(bundle),
            Transaction::ExecuteOperation(_) => None,
        })
    }

    /// Checks that the serialized size of this block does not exceed the given maximum.
    pub fn check_proposal_size(&self, maximum_block_proposal_size: u64) -> Result<(), ChainError> {
        let size = bcs::serialized_size(self)?;
        ensure!(
            size <= usize::try_from(maximum_block_proposal_size).unwrap_or(usize::MAX),
            ChainError::BlockProposalTooLarge(size)
        );
        Ok(())
    }
}

#[async_graphql::ComplexObject]
impl ProposedBlock {
    /// Metadata about the transactions in this block.
    async fn transaction_metadata(&self) -> Vec<TransactionMetadata> {
        self.transactions
            .iter()
            .map(TransactionMetadata::from_transaction)
            .collect()
    }
}

/// A transaction in a block: incoming messages or an operation.
#[derive(
    Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, Allocative, strum::AsRefStr,
)]
pub enum Transaction {
    /// Receive a bundle of incoming messages.
    ReceiveMessages(IncomingBundle),
    /// Execute an operation.
    ExecuteOperation(Operation),
}

impl BcsHashable<'_> for Transaction {}

impl Transaction {
    /// Returns the incoming bundle, if this transaction receives messages.
    pub fn incoming_bundle(&self) -> Option<&IncomingBundle> {
        match self {
            Transaction::ReceiveMessages(bundle) => Some(bundle),
            _ => None,
        }
    }

    /// Returns whether this transaction executes a `SystemOperation::UpdateStream`.
    pub fn is_update_stream(&self) -> bool {
        matches!(
            self,
            Transaction::ExecuteOperation(op) if op.is_update_stream()
        )
    }

    /// Returns whether this transaction executes a `SystemOperation::Checkpoint`.
    pub fn is_checkpoint(&self) -> bool {
        matches!(
            self,
            Transaction::ExecuteOperation(op) if op.is_checkpoint()
        )
    }
}

/// GraphQL-compatible structured representation of an operation.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, SimpleObject)]
#[graphql(name = "Operation")]
pub struct OperationMetadata {
    /// The type of operation: "System" or "User"
    pub operation_type: String,
    /// For user operations, the application ID
    pub application_id: Option<ApplicationId>,
    /// For user operations, the serialized bytes (as a hex string for GraphQL)
    pub user_bytes_hex: Option<String>,
    /// For system operations, structured representation
    pub system_operation: Option<SystemOperationMetadata>,
}

impl From<&Operation> for OperationMetadata {
    fn from(operation: &Operation) -> Self {
        match operation {
            Operation::System(sys_op) => OperationMetadata {
                operation_type: "System".to_string(),
                application_id: None,
                user_bytes_hex: None,
                system_operation: Some(SystemOperationMetadata::from(sys_op.as_ref())),
            },
            Operation::User {
                application_id,
                bytes,
            } => OperationMetadata {
                operation_type: "User".to_string(),
                application_id: Some(*application_id),
                user_bytes_hex: Some(hex::encode(bytes)),
                system_operation: None,
            },
        }
    }
}

/// GraphQL-compatible metadata about a transaction.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, SimpleObject)]
pub struct TransactionMetadata {
    /// The type of transaction: "ReceiveMessages" or "ExecuteOperation"
    pub transaction_type: String,
    /// The incoming bundle, if this is a ReceiveMessages transaction
    pub incoming_bundle: Option<IncomingBundle>,
    /// The operation, if this is an ExecuteOperation transaction
    pub operation: Option<OperationMetadata>,
}

impl TransactionMetadata {
    /// Builds GraphQL-compatible metadata from a transaction.
    pub fn from_transaction(transaction: &Transaction) -> Self {
        match transaction {
            Transaction::ReceiveMessages(bundle) => TransactionMetadata {
                transaction_type: "ReceiveMessages".to_string(),
                incoming_bundle: Some(bundle.clone()),
                operation: None,
            },
            Transaction::ExecuteOperation(op) => TransactionMetadata {
                transaction_type: "ExecuteOperation".to_string(),
                incoming_bundle: None,
                operation: Some(OperationMetadata::from(op)),
            },
        }
    }
}

/// A chain ID with a block height.
#[derive(
    Debug,
    Clone,
    Copy,
    Eq,
    PartialEq,
    Ord,
    PartialOrd,
    Serialize,
    Deserialize,
    SimpleObject,
    Allocative,
)]
pub struct ChainAndHeight {
    /// The chain that the block belongs to.
    pub chain_id: ChainId,
    /// The height of the block within that chain.
    pub height: BlockHeight,
}

/// A bundle of cross-chain messages.
#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize, SimpleObject, Allocative)]
pub struct IncomingBundle {
    /// The origin of the messages.
    pub origin: ChainId,
    /// The messages to be delivered to the inbox identified by `origin`.
    pub bundle: MessageBundle,
    /// What to do with the message.
    pub action: MessageAction,
}

impl IncomingBundle {
    /// Returns an iterator over all posted messages in this bundle, together with their ID.
    pub fn messages(&self) -> impl Iterator<Item = &PostedMessage> {
        self.bundle.messages.iter()
    }

    fn matches_policy(&self, policy: &MessagePolicy) -> bool {
        if let Some(chain_ids) = &policy.restrict_chain_ids_to {
            if !chain_ids.contains(&self.origin) {
                return false;
            }
        }
        if policy.ignore_chain_ids.contains(&self.origin) {
            return false;
        }
        if !policy.never_reject_application_ids.is_empty()
            && self.messages().all(|posted_msg| {
                policy
                    .never_reject_application_ids
                    .contains(&posted_msg.message.application_id())
            })
        {
            return true;
        }
        if let Some(app_ids) = &policy.reject_message_bundles_without_application_ids {
            if !self
                .messages()
                .any(|posted_msg| app_ids.contains(&posted_msg.message.application_id()))
            {
                return false;
            }
        }
        if let Some(app_ids) = &policy.reject_message_bundles_with_other_application_ids {
            if !self
                .messages()
                .all(|posted_msg| app_ids.contains(&posted_msg.message.application_id()))
            {
                return false;
            }
        }
        !policy.is_reject()
    }

    /// Applies the message policy to this bundle, returning `None` if it is dropped,
    /// or the bundle with a possibly updated action otherwise.
    #[instrument(level = "trace", skip(self))]
    pub fn apply_policy(mut self, policy: &MessagePolicy) -> Option<IncomingBundle> {
        if !self.matches_policy(policy) {
            if self.bundle.is_skippable() {
                return None;
            } else if !self.bundle.is_protected() {
                info!(
                    origin = %self.origin,
                    "Rejecting incoming message bundle due to the message policy"
                );
                self.action = MessageAction::Reject;
            }
        }
        Some(self)
    }
}

impl BcsHashable<'_> for IncomingBundle {}

/// What to do with a message picked from the inbox.
#[derive(Copy, Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize, Allocative)]
pub enum MessageAction {
    /// Execute the incoming message.
    Accept,
    /// Do not execute the incoming message.
    Reject,
}

/// Policy for handling message bundle execution failures during block execution.
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub enum BundleFailurePolicy {
    /// Abort block execution on any bundle failure. The proposal is never modified.
    #[default]
    Abort,
    /// Automatically handle failing bundles with checkpointing and retry.
    ///
    /// This policy is intended for use by clients when preparing proposals. It modifies
    /// the proposal by discarding or rejecting bundles that fail to execute:
    ///
    /// - For limit errors (block too large, fuel exceeded, etc.): discard the bundle
    ///   so it can be retried in a later block, unless it's the first transaction
    ///   (in which case it's inherently too large and gets rejected).
    /// - For bundles whose messages are all from applications in
    ///   `never_reject_application_ids`: discard the bundle (and subsequent bundles from
    ///   the same sender) so they can be retried in a later block, and log a warning.
    /// - For all other non-limit errors: reject the bundle (triggering bounced messages).
    /// - After `max_failures` discarded bundles, discard all remaining message bundles.
    AutoRetry {
        /// Maximum number of discarded bundles before discarding all remaining message bundles.
        max_failures: u32,
        /// Applications whose messages must never be rejected. A failed bundle whose messages
        /// are all from such applications is discarded instead of rejected. A bundle that
        /// contains any message from an application not on this list can be rejected.
        never_reject_application_ids: Arc<HashSet<GenericApplicationId>>,
    },
}

/// Policy for executing message bundles during block execution.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct BundleExecutionPolicy {
    /// What to do when a bundle fails.
    pub on_failure: BundleFailurePolicy,
    /// Optional time budget for bundle execution.
    pub time_budget: Option<Duration>,
}

impl BundleExecutionPolicy {
    /// Returns a policy suitable for committed blocks: abort on failure, no time budget.
    pub fn committed() -> Self {
        BundleExecutionPolicy {
            on_failure: BundleFailurePolicy::Abort,
            time_budget: None,
        }
    }
}

/// A set of messages from a single block, for a single destination.
#[derive(Debug, Eq, PartialEq, Clone, Hash, Serialize, Deserialize, SimpleObject, Allocative)]
pub struct MessageBundle {
    /// The block height.
    pub height: BlockHeight,
    /// The block's timestamp.
    pub timestamp: Timestamp,
    /// The confirmed block certificate hash.
    pub certificate_hash: CryptoHash,
    /// The index of the transaction in the block that is sending this bundle.
    pub transaction_index: u32,
    /// The relevant messages.
    pub messages: Vec<PostedMessage>,
}

#[derive(Clone, Debug, Serialize, Deserialize, Allocative)]
#[cfg_attr(with_testing, derive(Eq, PartialEq))]
/// An earlier proposal that is being retried.
pub enum OriginalProposal {
    /// A proposal in the fast round.
    Fast(AccountSignature),
    /// A validated block certificate from an earlier round.
    Regular {
        /// The validated block certificate.
        certificate: LiteCertificate<'static>,
    },
}

/// An authenticated proposal for a new block.
// TODO(#456): the signature of the block owner is currently lost but it would be useful
// to have it for auditing purposes.
#[derive(Clone, Debug, Serialize, Deserialize, Allocative)]
#[cfg_attr(with_testing, derive(Eq, PartialEq))]
pub struct BlockProposal {
    /// The signed content of the proposal: the proposed block, the round, and any
    /// execution outcome from a previous round.
    pub content: ProposalContent,
    /// The proposer's signature over `content`.
    pub signature: AccountSignature,
    /// The earlier proposal being retried, if this proposal is a retry in a later round.
    #[debug(skip_if = Option::is_none)]
    pub original_proposal: Option<OriginalProposal>,
}

/// A message together with kind, authentication and grant information.
#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize, SimpleObject, Allocative)]
#[graphql(complex)]
pub struct PostedMessage {
    /// The user authentication carried by the message, if any.
    #[debug(skip_if = Option::is_none)]
    pub authenticated_owner: Option<AccountOwner>,
    /// A grant to pay for the message execution.
    #[debug(skip_if = Amount::is_zero)]
    pub grant: Amount,
    /// Where to send a refund for the unused part of the grant after execution, if any.
    #[debug(skip_if = Option::is_none)]
    pub refund_grant_to: Option<Account>,
    /// The kind of message being sent.
    pub kind: MessageKind,
    /// The message itself.
    pub message: Message,
}

/// Extension trait for converting an `OutgoingMessage` into a `PostedMessage`.
pub trait OutgoingMessageExt {
    /// Returns the posted message, i.e. the outgoing message without the destination.
    fn into_posted(self) -> PostedMessage;
}

impl OutgoingMessageExt for OutgoingMessage {
    /// Returns the posted message, i.e. the outgoing message without the destination.
    fn into_posted(self) -> PostedMessage {
        let OutgoingMessage {
            destination: _,
            authenticated_owner,
            grant,
            refund_grant_to,
            kind,
            message,
        } = self;
        PostedMessage {
            authenticated_owner,
            grant,
            refund_grant_to,
            kind,
            message,
        }
    }
}

#[async_graphql::ComplexObject]
impl PostedMessage {
    /// Structured message metadata for GraphQL.
    async fn message_metadata(&self) -> MessageMetadata {
        MessageMetadata::from(&self.message)
    }
}

/// The execution result of a single operation.
#[derive(Debug, Default, PartialEq, Eq, Hash, Clone, Serialize, Deserialize, Allocative)]
pub struct OperationResult(
    #[debug(with = "hex_debug")]
    #[serde(with = "serde_bytes")]
    pub Vec<u8>,
);

impl BcsHashable<'_> for OperationResult {}

doc_scalar!(
    OperationResult,
    "The execution result of a single operation."
);

/// The messages and the state hash resulting from a [`ProposedBlock`]'s execution.
#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize, SimpleObject, Allocative)]
#[cfg_attr(with_testing, derive(Default))]
pub struct BlockExecutionOutcome {
    /// The list of outgoing messages for each transaction.
    pub messages: Vec<Vec<OutgoingMessage>>,
    /// The hashes and heights of previous blocks that sent messages to the same recipients.
    pub previous_message_blocks: BTreeMap<ChainId, (CryptoHash, BlockHeight)>,
    /// The hashes and heights of previous blocks that published events to the same channels.
    pub previous_event_blocks: BTreeMap<StreamId, (CryptoHash, BlockHeight)>,
    /// The hash of the chain's execution state after this block.
    pub state_hash: CryptoHash,
    /// The record of oracle responses for each transaction.
    pub oracle_responses: Vec<Vec<OracleResponse>>,
    /// The list of events produced by each transaction.
    pub events: Vec<Vec<Event>>,
    /// The list of blobs created by each transaction.
    pub blobs: Vec<Vec<Blob>>,
    /// The execution result for each operation.
    pub operation_results: Vec<OperationResult>,
}

/// The hash and chain ID of a `CertificateValue`.
#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize, Allocative)]
pub struct LiteValue {
    /// The hash of the `CertificateValue`.
    pub value_hash: CryptoHash,
    /// The chain that the value belongs to.
    pub chain_id: ChainId,
    /// The kind of certificate this value is for.
    pub kind: CertificateKind,
}

impl LiteValue {
    /// Creates a `LiteValue` from a certificate value.
    pub fn new<T: CertificateValue>(value: &T) -> Self {
        LiteValue {
            value_hash: value.hash(),
            chain_id: value.chain_id(),
            kind: T::KIND,
        }
    }
}

//(deuszx): pub is temp.
/// The value a validator signs when voting: the value hash, round, certificate kind, the
/// unlocking round (for `ValidatedBlock` votes), the first-round attestation (for
/// `ConfirmedBlock` votes), and the justification commitment.
///
/// The unlocking round is the consensus device behind fault attributability: by signing it, a
/// validator asserts "I have not voted to confirm a block other than this one in any round at or
/// above the unlocking round". `None` means an unlocking round of `0`, i.e. the strongest claim
/// ("...in any round"), and is used for freshly proposed blocks and for `ConfirmedBlock`/`Timeout`
/// votes, which carry no unlocking round.
///
/// The `bool` is the first-round attestation: it is `true` only when a `ConfirmedBlock`
/// vote confirms a block in the chain's first round, and is always `false` for `ValidatedBlock`
/// and `Timeout` votes.
///
/// The final hash is the justification commitment: the hash of the quorum this vote cites (see
/// [`CommittedQuorum`]), which transitively commits to the whole justification chain below it.
/// By signing it, the voter attests that they verified the cited quorum, so certificates are
/// verified by checking only their top quorum's signatures. A `ValidatedBlock` vote cites the
/// quorum that justifies its unlocking round (`None` for a fresh proposal); a `ConfirmedBlock`
/// vote cites the quorum that validated the block in the same round (`None` when confirming in
/// the chain's first round); `Timeout` votes cite nothing.
///
/// [`CommittedQuorum`]: crate::justification::CommittedQuorum
#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize)]
pub struct VoteValue(
    pub(crate) CryptoHash,
    pub(crate) Round,
    pub(crate) CertificateKind,
    pub(crate) Option<Round>,
    pub(crate) bool,
    pub(crate) Option<CryptoHash>,
);

/// A vote on a statement from a validator.
#[derive(Allocative, Clone, Debug, Serialize, Deserialize)]
#[serde(bound(deserialize = "T: Deserialize<'de>"))]
pub struct Vote<T> {
    /// The value being voted for.
    pub value: T,
    /// The consensus round in which the vote was cast.
    pub round: Round,
    /// The unlocking round this vote signed (see [`VoteValue`]). Only `ValidatedBlock` votes carry
    /// an unlocking round; it is `None` for fresh proposals and for `ConfirmedBlock`/`Timeout` votes.
    pub unlocking_round: Option<Round>,
    /// The first-round attestation this vote signed (see [`VoteValue`]). It is `true` only for a
    /// `ConfirmedBlock` vote that confirms a block in the chain's first round; it is always
    /// `false` for `ValidatedBlock` and `Timeout` votes.
    pub first_round: bool,
    /// The justification commitment this vote signed (see [`VoteValue`]): the hash of the cited
    /// quorum, or `None` if the vote cites none.
    pub justification_commitment: Option<CryptoHash>,
    /// The validator's signature over the value hash, round, certificate kind, unlocking round,
    /// first-round attestation and justification commitment.
    pub signature: ValidatorSignature,
}

impl<T> Vote<T> {
    /// Use signing key to create a signed object.
    pub fn new(value: T, round: Round, key_pair: &ValidatorSecretKey) -> Self
    where
        T: CertificateValue,
    {
        Self::new_with_unlocking_round(value, round, None, None, key_pair)
    }

    /// Use signing key to create a signed object with the given unlocking round and the
    /// justification commitment of the quorum that grounds it (see [`VoteValue`]).
    pub fn new_with_unlocking_round(
        value: T,
        round: Round,
        unlocking_round: Option<Round>,
        justification_commitment: Option<CryptoHash>,
        key_pair: &ValidatorSecretKey,
    ) -> Self
    where
        T: CertificateValue,
    {
        let hash_and_round = VoteValue(
            value.hash(),
            round,
            T::KIND,
            unlocking_round,
            false,
            justification_commitment,
        );
        let signature = ValidatorSignature::new(&hash_and_round, key_pair);
        Self {
            value,
            round,
            unlocking_round,
            first_round: false,
            justification_commitment,
            signature,
        }
    }

    /// Use signing key to create a signed `ConfirmedBlock` object that carries the first-round
    /// attestation `first_round` and the justification commitment of the quorum that validated
    /// the block (see [`VoteValue`]). The unlocking round is always `None`.
    pub fn new_with_first_round(
        value: T,
        round: Round,
        first_round: bool,
        justification_commitment: Option<CryptoHash>,
        key_pair: &ValidatorSecretKey,
    ) -> Self
    where
        T: CertificateValue,
    {
        let hash_and_round = VoteValue(
            value.hash(),
            round,
            T::KIND,
            None,
            first_round,
            justification_commitment,
        );
        let signature = ValidatorSignature::new(&hash_and_round, key_pair);
        Self {
            value,
            round,
            unlocking_round: None,
            first_round,
            justification_commitment,
            signature,
        }
    }

    /// Returns the vote, with a `LiteValue` instead of the full value.
    pub fn lite(&self) -> LiteVote
    where
        T: CertificateValue,
    {
        LiteVote {
            value: LiteValue::new(&self.value),
            round: self.round,
            unlocking_round: self.unlocking_round,
            first_round: self.first_round,
            justification_commitment: self.justification_commitment,
            signature: self.signature,
        }
    }

    /// Returns the value this vote is for.
    pub fn value(&self) -> &T {
        &self.value
    }
}

/// A vote on a statement from a validator, represented as a `LiteValue`.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[cfg_attr(with_testing, derive(Eq, PartialEq))]
pub struct LiteVote {
    /// The value being voted for, as a `LiteValue`.
    pub value: LiteValue,
    /// The consensus round in which the vote was cast.
    pub round: Round,
    /// The unlocking round this vote signed (see [`VoteValue`]). Only `ValidatedBlock` votes carry
    /// an unlocking round; it is `None` for fresh proposals and for `ConfirmedBlock`/`Timeout` votes.
    pub unlocking_round: Option<Round>,
    /// The first-round attestation this vote signed (see [`VoteValue`]). It is `true` only for a
    /// `ConfirmedBlock` vote that confirms a block in the chain's first round; it is always
    /// `false` for `ValidatedBlock` and `Timeout` votes.
    pub first_round: bool,
    /// The justification commitment this vote signed (see [`VoteValue`]): the hash of the cited
    /// quorum, or `None` if the vote cites none.
    pub justification_commitment: Option<CryptoHash>,
    /// The validator's signature over the value hash, round, certificate kind, unlocking round,
    /// first-round attestation and justification commitment.
    pub signature: ValidatorSignature,
}

impl LiteVote {
    /// Returns the full vote, with the value, if it matches.
    #[cfg(with_testing)]
    pub fn with_value<T: CertificateValue>(self, value: T) -> Option<Vote<T>> {
        if self.value.value_hash != value.hash() {
            return None;
        }
        Some(Vote {
            value,
            round: self.round,
            unlocking_round: self.unlocking_round,
            first_round: self.first_round,
            justification_commitment: self.justification_commitment,
            signature: self.signature,
        })
    }

    /// Returns the kind of certificate this vote is for.
    pub fn kind(&self) -> CertificateKind {
        self.value.kind
    }
}

impl MessageBundle {
    /// Returns the logical position of this bundle in its sender chain's outgoing
    /// stream.
    pub fn cursor(&self) -> Cursor {
        Cursor {
            height: self.height,
            index: self.transaction_index,
        }
    }

    /// Returns a rough estimate of the serialized size in bytes, for chunking.
    pub fn estimated_size(&self) -> usize {
        // Fixed overhead: height (8) + timestamp (8) + hash (32) + tx_index (4) + vec len (8)
        let overhead = 60;
        let messages_size: usize = self
            .messages
            .iter()
            .map(PostedMessage::estimated_size)
            .sum();
        overhead + messages_size
    }

    /// Returns whether all messages in this bundle can be skipped.
    pub fn is_skippable(&self) -> bool {
        self.messages.iter().all(PostedMessage::is_skippable)
    }

    /// Returns whether any message in this bundle is protected.
    pub fn is_protected(&self) -> bool {
        self.messages.iter().any(PostedMessage::is_protected)
    }
}

impl PostedMessage {
    /// Returns a rough estimate of the serialized size in bytes.
    pub fn estimated_size(&self) -> usize {
        // Fixed: signer option (33) + grant (16) + refund option (34) + kind (1) + enum tag (8)
        let overhead = 92;
        let message_size = match &self.message {
            Message::System(_) => 256, // conservative estimate for system messages
            Message::User { bytes, .. } => 64 + bytes.len(),
        };
        overhead + message_size
    }

    /// Returns whether this message can be skipped.
    pub fn is_skippable(&self) -> bool {
        match self.kind {
            MessageKind::Protected | MessageKind::Tracked => false,
            MessageKind::Simple | MessageKind::Bouncing => self.grant == Amount::ZERO,
        }
    }

    /// Returns whether this message is protected.
    pub fn is_protected(&self) -> bool {
        matches!(self.kind, MessageKind::Protected)
    }

    /// Returns whether this message is tracked.
    pub fn is_tracked(&self) -> bool {
        matches!(self.kind, MessageKind::Tracked)
    }

    /// Returns whether this message is bouncing.
    pub fn is_bouncing(&self) -> bool {
        matches!(self.kind, MessageKind::Bouncing)
    }
}

impl BlockExecutionOutcome {
    /// Combines this outcome with a proposed block into a full block.
    pub fn with(self, block: ProposedBlock) -> Block {
        Block::new(block, self)
    }

    /// Returns the IDs of all blobs referenced by oracle responses in this outcome.
    pub fn oracle_blob_ids(&self) -> HashSet<BlobId> {
        let mut required_blob_ids = HashSet::new();
        for responses in &self.oracle_responses {
            for response in responses {
                match response {
                    OracleResponse::Blob(blob_id) => {
                        required_blob_ids.insert(*blob_id);
                    }
                    OracleResponse::Checkpoint { used_blobs, .. } => {
                        required_blob_ids.extend(used_blobs.iter().copied());
                    }
                    _ => {}
                }
            }
        }

        required_blob_ids
    }

    /// Returns whether any transaction in this outcome recorded oracle responses.
    pub fn has_oracle_responses(&self) -> bool {
        self.oracle_responses
            .iter()
            .any(|responses| !responses.is_empty())
    }

    /// Returns an iterator over the IDs of all blobs created in this outcome.
    pub fn iter_created_blobs_ids(&self) -> impl Iterator<Item = BlobId> + '_ {
        self.blobs.iter().flatten().map(|blob| blob.id())
    }
}

/// The data a block proposer signs.
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize, Allocative)]
pub struct ProposalContent {
    /// The proposed block.
    pub block: ProposedBlock,
    /// The consensus round in which this proposal is made.
    pub round: Round,
    /// If this is a retry from an earlier round, the execution outcome.
    #[debug(skip_if = Option::is_none)]
    pub outcome: Option<BlockExecutionOutcome>,
}

impl BlockProposal {
    /// Creates a new block proposal, signed by the given owner.
    pub async fn new_initial<S: Signer + ?Sized>(
        owner: AccountOwner,
        round: Round,
        block: ProposedBlock,
        signer: &S,
    ) -> Result<Self, S::Error> {
        let content = ProposalContent {
            round,
            block,
            outcome: None,
        };
        let signature = signer.sign(&owner, &CryptoHash::new(&content)).await?;

        Ok(Self {
            content,
            signature,
            original_proposal: None,
        })
    }

    /// Creates a proposal that retries a fast-round proposal in a later round.
    pub async fn new_retry_fast<S: Signer + ?Sized>(
        owner: AccountOwner,
        round: Round,
        old_proposal: BlockProposal,
        signer: &S,
    ) -> Result<Self, S::Error> {
        let content = ProposalContent {
            round,
            block: old_proposal.content.block,
            outcome: None,
        };
        let signature = signer.sign(&owner, &CryptoHash::new(&content)).await?;

        Ok(Self {
            content,
            signature,
            original_proposal: Some(OriginalProposal::Fast(old_proposal.signature)),
        })
    }

    /// Creates a proposal that retries a validated block from an earlier round.
    pub async fn new_retry_regular<S: Signer>(
        owner: AccountOwner,
        round: Round,
        validated_block_certificate: ValidatedBlockCertificate,
        signer: &S,
    ) -> Result<Self, S::Error> {
        let certificate = validated_block_certificate.lite_certificate().cloned();
        let block = validated_block_certificate.into_inner().into_inner();
        let (block, outcome) = block.into_proposal();
        let content = ProposalContent {
            block,
            round,
            outcome: Some(outcome),
        };
        let signature = signer.sign(&owner, &CryptoHash::new(&content)).await?;

        Ok(Self {
            content,
            signature,
            original_proposal: Some(OriginalProposal::Regular { certificate }),
        })
    }

    /// Returns the `AccountOwner` that proposed the block.
    pub fn owner(&self) -> AccountOwner {
        match self.signature {
            AccountSignature::Ed25519 { public_key, .. } => public_key.into(),
            AccountSignature::Secp256k1 { public_key, .. } => public_key.into(),
            AccountSignature::EvmSecp256k1 { address, .. } => AccountOwner::Address20(address),
        }
    }

    /// Verifies the signature on this proposal.
    pub fn check_signature(&self) -> Result<(), CryptoError> {
        self.signature.verify(&self.content)
    }

    /// Returns the IDs of the blobs that must be available to validate this proposal.
    pub fn required_blob_ids(&self) -> impl Iterator<Item = BlobId> + '_ {
        self.content.block.published_blob_ids().into_iter().chain(
            self.content
                .outcome
                .iter()
                .flat_map(|outcome| outcome.oracle_blob_ids()),
        )
    }

    /// Returns the IDs of the blobs that are required or created by this proposal.
    pub fn expected_blob_ids(&self) -> impl Iterator<Item = BlobId> + '_ {
        self.content.block.published_blob_ids().into_iter().chain(
            self.content.outcome.iter().flat_map(|outcome| {
                outcome
                    .oracle_blob_ids()
                    .into_iter()
                    .chain(outcome.iter_created_blobs_ids())
            }),
        )
    }

    /// Checks that the original proposal, if present, matches the new one and has a higher round.
    pub fn check_invariants(&self) -> Result<(), &'static str> {
        match (&self.original_proposal, &self.content.outcome) {
            (None, None) => {}
            (Some(OriginalProposal::Fast(_)), None) => ensure!(
                self.content.round > Round::Fast,
                "The new proposal's round must be greater than the original's"
            ),
            (None, Some(_))
            | (Some(OriginalProposal::Fast(_)), Some(_))
            | (Some(OriginalProposal::Regular { .. }), None) => {
                return Err("Must contain a validation certificate if and only if \
                     it contains the execution outcome from a previous round");
            }
            (Some(OriginalProposal::Regular { certificate }), Some(outcome)) => {
                ensure!(
                    self.content.round > certificate.round,
                    "The new proposal's round must be greater than the original's"
                );
                let block = outcome.clone().with(self.content.block.clone());
                let value = ValidatedBlock::new(block);
                ensure!(
                    certificate.check_value(&value),
                    "Lite certificate must match the given block and execution outcome"
                );
            }
        }
        Ok(())
    }
}

impl LiteVote {
    /// Uses the signing key to create a signed object.
    pub fn new(value: LiteValue, round: Round, secret_key: &ValidatorSecretKey) -> Self {
        let hash_and_round = VoteValue(value.value_hash, round, value.kind, None, false, None);
        let signature = ValidatorSignature::new(&hash_and_round, secret_key);
        Self {
            value,
            round,
            unlocking_round: None,
            first_round: false,
            justification_commitment: None,
            signature,
        }
    }

    /// Verifies the signature in the vote.
    pub fn check(&self, public_key: ValidatorPublicKey) -> Result<(), ChainError> {
        let hash_and_round = VoteValue(
            self.value.value_hash,
            self.round,
            self.value.kind,
            self.unlocking_round,
            self.first_round,
            self.justification_commitment,
        );
        Ok(self.signature.check(&hash_and_round, public_key)?)
    }
}

/// Helper for aggregating validator signatures on a value into a certificate.
pub struct SignatureAggregator<'a, T: CertificateValue> {
    committee: &'a Committee,
    weight: u64,
    used_validators: HashSet<ValidatorPublicKey>,
    partial: GenericCertificate<T>,
}

impl<'a, T: CertificateValue> SignatureAggregator<'a, T> {
    /// Starts aggregating signatures for the given value into a certificate whose voters signed
    /// the given unlocking round, first-round attestation and justification commitment (see
    /// [`VoteValue`]).
    pub fn new(
        value: T,
        round: Round,
        unlocking_round: Option<Round>,
        first_round: bool,
        justification_commitment: Option<CryptoHash>,
        committee: &'a Committee,
    ) -> Self {
        Self {
            committee,
            weight: 0,
            used_validators: HashSet::new(),
            partial: GenericCertificate::new_with_payload(
                value,
                round,
                unlocking_round,
                first_round,
                justification_commitment,
                Vec::new(),
            ),
        }
    }

    /// Tries to append a signature to a (partial) certificate. Returns Some(certificate) if a
    /// quorum was reached. The resulting final certificate is guaranteed to be valid in the sense
    /// of `check` below. Returns an error if the signed value cannot be aggregated.
    pub fn append(
        &mut self,
        public_key: ValidatorPublicKey,
        signature: ValidatorSignature,
    ) -> Result<Option<GenericCertificate<T>>, ChainError>
    where
        T: CertificateValue,
    {
        let hash_and_round = VoteValue(
            self.partial.hash(),
            self.partial.round,
            T::KIND,
            self.partial.unlocking_round(),
            self.partial.first_round(),
            self.partial.justification_commitment(),
        );
        signature.check(&hash_and_round, public_key)?;
        // Check that each validator only appears once.
        ensure!(
            !self.used_validators.contains(&public_key),
            ChainError::CertificateValidatorReuse
        );
        self.used_validators.insert(public_key);
        // Update weight.
        let voting_rights = self.committee.weight(&public_key);
        ensure!(voting_rights > 0, ChainError::InvalidSigner);
        self.weight += voting_rights;
        // Update certificate.
        self.partial.add_signature((public_key, signature));

        if self.weight >= self.committee.quorum_threshold() {
            self.weight = 0; // Prevent from creating the certificate twice.
            Ok(Some(self.partial.clone()))
        } else {
            Ok(None)
        }
    }
}

// Checks if the array slice is strictly ordered. That means that if the array
// has duplicates, this will return False, even if the array is sorted
pub(crate) fn is_strictly_ordered(values: &[(ValidatorPublicKey, ValidatorSignature)]) -> bool {
    values.windows(2).all(|pair| pair[0].0 < pair[1].0)
}

/// Verifies certificate signatures: that the signers form a quorum of the committee without
/// duplicates, and that every signature verifies over the given signed payload.
pub(crate) fn check_signatures(
    value: &VoteValue,
    signatures: &[(ValidatorPublicKey, ValidatorSignature)],
    committee: &Committee,
) -> Result<(), ChainError> {
    // Check the quorum.
    let mut weight = 0;
    let mut used_validators = HashSet::new();
    for (validator, _) in signatures {
        // Check that each validator only appears once.
        ensure!(
            !used_validators.contains(validator),
            ChainError::CertificateValidatorReuse
        );
        used_validators.insert(*validator);
        // Update weight.
        let voting_rights = committee.weight(validator);
        ensure!(voting_rights > 0, ChainError::InvalidSigner);
        weight += voting_rights;
    }
    ensure!(
        weight >= committee.quorum_threshold(),
        ChainError::CertificateRequiresQuorum
    );
    // All that is left is checking signatures!
    ValidatorSignature::verify_batch(value, signatures.iter())?;
    Ok(())
}

impl BcsSignable<'_> for ProposalContent {}

impl BcsSignable<'_> for VoteValue {}

doc_scalar!(
    MessageAction,
    "Whether an incoming message is accepted or rejected."
);

#[cfg(test)]
mod signing {
    use linera_base::{
        crypto::{AccountSecretKey, AccountSignature, CryptoHash, EvmSignature, TestString},
        data_types::{BlockHeight, Epoch, Round},
        identifiers::ChainId,
    };

    use crate::data_types::{BlockProposal, ProposalContent, ProposedBlock};

    #[test]
    fn proposal_content_signing() {
        use std::str::FromStr;

        // Generated in MetaMask.
        let secret_key = linera_base::crypto::EvmSecretKey::from_str(
            "f77a21701522a03b01c111ad2d2cdaf2b8403b47507ee0aec3c2e52b765d7a66",
        )
        .unwrap();
        let address = secret_key.address();

        let signer: AccountSecretKey = AccountSecretKey::EvmSecp256k1(secret_key);
        let public_key = signer.public();

        let proposed_block = ProposedBlock {
            chain_id: ChainId(CryptoHash::new(&TestString::new("ChainId"))),
            epoch: Epoch(11),
            transactions: vec![],
            height: BlockHeight(11),
            timestamp: 190000000u64.into(),
            authenticated_owner: None,
            previous_block_hash: None,
        };

        let proposal = ProposalContent {
            block: proposed_block,
            round: Round::SingleLeader(11),
            outcome: None,
        };

        // personal_sign of the `proposal_hash` done via MetaMask.
        // Wrap with proper variant so that bytes match (include the enum variant tag).
        let signature = EvmSignature::from_str(
            "d69d31203f59be441fd02cdf68b2504cbcdd7215905c9b7dc3a7ccbf09afe14550\
            3c93b391810ce9edd6ee36b1e817b2d0e9dabdf4a098da8c2f670ef4198e8a1b",
        )
        .unwrap();
        let metamask_signature = AccountSignature::EvmSecp256k1 {
            signature,
            address: address.0 .0,
        };

        let signature = signer.sign(&proposal);
        assert_eq!(signature, metamask_signature);

        assert_eq!(signature.owner(), public_key.into());

        let block_proposal = BlockProposal {
            content: proposal,
            signature,
            original_proposal: None,
        };
        assert_eq!(block_proposal.owner(), public_key.into(),);
    }
}