This is a node.js module binding to cfx-addr.
This project was bootstrapped by create-neon.
Installing conflux-address-rust requires a supported version of Node and Rust.
You can install the project with npm. In the project directory, run:
$ npm install @conflux-dev/conflux-address-rust
This fully installs the project, including installing any dependencies and running the build.
After installing, you can explore its exports as below:
const {encode, decode} = require('@conflux-dev/conflux-address-rust');
decode('cfxtest:aak2rra2njvd77ezwjvx04kkds9fzagfe6d5r8e957');
/* {
hexAddress: '0x1386b4185a223ef49592233b69291bbe5a80c527',
netId: 1,
type: 'user'
} */
encode('0x1386b4185a223ef49592233b69291bbe5a80c527', 1, true)
// 'CFXTEST:TYPE.USER:AAK2RRA2NJVD77EZWJVX04KKDS9FZAGFE6D5R8E957'
encode('0x1386b4185a223ef49592233b69291bbe5a80c527', 1, false)
// 'cfxtest:aak2rra2njvd77ezwjvx04kkds9fzagfe6d5r8e957'
encode('0x1386b4185a223ef49592233b69291bbe5a80c527', 1, true)
// 'CFXTEST:TYPE.USER:AAK2RRA2NJVD77EZWJVX04KKDS9FZAGFE6D5R8E957'
encode('0x1386b4185a223ef49592233b69291bbe5a80c527', 1029, true)
// 'CFX:TYPE.USER:AAK2RRA2NJVD77EZWJVX04KKDS9FZAGFE6KU8SCZ91'
address(string)
: hex40 addressnetId(number)
: network id- [
verbose(bool)
]: whether encode as verbose
address(string)
: base32 address
address(string)
: base32 encoded address
hexAddress(string)
: buffernetId(number)
: network idtype(string)
: address type
In the project directory, you can run:
Installs the project, including running npm run build
.
Builds the Node addon (index.node
) from source.
This command uses the cargo-cp-artifact utility to run the Rust build and copy the built library into ./index.node
.
Additional cargo build
arguments may be passed to npm build
and npm build-*
commands. For example, to enable a cargo feature:
npm run build -- --feature=beetle
Alias for npm build
.
Same as npm build
but, builds the module with the release
profile. Release builds will compile slower, but run faster.
Runs the unit tests by calling cargo test
. You can learn more about adding tests to your Rust code from the Rust book.