@xylabs/hex

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/hex

Interfaces

• HexConfig

Type Aliases

• Address
• HashBitLength
• Hash
• Hex

Variables

• ZERO_ADDRESS
• ZERO_HASH
• HashBitLength
• hexRegex
• hexRegexWithPrefix

Functions

• toAddress
• isAddress
• asAddress
• isHashBitLength
• isHash
• asHash
• asHex
• hexFrom
• hexFromArrayBuffer
• hexFromBigInt
• hexFromHexString
• hexFromNumber
• isHex
• isHexZero
• toHexLegacy
• bitsToNibbles
• nibblesToBits
• toHex
• hexToBigInt

functions

asAddress

@xylabs/hex

Call Signature

function asAddress(value): undefined | Lowercase<string>;

Parameters

value

unknown

Returns

undefined | Lowercase<string>

Call Signature

function asAddress(value, assert): Lowercase<string>;

Parameters

value

unknown

assert

AssertConfig

Returns

Lowercase<string>

asHash

@xylabs/hex

Call Signature

function asHash(value): undefined | Lowercase<string>;

Parameters

value

unknown

Returns

undefined | Lowercase<string>

Call Signature

function asHash(value, assert): Lowercase<string>;

Parameters

value

unknown

assert

AssertConfig

Returns

Lowercase<string>

asHex

@xylabs/hex

Call Signature

function asHex(value): undefined | Lowercase<string>;

Parameters

value

unknown

Returns

undefined | Lowercase<string>

Call Signature

function asHex(value, assert): Lowercase<string>;

Parameters

value

unknown

assert

AssertConfig

Returns

Lowercase<string>

bitsToNibbles

@xylabs/hex

function bitsToNibbles(value): number;

Parameters

value

number

Returns

number

hexFrom

@xylabs/hex

function hexFrom(value, config?): Lowercase<string>;

Takes unknown value and tries our best to convert it to a hex string

Parameters

value

Supported types are string, number, bigint, and ArrayBuffer

string | number | bigint | ArrayBufferLike

config?

HexConfig

Configuration of output format and validation

Returns

Lowercase<string>

hexFromArrayBuffer

@xylabs/hex

function hexFromArrayBuffer(buffer, config?): Lowercase<string>;

Convert an ArrayBuffer to a hex string

Parameters

buffer

ArrayBufferLike

The buffer to be converted

config?

HexConfig

Configuration of output format and validation

Returns

Lowercase<string>

hexFromBigInt

@xylabs/hex

function hexFromBigInt(value, config): Lowercase<string>;

Convert a bigint to a hex string

Parameters

value

bigint

The bigint to be converted

config

HexConfig = {}

Configuration of output format and validation

Returns

Lowercase<string>

hexFromHexString

@xylabs/hex

function hexFromHexString(value, config): Lowercase<string>;

Parameters

value

string

config

HexConfig = {}

Returns

Lowercase<string>

hexFromNumber

@xylabs/hex

function hexFromNumber(value, config?): Lowercase<string>;

Parameters

value

number

config?

HexConfig

Returns

Lowercase<string>

hexToBigInt

@xylabs/hex

function hexToBigInt(hex): bigint;

Parameters

hex

Lowercase<string>

Returns

bigint

isAddress

@xylabs/hex

function isAddress(value, config): value is Lowercase<string>;

Parameters

value

unknown

config

HexConfig = {}

Returns

value is Lowercase<string>

isHash

@xylabs/hex

function isHash(value, bitLength): value is Lowercase<string>;

Parameters

value

unknown

bitLength

HashBitLength = 256

Returns

value is Lowercase<string>

isHashBitLength

@xylabs/hex

function isHashBitLength(value): value is HashBitLength;

Parameters

value

unknown

Returns

value is HashBitLength

isHex

@xylabs/hex

function isHex(value, config?): value is Lowercase<string>;

Parameters

value

unknown

config?

HexConfig

Returns

value is Lowercase<string>

isHexZero

@xylabs/hex

function isHexZero(value?): undefined | boolean;

Parameters

value?

string

Returns

undefined | boolean

nibblesToBits

@xylabs/hex

function nibblesToBits(value): number;

Parameters

value

number

Returns

number

toAddress

@xylabs/hex

function toAddress(value, config): Lowercase<string>;

Parameters

value

string | number | bigint | ArrayBufferLike

config

HexConfig = {}

Returns

Lowercase<string>

toHex

@xylabs/hex

function toHex(value, config): Lowercase<string>;

takes any value and tries our best to convert it to a hex string

Parameters

value

Supported types are string, number, bigint, and ArrayBuffer

string | number | bigint | ArrayBufferLike

config

HexConfig = {}

Configuration of output format and validation

Returns

Lowercase<string>

toHexLegacy

@xylabs/hex

function toHexLegacy(buffer): string;

Parameters

buffer

ArrayBuffer

Returns

string

interfaces

HexConfig

@xylabs/hex

Configuration of validation and output format

Properties

bitLength?

optional bitLength: number;

byteSize?

optional byteSize: number;

prefix?

optional prefix: boolean;

type-aliases

Address

@xylabs/hex

type Address = Exclude<Hex, "reserved-address-value">;

Hash

@xylabs/hex

type Hash = Exclude<Hex, "reserved-hash-value">;

HashBitLength

@xylabs/hex

type HashBitLength = 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096;

Hex

@xylabs/hex

type Hex = Exclude<Lowercase<string>, "reserved-hex-value">;

variables

HashBitLength

@xylabs/hex

HashBitLength: HashBitLength[];

ZERO_ADDRESS

@xylabs/hex

const ZERO_ADDRESS: Address;

ZERO_HASH

@xylabs/hex

const ZERO_HASH: Hash;

hexRegex

@xylabs/hex

const hexRegex: RegExp;

hexRegexWithPrefix

@xylabs/hex

const hexRegexWithPrefix: RegExp;

Part of sdk-js

Maintainers

• Arie Trouw (arietrouw.com)
• Matt Jones
• Joel Carter
• Jordan Trouw

License

See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs