ripple::ValidVault Class Reference

Invariants: Vault object and MPTokenIssuance for vault shares. More...

#include <InvariantCheck.h>

Collaboration diagram for ripple::ValidVault:

Classes
struct	Shares
struct	Vault

Public Member Functions
void	visitEntry (bool, std::shared_ptr< SLE const > const &, std::shared_ptr< SLE const > const &)
bool	finalize (STTx const &, TER const, XRPAmount const, ReadView const &, beast::Journal const &)

Private Attributes
std::vector< Vault >	afterVault_ = {}
std::vector< Shares >	afterMPTs_ = {}
std::vector< Vault >	beforeVault_ = {}
std::vector< Shares >	beforeMPTs_ = {}
std::unordered_map< uint256, Number >	deltas_ = {}

Static Private Attributes
static Number constexpr	zero {}

Detailed Description

Invariants: Vault object and MPTokenIssuance for vault shares.

• vault deleted and vault created is empty
• vault created must be linked to pseudo-account for shares and assets
• vault must have MPTokenIssuance for shares
• vault without shares outstanding must have no shares
• loss unrealized does not exceed the difference between assets total and assets available
• assets available do not exceed assets total
• vault deposit increases assets and share issuance, and adds to: total assets, assets available, shares outstanding
• vault withdrawal and clawback reduce assets and share issuance, and subtracts from: total assets, assets available, shares outstanding
• vault set must not alter the vault assets or shares balance
• no vault transaction can change loss unrealized (it's updated by loan transactions)

Definition at line 756 of file InvariantCheck.h.

Member Function Documentation

visitEntry()

void ripple::ValidVault::visitEntry	(	bool	isDelete,
		std::shared_ptr< SLE const > const &	before,
		std::shared_ptr< SLE const > const &	after
	)

Definition at line 2221 of file InvariantCheck.cpp.

finalize()

bool ripple::ValidVault::finalize	(	STTx const &	tx,
		TER const	ret,
		XRPAmount const	fee,
		ReadView const &	view,
		beast::Journal const &	j
	)

Definition at line 2309 of file InvariantCheck.cpp.

Member Data Documentation

zero

Number constexpr ripple::ValidVault::zero {}

staticconstexprprivate

Definition at line 758 of file InvariantCheck.h.

afterVault_

std::vector<Vault> ripple::ValidVault::afterVault_ = {}

private

Definition at line 783 of file InvariantCheck.h.

afterMPTs_

std::vector<Shares> ripple::ValidVault::afterMPTs_ = {}

private

Definition at line 784 of file InvariantCheck.h.

beforeVault_

std::vector<Vault> ripple::ValidVault::beforeVault_ = {}

private

Definition at line 785 of file InvariantCheck.h.

beforeMPTs_

std::vector<Shares> ripple::ValidVault::beforeMPTs_ = {}

private

Definition at line 786 of file InvariantCheck.h.

deltas_

std::unordered_map<uint256, Number> ripple::ValidVault::deltas_ = {}

private

Definition at line 787 of file InvariantCheck.h.