554d5f97df
* WIP add combinatorial tests for internal Exchange functions * Change combinitorial testing strategy based on feedback * Check value of filled[orderHash] in updateFilledState tests * Add combinatorial tests for addFillResults * Add combinatorial tests for getPartialAmount * Implement generic `testWithReferenceFuncAsync` * Implement generic `testCombinatoriallyWithReferenceFuncAsync` * Add combinatorial tests for isRoundingError * Add combinatorial tests for calculateFillResults * Add support for Geth in internal contract tests * Fix contract artifacts * Change DECIMAL_PLACES to 78 and add a note. * Document new functions in utils * Optimize tests by only reseting state when needed * Rename/move some files * Print parameter names on failure in testWithReferenceFuncAsync * Add to changelog for utils package * Appease various linters * Rename some more things related to FillOrderCombinatorialUtils * Remove .only from test/exchange/internal.ts * Remove old test for isRoundingError and getPartialAmount * Appease linters again * Remove old todos * Fix typos, add comments, rename some things * Re-add some LibMath tests * Update contract internal tests to use new SafeMath revert reasons * Apply PR feedback from Amir * Apply PR feedback from Remco * Re-add networks to ZRXToken artifact * Remove duplicate Whitelist in compiler.json
Contracts
Smart contracts that implement the 0x protocol.
Usage
- Docs
- Overview of 0x protocol architecture
- 0x smart contract interactions
- Deployed smart contract addresses
- 0x protocol message format
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=contracts yarn build
Or continuously rebuild on change:
PKG=contracts yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test
Testing options
Revert stack traces
If you want to see helpful stack traces (incl. line number, code snippet) for smart contract reverts, run the tests with:
yarn test:trace
Note: This currently slows down the test runs and is therefore not enabled by default.
Backing Ethereum node
By default, our tests run against an in-process Ganache instance. In order to run the tests against Geth, first follow the instructions in the README for the devnet package to start the devnet Geth node. Then run:
TEST_PROVIDER=geth yarn test
Code coverage
In order to see the Solidity code coverage output generated by @0xproject/sol-cov, run:
yarn test:coverage
Gas profiler
In order to profile the gas costs for a specific smart contract call/transaction, you can run the tests in profiler mode.
Note: Traces emitted by ganache have incorrect gas costs so we recommend using Geth for profiling.
TEST_PROVIDER=geth yarn test:profiler
You'll see a warning that you need to explicitly enable and disable the profiler before and after the block of code you want to profile.
import { profiler } from './utils/profiler';
profiler.start();
// Some call to a smart contract
profiler.stop();
Without explicitly starting and stopping the profiler, the profiler output will be too busy, and therefore unusable.