xrpl
    Preparing search index...

    Interface Vault

    The Vault object type represents a Single Asset Vault instance.

    interface Vault {
        Account: string;
        Asset: Currency;
        AssetsAvailable?: string;
        AssetsMaximum?: string;
        AssetsTotal?: string;
        Data?: string;
        Flags: number;
        index: string;
        LedgerEntryType: "Vault";
        LedgerIndex: string;
        LEVersion?: number;
        LossUnrealized?: string;
        Owner: string;
        OwnerNode: string;
        PreviousTxnID: string;
        PreviousTxnLgrSeq: number;
        RedemptionDate?: number;
        Scale?: number;
        Sequence: number;
        ShareMPTID: string;
        SubscriptionDate?: number;
        VaultKind?: number;
        WithdrawalPolicy: number;
    }

    Hierarchy

    • BaseLedgerEntry
    • HasPreviousTxnID
      • Vault
    Index

    Properties

    Account Asset AssetsAvailable? AssetsMaximum? AssetsTotal? Data? Flags index LedgerEntryType LedgerIndex LEVersion? LossUnrealized? Owner OwnerNode PreviousTxnID PreviousTxnLgrSeq RedemptionDate? Scale? Sequence ShareMPTID SubscriptionDate? VaultKind? WithdrawalPolicy

    Properties

    Account: string

    The address of the Vaults pseudo-account.

    Asset: Currency

    The asset of the vault. The vault supports XRP, IOU and MPT.

    AssetsAvailable?: string

    The asset amount that is available in the vault.

    AssetsMaximum?: string

    The maximum asset amount that can be held in the vault. Zero value 0 indicates there is no cap.

    AssetsTotal?: string

    The total value of the vault.

    Data?: string

    Arbitrary metadata about the Vault. Limited to 256 bytes.

    Flags: number

    A bit-map of boolean flags.

    index: string
    LedgerEntryType: "Vault"
    LedgerIndex: string

    Ledger object identifier.

    LEVersion?: number

    (LendingProtocolV1_1) The internal version of the ledger object's structure.

    LossUnrealized?: string

    The potential loss amount that is not yet realized expressed as the vaults asset.

    Owner: string

    The account address of the Vault Owner.

    OwnerNode: string

    Identifies the page where this item is referenced in the owner's directory.

    PreviousTxnID: string

    The identifying hash of the transaction that most recently modified this object.

    PreviousTxnLgrSeq: number

    The index of the ledger that contains the transaction that most recently modified this object.

    RedemptionDate?: number

    (LendingProtocolV1_1, close-ended vaults only) The time, in seconds since the Ripple Epoch, at which shares may begin to be redeemed from the Vault.

    Scale?: number

    The scaling factor for vault shares. Only applicable for IOU assets. Valid values are between 0 and 18 inclusive. For XRP and MPT, this is always 0.

    Sequence: number

    The transaction sequence number that created the vault.

    ShareMPTID: string

    The identifier of the share MPTokenIssuance object.

    SubscriptionDate?: number

    (LendingProtocolV1_1, close-ended vaults only) The time, in seconds since the Ripple Epoch, up to which deposits into the Vault are accepted.

    VaultKind?: number

    (LendingProtocolV1_1) The kind of Vault: 0 for an open-ended vault or 1 for a close-ended vault.

    WithdrawalPolicy: number

    Indicates the withdrawal strategy used by the Vault.

    Settings

    Member Visibility

    On This Page

    Properties