13180876702

Committed 06 Feb 2025 02:21PM UTC coverage: 74.065% (+0.007%) from 74.058%

Build # 13180876702

Build Type

push

github

Committed by

web-flow

Commit Message

chore: improve wallet recovery log message (#6792)

Description
---
Improved the wallet recovery log message:

```rust
2025-02-06 09:02:50.398360400 [wallet::utxo_scanning] INFO  Fresh wallet recovery/scanning: Wallet birthday 
'1124' at epoch time '1738108800' with block height '81', scanning from epoch time '1736899200' at block height 
'0' with header hash '68bb2afeff36c7885b1d3af054e253330'
```

Motivation and Context
---
When a user sees an info message about recovery, this message will make
it clear what the birthday is and what the starting scan height is.

See #6787.

How Has This Been Tested?
---
System-level testing

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

<!-- 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
---

- [x] None
- [ ] Requires data directory on base node to be deleted
- [ ] Requires hard fork
- [ ] 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 -->

Run Details

21 of 32 new or added lines in 1 file covered. (65.63%)

24 existing lines in 10 files now uncovered.

83674 of 112974 relevant lines covered (74.06%)

284987.87 hits per line

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

0.0

/base_layer/core/src/base_node/comms_interface/comms_response.rs

// Copyright 2019. 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::{self, Display, Formatter},
    sync::Arc,
};

use tari_common_types::{
    chain_metadata::ChainMetadata,
    types::{CompressedPublicKey, HashOutput, PrivateKey},
};

use crate::{
    blocks::{Block, ChainHeader, HistoricalBlock, NewBlockTemplate},
    chain_storage::TemplateRegistrationEntry,
    proof_of_work::Difficulty,
    transactions::transaction_components::{Transaction, TransactionKernel, TransactionOutput},
};

/// API Response enum
#[allow(clippy::large_enum_variant)]
#[derive(Debug, Clone)]
pub enum NodeCommsResponse {
    ChainMetadata(ChainMetadata),
    TransactionKernels(Vec<TransactionKernel>),
    BlockHeaders(Vec<ChainHeader>),
    BlockHeader(Option<ChainHeader>),
    Block(Box<Option<Block>>),
    TransactionOutputs(Vec<TransactionOutput>),
    HistoricalBlocks(Vec<HistoricalBlock>),
    HistoricalBlock(Box<Option<HistoricalBlock>>),
    NewBlockTemplate(NewBlockTemplate),
    NewBlock {
        success: bool,
        error: Option<String>,
        block: Option<Block>,
    },
    TargetDifficulty(Difficulty),
    MmrNodes(Vec<HashOutput>, Vec<u8>),
    FetchMempoolTransactionsByExcessSigsResponse(FetchMempoolTransactionsResponse),
    FetchValidatorNodesKeysResponse(Vec<(CompressedPublicKey, [u8; 32])>),
    GetShardKeyResponse(Option<[u8; 32]>),
    FetchTemplateRegistrationsResponse(Vec<TemplateRegistrationEntry>),
}

impl Display for NodeCommsResponse {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        #[allow(clippy::enum_glob_use)]
        use NodeCommsResponse::*;
        match self {
            ChainMetadata(_) => write!(f, "ChainMetadata"),
            TransactionKernels(_) => write!(f, "TransactionKernel"),
            BlockHeaders(_) => write!(f, "BlockHeaders"),
            BlockHeader(_) => write!(f, "BlockHeader"),
            Block(_) => write!(f, "Block"),
            HistoricalBlock(_) => write!(f, "HistoricalBlock"),
            TransactionOutputs(_) => write!(f, "TransactionOutputs"),
            HistoricalBlocks(_) => write!(f, "HistoricalBlocks"),
            NewBlockTemplate(_) => write!(f, "NewBlockTemplate"),
            NewBlock {
                success,
                error,
                block: _,
            } => write!(
                f,
                "NewBlock({},{},...)",
                success,
                error.as_ref().unwrap_or(&"Unspecified".to_string())
            ),
            TargetDifficulty(_) => write!(f, "TargetDifficulty"),
            MmrNodes(_, _) => write!(f, "MmrNodes"),
            FetchMempoolTransactionsByExcessSigsResponse(resp) => write!(
                f,
                "FetchMempoolTransactionsByExcessSigsResponse({} transaction(s), {} not found)",
                resp.transactions.len(),
                resp.not_found.len()
            ),
            FetchValidatorNodesKeysResponse(_) => write!(f, "FetchValidatorNodesKeysResponse"),
            GetShardKeyResponse(_) => write!(f, "GetShardKeyResponse"),
            FetchTemplateRegistrationsResponse(_) => write!(f, "FetchTemplateRegistrationsResponse"),
        }
    }
}

/// Container struct for mempool transaction responses
#[derive(Debug, Clone)]
pub struct FetchMempoolTransactionsResponse {
    pub transactions: Vec<Arc<Transaction>>,
    pub not_found: Vec<PrivateKey>,
}

1	// Copyright 2019. 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::{
24	fmt::{self, Display, Formatter},
25	sync::Arc,
26	};
27
28	use tari_common_types::{
29	chain_metadata::ChainMetadata,
30	types::{CompressedPublicKey, HashOutput, PrivateKey},
31	};
32
33	use crate::{
34	blocks::{Block, ChainHeader, HistoricalBlock, NewBlockTemplate},
35	chain_storage::TemplateRegistrationEntry,
36	proof_of_work::Difficulty,
37	transactions::transaction_components::{Transaction, TransactionKernel, TransactionOutput},
38	};
39
40	/// API Response enum
41	#[allow(clippy::large_enum_variant)]
42	#[derive(Debug, Clone)]
43	pub enum NodeCommsResponse {
44	ChainMetadata(ChainMetadata),
45	TransactionKernels(Vec<TransactionKernel>),
46	BlockHeaders(Vec<ChainHeader>),
47	BlockHeader(Option<ChainHeader>),
48	Block(Box<Option<Block>>),
49	TransactionOutputs(Vec<TransactionOutput>),
50	HistoricalBlocks(Vec<HistoricalBlock>),
51	HistoricalBlock(Box<Option<HistoricalBlock>>),
52	NewBlockTemplate(NewBlockTemplate),
53	NewBlock {
54	success: bool,
55	error: Option<String>,
56	block: Option<Block>,
57	},
58	TargetDifficulty(Difficulty),
59	MmrNodes(Vec<HashOutput>, Vec<u8>),
60	FetchMempoolTransactionsByExcessSigsResponse(FetchMempoolTransactionsResponse),
61	FetchValidatorNodesKeysResponse(Vec<(CompressedPublicKey, [u8; 32])>),
62	GetShardKeyResponse(Option<[u8; 32]>),
63	FetchTemplateRegistrationsResponse(Vec<TemplateRegistrationEntry>),
64	}
65
66	impl Display for NodeCommsResponse {
UNCOV 67	fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {	×
UNCOV 68	#[allow(clippy::enum_glob_use)]	×
UNCOV 69	use NodeCommsResponse::*;	×
UNCOV 70	match self {	×
UNCOV 71	ChainMetadata(_) => write!(f, "ChainMetadata"),	×
72	TransactionKernels(_) => write!(f, "TransactionKernel"),	×
73	BlockHeaders(_) => write!(f, "BlockHeaders"),	×
74	BlockHeader(_) => write!(f, "BlockHeader"),	×
75	Block(_) => write!(f, "Block"),	×
76	HistoricalBlock(_) => write!(f, "HistoricalBlock"),	×
77	TransactionOutputs(_) => write!(f, "TransactionOutputs"),	×
78	HistoricalBlocks(_) => write!(f, "HistoricalBlocks"),	×
79	NewBlockTemplate(_) => write!(f, "NewBlockTemplate"),	×
80	NewBlock {
81	success,	×
82	error,	×
83	block: _,	×
84	} => write!(	×
85	f,	×
86	"NewBlock({},{},...)",	×
87	success,	×
88	error.as_ref().unwrap_or(&"Unspecified".to_string())	×
89	),	×
90	TargetDifficulty(_) => write!(f, "TargetDifficulty"),	×
91	MmrNodes(_, _) => write!(f, "MmrNodes"),	×
92	FetchMempoolTransactionsByExcessSigsResponse(resp) => write!(	×
93	f,	×
94	"FetchMempoolTransactionsByExcessSigsResponse({} transaction(s), {} not found)",	×
95	resp.transactions.len(),	×
96	resp.not_found.len()	×
97	),	×
98	FetchValidatorNodesKeysResponse(_) => write!(f, "FetchValidatorNodesKeysResponse"),	×
99	GetShardKeyResponse(_) => write!(f, "GetShardKeyResponse"),	×
100	FetchTemplateRegistrationsResponse(_) => write!(f, "FetchTemplateRegistrationsResponse"),	×
101	}
UNCOV 102	}	×
103	}
104
105	/// Container struct for mempool transaction responses
106	#[derive(Debug, Clone)]
107	pub struct FetchMempoolTransactionsResponse {
108	pub transactions: Vec<Arc<Transaction>>,
109	pub not_found: Vec<PrivateKey>,
110	}

tari-project / tari / 13180876702

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