xrpl/src/models/ledger/Credential.ts

A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser

import { GlobalFlagsInterface } from '../transactions/common'

import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'

export interface CredentialFlags extends GlobalFlagsInterface {
  lsfAccepted?: boolean
}

/**
 *
 * A Credential object describes a credential, similar to a passport, which is an issuable identity verifier
 * that can be used as a prerequisite for other transactions
 *
 * @category Ledger Entries
 */
export default interface Credential extends BaseLedgerEntry, HasPreviousTxnID {
  LedgerEntryType: 'Credential'
  /**
   * A bit-map of boolean flags
   */
  Flags: number | CredentialFlags

  /** The account that the credential is for. */
  Subject: string

  /** The issuer of the credential. */
  Issuer: string

  /** A hex-encoded value to identify the type of credential from the issuer. */
  CredentialType: string

  /** A hint indicating which page of the subject's owner directory links to this object,
   * in case the directory consists of multiple pages.
   */
  SubjectNode: string

  /** A hint indicating which page of the issuer's owner directory links to this object,
   * in case the directory consists of multiple pages.
   */
  IssuerNode: string

  /** Credential expiration. */
  Expiration?: number

  /** Additional data about the credential (such as a link to the VC document). */
  URI?: string
}