Skip to content

Latest commit

 

History

History
139 lines (94 loc) · 6.48 KB

README.md

File metadata and controls

139 lines (94 loc) · 6.48 KB
Raw

Cherryswap-monorepo CircleCI Coverage Status

Cherry Swap is an autonomous, open-source platform for interest rate swaps on Compound Finance markets.

ETHBERLINZWEI Winners

Table of Contents

Resources

Our Team

  • 🇿🇦 Chris Maree - Integrations
  • 🇩🇪 Sabine Bertram - Vyper contracts
  • 🇹🇳 Haythem Sellami - Solidity contracts
  • 🇬🇧 Chris Fulford - Front-end development
  • 🇳🇿 Liesl Eichholz - Design, UX/UI

Networks

Testnets

Kovan Testnet

The contract addresses deployed on Kovan Test Network:

Contract Address
CherryDai
CherryMath
CherrySwap

Mainnets

Ethereum Mainnet

The contract addresses deployed on Mainnet Mainnet:

Contract Address
CherryDai
CherryMath
CherrySwap

How It Works

Technical Description

Local Development

This monorepo contains the following packages:

Node.js LTS or greater required.

# current package name aliases: {frontend, contracts}

Testing

Code Linting

Linting is setup for JavaScript with ESLint & Solidity with Solhint and Prettier.

# lint solidity contracts
$ yarn run contracts:prettier

Code style is enforced through the CI test process, builds will fail if there're any linting errors.

Deployment

Issues

If you come across an issue with Cherryswap, do a search in the Issues tab of this repo to make sure it hasn't been reported before. Follow these steps to help us prevent duplicate issues and unnecessary notifications going to the many people watching this repo:

  • If the issue you found has been reported and is still open, and the details match your issue, give a "thumbs up" to the relevant posts in the issue thread to signal that you have the same issue. No further action is required on your part.
  • If the issue you found has been reported and is still open, but the issue is missing some details, you can add a comment to the issue thread describing the additional details.
  • If the issue you found has been reported but has been closed, you can comment on the closed issue thread and ask to have the issue reopened because you are still experiencing the issue. Alternatively, you can open a new issue, reference the closed issue by number or link, and state that you are still experiencing the issue. Provide any additional details in your post so we can better understand the issue and how to fix it.

Additional Resources

License

MIT License

Copyright (c) 2019 NeapolitanSwaps

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.