19257987480

Committed 11 Nov 2025 07:12AM UTC coverage: 50.496% (-1.1%) from 51.608%

Build # 19257987480

Build Type

push

github

Committed by

web-flow

Commit Message

fix(sidechain)!: adds shard group accumulated data to checkpoint (#7577)

Description
---
fix(sidechain)!: adds shard group accumulated data to checkpoint

Motivation and Context
---
This PR adds accumulated data typ to the sidechain header used for epoch
checkpoints.

Related https://github.com/tari-project/tari-ootle/pull/1639

How Has This Been Tested?
---
Updated fixtures for tests

What process can a PR reviewer use to test or verify this change?
---

<!-- Checklist -->
<!-- 1. Is the title of your PR in the form that would make nice release
notes? The title, excluding the conventional commit
tag, will be included exactly as is in the CHANGELOG, so please think
about it carefully. -->


Breaking Changes
---

- [ ] None
- [ ] Requires data directory on base node to be deleted
- [ ] Requires hard fork
- [x] Other - Please specify

<!-- Does this include a breaking change? If so, include this line as a
footer -->
<!-- BREAKING CHANGE: Description what the user should do, e.g. delete a
database, resync the chain -->

BREAKING CHANGE: Previous commit proofs (epoch checkpoints, etc.) are
not compatible. These are not enabled on mainnet.


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

## Summary by CodeRabbit

## Release Notes

* **New Features**
* Added accumulated exhaust burn tracking to sidechain block headers,
enabling storage and retrieval of total exhaust burn metrics within
block validation data.

* **Chores**
* Updated protocol definitions and conversion logic to support the new
accumulated data structure.
* Refreshed test fixtures and block header schemas to accommodate
expanded metadata requirements.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Run Details

1 of 20 new or added lines in 2 files covered. (5.0%)

1479 existing lines in 36 files now uncovered.

57906 of 114674 relevant lines covered (50.5%)

8050.74 hits per line

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

28.89

/base_layer/node_components/src/blocks/block_header_accumulated_data.rs

//  Copyright 2025, 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};

use primitive_types::U512;
use tari_common_types::types::{HashOutput, PrivateKey};
use tari_transaction_components::tari_proof_of_work::{AccumulatedDifficulty, Difficulty};

/// Accumulated and other pertinent data in the block header acting as a "condensed blockchain snapshot" for the block
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct BlockHeaderAccumulatedData {
    /// The block hash.
    pub hash: HashOutput,
    /// The total accumulated offset for all kernels in the block.
    pub total_kernel_offset: PrivateKey,
    /// The achieved difficulty for solving the current block using the specified proof of work algorithm.
    pub achieved_difficulty: Difficulty,
    /// The total accumulated difficulty for all blocks since Genesis, but not including this block, tracked
    /// separately.
    pub total_accumulated_difficulty: U512,
    /// The total accumulated difficulty for Merged mined monero RandomX proof of work for all blocks since Genesis,
    /// but not including this block, tracked separately.
    pub accumulated_monero_randomx_difficulty: AccumulatedDifficulty,
    /// The total accumulated difficulty for Tari RandomX proof of work for all blocks since Genesis,
    /// but not including this block, tracked separately.
    pub accumulated_tari_randomx_difficulty: AccumulatedDifficulty,
    /// The total accumulated difficulty for SHA3 proof of work for all blocks since Genesis,
    /// but not including this block, tracked separately.
    pub accumulated_sha3x_difficulty: AccumulatedDifficulty,
    /// The total accumulated difficulty for Cuckaroo proof of work for all blocks since Genesis,
    pub accumulated_cuckaroo_difficulty: AccumulatedDifficulty,
    /// The target difficulty for solving the current block using the specified proof of work algorithm.
    pub target_difficulty: Difficulty,
}

impl BlockHeaderAccumulatedData {
    pub fn genesis(hash: HashOutput, total_kernel_offset: PrivateKey) -> Self {
        Self {
            hash,
            total_kernel_offset,
            achieved_difficulty: Difficulty::min(),
            total_accumulated_difficulty: 1.into(),
            accumulated_monero_randomx_difficulty: AccumulatedDifficulty::min(),
            accumulated_tari_randomx_difficulty: AccumulatedDifficulty::min(),
            accumulated_sha3x_difficulty: AccumulatedDifficulty::min(),
            accumulated_cuckaroo_difficulty: AccumulatedDifficulty::min(),
            target_difficulty: Difficulty::min(),
        }
    }

    pub fn accumulated_monero_randomx_difficulty(&self) -> AccumulatedDifficulty {
        self.accumulated_monero_randomx_difficulty
    }

    pub fn accumulated_tari_randomx_difficulty(&self) -> AccumulatedDifficulty {
        self.accumulated_tari_randomx_difficulty
    }

    pub fn accumulated_sha3x_difficulty(&self) -> AccumulatedDifficulty {
        self.accumulated_sha3x_difficulty
    }

    pub fn accumulated_cuckaroo_difficulty(&self) -> AccumulatedDifficulty {
        self.accumulated_cuckaroo_difficulty
    }
}

impl Display for BlockHeaderAccumulatedData {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "Hash: {}", self.hash)?;
        writeln!(f, "Achieved difficulty: {}", self.achieved_difficulty)?;
        writeln!(f, "Total accumulated difficulty: {}", self.total_accumulated_difficulty)?;
        writeln!(
            f,
            "Accumulated Monero RandomX difficulty: {}",
            self.accumulated_monero_randomx_difficulty
        )?;
        writeln!(
            f,
            "Accumulated Tari RandomX difficulty: {}",
            self.accumulated_tari_randomx_difficulty
        )?;
        writeln!(f, "Accumulated sha3 difficulty: {}", self.accumulated_sha3x_difficulty)?;
        writeln!(
            f,
            "Accumulated cuckaroo difficulty: {}",
            self.accumulated_cuckaroo_difficulty
        )?;
        writeln!(f, "Target difficulty: {}", self.target_difficulty)?;
        Ok(())
    }
}

1	// Copyright 2025, 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	use std::{fmt, fmt::Display};
23
24	use primitive_types::U512;
25	use tari_common_types::types::{HashOutput, PrivateKey};
26	use tari_transaction_components::tari_proof_of_work::{AccumulatedDifficulty, Difficulty};
27
28	/// Accumulated and other pertinent data in the block header acting as a "condensed blockchain snapshot" for the block
29	#[derive(Debug, Clone, PartialEq, Eq)]
30	pub struct BlockHeaderAccumulatedData {
31	/// The block hash.
32	pub hash: HashOutput,
33	/// The total accumulated offset for all kernels in the block.
34	pub total_kernel_offset: PrivateKey,
35	/// The achieved difficulty for solving the current block using the specified proof of work algorithm.
36	pub achieved_difficulty: Difficulty,
37	/// The total accumulated difficulty for all blocks since Genesis, but not including this block, tracked
38	/// separately.
39	pub total_accumulated_difficulty: U512,
40	/// The total accumulated difficulty for Merged mined monero RandomX proof of work for all blocks since Genesis,
41	/// but not including this block, tracked separately.
42	pub accumulated_monero_randomx_difficulty: AccumulatedDifficulty,
43	/// The total accumulated difficulty for Tari RandomX proof of work for all blocks since Genesis,
44	/// but not including this block, tracked separately.
45	pub accumulated_tari_randomx_difficulty: AccumulatedDifficulty,
46	/// The total accumulated difficulty for SHA3 proof of work for all blocks since Genesis,
47	/// but not including this block, tracked separately.
48	pub accumulated_sha3x_difficulty: AccumulatedDifficulty,
49	/// The total accumulated difficulty for Cuckaroo proof of work for all blocks since Genesis,
50	pub accumulated_cuckaroo_difficulty: AccumulatedDifficulty,
51	/// The target difficulty for solving the current block using the specified proof of work algorithm.
52	pub target_difficulty: Difficulty,
53	}
54
55	impl BlockHeaderAccumulatedData {
56	pub fn genesis(hash: HashOutput, total_kernel_offset: PrivateKey) -> Self {	155✔
57	Self {	155✔
58	hash,	155✔
59	total_kernel_offset,	155✔
60	achieved_difficulty: Difficulty::min(),	155✔
61	total_accumulated_difficulty: 1.into(),	155✔
62	accumulated_monero_randomx_difficulty: AccumulatedDifficulty::min(),	155✔
63	accumulated_tari_randomx_difficulty: AccumulatedDifficulty::min(),	155✔
64	accumulated_sha3x_difficulty: AccumulatedDifficulty::min(),	155✔
65	accumulated_cuckaroo_difficulty: AccumulatedDifficulty::min(),	155✔
66	target_difficulty: Difficulty::min(),	155✔
67	}	155✔
68	}	155✔
69
70	pub fn accumulated_monero_randomx_difficulty(&self) -> AccumulatedDifficulty {	×
71	self.accumulated_monero_randomx_difficulty	×
72	}	×
73
74	pub fn accumulated_tari_randomx_difficulty(&self) -> AccumulatedDifficulty {	×
75	self.accumulated_tari_randomx_difficulty	×
76	}	×
77
UNCOV 78	pub fn accumulated_sha3x_difficulty(&self) -> AccumulatedDifficulty {	×
UNCOV 79	self.accumulated_sha3x_difficulty	×
UNCOV 80	}	×
81
82	pub fn accumulated_cuckaroo_difficulty(&self) -> AccumulatedDifficulty {	×
83	self.accumulated_cuckaroo_difficulty	×
84	}	×
85	}
86
87	impl Display for BlockHeaderAccumulatedData {
88	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {	×
89	writeln!(f, "Hash: {}", self.hash)?;	×
90	writeln!(f, "Achieved difficulty: {}", self.achieved_difficulty)?;	×
91	writeln!(f, "Total accumulated difficulty: {}", self.total_accumulated_difficulty)?;	×
92	writeln!(	×
93	f,	×
94	"Accumulated Monero RandomX difficulty: {}",	×
95	self.accumulated_monero_randomx_difficulty
96	)?;	×
97	writeln!(	×
98	f,	×
99	"Accumulated Tari RandomX difficulty: {}",	×
100	self.accumulated_tari_randomx_difficulty
101	)?;	×
102	writeln!(f, "Accumulated sha3 difficulty: {}", self.accumulated_sha3x_difficulty)?;	×
103	writeln!(	×
104	f,	×
105	"Accumulated cuckaroo difficulty: {}",	×
106	self.accumulated_cuckaroo_difficulty
107	)?;	×
108	writeln!(f, "Target difficulty: {}", self.target_difficulty)?;	×
109	Ok(())	×
110	}	×
111	}

tari-project / tari / 19257987480

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