dash/src/net_types.h

63 lines
1.8 KiB
C
Raw Normal View History

// Copyright (c) 2019 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_NET_TYPES_H
#define BITCOIN_NET_TYPES_H
#include <cstdint>
#include <map>
#include <string>
class CSubNet;
class UniValue;
class CBanEntry
{
public:
static constexpr int CURRENT_VERSION{1};
int nVersion{CBanEntry::CURRENT_VERSION};
int64_t nCreateTime{0};
int64_t nBanUntil{0};
CBanEntry() {}
explicit CBanEntry(int64_t nCreateTimeIn)
: nCreateTime{nCreateTimeIn} {}
/**
* Create a ban entry from JSON.
* @param[in] json A JSON representation of a ban entry, as created by `ToJson()`.
* @throw std::runtime_error if the JSON does not have the expected fields.
*/
explicit CBanEntry(const UniValue& json);
/**
* Generate a JSON representation of this ban entry.
* @return JSON suitable for passing to the `CBanEntry(const UniValue&)` constructor.
*/
UniValue ToJson() const;
};
using banmap_t = std::map<CSubNet, CBanEntry>;
/**
* Convert a `banmap_t` object to a JSON array.
* @param[in] bans Bans list to convert.
* @return a JSON array, similar to the one returned by the `listbanned` RPC. Suitable for
* passing to `BanMapFromJson()`.
*/
UniValue BanMapToJson(const banmap_t& bans);
/**
* Convert a JSON array to a `banmap_t` object.
* @param[in] bans_json JSON to convert, must be as returned by `BanMapToJson()`.
* @param[out] bans Bans list to create from the JSON.
* @throws std::runtime_error if the JSON does not have the expected fields or they contain
* unparsable values.
*/
void BanMapFromJson(const UniValue& bans_json, banmap_t& bans);
#endif // BITCOIN_NET_TYPES_H