ilanolkies/rsk-utils

rsk-utils

A collection of JS utility functions for RSK.

Addresses

isAddress(address) ⇒ Boolean

Check if a string is an address

Kind: global function
Params

• address String

toChecksumAddress(address, chainId) ⇒ String

Implements EIP-1191 Address Checksum

Kind: global function
Returns: String - checksummed address
Params

• address String
• chainId Integer | String

isValidChecksumAddress(address, chainId) ⇒ Boolean

Validates address checksum

Kind: global function
Params

• address String
• chainId Integer | String

isValidAddress(address, chainId) ⇒ Boolean

Checks if an address is valid.

Kind: global function
Params

• address String
• chainId Integer | String

searchChecksummedNetworks(address, [networks]) ⇒ Array

Search network info of checksummed address

Kind: global function
Params

• address String
• [networks] Array - chainId list see: https://chainid.network/chains.json

Arrays

arrayIntersection(a, b) ⇒ Array

Kind: global function
Returns: Array - a ∩ b
Params

• a Array
• b Array

arrayDifference(a, b) ⇒ Array

Kind: global function
Returns: Array - a - b
Params

• a Array
• b Array

arraySymmetricDifference(a, b) ⇒ Array

Kind: global function
Returns: Array - a - b
Params

• a Array
• b Array

hasValue(haystack, needle) ⇒ Boolean

Check if an array contains some of the searched items

Kind: global function
Params

• haystack Array
• needle Array

includesAll(haystack, needle) ⇒ Boolean

Check if an array contains all the searched items

Kind: global function
Params

• haystack Array
• needle Array

Hashes

keccak256(input, [format]) ⇒ Buffer

Creates Keccak sha256 hash

Kind: global function
Params

• input String | Number | Array | Buffer
• [format] String = 'hex'

Strings

isHexString(str) ⇒ Boolean

Checks if a string is hex string

Kind: global function
Params

• str String

add0x(str) ⇒ String

Add '0x' at start of hex strings, honoring prefix

Kind: global function
Params

• str String

hasHexPrefix(str) ⇒ Boolean

Checks if string is hex prefixed

Kind: global function
Params

• str String

stripHexPrefix(str) ⇒ String

remove 0x from start of string

Kind: global function
Params

• str String

remove0x(value) ⇒ Any

Remove '0x' from hex strings, honoring prefix

Kind: global function
Returns: Any - if value is hex string, {String} without '0x'
Params

• value Any

isTxOrBlockHash(str) ⇒ Boolean

Checks if a string is a tx or block hash

Kind: global function
Returns: Boolean - '
Params

• str string