refactor: introduce SignHash type for improved type safety in LLMQ signing #6826
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| // Copyright (c) 2025 The Dash Core developers | ||
| // Distributed under the MIT software license, see the accompanying | ||
| // file COPYING or http://www.opensource.org/licenses/mit-license.php. | ||
|
|
||
| #include <llmq/signhash.h> | ||
|
|
||
| #include <hash.h> | ||
| #include <serialize.h> | ||
|
|
||
| #include <vector> | ||
|
|
||
| namespace llmq { | ||
|
|
||
| SignHash::SignHash(Consensus::LLMQType llmqType, const uint256& quorumHash, const uint256& id, const uint256& msgHash) | ||
| { | ||
| CHashWriter h(SER_GETHASH, 0); | ||
| h << llmqType; | ||
|
There was a problem hiding this comment. 🛠️ Refactor suggestion Ensure deterministic encoding of enum; drop unused include.
Apply: -#include <vector>
@@
- h << llmqType;
+ h << static_cast<uint8_t>(llmqType);Also applies to: 10-10 🤖 Prompt for AI Agents |
||
| h << quorumHash; | ||
| h << id; | ||
| h << msgHash; | ||
| m_hash = h.GetHash(); | ||
| } | ||
|
|
||
| } // namespace llmq | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| // Copyright (c) 2025 The Dash Core developers | ||
| // Distributed under the MIT software license, see the accompanying | ||
| // file COPYING or http://www.opensource.org/licenses/mit-license.php. | ||
|
|
||
| #ifndef BITCOIN_LLMQ_SIGNHASH_H | ||
| #define BITCOIN_LLMQ_SIGNHASH_H | ||
|
|
||
| #include <llmq/params.h> | ||
| #include <uint256.h> | ||
|
|
||
| #include <cstring> | ||
| #include <vector> | ||
|
|
||
| #include <saltedhasher.h> | ||
| #include <util/hash_type.h> | ||
|
|
||
| namespace llmq { | ||
|
|
||
| /** | ||
| * SignHash is a strongly-typed wrapper for the hash used in LLMQ signing operations. | ||
| * It encapsulates the hash calculation for quorum signatures, replacing the need for | ||
| * BuildSignHash function and avoiding circular dependencies. | ||
| */ | ||
| class SignHash : public BaseHash<uint256> | ||
| { | ||
| public: | ||
| SignHash() = default; | ||
| using BaseHash<uint256>::BaseHash; | ||
|
|
||
| /** | ||
| * Constructs a SignHash from the given parameters. | ||
| * This replaces the previous BuildSignHash function. | ||
| */ | ||
| SignHash(Consensus::LLMQType llmqType, const uint256& quorumHash, const uint256& id, const uint256& msgHash); | ||
|
|
||
| /** | ||
| * Get the underlying uint256 hash value. | ||
| */ | ||
| const uint256& Get() const { return m_hash; } | ||
|
|
||
| // Serialization support | ||
| template <typename Stream> | ||
| void Serialize(Stream& s) const | ||
| { | ||
| s << m_hash; | ||
| } | ||
|
|
||
| template <typename Stream> | ||
| void Unserialize(Stream& s) | ||
| { | ||
| s >> m_hash; | ||
| } | ||
| }; | ||
|
|
||
| // Salted hasher for llmq::SignHash that reuses the salted hasher for uint256 | ||
| struct SignHashSaltedHasher { | ||
| std::size_t operator()(const SignHash& signHash) const noexcept { return StaticSaltedHasher{}(signHash.Get()); } | ||
| }; | ||
|
|
||
| } // namespace llmq | ||
|
|
||
| // Make SignHash hashable for use in unordered_map | ||
| template <> | ||
| struct std::hash<llmq::SignHash> { | ||
| std::size_t operator()(const llmq::SignHash& signHash) const noexcept | ||
| { | ||
| // Use the first 8 bytes of the hash as the hash value | ||
| const unsigned char* data = signHash.data(); | ||
| std::size_t result; | ||
| std::memcpy(&result, data, sizeof(result)); | ||
| return result; | ||
| } | ||
| }; | ||
|
|
||
|
|
||
| #endif // BITCOIN_LLMQ_SIGNHASH_H |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.