Interface VaultInfoResponse

Type Declaration

• Optionalledger_current_index?: number

  The ledger index of the current in-progress ledger, which was used when retrieving this information. May be omitted.

• Optionalledger_hash?: string

  The identifying hash of the ledger that was used to generate this response.

• Optionalledger_index?: number

  The ledger index of the ledger version that was used to generate this response.

• Optionalvalidated?: boolean

  If included and set to true, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change.

• vault: {
      Account: string;
      Asset: Currency;
      AssetsAvailable?: string;
      AssetsMaximum?: string;
      AssetsTotal?: string;
      Data?: string;
      Flags: number;
      index: string;
      LedgerEntryType: "Vault";
      LossUnrealized?: string;
      Owner: string;
      OwnerNode: string;
      PreviousTxnID: string;
      PreviousTxnLgrSeq: number;
      Scale?: number;
      Sequence: number;
      ShareMPTID: string;
      shares: {
          AssetScale?: number;
          DomainID?: string;
          Flags: number;
          index: string;
          Issuer: string;
          LedgerEntryType: string;
          LockedAmount?: string;
          MaximumAmount?: string;
          mpt_issuance_id?: string;
          MPTokenMetadata?: string;
          OutstandingAmount: string;
          OwnerNode: string;
          PreviousTxnID: string;
          PreviousTxnLgrSeq: number;
          ReferenceHolding?: string;
          Sequence: number;
          TransferFee?: number;
      };
      WithdrawalPolicy: number;
  }

  • Account: string

    The pseudo-account ID of the vault.

  • Asset: Currency

    Object representing the asset held in the vault.

  • OptionalAssetsAvailable?: string

    Amount of assets currently available for withdrawal.

  • OptionalAssetsMaximum?: string

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

  • OptionalAssetsTotal?: string

    Total amount of assets in the vault.

  • OptionalData?: string

    Arbitrary metadata about the Vault. Limited to 256 bytes.

  • Flags: number

    Flags

  • index: string

    Unique index of the vault ledger entry.

  • LedgerEntryType: "Vault"

    Ledger entry type, always "Vault".

  • OptionalLossUnrealized?: string

    Unrealized loss associated with the vault.

  • Owner: string

    ID of the Vault Owner account.

  • OwnerNode: string

    Identifier for the owner node in the ledger tree.

  • PreviousTxnID: string

    Transaction ID of the last modification to this vault.

  • PreviousTxnLgrSeq: number

    Ledger sequence number of the last transaction modifying this vault.

  • OptionalScale?: 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

    Sequence number of the vault entry.

  • ShareMPTID: string

    Multi-purpose token ID associated with this vault.

  • shares: {
        AssetScale?: number;
        DomainID?: string;
        Flags: number;
        index: string;
        Issuer: string;
        LedgerEntryType: string;
        LockedAmount?: string;
        MaximumAmount?: string;
        mpt_issuance_id?: string;
        MPTokenMetadata?: string;
        OutstandingAmount: string;
        OwnerNode: string;
        PreviousTxnID: string;
        PreviousTxnLgrSeq: number;
        ReferenceHolding?: string;
        Sequence: number;
        TransferFee?: number;
    }

    Object containing details about issued shares.

    • OptionalAssetScale?: number

      An asset scale is a non-negative integer (0, 1, 2, ...) such that one MPT unit equals 10^(-scale) of a corresponding standard unit.

    • OptionalDomainID?: string

      The PermissionedDomain object ID associated with the shares of this Vault.

    • Flags: number

      Bit-field flags associated with the shares issuance.

    • index: string

      Unique index of the shares ledger entry.

    • Issuer: string

      The ID of the Issuer of the Share. It will always be the pseudo-account ID.

    • LedgerEntryType: string

      Ledger entry type, always "MPTokenIssuance".

    • OptionalLockedAmount?: string

      The total amount of this MPT that is currently locked across all holders via Escrow or PaymentChannel.

    • OptionalMaximumAmount?: string

      An unsigned 64-bit number that specifies the maximum number of MPTs that can be distributed to non-issuing accounts (i.e., minted).

    • Optionalmpt_issuance_id?: string

      The ID of the MPTokenIssuance object. It will always be equal to vault.ShareMPTID.

    • OptionalMPTokenMetadata?: string

      Arbitrary metadata about this issuance, in hex format. The limit for this field is 1024 bytes.

    • OutstandingAmount: string

      Total outstanding shares issued.

    • OwnerNode: string

      Identifier for the owner node of the shares.

    • PreviousTxnID: string

      Transaction ID of the last modification to the shares issuance.

    • PreviousTxnLgrSeq: number

      Ledger sequence number of the last transaction modifying the shares issuance.

    • OptionalReferenceHolding?: string

      Hash256 pointing to the vault pseudo-account's holding for the underlying asset. Present for IOU and MPT-backed vaults. Absent for XRP-backed vaults.

    • Sequence: number

      Sequence number of the shares issuance entry.

    • OptionalTransferFee?: number

      This value specifies the fee, in tenths of a basis point, charged by the issuer for secondary sales of the token. Valid values are between 0 and 50,000 inclusive.

  • WithdrawalPolicy: number

    Policy defining withdrawal conditions.