refactor(StakeManager): make function names more descriptive #93
Conversation
| @@ -66,7 +66,7 @@ contract StakeManager is Ownable { | |||
| _; | |||
| } | |||
|
|
|||
| modifier onlyInitialized(address account) { | |||
| modifier onlyAccountInitialized(address account) { | |||
There was a problem hiding this comment.
I've changed this one as onlyInitialized is commonly used in OZ Initializable contracts
| @@ -106,7 +106,7 @@ contract StakeManager is Ownable { | |||
| /** | |||
| * @notice Process epoch if it has ended | |||
| */ | |||
| modifier processEpoch() { | |||
| modifier finalizeEpoch() { | |||
There was a problem hiding this comment.
Really wat this modifier does is finalizing the epoch if it's duration has passed.
There's an argument to be made that there's cases where it won't finalize, but I still think it's better than "process epoch" which can mean many things.
| */ | ||
| function increaseMPFromMigration(uint256 _increasedMP) external onlyOldManager { | ||
| totalSupplyMP += _increasedMP; | ||
| function increaseTotalMP(uint256 _amount) external onlyPreviousManager { |
There was a problem hiding this comment.
The entire "increasedMP" notion in this contract felt a bit off to me.
In this case here, really what we're doing is adjusting the total MP of the next manager.
| */ | ||
| function _getIncreasedMP(uint256 _balance, uint256 _deltaTime) private pure returns (uint256 _increasedMP) { | ||
| function _getMPToMint(uint256 _balance, uint256 _deltaTime) private pure returns (uint256) { |
There was a problem hiding this comment.
Also here, this function really just calculates the MP that should be minted
| console.log("####### epoch :", epoch); | ||
| console.log("==============="); | ||
| } | ||
|
|
There was a problem hiding this comment.
This entire function was not used anywhere.
0x-r4bbit
force-pushed
the
refactor/better-fn-names
branch
3 times, most recently
from
9f59efb
to
97edf24
Compare
Some of the functions on our contracts were confusing. This commit changes them so they describe what they actually do.
0x-r4bbit
force-pushed
the
refactor/better-fn-names
branch
from
97edf24
to
3c4c463
Compare
Some of the functions on our contracts were confusing. This commit changes them so they describe what they actually do.
Checklist
Ensure you completed all of the steps below before submitting your pull request:
forge snapshot?pnpm gas-report?pnpm lint?forge test?pnpm verify?