add: surya report

.husky/pre-commit

@@ -1,4 +1,7 @@
 echo "Running tests..."
 
 yarn lint-staged
-yarn test
+yarn test
+
+surya mdreport report_outfile.md contracts/**/*.sol
+git add report_outfile.md

report_outfile.md

@@ -0,0 +1,72 @@
+## Sūrya's Description Report
+
+### Files Description Table
+
+
+|  File Name  |  SHA-1 Hash  |
+|-------------|--------------|
+| contracts/ERC20/BaseERC20.sol | [object Promise] |
+| contracts/ERC20/IERC20.sol | [object Promise] |
+| contracts/ERC20/TradableERC20.sol | [object Promise] |
+| contracts/ERC20/VotingERC20.sol | [object Promise] |
+| contracts/utils/Ownable.sol | [object Promise] |
+
+
+### Contracts Description Table
+
+
+|  Contract  |         Type        |       Bases      |                  |                 |
+|:----------:|:-------------------:|:----------------:|:----------------:|:---------------:|
+|     └      |  **Function Name**  |  **Visibility**  |  **Mutability**  |  **Modifiers**  |
+||||||
+| **BaseERC20** | Implementation | IERC20, Ownable |||
+| └ | <Constructor> | Public ❗️ | 🛑  |NO❗️ |
+| └ | balanceOf | Public ❗️ |   |NO❗️ |
+| └ | transfer | Public ❗️ | 🛑  | validAddress |
+| └ | allowance | Public ❗️ |   |NO❗️ |
+| └ | approve | Public ❗️ | 🛑  | validAddress |
+| └ | transferFrom | Public ❗️ | 🛑  | validAddress validAddress |
+| └ | totalSupply | Public ❗️ |   |NO❗️ |
+| └ | _mint | Internal 🔒 | 🛑  | validAddress |
+| └ | _burn | Internal 🔒 | 🛑  | validAddress |
+||||||
+| **IERC20** | Interface |  |||
+| └ | totalSupply | External ❗️ |   |NO❗️ |
+| └ | balanceOf | External ❗️ |   |NO❗️ |
+| └ | transfer | External ❗️ | 🛑  |NO❗️ |
+| └ | allowance | External ❗️ |   |NO❗️ |
+| └ | approve | External ❗️ | 🛑  |NO❗️ |
+| └ | transferFrom | External ❗️ | 🛑  |NO❗️ |
+||||||
+| **TradableERC20** | Implementation | VotingERC20 |||
+| └ | <Constructor> | Public ❗️ | 🛑  | VotingERC20 |
+| └ | buy | Public ❗️ |  💵 | haveNotVoted |
+| └ | sell | Public ❗️ | 🛑  | haveNotVoted |
+| └ | transfer | Public ❗️ | 🛑  | haveNotVoted |
+| └ | approve | Public ❗️ | 🛑  | haveNotVoted |
+| └ | setFeePercentage | Public ❗️ | 🛑  | onlyOwner |
+| └ | collectAndBurnFee | Public ❗️ | 🛑  | onlyOwner |
+| └ | getFeeBalance | Public ❗️ |   | onlyOwner |
+| └ | withdrawBalanceAmount | Public ❗️ | 🛑  | onlyOwner |
+| └ | withdrawBalance | Public ❗️ | 🛑  | onlyOwner |
+||||||
+| **VotingERC20** | Implementation | BaseERC20 |||
+| └ | <Constructor> | Public ❗️ | 🛑  | BaseERC20 |
+| └ | _ownsMoreThan | Internal 🔒 |   | |
+| └ | _startVoting | Internal 🔒 | 🛑  | |
+| └ | _updatePrice | Internal 🔒 | 🛑  | |
+| └ | userPercentage | Public ❗️ |   |NO❗️ |
+| └ | stopVoting | Public ❗️ | 🛑  |NO❗️ |
+| └ | vote | Public ❗️ | 🛑  |NO❗️ |
+| └ | <Receive Ether> | External ❗️ |  💵 |NO❗️ |
+||||||
+| **Ownable** | Implementation |  |||
+| └ | <Constructor> | Public ❗️ | 🛑  |NO❗️ |
+
+
+### Legend
+
+|  Symbol  |  Meaning  |
+|:--------:|-----------|
+|    🛑    | Function can modify state |
+|    💵    | Function is payable |