btc_block_addon.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 VERIBLOCK_POP_CPP_BTC_BLOCK_INDEX_HPP
#define VERIBLOCK_POP_CPP_BTC_BLOCK_INDEX_HPP
 
#include <veriblock/pop/arith_uint256.hpp>
#include <veriblock/pop/entities/endorsements.hpp>
#include <veriblock/pop/uint.hpp>
 
#include "block_status.hpp"
 
namespace altintegration {
 
struct BtcBlockAddon {
  using ref_height_t = int32_t;
 
  ArithUint256 chainWork = 0;
 
  static constexpr auto validTipLevel = BLOCK_VALID_TREE;
 
  void setNullInmemFields();
 
  void setIsBootstrap(bool isBootstrap);
 
  uint32_t refCount() const;
 
  const std::vector<ref_height_t>& getRefs() const { return refs; }
 
  void addRef(ref_height_t referencedAtHeight);
 
  void removeRef(ref_height_t referencedAtHeight);
 
  void clearRefs();
 
  void insertBlockOfProofEndorsement(const VbkEndorsement* e);
 
  bool eraseLastFromBlockOfProofEndorsement(const VbkEndorsement* endorsement);
 
  void clearBlockOfProofEndorsement();
 
  const std::vector<const VbkEndorsement*>& getBlockOfProofEndorsement() const;
 
  std::string toPrettyString() const;
 
  void toVbkEncoding(WriteStream& w) const;
 
 protected:
  // Ideally we would want a sorted collection with cheap addition, deletion and
  // lookup. In practice, due to VBK/BTC block time ratio(20x) and multiple APMs
  // running, there's little chance of VTBs shipping non-empty BTC context. The
  // altchain mempool prioritization algo will realistically pick 1 VTB per VBK
  // keystone period(20 blocks), providing us with the BTC block mined during
  // this period. Thus, we can expect to have 1-2 references per block and 2x
  // that during fork resolution making std::vector the fastest storage option
  // in this case.
  // TODO: figure out if this is somehow abusable by spammers/dosers
  std::vector<ref_height_t> refs{};
 
  std::vector<const VbkEndorsement*> _blockOfProofEndorsements;
 
  void setDirty();
 
  void setNull();
 
  friend bool DeserializeFromVbkEncoding(ReadStream& stream,
                                         BtcBlockAddon& out,
                                         ValidationState& state);
};
 
bool DeserializeFromVbkEncoding(ReadStream& stream,
                                BtcBlockAddon& out,
                                ValidationState& state);
 
}  // namespace altintegration
 
#endif  // VERIBLOCK_POP_CPP_BTC_BLOCK_INDEX_HPP