feat: unit improvements

[gomesalexandre]

Description

This PR:

• adds full coverage including all branches
• runs CI on PRs and pushes targeted to develop/main
• uses OZ safeTransfer / safeTransferFrom for transfers

As the current last PR of the stack, also adds some improvements to the contract as noted by @0xean in #2, namely:

Not sure on this one, but do we want to also emit the oldRuneAddress if we are changing it. (#2 (comment))

can we do better than this? I would imagine rune addresses are specific length / number of bytes so we might be able to (#2 (comment))

Issue

• closes smart contract unit tests  #5

Screenshots

[gomesalexandre]

Note this doesn't exit 1 on non-100% coverage unfortunately. Since the output:

Compiling 39 files with 0.8.25
Solc 0.8.25 finished in 2.42s
Compiler run �[32msuccessful!�[0m
Analysing contracts...
Running tests...
| File                  | % Lines         | % Statements    | % Branches      | % Funcs         |
|-----------------------|-----------------|-----------------|-----------------|-----------------|
| src/FoxStaking.sol    | 100.00% (37/37) | 100.00% (38/38) | 100.00% (14/14) | 100.00% (14/14) |
| test/FoxStaking.t.sol | 100.00% (1/1)   | 100.00% (1/1)   | 100.00% (0/0)   | 100.00% (1/1)   |
| Total                 | 100.00% (38/38) | 100.00% (39/39) | 100.00% (14/14) | 100.00% (15/15) |

is more than likely to stay pretty much the same as we're not going to add more contract files/test files, do we want to have some smallish awk/sed/grep script here to exit 1 on non-100% coverage so that CI can fail? e.g something like this (ChatGPT-generated, untested but the idea is to rely on the output being consistent, filter out the irrelevant lines, and ensure both FoxStaking, FoxStaking.t and Total lines are 100.00%.

- name: Check coverage for 100%
  run: |
    forge coverage --report summary | tee coverage.txt
    # Assuming the coverage summary always starts at a known line after "Running tests..."
    tail -n +10 coverage.txt > trimmed_coverage.txt
    if grep -v '100.00%' trimmed_coverage.txt; then
      echo "Not all coverage metrics are 100%"
      exit 1
    else
      echo "All coverage metrics are 100%"
    fi

Alternatively, forge coverage can output lcov which we may be able to use instead

[gomesalexandre]

Re: Using lcov to fail CI on non-100% :sad: :

[woodenfurniture]

We'll likely have more files as our test suites expand, but simply checking the total should be totally sufficient.

Could easily have a brute force check of the test with a regex to assert that any number preceding a % symbol is the string 100.00, which would cover all files regardless of how many we add in the future

[woodenfurniture]

Getting this in to keep things unblocked, will follow up on coverage assertion for CI re this comment
#13 (comment)