# @0xproject/contract-wrappers

> Smart TS wrappers for 0x smart contracts

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

## Install

```sh
npm install @0xproject/contract-wrappers
pnpm add @0xproject/contract-wrappers
yarn add @0xproject/contract-wrappers
bun add @0xproject/contract-wrappers
```

## 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 | 2.0.2 |
| Published | 2018-10-04 |
| First published | 2018-05-22 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 16 |
| Unpacked size | 3.1 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1408 |
| Maintainers | albrow, amirbandeali, bchillman, dekz, fberger, fragosti, logvinov |
| Keywords | 0xproject, ethereum, tokens, exchange |

## Links

- npm: https://www.npmjs.com/package/@0xproject/contract-wrappers
- Repository: https://github.com/0xProject/0x-monorepo
- npm.io page: https://npm.io/package/@0xproject/contract-wrappers

## Dependencies (16)

- [uuid](https://npm.io/package/uuid.md) ^3.1.0
- [ethers](https://npm.io/package/ethers.md) 4.0.0-beta.14
- [lodash](https://npm.io/package/lodash.md) ^4.17.5
- [js-sha3](https://npm.io/package/js-sha3.md) ^0.7.0
- [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/types](https://npm.io/package/@0xproject/types.md) ^1.1.4
- [@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/order-utils](https://npm.io/package/@0xproject/order-utils.md) ^1.0.7
- [ethereumjs-blockstream](https://npm.io/package/ethereumjs-blockstream.md) 6.0.0
- [@0xproject/json-schemas](https://npm.io/package/@0xproject/json-schemas.md) ^1.0.7
- [@0xproject/web3-wrapper](https://npm.io/package/@0xproject/web3-wrapper.md) ^3.0.3
- [@0xproject/base-contract](https://npm.io/package/@0xproject/base-contract.md) ^3.0.1
- [@0xproject/fill-scenarios](https://npm.io/package/@0xproject/fill-scenarios.md) ^1.0.7
- [@0xproject/typescript-typings](https://npm.io/package/@0xproject/typescript-typings.md) ^3.0.2

## Recent versions

- 2.0.2 (latest) — 2018-10-04
- 2.0.1 — 2018-09-28
- 2.0.0 — 2018-09-25
- 1.0.5 — 2018-09-25
- 1.0.4 — 2018-09-21
- 1.0.3 — 2018-09-19
- 1.0.2 — 2018-09-18
- 1.0.1 — 2018-09-05
- 1.0.1-rc.5 — 2018-08-27
- 1.0.1-rc.4 — 2018-08-24
- 1.0.1-rc.3 — 2018-08-14
- 1.0.1-rc.2 — 2018-07-26
- 1.0.1-rc.1 — 2018-07-26
- 1.0.0-rc.1 — 2018-07-19
- 0.1.1 — 2018-07-18
- … 5 more at https://npm.io/package/@0xproject/contract-wrappers/versions

## README

## @0xproject/contract-wrappers

Smart TS wrappers for 0x smart contracts. The wrappers have simplified interfaces, perform client-side validation on transactions and throw helpful error messages.

### Read the [Documentation](https://0xproject.com/docs/0x.js).

## Installation

**Install**

```bash
npm install @0xproject/contract-wrappers --save
```

**Import**

```javascript
import { ContractWrappers } from '@0xproject/contract-wrappers';
```

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 strongly recommend that the community help us make improvements and determine the future direction of the protocol. 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/contract-wrappers yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0xproject/contract-wrappers yarn watch
```

```bash
yarn build
```

or continuously rebuild on change:

```bash
yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```

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