sc_service/chain_ops/revert_chain.rs
1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
5
6// This program is free software: you can redistribute it and/or modify
7// it under the terms of the GNU General Public License as published by
8// the Free Software Foundation, either version 3 of the License, or
9// (at your option) any later version.
10
11// This program is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License
17// along with this program. If not, see <https://www.gnu.org/licenses/>.
18
19use crate::error::Error;
20use log::info;
21use sc_client_api::{Backend, UsageProvider};
22use sp_runtime::traits::{Block as BlockT, NumberFor, Zero};
23use std::sync::Arc;
24
25/// Performs a revert of `blocks` blocks.
26pub fn revert_chain<B, BA, C>(
27 client: Arc<C>,
28 backend: Arc<BA>,
29 blocks: NumberFor<B>,
30) -> Result<(), Error>
31where
32 B: BlockT,
33 C: UsageProvider<B>,
34 BA: Backend<B>,
35{
36 let reverted = backend.revert(blocks, false)?;
37 let info = client.usage_info().chain;
38
39 if reverted.0.is_zero() {
40 info!("There aren't any non-finalized blocks to revert.");
41 } else {
42 info!("Reverted {} blocks. Best: #{} ({})", reverted.0, info.best_number, info.best_hash);
43
44 if reverted.0 > blocks {
45 info!(
46 "Number of reverted blocks is higher than requested \
47 because of reverted leaves higher than the best block."
48 )
49 }
50 }
51 Ok(())
52}