Submission Details
Severity:
Contract and functions layout at the start of the `DSCEngine.sol` and `DecentralizedStableCoin.sol` is clutter and should be removed
Description
At the start of the DSCEngine.sol and DecentralizedStableCoin.sol files the layout of the contract and functions is displayed. This is clutter and does not help with understanding the contract more then it generates clutter.
// Layout of Contract:
// version
// imports
// errors
// interfaces, libraries, contracts
// Type declarations
// State variables
// Events
// Modifiers
// Functions
// Layout of Functions:
// constructor
// receive function (if exists)
// fallback function (if exists)
// external
// public
// internal
// private
// view & pure functions
Especially since the described layout is almost identical to the, well known, Solidity standard layout: https://docs.soliditylang.org/en/latest/style-guide.html
Recommend Mitigation
Either remove it completely or add a single message saying something similar to:
// Smart contract layout follows: https://docs.soliditylang.org/en/latest/style-guide.html
Prize pool breakdown
Total prize
15,000 USDC
nSLOC
23664 USDC / LOC
14,000 USDC
1,000 USDC
Live
The contest is live. Earn rewards by submitting a finding.
Appeals
This is your time to appeal against judgements on your submissions.
Appeals Review
Appeals are being carefully reviewed by our judges.