Stabilize Finance Process Quality Review

Score 43%

This is a Stabilize Finance Process Quality Review completed on 3 November 2020. It was performed using the Process Review process (version 0.5) and is documented here. The review was performed by ShinkaRex of Caliburn Consulting. Check out our Telegram.

The final score of the review is 43%, a not a pass, but close. The breakdown of the scoring is in Scoring Appendix.

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.

  1. Here is my smart contract on the blockchain

  2. You can see it matches a software repository used to develop the code

  3. Here is the documentation that explains what my smart contract does

  4. Here are the tests I ran to verify my smart contract

  5. Here are the audit(s) performed to review my code by third party experts

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

Executing Code Verification

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 address(s) readily available? (Y/N)

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

  3. Are the Contract(s) Verified/Verifiable? (Y/N)

  4. Does the code match a tagged version in the code hosting platform? (%)

  5. Is the software repository healthy? (%)

Are the executing code address(s) readily available? (Y/N)

Answer: Yes

They are available at Address https://github.com/stabilize-token/contracts as indicated in the Appendix. This review only covers the contract Operator.sol.

Is the code actively being used? (%)

Answer: 100%

Activity is 29 transactions a day, 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

Are the Contract(s) Verified/Verifiable? (Y/N)

Answer: Yes

0xEe9156C93ebB836513968F92B4A67721f3cEa08a is the Etherscan verified contract address.

How to improve this score

Ensure that the deployed code is verified as described in this article for Etherscan or ETHPM. Improving this score may require redeployment.

Does the code match a tagged version on a code hosting platform? (%)

Answer: 100%

All deployed code was easily matched to the released code.

100% All code matches and Repository was clearly labelled 60 % All code matches but no labelled repository. Repository was found manually 30% Almost all code does match perfectly and repository was found manually 0% Most matching Code could not be found

GitHub address : https://github.com/stabilize-token/contracts

Deployed contracts in the following file;

Matching Repository: https://github.com/stabilize-token/contracts/tree/master/contracts

Is development software repository healthy? (%)

Answer: 50%

With 29 commits and 2 branches, this is a semi-healthy repository

How to improve this score

Ensure there is a clearly labelled repository holding all the contracts, documentation and tests for the deployed code. Continue to test and perform other verification activities after deployment, including routine maintenance updating to new releases of testing and deployment tools.

Documentation

This section looks at the software documentation. The document explaining these questions is here.

Required questions are;

  1. Is there a whitepaper? (Y/N)

  2. Are the basic application requirements documented? (Y/N)

  3. Do the requirements fully (100%) cover the deployed contracts? (%)

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

  5. Is it possible to trace software requirements to the implementation in code (%)

Is there a whitepaper? (Y/N)

Answer: Yes

Their whitepaper was found buried in their github.

Location: https://github.com/stabilize-token/contracts/blob/master/docs/whitepaper.pdf

Are the basic application requirements documented? (Y/N)

Answer: No

There is no apparent external documentation of the application requirements.

How to improve this score

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

Do the requirements fully (100%) cover the deployed contracts? (%)

Answer: 0%

With no evident external requirement documentation, there is no coverage of the deployed contracts.

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.

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

Answer: 20%

Within the code, all the functions are well-explained and well-documented.

Code examples are in the Appendix. As per the SLOC, there is 20% commenting to code.

Is it possible to trace requirements to the implementation in code (%)

Answer: 0%

With no apparent external documentation of the requirements, there is no connection between the documentation to 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;

  1. Full test suite (Covers all the deployed code) (%)

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

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

  4. Packaged with the deployed code (Y/N)

  5. Report of the results (%)

  6. Formal Verification test done (%)

  7. Stress Testing environment (%)

Is there a Full test suite? (%)

Answer: 0%

There is no evidence of any testing having been preformed.

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.

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

Answer: 0%

There is no evidence of any testing having been preformed.

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.

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

Answer: No

There is no evidence of any testing having been preformed, and therefore there are no scripts or instructions to run the tests.

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.

Packaged with the deployed code (Y/N)

Answer: No

There is no evidence of any testing having been preformed, and therefore it is not packaged with the deployed code.

How to improve this score

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.

Report of the results (%)

Answer: 0%

There is no evidence of any testing having been preformed, and therefore there is no report of the results.

How to improve this score

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

Formal Verification test done (%)

Answer: 0%

There is no evidence of any testing having been preformed, and therefore no evidence of formal verification testing having been done.

Stress Testing environment (%)

Answer: 0%

There is no evidence of any testing having been preformed, and therefore no evidence of any stress testing having been done.

Audits

Answer: 20%

No audit has been preformed.

Guidance:

  1. Multiple Audits performed before deployment and results public and implemented or not required (100%)

  2. Single audit performed before deployment and results public and implemented or not required (90%)

  3. Audit(s) performed after deployment and no changes required. Audit report is public. (70%)

  4. No audit performed (20%)

  5. Audit Performed after deployment, existence is public, report is not public and no improvements deployed OR smart contract address' not found, question 1 (0%)

Appendices

Author Details

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.

Scoring Appendix

Executing Code Appendix

Code Used Appendix

Example Code Appendix

pragma solidity ^0.6.6;
// Treasury Furnace is a simple vault for all the withdrawal fees sent to it and is a furnace for STBZ tokens
// When a user wants to take from the Treasury, they will simply have to burn their STBZ tokens into the treasury
// And they will redeem the percentage compared to the circulating number of STBZ tokens (total - operator - treasury)
// STBZ tokens stored in the treasury are effectively burned and cannot be redeemed again
// If this treasury is replaced in the future, future contracts will need to account for the burned tokens in this contract
contract StabilizeTreasuryFurnace is Ownable {
using SafeMath for uint256;
using SafeERC20 for IERC20;
// variables
address public stbzAddress; // The address for the STBZ tokens
address public operatorAddress; // The address for the operator contract
IERC20 private _stabilizeT; // Instance of stabilize token
address[] private activeTokens; // A list of all the acceptable reward tokens to this treasury
address[] public furnaceList; // A list of all the furnaces used previously
// Events
event TreasuryBurn(address indexed user, uint256 amount);
constructor(
address _stbz,
address _operator
) public {
stbzAddress = _stbz;
operatorAddress = _operator;
_stabilizeT = IERC20(stbzAddress);
initialTokens();
initialFurnaces();
}
// Initial operations
function initialTokens() internal {
// Testnet
/*
activeTokens.push(address(0xFf795577d9AC8bD7D90Ee22b6C1703490b6512FD)); // DAI
activeTokens.push(address(0xe22da380ee6B445bb8273C81944ADEB6E8450422)); // USDC
activeTokens.push(address(0x13512979ADE267AB5100878E2e0f485B568328a4)); // USDT
activeTokens.push(address(0xD868790F57B39C9B2B51b12de046975f986675f9)); // sUSD
*/
// Mainnet
activeTokens.push(address(0x6B175474E89094C44Da98b954EedeAC495271d0F)); // DAI
activeTokens.push(address(0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48)); // USDC
activeTokens.push(address(0xdAC17F958D2ee523a2206206994597C13D831ec7)); // USDT
activeTokens.push(address(0x57Ab1ec28D129707052df4dF418D58a2D46d5f51)); // sUSD
}
function initialFurnaces() internal {
// Testnet
//furnaceList.push(address(0x0B5F5ECeA3835a5C5f6F528353fae50c75B60c3e)); // Treasury #1
//furnaceList.push(address(0x81C878E0B9261622192183415969a00dA12685ef)); // Treasury #2
// Mainnet
// None yet
}
// functions
function circulatingSupply() public view returns (uint256) {
if(_stabilizeT.totalSupply() == 0){
return 0;
}else{
// Circulating supply is total supply minus operator contract minus treasury account
uint256 total = _stabilizeT.totalSupply().sub(_stabilizeT.balanceOf(operatorAddress)).sub(_stabilizeT.balanceOf(address(this)));
// Now factor in all previous furnaces
if(furnaceList.length > 0){
for(uint256 i = 0; i < furnaceList.length; i++){
total = total.sub(_stabilizeT.balanceOf(furnaceList[i]));
}
}
return total;
}
}
function totalTokens() external view returns (uint256) {
return activeTokens.length;
}

SLOC Appendix

Solidity Contracts

Language

Files

Lines

Blanks

Comments

Code

Complexity

Solidity

9

2151

923

309

1479

184

Comments to Code 309 / 1479 = 21%