ETHPool provides a service where people can deposit ETH and they will receive weekly rewards. Users must be able to take out their deposits along with their portion of rewards at any time. As well, users can add additional deposits at any time. New rewards are deposited manually into the pool by the ETHPool team each week using a contract function.
- Only the team can deposit rewards.
- Deposited rewards go to the users proportional to the amount of ETH each user has at the time the team deposits rewards (Note: both deposits and accrued rewards so far account for the total Eth of a user. Or in other words, rewards are automatically reinvested and count as additional deposits for a user)
- Users should be able to withdraw at any time their deposits along with their share of rewards accrued so far.
Example:
Let say we have user A and B and team T.
A deposits 100, and B deposits 300 for a total of 400 in the pool. Now A has 25% of the pool and B has 75%. When T deposits 200 rewards, A should be able to withdraw 150 and B 450. What if the following happens? A deposits then T deposits then B deposits then A withdraws and finally B withdraws. A should get their deposit + all the rewards. B should only get their deposit because rewards were sent to the pool before they participated.
Design and code a contract for ETHPool, take all the assumptions you need to move forward.
You can use any development tools you prefer: Foundry (preferred), Hardhat, Truffle, Brownie, Solidity, Vyper.
Useful resources:
- Solidity Docs: https://docs.soliditylang.org/en/v0.8.4
- Educational Resource: https://github.com/austintgriffith/scaffold-eth
- Project Starter: https://github.com/abarmat/solidity-starter
Make sure that all your code is tested properly
Deploy the contract to any Ethereum testnet of your preference. Keep record of the deployed address.
Bonus:
- Verify the contract in Etherscan
Create a script (or a Hardhat task) to query the total amount of ETH held in the contract.
You can use any library you prefer: Ethers.js, Web3.js, Web3.py, eth-brownie