Skip to content

Consensys/web3js-quorum

Folders and files

NameName
Last commit message
Last commit date
Jun 22, 2021
Jun 8, 2021
Jan 13, 2022
Feb 16, 2022
Feb 16, 2022
Feb 16, 2022
Feb 16, 2022
Jan 11, 2024
Sep 1, 2023
Feb 16, 2022
Apr 27, 2021
Sep 3, 2021
May 3, 2021
Mar 31, 2020
Jun 14, 2021
Sep 6, 2020
Apr 8, 2021
Apr 8, 2021
May 3, 2021
Apr 20, 2023
Jun 22, 2021
Apr 5, 2022
Apr 5, 2022

Repository files navigation

Website npm Known Vulnerabilities

This repository is not actively maintained by Consensys and is provided as-is. It is open-source and contributions are welcome.

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.