Bitcoin Core 29.99.0
P2P Digital Currency
transaction_identifier.h
Go to the documentation of this file.
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
19template <bool has_witness>
21{
23
24 // Note: Use FromUint256 externally instead.
25 transaction_identifier(const uint256& wrapped) : m_wrapped{wrapped} {}
26
27 constexpr int Compare(const transaction_identifier<has_witness>& other) const { return m_wrapped.Compare(other.m_wrapped); }
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
35public:
37
38 template <typename Other>
39 bool operator==(const Other& other) const { return Compare(other) == 0; }
40 template <typename Other>
41 bool operator!=(const Other& other) const { return Compare(other) != 0; }
42 template <typename Other>
43 bool operator<(const Other& other) const { return Compare(other) < 0; }
44
45 const uint256& ToUint256() const LIFETIMEBOUND { return m_wrapped; }
46 static transaction_identifier FromUint256(const uint256& id) { return {id}; }
47
49 constexpr bool IsNull() const { return m_wrapped.IsNull(); }
50 constexpr void SetNull() { m_wrapped.SetNull(); }
51 static std::optional<transaction_identifier> FromHex(std::string_view hex)
52 {
53 auto u{uint256::FromHex(hex)};
54 if (!u) return std::nullopt;
55 return FromUint256(*u);
56 }
57 std::string GetHex() const { return m_wrapped.GetHex(); }
58 std::string ToString() const { return m_wrapped.ToString(); }
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 constexpr const std::byte* begin() const { return reinterpret_cast<const std::byte*>(m_wrapped.begin()); }
62 constexpr const std::byte* end() const { return reinterpret_cast<const std::byte*>(m_wrapped.end()); }
63 template <typename Stream> void Serialize(Stream& s) const { m_wrapped.Serialize(s); }
64 template <typename Stream> void Unserialize(Stream& s) { m_wrapped.Unserialize(s); }
65};
66
71
72template <typename T>
73concept TxidOrWtxid = std::is_same_v<T, Txid> || std::is_same_v<T, Wtxid>;
74
75class GenTxid : public std::variant<Txid, Wtxid>
76{
77public:
78 using variant::variant;
79
80 bool IsWtxid() const { return std::holds_alternative<Wtxid>(*this); }
81
83 {
84 return std::visit([](const auto& id) -> const uint256& { return id.ToUint256(); }, *this);
85 }
86
87 friend auto operator<=>(const GenTxid& a, const GenTxid& b)
88 {
89 // Use a reference for read-only access to the hash, avoiding a copy that might not be optimized away.
90 return std::tuple<bool, const uint256&>(a.IsWtxid(), a.ToUint256()) <=> std::tuple<bool, const uint256&>(b.IsWtxid(), b.ToUint256());
91 }
92};
93
94#endif // BITCOIN_PRIMITIVES_TRANSACTION_IDENTIFIER_H
#define LIFETIMEBOUND
Definition: attributes.h:16
bool IsWtxid() const
const uint256 & ToUint256() const LIFETIMEBOUND
friend auto operator<=>(const GenTxid &a, const GenTxid &b)
constexpr bool IsNull() const
Definition: uint256.h:48
constexpr unsigned char * end()
Definition: uint256.h:102
void Unserialize(Stream &s)
Definition: uint256.h:118
std::string ToString() const
Definition: uint256.cpp:21
constexpr int Compare(const base_blob &other) const
Lexicographic ordering.
Definition: uint256.h:64
constexpr unsigned char * begin()
Definition: uint256.h:101
void Serialize(Stream &s) const
Definition: uint256.h:112
constexpr void SetNull()
Definition: uint256.h:55
std::string GetHex() const
Definition: uint256.cpp:11
constexpr const unsigned char * data() const
Definition: uint256.h:98
transaction_identifier represents the two canonical transaction identifier types (txid,...
std::string ToString() const
static constexpr auto size()
void Serialize(Stream &s) const
constexpr const std::byte * begin() const
const uint256 & ToUint256() const LIFETIMEBOUND
constexpr bool IsNull() const
Wrapped uint256 methods.
transaction_identifier(const uint256 &wrapped)
bool operator<(const Other &other) const
bool operator==(const Other &other) const
constexpr int Compare(const Other &other) const
std::string GetHex() const
bool operator!=(const Other &other) const
constexpr const std::byte * data() const
static transaction_identifier FromUint256(const uint256 &id)
constexpr const std::byte * end() const
constexpr int Compare(const transaction_identifier< has_witness > &other) const
static std::optional< transaction_identifier > FromHex(std::string_view hex)
256-bit opaque blob.
Definition: uint256.h:196
static std::optional< uint256 > FromHex(std::string_view str)
Definition: uint256.h:198