README.md

js-conflux-sdk

JavaScript Conflux Software Development Kit is a complete library for interacting with the Conflux Blockchain.

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

Docs

• Overview
• Complete document for sending transaction
• Interact with contract
• SDK support for CIP37 address
• API
• Error handling
• Conflux Official document
• Conflux RPC endpoints

Quick Start

Nodejs

const { Conflux } = require('js-conflux-sdk');

const conflux = new Conflux({
  url: 'https://test.confluxrpc.com',
  networkId: 1,
  logger: console, // for debug
});

require deep nested file/dir

const util = require('js-conflux-sdk/src/util');

Frontend

umd

import { Conflux } from 'js-conflux-sdk/dist/js-conflux-sdk.umd.min.js';

or if your bundler supports the browser field in package.json

import { Conflux } from 'js-conflux-sdk';

or

<script type="text/javascript" src="node_modules/js-conflux-sdk/dist/js-conflux-sdk.umd.min.js"></script>
<script type="text/javascript">
  const conflux = new window.Conflux.Conflux({
    url: 'https://test.confluxrpc.com',
    logger: console,
    networkId: 1,
  });
</script>

CDN links

• jsdelivr

SDK version relation with Conflux-rust

How to know SDK's version

const { Conflux } = require('js-conflux-sdk');
const cfx = new Conflux({
  url: 'xxxx',
  networkId: 1,
});
console.log(cfx.version);

How to know fullnode's version

const clientVersion = await cfx.getClientVersion();
console.log(clientVersion);

js-conflux-sdk	conflux-rust(node)
v1.7.0+	v1.1.5+
v1.6.0+	v1.1.3+
v1.5.11+	v1.1.1+