Namespace Xrpl.Sugar
Classes
AddressNTag
AmmLiquidity
AMM deposits and withdrawals computed exactly, the way rippled's AMMDeposit and
AMMWithdraw compute them under fixAMMv1_3: the LP tokens a deposit issues, the
assets a withdrawal pays, and the refusals the amounts lead to.
AmmMath
What an AMM pool will do before you ask it to - what a deposit is worth in LP tokens, what a withdrawal costs, what a swap pays out, and each of those read backwards - computed the way rippled computes it.
AmmOutcome
What an AMMDeposit or AMMWithdraw did to the sending account, read from the
metadata.
AmmPool
An AMM pool's state as amm_info reports it: the two assets, the balances the AMM
account holds, the LP token balance and the trading fee.
AmmQuote
What an AMM deposit or withdrawal would move, or why the node would refuse it. Amounts are in each asset's own unit - drops for XRP - and always positive.
AutofillSugar
Balance
BalancesSugar
ComposeSugar
Ledger-driven signature composition (#43): routes portable multisig Signer entries into tx.Signers, SponsorSignature.Signers or CounterpartySignature.Signers by looking up the SignerLists of the transaction's Account, Sponsor and (for LoanSet) Counterparty.
DexQuoteSugar
Quotes for payments and offers, computed by the local payment engine against the node's last validated ledger: a DexSnapshot read from the node, then PaymentFlow or OfferCreateCrossing run on it.
DomainAccessResult
Result of a permissioned domain access check.
DomainAccessSugar
DomainCredentialStatus
Status of a single credential held by the account that matches one of the domain's accepted (issuer, credential_type) pairs but is not currently valid.
GetBalancesOptions
GetFeeXrpSugar
GetLedgerSugar
GetOrderBookSugar
LedgerRules
The amendments that change how rippled computes lending, vault and AMM amounts: which
Number rounding the ledger uses and which fixes apply. Defaults are the newest rules.
LedgerSequenceHelper
LoanAmountPayment
What a regular LoanPay does with its Amount: see
PaymentForAmount(LOLoan, IssuedCurrency, ushort, XrplNumber, DateTime, bool, LedgerRules).
LoanBrokerCover
A loan broker's first-loss cover computed offline from the LoanBroker and Vault
entries, the way rippled's LoanBrokerCoverDeposit, LoanBrokerCoverWithdraw,
LoanBrokerCoverClawback and minimumBrokerCover compute it.
LoanBrokerCoverOutcome
What a LoanBrokerCoverDeposit, LoanBrokerCoverWithdraw or
LoanBrokerCoverClawback did to the broker's first-loss cover, read from its metadata -
of a validated transaction, or of a simulate run
(PreviewLoanBrokerCoverDeposit(IXrplClient, LoanBrokerCoverDeposit, LedgerRules, CancellationToken),
PreviewLoanBrokerCoverWithdraw(IXrplClient, LoanBrokerCoverWithdraw, LedgerRules, CancellationToken),
PreviewLoanBrokerCoverClawback(IXrplClient, LoanBrokerCoverClawback, LedgerRules, CancellationToken)).
LoanBrokerCoverQuote
What a change to a loan broker's first-loss cover would do, or why the node would refuse it:
the result of LoanBrokerCover. Amounts are in the vault asset's own unit - drops
for XRP - as the LoanBroker fields are.
LoanManageAvailability
Which LoanManage actions an account may take on a loan at a given time: the result of
Availability(LOLoan, LOLoanBroker, string, DateTime, LedgerRules).
LoanManageCheck
Whether one LoanManage action is allowed now, and from when its time condition holds:
part of LoanManageAvailability.
LoanManageOutcome
What a LoanManage did to the loan, its vault and its broker, read from its metadata - of
a validated transaction, or of a simulate run (PreviewLoanManage(IXrplClient, LoanManage, CancellationToken)).
Compare it with the LoanManageQuote shown before signing.
LoanManageQuote
What a LoanManage would do to the vault, the broker and the loan, or why the node would
refuse it: the result of Impair(LOLoan, LOVault, DateTime, LedgerRules, ulong?), Unimpair(LOLoan, LOVault, DateTime, LedgerRules, ulong?)
and Default(LOLoan, LOLoanBroker, LOVault, LedgerRules, DateTime?, ulong?). Amounts are in the vault asset's own unit - drops for
XRP - as the Vault and LoanBroker fields are.
LoanManagement
A loan broker's LoanManage computed offline from the Loan, LoanBroker and
Vault entries, the way rippled 3.4.1's LoanManage transactor and
loanVaultExposure compute it: when impairing, unimpairing and defaulting a loan is
allowed, and what each does to the vault, the broker's cover and the depositors' share value.
LoanOrigination
The terms of a loan before LoanSet, computed offline from the transaction and the
vault and broker entries, the way rippled's LoanSet and computeLoanProperties
compute them.
LoanOriginationTerms
The terms a LoanSet would give a loan, or why the node would refuse them: the result of
Compute(LoanSet, LOVault, LOLoanBroker, DateTime?, LedgerRules).
LoanPaymentDue
What a loan payment costs and where the money goes, as rippled splits it. Amounts are in the loan asset's own unit - drops for XRP - and compare directly with LoanPaymentOutcome.
LoanPaymentOutcome
What a LoanPay did, read from its metadata - of a validated transaction, or of a
simulate run (PreviewLoanPay(IXrplClient, LoanPay, CancellationToken)).
LoanPayments
What a Loan entry says about the next payment, without asking the node.
LoanSchedule
Projects the regular payments of a loan from its current Loan entry.
LoanScheduleRow
One regular payment of a LoanSchedule. Amounts are in the loan asset's own unit, drops for XRP.
LoanSetOutcome
The loan a LoanSet created, read from its metadata - of a validated transaction, or of a
simulate run (PreviewLoanSet(IXrplClient, LoanSet, CancellationToken)).
PaymentQuote
A payment quoted against the ledger, and what it would do.
PreviewSugar
Previews transactions through simulate. The node runs the transaction against the
current open ledger and discards it, so the numbers are the ones it would apply - rounding,
interest and fees included - as long as nothing else changes the ledger in between.
SubmitSugar
TransactionPreview<TOutcome>
The result of running a transaction through simulate: what the node would do with it,
without submitting it.
Utils
VaultOutcome
What a VaultDeposit, VaultWithdraw or VaultClawback did to the vault
and to the account that sent it, read from the metadata.
VaultQuote
What a vault deposit or withdrawal would move, or why the node would refuse it: the result of VaultShares. Assets are in the vault asset's own unit - drops for XRP - and shares in whole units of the vault's share MPT.
VaultShares
Vault deposits and withdrawals computed offline from the Vault entry and its share
issuance, the way rippled's VaultDeposit, VaultWithdraw and
VaultHelpers.cpp compute them.
Enums
DomainAccessScope
Which of rippled's two domain checks a GetDomainAccess(IXrplClient, string, string, CancellationToken) call applies.
LoanManageAction
What a LoanManage does to the loan, by the flag it carries.
VaultPhase
The phase of a closed-ended vault (XLS-65 under LendingProtocolV1_1), as
PhaseAt(LOVault, DateTime?, LedgerRules) returns it.