@0x/contracts-coordinator
v3.1.38
Published
Smart contract extensions of 0x protocol
Downloads
293
Keywords
Readme
Coordinator
This package contains a contract that allows users to call arbitrary functions on the Exchange contract with permission from one or more Coordinators. 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-coordinator --save
Bug bounty
A bug bounty for the 2.0.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 true
Then install dependencies
yarn install
Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
PKG=@0x/contracts-coordinator yarn build
Or continuously rebuild on change:
PKG=@0x/contracts-coordinator yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test
Testing options
Contracts testing options like coverage, profiling, revert traces or backing node choosing - are described here.