@tevm/voltaire

@tevm/voltaire / primitives/ReturnData

primitives/ReturnData

Classes

InvalidHexFormatError

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

Extends

PrimitiveError

Constructors

Constructor

new InvalidHexFormatError(message, context?): InvalidHexFormatError

Defined in: src/primitives/ReturnData/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/ReturnData/errors.ts:16 Error thrown when value type is unsupported

Extends

PrimitiveError

Constructors

Constructor

new InvalidValueError(message, context?): InvalidValueError

Defined in: src/primitives/ReturnData/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

ReturnDataType

ReturnDataType = Uint8Array & object

Defined in: src/primitives/ReturnData/ReturnDataType.ts:9 ReturnData - Raw bytes returned from contract call Branded Uint8Array representing uninterpreted return data from contract execution. Can be decoded using ABI specifications.

Type Declaration

[brand]

readonly [brand]: "ReturnData"

Functions

_equals()

_equals(a, b): boolean

Defined in: src/primitives/ReturnData/equals.js:13 Check if two ReturnData instances are equal

Parameters

a

ReturnDataType First ReturnData

b

ReturnDataType Second ReturnData

Returns

boolean True if equal

Example

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

_from()

_from(value): ReturnDataType

Defined in: src/primitives/ReturnData/from.js:19 Create ReturnData from various input types

Parameters

value

Hex string or Uint8Array string | Uint8Array<ArrayBufferLike>

Returns

ReturnDataType ReturnData

Throws

If value type is unsupported

Throws

If hex string is invalid

Example

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

_fromBytes()

_fromBytes(value): ReturnDataType

Defined in: src/primitives/ReturnData/fromBytes.js:12 Create ReturnData from Uint8Array (zero-copy cast)

Parameters

value

Uint8Array<ArrayBufferLike> Byte array

Returns

ReturnDataType ReturnData

Example

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

_fromHex()

_fromHex(value): ReturnDataType

Defined in: src/primitives/ReturnData/fromHex.js:16 Create ReturnData from hex string

Parameters

value

string Hex string (with or without 0x prefix)

Returns

ReturnDataType ReturnData

Throws

If hex string is invalid

Example

const data = ReturnData.fromHex("0x00000001");

_isEmpty()

_isEmpty(data): boolean

Defined in: src/primitives/ReturnData/isEmpty.js:12 Check if ReturnData is empty

Parameters

data

ReturnDataType ReturnData

Returns

boolean True if empty

Example

const empty = ReturnData.isEmpty(data);

_toBytes()

_toBytes(data): Uint8Array<ArrayBufferLike>

Defined in: src/primitives/ReturnData/toBytes.js:12 Convert ReturnData to plain Uint8Array

Parameters

data

ReturnDataType ReturnData

Returns

Uint8Array<ArrayBufferLike> Plain byte array

Example

const bytes = ReturnData.toBytes(data);

_toHex()

_toHex(data): string

Defined in: src/primitives/ReturnData/toHex.js:14 Convert ReturnData to hex string

Parameters

data

ReturnDataType ReturnData

Returns

string Hex string with 0x prefix

Example

const hex = ReturnData.toHex(data); // "0x00000001"

equals()

equals(a, b): boolean

Defined in: src/primitives/ReturnData/index.ts:51 Check if two ReturnData instances are equal

Parameters

a

ReturnDataType

b

ReturnDataType

Returns

boolean

from()

from(value): ReturnDataType

Defined in: src/primitives/ReturnData/index.ts:16 Create ReturnData from various input types

Parameters

value

string | Uint8Array<ArrayBufferLike>

Returns

ReturnDataType

fromBytes()

fromBytes(value): ReturnDataType

Defined in: src/primitives/ReturnData/index.ts:30 Create ReturnData from Uint8Array

Parameters

value

Uint8Array

Returns

ReturnDataType

fromHex()

fromHex(value): ReturnDataType

Defined in: src/primitives/ReturnData/index.ts:23 Create ReturnData from hex string

Parameters

value

string

Returns

ReturnDataType

isEmpty()

isEmpty(data): boolean

Defined in: src/primitives/ReturnData/index.ts:58 Check if ReturnData is empty

Parameters

data

ReturnDataType

Returns

boolean

toBytes()

toBytes(data): Uint8Array

Defined in: src/primitives/ReturnData/index.ts:44 Convert ReturnData to plain Uint8Array

Parameters

data

ReturnDataType

Returns

Uint8Array

toHex()

toHex(data): string

Defined in: src/primitives/ReturnData/index.ts:37 Convert ReturnData to hex string

Parameters

data

ReturnDataType

Returns

string

primitives/RelayData primitives/RevertReason

​primitives/ReturnData

​Classes

​InvalidHexFormatError

​Extends

​Constructors

Constructor

Parameters

message

context?

Returns

Overrides

​Properties

cause?

Inherited from

code

Example

Inherited from

context?

Example

Inherited from

docsPath?

Example

Inherited from

​Methods

getErrorChain()

Returns

Inherited from

toJSON()

Returns

Inherited from

​InvalidValueError

​Extends

​Constructors

Constructor

Parameters

message

context?

Returns

Overrides

​Properties

cause?

Inherited from

code

Example

Inherited from

context?

Example

Inherited from

docsPath?

Example

Inherited from

​Methods

getErrorChain()

Returns

Inherited from

toJSON()

Returns

Inherited from

​Type Aliases

​ReturnDataType

​Type Declaration

[brand]

​Functions

​_equals()

​Parameters

a

b

​Returns

​Example

​_from()

​Parameters

value

​Returns

​Throws

​Throws

​Example

​_fromBytes()

​Parameters

value

​Returns

primitives/ReturnData

Classes

InvalidHexFormatError

Extends

Constructors

Properties

Methods

InvalidValueError

Extends

Constructors

Properties

Methods

Type Aliases

ReturnDataType

Type Declaration

Functions

_equals()

Parameters

Returns

Example

_from()

Parameters

Returns

Throws

Throws

Example

_fromBytes()

Parameters

Returns

Example

_fromHex()

Parameters

Returns

Throws

Example

_isEmpty()

Parameters

Returns

Example

_toBytes()

Parameters

Returns

Example

_toHex()

Parameters

Returns

Example

equals()

Parameters

Returns

from()

Parameters

Returns

fromBytes()

Parameters

Returns

fromHex()

Parameters

Returns

isEmpty()

Parameters

Returns

toBytes()

Parameters

Returns

toHex()

Parameters

Returns