feat: unit improvements

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Initial linting
+1696c504527d64d9b22cefe03e38ac1f41c90268

.github/workflows/foundry.yml

@@ -1,6 +1,11 @@
-name: test
+name: Foundry
 
-on: workflow_dispatch
+on:
+  workflow_dispatch:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
 
 env:
   FOUNDRY_PROFILE: ci
@@ -22,9 +27,7 @@ jobs:
           submodules: recursive
 
       - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
-        with:
-          version: nightly
+        uses: foundry-rs/foundry-toolchain@v1.2.0
 
       - name: Run Forge build
         run: |
@@ -36,3 +39,7 @@ jobs:
         run: |
           forge test -vvv
         id: test
+      - name: Generate coverage report
+        run: |
+          forge coverage --report summary
+        id: coverage

.prettierrc

@@ -0,0 +1,16 @@
+{
+  "plugins": ["prettier-plugin-solidity"],
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "parser": "solidity-parse",
+        "printWidth": 80,
+        "tabWidth": 4,
+        "useTabs": false,
+        "singleQuote": false,
+        "bracketSpacing": false
+      }
+    }
+  ]
+}

foundry/src/FoxStaking.sol

@@ -5,13 +5,14 @@ import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
 import {Pausable} from "@openzeppelin/contracts/utils/Pausable.sol";
 import {IFoxStaking, StakingInfo} from "./IFoxStaking.sol";
-import {console} from "forge-std/Script.sol";
+import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 contract FoxStaking is
     IFoxStaking,
     Ownable(msg.sender), // Deployer is the owner
     Pausable
 {
+    using SafeERC20 for IERC20;
     IERC20 public foxToken;
     mapping(address => StakingInfo) public stakingInfo;
 
@@ -32,6 +33,7 @@ contract FoxStaking is
     event Withdraw(address indexed account, uint256 amount);
     event SetRuneAddress(
         address indexed account,
+        string indexed oldRuneAddress,
         string indexed newRuneAddress
     );
 
@@ -95,13 +97,12 @@ contract FoxStaking is
         uint256 amount,
         string memory runeAddress
     ) external whenNotPaused whenStakingNotPaused {
-        require(bytes(runeAddress).length > 0, "Rune address cannot be empty");
-        require(amount > 0, "FOX amount to stake must be greater than 0");
-        // Transfer fundus from msg.sender to contract assuming allowance has been set - here goes nothing
         require(
-            foxToken.transferFrom(msg.sender, address(this), amount),
-            "Transfer failed"
+            bytes(runeAddress).length == 43,
+            "Rune address must be 43 characters"
         );
+        require(amount > 0, "FOX amount to stake must be greater than 0");
+        foxToken.safeTransferFrom(msg.sender, address(this), amount);
 
         StakingInfo storage info = stakingInfo[msg.sender];
         info.stakingBalance += amount;
@@ -138,17 +139,19 @@ contract FoxStaking is
         require(block.timestamp >= info.cooldownExpiry, "Not cooled down yet");
         uint256 withdrawAmount = info.unstakingBalance;
         info.unstakingBalance = 0;
-        require(
-            foxToken.transfer(msg.sender, withdrawAmount),
-            "Transfer failed"
-        );
+        foxToken.safeTransfer(msg.sender, withdrawAmount);
         emit Withdraw(msg.sender, withdrawAmount);
     }
 
     function setRuneAddress(string memory runeAddress) external {
+        require(
+            bytes(runeAddress).length == 43,
+            "Rune address must be 43 characters"
+        );
         StakingInfo storage info = stakingInfo[msg.sender];
+        string memory oldRuneAddress = info.runeAddress;
         info.runeAddress = runeAddress;
-        emit SetRuneAddress(msg.sender, runeAddress);
+        emit SetRuneAddress(msg.sender, oldRuneAddress, runeAddress);
     }
 
     function balanceOf(address account) external view returns (uint256 total) {

foundry/src/IFoxStaking.sol

@@ -2,13 +2,12 @@
 pragma solidity ^0.8.25;
 
 struct StakingInfo {
-  uint256 stakingBalance;
-  uint256 unstakingBalance;
-  uint256 cooldownExpiry;
-  string runeAddress;
+    uint256 stakingBalance;
+    uint256 unstakingBalance;
+    uint256 cooldownExpiry;
+    string runeAddress;
 }
 
-
 /// @notice This interface outlines the functions for staking FOX tokens, managing RUNE addresses for rewards, and claiming 'em.
 interface IFoxStaking {
     /// @notice Pauses deposits
@@ -59,7 +58,5 @@ interface IFoxStaking {
     /// This can be initiated by any address with any address as param, as this has view modifier i.e everything is public on-chain
     /// @param account The address we're getting the staked FOX balance for.
     /// @return total The total amount of FOX tokens held.
-    function balanceOf(
-        address account
-    ) external view returns (uint256 total);
+    function balanceOf(address account) external view returns (uint256 total);
 }