Home
JavaScript Conflux Software Development Kit is a complete library for interacting with the Conflux Blockchain Core Space in both Node.js and browser environment.
Featured with:
Full support of Conflux Network Core Space's JSON-RPC API
Wallet management
Meta-classes create JavaScript objects from any contract ABI, including ABIv2 and Human-Readable ABI
Unit(CFX, Drip) conversion
Common utilities:
Address conversion
ABI/RLP encoding/decoding
Crypto utilities
Type conversion
Extensive documentation and examples
For the Conflux eSpace JS SDK, consider using one of the following robust libraries: ethers.js, viem, or web3.js
Docs
Install
Install through npm
How to import
Nodejs
Use in Node.js script
require deep nested file/dir
Frontend
umd
The front-packed package is located in js-conflux-sdk
's dist folder.
or if your bundler supports the browser
field in package.json
or
From v2.0
the exported root class to browser window name changed from Conflux to TreeGraph
Or you can use public CDN links:
Quick Start
After importing the package, you can use the Conflux
class instance to interact with the Conflux network, such as querying the balance of an account, sending a transaction.
For more guides and examples, please refer to the SDK documentation.
Address conversion performance
To gain an address conversion(hex->base32 or reverse) 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.
Note: @conflux-dev/conflux-address-rust required a rust environment to install.
SDK version relation with Conflux-rust
How to know SDK's version
How to know fullnode's version
js-conflux-sdk | conflux-rust(node) |
---|---|
v2.4.0+ | v2.4.0+ |
v2.0.0+ | v2.0.0+ |
v1.7.0+ | v1.1.5+ |
v1.6.0+ | v1.1.3+ |
v1.5.11+ | v1.1.1+ |
Related Projects | Tools
CIP-23 can be used to work with Conflux signTypedData
hardhat-conflux hardhat plugin that can be used to interact with Conflux Core Network Contracts
@conflux-dev/hdwallet HD Wallet
Last updated