0.1.1 • Published 7 years ago

web3-quorum v0.1.1

Weekly downloads
29
License
LGPL-3.0
Repository
github
Last release
7 years ago

Ethereum & Quorum JavaScript API

Join the chat at https://gitter.im/ethereum/web3.js

This is the fork version of the Web3 API Ethereum compatible JavaScript API which is extended to support the Quorum API.

NPM version Build Status dependency status dev dependency status Coverage Status Stories in Ready

You need to run a local Ethereum/Quorum node to use this library.

Documentation Quorum API

Installation

Node.js

npm install web3-quorum

Usage

Use the web3 object directly from global namespace:

console.log(web3); // {eth: .., shh: ...} // it's here!

Set a provider (HttpProvider)

web3.setProvider(new web3.providers.HttpProvider('http://localhost:8545'));

There you go, now you can use it:

var nodeInfo = web3.quorum.nodeInfo;
web3.quorum.getNodeInfo(function(error, result){
    console.log(error, result);
});

Quorum functions

web3.quorum.nodeInfo
web3.quorum.isBlockMaker(address)
web3.quorum.isVoter(address)
web3.quorum.canonicalHash(blockHash)
web3.quorum.makeBlock()
web3.quorum.vote()
web3.quorum.pauseBlockMaker()
web3.quorum.resumeBlockMaker()

Contribute!

Requirements

  • Node.js
  • npm
sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm
sudo apt-get install nodejs-legacy

Building (gulp)

npm run-script build

Testing (mocha)

npm test