Icon HelpCircleForumIcon Link

⌘K

Icon HelpCircleForumIcon Link

Icon LinkModule: @fuel-ts/utils

Icon LinkClasses

Icon LinkInterfaces

Icon LinkVariables

Icon LinkdefaultConsensusKey

Const defaultConsensusKey: "0xa449b1ffee0e2205fa924c6740cc48b3b473aa28587df6dab12abc245d1f5298"

Icon LinkDefined in

packages/utils/src/utils/defaultSnapshotConfigs.ts:12 Icon Link


Icon LinkdefaultSnapshotConfigs

Const defaultSnapshotConfigs: SnapshotConfigs

Icon LinkDefined in

packages/utils/src/utils/defaultSnapshotConfigs.ts:6 Icon Link

Icon LinkFunctions

Icon Linkarrayify

arrayify(value, name?, copy?): Uint8Array

Get a typed Uint8Array from a BytesLike object.

Icon LinkParameters

NameTypeDefault valueDescription
valueBytesLike undefinedthe BytesLike data.
name?stringundefineda display name for the error result.
copybooleantruecreate a copy of the original data (if applicable).

Icon LinkReturns

Uint8Array

  • a typed Uint8Array.

Icon LinkDefined in

packages/utils/src/utils/arrayify.ts:12 Icon Link


Icon LinkcapitalizeString

capitalizeString(str): string

Icon LinkParameters

NameType
strstring

Icon LinkReturns

string

Icon LinkDefined in

packages/utils/src/utils/capitalizeString.ts:1 Icon Link


Icon LinkchunkAndPadBytes

chunkAndPadBytes(bytes, chunkSize): Uint8Array[]

Function to take a byte array and split into chunks of a given size

Icon LinkParameters

NameTypeDescription
bytesUint8ArrayThe byte array to chunk
chunkSizenumberThe size of each chunk

Icon LinkReturns

Uint8Array[]

An array of byte arrays of a specified size

Icon LinkDefined in

packages/utils/src/utils/chunkAndPadBytes.ts:8 Icon Link


Icon Linkconcat

concat(arrays): Uint8Array

Concatenates multiple BytesLike into a single Uint8Array.

Icon LinkParameters

NameTypeDescription
arraysreadonly BytesLike []The arrays to concatenate.

Icon LinkReturns

Uint8Array

  • The concatenated array.

Icon LinkDefined in

packages/utils/src/utils/concat.ts:38 Icon Link


Icon LinkconcatBytes

concatBytes(arrays): Uint8Array

Concatenates multiple Uint8Arrays into a single Uint8Array.

Icon LinkParameters

NameTypeDescription
arraysreadonly Uint8Array[] | readonly number[][]The arrays to concatenate.

Icon LinkReturns

Uint8Array

  • The concatenated array.

Icon LinkDefined in

packages/utils/src/utils/concat.ts:11 Icon Link


Icon LinkdataSlice

dataSlice(data, start?, end?): string

Returns a hex string by slicing data from the start offset to the end offset.

Icon LinkParameters

NameTypeDescription
dataBytesLike the data to be sliced.
start?numberthe start offset (default: 0).
end?numberthe end offset (default: length of data).

Icon LinkReturns

string

  • a sliced hex string from start to end.

Icon LinkDefined in

packages/utils/src/utils/dataSlice.ts:15 Icon Link


Icon LinkdecodeBase58

decodeBase58(value): BN

Icon LinkParameters

NameType
valuestring

Icon LinkReturns

BN

Icon LinkDefined in

packages/utils/src/utils/base58.ts:51 Icon Link


Icon LinkencodeBase58

encodeBase58(_value): string

Encode value as a Base58-encoded string.

Icon LinkParameters

NameType
_valueBytesLike

Icon LinkReturns

string

Icon LinkDefined in

packages/utils/src/utils/base58.ts:30 Icon Link


Icon Linkhexlify

hexlify(data): string

Returns a hex representation of the inputted bytes.

Icon LinkParameters

NameType
dataBytesLike

Icon LinkReturns

string

Icon LinkDefined in

packages/utils/src/utils/hexlify.ts:10 Icon Link


Icon LinkisDefined

isDefined<T>(value): value is T

Icon LinkType parameters

Name
T

Icon LinkParameters

NameType
valueundefined | T

Icon LinkReturns

value is T

Icon LinkDefined in

packages/utils/src/utils/isDefined.ts:1 Icon Link


Icon LinknormalizeString

normalizeString(str): string

Converts some.string-value into SomeStringValue.

Examples: my-simple.test —— MySimpleTest myFile.ts —— MyFileTs my-abi.json —— MyAbiJson

Icon LinkParameters

NameType
strstring

Icon LinkReturns

string

Icon LinkDefined in

packages/utils/src/utils/normalizeString.ts:11 Icon Link


Icon Linksleep

sleep(time): Promise<unknown>

Icon LinkParameters

NameType
timenumber

Icon LinkReturns

Promise<unknown>

Icon LinkDefined in

packages/utils/src/utils/sleep.ts:1 Icon Link


Icon LinktoUtf8Bytes

toUtf8Bytes(stri, form?): Uint8Array

Returns the UTF-8 byte representation of str.

If form is disabled, the string is not normalized.

Icon LinkParameters

NameTypeDefault valueDescription
stristringundefinedthe string to convert to UTF-8 bytes.
formbooleantruewhether to normalize the string.

Icon LinkReturns

Uint8Array

  • the UTF-8 byte representation of str.

Icon LinkDefined in

packages/utils/src/utils/toUtf8Bytes.ts:11 Icon Link


Icon LinktoUtf8String

toUtf8String(bytes): string

Returns the string represented by the UTF-8 data bytes.

Icon LinkParameters

NameTypeDescription
bytesBytesLike the UTF-8 data bytes

Icon LinkReturns

string

the string represented by the UTF-8 data bytes

Icon LinkDefined in

packages/utils/src/utils/toUtf8String.ts:179 Icon Link