Various Non-Conformance to Solidity naming conventions

[code423n4]

Handle

Dravee

Vulnerability details

Impact

Solidity defines a naming convention that should be followed.

Proof of Concept

Variable XDEFIDistribution.MAX_TOTAL_XDEFI_SUPPLY (contracts/XDEFIDistribution.sol#14) is not in mixedCase
Constant XDEFIDistribution._pointsMultiplier (contracts/XDEFIDistribution.sol#17) is not in UPPER_CASE_WITH_UNDERSCORES
Variable XDEFIDistribution._pointsPerUnit (contracts/XDEFIDistribution.sol#18) is not in mixedCase
Variable XDEFIDistribution.XDEFI (contracts/XDEFIDistribution.sol#20) is not in mixedCase
Variable XDEFIDistribution._zeroDurationPointBase (contracts/XDEFIDistribution.sol#30) is not in mixedCase
Variable XDEFIDistribution._locked (contracts/XDEFIDistribution.sol#37) is not in mixedCase
Function IXDEFIDistribution.XDEFI() (contracts/interfaces/IXDEFIDistribution.sol#37) is not in mixedCase

Tools Used

Slither

Recommended Mitigation Steps

Follow the Solidity naming convention: https://docs.soliditylang.org/en/v0.4.25/style-guide.html#naming-conventions

[deluca-mike]

MAX_TOTAL_XDEFI_SUPPLY is being removed.
_pointsMultiplier will be renamed to POINTS_MULTIPLIER.
_pointsPerUnit, _pointsPerUnit, and _locked will remain as it is an internal variable and that is the standard we use to distinguish between exposed and non-exposed variables and functions.
XDEFI will be renamed to xdefi.
_zeroDurationPointBase, despite being immutable, is actually not considered constant by Solidity developers themselves, sadly. See this and this.

[deluca-mike]

MAX_TOTAL_XDEFI_SUPPLY and _zeroDurationPointBase was removed from the release candidate contract.

_pointsMultiplier was renamed to POINTS_MULTIPLIER, but then to POINTS_MULTIPLIER_BITS since another issue correctly suggested we shift rather than multiply.

XDEFI was renamed to xdefi.