netgroup.h

Go to the documentation of this file.

// Copyright (c) 2021-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_NETGROUP_H
#define BITCOIN_NETGROUP_H

#include <netaddress.h>
#include <uint256.h>

#include <cstddef>
#include <vector>

class NetGroupManager {
public:
    NetGroupManager(const NetGroupManager&) = delete;
    NetGroupManager(NetGroupManager&&) = default;
    NetGroupManager& operator=(const NetGroupManager&) = delete;
    NetGroupManager& operator=(NetGroupManager&&) = delete;

    static NetGroupManager WithEmbeddedAsmap(std::span<const std::byte> asmap) {
        return NetGroupManager(asmap, {});
    }

    static NetGroupManager WithLoadedAsmap(std::vector<std::byte>&& asmap) {
        return NetGroupManager(std::span{asmap}, std::move(asmap));
    }

    static NetGroupManager NoAsmap() {
        return NetGroupManager({}, {});
    }

    uint256 GetAsmapVersion() const;

    std::vector<unsigned char> GetGroup(const CNetAddr& address) const;

    uint32_t GetMappedAS(const CNetAddr& address) const;

    void ASMapHealthCheck(const std::vector<CNetAddr>& clearnet_addrs) const;

    bool UsingASMap() const;

private:
    const std::span<const std::byte> m_asmap;
    std::vector<std::byte> m_loaded_asmap;

    explicit NetGroupManager(std::span<const std::byte> embedded_asmap, std::vector<std::byte>&& loaded_asmap)
        : m_asmap{embedded_asmap},
          m_loaded_asmap{std::move(loaded_asmap)}
    {
        assert(m_loaded_asmap.empty() || m_asmap.data() == m_loaded_asmap.data());
    }
};

#endif // BITCOIN_NETGROUP_H