js-conflux-sdk
TypeScript icon, indicating that this package has built-in type declarations

2.4.5 • Public • Published

js-conflux-sdk

npm npm

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:
    1. Address conversion
    2. ABI/RLP encoding/decoding
    3. Crypto utilities
    4. 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

npm install js-conflux-sdk

How to import

Nodejs

Use in Node.js script

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

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

require deep nested file/dir

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

Frontend

umd

The front-packed package is located in js-conflux-sdk's dist folder.

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.TreeGraph.Conflux({
    url: 'https://test.confluxrpc.com',
    logger: console,
    networkId: 1,
  });
</script>

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.

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

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

const exampleAddress = 'cfxtest:aar8jzybzv0fhzreav49syxnzut8s0jt1a1pdeeuwb';

async function main() {
  const balance = await conflux.cfx.getBalance(exampleAddress);
  console.log(`Balance of ${exampleAddress} is ${Drip(balance).toCFX()} CFX`);

  const account = await conflux.wallet.addPrivateKey(process.env.PRIVATE_KEY); // prepare and set your private key as environment variable

  const txHash = await conflux.cfx.sendTransaction({
    from: account.address,
    to: exampleAddress,
    value: Drip.fromCFX(1), // send 1 CFX
  });

  console.log(`Transaction hash: ${txHash}`);

  // after the transaction is executed, you can query the receipt, and the receiver should have 1 CFX more
}

main().catch(console.error);

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

const { Conflux } = require('js-conflux-sdk');
const conflux = new Conflux({
  url: 'https://test.confluxrpc.com',
  networkId: 1,
});
console.log(conflux.version);
// 2.0.0

How to know fullnode's version

const clientVersion = await conflux.cfx.getClientVersion();
console.log(clientVersion);
// conflux-rust-2.0.0
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

Readme

Keywords

Package Sidebar

Install

npm i js-conflux-sdk

Weekly Downloads

918

Version

2.4.5

License

LGPL-3.0

Unpacked Size

5.14 MB

Total Files

217

Last publish

Collaborators

  • ypliu
  • geekberry
  • pana
  • wangdayong228