Class PaymentFlowResult
What a Payment would do, as PaymentFlow computes it.
Inheritance
Namespace: Xrpl.Amounts
Assembly: Xrpl.dll
Syntax
public sealed class PaymentFlowResult
Properties
| Edit this page View SourceApplied
Whether the transaction reaches a ledger and its fee is charged: tes and tec results.
Declaration
public bool Applied { get; }
Property Value
| Type | Description |
|---|---|
| bool |
BalanceChanges
How every account's balances moved, the fee included, as the metadata will record them.
Declaration
public IReadOnlyList<BalanceChange> BalanceChanges { get; }
Property Value
| Type | Description |
|---|---|
| IReadOnlyList<BalanceChange> |
DeliveredAmount
What the destination received (delivered_amount); null unless the payment succeeds.
Declaration
public XrplAmount? DeliveredAmount { get; }
Property Value
| Type | Description |
|---|---|
| XrplAmount? |
EngineResult
The node's result, such as tesSUCCESS, tecPATH_PARTIAL, tecPATH_DRY or a tem code.
Declaration
public string EngineResult { get; }
Property Value
| Type | Description |
|---|---|
| string |
Fills
The offers and pool slices the engine took, in the order it took them: pass by pass, and within a pass by the position of the book in the strand. Empty when the transaction fails, since nothing it took stays.
Declaration
public IReadOnlyList<OfferFill> Fills { get; }
Property Value
| Type | Description |
|---|---|
| IReadOnlyList<OfferFill> |
MpTokens
The MPTokens the payment created: an offer owner's, paid an MPT it held none of.
Declaration
public IReadOnlyList<MpTokenChange> MpTokens { get; }
Property Value
| Type | Description |
|---|---|
| IReadOnlyList<MpTokenChange> |
NeedsDeeperBooks
Whether the engine walked past the last offer the snapshot read of a book it holds only in part (PartialBooks): the node may cross offers the snapshot does not have, so the result is exact only once the snapshot is read deeper.
Declaration
public bool NeedsDeeperBooks { get; }
Property Value
| Type | Description |
|---|---|
| bool |
Offers
The snapshot's offers that were crossed or removed.
Declaration
public IReadOnlyList<OfferChange> Offers { get; }
Property Value
| Type | Description |
|---|---|
| IReadOnlyList<OfferChange> |
Paid
What the sender spent in the SendMax asset, transfer fees included; null unless the payment succeeds.
Declaration
public XrplAmount? Paid { get; }
Property Value
| Type | Description |
|---|---|
| XrplAmount? |
Passes
Every strand the engine tried, pass by pass, and how it fared - including the passes of a transaction that failed, which say why it found no liquidity.
Declaration
public IReadOnlyList<FlowPass> Passes { get; }
Property Value
| Type | Description |
|---|---|
| IReadOnlyList<FlowPass> |
Pools
The AMM pools the payment went through.
Declaration
public IReadOnlyList<AmmPoolChange> Pools { get; }
Property Value
| Type | Description |
|---|---|
| IReadOnlyList<AmmPoolChange> |
SnapshotAfter
The snapshot as the payment leaves it, to evaluate the next transaction against: the
balances after the fee and the payment, the sender's Sequence moved on (or its
ticket consumed), owner counts, trust lines created and deleted, offers crossed or
removed, the pools' and MPTs' balances, and the destination account when the payment
creates it. The evaluated snapshot itself when the payment is not Applied.
Declaration
public DexSnapshot SnapshotAfter { get; }
Property Value
| Type | Description |
|---|---|
| DexSnapshot |
Remarks
Built on first read. Its index is derived from the evaluated snapshot's, so evaluating
against it costs little more than evaluating against the evaluated snapshot again. It
is only as complete as that snapshot: what it does not hold, the payment cannot write
back. rippled gives a created account the sequence of the ledger it lands in, which is not known
offline: it is taken to be the ledger after LedgerSequence, the earliest
a transaction submitted after the read can land in.
The transaction's Sequence is taken as given: the engine does not check it
against the account's, as the node does with tefPAST_SEQ and terPRE_SEQ.
TrustLines
The trust lines the payment created or deleted.
Declaration
public IReadOnlyList<TrustLineChange> TrustLines { get; }
Property Value
| Type | Description |
|---|---|
| IReadOnlyList<TrustLineChange> |