Calculates payment paths. More...

#include <Pathfinder.h>

Inheritance diagram for ripple::Pathfinder:

Collaboration diagram for ripple::Pathfinder:

[legend]

Classes
struct	PathRank

Public Types
enum	NodeType { nt_SOURCE , nt_ACCOUNTS , nt_BOOKS , nt_XRP_BOOK , nt_DEST_BOOK , nt_DESTINATION }

enum	PaymentType { pt_XRP_to_XRP , pt_XRP_to_nonXRP , pt_nonXRP_to_XRP , pt_nonXRP_to_same , pt_nonXRP_to_nonXRP }

using	PathType = std::vector< NodeType >

Public Member Functions
	Pathfinder (std::shared_ptr< RippleLineCache > const &cache, AccountID const &srcAccount, AccountID const &dstAccount, Currency const &uSrcCurrency, std::optional< AccountID > const &uSrcIssuer, STAmount const &dstAmount, std::optional< STAmount > const &srcAmount, std::optional< uint256 > const &domain, Application &app)
	Construct a pathfinder without an issuer.

	Pathfinder (Pathfinder const &)=delete

Pathfinder &	operator= (Pathfinder const &)=delete

	~Pathfinder ()=default

bool	findPaths (int searchLevel, std::function< bool(void)> const &continueCallback={})

void	computePathRanks (int maxPaths, std::function< bool(void)> const &continueCallback={})
	Compute the rankings of the paths.

STPathSet	getBestPaths (int maxPaths, STPath &fullLiquidityPath, STPathSet const &extraPaths, AccountID const &srcIssuer, std::function< bool(void)> const &continueCallback={})

Static Public Member Functions
static void	initPathTable ()

Private Member Functions
STPathSet &	addPathsForType (PathType const &type, std::function< bool(void)> const &continueCallback)

bool	issueMatchesOrigin (Issue const &)

int	getPathsOut (Currency const &currency, AccountID const &account, LineDirection direction, bool isDestCurrency, AccountID const &dest, std::function< bool(void)> const &continueCallback)

void	addLink (STPath const &currentPath, STPathSet &incompletePaths, int addFlags, std::function< bool(void)> const &continueCallback)

void	addLinks (STPathSet const &currentPaths, STPathSet &incompletePaths, int addFlags, std::function< bool(void)> const &continueCallback)

TER	getPathLiquidity (STPath const &path, STAmount const &minDstAmount, STAmount &amountOut, uint64_t &qualityOut) const

bool	isNoRippleOut (STPath const &currentPath)

bool	isNoRipple (AccountID const &fromAccount, AccountID const &toAccount, Currency const &currency)

void	rankPaths (int maxPaths, STPathSet const &paths, std::vector< PathRank > &rankedPaths, std::function< bool(void)> const &continueCallback)

Static Private Member Functions
static auto &	getCounter () noexcept

Private Attributes
AccountID	mSrcAccount

AccountID	mDstAccount

AccountID	mEffectiveDst

STAmount	mDstAmount

Currency	mSrcCurrency

std::optional< AccountID >	mSrcIssuer

STAmount	mSrcAmount

STAmount	mRemainingAmount
	The amount remaining from mSrcAccount after the default liquidity has been removed.

bool	convert_all_

std::optional< uint256 >	mDomain

std::shared_ptr< ReadView const >	mLedger

std::unique_ptr< LoadEvent >	m_loadEvent

std::shared_ptr< RippleLineCache >	mRLCache

STPathElement	mSource

STPathSet	mCompletePaths

std::vector< PathRank >	mPathRanks

std::map< PathType, STPathSet >	mPaths

hash_map< Issue, int >	mPathsOutCountMap

Application &	app_

beast::Journal const	j_

Static Private Attributes
static std::uint32_t const	afADD_ACCOUNTS = 0x001

static std::uint32_t const	afADD_BOOKS = 0x002

static std::uint32_t const	afOB_XRP = 0x010

static std::uint32_t const	afOB_LAST = 0x040

static std::uint32_t const	afAC_LAST = 0x080

Detailed Description

Calculates payment paths.

The RippleCalc determines the quality of the found paths.

See also: RippleCalc

Definition at line 20 of file Pathfinder.h.

Member Typedef Documentation

◆ PathType

using ripple::Pathfinder::PathType = std::vector<NodeType>

Definition at line 76 of file Pathfinder.h.

Member Enumeration Documentation

◆ NodeType

enum ripple::Pathfinder::NodeType

Enumerator
nt_SOURCE
nt_ACCOUNTS
nt_BOOKS
nt_XRP_BOOK
nt_DEST_BOOK
nt_DESTINATION

Definition at line 66 of file Pathfinder.h.

◆ PaymentType

enum ripple::Pathfinder::PaymentType

Enumerator
pt_XRP_to_XRP
pt_XRP_to_nonXRP
pt_nonXRP_to_XRP
pt_nonXRP_to_same
pt_nonXRP_to_nonXRP

Definition at line 80 of file Pathfinder.h.

Constructor & Destructor Documentation

◆ Pathfinder() [1/2]

ripple::Pathfinder::Pathfinder	(	std::shared_ptr< RippleLineCache > const &	cache,
		AccountID const &	srcAccount,
		AccountID const &	dstAccount,
		Currency const &	uSrcCurrency,
		std::optional< AccountID > const &	uSrcIssuer,
		STAmount const &	dstAmount,
		std::optional< STAmount > const &	srcAmount,
		std::optional< uint256 > const &	domain,
		Application &	app
	)

Construct a pathfinder without an issuer.

Definition at line 142 of file Pathfinder.cpp.

◆ Pathfinder() [2/2]

ripple::Pathfinder::Pathfinder ( Pathfinder const & )

delete

◆ ~Pathfinder()

ripple::Pathfinder::~Pathfinder ( )

default

Member Function Documentation

◆ operator=()

Pathfinder & ripple::Pathfinder::operator= ( Pathfinder const & )

delete

◆ initPathTable()

void ripple::Pathfinder::initPathTable ( )

static

Definition at line 1298 of file Pathfinder.cpp.

◆ findPaths()

bool ripple::Pathfinder::findPaths	(	int	searchLevel,
		std::function< bool(void)> const &	continueCallback = `{}`
	)

Definition at line 181 of file Pathfinder.cpp.

◆ computePathRanks()

void ripple::Pathfinder::computePathRanks	(	int	maxPaths,
		std::function< bool(void)> const &	continueCallback = `{}`
	)

Compute the rankings of the paths.

Definition at line 399 of file Pathfinder.cpp.

◆ getBestPaths()

STPathSet ripple::Pathfinder::getBestPaths	(	int	maxPaths,
		STPath &	fullLiquidityPath,
		STPathSet const &	extraPaths,
		AccountID const &	srcIssuer,
		std::function< bool(void)> const &	continueCallback = `{}`
	)

Definition at line 556 of file Pathfinder.cpp.

◆ addPathsForType()

STPathSet & ripple::Pathfinder::addPathsForType	(	PathType const &	type,
		std::function< bool(void)> const &	continueCallback
	)

private

Definition at line 790 of file Pathfinder.cpp.

◆ issueMatchesOrigin()

bool ripple::Pathfinder::issueMatchesOrigin ( Issue const & issue )

private

Definition at line 692 of file Pathfinder.cpp.

◆ getPathsOut()

int ripple::Pathfinder::getPathsOut	(	Currency const &	currency,
		AccountID const &	account,
		LineDirection	direction,
		bool	isDestCurrency,
		AccountID const &	dest,
		std::function< bool(void)> const &	continueCallback
	)

private

Definition at line 703 of file Pathfinder.cpp.

◆ addLink()

void ripple::Pathfinder::addLink	(	STPath const &	currentPath,
		STPathSet &	incompletePaths,
		int	addFlags,
		std::function< bool(void)> const &	continueCallback
	)

private

Definition at line 934 of file Pathfinder.cpp.

◆ addLinks()

void ripple::Pathfinder::addLinks	(	STPathSet const &	currentPaths,
		STPathSet &	incompletePaths,
		int	addFlags,
		std::function< bool(void)> const &	continueCallback
	)

private

Definition at line 773 of file Pathfinder.cpp.

◆ getPathLiquidity()

TER ripple::Pathfinder::getPathLiquidity	(	STPath const &	path,
		STAmount const &	minDstAmount,
		STAmount &	amountOut,
		uint64_t &	qualityOut
	)		const

private

Definition at line 330 of file Pathfinder.cpp.

◆ isNoRippleOut()

bool ripple::Pathfinder::isNoRippleOut ( STPath const & currentPath )

private

Definition at line 899 of file Pathfinder.cpp.

◆ isNoRipple()

bool ripple::Pathfinder::isNoRipple	(	AccountID const &	fromAccount,
		AccountID const &	toAccount,
		Currency const &	currency
	)

private

Definition at line 882 of file Pathfinder.cpp.

◆ rankPaths()

void ripple::Pathfinder::rankPaths	(	int	maxPaths,
		STPathSet const &	paths,
		std::vector< PathRank > &	rankedPaths,
		std::function< bool(void)> const &	continueCallback
	)

private

Definition at line 478 of file Pathfinder.cpp.

◆ getCounter()

static auto & ripple::CountedObject< Pathfinder >::getCounter ( )

staticprivatenoexceptinherited

Definition at line 110 of file CountedObject.h.

Member Data Documentation

◆ mSrcAccount

AccountID ripple::Pathfinder::mSrcAccount

private

Definition at line 179 of file Pathfinder.h.

◆ mDstAccount

AccountID ripple::Pathfinder::mDstAccount

private

Definition at line 180 of file Pathfinder.h.

◆ mEffectiveDst

AccountID ripple::Pathfinder::mEffectiveDst

private

Definition at line 181 of file Pathfinder.h.

◆ mDstAmount

STAmount ripple::Pathfinder::mDstAmount

private

Definition at line 182 of file Pathfinder.h.

◆ mSrcCurrency

Currency ripple::Pathfinder::mSrcCurrency

private

Definition at line 183 of file Pathfinder.h.

◆ mSrcIssuer

std::optional<AccountID> ripple::Pathfinder::mSrcIssuer

private

Definition at line 184 of file Pathfinder.h.

◆ mSrcAmount

STAmount ripple::Pathfinder::mSrcAmount

private

Definition at line 185 of file Pathfinder.h.

◆ mRemainingAmount

STAmount ripple::Pathfinder::mRemainingAmount

private

The amount remaining from mSrcAccount after the default liquidity has been removed.

Definition at line 188 of file Pathfinder.h.

◆ convert_all_

bool ripple::Pathfinder::convert_all_

private

Definition at line 189 of file Pathfinder.h.

◆ mDomain

std::optional<uint256> ripple::Pathfinder::mDomain

private

Definition at line 190 of file Pathfinder.h.

◆ mLedger

std::shared_ptr<ReadView const> ripple::Pathfinder::mLedger

private

Definition at line 192 of file Pathfinder.h.

◆ m_loadEvent

std::unique_ptr<LoadEvent> ripple::Pathfinder::m_loadEvent

private

Definition at line 193 of file Pathfinder.h.

◆ mRLCache

std::shared_ptr<RippleLineCache> ripple::Pathfinder::mRLCache

private

Definition at line 194 of file Pathfinder.h.

◆ mSource

STPathElement ripple::Pathfinder::mSource

private

Definition at line 196 of file Pathfinder.h.

◆ mCompletePaths

STPathSet ripple::Pathfinder::mCompletePaths

private

Definition at line 197 of file Pathfinder.h.

◆ mPathRanks

std::vector<PathRank> ripple::Pathfinder::mPathRanks

private

Definition at line 198 of file Pathfinder.h.

◆ mPaths

std::map<PathType, STPathSet> ripple::Pathfinder::mPaths

private

Definition at line 199 of file Pathfinder.h.

◆ mPathsOutCountMap

hash_map<Issue, int> ripple::Pathfinder::mPathsOutCountMap

private

Definition at line 201 of file Pathfinder.h.

◆ app_

Application& ripple::Pathfinder::app_

private

Definition at line 203 of file Pathfinder.h.

◆ j_

beast::Journal const ripple::Pathfinder::j_

private

Definition at line 204 of file Pathfinder.h.

◆ afADD_ACCOUNTS

std::uint32_t const ripple::Pathfinder::afADD_ACCOUNTS = 0x001

staticprivate

Definition at line 207 of file Pathfinder.h.

◆ afADD_BOOKS

std::uint32_t const ripple::Pathfinder::afADD_BOOKS = 0x002

staticprivate

Definition at line 210 of file Pathfinder.h.

◆ afOB_XRP

std::uint32_t const ripple::Pathfinder::afOB_XRP = 0x010

staticprivate

Definition at line 213 of file Pathfinder.h.

◆ afOB_LAST

std::uint32_t const ripple::Pathfinder::afOB_LAST = 0x040

staticprivate

Definition at line 216 of file Pathfinder.h.

◆ afAC_LAST

std::uint32_t const ripple::Pathfinder::afAC_LAST = 0x080

staticprivate

Definition at line 219 of file Pathfinder.h.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ PathType

Member Enumeration Documentation

◆ NodeType

◆ PaymentType

Constructor & Destructor Documentation

◆ Pathfinder() [1/2]

◆ Pathfinder() [2/2]

◆ ~Pathfinder()

Member Function Documentation

◆ operator=()

◆ initPathTable()

◆ findPaths()

◆ computePathRanks()

◆ getBestPaths()

◆ addPathsForType()

◆ issueMatchesOrigin()

◆ getPathsOut()

◆ addLink()

◆ addLinks()

◆ getPathLiquidity()

◆ isNoRippleOut()

◆ isNoRipple()

◆ rankPaths()

◆ getCounter()

Member Data Documentation

◆ mSrcAccount

◆ mDstAccount

◆ mEffectiveDst

◆ mDstAmount

◆ mSrcCurrency

◆ mSrcIssuer

◆ mSrcAmount

◆ mRemainingAmount

◆ convert_all_

◆ mDomain

◆ mLedger

◆ m_loadEvent

◆ mRLCache

◆ mSource

◆ mCompletePaths

◆ mPathRanks

◆ mPaths

◆ mPathsOutCountMap

◆ app_

◆ j_

◆ afADD_ACCOUNTS

◆ afADD_BOOKS

◆ afOB_XRP

◆ afOB_LAST

◆ afAC_LAST