Skip to main content
@tevm/voltaire
@tevm/voltaire / index / BrandedBytes64

​
BrandedBytes64

​
Type Aliases

​
Bytes64Like

Bytes64Like = Bytes64Type | string | Uint8Array
Defined in: src/primitives/Bytes/Bytes64/Bytes64Type.ts:11 Inputs that can be converted to Bytes64

​
Variables

​
SIZE

const SIZE: 64 = 64
Defined in: src/primitives/Bytes/Bytes64/Bytes64Type.ts:13

​
ZERO

const ZERO: Bytes64Type
Defined in: src/primitives/Bytes/Bytes64/constants.js:10 Zero Bytes64 constant (64 zero bytes)

​
Functions

​
Bytes64()

Bytes64(value): Bytes64Type
Defined in: src/primitives/Bytes/Bytes64/index.ts:39

​
Parameters

value
Bytes64Like

​
Returns

Bytes64Type

​
clone()

clone(bytes): Bytes64Type
Defined in: src/primitives/Bytes/Bytes64/clone.js:14 Clone a Bytes64 value

​
Parameters

bytes
Bytes64Type Value to clone

​
Returns

Bytes64Type Cloned value

​
See

https://voltaire.tevm.sh/primitives/bytes/bytes64 for documentation

​
Since

0.0.0

​
Example

import * as Bytes64 from './primitives/Bytes/Bytes64/index.js';
const cloned = Bytes64.clone(bytes);

​
compare()

compare(a, b): number
Defined in: src/primitives/Bytes/Bytes64/compare.js:15 Compare two Bytes64 values

​
Parameters

a
Bytes64Type First value
b
Bytes64Type Second value

​
Returns

number -1 if a < b, 0 if equal, 1 if a > b

​
See

https://voltaire.tevm.sh/primitives/bytes/bytes64 for documentation

​
Since

0.0.0

​
Example

import * as Bytes64 from './primitives/Bytes/Bytes64/index.js';
const result = Bytes64.compare(a, b);

​
equals()

equals(a, b): boolean
Defined in: src/primitives/Bytes/Bytes64/equals.js:15 Check if two Bytes64 values are equal

​
Parameters

a
Bytes64Type First value
b
Bytes64Type Second value

​
Returns

boolean True if equal

​
See

https://voltaire.tevm.sh/primitives/bytes/bytes64 for documentation

​
Since

0.0.0

​
Example

import * as Bytes64 from './primitives/Bytes/Bytes64/index.js';
const equal = Bytes64.equals(a, b);

​
from()

from(value): Bytes64Type
Defined in: src/primitives/Bytes/Bytes64/from.js:19 Create Bytes64 from string or bytes

​
Parameters

value
Hex string with optional 0x prefix or Uint8Array string | Uint8Array<ArrayBufferLike>

​
Returns

Bytes64Type Bytes64

​
See

https://voltaire.tevm.sh/primitives/bytes/bytes64 for documentation

​
Since

0.0.0

​
Throws

If input is invalid or wrong length

​
Example

import * as Bytes64 from './primitives/Bytes/Bytes64/index.js';
const bytes = Bytes64.from('0x' + '12'.repeat(64));
const bytes2 = Bytes64.from(new Uint8Array(64));

​
fromBytes()

fromBytes(bytes): Bytes64Type
Defined in: src/primitives/Bytes/Bytes64/fromBytes.js:18 Create Bytes64 from raw bytes

​
Parameters

bytes
Uint8Array<ArrayBufferLike> Raw bytes (must be 64 bytes)

​
Returns

Bytes64Type Bytes64

​
See

https://voltaire.tevm.sh/primitives/bytes/bytes64 for documentation

​
Since

0.0.0

​
Throws

If bytes is wrong length

​
Example

import * as Bytes64 from './primitives/Bytes/Bytes64/index.js';
const bytes = Bytes64.fromBytes(new Uint8Array(64));

​
fromHex()

fromHex(hex): Bytes64Type
Defined in: src/primitives/Bytes/Bytes64/fromHex.js:19 Create Bytes64 from hex string

​
Parameters

hex
string Hex string with optional 0x prefix

​
Returns

Bytes64Type Bytes64

​
See

https://voltaire.tevm.sh/primitives/bytes/bytes64 for documentation

​
Since

0.0.0

​
Throws

If hex is wrong length

​
Throws

If hex contains invalid characters

​
Example

import * as Bytes64 from './primitives/Bytes/Bytes64/index.js';
const bytes = Bytes64.fromHex('0x' + '1234'.repeat(32));

​
isZero()

isZero(bytes): boolean
Defined in: src/primitives/Bytes/Bytes64/isZero.js:14 Check if Bytes64 is all zeros

​
Parameters

bytes
Bytes64Type Value to check

​
Returns

boolean True if all zeros

​
See

https://voltaire.tevm.sh/primitives/bytes/bytes64 for documentation

​
Since

0.0.0

​
Example

import * as Bytes64 from './primitives/Bytes/Bytes64/index.js';
const isAllZeros = Bytes64.isZero(bytes);

​
size()

size(_bytes): 64
Defined in: src/primitives/Bytes/Bytes64/size.js:16 Get size of Bytes64 (always 64)

​
Parameters

_bytes
Bytes64Type Bytes64 value

​
Returns

64 Size in bytes

​
See

https://voltaire.tevm.sh/primitives/bytes/bytes64 for documentation

​
Since

0.0.0

​
Example

import * as Bytes64 from './primitives/Bytes/Bytes64/index.js';
const s = Bytes64.size(bytes); // 64

​
toHex()

toHex(bytes): string
Defined in: src/primitives/Bytes/Bytes64/toHex.js:14 Convert Bytes64 to hex string

​
Parameters

bytes
Bytes64Type Bytes64 to convert

​
Returns

string Hex string with 0x prefix

​
See

https://voltaire.tevm.sh/primitives/bytes/bytes64 for documentation

​
Since

0.0.0

​
Example

import * as Bytes64 from './primitives/Bytes/Bytes64/index.js';
const hex = Bytes64.toHex(bytes);

​
toUint8Array()

toUint8Array(bytes): Uint8Array<ArrayBufferLike>
Defined in: src/primitives/Bytes/Bytes64/toUint8Array.js:14 Convert Bytes64 to Uint8Array

​
Parameters

bytes
Bytes64Type Bytes64 to convert

​
Returns

Uint8Array<ArrayBufferLike> Raw bytes

​
See

https://voltaire.tevm.sh/primitives/bytes/bytes64 for documentation

​
Since

0.0.0

​
Example

import * as Bytes64 from './primitives/Bytes/Bytes64/index.js';
const raw = Bytes64.toUint8Array(bytes);

​
zero()

zero(): Bytes64Type
Defined in: src/primitives/Bytes/Bytes64/zero.js:15 Create a zero-filled Bytes64

​
Returns

Bytes64Type Zero-filled Bytes64

​
See

https://voltaire.tevm.sh/primitives/bytes/bytes64 for documentation

​
Since

0.0.0

​
Example

import * as Bytes64 from './primitives/Bytes/Bytes64/index.js';
const zeros = Bytes64.zero();

​
References

​
Bytes64Type

Re-exports Bytes64Type