Paladin - Warden Pledges contest - neko_nyaa's results

[L-01] Typo/grammar mistakes

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L71

• protocalFeeRatio should be protocolFeeRatio

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L545

• InequalArraySizes should be UnequalArraySizes

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L42

• canceled should be cancelled

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L292

• taget of votes should be target of votes
• balacne should be balance

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L650

• Address tof the EC2O token should be Address of the ERC2O token (two mistakes: tof and EC20)

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L295 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L296 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L365 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L366 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L413

• ot be pulled should be to be pulled

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L453 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L485

• fo should be of

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L339

• reards should be rewards

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L621

• Platform should not be uppercase when referring to self.
  • This is a bit nitpicking, I apologize if I misunderstand its meaning.

[L-02] Redundant return value

Function recoverERC20() uses OpenZeppelin's safeTransfer(), which is guaranteed to revert if the transfer fails. Hence, this function will either revert, or return true, making the return value redundant.

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L653-L661

[L-03] Incomplete documentation

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L84-L119

All of the events (13 in total) have incomplete documentation

[L-04] Wrong usage of NatSpec format comments

In general, @notice is meant to be a brief description of the function (i.e. what it's supposed to do, in one line), while @dev is meant to provide devs with clarifications, or some notes on function behavior that one might not expect, or anything noteworthy in general.

The report below points out all found instances of tags misusage, along with recommended mitigation. There are four distinct issues in total listed:

• All instances below lists two lines, where the @dev-tagged line and the @notice-tagged line are completely the same. Recommendation: remove the @dev line.

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L288-L289 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L149-L150 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L158-L159 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L168-L169 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L189-L190 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L200-L201 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L536-L537 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L555-L556 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L565-L566 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L581-L582 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L595-L596 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L608-L609 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L621-L622 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L648-L649

• All instances below lists two lines, where the @dev-tagged line is just the @notice line with extra details. Recommendation: Remove the current @notice and replace @dev with @notice.

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L361-L362 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L407-L408 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L451-L452 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L483-L484

• All instances below lists one line, where the @dev tag is used where @notice should be. Recommendation: Replace @dev with @notice.

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L126 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L177 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L216 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L521

• All instances below lists one line, where the comment is descriptive enough to be placed in the preceeding @notice tag, or be its own @dev tag. Recommendation: Either combine them with the preceeding @notice tag, or tag it with @dev.

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L55 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L66

[L-05] Missing zero address checks in constructor

Specifically, updateChest() has a zero-address sanity check for chestAddress, however there is no such check in the constructor.

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L131-L143

[N-01] A constant should be used instead of a magic value

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L626

This is also in line with how the contract defines constants for e.g. MAX_PCT.

[N-02] Documentation on obvious functions may be redundant

I think pause() functions are completely clear and do not need documentation. Furthermore they are admin functions.

However this is an opinion-based non-risk finding, the decision should be ultimately up to the sponsors' preference.

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L634 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L641

[N-03] Use native time unit rather than defining constants

The line below can be changed to 7 weeks

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L24

This is also for consistency with how minDelegationTime is defined, as shown below

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L79

[N-04] Events can use indexed fields for easier querying

Generally it is a good idea to place indexed fields for database-like data, where it is expected that such data will be queried.

Specifically, the event NewPledge would be extremely helpful to contain indexed fields for creator and receiver, where such values can be expected to be queried by user when needed (e.g. when a receiver wants to query who has pledged them or otherwise).

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L85-L92

[N-05] The nonReentrant modifier should occur before all other modifiers

This is a best-practice to protect against reentrancy in other modifiers. Applies to all functions with this modifier.

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L195 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L206 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L307 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L373 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L419 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L456 https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L488

Overall, the codebase was quite well-written, with clear intentions for gas optimizations found in e.g. unchecked for loops. The C4udit tool also points out a lot of impactful gas optimizations. This report points out some other possible gas savings for the contract.

[G-01] Several variables can be made constant and immutable

The following value can be made constant:

uint256 public minDelegationTime = 1 weeks;

• https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L79

The following two values can be made immutable:

IVotingEscrow public votingEscrow;
IBoostV2 public delegationBoost;

• https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L60
• https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L62

Applying all the aforementioned reduces deployment gas from 2695825 down to 2678735 (for 17090 gas in total).

Furthermore, since constants and immutables are stored in the contract bytecode rather than storage, this also saves around 2000 storage-reading gas for every operations that require these values.

[G-02] unchecked applicable for arithmetic operations that cannot overflow/underflow

Two instances are found:

• https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L182
  • Obviously cannot overflow/underflow. Can change to:

unchecked {return (timestamp / WEEK) * WEEK;}

• https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L268
  • The condition check one line before ensures cannot underflow. Thus can be changed to:

unchecked{pledgeAvailableRewardAmounts[pledgeId] -= rewardAmount;}

Saves approx. 150 operational gas on re-running tests with these modifications applied, also saves minor deployment gas.

[G-03] protocalFeeRatio can be better packed

(For the sake of reporting, we ignore the typo)

https://github.com/code-423n4/2022-10-paladin/blob/d6d0c0e57ad80f15e9691086c9c7270d4ccfe0e6/contracts/WardenPledge.sol#L71

The storage variable protocalFeeRatio can be changed to type uint96, since the fee ratio cannot exceed 500. Then the storage slot looks like follow:

// this is one slot
uint96 public protocalFeeRatio = 250;
address public chestAddress;

updatePlatformFee() can be easily modified accordingly.

Re-running tests with this optimization increases deployment gas by 18698 (up to 2714523). However, all pledging operations (except for closePledge()) saves approx. 2000 gas, for having reduced one storage slot to look at. Hence this optimization is impactful in the long run.