code-423n4 / 2021-08-yield-findings

1 stars 0 forks source link

CompositeMultiOracle.sol - Add natspec documentation #15

Open code423n4 opened 3 years ago

code423n4 commented 3 years ago

Handle

PierrickGT

Vulnerability details

Impact

In CompositeMultiOracle.sol, internal functions, event, struct, public constant and mapping are not documented.

Functions parameters and return values should also be documented for external functions.

Natspec documentation should also be added to describe what this contract is all about.

Proof of Concept

https://github.com/code-423n4/2021-08-yield/blob/1383f6a715657547603cddd0fed824cde631c7db/contracts/oracles/compound/CTokenMultiOracle.sol#L79-L81

https://github.com/code-423n4/2021-08-yield/blob/1383f6a715657547603cddd0fed824cde631c7db/contracts/oracles/compound/CTokenMultiOracle.sol#L97-L99

Recommended Mitigation Steps

Add natspec documentation to describe the contract and not just his title:

Add natspec documentation for the following code:

Add natspec documentation for parameters and return value of these functions:

alcueca commented 3 years ago

Fix