# @0x/contract-wrappers

> Wrappers for 0x smart contract wrappers generated using @0x/abi-gen

Latest version **13.23.8** (published 2023-11-16) · Apache-2.0 license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 13.23.8 |
| Published | 2023-11-16 |
| First published | 2018-10-18 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=6.12 |
| Dependencies | 9 |
| Unpacked size | 2.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 403 |
| Maintainers | aeph4muh, rhinodavid, mwelche, savdont, kyuc, henryzhu, tobernguyen, dekz, amirbandeali, phil-ociraptor |
| Keywords | 0xproject, ethereum, tokens, exchange |

## Links

- npm: https://www.npmjs.com/package/@0x/contract-wrappers
- Repository: https://github.com/0xProject/protocol
- Homepage: https://github.com/0xProject/protocol/tree/main/packages/contract-wrappers
- Issues: https://github.com/0xProject/protocol/issues
- npm.io page: https://npm.io/package/@0x/contract-wrappers

## Dependencies (9)

- [ethers](https://npm.io/package/ethers.md) ~4.0.4
- [@0x/types](https://npm.io/package/@0x/types.md) ^3.3.7
- [@0x/utils](https://npm.io/package/@0x/utils.md) ^7.0.0
- [@0x/assert](https://npm.io/package/@0x/assert.md) ^3.0.36
- [ethereum-types](https://npm.io/package/ethereum-types.md) ^3.7.1
- [@0x/json-schemas](https://npm.io/package/@0x/json-schemas.md) ^6.4.4
- [@0x/web3-wrapper](https://npm.io/package/@0x/web3-wrapper.md) ^8.0.1
- [@0x/base-contract](https://npm.io/package/@0x/base-contract.md) ^7.0.0
- [@0x/contract-addresses](https://npm.io/package/@0x/contract-addresses.md) ^8.13.0

## Recent versions

- 13.23.8 (latest) — 2023-11-16
- 13.14.0-multiplex (multiplex) — 2021-03-16
- 12.2.0-beta.4 (protocolV3) — 2019-12-02
- 13.23.7 — 2023-08-29
- 13.23.6 — 2023-08-18
- 13.23.5 — 2023-08-09
- 13.23.4 — 2023-07-21
- 13.23.3 — 2023-07-19
- 13.23.2 — 2023-05-10
- 13.23.1 — 2023-05-01
- 13.23.0 — 2023-04-24
- 13.22.21 — 2023-04-20
- 13.22.20 — 2023-04-17
- 13.22.18 — 2023-03-10
- 13.22.17 — 2023-03-01
- … 125 more at https://npm.io/package/@0x/contract-wrappers/versions

## README

## @0x/contract-wrappers

Wrappers for 0x smart contracts, generated using @0x/abi-gen.

## Installation

**Install**

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

**Import**

```typescript
import { ContractWrappers } from '@0x/contract-wrappers';
```

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

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0x/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](../../.github/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=@0x/contract-wrappers yarn build
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```

### Documentation

Documentation for this package is generated by TypeDoc, using the Solidity source code for 0x contracts. Each contract corresponds to one global-level module, which contains relevant enums and interfaces for its events and structs. Most significantly, each module exports a class, `<ContractName>Contract`, e.g. `ExchangeContract`, which implements helper methods for all the functions defined in the corresponding contract.

A convention to note is that these contract-specific helper methods are defined as _object literals_, which are separated from methods in the generated documentation. Each contract method has a number of sub-methods, e.g. `sendTransactionAsync`, or `estimateGasAsync`, which are documented separately. This is an example of an expected method call signature: `exchangeContractInstance.fillOrder.sendTransactionAsync(...arguments)`.

### Development

This package contains generated code. We use the `abi-gen` utility to generate wrappers from compiler artifacts in `@0x/contract-artifacts`. To re-generate wrappers, e.g. when `@0x/contract-artifacts` has been updated, run `yarn wrappers:generate && yarn wrappers:prettier`.

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