aboutsummaryrefslogblamecommitdiffstats
path: root/packages/dev-utils/README.md
blob: d7e580d9f4df6b9736674891eee0622e2fa54c58 (plain) (tree)
1
2
3
4
5
6
7
8
9
            


                                                      




                                                                                            
                                                                                                                                   


                                                                                                                                                      

                                                                                         




                             


                                                                                                               



                                                                                             
   
## Dev utils

Dev utils to be shared across 0x projects and packages

## Configuration

Some env variables might be set to change the behaviour of created web3 providers/instances.

```
VERBOSE_GANACHE: boolean. Enables verbose Ganache logging. Every request/response payload. Slightly slower, but useful for testing.
SOLIDITY_COVERAGE: boolean. If set - adds coverage subprovider which intercepts all calls/transactions and can be later used to compute code coverage.
```

Boolean env variables should be either `true` or `false`. Defaults to `false` if not set.

## Install

```bash
yarn add @0xproject/dev-utils
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
}
```