@0x/contracts-zero-ex

Extensible contracts for interacting with the 0x protocol

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@0x/contracts-zero-ex
278110.39.111 days ago3 years agoMinified + gzip package size for @0x/contracts-zero-ex in KB

Readme

ZeroEx (ExchangeProxy)

This package contains contracts for the ZeroEx extensible contract architecture.
NOTE: This repo is undergoing a tooling change. If adding a contract, you will need to add it to compiler.json. You can generate the entire list by running the following: find . -type f -name "*.sol" | grep -v foundry | grep -v "contracts/dep" | grep -v "node_modules"

Installation

Install
npm install @0x/contracts-zero-ex --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-zero-ex yarn build

Or continuously rebuild on change:
PKG=@0x/contracts-zero-ex yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test

Run Integration Tests

you will need to create a .env that the root of /contracts/zero-ex containing rpc's for all 7 chains the tests will be run on
ARBITRUM_RPC_URL=https://arb-mainnet........
AVALANCHE_RPC_URL=https://avalanche-mainnet......
BSC_RPC_URL=https://bsc-mainnet......
FANTOM_RPC_URL=https://fantom-mainnet......
MAINNET_RPC_URL=https://eth-mainnet......
OPTIMISM_RPC_URL=https://opt-mainnet......
POLYGON_RPC_URL=https://polygon-mainnet......

git submodule update --init --recursive
foundryup
yarn test:integration