P
P
PQ Reviews
Search…
0.7
Tokemak Process Quality Review
Score: 56%

Overview

This is a Tokemak Process Quality Review completed on October 14th 2021. It was performed using the Process Review process (version 0.7.3) and is documented here. The review was performed by Nic of DeFiSafety. Check out our Telegram.
The final score of the review is 56%, 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 blockchains used by this protocol. This report covers all of the blockchains upon which the protocol is deployed.
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%
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 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: 0%
With 13 commits and 1 branch, Tokemak's main contract repository is underdevelopped.
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

How to improve this score:

Continue to test and perform other verification activities after deployment, including routine maintenance updating to new releases of testing and deployment tools. A public development history indicates clearly to the public the level of continued investment and activity by the developers on the application. This gives a level of security and faith in the application.

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

Answer: Yes
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

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: No
There are no software functions documented in the Tokemak documentation.

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: 0%
There are no software functions documented in the Tokemak documentation.
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 be improved by adding content to the software functions 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: 0%
Code examples are in the Appendix. As per the SLOC, there is 7% 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%
As there are no software functions documented in the Tokemak documentation, it is impossible for us to evaluate the degree of traceability as to their implementation in the protocol's source 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: 0%
There is no test suite in the Tokemak GitHub repository.
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 improved 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: 85%
Tokemak has an average of 85% code coverage in their Quantstamp audit.
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: No
There are no scripts or test instructions in the Tokemak GitHub repositories.

How to improve this score:

Add the scripts to the repository and ensure they work. Ask an outsider to create the environment and run the tests. Improve the scripts and docs based on their feedback.

14) Report of the results (%)

Answer: 0%
There is no Tokemak test result report in their GitHub repositories.
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%
Tokemak has not yet undergone a Formal Verification test.

16) Stress Testing environment (%)

Answer: 0%
There is no evidence of Tokemak's testnet smart contract 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: 100%
Tokemak has had two audits deployed before mainnet launches, fixes have been implemented, and the public reports can be found at https://tokemak.gitbook.io/tokemak/protocol-information/network-security.
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: 100%
Tokemak's Bug Bounty program rewards participating users with up to 1.5m for the most critical of finds. Program can be found at https://immunefi.com/bounty/tokemak/.
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%
Although an official governance model has yet to be released on Tokemak's end, you can already find some decent information about DAO capabilities at https://medium.com/tokemak/tokenomics-4b3857badc73, https://tokemak.gitbook.io/tokemak/governance-+-treasury/untitled, as well as https://tokemak.gitbook.io/tokemak/toke/toke-voting-and-orbitdb.
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: 50%
a) All contracts are clearly labelled as upgradeable - 10% - only the Reactor contracts are clearly labelled as upgradeable for now.
b) The type of ownership is clearly indicated (OnlyOwner / MultiSig / Defined Roles) - 30% - as clear voting roles are already established, and there are MultiSig smart contracts detailed at https://github.com/Tokemak/tokemak-smart-contracts-public.
c) The capabilities for change in the contracts are described - 10% - as only the Reactor contracts have clear and established capabilities for change, and there is additional information as to potential change implementation at the bottom of https://medium.com/tokemak/tokenomics-4b3857badc73.
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: 30%
All Tokemak access control documentation is currently in technical software language, as no true user investment safety information is currently available.
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%
There is currently no Pause Control or similar functions detailed in the Tokemak documenation.
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
contract Pool is ILiquidityPool, Initializable, ERC20, Ownable, Pausable {
2
using SafeMath for uint256;
3
using SafeERC20 for ERC20;
4
5
ERC20 public override underlyer; // Underlying ERC20 token
6
IManager public manager;
7
8
// implied: deployableLiquidity = underlyer.balanceOf(this) - withheldLiquidity
9
uint256 public override withheldLiquidity;
10
11
/ fAsset holder -> WithdrawalInfo
12
mapping(address => WithdrawalInfo) public override requestedWithdrawals;
13
14
/ NonReentrant
15
bool private _entered;
16
bool public _eventSend;
17
Destinations public destinations;
18
19
modifier nonReentrant() {
20
require(!_entered, "ReentrancyGuard: reentrant call");
21
_entered = true;
22
_;
23
_entered = false;
24
}
25
26
modifier onEventSend() {
27
if(_eventSend) {
28
_;
29
}
30
}
31
32
function initialize(
33
ERC20 _underlyer,
34
IManager _manager,
35
string memory _name,
36
string memory _symbol
37
) public initializer {
38
require(address(_underlyer) != address(0), "ZERO_ADDRESS");
39
require(address(_manager) != address(0), "ZERO_ADDRESS");
40
41
__Context_init_unchained();
42
__Ownable_init_unchained();
43
__Pausable_init_unchained();
44
__ERC20_init_unchained(_name, _symbol);
45
46
underlyer = _underlyer;
47
manager = _manager;
48
}
49
50
///@notice Gets decimals of underlyer so that tAsset decimals will match
51
function decimals() public view override returns (uint8) {
52
return underlyer.decimals();
53
}
54
55
function deposit(uint256 amount) external override whenNotPaused {
56
_deposit(msg.sender, msg.sender, amount);
57
}
58
59
function depositFor(address account, uint256 amount) external override whenNotPaused {
60
_deposit(msg.sender, account, amount);
61
}
62
63
/// @dev References the WithdrawalInfo for how much the user is permitted to withdraw
64
/// @dev No withdrawal permitted unless currentCycle >= minCycle
65
/// @dev Decrements withheldLiquidity by the withdrawn amount
66
/// @dev TODO Update rewardsContract with proper accounting
67
function withdraw(uint256 requestedAmount) external override whenNotPaused nonReentrant {
68
require(
69
requestedAmount <= requestedWithdrawals[msg.sender].amount,
70
"WITHDRAW_INSUFFICIENT_BALANCE"
71
);
72
require(requestedAmount > 0, "NO_WITHDRAWAL");
73
require(underlyer.balanceOf(address(this)) >= requestedAmount, "INSUFFICIENT_POOL_BALANCE");
74
75
// Checks for manager cycle and if user is allowed to withdraw based on their minimum withdrawal cycle
76
require(
77
requestedWithdrawals[msg.sender].minCycle <= manager.getCurrentCycleIndex(),
78
"INVALID_CYCLE"
79
);
80
81
requestedWithdrawals[msg.sender].amount = requestedWithdrawals[msg.sender].amount.sub(
82
requestedAmount
83
);
84
85
// If full amount withdrawn delete from mapping
86
if (requestedWithdrawals[msg.sender].amount == 0) {
87
delete requestedWithdrawals[msg.sender];
88
}
89
90
withheldLiquidity = withheldLiquidity.sub(requestedAmount);
91
92
_burn(msg.sender, requestedAmount);
93
underlyer.safeTransfer(msg.sender, requestedAmount);
94
95
bytes32 eventSig = "Withdraw";
96
encodeAndSendData(eventSig, msg.sender);
97
}
98
99
/// @dev Adjusts the withheldLiquidity as necessary
100
/// @dev Updates the WithdrawalInfo for when a user can withdraw and for what requested amount
101
function requestWithdrawal(uint256 amount) external override {
102
require(amount > 0, "INVALID_AMOUNT");
103
require(amount <= balanceOf(msg.sender), "INSUFFICIENT_BALANCE");
104
105
//adjust withheld liquidity by removing the original withheld amount and adding the new amount
106
withheldLiquidity = withheldLiquidity.sub(requestedWithdrawals[msg.sender].amount).add(
107
amount
108
);
109
requestedWithdrawals[msg.sender].amount = amount;
110
if (manager.getRolloverStatus()) { // If manger is currently rolling over add two to min withdrawal cycle
111
requestedWithdrawals[msg.sender].minCycle = manager.getCurrentCycleIndex().add(2);
112
} else { // If manager is not rolling over add one to minimum withdrawal cycle
113
requestedWithdrawals[msg.sender].minCycle = manager.getCurrentCycleIndex().add(1);
114
}
115
116
emit WithdrawalRequested(msg.sender, amount);
117
}
118
119
function preTransferAdjustWithheldLiquidity(address sender, uint256 amount) internal {
120
if (requestedWithdrawals[sender].amount > 0) {
121
//reduce requested withdraw amount by transferred amount;
122
uint256 newRequestedWithdrawl = requestedWithdrawals[sender].amount.sub(
123
Math.min(amount, requestedWithdrawals[sender].amount)
124
);
125
126
//subtract from global withheld liquidity (reduce) by removing the delta of (requestedAmount - newRequestedAmount)
127
withheldLiquidity = withheldLiquidity.sub(
128
requestedWithdrawals[sender].amount.sub(newRequestedWithdrawl)
129
);
130
131
//update the requested withdraw for user
132
requestedWithdrawals[sender].amount = newRequestedWithdrawl;
133
134
//if the withdraw request is 0, empty it out
135
if (requestedWithdrawals[sender].amount == 0) {
136
delete requestedWithdrawals[sender];
137
}
138
}
139
}
Copied!

SLOC Appendix

Solidity Contracts

Language
Files
Lines
Blanks
Comments
Code
Complexity
Solidity
9
2354
435
132
1787
228
Comments to Code 132/1787 = 7%

Javascript Tests

Language
Files
Lines
Blanks
Comments
Code
Complexity
JavaScript
N/A
N/A
N/A
N/A
N/A
N/A
Tests to Code = N/A
Last modified 5d ago