Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve farming code readability [SC-929] #71

Closed

Conversation

byshape
Copy link
Contributor

@byshape byshape commented Sep 26, 2023

  • Renamed FarmAccounting => Farming, UserAccounting => Rewards
  • Renamed FarmingLib.startFarming => updateFarmData, stopFarming => cancelFarming
  • Renamed FarmAccounting.startFarming => update, stopFarming => cancel
  • Moved the functionality related to the distributor to a separate abstract contract Distributor
  • Added documentation to 3 main contracts: FarmingPlugin, FarmingPool, MultiFarmingPlugin
  • Updated the code to be more in line with the Solidity Style Guide
  • Updated README.md

@codecov
Copy link

codecov bot commented Sep 26, 2023

Codecov Report

Attention: 4 lines in your changes are missing coverage. Please review.

Files Coverage Δ
contracts/Distributor.sol 100.00% <100.00%> (ø)
contracts/FarmingLib.sol 100.00% <100.00%> (ø)
contracts/FarmingPlugin.sol 100.00% <100.00%> (ø)
contracts/FarmingPool.sol 100.00% <100.00%> (ø)
contracts/accounting/Farming.sol 100.00% <100.00%> (ø)
contracts/accounting/Rewards.sol 100.00% <100.00%> (ø)
contracts/MultiFarmingPlugin.sol 69.84% <78.94%> (-4.49%) ⬇️

📢 Thoughts on this report? Let us know!.

@byshape byshape marked this pull request as ready for review September 27, 2023 19:09
@ZumZoom
Copy link
Member

ZumZoom commented Dec 19, 2023

Closing in favour of #72, #73 and #74

@ZumZoom ZumZoom closed this Dec 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants