vtb.hpp

// Copyright (c) 2019-2022 Xenios SEZC
// https://www.veriblock.org
// Distributed under the MIT software license, see the accompanying
// file LICENSE or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef ALT_INTEGRATION_INCLUDE_VERIBLOCK_ENTITIES_VTB_HPP_
#define ALT_INTEGRATION_INCLUDE_VERIBLOCK_ENTITIES_VTB_HPP_
 
#include <cstddef>
#include <cstdint>
#include <string>
#include <vector>
#include <veriblock/pop/fmt.hpp>
#include <veriblock/pop/json.hpp>
#include <veriblock/pop/serde.hpp>
#include <veriblock/pop/uint.hpp>
 
#include "vbk_merkle_path.hpp"
#include "vbkblock.hpp"
#include "vbkpoptx.hpp"
#include "veriblock/pop/blob.hpp"
 
namespace altintegration {
class ValidationState;
class WriteStream;
struct ReadStream;
template <typename T>
struct IsPopPayload;
 
struct VTB {
  using id_t = uint256;
  using containing_block_t = VbkBlock;
 
  uint32_t version = 1;
  VbkPopTx transaction{};
  VbkMerklePath merklePath{};
  containing_block_t containingBlock{};
 
  mutable bool checked{false};
 
  std::string toPrettyString() const;
  std::string toShortPrettyString() const;
 
  void toVbkEncoding(WriteStream& stream) const;
 
  std::vector<uint8_t> toVbkEncoding() const;
 
  size_t estimateSize() const;
 
  id_t getId() const;
 
  static const std::string& name() { return _name; }
 
  friend bool operator==(const VTB& a, const VTB& b) {
    return a.getId() == b.getId();
  }
 
  friend bool operator!=(const VTB& a, const VTB& b) { return !(a == b); }
 
  friend bool operator<(const VTB& a, const VTB& b) {
    return a.containingBlock.getHeight() < b.containingBlock.getHeight();
  }
 
 private:
  static const std::string _name;
};
 
template <>
struct IsPopPayload<VTB> {
  static const bool value = true;
};
 
template <typename JsonValue>
JsonValue ToJSON(const VTB& v) {
  JsonValue obj = json::makeEmptyObject<JsonValue>();
  json::putIntKV(obj, "version", v.version);
  json::putKV(obj, "transaction", ToJSON<JsonValue>(v.transaction));
  json::putKV(obj, "merklePath", ToJSON<JsonValue>(v.merklePath));
  json::putKV(obj, "containingBlock", ToJSON<JsonValue>(v.containingBlock));
 
  // return this entity in VBK-serialized form for easy consumption.
  // DO NOT REMOVE these fields - otherwise Stratum compat will break.
  json::putStringKV(obj, "id", v.getId().toHex());
  json::putStringKV(obj, "serialized", SerializeToHex(v));
  return obj;
}
 
bool DeserializeFromVbkEncoding(ReadStream& stream,
                                VTB& out,
                                ValidationState& state);
 
}  // namespace altintegration
 
#endif  // ALT_INTEGRATION_INCLUDE_VERIBLOCK_ENTITIES_VTB_HPP_