Merge pull request #12 from thesis/renames

Small renames: s/nonces/nonce, s/sender/spender

contracts/token/ERC20WithPermit.sol

@@ -27,7 +27,7 @@ contract ERC20WithPermit is IERC20WithPermit, Ownable {
     /// @notice Returns the current nonce for EIP2612 permission for the
     ///         provided token owner for a replay protection. Used to construct
     ///         EIP2612 signature provided to `permit` function.
-    mapping(address => uint256) public override nonces;
+    mapping(address => uint256) public override nonce;
 
     uint256 public immutable cachedChainId;
     bytes32 public immutable cachedDomainSeparator;
@@ -73,29 +73,29 @@ contract ERC20WithPermit is IERC20WithPermit, Ownable {
         return true;
     }
 
-    /// @notice Moves `amount` tokens from `sender` to `recipient` using the
+    /// @notice Moves `amount` tokens from `spender` to `recipient` using the
     ///         allowance mechanism. `amount` is then deducted from the caller's
     ///         allowance unless the allowance was made for `type(uint256).max`.
     /// @return True if the operation succeeded, reverts otherwise.
     /// @dev Requirements:
-    ///      - `sender` and `recipient` cannot be the zero address,
-    ///      - `sender` must have a balance of at least `amount`,
-    ///      - the caller must have allowance for `sender`'s tokens of at least
+    ///      - `spender` and `recipient` cannot be the zero address,
+    ///      - `spender` must have a balance of at least `amount`,
+    ///      - the caller must have allowance for `spender`'s tokens of at least
     ///        `amount`.
     function transferFrom(
-        address sender,
+        address spender,
         address recipient,
         uint256 amount
     ) external override returns (bool) {
-        uint256 currentAllowance = allowance[sender][msg.sender];
+        uint256 currentAllowance = allowance[spender][msg.sender];
         if (currentAllowance != type(uint256).max) {
             require(
                 currentAllowance >= amount,
                 "Transfer amount exceeds allowance"
             );
-            _approve(sender, msg.sender, currentAllowance - amount);
+            _approve(spender, msg.sender, currentAllowance - amount);
         }
-        _transfer(sender, recipient, amount);
+        _transfer(spender, recipient, amount);
         return true;
     }
 
@@ -141,7 +141,7 @@ contract ERC20WithPermit is IERC20WithPermit, Ownable {
                         owner,
                         spender,
                         amount,
-                        nonces[owner]++,
+                        nonce[owner]++,
                         deadline
                     )
                 )
@@ -289,21 +289,21 @@ contract ERC20WithPermit is IERC20WithPermit, Ownable {
     }
 
     function _transfer(
-        address sender,
+        address spender,
         address recipient,
         uint256 amount
     ) private {
-        require(sender != address(0), "Transfer from the zero address");
+        require(spender != address(0), "Transfer from the zero address");
         require(recipient != address(0), "Transfer to the zero address");
         require(recipient != address(this), "Transfer to the token address");
 
-        beforeTokenTransfer(sender, recipient, amount);
+        beforeTokenTransfer(spender, recipient, amount);
 
-        uint256 senderBalance = balanceOf[sender];
-        require(senderBalance >= amount, "Transfer amount exceeds balance");
-        balanceOf[sender] = senderBalance - amount;
+        uint256 spenderBalance = balanceOf[spender];
+        require(spenderBalance >= amount, "Transfer amount exceeds balance");
+        balanceOf[spender] = spenderBalance - amount;
         balanceOf[recipient] += amount;
-        emit Transfer(sender, recipient, amount);
+        emit Transfer(spender, recipient, amount);
     }
 
     function _approve(

contracts/token/IERC20WithPermit.sol

@@ -51,7 +51,7 @@ interface IERC20WithPermit is IERC20, IERC20Metadata, IApproveAndCall {
     /// @notice Returns the current nonce for EIP2612 permission for the
     ///         provided token owner for a replay protection. Used to construct
     ///         EIP2612 signature provided to `permit` function.
-    function nonces(address owner) external view returns (uint256);
+    function nonce(address owner) external view returns (uint256);
 
     /// @notice Returns EIP2612 Permit message hash. Used to construct EIP2612
     ///         signature provided to `permit` function.

test/token/ERC20WithPermit.test.js

@@ -103,7 +103,7 @@ describe("ERC20WithPermit", () => {
 
   describe("transfer", () => {
     context("when the recipient is not the zero address", () => {
-      context("when the sender does not have enough balance", () => {
+      context("when the spender does not have enough balance", () => {
         const amount = initialSupply.add(1)
 
         it("should revert", async () => {
@@ -113,7 +113,7 @@ describe("ERC20WithPermit", () => {
         })
       })
 
-      context("when the sender transfers all balance", () => {
+      context("when the spender transfers all balance", () => {
         const amount = initialSupply
 
         let tx
@@ -142,7 +142,7 @@ describe("ERC20WithPermit", () => {
         })
       })
 
-      context("when the sender transfers zero tokens", () => {
+      context("when the spender transfers zero tokens", () => {
         const amount = ethers.BigNumber.from(0)
 
         let tx
@@ -401,7 +401,7 @@ describe("ERC20WithPermit", () => {
 
   describe("approve", () => {
     context("when the spender is not the zero address", () => {
-      context("when the sender has enough balance", () => {
+      context("when the spender has enough balance", () => {
         const allowance = initialSupply
 
         it("should emit an approval event", async () => {
@@ -452,7 +452,7 @@ describe("ERC20WithPermit", () => {
         })
       })
 
-      context("when the sender does not have enough balance", () => {
+      context("when the spender does not have enough balance", () => {
         const allowance = initialSupply.add(1)
 
         it("should emit an approval event", async () => {
@@ -729,7 +729,7 @@ describe("ERC20WithPermit", () => {
 
       const domainSeparator = await token.DOMAIN_SEPARATOR()
       const permitTypehash = await token.PERMIT_TYPEHASH()
-      const nonce = await token.nonces(permittingHolder.address)
+      const nonce = await token.nonce(permittingHolder.address)
 
       const approvalDigest = ethers.utils.keccak256(
         ethers.utils.solidityPack(
@@ -816,7 +816,7 @@ describe("ERC20WithPermit", () => {
     })
 
     context("when the spender is not the zero address", () => {
-      context("when the sender has enough balance", () => {
+      context("when the spender has enough balance", () => {
         const allowance = permittingHolderBalance
         it("should emit an approval event", async () => {
           const deadline = tomorrow
@@ -930,7 +930,7 @@ describe("ERC20WithPermit", () => {
         })
       })
 
-      context("when the sender does not have enough balance", () => {
+      context("when the spender does not have enough balance", () => {
         const allowance = permittingHolderBalance.add(1)
         it("should emit an approval event", async () => {
           const deadline = tomorrow