# web3js-quorum

> Web3 JS Quorum - JSON-RPC API

Latest version **22.4.0** (published 2022-04-05) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install web3js-quorum
pnpm add web3js-quorum
yarn add web3js-quorum
bun add web3js-quorum
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 22.4.0 |
| Published | 2022-04-05 |
| First published | 2021-06-23 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 3.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 31 |
| Author | ConsenSys |
| Maintainers | nmvalera, achraf17 |
| Keywords | web3, besu, eea, orion, quorum, tessera, constellation |

## Links

- npm: https://www.npmjs.com/package/web3js-quorum
- Repository: https://github.com/ConsenSysQuorum/web3js-quorum
- Homepage: https://github.com/ConsenSysQuorum/web3js-quorum#readme
- Issues: https://github.com/ConsenSysQuorum/web3js-quorum/issues
- npm.io page: https://npm.io/package/web3js-quorum

## Dependencies (5)

- [rlp](https://npm.io/package/rlp.md) 2.2.7
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [ethereumjs-tx](https://npm.io/package/ethereumjs-tx.md) ^2.1.2
- [ethereumjs-util](https://npm.io/package/ethereumjs-util.md) 6.2.1
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.9

## Recent versions

- 22.4.0 (latest) — 2022-04-05
- 21.7.0-rc1 — 2021-06-23

## README

[![Website](https://img.shields.io/website?label=documentation&url=https://consensys.github.io/web3js-quorum/latest/index.html)](https://consensys.github.io/web3js-quorum/latest/index.html)
[![npm](https://img.shields.io/npm/v/web3js-quorum)](https://www.npmjs.com/package/web3js-quorum)
[![Known Vulnerabilities](https://snyk.io/test/github/ConsenSys/web3js-quorum/badge.svg?targetFile=package.json)](https://snyk.io/test/github/ConsenSys/web3js-quorum?targetFile=package.json)

# web3js-quorum

Web3js-Quorum is an Ethereum JavaScript library extending [web3.js](https://github.com/ethereum/web3.js/) that adds supports for [GoQuorum](https://docs.goquorum.consensys.net/en/stable/) and [Hyperledger Besu](https://besu.hyperledger.org/en/stable/) specific JSON-RPC APIs and features. In particular it enables to use [web3.js](https://github.com/ethereum/web3.js/) with private transactions.

Web3js-Quorum gather all features from [quorum.js](https://github.com/ConsenSys/quorum.js) and [web3js-eea](https://github.com/ConsenSys/web3js-eea) in a single library.

Please read the [documentation](https://consensys.github.io/web3js-quorum/latest/index.html) for more.

## Features

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

## Installation

```shell
npm install web3 web3js-quorum
```

## Quickstart

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

### Extending web3 object

```js
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](https://consensys.github.io/web3js-quorum/latest/index.html).

## Examples

The [example](https://github.com/ConsenSys/web3js-quorum/tree/master/example) directory contains examples of web3js-quorum usage with Besu as a Quorum client.  
The [7nodes-test](https://github.com/ConsenSys/web3js-quorum/tree/master/7nodes-test) directory contains examples of web3js-quorum usage with GoQuorum as a Quorum client.

## Migrations
* To migrate from web3js-eea refer to [this](https://consensys.github.io/web3js-quorum/latest/tutorial-Migrate%20from%20web3js-eea.html)
* To migrate from quorum.js refer to [this](https://consensys.github.io/web3js-quorum/latest/tutorial-Migrate%20from%20quorum.js.html)

## Contributing

Please follow the [Contribution Guidelines](https://github.com/ConsenSys/web3js-quorum/blob/master/CONTRIBUTING.md) and Review Guidelines.

---
_Source: https://npm.io/package/web3js-quorum · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._