25903914664-1

// Copyright (C) 2013-2020 Blockstack PBC, a public benefit corporation
// Copyright (C) 2020-2023 Stacks Open Internet Foundation
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

use std::collections::VecDeque;
use std::hash::{DefaultHasher, Hash, Hasher};
#[cfg(any(test, feature = "testing"))]
use std::sync::LazyLock;
use std::thread::{self, JoinHandle};
use std::time::{Duration, Instant};

use clarity::vm::costs::ExecutionCost;
use clarity::vm::events::StacksTransactionEvent;
use clarity::vm::types::{ResponseData, TupleData};
use clarity::vm::Value;
use regex::{Captures, Regex};
use serde::Deserialize;
use stacks_common::codec::{Error as CodecError, StacksMessageCodec, MAX_PAYLOAD_LEN};
use stacks_common::consts::CHAIN_ID_MAINNET;
use stacks_common::types::chainstate::{ConsensusHash, StacksBlockId};
use stacks_common::util::get_epoch_time_secs;
use stacks_common::util::hash::{hex_bytes, to_hex, Sha512Trunc256Sum};
#[cfg(any(test, feature = "testing"))]
use stacks_common::util::tests::TestFlag;

use crate::burnchains::Txid;
use crate::chainstate::burn::db::sortdb::{SortitionDB, SortitionHandleConn};
use crate::chainstate::nakamoto::miner::{MinerTenureInfoCause, NakamotoBlockBuilder};
use crate::chainstate::nakamoto::{NakamotoBlock, NakamotoChainState, NAKAMOTO_BLOCK_VERSION};
use crate::chainstate::stacks::address::PoxAddress;
use crate::chainstate::stacks::boot::PoxVersions;
use crate::chainstate::stacks::db::{StacksBlockHeaderTypes, StacksChainState, StacksHeaderInfo};
use crate::chainstate::stacks::miner::{
    BlockBuilder, BlockLimitFunction, TransactionError, TransactionProblematic, TransactionResult,
    TransactionSkipped,
};
use crate::chainstate::stacks::{Error as ChainError, StacksTransaction, TransactionPayload};
use crate::clarity_vm::clarity::ClarityError;
use crate::config::DEFAULT_MAX_TENURE_BYTES;
use crate::core::mempool::ProposalCallbackReceiver;
use crate::net::connection::ConnectionOptions;
use crate::net::http::{
    http_reason, parse_json, Error, HttpContentType, HttpRequest, HttpRequestContents,
    HttpRequestPreamble, HttpResponse, HttpResponseContents, HttpResponsePayload,
    HttpResponsePreamble,
};
use crate::net::httpcore::RPCRequestHandler;
use crate::net::{Error as NetError, StacksNodeState};
use crate::util_lib::db::Error as db_error;

/// Test flag to stall block validation per endpoint with a matching passphrase
#[cfg(any(test, feature = "testing"))]
pub static TEST_VALIDATE_STALL: LazyLock<TestFlag<Vec<Option<String>>>> =
    LazyLock::new(TestFlag::default);

#[cfg(any(test, feature = "testing"))]
/// Artificial delay to add to block validation.
pub static TEST_VALIDATE_DELAY_DURATION_SECS: LazyLock<TestFlag<u64>> =
    LazyLock::new(TestFlag::default);

#[cfg(any(test, feature = "testing"))]
/// Mock for the set of transactions that must be replayed
pub static TEST_REPLAY_TRANSACTIONS: LazyLock<
    TestFlag<std::collections::VecDeque<StacksTransaction>>,
> = LazyLock::new(TestFlag::default);

#[cfg(any(test, feature = "testing"))]
/// Whether to reject any transaction while we're in a replay set.
pub static TEST_REJECT_REPLAY_TXS: LazyLock<TestFlag<bool>> = LazyLock::new(TestFlag::default);

// This enum is used to supply a `reason_code` for validation
//  rejection responses. This is serialized as an enum with string
//  type (in jsonschema terminology).
define_u8_enum![ValidateRejectCode {
    BadBlockHash = 0,
    BadTransaction = 1,
    InvalidBlock = 2,
    ChainstateError = 3,
    UnknownParent = 4,
    NonCanonicalTenure = 5,
    NoSuchTenure = 6,
    InvalidTransactionReplay = 7,
    InvalidParentBlock = 8,
    InvalidTimestamp = 9,
    NetworkChainMismatch = 10,
    NotFoundError = 11,
    ProblematicTransaction = 12
}];

pub static TOO_MANY_REQUESTS_STATUS: u16 = 429;

impl TryFrom<u8> for ValidateRejectCode {
    type Error = CodecError;
    fn try_from(value: u8) -> Result<Self, Self::Error> {
        Self::from_u8(value)
            .ok_or_else(|| CodecError::DeserializeError(format!("Unknown type prefix: {value}")))
    }
}

fn hex_ser_block<S: serde::Serializer>(b: &NakamotoBlock, s: S) -> Result<S::Ok, S::Error> {
    let inst = to_hex(&b.serialize_to_vec());
    s.serialize_str(inst.as_str())
}

fn hex_deser_block<'de, D: serde::Deserializer<'de>>(d: D) -> Result<NakamotoBlock, D::Error> {
    let inst_str = String::deserialize(d)?;
    let bytes = hex_bytes(&inst_str).map_err(serde::de::Error::custom)?;
    NakamotoBlock::consensus_deserialize(&mut bytes.as_slice()).map_err(serde::de::Error::custom)
}

/// A response for block proposal validation
///  that the stacks-node thinks should be rejected.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct BlockValidateReject {
    pub signer_signature_hash: Sha512Trunc256Sum,
    pub reason: String,
    pub reason_code: ValidateRejectCode,
    /// The txid of the transaction that caused the block to be rejected, if any
    #[serde(default)]
    pub failed_txid: Option<Txid>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct BlockValidateRejectReason {
    pub reason: String,
    pub reason_code: ValidateRejectCode,
    /// The txid of the transaction that caused the block to be rejected, if any
    pub failed_txid: Option<Txid>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum BlockProposalResult {
    Accepted,
    Error,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct BlockProposalResponse {
    pub result: BlockProposalResult,
    pub message: String,
}

impl<T> From<T> for BlockValidateRejectReason
where
    T: Into<ChainError>,
{
    fn from(value: T) -> Self {
        let ce: ChainError = value.into();
        let reason_code = match ce {
            ChainError::DBError(db_error::NotFoundError) => ValidateRejectCode::NotFoundError,
            _ => ValidateRejectCode::ChainstateError,
        };
        Self {
            reason: format!("Chainstate Error: {ce}"),
            reason_code,
            failed_txid: None,
        }
    }
}

/// A response for block proposal validation
///  that the stacks-node thinks is acceptable.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct BlockValidateOk {
    pub signer_signature_hash: Sha512Trunc256Sum,
    pub cost: ExecutionCost,
    pub size: u64,
    pub validation_time_ms: u64,
    /// If a block was validated by a transaction replay set,
    /// then this returns `Some` with the hash of the replay set.
    pub replay_tx_hash: Option<u64>,
    /// If a block was validated by a transaction replay set,
    /// then this is true if this block exhausted the set of transactions.
    pub replay_tx_exhausted: bool,
}

/// This enum is used for serializing the response to block
/// proposal validation.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(tag = "result")]
pub enum BlockValidateResponse {
    Ok(BlockValidateOk),
    Reject(BlockValidateReject),
}

impl From<Result<BlockValidateOk, BlockValidateReject>> for BlockValidateResponse {
    fn from(value: Result<BlockValidateOk, BlockValidateReject>) -> Self {
        match value {
            Ok(o) => BlockValidateResponse::Ok(o),
            Err(e) => BlockValidateResponse::Reject(e),
        }
    }
}

impl BlockValidateResponse {
    /// Get the signer signature hash from the response
    pub fn signer_signature_hash(&self) -> &Sha512Trunc256Sum {
        match self {
            BlockValidateResponse::Ok(o) => &o.signer_signature_hash,
            BlockValidateResponse::Reject(r) => &r.signer_signature_hash,
        }
    }
}

#[cfg(any(test, feature = "testing"))]
fn fault_injection_validation_stall(auth_token: Option<String>) {
    if TEST_VALIDATE_STALL.get().contains(&auth_token) {
        // Do an extra check just so we don't log EVERY time.
        warn!("Block validation is stalled due to testing directive."; "auth_token" => ?auth_token);
        while TEST_VALIDATE_STALL.get().contains(&auth_token) {
            std::thread::sleep(std::time::Duration::from_millis(10));
        }
        info!(
            "Block validation is no longer stalled due to testing directive. Continuing..."; "auth_token" => ?auth_token
        );
    }
}

#[cfg(not(any(test, feature = "testing")))]
fn fault_injection_validation_stall(_auth_token: Option<String>) {}

#[cfg(any(test, feature = "testing"))]
fn fault_injection_validation_delay() {
    let delay = TEST_VALIDATE_DELAY_DURATION_SECS.get();
    if delay == 0 {
        return;
    }
    warn!("Sleeping for {} seconds to simulate slow processing", delay);
    thread::sleep(Duration::from_secs(delay));
}

#[cfg(not(any(test, feature = "testing")))]
fn fault_injection_validation_delay() {}

#[cfg(any(test, feature = "testing"))]
fn fault_injection_reject_replay_txs() -> Result<(), BlockValidateRejectReason> {
    let reject = TEST_REJECT_REPLAY_TXS.get();
    if reject {
        Err(BlockValidateRejectReason {
            reason_code: ValidateRejectCode::InvalidTransactionReplay,
            reason: "Rejected by test flag".into(),
            failed_txid: None,
        })
    } else {
        Ok(())
    }
}

#[cfg(not(any(test, feature = "testing")))]
fn fault_injection_reject_replay_txs() -> Result<(), BlockValidateRejectReason> {
    Ok(())
}

/// Represents a block proposed to the `v3/block_proposal` endpoint for validation
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct NakamotoBlockProposal {
    /// Proposed block
    #[serde(serialize_with = "hex_ser_block", deserialize_with = "hex_deser_block")]
    pub block: NakamotoBlock,
    /// Identifies which chain block is for (Mainnet, Testnet, etc.)
    pub chain_id: u32,
    /// Optional transaction replay set
    pub replay_txs: Option<Vec<StacksTransaction>>,
}

fn match_result_ok(value: &Value) -> Option<&Value> {
    let Value::Response(ResponseData { committed, data }) = value else {
        return None;
    };
    if !committed {
        return None;
    }
    Some(data.as_ref())
}

fn match_tuple(value: &Value) -> Option<&TupleData> {
    if let Value::Tuple(data) = value {
        Some(data)
    } else {
        None
    }
}

pub fn is_event_pox_addr_valid(is_mainnet: bool, event: &StacksTransactionEvent) -> bool {
    let StacksTransactionEvent::SmartContractEvent(event) = event else {
        // only smart contract events are relevant, so everything else is "okay"
        return true;
    };
    if !event.key.0.is_boot() {
        // only boot code events are relevant, so everything else is "okay"
        return true;
    }
    if event.key.0.name.as_str() != PoxVersions::Pox4.get_name_str() {
        // only pox events are relevant
        return true;
    }
    if &event.key.1 != "print" {
        // only look at print events
        return true;
    }
    let Some(pox_event_tuple) = match_result_ok(&event.value) else {
        // only care about (okay ...) results
        return true;
    };
    let Some(outer_tuple_data) = match_tuple(&pox_event_tuple) else {
        // should be unreachable
        return true;
    };
    let Ok(data_tuple) = outer_tuple_data.get("data") else {
        // should be unreachable
        return true;
    };
    let Some(data_tuple_data) = match_tuple(&data_tuple) else {
        // should be unreachable
        return true;
    };
    let Ok(pox_addr_tuple) = data_tuple_data.get("pox-addr") else {
        // should be unreachable
        return true;
    };

    let pox_addr_value = if let Value::Optional(data) = pox_addr_tuple {
        match data.data {
            None => return true,
            Some(ref inner) => inner.as_ref(),
        }
    } else {
        pox_addr_tuple
    };

    PoxAddress::try_from_pox_tuple(is_mainnet, pox_addr_value).is_some()
}

impl NakamotoBlockProposal {
    fn spawn_validation_thread(
        self,
        sortdb: SortitionDB,
        mut chainstate: StacksChainState,
        receiver: Box<dyn ProposalCallbackReceiver>,
        connection_opts: &ConnectionOptions,
    ) -> Result<JoinHandle<()>, std::io::Error> {
        let timeout_secs = connection_opts.block_proposal_validation_timeout_secs;
        let auth_token = connection_opts.auth_token.clone();
        thread::Builder::new()
            .name("block-proposal".into())
            .spawn(move || {
                let result = self
                    .validate(&sortdb, &mut chainstate, timeout_secs, auth_token)
                    .map_err(|reason| BlockValidateReject {
                        signer_signature_hash: self.block.header.signer_signature_hash(),
                        reason_code: reason.reason_code,
                        reason: reason.reason,
                        failed_txid: reason.failed_txid,
                    });
                receiver.notify_proposal_result(result);
            })
    }

    /// DO NOT CALL FROM CONSENSUS CODE
    ///
    /// Check to see if a block builds atop the highest block in a given tenure.
    /// That is:
    /// - its parent must exist, and
    /// - its parent must be as high as the highest block in the given tenure.
    fn check_block_builds_on_highest_block_in_tenure(
        chainstate: &StacksChainState,
        sortdb: &SortitionDB,
        tenure_id: &ConsensusHash,
        parent_block_id: &StacksBlockId,
    ) -> Result<(), BlockValidateRejectReason> {
        let Some(highest_header) = NakamotoChainState::find_highest_known_block_header_in_tenure(
            chainstate, sortdb, tenure_id,
        )
        .map_err(|e| BlockValidateRejectReason {
            reason_code: ValidateRejectCode::ChainstateError,
            reason: format!("Failed to query highest block in tenure ID: {:?}", &e),
            failed_txid: None,
        })?
        else {
            warn!(
                "Rejected block proposal";
                "reason" => "Block is not a tenure-start block, and has an unrecognized tenure consensus hash",
                "consensus_hash" => %tenure_id,
            );
            return Err(BlockValidateRejectReason {
                reason_code: ValidateRejectCode::NoSuchTenure,
                reason: "Block is not a tenure-start block, and has an unrecognized tenure consensus hash".into(),
                failed_txid: None,
            });
        };
        let Some(parent_header) =
            NakamotoChainState::get_block_header(chainstate.db(), parent_block_id).map_err(
                |e| BlockValidateRejectReason {
                    reason_code: ValidateRejectCode::ChainstateError,
                    reason: format!("Failed to query block header by block ID: {:?}", &e),
                    failed_txid: None,
                },
            )?
        else {
            warn!(
                "Rejected block proposal";
                "reason" => "Block has no parent",
                "parent_block_id" => %parent_block_id
            );
            return Err(BlockValidateRejectReason {
                reason_code: ValidateRejectCode::UnknownParent,
                reason: "Block has no parent".into(),
                failed_txid: None,
            });
        };
        if parent_header.anchored_header.height() != highest_header.anchored_header.height() {
            warn!(
                "Rejected block proposal";
                "reason" => "Block's parent is not the highest block in this tenure",
                "consensus_hash" => %tenure_id,
                "parent_header.height" => parent_header.anchored_header.height(),
                "highest_header.height" => highest_header.anchored_header.height(),
            );
            return Err(BlockValidateRejectReason {
                reason_code: ValidateRejectCode::InvalidParentBlock,
                reason: "Block is not higher than the highest block in its tenure".into(),
                failed_txid: None,
            });
        }
        Ok(())
    }

    /// Verify that the block we received builds upon a valid tenure.
    /// Implemented as a static function to facilitate testing.
    pub(crate) fn check_block_has_valid_tenure(
        db_handle: &SortitionHandleConn,
        tenure_id: &ConsensusHash,
    ) -> Result<(), BlockValidateRejectReason> {
        // Verify that the block's tenure is on the canonical sortition history
        if !db_handle.has_consensus_hash(tenure_id)? {
            warn!(
                "Rejected block proposal";
                "reason" => "Block's tenure consensus hash is not on the canonical Bitcoin fork",
                "consensus_hash" => %tenure_id,
            );
            return Err(BlockValidateRejectReason {
                reason_code: ValidateRejectCode::NonCanonicalTenure,
                reason: "Tenure consensus hash is not on the canonical Bitcoin fork".into(),
                failed_txid: None,
            });
        }
        Ok(())
    }

    /// Verify that the block we received builds on the highest block in its tenure.
    /// * For tenure-start blocks, the parent must be as high as the highest block in the parent
    /// block's tenure.
    /// * For all other blocks, the parent must be as high as the highest block in the tenure.
    ///
    /// Implemented as a static function to facilitate testing
    pub(crate) fn check_block_has_valid_parent(
        chainstate: &StacksChainState,
        sortdb: &SortitionDB,
        block: &NakamotoBlock,
    ) -> Result<(), BlockValidateRejectReason> {
        let is_tenure_start =
            block
                .is_wellformed_tenure_start_block()
                .map_err(|_| BlockValidateRejectReason {
                    reason_code: ValidateRejectCode::InvalidBlock,
                    reason: "Block is not well-formed".into(),
                    failed_txid: None,
                })?;

        if !is_tenure_start {
            // this is a well-formed block that is not the start of a tenure, so it must build
            // atop an existing block in its tenure.
            Self::check_block_builds_on_highest_block_in_tenure(
                chainstate,
                sortdb,
                &block.header.consensus_hash,
                &block.header.parent_block_id,
            )?;
        } else {
            // this is a tenure-start block, so it must build atop a parent which has the
            // highest height in the *previous* tenure.
            let parent_header = NakamotoChainState::get_block_header(
                chainstate.db(),
                &block.header.parent_block_id,
            )?
            .ok_or_else(|| BlockValidateRejectReason {
                reason_code: ValidateRejectCode::UnknownParent,
                reason: "No parent block".into(),
                failed_txid: None,
            })?;

            Self::check_block_builds_on_highest_block_in_tenure(
                chainstate,
                sortdb,
                &parent_header.consensus_hash,
                &block.header.parent_block_id,
            )?;
        }
        Ok(())
    }

    /// Test this block proposal against the current chain state and
    /// either accept or reject the proposal
    ///
    /// This is done in 3 stages:
    /// - Static validation of the block, which checks the following:
    ///   - Block header is well-formed
    ///   - Transactions are well-formed
    ///   - Miner signature is valid
    /// - Validation of transactions by executing them agains current chainstate.
    ///   This is resource intensive, and therefore done only if previous checks pass
    ///
    /// During transaction replay, we also check that the block only contains the unmined
    /// transactions that need to be replayed, up until either:
    /// - The set of transactions that must be replayed is exhausted
    /// - A cost limit is hit
    pub fn validate(
        &self,
        sortdb: &SortitionDB,
        chainstate: &mut StacksChainState, // not directly used; used as a handle to open other chainstates
        timeout_secs: u64,
        auth_token: Option<String>,
    ) -> Result<BlockValidateOk, BlockValidateRejectReason> {
        fault_injection_validation_stall(auth_token);
        let start = Instant::now();

        fault_injection_validation_delay();

        let mainnet = self.chain_id == CHAIN_ID_MAINNET;
        if self.chain_id != chainstate.chain_id || mainnet != chainstate.mainnet {
            warn!(
                "Rejected block proposal";
                "reason" => "Wrong network/chain_id",
                "expected_chain_id" => chainstate.chain_id,
                "expected_mainnet" => chainstate.mainnet,
                "received_chain_id" => self.chain_id,
                "received_mainnet" => mainnet,
            );
            return Err(BlockValidateRejectReason {
                reason_code: ValidateRejectCode::NetworkChainMismatch,
                reason: "Wrong network/chain_id".into(),
                failed_txid: None,
            });
        }

        // Check block version. If it's less than the compiled-in version, just emit a warning
        // because there's a new version of the node / signer binary available that really ought to
        // be used (hint, hint)
        if self.block.header.version != NAKAMOTO_BLOCK_VERSION {
            warn!("Proposed block has unexpected version. Upgrade your node and/or signer ASAP.";
                  "block.header.version" => %self.block.header.version,
                  "expected" => %NAKAMOTO_BLOCK_VERSION);
        }

        // open sortition view to the current burn view.
        // If the block has a TenureChange with an Extend cause, then the burn view is whatever is
        // indicated in the TenureChange.
        // Otherwise, it's the same as the block's parent's burn view.
        let parent_stacks_header = NakamotoChainState::get_block_header(
            chainstate.db(),
            &self.block.header.parent_block_id,
        )?
        .ok_or_else(|| BlockValidateRejectReason {
            reason_code: ValidateRejectCode::UnknownParent,
            reason: "Unknown parent block".into(),
            failed_txid: None,
        })?;

        let burn_view_consensus_hash =
            NakamotoChainState::get_block_burn_view(sortdb, &self.block, &parent_stacks_header)?;
        let sort_tip =
            SortitionDB::get_block_snapshot_consensus(sortdb.conn(), &burn_view_consensus_hash)?
                .ok_or_else(|| BlockValidateRejectReason {
                    reason_code: ValidateRejectCode::NoSuchTenure,
                    reason: "Failed to find sortition for block tenure".to_string(),
                    failed_txid: None,
                })?;

        let burn_dbconn: SortitionHandleConn = sortdb.index_handle(&sort_tip.sortition_id);
        let db_handle = sortdb.index_handle(&sort_tip.sortition_id);

        // (For the signer)
        // Verify that the block's tenure is on the canonical sortition history
        Self::check_block_has_valid_tenure(&db_handle, &self.block.header.consensus_hash)?;

        // (For the signer)
        // Verify that this block's parent is the highest such block we can build off of
        Self::check_block_has_valid_parent(chainstate, sortdb, &self.block)?;

        // get the burnchain tokens spent for this block. There must be a record of this (i.e.
        // there must be a block-commit for this), or otherwise this block doesn't correspond to
        // any burnchain chainstate.
        let expected_burn_opt =
            NakamotoChainState::get_expected_burns(&db_handle, chainstate.db(), &self.block)?;
        if expected_burn_opt.is_none() {
            warn!(
                "Rejected block proposal";
                "reason" => "Failed to find parent expected burns",
            );
            return Err(BlockValidateRejectReason {
                reason_code: ValidateRejectCode::UnknownParent,
                reason: "Failed to find parent expected burns".into(),
                failed_txid: None,
            });
        };

        // Static validation checks
        NakamotoChainState::validate_normal_nakamoto_block_burnchain(
            chainstate.nakamoto_blocks_db(),
            &db_handle,
            expected_burn_opt,
            &self.block,
            mainnet,
            self.chain_id,
        )?;

        // Validate txs against chainstate

        // Validate the block's timestamp. It must be:
        // - Greater than the parent block's timestamp
        // - At most 15 seconds into the future
        if let StacksBlockHeaderTypes::Nakamoto(parent_nakamoto_header) =
            &parent_stacks_header.anchored_header
        {
            if self.block.header.timestamp <= parent_nakamoto_header.timestamp {
                warn!(
                    "Rejected block proposal";
                    "reason" => "Block timestamp is not greater than parent block",
                    "block_timestamp" => self.block.header.timestamp,
                    "parent_block_timestamp" => parent_nakamoto_header.timestamp,
                );
                return Err(BlockValidateRejectReason {
                    reason_code: ValidateRejectCode::InvalidTimestamp,
                    reason: "Block timestamp is not greater than parent block".into(),
                    failed_txid: None,
                });
            }
        }
        if self.block.header.timestamp > get_epoch_time_secs() + 15 {
            warn!(
                "Rejected block proposal";
                "reason" => "Block timestamp is too far into the future",
                "block_timestamp" => self.block.header.timestamp,
                "current_time" => get_epoch_time_secs(),
            );
            return Err(BlockValidateRejectReason {
                reason_code: ValidateRejectCode::InvalidTimestamp,
                reason: "Block timestamp is too far into the future".into(),
                failed_txid: None,
            });
        }

        if self.block.header.chain_length
            != parent_stacks_header.stacks_block_height.saturating_add(1)
        {
            warn!(
                "Rejected block proposal";
                "reason" => "Block height is non-contiguous with parent",
                "block_height" => self.block.header.chain_length,
                "parent_block_height" => parent_stacks_header.stacks_block_height,
            );
            return Err(BlockValidateRejectReason {
                reason_code: ValidateRejectCode::InvalidBlock,
                reason: "Block height is non-contiguous with parent".into(),
                failed_txid: None,
            });
        }

        let tenure_change = self
            .block
            .txs
            .iter()
            .find(|tx| matches!(tx.payload, TransactionPayload::TenureChange(..)));
        let coinbase = self
            .block
            .txs
            .iter()
            .find(|tx| matches!(tx.payload, TransactionPayload::Coinbase(..)));
        let tenure_cause = tenure_change
            .and_then(|tx| match &tx.payload {
                TransactionPayload::TenureChange(tc) => Some(MinerTenureInfoCause::from(tc)),
                _ => None,
            })
            .unwrap_or_else(|| MinerTenureInfoCause::NoTenureChange);

        let replay_tx_exhausted = self.validate_replay(
            &parent_stacks_header,
            tenure_change,
            coinbase,
            tenure_cause,
            chainstate,
            &burn_dbconn,
        )?;

        let mut builder = NakamotoBlockBuilder::new(
            &parent_stacks_header,
            &self.block.header.consensus_hash,
            self.block.header.burn_spent,
            tenure_change,
            coinbase,
            self.block.header.pox_treatment.len(),
            None,
            None,
            Some(self.block.header.timestamp),
            u64::from(DEFAULT_MAX_TENURE_BYTES),
        )?;

        let mut miner_tenure_info =
            builder.load_tenure_info(chainstate, &burn_dbconn, tenure_cause)?;
        let burn_chain_height = miner_tenure_info.burn_tip_height;
        let mut tenure_tx = builder.tenure_begin(&burn_dbconn, &mut miner_tenure_info)?;

        let block_deadline = Instant::now() + Duration::from_secs(timeout_secs);
        let mut receipts_total = 0u64;
        for (i, tx) in self.block.txs.iter().enumerate() {
            let remaining = block_deadline.saturating_duration_since(Instant::now());

            let tx_len = tx.tx_len();

            let tx_result = builder.try_mine_tx_with_len(
                &mut tenure_tx,
                tx,
                tx_len,
                &BlockLimitFunction::NO_LIMIT_HIT,
                Some(remaining),
                &mut receipts_total,
            );
            let reason = match tx_result {
                TransactionResult::Success(success_result) => {
                    let all_events_valid = success_result
                        .receipt
                        .events
                        .iter()
                        .all(|event| is_event_pox_addr_valid(mainnet, event));
                    if !all_events_valid {
                        Some((
                            format!("Problematic tx {i}: contains invalid pox address"),
                            ValidateRejectCode::ProblematicTransaction,
                        ))
                    } else {
                        None
                    }
                }
                TransactionResult::Skipped(s) => Some((
                    format!("tx {i} skipped: {}", s.error),
                    ValidateRejectCode::BadTransaction,
                )),
                TransactionResult::ProcessingError(e) => Some((
                    format!("Error processing tx {i}: {}", e.error),
                    ValidateRejectCode::BadTransaction,
                )),
                TransactionResult::Problematic(p) => Some((
                    format!("Problematic tx {i}: {}", p.error),
                    ValidateRejectCode::ProblematicTransaction,
                )),
            };
            if let Some((reason, reject_code)) = reason {
                warn!(
                    "Rejected block proposal";
                    "reason" => %reason,
                    "tx" => ?tx,
                );
                return Err(BlockValidateRejectReason {
                    reason,
                    reason_code: reject_code,
                    failed_txid: Some(tx.txid()),
                });
            }
        }

        let mut block = builder.mine_nakamoto_block(&mut tenure_tx, burn_chain_height);
        // Override the block version with the one from the proposal. This must be
        // done before computing the block hash, because the block hash includes the
        // version in its computation.
        block.header.version = self.block.header.version;
        let size = builder.get_bytes_so_far();
        let cost = builder.tenure_finish(tenure_tx)?;

        // Clone signatures from block proposal
        // These have already been validated by `validate_nakamoto_block_burnchain()``
        block.header.miner_signature = self.block.header.miner_signature.clone();
        block
            .header
            .signer_signature
            .clone_from(&self.block.header.signer_signature);

        // Assuming `tx_merkle_root` has been checked we don't need to hash the whole block
        let expected_block_header_hash = self.block.header.block_hash();
        let computed_block_header_hash = block.header.block_hash();

        if computed_block_header_hash != expected_block_header_hash {
            warn!(
                "Rejected block proposal";
                "reason" => "Block hash is not as expected",
                "expected_block_header_hash" => %expected_block_header_hash,
                "computed_block_header_hash" => %computed_block_header_hash,
                "expected_block" => ?self.block,
                "computed_block" => ?block,
            );
            return Err(BlockValidateRejectReason {
                reason: "Block hash is not as expected".into(),
                reason_code: ValidateRejectCode::BadBlockHash,
                failed_txid: None,
            });
        }

        let validation_time_ms = u64::try_from(start.elapsed().as_millis()).unwrap_or(u64::MAX);

        info!(
            "Participant: validated anchored block";
            "block_header_hash" => %computed_block_header_hash,
            "height" => block.header.chain_length,
            "tx_count" => block.txs.len(),
            "parent_stacks_block_id" => %block.header.parent_block_id,
            "block_size" => size,
            "execution_cost" => %cost,
            "validation_time_ms" => validation_time_ms,
            "tx_fees_microstacks" => block.txs.iter().fold(0, |agg: u64, tx| {
                agg.saturating_add(tx.get_tx_fee())
            })
        );

        let replay_tx_hash = Self::tx_replay_hash(&self.replay_txs);

        Ok(BlockValidateOk {
            signer_signature_hash: block.header.signer_signature_hash(),
            cost,
            size,
            validation_time_ms,
            replay_tx_hash,
            replay_tx_exhausted,
        })
    }

    pub fn tx_replay_hash(replay_txs: &Option<Vec<StacksTransaction>>) -> Option<u64> {
        replay_txs.as_ref().map(|txs| {
            let mut hasher = DefaultHasher::new();
            txs.hash(&mut hasher);
            hasher.finish()
        })
    }

    /// Validate the block against the replay set.
    ///
    /// Returns a boolean indicating whether this block exhausts the replay set.
    ///
    /// Returns `false` if there is no replay set.
    fn validate_replay(
        &self,
        parent_stacks_header: &StacksHeaderInfo,
        tenure_change: Option<&StacksTransaction>,
        coinbase: Option<&StacksTransaction>,
        tenure_cause: MinerTenureInfoCause,
        // not directly used; used as a handle to open other chainstates
        chainstate_handle: &StacksChainState,
        burn_dbconn: &SortitionHandleConn,
    ) -> Result<bool, BlockValidateRejectReason> {
        let mut replay_txs_maybe: Option<VecDeque<StacksTransaction>> =
            self.replay_txs.clone().map(|txs| txs.into());

        let Some(ref mut replay_txs) = replay_txs_maybe else {
            return Ok(false);
        };

        let mut replay_builder = NakamotoBlockBuilder::new(
            &parent_stacks_header,
            &self.block.header.consensus_hash,
            self.block.header.burn_spent,
            tenure_change,
            coinbase,
            self.block.header.pox_treatment.len(),
            None,
            None,
            Some(self.block.header.timestamp),
            u64::from(DEFAULT_MAX_TENURE_BYTES),
        )?;
        let (mut replay_chainstate, _) = chainstate_handle.reopen()?;
        let mut replay_miner_tenure_info =
            replay_builder.load_tenure_info(&mut replay_chainstate, &burn_dbconn, tenure_cause)?;
        let mut replay_tenure_tx =
            replay_builder.tenure_begin(&burn_dbconn, &mut replay_miner_tenure_info)?;

        let mut total_receipts = 0;
        for (i, tx) in self.block.txs.iter().enumerate() {
            let tx_len = tx.tx_len();

            // If a list of replay transactions is set, this transaction must be the next
            // mineable transaction from this list.
            loop {
                if matches!(
                    tx.payload,
                    TransactionPayload::TenureChange(..) | TransactionPayload::Coinbase(..)
                ) {
                    // Allow this to happen, tenure extend checks happen elsewhere.
                    break;
                }
                fault_injection_reject_replay_txs()?;
                let Some(replay_tx) = replay_txs.pop_front() else {
                    // During transaction replay, we expect that the block only
                    // contains transactions from the replay set. Thus, if we're here,
                    // the block contains a transaction that is not in the replay set,
                    // and we should reject the block.
                    warn!("Rejected block proposal. Block contains transactions beyond the replay set.";
                        "txid" => %tx.txid(),
                        "tx_index" => i,
                    );
                    return Err(BlockValidateRejectReason {
                        reason_code: ValidateRejectCode::InvalidTransactionReplay,
                        reason: "Block contains transactions beyond the replay set".into(),
                        failed_txid: Some(tx.txid()),
                    });
                };
                if replay_tx.txid() == tx.txid() {
                    break;
                }

                // The included tx doesn't match the next tx in the
                // replay set. Check to see if the tx is skipped because
                // it was unmineable.
                let tx_result = replay_builder.try_mine_tx_with_len(
                    &mut replay_tenure_tx,
                    &replay_tx,
                    replay_tx.tx_len(),
                    &BlockLimitFunction::NO_LIMIT_HIT,
                    None,
                    &mut total_receipts,
                );
                match tx_result {
                    TransactionResult::Skipped(TransactionSkipped { error, .. })
                    | TransactionResult::ProcessingError(TransactionError { error, .. })
                    | TransactionResult::Problematic(TransactionProblematic { error, .. }) => {
                        // The tx wasn't able to be mined. Check the underlying error, to
                        // see if we should reject the block or allow the tx to be
                        // dropped from the replay set.

                        match error {
                            ChainError::CostOverflowError(..)
                            | ChainError::BlockTooBigError
                            | ChainError::BlockCostLimitError
                            | ChainError::ClarityError(ClarityError::CostError(..)) => {
                                // block limit reached; add tx back to replay set.
                                // BUT we know that the block should have ended at this point, so
                                // return an error.
                                let txid = replay_tx.txid();
                                replay_txs.push_front(replay_tx);

                                warn!("Rejecting block proposal. Next replay tx exceeds cost limits, so should have been in the next block.";
                                    "error" => %error,
                                    "txid" => %txid,
                                );

                                return Err(BlockValidateRejectReason {
                                    reason_code: ValidateRejectCode::InvalidTransactionReplay,
                                    reason: "Next replay tx exceeds cost limits, so should have been in the next block.".into(),
                                    failed_txid: None,
                                });
                            }
                            _ => {
                                info!("During replay block validation, allowing problematic tx to be dropped";
                                    "txid" => %replay_tx.txid(),
                                    "error" => %error,
                                );
                                // it's ok, drop it
                                continue;
                            }
                        }
                    }
                    TransactionResult::Success(_) => {
                        // Tx should have been included
                        warn!("Rejected block proposal. Block doesn't contain replay transaction that should have been included.";
                            "block_txid" => %tx.txid(),
                            "block_tx_index" => i,
                            "replay_txid" => %replay_tx.txid(),
                        );
                        return Err(BlockValidateRejectReason {
                            reason_code: ValidateRejectCode::InvalidTransactionReplay,
                            reason: "Transaction is not in the replay set".into(),
                            failed_txid: Some(tx.txid()),
                        });
                    }
                };
            }

            // Apply the block's transaction to our block builder, but we don't
            // actually care about the result - that happens in the main
            // validation check.
            let _tx_result = replay_builder.try_mine_tx_with_len(
                &mut replay_tenure_tx,
                tx,
                tx_len,
                &BlockLimitFunction::NO_LIMIT_HIT,
                None,
                &mut total_receipts,
            );
        }

        let no_replay_txs_remaining = replay_txs.is_empty();

        // Now, we need to check if the remaining replay transactions are unmineable.
        let only_unmineable_remaining = !replay_txs.is_empty()
            && replay_txs.iter().all(|tx| {
                let tx_result = replay_builder.try_mine_tx_with_len(
                    &mut replay_tenure_tx,
                    &tx,
                    tx.tx_len(),
                    &BlockLimitFunction::NO_LIMIT_HIT,
                    None,
                    &mut total_receipts,
                );
                match tx_result {
                    TransactionResult::Skipped(TransactionSkipped { error, .. })
                    | TransactionResult::ProcessingError(TransactionError { error, .. })
                    | TransactionResult::Problematic(TransactionProblematic { error, .. }) => {
                        // If it's just a cost error, it's not unmineable.
                        !matches!(
                            error,
                            ChainError::CostOverflowError(..)
                                | ChainError::BlockTooBigError
                                | ChainError::ClarityError(ClarityError::CostError(..))
                                | ChainError::BlockCostLimitError
                        )
                    }
                    TransactionResult::Success(_) => {
                        // The tx could have been included, but wasn't. This is ok, but we
                        // haven't exhausted the replay set.
                        false
                    }
                }
            });

        Ok(no_replay_txs_remaining || only_unmineable_remaining)
    }
}

#[derive(Clone, Default)]
pub struct RPCBlockProposalRequestHandler {
    pub block_proposal: Option<NakamotoBlockProposal>,
    pub auth: Option<String>,
}

impl RPCBlockProposalRequestHandler {
    pub fn new(auth: Option<String>) -> Self {
        Self {
            block_proposal: None,
            auth,
        }
    }

    /// Decode a JSON-encoded block proposal
    fn parse_json(body: &[u8]) -> Result<NakamotoBlockProposal, Error> {
        serde_json::from_slice(body)
            .map_err(|e| Error::DecodeError(format!("Failed to parse body: {e}")))
    }
}

/// Decode the HTTP request
impl HttpRequest for RPCBlockProposalRequestHandler {
    fn verb(&self) -> &'static str {
        "POST"
    }

    fn path_regex(&self) -> Regex {
        Regex::new(r#"^/v3/block_proposal$"#).unwrap()
    }

    fn metrics_identifier(&self) -> &str {
        "/v3/block_proposal"
    }

    /// Try to decode this request.
    /// There's nothing to load here, so just make sure the request is well-formed.
    fn try_parse_request(
        &mut self,
        preamble: &HttpRequestPreamble,
        _captures: &Captures,
        query: Option<&str>,
        body: &[u8],
    ) -> Result<HttpRequestContents, Error> {
        // If no authorization is set, then the block proposal endpoint is not enabled
        let Some(password) = &self.auth else {
            return Err(Error::Http(400, "Bad Request.".into()));
        };
        let Some(auth_header) = preamble.headers.get("authorization") else {
            return Err(Error::Http(401, "Unauthorized".into()));
        };
        if auth_header != password {
            return Err(Error::Http(401, "Unauthorized".into()));
        }
        if preamble.get_content_length() == 0 {
            return Err(Error::DecodeError(
                "Invalid Http request: expected non-zero-length body for block proposal endpoint"
                    .to_string(),
            ));
        }
        if preamble.get_content_length() > MAX_PAYLOAD_LEN {
            return Err(Error::DecodeError(
                "Invalid Http request: BlockProposal body is too big".to_string(),
            ));
        }

        let block_proposal = match preamble.content_type {
            Some(HttpContentType::JSON) => Self::parse_json(body)?,
            Some(_) => {
                return Err(Error::DecodeError(
                    "Wrong Content-Type for block proposal; expected application/json".to_string(),
                ))
            }
            None => {
                return Err(Error::DecodeError(
                    "Missing Content-Type for block proposal".to_string(),
                ))
            }
        };

        if block_proposal.block.is_shadow_block() {
            return Err(Error::DecodeError(
                "Shadow blocks cannot be submitted for validation".to_string(),
            ));
        }

        self.block_proposal = Some(block_proposal);
        Ok(HttpRequestContents::new().query_string(query))
    }
}

struct ProposalThreadInfo {
    sortdb: SortitionDB,
    chainstate: StacksChainState,
    receiver: Box<dyn ProposalCallbackReceiver>,
}

impl RPCRequestHandler for RPCBlockProposalRequestHandler {
    /// Reset internal state
    fn restart(&mut self) {
        self.block_proposal = None
    }

    /// Make the response
    fn try_handle_request(
        &mut self,
        preamble: HttpRequestPreamble,
        _contents: HttpRequestContents,
        node: &mut StacksNodeState,
    ) -> Result<(HttpResponsePreamble, HttpResponseContents), NetError> {
        let block_proposal = self
            .block_proposal
            .take()
            .ok_or(NetError::SendError("`block_proposal` not set".into()))?;

        info!(
            "Received block proposal request";
            "signer_signature_hash" => %block_proposal.block.header.signer_signature_hash(),
            "block_header_hash" => %block_proposal.block.header.block_hash(),
            "height" => block_proposal.block.header.chain_length,
            "tx_count" => block_proposal.block.txs.len(),
            "parent_stacks_block_id" => %block_proposal.block.header.parent_block_id,
        );

        let res = node.with_node_state(|network, sortdb, chainstate, _mempool, rpc_args| {
            if network.is_proposal_thread_running() {
                return Err((
                    TOO_MANY_REQUESTS_STATUS,
                    NetError::SendError("Proposal currently being evaluated".into()),
                ));
            }

            if block_proposal
                .block
                .header
                .timestamp
                .saturating_add(network.get_connection_opts().block_proposal_max_age_secs)
                < get_epoch_time_secs()
            {
                return Err((
                    422,
                    NetError::SendError("Block proposal is too old to process.".into()),
                ));
            }

            let (chainstate, _) = chainstate.reopen().map_err(|e| (400, NetError::from(e)))?;
            let sortdb = sortdb.reopen().map_err(|e| (400, NetError::from(e)))?;
            let receiver = rpc_args
                .event_observer
                .and_then(|observer| observer.get_proposal_callback_receiver())
                .ok_or_else(|| {
                    (
                        400,
                        NetError::SendError(
                            "No `observer` registered for receiving proposal callbacks".into(),
                        ),
                    )
                })?;
            let thread_info = block_proposal
                .spawn_validation_thread(
                    sortdb,
                    chainstate,
                    receiver,
                    network.get_connection_opts(),
                )
                .map_err(|_e| {
                    (
                        TOO_MANY_REQUESTS_STATUS,
                        NetError::SendError(
                            "IO error while spawning proposal callback thread".into(),
                        ),
                    )
                })?;
            network.set_proposal_thread(thread_info);
            Ok(())
        });

        match res {
            Ok(_) => {
                let preamble = HttpResponsePreamble::accepted_json(&preamble);
                let body = HttpResponseContents::try_from_json(&serde_json::json!({
                    "result": "Accepted",
                    "message": "Block proposal is processing, result will be returned via the event observer"
                }))?;
                Ok((preamble, body))
            }
            Err((code, err)) => {
                let preamble = HttpResponsePreamble::error_json(code, http_reason(code));
                let body = HttpResponseContents::try_from_json(&serde_json::json!({
                    "result": "Error",
                    "message": format!("Could not process block proposal request: {err}")
                }))?;
                Ok((preamble, body))
            }
        }
    }
}

/// Decode the HTTP response
impl HttpResponse for RPCBlockProposalRequestHandler {
    fn try_parse_response(
        &self,
        preamble: &HttpResponsePreamble,
        body: &[u8],
    ) -> Result<HttpResponsePayload, Error> {
        let response: BlockProposalResponse = parse_json(preamble, body)?;
        HttpResponsePayload::try_from_json(response)
    }
}

stacks-network / stacks-core / 25903914664-1

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous