xrpl/src/utils/stringConversion.ts

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

import { stringToHex, hexToString } from '@xrplf/isomorphic/utils'

/**
 * Converts a string to its hex equivalent. Useful for Memos.
 *
 * @param string - The string to convert to Hex.
 * @returns The Hex equivalent of the string.
 *
 * @deprecated use `@xrplf/isomorphic/utils`'s `stringToHex`
 *
 * @category Utilities
 */
function convertStringToHex(string: string): string {
  return stringToHex(string)
}

/**
 * Converts hex to its string equivalent. Useful to read the Domain field and some Memos.
 *
 * @param hex - The hex to convert to a string.
 * @param encoding - The encoding to use. Defaults to 'utf8' (UTF-8). 'ascii' is also allowed.
 * @returns The converted string.
 *
 * @deprecated use `@xrplf/isomorphic/utils`'s `hexToString`
 *
 * @category Utilities
 */
function convertHexToString(hex: string, encoding = 'utf8'): string {
  return hexToString(hex, encoding)
}

export { convertHexToString, convertStringToHex }