@0xproject/dev-utils

0x dev TS utils

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
1,35413Apr 24, 2021May 23, 2017Minified + gzip package size for @0xproject/dev-utils in KB

Readme

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

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

PKG=@0xproject/dev-utils yarn build

Or continuously rebuild on change:

PKG=@0xproject/dev-utils yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.