@zilliqa-js/util
Advanced tools
Utility functions useful in Zilliqa-related programs.
BNSee documentation at bn.js. This is
simply a re-export of that library to prevent bloating other @zilliqa-js
packages, most of which depend on bn.js in small ways.
LongSee documentation at long.js. This is
simply a re-export for similar reasons. Note that long is only required if
you need to serialise integers with size greater than or equal to 2^53.
PRESETSCommonly used variables such as DEVNET_URL. See source for more info.
intToHexArray(int: number, size: number): string[]Converts an integer to an array of hexadecimal strings (little endian). Size is the total length of bytes to pad to.
Parameters
int: number - the decimal number to convert.Returns
string[] - hexadecimal array representation of the decimal number.intToByteArray(num: number, size: number): Uint8ArrayConverts an integer to a Uint8Array (i.e., byte array).
Parameters
num: number - the decimal number to convertReturns
Uint8Array - byte array, padded to size.hexToByteArray(hex: string): Uint8ArrayConverts a hex-encoded string to a Uint8Array. Endianess is not important.
Parameters
hex: stringReturns
Uint8ArrayhexToIntArray(hex: string): number[]Converts a hex-encoded string to an array of integers.
Parameters
hex: stringReturns
number[]pack(a: number, b: number): numberPerforms bitwise addition of two 16-bit numbers, returning a 32-bit number. Throws if either number exceeds 16 bits.
Parameters
a: number - a 16-bit number.b: number - a 16-bit number.Returns
number - the combined 32-bit number.compareBytes(a: string, b: string): booleanPerforms a constant time comparison of two hexadecimal values. This avoids timing attacks.
Parameters
a: string - hex-encoded string.b: string - hex-encoded string.Returns
boolean - true if the values are equal.isHex(str: string): booleanDetermines if a given string is hex-encoded.
Parameters
str: string.Returns
boolean - true if the string is hex-encoded.isAddress(address: string): booleanDetermines if a given string is a valid address.
Parameters
address: string.Returns
boolean - true if the string is an address.isBech32(address: string): booleanDetermines if a given string is a valid Zilliqa bech32 address.
Parameters
address: string.Returns
boolean - true if the string is a valid Zilliqa bech32 address.isPrivateKey(privateKey: string): booleanDetermines if a given string is a valid private key.
Parameters
privateKey: string.Returns
boolean - true if the string is a valid private key.isPubKey(pubKey: string): booleanDetermines if a given string is a valid uncompressed public key.
Parameters
pubKey: string.Returns
boolean - true if the string is a valid public key.isSignature(sig: string): booleanDetermines if a given string is a valid Schnorr signature.
Parameters
sig: stringReturns
boolean - true if the string is a valid signature.isNumber(x: unknown): booleanDetermines if a given value is a valid JS number.
Parameters
x: unknownReturns
boolean - true if the string is a valid signature.isBN(x: unknown): booleanDetermines if a given value is an instance of BN.js.
Parameters
x: unknownReturns
boolean - true if the value is a BN instance.isString(x: unknown): booleanDetermines if a given value is a valid JS string.
Parameters
x: unknownReturns
boolean - true if the value is a string.isPlainObject(x: unknown): booleanDetermines if a given value is a plain JS object (i.e. directly below
Object in the prototype chain).
Parameters
x: unknownReturns
boolean - true if the value is a plain object.matchesObject(x: unknown, test: { [key: string]: Validator[] }): booleanDetermines if a value has the shape specified by test.
Parameters
x: unknowntest: { [key: string]: Validator[] }Returns
boolean - true if the value matches test.fromQa(qa: BN, unit: Units, options: Options)Converts from qa (smallest unit) to zil or li.
Parameters
qa: BN - the value to convert from.unit: Units - the unit to be converted to ('zil' | 'qa').options: Options - an object specifying options.toQa(input: string | number | BN, unit: Units)Converts zil or li to qa (smallest unit).
Parameters
input: string | number | BN - the value to convert from.unit: Units - the unit to be converted from ('zil' | 'li').FAQs
Utilities for working with Zilliqa.
The npm package @zilliqa-js/util receives a total of 1,935 weekly downloads. As such, @zilliqa-js/util popularity was classified as popular.
We found that @zilliqa-js/util demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.