Nattily Primped Monster

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

    2.0.9 • Public • Published

    js-conflux-sdk

    npm npm

    JavaScript Conflux Software Development Kit is a complete library for interacting with the Conflux Blockchain in both Node.js and browser environment.

    Please read the documentation for more.

    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 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

    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.0.0+ v2.0.0+
    v1.7.0+ v1.1.5+
    v1.6.0+ v1.1.3+
    v1.5.11+ v1.1.1+

    Keywords

    Install

    npm i js-conflux-sdk

    DownloadsWeekly Downloads

    1,720

    Version

    2.0.9

    License

    LGPL-3.0

    Unpacked Size

    4.56 MB

    Total Files

    215

    Last publish

    Collaborators

    • ypliu
    • geekberry
    • pana
    • wangdayong228