LockupContract Static Analysis Findings

LCT-01S: Illegible Numeric Value Representation

Type	Severity	Location
Code Style		LockupContract.sol:L25

Description:

The linked representation of a numeric literal is sub-optimally represented decreasing the legibility of the codebase.

Example:

Copy
25uint constant public SECONDS_IN_ONE_YEAR = 31536000;

Recommendation:

To properly illustrate the value's purpose, we advise the following guidelines to be followed. For values meant to depict fractions with a base of 1e18, we advise fractions to be utilized directly (i.e. 1e17 becomes 0.1e18) as they are supported. For values meant to represent a percentage base, we advise each value to utilize the underscore (_) separator to discern the percentage decimal (i.e. 10000 becomes 100_00, 300 becomes 3_00 and so on). Finally, for large numeric values we simply advise the underscore character to be utilized again to represent them (i.e. 1000000 becomes 1_000_000).

Alleviation (8bedd3b0df6387957e6b8f5d52507e776c1458b0):

The Powercity team evaluated this exhibit but has opted to acknowledge it in the current iteration of the codebase.

LCT-02S: Inexistent Sanitization of Input Addresses

Type	Severity	Location
Input Sanitization		LockupContract.sol:L41-L60

Description:

The linked function(s) accept address arguments yet do not properly sanitize them.

Impact:

The presence of zero-value addresses, especially in constructor implementations, can cause the contract to be permanently inoperable. These checks are advised as zero-value inputs are a common side-effect of off-chain software related bugs.

Example:

Copy
41constructor 
42(
43    address _lqtyTokenAddress, 
44    address _beneficiary, 
45    uint _unlockTime
46)
47    public 
48{
49    lqtyToken = ILQTYToken(_lqtyTokenAddress);
50
51    /*
52    * Set the unlock time to a chosen instant in the future, as long as it is at least 1 year after
53    * the system was deployed 
54    */
55    _requireUnlockTimeIsAtLeastOneYearAfterSystemDeployment(_unlockTime);
56    unlockTime = _unlockTime;
57    
58    beneficiary =  _beneficiary;
59    emit LockupContractCreated(_beneficiary, _unlockTime);
60}

Recommendation:

We advise some basic sanitization to be put in place by ensuring that each address specified is non-zero.

Alleviation (8bedd3b0df6387957e6b8f5d52507e776c1458b0):

Both input addresses of the contract's LockupContract::constructor are adequately sanitized as non-zero, preventing the contract from being misconfigured during deployment.