rippled/VaultHelpers_8h_source.html

#pragma once


#include <xrpl/protocol/STAmount.h>

#include <xrpl/protocol/STLedgerEntry.h>


#include <memory>

#include <optional>


namespace xrpl {


[[nodiscard]] std::optional<STAmount>

assetsToSharesDeposit(

    std::shared_ptr<SLE const> const& vault,

    std::shared_ptr<SLE const> const& issuance,

    STAmount const& assets);


[[nodiscard]] std::optional<STAmount>

sharesToAssetsDeposit(

    std::shared_ptr<SLE const> const& vault,

    std::shared_ptr<SLE const> const& issuance,

    STAmount const& shares);


enum class TruncateShares : bool { no = false, yes = true };


[[nodiscard]] std::optional<STAmount>

assetsToSharesWithdraw(

    std::shared_ptr<SLE const> const& vault,

    std::shared_ptr<SLE const> const& issuance,

    STAmount const& assets,

    TruncateShares truncate = TruncateShares::no);


[[nodiscard]] std::optional<STAmount>

sharesToAssetsWithdraw(

    std::shared_ptr<SLE const> const& vault,

    std::shared_ptr<SLE const> const& issuance,

    STAmount const& shares);


}  // namespace xrpl

memory

xrpl
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:5

xrpl::sharesToAssetsDeposit
std::optional< STAmount > sharesToAssetsDeposit(std::shared_ptr< SLE const > const &vault, std::shared_ptr< SLE const > const &issuance, STAmount const &shares)
From the perspective of a vault, return the number of assets to take from depositor when they receive...
Definition VaultHelpers.cpp:37

xrpl::TruncateShares
TruncateShares
Controls whether to truncate shares instead of rounding.
Definition VaultHelpers.h:44

xrpl::TruncateShares::no
@ no

xrpl::assetsToSharesDeposit
std::optional< STAmount > assetsToSharesDeposit(std::shared_ptr< SLE const > const &vault, std::shared_ptr< SLE const > const &issuance, STAmount const &assets)
From the perspective of a vault, return the number of shares to give depositor when they offer a fixe...
Definition VaultHelpers.cpp:10

xrpl::assetsToSharesWithdraw
std::optional< STAmount > assetsToSharesWithdraw(std::shared_ptr< SLE const > const &vault, std::shared_ptr< SLE const > const &issuance, STAmount const &assets, TruncateShares truncate=TruncateShares::no)
From the perspective of a vault, return the number of shares to demand from the depositor when they a...
Definition VaultHelpers.cpp:63

xrpl::sharesToAssetsWithdraw
std::optional< STAmount > sharesToAssetsWithdraw(std::shared_ptr< SLE const > const &vault, std::shared_ptr< SLE const > const &issuance, STAmount const &shares)
From the perspective of a vault, return the number of assets to give the depositor when they redeem a...
Definition VaultHelpers.cpp:90

xrpl::no
@ no
Definition Steps.h:24

xrpl::yes
@ yes
Definition Steps.h:24

optional

std::shared_ptr