Puppy Raffle

AI First Flight #1
Beginner FriendlyFoundrySolidityNFT
EXP
View results
Submission Details
Severity: low
Valid

[M-2] `PuppyRaffle::getActivePlayerIndex` Returns 0 for Both Active Player at Index 0 and Non-Existent Players

[M-2] PuppyRaffle::getActivePlayerIndex Returns 0 for Both Active Player at Index 0 and Non-Existent Players

Description

The getActivePlayerIndex function uses 0 as a sentinel value to indicate that a player is not active in the raffle. However, 0 is also a valid array index (the first player in players[0]). As a result, off-chain callers or integrating contracts cannot distinguish between an active player at index 0 and a user who has not entered the raffle at all.

The function getActivePlayerIndex is intended to look up a player's current array position within the players array and return 0 if the address is not found.

However, because Solidity arrays are zero-indexed, the player at position 0 will also return an index of 0. This creates an ambiguity where an active participant at players[0] appears indistinguishable from an inactive user who never joined.

function getActivePlayerIndex(address player) external view returns (uint256) {for (uint256 i = 0; i < players.length; i++) {if (players[i] == player) {return i;}}//@> Returns 0 for inactive players, colliding with valid player at index 0return 0;}

Risk

Likelihood: High

  • Occurs on every single raffle execution for the very first player (players[0]) who enters the pool.

Impact: Medium

  • Any UI, off-chain service, or smart contract relying on getActivePlayerIndex to check whether an address is active will misinterpret the first player (players[0]) as inactive/not registered.

  • Front-ends may prompt the first player to re-enter or pay entry fees again unnecessarily because the interface reports they are not currently in the raffle.

Proof of Concept

function test_playerIndexZero() public {
address[] memory players = new address[](4);
for (uint256 i = 1; i < 4; i++) {
players[i] = address(uint160(i + 1));
}
puppyRaffle.enterRaffle{value: entranceFee * 4}(players);
uint256 playerIndex = puppyRaffle.getActivePlayerIndex(players[0]);
console2.log("playerIndex", playerIndex);
assert(playerIndex == 0);
}


Ran 1 test for test/PuppyRaffleTest.t.sol:PuppyRaffleTest
[PASS] test_playerIndexZero() (gas: 146012)
Logs:
playerIndex 0

Traces:````[146012] PuppyRaffleTest::test_playerIndexZero()````├─ [126225] PuppyRaffle::enterRaffle{value: 4000000000000000000}([0x0000000000000000000000000000000000000000, 0x0000000000000000000000000000000000000002, 0x0000000000000000000000000000000000000003, 0x0000000000000000000000000000000000000004])````│ ├─ emit RaffleEnter(newPlayers: [0x0000000000000000000000000000000000000000, 0x0000000000000000000000000000000000000002, 0x0000000000000000000000000000000000000003, 0x0000000000000000000000000000000000000004])````│ └─ ← [Stop]````├─ [2962] PuppyRaffle::getActivePlayerIndex(0x0000000000000000000000000000000000000000) [staticcall]````│ └─ ← [Return] 0````├─ [0] console::log("playerIndex", 0) [staticcall]````│ └─ ← [Stop]````└─ ← [Stop]

Suite result: ok. 1 passed; 0 failed; 0 skipped; finished in 26.53ms (3.83ms CPU time)

Recommended Mitigation

Revert on Inactive Player

Revert execution if the player is not found, or return a (uint256 index, bool isActive) tuple so callers can reliably determine participation status.

function getActivePlayerIndex(address player) external view returns (uint256, bool) {
for (uint256 i = 0; i < players.length; i++) {
if (players[i] == player) {
return (i, true);
}
}
return (0, false);
}
Updates

Lead Judging Commences

ai-first-flight-judge Lead Judge about 3 hours ago
Submission Judgement Published
Validated
Assigned finding tags:

[L-01] Ambiguous index returned from PuppyRaffle::getActivePlayerIndex(address), leading to possible refund failures

## Description The `PuppyRaffle::getActivePlayerIndex(address)` returns `0` when the index of this player's address is not found, which is the same as if the player would have been found in the first element in the array. This can trick calling logic to think the address was found and then attempt to execute a `PuppyRaffle::refund(uint256)`. ## Vulnerability Details The `PuppyRaffle::refund()` function requires the index of the player's address to preform the requested refund. ```solidity /// @param playerIndex the index of the player to refund. You can find it externally by calling `getActivePlayerIndex` function refund(uint256 playerIndex) public; ``` In order to have this index, `PuppyRaffle::getActivePlayerIndex(address)` must be used to learn the correct value. ```solidity /// @notice a way to get the index in the array /// @param player the address of a player in the raffle /// @return the index of the player in the array, if they are not active, it returns 0 function getActivePlayerIndex(address player) external view returns (int256) { // find the index... // if not found, then... return 0; } ``` The logic in this function returns `0` as the default, which is as stated in the `@return` NatSpec. However, this can create an issue when the calling logic checks the value and naturally assumes `0` is a valid index that points to the first element in the array. When the players array has at two or more players, calling `PuppyRaffle::refund()` with the incorrect index will result in a normal revert with the message "PuppyRaffle: Only the player can refund", which is fine and obviously expected. On the other hand, in the event a user attempts to perform a `PuppyRaffle::refund()` before a player has been added the EvmError will likely cause an outrageously large gas fee to be charged to the user. This test case can demonstrate the issue: ```solidity function testRefundWhenIndexIsOutOfBounds() public { int256 playerIndex = puppyRaffle.getActivePlayerIndex(playerOne); vm.prank(playerOne); puppyRaffle.refund(uint256(playerIndex)); } ``` The results of running this one test show about 9 ETH in gas: ```text Running 1 test for test/PuppyRaffleTest.t.sol:PuppyRaffleTest [FAIL. Reason: EvmError: Revert] testRefundWhenIndexIsOutOfBounds() (gas: 9079256848778899449) Test result: FAILED. 0 passed; 1 failed; 0 skipped; finished in 914.01µs ``` Additionally, in the very unlikely event that the first player to have entered attempts to preform a `PuppyRaffle::refund()` for another user who has not already entered the raffle, they will unwittingly refund their own entry. A scenario whereby this might happen would be if `playerOne` entered the raffle for themselves and 10 friends. Thinking that `nonPlayerEleven` had been included in the original list and has subsequently requested a `PuppyRaffle::refund()`. Accommodating the request, `playerOne` gets the index for `nonPlayerEleven`. Since the address does not exist as a player, `0` is returned to `playerOne` who then calls `PuppyRaffle::refund()`, thereby refunding their own entry. ## Impact 1. Exorbitantly high gas fees charged to user who might inadvertently request a refund before players have entered the raffle. 2. Inadvertent refunds given based in incorrect `playerIndex`. ## Recommendations 1. Ideally, the whole process can be simplified. Since only the `msg.sender` can request a refund for themselves, there is no reason why `PuppyRaffle::refund()` cannot do the entire process in one call. Consider refactoring and implementing the `PuppyRaffle::refund()` function in this manner: ```solidity /// @dev This function will allow there to be blank spots in the array function refund() public { require(_isActivePlayer(), "PuppyRaffle: Player is not active"); address playerAddress = msg.sender; payable(msg.sender).sendValue(entranceFee); for (uint256 playerIndex = 0; playerIndex < players.length; ++playerIndex) { if (players[playerIndex] == playerAddress) { players[playerIndex] = address(0); } } delete existingAddress[playerAddress]; emit RaffleRefunded(playerAddress); } ``` Which happens to take advantage of the existing and currently unused `PuppyRaffle::_isActivePlayer()` and eliminates the need for the index altogether. 2. Alternatively, if the existing process is necessary for the business case, then consider refactoring the `PuppyRaffle::getActivePlayerIndex(address)` function to return something other than a `uint` that could be mistaken for a valid array index. ```diff + int256 public constant INDEX_NOT_FOUND = -1; + function getActivePlayerIndex(address player) external view returns (int256) { - function getActivePlayerIndex(address player) external view returns (uint256) { for (uint256 i = 0; i < players.length; i++) { if (players[i] == player) { return int256(i); } } - return 0; + return INDEX_NOT_FOUND; } function refund(uint256 playerIndex) public { + require(playerIndex < players.length, "PuppyRaffle: No player for index"); ```

Support

FAQs

Can't find an answer? Chat with us on Discord, Twitter or Linkedin.

Give us feedback!