This is a Process Quality Review of WiseToken completed on 2 December 2020. It was performed using the Process Review process (version 0.6) and is documented here. The review was performed by ShinkaRex of Caliburn Consulting. Check out our Telegram.
The final score of the review is 53%, a below pass. The breakdown of the scoring is in Scoring Appendix.​
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
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, 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. 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.
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;
Are the executing code addresses readily available? (Y/N)
Is the code actively being used? (%)
Is there a public software repository? (Y/N)
Is there a development history visible? (%)
Is the team public (not anonymous)? (Y/N)
Answer: Yes
They are available at website https://wisetoken.net/ as indicated in the Appendix. There is a button for each contract.
Answer: 100%
Activity is 216 transactions a day on contract LiquidityTransformer.sol, as indicated in the Appendix.​
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
Answer: Yes
Location: https://github.com/wise-foundation/wise-token-contracts​
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.
Answer: 0%
There is 1 branch and 2 commits on this 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
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.
Answer: Yes
Information about their team can be found at the bottom of https://wisetoken.net/.
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 seems a No.
This section looks at the software documentation. The document explaining these questions is here.
Required questions are;
Is there a whitepaper? (Y/N)
Are the basic software functions documented? (Y/N)
Does the software function documentation fully (100%) cover the deployed contracts? (%)
Are there sufficiently detailed comments for all functions within the deployed contract code (%)
Is it possible to trace from software documentation to the implementation in codee (%)
Answer: Yes
Location: https://wisetoken.net/teal/​
Answer: No
There is no evident software function documentation.
Write the document based on the deployed code. For guidance, refer to the SecurEth System Description Document.
Answer: 0%
There is no evidence of software function 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
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.
Answer: 30%
Commenting is present, although it offers limited insight as to the functions of the deployed code.
Code examples are in the Appendix. As per the SLOC, there is 20% 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
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.
Answer: 0%
There is no connection between the software 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
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.
This section looks at the software testing available. It is explained in this document. This section answers the following questions;
Full test suite (Covers all the deployed code) (%)
Code coverage (Covers all the deployed lines of code, or explains misses) (%)
Scripts and instructions to run the tests (Y/N)
Packaged with the deployed code (Y/N)
Report of the results (%)
Formal Verification test done (%)
Stress Testing environment (%)
Answer: No
There is no evidence of testing.
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
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.
Answer: 0%
There is no evidence of testing, and therefore no code coverage.
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
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.
Answer: No
There is no evidence of testing, and therefore no scripts of instructions to run the tests.
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.
Answer: No
There is no evidence of testing, and it is not packaged with the deployed code.
Improving this score requires redeployment of the code, with the tests. This score gives credit to those who test their code before deployment and release them together. If a developer adds tests after deployment they can gain full points for all test elements except this one.
Answer: 0%
There is no evidence of testing, and therefore no reporting of the results.
Add a report with the results. The test scripts should generate the report or elements of it.
Answer: 0%
There is no evidence of formal verification testing having been done.
Answer: 0%
There is no evidence of stress testing on any test network.
Answer: 90%
An audit has been preformed by CodeFabrik. It was completed in September 2020. WiseToken went live in October 2020.
Guidance:
Multiple Audits performed before deployment and results public and implemented or not required (100%)
Single audit performed before deployment and results public and implemented or not required (90%)
Audit(s) performed after deployment and no changes required. Audit report is public. (70%)
No audit performed (20%)
Audit Performed after deployment, existence is public, report is not public and no improvements deployed OR smart contract address' not found, question 1 (0%)
The author of this review is Rex of Caliburn Consulting.
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.
Career wise I am a business development manager for an avionics supplier.
// WISE RESERVATION (EXTERNAL FUNCTIONS) //// ------------------------------------- //​/** @dev Performs reservation of WISE tokens with ETH* @param _investmentDays array of reservation days.* @param _referralAddress referral address for bonus.*/function reserveWise(uint8[] calldata _investmentDays,address _referralAddress)externalpayablerefundSponsorDynamicinvestmentEntryAmount(_investmentDays.length){checkInvestmentDays(_investmentDays,_currentWiseDay());​_reserveWise(_investmentDays,_referralAddress,msg.sender,msg.value);}​/** @notice Allows reservation of WISE tokens with other ERC20 tokens* @dev this will require LT contract to be approved as spender* @param _tokenAddress address of an ERC20 token to use* @param _tokenAmount amount of tokens to use for reservation* @param _investmentDays array of reservation days* @param _referralAddress referral address for bonus*/function reserveWiseWithToken(address _tokenAddress,uint256 _tokenAmount,uint8[] calldata _investmentDays,address _referralAddress)externalrefundSponsorFixed{IERC20Token _token = IERC20Token(_tokenAddress);​_token.transferFrom(msg.sender,address(this),_tokenAmount);​_token.approve(address(UNISWAP_ROUTER),_tokenAmount);​address[] memory _path = preparePath(_tokenAddress);​uint256[] memory amounts =UNISWAP_ROUTER.swapExactTokensForETH(_tokenAmount,0,_path,address(this),block.timestamp.add(2 hours));​require(amounts[1] >= MIN_INVEST * _investmentDays.length,'WISE: investment below minimum');​checkInvestmentDays(_investmentDays,_currentWiseDay());​_reserveWise(_investmentDays,_referralAddress,msg.sender,amounts[1]);}​// WISE RESERVATION (INTERNAL FUNCTIONS) //// ------------------------------------- //​/** @notice Distributes ETH equaly between selected reservation days* @dev this will require LT contract to be approved as a spender* @param _investmentDays array of selected reservation days* @param _referralAddress referral address for bonus* @param _senderAddress address of the investor* @param _senderValue amount of ETH contributed*/
Language | Files | Lines | Blanks | Comments | Code | Complexity |
Solidity | 1 | 1400 | 207 | 204 | 989 | 75 |
Comments to Code 204/ 989 = 20%