near-primitives 0.36.0

use crate::block_header::BlockHeader;
use crate::stateless_validation::chunk_endorsements_bitmap::ChunkEndorsementsBitmap;
use crate::types::validator_stake::{ValidatorStake, ValidatorStakeIter};
use crate::types::{AccountId, EpochId, ShardId, ValidatorStakeV1};
use borsh::{BorshDeserialize, BorshSerialize};
use near_primitives_core::hash::CryptoHash;
use near_primitives_core::types::{Balance, BlockHeight, ProtocolVersion};
use near_primitives_core::version::ProtocolFeature;
use near_schema_checker_lib::ProtocolSchema;
use std::collections::HashMap;

/// Information per each block.
#[derive(
    BorshSerialize, BorshDeserialize, Eq, PartialEq, Clone, Debug, serde::Serialize, ProtocolSchema,
)]
pub enum BlockInfo {
    V1(BlockInfoV1),
    V2(BlockInfoV2),
    V3(BlockInfoV3),
    V4(BlockInfoV4),
    V5(BlockInfoV5),
}

impl Default for BlockInfo {
    fn default() -> Self {
        Self::V4(BlockInfoV4::default())
    }
}

impl BlockInfo {
    #[allow(deprecated)]
    pub fn new(
        hash: CryptoHash,
        height: BlockHeight,
        last_finalized_height: BlockHeight,
        last_final_block_hash: CryptoHash,
        prev_hash: CryptoHash,
        proposals: Vec<ValidatorStake>,
        validator_mask: Vec<bool>,
        total_supply: Balance,
        current_protocol_version: ProtocolVersion,
        latest_protocol_version: ProtocolVersion,
        timestamp_nanosec: u64,
        chunk_endorsements: ChunkEndorsementsBitmap,
        shard_split: Option<(ShardId, AccountId)>,
    ) -> Self {
        if ProtocolFeature::DynamicResharding.enabled(current_protocol_version) {
            Self::V4(BlockInfoV4 {
                hash,
                height,
                last_finalized_height,
                last_final_block_hash,
                prev_hash,
                proposals,
                chunk_mask: validator_mask,
                latest_protocol_version,
                total_supply,
                epoch_first_block: Default::default(),
                epoch_id: Default::default(),
                timestamp_nanosec,
                chunk_endorsements,
                shard_split,
            })
        } else {
            Self::V3(BlockInfoV3 {
                hash,
                height,
                last_finalized_height,
                last_final_block_hash,
                prev_hash,
                epoch_first_block: Default::default(),
                epoch_id: Default::default(),
                proposals,
                chunk_mask: validator_mask,
                latest_protocol_version,
                slashed: Default::default(),
                total_supply,
                timestamp_nanosec,
                chunk_endorsements,
            })
        }
    }

    pub fn from_header(
        header: &BlockHeader,
        last_finalized_height: BlockHeight,
        current_protocol_version: ProtocolVersion,
    ) -> Self {
        BlockInfo::new(
            *header.hash(),
            header.height(),
            last_finalized_height,
            *header.last_final_block(),
            *header.prev_hash(),
            header.prev_validator_proposals().collect(),
            header.chunk_mask().to_vec(),
            header.total_supply(),
            current_protocol_version,
            header.latest_protocol_version(),
            header.raw_timestamp(),
            chunk_endorsements_from_header(header),
            header.shard_split().cloned(),
        )
    }

    /// Constructs BlockInfo for a spice chain. `last_certified_block_epoch`
    /// is supplied by the caller and read by EpochManager to decide whether
    /// to advance to the next epoch. In `ChainUpdate::postprocess_block` it
    /// is derived from `header.prev_hash()` rather than `header.hash()`,
    /// because the current block's uncertified-chunks tracking isn't written
    /// until later in the same update, so it reflects certification as of
    /// the parent block.
    pub fn from_spice_header(
        header: &BlockHeader,
        last_finalized_height: BlockHeight,
        last_certified_block_epoch: EpochId,
    ) -> Self {
        Self::V5(BlockInfoV5 {
            hash: *header.hash(),
            height: header.height(),
            last_finalized_height,
            last_final_block_hash: *header.last_final_block(),
            prev_hash: *header.prev_hash(),
            proposals: header.prev_validator_proposals().collect(),
            chunk_mask: header.chunk_mask().to_vec(),
            latest_protocol_version: header.latest_protocol_version(),
            total_supply: header.total_supply(),
            epoch_first_block: Default::default(),
            epoch_id: Default::default(),
            timestamp_nanosec: header.raw_timestamp(),
            chunk_endorsements: chunk_endorsements_from_header(header),
            shard_split: header.shard_split().cloned(),
            last_certified_block_epoch,
        })
    }

    #[inline]
    pub fn proposals_iter(&self) -> ValidatorStakeIter<'_> {
        match self {
            Self::V1(info) => ValidatorStakeIter::v1(&info.proposals),
            Self::V2(info) => ValidatorStakeIter::new(&info.proposals),
            Self::V3(info) => ValidatorStakeIter::new(&info.proposals),
            Self::V4(info) => ValidatorStakeIter::new(&info.proposals),
            Self::V5(info) => ValidatorStakeIter::new(&info.proposals),
        }
    }

    #[inline]
    pub fn hash(&self) -> &CryptoHash {
        match self {
            Self::V1(info) => &info.hash,
            Self::V2(info) => &info.hash,
            Self::V3(info) => &info.hash,
            Self::V4(info) => &info.hash,
            Self::V5(info) => &info.hash,
        }
    }

    #[inline]
    pub fn height(&self) -> BlockHeight {
        match self {
            Self::V1(info) => info.height,
            Self::V2(info) => info.height,
            Self::V3(info) => info.height,
            Self::V4(info) => info.height,
            Self::V5(info) => info.height,
        }
    }

    #[inline]
    pub fn last_finalized_height(&self) -> BlockHeight {
        match self {
            Self::V1(info) => info.last_finalized_height,
            Self::V2(info) => info.last_finalized_height,
            Self::V3(info) => info.last_finalized_height,
            Self::V4(info) => info.last_finalized_height,
            Self::V5(info) => info.last_finalized_height,
        }
    }

    #[inline]
    pub fn last_final_block_hash(&self) -> &CryptoHash {
        match self {
            Self::V1(info) => &info.last_final_block_hash,
            Self::V2(info) => &info.last_final_block_hash,
            Self::V3(info) => &info.last_final_block_hash,
            Self::V4(info) => &info.last_final_block_hash,
            Self::V5(info) => &info.last_final_block_hash,
        }
    }

    #[inline]
    pub fn prev_hash(&self) -> &CryptoHash {
        match self {
            Self::V1(info) => &info.prev_hash,
            Self::V2(info) => &info.prev_hash,
            Self::V3(info) => &info.prev_hash,
            Self::V4(info) => &info.prev_hash,
            Self::V5(info) => &info.prev_hash,
        }
    }

    #[inline]
    pub fn is_genesis(&self) -> bool {
        self.prev_hash() == &CryptoHash::default()
    }

    #[inline]
    pub fn epoch_first_block(&self) -> &CryptoHash {
        match self {
            Self::V1(info) => &info.epoch_first_block,
            Self::V2(info) => &info.epoch_first_block,
            Self::V3(info) => &info.epoch_first_block,
            Self::V4(info) => &info.epoch_first_block,
            Self::V5(info) => &info.epoch_first_block,
        }
    }

    #[inline]
    pub fn epoch_first_block_mut(&mut self) -> &mut CryptoHash {
        match self {
            Self::V1(info) => &mut info.epoch_first_block,
            Self::V2(info) => &mut info.epoch_first_block,
            Self::V3(info) => &mut info.epoch_first_block,
            Self::V4(info) => &mut info.epoch_first_block,
            Self::V5(info) => &mut info.epoch_first_block,
        }
    }

    #[inline]
    pub fn epoch_id(&self) -> &EpochId {
        match self {
            Self::V1(info) => &info.epoch_id,
            Self::V2(info) => &info.epoch_id,
            Self::V3(info) => &info.epoch_id,
            Self::V4(info) => &info.epoch_id,
            Self::V5(info) => &info.epoch_id,
        }
    }

    #[inline]
    pub fn epoch_id_mut(&mut self) -> &mut EpochId {
        match self {
            Self::V1(info) => &mut info.epoch_id,
            Self::V2(info) => &mut info.epoch_id,
            Self::V3(info) => &mut info.epoch_id,
            Self::V4(info) => &mut info.epoch_id,
            Self::V5(info) => &mut info.epoch_id,
        }
    }

    #[inline]
    pub fn chunk_mask(&self) -> &[bool] {
        match self {
            Self::V1(info) => &info.chunk_mask,
            Self::V2(info) => &info.chunk_mask,
            Self::V3(info) => &info.chunk_mask,
            Self::V4(info) => &info.chunk_mask,
            Self::V5(info) => &info.chunk_mask,
        }
    }

    #[inline]
    pub fn latest_protocol_version(&self) -> &ProtocolVersion {
        match self {
            Self::V1(info) => &info.latest_protocol_version,
            Self::V2(info) => &info.latest_protocol_version,
            Self::V3(info) => &info.latest_protocol_version,
            Self::V4(info) => &info.latest_protocol_version,
            Self::V5(info) => &info.latest_protocol_version,
        }
    }

    #[inline]
    pub fn total_supply(&self) -> &Balance {
        match self {
            Self::V1(info) => &info.total_supply,
            Self::V2(info) => &info.total_supply,
            Self::V3(info) => &info.total_supply,
            Self::V4(info) => &info.total_supply,
            Self::V5(info) => &info.total_supply,
        }
    }

    #[inline]
    pub fn timestamp_nanosec(&self) -> &u64 {
        match self {
            Self::V1(info) => &info.timestamp_nanosec,
            Self::V2(info) => &info.timestamp_nanosec,
            Self::V3(info) => &info.timestamp_nanosec,
            Self::V4(info) => &info.timestamp_nanosec,
            Self::V5(info) => &info.timestamp_nanosec,
        }
    }

    #[inline]
    pub fn chunk_endorsements(&self) -> Option<&ChunkEndorsementsBitmap> {
        match self {
            Self::V1(_) => None,
            Self::V2(_) => None,
            Self::V3(info) => Some(&info.chunk_endorsements),
            Self::V4(info) => Some(&info.chunk_endorsements),
            Self::V5(info) => Some(&info.chunk_endorsements),
        }
    }

    #[inline]
    pub fn shard_split(&self) -> Option<&(ShardId, AccountId)> {
        match self {
            Self::V1(_) => None,
            Self::V2(_) => None,
            Self::V3(_) => None,
            Self::V4(info) => info.shard_split.as_ref(),
            Self::V5(info) => info.shard_split.as_ref(),
        }
    }

    /// Epoch id of the last certified block reachable from this block.
    /// Populated only on spice chains. EpochManager uses it to hold the epoch
    /// transition until certification catches up.
    #[inline]
    pub fn last_certified_block_epoch(&self) -> Option<&EpochId> {
        match self {
            Self::V1(_) | Self::V2(_) | Self::V3(_) | Self::V4(_) => None,
            Self::V5(info) => Some(&info.last_certified_block_epoch),
        }
    }
}

fn chunk_endorsements_from_header(header: &BlockHeader) -> ChunkEndorsementsBitmap {
    header.chunk_endorsements().cloned().unwrap_or_else(|| {
        if header.is_genesis() {
            Default::default()
        } else {
            panic!("non-genesis header should include chunk endorsements")
        }
    })
}

/// BlockInfo used on spice chains. Carries `last_certified_block_epoch` so
/// EpochManager can hold the epoch transition until execution certification
/// has caught up.
#[derive(
    Default,
    BorshSerialize,
    BorshDeserialize,
    Eq,
    PartialEq,
    Clone,
    Debug,
    serde::Serialize,
    ProtocolSchema,
)]
pub struct BlockInfoV5 {
    pub hash: CryptoHash,
    pub height: BlockHeight,
    pub last_finalized_height: BlockHeight,
    pub last_final_block_hash: CryptoHash,
    pub prev_hash: CryptoHash,
    pub epoch_first_block: CryptoHash,
    pub epoch_id: EpochId,
    pub proposals: Vec<ValidatorStake>,
    pub chunk_mask: Vec<bool>,
    /// Latest protocol version this validator observes.
    pub latest_protocol_version: ProtocolVersion,
    /// Total supply at this block.
    pub total_supply: Balance,
    pub timestamp_nanosec: u64,
    pub chunk_endorsements: ChunkEndorsementsBitmap,
    /// Shard split information from the block header, used for dynamic resharding.
    pub shard_split: Option<(ShardId, AccountId)>,
    /// Epoch id of the last block whose chunk execution results are certified.
    pub last_certified_block_epoch: EpochId,
}

// V3 -> V4: Add shard_split for dynamic resharding, remove slashed
#[derive(
    Default,
    BorshSerialize,
    BorshDeserialize,
    Eq,
    PartialEq,
    Clone,
    Debug,
    serde::Serialize,
    ProtocolSchema,
)]
pub struct BlockInfoV4 {
    pub hash: CryptoHash,
    pub height: BlockHeight,
    pub last_finalized_height: BlockHeight,
    pub last_final_block_hash: CryptoHash,
    pub prev_hash: CryptoHash,
    pub epoch_first_block: CryptoHash,
    pub epoch_id: EpochId,
    pub proposals: Vec<ValidatorStake>,
    pub chunk_mask: Vec<bool>,
    /// Latest protocol version this validator observes.
    pub latest_protocol_version: ProtocolVersion,
    /// Total supply at this block.
    pub total_supply: Balance,
    pub timestamp_nanosec: u64,
    pub chunk_endorsements: ChunkEndorsementsBitmap,
    /// Shard split information from the block header, used for dynamic resharding.
    /// Only present on the last block of an epoch when a shard split is scheduled.
    pub shard_split: Option<(ShardId, AccountId)>,
}

// V2 -> V3: Add chunk_endorsements bitmap
#[derive(
    Default,
    BorshSerialize,
    BorshDeserialize,
    Eq,
    PartialEq,
    Clone,
    Debug,
    serde::Serialize,
    ProtocolSchema,
)]
pub struct BlockInfoV3 {
    pub hash: CryptoHash,
    pub height: BlockHeight,
    pub last_finalized_height: BlockHeight,
    pub last_final_block_hash: CryptoHash,
    pub prev_hash: CryptoHash,
    pub epoch_first_block: CryptoHash,
    pub epoch_id: EpochId,
    pub proposals: Vec<ValidatorStake>,
    pub chunk_mask: Vec<bool>,
    /// Latest protocol version this validator observes.
    pub latest_protocol_version: ProtocolVersion,
    /// Validators slashed since the start of epoch or in previous epoch.
    #[deprecated]
    pub slashed: HashMap<AccountId, SlashState>,
    /// Total supply at this block.
    pub total_supply: Balance,
    pub timestamp_nanosec: u64,
    pub chunk_endorsements: ChunkEndorsementsBitmap,
}

// V1 -> V2: Use versioned ValidatorStake structure in proposals
#[derive(
    Default,
    BorshSerialize,
    BorshDeserialize,
    Eq,
    PartialEq,
    Clone,
    Debug,
    serde::Serialize,
    ProtocolSchema,
)]
pub struct BlockInfoV2 {
    pub hash: CryptoHash,
    pub height: BlockHeight,
    pub last_finalized_height: BlockHeight,
    pub last_final_block_hash: CryptoHash,
    pub prev_hash: CryptoHash,
    pub epoch_first_block: CryptoHash,
    pub epoch_id: EpochId,
    pub proposals: Vec<ValidatorStake>,
    pub chunk_mask: Vec<bool>,
    /// Latest protocol version this validator observes.
    pub latest_protocol_version: ProtocolVersion,
    /// Validators slashed since the start of epoch or in previous epoch.
    #[deprecated]
    pub slashed: HashMap<AccountId, SlashState>,
    /// Total supply at this block.
    pub total_supply: Balance,
    pub timestamp_nanosec: u64,
}

/// Information per each block.
#[derive(
    Default,
    BorshSerialize,
    BorshDeserialize,
    Eq,
    PartialEq,
    Clone,
    Debug,
    serde::Serialize,
    ProtocolSchema,
)]
pub struct BlockInfoV1 {
    pub hash: CryptoHash,
    pub height: BlockHeight,
    pub last_finalized_height: BlockHeight,
    pub last_final_block_hash: CryptoHash,
    pub prev_hash: CryptoHash,
    pub epoch_first_block: CryptoHash,
    pub epoch_id: EpochId,
    pub proposals: Vec<ValidatorStakeV1>,
    pub chunk_mask: Vec<bool>,
    /// Latest protocol version this validator observes.
    pub latest_protocol_version: ProtocolVersion,
    /// Validators slashed since the start of epoch or in previous epoch.
    #[deprecated]
    pub slashed: HashMap<AccountId, SlashState>,
    /// Total supply at this block.
    pub total_supply: Balance,
    pub timestamp_nanosec: u64,
}

impl BlockInfoV1 {
    #[allow(deprecated)]
    pub fn new(
        hash: CryptoHash,
        height: BlockHeight,
        last_finalized_height: BlockHeight,
        last_final_block_hash: CryptoHash,
        prev_hash: CryptoHash,
        proposals: Vec<ValidatorStakeV1>,
        validator_mask: Vec<bool>,
        total_supply: Balance,
        latest_protocol_version: ProtocolVersion,
        timestamp_nanosec: u64,
    ) -> Self {
        Self {
            hash,
            height,
            last_finalized_height,
            last_final_block_hash,
            prev_hash,
            proposals,
            chunk_mask: validator_mask,
            latest_protocol_version,
            slashed: HashMap::new(),
            total_supply,
            epoch_first_block: Default::default(),
            epoch_id: Default::default(),
            timestamp_nanosec,
        }
    }
}

/// State that a slashed validator can be in.
#[derive(
    BorshSerialize, BorshDeserialize, serde::Serialize, Debug, Clone, PartialEq, Eq, ProtocolSchema,
)]
pub enum SlashState {
    /// Double Sign, will be partially slashed.
    DoubleSign,
    /// Malicious behavior but is already slashed (tokens taken away from account).
    AlreadySlashed,
    /// All other cases (tokens should be entirely slashed),
    Other,
}