Vana SDK - v2.2.2
    Preparing search index...

    Function formatToken

    • Format a token amount based on its decimals

      Parameters

      • amount: string | number | bigint

        Raw token amount

      • decimals: number = 18

        Token decimals (default: 18)

      • displayDecimals: number = 4

        Decimals to show in formatted output (default: 4)

      Returns string

      Formatted token amount as string

      Generic token formatter that handles any ERC20-style token with configurable decimal places. Most tokens use 18 decimals like ETH, but some use different values (e.g., USDC uses 6).

      // 18 decimal token (like ETH)
      formatToken(1000000000000000000n) // Returns: "1.0000"
      formatToken(1500000000000000000n, 18, 2) // Returns: "1.50"

      // 6 decimal token (like USDC)
      formatToken(1000000n, 6) // Returns: "1.0000"
      formatToken(1500000n, 6, 2) // Returns: "1.50"

      // Whole numbers
      formatToken(5000000000000000000n) // Returns: "5"
      formatToken(5123456789000000000n, 18, 6) // Returns: "5.123456"