@0x/contracts-erc20-bridge-sampler

ERC20BridgeSampler

This package contains contracts used in DEX aggregation.

This is an MVP implementation, which agnostically samples DEXes for off-chain sorting and order generation. It is entirely read-only and never not touches any funds.

Installation

Install

npm install @0x/contracts-erc20-bridge-sampler --save

Contributing

We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.

For proposals regarding the 0x protocol's smart contract architecture, message format, or additional functionality, go to the 0x Improvement Proposals (ZEIPs) repository and follow the contribution guidelines provided therein.

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=@0x/contracts-erc20-bridge-sampler yarn build

Or continuously rebuild on change:

PKG=@0x/contracts-erc20-bridge-sampler yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test