hardhat/src/internal/util/wei-values.ts

Hardhat is an extensible developer tool that helps smart contract developers increase productivity by reliably bringing together the tools they want.

/**
 * This function turns a wei value in a human readable string. It shows values
 * in ETH, gwei or wei, depending on how large it is.
 *
 * It never show more than 99999 wei or gwei, moving to the larger denominator
 * when necessary.
 *
 * It never shows more than 4 decimal digits. Adapting denominator and
 * truncating as necessary.
 */
export function weiToHumanReadableString(wei: bigint | number): string {
  if (typeof wei === "number") {
    wei = BigInt(wei);
  }

  if (wei === 0n) {
    return "0 ETH";
  }

  if (wei < 100_000n) {
    return `${wei.toString()} wei`;
  }

  if (wei < 10n ** 14n) {
    return `${toDecimalString(wei, 9, 4)} gwei`;
  }

  return `${toDecimalString(wei, 18, 4)} ETH`;
}

function toDecimalString(
  value: bigint,
  digitsToInteger: number,
  decimalDigits: number = 4
): string {
  const oneUnit = 10n ** BigInt(digitsToInteger);
  const oneDecimal = 10n ** BigInt(digitsToInteger - decimalDigits);

  const integer = value / oneUnit;

  const decimals = (value % oneUnit) / oneDecimal;
  if (decimals === 0n) {
    return integer.toString(10);
  }

  const decimalsString = removeRightZeros(
    decimals.toString(10).padStart(decimalDigits, "0")
  );

  return `${integer.toString(10)}.${decimalsString}`;
}

function removeRightZeros(str: string): string {
  let zeros = 0;

  for (let i = str.length - 1; i >= 0; i--) {
    if (str.charAt(i) !== "0") {
      break;
    }

    zeros += 1;
  }

  return str.substr(0, str.length - zeros);
}