more cleanup

foundry/.env.arbitrum-one.example

@@ -1,5 +1,5 @@
 ETHERSCAN_API_KEY="" # this must be an arbiscan api key
-FOX_TOKEN_ADDRESS=""
+STAKING_TOKEN_ADDRESS=""
 PRIVATE_KEY=""
 RPC_URL="https://arbitrum-mainnet.infura.io/v3/<INFURA_API_KEY>"
 VERIFIER_URL="https://api.arbiscan.io/api"

foundry/.env.arbitrum-sepolia.example

@@ -1,5 +1,5 @@
 ETHERSCAN_API_KEY="" # this must be an arbiscan api key
-FOX_TOKEN_ADDRESS=""
+STAKING_TOKEN_ADDRESS=""
 PRIVATE_KEY=""
 RPC_URL="https://arbitrum-sepolia.infura.io/v3/<INFURA_API_KEY>"
 VERIFIER_URL="https://api-sepolia.arbiscan.io/api"

foundry/.env.local.example

@@ -1,5 +1,5 @@
 ETHERSCAN_API_KEY="not-required"
-FOX_TOKEN_ADDRESS="0xc770EEfAd204B5180dF6a14Ee197D99d808ee52d"
+STAKING_TOKEN_ADDRESS="0xc770EEfAd204B5180dF6a14Ee197D99d808ee52d"
 PRIVATE_KEY=""
 RPC_URL="http://localhost:8545"
 VERIFIER_URL="not-required"

foundry/.env.mainnet.example

@@ -1,5 +1,5 @@
 ETHERSCAN_API_KEY=""
-FOX_TOKEN_ADDRESS="0xc770EEfAd204B5180dF6a14Ee197D99d808ee52d"
+STAKING_TOKEN_ADDRESS="0xc770EEfAd204B5180dF6a14Ee197D99d808ee52d"
 PRIVATE_KEY=""
 RPC_URL="https://mainnet.infura.io/v3/<INFURA_API_KEY>"
 VERIFIER_URL="https://api.etherscan.io/api"

foundry/.env.sepolia.example

@@ -1,5 +1,5 @@
 ETHERSCAN_API_KEY=""
-FOX_TOKEN_ADDRESS=""
+STAKING_TOKEN_ADDRESS=""
 PRIVATE_KEY=""
 RPC_URL="https://sepolia.infura.io/v3/<INFURA_API_KEY>"
 VERIFIER_URL="https://api-sepolia.etherscan.io/api"

foundry/README.md

@@ -5,11 +5,11 @@
 1. Install foundry https://book.getfoundry.sh/getting-started/installation
 2. Install slither `brew install slither-analyzer`
 3. Set up .env files:
-    1. Copy an example .env file for your chosen environment:
-        ```shell
-        cp .env.<your-chosen-env>.example .env.<your-chosen-env>
-        ```
-    2. Fill in the needed env vars there
+   1. Copy an example .env file for your chosen environment:
+      ```shell
+      cp .env.<your-chosen-env>.example .env.<your-chosen-env>
+      ```
+   2. Fill in the needed env vars there
 
 ### Private key
 
@@ -32,7 +32,9 @@ https://faucet.circle.com/
 ## Deploying
 
 ### Local deployment
+
 Deploying locally is different to deploying directly to a network for 2 reasons:
+
 1. Its being deployed to a fork of another network (typically ethereum mainnet) rather than a real network.
 2. There's no local instance of etherscan, so etherscan verification is skipped.
 
@@ -46,7 +48,7 @@ anvil --rpc-url $RPC_URL
 ### Deployment steps
 
 ```shell
-cd foundry 
+cd foundry
 
 # Install
 forge install
@@ -70,5 +72,5 @@ forge verify-contract \
   --compiler-version "v0.8.25" \
   --etherscan-api-key $ARBISCAN_API_KEY \
   $CONTRACT_IMPLEMENTATION_ADDRESS \
-  src/FoxStakingV1.sol:FoxStakingV1
+  src/StakingV1.sol:StakingV1
 ```

foundry/deploy.sh

@@ -35,14 +35,14 @@ forge clean
 
 if [ "$ENVIRONMENT" = "local" ]; then
     # Local environment-specific commands (no etherscan verification)
-    FOX_TOKEN_ADDRESS="$FOX_TOKEN_ADDRESS" forge script script/DeployFoxStaking.s.sol:DeployFoxStaking \
+    STAKING_TOKEN_ADDRESS="$STAKING_TOKEN_ADDRESS" forge script script/DeployStaking.s.sol:DeployStaking \
         --fork-url $RPC_URL  \
         --private-key $PRIVATE_KEY \
         --broadcast \
         -vvvvv
 else
     # All other environments use etherscan verification (which automatically reroutes to arbiscan as needed)
-    FOX_TOKEN_ADDRESS="$FOX_TOKEN_ADDRESS" forge script script/DeployFoxStaking.s.sol:DeployFoxStaking \
+    STAKING_TOKEN_ADDRESS="$STAKING_TOKEN_ADDRESS" forge script script/DeployStaking.s.sol:DeployStaking \
         --rpc-url $RPC_URL  \
         --private-key $PRIVATE_KEY \
         --broadcast \

foundry/script/DeployFoxStaking.s.sol → foundry/script/DeployStaking.s.sol

@@ -7,19 +7,19 @@ import {Upgrades} from "openzeppelin-foundry-upgrades/Upgrades.sol";
 import {StakingV1} from "../src/StakingV1.sol";
 
 contract DeployStaking is Script {
-    address foxTokenAddress;
+    address stakingTokenAddress;
 
     function setUp() public {
-        foxTokenAddress = vm.envAddress("FOX_TOKEN_ADDRESS");
+        stakingTokenAddress = vm.envAddress("STAKING_TOKEN_ADDRESS");
     }
 
     function run() public {
         vm.startBroadcast();
-        address foxStakingProxy = Upgrades.deployUUPSProxy(
+        address stakingProxy = Upgrades.deployUUPSProxy(
             "StakingV1.sol",
-            abi.encodeCall(StakingV1.initialize, (foxTokenAddress))
+            abi.encodeCall(StakingV1.initialize, (stakingTokenAddress))
         );
         vm.stopBroadcast();
-        console.log("Contract deployed at:", foxStakingProxy);
+        console.log("Contract deployed at:", stakingProxy);
     }
 }

foundry/src/StakingV1.sol

@@ -158,10 +158,10 @@ contract StakingV1 is
             info.earnedRewards;
     }
 
-    /// @notice Allows a user to stake a specified amount of FOX tokens and assign a RUNE address for rewards - which can be changed later on.
+    /// @notice Allows a user to stake a specified amount of staking tokens and assign a RUNE address for rewards - which can be changed later on.
     /// This has to be initiated by the user itself i.e msg.sender only, cannot be called by an address for another
-    /// @param amount The amount of FOX tokens to be staked.
-    /// @param runeAddress The RUNE address to be associated with the user's staked FOX position.
+    /// @param amount The amount of staking tokens to be staked.
+    /// @param runeAddress The RUNE address to be associated with the user's staked staking position.
     function stake(
         uint256 amount,
         string memory runeAddress
@@ -170,7 +170,7 @@ contract StakingV1 is
             bytes(runeAddress).length == 43,
             "Rune address must be 43 characters"
         );
-        require(amount > 0, "FOX amount to stake must be greater than 0");
+        require(amount > 0, "amount to stake must be greater than 0");
         updateReward(msg.sender);
         stakingToken.safeTransferFrom(msg.sender, address(this), amount);
 
@@ -182,9 +182,9 @@ contract StakingV1 is
         emit Stake(msg.sender, amount, runeAddress);
     }
 
-    /// @notice Initiates the unstake process for a specified amount of FOX, starting the cooldown period (28 days).
+    /// @notice Initiates the unstake process for a specified amount of staking token, starting the cooldown period (28 days).
     /// This has to be initiated by the user itself i.e msg.sender only, cannot be called by an address for another
-    /// @param amount The amount of FOX tokens to be unstaked.
+    /// @param amount The amount of staking tokens to be unstaked.
     function unstake(
         uint256 amount
     ) external whenNotPaused whenUnstakingNotPaused nonReentrant {
@@ -287,7 +287,7 @@ contract StakingV1 is
 
     /// @notice Allows a user to initially set (or update) their THORChain (RUNE) address for receiving staking rewards.
     /// This has to be initiated by the user itself i.e msg.sender only, cannot be called by an address for another
-    /// @param runeAddress The new RUNE address to be associated with the user's staked FOX position.
+    /// @param runeAddress The new RUNE address to be associated with the user's staked position.
     function setRuneAddress(string memory runeAddress) external {
         require(
             bytes(runeAddress).length == 43,
@@ -299,10 +299,10 @@ contract StakingV1 is
         emit SetRuneAddress(msg.sender, oldRuneAddress, runeAddress);
     }
 
-    /// @notice View the staked balance of FOX tokens for a given address.
+    /// @notice View the staked balance of tokens for a given address.
     /// 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.
+    /// @param account The address we're getting the staked staking balance for.
+    /// @return total The total amount of staking tokens held.
     function balanceOf(address account) external view returns (uint256 total) {
         StakingInfo memory info = stakingInfo[account];
         return info.stakingBalance + info.unstakingBalance;

foundry/test/StakingTestStaking.t.sol

@@ -154,7 +154,7 @@ contract FOXStakingTestStaking is Test {
         vm.assertEq(unstakingBalance, 0);
 
         // Try to stake 0
-        vm.expectRevert("FOX amount to stake must be greater than 0");
+        vm.expectRevert("amount to stake must be greater than 0");
         foxStaking.stake(0, runeAddress);
 
         // Check user staking balances are unchanged