dev-utils

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

yarn add @0xproject/dev-utils

If your project is in TypeScript, add the following to your tsconfig.json:

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

Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

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

If this is your first time building this package, you must first build all packages within the monorepo. This is because packages that depend on other packages located inside this monorepo are symlinked when run from within the monorepo. This allows you to make changes across multiple packages without first publishing dependent packages to NPM. To build all packages, run the following from the monorepo root directory:

yarn lerna:rebuild

Or continuously rebuild on change:

yarn dev

You can also build this specific package by running the following from within its directory:

yarn build

or continuously rebuild on change:

yarn build:watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test