Emit missing events on important configuration changes #33
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Many state-changing operations do not emit events. Consider emitting events for important state
changes.
These operations include:
ZkBobPool
:initialize()
setTokenSeller()
setOperatorManager()
ZkBobAccounting
:_setLimits()
_resetDailyLimits()
_setUsersTier()
BobVault:
setYieldAdmin()
setInvestAdmin()
MutableOperatorManager
:_setOperator()
ERC20Recovery
:setRecoveryAdmin()
setRecoveredFundsReceiver()
setRecoveryLimitPercent()
setRecoveryRequestTimelockPeriod()
Claimable
:setClaimingAdmin()
Comments to changes:
Event describing the corresponding changes were added to:
ZkBobPool
:setTokenSeller()
,setOperatorManager()
,withdrawFee()
ZkBobAccounting
:_setLimits()
MutableOperatorManager
:_setOperator()
. For other parameters, they are not expected to be changed regularly and there is no any interest in their retrospective observations, thus such events considered as redundant:
ZkBobPool
:initialize()
– an event will be emitted as part of _setLimits executionZkBobAccounting
:_resetDailyLimits()
is not expected to be called regularly; _setUsersTier() already contains the eventUpdateTier
BobVault
:setYieldAdmin()
andsetInvestAdmin()
are not expected to be called regularlyERC20Recovery:
setRecoveryAdmin()is not expected to be called regularly;
setRecoveredFundsReceiver(),
setRecoveryLimitPercent(),
setRecoveryRequestTimelockPeriod()` do not require their retrospective observations whereas the current value can be extracted with getters.Claimable
:setClaimingAdmin()
is not expected to be called regularly