Interface VaultInfoResponse

Type declaration

• 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;
      AssetsTotal: string;
      Flags?: number;
      index: string;
      LedgerEntryType: "Vault";
      LossUnrealized?: string;
      Owner: string;
      OwnerNode?: string;
      PreviousTxnID: string;
      PreviousTxnLgrSeq: number;
      Sequence: number;
      ShareMPTID?: string;
      shares: {
          DomainID?: string;
          Flags?: number;
          index: string;
          Issuer: string;
          LedgerEntryType: string;
          mpt_issuance_id?: string;
          OutstandingAmount: string;
          OwnerNode?: string;
          PreviousTxnID: string;
          PreviousTxnLgrSeq: number;
          Sequence: number;
      };
      WithdrawalPolicy?: number;
  }

  • Account: string

    The pseudo-account ID of the vault.

  • Asset: Currency

    Object representing the asset held in the vault.

  • AssetsAvailable: string

    Amount of assets currently available for withdrawal.

  • AssetsTotal: string

    Total amount of assets in the vault.

  • OptionalFlags?: 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.

  • OptionalOwnerNode?: 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.

  • Sequence: number

    Sequence number of the vault entry.

  • OptionalShareMPTID?: string

    Multi-purpose token ID associated with this vault.

  • shares: {
        DomainID?: string;
        Flags?: number;
        index: string;
        Issuer: string;
        LedgerEntryType: string;
        mpt_issuance_id?: string;
        OutstandingAmount: string;
        OwnerNode?: string;
        PreviousTxnID: string;
        PreviousTxnLgrSeq: number;
        Sequence: number;
    }

    Object containing details about issued shares.

    • OptionalDomainID?: string

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

    • OptionalFlags?: 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".

    • Optionalmpt_issuance_id?: string

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

    • OutstandingAmount: string

      Total outstanding shares issued.

    • OptionalOwnerNode?: 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.

    • Sequence: number

      Sequence number of the shares issuance entry.

  • OptionalWithdrawalPolicy?: number

    Policy defining withdrawal conditions.