Classes
class	AccountActivityBuckets
	Stack of account activity buckets. More...

class	AccountBalances
	Container holding information about account. More...

class	AccountImportanceSnapshots
	Stack of account importance snapshots. More...

class	AccountRestriction
	Account restriction. More...

class	AccountRestrictionDescriptor
	Account restriction descriptor. More...

class	AccountRestrictions
	Account restrictions. More...

struct	AccountRestrictionsSerializer
	Policy for saving and loading account restrictions data. More...

struct	AccountState
	Account state data. More...

struct	AccountStateNonHistoricalSerializer
	Policy for saving and loading account state data without historical information. More...

struct	AccountStateSerializer
	Policy for saving and loading account state data. More...

struct	BlockDifficultyInfo

struct	CatapultState
	Stateful catapult information. More...

class	CompactArrayStack
	Compact array-based stack that allocates memory dynamically only when it is not empty. More...

class	CompactMosaicMap

struct	HashLockInfo
	A hash lock info. More...

struct	HashLockInfoExtendedDataSerializer
	Policy for saving and loading hash lock info extended data. More...

struct	HashLockInfoSerializer
	Policy for saving and loading hash lock info data. More...

struct	LockInfo
	A lock info. More...

struct	LockInfoSerializer
	Policy for saving and loading lock info data. More...

class	MosaicDefinition
	Represents a mosaic definition. More...

class	MosaicEntry
	A tuple composed of a mosaic definition and its current state. More...

struct	MosaicEntrySerializer
	Policy for saving and loading mosaic entry data. More...

class	MosaicEntrySupplyMixin
	Mixin for storing and modifying a supply in MosaicEntry. More...

class	MultisigCosignatoriesMixin
	Mixin for storing information about cosignatories of an account. More...

class	MultisigCosignatoryOfMixin
	Mixin for storing information about accounts that current account can cosign. More...

class	MultisigEntry
	Multisig entry. More...

struct	MultisigEntrySerializer
	Policy for saving and loading multisig entry data. More...

class	Namespace
	A catapult namespace. More...

class	NamespaceAlias
	A namespace alias. More...

class	NamespaceEntry
	A pair composed of a namespace and its root. More...

struct	NamespaceLifetime
	Lifetime of a namespace. More...

class	RootNamespace
	A root namespace. More...

class	RootNamespaceHistory
	A root namespace history. More...

struct	RootNamespaceHistoryNonHistoricalSerializer
	Policy for saving and loading root namespace history data without historical information. More...

struct	RootNamespaceHistorySerializer
	Policy for saving and loading root namespace history data. More...

struct	SecretLockInfo
	A secret lock info. More...

struct	SecretLockInfoExtendedDataSerializer
	Policy for saving and loading secret lock info extended data. More...

struct	SecretLockInfoSerializer
	Policy for saving and loading secret lock info data. More...

struct	TimestampedHash
	Represents a hash with attached timestamp. More...

class	TypedAccountRestriction
	Typed account restriction. More...

Typedefs
using	TimestampedHashRange = model::EntityRange< TimestampedHash >
	An entity range composed of timestamped hashes. More...

Enumerations
enum	LockStatus : uint8_t { LockStatus::Unused, LockStatus::Used }
	A lock status. More...

enum	AliasType : uint8_t { AliasType::None, AliasType::Mosaic, AliasType::Address }
	Possible alias types. More...

enum	AccountRestrictionOperationType { AccountRestrictionOperationType::Allow, AccountRestrictionOperationType::Block }
	Operation type. More...

enum	AccountType : uint8_t { AccountType::Unlinked, AccountType::Main, AccountType::Remote, AccountType::Remote_Unlinked }
	Possible account types. More...

Functions
template<typename T >
auto	ToVector (T value)
	Converts value to a vector. More...

template<size_t N>
auto	ToVector (const std::array< uint8_t, N > &value)
	Converts an array (value) to a vector. More...

bool	IsRemote (AccountType accountType)
	Returns `true` if accountType corresponds to a remote account. More...

void	RequireLinkedRemoteAndMainAccounts (const AccountState &remoteAccountState, const AccountState &mainAccountState)
	Requires that remoteAccountState and mainAccountState state are linked. More...

RawBuffer	SerializeKey (const TimestampedHash &timestampedHash)
	Wraps timestampedHash in raw buffer. More...

std::ostream &	operator<< (std::ostream &out, const TimestampedHash &timestampedHash)
	Insertion operator for outputting timestampedHash to out. More...

Typedef Documentation

◆ TimestampedHashRange

using catapult::state::TimestampedHashRange = typedef model::EntityRange<TimestampedHash>

An entity range composed of timestamped hashes.

Enumeration Type Documentation

◆ AccountRestrictionOperationType

enum catapult::state::AccountRestrictionOperationType

strong

Operation type.

Enumerator
Allow	Account restriction contains allowed values.
Block	Account restriction contains blocked value.

◆ AccountType

enum catapult::state::AccountType : uint8_t

strong

Possible account types.

Enumerator
Unlinked	Account is not linked to another account.
Main	Account is a balance-holding account that is linked to a remote harvester account.
Remote	Account is a remote harvester account that is linked to a balance-holding account.
Remote_Unlinked	Account is a remote harvester eligible account that is unlinked.

◆ AliasType

enum catapult::state::AliasType : uint8_t

strong

Possible alias types.

Enumerator
None	No alias.
Mosaic	Mosaic id alias.
Address	Account address alias.

◆ LockStatus

enum catapult::state::LockStatus : uint8_t

strong

A lock status.

Enumerator
Unused	Lock is unused.
Used	Lock was already used.

Function Documentation

◆ IsRemote()

bool catapult::state::IsRemote ( AccountType accountType )

Returns true if accountType corresponds to a remote account.

◆ operator<<()

std::ostream & catapult::state::operator<<	(	std::ostream &	out,
		const TimestampedHash &	timestampedHash
	)

Insertion operator for outputting timestampedHash to out.

Here is the call graph for this function:

◆ RequireLinkedRemoteAndMainAccounts()

void catapult::state::RequireLinkedRemoteAndMainAccounts	(	const AccountState &	remoteAccountState,
		const AccountState &	mainAccountState
	)

Requires that remoteAccountState and mainAccountState state are linked.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SerializeKey()

RawBuffer catapult::state::SerializeKey ( const TimestampedHash & timestampedHash )

Wraps timestampedHash in raw buffer.

◆ ToVector() [1/2]

template<size_t N>

auto catapult::state::ToVector ( const std::array< uint8_t, N > & value )

Converts an array (value) to a vector.

◆ ToVector() [2/2]

template<typename T >

auto catapult::state::ToVector ( T value )

Converts value to a vector.

Here is the caller graph for this function:

Classes

Typedefs

Enumerations

Functions

Typedef Documentation

◆ TimestampedHashRange

Enumeration Type Documentation

◆ AccountRestrictionOperationType

◆ AccountType

◆ AliasType

◆ LockStatus

Function Documentation

◆ IsRemote()

◆ operator<<()

◆ RequireLinkedRemoteAndMainAccounts()

◆ SerializeKey()

◆ ToVector() [1/2]

◆ ToVector() [2/2]