Show / Hide Table of Contents

Namespace Xrpl.Amounts

Classes

AmmOfferMath

The arithmetic of an AMM pool's synthetic offer, as rippled's payment engine does it: the swap formulas and the offer a pool puts beside an order book, with rippled's Number rounding.

AmmPoolChange

An AMM pool's balances after the crossing.

BalanceChange

How one account's balance of one asset moved.

BookIndex

A set of order books - each a pair of assets, in the open book or a domain - built from a whole ledger, from a list of assets, or from the trust lines of the accounts involved.

DexAccount

An account as the crossing reads it: its XRP, its reserve and, for an issuer, its settings.

DexAmmPool

An AMM pool as the payment engine reads it.

DexBook

A book: the asset its offers ask for and the asset they give, in a domain or the open book.

DexCredential

A credential an account holds.

DexCredentialType

A kind of credential: who issues it and its type.

DexDomain

A permissioned domain: its owner, and the credentials that make an account a member.

DexMptHolding

An account's holding of an MPT (MPToken).

DexMptIssuance

An MPT issuance (MPTokenIssuance) as the engine reads it.

DexOffer

An offer in a book.

DexSnapshot

The ledger state an OfferCreate crosses against: the offers in the books it can reach, the AMM pools on those books, and what the accounts involved hold. A crossing computed by OfferCreateCrossing is exact against this state; it is only as current as the state is.

DexSnapshotOptions

How DexSnapshot's FromNodeAsync reads the books.

DexTrustLine

A trust line, described from one of its two accounts: Account and the peer named by the currency's issuer in Balance. Each side's settings are given for that side; the Peer properties belong to the other account.

FlowPass

One strand tried in one pass of the engine.

LedgerAmountGrid

The amounts the ledger can hold, and how to land on one.

MpTokenChange

An MPToken the transaction created: an account paid an MPT it held none of.

OfferChange

An offer after the crossing.

OfferCreateCrossing

An OfferCreate crossed locally against a DexSnapshot, the way rippled 3.4.1's payment engine crosses it: every offer of the book in quality order, the AMM pool interleaved with them, the auto-bridge through XRP when neither side is XRP, and the result the node would return.

OfferCrossing

What one offer contributes when a payment or an OfferCreate crosses it, sized the way rippled's BookStep sizes it: the offer's funding, transfer fees in and out, and the cut to an input or output limit, each rounded as the node rounds it.

OfferCrossingResult

What an OfferCreate would do, as OfferCreateCrossing computes it.

OfferFill

One offer, or one slice of an AMM pool, the engine took. The fills of a result are in the order the engine took them: pass by pass, and within a pass by the position of the book in the strand, each book's in the order the book gave them.

OfferStep

What one offer contributes to a step of a payment or an offer crossing.

PathFindAlternative

One way to make the payment: from one source asset, along up to four paths and the default one.

PathFindRequest

What to find paths for, as ripple_path_find takes it.

PathFindResult

What a path search found, as ripple_path_find returns it.

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.

PathfindingSource

The ledger a path search reads: accounts, their trust lines in the order the ledger keeps them, the MPTs they issue and hold, the index of order books, and the state the payment engine needs to rank the paths it finds. Built from a DexSnapshot or read from a node at one ledger.

PaymentFlow

A Payment computed locally against a DexSnapshot, the way rippled 3.4.1 applies it: its paths turned into strands of trust lines, order books and AMM pools, run by the payment engine with SendMax, DeliverMin, partial payment and the limit quality, and the result the node would return.

PaymentFlowResult

What a Payment would do, as PaymentFlow computes it.

TrustLineChange

A trust line the transaction created or deleted.

XrplAmountMath

rippled's STAmount arithmetic on XrplAmount, bit for bit: addition, multiply, divide, and the directed rounding mulRound / divRound that offer crossing uses, in both their legacy and strict forms.

Structs

AmmPoolOffer

The synthetic offer an AMM pool puts beside an order book.

XrplAmount

An amount of one asset, held the way rippled's STAmount holds it: XRP as a whole number of drops, an MPT as a whole number of units, an issued currency as a 16-digit mantissa with an exponent from -96 to 80. The whole range of the ledger is representable.

XrplQuality

rippled's Quality: the exchange rate of an offer, in / out, in the 64-bit encoding the ledger sorts order books by - the exponent plus 100 in the top byte, the 16-digit mantissa below it.

Interfaces

IBookIndex

Which order books exist, as the path finder asks: the books an asset can be sold into. rippled keeps this index (OrderBookDB) for the whole ledger; a client supplies it.

Enums

AmountKind

What an amount holds, which decides how rippled's STAmount rounds it.

FlowPassOutcome

How one strand fared in one pass of the engine.

OfferRemovalReason

Why an offer left the ledger during a crossing or a payment.

In this article
Back to top Generated by DocFX