altintegration Namespace Reference

Defines logging helpers. More...

Namespaces
namespace	json
	Package that contains adaptors to simplify serialization of entities to JSON.

Classes
class	Address
	Represents address on VBK chain. More...
class	AltBlock
	Represents a view on Altchain block - i.e. More...
struct	AltBlockTree
	Represents simplified view on Altchain's block tree, maintains VBK tree and BTC tree. More...
struct	AltChainParams
	Base class for all Altchain-related configs. More...
struct	AltChainParamsRegTest
struct	AltCommandGroupStore
	A wrapper for the payload store that constructs command objects. More...
class	ArithUint256
	256-bit unsigned big integer. More...
class	ATV
	Atlchain endorsement. More...
struct	AuthenticatedContextInfoContainer
	Contains ContextInfoContainer and merkle path which authenticates hash of ContextInfoContainer to a block header. More...
struct	BaseBlockTree
	Base block tree that stores all blocks, maintains tree tips, maintains active chain. More...
struct	Blob
	Contiguous byte array of fixed size. More...
struct	BlockBatch
	An interface which represents single write batch of a group of blocks. More...
struct	BlockIndex
	A node in a block tree. More...
struct	BlockIterator
	An abstraction over on-disk storage block iterator. More...
struct	BlockReader
	An abstraction over on-disk storage iterator. More...
struct	BlockTree
	BlockTree is a tree of blocks with single "bootstrap" block as root. More...
struct	BtcBlock
	Bitcoin block. More...
struct	BtcChainParams
	base class for BTC params More...
struct	BtcChainParamsMain
	mainnet network params in Bitcoin chain. More...
struct	BtcChainParamsRegTest
	regtest network params in Bitcoin chain. More...
struct	BtcChainParamsTest
	testnet3 network params in Bitcoin chain. More...
struct	BtcTx
	Bitcoin transaction representation. More...
struct	CacheEntry
struct	Chain
	Fully in-memory chain representation. More...
struct	ChainSlice
	Non-owning partial chain view similar to std::span. More...
struct	CheckPublicationData
	A command which performs stateful check of PublicationData stored in ATV. More...
struct	Coin
	represents VBK atomic units More...
struct	Config
	A container for Bitcoin and Veriblock configuration data. More...
struct	ContextInfoContainer
	Container of context info for endorsed block. More...
struct	DefaultPopRewardsCalculator
struct	Endorsement
struct	EthashCache
struct	EthashCacheI
struct	FinalizedPayloadsIndex
	Stores a mapping "payload id -> containing block" hash of payloads that are stored in finalized blocks. More...
struct	Finalizer
	Finalizer holds a function that is executed on Finalizer destruction. More...
struct	IsPopPayload
	type trait which returns true on types that are "POP Payloads" More...
struct	KeystoneContainer
	A container for two previous keystones of endorsed block. More...
struct	Logger
	An interface for logger. More...
struct	MemPool
	Data structure, that stores in memory all valid payloads (ATV, VTB, VbkBlock) submitted by other peers through p2p or by users through rpc. More...
struct	MempoolResult
	An entity which is returned from MemPool on call to submitAll. More...
struct	MerklePath
	Path in Merkle tree which proves that subject is inside this tree. More...
struct	NetworkBytePair
	Stores pair of TxType and VBK network byte. More...
struct	Output
	Single spending output. More...
struct	PayloadsIndex
	Payloads index that stores mapping "payload id -> set of containing blocks" from all NON-FINALIZED blocks. More...
struct	PayloadsStorage
	Accessor for ATV/VTB/VbkBlock bodies given hash. More...
struct	PopContext
	Main entrypoint into the veriblock-pop library. More...
struct	PopData
	Represents ALT block body of POP-related info. More...
struct	PopPayouts
	A container for Pop payouts information. More...
struct	PopPayoutsParams
	Defines config for POP payouts. More...
struct	PopRewardsCalculator
struct	PopRewardsCurveParams
	A container for curve params. More...
struct	PopRewardsParams
	A container for PoP rewards params. More...
struct	ProgpowHeaderCache
struct	ProgpowHeaderCacheI
struct	PublicationData
	Publication data about ALT block inside VBK blockchain. More...
struct	ReadStream
	Binary reading stream, that is useful during binary deserialization. More...
class	reverse_range
	translates a pair of forward iterators to a range whose regular iteration order is "backward" More...
struct	Slice
	Non-owning contiguous array. More...
struct	StateCorruptedException
	Is thrown only when this library detects POP-related state corruption, and can't recover. More...
struct	StorageIOException
	exception which is thrown on any IO errors. More...
struct	StoredBlockIndex
class	ValidationState
	Class that is used for storing validation state. More...
struct	VbkBlock
	Veriblock block. More...
class	VbkBlockTree
	Veriblock block tree. More...
struct	VbkChainParams
	VeriBlock chain parameters. More...
struct	VbkChainParamsMain
	MainNet VBK parameters. More...
struct	VbkChainParamsRegTest
	RegTest VBK config. More...
struct	VbkChainParamsTest
	TestNet VBK config. More...
struct	VbkCommandGroupStore
	A wrapper for the payload store that constructs command objects. More...
struct	VbkMerklePath
	Path in Merkle tree, which proves that subject exists in the tree. More...
struct	VbkNetworkType
	works as optional<uint8_t> More...
struct	VbkPopTx
	Veriblock POP transaction, which endorses VBK block in BTC blockchain. More...
struct	VbkTx
	Veriblock transaction, which endorses ALT block in VBK blockchain. More...
struct	vblake_ctx
	vBlake hash state context. More...
struct	VTB
	Veriblock to Bitcoin publication, committed to Veriblock blockchain in containingBlock. More...
class	WriteStream
	Binary writer that is useful for binary serialization. More...

Typedefs
using	BtcBlockTree = BlockTree< BtcBlock, BtcChainParams >
	Bitcoin tree. More...
using	uint128 = Blob< VBK_MERKLE_ROOT_HASH_SIZE >
	Fixed-size array. More...
using	uint256 = Blob< SHA256_HASH_SIZE >
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
using	uint72 = Blob< VBK_PREVIOUS_KEYSTONE_HASH_SIZE >
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
using	uint96 = Blob< VBK_PREVIOUS_BLOCK_HASH_SIZE >
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
using	uint192 = Blob< VBK_BLOCK_HASH_SIZE >
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

Enumerations
enum	BlockStateStatus : uint32_t {   BLOCK_VALID_TREE = 1 , BLOCK_CONNECTED = 2 , BLOCK_CAN_BE_APPLIED_MAYBE_WITH_OTHER_CHAIN = 3 , BLOCK_CAN_BE_APPLIED = 4 ,   BLOCK_VALID_MASK }
	Flags that describe block status. More...
enum	BlockValidityStatus : uint32_t {   BLOCK_VALID_UNKNOWN = 0 , BLOCK_BOOTSTRAP = 1 << 4 , BLOCK_FAILED_BLOCK = 1 << 5 , BLOCK_FAILED_POP = 1 << 6 ,   BLOCK_FAILED_CHILD = 1 << 7 , BLOCK_FAILED_MASK , BLOCK_HAS_PAYLOADS = 1 << 8 , BLOCK_ACTIVE = 1 << 9 ,   BLOCK_DELETED = 1 << 10 }
	Flags that describe block status. More...
enum class	PopFrOutcome {   UNKNOWN , CANDIDATE_IS_TIP , CANDIDATE_INVALID_CHAIN , CANDIDATE_INVALID_PAYLOADS ,   CANDIDATE_PART_OF_ACTIVE_CHAIN , CANDIDATE_IS_TIP_SUCCESSOR , TIP_IS_FINAL , BOTH_DONT_CROSS_KEYSTONE_BOUNDARY ,   CANDIDATE_INVALID_INDEPENDENTLY , HIGHER_POP_SCORE }
enum class	TxType { VBK_TX = 0x01 , VBK_POP_TX = 0x02 }
	Veriblock transaction type. More...
enum class	AddressType { STANDARD = 1 , MULTISIG = 3 }
	VBK Address type (modelled after transaction type). More...
enum class	LogLevel {   debug , info , warn , error ,   critical , off }
	Log level. More...

Functions
template<typename T , typename Container >
const T	min_or_default (Container &c, const T default_)
	returns min value in a container (vector, array...), or "default" value if container is empty More...
template<typename BlockTreeT >
std::vector< typename BlockTreeT::block_t >	getContext (const BlockTreeT &tree, typename BlockTreeT::hash_t tip, size_t size=std::numeric_limits< size_t >::max())
	Build a context (blocks necessary to connect) in a tree from tip backwards size elements. More...
template<typename BlockTree >
std::vector< std::vector< uint8_t > >	getLastKnownBlocks (const BlockTree &tree, size_t size)
	helper to get last N known block hashes More...
template<typename Block , typename ChainParams >
bool	addBlocks (BlockTree< Block, ChainParams > &tree, const std::vector< std::vector< uint8_t > > &blocks, ValidationState &state)
	helper to accept multiple blocks More...
bool	GeneratePublicationData (const std::vector< uint8_t > &endorsedBlockHeader, const std::vector< uint8_t > &txMerkleRoot, const PopData &popData, const std::vector< uint8_t > &payoutInfo, const AltBlockTree &tree, PublicationData &out)
	Creates a PublicationData - an entity, which stores information about Altchain block endorsement. More...
PublicationData	GeneratePublicationData (const std::vector< uint8_t > &endorsedBlockHeader, const BlockIndex< AltBlock > &endorsedBlock, const std::vector< uint8_t > &txMerkleRoot, const PopData &popData, const std::vector< uint8_t > &payoutInfo, const AltChainParams &params)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PublicationData	GeneratePublicationData (const std::vector< uint8_t > &endorsedBlockHeader, const BlockIndex< AltBlock > &endorsedBlock, const std::vector< uint8_t > &txMerkleRoot, uint32_t version, const std::vector< ATV::id_t > &atv_ids, const std::vector< VTB::id_t > &vtb_ids, const std::vector< VbkBlock::id_t > &vbk_ids, const std::vector< uint8_t > &payoutInfo, const AltChainParams &params)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
uint256	CalculateTopLevelMerkleRoot (const std::vector< uint8_t > &txMerkleRoot, const uint256 &popDataMerkleRoot, const ContextInfoContainer &ctx)
	calculates top level merkle root that cryptographically authenticates block content (transactions, PopData, context info) to a block
uint256	CalculateTopLevelMerkleRoot (const AuthenticatedContextInfoContainer &ctx)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
uint256	CalculateTopLevelMerkleRoot (const std::vector< uint8_t > &txMerkleRoot, const PopData &popData, const BlockIndex< AltBlock > *prevBlock, const AltChainParams &params)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
int	getMaxAtvsInVbkBlock (uint64_t altchainId)
	The second to the last byte is used to determine the max number of occurrences The first 7 bits determine the base (1 is added to the first 7 bits interpreted as a number), and the last bit determines the exponent (0 = exponent of 1, 1 = exponent of 2) For example: 00000000 has a base of 1 (0+1) and an exponent of 1 for a maximum of 1 publication 00000110 has a base of 4 (3+1) and an exponent of 1 for a maximum of 4 publications 00000101 has a base of 3 (2+1) and an exponent of 2 for a maximum of 9 publications.
void	PrintTo (const ArithUint256 &uint, ::std::ostream *os)
	custom gtest printer, which prints Blob of any size as hexstring @ private More...
std::string	EncodeBase58 (const unsigned char *pbegin, const unsigned char *pend)
	Encodes input bytes to Base58.
template<typename T , typename = typename std::enable_if<sizeof(typename T::value_type) == 1>::type>
std::string	EncodeBase58 (const T &container)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DecodeBase58 (const std::string &str, std::vector< unsigned char > &out, ValidationState &state)
	Decodes base58 into bytes.
std::string	EncodeBase59 (const unsigned char *pbegin, const unsigned char *pend)
	Encode input bytes to base59.
std::string	EncodeBase59 (const uint8_t *buf, size_t size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T , typename = typename std::enable_if<sizeof(typename T::value_type) == 1>::type>
std::string	EncodeBase59 (const T &container)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DecodeBase59 (const std::string &input, std::vector< uint8_t > &out, ValidationState &state)
	Decode base59 string into bytes.
template<typename Value , size_t N>
Value	ToJSON (const Blob< N > &blob)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromVbkEncoding (ReadStream &stream, AltBlockAddon &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename JsonValue >
JsonValue	ToJSON (const PopPayoutsParams &p)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
template<typename JsonValue >
JsonValue	ToJSON (const AltChainParams &p, bool reverseAltHashes=true)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
template<typename Block >
const BlockIndex< Block > *	getForkBlock (const BlockIndex< Block > &a, const BlockIndex< Block > &b)
	getForkBlock assumes that: the block tree is not malformed the fork block(worst case: genesis/bootstrap block) is in memory the complexity is O(n) More...
template<typename Block >
bool	isBlockOutdated (const BlockIndex< Block > &finalBlock, const BlockIndex< Block > &candidate)
	a candidate is considered outdated if it is behind finalBlock, or on same height and not equal to finalBlock, or its fork block is outdated More...
constexpr bool	isValidInvalidationReason (const BlockValidityStatus &reason)
	Check if the reason value can be used as the reason for invalidateSubtree and revalidateSubtree. More...
bool	DeserializeFromVbkEncoding (ReadStream &stream, BtcBlockAddon &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename C >
C::index_t *	findFork (const C &chain, const typename C::index_t *pindex)
	Find fork between chain and pindex. More...
std::string	popFrOutcomeToString (PopFrOutcome value, const ValidationState &state)
template<typename T >
bool	DeserializeFromVbkEncoding (ReadStream &stream, PopState< T > &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
template<typename JsonValue >
JsonValue	ToJSON (const BlockIndex< VbkBlock > &i)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
template<typename JsonValue >
JsonValue	ToJSON (const BlockIndex< BtcBlock > &i)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
template<typename Block >
void	forEachNodePostorder (BlockIndex< Block > &index, const std::function< void(BlockIndex< Block > &)> &visit, const std::function< bool(BlockIndex< Block > &)> &shouldVisit)
	Postorder tree traversal algorithm. More...
template<typename Block >
void	forEachNodePreorder (BlockIndex< Block > &index, const std::function< bool(BlockIndex< Block > &)> &visit)
	iterate across all subtrees starting (and including) given 'index' More...
template<typename Block >
void	forEachNextNodePreorder (BlockIndex< Block > &index, const std::function< bool(BlockIndex< Block > &)> &shouldContinue)
	iterate across all subtrees starting (and excluding) given 'index' More...
template<typename Block >
std::vector< BlockIndex< Block > * >	findValidTips (BlockIndex< Block > &index)
	Find all tips after given block, including given block. More...
template<typename Block >
std::vector< BlockIndex< Block > * >	findValidTips (const std::unordered_set< BlockIndex< Block > * > &tips, BlockIndex< Block > &index)
	Find all tips after given block, including given block. More...
bool	DeserializeFromVbkEncoding (ReadStream &stream, VbkBlockAddon &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VbkBlock	GetRegTestVbkBlock ()
	Getter for regtest_progpow VBK network genesis block.
BtcBlock	GetRegTestBtcBlock ()
	Getter for regtest BTC network genesis block.
void	setEthashCache (std::unique_ptr< EthashCacheI > cache)
void	setProgpowHeaderCache (std::unique_ptr< ProgpowHeaderCacheI > cache)
uint192	progPowHash (Slice< const uint8_t > header)
	Calculate vPROGPOW hash of given VbkBlock header (65 bytes) More...
uint192	progPowHash (Slice< const uint8_t > header, progpow::ethash_cache *light)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	DeserializeFromVbkEncoding (ReadStream &stream, CacheEntry &out, ValidationState &state)
uint32_t	kiss99 (kiss99_t &st)
	Calculate KISS99. More...
void	vblake_init (vblake_ctx *ctx)
	Initialize the hashing context. More...
int	vblake_update (vblake_ctx *ctx, const void *in, size_t inlen)
	Add "inlen" bytes from "in" into the hash. More...
void	vblake_final (vblake_ctx *ctx, void *out)
	Generate the message digest. More...
int	vblake (void *out, const void *in, size_t inlen)
	Convenience function for all-in-one computation. More...
template<typename Value >
Value	ToJSON (const Address &addr)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromVbkEncoding (ReadStream &stream, Address &out, ValidationState &state)
	Read data from the stream and convert it to VBK address. More...
template<typename JsonValue >
JsonValue	ToJSON (const AltBlock &alt, bool reverseHashes=true)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromRaw (ReadStream &stream, AltBlock &out, ValidationState &state, const AltBlock::hash_t &=AltBlock::hash_t{})
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	DeserializeFromVbkEncoding (ReadStream &stream, AltBlock &out, ValidationState &state, const AltBlock::hash_t &=AltBlock::hash_t{})
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename JsonValue >
JsonValue	ToJSON (const ATV &atv)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromVbkEncoding (ReadStream &stream, ATV &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename JsonValue >
JsonValue	ToJSON (const BtcBlock &b)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromRaw (ReadStream &stream, BtcBlock &out, ValidationState &state, const BtcBlock::hash_t &precalculatedHash=BtcBlock::hash_t{})
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	DeserializeFromVbkEncoding (ReadStream &stream, BtcBlock &out, ValidationState &state, const BtcBlock::hash_t &precalculatedHash=BtcBlock::hash_t{})
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	DeserializeFromVbkEncoding (ReadStream &stream, BtcTx &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	DeserializeFromVbkEncoding (ReadStream &stream, Coin &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	DeserializeFromVbkEncoding (ReadStream &stream, ContextInfoContainer &ctx, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	DeserializeFromVbkEncoding (ReadStream &stream, AuthenticatedContextInfoContainer &ctx, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename JsonValue >
JsonValue	ToJSON (const ContextInfoContainer &a)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
template<typename JsonValue >
JsonValue	ToJSON (const AuthenticatedContextInfoContainer &a)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
template<typename Value , class A , class B , class C >
Value	ToJSON (const Endorsement< A, B, C > &e)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromVbkEncoding (ReadStream &stream, KeystoneContainer &container, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename JsonValue >
JsonValue	ToJSON (const KeystoneContainer &c)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
template<typename JsonValue >
JsonValue	ToJSON (const MerklePath &m)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromRaw (ReadStream &stream, const uint256 &subject, MerklePath &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	DeserializeFromVbkEncoding (ReadStream &stream, const uint256 &subject, MerklePath &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
uint32_t	estimateNumberOfPopTxs (const std::vector< VbkMerklePath > &paths)
bool	isPopSubTreeFull (const std::vector< VbkMerklePath > &paths)
template<typename JsonValue >
JsonValue	ToJSON (const Output &o)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromVbkEncoding (ReadStream &stream, Output &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename JsonValue >
JsonValue	ToJSON (const PopData &p, bool verbose=false)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromVbkEncoding (ReadStream &stream, PopData &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename JsonValue >
JsonValue	ToJSON (const PublicationData &p)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromVbkEncoding (ReadStream &stream, PublicationData &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename JsonValue >
JsonValue	ToJSON (const VbkMerklePath &mp)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromVbkEncoding (ReadStream &stream, VbkMerklePath &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename JsonValue >
JsonValue	ToJSON (const VbkBlock &b)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromRaw (ReadStream &stream, VbkBlock &out, ValidationState &state, const VbkBlock::hash_t &hash=VbkBlock::hash_t{})
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	DeserializeFromVbkEncoding (ReadStream &stream, VbkBlock &out, ValidationState &state, const VbkBlock::hash_t &hash=VbkBlock::hash_t{})
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename JsonValue >
JsonValue	ToJSON (const VbkPopTx &tx)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromRaw (ReadStream &stream, Slice< const uint8_t > signature, Slice< const uint8_t > publicKey, VbkPopTx &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	DeserializeFromVbkEncoding (ReadStream &stream, VbkPopTx &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename JsonValue >
JsonValue	ToJSON (const VbkTx &tx)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromRaw (ReadStream &stream, Slice< const uint8_t > signature, Slice< const uint8_t > publicKey, VbkTx &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	DeserializeFromVbkEncoding (ReadStream &stream, VbkTx &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename JsonValue >
JsonValue	ToJSON (const VTB &v)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	DeserializeFromVbkEncoding (ReadStream &stream, VTB &out, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
uint256	sha256 (Slice< const uint8_t > data)
	Calculates SHA256 of the input data. More...
uint256	sha256 (Slice< const uint8_t > a, Slice< const uint8_t > b)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
uint256	sha256twice (Slice< const uint8_t > data)
	Calculates SHA256 of the input data twice. More...
uint256	sha256twice (Slice< const uint8_t > a, Slice< const uint8_t > b)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
uint192	vblake (Slice< const uint8_t > data)
	Calculates VBlake of the input data. More...
template<typename Value , typename T >
Value	ToJSON (const T &)
	Encode given entity into JSON. More...
bool	isKeystone (int32_t blockNumber, uint32_t keystoneInterval)
	Calculates if block with height = blockNumber is keystone. More...
Logger &	GetLogger ()
	getter for global logger instance More...
void	SetLogger (std::unique_ptr< Logger > lgr, LogLevel log_lvl=LogLevel::info)
	setter for global logger instance
template<typename L >
void	SetLogger (LogLevel log_lvl=LogLevel::info)
	setter for global logger instance More...
std::string	LevelToString (LogLevel l)
	convert loglevel to string
LogLevel	StringToLevel (const std::string &)
	convert string to loglevel More...
template<typename S , typename... Args>
std::string	format (const S &format_str, Args &&... args)
template<typename JsonValue >
JsonValue	ToJSON (const MempoolResult &r)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
template<typename T >
reverse_range< T >	reverse_iterate (T &x)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
bool	checkRange (uint64_t num, uint64_t min, uint64_t max, ValidationState &state)
	Checks if expression 'min' <= 'num' <= 'max' is true. More...
std::vector< uint8_t >	trimmedArray (int64_t input)
	Converts the input to the byte array and trims it's size to the lowest possible value. More...
template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>
std::vector< uint8_t >	fixedArray (T input)
	Converts the input to the byte array. More...
bool	readVarLenValue (ReadStream &stream, Slice< const uint8_t > &out, ValidationState &state, uint64_t minLen, uint64_t maxLen)
	Read variable length value, which consists of [N=(4 bytes = size of slice) | N bytes slice] Size of slice should be within range [minLen; maxLen]. More...
bool	readSingleByteLenValue (ReadStream &stream, Slice< const uint8_t > &out, ValidationState &state, uint64_t minLen, uint64_t maxLen)
	Read variable length value, which consists of [N=(1 byte = size of slice) | N bytes slice] Size of slice should be within range [minLen; maxLen]. More...
template<typename Container , typename = typename std::enable_if< sizeof(typename Container::value_type) == 1>::type>
bool	readSingleByteLenValue (ReadStream &stream, Container &out, ValidationState &state, uint64_t minLen, uint64_t maxLen)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>
bool	readSingleBEValue (ReadStream &stream, T &out, ValidationState &state)
	Read single Big-Endian value from a stream. More...
void	writeSingleByteLenValue (WriteStream &stream, Slice< const uint8_t > value)
	Write single byte length value, which consists of N bytes vector Appends 1 byte data length to the stream. More...
void	writeSingleBEValue (WriteStream &stream, int64_t value)
	Write single Big-Endian value to the stream. More...
template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>
void	writeSingleFixedBEValue (WriteStream &stream, T value)
	Write single Big-Endian value to the stream. More...
void	writeVarLenValue (WriteStream &stream, Slice< const uint8_t > value)
	Write variable length value, which consists of N bytes vector Appends up to 8 bytes data length to the stream and 1 byte data length size. More...
NetworkBytePair	readNetworkByte (ReadStream &stream, TxType type)
	Read optional network byte from the stream. More...
bool	readNetworkByte (ReadStream &stream, TxType type, NetworkBytePair &out, ValidationState &state)
	Read optional network byte from the stream. More...
void	writeNetworkByte (WriteStream &stream, NetworkBytePair networkOrType)
	Write optional network byte to the stream. More...
template<typename Container >
bool	readSetOf (ReadStream &stream, Container &out, ValidationState &state, size_t min, size_t max, std::function< bool(ReadStream &, typename Container::value_type &, ValidationState &)> readFunc)
	Reads set of entities of. More...
template<typename Container >
bool	readSetOf (ReadStream &stream, Container &out, ValidationState &state, std::function< bool(Container &, ReadStream &, typename Container::value_type &, ValidationState &)> readFunc)
	Reads container of entities. More...
template<typename T >
bool	readArrayOf (ReadStream &stream, std::vector< T > &out, ValidationState &state, size_t min, size_t max, std::function< bool(ReadStream &, T &, ValidationState &)> readFunc)
	Reads array of entities of type T. More...
template<typename T >
bool	readArrayOf (ReadStream &stream, std::vector< T > &out, ValidationState &state, std::function< bool(ReadStream &, T &, ValidationState &)> readFunc)
	Reads array of entities of type T. More...
template<typename T >
size_t	estimateArraySizeOf (const std::vector< T > &t, std::function< size_t(const T &t)> f)
	Estimate size of array in bytes. More...
template<typename T >
bool	DeserializeFromVbkEncoding (Slice< const uint8_t > data, T &out, ValidationState &state)
	Deserialize from VBK encoding. More...
template<typename T >
bool	DeserializeFromRaw (Slice< const uint8_t > data, T &out, ValidationState &state)
	Deserialize from RAW encoding. More...
template<typename T >
bool	DeserializeFromHex (const std::string &hex, T &out, ValidationState &state)
	Deserialize from HEX VBK encoding. More...
template<typename T >
bool	DeserializeFromRawHex (const std::string &hex, T &out, ValidationState &state)
	Deserialize from HEX RAW encoding. More...
template<typename T >
std::vector< uint8_t >	SerializeToVbkEncoding (const T &obj)
	Serialize to VBK encoding. More...
template<typename T >
std::vector< uint8_t >	SerializeToRaw (const T &obj)
	Serialize to RAW encoding. More...
template<typename T >
std::string	SerializeToHex (const T &obj)
	Serialize to HEX VBK encoding. More...
template<typename T >
std::string	SerializeToRawHex (const T &obj)
	Serialize to HEX RAW encoding. More...
template<typename T >
T	AssertDeserializeFromRaw (std::vector< uint8_t > raw)
	Deserialize from RAW encoding. More...
template<typename T >
T	AssertDeserializeFromVbkEncoding (Slice< const uint8_t > raw)
	Deserialize from VBK encoding. More...
template<typename T >
T	AssertDeserializeFromHex (std::string hex)
	Deserialize from HEX VBK encoding. More...
template<typename T >
T	AssertDeserializeFromRawHex (std::string hex)
	Deserialize from HEX RAW encoding. More...
template<typename MerklePathType , typename HashType1 , typename HashType2 >
bool	checkMerklePath (const MerklePathType &merklePath, const HashType1 &transactionHash, const HashType2 &merkleRoot, ValidationState &state)
	Verify merkle path. More...
bool	checkSignature (const VbkTx &tx, ValidationState &state)
	Verify signature of a transaction.
bool	checkSignature (const VbkPopTx &tx, ValidationState &state)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	checkBtcBlocks (const std::vector< BtcBlock > &btcBlocks, ValidationState &state, const BtcChainParams &param)
	Stateless validation for a chain of Blocks.
bool	checkVbkBlocks (const std::vector< VbkBlock > &vbkBlocks, ValidationState &state, const VbkChainParams &param)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	checkBitcoinTransactionForPoPData (const VbkPopTx &tx, ValidationState &state)
	Search BtcTx for POP data.
bool	checkProofOfWork (const BtcBlock &block, const BtcChainParams &param)
	Stateless validation for a Block.
bool	checkProofOfWork (const VbkBlock &block, const VbkChainParams &param)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	checkVbkPopTx (const VbkPopTx &tx, ValidationState &state, const BtcChainParams &param, const VbkChainParams &vbk)
	Stateless validation for VbkPopTx.
bool	checkVbkTx (const VbkTx &tx, const AltChainParams &params, const VbkChainParams &vbkparams, ValidationState &state)
	Stateless validation for VbkTx.
bool	checkPublicationData (const PublicationData &pub, const AltChainParams &params, ValidationState &state)
	Stateless validation for PublicationData.
bool	checkBlock (const BtcBlock &block, ValidationState &state, const BtcChainParams &params)
	Stateless validation for a single block.
bool	checkVbkBlockPlausibility (const VbkBlock &block, ValidationState &state, const VbkChainParams &params)
	Optimization: VBK block is not plausible if its combination of height+time do not correspond to potential VBK network.
bool	checkBlock (const VbkBlock &block, ValidationState &state, const VbkChainParams &params)
	Stateless validation for VbkBlock.
bool	checkATV (const ATV &atv, ValidationState &state, const AltChainParams &alt, const VbkChainParams &vbkp)
	Stateless validation for ATV.
bool	checkVTB (const VTB &vtb, ValidationState &state, const BtcChainParams &btc, const VbkChainParams &vbk)
	Stateless validation for VTB.
bool	checkPopData (PopValidator &validator, const PopData &popData, ValidationState &state)
	Stateless validation for PopData and all internal PoP payloads.
bool	DeserializeFromVbkEncoding (ReadStream &stream, StoredAltBlockAddon &out, ValidationState &state)
template<typename Block >
bool	DeserializeFromVbkEncoding (ReadStream &stream, StoredBlockIndex< Block > &out, ValidationState &state, typename Block::hash_t precalculatedHash=typename Block::hash_t())
bool	DeserializeFromVbkEncoding (ReadStream &stream, StoredBtcBlockAddon &out, ValidationState &state)
bool	DeserializeFromVbkEncoding (ReadStream &stream, StoredVbkBlockAddon &out, ValidationState &state)
template<typename BlockTreeT >
bool	loadTree (BlockTreeT &tree, const typename BlockTreeT::hash_t &tiphash, std::vector< typename BlockTreeT::stored_index_t > &blocks, bool fast_load, ValidationState &state)
	efficiently loads blocks into tree (they must be sorted by height) and does validation of these blocks. More...
void	saveTrees (const AltBlockTree &tree, BlockBatch &batch)
	Save all (BTC/VBK/ALT) trees on disk in a single Batch.
bool	loadTrees (AltBlockTree &tree, bool fast_load, ValidationState &state)
	Load all (ALT/VBK/BTC) trees from disk into memory.
std::vector< uint8_t >	ParseHex (const char *psz)
	Parse bytes from hex.
std::vector< uint8_t >	ParseHex (const std::string &hex)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
constexpr bool	IsSpace (char c) noexcept
	Tests if the given character is a whitespace character. More...
template<typename T >
std::string	HexStr (const T itbegin, const T itend)
	Convert bytes to hex. More...
template<typename T >
std::string	HexStr (const T &vch, bool reverseHex=false)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void	setMockTime (uint32_t mocktime)
	Set mock time for usage in unit tests. More...
uint32_t	getMockTime ()
	Get current mock time.
uint32_t	currentTimestamp4 ()
	Get current time as 4 bytes. If mock time is set, returns mock time.
template<typename JsonValue >
JsonValue	ToJSON (const ValidationState &s, bool *acceptedToMempool=nullptr)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

Variables
constexpr const auto	ADDRESS_POP_DATA_SIZE_PROGPOW = 15
	VTB contains BtcTx, which contains POP-miner's address and endorsed VBK header. More...
constexpr const auto	SHA256_HASH_SIZE = 32
	sha256 hash size More...
constexpr const auto	BTC_TX_MAX_RAW_SIZE = 4 * 1000 * 1000
	maximum possible BTC TX serialized size. More...
constexpr const uint32_t	BTC_HEADER_SIZE = 80
	Bitcoin header size. More...
constexpr const auto	MAX_BTC_BLOCKS_IN_VBKPOPTX = 65535
	maximum total BTC blocks in VTB blockOfProofContext More...
constexpr const auto	BTC_BLOCK_HASH_SIZE = 32
	size of BTC block hash More...
constexpr const auto	VBK_BLOCK_HASH_SIZE = 24
	size of VBK block hash More...
constexpr const auto	VBK_MERKLE_ROOT_HASH_SIZE = 16
	size of VBK merkle root More...
constexpr const auto	VBK_PREVIOUS_BLOCK_HASH_SIZE = 12
	size of VBK previous block hash size More...
constexpr const auto	VBK_PREVIOUS_KEYSTONE_HASH_SIZE = 9
	size of VBK previous keystone hash size More...
constexpr const auto	MAX_PAYOUT_INFO_SIZE = 10000
	max payout info size. More...
constexpr const auto	MAX_HEADER_SIZE_PUBLICATION_DATA = 1024
	maximum header size in PublicationData More...
constexpr const auto	MAX_CONTEXT_SIZE_PUBLICATION_DATA = 10000
	maximum context size in PublicationData More...
constexpr const auto	MAX_PUBLICATIONDATA_SIZE
	absolute maximum size for PublicationData More...
constexpr const auto	MAX_POPDATA_SIZE = 5500000
	maximum size of single PopData in a single ALT block, in bytes. More...
constexpr const auto	MAX_POPDATA_VBK = 50000
	absolute maximum number of VBK blocks per ALT block More...
constexpr const auto	MAX_POPDATA_VTB = 50000
	absolute maximum number of VTB blocks per ALT block More...
constexpr const auto	MAX_POPDATA_ATV = 50000
	absolute maximum number of ATV blocks per ALT block More...
constexpr const auto	MAX_PAYOUT = 50000
	absolute maximum number of pauouts per ALT block More...
constexpr const auto	MIN_ALT_HASH_SIZE = 0
	minimum allowed size of altchain hash More...
constexpr const auto	MAX_ALT_HASH_SIZE = 1024
	absolute maximum allowed size for altchain hash More...
constexpr const auto	MAX_BTCADDON_REFS = 65536
	absolute maximum of 'refs' for BTC addon More...
constexpr const auto	MAX_VBKPOPTX_PER_VBK_BLOCK = 1024
	absolute maximum number of PopTxes (VTBs) per VBK block More...
constexpr const auto	VTB_ID_SIZE = 32
	size of VTB id More...
constexpr const auto	ATV_ID_SIZE = 32
	size of ATV id More...
constexpr const auto	VBK_ID_SIZE = 12
	size of VbkBlock id More...
constexpr const auto	VBK_PUBLICATIONDATA_SIZE = 80
	65 VBK header + 15 POP bytes of Address More...
constexpr const uint32_t	VBK_HEADER_SIZE_VBLAKE = 64
	pre-progpow VBK header size More...
constexpr const uint32_t	VBK_HEADER_SIZE_PROGPOW = 65
	post-progpow VBK header size More...
constexpr const auto	MAX_LAYER_COUNT_MERKLE = 40
	max total layers in merkle paths More...
constexpr const auto	MAX_OUTPUTS_COUNT = 255
	NodeCore is using byte value when serializing outputs so we limit to 255. More...
constexpr const auto	MAX_SIGNATURE_SIZE = 72
	ASN.1/DER ECDSA encoding max value. More...
constexpr const auto	MAX_PUBLIC_KEY_SIZE = 88
	X509 encoding. Max value is based on experimental data. More...
constexpr const auto	VBK_ADDRESS_SIZE = 30
	VBK address size in bytes. More...
constexpr const auto	VBK_MAX_CALCULATED_EPOCHS_SIZE = 4096U
	maximum number of Ethash cache sizes stored in this library. More...
constexpr const auto	VBK_ETHASH_EPOCH_LENGTH = 8000U
	size of 1 ethash epoch in progpow More...
constexpr const auto	VBK_ETHASH_EPOCH_OFFSET = 323U
	we start at this epoch More...
static const int32_t	ALT_MAX_REORG_BLOCKS_MIN_VALUE = 10000
	minimum number of blocks in ALT tree More...
static const int32_t	VBK_MAX_REORG_BLOCKS_MIN_VALUE = 20000
	minimum number of blocks in VBK tree More...
static const int32_t	BTC_MAX_REORG_BLOCKS_MIN_VALUE = 10000
	minimum number of blocks in BTC tree More...
template<>
	__pad0__
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
template<>
	__pad1__
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
template<>
	__pad2__
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

Detailed Description

a facade for Signals

Contains veriblock-specific serialization and deserialziation primitives.

By default, logger is disabled (no-op logger is used). Users can derive from Logger class, and specify their logger instance.

Used log levels:

• DEBUG - most noisy and verbose, debug level
• INFO - default recommended level for logs
• WARN - warning level
• ERROR - validation error happened
• CRITICAL - assert messages are logged here
• OFF - disable logs

---

Class Documentation

altintegration::MempoolResult

struct altintegration::MempoolResult

Definition at line 19 of file mempool_result.hpp.

Collaboration diagram for altintegration::MempoolResult:

Class Members
vector< pair< id_t, ValidationState > >	atvs
vector< pair< id_t, ValidationState > >	context
vector< pair< id_t, ValidationState > >	vtbs

altintegration::NetworkBytePair

struct altintegration::NetworkBytePair

Definition at line 53 of file network_byte_pair.hpp.

Collaboration diagram for altintegration::NetworkBytePair:

Class Members
VbkNetworkType	networkType	< works as std::optional. if hasNetworkByte is true, networkByte is set
uint8_t	typeId

altintegration::vblake_ctx

struct altintegration::vblake_ctx

Definition at line 18 of file vblake.hpp.

Collaboration diagram for altintegration::vblake_ctx:

Class Members
uint8_t	b[64]	input buffer
uint64_t	h[8]	chained state

Typedef Documentation

BtcBlockTree

using altintegration::BtcBlockTree = typedef BlockTree<BtcBlock, BtcChainParams>

Definition at line 39 of file vbk_block_tree.hpp.

uint128

using altintegration::uint128 = typedef Blob<VBK_MERKLE_ROOT_HASH_SIZE>

Definition at line 22 of file uint.hpp.

uint192

using altintegration::uint192 = typedef Blob<VBK_BLOCK_HASH_SIZE>

Definition at line 30 of file uint.hpp.

uint256

using altintegration::uint256 = typedef Blob<SHA256_HASH_SIZE>

Definition at line 24 of file uint.hpp.

uint72

using altintegration::uint72 = typedef Blob<VBK_PREVIOUS_KEYSTONE_HASH_SIZE>

Definition at line 26 of file uint.hpp.

uint96

using altintegration::uint96 = typedef Blob<VBK_PREVIOUS_BLOCK_HASH_SIZE>

Definition at line 28 of file uint.hpp.

Enumeration Type Documentation

AddressType

enum class altintegration::AddressType

strong

Definition at line 18 of file address.hpp.

                       {
  STANDARD = 1,
  MULTISIG = 3,
};

BlockStateStatus

enum altintegration::BlockStateStatus : uint32_t

Enumerator
BLOCK_VALID_TREE	acceptBlockHeader succeded. All ancestors are at least at this state and statelessly valid.
BLOCK_CONNECTED	the block is connected via connectBlock, which means that this block and all its ancestors are at least BLOCK_CONNECTED and have BLOCK_HAS_PAYLOADS set.
BLOCK_CAN_BE_APPLIED_MAYBE_WITH_OTHER_CHAIN	the block has been successfully applied, but may not be fully valid, because it may connect to the "other" chain when two chains are applied together during POP FR. All the ancestors are at least BLOCK_CAN_BE_APPLIED_MAYBE_WITH_OTHER_CHAIN.
BLOCK_CAN_BE_APPLIED	the chain with the block at its tip is fully valid, so if we do SetState on this block, it is guaranteed to succeed. All the ancestors are at least BLOCK_CAN_BE_APPLIED.
BLOCK_VALID_MASK	all stateful validity levels

Definition at line 14 of file block_status.hpp.

                      : uint32_t {
  BLOCK_VALID_TREE = 1,
  BLOCK_CONNECTED = 2,
  BLOCK_CAN_BE_APPLIED_MAYBE_WITH_OTHER_CHAIN = 3,
  BLOCK_CAN_BE_APPLIED = 4,
 
  BLOCK_VALID_MASK = BLOCK_VALID_TREE | BLOCK_CONNECTED |
                     BLOCK_CAN_BE_APPLIED_MAYBE_WITH_OTHER_CHAIN |
                     BLOCK_CAN_BE_APPLIED,
 
};

BlockValidityStatus

enum altintegration::BlockValidityStatus : uint32_t

Enumerator
BLOCK_VALID_UNKNOWN	default state for validity - validity state is unknown
BLOCK_BOOTSTRAP	this is a bootstrap block
BLOCK_FAILED_BLOCK	block is statelessly valid, but the altchain marked it as failed
BLOCK_FAILED_POP	block failed state{less,ful} validation due to its payloads
BLOCK_FAILED_CHILD	block is state{lessly,fully} valid and the altchain did not report it as invalid, but some of the ancestor blocks are invalid
BLOCK_FAILED_MASK	all invalidity flags
BLOCK_HAS_PAYLOADS	acceptBlockHeader has been executed on this block;
BLOCK_ACTIVE	the block is currently applied via SetState.
BLOCK_DELETED	the block is temporarily deleted

Definition at line 40 of file block_status.hpp.

                         : uint32_t {
  BLOCK_VALID_UNKNOWN = 0,
 
  // all values from (0, 15] are reserved for BlockStateStatus
 
  BLOCK_BOOTSTRAP = 1 << 4,
  BLOCK_FAILED_BLOCK = 1 << 5,
  BLOCK_FAILED_POP = 1 << 6,
  BLOCK_FAILED_CHILD = 1 << 7,
  BLOCK_FAILED_MASK =
      BLOCK_FAILED_CHILD | BLOCK_FAILED_POP | BLOCK_FAILED_BLOCK,
  BLOCK_HAS_PAYLOADS = 1 << 8,
  BLOCK_ACTIVE = 1 << 9,
  BLOCK_DELETED = 1 << 10
 
};

LogLevel

enum class altintegration::LogLevel

strong

Definition at line 31 of file logger.hpp.

{ debug, info, warn, error, critical, off };

PopFrOutcome

enum class altintegration::PopFrOutcome

strong

Definition at line 457 of file fork_resolution.hpp.

                        {
  UNKNOWN,
  CANDIDATE_IS_TIP,
  CANDIDATE_INVALID_CHAIN,
  CANDIDATE_INVALID_PAYLOADS,
  CANDIDATE_PART_OF_ACTIVE_CHAIN,
  CANDIDATE_IS_TIP_SUCCESSOR,
  TIP_IS_FINAL,
  BOTH_DONT_CROSS_KEYSTONE_BOUNDARY,
  CANDIDATE_INVALID_INDEPENDENTLY,
  HIGHER_POP_SCORE,
};

TxType

enum class altintegration::TxType

strong

Enumerator
VBK_TX	regular transaction
VBK_POP_TX	pop transaction

Definition at line 26 of file consts.hpp.

                  {
  VBK_TX = 0x01,
  VBK_POP_TX = 0x02,
};

Function Documentation

addBlocks()

template<typename Block , typename ChainParams >

bool altintegration::addBlocks	(	BlockTree< Block, ChainParams > &	tree,
		const std::vector< std::vector< uint8_t > > &	blocks,
		ValidationState &	state
	)

Definition at line 77 of file alt-util.hpp.

                                       {
  for (const auto& b : blocks) {
    Block block = Block::fromRaw(b);
    if (!tree.acceptBlockHeader(block, state)) {
      return false;
    }
  }
 
  return true;
}

AssertDeserializeFromHex()

template<typename T >

T altintegration::AssertDeserializeFromHex

(

std::string

hex

)

Note

will fail on assert if can't be deserialized.

Definition at line 491 of file serde.hpp.

                                          {
  T t;
  ValidationState state;
  bool result = DeserializeFromHex(hex, t, state);
  VBK_ASSERT_MSG(result, "Can't deserialize: %s", state.toString());
  return t;
}

AssertDeserializeFromRaw()

template<typename T >

T altintegration::AssertDeserializeFromRaw

(

std::vector< uint8_t >

raw

)

Note

will fail on assert if can't be deserialized.

Definition at line 469 of file serde.hpp.

                                                   {
  T t;
  ValidationState state;
  bool result = DeserializeFromRaw(raw, t, state);
  VBK_ASSERT_MSG(result, "Can't deserialize: %s", state.toString());
  return t;
}

AssertDeserializeFromRawHex()

template<typename T >

T altintegration::AssertDeserializeFromRawHex

(

std::string

hex

)

Note

will fail on assert if can't be deserialized.

Definition at line 502 of file serde.hpp.

                                             {
  T t;
  ValidationState state;
  bool result = DeserializeFromRawHex(hex, t, state);
  VBK_ASSERT_MSG(result, "Can`t deserialize: %s", state.toString());
  return t;
}

AssertDeserializeFromVbkEncoding()

template<typename T >

T altintegration::AssertDeserializeFromVbkEncoding

(

Slice< const uint8_t >

raw

)

Note

will fail on assert if can't be deserialized.

Definition at line 480 of file serde.hpp.

                                                             {
  T t;
  ValidationState state;
  bool result = DeserializeFromVbkEncoding(raw, t, state);
  VBK_ASSERT_MSG(result, "Can't deserialize: %s", state.toString());
  return t;
}

checkMerklePath()

template<typename MerklePathType , typename HashType1 , typename HashType2 >

bool altintegration::checkMerklePath	(	const MerklePathType &	merklePath,
		const HashType1 &	transactionHash,
		const HashType2 &	merkleRoot,
		ValidationState &	state
	)

Definition at line 31 of file stateless_validation.hpp.

                                             {
  if (merklePath.subject != transactionHash) {
    return state.Invalid("invalid-merklepath",
                         "Transaction hash cannot be proven by merkle path");
  }
 
  auto root = merklePath.calculateMerkleRoot();
  if (root != merkleRoot) {
    return state.Invalid("invalid-merklepath",
                         "Wrong merkle root. Expected: " + merkleRoot.toHex() +
                             ", got: " + root.toHex());
  }
 
  return true;
}

checkRange()

bool altintegration::checkRange	(	uint64_t	num,
		uint64_t	min,
		uint64_t	max,
		ValidationState &	state
	)

If false, returns invalid state with error description.

Parameters

num	number to check
min	min value
max	max value
state	will return error description here

Returns

true if check is OK, false otherwise

DeserializeFromHex()

template<typename T >

bool altintegration::DeserializeFromHex	(	const std::string &	hex,
		T &	out,
		ValidationState &	state
	)

Definition at line 420 of file serde.hpp.

                                                {
  auto data = ParseHex(hex);
  ReadStream stream(data);
  return DeserializeFromVbkEncoding(stream, out, state);
}

DeserializeFromRaw()

template<typename T >

bool altintegration::DeserializeFromRaw	(	Slice< const uint8_t >	data,
		T &	out,
		ValidationState &	state
	)

Definition at line 411 of file serde.hpp.

                                                {
  ReadStream stream(data);
  return DeserializeFromRaw(stream, out, state);
}

DeserializeFromRawHex()

template<typename T >

bool altintegration::DeserializeFromRawHex	(	const std::string &	hex,
		T &	out,
		ValidationState &	state
	)

Definition at line 430 of file serde.hpp.

                                                   {
  auto data = ParseHex(hex);
  ReadStream stream(data);
  return DeserializeFromRaw(stream, out, state);
}

DeserializeFromVbkEncoding() [1/4]

bool altintegration::DeserializeFromVbkEncoding	(	ReadStream &	stream,
		Address &	out,
		ValidationState &	state
	)

Parameters

	stream	data stream to read from
[out]	out	output address
[out]	state

Returns

Address containing VBK address

DeserializeFromVbkEncoding() [2/4]

template<typename T >

bool altintegration::DeserializeFromVbkEncoding	(	ReadStream &	stream,
		PopState< T > &	out,
		ValidationState &	state
	)

Definition at line 104 of file pop_state.hpp.

                                                        {
  std::vector<T> endorsements;
  auto max = std::max(MAX_POPDATA_ATV, MAX_POPDATA_VTB);
  if (!readArrayOf<T>(
          stream,
          endorsements,
          state,
          0,
          max,
          [](ReadStream& stream, T& t, ValidationState& state) -> bool {
            return DeserializeFromVbkEncoding(stream, t, state);
          })) {
    return state.Invalid("popstate-bad-endorsement");
  }
 
  for (const auto& endorsement : endorsements) {
    auto it = out._containingEndorsements.emplace(
        endorsement.getId(), std::make_shared<T>(endorsement));
    // newly created endorsement must not be null
    VBK_ASSERT(it->second);
  }
  // do not restore 'endorsedBy' here, it will be done later during tree
  // loading
  return true;
}

DeserializeFromVbkEncoding() [3/4]

template<typename Block >

bool altintegration::DeserializeFromVbkEncoding	(	ReadStream &	stream,
		StoredBlockIndex< Block > &	out,
		ValidationState &	state,
		typename Block::hash_t	precalculatedHash = typename Block::hash_t()
	)

Definition at line 66 of file stored_block_index.hpp.

                                                                     {
  const auto& name = Block::name();
  using height_t = typename Block::height_t;
  if (!stream.readBE<height_t>(out.height, state)) {
    return state.Invalid(name + "-stored-block-index-height");
  }
  Block block{};
  if (!DeserializeFromRaw(stream, block, state, precalculatedHash)) {
    return state.Invalid(name + "-stored-block-index-header");
  }
  out.header = std::make_shared<Block>(block);
  if (!stream.readBE<uint32_t>(out.status, state)) {
    return state.Invalid(name + "-stored-block-index-status");
  }
 
  if (!DeserializeFromVbkEncoding(stream, out.addon, state)) {
    return state.Invalid(name + "-stored-block-index-addon");
  }
  return true;
}

DeserializeFromVbkEncoding() [4/4]

template<typename T >

bool altintegration::DeserializeFromVbkEncoding	(	Slice< const uint8_t >	data,
		T &	out,
		ValidationState &	state
	)

Definition at line 402 of file serde.hpp.

                                                        {
  ReadStream stream(data);
  return DeserializeFromVbkEncoding(stream, out, state);
}

EncodeBase58()

template<typename T , typename = typename std::enable_if<sizeof(typename T::value_type) == 1>::type>

std::string altintegration::EncodeBase58

(

const T &

container

)

Definition at line 23 of file base58.hpp.

                                           {
  const uint8_t *ptr = container.data();
  return EncodeBase58(ptr, ptr + container.size());
}

EncodeBase59()

template<typename T , typename = typename std::enable_if<sizeof(typename T::value_type) == 1>::type>

std::string altintegration::EncodeBase59

(

const T &

container

)

Definition at line 26 of file base59.hpp.

                                           {
  const uint8_t *ptr = container.data();
  return EncodeBase59(ptr, ptr + container.size());
}

estimateArraySizeOf()

template<typename T >

size_t altintegration::estimateArraySizeOf	(	const std::vector< T > &	t,
		std::function< size_t(const T &t)>	f
	)

Definition at line 395 of file serde.hpp.

                                                              {
  return estimateContainerSize<std::vector<T>>(t, f);
}

estimateNumberOfPopTxs()

uint32_t altintegration::estimateNumberOfPopTxs ( const std::vector< VbkMerklePath > &  paths )

inline

Definition at line 237 of file merkle_tree.hpp.

                                           {
  // validate that we have a continugous indexes set
  std::set<int32_t> indexes;
  int32_t maxIndex = -1;
  for (const auto& path : paths) {
    if (path.treeIndex == (int32_t)VbkMerkleTree::TreeIndex::POP &&
        maxIndex < path.index) {
      maxIndex = path.index;
    }
  }
 
  // find the latest index and determine amount of the leaves
  uint32_t aproximate_leaves_number = 0;
  for (const auto& path : paths) {
    if (path.treeIndex == (int32_t)VbkMerkleTree::TreeIndex::POP &&
        maxIndex == path.index) {
      if (path.layers.empty()) {
        aproximate_leaves_number = 1;
        break;
      }
      auto vec = path.equalLayerIndexes();
      if (vec.empty()) {
        aproximate_leaves_number = (1 << (path.layers.size() - 2));
        break;
      } else if (vec.front() == 0) {
        aproximate_leaves_number = path.index + 1;
        break;
      } else {
        aproximate_leaves_number = (1 << (path.layers.size() - 2));
        for (const auto& i : vec) {
          aproximate_leaves_number -= (1 << i);
        }
        break;
      }
    }
  }
 
  return aproximate_leaves_number;
}

findFork()

template<typename C >

C::index_t * altintegration::findFork	(	const C &	chain,
		const typename C::index_t *	pindex
	)

Returns

nullptr if fork can not be found

Definition at line 144 of file chain.hpp.

                                                               {
  if (pindex == nullptr || chain.tip() == nullptr) {
    return nullptr;
  }
 
  auto lastHeight = chain.chainHeight();
  if (pindex->getHeight() > lastHeight) {
    pindex = pindex->getAncestor(lastHeight);
  }
  while (pindex != nullptr && !chain.contains(pindex)) {
    pindex = pindex->getPrev();
  }
  return const_cast<typename C::index_t*>(pindex);
}

findValidTips() [1/2]

template<typename Block >

std::vector< BlockIndex< Block > * > altintegration::findValidTips

(

BlockIndex< Block > &

index

)

Template Parameters

Block

Definition at line 79 of file tree_algo.hpp.

                                                                      {
  using index_t = BlockIndex<Block>;
  std::vector<index_t*> ret{};
  forEachNodePreorder<Block>(index, [&ret](index_t& next) -> bool {
    if (!next.isValid()) {
      // this is invalid subtree
      return false;
    }
 
    // this is valid subtree
    if (next.isValidTip()) {
      ret.push_back(&next);
      // do not continue, as there are no valid next blocks
      return false;
    }
 
    return true;
  });
 
  return ret;
}

findValidTips() [2/2]

template<typename Block >

std::vector< BlockIndex< Block > * > altintegration::findValidTips	(	const std::unordered_set< BlockIndex< Block > * > &	tips,
		BlockIndex< Block > &	index
	)

Template Parameters

Block

Definition at line 106 of file tree_algo.hpp.

                              {
  using index_t = BlockIndex<Block>;
  std::vector<index_t*> ret{};
  for (auto* tip : tips) {
    auto* ancestor = tip->getAncestor(index.getHeight());
    if (ancestor == &index) {
      ret.push_back(tip);
    }
  }
 
  return ret;
}

fixedArray()

template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>

std::vector< uint8_t > altintegration::fixedArray

(

T

input

)

Parameters

input

value to convert

Returns

converted byte array

Definition at line 58 of file serde.hpp.

                                       {
  WriteStream inputStream;
  inputStream.writeBE(input);
  return inputStream.data();
}

forEachNextNodePreorder()

template<typename Block >

void altintegration::forEachNextNodePreorder	(	BlockIndex< Block > &	index,
		const std::function< bool(BlockIndex< Block > &)> &	shouldContinue
	)

Definition at line 63 of file tree_algo.hpp.

                                                                 {
  for (auto* pnext : index.pnext) {
    VBK_ASSERT(pnext != nullptr);
    if (shouldContinue(*pnext)) {
      forEachNextNodePreorder(*pnext, shouldContinue);
    }
  }
}

forEachNodePostorder()

template<typename Block >

void altintegration::forEachNodePostorder	(	BlockIndex< Block > &	index,
		const std::function< void(BlockIndex< Block > &)> &	visit,
		const std::function< bool(BlockIndex< Block > &)> &	shouldVisit
	)

Definition at line 19 of file tree_algo.hpp.

                                                              {
  using index_t = BlockIndex<Block>;
  std::unordered_set<index_t*> set;
  std::stack<index_t*> stack;
  stack.push(&index);
  while (!stack.empty()) {
    auto* item = stack.top();
    if (set.count(item) > 0) {
      visit(*item);
      stack.pop();
    } else {
      for (auto* next : item->pnext) {
        if (shouldVisit(*next)) {
          stack.push(next);
        }
      }
      set.insert(item);
    }
  }
}

forEachNodePreorder()

template<typename Block >

void altintegration::forEachNodePreorder	(	BlockIndex< Block > &	index,
		const std::function< bool(BlockIndex< Block > &)> &	visit
	)

Definition at line 45 of file tree_algo.hpp.

                                                                             {
  if (!visit(index)) {
    // we should not continue traversal of this subtree
    return;
  }
 
  // because pnext can be modified while iterating, we make a copy and iterate
  // over a copy
  auto copy = index.pnext;
  for (auto* pnext : copy) {
    VBK_ASSERT(pnext != nullptr);
    forEachNodePreorder(*pnext, visit);
  }
}

format()

template<typename S , typename... Args>

std::string altintegration::format ( const S &  format_str, Args &&...  args  )

inline

Definition at line 128 of file logger.hpp.

                                                             {
  try {
    return fmt::format(format_str, (Args &&) args...);
  } catch (const fmt::format_error&) {
    VBK_LOG_WARN("invalid string formatting, str: %s", format_str);
  }
  return "";
}

GeneratePublicationData()

bool altintegration::GeneratePublicationData	(	const std::vector< uint8_t > &	endorsedBlockHeader,
		const std::vector< uint8_t > &	txMerkleRoot,
		const PopData &	popData,
		const std::vector< uint8_t > &	payoutInfo,
		const AltBlockTree &	tree,
		PublicationData &	out
	)

Parameters

[in]	endorsedBlockHeader	endorsed block header
[in]	txMerkleRoot	original merkle root from altchain
[in]	popData	PopData from endorsed block
[in]	payoutInfo	payout info bytes.
[in]	tree	AltBlockTree instance
[out]	out	output instance

Returns

true if endorsed block found, false otherwise.

getContext()

template<typename BlockTreeT >

std::vector< typename BlockTreeT::block_t > altintegration::getContext	(	const BlockTreeT &	tree,
		typename BlockTreeT::hash_t	tip,
		size_t	size = std::numeric_limits<size_t>::max()
	)

Definition at line 43 of file alt-util.hpp.

                                                  {
  std::vector<typename BlockTreeT::block_t> ret;
  auto* cursor = tree.getBlockIndex(tip);
  size_t i = 0;
  while (cursor != nullptr && i++ < size) {
    ret.push_back(cursor->getHeader());
    cursor = cursor->pprev;
  }
  return ret;
}

getForkBlock()

template<typename Block >

const BlockIndex< Block > * altintegration::getForkBlock	(	const BlockIndex< Block > &	a,
		const BlockIndex< Block > &	b
	)

Definition at line 428 of file block_index.hpp.

                                                                  {
  const auto initialHeight = std::min(a.getHeight(), b.getHeight());
 
  for (auto cursorA = a.getAncestor(initialHeight),
            cursorB = b.getAncestor(initialHeight);
       cursorA != nullptr && cursorB != nullptr;
       cursorA = cursorA->getPrev(), cursorB = cursorB->getPrev()) {
    if (cursorA == cursorB) {
      return cursorA;
    }
  }
 
  // chain `b` is not connected to `a`
  return nullptr;
}

getLastKnownBlocks()

template<typename BlockTree >

std::vector< std::vector< uint8_t > > altintegration::getLastKnownBlocks	(	const BlockTree &	tree,
		size_t	size
	)

Definition at line 59 of file alt-util.hpp.

                                                                  {
  std::vector<std::vector<uint8_t>> ret;
  ret.reserve(size);
 
  auto* tip = tree.getBestChain().tip();
  for (size_t i = 0; i < size && tip != nullptr; i++) {
    ret.push_back(tip->getHash().asVector());
    tip = tip->pprev;
  }
 
  // reverse them since we add them in reverse order (tip -> genesis)
  std::reverse(ret.begin(), ret.end());
  return ret;
}

GetLogger()

Logger & altintegration::GetLogger

(

)

Warning

DO NOT USE LOGGER IN DESTRUCTORS.

HexStr() [1/2]

template<typename T >

std::string altintegration::HexStr ( const T &  vch, bool  reverseHex = false  )

inline

Definition at line 60 of file strutil.hpp.

                                                               {
  if (reverseHex) {
    return HexStr(vch.rbegin(), vch.rend());
  } else {
    return HexStr(vch.begin(), vch.end());
  }
}

HexStr() [2/2]

template<typename T >

std::string altintegration::HexStr	(	const T	itbegin,
		const T	itend
	)

Definition at line 44 of file strutil.hpp.

                                                 {
  std::string rv;
  // clang-format off
  static const char hexmap[16] = {'0','1','2','3','4','5','6','7','8','9','a','b','c','d','e','f'};
  // clang-format on
  rv.reserve(std::distance(itbegin, itend) * 2u);
  for (T it = itbegin; it < itend; ++it) {
    auto val = (uint8_t)(*it);
    rv.push_back(hexmap[val >> 4u]);
    rv.push_back(hexmap[val & 15u]);
  }
  return rv;
}

isBlockOutdated()

template<typename Block >

bool altintegration::isBlockOutdated	(	const BlockIndex< Block > &	finalBlock,
		const BlockIndex< Block > &	candidate
	)

Definition at line 448 of file block_index.hpp.

                                                         {
  // finalBlock is ancestor of candidate
  if (candidate.getAncestor(finalBlock.getHeight()) == &finalBlock) {
    return false;
  }
 
  // all candidates behind final block are outdated
  if (candidate.getHeight() < finalBlock.getHeight()) {
    return true;
  }
 
  // all parallel blocks (on same height as final, but not final) are outdated
  if (candidate.getHeight() == finalBlock.getHeight() &&
      &finalBlock != &candidate) {
    return true;
  }
 
  // candidate is ancestor of finalBlock and within window
  if (finalBlock.getAncestor(candidate.getHeight()) == &candidate) {
    return false;
  }
 
  // candidate is on a fork
  auto* fork = getForkBlock(finalBlock, candidate);
 
  // candidate does not connect to finalBlock
  if (fork == nullptr) {
    return true;
  }
 
  // if fork block is outdated, then candidate is also outdated
  return isBlockOutdated(finalBlock, *fork);
}

isKeystone()

bool altintegration::isKeystone	(	int32_t	blockNumber,
		uint32_t	keystoneInterval
	)

Parameters

blockNumber	blopck height
keystoneInterval	keystone interval

Returns

true if block is keystone

isPopSubTreeFull()

bool altintegration::isPopSubTreeFull ( const std::vector< VbkMerklePath > &  paths )

inline

Definition at line 278 of file merkle_tree.hpp.

                                                                    {
  return (uint32_t)paths.size() == estimateNumberOfPopTxs(paths);
}

IsSpace()

constexpr bool altintegration::IsSpace ( char  c )

inlineconstexprnoexcept

The whitespace characters are: space, form-feed ('\f'), newline ('\n'), carriage return ('\r'), horizontal tab ('\t'), and vertical tab ('\v').

This function is locale independent. Under the C locale this function gives the same result as std::isspace.

Parameters

[in]

c

character to test

Returns

true if the argument is a whitespace character; otherwise false

Definition at line 37 of file strutil.hpp.

                                               {
  return c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' ||
         c == '\v';
}

isValidInvalidationReason()

constexpr bool altintegration::isValidInvalidationReason ( const BlockValidityStatus &  reason )

constexpr

Definition at line 71 of file block_status.hpp.

                                                                            {
  return reason == BLOCK_FAILED_BLOCK || reason == BLOCK_FAILED_POP;
}

kiss99()

uint32_t altintegration::kiss99

(

kiss99_t &

st

)

https://en.wikipedia.org/wiki/KISS_(algorithm) http://www.cse.yorku.ca/~oz/marsaglia-rng.html

Parameters

st

Returns

loadTree()

template<typename BlockTreeT >

bool altintegration::loadTree	(	BlockTreeT &	tree,
		const typename BlockTreeT::hash_t &	tiphash,
		std::vector< typename BlockTreeT::stored_index_t > &	blocks,
		bool	fast_load,
		ValidationState &	state
	)

Sets tip after loading.

Invariant

NOT atomic

Definition at line 23 of file util.hpp.

                                      {
  using stored_index_t = typename BlockTreeT::stored_index_t;
 
  if (blocks.size() == 0) return true;
 
  VBK_LOG_INFO("Loading %d %s blocks with tip %s",
               blocks.size(),
               BlockTreeT::block_t::name(),
               HexStr(tiphash));
  VBK_ASSERT(tree.isBootstrapped() && "tree must be bootstrapped");
 
  // first, sort them by height
  std::sort(blocks.begin(),
            blocks.end(),
            [](const stored_index_t& a, const stored_index_t& b) {
              return a.height < b.height;
            });
 
  for (const auto& block : blocks) {
    // load blocks one by one
    if (!tree.loadBlockForward(block, fast_load, state)) {
      return state.Invalid("load-tree");
    }
  }
 
  if (!tree.loadTip(tiphash, state)) {
    return state.Invalid("load-tree");
  }
 
  auto* t = tree.getBestChain().tip();
  VBK_ASSERT(t != nullptr);
 
  return true;
}

min_or_default()

template<typename T , typename Container >

const T altintegration::min_or_default	(	Container &	c,
		const T	default_
	)

Definition at line 152 of file algorithm.hpp.

                                                       {
  const auto it = std::min_element(c.begin(), c.end());
  return it == c.end() ? default_ : *it;
}

PrintTo()

void altintegration::PrintTo ( const ArithUint256 &  uint, ::std::ostream *  os  )

inline

Definition at line 297 of file arith_uint256.hpp.

                                                              {
  *os << uint.toHex();
}

progPowHash()

uint192 altintegration::progPowHash

(

Slice< const uint8_t >

header

)

Parameters

header

65-bytes header

Returns

24-byte hash

readArrayOf() [1/2]

template<typename T >

bool altintegration::readArrayOf	(	ReadStream &	stream,
		std::vector< T > &	out,
		ValidationState &	state,
		size_t	min,
		size_t	max,
		std::function< bool(ReadStream &, T &, ValidationState &)>	readFunc
	)

Template Parameters

T	type of entity to read

Parameters

stream	read data from this stream
out	out output array of T
state	will return error description here
min	min size of array
max	max size of array
readFunc	function that is called to read single value of type T

Returns

true if read is OK, false otherwise

Definition at line 319 of file serde.hpp.

                                                                   {
  int32_t count = 0;
  if (!readSingleBEValue<int32_t>(stream, count, state)) {
    return state.Invalid("readarray-bad-count");
  }
  if (!checkRange(count, min, max, state)) {
    return state.Invalid("readarray-bad-range");
  }
 
  out.reserve(count);
 
  for (size_t i = 0; i < (size_t)count; i++) {
    T item;
    if (!readFunc(stream, item, state)) {
      return state.Invalid("readarray-bad-item", i);
    }
    out.push_back(item);
  }
 
  return true;
}

readArrayOf() [2/2]

template<typename T >

bool altintegration::readArrayOf	(	ReadStream &	stream,
		std::vector< T > &	out,
		ValidationState &	state,
		std::function< bool(ReadStream &, T &, ValidationState &)>	readFunc
	)

Template Parameters

T	type of entity to read

Parameters

[in]	stream	read data from this stream
[out]	out	output array of T
[in]	readFunc	function that is called to read single value of type T
[out]	state	validation state.

Exceptions

std::out_of_range

if stream is out of data

Returns

vector of read elements of type T

Definition at line 358 of file serde.hpp.

                                                                   {
  int32_t max = std::numeric_limits<int32_t>::max();
  return readArrayOf<T>(stream, out, state, 0, max, readFunc);
}

readNetworkByte() [1/2]

NetworkBytePair altintegration::readNetworkByte	(	ReadStream &	stream,
		TxType	type
	)

Parameters

stream	read data from this stream
type	use this value to detect if we are reading network byte or type byte

Exceptions

std::out_of_range

if stream is out of data

Returns

NetworkBytePair structure

readNetworkByte() [2/2]

bool altintegration::readNetworkByte	(	ReadStream &	stream,
		TxType	type,
		NetworkBytePair &	out,
		ValidationState &	state
	)

Parameters

stream	read data from this stream
type	use this value to detect if we are reading network byte or type byte
out	NetworkBytePair structure
state	will return error description here

Returns

true if read is OK, false otherwise

readSetOf() [1/2]

template<typename Container >

bool altintegration::readSetOf	(	ReadStream &	stream,
		Container &	out,
		ValidationState &	state,
		size_t	min,
		size_t	max,
		std::function< bool(ReadStream &, typename Container::value_type &, ValidationState &)>	readFunc
	)

Template Parameters

T	type of entity to read

Parameters

stream	read data from this stream
out	output set
state	will return error description here
min	min size of array
max	max size of array
readFunc	function that is called to read single value

Returns

true if read is OK, false otherwise

Definition at line 256 of file serde.hpp.

                                                               {
  int32_t count = 0;
  if (!readSingleBEValue<int32_t>(stream, count, state)) {
    return state.Invalid("readarray-bad-count");
  }
  if (!checkRange(count, min, max, state)) {
    return state.Invalid("readarray-bad-range");
  }
 
  for (size_t i = 0; i < (size_t)count; i++) {
    typename Container::value_type item;
    if (!readFunc(stream, item, state)) {
      return state.Invalid("readarray-bad-item", i);
    }
    if (out.insert(item).second == false) {
      return state.Invalid("readarray-duplicate-item", i);
    }
  }
 
  return true;
}

readSetOf() [2/2]

template<typename Container >

bool altintegration::readSetOf	(	ReadStream &	stream,
		Container &	out,
		ValidationState &	state,
		std::function< bool(Container &, ReadStream &, typename Container::value_type &, ValidationState &)>	readFunc
	)

Template Parameters

T	type of entity to read

Parameters

[in]	stream	read data from this stream
[out]	out	output container
[in]	readFunc	function that is called to read single value
[out]	state	validation state

Exceptions

std::out_of_range

if stream is out of data

Returns

vector of read elements

Definition at line 296 of file serde.hpp.

                                                               {
  int32_t max = std::numeric_limits<int32_t>::max();
  return readContainer(stream, out, state, 0, max, readFunc);
}

readSingleBEValue()

template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>

bool altintegration::readSingleBEValue	(	ReadStream &	stream,
		T &	out,
		ValidationState &	state
	)

This function interprets sizeof(T) bytes as Big-Endian number and returns it.

Template Parameters

T	number type - uint64_t, etc.

Parameters

stream	read data from this stream
out	read number
state	will return error description here

Returns

true if read is OK, false otherwise

Definition at line 130 of file serde.hpp.

                                                                           {
  Slice<const uint8_t> data;
  if (!readSingleByteLenValue(stream, data, state, 0, sizeof(T))) {
    return state.Invalid("readsinglebe-bad-data");
  }
  ReadStream dataStream(data);
  return dataStream.readBE<T>(out, state, data.size());
}

readSingleByteLenValue() [1/2]

template<typename Container , typename = typename std::enable_if< sizeof(typename Container::value_type) == 1>::type>

bool altintegration::readSingleByteLenValue	(	ReadStream &	stream,
		Container &	out,
		ValidationState &	state,
		uint64_t	minLen,
		uint64_t	maxLen
	)

Definition at line 102 of file serde.hpp.

                                             {
  uint8_t length = 0;
  if (!stream.readBE<uint8_t>(length, state)) {
    return state.Invalid("readsingle-bad-length");
  }
  if (!checkRange(length, minLen, maxLen, state)) {
    return state.Invalid("readsingle-bad-range");
  }
  out.resize(length);
  return stream.read(length, out.data(), state);
}

readSingleByteLenValue() [2/2]

bool altintegration::readSingleByteLenValue	(	ReadStream &	stream,
		Slice< const uint8_t > &	out,
		ValidationState &	state,
		uint64_t	minLen,
		uint64_t	maxLen
	)

Parameters

stream	read data from this stream
out	slice with data
state	will return error description here
minLen	minimum possible value of slice size
maxLen	maximum possible value of slice size

Returns

true if read is OK, false otherwise

readVarLenValue()

bool altintegration::readVarLenValue	(	ReadStream &	stream,
		Slice< const uint8_t > &	out,
		ValidationState &	state,
		uint64_t	minLen,
		uint64_t	maxLen
	)

Parameters

stream	read data from this stream
out	slice with data
state	will return error description here
minLen	minimum possible value of slice size
maxLen	maximum possible value of slice size

Returns

true if read is OK, false otherwise

reverse_iterate()

template<typename T >

reverse_range< T > altintegration::reverse_iterate

(

T &

x

)

Definition at line 29 of file reversed_range.hpp.

                                       {
  return reverse_range<T>(x);
}

SerializeToHex()

template<typename T >

std::string altintegration::SerializeToHex

(

const T &

obj

)

Definition at line 456 of file serde.hpp.

                                       {
  return HexStr(SerializeToVbkEncoding<T>(obj));
}

SerializeToRaw()

template<typename T >

std::vector< uint8_t > altintegration::SerializeToRaw

(

const T &

obj

)

Definition at line 448 of file serde.hpp.

                                                {
  WriteStream w;
  obj.toRaw(w);
  return w.data();
}

SerializeToRawHex()

template<typename T >

std::string altintegration::SerializeToRawHex

(

const T &

obj

)

Definition at line 462 of file serde.hpp.

                                          {
  return HexStr(SerializeToRaw<T>(obj));
}

SerializeToVbkEncoding()

template<typename T >

std::vector< uint8_t > altintegration::SerializeToVbkEncoding

(

const T &

obj

)

Definition at line 440 of file serde.hpp.

                                                        {
  WriteStream w;
  obj.toVbkEncoding(w);
  return w.data();
}

SetLogger()

template<typename L >

void altintegration::SetLogger

(

LogLevel

log_lvl = LogLevel::info

)

Definition at line 64 of file logger.hpp.

                                                {
  SetLogger(std::unique_ptr<L>(new L()), log_lvl);
}

setMockTime()

void altintegration::setMockTime

(

uint32_t

mocktime

)

0 disables mock time.

Parameters

mocktime

sha256()

uint256 altintegration::sha256

(

Slice< const uint8_t >

data

)

Parameters

data	read data from this array

Returns

vector with SHA256 hash of the input data

sha256twice()

uint256 altintegration::sha256twice

(

Slice< const uint8_t >

data

)

Parameters

data	read data from this array

Returns

vector with SHA256 hash of the input data

StringToLevel()

LogLevel altintegration::StringToLevel

(

const std::string &

)

Exceptions

std::invalid_argument

ToJSON() [1/25]

template<typename Value >

Value altintegration::ToJSON ( const Address &  addr )

inline

Definition at line 100 of file address.hpp.

                                         {
  return ToJSON<Value>(addr.toString());
}

ToJSON() [2/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON	(	const AltBlock &	alt,
		bool	reverseHashes = true
	)

Definition at line 90 of file altblock.hpp.

                                                                 {
  JsonValue object = json::makeEmptyObject<JsonValue>();
  json::putStringKV(object, "hash", HexStr(alt.getHash(), reverseHashes));
  json::putStringKV(
      object, "previousBlock", HexStr(alt.previousBlock, reverseHashes));
  json::putIntKV(object, "timestamp", alt.getBlockTime());
  json::putIntKV(object, "height", alt.height);
  return object;
}

ToJSON() [3/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON	(	const AltChainParams &	p,
		bool	reverseAltHashes = true
	)

Definition at line 312 of file alt_chain_params.hpp.

                                                                        {
  auto obj = json::makeEmptyObject<JsonValue>();
  json::putIntKV(obj, "networkId", p.getIdentifier());
  json::putArrayKV(
      obj, "forkResolutionLookupTable", p.getForkResolutionLookUpTable());
  json::putIntKV(obj, "maxVbkBlocksInAltBlock", p.getMaxVbkBlocksInAltBlock());
  json::putIntKV(obj, "maxVTBsInAltBlock", p.getMaxVTBsInAltBlock());
  json::putIntKV(obj, "maxATVsInAltBlock", p.getMaxATVsInAltBlock());
  json::putIntKV(obj, "maxReorgBlocks", p.getMaxReorgBlocks());
  json::putIntKV(obj,
                 "endorsementSettlementInterval",
                 p.getEndorsementSettlementInterval());
  json::putIntKV(obj, "finalityDelay", p.getFinalityDelay());
  json::putIntKV(obj, "keystoneInterval", p.getKeystoneInterval());
  json::putIntKV(
      obj, "maxAltchainFutureBlockTime", p.maxAltchainFutureBlockTime());
  json::putKV(obj, "payoutParams", ToJSON<JsonValue>(p.getPayoutParams()));
  json::putKV(obj,
              "bootstrapBlock",
              ToJSON<JsonValue>(p.getBootstrapBlock(), reverseAltHashes));
  return obj;
}

ToJSON() [4/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const ATV &

atv

)

Definition at line 103 of file atv.hpp.

                                 {
  JsonValue obj = json::makeEmptyObject<JsonValue>();
  json::putIntKV(obj, "version", atv.version);
  json::putKV(obj, "transaction", ToJSON<JsonValue>(atv.transaction));
  json::putKV(obj, "merklePath", ToJSON<JsonValue>(atv.merklePath));
  json::putKV(obj, "blockOfProof", ToJSON<JsonValue>(atv.blockOfProof));
 
  // return this entity in VBK-serialized form for easy consumption.
  // DO NOT REMOVE these fields - otherwise Stratum compat will break.
  json::putStringKV(obj, "id", atv.getId().toHex());
  json::putStringKV(obj, "serialized", SerializeToHex(atv));
  return obj;
}

ToJSON() [5/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const AuthenticatedContextInfoContainer &

a

)

Definition at line 117 of file context_info_container.hpp.

                                                             {
  auto o = json::makeEmptyObject<JsonValue>();
 
  WriteStream w;
  a.toVbkEncoding(w);
 
  json::putStringKV(o, "serialized", HexStr(w.data()));
  json::putStringKV(o, "stateRoot", HexStr(a.stateRoot));
  json::putKV(o, "context", ToJSON<JsonValue>(a.ctx));
  return o;
}

ToJSON() [6/25]

template<typename Value , size_t N>

Value altintegration::ToJSON ( const Blob< N > &  blob )

inline

Definition at line 249 of file blob.hpp.

                                         {
  return ToJSON<Value>(blob.toHex());
}

ToJSON() [7/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const BlockIndex< BtcBlock > &

i

)

Definition at line 272 of file vbk_block_tree.hpp.

                                                {
  auto obj = json::makeEmptyObject<JsonValue>();
  json::putStringKV(obj, "chainWork", i.chainWork.toHex());
  json::putIntKV(obj, "height", i.getHeight());
  json::putKV(obj, "header", ToJSON<JsonValue>(i.getHeader()));
  json::putIntKV(obj, "status", i.getStatus());
  json::putArrayKV(obj, "vbkrefs", i.getRefs());
 
  auto bopEndorsements = json::makeEmptyArray<JsonValue>();
  for (const auto* e : i.getBlockOfProofEndorsement()) {
    if (e == nullptr) {
      continue;
    }
    json::arrayPushBack(bopEndorsements, ToJSON<JsonValue>(e->getId()));
  }
  json::putKV(obj, "blockOfProofEndorsements", bopEndorsements);
 
  return obj;
}

ToJSON() [8/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const BlockIndex< VbkBlock > &

i

)

Definition at line 234 of file vbk_block_tree.hpp.

                                                {
  auto obj = json::makeEmptyObject<JsonValue>();
  json::putStringKV(obj, "chainWork", i.chainWork.toHex());
 
  std::vector<uint256> endorsements;
  for (const auto& e : i.getContainingEndorsements()) {
    endorsements.push_back(e.first);
  }
  json::putArrayKV(obj, "containingEndorsements", endorsements);
 
  std::vector<uint256> endorsedBy;
  for (const auto* e : i.getEndorsedBy()) {
    endorsedBy.push_back(e->id);
  }
  json::putArrayKV(obj, "endorsedBy", endorsedBy);
  json::putIntKV(obj, "height", i.getHeight());
  json::putKV(obj, "header", ToJSON<JsonValue>(i.getHeader()));
  json::putIntKV(obj, "status", i.getStatus());
  json::putIntKV(obj, "altrefs", i.refCount());
 
  auto stored = json::makeEmptyObject<JsonValue>();
  json::putArrayKV(stored, "vtbids", i.getPayloadIds<VTB>());
  json::putKV(obj, "stored", stored);
 
  auto bopEndorsements = json::makeEmptyArray<JsonValue>();
  for (const auto* e : i.getBlockOfProofEndorsement()) {
    if (e == nullptr) {
      continue;
    }
    json::arrayPushBack(bopEndorsements, ToJSON<JsonValue>(e->getId()));
  }
  json::putKV(obj, "blockOfProofEndorsements", bopEndorsements);
 
  return obj;
}

ToJSON() [9/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const BtcBlock &

b

)

Definition at line 141 of file btcblock.hpp.

                                    {
  JsonValue object = json::makeEmptyObject<JsonValue>();
  json::putStringKV(object, "hash", HexStr(b.getHash()));
  json::putIntKV(object, "version", b.getVersion());
  json::putStringKV(object, "previousBlock", HexStr(b.getPreviousBlock()));
  json::putStringKV(object, "merkleRoot", HexStr(b.getMerkleRoot()));
  json::putIntKV(object, "timestamp", b.getTimestamp());
  json::putIntKV(object, "bits", b.getDifficulty());
  json::putIntKV(object, "nonce", b.getNonce());
  return object;
}

ToJSON() [10/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const ContextInfoContainer &

a

)

Definition at line 105 of file context_info_container.hpp.

                                                {
  auto o = json::makeEmptyObject<JsonValue>();
  json::putIntKV(o, "height", a.height);
  json::putStringKV(
      o, "firstPreviousKeystone", HexStr(a.keystones.firstPreviousKeystone));
  json::putStringKV(
      o, "secondPreviousKeystone", HexStr(a.keystones.secondPreviousKeystone));
  return o;
}

ToJSON() [11/25]

template<typename Value , class A , class B , class C >

Value altintegration::ToJSON

(

const Endorsement< A, B, C > &

e

)

Definition at line 115 of file endorsement.hpp.

                                            {
  auto obj = json::makeEmptyObject<Value>();
  json::putStringKV(obj, "id", HexStr(e.id));
  json::putStringKV(obj, "endorsedHash", HexStr(e.endorsedHash));
  json::putStringKV(obj, "containingHash", e.containingHash);
  json::putStringKV(obj, "blockOfProof", e.blockOfProof);
  return obj;
}

ToJSON() [12/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const KeystoneContainer &

c

)

Definition at line 56 of file keystone_container.hpp.

                                             {
  auto obj = json::makeEmptyObject<JsonValue>();
  json::putStringKV(
      obj, "firstPreviousKeystone", HexStr(c.firstPreviousKeystone));
  json::putStringKV(
      obj, "secondPreviousKeystone", HexStr(c.secondPreviousKeystone));
  return obj;
}

ToJSON() [13/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const MempoolResult &

r

)

Definition at line 51 of file mempool_result.hpp.

                                         {
  auto obj = json::makeEmptyObject<JsonValue>();
  detail::putArrayOfPairs(obj, "vbkblocks", r.context);
  detail::putArrayOfPairs(obj, "vtbs", r.vtbs);
  detail::putArrayOfPairs(obj, "atvs", r.atvs);
  return obj;
}

ToJSON() [14/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const MerklePath &

m

)

Definition at line 59 of file merkle_path.hpp.

                                      {
  JsonValue obj = json::makeEmptyObject<JsonValue>();
  json::putIntKV(obj, "index", m.index);
  json::putStringKV(obj, "subject", HexStr(m.subject));
  json::putArrayKV(obj, "layers", m.layers);
  return obj;
}

ToJSON() [15/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const Output &

o

)

Definition at line 56 of file output.hpp.

                                  {
  JsonValue obj = json::makeEmptyObject<JsonValue>();
  json::putStringKV(obj, "address", o.address.toString());
  json::putIntKV(obj, "coin", o.coin.units);
  return obj;
}

ToJSON() [16/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON	(	const PopData &	p,
		bool	verbose = false
	)

Definition at line 112 of file popdata.hpp.

                                                         {
  JsonValue obj = json::makeEmptyObject<JsonValue>();
  json::putIntKV(obj, "version", p.version);
  if (verbose) {
    detail::putArrayKV(obj, "vbkblocks", p.context);
    detail::putArrayKV(obj, "vtbs", p.vtbs);
    detail::putArrayKV(obj, "atvs", p.atvs);
  } else {
    detail::putArrayOfIds(obj, "vbkblocks", p.context);
    detail::putArrayOfIds(obj, "vtbs", p.vtbs);
    detail::putArrayOfIds(obj, "atvs", p.atvs);
  }
 
  return obj;
}

ToJSON() [17/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const PopPayoutsParams &

p

)

Definition at line 110 of file alt_chain_params.hpp.

                                            {
  auto obj = json::makeEmptyObject<JsonValue>();
  json::putArrayKV(obj, "lookupTable", p.relativeScoreLookupTable());
  json::putArrayKV(obj, "roundRatios", p.roundRatios());
  json::putIntKV(
      obj, "difficultyAveragingInterval", p.difficultyAveragingInterval());
  json::putDoubleKV(
      obj, "maxScoreThresholdKeystone", p.maxScoreThresholdKeystone());
  json::putDoubleKV(
      obj, "maxScoreThresholdNormal", p.maxScoreThresholdNormal());
  json::putBoolKV(obj, "useFlatScoreRound", p.useFlatScoreRound());
  json::putIntKV(obj, "flatScoreRound", p.flatScoreRound());
  json::putIntKV(obj, "payoutRounds", p.payoutRounds());
  json::putIntKV(obj, "keystoneRound", p.keystoneRound());
  json::putDoubleKV(obj, "slopeKeystone", p.slopeKeystone());
  json::putDoubleKV(obj, "slopeNormal", p.slopeNormal());
  json::putDoubleKV(obj, "startOfSlope", p.startOfSlope());
  json::putIntKV(obj, "popPayoutDelay", p.getPopPayoutDelay());
  return obj;
}

ToJSON() [18/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const PublicationData &

p

)

Definition at line 54 of file publication_data.hpp.

                                           {
  JsonValue obj = json::makeEmptyObject<JsonValue>();
  json::putIntKV(obj, "identifier", p.identifier);
  json::putStringKV(obj, "header", HexStr(p.header));
  json::putStringKV(obj, "payoutInfo", HexStr(p.payoutInfo));
  json::putStringKV(obj, "contextInfo", HexStr(p.contextInfo));
  return obj;
}

ToJSON() [19/25]

template<typename Value , typename T >

Value altintegration::ToJSON

(

const T &

)

Template Parameters

Value	JSON Value type, which represents a "union" of JSON types.
T	Entity type to encode.

Returns

JSON Value.

Definition at line 20 of file json.hpp.

                         {
  static_assert(sizeof(T) == 0, "Undefined function for this type");
}

ToJSON() [20/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON	(	const ValidationState &	s,
		bool *	acceptedToMempool = nullptr
	)

Definition at line 82 of file validation_state.hpp.

                                                                              {
  auto obj = json::makeEmptyObject<JsonValue>();
 
  if (acceptedToMempool != nullptr) {
    json::putBoolKV(obj, "accepted", *acceptedToMempool);
  }
 
  if (s.IsValid()) {
    json::putStringKV(obj, "state", "valid");
    return obj;
  } else if (s.IsInvalid()) {
    json::putStringKV(obj, "state", "invalid");
  }
 
  json::putStringKV(obj, "code", s.GetPath());
  json::putStringKV(obj, "message", s.GetDebugMessage());
 
  return obj;
}

ToJSON() [21/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const VbkBlock &

b

)

Definition at line 170 of file vbkblock.hpp.

                                    {
  JsonValue obj = json::makeEmptyObject<JsonValue>();
  json::putStringKV(obj, "hash", HexStr(b.getHash()));
  json::putIntKV(obj, "height", b.getHeight());
  json::putIntKV(obj, "version", b.getVersion());
  json::putStringKV(obj, "previousBlock", HexStr(b.getPreviousBlock()));
  json::putStringKV(obj, "previousKeystone", HexStr(b.getPreviousKeystone()));
  json::putStringKV(
      obj, "secondPreviousKeystone", HexStr(b.getSecondPreviousKeystone()));
  json::putStringKV(obj, "merkleRoot", HexStr(b.getMerkleRoot()));
  json::putIntKV(obj, "timestamp", b.getTimestamp());
  json::putIntKV(obj, "difficulty", b.getDifficulty());
  json::putIntKV(obj, "nonce", b.getNonce());
 
  // return this entity in VBK-serialized form for easy consumption.
  // DO NOT REMOVE these fields - otherwise Stratum compat will break.
  json::putStringKV(obj, "id", HexStr(b.getId()));
  json::putStringKV(obj, "serialized", SerializeToHex(b));
  return obj;
}

ToJSON() [22/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const VbkMerklePath &

mp

)

Definition at line 62 of file vbk_merkle_path.hpp.

                                          {
  JsonValue obj = json::makeEmptyObject<JsonValue>();
  json::putIntKV(obj, "treeIndex", mp.treeIndex);
  json::putIntKV(obj, "index", mp.index);
  json::putStringKV(obj, "subject", mp.subject.toHex());
  json::putArrayKV(obj, "layers", mp.layers);
  return obj;
}

ToJSON() [23/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const VbkPopTx &

tx

)

Definition at line 90 of file vbkpoptx.hpp.

                                     {
  JsonValue obj = json::makeEmptyObject<JsonValue>();
  tx.networkOrType.networkType.template putJson<JsonValue>(obj);
  json::putStringKV(obj, "hash", tx.getHash().toHex());
  json::putIntKV(obj, "type", tx.networkOrType.typeId);
  json::putStringKV(obj, "address", tx.address.toString());
  json::putKV(obj, "publishedBlock", ToJSON<JsonValue>(tx.publishedBlock));
  json::putStringKV(
      obj, "bitcoinTransaction", SerializeToRawHex(tx.bitcoinTransaction));
  json::putKV(obj, "merklePath", ToJSON<JsonValue>(tx.merklePath));
  json::putKV(obj, "blockOfProof", ToJSON<JsonValue>(tx.blockOfProof));
  json::putArrayKV(obj, "blockOfProofContext", tx.blockOfProofContext);
  json::putStringKV(obj, "signature", HexStr(tx.signature));
  json::putStringKV(obj, "publicKey", HexStr(tx.publicKey));
  return obj;
}

ToJSON() [24/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const VbkTx &

tx

)

Definition at line 95 of file vbktx.hpp.

                                  {
  JsonValue obj = json::makeEmptyObject<JsonValue>();
  tx.networkOrType.networkType.template putJson<JsonValue>(obj);
  json::putStringKV(obj, "hash", tx.getHash().toHex());
  json::putIntKV(obj, "type", tx.networkOrType.typeId);
  json::putStringKV(obj, "sourceAddress", tx.sourceAddress.toString());
  json::putIntKV(obj, "sourceAmount", tx.sourceAmount.units);
  json::putArrayKV(obj, "outputs", tx.outputs);
  json::putIntKV(obj, "signatureIndex", tx.signatureIndex);
  json::putKV(obj, "publicationData", ToJSON<JsonValue>(tx.publicationData));
  json::putStringKV(obj, "signature", HexStr(tx.signature));
  json::putStringKV(obj, "publicKey", HexStr(tx.publicKey));
  return obj;
}

ToJSON() [25/25]

template<typename JsonValue >

JsonValue altintegration::ToJSON

(

const VTB &

v

)

Definition at line 96 of file vtb.hpp.

                               {
  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;
}

trimmedArray()

std::vector< uint8_t > altintegration::trimmedArray

(

int64_t

input

)

Parameters

input

value to convert

Returns

converted and trimmed byte array

vblake() [1/2]

uint192 altintegration::vblake

(

Slice< const uint8_t >

data

)

Parameters

data	read data from this array

Returns

vector with VBlake hash of the input data

vblake() [2/2]

int altintegration::vblake	(	void *	out,
		const void *	in,
		size_t	inlen
	)

Parameters

[out]	out	output hash - 24 bytes
[in]	in	input data
[in]	inlen	length of input data, not more than 64 bytes

Returns

0 if succeeded, -1 if inlen is more than 64 bytes

vblake_final()

void altintegration::vblake_final	(	vblake_ctx *	ctx,
		void *	out
	)

Parameters

ctx	initialized context.
out	resulting hash is written here. Should be 24 bytes.

vblake_init()

void altintegration::vblake_init

(

vblake_ctx *

ctx

)

Parameters

ctx	context to initialize.

vblake_update()

int altintegration::vblake_update	(	vblake_ctx *	ctx,
		const void *	in,
		size_t	inlen
	)

Parameters

ctx	initialized context.
in	input buffer.
inlen	size of input buffer. At most 64 bytes.

Returns

0 if succeeded, -1 if input buffer is more than 64 bytes.

writeNetworkByte()

void altintegration::writeNetworkByte	(	WriteStream &	stream,
		NetworkBytePair	networkOrType
	)

Parameters

stream	write data to this stream
networkOrType	write network byte if available, write type byte after

writeSingleBEValue()

void altintegration::writeSingleBEValue	(	WriteStream &	stream,
		int64_t	value
	)

This function converts number to the bytes array in Big-Endian order, trims it and writes to the stream

Parameters

stream	write data to this stream
value	value to be written

Exceptions

std::out_of_range

if stream is out of data

writeSingleByteLenValue()

void altintegration::writeSingleByteLenValue	(	WriteStream &	stream,
		Slice< const uint8_t >	value
	)

Parameters

stream	write data to this stream
value	data that should be written

Exceptions

std::out_of_range

if value size is too high

writeSingleFixedBEValue()

template<typename T , typename = typename std::enable_if<std::is_integral<T>::value>::type>

void altintegration::writeSingleFixedBEValue	(	WriteStream &	stream,
		T	value
	)

This function converts number to the bytes array in Big-Endian order and writes to the stream

Parameters

stream	write data to this stream
value	value to be written

Exceptions

std::out_of_range

if stream is out of data

Definition at line 169 of file serde.hpp.

                                                           {
  WriteStream dataStream;
  dataStream.writeBE<T>(value);
  writeSingleByteLenValue(stream, dataStream.data());
}

writeVarLenValue()

void altintegration::writeVarLenValue	(	WriteStream &	stream,
		Slice< const uint8_t >	value
	)

Parameters

stream	write data to this stream
value	data that should be written

Variable Documentation

__pad0__

template<>

altintegration::__pad0__

Definition at line 452 of file mempool.hpp.

__pad1__

template<>

altintegration::__pad1__

Definition at line 452 of file mempool.hpp.

__pad2__

template<>

altintegration::__pad2__

Definition at line 452 of file mempool.hpp.

ADDRESS_POP_DATA_SIZE_PROGPOW

constexpr const auto altintegration::ADDRESS_POP_DATA_SIZE_PROGPOW = 15

constexpr

Total size of this container is 80 bytes. 65 of which are VbkBlock (post-progpow), and 15 are address.

Definition at line 36 of file consts.hpp.

ALT_MAX_REORG_BLOCKS_MIN_VALUE

const int32_t altintegration::ALT_MAX_REORG_BLOCKS_MIN_VALUE = 10000

static

Definition at line 128 of file consts.hpp.

ATV_ID_SIZE

constexpr const auto altintegration::ATV_ID_SIZE = 32

constexpr

Definition at line 96 of file consts.hpp.

BTC_BLOCK_HASH_SIZE

constexpr const auto altintegration::BTC_BLOCK_HASH_SIZE = 32

constexpr

Definition at line 53 of file consts.hpp.

BTC_HEADER_SIZE

constexpr const uint32_t altintegration::BTC_HEADER_SIZE = 80

constexpr

Definition at line 45 of file consts.hpp.

BTC_MAX_REORG_BLOCKS_MIN_VALUE

const int32_t altintegration::BTC_MAX_REORG_BLOCKS_MIN_VALUE = 10000

static

Definition at line 132 of file consts.hpp.

BTC_TX_MAX_RAW_SIZE

constexpr const auto altintegration::BTC_TX_MAX_RAW_SIZE = 4 * 1000 * 1000

constexpr

Definition at line 42 of file consts.hpp.

MAX_ALT_HASH_SIZE

constexpr const auto altintegration::MAX_ALT_HASH_SIZE = 1024

constexpr

Definition at line 88 of file consts.hpp.

MAX_BTC_BLOCKS_IN_VBKPOPTX

constexpr const auto altintegration::MAX_BTC_BLOCKS_IN_VBKPOPTX = 65535

constexpr

Definition at line 51 of file consts.hpp.

MAX_BTCADDON_REFS

constexpr const auto altintegration::MAX_BTCADDON_REFS = 65536

constexpr

Definition at line 90 of file consts.hpp.

MAX_CONTEXT_SIZE_PUBLICATION_DATA

constexpr const auto altintegration::MAX_CONTEXT_SIZE_PUBLICATION_DATA = 10000

constexpr

Definition at line 69 of file consts.hpp.

MAX_HEADER_SIZE_PUBLICATION_DATA

constexpr const auto altintegration::MAX_HEADER_SIZE_PUBLICATION_DATA = 1024

constexpr

Definition at line 67 of file consts.hpp.

MAX_LAYER_COUNT_MERKLE

constexpr const auto altintegration::MAX_LAYER_COUNT_MERKLE = 40

constexpr

Definition at line 106 of file consts.hpp.

MAX_OUTPUTS_COUNT

constexpr const auto altintegration::MAX_OUTPUTS_COUNT = 255

constexpr

Definition at line 108 of file consts.hpp.

MAX_PAYOUT

constexpr const auto altintegration::MAX_PAYOUT = 50000

constexpr

Definition at line 84 of file consts.hpp.

MAX_PAYOUT_INFO_SIZE

constexpr const auto altintegration::MAX_PAYOUT_INFO_SIZE = 10000

constexpr

See also

https://bitcoin.stackexchange.com/a/35881/85437

Definition at line 65 of file consts.hpp.

MAX_POPDATA_ATV

constexpr const auto altintegration::MAX_POPDATA_ATV = 50000

constexpr

Definition at line 82 of file consts.hpp.

MAX_POPDATA_SIZE

constexpr const auto altintegration::MAX_POPDATA_SIZE = 5500000

constexpr

VTB can have a size up to 5.3 MB, so this number must be at least 5.3MB

Definition at line 76 of file consts.hpp.

MAX_POPDATA_VBK

constexpr const auto altintegration::MAX_POPDATA_VBK = 50000

constexpr

Definition at line 78 of file consts.hpp.

MAX_POPDATA_VTB

constexpr const auto altintegration::MAX_POPDATA_VTB = 50000

constexpr

Definition at line 80 of file consts.hpp.

MAX_PUBLIC_KEY_SIZE

constexpr const auto altintegration::MAX_PUBLIC_KEY_SIZE = 88

constexpr

Definition at line 112 of file consts.hpp.

MAX_PUBLICATIONDATA_SIZE

constexpr const auto altintegration::MAX_PUBLICATIONDATA_SIZE

constexpr

Initial value:

=
    1 + sizeof(int64_t) + 1 + MAX_HEADER_SIZE_PUBLICATION_DATA + 1 +
    MAX_PAYOUT_INFO_SIZE + 1 + MAX_CONTEXT_SIZE_PUBLICATION_DATA

Definition at line 71 of file consts.hpp.

MAX_SIGNATURE_SIZE

constexpr const auto altintegration::MAX_SIGNATURE_SIZE = 72

constexpr

Definition at line 110 of file consts.hpp.

MAX_VBKPOPTX_PER_VBK_BLOCK

constexpr const auto altintegration::MAX_VBKPOPTX_PER_VBK_BLOCK = 1024

constexpr

Definition at line 92 of file consts.hpp.

MIN_ALT_HASH_SIZE

constexpr const auto altintegration::MIN_ALT_HASH_SIZE = 0

constexpr

Definition at line 86 of file consts.hpp.

SHA256_HASH_SIZE

constexpr const auto altintegration::SHA256_HASH_SIZE = 32

constexpr

Definition at line 39 of file consts.hpp.

VBK_ADDRESS_SIZE

constexpr const auto altintegration::VBK_ADDRESS_SIZE = 30

constexpr

Definition at line 114 of file consts.hpp.

VBK_BLOCK_HASH_SIZE

constexpr const auto altintegration::VBK_BLOCK_HASH_SIZE = 24

constexpr

Definition at line 55 of file consts.hpp.

VBK_ETHASH_EPOCH_LENGTH

constexpr const auto altintegration::VBK_ETHASH_EPOCH_LENGTH = 8000U

constexpr

Definition at line 119 of file consts.hpp.

VBK_ETHASH_EPOCH_OFFSET

constexpr const auto altintegration::VBK_ETHASH_EPOCH_OFFSET = 323U

constexpr

Definition at line 121 of file consts.hpp.

VBK_HEADER_SIZE_PROGPOW

constexpr const uint32_t altintegration::VBK_HEADER_SIZE_PROGPOW = 65

constexpr

Definition at line 104 of file consts.hpp.

VBK_HEADER_SIZE_VBLAKE

constexpr const uint32_t altintegration::VBK_HEADER_SIZE_VBLAKE = 64

constexpr

Definition at line 102 of file consts.hpp.

VBK_ID_SIZE

constexpr const auto altintegration::VBK_ID_SIZE = 12

constexpr

Definition at line 98 of file consts.hpp.

VBK_MAX_CALCULATED_EPOCHS_SIZE

constexpr const auto altintegration::VBK_MAX_CALCULATED_EPOCHS_SIZE = 4096U

constexpr

Definition at line 117 of file consts.hpp.

VBK_MAX_REORG_BLOCKS_MIN_VALUE

const int32_t altintegration::VBK_MAX_REORG_BLOCKS_MIN_VALUE = 20000

static

Definition at line 130 of file consts.hpp.

VBK_MERKLE_ROOT_HASH_SIZE

constexpr const auto altintegration::VBK_MERKLE_ROOT_HASH_SIZE = 16

constexpr

Definition at line 57 of file consts.hpp.

VBK_PREVIOUS_BLOCK_HASH_SIZE

constexpr const auto altintegration::VBK_PREVIOUS_BLOCK_HASH_SIZE = 12

constexpr

Definition at line 59 of file consts.hpp.

VBK_PREVIOUS_KEYSTONE_HASH_SIZE

constexpr const auto altintegration::VBK_PREVIOUS_KEYSTONE_HASH_SIZE = 9

constexpr

Definition at line 61 of file consts.hpp.

VBK_PUBLICATIONDATA_SIZE

constexpr const auto altintegration::VBK_PUBLICATIONDATA_SIZE = 80

constexpr

Definition at line 100 of file consts.hpp.

VTB_ID_SIZE

constexpr const auto altintegration::VTB_ID_SIZE = 32

constexpr

Definition at line 94 of file consts.hpp.