Comments are meant to be helpful and describe the intent of the code block. However, in multiple parts of the codebase, comments are not consistent with the code that is written or do not add any value to the reader. These are some examples:
The function createLimitShort
in ShortOrdersFacet.sol
contract says that initalCR
is converted to uint8
but throughout the execution of the function it is not converted.
The docs state that The system allows the shorter to specify the CR so that it fits between initialMargin < CR < MAX CR.
. However in createLimitShort
in ShortOrdersFacet.sol
this block of code allows to create short at initialMargin.
In deposit
, depositEth
, withdraw
in BridgeReth.sol
and BridgeSteth.sol
comments say that in this functions there are made operations on zETH
, such as credit zETH to user
or fulfill zETH obligation to user
. However this function does not do the described tasks.
VScode, Manual Review
Consider correcting the comments to not mislead users or developers and write comments that add value to the reader. This will improve code clarity and consistency between docstrings and contract implementations.
The contest is live. Earn rewards by submitting a finding.
This is your time to appeal against judgements on your submissions.
Appeals are being carefully reviewed by our judges.