Staking rewards

contracts/mocks/ExampleERC20.sol

@@ -13,8 +13,9 @@ import {
     ERC20Burnable,
     ERC20
 } from "@openzeppelin/[email protected]/token/ERC20/extensions/ERC20Burnable.sol";
+import {IERC20Mintable} from "../staking/interfaces/IERC20Mintable.sol";
 
-contract ExampleERC20 is ERC20Burnable {
+contract ExampleERC20 is ERC20Burnable, IERC20Mintable {
     string private constant _TOKEN_NAME = "Mock Token";
     string private constant _TOKEN_SYMBOL = "EXMP";
 
@@ -30,4 +31,8 @@ contract ExampleERC20 is ERC20Burnable {
 
         _mint(msg.sender, amount);
     }
+
+    function mint(address account, uint256 amount) external {
+        _mint(account, amount);
+    }
 }

contracts/staking/ERC20TokenStakingManager.sol

@@ -8,7 +8,7 @@
 import {IERC20TokenStakingManager} from "./interfaces/IERC20TokenStakingManager.sol";
 import {Initializable} from
     "@openzeppelin/[email protected]/proxy/utils/Initializable.sol";
-import {IERC20} from "@openzeppelin/[email protected]/token/ERC20/IERC20.sol";
+import {IERC20Mintable} from "./interfaces/IERC20Mintable.sol";
 import {SafeERC20TransferFrom} from "@utilities/SafeERC20TransferFrom.sol";
 import {SafeERC20} from "@openzeppelin/[email protected]/token/ERC20/utils/SafeERC20.sol";
 import {ICMInitializable} from "../utilities/ICMInitializable.sol";
@@ -20,13 +20,13 @@
     PoSValidatorManager,
     IERC20TokenStakingManager
 {
-    using SafeERC20 for IERC20;
-    using SafeERC20TransferFrom for IERC20;
+    using SafeERC20 for IERC20Mintable;
+    using SafeERC20TransferFrom for IERC20Mintable;
 
     // solhint-disable private-vars-leading-underscore
     /// @custom:storage-location erc7201:avalanche-icm.storage.ERC20TokenStakingManager
     struct ERC20TokenStakingManagerStorage {
-        IERC20 _token;
+        IERC20Mintable _token;
         uint8 _tokenDecimals;
     }
     // solhint-enable private-vars-leading-underscore
@@ -62,26 +62,29 @@
      */
     function initialize(
         PoSValidatorManagerSettings calldata settings,
-        IERC20 token
+        IERC20Mintable token
     ) external reinitializer(2) {
         __ERC20TokenStakingManager_init(settings, token);
     }
 
     // solhint-disable func-name-mixedcase
     function __ERC20TokenStakingManager_init(
         PoSValidatorManagerSettings calldata settings,
-        IERC20 token
+        IERC20Mintable token
     ) internal onlyInitializing {
         __POS_Validator_Manager_init(settings);
         __ERC20TokenStakingManager_init_unchained(token);
     }
 
     // solhint-disable func-name-mixedcase
-    function __ERC20TokenStakingManager_init_unchained(IERC20 token) internal onlyInitializing {
+    function __ERC20TokenStakingManager_init_unchained(IERC20Mintable token)
+        internal
+        onlyInitializing
+    {
         ERC20TokenStakingManagerStorage storage $ = _getERC20StakingManagerStorage();
         require(address(token) != address(0), "ERC20TokenStakingManager: zero token address");
         $._token = token;
     }
 
     /**
      * @notice Begins the validator registration process. Locks the configured ERC20 in the contract as the stake.
@@ -120,4 +123,9 @@
     function _unlock(uint256 value, address to) internal virtual override {
         _getERC20StakingManagerStorage()._token.safeTransfer(to, value);
     }
+
+    function _reward(address account, uint256 amount) internal virtual override {
+        ERC20TokenStakingManagerStorage storage $ = _getERC20StakingManagerStorage();
+        $._token.mint(account, amount);
+    }
 }

contracts/staking/NativeTokenStakingManager.sol

@@ -82,4 +82,9 @@ contract NativeTokenStakingManager is
     function _unlock(uint256 value, address to) internal virtual override {
         payable(to).sendValue(value);
     }
+
+    // solhint-disable-next-line no-empty-blocks
+    function _reward(address account, uint256 amount) internal virtual override {
+        // TODO: call the native minter precompile to mint `amount` for `account`
+    }
 }

contracts/staking/PoSValidatorManager.sol

@@ -98,6 +98,14 @@ abstract contract PoSValidatorManager is IPoSValidatorManager, ValidatorManager
 
     function completeEndValidation(uint32 messageIndex) external {
         Validator memory validator = _completeEndValidation(messageIndex);
+
+        PoSValidatorManagerStorage storage $ = _getPoSValidatorManagerStorage();
+        uint256 rewardAmount = $._rewardCalculator.calculateReward(
+            validator.weight, validator.startedAt, validator.endedAt, 0, 0
+        );
+
+        _reward(validator.owner, rewardAmount);
+
         _unlock(validator.startingWeight, validator.owner);
     }
 
@@ -356,7 +364,11 @@ abstract contract PoSValidatorManager is IPoSValidatorManager, ValidatorManager
 
         Delegator memory delegator = $._delegatorStakes[delegationID];
         _unlock(delegator.weight, delegator.owner);
-        // TODO: issue rewards
+
+        uint256 rewardAmount = $._rewardCalculator.calculateReward(
+            delegator.weight, delegator.startedAt, delegator.endedAt, 0, 0
+        );
+        _reward(delegator.owner, rewardAmount);
 
         emit DelegationEnded(delegationID, validationID, nonce);
     }
@@ -378,4 +390,6 @@ abstract contract PoSValidatorManager is IPoSValidatorManager, ValidatorManager
             "PoSValidatorManager: delegation registration not pending"
         );
     }
+
+    function _reward(address account, uint256 amount) internal virtual;
 }

contracts/staking/interfaces/IERC20Mintable.sol

@@ -0,0 +1,12 @@
+// (c) 2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+// SPDX-License-Identifier: Ecosystem
+
+pragma solidity 0.8.25;
+
+import {IERC20} from "@openzeppelin/[email protected]/token/ERC20/IERC20.sol";
+
+interface IERC20Mintable is IERC20 {
+    function mint(address account, uint256 amount) external;
+}

contracts/staking/tests/ERC20TokenStakingManagerTests.t.sol

@@ -9,24 +9,27 @@ import {PoSValidatorManagerTest} from "./PoSValidatorManagerTests.t.sol";
 import {ERC20TokenStakingManager} from "../ERC20TokenStakingManager.sol";
 import {ValidatorManagerSettings} from "../interfaces/IValidatorManager.sol";
 import {PoSValidatorManagerSettings} from "../interfaces/IPoSValidatorManager.sol";
-import {IRewardCalculator} from "../interfaces/IRewardCalculator.sol";
+import {ExampleRewardCalculator} from "../ExampleRewardCalculator.sol";
 import {ICMInitializable} from "../../utilities/ICMInitializable.sol";
 import {ExampleERC20} from "@mocks/ExampleERC20.sol";
 import {IERC20} from "@openzeppelin/[email protected]/token/ERC20/IERC20.sol";
+import {IERC20Mintable} from "../interfaces/IERC20Mintable.sol";
 import {SafeERC20} from "@openzeppelin/[email protected]/token/ERC20/utils/SafeERC20.sol";
 
 // TODO: Remove this once all unit tests implemented
 // solhint-disable no-empty-blocks
 contract ERC20TokenStakingManagerTest is PoSValidatorManagerTest {
-    using SafeERC20 for IERC20;
+    using SafeERC20 for IERC20Mintable;
 
     ERC20TokenStakingManager public app;
-    IERC20 public token;
+    IERC20Mintable public token;
+    ExampleRewardCalculator public rewardCalculator;
 
     function setUp() public virtual {
         // Construct the object under test
         app = new ERC20TokenStakingManager(ICMInitializable.Allowed);
         token = new ExampleERC20();
+        rewardCalculator = new ExampleRewardCalculator(DEFAULT_REWARD_RATE);
         app.initialize(
             PoSValidatorManagerSettings({
                 baseSettings: ValidatorManagerSettings({
@@ -37,7 +40,7 @@ contract ERC20TokenStakingManagerTest is PoSValidatorManagerTest {
                 minimumStakeAmount: DEFAULT_MINIMUM_STAKE,
                 maximumStakeAmount: DEFAULT_MAXIMUM_STAKE,
                 minimumStakeDuration: DEFAULT_MINIMUM_STAKE_DURATION,
-                rewardCalculator: IRewardCalculator(address(0))
+                rewardCalculator: rewardCalculator
             }),
             token
         );
@@ -83,6 +86,10 @@ contract ERC20TokenStakingManagerTest is PoSValidatorManagerTest {
         vm.expectCall(address(token), abi.encodeCall(IERC20.transfer, (account, amount)));
     }
 
+    function _expectRewardIssuance(address account, uint256 amount) internal override {
+        vm.expectCall(address(token), abi.encodeCall(IERC20Mintable.mint, (account, amount)));
+    }
+
     function _getStakeAssetBalance(address account) internal view override returns (uint256) {
         return token.balanceOf(account);
     }

contracts/staking/tests/NativeTokenStakingManagerTests.t.sol

@@ -10,6 +10,7 @@ import {NativeTokenStakingManager} from "../NativeTokenStakingManager.sol";
 import {ValidatorManagerSettings} from "../interfaces/IValidatorManager.sol";
 import {PoSValidatorManagerSettings} from "../interfaces/IPoSValidatorManager.sol";
 import {IRewardCalculator} from "../interfaces/IRewardCalculator.sol";
+import {ExampleRewardCalculator} from "../ExampleRewardCalculator.sol";
 import {ICMInitializable} from "../../utilities/ICMInitializable.sol";
 
 // TODO: Remove this once all unit tests implemented
@@ -30,13 +31,25 @@ contract NativeTokenStakingManagerTest is PoSValidatorManagerTest {
                 minimumStakeAmount: DEFAULT_MINIMUM_STAKE,
                 maximumStakeAmount: DEFAULT_MAXIMUM_STAKE,
                 minimumStakeDuration: DEFAULT_MINIMUM_STAKE_DURATION,
-                rewardCalculator: IRewardCalculator(address(0))
+                rewardCalculator: IRewardCalculator(new ExampleRewardCalculator(DEFAULT_REWARD_RATE))
             })
         );
         validatorManager = app;
         posValidatorManager = app;
     }
 
+    function testCompleteEndValidation() public override {
+        // TODO: get native token staking rewards working, then remove this
+        // method and let the implementation in PosValidatorManagerTests do the
+        // test, and remove the `virtual` modifier from that implementation.
+    }
+
+    function testCompleteEndDelegation() public override {
+        // TODO: get native token staking rewards working, then remove this
+        // method and let the implementation in PosValidatorManagerTests do the
+        // test, and remove the `virtual` modifier from that implementation.
+    }
+
     // Helpers
     function _initializeValidatorRegistration(
         bytes32 nodeID,
@@ -69,6 +82,8 @@ contract NativeTokenStakingManagerTest is PoSValidatorManagerTest {
         vm.expectCall(account, amount, "");
     }
 
+    function _expectRewardIssuance(address account, uint256 amount) internal override {}
+
     function _getStakeAssetBalance(address account) internal view override returns (uint256) {
         return account.balance;
     }

contracts/staking/tests/PoSValidatorManagerTests.t.sol

@@ -21,6 +21,7 @@ abstract contract PoSValidatorManagerTest is ValidatorManagerTest {
     uint64 public constant DEFAULT_DELEGATOR_END_DELEGATION_TIMESTAMP = uint64(4000);
     address public constant DEFAULT_DELEGATOR_ADDRESS =
         address(0x1234123412341234123412341234123412341234);
+    uint64 public constant DEFAULT_REWARD_RATE = uint64(10);
 
     PoSValidatorManager public posValidatorManager;
 
@@ -371,14 +372,18 @@ abstract contract PoSValidatorManagerTest is ValidatorManagerTest {
         posValidatorManager.resendEndDelegation(delegationID);
     }
 
-    function testCompleteEndDelegation() public {
+    function testCompleteEndDelegation() public virtual {
+        uint256 registrationDuration = 1000 * 60 * 60 * 24; // 1 day
+
+        uint256 registrationExpiry = vm.getBlockTimestamp() + registrationDuration;
+
         bytes32 validationID = _setUpCompleteValidatorRegistration({
             nodeID: DEFAULT_NODE_ID,
             subnetID: DEFAULT_SUBNET_ID,
             weight: DEFAULT_WEIGHT,
-            registrationExpiry: DEFAULT_EXPIRY,
+            registrationExpiry: uint64(registrationExpiry),
             blsPublicKey: DEFAULT_BLS_PUBLIC_KEY,
-            registrationTimestamp: DEFAULT_REGISTRATION_TIMESTAMP
+            registrationTimestamp: uint64(registrationExpiry)
         });
         bytes32 delegationID = _setUpInitializeDelegatorRegistration({
             validationID: validationID,
@@ -388,32 +393,34 @@ abstract contract PoSValidatorManagerTest is ValidatorManagerTest {
             expectedValidatorWeight: DEFAULT_DELEGATOR_WEIGHT + DEFAULT_WEIGHT,
             expectedNonce: 1
         });
-        _setUpCompleteDelegatorRegistration(
-            validationID,
-            delegationID,
-            DEFAULT_DELEGATOR_COMPLETE_REGISTRATION_TIMESTAMP,
-            DEFAULT_DELEGATOR_WEIGHT + DEFAULT_WEIGHT,
-            1
-        );
+        _setUpCompleteDelegatorRegistration({
+            validationID: validationID,
+            delegationID: delegationID,
+            completeRegistrationTimestamp: DEFAULT_DELEGATOR_COMPLETE_REGISTRATION_TIMESTAMP,
+            expectedValidatorWeight: DEFAULT_DELEGATOR_WEIGHT + DEFAULT_WEIGHT,
+            expectedNonce: 1
+        });
         _setUpInitializeEndDelegation({
             validationID: validationID,
             delegatorAddress: DEFAULT_DELEGATOR_ADDRESS,
             delegationID: delegationID,
-            endDelegationTimestamp: DEFAULT_DELEGATOR_END_DELEGATION_TIMESTAMP,
+            endDelegationTimestamp: uint64(registrationExpiry),
             expectedValidatorWeight: DEFAULT_WEIGHT,
             expectedNonce: 2
         });
 
         address delegator = DEFAULT_DELEGATOR_ADDRESS;
         uint256 balanceBefore = _getStakeAssetBalance(delegator);
+        uint256 expectedReward = DEFAULT_DELEGATOR_WEIGHT * DEFAULT_REWARD_RATE / 365;
         _expectStakeUnlock(delegator, DEFAULT_DELEGATOR_WEIGHT);
+        _expectRewardIssuance(delegator, expectedReward);
 
         _setUpCompleteEndDelegation(validationID, delegationID, DEFAULT_WEIGHT, DEFAULT_WEIGHT, 2);
 
         uint256 balanceChange = _getStakeAssetBalance(delegator) - balanceBefore;
         require(
-            balanceChange >= DEFAULT_DELEGATOR_WEIGHT,
-            "delegator should have received their stake back"
+            balanceChange == DEFAULT_DELEGATOR_WEIGHT + expectedReward,
+            "delegator should have received their stake back and been rewarded"
         );
     }
 
@@ -557,25 +564,35 @@ abstract contract PoSValidatorManagerTest is ValidatorManagerTest {
         _setUpCompleteEndDelegation(validationID, delegationID1, DEFAULT_WEIGHT, DEFAULT_WEIGHT, 4);
     }
 
-    function testCompleteEndValidation() public override {
+    function testCompleteEndValidation() public virtual override {
+        uint256 registrationDuration = 1000 * 60 * 60 * 24; // 1 day
+
+        uint256 registrationExpiry = vm.getBlockTimestamp() + registrationDuration;
+
         bytes32 validationID = _setUpInitializeEndValidation({
             nodeID: DEFAULT_NODE_ID,
             subnetID: DEFAULT_SUBNET_ID,
             weight: DEFAULT_WEIGHT,
-            registrationExpiry: DEFAULT_EXPIRY,
+            registrationExpiry: uint64(registrationExpiry),
             blsPublicKey: DEFAULT_BLS_PUBLIC_KEY,
             registrationTimestamp: DEFAULT_REGISTRATION_TIMESTAMP,
-            completionTimestamp: DEFAULT_COMPLETION_TIMESTAMP
+            completionTimestamp: uint64(registrationExpiry)
         });
 
         uint256 balanceBefore = _getStakeAssetBalance(address(this));
 
+        uint256 expectedReward = DEFAULT_WEIGHT * DEFAULT_REWARD_RATE / 365 - 1;
+
         _expectStakeUnlock(address(this), DEFAULT_WEIGHT);
+        _expectRewardIssuance(address(this), expectedReward);
 
         _testCompleteEndValidation(validationID);
 
         uint256 balanceChange = _getStakeAssetBalance(address(this)) - balanceBefore;
-        require(balanceChange == DEFAULT_WEIGHT, "validator should have received their stake back");
+        require(
+            balanceChange == DEFAULT_WEIGHT + expectedReward,
+            "validator should have received their stake back and been rewarded"
+        );
     }
 
     function testValueToWeight() public view {
@@ -713,6 +730,7 @@ abstract contract PoSValidatorManagerTest is ValidatorManagerTest {
 
     function _getStakeAssetBalance(address account) internal virtual returns (uint256);
     function _expectStakeUnlock(address account, uint256 amount) internal virtual;
+    function _expectRewardIssuance(address account, uint256 amount) internal virtual;
 
     function _formatErrorMessage(bytes memory errorMessage) internal pure returns (bytes memory) {
         return abi.encodePacked("PoSValidatorManager: ", errorMessage);

scripts/abi_bindings.sh

@@ -16,7 +16,7 @@ export ARCH=$(uname -m)
 [ $ARCH = x86_64 ] && ARCH=amd64
 echo "ARCH set to $ARCH"
 
-DEFAULT_CONTRACT_LIST="TeleporterMessenger TeleporterRegistry ExampleERC20 TestMessenger ValidatorSetSig NativeTokenStakingManager ERC20TokenStakingManager PoAValidatorManager"
+DEFAULT_CONTRACT_LIST="TeleporterMessenger TeleporterRegistry ExampleERC20 ExampleRewardCalculator TestMessenger ValidatorSetSig NativeTokenStakingManager ERC20TokenStakingManager PoAValidatorManager"
 
 PROXY_LIST="TransparentUpgradeableProxy ProxyAdmin"