Skip to content

Conversation

@chrismaree
Copy link
Member

Problem:
Although most of the codebase is thoroughly documented, there are a few instances where
documentation is lacking. For instance:
In the HubPool contract the public unclaimedAccumulatedProtocolFees variable has no inline
documentation.
In the HubPool contract the inline documentation accompanying
PoolRebalanceLeaf.netSendAmounts, although lengthy, could benefit from additional
clarification around the case of negative values. It could clarify further that in such cases the
actual netSendAmounts value is ignored, but it should match the amountToReturn parameter in
the RelayerRefundLeaf.
Many of the functions in the MerkleLib library are missing NatSpec @return statements.

Solution: all places with missing documentation were updated.

Signed-off-by: chrismaree <christopher.maree@gmail.com>
Signed-off-by: chrismaree <christopher.maree@gmail.com>
@chrismaree chrismaree requested a review from nicholaspai March 16, 2022 07:16
@chrismaree chrismaree added the OZ Audit - March Resolves issue discovered in March 2022 OZ Audit label Mar 16, 2022
@mrice32 mrice32 self-requested a review March 17, 2022 12:28
Copy link
Member

@nicholaspai nicholaspai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM after committing my suggestions!

chrismaree and others added 4 commits March 18, 2022 07:28
Co-authored-by: nicholaspai <9457025+nicholaspai@users.noreply.github.com>
Co-authored-by: nicholaspai <9457025+nicholaspai@users.noreply.github.com>
Co-authored-by: nicholaspai <9457025+nicholaspai@users.noreply.github.com>
Co-authored-by: nicholaspai <9457025+nicholaspai@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

OZ Audit - March Resolves issue discovered in March 2022 OZ Audit

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants