Finished Reviews

Metronome Currency PQ Audits

Score: 84%

This is a Metronome Process Quality Review completed on ____ 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 84%, a strong pass. 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.

  • 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

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.

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? (Y/N)

  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)

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

Answer: Yes

I finally found them on the GitHub; https://github.com/autonomoussoftware/metronome readme, as indicated in the Appendix.

Is the code actively being used? (%)

Answer: 70%

Contract for AutonomousConverter (0x686e5ac50D9236A9b7406791256e47feDDB26AbA) has 7 internal transaction 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

Is there a public software repository? (Y/N)

Answer: Yes

There is a github; https://github.com/autonomoussoftware/metronome

Is there a development history visible? (%)

Answer: 70%

With 76 commits on 8 branches and a release, this is a pretty healthy repo.

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

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.

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

Answer: Yes

https://metronome.io/about/ on the Team Leads tab has the team description.

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 software functions documented? (Y/N)

  3. Does the software function documentation 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 from software documentation to the implementation in codee (%)

Is there a whitepaper? (Y/N)

Answer: Yes

For Metronome, the white paper is called an "Owners Manual"

Location: https://github.com/autonomoussoftware/documentation/blob/master/owners_manual/owners_manual.md

How to improve this score

Ensure the white paper is available for download from your website or at least the software repository. Ideally update the whitepaper to meet the capabilities of your present application.

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

Answer: Yes

The API is very well documented in this section. This public functions cover the bulk of the software.

Location: https://github.com/autonomoussoftware/documentation/blob/master/owners_manual/owners_manual.md#metronome-core

How to improve this score

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

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

Answer: 80%

Through the API (link above) all the major functions are described.

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.

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

Answer: 40%

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

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

Answer: 40%

The API docs mention the functions but there is not attempt at connecting it with 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: 100%

The TtC is 208%. The test are in https://github.com/autonomoussoftware/metronome/tree/master/test

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.

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

Answer: 50%

No indication of code coverage results is evident.

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

Tests are in the readme of the github

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

Report of the results (%)

Answer: 0%

No report is evident.

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%

No formal verification test is evident.

Stress Testing environment (%)

Answer: 0%

No test networks are evident, though ethereum classic addresses exist.

Audits

Answer: 100%

Two audits (dating 2018 wow!) are at https://github.com/autonomoussoftware/metronome-audits. From Zeppelin (who are top knotch) and Coin Inspect. Therefore a score of 100%.

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 : [email protected]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

/// @notice set address of Proposals contract
/// @param _proposals address of token porter
/// @return true/false
function setProposalContract(address _proposals) public onlyOwner returns (bool) {
require(_proposals != 0x0);
proposals = Proposals(_proposals);
return true;
}
/// @notice set address of token porter
/// @param _tokenPorter address of token porter
/// @return true/false
function setTokenPorter(address _tokenPorter) public onlyOwner returns (bool) {
require(_tokenPorter != 0x0);
tokenPorter = TokenPorter(_tokenPorter);
return true;
}
/// @notice set contract addresses in validator contract.
/// @param _tokenAddr address of MetToken contract
/// @param _auctionsAddr address of Auction contract
/// @param _tokenPorterAddr address of TokenPorter contract
function initValidator(address _tokenAddr, address _auctionsAddr, address _tokenPorterAddr) public onlyOwner {
require(_tokenAddr != 0x0);
require(_auctionsAddr != 0x0);
require(_tokenPorterAddr != 0x0);
tokenPorter = TokenPorter(_tokenPorterAddr);
auctions = Auctions(_auctionsAddr);
token = METToken(_tokenAddr);
}
/// @notice Off chain validator call this function to validate and attest the hash.
/// @param _burnHash current burnHash
/// @param _originChain source chain
/// @param _recipientAddr recipientAddr
/// @param _amount amount to import
/// @param _fee fee for import-export
/// @param _proof proof
/// @param _extraData extra information for import
/// @param _globalSupplyInOtherChains total supply in all other chains except this chain
function attestHash(bytes32 _burnHash, bytes8 _originChain, address _recipientAddr,
uint _amount, uint _fee, bytes32[] _proof, bytes _extraData,
uint _globalSupplyInOtherChains) public onlyValidator {
require(_burnHash != 0x0);
require(!hashAttestations[_burnHash][msg.sender]);
require(!hashRefutation[_burnHash][msg.sender]);
require(verifyProof(tokenPorter.merkleRoots(_burnHash), _burnHash, _proof));
hashAttestations[_burnHash][msg.sender] = true;
attestationCount[_burnHash]++;
emit LogAttestation(_burnHash, _recipientAddr, true);
if (attestationCount[_burnHash] >= threshold && !hashClaimed[_burnHash]) {
hashClaimed[_burnHash] = true;
require(tokenPorter.mintToken(_originChain, _recipientAddr, _amount, _fee,
_extraData, _burnHash, _globalSupplyInOtherChains, validators));
}
}
/// @notice off chain validator can refute hash, if given export hash is not verified in origin chain.
/// @param _burnHash Burn hash
function refuteHash(bytes32 _burnHash, address _recipientAddr) public onlyValidator {
require(!hashAttestations[_burnHash][msg.sender]);
require(!hashRefutation[_burnHash][msg.sender]);
hashRefutation[_burnHash][msg.sender] = true;
emit LogAttestation(_burnHash, _recipientAddr, false);
}
/// @notice verify that the given leaf is in merkle root.
/// @param _root merkle root
/// @param _leaf leaf node, current burn hash
/// @param _proof merkle path
/// @return true/false outcome of the verification.
function verifyProof(bytes32 _root, bytes32 _leaf, bytes32[] _proof) private pure returns (bool) {
require(_root != 0x0 && _leaf != 0x0 && _proof.length != 0);
bytes32 _hash = _leaf;
for (uint i = 0; i < _proof.length; i++) {
_hash = sha256(_proof[i], _hash);
}
return (_hash == _root);
}
}

SLOC Appendix

Solidity Contracts

Language

Files

Lines

Blanks

Comments

Code

Complexity

Solidity

1

2321

350

473

1498

324

Comments to Code 473 / 1498 = 32%

Javascript Tests

Language

Files

Lines

Blanks

Comments

Code

Complexity

JavaScript

16

4242

567

555

3120

100

Tests to Code 3120/ 1498= 208%