/Users/brunogarcia/projects/bitcoin-core-dev/src/primitives/transaction_identifier.h
Line | Count | Source |
1 | | // Copyright (c) 2023-present The Bitcoin Core developers |
2 | | // Distributed under the MIT software license, see the accompanying |
3 | | // file COPYING or https://opensource.org/license/mit. |
4 | | |
5 | | #ifndef BITCOIN_PRIMITIVES_TRANSACTION_IDENTIFIER_H |
6 | | #define BITCOIN_PRIMITIVES_TRANSACTION_IDENTIFIER_H |
7 | | |
8 | | #include <attributes.h> |
9 | | #include <uint256.h> |
10 | | #include <util/types.h> |
11 | | |
12 | | #include <compare> |
13 | | #include <concepts> |
14 | | #include <tuple> |
15 | | #include <variant> |
16 | | |
17 | | /** transaction_identifier represents the two canonical transaction identifier |
18 | | * types (txid, wtxid).*/ |
19 | | template <bool has_witness> |
20 | | class transaction_identifier |
21 | | { |
22 | | uint256 m_wrapped; |
23 | | |
24 | | // Note: Use FromUint256 externally instead. |
25 | 0 | transaction_identifier(const uint256& wrapped) : m_wrapped{wrapped} {}Unexecuted instantiation: transaction_identifier<false>::transaction_identifier(uint256 const&) Unexecuted instantiation: transaction_identifier<true>::transaction_identifier(uint256 const&) |
26 | | |
27 | 0 | constexpr int Compare(const transaction_identifier<has_witness>& other) const { return m_wrapped.Compare(other.m_wrapped); }Unexecuted instantiation: transaction_identifier<false>::Compare(transaction_identifier<false> const&) const Unexecuted instantiation: transaction_identifier<true>::Compare(transaction_identifier<true> const&) const |
28 | | template <typename Other> |
29 | | constexpr int Compare(const Other& other) const |
30 | | { |
31 | | static_assert(ALWAYS_FALSE<Other>, "Forbidden comparison type"); |
32 | | return 0; |
33 | | } |
34 | | |
35 | | public: |
36 | 0 | transaction_identifier() : m_wrapped{} {}Unexecuted instantiation: transaction_identifier<false>::transaction_identifier() Unexecuted instantiation: transaction_identifier<true>::transaction_identifier() |
37 | | |
38 | | template <typename Other> |
39 | 0 | bool operator==(const Other& other) const { return Compare(other) == 0; }Unexecuted instantiation: bool transaction_identifier<false>::operator==<transaction_identifier<false>>(transaction_identifier<false> const&) const Unexecuted instantiation: bool transaction_identifier<true>::operator==<transaction_identifier<true>>(transaction_identifier<true> const&) const |
40 | | template <typename Other> |
41 | 0 | bool operator!=(const Other& other) const { return Compare(other) != 0; }Unexecuted instantiation: bool transaction_identifier<false>::operator!=<transaction_identifier<false>>(transaction_identifier<false> const&) const Unexecuted instantiation: bool transaction_identifier<true>::operator!=<transaction_identifier<true>>(transaction_identifier<true> const&) const |
42 | | template <typename Other> |
43 | 0 | bool operator<(const Other& other) const { return Compare(other) < 0; }Unexecuted instantiation: bool transaction_identifier<false>::operator<<transaction_identifier<false>>(transaction_identifier<false> const&) const Unexecuted instantiation: bool transaction_identifier<true>::operator<<transaction_identifier<true>>(transaction_identifier<true> const&) const |
44 | | |
45 | 0 | const uint256& ToUint256() const LIFETIMEBOUND { return m_wrapped; }Unexecuted instantiation: transaction_identifier<false>::ToUint256() const Unexecuted instantiation: transaction_identifier<true>::ToUint256() const |
46 | 0 | static transaction_identifier FromUint256(const uint256& id) { return {id}; }Unexecuted instantiation: transaction_identifier<false>::FromUint256(uint256 const&) Unexecuted instantiation: transaction_identifier<true>::FromUint256(uint256 const&) |
47 | | |
48 | | /** Wrapped `uint256` methods. */ |
49 | 0 | constexpr bool IsNull() const { return m_wrapped.IsNull(); } |
50 | 0 | constexpr void SetNull() { m_wrapped.SetNull(); } |
51 | | static std::optional<transaction_identifier> FromHex(std::string_view hex) |
52 | 0 | { |
53 | 0 | auto u{uint256::FromHex(hex)}; |
54 | 0 | if (!u) return std::nullopt; |
55 | 0 | return FromUint256(*u); |
56 | 0 | } Unexecuted instantiation: transaction_identifier<false>::FromHex(std::__1::basic_string_view<char, std::__1::char_traits<char>>) Unexecuted instantiation: transaction_identifier<true>::FromHex(std::__1::basic_string_view<char, std::__1::char_traits<char>>) |
57 | 0 | std::string GetHex() const { return m_wrapped.GetHex(); }Unexecuted instantiation: transaction_identifier<false>::GetHex() const Unexecuted instantiation: transaction_identifier<true>::GetHex() const |
58 | 0 | std::string ToString() const { return m_wrapped.ToString(); }Unexecuted instantiation: transaction_identifier<false>::ToString() const Unexecuted instantiation: transaction_identifier<true>::ToString() const |
59 | | static constexpr auto size() { return decltype(m_wrapped)::size(); } |
60 | | constexpr const std::byte* data() const { return reinterpret_cast<const std::byte*>(m_wrapped.data()); } |
61 | 0 | constexpr const std::byte* begin() const { return reinterpret_cast<const std::byte*>(m_wrapped.begin()); }Unexecuted instantiation: transaction_identifier<true>::begin() const Unexecuted instantiation: transaction_identifier<false>::begin() const |
62 | 0 | constexpr const std::byte* end() const { return reinterpret_cast<const std::byte*>(m_wrapped.end()); } |
63 | 0 | template <typename Stream> void Serialize(Stream& s) const { m_wrapped.Serialize(s); }Unexecuted instantiation: void transaction_identifier<false>::Serialize<ParamsStream<SizeComputer&, TransactionSerParams>>(ParamsStream<SizeComputer&, TransactionSerParams>&) const Unexecuted instantiation: void transaction_identifier<false>::Serialize<ParamsStream<DataStream&, TransactionSerParams>>(ParamsStream<DataStream&, TransactionSerParams>&) const Unexecuted instantiation: void transaction_identifier<false>::Serialize<DataStream>(DataStream&) const Unexecuted instantiation: void transaction_identifier<false>::Serialize<ParamsStream<VectorWriter&, TransactionSerParams>>(ParamsStream<VectorWriter&, TransactionSerParams>&) const Unexecuted instantiation: void transaction_identifier<false>::Serialize<ParamsStream<ParamsStream<VectorWriter&, TransactionSerParams>&, TransactionSerParams>>(ParamsStream<ParamsStream<VectorWriter&, TransactionSerParams>&, TransactionSerParams>&) const Unexecuted instantiation: void transaction_identifier<false>::Serialize<AutoFile>(AutoFile&) const Unexecuted instantiation: void transaction_identifier<false>::Serialize<HashWriter>(HashWriter&) const Unexecuted instantiation: void transaction_identifier<false>::Serialize<ParamsStream<BufferedWriter<AutoFile>&, TransactionSerParams>>(ParamsStream<BufferedWriter<AutoFile>&, TransactionSerParams>&) const Unexecuted instantiation: void transaction_identifier<false>::Serialize<ParamsStream<AutoFile&, TransactionSerParams>>(ParamsStream<AutoFile&, TransactionSerParams>&) const Unexecuted instantiation: void transaction_identifier<true>::Serialize<HashWriter>(HashWriter&) const Unexecuted instantiation: void transaction_identifier<false>::Serialize<ParamsStream<HashWriter&, TransactionSerParams>>(ParamsStream<HashWriter&, TransactionSerParams>&) const |
64 | 0 | template <typename Stream> void Unserialize(Stream& s) { m_wrapped.Unserialize(s); }Unexecuted instantiation: void transaction_identifier<false>::Unserialize<ParamsStream<DataStream&, TransactionSerParams>>(ParamsStream<DataStream&, TransactionSerParams>&) Unexecuted instantiation: void transaction_identifier<false>::Unserialize<DataStream>(DataStream&) Unexecuted instantiation: void transaction_identifier<false>::Unserialize<ParamsStream<SpanReader&, TransactionSerParams>>(ParamsStream<SpanReader&, TransactionSerParams>&) Unexecuted instantiation: void transaction_identifier<false>::Unserialize<ParamsStream<AutoFile&, TransactionSerParams>>(ParamsStream<AutoFile&, TransactionSerParams>&) Unexecuted instantiation: void transaction_identifier<false>::Unserialize<AutoFile>(AutoFile&) Unexecuted instantiation: void transaction_identifier<false>::Unserialize<ParamsStream<BufferedFile&, TransactionSerParams>>(ParamsStream<BufferedFile&, TransactionSerParams>&) |
65 | | }; |
66 | | |
67 | | /** Txid commits to all transaction fields except the witness. */ |
68 | | using Txid = transaction_identifier<false>; |
69 | | /** Wtxid commits to all transaction fields including the witness. */ |
70 | | using Wtxid = transaction_identifier<true>; |
71 | | |
72 | | template <typename T> |
73 | | concept TxidOrWtxid = std::is_same_v<T, Txid> || std::is_same_v<T, Wtxid>; |
74 | | |
75 | | class GenTxid : public std::variant<Txid, Wtxid> |
76 | | { |
77 | | public: |
78 | | using variant::variant; |
79 | | |
80 | 0 | bool IsWtxid() const { return std::holds_alternative<Wtxid>(*this); } |
81 | | |
82 | | const uint256& ToUint256() const LIFETIMEBOUND |
83 | 0 | { |
84 | 0 | return std::visit([](const auto& id) -> const uint256& { return id.ToUint256(); }, *this);Unexecuted instantiation: uint256 const& GenTxid::ToUint256() const::'lambda'(auto const&)::operator()<transaction_identifier<false>>(auto const&) const Unexecuted instantiation: uint256 const& GenTxid::ToUint256() const::'lambda'(auto const&)::operator()<transaction_identifier<true>>(auto const&) const |
85 | 0 | } |
86 | | |
87 | | friend auto operator<=>(const GenTxid& a, const GenTxid& b) |
88 | 0 | { |
89 | | // Use a reference for read-only access to the hash, avoiding a copy that might not be optimized away. |
90 | 0 | return std::tuple<bool, const uint256&>(a.IsWtxid(), a.ToUint256()) <=> std::tuple<bool, const uint256&>(b.IsWtxid(), b.ToUint256()); |
91 | 0 | } |
92 | | }; |
93 | | |
94 | | #endif // BITCOIN_PRIMITIVES_TRANSACTION_IDENTIFIER_H |