logo
bg_imgbg_imgbg_imgbg_img
exclamation mark iconReport an issue

If you notice some outdated information please let us know!

close icon
Name
Email
Your message
arrow-left

unFederalReserve

74%

Process Quality Review (0.7)

unFederalReserve

Final score:74%
Date:07 Jun 2021
Audit Process:version 0.7
Author:Nic of DeFiSafety
PQR Score:74%

PASS

Scoring Appendix

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.

The blockchain used by this protocol
Ethereum
#QuestionAnswer
95%
1.100%
2.100%
3.Yes
4.50%
5.Yes
96%
6.Yes
7.Yes
8.100%
9.63%
10.100%
57%
11.80%
12.50%
13.Yes
14.0%
15.0%
16.100%
70%
17.70%
18.70%
53%
19.70%
20.60%
21.90%
22.0%
Total:74%

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.

  • Here is my smart contract on the blockchain
  • You can see it matches a software repository used to develop the code
  • Here is the documentation that explains what my smart contract does
  • Here are the tests I ran to verify my smart contract
  • Here are the audit(s) performed to review my code by third party experts

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 2021. Permission is given to copy in whole, retaining this copyright label.

Code And Team

95%

This section looks at the code deployed on the Mainnet that gets reviewed and its corresponding software repository. The document explaining these questions is here.

1. Are the executing code addresses readily available? (%)

Answer: 100%

Percentage Score Guidance:
100%
Clearly labelled and on website, docs or repo, quick to find
70%
Clearly labelled and on website, docs or repo but takes a bit of looking
40%
Addresses in mainnet.json, in discord or sub graph, etc
20%
Address found but labeling not clear or easy to find
0%
Executing addresses could not be found

2. Is the code actively being used? (%)

Answer: 100%

Activity is 60 transactions a day on contract Unitroller.sol, as indicated in the Appendix.​

Percentage Score Guidance:
100%
More than 10 transactions a day
70%
More than 10 transactions a week
40%
More than 10 transactions a month
10%
Less than 10 transactions a month
0%
No activity

3. Is there a public software repository? (Y/N)

Answer: Yes

Is there a public software repository with the code at a minimum, but also normally test and scripts. Even if the repository was created just to hold the files and has just 1 transaction, it gets a "Yes". For teams with private repositories, this answer is "No"

Score Guidance:
Yes
There is a public software repository with the code at a minimum, but also normally test and scripts. Even if the repository was created just to hold the files and has just 1 transaction.
No
For teams with private repositories.

4. Is there a development history visible? (%)

Answer: 50%

With 65 commits and 2 branches, this is a semi-acceptable software repository.

This metric checks if the software repository demonstrates a strong steady history. This is normally demonstrated by commits, branches and releases in a software repository. A healthy history demonstrates a history of more than a month (at a minimum).

Percentage Score Guidance:
100%
Any one of 100+ commits, 10+branches
70%
Any one of 70+ commits, 7+branches
50%
Any one of 50+ commits, 5+branches
30%
Any one of 30+ commits, 3+branches
0%
Less than 2 branches or less than 30 commits

5. Is the team public (not anonymous)? (Y/N)

Answer: Yes

You can find team information at https://unfederalreserve.com/team

For a "Yes" in this question, the real names of some team members must be public on the website or other documentation (LinkedIn, etc). If the team is anonymous, then this question is a "No".

Documentation

96%

This section looks at the software documentation. The document explaining these questions is here.

6. Is there a whitepaper? (Y/N)

Answer: Yes

7. Are the basic software functions documented? (Y/N)

Answer: Yes

8. Does the software function documentation fully (100%) cover the deployed contracts? (%)

Answer: 100%

Percentage Score Guidance:
100%
All contracts and functions documented
80%
Only the major functions documented
79 - 1%
Estimate of the level of software documentation
0%
No software documentation

9. Are there sufficiently detailed comments for all functions within the deployed contract code (%)

Answer: 63%
  • Code examples are in the Appendix. As per the SLOC, there is 63% commenting to code (CtC).  - Note: This is essentially the CtC of their Compound fork, which is their only extensive repository.

The Comments to Code (CtC) ratio is the primary metric for this score.

Percentage Score Guidance:
100%
CtC > 100 Useful comments consistently on all code
90 - 70%
CtC > 70 Useful comment on most code
60 - 20%
CtC > 20 Some useful commenting
0%
CtC < 20 No useful commenting

10. Is it possible to trace from software documentation to the implementation in code (%)

Answer: 100%

There is clear explicit traceability found at https://lending-docs.unfederalreserve.com/docs/developer/untokens/.

Percentage Score Guidance:
100%
Clear explicit traceability between code and documentation at a requirement level for all code
60%
Clear association between code and documents via non explicit traceability
40%
Documentation lists all the functions and describes their functions
0%
No connection between documentation and code

Testing

57%

11. Full test suite (Covers all the deployed code) (%)

Answer: 80%
  • As per the SLOC, there is 95% testing to code (TtC).  - Note: This is essentially the TtC of their Compound fork.

This score is guided by the Test to Code ratio (TtC). Generally a good test to code ratio is over 100%. However the reviewers best judgement is the final deciding factor.

Percentage Score Guidance:
100%
TtC > 120% Both unit and system test visible
80%
TtC > 80% Both unit and system test visible
40%
TtC < 80% Some tests visible
0%
No tests obvious

12. Code coverage (Covers all the deployed lines of code, or explains misses) (%)

Answer: 50%

Percentage Score Guidance:
100%
Documented full coverage
99 - 51%
Value of test coverage from documented results
50%
No indication of code coverage but clearly there is a reasonably complete set of tests
30%
Some tests evident but not complete
0%
No test for coverage seen

13. Scripts and instructions to run the tests? (Y/N)

Answer: Yes

Instructions can be found at the bottom of this page: https://github.com/UnFederalReserve/compound-protocol​  

14. Report of the results (%)

Answer: 0%

There is no evidence of a test report.

Percentage Score Guidance:
100%
Detailed test report as described below
70%
GitHub code coverage report visible
0%
No test report evident

15. Formal Verification test done (%)

Answer: 0%

No formal verification of unFederalReserve was performed.

16. Stress Testing environment (%)

Answer: 100%

Security

70%

This section looks at the 3rd party software audits done. It is explained in this document.

17. Did 3rd Party audits take place? (%)

Answer: 70%

Percentage Score Guidance:
100%
Multiple Audits performed before deployment and results public and implemented or not required
90%
Single audit performed before deployment and results public and implemented or not required
70%
Audit(s) performed after deployment and no changes required. Audit report is public
50%
Audit(s) performed after deployment and changes needed but not implemented
20%
No audit performed
0%
Audit Performed after deployment, existence is public, report is not public and no improvements deployed OR smart contract address not found, (where question 1 is 0%)
Deduct 25% if code is in a private repo and no note from auditors that audit is applicable to deployed code.

18. Is the bug bounty acceptable high? (%)

Answer: 70%

Bug bounty info found at https://lending-docs.unfederalreserve.com/docs/security/bug-bounty/​.  Reward as high as 150k, and active since May 20th 2021.

Percentage Score Guidance:
100%
Bounty is 10% TVL or at least $1M AND active program (see below)
90%
Bounty is 5% TVL or at least 500k AND active program
80%
Bounty is 5% TVL or at least 500k
70%
Bounty is 100k or over AND active program
60%
Bounty is 100k or over
50%
Bounty is 50k or over AND active program
40%
Bounty is 50k or over
20%
Bug bounty program bounty is less than 50k
0%
No bug bounty program offered
An active program means that a third party (such as Immunefi) is actively driving hackers to the site. An inactive program would be static mentions on the docs.

Access Controls

53%

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.

19. Can a user clearly and quickly find the status of the access controls (%)

Answer: 70%

Admin controls can be found on page 42 of https://unfederalreserve.com/docs/Residual_Token_Whitepaper_091520_CONFIDE.pdf, and page 2 of https://unfederalreserve.com/docs/LitePaperRSDL.pdf.    - Note: unFederalReserve is indicated as being immutable on their home page at https://unfederalreserve.com/, however there is contradictory information in their documentation.

Percentage Score Guidance:
100%
Clearly labelled and on website, docs or repo, quick to find
70%
Clearly labelled and on website, docs or repo but takes a bit of looking
40%
Access control docs in multiple places and not well labelled
20%
Access control docs in multiple places and not labelled
0%
Admin Control information could not be found

20. Is the information clear and complete (%)

Answer: 60%

Percentage Score Guidance:
All the contracts are immutable -- 100% OR
a) All contracts are clearly labelled as upgradeable (or not) -- 30% AND
b) The type of ownership is clearly indicated (OnlyOwner / MultiSig / Defined Roles) -- 30% AND
c) The capabilities for change in the contracts are described -- 30%

21. Is the information in non-technical terms that pertain to the investments (%)

Answer: 90%

Percentage Score Guidance:
100%
All the contracts are immutable
90%
Description relates to investments safety and updates in clear, complete non-software language
30%
Description all in software specific language
0%
No admin control information could be found

22. Is there Pause Control documentation including records of tests (%)

Answer: 0%

Percentage Score Guidance:
100%
All the contracts are immutable or no pause control needed and this is explained OR Pause control(s) are clearly documented and there is records of at least one test within 3 months
80%
Pause control(s) explained clearly but no evidence of regular tests
40%
Pause controls mentioned with no detail on capability or tests
0%
Pause control not documented or explained

Appendices

 The author of this review is Rex of DeFi Safety.

Email: rex@defisafety.com
Twitter: @defisafety

I started with Ethereum just before the DAO and that was a wonderful education.  It showed the importance of code quality. The second Parity hack also showed the importance of good process.  Here my aviation background offers some value. Aerospace knows how to make reliable code using quality processes.
I was coaxed to go to EthDenver 2018 and there I started SecuEth.org with Bryant and Roman. We created guidelines on good processes for blockchain code development. We got EthFoundation funding to assist in their development Process Quality Reviews are an extension of the SecurEth guidelines that will further increase the quality processes in Solidity and Vyper development. DeFiSafety is my full time gig and we are working on funding vehicles for a permanent staff.

1pragma solidity ^0.5.16;
23import "./ErrorReporter.sol";
4import "./ComptrollerStorage.sol";
5/**
6 * @title ComptrollerCore
7 * @dev Storage for the comptroller is at this address, while execution is delegated to the `comptrollerImplementation`.
8 * CTokens should reference this contract as their comptroller.
9 */
10contract Unitroller is UnitrollerAdminStorage, ComptrollerErrorReporter {
1112    /**
13      * @notice Emitted when pendingComptrollerImplementation is changed
14      */
15    event NewPendingImplementation(address oldPendingImplementation, address newPendingImplementation);
1617    /**
18      * @notice Emitted when pendingComptrollerImplementation is accepted, which means comptroller implementation is updated
19      */
20    event NewImplementation(address oldImplementation, address newImplementation);
2122    /**
23      * @notice Emitted when pendingAdmin is changed
24      */
25    event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin);
2627    /**
28      * @notice Emitted when pendingAdmin is accepted, which means admin is updated
29      */
30    event NewAdmin(address oldAdmin, address newAdmin);
3132    constructor() public {
33        // Set admin to caller
34        admin = msg.sender;
35    }
3637    /** Admin Functions **/
38    function _setPendingImplementation(address newPendingImplementation) public returns (uint) {
3940        if (msg.sender != admin) {
41            return fail(Error.UNAUTHORIZED, FailureInfo.SET_PENDING_IMPLEMENTATION_OWNER_CHECK);
42        }
4344        address oldPendingImplementation = pendingComptrollerImplementation;
4546        pendingComptrollerImplementation = newPendingImplementation;
4748        emit NewPendingImplementation(oldPendingImplementation, pendingComptrollerImplementation);
4950        return uint(Error.NO_ERROR);
51    }
5253    /**
54    * @notice Accepts new implementation of comptroller. msg.sender must be pendingImplementation
55    * @dev Admin function for new implementation to accept it's role as implementation
56    * @return uint 0=success, otherwise a failure (see ErrorReporter.sol for details)
57    */
58    function _acceptImplementation() public returns (uint) {
59        // Check caller is pendingImplementation and pendingImplementation ≠ address(0)
60        if (msg.sender != pendingComptrollerImplementation || pendingComptrollerImplementation == address(0)) {
61            return fail(Error.UNAUTHORIZED, FailureInfo.ACCEPT_PENDING_IMPLEMENTATION_ADDRESS_CHECK);
62        }
63

Solidity Contracts

Language
Files
Lines
Blanks
Comments
Code
Complexity
Solidity
44
15331
2428
4993
7910
1569

Comments to Code: 4993 / 7910 =  63 %

JavaScript Tests

Language
Files
Lines
Blanks
Comments
Code
Complexity
JavaScript
48
9138
1352
244
7542
313

Tests to Code: 7542 / 7910 = 95 %