17372468680

Committed 01 Sep 2025 08:43AM UTC coverage: 60.111% (-1.0%) from 61.105%

Build # 17372468680

Build Type

push

github

Committed by

SWvheerden

Commit Message

feat: improve header sync (#7421)

Description
---
When we have a valid PoW equal to or higher than what we have or what
has been advertised by the sync peer, we need to commit the headers, so
any downstream block sync error does not invalidate the headers that
have been downloaded.

_**Edit:** When block sync fails, we also make sure to swap to the best
PoW chain, also preserving banked headers if we do not need to reorg._

Closes #7342

Motivation and Context
---
See #7342

How Has This Been Tested?
---
System-level tests passed:
- Synching a previously synced node, a couple of days old.
- Syncing from scratch, encountering multiple block-sync failures, but
using the good PoW headers already banked.
```rust
   51952: 2025-08-18 16:07:02.097680100 [c::bn::block_sync] DEBUG Validating block body #22624 (PoW = RandomXTari, input(s): 1, output(s): 54, kernel(s): 2, latency: 108.00µs)
   51961: 2025-08-18 16:07:02.111648900 [c::bn::block_sync] DEBUG Validated in 14ms. Storing block body #22624 (PoW = RandomXTari, input(s): 1, output(s): 54, kernel(s): 2)
   51962: 2025-08-18 16:07:02.111668100 [c::bn::block_sync] TRACE Hash: <a class=hub.com/tari-project/tari/commit/91a1fbccc1f94e2aa93b6efdaf9c3fbf16d0588c">91a1fbccc<a href="https://github.com/tari-project/tari/commit/6fb8d66c20efe20d9ba71db70213e46332f9e8f5">3458b7ef444e605f62375077
   54024: 2025-08-18 16:11:06.389482300 [c::bn::block_sync] WARN  Peer did not supply all the blocks they claimed they had: Their claim - height: 74721, accumulated difficulty: <a class="double-link" href="https://github.com/tari-project/tari/commit/4089235547434023187024157117581153168163">408923554</a><a href="https://github.com/tari-project/tari/commit/6fb8d66c20efe20d9ba71db70213e46332f9e8f5">715651441378. Our status after block sync - height: 22624, accumulated difficulty: </a><a class="double-link" href="https://github.com/tari-project/tari/commit/1547640955349056263010512134240412613668">154764095</a><a href="https://github.com/tari-project/tari/commit/6fb8d66c20efe20d9ba71db70213e46332f9e8f5">889130919000
   54028: 2025-08-18 16:11:06.390047900 [c::bn::block_sync] WARN  Block sync failed - best header: 74723/1bcf293971df2d6c888a6589dca3a323b, best block: 22624/91a1fbccc1f94e2aa93b6efdaf9c3fbf16d0588c3458b7ef444e605f62375077. No more sync peers available: Block sync failed
   54109: 2025-08-18 16:11:11.596105400 [c::bn::header_sync] DEBUG Starting header sync.
   54110: 2025-08-18 16:11:11.59617... (continued)

Run Details

33 of 132 new or added lines in 3 files covered. (25.0%)

1427 existing lines in 30 files now uncovered.

71522 of 118983 relevant lines covered (60.11%)

536188.7 hits per line

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

75.0

/base_layer/core/src/base_node/sync/rpc/tests.rs

//  Copyright 2020, 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 futures::StreamExt;
use tari_comms::protocol::rpc::{mock::RpcRequestMock, RpcStatusCode};
use tari_service_framework::reply_channel;
use tari_test_utils::{streams::convert_mpsc_to_stream, unpack_enum};
use tokio::sync::broadcast;

use super::BaseNodeSyncRpcService;
use crate::{
    base_node::{BaseNodeSyncService, LocalNodeCommsInterface},
    chain_storage::BlockchainDatabase,
    proto::base_node::{SyncBlocksRequest, SyncUtxosRequest},
    test_helpers::{
        blockchain::{create_main_chain, create_new_blockchain, TempDatabase},
        create_peer_manager,
    },
};

fn setup() -> (
    BaseNodeSyncRpcService<TempDatabase>,
    BlockchainDatabase<TempDatabase>,
    RpcRequestMock,
) {
    let peer_manager = create_peer_manager();
    let request_mock = RpcRequestMock::new(peer_manager);

    let db = create_new_blockchain();
    let (req_tx, _) = reply_channel::unbounded();
    let (block_tx, _) = reply_channel::unbounded();
    let (block_event_tx, _) = broadcast::channel(1);
    let service = BaseNodeSyncRpcService::new(
        db.clone().into(),
        LocalNodeCommsInterface::new(req_tx, block_tx, block_event_tx),
    );
    (service, db, request_mock)
}

mod sync_blocks {
    use super::*;

    #[tokio::test]
    async fn it_returns_not_found_if_unknown_hash() {
        let (service, _, rpc_request_mock) = setup();
        let msg = SyncBlocksRequest {
            start_hash: vec![0; 32],
            end_hash: vec![0; 32],
        };
        let req = rpc_request_mock.request_with_context(Default::default(), msg);
        let err = service.sync_blocks(req).await.unwrap_err();
        unpack_enum!(RpcStatusCode::NotFound = err.as_status_code());
    }

    #[tokio::test]
    async fn it_sends_bad_request_on_bad_response() {
        let (service, db, rpc_request_mock) = setup();

        let (_, chain) = create_main_chain(&db, block_specs!(["A->GB"])).await;

        let block = chain.get("A").unwrap();
        let msg = SyncBlocksRequest {
            start_hash: block.hash().to_vec(),
            end_hash: block.hash().to_vec(),
        };
        let req = rpc_request_mock.request_with_context(Default::default(), msg);
        assert!(service.sync_blocks(req).await.is_err());
    }

    #[tokio::test]
    async fn it_streams_blocks_until_end() {
        let (service, db, rpc_request_mock) = setup();

        let (_, chain) = create_main_chain(&db, block_specs!(["A->GB"], ["B->A"], ["C->B"], ["D->C"], ["E->D"])).await;

        let first_block = chain.get("A").unwrap();
        let last_block = chain.get("E").unwrap();

        let msg = SyncBlocksRequest {
            start_hash: first_block.hash().to_vec(),
            end_hash: last_block.hash().to_vec(),
        };
        let req = rpc_request_mock.request_with_context(Default::default(), msg);
        let mut streaming = service.sync_blocks(req).await.unwrap().into_inner();
        let blocks = convert_mpsc_to_stream(&mut streaming)
            .map(|block| block.unwrap())
            .collect::<Vec<_>>()
            .await;

        assert_eq!(blocks.len(), 4);
        blocks.iter().zip(["B", "C", "D", "E"]).for_each(|(block, name)| {
            assert_eq!(*chain.get(name).unwrap().hash(), block.hash);
        });
    }
}

mod sync_utxos {
    use super::*;

    #[tokio::test]
    async fn it_returns_not_found_if_unknown_hash() {
        let (service, db, rpc_request_mock) = setup();
        let gen_block_hash = db.fetch_header(0).unwrap().unwrap().hash();
        let msg = SyncUtxosRequest {
            start_header_hash: gen_block_hash.to_vec(),
            end_header_hash: vec![0; 32],
        };
        let req = rpc_request_mock.request_with_context(Default::default(), msg);
        let err = service.sync_utxos(req).await.unwrap_err();
        unpack_enum!(RpcStatusCode::NotFound = err.as_status_code());
    }

    #[tokio::test]
    async fn it_returns_not_found_if_start_not_found() {
        let (service, db, rpc_request_mock) = setup();
        let (_, chain) = create_main_chain(&db, block_specs!(["A->GB"])).await;
        let gb = chain.get("GB").unwrap();
        let msg = SyncUtxosRequest {
            start_header_hash: vec![0; 32],
            end_header_hash: gb.hash().to_vec(),
        };
        let req = rpc_request_mock.request_with_context(Default::default(), msg);
        let err = service.sync_utxos(req).await.unwrap_err();
        unpack_enum!(RpcStatusCode::NotFound = err.as_status_code());
    }
}

1	// Copyright 2020, 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 futures::StreamExt;
24	use tari_comms::protocol::rpc::{mock::RpcRequestMock, RpcStatusCode};
25	use tari_service_framework::reply_channel;
26	use tari_test_utils::{streams::convert_mpsc_to_stream, unpack_enum};
27	use tokio::sync::broadcast;
28
29	use super::BaseNodeSyncRpcService;
30	use crate::{
31	base_node::{BaseNodeSyncService, LocalNodeCommsInterface},
32	chain_storage::BlockchainDatabase,
33	proto::base_node::{SyncBlocksRequest, SyncUtxosRequest},
34	test_helpers::{
35	blockchain::{create_main_chain, create_new_blockchain, TempDatabase},
36	create_peer_manager,
37	},
38	};
39
40	fn setup() -> (	5✔
41	BaseNodeSyncRpcService<TempDatabase>,	5✔
42	BlockchainDatabase<TempDatabase>,	5✔
43	RpcRequestMock,	5✔
44	) {	5✔
45	let peer_manager = create_peer_manager();	5✔
46	let request_mock = RpcRequestMock::new(peer_manager);	5✔
47		5✔
48	let db = create_new_blockchain();	5✔
49	let (req_tx, _) = reply_channel::unbounded();	5✔
50	let (block_tx, _) = reply_channel::unbounded();	5✔
51	let (block_event_tx, _) = broadcast::channel(1);	5✔
52	let service = BaseNodeSyncRpcService::new(	5✔
53	db.clone().into(),	5✔
54	LocalNodeCommsInterface::new(req_tx, block_tx, block_event_tx),	5✔
55	);	5✔
56	(service, db, request_mock)	5✔
57	}	5✔
58
59	mod sync_blocks {
60	use super::*;
61
62	#[tokio::test]
63	async fn it_returns_not_found_if_unknown_hash() {	1✔
64	let (service, _, rpc_request_mock) = setup();	1✔
65	let msg = SyncBlocksRequest {	1✔
66	start_hash: vec![0; 32],	1✔
67	end_hash: vec![0; 32],	1✔
68	};	1✔
69	let req = rpc_request_mock.request_with_context(Default::default(), msg);	1✔
70	let err = service.sync_blocks(req).await.unwrap_err();	1✔
71	unpack_enum!(RpcStatusCode::NotFound = err.as_status_code());	1✔
72	}	1✔
73
74	#[tokio::test]
75	async fn it_sends_bad_request_on_bad_response() {	1✔
76	let (service, db, rpc_request_mock) = setup();	1✔
77		1✔
78	let (_, chain) = create_main_chain(&db, block_specs!(["A->GB"])).await;	1✔
79		1✔
80	let block = chain.get("A").unwrap();	1✔
UNCOV 81	let msg = SyncBlocksRequest {	×
UNCOV 82	start_hash: block.hash().to_vec(),	×
UNCOV 83	end_hash: block.hash().to_vec(),	×
UNCOV 84	};	×
UNCOV 85	let req = rpc_request_mock.request_with_context(Default::default(), msg);	×
UNCOV 86	assert!(service.sync_blocks(req).await.is_err());	×
87	}	1✔
88
89	#[tokio::test]
90	async fn it_streams_blocks_until_end() {	1✔
91	let (service, db, rpc_request_mock) = setup();	1✔
92		1✔
93	let (_, chain) = create_main_chain(&db, block_specs!(["A->GB"], ["B->A"], ["C->B"], ["D->C"], ["E->D"])).await;	1✔
94		1✔
95	let first_block = chain.get("A").unwrap();	1✔
UNCOV 96	let last_block = chain.get("E").unwrap();	×
UNCOV 97		×
UNCOV 98	let msg = SyncBlocksRequest {	×
UNCOV 99	start_hash: first_block.hash().to_vec(),	×
UNCOV 100	end_hash: last_block.hash().to_vec(),	×
UNCOV 101	};	×
UNCOV 102	let req = rpc_request_mock.request_with_context(Default::default(), msg);	×
103	let mut streaming = service.sync_blocks(req).await.unwrap().into_inner();	1✔
104	let blocks = convert_mpsc_to_stream(&mut streaming)	1✔
UNCOV 105	.map(\|block\| block.unwrap())	×
UNCOV 106	.collect::<Vec<_>>()	×
UNCOV 107	.await;	×
108		1✔
109	assert_eq!(blocks.len(), 4);	1✔
110	blocks.iter().zip(["B", "C", "D", "E"]).for_each(\|(block, name)\| {	1✔
UNCOV 111	assert_eq!(*chain.get(name).unwrap().hash(), block.hash);	×
112	});	1✔
113	}	1✔
114	}
115
116	mod sync_utxos {
117	use super::*;
118
119	#[tokio::test]
120	async fn it_returns_not_found_if_unknown_hash() {	1✔
121	let (service, db, rpc_request_mock) = setup();	1✔
122	let gen_block_hash = db.fetch_header(0).unwrap().unwrap().hash();	1✔
123	let msg = SyncUtxosRequest {	1✔
124	start_header_hash: gen_block_hash.to_vec(),	1✔
125	end_header_hash: vec![0; 32],	1✔
126	};	1✔
127	let req = rpc_request_mock.request_with_context(Default::default(), msg);	1✔
128	let err = service.sync_utxos(req).await.unwrap_err();	1✔
129	unpack_enum!(RpcStatusCode::NotFound = err.as_status_code());	1✔
130	}	1✔
131
132	#[tokio::test]
133	async fn it_returns_not_found_if_start_not_found() {	1✔
134	let (service, db, rpc_request_mock) = setup();	1✔
135	let (_, chain) = create_main_chain(&db, block_specs!(["A->GB"])).await;	1✔
136	let gb = chain.get("GB").unwrap();	1✔
UNCOV 137	let msg = SyncUtxosRequest {	×
UNCOV 138	start_header_hash: vec![0; 32],	×
UNCOV 139	end_header_hash: gb.hash().to_vec(),	×
UNCOV 140	};	×
UNCOV 141	let req = rpc_request_mock.request_with_context(Default::default(), msg);	×
142	let err = service.sync_utxos(req).await.unwrap_err();	1✔
143	unpack_enum!(RpcStatusCode::NotFound = err.as_status_code());	1✔
144	}	1✔
145	}

tari-project / tari / 17372468680

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