External module harmony-utils
Functions
Const add0xToString
- add0xToString(obj: string): string
-
Parameters
Returns string
Const assertObject
- assertObject(input: any): (Anonymous function)
-
Parameters
Returns (Anonymous function)
Const fromWei
- fromWei(wei: BN | string, unit: Units, options?: any): string
-
Parameters
-
wei: BN | string
-
-
Default value options: any = DEFAULT_OPTIONS
Returns string
generateValidateObjects
- generateValidateObjects(validatorObject: {}): { optionalArgs: any; requiredArgs: any }
-
Parameters
Returns { optionalArgs: any; requiredArgs: any }
-
optionalArgs: any
-
requiredArgs: any
Const hexToNumber
- hexToNumber(hex: string): string
-
Parameters
Returns string
Const isAddress
- isAddress(address: string): boolean
-
Parameters
Returns boolean
Const isArray
- isArray(obj: any): boolean
-
Parameters
Returns boolean
[boolean]
Const isBech32Address
- isBech32Address(raw: string): boolean
-
Parameters
Returns boolean
Const isBech32TestNetAddress
- isBech32TestNetAddress(raw: string): boolean
-
Parameters
Returns boolean
Const isBlockNumber
- isBlockNumber(obj: any): boolean
-
Parameters
Returns boolean
Const isBoolean
- isBoolean(obj: any): boolean
-
Parameters
Returns boolean
[boolean]
Const isFunction
- isFunction(obj: any): boolean
-
Parameters
Returns boolean
[description]
Const isHash
- isHash(hash: string): boolean
-
Parameters
Returns boolean
Const isHex
-
Parameters
Returns boolean
Const isHttp
- isHttp(obj: any): boolean
-
Parameters
Returns boolean
Const isInt
-
Parameters
Returns boolean
[boolean]
Const isJsonString
- isJsonString(obj: any): boolean
-
Parameters
Returns boolean
[boolean]
Const isKeyString
- isKeyString(keyString: string, lengh: number): boolean
-
Parameters
-
keyString: string
-
lengh: number
Returns boolean
Const isNumber
- isNumber(obj: any): boolean
-
Parameters
Returns boolean
[boolean]
Const isObject
- isObject(obj: any): boolean
-
Parameters
Returns boolean
[boolean]
Const isPrivateKey
- isPrivateKey(privateKey: string): boolean
-
Parameters
Returns boolean
Const isPublicKey
- isPublicKey(publicKey: string): boolean
-
Parameters
Returns boolean
Const isString
- isString(obj: any): boolean
-
Parameters
Returns boolean
[boolean]
Const isValidAddress
- isValidAddress(address: string): boolean
-
Parameters
Returns boolean
Const isWs
-
Parameters
Returns boolean
Const numToStr
- numToStr(input: any): any
Const numberToHex
- numberToHex(obj: any): string
-
Parameters
Returns string
Const numberToString
- numberToString(obj: BN | number | string, radix?: number): string
-
Parameters
-
obj: BN | number | string
-
Default value radix: number = 10
Returns string
Const strip0x
- strip0x(obj: string): string
-
Parameters
Returns string
Const toWei
- toWei(input: BN | string, unit: Units): BN
validateArgs
- validateArgs(args: any, requiredArgs: any, optionalArgs: any): boolean
-
Parameters
-
args: any
-
requiredArgs: any
-
optionalArgs: any
Returns boolean
About this package
@harmony-js/util
provides utility functions for Harmony dapps and otherharmony-js
packagesDevelop can use this package to:
How to use this package
Step 1: create a Harmony Instance
const { Harmony } = require('@harmony-js/core'); const { ChainID, ChainType } = require('@harmony-js/utils'); const { BN } = require('@harmony-js/crypto'); const hmy = new Harmony( 'http://localhost:9500', { chainType: ChainType.Harmony, chainId: ChainID.HmyLocal, }, );
Step 2: Select and call functions
Here are some examples:
// numberToString const num = 123; const str = hmy.utils.numberToString(num) console.log(str); // add0xToString const str = '12345'; const expected = hmy.utils.add0xToString(str) console.log(expected); // fromWei const Wei = new BN('1000000000000000000'); const expected = hmy.utils.fromWei(Wei, hmy.utils.Units.one); console.log(expected); // toWei const one = new BN('1'); const expected = hmy.utils.toWei(one, hmy.utils.Units.one); const num = hmy.utils.numToStr(expected); console.log(num);
Step 3: Using unit class to convet the token unit
// convert one to Gwei const one = new hmy.utils.Unit('1').asOne(); const oneToGwei = one.toGwei(); console.log(oneToGwei);
Some Important consts and Enums
Chain Type
Harmony = 'hmy', Ethereum = 'eth',
Chain ID
Default = 0, EthMainnet = 1, Morden = 2, Ropsten = 3, Rinkeby = 4, RootstockMainnet = 30, RootstockTestnet = 31, Kovan = 42, EtcMainnet = 61, EtcTestnet = 62, Geth = 1337, Ganache = 0, HmyMainnet = 1, HmyTestnet = 2, HmyLocal = 2, HmyPangaea = 3,
Default Config
export const defaultConfig = { Default: { Chain_ID: ChainID.HmyLocal, Chain_Type: ChainType.Harmony, Chain_URL: 'http://localhost:9500', Network_ID: 'Local', }, DefaultWS: { Chain_ID: ChainID.HmyLocal, Chain_Type: ChainType.Harmony, Chain_URL: 'ws://localhost:9800', Network_ID: 'LocalWS', }, };
Unit Map
[Units.wei, '1'], // 1 wei [Units.Kwei, '1000'], // 1e3 wei [Units.Mwei, '1000000'], // 1e6 wei [Units.Gwei, '1000000000'], // 1e9 wei [Units.szabo, '1000000000000'], // 1e12 wei [Units.finney, '1000000000000000'], // 1e15 wei [Units.ether, '1000000000000000000'], // 1e18 wei [Units.one, '1000000000000000000'], // 1e18 wei [Units.Kether, '1000000000000000000000'], // 1e21 wei [Units.Mether, '1000000000000000000000000'], // 1e24 wei [Units.Gether, '1000000000000000000000000000'], // 1e27 wei [Units.Tether, '1000000000000000000000000000000'], // 1e30 wei