QA Report #293
Labels
bug
Something isn't working
old-submission-method
QA (Quality Assurance)
Assets are not at risk. State handling, function incorrect as to spec, issues with clarity, syntax
valid
Typos
HomeFiProxy.sol: L22
/// @notice bytes2 array of upgradable contracts initials
Change
contracts
tocontract
HomeFiProxy.sol: L29
/// @dev mapping that tell if a particular address is active(latest version of contract)
Change
tell
totells
orshows
HomeFiProxy.sol: L32
/// @dev mapping that maps contract initials with there implementation address
Change
there
totheir
Disputes.sol: L51
// Revert if project not originated of HomeFi
Change
of
toby
Disputes.sol: L179
// Revert is signer is not builder, contractor or subcontractor.
Change first instance of
is
toif
HomeFi.sol: L115
Change
with
toby
Project.sol: L214
// Allocate funds to tasks and mark then as allocated
Change
then
tothem
or else removethen
Project.sol: L455
// As as needs to go though funding process again.
Replace repeated word
as
The same typo (
Revet
) occurs in both lines referenced below:Project.sol: L514
Project.sol: L520
Example (Project.sol: L514):
// Revet if sender is not builder or contractor
Change
Revet
toRevert
in both casesProject.sol: L574
// Max amount out times this loop will run
Change
out
toof
Project.sol: L575
// This is to ensure the transaction do not run out of gas (max gas limit)
Change
do
todoes
The same typo (
is
) occurs in both lines referenced below:Project.sol: L613
Project.sol: L660
// If there is enough funds to allocate this task
Change
is
toare
in both casesCommunity.sol: L164
// Emit event if _hash. This way this hash needs not be stored in memory.
Change
needs
toneed
Community.sol: L271
// If _publishFee is zero than mark publish fee as paid
Change
than
tothen
The same typo (
address - address
) occurs in both lines referenced below:Project.sol: L866
Community.sol: L821
Example (Project.sol: L866):
Suggestion:
Community.sol: L618
// Initiate empty equal equal to member count length
Remove repeated word
equal
Unclear comments
Comments should communicate clearly, immediately and without ambiguity. The comments below could be improved, as shown:
Project.sol: L379
// If balance is present then it to the builder.
Suggestion: Change
then it
tothen transfer it
Community.sol: L752
Suggestion:
Long single line comments
In theory, comments over 79 characters should wrap using multi-line comment syntax. Even if somewhat longer comments are acceptable, there are cases where very long comments interfere with readability.
Below are five instances of long comments whose readability could be improved, as shown:
HomeFiProxy.sol: L50
Suggestion:
HomeFiProxy.sol: L123
Suggestion:
Project.sol: L785
Suggestion:
Project.sol: L819
Suggestion:
SignatureDecoder.sol: L58
Suggestion:
Update sensitive terms
Terms incorporating "white," "black," "master" or "slave" are potentially problematic. Substituting more neutral terminology is becoming common practice. It is apparent that use of
whitelist
has been avoided inRigor Protocol
. There is one instance ofmaster
, however, as shown below:Project.sol: L86
/// @dev Added to make sure master implementation cannot be initialized
The text was updated successfully, but these errors were encountered: