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 Mainnet that gets reviewed and its corresponding software repository. The document explaining these questions is here.
1. Are the executing code addresses readily available? (%)
They are available at website https://api.nexusmutual.io/version-data/, as indicated in the Appendix.
2. Is the code actively being used? (%)
Activity is over 10 transactions a day, when combining internal and external transactions, on contract 0x84EdfFA16bb0b9Ab1163abb0a13Ff0744c11272f as indicated in the Appendix.
3. Is there a public software repository? (Y/N)
GitHub: https://github.com/NexusMutual
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"
4. Is there a development history visible? (%)
An impressive 2,248 commits with 10 branches details a rich 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).
5. Is the team public (not anonymous)? (Y/N)
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".
This section looks at the software documentation. The document explaining these questions is here.
6. Is there a whitepaper? (Y/N)
7. Are the basic software functions documented? (Y/N)
8. Does the software function documentation fully (100%) cover the deployed contracts? (%)
The documentation covers all deployed contracts, but there is little explanation.
9. Are there sufficiently detailed comments for all functions within the deployed contract code (%)
The Comments to Code (CtC) ratio is the primary metric for this score.
10. Is it possible to trace from software documentation to the implementation in code (%)
A deployment contract has not been clearly explained with explicit traceability, and other traceability is nonexplicit between the documents and the protocol's GitHub.
11. Full test suite (Covers all the deployed code) (%)
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.
12. Code coverage (Covers all the deployed lines of code, or explains misses) (%)
The code coverage is documented here.
13. Scripts and instructions to run the tests? (Y/N)
Scrips/Instructions location: https://github.com/NexusMutual/smart-contracts
14. Report of the results (%)
There is no test report.
15. Formal Verification test done (%)
No formal verification was found.
16. Stress Testing environment (%)
The documents mention projects undergoing testing in addition to documented Kovan testing.
This section looks at the 3rd party software audits done. It is explained in this document.
17. Did 3rd Party audits take place? (%)
Three audits have taken place in which the results have been published. The most recent was in May, 2021.
18. Is the bug bounty acceptable high? (%)
Nexus Mutual operates an active bounty program with a maximum reward of $50,000.
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 (%)
The access controls are easily located in the documents.
20. Is the information clear and complete (%)
21. Is the information in non-technical terms that pertain to the investments (%)
The information is very clearly explained in this document. You can also find additional Risk Assessment info here.
22. Is there Pause Control documentation including records of tests (%)
Pause controls are defined without evidence of regular testing.
1contract ClaimsData is IClaimsData, LegacyMasterAware {
2 using SafeMath for uint;
3
4 struct Claim {
5 uint coverId;
6 uint dateUpd;
7 }
8
9 struct Vote {
10 address voter;
11 uint tokens;
12 uint claimId;
13 int8 verdict;
14 bool rewardClaimed;
15 }
16
17 struct ClaimsPause {
18 uint coverid;
19 uint dateUpd;
20 bool submit;
21 }
22
23 struct ClaimPauseVoting {
24 uint claimid;
25 uint pendingTime;
26 bool voting;
27 }
28
29 struct RewardDistributed {
30 uint lastCAvoteIndex;
31 uint lastMVvoteIndex;
32
33 }
34
35 struct ClaimRewardDetails {
36 uint percCA;
37 uint percMV;
38 uint tokenToBeDist;
39
40 }
41
42 struct ClaimTotalTokens {
43 uint accept;
44 uint deny;
45 }
46
47 struct ClaimRewardStatus {
48 uint percCA;
49 uint percMV;
50 }
51
52 ClaimRewardStatus[] internal rewardStatus;
53
54 Claim[] internal allClaims;
55 Vote[] internal allvotes;
56 ClaimsPause[] internal claimPause;
57 ClaimPauseVoting[] internal claimPauseVotingEP;
58
59 mapping(address => RewardDistributed) internal voterVoteRewardReceived;
60 mapping(uint => ClaimRewardDetails) internal claimRewardDetail;
61 mapping(uint => ClaimTotalTokens) internal claimTokensCA;
62 mapping(uint => ClaimTotalTokens) internal claimTokensMV;
63 mapping(uint => int8) internal claimVote;
64 mapping(uint => uint) internal claimsStatus;
65 mapping(uint => uint) internal claimState12Count;
66 mapping(uint => uint[]) internal claimVoteCA;
67 mapping(uint => uint[]) internal claimVoteMember;
68 mapping(address => uint[]) internal voteAddressCA;
69 mapping(address => uint[]) internal voteAddressMember;
70 mapping(address => uint[]) internal allClaimsByAddress;
71 mapping(address => mapping(uint => uint)) internal userClaimVoteCA;
72 mapping(address => mapping(uint => uint)) internal userClaimVoteMember;
73 mapping(address => uint) public userClaimVotePausedOn;
74
75 uint internal claimPauseLastsubmit;
76 uint internal claimStartVotingFirstIndex;
77 uint public pendingClaimStart;
78 uint public claimDepositTime;
79 uint public maxVotingTime;
80 uint public minVotingTime;
81 uint public payoutRetryTime;
82 uint public claimRewardPerc;
83 uint public minVoteThreshold;
84 uint public maxVoteThreshold;
85 uint public majorityConsensus;
86 uint public pauseDaysCA;
87
88 event ClaimRaise(
89 uint indexed coverId,
90 address indexed userAddress,
91 uint claimId,
92 uint dateSubmit
93 );
94
95 event VoteCast(
96 address indexed userAddress,
97 uint indexed claimId,
98 bytes4 indexed typeOf,
99 uint tokens,
100 uint submitDate,
101 int8 verdict
102 );
103
104 constructor() public {
105 pendingClaimStart = 1;
106 maxVotingTime = 48 * 1 hours;
107 minVotingTime = 12 * 1 hours;
108 payoutRetryTime = 24 * 1 hours;
109 allvotes.push(Vote(address(0), 0, 0, 0, false));
110 allClaims.push(Claim(0, 0));
111 claimDepositTime = 7 days;
112 claimRewardPerc = 20;
113 minVoteThreshold = 5;
114 maxVoteThreshold = 10;
115 majorityConsensus = 70;
116 pauseDaysCA = 3 days;
117 _addRewardIncentive();
118 }
119
120 /**
121 * @dev Updates the pending claim start variable,
122 * the lowest claim id with a pending decision/payout.
123 */
124 function setpendingClaimStart(uint _start) external onlyInternal {
125 require(pendingClaimStart <= _start);
126 pendingClaimStart = _start;
127 }
128
129 /**
130 * @dev Updates the max vote index for which claim assessor has received reward
131 * @param _voter address of the voter.
132 * @param caIndex last index till which reward was distributed for CA
133 */
134 function setRewardDistributedIndexCA(address _voter, uint caIndex) external onlyInternal {
135 voterVoteRewardReceived[_voter].lastCAvoteIndex = caIndex;
136
137 }
138
139 /**
140 * @dev Used to pause claim assessor activity for 3 days
141 * @param user Member address whose claim voting ability needs to be paused
142 */
143 function setUserClaimVotePausedOn(address user) external {
144 require(ms.checkIsAuthToGoverned(msg.sender));
145 userClaimVotePausedOn[user] = now;
146 }
147
148 /**
149 * @dev Updates the max vote index for which member has received reward
150 * @param _voter address of the voter.
151 * @param mvIndex last index till which reward was distributed for member
152 */
153 function setRewardDistributedIndexMV(address _voter, uint mvIndex) external onlyInternal {
154
155 voterVoteRewardReceived[_voter].lastMVvoteIndex = mvIndex;
156 }
157
158 /**
159 * @param claimid claim id.
160 * @param percCA reward Percentage reward for claim assessor
161 * @param percMV reward Percentage reward for members
162 * @param tokens total tokens to be rewarded
163 */
164 function setClaimRewardDetail(
165 uint claimid,
166 uint percCA,
167 uint percMV,
168 uint tokens
169 )
170 external
171 onlyInternal
172 {
173 claimRewardDetail[claimid].percCA = percCA;
174 claimRewardDetail[claimid].percMV = percMV;
175 claimRewardDetail[claimid].tokenToBeDist = tokens;
176 }
177
178 /*
179 * @dev Sets the reward claim status against a vote id.
180 * @param _voteid vote Id.
181 * @param claimed true if reward for vote is claimed, else false.
182 */
183 function setRewardClaimed(uint _voteid, bool claimed) external onlyInternal {
184 allvotes[_voteid].rewardClaimed = claimed;
185 }
186
187 /*
188 * @dev Sets the final vote's result(either accepted or declined)of a claim.
189 * @param _claimId Claim Id.
190 * @param _verdict 1 if claim is accepted,-1 if declined.
191 */
192 function changeFinalVerdict(uint _claimId, int8 _verdict) external onlyInternal {
193 claimVote[_claimId] = _verdict;
194 }
195
Comments to Code: 1695 / 6174 = 27 %
Tests to Code: 5368 / 6174 = 87 %