VaultHelpers.h

#pragma once
 
#include <xrpl/basics/Number.h>
#include <xrpl/ledger/ReadView.h>
#include <xrpl/protocol/AccountID.h>
#include <xrpl/protocol/Asset.h>
#include <xrpl/protocol/Protocol.h>
#include <xrpl/protocol/STAmount.h>
#include <xrpl/protocol/STLedgerEntry.h>
#include <xrpl/protocol/TER.h>
 
#include <cstdint>
#include <expected>
#include <optional>
 
namespace xrpl {
 
class STTx;

[[nodiscard]] std::optional<STAmount>
assetsToSharesDeposit(SLE::ConstRef vault, SLE::ConstRef issuance, STAmount const& assets);

[[nodiscard]] std::optional<STAmount>
sharesToAssetsDeposit(SLE::ConstRef vault, SLE::ConstRef issuance, STAmount const& shares);

[[nodiscard]] std::expected<STAmount, TER>
clampToAssetsTotalScale(SLE::ConstRef vault, STAmount const& delta);

enum class TruncateShares : bool { No = false, Yes = true };

enum class WaiveUnrealizedLoss : bool { No = false, Yes = true };

[[nodiscard]] Number
assetsTotalForWithdrawal(SLE::ConstRef vault, WaiveUnrealizedLoss waive);

[[nodiscard]] bool
debitIsNonZeroDust(Asset const& asset, Number const& total, Number const& amount);

[[nodiscard]] std::optional<STAmount>
assetsToSharesWithdraw(
    SLE::ConstRef vault,
    SLE::ConstRef issuance,
    STAmount const& assets,
    TruncateShares truncate = TruncateShares::No,
    WaiveUnrealizedLoss waive = WaiveUnrealizedLoss::No);

[[nodiscard]] std::optional<STAmount>
sharesToAssetsWithdraw(
    SLE::ConstRef vault,
    SLE::ConstRef issuance,
    STAmount const& shares,
    WaiveUnrealizedLoss waive = WaiveUnrealizedLoss::No);

[[nodiscard]] bool
isSoleShareholder(ReadView const& view, AccountID const& account, SLE::ConstRef issuance);

[[nodiscard]] VaultVersion
getVaultVersion(SLE::ConstRef vault);

[[nodiscard]] VaultKind
getVaultKind(SLE::ConstRef vault);

[[nodiscard]] VaultKind
getVaultKind(STTx const& tx);

[[nodiscard]] bool
isValidVaultKind(STTx const& tx);

[[nodiscard]] bool
isValidClosedEndedGap(std::uint32_t sub, std::uint32_t red);

[[nodiscard]] VaultPhase
getVaultPhase(ReadView const& view, SLE::ConstRef vault);

[[nodiscard]] VaultPhase
getVaultPhase(
    ReadView const& view,
    std::optional<std::uint8_t> vaultKind,
    std::optional<std::uint32_t> subscriptionDate,
    std::optional<std::uint32_t> redemptionDate);

enum class SuppressExpired : bool { No = false, Yes = true };

[[nodiscard]] TER
checkVaultDomain(
    ReadView const& view,
    SLE::ConstRef issuance,
    AccountID const& subject,
    SuppressExpired suppressExpired);
 
}  // namespace xrpl