Show / Hide Table of Contents

Class PathFinding

Payment paths found locally, as rippled 3.4.1's ripple_path_find finds them: its PathRequest and Pathfinder over a PathfindingSource, each path ranked with the payment engine, and the cost of the best ones computed.

Inheritance
object
PathFinding
Namespace: Xrpl.Amounts
Assembly: Xrpl.dll
Syntax
public static class PathFinding
Remarks

Against the same ledger and the same order books, the result matches the node's but for the order of the alternatives and of equally good books, which the node keeps in hash sets. The node's index keeps books whose last offer is gone until it rebuilds; an index read from the ledger does not, which can change which accounts are tried first when an account has more than ten ways on.

Fields

| Edit this page View Source

MaxPaths

The paths an alternative carries, the default one aside (PathRequest::kMaxPaths).

Declaration
public const int MaxPaths = 4
Field Value
Type Description
int

Methods

| Edit this page View Source

FindAsync(PathfindingSource, PathFindRequest, LedgerRules, CancellationToken)

Finds the paths of request in source.

Declaration
public static Task<PathFindResult> FindAsync(PathfindingSource source, PathFindRequest request, LedgerRules rules = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PathfindingSource source

The ledger to search.

PathFindRequest request

What to pay.

LedgerRules rules

The amendments in force; the current rules when null.

CancellationToken cancellationToken

Cancels the search and the reads under it.

Returns
Type Description
Task<PathFindResult>
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX