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

Olympus Finance

51%

Process Quality Review (0.7)

Olympus Finance

Final score:51%
Date:04 Oct 2021
Audit Process:version 0.7
Author:Nick
PQR Score:51%

FAIL

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
65%
1.100%
2.100%
3.Yes
4.50%
5.No
24%
6.Yes
7.No
8.20%
9.52%
10.0%
39%
11.40%
12.30%
13.Yes
14.0%
15.0%
16.100%
61%
17.70%
18.0%
60%
19.40%
20.60%
21.90%
22.40%
Total:51%

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

65%

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 30+ transactions a day on contract DAI Bond, 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 24 commits and 8 branches, Olympus' main smart contract repository has an acceptable development history.

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: No

The team is anonymous.

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

24%

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: No

Software functions are not covered by the documentation.

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

Answer: 20%

Aside from one contract, no documentation could be found relating to the remaining contracts.

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: 52%

Code examples are in the Appendix. As per the SLOC, there is 52% commenting to code (CtC).

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: 0%

The documentation does not list all software functions.

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

39%

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

Answer: 40%

Code examples are in the Appendix. As per the SLOC, there is 28% 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 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: 30%

There is no evidence of code coverage testing. However, there is an incomplete although existing set of tests.

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

14. Report of the results (%)

Answer: 0%

There is no test report result.

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 test has been done.

16. Stress Testing environment (%)

Answer: 100%

There is evidence of Olympus using the Rinkeby network for testing.

Security

61%

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%

Two audits were conducted after deployment: the results are public and have been implemented.

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: 0%

There is no bug bounty program.

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

60%

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: 40%

Access control information can be found in the DAO section of the Olympus documentation, as well as the Treasury section. There is also a Medium article about their Governance at https://olympusdao.medium.com/the-genesis-dao-70f0ee6b5b8. Although this is good access control information, it is in multiple places and is not well-labelled.

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%
  • a) Labelled as upgradeable by governance voting rounds = 30%  - b) The DAO community takes an ownership role = 30%  - c) There is no detailed capability for contract change = 0%

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%

The {medium article](https://olympusdao.medium.com/the-genesis-dao-70f0ee6b5b80) is clearly explained. in user-friendly language.

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: 40%

A halt function is mentioned without further elaboration.

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.

1contract OlympusStaking is Ownable {
23    using SafeMath for uint256;
4    using SafeERC20 for IERC20;
56    address public immutable OHM;
7    address public immutable sOHM;
89    struct Epoch {
10        uint length;
11        uint number;
12        uint endBlock;
13        uint distribute;
14    }
15    Epoch public epoch;
1617    address public distributor;
18    
19    address public locker;
20    uint public totalBonus;
21    
22    address public warmupContract;
23    uint public warmupPeriod;
24    
25    constructor ( 
26        address _OHM, 
27        address _sOHM, 
28        uint _epochLength,
29        uint _firstEpochNumber,
30        uint _firstEpochBlock
31    ) {
32        require( _OHM != address(0) );
33        OHM = _OHM;
34        require( _sOHM != address(0) );
35        sOHM = _sOHM;
36        
37        epoch = Epoch({
38            length: _epochLength,
39            number: _firstEpochNumber,
40            endBlock: _firstEpochBlock,
41            distribute: 0
42        });
43    }
4445    struct Claim {
46        uint deposit;
47        uint gons;
48        uint expiry;
49        bool lock; // prevents malicious delays
50    }
51    mapping( address => Claim ) public warmupInfo;
5253    /**
54        @notice stake OHM to enter warmup
55        @param _amount uint
56        @return bool
57     */
58    function stake( uint _amount, address _recipient ) external returns ( bool ) {
59        rebase();
60        
61        IERC20( OHM ).safeTransferFrom( msg.sender, address(this), _amount );
6263        Claim memory info = warmupInfo[ _recipient ];
64        require( !info.lock, "Deposits for account are locked" );
6566        warmupInfo[ _recipient ] = Claim ({
67            deposit: info.deposit.add( _amount ),
68            gons: info.gons.add( IsOHM( sOHM ).gonsForBalance( _amount ) ),
69            expiry: epoch.number.add( warmupPeriod ),
70            lock: false
71        });
72        
73        IERC20( sOHM ).safeTransfer( warmupContract, _amount );
74        return true;
75    }
7677    /**
78        @notice retrieve sOHM from warmup
79        @param _recipient address
80     */
81    function claim ( address _recipient ) public {
82        Claim memory info = warmupInfo[ _recipient ];
83        if ( epoch.number >= info.expiry && info.expiry != 0 ) {
84            delete warmupInfo[ _recipient ];
85            IWarmup( warmupContract ).retrieve( _recipient, IsOHM( sOHM ).balanceForGons( info.gons ) );
86        }
87    }
8889    /**
90        @notice forfeit sOHM in warmup and retrieve OHM
91     */
92    function forfeit() external {
93        Claim memory info = warmupInfo[ msg.sender ];
94        delete warmupInfo[ msg.sender ];
9596        IWarmup( warmupContract ).retrieve( address(this), IsOHM( sOHM ).balanceForGons( info.gons ) );
97        IERC20( OHM ).safeTransfer( msg.sender, info.deposit );
98    }
99100    /**
101        @notice prevent new deposits to address (protection from malicious activity)
102     */
103    function toggleDepositLock() external {
104        warmupInfo[ msg.sender ].lock = !warmupInfo[ msg.sender ].lock;
105    }
106107    /**
108        @notice redeem sOHM for OHM
109        @param _amount uint
110        @param _trigger bool
111     */
112    function unstake( uint _amount, bool _trigger ) external {
113        if ( _trigger ) {
114            rebase();
115        }
116        IERC20( sOHM ).safeTransferFrom( msg.sender, address(this), _amount );
117        IERC20( OHM ).safeTransfer( msg.sender, _amount );
118    }
119120    /**
121        @notice returns the sOHM index, which tracks rebase growth
122        @return uint
123     */
124    function index() public view returns ( uint ) {
125        return IsOHM( sOHM ).index();
126    }
127128    /**
129        @notice trigger rebase if epoch over
130     */
131    function rebase() public {
132        if( epoch.endBlock <= block.number ) {
133134            IsOHM( sOHM ).rebase( epoch.distribute, epoch.number );
135136            epoch.endBlock = epoch.endBlock.add( epoch.length );
137            epoch.number++;
138            
139            if ( distributor != address(0) ) {
140                IDistributor( distributor ).distribute();
141            }
142143            uint balance = contractBalance();
144            uint staked = IsOHM( sOHM ).circulatingSupply();
145146            if( balance <= staked ) {
147                epoch.distribute = 0;
148            } else {
149                epoch.distribute = balance.sub( staked );
150            }
151        }
152    }
153154    /**
155        @notice returns contract OHM holdings, including bonuses provided
156        @return uint
157     */
158    function contractBalance() public view returns ( uint ) {
159        return IERC20( OHM ).balanceOf( address(this) ).add( totalBonus );
160    }
161162    /*
163        @notice provide bonus to locked staking contract
164        @param _amount uint
165     */
166    function giveLockBonus( uint _amount ) external {
167        require( msg.sender == locker );
168        totalBonus = totalBonus.add( _amount );
169        IERC20( sOHM ).safeTransfer( locker, _amount );
170    }
171172    /*
173        @notice reclaim bonus from locked staking contract
174        @param _amount uint
175     */

Solidity Contracts

Language
Files
Lines
Blanks
Comments
Code
Complexity
Solidity
12
7608
1304
2162
4142
555

Comments to Code: 2162 / 4142 =  52 %

JavaScript Tests

Language
Files
Lines
Blanks
Comments
Code
Complexity
JavaScript
1
92
17
11
64
0
TypeScript
4
933
226
13
694
8
Total
5
1025
243
24
758
8

Tests to Code: 758 / 4142 = 18 %