![Logo](/Aboudoc/Synthetix-Staking-Rewards/raw/main/images/logo.png)
A very simple staking contract
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
To get a local copy up and running follow these simple example steps.
-
npm
npm install npm@latest -g
-
hardhat
npm install --save-dev hardhat
npm install @nomiclabs/hardhat-ethers @nomiclabs/hardhat-waffle
run:
npx hardhat
- Clone the repo
git clone https://github.com/Aboudoc/Synthetix-Staking-Rewards.git
- Install NPM packages
npm install
If you need testnet funds, use the Alchemy testnet faucet.
This project shows a basic example of Synthetix Staking Rewards
Users earn reward by staking their token.
The amount they earn is reward rate * amount staked by the user / total staked for every second.
reward rate is set by the contract owner.
You'll find below the formula to compute rewards earned by a user from k to n seconds:
Let's compute how many rewards are earned by Alice:
Let's consider the following example:
We compute Rj using the second formula after a user stakes or withdraw:
Let's computer reward earned by each user:
Our goal is to implement the following algorithm:
(...soon)
- 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).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
Reda Aboutika - @twitter - reda.aboutika@gmail.com
Project Link: https://github.com/Aboudoc/Synthetix-Staking-Rewards.git