Show / Hide Table of Contents

Class PathFindRequest

What to find paths for, as ripple_path_find takes it.

Inheritance
object
PathFindRequest
Namespace: Xrpl.Amounts
Assembly: Xrpl.dll
Syntax
public sealed class PathFindRequest

Properties

| Edit this page View Source

DestinationAccount

The receiving account.

Declaration
public string DestinationAccount { get; init; }
Property Value
Type Description
string
| Edit this page View Source

DestinationAmount

What to deliver. Minus one of an asset ("-1") asks for as much as possible, which SendMax then limits.

Declaration
public XrplAmount DestinationAmount { get; init; }
Property Value
Type Description
XrplAmount
| Edit this page View Source

DomainId

The permissioned domain whose books to use; null for the open books.

Declaration
public string DomainId { get; init; }
Property Value
Type Description
string
| Edit this page View Source

SearchLevel

How deep to search: 2 is the node's default, 7 its slow search, 10 the deepest.

Declaration
public int SearchLevel { get; init; }
Property Value
Type Description
int
| Edit this page View Source

SendMax

The most to spend; only with a destination amount of minus one.

Declaration
public XrplAmount? SendMax { get; init; }
Property Value
Type Description
XrplAmount?
| Edit this page View Source

SourceAccount

The paying account.

Declaration
public string SourceAccount { get; init; }
Property Value
Type Description
string
| Edit this page View Source

SourceCurrencies

The assets the source may pay in, at most 18; an issued currency without an issuer means any issuer the source holds, and an MPT is named by its issuance ID alone. When empty, every asset the source can send is tried, the MPTs it issues or holds among them.

Declaration
public IReadOnlyList<Common.IssuedCurrency> SourceCurrencies { get; init; }
Property Value
Type Description
IReadOnlyList<Common.IssuedCurrency>
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX