xrpl::path::RippleCalc Class Reference

RippleCalc calculates the quality of a payment path. More...

#include <RippleCalc.h>

Collaboration diagram for xrpl::path::RippleCalc:

Classes
struct	Input
struct	Output

Static Public Member Functions
static Output	rippleCalculate (PaymentSandbox &view, STAmount const &saMaxAmountReq, STAmount const &saDstAmountReq, AccountID const &uDstAccountID, AccountID const &uSrcAccountID, STPathSet const &spsPaths, std::optional< uint256 > const &domainID, ServiceRegistry &registry, Input const *const pInputs=nullptr)

Public Attributes
PaymentSandbox &	view
boost::container::flat_set< uint256 >	permanentlyUnfundedOffers

Detailed Description

RippleCalc calculates the quality of a payment path.

Quality is the amount of input required to produce a given output along a specified path - another name for this is exchange rate.

Definition at line 23 of file RippleCalc.h.

Member Function Documentation

rippleCalculate()

RippleCalc::Output xrpl::path::RippleCalc::rippleCalculate ( PaymentSandbox & view, STAmount const & saMaxAmountReq, STAmount const & saDstAmountReq, AccountID const & uDstAccountID, AccountID const & uSrcAccountID, STPathSet const & spsPaths, std::optional< uint256 > const & domainID, ServiceRegistry & registry, Input const *const pInputs = nullptr )

static

Definition at line 23 of file RippleCalc.cpp.

Member Data Documentation

view

PaymentSandbox& xrpl::path::RippleCalc::view

Definition at line 99 of file RippleCalc.h.

permanentlyUnfundedOffers

boost::container::flat_set<uint256> xrpl::path::RippleCalc::permanentlyUnfundedOffers

Definition at line 105 of file RippleCalc.h.