altintegration::BlockIndex< Block > Struct Template Reference

A node in a block tree. More...

Detailed Description

template<typename Block>
struct altintegration::BlockIndex< Block >

Template Parameters

Block

Definition at line 31 of file block_index.hpp.

#include <block_index.hpp>

Inheritance diagram for altintegration::BlockIndex< Block >:

Collaboration diagram for altintegration::BlockIndex< Block >:

Public Types
using	block_t = Block
using	addon_t = typename Block::addon_t
using	hash_t = typename block_t::hash_t
using	prev_hash_t = typename block_t::prev_hash_t
using	height_t = typename block_t::height_t

Public Member Functions
	BlockIndex (BlockIndex *prev)
	create a regular block in a deleted state More...
	BlockIndex (height_t _height)
	create a root block in a deleted state More...
void	disconnectFromPrev ()
bool	isTip () const
	BlockIndex (BlockIndex &&other)=default
BlockIndex &	operator= (BlockIndex &&other)=default
bool	isDeleted () const
bool	isRoot () const
void	restore ()
void	deleteTemporarily ()
void	mergeFrom (const StoredBlockIndex< Block > &other)
StoredBlockIndex< Block >	toStoredBlockIndex () const
bool	isConnected () const noexcept
	Block is connected if it contains block body (PopData), and all its ancestors are connected. More...
uint32_t	getStatus () const
void	setStatus (uint32_t _status)
uint32_t	getValidityLevel () const
bool	isFailed () const
bool	isValid (enum BlockStateStatus upTo=BLOCK_VALID_TREE) const
bool	isValidUpTo (enum BlockStateStatus upTo) const
void	setNull ()
void	setNullInmemFields ()
bool	raiseValidity (enum BlockStateStatus upTo)
bool	lowerValidity (enum BlockStateStatus upTo)
void	setDirty ()
void	unsetDirty ()
bool	isDirty () const
void	setFlag (enum BlockValidityStatus s)
void	unsetFlag (enum BlockValidityStatus s)
bool	hasFlags (enum BlockValidityStatus s) const
const hash_t &	getHash () const
uint32_t	getTimestamp () const
uint32_t	getDifficulty () const
height_t	getHeight () const
void	setHeight (const height_t newHeight)
const block_t &	getHeader () const
void	setHeader (const block_t &newHeader)
void	setHeader (std::shared_ptr< block_t > newHeader)
bool	canBeATip () const
bool	isValidTip () const
	The block is a valid tip if it can be a tip and either there are no descendant blocks or none of the descendants can be a tip. More...
bool	allDescendantsUnapplied () const
	Check if all immediate descendants of the block are unapplied. More...
size_t	nondeletedDescendantCount () const
	Count the descendants that are not deleted. More...
bool	allDescendantsUnconnected () const
	Check if all immediate descendants of the block are not connected. More...
const BlockIndex *	getAncestorBlocksBehind (height_t steps) const
const BlockIndex *	getPrev () const
BlockIndex *	getPrev ()
bool	isDescendantOf (const BlockIndex &ancestor) const
bool	isAncestorOf (const BlockIndex &descendant) const
const BlockIndex *	getAncestor (height_t _height) const
BlockIndex *	getAncestor (height_t _height)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
std::string	toPrettyString (size_t level=0) const
std::string	toShortPrettyString () const

Public Attributes
BlockIndex *	pprev = nullptr
	(memory only) pointer to the previous block More...
std::set< BlockIndex * >	pnext {}
	(memory only) a set of pointers for forward iteration More...
bool	finalized = false
	(memory only) if true, this block can not be reorganized More...

Protected Attributes
height_t	height = 0
	height of the entry in the chain More...
std::shared_ptr< block_t >	header = std::make_shared<block_t>()
	block header More...
uint32_t	status = BLOCK_VALID_UNKNOWN | BLOCK_DELETED
	contains status flags More...
bool	dirty = false
	(memory only) if true, this block should be written on disk More...

Friends
bool	operator== (const BlockIndex &a, const BlockIndex &b)
bool	operator!= (const BlockIndex &a, const BlockIndex &b)

Member Typedef Documentation

addon_t

template<typename Block >

using altintegration::BlockIndex< Block >::addon_t = typename Block::addon_t

Definition at line 33 of file block_index.hpp.

block_t

template<typename Block >

using altintegration::BlockIndex< Block >::block_t = Block

Definition at line 32 of file block_index.hpp.

hash_t

template<typename Block >

using altintegration::BlockIndex< Block >::hash_t = typename block_t::hash_t

Definition at line 34 of file block_index.hpp.

height_t

template<typename Block >

using altintegration::BlockIndex< Block >::height_t = typename block_t::height_t

Definition at line 36 of file block_index.hpp.

prev_hash_t

template<typename Block >

using altintegration::BlockIndex< Block >::prev_hash_t = typename block_t::prev_hash_t

Definition at line 35 of file block_index.hpp.

Constructor & Destructor Documentation

BlockIndex() [1/2]

template<typename Block >

altintegration::BlockIndex< Block >::BlockIndex ( BlockIndex< Block > *  prev )

inline

Definition at line 48 of file block_index.hpp.

                               : pprev(prev) {
    // FIXME: prev should be a reference
    VBK_ASSERT(prev != nullptr);
 
    pprev->pnext.insert(this);
 
    if (pprev->isFailed()) {
      setFlag(BLOCK_FAILED_CHILD);
    }
 
    height = prev->getHeight() + 1;
 
    // TODO: what dirtiness should it have here?
  }

BlockIndex() [2/2]

template<typename Block >

altintegration::BlockIndex< Block >::BlockIndex ( height_t  _height )

inlineexplicit

Definition at line 64 of file block_index.hpp.

: pprev(nullptr), height(_height) {}

~BlockIndex()

template<typename Block >

altintegration::BlockIndex< Block >::~BlockIndex ( )

inline

Definition at line 66 of file block_index.hpp.

                {
    // before block is deallocated it must be disconnected and deleted.
    VBK_ASSERT(isTip());
    VBK_ASSERT(isDeleted());
    VBK_ASSERT_MSG(pprev == nullptr, pprev->toPrettyString());
  }

Member Function Documentation

allDescendantsUnapplied()

template<typename Block >

bool altintegration::BlockIndex< Block >::allDescendantsUnapplied ( ) const

inline

Definition at line 286 of file block_index.hpp.

                                       {
    return isTip() ||
           std::none_of(pnext.begin(), pnext.end(), [](BlockIndex* index) {
             return index->hasFlags(BLOCK_ACTIVE);
           });
  }

allDescendantsUnconnected()

template<typename Block >

bool altintegration::BlockIndex< Block >::allDescendantsUnconnected ( ) const

inline

Definition at line 306 of file block_index.hpp.

                                         {
    return isTip() ||
           std::none_of(pnext.begin(), pnext.end(), [](BlockIndex* index) {
             return index->isConnected();
           });
  }

canBeATip()

template<typename Block >

bool altintegration::BlockIndex< Block >::canBeATip ( ) const

inline

Definition at line 268 of file block_index.hpp.

                         {
    return !isDeleted() && isValid(addon_t::validTipLevel);
  }

deleteTemporarily()

template<typename Block >

void altintegration::BlockIndex< Block >::deleteTemporarily ( )

inline

Definition at line 105 of file block_index.hpp.

                           {
    VBK_ASSERT_MSG(!isDeleted(),
                   "tried to delete block %s that is already deleted",
                   toPrettyString());
 
    // FIXME: this is a hack that might eventually bite us
    addon_t::setNull();
 
    // preserve FAILED_* flags
    this->status = (this->status & BLOCK_FAILED_MASK) | BLOCK_VALID_UNKNOWN |
                   BLOCK_DELETED;
 
    // make it dirty by default
    setDirty();
  }

disconnectFromPrev()

template<typename Block >

void altintegration::BlockIndex< Block >::disconnectFromPrev ( )

inline

Definition at line 73 of file block_index.hpp.

                            {
    if (pprev == nullptr) {
      // this block is already root
      return;
    }
 
    VBK_ASSERT_MSG(pprev->pnext.count(this) > 0, this->toPrettyString());
    this->pprev->pnext.erase(this);
    this->pprev = nullptr;
  }

getAncestor() [1/2]

template<typename Block >

BlockIndex * altintegration::BlockIndex< Block >::getAncestor ( height_t  _height )

inline

Definition at line 366 of file block_index.hpp.

                                            {
    const auto& t = as_const(*this);
    return const_cast<BlockIndex*>(t.getAncestor(_height));
  }

getAncestor() [2/2]

template<typename Block >

const BlockIndex * altintegration::BlockIndex< Block >::getAncestor ( height_t  _height ) const

inline

Returns

a pointer to ancestor on height _height, if any. If no ancestor on this height, or height is greater than this block height, returns nullptr.

Definition at line 347 of file block_index.hpp.

                                                        {
    VBK_ASSERT(_height >= 0);
    if (_height > this->height) {
      return nullptr;
    }
 
    // TODO: this algorithm is not optimal. for O(n) seek backwards until we hit
    // valid height. also it assumes whole blockchain is in memory (pprev is
    // valid until given height)
    const BlockIndex* index = this;
    while (index != nullptr && index->height > _height) {
      index = index->getPrev();
    }
 
    VBK_ASSERT(index == nullptr || index->height == _height);
    return index;
  }

getAncestorBlocksBehind()

template<typename Block >

const BlockIndex * altintegration::BlockIndex< Block >::getAncestorBlocksBehind ( height_t  steps ) const

inline

Definition at line 313 of file block_index.hpp.

                                                                  {
    if (steps < 0 || steps > this->height) {
      return nullptr;
    }
 
    return this->getAncestor(this->height - steps);
  }

getDifficulty()

template<typename Block >

uint32_t altintegration::BlockIndex< Block >::getDifficulty ( ) const

inline

Definition at line 250 of file block_index.hpp.

{ return header->getDifficulty(); }

getHash()

template<typename Block >

const hash_t & altintegration::BlockIndex< Block >::getHash ( ) const

inline

Definition at line 248 of file block_index.hpp.

{ return header->getHash(); }

getHeader()

template<typename Block >

const block_t & altintegration::BlockIndex< Block >::getHeader ( ) const

inline

Definition at line 258 of file block_index.hpp.

{ return *header; }

getHeight()

template<typename Block >

height_t altintegration::BlockIndex< Block >::getHeight ( ) const

inline

Definition at line 252 of file block_index.hpp.

{ return height; }

getPrev() [1/2]

template<typename Block >

BlockIndex * altintegration::BlockIndex< Block >::getPrev ( )

inline

Definition at line 331 of file block_index.hpp.

                        {
    const auto& t = as_const(*this);
    return const_cast<BlockIndex*>(t.getPrev());
  }

getPrev() [2/2]

template<typename Block >

const BlockIndex * altintegration::BlockIndex< Block >::getPrev ( ) const

inline

Definition at line 321 of file block_index.hpp.

                                    {
    VBK_ASSERT_MSG(isRoot() || getHeight() == pprev->getHeight() + 1,
                   "state corruption: unexpected height of the previous block "
                   "%s of block %s",
                   pprev->toPrettyString(),
                   toPrettyString());
 
    return pprev;
  }

getStatus()

template<typename Block >

uint32_t altintegration::BlockIndex< Block >::getStatus ( ) const

inline

Definition at line 149 of file block_index.hpp.

{ return status; }

getTimestamp()

template<typename Block >

uint32_t altintegration::BlockIndex< Block >::getTimestamp ( ) const

inline

Definition at line 249 of file block_index.hpp.

{ return header->getTimestamp(); }

getValidityLevel()

template<typename Block >

uint32_t altintegration::BlockIndex< Block >::getValidityLevel ( ) const

inline

Definition at line 156 of file block_index.hpp.

                                    {
    auto level = status & BLOCK_VALID_MASK;
    VBK_ASSERT_MSG(level <= BLOCK_CAN_BE_APPLIED, "unknown validity level");
    return level;
  }

hasFlags()

template<typename Block >

bool altintegration::BlockIndex< Block >::hasFlags ( enum BlockValidityStatus  s ) const

inline

Definition at line 246 of file block_index.hpp.

{ return this->status & s; }

isAncestorOf()

template<typename Block >

bool altintegration::BlockIndex< Block >::isAncestorOf ( const BlockIndex< Block > &  descendant ) const

inline

Definition at line 340 of file block_index.hpp.

                                                        {
    return descendant.getAncestor(getHeight()) == this;
  }

isConnected()

template<typename Block >

bool altintegration::BlockIndex< Block >::isConnected ( ) const

inlinenoexcept

Returns

true if block is connected, false otherwise.

Definition at line 145 of file block_index.hpp.

                                    {
    return this->isValidUpTo(BLOCK_CONNECTED);
  }

isDeleted()

template<typename Block >

bool altintegration::BlockIndex< Block >::isDeleted ( ) const

inline

Definition at line 93 of file block_index.hpp.

{ return hasFlags(BLOCK_DELETED); };

isDescendantOf()

template<typename Block >

bool altintegration::BlockIndex< Block >::isDescendantOf ( const BlockIndex< Block > &  ancestor ) const

inline

Definition at line 336 of file block_index.hpp.

                                                        {
    return getAncestor(ancestor.getHeight()) == &ancestor;
  }

isDirty()

template<typename Block >

bool altintegration::BlockIndex< Block >::isDirty ( ) const

inline

Definition at line 231 of file block_index.hpp.

{ return this->dirty; }

isFailed()

template<typename Block >

bool altintegration::BlockIndex< Block >::isFailed ( ) const

inline

Definition at line 162 of file block_index.hpp.

{ return (status & BLOCK_FAILED_MASK) != 0u; }

isRoot()

template<typename Block >

bool altintegration::BlockIndex< Block >::isRoot ( ) const

inline

Definition at line 94 of file block_index.hpp.

{ return pprev == nullptr; };

isTip()

template<typename Block >

bool altintegration::BlockIndex< Block >::isTip ( ) const

inline

Definition at line 84 of file block_index.hpp.

{ return pnext.empty(); }

isValid()

template<typename Block >

bool altintegration::BlockIndex< Block >::isValid ( enum BlockStateStatus  upTo = BLOCK_VALID_TREE ) const

inline

Definition at line 164 of file block_index.hpp.

                                                                    {
    return !isFailed() && isValidUpTo(upTo);
  }

isValidTip()

template<typename Block >

bool altintegration::BlockIndex< Block >::isValidTip ( ) const

inline

Definition at line 275 of file block_index.hpp.

                          {
    return canBeATip() &&
           (isTip() ||
            std::none_of(pnext.begin(), pnext.end(), [](BlockIndex* index) {
              return index->canBeATip();
            }));
  }

isValidUpTo()

template<typename Block >

bool altintegration::BlockIndex< Block >::isValidUpTo ( enum BlockStateStatus  upTo ) const

inline

Definition at line 168 of file block_index.hpp.

                                                     {
    auto validityLevel = getValidityLevel();
    VBK_ASSERT_MSG(
        validityLevel != BLOCK_CAN_BE_APPLIED || !hasFlags(BLOCK_FAILED_POP),
        "block %s is both BLOCK_CAN_BE_APPLIED and BLOCK_FAILED_POP which are "
        "mutually exclusive",
        toPrettyString());
 
    return getValidityLevel() >= upTo;
  }

lowerValidity()

template<typename Block >

bool altintegration::BlockIndex< Block >::lowerValidity ( enum BlockStateStatus  upTo )

inline

Definition at line 214 of file block_index.hpp.

                                                 {
    // we can't lower the validity of a block that's known to be invalid due to
    // PoP, as that would incorrectly label another validity level as failed.
    // BLOCK_FAILED_POP has to be cleared first via revalidateSubtree it's ok to
    // lower the validity of a block invalidated by altchain
    if ((status & BLOCK_FAILED_POP) != 0u) {
      return false;
    }
    if ((status & BLOCK_VALID_MASK) > upTo) {
      status = (status & ~BLOCK_VALID_MASK) | upTo;
      return true;
    }
    return false;
  }

mergeFrom()

template<typename Block >

void altintegration::BlockIndex< Block >::mergeFrom ( const StoredBlockIndex< Block > &  other )

inline

Definition at line 123 of file block_index.hpp.

                                                       {
    setHeight(other.height);
    setHeader(other.header);
    setStatus(other.status);
 
    other.addon.toInmem(*this);
  }

nondeletedDescendantCount()

template<typename Block >

size_t altintegration::BlockIndex< Block >::nondeletedDescendantCount ( ) const

inline

Definition at line 296 of file block_index.hpp.

                                           {
    return std::count_if(
        pnext.begin(), pnext.end(), [](const BlockIndex* index) {
          return !index->isDeleted();
        });
  }

raiseValidity()

template<typename Block >

bool altintegration::BlockIndex< Block >::raiseValidity ( enum BlockStateStatus  upTo )

inline

Definition at line 195 of file block_index.hpp.

                                                 {
    // we can't raise the validity of a block that's known to be invalid due to
    // PoP it's ok to raise the validity of a block invalidated by altchain
    if ((status & BLOCK_FAILED_POP) != 0u) {
      return false;
    }
    if ((status & BLOCK_VALID_MASK) < upTo) {
      VBK_ASSERT_MSG(isRoot() || pprev->getValidityLevel() >= upTo,
                     "attempted to raise the validity level of block %s beyond "
                     "the validity level of its ancestor %s",
                     toPrettyString(),
                     pprev->toPrettyString());
 
      status = (status & ~BLOCK_VALID_MASK) | upTo;
      return true;
    }
    return false;
  }

restore()

template<typename Block >

void altintegration::BlockIndex< Block >::restore ( )

inline

Definition at line 96 of file block_index.hpp.

                 {
    VBK_ASSERT_MSG(isDeleted(),
                   "tried to restore block %s that is not deleted",
                   toPrettyString());
 
    // unsetFlag runs setDirty() for us
    unsetFlag(BLOCK_DELETED);
  }

setDirty()

template<typename Block >

void altintegration::BlockIndex< Block >::setDirty ( )

inline

Definition at line 229 of file block_index.hpp.

{ this->dirty = true; }

setFlag()

template<typename Block >

void altintegration::BlockIndex< Block >::setFlag ( enum BlockValidityStatus  s )

inline

Definition at line 233 of file block_index.hpp.

                                           {
    auto newStatus = this->status | s;
    if (newStatus == this->status) return;
    this->status = newStatus;
    setDirty();
  }

setHeader() [1/2]

template<typename Block >

void altintegration::BlockIndex< Block >::setHeader ( const block_t &  newHeader )

inline

Definition at line 259 of file block_index.hpp.

                                           {
    header = std::make_shared<block_t>(newHeader);
    setDirty();
  }

setHeader() [2/2]

template<typename Block >

void altintegration::BlockIndex< Block >::setHeader ( std::shared_ptr< block_t >  newHeader )

inline

Definition at line 263 of file block_index.hpp.

                                                   {
    header = std::move(newHeader);
    setDirty();
  }

setHeight()

template<typename Block >

void altintegration::BlockIndex< Block >::setHeight ( const height_t  newHeight )

inline

Definition at line 253 of file block_index.hpp.

                                           {
    height = newHeight;
    setDirty();
  }

setNull()

template<typename Block >

void altintegration::BlockIndex< Block >::setNull ( )

inline

Definition at line 179 of file block_index.hpp.

                 {
    addon_t::setNull();
    this->pprev = nullptr;
    this->pnext.clear();
    this->height = 0;
    this->status = BLOCK_VALID_UNKNOWN;
    // make it dirty by default
    setDirty();
  }

setNullInmemFields()

template<typename Block >

void altintegration::BlockIndex< Block >::setNullInmemFields ( )

inline

Definition at line 189 of file block_index.hpp.

                            {
    addon_t::setNullInmemFields();
    this->pprev = nullptr;
    this->pnext.clear();
  }

setStatus()

template<typename Block >

void altintegration::BlockIndex< Block >::setStatus ( uint32_t  _status )

inline

Definition at line 150 of file block_index.hpp.

                                   {
    if (_status == this->status) return;
    this->status = _status;
    setDirty();
  }

toPrettyString()

template<typename Block >

std::string altintegration::BlockIndex< Block >::toPrettyString ( size_t  level = 0 ) const

inline

Definition at line 371 of file block_index.hpp.

                                                   {
    return format(
        "{}{}BlockIndex(height={} hash={} prev={} next={} final={} status={} "
        "{})",
        std::string(level, ' '),
        Block::name(),
        height,
        HexStr(getHash()),
        (pprev == nullptr
             ? "nullptr"
             : format("{}:{}", pprev->getHeight(), HexStr(pprev->getHash()))),
        nondeletedDescendantCount(),
        finalized,
        status,
        addon_t::toPrettyString());
  }

toShortPrettyString()

template<typename Block >

std::string altintegration::BlockIndex< Block >::toShortPrettyString ( ) const

inline

Definition at line 388 of file block_index.hpp.

                                        {
    return format("{}:{}:{}", Block::name(), height, HexStr(getHash()));
  }

toStoredBlockIndex()

template<typename Block >

StoredBlockIndex< Block > altintegration::BlockIndex< Block >::toStoredBlockIndex ( ) const

inline

Definition at line 131 of file block_index.hpp.

                                                     {
    StoredBlockIndex<Block> ret;
    ret.height = height;
    ret.status = status;
    ret.header = header;
    ret.addon = *this;
    return ret;
  }

unsetDirty()

template<typename Block >

void altintegration::BlockIndex< Block >::unsetDirty ( )

inline

Definition at line 230 of file block_index.hpp.

{ this->dirty = false; }

unsetFlag()

template<typename Block >

void altintegration::BlockIndex< Block >::unsetFlag ( enum BlockValidityStatus  s )

inline

Definition at line 239 of file block_index.hpp.

                                             {
    auto newStatus = this->status & ~s;
    if (newStatus == this->status) return;
    this->status = newStatus;
    setDirty();
  }

Friends And Related Function Documentation

operator!=

template<typename Block >

bool operator!= ( const BlockIndex< Block > &  a, const BlockIndex< Block > &  b  )

friend

Definition at line 397 of file block_index.hpp.

                                                                   {
    return a.getStatus() != b.getStatus() && a.getHeight() != b.getHeight() &&
           a.getHeader() != b.getHeader();
  }

operator==

template<typename Block >

bool operator== ( const BlockIndex< Block > &  a, const BlockIndex< Block > &  b  )

friend

Definition at line 392 of file block_index.hpp.

                                                                   {
    return a.getStatus() == b.getStatus() && a.getHeight() == b.getHeight() &&
           a.getHeader() == b.getHeader();
  }

Member Data Documentation

dirty

template<typename Block >

bool altintegration::BlockIndex< Block >::dirty = false

protected

Definition at line 413 of file block_index.hpp.

finalized

template<typename Block >

bool altintegration::BlockIndex< Block >::finalized = false

Definition at line 45 of file block_index.hpp.

header

template<typename Block >

std::shared_ptr<block_t> altintegration::BlockIndex< Block >::header = std::make_shared<block_t>()

protected

Definition at line 407 of file block_index.hpp.

height

template<typename Block >

height_t altintegration::BlockIndex< Block >::height = 0

protected

Definition at line 404 of file block_index.hpp.

pnext

template<typename Block >

std::set<BlockIndex*> altintegration::BlockIndex< Block >::pnext {}

Definition at line 42 of file block_index.hpp.

pprev

template<typename Block >

BlockIndex* altintegration::BlockIndex< Block >::pprev = nullptr

Definition at line 39 of file block_index.hpp.

status

template<typename Block >

uint32_t altintegration::BlockIndex< Block >::status = BLOCK_VALID_UNKNOWN | BLOCK_DELETED

protected

Definition at line 410 of file block_index.hpp.

---

The documentation for this struct was generated from the following file:

• include/veriblock/pop/blockchain/block_index.hpp