0xProject
Broker
This package contains the implementation of the Broker contract. This contract serves as an entry-point to the 0x Exchange for the filling of property-based orders. Addresses of the deployed contracts can be found in this 0x guide or the DEPLOYS file within this package.
Installation
Install
npm install @0x/contracts-broker --saveBug bounty
A bug bounty for the 3.0 contracts is ongoing! Instructions can be found here.
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.
For proposals regarding the 0x protocol's smart contract architecture, message format, or additional functionality, go to the 0x Improvement Proposals (ZEIPs) repository and follow the contribution guidelines provided therein.
Please read our contribution guidelines before getting started.
Install Dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
yarn config set workspaces-experimental trueThen install dependencies
yarn installBuild
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
PKG=@0x/contracts-broker yarn buildOr continuously rebuild on change:
PKG=@0x/contracts-broker yarn watchClean
yarn cleanLint
yarn lintRun Tests
yarn testTesting options
Contracts testing options like coverage, profiling, revert traces or backing node choosing - are described here.