Wyvern Protocol Javascript SDK

Synopsis

This is the standard Javascript SDK for the Wyvern Protocol. Modeled in part after the excellent 0x.js.

Versioning

This project uses semantic versioning.

The major version of this library will always correspond with the major version of the Wyvern Protocol, but there is not necessarily an equivalence between the minor version of this library and the minor version of the Wyvern Protocol.

Currently, the latest version of this library supports Wyvern Protocol v2. v2.1 support will be added as soon as v2.1 is deployed to the Ethereum mainnet.

Development Information

Setup

Node >= v6.9.1, < 10 and Yarn required.

Before any development, install the required NPM dependencies:

nvm install v10.24.1
nvm use v10.24.1
yarn install
yarn run build

Wyvern Contract Deployment

Before running deployment script, following addresses are needed:

1. SWAP ERC-20 Token Address
2. Fee Wallet Address where 80% of collected fees go
3. Dev Wallet Address where 10% of collected fees go

cd src/wyvern-ethereum
truffle compile
truffle migrate --network <goerli/main>

After truffle migration is finished, it will update the src/wyvern-ethereum/config.json.

Now, build using yarn run build and push compiled files.

Contributing

Contributions welcome! Please use GitHub issues for suggestions/concerns - if you prefer to express your intentions in code, feel free to submit a pull request.