diff options
author | Fabio Berger <me@fabioberger.com> | 2018-06-25 21:18:02 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-06-25 21:18:02 +0800 |
commit | ec9d1ca57ed2caf47a05546705bb59eeda2322f2 (patch) | |
tree | 7e64f0ee80a0b3abfc5f16a04fbc7d31ed0fe84b /packages/contracts | |
parent | f8bde5ab9b8e5d4ec8b9532dfbf18d1202dbfb29 (diff) | |
download | dexon-0x-contracts-ec9d1ca57ed2caf47a05546705bb59eeda2322f2.tar dexon-0x-contracts-ec9d1ca57ed2caf47a05546705bb59eeda2322f2.tar.gz dexon-0x-contracts-ec9d1ca57ed2caf47a05546705bb59eeda2322f2.tar.bz2 dexon-0x-contracts-ec9d1ca57ed2caf47a05546705bb59eeda2322f2.tar.lz dexon-0x-contracts-ec9d1ca57ed2caf47a05546705bb59eeda2322f2.tar.xz dexon-0x-contracts-ec9d1ca57ed2caf47a05546705bb59eeda2322f2.tar.zst dexon-0x-contracts-ec9d1ca57ed2caf47a05546705bb59eeda2322f2.zip |
Document all the contract test options in README
Diffstat (limited to 'packages/contracts')
-rw-r--r-- | packages/contracts/README.md | 46 |
1 files changed, 43 insertions, 3 deletions
diff --git a/packages/contracts/README.md b/packages/contracts/README.md index 9c829c753..2e6376f39 100644 --- a/packages/contracts/README.md +++ b/packages/contracts/README.md @@ -64,11 +64,51 @@ yarn lint yarn test ``` -### Run Tests Against Geth +#### Testing options -Follow the instructions in the README for the devnet package to start the -devnet. +###### 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](https://github.com/trufflesuite/ganache-core) instance. In order to run the tests against [Geth](https://github.com/ethereum/go-ethereum), first follow the instructions in the README for the devnet package to start the devnet Geth node. Then run: ```bash 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. + +```typescript +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. |