mirror of
https://github.com/XRPLF/rippled.git
synced 2026-06-04 09:16:47 +00:00
ea023121f5
Co-authored-by: Vito Tumas <5780819+Tapanito@users.noreply.github.com> Co-authored-by: Ed Hennis <ed@ripple.com>
95 lines
2.7 KiB
C++
95 lines
2.7 KiB
C++
#pragma once
|
|
|
|
#include <xrpl/basics/Number.h>
|
|
#include <xrpl/basics/base_uint.h>
|
|
#include <xrpl/beast/utility/Journal.h>
|
|
#include <xrpl/ledger/ReadView.h>
|
|
#include <xrpl/protocol/MPTIssue.h>
|
|
#include <xrpl/protocol/STTx.h>
|
|
#include <xrpl/protocol/TER.h>
|
|
|
|
#include <optional>
|
|
#include <unordered_map>
|
|
#include <vector>
|
|
|
|
namespace xrpl {
|
|
|
|
/*
|
|
* @brief 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)
|
|
*
|
|
*/
|
|
class ValidVault
|
|
{
|
|
Number static constexpr zero{};
|
|
|
|
struct Vault final
|
|
{
|
|
uint256 key = beast::zero;
|
|
Asset asset;
|
|
AccountID pseudoId;
|
|
AccountID owner;
|
|
uint192 shareMPTID = beast::zero;
|
|
Number assetsTotal = 0;
|
|
Number assetsAvailable = 0;
|
|
Number assetsMaximum = 0;
|
|
Number lossUnrealized = 0;
|
|
|
|
Vault static make(SLE const&);
|
|
};
|
|
|
|
struct Shares final
|
|
{
|
|
MPTIssue share;
|
|
std::uint64_t sharesTotal = 0;
|
|
std::uint64_t sharesMaximum = 0;
|
|
|
|
Shares static make(SLE const&);
|
|
};
|
|
|
|
public:
|
|
struct DeltaInfo final
|
|
{
|
|
Number delta = numZero;
|
|
std::optional<int> scale;
|
|
|
|
// Compute the delta between two Numbers, taking the coarsest scale
|
|
[[nodiscard]] static DeltaInfo
|
|
makeDelta(Number const& before, Number const& after, Asset const& asset);
|
|
};
|
|
|
|
private:
|
|
std::vector<Vault> afterVault_;
|
|
std::vector<Shares> afterMPTs_;
|
|
std::vector<Vault> beforeVault_;
|
|
std::vector<Shares> beforeMPTs_;
|
|
std::unordered_map<uint256, DeltaInfo> deltas_;
|
|
|
|
public:
|
|
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&);
|
|
|
|
// Compute the coarsest scale required to represent all numbers
|
|
[[nodiscard]] static std::int32_t
|
|
computeCoarsestScale(std::vector<DeltaInfo> const& numbers);
|
|
};
|
|
|
|
} // namespace xrpl
|