conflux-address-js
The simple encoder and decoder for Conflux address.
Check CIP-37 for the protocols.
Install
$ npm install @conflux-dev/conflux-address-js
Opt-in for performance
To gain a address conversion performance boost, you can install @conflux-dev/conflux-address-rust
in your project. Which will be used to replace the purejs version and can gain a 10-100
performance boost.
$ npm install --save-optional @conflux-dev/conflux-address-rust
Usage
Encoding
const confluxAddr = require('@conflux-dev/conflux-address-js')
const hexBuffer = Buffer.from('106d49f8505410eb4e671d51f7d96d2c87807b09', 'hex')
const netId = 1029
console.log(confluxAddr.encode(hexBuffer, netId))
console.log(confluxAddr.encode(hexBuffer, netId, true))
Decoding
const confluxAddr = require('@conflux-dev/conflux-address-js')
console.log(confluxAddr.decode('cfx:aajg4wt2mbmbb44sp6szd783ry0jtad5bea80xdy7p'))
console.log(confluxAddr.decode('CFX:TYPE.USER:AAJG4WT2MBMBB44SP6SZD783RY0JTAD5BEA80XDY7P'))
API
encode
: Low level encode methoddecode
: Low level decode methodisValidCfxAddress
: Return a boolean value indicating whether the address is validverifyCfxAddress
: Check whether a address is valid, if not will throw an errorhasNetworkPrefix
: Check a string whether has an network prefixsimplifyCfxAddress
: Return a non verbose addressshortenCfxAddress
: Return a shorten addressisZeroAddress
: Check whether a address is zero addressisInternalContractAddress
: Check where a address is Conflux InternalContract addressisValidHexAddress
: Check whether a address is valid hex addressisValidCfxHexAddress
: Check where a address is valid Conflux hex address