fromBytes

Decodes a byte array to a string, hex value, boolean or number.

Shortcut Functions:

Import

import { fromBytes } from 'viem'

Usage

import { fromBytes } from 'viem'
 
fromBytes(
  new Uint8Array([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33]), 
  'string'
)
// 'Hello world'
 
fromBytes(
  new Uint8Array([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33]), 
  'hex'
)
// '0x48656c6c6f20576f726c6421'
 
fromBytes(new Uint8Array([1, 164]), 'number')
// 420
 
fromBytes(new Uint8Array([1]), 'boolean')
// true

Returns

string | Hex | number | bigint | boolean

The targeted type.

Parameters

value

Type: ByteArray

The byte array to decode.

toOrOptions

Type: "string" | "hex" | "number" | "bigint" | "boolean" | Options

The output type or options.

fromBytes(
  new Uint8Array([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33]), 
  'string'
)
// 'Hello world'

fromBytes(
  new Uint8Array([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]), 
  { 
    size: 32, 
    to: 'string'
  } 
)
// 'Hello world'

Shortcut Functions

bytesToHex

Type: Hex

Decodes a byte array to a hex value.

import { bytesToHex } from 'viem'
 
bytesToHex( 
  new Uint8Array([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33])
)
// '0x48656c6c6f20576f726c6421'
 
bytesToHex( 
  new Uint8Array([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]), 
  { size: 32 }
)
// '0x48656c6c6f20576f726c64210000000000000000000000000000000000000000'

bytesToString

Type: Hex

Decodes a byte array to a string.

import { bytesToString } from 'viem'
 
bytesToString( 
  new Uint8Array([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33])
)
// 'Hello world'
 
bytesToString( 
  new Uint8Array([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]), 
  { size: 32 }
)
// 'Hello world'

bytesToNumber

Type: number

Decodes a byte array to a number.

import { bytesToNumber } from 'viem'
 
bytesToNumber(new Uint8Array([1, 164])) 
// 420
 
bytesToNumber( 
  new Uint8Array([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 164]), 
  { size: 32 }
)
// 420

bytesToBigInt

Type: number

Decodes a byte array to a number.

import { bytesToBigInt } from 'viem'
 
bytesToBigInt( 
  new Uint8Array([12, 92, 243, 146, 17, 135, 111, 181, 229, 136, 67, 39, 250, 86, 252, 11, 117])
)
// 4206942069420694206942069420694206942069n
 
bytesToBigInt( 
  new Uint8Array([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 12, 92, 243, 146, 17, 135, 111, 181, 229, 136, 67, 39, 250, 86, 252, 11, 117]),
  { size: 32 }
)
// 4206942069420694206942069420694206942069n

bytesToBool

Type: boolean

Decodes a byte array to a boolean.

import { bytesToBool } from 'viem'
 
bytesToBool(new Uint8Array([1])) 
// true
 
bytesToBool( 
  new Uint8Array([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1]),
  { size: 32 }
) 
// true