Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@burstjs/util

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@burstjs/util

Useful utilities and tools for building Burstcoin applications

0.6.0-alpha.8
Source
npm

Version published: 4 years ago

Weekly downloads: 18; decreased by-28%

Maintainers: 2

Weekly downloads

Created: 6 years ago

Source

@burstjs/util

Useful utilities and tools for building Burstcoin applications

Installation

@burstjs/http can be used with NodeJS or Web. Two formats are available

Using with NodeJS and/or modern web frameworks

Install using npm:

npm install @burstjs/util

or using yarn:

yarn add @burstjs/util

Example

import {convertNumberToNQTString} from '@burstjs/util'

const value = convertNumberToNQTString(1000)
console.log(value)

Using in classic `<script>`

Each package is available as bundled standalone library using IIFE. This way burstJS can be used also within <script>-Tags. This might be useful for Wordpress and/or other PHP applications.

Just import the package using the HTML <script> tag.

<script src='https://cdn.jsdelivr.net/npm/@burstjs/util/dist/util.crypto.min.js'></script>

Example

const value = b$util.convertNumberToNQTString(1000)
console.log(value)

See more here:

@burstjs/util Online Documentation

API Reference

Modules

util

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

util

util
- static
  - .isValid ⇒ boolean
- inner
  - ~convertAddressToNumericId(address) ⇒
  - ~convertBurstTimeToDate(burstTimestamp) ⇒
  - ~convertBurstTimeToEpochTime(burstTimestamp) ⇒
  - ~convertByteArrayToHexString(bytes, uppercase) ⇒ string
  - ~convertByteArrayToString(byteArray, startIndex, length) ⇒ string
  - ~convertDateToBurstTime(date) ⇒
  - ~convertHexEndianess(hexString) ⇒
  - ~convertHexStringToByteArray(hex) ⇒ Array.<number>
  - ~convertHexStringToDecString(hexStr) ⇒
  - ~convertHexStringToString(hex) ⇒ string
  - ~convertNQTStringToNumber(amount) ⇒
  - ~convertNumberToNQTString(n) ⇒
  - ~convertNumericIdToAddress(numericId) ⇒
  - ~convertStringToByteArray(str) ⇒ Array.<number>
  - ~convertStringToHexString(str) ⇒ string
  - ~isValid(address) ⇒ boolean
  - ~sumNQTStringToNumber(...nqts) ⇒

util.isValid ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: static property of util
Returns: boolean -

true, if is a valid address, else false

Note: This is with prior quick check

Param	Type	Description
address	`string`	The address

util~convertAddressToNumericId(address) ⇒

Converts BURST-XXXX-XXXX-XXXX-XXXXX into numeric Id

Kind: inner method of util
Returns:

The numeric id, or undefined if address is invalid

Param	Description
address	The BURST address

util~convertBurstTimeToDate(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Date

Kind: inner method of util
Returns:

Date

Param	Description
burstTimestamp	The numeric Id

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

Converts a Burst/Block Time (seconds since genesis block) into Unix Epoch Time (milliseconds since 01.01.1970)

Kind: inner method of util
Returns:

Unix Epoch Time (milliseconds since 01.01.1970)

Param	Description
burstTimestamp	The numeric Id

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

Converts byte array to hexadecimal string Inverse operation of [[convertHexStringToByteArray]]

Kind: inner method of util
Returns: string -

A hex string representing the byte array input

Param	Default	Description
bytes		The (unsigned) byte array to be converted
uppercase	`false`	If true, converts hex string with uppercase characters (Default: false)

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

Converts a byte array into string Inverse function [[convertStringToByteArray]]

Kind: inner method of util
Returns: string -

The converted string

Param	Default	Description
byteArray		The byte array to be converted
startIndex	`0`	The starting index of array to be converted (Default: 0)
length		The number of bytes to be considered, iff startIndex is given. If null the byte array's length is considered

util~convertDateToBurstTime(date) ⇒

Converts a Date into Burst/Block Time (seconds since genesis block)

Kind: inner method of util
Returns:

The Burst Timestamp

Param	Description
date	The date to be converted

util~convertHexEndianess(hexString) ⇒

Converts the endianess of a hex string. If string is little Endianess it turns into Big Endianess, and vice versa

Kind: inner method of util
Returns:

The converted string as hex string

Param	Description
hexString	The hex string to be converted

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

Converts an hexadecimal string to byte array

Kind: inner method of util
Returns: Array.<number> -

An byte array representing the hexadecimal input

Param	Description
hex	The hexadecimal string to be converted

util~convertHexStringToDecString(hexStr) ⇒

Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string

Kind: inner method of util
Returns:

A decimal string

Param	Description
hexStr	A hexadecimal string

util~convertHexStringToString(hex) ⇒ `string`

Converts a Hexadecimally encoded string into String Inverse function [[convertStringToHexString]]

Kind: inner method of util
Returns: string -

The string represented by the Hex String

Param	Description
hex	The Hex string to be converted

util~convertNQTStringToNumber(amount) ⇒

Helper method to convert a String to number

Kind: inner method of util
Returns:

A number expressed in Burst (not NQT)

Throws:

exception if argument is invalid

Param	Description
amount	The amount in NQT

util~convertNumberToNQTString(n) ⇒

Helper method to Number to String(8 decimals) representation

Kind: inner method of util
Returns:

a NQT number string

Param	Description
n	the number

util~convertNumericIdToAddress(numericId) ⇒

Encode a numeric id into BURST-XXXX-XXXX-XXXX-XXXXX

Kind: inner method of util
Returns:

the BURST address in Reed-Solomon encoding, or undefined if passed null, undefined

Param	Description
numericId	The numeric Id

util~convertStringToByteArray(str) ⇒ `Array.<number>`

Converts a string into byte array Inverse function [[convertByteArrayToString]]

Kind: inner method of util
Returns: Array.<number> -

A byte array representing the string input

Param	Description
str	The string to be converted

util~convertStringToHexString(str) ⇒ `string`

Converts/Encode a String into Hexadecimally encoded Inverse function [[convertHexStringToString]]

Kind: inner method of util
Returns: string -

The Hex String representing the input string

Param	Description
str	The Hex string to be converted

util~isValid(address) ⇒ `boolean`

Check for valid Burst address (format: BURST-XXXX-XXXX-XXXX-XXXXX, XXXX-XXXX-XXXX-XXXXX)

Kind: inner method of util
Returns: boolean -

true, if is a valid address, else false

Param	Type	Description
address	`string`	The address

util~sumNQTStringToNumber(...nqts) ⇒

Sums various NQT values and returns in Burst

Kind: inner method of util
Returns:

The sum of all amounts in BURST

Param	Description
...nqts	Variable amount list with NQT string

Keywords

FAQs

What is @burstjs/util?

Is @burstjs/util popular?

Is @burstjs/util well maintained?

Package last updated on 10 Dec 2020

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.

Install

@burstjs/util

@burstjs/util

Installation

Using with NodeJS and/or modern web frameworks

Example

Using in classic <script>

Example

API Reference

Modules

util

util.isValid ⇒ boolean

util~convertAddressToNumericId(address) ⇒

util~convertBurstTimeToDate(burstTimestamp) ⇒

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

util~convertByteArrayToHexString(bytes, uppercase) ⇒ string

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ string

util~convertDateToBurstTime(date) ⇒

util~convertHexEndianess(hexString) ⇒

util~convertHexStringToByteArray(hex) ⇒ Array.<number>

util~convertHexStringToDecString(hexStr) ⇒

util~convertHexStringToString(hex) ⇒ string

util~convertNQTStringToNumber(amount) ⇒

util~convertNumberToNQTString(n) ⇒

util~convertNumericIdToAddress(numericId) ⇒

util~convertStringToByteArray(str) ⇒ Array.<number>

util~convertStringToHexString(str) ⇒ string

util~isValid(address) ⇒ boolean

util~sumNQTStringToNumber(...nqts) ⇒

util

util.isValid ⇒ boolean

util~convertAddressToNumericId(address) ⇒

util~convertBurstTimeToDate(burstTimestamp) ⇒

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

util~convertByteArrayToHexString(bytes, uppercase) ⇒ string

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ string

util~convertDateToBurstTime(date) ⇒

util~convertHexEndianess(hexString) ⇒

util~convertHexStringToByteArray(hex) ⇒ Array.<number>

util~convertHexStringToDecString(hexStr) ⇒

util~convertHexStringToString(hex) ⇒ string

util~convertNQTStringToNumber(amount) ⇒

util~convertNumberToNQTString(n) ⇒

util~convertNumericIdToAddress(numericId) ⇒

util~convertStringToByteArray(str) ⇒ Array.<number>

util~convertStringToHexString(str) ⇒ string

util~isValid(address) ⇒ boolean

util~sumNQTStringToNumber(...nqts) ⇒

util

util.isValid ⇒ boolean

util~convertAddressToNumericId(address) ⇒

util~convertBurstTimeToDate(burstTimestamp) ⇒

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

util~convertByteArrayToHexString(bytes, uppercase) ⇒ string

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ string

util~convertDateToBurstTime(date) ⇒

util~convertHexEndianess(hexString) ⇒

util~convertHexStringToByteArray(hex) ⇒ Array.<number>

util~convertHexStringToDecString(hexStr) ⇒

util~convertHexStringToString(hex) ⇒ string

util~convertNQTStringToNumber(amount) ⇒

util~convertNumberToNQTString(n) ⇒

util~convertNumericIdToAddress(numericId) ⇒

util~convertStringToByteArray(str) ⇒ Array.<number>

util~convertStringToHexString(str) ⇒ string

util~isValid(address) ⇒ boolean

util~sumNQTStringToNumber(...nqts) ⇒

util

util.isValid ⇒ boolean

util~convertAddressToNumericId(address) ⇒

util~convertBurstTimeToDate(burstTimestamp) ⇒

util~convertBurstTimeToEpochTime(burstTimestamp) ⇒

util~convertByteArrayToHexString(bytes, uppercase) ⇒ string

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ string

util~convertDateToBurstTime(date) ⇒

util~convertHexEndianess(hexString) ⇒

util~convertHexStringToByteArray(hex) ⇒ Array.<number>

util~convertHexStringToDecString(hexStr) ⇒

util~convertHexStringToString(hex) ⇒ string

util~convertNQTStringToNumber(amount) ⇒

util~convertNumberToNQTString(n) ⇒

Using in classic `<script>`

util.isValid ⇒ `boolean`

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

util~convertHexStringToString(hex) ⇒ `string`

util~convertStringToByteArray(str) ⇒ `Array.<number>`

util~convertStringToHexString(str) ⇒ `string`

util~isValid(address) ⇒ `boolean`

util.isValid ⇒ `boolean`

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

util~convertHexStringToString(hex) ⇒ `string`

util~convertStringToByteArray(str) ⇒ `Array.<number>`

util~convertStringToHexString(str) ⇒ `string`

util~isValid(address) ⇒ `boolean`

util.isValid ⇒ `boolean`

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

util~convertHexStringToString(hex) ⇒ `string`

util~convertStringToByteArray(str) ⇒ `Array.<number>`

util~convertStringToHexString(str) ⇒ `string`

util~isValid(address) ⇒ `boolean`

util.isValid ⇒ `boolean`

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

util~convertHexStringToString(hex) ⇒ `string`

util~convertStringToByteArray(str) ⇒ `Array.<number>`

util~convertStringToHexString(str) ⇒ `string`

util~isValid(address) ⇒ `boolean`

util.isValid ⇒ `boolean`

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

util~convertHexStringToString(hex) ⇒ `string`

util~convertStringToByteArray(str) ⇒ `Array.<number>`

util~convertStringToHexString(str) ⇒ `string`

util~isValid(address) ⇒ `boolean`

util.isValid ⇒ `boolean`

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

util~convertHexStringToString(hex) ⇒ `string`

util~convertStringToByteArray(str) ⇒ `Array.<number>`

util~convertStringToHexString(str) ⇒ `string`

util~isValid(address) ⇒ `boolean`

util.isValid ⇒ `boolean`

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`

util~convertHexStringToByteArray(hex) ⇒ `Array.<number>`

util~convertHexStringToString(hex) ⇒ `string`

util~convertStringToByteArray(str) ⇒ `Array.<number>`

util~convertStringToHexString(str) ⇒ `string`

util~isValid(address) ⇒ `boolean`

util.isValid ⇒ `boolean`

util~convertByteArrayToHexString(bytes, uppercase) ⇒ `string`

util~convertByteArrayToString(byteArray, startIndex, length) ⇒ `string`