Class VaultCreateResponse

The VaultCreate transaction creates a new Vault ledger object for holding pooled assets.

Inheritance
object
BaseTransactionResponse
TransactionResponse
VaultCreateResponse
Implements
Inherited Members
Namespace: Xrpl.Models.Transactions
Assembly: Xrpl.dll
Syntax
public class VaultCreateResponse : TransactionResponse, ITransactionResponse, IBaseTransactionResponse, IVaultCreate, ITransactionCommon
Remarks

Requires the Vault amendment (XLS-65d). This feature is in draft and subject to change.

Properties

| Edit this page View Source

Amount

The initial deposit amount.

Declaration
[JsonPropertyName("Amount")]
public Currency Amount { get; set; }
Property Value
Type Description
Currency
| Edit this page View Source

Asset

The asset held by the vault.

Declaration
[JsonPropertyName("Asset")]
[JsonConverter(typeof(IssuedCurrencyConverter))]
public Common.IssuedCurrency Asset { get; set; }
Property Value
Type Description
Common.IssuedCurrency
| Edit this page View Source

AssetsMaximum

The maximum asset amount that can be held in the vault. STNumber type (12 bytes: int64 mantissa + int32 exponent), serialized as string in JSON.

Declaration
[JsonPropertyName("AssetsMaximum")]
public string AssetsMaximum { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Data

Arbitrary hex-encoded data associated with the vault, limited to 256 bytes.

Declaration
[JsonPropertyName("Data")]
public string Data { get; set; }
Property Value
Type Description
string
| Edit this page View Source

DomainID

The ID of a permissioned domain to associate with the vault.

Declaration
[JsonPropertyName("DomainID")]
public string DomainID { get; set; }
Property Value
Type Description
string
| Edit this page View Source

MPTokenMetadata

Arbitrary metadata for the vault shares (MPToken), limited in size. Hex-encoded string.

Declaration
[JsonPropertyName("MPTokenMetadata")]
public string MPTokenMetadata { get; set; }
Property Value
Type Description
string
| Edit this page View Source

RedemptionDate

LendingProtocolV1_1: the start of a closed-ended vault's redemption phase. Fixed at creation, and must lie at least three minutes and less than thirty years after SubscriptionDate. Serialized as seconds since the Ripple Epoch.

Declaration
[JsonPropertyName("RedemptionDate")]
[JsonConverter(typeof(RippleDateTimeConverter))]
public DateTime? RedemptionDate { get; set; }
Property Value
Type Description
Nullable
| Edit this page View Source

Scale

The scale (decimal precision) for the vault shares.

Declaration
[JsonPropertyName("Scale")]
public uint? Scale { get; set; }
Property Value
Type Description
uint?
| Edit this page View Source

SubscriptionDate

LendingProtocolV1_1: the end of a closed-ended vault's subscription phase, after which its investment phase begins. Fixed at creation. Serialized as seconds since the Ripple Epoch.

Declaration
[JsonPropertyName("SubscriptionDate")]
[JsonConverter(typeof(RippleDateTimeConverter))]
public DateTime? SubscriptionDate { get; set; }
Property Value
Type Description
Nullable
| Edit this page View Source

VaultKind

LendingProtocolV1_1: the kind of vault, see VaultKind. Absent means open-ended. ClosedEnded requires both SubscriptionDate and RedemptionDate; an open-ended vault may carry neither.

Declaration
[JsonPropertyName("VaultKind")]
public uint? VaultKind { get; set; }
Property Value
Type Description
uint?
| Edit this page View Source

WithdrawalPolicy

The withdrawal policy for the vault. Defines how withdrawals are handled.

Declaration
[JsonPropertyName("WithdrawalPolicy")]
public uint? WithdrawalPolicy { get; set; }
Property Value
Type Description
uint?

Implements