yqrashawn / js-conflux-sdk

The JavaScript SDK for Conflux Chain

js-conflux-sdk

JavaScript Conflux Software Development Kit

1.0 Key features

1. Add cfx.wallet to manage multiple accounts, which has replace v0.13's cfx.Account.
2. Add cfx.InternalContract(name) to interact with Conflux internal contracts.
3. Add websocket provider, support pub/sub
4. Provide Drip to easily convert unit between CFX, Drip, Gdrip
5. Use JSBI for front-end, native BigInt for back-end

Check the complete changelog

Quick Usage

Nodejs

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

const conflux = new Conflux({
  url: 'http://test.confluxrpc.org',
  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: 'http://test.confluxrpc.org',
    logger: console,
  });
</script>

Documentation

• Quick Intro (Recommend to read)
• Complete document for send transaction
• Interacting with contract
• API

TODO

• support CIP 23