Skip to content

An exogenous decentralised stablecoin using chainlink oracles to peg a stablecoin to the dollar price of btc and eth used as collateral with liquidation functions

License

Notifications You must be signed in to change notification settings

achoudhury4927/foundry-adil-stablecoin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Exogenous Stablecoin

This is a Decentralised Algorithmic Exogenous Stablecoin using chainlink price feeds to ensure coins can only be minted with enough collateral
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact

About The Project

Built With

  • Solidity
  • Foundry

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You will need foundry to install the packages and run tests. You can find out more here: https://book.getfoundry.sh/getting-started/installation. Make to run the makefile commands.

  • foundry

    curl -L https://foundry.paradigm.xyz | bash
  • foundryup

    foundryup
  • make

    sudo apt-get install make

Installation

  1. Clone the repo
    git clone https://github.com/achoudhury4927/foundry-adil-erc721.git
  2. Run Anvil
    make anvil
  3. Deploy contracts on local Anvil chain
    make deploy
  4. Run tests
    make test

(back to top)

Roadmap

  • ERC20 Stablecoin
    • Unit Tests
    • Integration Tests
  • Deposit Collateral
    • Unit Tests
    • Fuzz Tests
    • Integration Tests
  • Chainlink Oracle Pricefeeds
    • Unit Tests
    • Fuzz Tests
    • Integration Tests
  • Mint
    • Unit Tests
    • Fuzz Tests
    • Integration Tests
  • Burn
    • Unit Tests
    • Fuzz Tests
    • Integration Tests
  • Liquidations
    • Unit Tests
    • Fuzz Tests
    • Integration Tests
  • Deploy Engine Script
  • Deploy to Base L2

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Adil Choudhury - @0xAdilc - contact@adilc.me

Project Link: https://github.com/achoudhury4927/foundry-adil-stablecoin

(back to top)

About

An exogenous decentralised stablecoin using chainlink oracles to peg a stablecoin to the dollar price of btc and eth used as collateral with liquidation functions

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published