Home
JavaScript Conflux Software Development Kit is a complete library for interacting with the Conflux Blockchain in both Node.js and browser environment.
Features:
  • Can be used in both browser and Node.js environment
  • Connect to Conflux node over HTTP/Websocket JSON-RPC
  • Meta-classes create JavaScript objects from any contract ABI
  • Account utilities
  • Type converter, sign and hash utilities
  • Extensive documentation
  • Builtin support for CRC20 and Internal Contracts
  • Batch RPC support

Docs

Check SDK's documentation site for more info.

Install

Install through npm
1
$ npm install js-conflux-sdk
Copied!

How to import

Nodejs

Use in Node.js script
1
const { Conflux } = require('js-conflux-sdk');
2
3
const conflux = new Conflux({
4
url: 'https://test.confluxrpc.com',
5
networkId: 1,
6
logger: console, // for debug
7
});
Copied!
require deep nested file/dir
1
const util = require('js-conflux-sdk/src/util');
Copied!

Frontend

umd

The front packed package is located in js-conflux-sdk's dist folder.
1
import { Conflux } from 'js-conflux-sdk/dist/js-conflux-sdk.umd.min.js';
Copied!
or if your bundler supports the browser field in package.json
1
import { Conflux } from 'js-conflux-sdk';
Copied!
or
1
<script type="text/javascript" src="node_modules/js-conflux-sdk/dist/js-conflux-sdk.umd.min.js"></script>
2
<script type="text/javascript">
3
const conflux = new window.TreeGraph.Conflux({
4
url: 'https://test.confluxrpc.com',
5
logger: console,
6
networkId: 1,
7
});
8
</script>
Copied!
From v2.0 the exported class to browser window name change from Conflux to TreeGraph
Or you can use public CDN links:

Address conversion performance

To gain a address conversion(hex->base32 or reverse) performance boost, you can install @conflux-dev/conflux-address-rust in your project. Which will be used to relace 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
1
const { Conflux } = require('js-conflux-sdk');
2
const conflux = new Conflux({
3
url: 'https://test.confluxrpc.com',
4
networkId: 1,
5
});
6
console.log(conflux.version);
7
// 2.0.0
Copied!
How to know fullnode's version
1
const clientVersion = await conflux.cfx.getClientVersion();
2
console.log(clientVersion);
3
// conflux-rust-2.0.0
Copied!
js-conflux-sdk
conflux-rust(node)
v2.0.0+
v2.0.0+
v1.7.0+
v1.1.5+
v1.6.0+
v1.1.3+
v1.5.11+
v1.1.1+
Last modified 12d ago