feat: add test and rename error arg (#62)

Author: heueristik

src/XanV1.sol

@@ -55,7 +55,7 @@ contract XanV1 is
     bytes32 internal constant _XAN_V1_STORAGE_LOCATION =
         0x52f7d5fb153315ca313a5634db151fa7e0b41cd83fe6719e93ed3cd02b69d200;
 
-    error UnlockedBalanceInsufficient(address sender, uint256 unlockedBalance, uint256 valueToLock);
+    error UnlockedBalanceInsufficient(address sender, uint256 unlockedBalance, uint256 requested);
     error LockedBalanceInsufficient(address sender, uint256 lockedBalance);
 
     error ImplementationZero();
@@ -370,11 +370,7 @@ contract XanV1 is
             uint256 unlockedBalance = unlockedBalanceOf(from);
 
             if (value > unlockedBalance) {
-                revert UnlockedBalanceInsufficient({ // force linebreak
-                    sender: from,
-                    unlockedBalance: unlockedBalance,
-                    valueToLock: value
-                });
+                revert UnlockedBalanceInsufficient({sender: from, unlockedBalance: unlockedBalance, requested: value});
             }
         }
 
@@ -389,7 +385,7 @@ contract XanV1 is
 
         uint256 unlockedBalance = unlockedBalanceOf(account);
         if (value > unlockedBalance) {
-            revert UnlockedBalanceInsufficient({sender: account, unlockedBalance: unlockedBalance, valueToLock: value});
+            revert UnlockedBalanceInsufficient({sender: account, unlockedBalance: unlockedBalance, requested: value});
         }
 
         data.lockedSupply += value;

test/XanV1.erc20.t.sol

@@ -0,0 +1,101 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+pragma solidity ^0.8.30;
+
+import {Upgrades, UnsafeUpgrades} from "@openzeppelin/foundry-upgrades/Upgrades.sol";
+import {Test} from "forge-std/Test.sol";
+
+import {MockXanV1, XanV1} from "./mocks/XanV1.m.sol";
+
+contract MockXanV1ERC20Test is Test {
+    using UnsafeUpgrades for address;
+
+    address internal constant _COUNCIL = address(uint160(1));
+
+    address internal _alice;
+    address internal _bob;
+    MockXanV1 internal _xanProxyMock;
+
+    function setUp() public {
+        (, _alice,) = vm.readCallers();
+
+        // Deploy proxy and mint tokens for the `_tokenHolder`.
+        vm.prank(_alice);
+        _xanProxyMock = MockXanV1(
+            Upgrades.deployUUPSProxy({
+                contractName: "XanV1.m.sol:MockXanV1",
+                initializerData: abi.encodeCall(XanV1.initializeV1, (_alice, _COUNCIL))
+            })
+        );
+
+        _bob = vm.randomAddress();
+    }
+
+    function test_update_MINT_does_not_require_address_0_to_hold_unlocked_tokens() public {
+        address from = address(0);
+        address to = _bob;
+        uint256 value = 100;
+
+        assertEq(_xanProxyMock.balanceOf(from), 0);
+        assertEq(_xanProxyMock.unlockedBalanceOf(from), 0);
+        uint256 toBalanceBeforeUpdate = _xanProxyMock.unlockedBalanceOf(to);
+
+        _xanProxyMock.update({from: from, to: to, value: value});
+
+        assertEq(_xanProxyMock.balanceOf(from), 0);
+        assertEq(_xanProxyMock.unlockedBalanceOf(from), 0);
+        assertEq(_xanProxyMock.balanceOf(to), toBalanceBeforeUpdate + value);
+    }
+
+    function test_update_TRANSFER_reverts_transfer_if_the_from_address_has_insufficient_unlocked_tokens() public {
+        address from = _bob;
+        address to = _alice;
+        uint256 value = 100;
+
+        assertEq(_xanProxyMock.balanceOf(from), 0);
+        assertEq(_xanProxyMock.unlockedBalanceOf(from), 0);
+
+        vm.expectRevert(
+            abi.encodeWithSelector(XanV1.UnlockedBalanceInsufficient.selector, from, 0, value), address(_xanProxyMock)
+        );
+        _xanProxyMock.update({from: from, to: to, value: value});
+    }
+
+    function test_update_TRANSFER_updates_if_the_from_address_has_sufficient_unlocked_tokens() public {
+        address from = _alice;
+        address to = _bob;
+        uint256 value = 100;
+
+        uint256 fromBalanceBeforeUpdate = _xanProxyMock.unlockedBalanceOf(from);
+        uint256 toBalanceBeforeUpdate = _xanProxyMock.unlockedBalanceOf(to);
+
+        _xanProxyMock.update({from: from, to: to, value: value});
+
+        assertEq(_xanProxyMock.balanceOf(from), fromBalanceBeforeUpdate - value);
+        assertEq(_xanProxyMock.balanceOf(to), toBalanceBeforeUpdate + value);
+    }
+
+    function test_update_BURN_reverts_if_the_from_address_has_unsufficient_unlocked_tokens() public {
+        address from = _bob;
+        address to = address(0);
+        uint256 value = 100;
+
+        vm.expectRevert(
+            abi.encodeWithSelector(XanV1.UnlockedBalanceInsufficient.selector, from, 0, value), address(_xanProxyMock)
+        );
+        _xanProxyMock.update({from: from, to: to, value: value});
+    }
+
+    function test_update_BURN_updates_if_the_from_address_has_sufficient_unlocked_tokens() public {
+        address from = _alice;
+        address to = address(0);
+        uint256 value = 100;
+
+        uint256 fromBalanceBeforeUpdate = _xanProxyMock.unlockedBalanceOf(from);
+        assertEq(_xanProxyMock.unlockedBalanceOf(to), 0);
+
+        _xanProxyMock.update({from: from, to: to, value: value});
+
+        assertEq(_xanProxyMock.balanceOf(from), fromBalanceBeforeUpdate - value);
+        assertEq(_xanProxyMock.balanceOf(to), 0);
+    }
+}

test/mocks/XanV1.m.sol

@@ -6,6 +6,10 @@ import {XanV1} from "../../src/XanV1.sol";
 /// @notice This mock makes internal functions of the XanV1 token accessible to external callers.
 /// @custom:oz-upgrades-unsafe-allow missing-initializer
 contract MockXanV1 is XanV1 {
+    function update(address from, address to, uint256 value) external {
+        XanV1._update({from: from, to: to, value: value});
+    }
+
     function isQuorumAndMinLockedSupplyReached(address impl) external view returns (bool isReached) {
         isReached = _isQuorumAndMinLockedSupplyReached(impl);
     }