ripple-binary-codec/src/types/blob.ts

XRP Ledger binary codec

import { SerializedType } from './serialized-type'
import { BinaryParser } from '../serdes/binary-parser'
import { hexToBytes } from '@xrplf/isomorphic/utils'

/**
 * Variable length encoded type
 */
class Blob extends SerializedType {
  constructor(bytes: Uint8Array) {
    super(bytes)
  }

  /**
   * Defines how to read a Blob from a BinaryParser
   *
   * @param parser The binary parser to read the Blob from
   * @param hint The length of the blob, computed by readVariableLengthLength() and passed in
   * @returns A Blob object
   */
  static fromParser(parser: BinaryParser, hint: number): Blob {
    return new Blob(parser.read(hint))
  }

  /**
   * Create a Blob object from a hex-string
   *
   * @param value existing Blob object or a hex-string
   * @returns A Blob object
   */
  static from<T extends Blob | string>(value: T): Blob {
    if (value instanceof Blob) {
      return value
    }

    if (typeof value === 'string') {
      if (!/^[A-F0-9]*$/iu.test(value)) {
        throw new Error('Cannot construct Blob from a non-hex string')
      }
      return new Blob(hexToBytes(value))
    }

    throw new Error('Cannot construct Blob from value given')
  }
}

export { Blob }