Assessment reports>Ionic Protocol>Discussion>Documentation

Documentation

As a consequence of updating the Fuse codebase, which is a modified fork of the Compound codebase, many aspects of the documentation are either outdated, inaccurate or insufficient. The codebase is more difficult to read and reason about than it should be due to the interchangeable use of NativeToken and ETH.

Code maturity is very important in high-assurance projects. Undocumented code may result in developer confusion, potentially leading to future bugs, should the code need to be modified later on. In general, lack of documentation impedes auditors and external developers from reading, understanding, and extending the code. The problem will also be carried over if the code is ever forked or re-used.

Zellic © 2023Back to top ↑