@zilliqa-js/util
Advanced tools
Readme
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.
int: number - the decimal number to convert.string[] - hexadecimal array representation of the decimal number.intToByteArray(num: number, size: number): Uint8ArrayConverts an integer to a Uint8Array (i.e., byte array).
num: number - the decimal number to convertUint8Array - byte array, padded to size.hexToByteArray(hex: string): Uint8ArrayConverts a hex-encoded string to a Uint8Array. Endianess is not important.
hex: stringUint8ArrayhexToIntArray(hex: string): number[]Converts a hex-encoded string to an array of integers.
hex: stringnumber[]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.
a: number - a 16-bit number.b: number - a 16-bit number.number - the combined 32-bit number.compareBytes(a: string, b: string): booleanPerforms a constant time comparison of two hexadecimal values. This avoids timing attacks.
a: string - hex-encoded string.b: string - hex-encoded string.boolean - true if the values are equal.isHex(str: string): booleanDetermines if a given string is hex-encoded.
str: string.boolean - true if the string is hex-encoded.isAddress(address: string): booleanDetermines if a given string is a valid address.
address: string.boolean - true if the string is an address.isBech32(address: string): booleanDetermines if a given string is a valid Zilliqa bech32 address.
address: string.boolean - true if the string is a valid Zilliqa bech32 address.isPrivateKey(privateKey: string): booleanDetermines if a given string is a valid private key.
privateKey: string.boolean - true if the string is a valid private key.isPubKey(pubKey: string): booleanDetermines if a given string is a valid uncompressed public key.
pubKey: string.boolean - true if the string is a valid public key.isSignature(sig: string): booleanDetermines if a given string is a valid Schnorr signature.
sig: stringboolean - true if the string is a valid signature.isNumber(x: unknown): booleanDetermines if a given value is a valid JS number.
x: unknownboolean - true if the string is a valid signature.isBN(x: unknown): booleanDetermines if a given value is an instance of BN.js.
x: unknownboolean - true if the value is a BN instance.isString(x: unknown): booleanDetermines if a given value is a valid JS string.
x: unknownboolean - 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).
x: unknownboolean - 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.
x: unknowntest: { [key: string]: Validator[] }boolean - true if the value matches test.fromQa(qa: BN, unit: Units, options: Options)Converts from qa (smallest unit) to zil or li.
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).
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.
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.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.