# @0xproject/web3-wrapper

> Wraps around web3 and gives a nicer interface

Latest version **3.0.3** (published 2018-10-04) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @0xproject/web3-wrapper
pnpm add @0xproject/web3-wrapper
yarn add @0xproject/web3-wrapper
bun add @0xproject/web3-wrapper
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.3 |
| Published | 2018-10-04 |
| First published | 2017-12-08 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=6.12 |
| Dependencies | 8 |
| Unpacked size | 150.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1409 |
| Maintainers | albrow, amirbandeali, bchillman, dekz, fberger, fragosti, logvinov |

## Links

- npm: https://www.npmjs.com/package/@0xproject/web3-wrapper
- Repository: https://github.com/0xProject/0x-monorepo
- Homepage: https://github.com/0xProject/0x-monorepo/packages/web3-wrapper/README.md
- Issues: https://github.com/0xProject/0x-monorepo/issues
- npm.io page: https://npm.io/package/@0xproject/web3-wrapper

## Dependencies (8)

- [ethers](https://npm.io/package/ethers.md) 4.0.0-beta.14
- [lodash](https://npm.io/package/lodash.md) ^4.17.5
- [ethereum-types](https://npm.io/package/ethereum-types.md) ^1.0.11
- [ethereumjs-util](https://npm.io/package/ethereumjs-util.md) ^5.1.1
- [@0xproject/utils](https://npm.io/package/@0xproject/utils.md) ^2.0.2
- [@0xproject/assert](https://npm.io/package/@0xproject/assert.md) ^1.0.13
- [@0xproject/json-schemas](https://npm.io/package/@0xproject/json-schemas.md) ^1.0.7
- [@0xproject/typescript-typings](https://npm.io/package/@0xproject/typescript-typings.md) ^3.0.2

## Recent versions

- 3.0.3 (latest) — 2018-10-04
- 3.0.2 — 2018-09-28
- 3.0.1 — 2018-09-25
- 3.0.0 — 2018-09-25
- 2.0.3 — 2018-09-21
- 2.0.2 — 2018-09-05
- 2.0.1 — 2018-08-27
- 2.0.0 — 2018-08-24
- 1.2.0 — 2018-08-14
- 1.1.2 — 2018-07-26
- 1.1.1 — 2018-07-26
- 1.1.0 — 2018-07-26
- 1.0.0 — 2018-07-19
- 0.7.3 — 2018-07-18
- 0.7.2 — 2018-07-09
- … 28 more at https://npm.io/package/@0xproject/web3-wrapper/versions

## README

## @0xproject/web3-wrapper

Web3-wrapper is a JSON-RPC client for Ethereum nodes. It is a type-safe alternative to [Web3.js](https://github.com/ethereum/web3.js/) written in TypeScript.

### Read the [Documentation](https://0xproject.com/docs/web3-wrapper).

## Installation

```bash
yarn add @0xproject/web3-wrapper
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
}
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

```bash
PKG=@0xproject/web3-wrapper yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0xproject/web3-wrapper yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```

---
_Source: https://npm.io/package/@0xproject/web3-wrapper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._