Class VaultOutcome
What a VaultDeposit, VaultWithdraw or VaultClawback did to the vault
and to the account that sent it, read from the metadata.
Inheritance
Namespace: Xrpl.Sugar
Assembly: Xrpl.dll
Syntax
public sealed class VaultOutcome
Remarks
Asset amounts are in the vault asset's own unit (drops for XRP); share amounts are whole
shares of the vault's ShareMPTID. Changes are signed from the named party's side:
a deposit makes AccountAssetChange negative and AccountShareChange
positive.
Properties
| Edit this page View SourceAccountAssetChange
The change in the sending account's asset balance, the transaction fee excluded. Zero on a
withdrawal paid to another Destination.
Declaration
public decimal AccountAssetChange { get; init; }
Property Value
| Type | Description |
|---|---|
| decimal |
AccountShareChange
The change in the sending account's shares.
Declaration
public decimal AccountShareChange { get; init; }
Property Value
| Type | Description |
|---|---|
| decimal |
Asset
The vault asset.
Declaration
public Common.IssuedCurrency Asset { get; init; }
Property Value
| Type | Description |
|---|---|
| Common.IssuedCurrency |
ShareMptId
The vault's share issuance.
Declaration
public string ShareMptId { get; init; }
Property Value
| Type | Description |
|---|---|
| string |
VaultAfter
The Vault as the transaction left it.
Declaration
public LOVault VaultAfter { get; init; }
Property Value
| Type | Description |
|---|---|
| LOVault |
VaultAssetChange
The change in the assets the vault holds.
Declaration
public decimal VaultAssetChange { get; init; }
Property Value
| Type | Description |
|---|---|
| decimal |
VaultId
The vault's ledger index.
Declaration
public string VaultId { get; init; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
| Edit this page View SourceFromMetadata(ITransactionCommon, ITransactionMetadata)
Reads the outcome of transaction from its metadata.
Declaration
public static VaultOutcome FromMetadata(ITransactionCommon transaction, ITransactionMetadata metadata)
Parameters
| Type | Name | Description |
|---|---|---|
| ITransactionCommon | transaction | |
| ITransactionMetadata | metadata |
Returns
| Type | Description |
|---|---|
| VaultOutcome |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The transaction is not a vault deposit, withdrawal or clawback, or the metadata does not modify its vault. |