If you notice some outdated information please let us know!
PASS
The final review score is indicated as a percentage. The percentage is calculated as Achieved Points due to MAX Possible Points. For each element the answer can be either Yes/No or a percentage. For a detailed breakdown of the individual weights of each question, please consult this document.
Very simply, the audit looks for the following declarations from the developer's site. With these declarations, it is reasonable to trust the smart contracts.
This report is for informational purposes only and does not constitute investment advice of any kind, nor does it constitute an offer to provide investment advisory or other services. Nothing in this report shall be considered a solicitation or offer to buy or sell any security, token, future, option or other financial instrument or to offer or provide any investment advice or service to any person in any jurisdiction. Nothing contained in this report constitutes investment advice or offers any opinion with respect to the suitability of any security, and the views expressed in this report should not be taken as advice to buy, sell or hold any security. The information in this report should not be relied upon for the purpose of investing. In preparing the information contained in this report, we have not taken into account the investment needs, objectives and financial circumstances of any particular investor. This information has no regard to the specific investment objectives, financial situation and particular needs of any specific recipient of this information and investments discussed may not be suitable for all investors.
Any views expressed in this report by us were prepared based upon the information available to us at the time such views were written. The views expressed within this report are limited to DeFiSafety and the author and do not reflect those of any additional or third party and are strictly based upon DeFiSafety, its authors, interpretations and evaluation of relevant data. Changed or additional information could cause such views to change. All information is subject to possible correction. Information may quickly become unreliable for various reasons, including changes in market conditions or economic circumstances.
This completed report is copyright (c) DeFiSafety 2023. Permission is given to copy in whole, retaining this copyright label.
This section looks at the code deployed on the relevant chain that gets reviewed and its corresponding software repository. The document explaining these questions is here.
1. Are the smart contract addresses easy to find? (%)
They can be found in the docs under Security and Smart Contracts and Security of the Forta docs, as indicated in the Appendix. This was easy to find.
2. How active is the primary contract? (%)
Contract Agents (Detection Bots) is used 12 times a day, as indicated in the Appendix.
3. Does the protocol have a public software repository? (Y/N)
Yes it does
4. Is there a development history visible? (%)
With 269 commits and 25 branches, this is a well used repo.
5. Is the team public (not anonymous)?
There is no apparent team page, but the GitHub contributors have several named devs. Where we found the team is documented in our team appendix at the end of this report.
This section looks at the software documentation. The document explaining these questions is here.
7. Is the protocol's software architecture documented? (Y/N)
This protocol's software architecture is documented in theSecurity and Smart Contract, Design page.
8. Does the software documentation fully cover the deployed contracts' source code? (%)
Software documentation is in the docs at "Security and Smart Contracts", "Smart Contracts". The documentation includes a text description of each contract and then details for all variables and functions. The documentation appears quite complete.
9. Is it possible to trace the documented software to its implementation in the protocol's source code? (%)
There is non explicit traceability between software documentation and implemented code. You cannot link from docs to code.
10. Has the protocol tested their deployed code? (%)
With 60,804 Lines of Code and only 18,522 test lines, the TtC is just 30%. However we believe the number of Lines of Code was in error. The CodeCov report indicated 80.6% coverage which is good but not great. We will score this at 81% Code examples are in the Appendix at the end of this report.. As per the SLOC, there is 30% testing to code (TtC). This score is guided by the Test to Code ratio (TtC). Generally a good test to code ratio is over 100%. However, the reviewer's best judgement is the final deciding factor. ─────────────────────────────────────────────────────────────────────────────── Language Files Lines Blanks Comments Code Complexity ─────────────────────────────────────────────────────────────────────────────── JavaScript 73 60804 7840 28082 24882 2756 ─────────────────────────────────────────────────────────────────────────────── Total 73 60804 7840 28082 24882 2756 ─────────────────────────────────────────────────────────────────────────────── Estimated Cost to Develop $789,359 Estimated Schedule Effort 12.571251 months Estimated People Required 5.578434 ─────────────────────────────────────────────────────────────────────────────── Processed 2267049 bytes, 2.267 megabytes (SI) ─────────────────────────────────────────────────────────────────────────────── C:\Users\Rex\Sync\DeFiSafety\DeFiSafety Common\Products\Processs Quality Reviews\Reviews - Copy\0.8\Forta\Flattened>cd C:\Users\Rex\Sync\DeFiSafety\DeFiSafety Common\Products\Processs Quality Reviews\Reviews - Copy\0.8\Forta\TestingEnv C:\Users\Rex\Sync\DeFiSafety\DeFiSafety Common\Products\Processs Quality Reviews\Reviews - Copy\0.8\Forta\TestingEnv>scc.exe ─────────────────────────────────────────────────────────────────────────────── Language Files Lines Blanks Comments Code Complexity ─────────────────────────────────────────────────────────────────────────────── JavaScript 22 6362 936 139 5287 128 TypeScript 7 643 108 12 523 13 JSON 5 11437 0 0 11437 0 YAML 3 80 7 4 69 0 ─────────────────────────────────────────────────────────────────────────────── Total 37 18522 1051 155 17316 141 ─────────────────────────────────────────────────────────────────────────────── Estimated Cost to Develop $539,467 Estimated Schedule Effort 10.878296 months Estimated People Required 4.405755 ─────────────────────────────────────────────────────────────────────────────── Processed 986733 bytes, 0.987 megabytes (SI) ───────────────────────────────────────────────────────────────────────────────
11. How covered is the protocol's code? (%)
Code coverage report indicates 81%
12. Does the protocol provide scripts and instructions to run their tests? (Y/N)
Scripts/Instructions location: https://github.com/forta-network/forta-contracts/readme
13. Is there a detailed report of the protocol's test results?(%)
Code coverage report indicates 81%. therefore the score for this question is 70% as per guidance.
14. Has the protocol undergone Formal Verification? (Y/N)
This protocol has not undergone formal verification. As it is a monitoring protocol this makes sense from a risk perspective. Also, the Forta protocol is monitored by Forta and therefore invariants are being assessed and monitored in real time. For this reason we shall grant points on this section.
15. Were the smart contracts deployed to a testnet? (Y/N)
This protocol has been deployed to a testnet.
This section looks at the 3rd party software audits done. It is explained in this document.
16. Is the protocol sufficiently audited? (%)
The audits are available here. There are several which have corrections included.
17. Is the bounty value acceptably high (%)
This protocol offers an active bug bounty of $100K
This section covers the documentation of special access controls for a DeFi protocol. The admin access controls are the contracts that allow updating contracts or coefficients in the protocol. Since these contracts can allow the protocol admins to "change the rules", complete disclosure of capabilities is vital for user's transparency. It is explained in this document.
18. Is the protocol's admin control information easy to find?
Admin control information was clearly documented at Security and Smart Contacts, Deployment. This was quick to find.
19. Are relevant contracts clearly labelled as upgradeable or immutable? (%)
.The relevant contracts are clearly identified as upgradeable through Open Zep's Defender. In this case, a score of 100% is given.
20. Is the type of smart contract ownership clearly indicated? (%)
Ownership is clearly indicated in the Roles section.
21. Are the protocol's smart contract change capabilities described? (%)
Smart contract change capabilities are explicitly identified in the contracts. The roles are itemized and described.
22. Is the protocol's admin control information easy to understand? (%)
This information is clearly described in software clear language.
23. Is there sufficient Pause Control documentation? (%)
This protocol's pause control is not clearly documented as not implemented or required.
24. Is there sufficient Timelock documentation? (%)
This protocol has timelock documentation that indicates no timelock required.
25. Is the Timelock of an adequate length? (Y/N)
The timelock is not implemented.
This section goes over the documentation that a protocol may or may not supply about their Oracle usage. Oracles are a fundamental part of DeFi as they are responsible for relaying tons of price data information to thousands of protocols using blockchain technology. Not only are they important for price feeds, but they are also an essential component of transaction verification and security. These questions are explained in this document.
26. Is the protocol's Oracle sufficiently documented? (%)
The protocol's oracle source is not required as indicated in the documentation.
27. Is front running mitigated by this protocol? (Y/N)
This protocol does not require an Oracle.
28. Can flashloan attacks be applied to the protocol, and if so, are those flashloan attack risks mitigated? (Y/N)
This protocol does not require an Oracle.
1Enter appendix example code here