/root/bitcoin/src/primitives/transaction_identifier.h

Source
// Copyright (c) 2023-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or https://opensource.org/license/mit.

#ifndef BITCOIN_PRIMITIVES_TRANSACTION_IDENTIFIER_H
#define BITCOIN_PRIMITIVES_TRANSACTION_IDENTIFIER_H

#include <attributes.h>
#include <uint256.h>
#include <util/types.h>

#include <compare>
#include <concepts>
#include <tuple>
#include <variant>

/** transaction_identifier represents the two canonical transaction identifier
 * types (txid, wtxid).*/
template <bool has_witness>
class transaction_identifier
{
    uint256 m_wrapped;

    // Note: Use FromUint256 externally instead.
    transaction_identifier(const uint256& wrapped) : m_wrapped{wrapped} {}

    constexpr int Compare(const transaction_identifier<has_witness>& other) const { return m_wrapped.Compare(other.m_wrapped); }
    template <typename Other>
    constexpr int Compare(const Other& other) const
    {
        static_assert(ALWAYS_FALSE<Other>, "Forbidden comparison type");
        return 0;
    }

public:
    transaction_identifier() : m_wrapped{} {}

    template <typename Other>
    bool operator==(const Other& other) const { return Compare(other) == 0; }
    template <typename Other>
    bool operator<(const Other& other) const { return Compare(other) < 0; }

    const uint256& ToUint256() const LIFETIMEBOUND { return m_wrapped; }
    static transaction_identifier FromUint256(const uint256& id) { return {id}; }

    /** Wrapped `uint256` methods. */
    constexpr bool IsNull() const { return m_wrapped.IsNull(); }
    constexpr void SetNull() { m_wrapped.SetNull(); }
    static std::optional<transaction_identifier> FromHex(std::string_view hex)
    {
        auto u{uint256::FromHex(hex)};
        if (!u) return std::nullopt;
        return FromUint256(*u);
    }
    std::string GetHex() const { return m_wrapped.GetHex(); }
    std::string ToString() const { return m_wrapped.ToString(); }
    static constexpr auto size() { return decltype(m_wrapped)::size(); }
    constexpr const std::byte* data() const { return reinterpret_cast<const std::byte*>(m_wrapped.data()); }
    constexpr const std::byte* begin() const { return reinterpret_cast<const std::byte*>(m_wrapped.begin()); }
    constexpr const std::byte* end() const { return reinterpret_cast<const std::byte*>(m_wrapped.end()); }
    template <typename Stream> void Serialize(Stream& s) const { m_wrapped.Serialize(s); }
    template <typename Stream> void Unserialize(Stream& s) { m_wrapped.Unserialize(s); }
};

/** Txid commits to all transaction fields except the witness. */
using Txid = transaction_identifier<false>;
/** Wtxid commits to all transaction fields including the witness. */
using Wtxid = transaction_identifier<true>;

template <typename T>
concept TxidOrWtxid = std::is_same_v<T, Txid> || std::is_same_v<T, Wtxid>;

class GenTxid : public std::variant<Txid, Wtxid>
{
public:
    using variant::variant;

    bool IsWtxid() const { return std::holds_alternative<Wtxid>(*this); }

    const uint256& ToUint256() const LIFETIMEBOUND
    {
        return std::visit([](const auto& id) -> const uint256& { return id.ToUint256(); }, *this);
    }

    friend auto operator<=>(const GenTxid& a, const GenTxid& b)
    {
        // Use a reference for read-only access to the hash, avoiding a copy that might not be optimized away.
        return std::tuple<bool, const uint256&>(a.IsWtxid(), a.ToUint256()) <=> std::tuple<bool, const uint256&>(b.IsWtxid(), b.ToUint256());
    }
};

#endif // BITCOIN_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: _ZN22transaction_identifierILb0EEC2ERK7uint256 Unexecuted instantiation: _ZN22transaction_identifierILb1EEC2ERK7uint256
26
27	0	constexpr int Compare(const transaction_identifier<has_witness>& other) const { return m_wrapped.Compare(other.m_wrapped); } Unexecuted instantiation: _ZNK22transaction_identifierILb0EE7CompareERKS0_ Unexecuted instantiation: _ZNK22transaction_identifierILb1EE7CompareERKS0_
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: _ZN22transaction_identifierILb0EEC2Ev Unexecuted instantiation: _ZN22transaction_identifierILb1EEC2Ev
37
38		template <typename Other>
39	0	bool operator==(const Other& other) const { return Compare(other) == 0; } Unexecuted instantiation: _ZNK22transaction_identifierILb0EEeqIS0_EEbRKT_ Unexecuted instantiation: _ZNK22transaction_identifierILb1EEeqIS0_EEbRKT_
40		template <typename Other>
41	0	bool operator<(const Other& other) const { return Compare(other) < 0; } Unexecuted instantiation: _ZNK22transaction_identifierILb0EEltIS0_EEbRKT_ Unexecuted instantiation: _ZNK22transaction_identifierILb1EEltIS0_EEbRKT_
42
43	0	const uint256& ToUint256() const LIFETIMEBOUND { return m_wrapped; } Unexecuted instantiation: _ZNK22transaction_identifierILb0EE9ToUint256Ev Unexecuted instantiation: _ZNK22transaction_identifierILb1EE9ToUint256Ev
44	0	static transaction_identifier FromUint256(const uint256& id) { return {id}; } Unexecuted instantiation: _ZN22transaction_identifierILb0EE11FromUint256ERK7uint256 Unexecuted instantiation: _ZN22transaction_identifierILb1EE11FromUint256ERK7uint256
45
46		/** Wrapped `uint256` methods. */
47	0	constexpr bool IsNull() const { return m_wrapped.IsNull(); }
48	0	constexpr void SetNull() { m_wrapped.SetNull(); }
49		static std::optional<transaction_identifier> FromHex(std::string_view hex)
50	0	{
51	0	auto u{uint256::FromHex(hex)};
52	0	if (!u) return std::nullopt;
53	0	return FromUint256(*u);
54	0	} Unexecuted instantiation: _ZN22transaction_identifierILb0EE7FromHexESt17basic_string_viewIcSt11char_traitsIcEE Unexecuted instantiation: _ZN22transaction_identifierILb1EE7FromHexESt17basic_string_viewIcSt11char_traitsIcEE
55	0	std::string GetHex() const { return m_wrapped.GetHex(); } Unexecuted instantiation: _ZNK22transaction_identifierILb0EE6GetHexB5cxx11Ev Unexecuted instantiation: _ZNK22transaction_identifierILb1EE6GetHexB5cxx11Ev
56	0	std::string ToString() const { return m_wrapped.ToString(); } Unexecuted instantiation: _ZNK22transaction_identifierILb0EE8ToStringB5cxx11Ev Unexecuted instantiation: _ZNK22transaction_identifierILb1EE8ToStringB5cxx11Ev
57		static constexpr auto size() { return decltype(m_wrapped)::size(); }
58		constexpr const std::byte* data() const { return reinterpret_cast<const std::byte*>(m_wrapped.data()); }
59	0	constexpr const std::byte* begin() const { return reinterpret_cast<const std::byte*>(m_wrapped.begin()); } Unexecuted instantiation: _ZNK22transaction_identifierILb1EE5beginEv Unexecuted instantiation: _ZNK22transaction_identifierILb0EE5beginEv
60	0	constexpr const std::byte* end() const { return reinterpret_cast<const std::byte*>(m_wrapped.end()); }
61	0	template <typename Stream> void Serialize(Stream& s) const { m_wrapped.Serialize(s); } Unexecuted instantiation: _ZNK22transaction_identifierILb0EE9SerializeI12ParamsStreamIR12SizeComputer20TransactionSerParamsEEEvRT_ Unexecuted instantiation: _ZNK22transaction_identifierILb0EE9SerializeI12ParamsStreamIR10DataStream20TransactionSerParamsEEEvRT_ Unexecuted instantiation: _ZNK22transaction_identifierILb0EE9SerializeI10DataStreamEEvRT_ Unexecuted instantiation: _ZNK22transaction_identifierILb0EE9SerializeI12ParamsStreamIR12VectorWriter20TransactionSerParamsEEEvRT_ Unexecuted instantiation: _ZNK22transaction_identifierILb0EE9SerializeI12ParamsStreamIRS2_IR12VectorWriter20TransactionSerParamsES5_EEEvRT_ Unexecuted instantiation: _ZNK22transaction_identifierILb0EE9SerializeI8AutoFileEEvRT_ Unexecuted instantiation: _ZNK22transaction_identifierILb0EE9SerializeI10HashWriterEEvRT_ Unexecuted instantiation: _ZNK22transaction_identifierILb0EE9SerializeI12ParamsStreamIR14BufferedWriterI8AutoFileE20TransactionSerParamsEEEvRT_ Unexecuted instantiation: _ZNK22transaction_identifierILb0EE9SerializeI12ParamsStreamIR8AutoFile20TransactionSerParamsEEEvRT_ Unexecuted instantiation: _ZNK22transaction_identifierILb1EE9SerializeI10HashWriterEEvRT_ Unexecuted instantiation: _ZNK22transaction_identifierILb0EE9SerializeI12ParamsStreamIR10HashWriter20TransactionSerParamsEEEvRT_
62	0	template <typename Stream> void Unserialize(Stream& s) { m_wrapped.Unserialize(s); } Unexecuted instantiation: _ZN22transaction_identifierILb0EE11UnserializeI12ParamsStreamIR10DataStream20TransactionSerParamsEEEvRT_ Unexecuted instantiation: _ZN22transaction_identifierILb0EE11UnserializeI10DataStreamEEvRT_ Unexecuted instantiation: _ZN22transaction_identifierILb0EE11UnserializeI12ParamsStreamIR10SpanReader20TransactionSerParamsEEEvRT_ Unexecuted instantiation: _ZN22transaction_identifierILb0EE11UnserializeI12ParamsStreamIR8AutoFile20TransactionSerParamsEEEvRT_ Unexecuted instantiation: _ZN22transaction_identifierILb0EE11UnserializeI8AutoFileEEvRT_ Unexecuted instantiation: _ZN22transaction_identifierILb0EE11UnserializeI12ParamsStreamIR12BufferedFile20TransactionSerParamsEEEvRT_
63		};
64
65		/** Txid commits to all transaction fields except the witness. */
66		using Txid = transaction_identifier<false>;
67		/** Wtxid commits to all transaction fields including the witness. */
68		using Wtxid = transaction_identifier<true>;
69
70		template <typename T>
71		concept TxidOrWtxid = std::is_same_v<T, Txid> \|\| std::is_same_v<T, Wtxid>;
72
73		class GenTxid : public std::variant<Txid, Wtxid>
74		{
75		public:
76		using variant::variant;
77
78	0	bool IsWtxid() const { return std::holds_alternative<Wtxid>(*this); }
79
80		const uint256& ToUint256() const LIFETIMEBOUND
81	0	{
82	0	return std::visit([](const auto& id) -> const uint256& { return id.ToUint256(); }, *this); Unexecuted instantiation: _ZZNK7GenTxid9ToUint256EvENKUlRKT_E_clI22transaction_identifierILb0EEEERK7uint256S2_ Unexecuted instantiation: _ZZNK7GenTxid9ToUint256EvENKUlRKT_E_clI22transaction_identifierILb1EEEERK7uint256S2_
83	0	}
84
85		friend auto operator<=>(const GenTxid& a, const GenTxid& b)
86	0	{
87		// Use a reference for read-only access to the hash, avoiding a copy that might not be optimized away.
88	0	return std::tuple<bool, const uint256&>(a.IsWtxid(), a.ToUint256()) <=> std::tuple<bool, const uint256&>(b.IsWtxid(), b.ToUint256());
89	0	}
90		};
91
92		#endif // BITCOIN_PRIMITIVES_TRANSACTION_IDENTIFIER_H

Coverage Report

Created: 2025-12-17 17:25