@0xproject/forwarder-helper

Provides convenience objects to help work with the Forwarder Contract

Read the Documentation.

Installation

yarn add @0xproject/forwarder-helper

Import

import { forwarderHelperFactory } from '@0xproject/forwarder-helper';

or

var forwarderHelperFactory = require('@0xproject/forwarder-helper').forwarderHelperFactory;

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/forwarder-helper yarn build

Or continuously rebuild on change:

PKG=@0xproject/forwarder-helper yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test