aboudoc / synthetix-staking-rewards Goto Github PK

Synthetix Staking Rewards

A very simple staking contract
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

(back to top)

Built With

(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/Synthetix-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

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.

Maths

You'll find below the formula to compute rewards earned by a user from k to n seconds:

Example using equation 1

Let's compute how many rewards are earned by Alice:

Example using equation 2

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:

Algorithm

Our goal is to implement the following algorithm:

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 - [email protected]

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

(back to top)

Acknowledgments

• Smart Contract Engineer

(back to top)