Skip to main content
@tevm/voltaire
@tevm/voltaire / primitives/EncodedData

​
primitives/EncodedData

​
Classes

​
InvalidHexFormatError

Defined in: src/primitives/EncodedData/errors.ts:6 Error thrown when hex string format is invalid

​
Extends

​
Constructors

Constructor
new InvalidHexFormatError(message, context?): InvalidHexFormatError
Defined in: src/primitives/EncodedData/errors.ts:7
Parameters
message
string
context?
Record<string, unknown>
Returns
InvalidHexFormatError
Overrides
PrimitiveError.constructor

​
Properties

cause?
optional cause: Error
Defined in: src/primitives/errors/AbstractError.ts:56 Root cause of this error (for error chaining)
Inherited from
PrimitiveError.cause
code
code: string
Defined in: src/primitives/errors/AbstractError.ts:39 Machine-readable error code for programmatic handling
Example
'INVALID_FORMAT', 'INVALID_LENGTH'
Inherited from
PrimitiveError.code
context?
optional context: Record<string, unknown>
Defined in: src/primitives/errors/AbstractError.ts:45 Additional context metadata for debugging
Example
{ value: '0x123', expected: '20 bytes' }
Inherited from
PrimitiveError.context
docsPath?
optional docsPath: string
Defined in: src/primitives/errors/AbstractError.ts:51 Path to documentation for this error
Example
'/primitives/address/from-hex#error-handling'
Inherited from
PrimitiveError.docsPath

​
Methods

getErrorChain()
getErrorChain(): string
Defined in: src/primitives/errors/AbstractError.ts:94 Get full error chain as string for logging
Returns
string
Inherited from
PrimitiveError.getErrorChain
toJSON()
toJSON(): Record<string, unknown>
Defined in: src/primitives/errors/AbstractError.ts:110 Serialize error to JSON for logging/telemetry
Returns
Record<string, unknown>
Inherited from
PrimitiveError.toJSON

​
InvalidValueError

Defined in: src/primitives/EncodedData/errors.ts:16 Error thrown when value type is unsupported

​
Extends

​
Constructors

Constructor
new InvalidValueError(message, context?): InvalidValueError
Defined in: src/primitives/EncodedData/errors.ts:17
Parameters
message
string
context?
Record<string, unknown>
Returns
InvalidValueError
Overrides
PrimitiveError.constructor

​
Properties

cause?
optional cause: Error
Defined in: src/primitives/errors/AbstractError.ts:56 Root cause of this error (for error chaining)
Inherited from
PrimitiveError.cause
code
code: string
Defined in: src/primitives/errors/AbstractError.ts:39 Machine-readable error code for programmatic handling
Example
'INVALID_FORMAT', 'INVALID_LENGTH'
Inherited from
PrimitiveError.code
context?
optional context: Record<string, unknown>
Defined in: src/primitives/errors/AbstractError.ts:45 Additional context metadata for debugging
Example
{ value: '0x123', expected: '20 bytes' }
Inherited from
PrimitiveError.context
docsPath?
optional docsPath: string
Defined in: src/primitives/errors/AbstractError.ts:51 Path to documentation for this error
Example
'/primitives/address/from-hex#error-handling'
Inherited from
PrimitiveError.docsPath

​
Methods

getErrorChain()
getErrorChain(): string
Defined in: src/primitives/errors/AbstractError.ts:94 Get full error chain as string for logging
Returns
string
Inherited from
PrimitiveError.getErrorChain
toJSON()
toJSON(): Record<string, unknown>
Defined in: src/primitives/errors/AbstractError.ts:110 Serialize error to JSON for logging/telemetry
Returns
Record<string, unknown>
Inherited from
PrimitiveError.toJSON

​
Type Aliases

​
EncodedDataType

EncodedDataType = `0x${string}` & object
Defined in: src/primitives/EncodedData/EncodedDataType.ts:9 EncodedData - ABI-encoded hex data Branded hex string representing ABI-encoded data. Can be decoded using ABI specifications.

​
Type Declaration

[brand]
readonly [brand]: "EncodedData"

​
Functions

​
_equals()

_equals(a, b): boolean
Defined in: src/primitives/EncodedData/equals.js:13 Check if two EncodedData instances are equal

​
Parameters

a
EncodedDataType First EncodedData
b
EncodedDataType Second EncodedData

​
Returns

boolean True if equal

​
Example

const isEqual = EncodedData.equals(data1, data2);

​
_from()

_from(value): EncodedDataType
Defined in: src/primitives/EncodedData/from.js:18 Create EncodedData from various input types

​
Parameters

value
Hex string or Uint8Array string | Uint8Array<ArrayBufferLike>

​
Returns

EncodedDataType EncodedData

​
Throws

If value type is unsupported

​
Throws

If hex string is invalid

​
Example

const data1 = EncodedData.from("0x0000...");
const data2 = EncodedData.from(new Uint8Array([0, 0, ...]));

​
_fromBytes()

_fromBytes(value): EncodedDataType
Defined in: src/primitives/EncodedData/fromBytes.js:14 Create EncodedData from Uint8Array

​
Parameters

value
Uint8Array<ArrayBufferLike> Byte array

​
Returns

EncodedDataType EncodedData

​
Example

const data = EncodedData.fromBytes(new Uint8Array([0, 0, 0, 1]));

​
_toBytes()

_toBytes(data): Uint8Array<ArrayBufferLike>
Defined in: src/primitives/EncodedData/toBytes.js:14 Convert EncodedData to Uint8Array

​
Parameters

data
EncodedDataType EncodedData

​
Returns

Uint8Array<ArrayBufferLike> Byte array

​
Example

const bytes = EncodedData.toBytes(data);

​
equals()

equals(a, b): boolean
Defined in: src/primitives/EncodedData/index.ts:34 Check if two EncodedData instances are equal

​
Parameters

a
EncodedDataType
b
EncodedDataType

​
Returns

boolean

​
from()

from(value): EncodedDataType
Defined in: src/primitives/EncodedData/index.ts:13 Create EncodedData from various input types

​
Parameters

value
string | Uint8Array<ArrayBufferLike>

​
Returns

EncodedDataType

​
fromBytes()

fromBytes(value): EncodedDataType
Defined in: src/primitives/EncodedData/index.ts:20 Create EncodedData from Uint8Array

​
Parameters

value
Uint8Array

​
Returns

EncodedDataType

​
toBytes()

toBytes(data): Uint8Array
Defined in: src/primitives/EncodedData/index.ts:27 Convert EncodedData to Uint8Array

​
Parameters

data
EncodedDataType

​
Returns

Uint8Array