web3js-quorum

Web3js-Quorum is an Ethereum JavaScript library extending web3.js that adds supports for GoQuorum and Hyperledger Besu specific JSON-RPC APIs and features. In particular it enables to use web3.js with private transactions.

Web3js-Quorum gather all features from quorum.js and web3js-eea in a single library.

Please read the documentation for more.

Features

• Supports GoQuorum and Besu JSON-RPC APIs
• Create and send private transactions
• Privacy group management

Installation

npm install web3 web3js-quorum

Quickstart

The Quorum client APIs methods provided by web3js-quorum are accessed like so:

Extending web3 object

const Web3 = require("web3");
const Web3Quorum = require("web3js-quorum");
const web3 = new Web3Quorum(new Web3("http://localhost:22000"));
web3.priv.generateAndSendRawTransaction(options);

Documentation

For full usage and API details see the documentation.

Examples

The example directory contains examples of web3js-quorum usage with Besu as a Quorum client.
The 7nodes-test directory contains examples of web3js-quorum usage with GoQuorum as a Quorum client.

Migrations

• To migrate from web3js-eea refer to this
• To migrate from quorum.js refer to this

Contributing

Please follow the Contribution Guidelines and Review Guidelines.