/Discrete-Staking-Rewards

With discrete staking rewards, the amount of rewards given can vary every second.

Primary LanguageSolidity

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Discrete Staking Rewards

A very simple staking contract
Explore the docs »

View Demo · Report Bug · Request Feature

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

About The Project

(back to top)

Built With

  • Hardhat
  • Ethers

(back to top)

Getting Started

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

Prerequisites

  • npm

    npm install npm@latest -g

  • hardhat

    npm install --save-dev hardhat
    npm install @nomiclabs/hardhat-ethers @nomiclabs/hardhat-waffle

    run:

    npx hardhat

Installation

  1. Clone the repo 
    git clone https://github.com/Aboudoc/Discrete-Staking-Rewards.git
  2. Install NPM packages 
    npm install

(back to top)

Usage

If you need testnet funds, use the Alchemy testnet faucet.

This project shows a basic example of Synthetix Staking Rewards

Staking

Discrete staking rewards is similar to staking rewards contract.

The difference is that the amount of rewards given can vary every second.

Maths

You'll find below a simple example using the main equation:

Maths
Maths
Maths
Maths

Further reading

(...soon)

Sources

(back to top)

Roadmap

  • Math proof: equation 1 to 2
  • Further reading
  • Deploy script
  • Unit test

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

Reda Aboutika - @twitter - reda.aboutika@gmail.com

Project Link: https://github.com/Aboudoc/Discrete-Staking-Rewards.git

(back to top)

Acknowledgments

(back to top)