P
P
PQ Reviews
Search…
0.7
Finished Reviews
Retired
Powered By GitBook
ApeSwap Process Quality Review
Score: 42%

Overview

This is a ApeSwap Process Quality Review completed on June 16th 2021. It was performed using the Process Review process (version 0.7.2) and is documented here. The review was performed by Nic of DeFiSafety. Check out our Telegram.
The final score of the review is 42%, a fail. The breakdown of the scoring is in Scoring Appendix. For our purposes, a pass is 70%.

Summary of the Process

Very simply, the review looks for the following declarations from the developer's site. With these declarations, it is reasonable to trust the smart contracts.
    Here are my smart contracts on the blockchain
    Here is the documentation that explains what my smart contracts do
    Here are the tests I ran to verify my smart contract
    Here are the audit(s) performed on my code by third party experts
    Here are the admin controls and strategies

Disclaimer

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.

Chain

This section indicates the blockchain used by this protocol.
Chain: Binance Smart Chain
Guidance: Ethereum Binance Smart Chain Polygon

Code and Team

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. This review will answer the questions;
1) Are the executing code addresses readily available? (%) 2) Is the code actively being used? (%) 3) Is there a public software repository? (Y/N) 4) Is there a development history visible? (%) 5) Is the team public (not anonymous)? (Y/N)

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

Answer: 100%
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 labelling not clear or easy to find 0% Executing addresses could not be found

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

Answer: 100%
Activity is 11,000 transactions a day on contract MasterApe.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 normally test and scripts also (Y/N). Even if the repo was created just to hold the files and has just 1 transaction, it gets a Yes. For teams with private repos, this answer is No.

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

Answer: 100%
With 207 commits and 4 branches, this is a healthy repository.
This 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).
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 10 commits

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

Answer: No
For a yes in this question the real names of some team members must be public on the website or other documentation. If the team is anonymous and then this question is a No.

Documentation

This section looks at the software documentation. The document explaining these questions is here.
Required questions are;
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? (%) 9) Are there sufficiently detailed comments for all functions within the deployed contract code (%) 10) Is it possible to trace from software documentation to the implementation in code (%)

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

Answer: Yes

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

Answer: Yes
Very minimal software documentation was found.

How to improve this score

Write the document based on the deployed code. For guidance, refer to the SecurEth System Description Document.

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

Answer: 10%
The only function docs I found in their repository are of the Timelock.sol contract at https://github.com/ApeSwapFinance/apeswap-banana-farm/blob/master/docs/send-timelock-tx.md.
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

How to improve this score

This score can improve by adding content to the requirements document such that it comprehensively covers the requirements. For guidance, refer to the SecurEth System Description Document . Using tools that aid traceability detection will help.

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

Answer: 25%
Code examples are in the Appendix. As per the SLOC, there is 25% commenting to code (CtC).
The Comments to Code (CtC) ratio is the primary metric for this 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

How to improve this score

This score can improve by adding comments to the deployed code such that it comprehensively covers the code. For guidance, refer to the SecurEth Software Requirements.

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

Answer: 0%
There is no inherent connection between the documentation and the code.
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

How to improve this score

This score can improve by adding traceability from requirements to code such that it is clear where each requirement is coded. For reference, check the SecurEth guidelines on traceability.

Testing

This section looks at the software testing available. It is explained in this document. This section answers the following questions;
11) Full test suite (Covers all the deployed code) (%) 12) Code coverage (Covers all the deployed lines of code, or explains misses) (%) 13) Scripts and instructions to run the tests (Y/N) 14) Report of the results (%) 15) Formal Verification test done (%) 16) Stress Testing environment (%)

11) Is there a Full test suite? (%)

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

How to improve this score

This score can improve by adding tests to fully cover the code. Document what is covered by traceability or test results in the software repository.

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

Answer: 30%
No test coverage evident in their GitHub or audits, but there is an incomplete set of test.
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

How to improve this score

This score can improve by adding tests achieving full code coverage. A clear report and scripts in the software repository will guarantee a high score.

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

Answer: Yes
No run test instructions in the farm repo, but there are some in their core repo at https://github.com/ApeSwapFinance/apeswap-swap-core.

14) Report of the results (%)

Answer: 0%
No test report was found in their GitHub.
Guidance: 100% Detailed test report as described below 70% GitHub Code coverage report visible 0% No test report evident

How to improve this score

Add a report with the results. The test scripts should generate the report or elements of it.

15) Formal Verification test done (%)

Answer: 0%
No evidence of a ApeSwap formal verification was found in their documentation or on the web.

16) Stress Testing environment (%)

Answer: 0%
No evidence of test-net smart contract address usage in any of their documentation.

Security

This section looks at the 3rd party software audits done. It is explained in this document. This section answers the following questions;
17) Did 3rd Party audits take place? (%) 18) Is the bounty value acceptably high?

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

Answer: 50%
Note: I gave them 50% because of all the issues highlighted, half of them were never addressed, and the other half were only partially fixed. None of the issues/recommendations highlighted are fully resolved and implemented.
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, question

18) Is the bounty value acceptably high (%)

Answer: 70%
Bug bounty program found at https://immunefi.com/bounty/apeswap/.
Program is active and rewards as high as 100k.
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
Active program means a third party actively driving hackers to the site. Inactive program would be static mention on the docs.

Access Controls

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. The questions this section asks are as follow;
19) Can a user clearly and quickly find the status of the admin controls? 20) Is the information clear and complete? 2`) Is the information in non-technical terms that pertain to the investments? 22) Is there Pause Control documentation including records of tests?

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

Answer: 0%
No admin control information was found in any of their documentation.
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: 0%
No access control documentation was found.
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%

How to improve this score

Create a document that covers the items described above. An example is enclosed.

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

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

How to improve this score

Create a document that covers the items described above in plain language that investors can understand. An example is enclosed.

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

Answer: 0%
No Pause Control documentation was found in any of their docs.
Guidance: 100% All the contracts are immutable or no pause control needed and this is explained OR 100% 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

How to improve this score

Create a document that covers the items described above in plain language that investors can understand. An example is enclosed.

Appendices

Author Details

The author of this review is Rex of DeFi Safety.
Email : [email protected] 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.

Scoring Appendix

Executing Code Appendix

Code Used Appendix

Example Code Appendix

1
// MasterApe is the master of BANANA AND BANANASPLIT.
2
// He can make Banana and he is a fair guy.
3
//
4
// Note that it's ownable and the owner wields tremendous power. The ownership
5
// will be transferred to a governance smart contract once BANANA is sufficiently
6
// distributed and the community can show to govern itself.
7
//
8
// Have fun reading it. Hopefully it's bug-free. God bless.
9
contract MasterApe is Ownable {
10
using SafeMath for uint256;
11
using SafeBEP20 for IBEP20;
12
13
// Info of each user.
14
struct UserInfo {
15
uint256 amount; // How many LP tokens the user has provided.
16
uint256 rewardDebt; // Reward debt. See explanation below.
17
//
18
// We do some fancy math here. Basically, any point in time, the amount of BANANAs
19
// entitled to a user but is pending to be distributed is:
20
//
21
// pending reward = (user.amount * pool.accBananaPerShare) - user.rewardDebt
22
//
23
// Whenever a user deposits or withdraws LP tokens to a pool. Here's what happens:
24
// 1. The pool's `accCakePerShare` (and `lastRewardBlock`) gets updated.
25
// 2. User receives the pending reward sent to his/her address.
26
// 3. User's `amount` gets updated.
27
// 4. User's `rewardDebt` gets updated.
28
}
29
30
// Info of each pool.
31
struct PoolInfo {
32
IBEP20 lpToken; // Address of LP token contract.
33
uint256 allocPoint; // How many allocation points assigned to this pool. BANANAs to distribute per block.
34
uint256 lastRewardBlock; // Last block number that BANANAs distribution occurs.
35
uint256 accCakePerShare; // Accumulated BANANAs per share, times 1e12. See below.
36
}
37
38
// The BANANA TOKEN!
39
BananaToken public cake;
40
// The BANANA SPLIT TOKEN!
41
BananaSplitBar public syrup;
42
// Dev address.
43
address public devaddr;
44
// BANANA tokens created per block.
45
uint256 public cakePerBlock;
46
// Bonus muliplier for early banana makers.
47
uint256 public BONUS_MULTIPLIER;
48
49
50
// Info of each pool.
51
PoolInfo[] public poolInfo;
52
// Info of each user that stakes LP tokens.
53
mapping (uint256 => mapping (address => UserInfo)) public userInfo;
54
// Total allocation points. Must be the sum of all allocation points in all pools.
55
uint256 public totalAllocPoint = 0;
56
// The block number when BANANA mining starts.
57
uint256 public startBlock;
58
59
event Deposit(address indexed user, uint256 indexed pid, uint256 amount);
60
event Withdraw(address indexed user, uint256 indexed pid, uint256 amount);
61
event EmergencyWithdraw(address indexed user, uint256 indexed pid, uint256 amount);
62
63
constructor(
64
BananaToken _banana,
65
BananaSplitBar _bananaSplit,
66
address _devaddr,
67
uint256 _bananaPerBlock,
68
uint256 _startBlock,
69
uint256 _multiplier
70
) public {
71
cake = _banana;
72
syrup = _bananaSplit;
73
devaddr = _devaddr;
74
cakePerBlock = _bananaPerBlock;
75
startBlock = _startBlock;
76
BONUS_MULTIPLIER = _multiplier;
77
78
// staking pool
79
poolInfo.push(PoolInfo({
80
lpToken: _banana,
81
allocPoint: 1000,
82
lastRewardBlock: startBlock,
83
accCakePerShare: 0
84
}));
85
86
totalAllocPoint = 1000;
87
88
}
89
90
modifier validatePool(uint256 _pid) {
91
require(_pid < poolInfo.length, "validatePool: pool exists?");
92
_;
93
}
94
95
function updateMultiplier(uint256 multiplierNumber) public onlyOwner {
96
BONUS_MULTIPLIER = multiplierNumber;
97
}
98
99
function poolLength() external view returns (uint256) {
100
return poolInfo.length;
101
}
102
103
// Detects whether the given pool already exists
104
function checkPoolDuplicate(IBEP20 _lpToken) public view {
105
uint256 length = poolInfo.length;
106
for (uint256 _pid = 0; _pid < length; _pid++) {
107
require(poolInfo[_pid].lpToken != _lpToken, "add: existing pool");
108
}
109
}
110
111
// Add a new lp to the pool. Can only be called by the owner.
112
// XXX DO NOT add the same LP token more than once. Rewards will be messed up if you do.
113
function add(uint256 _allocPoint, IBEP20 _lpToken, bool _withUpdate) public onlyOwner {
114
if (_withUpdate) {
115
massUpdatePools();
116
}
117
checkPoolDuplicate(_lpToken);
118
uint256 lastRewardBlock = block.number > startBlock ? block.number : startBlock;
119
totalAllocPoint = totalAllocPoint.add(_allocPoint);
120
poolInfo.push(PoolInfo({
121
lpToken: _lpToken,
122
allocPoint: _allocPoint,
123
lastRewardBlock: lastRewardBlock,
124
accCakePerShare: 0
125
}));
126
updateStakingPool();
127
}
128
129
// Update the given pool's BANANA allocation point. Can only be called by the owner.
130
function set(uint256 _pid, uint256 _allocPoint, bool _withUpdate) public onlyOwner {
131
if (_withUpdate) {
132
massUpdatePools();
133
}
134
uint256 prevAllocPoint = poolInfo[_pid].allocPoint;
135
poolInfo[_pid].allocPoint = _allocPoint;
136
if (prevAllocPoint != _allocPoint) {
137
totalAllocPoint = totalAllocPoint.sub(prevAllocPoint).add(_allocPoint);
138
updateStakingPool();
Copied!

SLOC Appendix

Solidity Contracts

Language
Files
Lines
Blanks
Comments
Code
Complexity
Solidity
16
2454
358
431
1665
212
Comments to Code 431/1665 = 25%

Javascript Tests

Language
Files
Lines
Blanks
Comments
Code
Complexity
JavaScript
7
773
83
15
675
0
Tests to Code 675/1665 = 40%
Last modified 4mo ago