P
P
PQ Reviews
Search…
0.7
Maple Finance Process Quality Review
Score: 92%

Overview

This is a Maple Finance Process Quality Review completed on September 29th 2021. It was performed using the Process Review process (version 0.7.3) and is documented here. The review was performed by Nick of DeFiSafety. Check out our Telegram.
The final score of the review is 92%, a PASS. 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: Ethereum
Guidance: Ethereum Binance Smart Chain Polygon Avalanche Terra Celo Arbitrum Solana

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 following 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%
They are available at website https://github.com/maple-labs/maple-core/blob/develop/README.md , as indicated in the Appendix.
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 over 10 external and internal transactions a day on contract Pool.sol, as indicated in the Appendix.

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".

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

Answer: 100%
At 768 commits and 19 branches, Maple Finance's development history is Shakespearean in quality and richness.
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).
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

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
The documentation contains the basic software functions at https://maplefinance.gitbook.io/maple/smart-contracts/general/mapleglobals.

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

Answer: 100%
Each and every function is covered in the exquisitely crafted software function documentation at https://maplefinance.gitbook.io/maple/smart-contracts/general.
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: 65%
Code examples are in the Appendix. As per the SLOC, there is 27% 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: 60%
The software documentation is near-perfect, but there is no explicit traceability (i.e. a link to a specific location in the GitHub repo) on 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 documentation to code such that it is clear where each outlined function is coded in the source code. 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: 100%
Code examples are in the Appendix. As per the SLOC, there is 267% 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

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

Answer: 75%
No code coverage testing was found, but the 267% TtC ratio indicates fairly extensive testing. However, this is due to dapptools not allowing code coverage being performed. Therefore, we will add points for their rigorous CI suite.
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 improved by adding tests that achieve 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
Scripts/Instructions location: https://github.com/maple-labs/maple-core#testing

14) Report of the results (%)

Answer: 70%
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 formal verification test was found.

16) Stress Testing environment (%)

Answer: 100%
Maple is deployed in full on a testnet.

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: 100%
Three audits were conducted on Maple, two of which were before the deployment of V1.
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 bounty value acceptably high (%)

Answer: 60%
The Maple Finance team has hosted a competition on Code Arena with a cash reward of up to 100k. It is however no longer active.
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

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? 21) 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: 70%
There is a security section in the wiki of the Maple Finance GitHub repository, but it takes a bit of looking.
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: 100%
All of the Maple Finance v1 contracts are immutable as described in the security section of their GitHub wiki. This is backed up by the immutable functions in their source code, as well as the use of the Constructor functions.
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: 100%
All of the contracts are immutable according to the security section of the Maple Finance GitHub wiki.
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

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

Answer: 100%
Pause controls are mentioned extensively in the Maple docs. A "fire drill" test of the Maple Pause Control will take place with DeFiSafety in the near future.
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
// SPDX-License-Identifier: AGPL-3.0-or-later
2
pragma solidity 0.6.11;
3
pragma experimental ABIEncoderV2;
4
5
import { ICalc } from "../modules/calculator/contracts/interfaces/ICalc.sol";
6
import { SafeMath } from "../modules/openzeppelin-contracts/contracts/math/SafeMath.sol";
7
import { IOracle } from "../modules/oracle/contracts/interfaces/IOracle.sol";
8
import { ISubFactory } from "../modules/subfactory/contracts/interfaces/ISubFactory.sol";
9
10
import { IMapleGlobals } from "./interfaces/IMapleGlobals.sol";
11
import { IERC20DetailsLike } from "./interfaces/Interfaces.sol";
12
13
/// @title MapleGlobals maintains a central source of parameters and allowlists for the Maple protocol.
14
contract MapleGlobals is IMapleGlobals {
15
16
using SafeMath for uint256;
17
18
address public override immutable mpl;
19
20
address public override pendingGovernor;
21
address public override governor;
22
address public override mapleTreasury;
23
address public override globalAdmin;
24
25
uint256 public override defaultGracePeriod;
26
uint256 public override swapOutRequired;
27
uint256 public override fundingPeriod;
28
uint256 public override investorFee;
29
uint256 public override treasuryFee;
30
uint256 public override maxSwapSlippage;
31
uint256 public override minLoanEquity;
32
uint256 public override stakerCooldownPeriod;
33
uint256 public override lpCooldownPeriod;
34
uint256 public override stakerUnstakeWindow;
35
uint256 public override lpWithdrawWindow;
36
37
bool public override protocolPaused;
38
39
mapping(address => bool) public override isValidLiquidityAsset;
40
mapping(address => bool) public override isValidCollateralAsset;
41
mapping(address => bool) public override validCalcs;
42
mapping(address => bool) public override isValidPoolDelegate;
43
mapping(address => bool) public override isValidBalancerPool;
44
45
mapping(address => mapping(address => address)) public override defaultUniswapPath;
46
47
mapping(address => address) public override oracleFor;
48
49
mapping(address => bool) public override isValidPoolFactory;
50
mapping(address => bool) public override isValidLoanFactory;
51
mapping(address => mapping(address => bool)) public override validSubFactories;
52
53
/**
54
@dev Checks that `msg.sender` is the Governor.
55
*/
56
modifier isGovernor() {
57
require(msg.sender == governor, "MG:NOT_GOV");
58
_;
59
}
60
61
/**
62
@dev Constructor function.
63
@dev It emits an `Initialized` event.
64
@param _governor Address of Governor.
65
@param _mpl Address of the ERC-2222 Maple Token for the Maple protocol.
66
@param _globalAdmin Address the Global Admin.
67
*/
68
constructor(address _governor, address _mpl, address _globalAdmin) public {
69
governor = _governor;
70
mpl = _mpl;
71
swapOutRequired = 10_000; // $10,000 of Pool cover
72
fundingPeriod = 10 days;
73
defaultGracePeriod = 5 days;
74
investorFee = 50; // 0.5 %
75
treasuryFee = 50; // 0.5 %
76
maxSwapSlippage = 1000; // 10 %
77
minLoanEquity = 2000; // 20 %
78
globalAdmin = _globalAdmin;
79
stakerCooldownPeriod = 10 days;
80
lpCooldownPeriod = 10 days;
81
stakerUnstakeWindow = 2 days;
82
lpWithdrawWindow = 2 days;
83
emit Initialized();
84
}
85
86
/************************/
87
/*** Setter Functions ***/
88
/************************/
89
90
function setStakerCooldownPeriod(uint256 newCooldownPeriod) external override isGovernor {
91
stakerCooldownPeriod = newCooldownPeriod;
92
emit GlobalsParamSet("STAKER_COOLDOWN_PERIOD", newCooldownPeriod);
93
}
94
95
function setLpCooldownPeriod(uint256 newCooldownPeriod) external override isGovernor {
96
lpCooldownPeriod = newCooldownPeriod;
97
emit GlobalsParamSet("LP_COOLDOWN_PERIOD", newCooldownPeriod);
98
}
99
100
function setStakerUnstakeWindow(uint256 newUnstakeWindow) external override isGovernor {
101
stakerUnstakeWindow = newUnstakeWindow;
102
emit GlobalsParamSet("STAKER_UNSTAKE_WINDOW", newUnstakeWindow);
103
}
104
105
function setLpWithdrawWindow(uint256 newLpWithdrawWindow) external override isGovernor {
106
lpWithdrawWindow = newLpWithdrawWindow;
107
emit GlobalsParamSet("LP_WITHDRAW_WINDOW", newLpWithdrawWindow);
108
}
109
110
function setMaxSwapSlippage(uint256 newMaxSlippage) external override isGovernor {
111
_checkPercentageRange(newMaxSlippage);
112
maxSwapSlippage = newMaxSlippage;
113
emit GlobalsParamSet("MAX_SWAP_SLIPPAGE", newMaxSlippage);
114
}
115
116
function setGlobalAdmin(address newGlobalAdmin) external override {
117
require(msg.sender == governor && newGlobalAdmin != address(0), "MG:NOT_GOV_OR_ADMIN");
118
require(!protocolPaused, "MG:PROTO_PAUSED");
119
globalAdmin = newGlobalAdmin;
120
emit GlobalAdminSet(newGlobalAdmin);
121
}
122
123
function setValidBalancerPool(address balancerPool, bool valid) external override isGovernor {
124
isValidBalancerPool[balancerPool] = valid;
125
emit BalancerPoolSet(balancerPool, valid);
126
}
127
128
function setProtocolPause(bool pause) external override {
129
require(msg.sender == globalAdmin, "MG:NOT_ADMIN");
130
protocolPaused = pause;
131
emit ProtocolPaused(pause);
132
}
133
134
function setValidPoolFactory(address poolFactory, bool valid) external override isGovernor {
135
isValidPoolFactory[poolFactory] = valid;
136
}
137
138
function setValidLoanFactory(address loanFactory, bool valid) external override isGovernor {
139
isValidLoanFactory[loanFactory] = valid;
140
}
141
142
function setValidSubFactory(address superFactory, address subFactory, bool valid) external override isGovernor {
143
require(isValidLoanFactory[superFactory] || isValidPoolFactory[superFactory], "MG:INVALID_SUPER_F");
144
validSubFactories[superFactory][subFactory] = valid;
145
}
146
147
function setDefaultUniswapPath(address from, address to, address mid) external override isGovernor {
148
defaultUniswapPath[from][to] = mid;
149
}
150
151
function setPoolDelegateAllowlist(address delegate, bool valid) external override isGovernor {
152
isValidPoolDelegate[delegate] = valid;
153
emit PoolDelegateSet(delegate, valid);
154
}
155
156
function setCollateralAsset(address asset, bool valid) external override isGovernor {
157
isValidCollateralAsset[asset] = valid;
158
emit CollateralAssetSet(asset, IERC20DetailsLike(asset).decimals(), IERC20DetailsLike(asset).symbol(), valid);
159
}
160
161
function setLiquidityAsset(address asset, bool valid) external override isGovernor {
162
isValidLiquidityAsset[asset] = valid;
163
emit LiquidityAssetSet(asset, IERC20DetailsLike(asset).decimals(), IERC20DetailsLike(asset).symbol(), valid);
164
}
165
166
function setCalc(address calc, bool valid) external override isGovernor {
167
validCalcs[calc] = valid;
168
}
169
170
function setInvestorFee(uint256 _fee) external override isGovernor {
171
_checkPercentageRange(treasuryFee.add(_fee));
172
investorFee = _fee;
173
emit GlobalsParamSet("INVESTOR_FEE", _fee);
174
}
175
176
function setTreasuryFee(uint256 _fee) external override isGovernor {
177
_checkPercentageRange(investorFee.add(_fee));
178
treasuryFee = _fee;
179
emit GlobalsParamSet("TREASURY_FEE", _fee);
180
}
181
182
function setMapleTreasury(address _mapleTreasury) external override isGovernor {
183
require(_mapleTreasury != address(0), "MG:ZERO_ADDR");
184
mapleTreasury = _mapleTreasury;
185
emit GlobalsAddressSet("MAPLE_TREASURY", _mapleTreasury);
186
}
187
188
function setDefaultGracePeriod(uint256 _defaultGracePeriod) external override isGovernor {
189
defaultGracePeriod = _defaultGracePeriod;
190
emit GlobalsParamSet("DEFAULT_GRACE_PERIOD", _defaultGracePeriod);
191
}
192
193
function setMinLoanEquity(uint256 _minLoanEquity) external override isGovernor {
194
_checkPercentageRange(_minLoanEquity);
195
minLoanEquity = _minLoanEquity;
196
emit GlobalsParamSet("MIN_LOAN_EQUITY", _minLoanEquity);
197
}
198
199
function setFundingPeriod(uint256 _fundingPeriod) external override isGovernor {
200
fundingPeriod = _fundingPeriod;
201
emit GlobalsParamSet("FUNDING_PERIOD", _fundingPeriod);
202
}
203
204
function setSwapOutRequired(uint256 amt) external override isGovernor {
205
require(amt >= uint256(10_000), "MG:SWAP_OUT_TOO_LOW");
206
swapOutRequired = amt;
207
emit GlobalsParamSet("SWAP_OUT_REQUIRED", amt);
208
}
209
210
function setPriceOracle(address asset, address oracle) external override isGovernor {
211
oracleFor[asset] = oracle;
212
emit OracleSet(asset, oracle);
213
}
214
215
/************************************/
216
/** Transfer Ownership Functions ***/
217
/***********************************/
218
219
function setPendingGovernor(address _pendingGovernor) external override isGovernor {
220
require(_pendingGovernor != address(0), "MG:ZERO_ADDR");
221
pendingGovernor = _pendingGovernor;
222
emit PendingGovernorSet(_pendingGovernor);
223
}
224
225
function acceptGovernor() external override {
226
require(msg.sender == pendingGovernor, "MG:NOT_PENDING_GOV");
227
governor = msg.sender;
228
pendingGovernor = address(0);
229
emit GovernorAccepted(msg.sender);
230
}
231
232
/************************/
233
/*** Getter Functions ***/
234
/************************/
235
236
function getLatestPrice(address asset) external override view returns (uint256) {
237
return uint256(IOracle(oracleFor[asset]).getLatestPrice());
238
}
239
Copied!

SLOC Appendix

Solidity Contracts

Language
Files
Lines
Blanks
Comments
Code
Complexity
Solidity
21
3434
562
1129
1743
119
Comments to Code 1129/1743 = 65%

Javascript Tests

Language
Files
Lines
Blanks
Comments
Code
Complexity
JavaScript
31
6960
1697
703
4560
60
Tests to Code 4560/1706 = 267%
Last modified 5d ago