feat: Standardize README and clean up (#48)

JGcarv · deluca-mike · web-flow · commit b2fd236e9a69 · 2022-12-22T14:15:27.000-05:00
* Update README.md * feat: Standardize README and clean up (#49) * feat: Standard Readme and cleanup * fix: PR Review Co-authored-by: Michael De Luca <35537333+deluca-mike@users.noreply.github.com>
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 ![Foundry CI](https://github.com/maple-labs/erc20/actions/workflows/push-to-main.yml/badge.svg) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
 
+## Overview
+
 Basic ERC-20 contract designed to be inherited and extended. Leveraging native overflow checks in solc 0.8 to simplify ERC-20 implementation. It should be noted that this ERC-20 implementation does not include some functionality that is commonly used in other tokens, such as:
 - `address(0)` checks on `_transfer`
 - `push`
@@ -11,13 +13,23 @@ This was intentional, as this ERC-20 was intended to have the minimum functional
 
 This token implementation includes ERC-2612 [permit](https://eips.ethereum.org/EIPS/eip-2612) capability as well as `increaseAllowance` and `decreaseAllowance` functions.
 
-To clone, set up and run tests:
-```
-git clone git@github.com:maple-labs/ERC20.git
-forge update
-make test
+## Setup
+
+This project was built using [Foundry](https://book.getfoundry.sh/). Refer to installation instructions [here](https://github.com/foundry-rs/foundry#installation).
+
+```sh
+git clone git@github.com:maple-labs/erc20.git
+cd erc20
+forge install
 ```
 
+## Running Tests
+
+- To run all tests: `forge test`
+- To run specific tests: `forge test --match <test_name>`
+
+`./scripts/test.sh` is used to enable Foundry profile usage with the `-p` flag. Profiles are used to specify the number of fuzz runs.
+
 ## Acknowledgements
 These contracts were inspired by and/or directly modified from the following sources:
 - [Solmate](https://github.com/Rari-Capital/solmate)
@@ -34,16 +46,10 @@ These contracts were inspired by and/or directly modified from the following sou
 
 For all information related to the ongoing bug bounty for these contracts run by [Immunefi](https://immunefi.com/), please visit this [site](https://immunefi.com/bounty/maple/).
 
-| Severity of Finding | Payout |
-|---|---|
-| Critical | $50,000 |
-| High | $25,000 |
-| Medium | $1,000 |
-
 ## About Maple
 Maple is a decentralized corporate credit market. Maple provides capital to institutional borrowers through globally accessible fixed-income yield opportunities.
 
-For all technical documentation related to the Maple protocol, please refer to the GitHub [wiki](https://github.com/maple-labs/maple-core/wiki).
+For all technical documentation related to the Maple protocol, please refer to the GitHub [wiki](https://github.com/maple-labs/maple-core-v2/wiki).
 
 ---
 
diff --git a/contracts/ERC20.sol b/contracts/ERC20.sol
@@ -18,9 +18,9 @@ import { IERC20 } from "./interfaces/IERC20.sol";
  */
 contract ERC20 is IERC20 {
 
-    /**************/
-    /*** ERC-20 ***/
-    /**************/
+    /**************************************************************************************************************************************/
+    /*** ERC-20                                                                                                                         ***/
+    /**************************************************************************************************************************************/
 
     string public override name;
     string public override symbol;
@@ -33,9 +33,9 @@ contract ERC20 is IERC20 {
 
     mapping(address => mapping(address => uint256)) public override allowance;
 
-    /****************/
-    /*** ERC-2612 ***/
-    /****************/
+    /**************************************************************************************************************************************/
+    /*** ERC-2612                                                                                                                       ***/
+    /**************************************************************************************************************************************/
 
     // PERMIT_TYPEHASH = keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)");
     bytes32 public constant override PERMIT_TYPEHASH = 0x6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9;
@@ -53,9 +53,9 @@ contract ERC20 is IERC20 {
         decimals = decimals_;
     }
 
-    /**************************/
-    /*** External Functions ***/
-    /**************************/
+    /**************************************************************************************************************************************/
+    /*** External Functions                                                                                                             ***/
+    /**************************************************************************************************************************************/
 
     function approve(address spender_, uint256 amount_) public virtual override returns (bool success_) {
         _approve(msg.sender, spender_, amount_);
@@ -72,7 +72,9 @@ contract ERC20 is IERC20 {
         return true;
     }
 
-    function permit(address owner_, address spender_, uint256 amount_, uint256 deadline_, uint8 v_, bytes32 r_, bytes32 s_) public virtual override {
+    function permit(address owner_, address spender_, uint256 amount_, uint256 deadline_, uint8 v_, bytes32 r_, bytes32 s_)
+        public virtual override
+    {
         require(deadline_ >= block.timestamp, "ERC20:P:EXPIRED");
 
         // Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines
@@ -85,17 +87,17 @@ contract ERC20 is IERC20 {
 
         // Nonce realistically cannot overflow.
         unchecked {
-            bytes32 digest = keccak256(
+            bytes32 digest_ = keccak256(
                 abi.encodePacked(
                     "\x19\x01",
                     DOMAIN_SEPARATOR(),
                     keccak256(abi.encode(PERMIT_TYPEHASH, owner_, spender_, amount_, nonces[owner_]++, deadline_))
                 )
             );
 
-            address recoveredAddress = ecrecover(digest, v_, r_, s_);
+            address recoveredAddress_ = ecrecover(digest_, v_, r_, s_);
 
-            require(recoveredAddress == owner_ && owner_ != address(0), "ERC20:P:INVALID_SIGNATURE");
+            require(recoveredAddress_ == owner_ && owner_ != address(0), "ERC20:P:INVALID_SIGNATURE");
         }
 
         _approve(owner_, spender_, amount_);
@@ -112,9 +114,9 @@ contract ERC20 is IERC20 {
         return true;
     }
 
-    /**********************/
-    /*** View Functions ***/
-    /**********************/
+    /**************************************************************************************************************************************/
+    /*** View Functions                                                                                                                 ***/
+    /**************************************************************************************************************************************/
 
     function DOMAIN_SEPARATOR() public view override returns (bytes32 domainSeparator_) {
         return keccak256(
@@ -128,9 +130,9 @@ contract ERC20 is IERC20 {
         );
     }
 
-    /**************************/
-    /*** Internal Functions ***/
-    /**************************/
+    /**************************************************************************************************************************************/
+    /*** Internal Functions                                                                                                             ***/
+    /**************************************************************************************************************************************/
 
     function _approve(address owner_, address spender_, uint256 amount_) internal {
         emit Approval(owner_, spender_, allowance[owner_][spender_] = amount_);
diff --git a/contracts/interfaces/IERC20.sol b/contracts/interfaces/IERC20.sol
@@ -4,9 +4,9 @@ pragma solidity ^0.8.7;
 /// @title Interface of the ERC20 standard as defined in the EIP, including EIP-2612 permit functionality.
 interface IERC20 {
 
-    /**************/
-    /*** Events ***/
-    /**************/
+    /**************************************************************************************************************************************/
+    /*** Events                                                                                                                         ***/
+    /**************************************************************************************************************************************/
 
     /**
      *  @dev   Emitted when one account has set the allowance of another account over their tokens.
@@ -24,9 +24,9 @@ interface IERC20 {
      */
     event Transfer(address indexed owner_, address indexed recipient_, uint256 amount_);
 
-    /**************************/
-    /*** External Functions ***/
-    /**************************/
+    /**************************************************************************************************************************************/
+    /*** External Functions                                                                                                             ***/
+    /**************************************************************************************************************************************/
 
     /**
      *  @dev    Function that allows one account to set the allowance of another account over their tokens.
@@ -87,9 +87,9 @@ interface IERC20 {
      */
     function transferFrom(address owner_, address recipient_, uint256 amount_) external returns (bool success_);
 
-    /**********************/
-    /*** View Functions ***/
-    /**********************/
+    /**************************************************************************************************************************************/
+    /*** View Functions                                                                                                                 ***/
+    /**************************************************************************************************************************************/
 
     /**
      *  @dev    Returns the allowance that one account has given another over their tokens.
diff --git a/contracts/test/ERC20.t.sol b/contracts/test/ERC20.t.sol
@@ -265,7 +265,11 @@ contract ERC20PermitTest is TestUtils {
         uint256 startingNonce = _token.nonces(_owner);
         uint256 expectedNonce = startingNonce + 1;
 
-        ( uint8 v, bytes32 r, bytes32 s ) = _getValidPermitSignature(address(_token), _owner, _spender, amount_, startingNonce, _deadline, _skOwner);
+        (
+            uint8 v,
+            bytes32 r,
+            bytes32 s
+        ) = _getValidPermitSignature(address(_token), _owner, _spender, amount_, startingNonce, _deadline, _skOwner);
 
         _user.erc20_permit(address(_token), _owner, _spender, amount_, _deadline, v, r, s);
 
@@ -371,7 +375,8 @@ contract ERC20PermitTest is TestUtils {
     function test_permit_badV() public {
         // Get valid signature. The `v` value is the expected v value that will cause `permit` to succeed, and must be 27 or 28.
         // Any other value should fail.
-        // If v is 27, then 28 should make it past the MALLEABLE require, but should result in an invalid signature, and vice versa when v is 28.
+        // If v is 27, then 28 should make it past the MALLEABLE require, but should result in an invalid signature,
+        // and vice versa when v is 28.
         ( uint8 v, bytes32 r, bytes32 s ) = _getValidPermitSignature(address(_token), _owner, _spender, 1000, 0, _deadline, _skOwner);
 
         for (uint8 i; i <= type(uint8).max; i++) {
@@ -391,7 +396,9 @@ contract ERC20PermitTest is TestUtils {
     }
 
     // Returns an ERC-2612 `permit` digest for the `owner` to sign
-    function _getDigest(address token_, address owner_, address spender_, uint256 amount_, uint256 nonce_, uint256 deadline_) internal view returns (bytes32 digest_) {
+    function _getDigest(address token_, address owner_, address spender_, uint256 amount_, uint256 nonce_, uint256 deadline_)
+        internal view returns (bytes32 digest_)
+    {
         return keccak256(
             abi.encodePacked(
                 '\x19\x01',
@@ -402,7 +409,17 @@ contract ERC20PermitTest is TestUtils {
     }
 
     // Returns a valid `permit` signature signed by this contract's `owner` address
-    function _getValidPermitSignature(address token_, address owner_, address spender_, uint256 amount_, uint256 nonce_, uint256 deadline_, uint256 ownerSk_) internal returns (uint8 v_, bytes32 r_, bytes32 s_) {
+    function _getValidPermitSignature(
+        address token_,
+        address owner_,
+        address spender_,
+        uint256 amount_,
+        uint256 nonce_,
+        uint256 deadline_,
+        uint256 ownerSk_
+    )
+        internal returns (uint8 v_, bytes32 r_, bytes32 s_)
+    {
         return vm.sign(ownerSk_, _getDigest(token_, owner_, spender_, amount_, nonce_, deadline_));
     }
 
diff --git a/contracts/test/mocks/MockERC20.sol b/contracts/test/mocks/MockERC20.sol
@@ -5,7 +5,7 @@ import { ERC20 } from "../../ERC20.sol";
 
 contract MockERC20 is ERC20 {
 
-    constructor(string memory name_, string memory symbol_, uint8 decimals_) ERC20(name_, symbol_, decimals_) { }
+    constructor(string memory name_, string memory symbol_, uint8 decimals_) ERC20(name_, symbol_, decimals_) {}
 
     function mint(address recipient_, uint256 amount_) external {
         _mint(recipient_, amount_);
