Namespace: num

References

BigNumberish

Re-exports BigNumberish

Functions

isHex

▸ isHex(hex): boolean

Test if string is hex-string

Parameters

Name	Type	Description
hex	string	hex-string

Returns

boolean

Defined in

src/utils/num.ts:14

---

toBigInt

▸ toBigInt(value): bigint

Convert BigNumberish to bigint

Parameters

Name	Type
value	BigNumberish

Returns

bigint

Defined in

src/utils/num.ts:21

---

isBigInt

▸ isBigInt(value): value is bigint

Test if value is bigint

Parameters

Name	Type
value	any

Returns

value is bigint

Defined in

src/utils/num.ts:28

---

toHex

▸ toHex(number): string

Convert BigNumberish to hex-string

Parameters

Name	Type
number	BigNumberish

Returns

string

format: hex-string

Defined in

src/utils/num.ts:36

---

toStorageKey

▸ toStorageKey(number): string

Convert BigNumberish to storage-key-string

Same as toHex but conforming to the STORAGE_KEY pattern ^0x0[0-7]{1}[a-fA-F0-9]{0,62}$.

A storage key is represented as up to 62 hex digits, 3 bits, and 5 leading zeroes: 0x0 + [0-7] + 62 hex = 0x + 64 hex

Parameters

Name	Type
number	BigNumberish

Returns

string

format: storage-key-string

Defined in

src/utils/num.ts:54

---

hexToDecimalString

▸ hexToDecimalString(hex): string

Convert hexadecimal string to decimal string

Parameters

Name	Type	Description
hex	string	hex-string

Returns

string

format: decimal string

Defined in

src/utils/num.ts:64

---

assertInRange

▸ assertInRange(input, lowerBound, upperBound, inputName?): void

Asserts input is equal to or greater then lowerBound and lower then upperBound.

The inputName parameter is used in the assertion message.

Parameters

Name	Type	Default value
input	BigNumberish	undefined
lowerBound	BigNumberish	undefined
upperBound	BigNumberish	undefined
inputName	string	''

Returns

void

Defined in

src/utils/num.ts:81

---

bigNumberishArrayToDecimalStringArray

▸ bigNumberishArrayToDecimalStringArray(rawCalldata): string[]

Convert BigNumberish array to decimal string array

Parameters

Name	Type
rawCalldata	BigNumberish[]

Returns

string[]

format: decimal string array

Defined in

src/utils/num.ts:102

---

bigNumberishArrayToHexadecimalStringArray

▸ bigNumberishArrayToHexadecimalStringArray(rawCalldata): string[]

Convert BigNumberish array to hexadecimal string array

Parameters

Name	Type
rawCalldata	BigNumberish[]

Returns

string[]

format: hex-string array

Defined in

src/utils/num.ts:110

---

getDecimalString

▸ getDecimalString(value): string

Convert string to decimal string

Parameters

Name	Type
value	string

Returns

string

format: decimal string

Defined in

src/utils/num.ts:123

---

getHexString

▸ getHexString(value): string

Convert string to hexadecimal string

Parameters

Name	Type
value	string

Returns

string

format: hex-string

Defined in

src/utils/num.ts:137

---

getHexStringArray

▸ getHexStringArray(value): string[]

Convert string array to hex-string array

Parameters

Name	Type
value	string[]

Returns

string[]

format: hex-string array

Defined in

src/utils/num.ts:151

---

hexToBytes

▸ hexToBytes(value): Uint8Array

Convert hex-string to an array of Bytes (Uint8Array)

Parameters

Name	Type	Description
value	string	hex-string

Returns

Uint8Array

Defined in

src/utils/num.ts:164

---

toHexString

▸ toHexString(number): string

Alias of ToHex

Parameters

Name	Type
number	BigNumberish

Returns

string

Defined in

src/utils/num.ts:36

---

cleanHex

▸ cleanHex(hex): string

Remove hex string leading zero and lowercase it

Example

'0x01A...' -> '0x1a..'

Parameters

Name	Type	Description
hex	string	hex-string

Returns

string

format: hex-string

Defined in

src/utils/num.ts:74

---

isStringWholeNumber

▸ isStringWholeNumber(value): boolean

Test if string is whole number (0, 1, 2, 3...)

Parameters

Name	Type
value	string

Returns

boolean

Defined in

src/utils/num.ts:117

---

toCairoBool

▸ toCairoBool(value): string

Convert boolean to "0" or "1"

Parameters

Name	Type
value	boolean

Returns

string

Defined in

src/utils/num.ts:158