xrpl/src/models/transactions/CredentialCreate.ts

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

import { HEX_REGEX } from '@xrplf/isomorphic/utils'

import { ValidationError } from '../../errors'

import {
  BaseTransaction,
  isNumber,
  isString,
  validateBaseTransaction,
  validateCredentialType,
  validateOptionalField,
  validateRequiredField,
} from './common'

const MAX_URI_LENGTH = 256

/**
 * Creates a Credential object. It must be sent by the issuer.
 *
 * @category Transaction Models
 * */
export interface CredentialCreate extends BaseTransaction {
  TransactionType: 'CredentialCreate'

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

  /** The subject of the credential. */
  Subject: string

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

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

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

/**
 * Verify the form and type of a CredentialCreate at runtime.
 *
 * @param tx - A CredentialCreate Transaction.
 * @throws When the CredentialCreate is Malformed.
 */
export function validateCredentialCreate(tx: Record<string, unknown>): void {
  validateBaseTransaction(tx)

  validateRequiredField(tx, 'Account', isString)

  validateRequiredField(tx, 'Subject', isString)

  validateCredentialType(tx)

  validateOptionalField(tx, 'Expiration', isNumber)

  validateURI(tx.URI)
}

function validateURI(URI: unknown): void {
  if (URI === undefined) {
    return
  }

  if (typeof URI !== 'string') {
    throw new ValidationError('CredentialCreate: invalid field URI')
  }

  if (URI.length === 0) {
    throw new ValidationError('CredentialCreate: URI cannot be an empty string')
  } else if (URI.length > MAX_URI_LENGTH) {
    throw new ValidationError(
      `CredentialCreate: URI length must be <= ${MAX_URI_LENGTH}`,
    )
  }

  if (!HEX_REGEX.test(URI)) {
    throw new ValidationError('CredentialCreate: URI must be encoded in hex')
  }
}