meterify.utils
Last updated
Was this helpful?
Last updated
Was this helpful?
This package provides utility functions for dapps and other packages.
The library to generate cryptographically strong pseudo-random HEX strings from a given byte size.
Example:
Parameters:
size
- Number
: The byte size for the HEX string, e.g. 32
will result in a 32 bytes HEX string with 64 characters preficed with "0x".
Returns:
String
: The generated random HEX string.
Example:
Parameters:
value
- String|Number
: A number, number string or HEX string to convert to a BN object.
Returns:
Example:
Parameters:
Returns:
Boolean
Example:
Parameters:
Returns:
Boolean
Will calculate the keccak256 of the input.
Example:
Parameters:
string
- String
: A string to hash.
Returns:
String
: the result hash.
Will calculate the sha3 of given input parameters in the same way solidity would. This means arguments will be ABI converted and tightly packed before being hashed.
Example:
Parameters:
paramX
- Mixed
: Any type, or an object with {type: 'uint', value: '123456'}
or {t: 'bytes', v: '0xfff456'}
. Basic types are autodetected as follows:
String
non numerical UTF-8 string is interpreted as string
.
String|Number|BN|HEX
positive number is interpreted as uint256
.
String|Number|BN
negative number is interpreted as int256
.
Boolean
as bool
.
String
HEX string with leading 0x
is interpreted as bytes
.
HEX
HEX number representation is interpreted as uint256
.
Returns:
String
: the result hash.
Checks if a given string is a HEX string.
Example:
Parameters:
hex
- String|HEX
: The given HEX string.
Returns:
Boolean
Checks if a given string is a HEX string. Difference to meterify.utils.isHex()
is that it expects HEX to be prefixed with 0x
.
Example:
Parameters:
hex
- String|HEX
: The given HEX string.
Returns:
Boolean
Checks if a given string is a valid Meter address. It will also check the checksum, if the address has upper and lowercase letters.
Example:
Parameters:
address
- String
: An address string.
Returns:
Boolean
Will convert an upper or lowercase Meter address to a checksum address.
Example:
Parameters:
address
- String
: An address string.
Returns:
String
: The checksum address.
Removes the prefix 0x
from a given hex if it exists.
Example:
Parameters:
hex
- String
: Hex
Returns:
String
: Hex without prefix.
Checks the checksum of a given address. Will also return false on non-checksum addresses.
Example:
Parameters:
address
- String
: An address string.
Returns:
Boolean
: true
when the checksum of the address is valid, false
if its not a checksum address, or the checksum is invalid.
Will auto convert any given value to HEX. Number strings will interpreted as numbers. Text strings will be interpreted as UTF-8 strings.
Example:
Parameters:
value
- String|Number|BN|BigNumber
: The input to convert to HEX.
Returns:
String
: The resulting HEX string.
Example:
Parameters:
number
- String|Number|HEX
: Number to convert to a big number.
Returns:
Returns the number representation of a given HEX value as a string.
Example:
Parameters:
hexString
- String|HEX
: A string to hash.
Returns:
String
: The number as a string.
Returns the number representation of a given HEX value.
Example:
Parameters:
hexString
- String|HEX
: A string to hash.
Returns:
Number
Returns the HEX representation of a given number value.
Example:
Parameters:
number
- String|Number|BN|BigNumber
: A number as string or number.
Returns:
String
: The HEX value of the given number.
Returns the UTF-8 string representation of a given HEX value.
Example:
Parameters:
hex
- String
: A HEX string to convert to a UTF-8 string.
Returns:
String
: The UTF-8 string.
Returns the ASCII string representation of a given HEX value.
Example:
Parameters:
hex
- String
: A HEX string to convert to a ASCII string.
Returns:
String
: The ASCII string.
Returns the HEX representation of a given UTF-8 string.
Example:
Parameters:
string
- String
: A UTF-8 string to convert to a HEX string.
Returns:
String
: The HEX string.
Returns the HEX representation of a given ASCII string. If you would like to transform an ASCII string into a valid bytes4
, bytes8
etc. value then please pass the correct length as the second parameter.
Example:
Parameters:
string
- String
: A ASCII string to convert to a HEX string.
length
- Number
: The length of the returned hex string. The default size is 32
e.g.: bytes32
.
Returns:
String
: The HEX string.
Returns a byte array from the given HEX string.
Example:
Parameters:
hex
- String|HEX
: A HEX to convert.
Returns:
Array
: The byte array.
Returns a HEX string from a byte array.
Example:
Parameters:
byteArray
- Array
: A byte array to convert.
Returns:
String
: The HEX string.
Converts a Meter value into wei
.
Example:
Note: wei
are the smallest conversion unit, and you should always make calculations in wei
and convert only for display reasons.
Parameters:
number
- String|BN
: The value.
unit
- String
(optional, defaults to "ether"
): The ether to convert from. Possible units are:
noether
: '0'
wei
: '1'
kwei
: '1000'
Kwei
: '1000'
babbage
: '1000'
femtoether
: '1000'
mwei
: '1000000'
Mwei
: '1000000'
lovelace
: '1000000'
picoether
: '1000000'
gwei
: '1000000000'
Gwei
: '1000000000'
shannon
: '1000000000'
nanoether
: '1000000000'
nano
: '1000000000'
szabo
: '1000000000000'
microether
: '1000000000000'
micro
: '1000000000000'
finney
: '1000000000000000'
milliether
: '1000000000000000'
milli
: '1000000000000000'
ether
: '1000000000000000000'
kether
: '1000000000000000000000'
grand
: '1000000000000000000000'
mether
: '1000000000000000000000000'
gether
: '1000000000000000000000000000'
tether
: '1000000000000000000000000000000'
Returns:
Converts any wei
value into another value.
Example:
Note: wei
are the smallest conversion unit, and you should always make calculations in wei and convert only for display reasons.
Parameters:
number
- String|BN
: The value in wei.
unit
- String
(optional, defaults to "ether"
): The ether to convert to. Possible units are:
noether
: '0'
wei
: '1'
kwei
: '1000'
Kwei
: '1000'
babbage
: '1000'
femtoether
: '1000'
mwei
: '1000000'
Mwei
: '1000000'
lovelace
: '1000000'
picoether
: '1000000'
gwei
: '1000000000'
Gwei
: '1000000000'
shannon
: '1000000000'
nanoether
: '1000000000'
nano
: '1000000000'
szabo
: '1000000000000'
microether
: '1000000000000'
micro
: '1000000000000'
finney
: '1000000000000000'
milliether
: '1000000000000000'
milli
: '1000000000000000'
ether
: '1000000000000000000'
kether
: '1000000000000000000000'
grand
: '1000000000000000000000'
mether
: '1000000000000000000000000'
gether
: '1000000000000000000000000000'
tether
: '1000000000000000000000000000000'
Returns:
String
: It always returns a string number.
Shows all possible values and their amount in wei
.
Example:
Return value:
Object
with the following properties:
noether
: '0'
wei
: '1'
kwei
: '1000'
Kwei
: '1000'
babbage
: '1000'
femtoether
: '1000'
mwei
: '1000000'
Mwei
: '1000000'
lovelace
: '1000000'
picoether
: '1000000'
gwei
: '1000000000'
Gwei
: '1000000000'
shannon
: '1000000000'
nanoether
: '1000000000'
nano
: '1000000000'
szabo
: '1000000000000'
microether
: '1000000000000'
micro
: '1000000000000'
finney
: '1000000000000000'
milliether
: '1000000000000000'
milli
: '1000000000000000'
ether
: '1000000000000000000'
kether
: '1000000000000000000000'
grand
: '1000000000000000000000'
mether
: '1000000000000000000000000'
gether
: '1000000000000000000000000000'
tether
: '1000000000000000000000000000000'
Adds a padding on the left of a string. Useful for adding paddings to HEX strings.
Example:
Parameters:
string
- String
: The string to add padding on the left.
characterAmount
- Number
: The number of characters the total string should have.
sign
- String
(optional): The character sign to use, defaults to "0"
.
Returns:
String
: The padded string.
Adds a padding on the right of a string, Useful for adding paddings to HEX strings.
Example:
Parameters:
string
- String
: The string to add padding on the right.
characterAmount
- Number
: The number of characters the total string should have.
sign
- String
(optional): The character sign to use, defaults to "0"
.
Returns:
String
: The padded string.
Converts a negative number into a two's complement.
Example:
Parameters:
number
- Number|String|BigNumber
: The number to convert.
Returns:
String
: The converted hex string.
Gets the r, s and v values of an ECDSA signature
Example
Parameters:
string
- String
: An ECDSA signature.
Returns:
Object
: Object containing r,s,v values.
The library for calculating with big numbers in JavaScript. See the for details.
Note: For safe conversion of many types, including , use .
Object
: The _ instance.
Checks if a given value is a instance.
bn
- Object
: An instance.
Checks if a given value is a instance.
BigNumber
- Object
: A instance.
Note: To mimic the keccak256 behavior of Solidity, use .
chainId
- number
(optional): Chain id where checksummed address should be valid, defaults to null
. for details.
chainId
- number
(optional): Chain id where checksummed address should be valid, defaults to null
. for details.
chainId
- number
(optional): Chain id where checksummed address should be valid, defaults to null
. for details.
Will safely convert any given value (including instances) into a instance, for handling big numbers in JavaScript.
Note: For just the class use .
Object
: The instance.
Note: This is not useful for big numbers, use instead.
String|BN
: If a string is given it returns a number string, otherwise a instance.