conflux-web.js - Ethereum JavaScript API

This is the Ethereum JavaScript API which connects to the Generic JSON RPC spec.

You need to run a local or remote Ethereum node to use this library.

Please read the documentation for more.

Installation

Node

npm install conflux-web

Yarn

yarn add conflux-web

Meteor

meteor npm install --save conflux-web@0.x

Usage

import Web3 from 'conflux-web';

const conflux-web = new Web3('ws://localhost:8546');
console.log(conflux-web);
> {
    cfx: ... ,
    utils: ...,
    ...
}

Additionally you can set a provider using conflux-web.setProvider() (e.g. WebsocketProvider)

conflux-web.setProvider('ws://localhost:8546');
// or
conflux-web.setProvider(new Web3.providers.WebsocketProvider('ws://localhost:8546'));

There you go, now you can use it:

conflux-web.cfx.getAccounts()
.then(console.log);

Usage with TypeScript

We support types within the repo itself. Please open an issue here if you find any wrong types.

You can use conflux-web.js as follows:

import Web3 from 'conflux-web';
const conflux-web = new Web3("ws://localhost:8546");

If you are using the types in a commonjs module like for example a node app you just have to enable esModuleInterop in your tsconfig compile option, also enable allowSyntheticDefaultImports for typesystem compatibility:

"compilerOptions": {
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    ....

Documentation

Documentation can be found at read the docs

Contributing

All contributions have to go into the 1.0 branch
Please follow the code style of the other files, we use 4 spaces as tabs.

Requirements

Node.js
npm

Commands

npm run clean // removes all the node_modules folders in all modules
npm run bootstrap // install all dependencies and symlinks the internal modules for all modules
npm run test // runs all tests 
npm run build // runs rollup
npm run dev // runs rollup with a watcher