From 6ffac526ba4a8d10f7bcf4a917f995f826aabec0 Mon Sep 17 00:00:00 2001 From: Sergei Tikhomirov Date: Tue, 1 Oct 2024 10:36:00 +0200 Subject: [PATCH] minor renaming, comments --- src/Membership.sol | 24 ++++++++++++------------ src/WakuRlnV2.sol | 22 +++++++++++----------- test/WakuRlnV2.t.sol | 2 +- 3 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/Membership.sol b/src/Membership.sol index 5207357..e9082a1 100644 --- a/src/Membership.sol +++ b/src/Membership.sol @@ -38,7 +38,7 @@ abstract contract MembershipUpgradeable is Initializable { uint32 public minMembershipRateLimit; /// @notice Membership active period duration (A in the spec) - uint32 public activeStateDuration; + uint32 public activeDuration; /// @notice Membership grace period duration (G in the spec) uint32 public gracePeriodDurationForNewMemberships; @@ -102,14 +102,14 @@ abstract contract MembershipUpgradeable is Initializable { /// @param _maxTotalRateLimit Maximum total rate limit of all memberships in the membership set /// @param _minMembershipRateLimit Minimum rate limit of each membership /// @param _maxMembershipRateLimit Maximum rate limit of each membership - /// @param _activeStateDuration Active state duration of each membership + /// @param _activeDuration Active state duration of each membership /// @param _gracePeriodDuration Grace period duration of each membership function __MembershipUpgradeable_init( address _priceCalculator, uint32 _maxTotalRateLimit, uint32 _minMembershipRateLimit, uint32 _maxMembershipRateLimit, - uint32 _activeStateDuration, + uint32 _activeDuration, uint32 _gracePeriodDuration ) internal @@ -120,7 +120,7 @@ abstract contract MembershipUpgradeable is Initializable { _maxTotalRateLimit, _minMembershipRateLimit, _maxMembershipRateLimit, - _activeStateDuration, + _activeDuration, _gracePeriodDuration ); } @@ -130,7 +130,7 @@ abstract contract MembershipUpgradeable is Initializable { uint32 _maxTotalRateLimit, uint32 _minMembershipRateLimit, uint32 _maxMembershipRateLimit, - uint32 _activeStateDuration, + uint32 _activeDuration, uint32 _gracePeriodDuration ) internal @@ -139,14 +139,14 @@ abstract contract MembershipUpgradeable is Initializable { require(0 < _minMembershipRateLimit); require(_minMembershipRateLimit <= _maxMembershipRateLimit); require(_maxMembershipRateLimit <= _maxTotalRateLimit); - require(_activeStateDuration > 0); + require(_activeDuration > 0); // Note: grace period duration may be equal to zero depositAmountCalculator = IPriceCalculator(_priceCalculator); maxTotalRateLimit = _maxTotalRateLimit; minMembershipRateLimit = _minMembershipRateLimit; maxMembershipRateLimit = _maxMembershipRateLimit; - activeStateDuration = _activeStateDuration; + activeDuration = _activeDuration; gracePeriodDurationForNewMemberships = _gracePeriodDuration; } @@ -158,7 +158,7 @@ abstract contract MembershipUpgradeable is Initializable { } /// @dev acquire a membership and trasnfer the deposit to the contract - /// @param _sender address of the holder of the new membership // FIXME: keeper? + /// @param _sender address of the holder of the new membership /// @param _idCommitment the idCommitment of the new membership /// @param _rateLimit the membership rate limit /// @return index the index of the new membership in the membership set @@ -188,8 +188,8 @@ abstract contract MembershipUpgradeable is Initializable { (index, indexReused) = _getFreeIndex(); memberships[_idCommitment] = MembershipInfo({ - holder: _sender, // FIXME: keeper? - gracePeriodStartTimestamp: block.timestamp + uint256(activeStateDuration), + holder: _sender, + gracePeriodStartTimestamp: block.timestamp + uint256(activeDuration), gracePeriodDuration: gracePeriodDurationForNewMemberships, token: token, depositAmount: depositAmount, @@ -230,8 +230,8 @@ abstract contract MembershipUpgradeable is Initializable { // Note: we add the new active period to the end of the ongoing grace period uint256 newGracePeriodStartTimestamp = ( membership.gracePeriodStartTimestamp + membership.gracePeriodDuration - // FIXME: we must use this membership's activeStateDuration, not global default - + uint256(activeStateDuration) + // FIXME: we must use this membership's activeDuration, not global default + + uint256(activeDuration) ); membership.gracePeriodStartTimestamp = newGracePeriodStartTimestamp; diff --git a/src/WakuRlnV2.sol b/src/WakuRlnV2.sol index fc0ae47..4f53844 100644 --- a/src/WakuRlnV2.sol +++ b/src/WakuRlnV2.sol @@ -71,14 +71,14 @@ contract WakuRlnV2 is Initializable, Ownable2StepUpgradeable, UUPSUpgradeable, M /// @param _maxTotalRateLimit Maximum total rate limit of all memberships in the membership set /// @param _minMembershipRateLimit Minimum rate limit of one membership /// @param _maxMembershipRateLimit Maximum rate limit of one membership - /// @param _activeStateDuration Membership expiration term + /// @param _activeDuration Membership active duration /// @param _gracePeriod Membership grace period function initialize( address _priceCalculator, uint32 _maxTotalRateLimit, uint32 _minMembershipRateLimit, uint32 _maxMembershipRateLimit, - uint32 _activeStateDuration, + uint32 _activeDuration, uint32 _gracePeriod ) public @@ -91,7 +91,7 @@ contract WakuRlnV2 is Initializable, Ownable2StepUpgradeable, UUPSUpgradeable, M _maxTotalRateLimit, _minMembershipRateLimit, _maxMembershipRateLimit, - _activeStateDuration, + _activeDuration, _gracePeriod ); @@ -287,17 +287,17 @@ contract WakuRlnV2 is Initializable, Ownable2StepUpgradeable, UUPSUpgradeable, M minMembershipRateLimit = _minMembershipRateLimit; } - /// @notice Set the expiration term for new memberships (expiration dates of existing memberships don't change) - /// @param _activeStateDuration new expiration term - function setactiveStateDuration(uint32 _activeStateDuration) external onlyOwner { - require(_activeStateDuration > 0); - activeStateDuration = _activeStateDuration; + /// @notice Set the active duration for new memberships (terms of existing memberships don't change) + /// @param _activeDuration new active duration + function setActiveDuration(uint32 _activeDuration) external onlyOwner { + require(_activeDuration > 0); + activeDuration = _activeDuration; } /// @notice Set the grace period for new memberships (grace periods of existing memberships don't change) - /// @param _gracePeriod new grace period term - function setGracePeriod(uint32 _gracePeriod) external onlyOwner { + /// @param _gracePeriodDuration new grace period duration + function setGracePeriodDuration(uint32 _gracePeriodDuration) external onlyOwner { // Note: grace period duration may be equal to zero - gracePeriodDurationForNewMemberships = _gracePeriod; + gracePeriodDurationForNewMemberships = _gracePeriodDuration; } } diff --git a/test/WakuRlnV2.t.sol b/test/WakuRlnV2.t.sol index e5a9d0f..832ccf6 100644 --- a/test/WakuRlnV2.t.sol +++ b/test/WakuRlnV2.t.sol @@ -227,7 +227,7 @@ contract WakuRlnV2Test is Test { assertEq(oldGracePeriodDuration, newGracePeriodDuration); assertEq( - oldGracePeriodStartTimestamp + oldGracePeriodDuration + uint256(w.activeStateDuration()), + oldGracePeriodStartTimestamp + oldGracePeriodDuration + uint256(w.activeDuration()), newGracePeriodStartTimestamp ); assertFalse(w.isInGracePeriod(idCommitment));