18586282491

Committed 17 Oct 2025 07:53AM UTC coverage: 58.577% (-1.0%) from 59.552%

Build # 18586282491

Build Type

push

github

Committed by

web-flow

Commit Message

fix: change how pagination works on utxo scanning (#7546)

Description
---
Properly handle the special edge case, where the request has reached the
page limit, but we are also not done with the block. We also dont want
to split up the block over two requests. So we need to ensure that we
remove the partial block we added so that it can be requested fully in
the next request. We also dont want to get in a loop where the block
cannot fit into the page limit, so if the block is the same as the first
one, we just send it as it, partial. If net we remove it and let it be
sent in the next request.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Bug Fixes**
* Fixed edge cases in paginated UTXO queries when a page ends mid-block
to prevent partial or duplicated results.
* Ensures correct continuation across block boundaries and early exit
when the first block is also the last that can be sent.
* Removes trailing blocks or partial entries so subsequent pages request
the correct data.
  * Improves error reporting for rare pagination inconsistencies.
* Preserves behavior when limits aren’t reached or the chain end is
encountered.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Run Details

0 of 10 new or added lines in 1 file covered. (0.0%)

1137 existing lines in 32 files now uncovered.

66481 of 113494 relevant lines covered (58.58%)

228684.39 hits per line

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

46.51

/base_layer/node_components/src/blocks/historical_block.rs

//  Copyright 2021, The Tari Project
//
//  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
//  following conditions are met:
//
//  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
//  disclaimer.
//
//  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
//  following disclaimer in the documentation and/or other materials provided with the distribution.
//
//  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
//  products derived from this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
//  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
//  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use std::{fmt, fmt::Display, sync::Arc};

use tari_common_types::types::HashOutput;

use crate::blocks::{error::BlockError, Block, BlockHeader, BlockHeaderAccumulatedData, ChainBlock};

/// The representation of a historical block in the blockchain. It is essentially identical to a protocol-defined
/// block but contains some extra metadata that clients such as Block Explorers will find interesting.
#[derive(Debug, Clone, PartialEq)]
pub struct HistoricalBlock {
    /// The number of blocks that have been mined since this block, including this one. The current tip will have one
    /// confirmation.
    confirmations: u64,
    /// The underlying block
    block: Block,
    /// Accumulated data in the block header
    accumulated_data: BlockHeaderAccumulatedData,
}

impl HistoricalBlock {
    pub fn new(block: Block, confirmations: u64, accumulated_data: BlockHeaderAccumulatedData) -> Self {
        HistoricalBlock {
            confirmations,
            block,
            accumulated_data,
        }
    }

    pub fn confirmations(&self) -> u64 {
        self.confirmations
    }

    pub fn header(&self) -> &BlockHeader {
        &self.block.header
    }

    /// Returns a reference to the block of the HistoricalBlock
    pub fn block(&self) -> &Block {
        &self.block
    }

    pub fn into_block(self) -> Block {
        self.block
    }

    pub fn accumulated_data(&self) -> &BlockHeaderAccumulatedData {
        &self.accumulated_data
    }

    pub fn hash(&self) -> &HashOutput {
        &self.accumulated_data.hash
    }

    pub fn try_into_chain_block(self) -> Result<ChainBlock, BlockError> {
        let chain_block = ChainBlock::try_construct(Arc::new(self.block), self.accumulated_data).ok_or_else(|| {
            BlockError::ChainBlockInvariantError(
                "Unable to construct ChainBlock because of a hash mismatch".to_string(),
            )
        })?;

        Ok(chain_block)
    }

    pub fn dissolve(self) -> (Block, BlockHeaderAccumulatedData, u64) {
        (self.block, self.accumulated_data, self.confirmations)
    }
}

impl Display for HistoricalBlock {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "{}", self.block())?;
        Ok(())
    }
}

impl From<HistoricalBlock> for Block {
    fn from(block: HistoricalBlock) -> Self {
        block.block
    }
}

1	// Copyright 2021, The Tari Project
2	//
3	// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
4	// following conditions are met:
5	//
6	// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
7	// disclaimer.
8	//
9	// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
10	// following disclaimer in the documentation and/or other materials provided with the distribution.
11	//
12	// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
13	// products derived from this software without specific prior written permission.
14	//
15	// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
16	// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17	// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
18	// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19	// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
20	// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
21	// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22
23	use std::{fmt, fmt::Display, sync::Arc};
24
25	use tari_common_types::types::HashOutput;
26
27	use crate::blocks::{error::BlockError, Block, BlockHeader, BlockHeaderAccumulatedData, ChainBlock};
28
29	/// The representation of a historical block in the blockchain. It is essentially identical to a protocol-defined
30	/// block but contains some extra metadata that clients such as Block Explorers will find interesting.
31	#[derive(Debug, Clone, PartialEq)]
32	pub struct HistoricalBlock {
33	/// The number of blocks that have been mined since this block, including this one. The current tip will have one
34	/// confirmation.
35	confirmations: u64,
36	/// The underlying block
37	block: Block,
38	/// Accumulated data in the block header
39	accumulated_data: BlockHeaderAccumulatedData,
40	}
41
42	impl HistoricalBlock {
43	pub fn new(block: Block, confirmations: u64, accumulated_data: BlockHeaderAccumulatedData) -> Self {	85✔
44	HistoricalBlock {	85✔
45	confirmations,	85✔
46	block,	85✔
47	accumulated_data,	85✔
48	}	85✔
49	}	85✔
50
51	pub fn confirmations(&self) -> u64 {	×
52	self.confirmations	×
53	}	×
54
55	pub fn header(&self) -> &BlockHeader {	2✔
56	&self.block.header	2✔
57	}	2✔
58
59	/// Returns a reference to the block of the HistoricalBlock
60	pub fn block(&self) -> &Block {	50✔
61	&self.block	50✔
62	}	50✔
63
64	pub fn into_block(self) -> Block {	27✔
65	self.block	27✔
66	}	27✔
67
UNCOV 68	pub fn accumulated_data(&self) -> &BlockHeaderAccumulatedData {	×
UNCOV 69	&self.accumulated_data	×
UNCOV 70	}	×
71
72	pub fn hash(&self) -> &HashOutput {	×
73	&self.accumulated_data.hash	×
74	}	×
75
76	pub fn try_into_chain_block(self) -> Result<ChainBlock, BlockError> {	36✔
77	let chain_block = ChainBlock::try_construct(Arc::new(self.block), self.accumulated_data).ok_or_else(\|\| {	36✔
78	BlockError::ChainBlockInvariantError(	×
79	"Unable to construct ChainBlock because of a hash mismatch".to_string(),	×
80	)	×
81	})?;	×
82
83	Ok(chain_block)	36✔
84	}	36✔
85
86	pub fn dissolve(self) -> (Block, BlockHeaderAccumulatedData, u64) {	×
87	(self.block, self.accumulated_data, self.confirmations)	×
88	}	×
89	}
90
91	impl Display for HistoricalBlock {
92	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {	×
93	writeln!(f, "{}", self.block())?;	×
94	Ok(())	×
95	}	×
96	}
97
98	impl From<HistoricalBlock> for Block {
99	fn from(block: HistoricalBlock) -> Self {	×
100	block.block	×
101	}	×
102	}

tari-project / tari / 18586282491

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