Skip to content

Commit

Permalink
fix: lint
Browse files Browse the repository at this point in the history
  • Loading branch information
@richard-ramos
richard-ramos committed Sep 6, 2024
1 parent 0d2f43e commit f91269a
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 38 deletions.
69 changes: 37 additions & 32 deletions src/Membership.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
pragma solidity 0.8.24;

import { IPriceCalculator } from "./IPriceCalculator.sol";
import "openzeppelin-contracts/contracts/token/ERC20/IERC20.sol";
import "openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";
import "openzeppelin-contracts/contracts/utils/Context.sol";
import { IERC20 } from "openzeppelin-contracts/contracts/token/ERC20/IERC20.sol";
import { SafeERC20 } from "openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";

// The number of periods should be greater than zero
error NumberOfPeriodsCantBeZero();
Expand Down Expand Up @@ -53,13 +52,13 @@ contract Membership {
uint32 public gracePeriod;

/// @notice balances available to withdraw
mapping(address => mapping(address => uint256)) public balancesToWithdraw; // holder -> token -> balance
mapping(address holder => mapping(address token => uint256 balance)) public balancesToWithdraw;

/// @notice Total rate limit of all memberships in the tree
uint256 public totalRateLimitPerEpoch;

/// @notice List of registered memberships (IDCommitment to membership metadata)
mapping(uint256 => MembershipInfo) public members;
/// @notice List of registered memberships
mapping(uint256 idCommitment => MembershipInfo member) public members;

/// @notice The index of the next member to be registered
uint32 public commitmentIndex;
Expand Down Expand Up @@ -219,30 +218,28 @@ contract Membership {
// by looking at the oldest membership. If it's expired, we can free it
MembershipInfo memory oldestMembership = members[_head];
if (
_isExpired(
!_isExpired(
oldestMembership.gracePeriodStartDate,
oldestMembership.gracePeriod,
oldestMembership.numberOfPeriods
)
) {
emit MemberExpired(_head, oldestMembership.userMessageLimit, oldestMembership.index);
) revert ExceedAvailableMaxRateLimitPerEpoch();

// Deduct the expired membership rate limit
_totalRateLimitPerEpoch -= oldestMembership.userMessageLimit;
emit MemberExpired(_head, oldestMembership.userMessageLimit, oldestMembership.index);

// Remove the element from the list
delete members[_head];
// Deduct the expired membership rate limit
_totalRateLimitPerEpoch -= oldestMembership.userMessageLimit;

// Promote the next oldest membership to oldest
_head = oldestMembership.next;
// Remove the element from the list
delete members[_head];

// Move balance from expired membership to holder balance
balancesToWithdraw[oldestMembership.holder][oldestMembership.token] += oldestMembership.amount;
// Promote the next oldest membership to oldest
_head = oldestMembership.next;

availableExpiredIndices.push(oldestMembership.index);
} else {
revert ExceedAvailableMaxRateLimitPerEpoch();
}
// Move balance from expired membership to holder balance
balancesToWithdraw[oldestMembership.holder][oldestMembership.token] += oldestMembership.amount;

availableExpiredIndices.push(oldestMembership.index);
}

// Ensure new head and tail are pointing to the correct memberships
Expand All @@ -264,14 +261,7 @@ contract Membership {
_totalRateLimitPerEpoch += _rateLimit;

// Reuse available slots from previously removed expired memberships
uint256 arrLen = availableExpiredIndices.length;
if (arrLen != 0) {
index = availableExpiredIndices[arrLen - 1];
availableExpiredIndices.pop();
reusedIndex = true;
} else {
index = commitmentIndex;
}
(index, reusedIndex) = _nextIndex();

totalRateLimitPerEpoch = _totalRateLimitPerEpoch;
members[_idCommitment] = MembershipInfo({
Expand All @@ -290,6 +280,21 @@ contract Membership {
tail = _idCommitment;
}

/// @dev reuse available slots from previously removed expired memberships
/// @return index index to use
/// @return reusedIndex indicates whether it is reusing an existing index, or using a new one
function _nextIndex() internal returns (uint32 index, bool reusedIndex) {
// Reuse available slots from previously removed expired memberships
uint256 arrLen = availableExpiredIndices.length;
if (arrLen != 0) {
index = availableExpiredIndices[arrLen - 1];
availableExpiredIndices.pop();
reusedIndex = true;
} else {
index = commitmentIndex;
}
}

/// @dev Extend a membership expiration date. Membership must be on grace period
/// @param _sender the address of the holder of the membership
/// @param _idCommitment the idCommitment of the membership
Expand All @@ -303,7 +308,7 @@ contract Membership {

if (_sender != mdetails.holder) revert NotHolder(_idCommitment);

uint256 newGracePeriodStartDate = block.timestamp + (uint256(billingPeriod) * uint256(mdetails.numberOfPeriods));
uint256 gracePeriodStartDate = block.timestamp + (uint256(billingPeriod) * uint256(mdetails.numberOfPeriods));

uint256 next = mdetails.next;
uint256 prev = mdetails.prev;
Expand All @@ -326,7 +331,7 @@ contract Membership {
// Move membership to the end (since it will be the newest)
mdetails.next = 0;
mdetails.prev = _tail;
mdetails.gracePeriodStartDate = newGracePeriodStartDate;
mdetails.gracePeriodStartDate = gracePeriodStartDate;
mdetails.gracePeriod = gracePeriod;

// Link previous tail with membership that was just extended
Expand All @@ -341,7 +346,7 @@ contract Membership {
head = _head;
tail = _idCommitment;

emit MemberExtended(_idCommitment, mdetails.userMessageLimit, mdetails.index, newGracePeriodStartDate);
emit MemberExtended(_idCommitment, mdetails.userMessageLimit, mdetails.index, gracePeriodStartDate);
}

/// @dev Determine whether a timestamp is considered to be expired or not after exceeding the grace period
Expand Down
2 changes: 1 addition & 1 deletion test/TestToken.sol
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: MIT
pragma solidity >=0.8.19 <0.9.0;

import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";

contract TestToken is ERC20 {
constructor() ERC20("TestToken", "TTT") { }
Expand Down
10 changes: 5 additions & 5 deletions test/WakuRlnV2.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ import { Deploy } from "../script/Deploy.s.sol";
import { DeploymentConfig } from "../script/DeploymentConfig.s.sol";
import "../src/WakuRlnV2.sol"; // solhint-disable-line
import "../src/Membership.sol"; // solhint-disable-line
import "../src/LinearPriceCalculator.sol"; // solhint-disable-line
import "./TestToken.sol";
import { IPriceCalculator } from "../src/IPriceCalculator.sol";
import { LinearPriceCalculator } from "../src/LinearPriceCalculator.sol";
import { TestToken } from "./TestToken.sol";
import { PoseidonT3 } from "poseidon-solidity/PoseidonT3.sol";
import { UUPSUpgradeable } from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import { ERC1967Proxy } from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
Expand Down Expand Up @@ -564,8 +565,7 @@ contract WakuRlnV2Test is Test {
assertEq(availableBalance, priceA * 2);
}

function test__RegistrationWhenMaxRateLimitIsReachedAndMultipleExpiredMembersAvailableButTheyDontHaveEnoughRateLimit(
)
function test__RegistrationWhenMaxRateLimitReachedAndMultipleExpiredMembersAvailableWithoutEnoughRateLimit()
external
{
vm.pauseGasMetering();
Expand Down Expand Up @@ -920,5 +920,5 @@ contract WakuRlnV2Test is Test {
assertEq(fetchedImpl, newImpl);
}

receive() external payable { }
receive() external payable { } // solhint-disable-line
}

0 comments on commit f91269a

Please sign in to comment.