This package contains smart contract utilities and libraries that are used throughout the entire codebase of smart contracts. These contracts are all generic and may helpful to use outside of the context of 0x protocol.
Install
npm install @0x/contracts-utils --saveWe 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.
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
yarn config set workspaces-experimental trueThen install dependencies
yarn installTo build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
PKG=@0x/contracts-utils yarn buildOr continuously rebuild on change:
PKG=@0x/contracts-utils yarn watchyarn cleanyarn lintyarn testContracts testing options like coverage, profiling, revert traces or backing node choosing - are described here.