Class PathStep

One step of one path: where the payment goes next, not the whole route.

Inheritance

object

PathStep

Namespace: Xrpl.Models.Common

Assembly: Xrpl.dll

Syntax

public class PathStep

Remarks

A path set is an array of paths, and a path is an array of these. The nesting reads correctly now that the name does: List<List<PathStep>> is a list of paths, where the old List<List<Path>> read as a list of lists of paths.

Named Path until 11.0.0.0, which collided with System.IO.Path - any file with using Xrpl.Models.Methods; and implicit usings on could not write Path.Combine - and with Xrpl.BinaryCodec.Types.Path, which is a whole path rather than a step, so the same name meant a container in one half of the SDK and its element in the other. Everything around it already said step: PathStepType, Validation.IsPathStep, and xrpl.js, where this is PathStep.

Properties

Account

(Optional) If present, this path step represents rippling through the specified address.
MUST NOT be provided if this step specifies the currency or issuer fields.

Declaration

[JsonPropertyName("account")]
public string Account { get; set; }

Property Value

Type	Description
string

CurrencyCode

(Optional) If present, this path step represents changing currencies through an order book.
The currency specified indicates the new currency.
MUST NOT be provided if this step specifies the account field.
MUST NOT be combined with the mpt_issuance_id field.

Declaration

[JsonPropertyName("currency")]
public string CurrencyCode { get; set; }

Property Value

Type	Description
string

Issuer

(Optional) If present, this path step represents changing currencies and this address defines the issuer of the new currency.
If omitted in a step with a non-XRP currency, a previous step of the path defines the issuer.
If present when currency is omitted, indicates a path step that uses an order book between same-named currencies with different issuers.
MUST be omitted if the currency is XRP.
MUST NOT be provided if this step specifies the account field.

Declaration

[JsonPropertyName("issuer")]
public string Issuer { get; set; }

Property Value

Type	Description
string

MPTokenIssuanceID

(Optional) If present, this path step represents changing assets through an MPT order book.
Requires rippled 3.2.0+ with the MPTokensV2 amendment enabled.
MUST NOT be combined with the currency field.

Declaration

[JsonPropertyName("mpt_issuance_id")]
public string MPTokenIssuanceID { get; set; }

Property Value

Type	Description
string

Type

(Optional) A bitfield indicating which fields are present in this path step.
Serialized as the number rippled sends: 0x01 account, 0x10 currency, 0x20 issuer, 0x40 mpt_issuance_id — a value the enum does not declare is preserved as-is.
The XRPL documentation marks the field as deprecated, but every rippled version still emits it on every path step of every response.
Read-only in practice: the value is ignored both by rippled when it parses a submitted transaction and by the binary codec, which derives the byte from the fields actually present in the step.

Declaration

[JsonPropertyName("type")]
public PathStepType? Type { get; set; }

Property Value

Type	Description
PathStepType?