Class 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.
Inheritance
Namespace: Xrpl.Sugar
Assembly: Xrpl.dll
Syntax
public sealed class LoanManageOutcome
Remarks
Amounts are in the vault asset's own unit - drops for XRP - as the Vault and
LoanBroker fields are. A change is final less previous, so a default makes
AssetsTotalChange negative and AssetsAvailableChange positive. An
entry the transaction did not modify - the broker on an impairment - changes by zero and has
no "after" entry. A LoanManage without an action flag changes no balance, but under
fixCleanup3_1_3 it still associates the loan, broker and vault with the vault asset,
which rounds their amount fields to it; a field that rounding moves shows up as a small change.
Properties
| Edit this page View SourceAction
The action the transaction's flags select.
Declaration
public LoanManageAction Action { get; init; }
Property Value
| Type | Description |
|---|---|
| LoanManageAction |
AssetsAvailableChange
The change in the vault's AssetsAvailable: the cover a default pays in.
Declaration
public decimal AssetsAvailableChange { get; init; }
Property Value
| Type | Description |
|---|---|
| decimal |
AssetsTotalChange
The change in the vault's AssetsTotal: minus the loss a default realizes.
Declaration
public decimal AssetsTotalChange { get; init; }
Property Value
| Type | Description |
|---|---|
| decimal |
BrokerAfter
The LoanBroker as the transaction left it; null when the metadata does not modify it.
Declaration
public LOLoanBroker BrokerAfter { get; init; }
Property Value
| Type | Description |
|---|---|
| LOLoanBroker |
CoverAvailableChange
The change in the broker's CoverAvailable: minus the cover a default pays to the vault.
Declaration
public decimal CoverAvailableChange { get; init; }
Property Value
| Type | Description |
|---|---|
| decimal |
DebtTotalChange
The change in the broker's DebtTotal: minus the exposure on a default.
Declaration
public decimal DebtTotalChange { get; init; }
Property Value
| Type | Description |
|---|---|
| decimal |
IsDefaulted
Whether the loan is in default after the transaction.
Declaration
public bool IsDefaulted { get; }
Property Value
| Type | Description |
|---|---|
| bool |
IsImpaired
Whether the loan is impaired after the transaction.
Declaration
public bool IsImpaired { get; }
Property Value
| Type | Description |
|---|---|
| bool |
LoanAfter
The Loan as the transaction left it; null when the metadata does not modify it.
Declaration
public LOLoan LoanAfter { get; init; }
Property Value
| Type | Description |
|---|---|
| LOLoan |
LoanFlagsAfter
The loan's flags after the transaction; null when the metadata does not modify the loan.
Declaration
public LoanFlags? LoanFlagsAfter { get; init; }
Property Value
| Type | Description |
|---|---|
| LoanFlags? |
LoanId
The managed loan's ledger index.
Declaration
public string LoanId { get; init; }
Property Value
| Type | Description |
|---|---|
| string |
LossUnrealizedChange
The change in the vault's LossUnrealized: the exposure an impairment books or an unimpairment or a default of an impaired loan takes back.
Declaration
public decimal LossUnrealizedChange { get; init; }
Property Value
| Type | Description |
|---|---|
| decimal |
VaultAfter
The Vault as the transaction left it; null when the metadata does not modify it.
Declaration
public LOVault VaultAfter { get; init; }
Property Value
| Type | Description |
|---|---|
| LOVault |
Methods
| Edit this page View SourceFromMetadata(ILoanManage, ITransactionMetadata)
Reads the outcome of transaction from its metadata.
Declaration
public static LoanManageOutcome FromMetadata(ILoanManage transaction, ITransactionMetadata metadata)
Parameters
| Type | Name | Description |
|---|---|---|
| ILoanManage | transaction | |
| ITransactionMetadata | metadata |
Returns
| Type | Description |
|---|---|
| LoanManageOutcome |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The transaction impairs, unimpairs or defaults the loan, and the metadata does not modify it: the transaction did not apply, or the metadata belongs to another transaction. |