0x Starter Project
This project will take you through a number of scenarios using the 0x v2 protocol. The previous v1 starter project has been moved to the 'v1' branch.
This repository contains a bunch of scenarios that you can run from the command-line:
- Fill order (ERC20)
- Fill order Fees
- Fill order (ERC721)
- Cancel orders up to
- Match orders
- Execute transaction
- Forwarder buy orders (ERC20)
- Forwarder buy orders (ERC721)
- Standard Relayer API fill order example
By default this project uses the 0x development mnemonic running against Ganache. This project can be configured to use a different mnenonic and also run against Kovan testnet.
You may choose to update the mnemonic in
src/configs.ts or use the one provided (note if many people use this mnemonic on Kovan then the funds may be drained). When changing the mnemonic ensure that the account has available funds (ETH and ZRX) on the respective network. You can request ZRX and ETH from the 0x Faucet located in 0x Portal.
Build this package:
Download the Ganache snapshot and load it on to a Ganache node:
yarn download_snapshot yarn ganache-cli
Run a scenario in another terminal:
To run all scenarios:
All the scenarios commands can be found in the
scripts section and begin with
Switching to Kovan
To switch between Kovan/ganache, change the last line in
src/configs.ts and re-build. Ganache is enabled by default.
export const NETWORK_CONFIGS = GANACHE_CONFIGS;
export const NETWORK_CONFIGS = KOVAN_CONFIGS;
Fill Order SRA Example
To run the Fill Order SRA Example you must first start up a server in another terminal:
Then in another terminal run:
Windows Development Setup
If you're setting up Node.js for the first time on Windows, you may find the following StackOverflow guide useful. There are a few build tools required for Node.js on Windows which are not installed by default (such as Python). Please follow that guide before running through the tutorials.