You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
167 lines
4.6 KiB
167 lines
4.6 KiB
import { InvalidHexBooleanError, SizeOverflowError, } from '../../errors/encoding.js';
|
|
import { size as size_ } from '../data/size.js';
|
|
import { trim } from '../data/trim.js';
|
|
import { hexToBytes } from './toBytes.js';
|
|
export function assertSize(hexOrBytes, { size }) {
|
|
if (size_(hexOrBytes) > size)
|
|
throw new SizeOverflowError({
|
|
givenSize: size_(hexOrBytes),
|
|
maxSize: size,
|
|
});
|
|
}
|
|
/**
|
|
* Decodes a hex string into a string, number, bigint, boolean, or byte array.
|
|
*
|
|
* - Docs: https://viem.sh/docs/utilities/fromHex
|
|
* - Example: https://viem.sh/docs/utilities/fromHex#usage
|
|
*
|
|
* @param hex Hex string to decode.
|
|
* @param toOrOpts Type to convert to or options.
|
|
* @returns Decoded value.
|
|
*
|
|
* @example
|
|
* import { fromHex } from 'viem'
|
|
* const data = fromHex('0x1a4', 'number')
|
|
* // 420
|
|
*
|
|
* @example
|
|
* import { fromHex } from 'viem'
|
|
* const data = fromHex('0x48656c6c6f20576f726c6421', 'string')
|
|
* // 'Hello world'
|
|
*
|
|
* @example
|
|
* import { fromHex } from 'viem'
|
|
* const data = fromHex('0x48656c6c6f20576f726c64210000000000000000000000000000000000000000', {
|
|
* size: 32,
|
|
* to: 'string'
|
|
* })
|
|
* // 'Hello world'
|
|
*/
|
|
export function fromHex(hex, toOrOpts) {
|
|
const opts = typeof toOrOpts === 'string' ? { to: toOrOpts } : toOrOpts;
|
|
const to = opts.to;
|
|
if (to === 'number')
|
|
return hexToNumber(hex, opts);
|
|
if (to === 'bigint')
|
|
return hexToBigInt(hex, opts);
|
|
if (to === 'string')
|
|
return hexToString(hex, opts);
|
|
if (to === 'boolean')
|
|
return hexToBool(hex, opts);
|
|
return hexToBytes(hex, opts);
|
|
}
|
|
/**
|
|
* Decodes a hex value into a bigint.
|
|
*
|
|
* - Docs: https://viem.sh/docs/utilities/fromHex#hextobigint
|
|
*
|
|
* @param hex Hex value to decode.
|
|
* @param opts Options.
|
|
* @returns BigInt value.
|
|
*
|
|
* @example
|
|
* import { hexToBigInt } from 'viem'
|
|
* const data = hexToBigInt('0x1a4', { signed: true })
|
|
* // 420n
|
|
*
|
|
* @example
|
|
* import { hexToBigInt } from 'viem'
|
|
* const data = hexToBigInt('0x00000000000000000000000000000000000000000000000000000000000001a4', { size: 32 })
|
|
* // 420n
|
|
*/
|
|
export function hexToBigInt(hex, opts = {}) {
|
|
const { signed } = opts;
|
|
if (opts.size)
|
|
assertSize(hex, { size: opts.size });
|
|
const value = BigInt(hex);
|
|
if (!signed)
|
|
return value;
|
|
const size = (hex.length - 2) / 2;
|
|
const max = (1n << (BigInt(size) * 8n - 1n)) - 1n;
|
|
if (value <= max)
|
|
return value;
|
|
return value - BigInt(`0x${'f'.padStart(size * 2, 'f')}`) - 1n;
|
|
}
|
|
/**
|
|
* Decodes a hex value into a boolean.
|
|
*
|
|
* - Docs: https://viem.sh/docs/utilities/fromHex#hextobool
|
|
*
|
|
* @param hex Hex value to decode.
|
|
* @param opts Options.
|
|
* @returns Boolean value.
|
|
*
|
|
* @example
|
|
* import { hexToBool } from 'viem'
|
|
* const data = hexToBool('0x01')
|
|
* // true
|
|
*
|
|
* @example
|
|
* import { hexToBool } from 'viem'
|
|
* const data = hexToBool('0x0000000000000000000000000000000000000000000000000000000000000001', { size: 32 })
|
|
* // true
|
|
*/
|
|
export function hexToBool(hex_, opts = {}) {
|
|
let hex = hex_;
|
|
if (opts.size) {
|
|
assertSize(hex, { size: opts.size });
|
|
hex = trim(hex);
|
|
}
|
|
if (trim(hex) === '0x00')
|
|
return false;
|
|
if (trim(hex) === '0x01')
|
|
return true;
|
|
throw new InvalidHexBooleanError(hex);
|
|
}
|
|
/**
|
|
* Decodes a hex string into a number.
|
|
*
|
|
* - Docs: https://viem.sh/docs/utilities/fromHex#hextonumber
|
|
*
|
|
* @param hex Hex value to decode.
|
|
* @param opts Options.
|
|
* @returns Number value.
|
|
*
|
|
* @example
|
|
* import { hexToNumber } from 'viem'
|
|
* const data = hexToNumber('0x1a4')
|
|
* // 420
|
|
*
|
|
* @example
|
|
* import { hexToNumber } from 'viem'
|
|
* const data = hexToBigInt('0x00000000000000000000000000000000000000000000000000000000000001a4', { size: 32 })
|
|
* // 420
|
|
*/
|
|
export function hexToNumber(hex, opts = {}) {
|
|
return Number(hexToBigInt(hex, opts));
|
|
}
|
|
/**
|
|
* Decodes a hex value into a UTF-8 string.
|
|
*
|
|
* - Docs: https://viem.sh/docs/utilities/fromHex#hextostring
|
|
*
|
|
* @param hex Hex value to decode.
|
|
* @param opts Options.
|
|
* @returns String value.
|
|
*
|
|
* @example
|
|
* import { hexToString } from 'viem'
|
|
* const data = hexToString('0x48656c6c6f20576f726c6421')
|
|
* // 'Hello world!'
|
|
*
|
|
* @example
|
|
* import { hexToString } from 'viem'
|
|
* const data = hexToString('0x48656c6c6f20576f726c64210000000000000000000000000000000000000000', {
|
|
* size: 32,
|
|
* })
|
|
* // 'Hello world'
|
|
*/
|
|
export function hexToString(hex, opts = {}) {
|
|
let bytes = hexToBytes(hex);
|
|
if (opts.size) {
|
|
assertSize(bytes, { size: opts.size });
|
|
bytes = trim(bytes, { dir: 'right' });
|
|
}
|
|
return new TextDecoder().decode(bytes);
|
|
}
|
|
//# sourceMappingURL=fromHex.js.map
|