// 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} {}

_ZN22transaction_identifierILb0EEC2ERK7uint256

Line

Count

Source

25

125k

    transaction_identifier(const uint256& wrapped) : m_wrapped{wrapped} {}

_ZN22transaction_identifierILb1EEC2ERK7uint256

Line

Count

Source

25

125k

    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); }

_ZNK22transaction_identifierILb0EE7CompareERKS0_

Line

Count

Source

27

1.75G

    constexpr int Compare(const transaction_identifier<has_witness>& other) const { return m_wrapped.Compare(other.m_wrapped); }

_ZNK22transaction_identifierILb1EE7CompareERKS0_

Line

Count

Source

27

9.07M

    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{} {}

_ZN22transaction_identifierILb0EEC2Ev

Line

Count

Source

36

1.02M

    transaction_identifier() : m_wrapped{} {}

Unexecuted instantiation: _ZN22transaction_identifierILb1EEC2Ev

    template <typename Other>

    bool operator==(const Other& other) const { return Compare(other) == 0; }

_ZNK22transaction_identifierILb0EEeqIS0_EEbRKT_

Line

Count

Source

39

11.3M

    bool operator==(const Other& other) const { return Compare(other) == 0; }

_ZNK22transaction_identifierILb1EEeqIS0_EEbRKT_

Line

Count

Source

39

9.07M

    bool operator==(const Other& other) const { return Compare(other) == 0; }

    template <typename Other>

    bool operator!=(const Other& other) const { return Compare(other) != 0; }

Unexecuted instantiation: _ZNK22transaction_identifierILb0EEneIS0_EEbRKT_

Unexecuted instantiation: _ZNK22transaction_identifierILb1EEneIS0_EEbRKT_

    template <typename Other>

    bool operator<(const Other& other) const { return Compare(other) < 0; }

_ZNK22transaction_identifierILb0EEltIS0_EEbRKT_

Line

Count

Source

43

1.73G

    bool operator<(const Other& other) const { return Compare(other) < 0; }

Unexecuted instantiation: _ZNK22transaction_identifierILb1EEltIS0_EEbRKT_

    const uint256& ToUint256() const LIFETIMEBOUND { return m_wrapped; }

_ZNK22transaction_identifierILb0EE9ToUint256Ev

Line

Count

Source

45

14.6M

    const uint256& ToUint256() const LIFETIMEBOUND { return m_wrapped; }

_ZNK22transaction_identifierILb1EE9ToUint256Ev

Line

Count

Source

45

12.9M

    const uint256& ToUint256() const LIFETIMEBOUND { return m_wrapped; }

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

_ZN22transaction_identifierILb0EE11FromUint256ERK7uint256

Line

Count

Source

46

125k

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

_ZN22transaction_identifierILb1EE11FromUint256ERK7uint256

Line

Count

Source

46

125k

    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);

    }

Unexecuted instantiation: _ZN22transaction_identifierILb0EE7FromHexESt17basic_string_viewIcSt11char_traitsIcEE

Unexecuted instantiation: _ZN22transaction_identifierILb1EE7FromHexESt17basic_string_viewIcSt11char_traitsIcEE

    std::string GetHex() const { return m_wrapped.GetHex(); }

Unexecuted instantiation: _ZNK22transaction_identifierILb0EE6GetHexB5cxx11Ev

Unexecuted instantiation: _ZNK22transaction_identifierILb1EE6GetHexB5cxx11Ev

    std::string ToString() const { return m_wrapped.ToString(); }

Unexecuted instantiation: _ZNK22transaction_identifierILb0EE8ToStringB5cxx11Ev

Unexecuted instantiation: _ZNK22transaction_identifierILb1EE8ToStringB5cxx11Ev

    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()); }

Unexecuted instantiation: _ZNK22transaction_identifierILb1EE5beginEv

Unexecuted instantiation: _ZNK22transaction_identifierILb0EE5beginEv

    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); }

_ZNK22transaction_identifierILb0EE9SerializeI12ParamsStreamIR12SizeComputer20TransactionSerParamsEEEvRT_

Line

Count

Source

63

3.88M

    template <typename Stream> void Serialize(Stream& s) const { m_wrapped.Serialize(s); }

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_

_ZNK22transaction_identifierILb0EE9SerializeI12ParamsStreamIR10HashWriter20TransactionSerParamsEEEvRT_

Line

Count

Source

63

972k

    template <typename Stream> void Serialize(Stream& s) const { m_wrapped.Serialize(s); }

    template <typename Stream> void Unserialize(Stream& s) { m_wrapped.Unserialize(s); }

Unexecuted instantiation: _ZN22transaction_identifierILb0EE11UnserializeI12ParamsStreamIR10DataStream20TransactionSerParamsEEEvRT_

_ZN22transaction_identifierILb0EE11UnserializeI10DataStreamEEvRT_

Line

Count

Source

64

50.4k

    template <typename Stream> void Unserialize(Stream& s) { m_wrapped.Unserialize(s); }

Unexecuted instantiation: _ZN22transaction_identifierILb0EE11UnserializeI12ParamsStreamIR10SpanReader20TransactionSerParamsEEEvRT_

Unexecuted instantiation: _ZN22transaction_identifierILb0EE11UnserializeI12ParamsStreamIR8AutoFile20TransactionSerParamsEEEvRT_

Unexecuted instantiation: _ZN22transaction_identifierILb0EE11UnserializeI8AutoFileEEvRT_

Unexecuted instantiation: _ZN22transaction_identifierILb0EE11UnserializeI12ParamsStreamIR12BufferedFile20TransactionSerParamsEEEvRT_

};

/** 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);

Unexecuted instantiation: _ZZNK7GenTxid9ToUint256EvENKUlRKT_E_clI22transaction_identifierILb0EEEERK7uint256S2_

Unexecuted instantiation: _ZZNK7GenTxid9ToUint256EvENKUlRKT_E_clI22transaction_identifierILb1EEEERK7uint256S2_

    }

    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