catapult Namespace Reference

Namespaces
	addressextraction
	api
	builders
	cache
	chain
	config
	consumers
	crypto
	deltaset
	diagnostics
	disruptor
	eventsource
	exception_detail
	extensions
	filespooling
	handlers
	harvesting
	hashcache
	importance
	io
	ionet
	local
	model
	mongo
	net
	networkheight
	nodediscovery
	observers
	packetserver
	parsers
	partialtransaction
	pluginhandlers
	plugins
	process
	state
	subscribers
	sync
	syncsource
	thread
	timesync
	tools
	transactionsink
	tree
	unbondedpruning
	utils
	validators
	version
	zeromq

Classes
struct	Address_tag
struct	Amount_tag
struct	BlockDuration_tag
struct	BlockFeeMultiplier_tag
class	catapult_error
	Base class for all catapult exceptions that derives from both std::exception and boost::exception. More...
class	catapult_error< catapult_error< TStlException > >
struct	Difficulty_tag
struct	ErrorParam1
	Tag for first custom exception parameter. More...
struct	ErrorParam2
	Tag for second custom exception parameter. More...
struct	GenerationHash_tag
struct	Hash160_tag
struct	Hash256_tag
struct	Hash512_tag
struct	Height_tag
struct	Importance_tag
struct	Key_tag
struct	MosaicId_tag
struct	MosaicNonce_tag
	Mosaic nonce. More...
struct	NamespaceId_tag
	Namespace identifier. More...
struct	Signature_tag
struct	Timestamp_tag
struct	UnresolvedAddress_tag
struct	UnresolvedMosaicId_tag

Typedefs
using	MosaicNonce = utils::BaseValue< uint32_t, MosaicNonce_tag >
using	NamespaceId = utils::BaseValue< uint64_t, NamespaceId_tag >
using	catapult_runtime_error = catapult_error< std::runtime_error >
using	catapult_invalid_argument = catapult_error< std::invalid_argument >
using	catapult_out_of_range = catapult_error< std::out_of_range >
using	catapult_file_io_error = catapult_error< catapult_runtime_error >
using	action = std::function< void()>
	An action function. More...
template<typename... TArgs>
using	predicate = std::function< bool(TArgs...)>
	A predicate function. More...
template<typename... TArgs>
using	consumer = std::function< void(TArgs...)>
	A consumer function. More...
template<typename T >
using	supplier = std::function< T()>
	A (stateless) supplier function. More...
using	Signature = utils::ByteArray< Signature_Size, Signature_tag >
using	Key = utils::ByteArray< Key_Size, Key_tag >
using	Hash512 = utils::ByteArray< Hash512_Size, Hash512_tag >
using	Hash256 = utils::ByteArray< Hash256_Size, Hash256_tag >
using	Hash160 = utils::ByteArray< Hash160_Size, Hash160_tag >
using	GenerationHash = utils::ByteArray< Hash256_Size, GenerationHash_tag >
using	Address = utils::ByteArray< Address_Decoded_Size, Address_tag >
using	UnresolvedAddress = utils::ByteArray< Address_Decoded_Size, UnresolvedAddress_tag >
using	Timestamp = utils::BaseValue< uint64_t, Timestamp_tag >
using	Amount = utils::BaseValue< uint64_t, Amount_tag >
using	MosaicId = utils::BaseValue< uint64_t, MosaicId_tag >
using	UnresolvedMosaicId = utils::BaseValue< uint64_t, UnresolvedMosaicId_tag >
using	Height = utils::BaseValue< uint64_t, Height_tag >
using	BlockDuration = utils::BaseValue< uint64_t, BlockDuration_tag >
using	BlockFeeMultiplier = utils::BaseValue< uint32_t, BlockFeeMultiplier_tag >
using	Difficulty = utils::ClampedBaseValue< uint64_t, Difficulty_tag >
using	Importance = utils::BaseValue< uint64_t, Importance_tag >

Functions
constexpr NamespaceId	Namespace_Base_Id (0)
	Base id for namespaces. More...
constexpr BlockDuration	Eternal_Artifact_Duration (0)
	Duration of eternal artifact. More...
template<typename T , size_t N>
constexpr size_t	CountOf (T const (&)[N]) noexcept
	Returns the size of the specified array. More...

Variables
constexpr size_t	Namespace_Max_Depth = 3
	Maximum number of parts for a namespace. More...
constexpr size_t	Rollback_Buffer_Size = 2
	Number of buffer values required to guarantee deterministic rollbacks. More...
constexpr size_t	Importance_History_Size = 1 + Rollback_Buffer_Size
	Number of historical importances associated with a single account. More...
constexpr size_t	Activity_Bucket_History_Size = 5 + Rollback_Buffer_Size
constexpr size_t	Cached_Hash_Size = Hash256_Size
constexpr size_t	Signature_Size = 64
constexpr size_t	Key_Size = 32
constexpr size_t	Hash512_Size = 64
constexpr size_t	Hash256_Size = 32
constexpr size_t	Hash160_Size = 20
constexpr size_t	Address_Decoded_Size = 25
constexpr size_t	Address_Encoded_Size = 40

Detailed Description

Copyright (c) 2016-present, Jaguar0625, gimre, BloodyRookie, Tech Bureau, Corp. All rights reserved.

This file is part of Catapult.

Catapult is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Catapult is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with Catapult. If not, see http://www.gnu.org/licenses/.

Typedef Documentation

action

using catapult::action = typedef std::function<void ()>

An action function.

Address

using catapult::Address = typedef utils::ByteArray<Address_Decoded_Size, Address_tag>

Amount

using catapult::Amount = typedef utils::BaseValue<uint64_t, Amount_tag>

BlockDuration

using catapult::BlockDuration = typedef utils::BaseValue<uint64_t, BlockDuration_tag>

BlockFeeMultiplier

using catapult::BlockFeeMultiplier = typedef utils::BaseValue<uint32_t, BlockFeeMultiplier_tag>

catapult_file_io_error

using catapult::catapult_file_io_error = typedef catapult_error<catapult_runtime_error>

catapult_invalid_argument

using catapult::catapult_invalid_argument = typedef catapult_error<std::invalid_argument>

catapult_out_of_range

using catapult::catapult_out_of_range = typedef catapult_error<std::out_of_range>

catapult_runtime_error

using catapult::catapult_runtime_error = typedef catapult_error<std::runtime_error>

consumer

template<typename... TArgs>

using catapult::consumer = typedef std::function<void (TArgs...)>

A consumer function.

Difficulty

using catapult::Difficulty = typedef utils::ClampedBaseValue<uint64_t, Difficulty_tag>

GenerationHash

using catapult::GenerationHash = typedef utils::ByteArray<Hash256_Size, GenerationHash_tag>

Hash160

using catapult::Hash160 = typedef utils::ByteArray<Hash160_Size, Hash160_tag>

Hash256

using catapult::Hash256 = typedef utils::ByteArray<Hash256_Size, Hash256_tag>

Hash512

using catapult::Hash512 = typedef utils::ByteArray<Hash512_Size, Hash512_tag>

Height

using catapult::Height = typedef utils::BaseValue<uint64_t, Height_tag>

Importance

using catapult::Importance = typedef utils::BaseValue<uint64_t, Importance_tag>

Key

using catapult::Key = typedef utils::ByteArray<Key_Size, Key_tag>

MosaicId

using catapult::MosaicId = typedef utils::BaseValue<uint64_t, MosaicId_tag>

MosaicNonce

using catapult::MosaicNonce = typedef utils::BaseValue<uint32_t, MosaicNonce_tag>

NamespaceId

using catapult::NamespaceId = typedef utils::BaseValue<uint64_t, NamespaceId_tag>

predicate

template<typename... TArgs>

using catapult::predicate = typedef std::function<bool (TArgs...)>

A predicate function.

Signature

using catapult::Signature = typedef utils::ByteArray<Signature_Size, Signature_tag>

supplier

template<typename T >

using catapult::supplier = typedef std::function<T ()>

A (stateless) supplier function.

Timestamp

using catapult::Timestamp = typedef utils::BaseValue<uint64_t, Timestamp_tag>

UnresolvedAddress

using catapult::UnresolvedAddress = typedef utils::ByteArray<Address_Decoded_Size, UnresolvedAddress_tag>

UnresolvedMosaicId

using catapult::UnresolvedMosaicId = typedef utils::BaseValue<uint64_t, UnresolvedMosaicId_tag>

Function Documentation

CountOf()

template<typename T , size_t N>

constexpr size_t catapult::CountOf ( T   const(&)[N] )

constexprnoexcept

Returns the size of the specified array.

Eternal_Artifact_Duration()

constexpr BlockDuration catapult::Eternal_Artifact_Duration ( 0  )

constexpr

Duration of eternal artifact.

Here is the caller graph for this function:

Namespace_Base_Id()

constexpr NamespaceId catapult::Namespace_Base_Id ( 0  )

constexpr

Base id for namespaces.

Here is the caller graph for this function:

Variable Documentation

Activity_Bucket_History_Size

constexpr size_t catapult::Activity_Bucket_History_Size = 5 + Rollback_Buffer_Size

constexpr

Number of historical activity buckets associated with a single account.

Note

This allows four full buckets and one partial (WIP) bucket.

Address_Decoded_Size

constexpr size_t catapult::Address_Decoded_Size = 25

constexpr

Address_Encoded_Size

constexpr size_t catapult::Address_Encoded_Size = 40

constexpr

Cached_Hash_Size

constexpr size_t catapult::Cached_Hash_Size = Hash256_Size

constexpr

Size of hashes in the hash cache.

Note

Reducing below Hash256_Size can save memory but will increase possibility of false positive rejections.

Hash160_Size

constexpr size_t catapult::Hash160_Size = 20

constexpr

Hash256_Size

constexpr size_t catapult::Hash256_Size = 32

constexpr

Hash512_Size

constexpr size_t catapult::Hash512_Size = 64

constexpr

Importance_History_Size

constexpr size_t catapult::Importance_History_Size = 1 + Rollback_Buffer_Size

constexpr

Number of historical importances associated with a single account.

Key_Size

constexpr size_t catapult::Key_Size = 32

constexpr

Namespace_Max_Depth

constexpr size_t catapult::Namespace_Max_Depth = 3

constexpr

Maximum number of parts for a namespace.

Rollback_Buffer_Size

constexpr size_t catapult::Rollback_Buffer_Size = 2

constexpr

Number of buffer values required to guarantee deterministic rollbacks.

Signature_Size

constexpr size_t catapult::Signature_Size = 64

constexpr