@bananapus/distributor-v6 0.0.3 → 0.0.5

package/src/JBDistributor.sol

@@ -13,45 +13,56 @@ import {JBVestingData} from "./structs/JBVestingData.sol";
 /// @notice A contract managing distributions of tokens to be claimed and vested by stakers of any other token.
 abstract contract JBDistributor is IJBDistributor {
     using SafeERC20 for IERC20;
+
     //*********************************************************************//
     // --------------------------- custom errors ------------------------- //
     //*********************************************************************//
 
-    /// @notice Thrown when a token has already begun vesting for a given round.
-    error JBDistributor_AlreadyVesting();
+    /// @notice Thrown when an empty tokenIds array is passed.
+    error JBDistributor_EmptyTokenIds();
 
     /// @notice Thrown when a native ETH transfer fails.
     error JBDistributor_NativeTransferFailed();
 
+    /// @notice Thrown when the caller does not have access to the token.
+    error JBDistributor_NoAccess();
+
     /// @notice Thrown when there is nothing to distribute for a token in the current round.
     error JBDistributor_NothingToDistribute();
 
-    /// @notice Thrown when the caller does not have access to the token.
-    error JBDistributor_NoAccess();
+    //*********************************************************************//
+    // ------------------------- public constants ------------------------ //
+    //*********************************************************************//
+
+    /// @notice The number of shares that represent 100%.
+    uint256 public constant MAX_SHARE = 100_000;
 
     //*********************************************************************//
     // ---------------- public immutable stored properties --------------- //
     //*********************************************************************//
 
-    /// @notice The starting block of the distributor.
-    uint256 public immutable startingBlock;
-
-    /// @notice The minimum amount of time stakers have to claim rewards, specified in blocks.
+    /// @notice The duration of each round, specified in seconds.
     uint256 public immutable override roundDuration;
 
+    /// @notice The starting timestamp of the distributor.
+    uint256 public immutable startingTimestamp;
+
     /// @notice The number of rounds until tokens are fully vested.
     uint256 public immutable override vestingRounds;
 
     //*********************************************************************//
-    // --------------------- public constant properties  ----------------- //
+    // --------------------- public stored properties -------------------- //
     //*********************************************************************//
 
-    /// @notice The number of shares that represent 100%.
-    uint256 public constant MAX_SHARE = 100_000;
+    /// @notice The index within `vestingDataOf` of the latest vest.
+    /// @custom:param hook The hook the tokenId belongs to.
+    /// @custom:param tokenId The ID of the token to which the vests belong.
+    /// @custom:param token The address of the token being vested.
+    mapping(address hook => mapping(uint256 tokenId => mapping(IERC20 token => uint256))) public latestVestedIndexOf;
 
-    //*********************************************************************//
-    // --------------------- public stored properties -------------------- //
-    //*********************************************************************//
+    /// @notice The block number recorded as the snapshot point for each round.
+    /// @dev Set to `block.number - 1` on first interaction in a round, so that `IVotes.getPastVotes` works.
+    mapping(uint256 round => uint256) public override roundSnapshotBlock;
 
     /// @notice The amount of a token that is currently vesting for a hook's stakers.
     /// @custom:param hook The hook whose stakers are vesting.
@@ -65,14 +76,8 @@ abstract contract JBDistributor is IJBDistributor {
     // slither-disable-next-line uninitialized-state
     mapping(address hook => mapping(uint256 tokenId => mapping(IERC20 token => JBVestingData[]))) public vestingDataOf;
 
-    /// @notice The index within `vestingDataOf` of the latest vest.
-    /// @custom:param hook The hook the tokenId belongs to.
-    /// @custom:param tokenId The ID of the token to which the vests belong.
-    /// @custom:param token The address of the token being vested.
-    mapping(address hook => mapping(uint256 tokenId => mapping(IERC20 token => uint256))) public latestVestedIndexOf;
-
     //*********************************************************************//
-    // ------------------------ internal properties ---------------------- //
+    // -------------------- internal stored properties ------------------- //
     //*********************************************************************//
 
     /// @notice The balance of a token held for a specific hook's stakers.
@@ -88,42 +93,123 @@ abstract contract JBDistributor is IJBDistributor {
         _snapshotAtRoundOf;
 
     //*********************************************************************//
-    // -------------------------- public views --------------------------- //
+    // -------------------------- constructor ---------------------------- //
     //*********************************************************************//
 
-    /// @notice The number of the current round.
-    function currentRound() public view override returns (uint256) {
-        return (block.number - startingBlock) / roundDuration;
+    /// @param roundDuration_ The duration of each round, specified in seconds.
+    /// @param vestingRounds_ The number of rounds until tokens are fully vested.
+    constructor(uint256 roundDuration_, uint256 vestingRounds_) {
+        startingTimestamp = block.timestamp;
+        roundDuration = roundDuration_;
+        vestingRounds = vestingRounds_;
+    }
+
+    //*********************************************************************//
+    // ---------------------- external transactions ---------------------- //
+    //*********************************************************************//
+
+    /// @notice Claims tokens and begins vesting.
+    /// @param hook The hook whose stakers are vesting.
+    /// @param tokenIds The IDs to claim rewards for.
+    /// @param tokens The tokens to claim.
+    function beginVesting(address hook, uint256[] calldata tokenIds, IERC20[] calldata tokens) external override {
+        // Revert if no token IDs are provided.
+        if (tokenIds.length == 0) revert JBDistributor_EmptyTokenIds();
+
+        // Keep a reference to the current round.
+        uint256 round = currentRound();
+
+        // Ensure the snapshot block is recorded for this round.
+        _ensureSnapshotBlock(round);
+
+        // Keep a reference to the total staked amount at the snapshot block.
+        uint256 totalStakeAmount = _totalStake(hook, roundSnapshotBlock[round]);
+
+        // Skip vesting when there are no stakers — funds carry over to the next round.
+        // slither-disable-next-line incorrect-equality
+        if (totalStakeAmount == 0) return;
+
+        // Loop through each token for which vesting is beginning.
+        for (uint256 i; i < tokens.length;) {
+            IERC20 token = tokens[i];
+
+            // Take a snapshot of the token balance if it hasn't been taken already.
+            JBTokenSnapshotData memory snapshot = _takeSnapshotOf(hook, token);
+            uint256 distributable = snapshot.balance - snapshot.vestingAmount;
+
+            // Revert if there is nothing to distribute for this token.
+            if (distributable == 0) revert JBDistributor_NothingToDistribute();
+
+            // Vest each token ID and get the total amount vested.
+            uint256 totalVestingAmount =
+                _vestTokenIds(hook, tokenIds, token, distributable, totalStakeAmount, round + vestingRounds);
+
+            unchecked {
+                // Store the updated total claimed amount now vesting.
+                totalVestingAmountOf[hook][token] += totalVestingAmount;
+
+                ++i;
+            }
+        }
     }
 
-    /// @notice The block at which a round started.
-    /// @param round The round to get the start block of.
-    function roundStartBlock(uint256 round) public view override returns (uint256) {
-        return startingBlock + roundDuration * round;
+    /// @notice Fund the distributor for a specific hook by pulling tokens from the caller.
+    /// @dev For native ETH, send `msg.value` and pass `IERC20(JBConstants.NATIVE_TOKEN)` as the token.
+    /// @param hook The hook to fund.
+    /// @param token The token to fund with.
+    /// @param amount The amount to fund.
+    function fund(address hook, IERC20 token, uint256 amount) external payable override {
+        if (address(token) == JBConstants.NATIVE_TOKEN) {
+            amount = msg.value;
+        } else {
+            // Use balance delta to handle fee-on-transfer tokens correctly.
+            uint256 balanceBefore = token.balanceOf(address(this));
+            token.safeTransferFrom(msg.sender, address(this), amount);
+            amount = token.balanceOf(address(this)) - balanceBefore;
+        }
+        _balanceOf[hook][token] += amount;
     }
 
-    /// @notice The balance of a token held for a specific hook's stakers.
-    /// @param hook The hook whose balance to check.
-    /// @param token The token to check the balance of.
-    function balanceOf(address hook, IERC20 token) external view override returns (uint256) {
-        return _balanceOf[hook][token];
+    /// @notice Record the snapshot block for the current round. Callable by anyone (keepers, frontends).
+    function poke() external override {
+        _ensureSnapshotBlock(currentRound());
     }
 
-    /// @notice The snapshot data of the token information for each round.
-    /// @param hook The hook the snapshot is for.
-    /// @param token The address of the token being claimed and vested.
-    /// @param round The round to which the data applies.
-    function snapshotAtRoundOf(
+    /// @notice Release vested rewards in the case that a token was burned.
+    /// @param hook The hook whose tokens were burned.
+    /// @param tokenIds The IDs of the burned tokens.
+    /// @param tokens The address of the tokens being released.
+    /// @param beneficiary The recipient of the released tokens.
+    function releaseForfeitedRewards(
         address hook,
-        IERC20 token,
-        uint256 round
+        uint256[] calldata tokenIds,
+        IERC20[] calldata tokens,
+        address beneficiary
     )
         external
-        view
         override
-        returns (JBTokenSnapshotData memory)
     {
-        return _snapshotAtRoundOf[hook][token][round];
+        // Make sure that all tokens are burned.
+        for (uint256 i; i < tokenIds.length;) {
+            if (!_tokenBurned(hook, tokenIds[i])) revert JBDistributor_NoAccess();
+            unchecked {
+                ++i;
+            }
+        }
+
+        // Unlock the rewards and send them to the beneficiary.
+        _unlockRewards(hook, tokenIds, tokens, beneficiary, false);
+    }
+
+    //*********************************************************************//
+    // ----------------------- external views ---------------------------- //
+    //*********************************************************************//
+
+    /// @notice The balance of a token held for a specific hook's stakers.
+    /// @param hook The hook whose balance to check.
+    /// @param token The token to check the balance of.
+    function balanceOf(address hook, IERC20 token) external view override returns (uint256) {
+        return _balanceOf[hook][token];
     }
 
     /// @notice Calculate how much of the token has been claimed for the given tokenId.
@@ -202,161 +288,43 @@ abstract contract JBDistributor is IJBDistributor {
         }
     }
 
-    //*********************************************************************//
-    // -------------------------- constructor ---------------------------- //
-    //*********************************************************************//
-
-    /// @param roundDuration_ The minimum amount of time stakers have to claim rewards, specified in blocks. Make sure
-    /// this is correct for each blockchain/rollup this gets deployed to.
-    /// @param vestingRounds_ The number of rounds until tokens are fully vested.
-    constructor(uint256 roundDuration_, uint256 vestingRounds_) {
-        startingBlock = block.number;
-        roundDuration = roundDuration_;
-        vestingRounds = vestingRounds_;
-    }
-
-    //*********************************************************************//
-    // ---------------------- external transactions ---------------------- //
-    //*********************************************************************//
-
-    /// @notice Fund the distributor for a specific hook by pulling tokens from the caller.
-    /// @dev For native ETH, send `msg.value` and pass `IERC20(JBConstants.NATIVE_TOKEN)` as the token.
-    /// @param hook The hook to fund.
-    /// @param token The token to fund with.
-    /// @param amount The amount to fund.
-    function fund(address hook, IERC20 token, uint256 amount) external payable override {
-        if (address(token) == JBConstants.NATIVE_TOKEN) {
-            amount = msg.value;
-        } else {
-            // Use balance delta to handle fee-on-transfer tokens correctly.
-            uint256 balanceBefore = token.balanceOf(address(this));
-            token.safeTransferFrom(msg.sender, address(this), amount);
-            amount = token.balanceOf(address(this)) - balanceBefore;
-        }
-        _balanceOf[hook][token] += amount;
-    }
-
-    /// @notice Claims tokens and begins vesting.
-    /// @param hook The hook whose stakers are vesting.
-    /// @param tokenIds The IDs to claim rewards for.
-    /// @param tokens The tokens to claim.
-    function beginVesting(address hook, uint256[] calldata tokenIds, IERC20[] calldata tokens) external override {
-        // Keep a reference to the current round.
-        uint256 round = currentRound();
-
-        // Keep a reference to the total staked amount at the current round.
-        uint256 totalStakeAmount = _totalStake(hook, roundStartBlock(round));
-
-        // Loop through each token for which vesting is beginning.
-        for (uint256 i; i < tokens.length;) {
-            IERC20 token = tokens[i];
-
-            // Take a snapshot of the token balance if it hasn't been taken already.
-            JBTokenSnapshotData memory snapshot = _takeSnapshotOf(hook, token);
-            uint256 distributable = snapshot.balance - snapshot.vestingAmount;
-
-            // Revert if there is nothing to distribute for this token.
-            if (distributable == 0) revert JBDistributor_NothingToDistribute();
-
-            // Vest each token ID and get the total amount vested.
-            uint256 totalVestingAmount =
-                _vestTokenIds(hook, tokenIds, token, distributable, totalStakeAmount, round + vestingRounds);
-
-            unchecked {
-                // Store the updated total claimed amount now vesting.
-                totalVestingAmountOf[hook][token] += totalVestingAmount;
-
-                ++i;
-            }
-        }
-    }
-
-    /// @notice Vests each token ID for a given reward token and returns the total amount vested.
-    /// @param hook The hook whose stakers are vesting.
-    /// @param tokenIds The IDs to claim rewards for.
-    /// @param token The reward token.
-    /// @param distributable The distributable amount for this round.
-    /// @param totalStakeAmount The total stake amount.
-    /// @param vestingReleaseRound The round at which vesting will be released.
-    /// @return totalVestingAmount The total amount that began vesting.
-    function _vestTokenIds(
+    /// @notice The snapshot data of the token information for each round.
+    /// @param hook The hook the snapshot is for.
+    /// @param token The address of the token being claimed and vested.
+    /// @param round The round to which the data applies.
+    function snapshotAtRoundOf(
         address hook,
-        uint256[] calldata tokenIds,
         IERC20 token,
-        uint256 distributable,
-        uint256 totalStakeAmount,
-        uint256 vestingReleaseRound
+        uint256 round
     )
-        internal
-        returns (uint256 totalVestingAmount)
+        external
+        view
+        override
+        returns (JBTokenSnapshotData memory)
     {
-        for (uint256 j; j < tokenIds.length;) {
-            uint256 tokenId = tokenIds[j];
-
-            // Skip burned tokens — they are excluded from _totalStake, so including them would overbook vesting.
-            if (_tokenBurned(hook, tokenId)) {
-                unchecked {
-                    ++j;
-                }
-                continue;
-            }
-
-            // Keep a reference to the vesting data for this hook/tokenId/token.
-            JBVestingData[] storage vestings = vestingDataOf[hook][tokenId][token];
-
-            // Make sure this token hasn't already been claimed by checking if the last item is the current round.
-            uint256 numVesting = vestings.length;
-            // slither-disable-next-line incorrect-equality
-            if (numVesting != 0 && vestings[numVesting - 1].releaseRound == vestingReleaseRound) {
-                revert JBDistributor_AlreadyVesting();
-            }
-
-            // Keep a reference to the amount of tokens being claimed.
-            uint256 tokenAmount = mulDiv(distributable, _tokenStake(hook, tokenId), totalStakeAmount);
-
-            // Add to the list of vesting data.
-            vestings.push(JBVestingData({releaseRound: vestingReleaseRound, amount: tokenAmount, shareClaimed: 0}));
+        return _snapshotAtRoundOf[hook][token][round];
+    }
 
-            emit Claimed(hook, tokenId, token, tokenAmount, vestingReleaseRound);
+    //*********************************************************************//
+    // -------------------------- public views --------------------------- //
+    //*********************************************************************//
 
-            unchecked {
-                totalVestingAmount += tokenAmount;
-                ++j;
-            }
-        }
+    /// @notice The number of the current round.
+    function currentRound() public view override returns (uint256) {
+        return (block.timestamp - startingTimestamp) / roundDuration;
     }
 
-    /// @notice Release vested rewards in the case that a token was burned.
-    /// @param hook The hook whose tokens were burned.
-    /// @param tokenIds The IDs of the burned tokens.
-    /// @param tokens The address of the tokens being released.
-    /// @param beneficiary The recipient of the released tokens.
-    function releaseForfeitedRewards(
-        address hook,
-        uint256[] calldata tokenIds,
-        IERC20[] calldata tokens,
-        address beneficiary
-    )
-        external
-        override
-    {
-        // Make sure that all tokens are burned.
-        for (uint256 i; i < tokenIds.length;) {
-            if (!_tokenBurned(hook, tokenIds[i])) revert JBDistributor_NoAccess();
-            unchecked {
-                ++i;
-            }
-        }
-
-        // Unlock the rewards and send them to the beneficiary.
-        _unlockRewards(hook, tokenIds, tokens, beneficiary, false);
+    /// @notice The timestamp at which a round started.
+    /// @param round The round to get the start timestamp of.
+    function roundStartTimestamp(uint256 round) public view override returns (uint256) {
+        return startingTimestamp + roundDuration * round;
     }
 
     //*********************************************************************//
     // ----------------------- public transactions ----------------------- //
     //*********************************************************************//
 
-    /// @notice Collect vested tokens.
+    /// @notice Collect vested tokens. Auto-vests for the current round if not already vested.
     /// @param hook The hook whose stakers are collecting.
     /// @param tokenIds The IDs of the tokens to collect for.
     /// @param tokens The address of the tokens being claimed.
@@ -370,6 +338,9 @@ abstract contract JBDistributor is IJBDistributor {
         public
         override
     {
+        // Revert if no token IDs are provided.
+        if (tokenIds.length == 0) revert JBDistributor_EmptyTokenIds();
+
         // Make sure that all tokens can be claimed by this sender.
         for (uint256 i; i < tokenIds.length;) {
             if (!_canClaim(hook, tokenIds[i], msg.sender)) revert JBDistributor_NoAccess();
@@ -378,6 +349,38 @@ abstract contract JBDistributor is IJBDistributor {
             }
         }
 
+        // --- Auto-vest for the current round ---
+        uint256 round = currentRound();
+
+        // Ensure the snapshot block is recorded for this round.
+        _ensureSnapshotBlock(round);
+
+        // Keep a reference to the total staked amount at the snapshot block.
+        uint256 totalStakeAmount = _totalStake(hook, roundSnapshotBlock[round]);
+
+        // Loop through each token and auto-vest if there's something distributable.
+        for (uint256 i; i < tokens.length;) {
+            IERC20 token = tokens[i];
+
+            // Take a snapshot of the token balance if it hasn't been taken already.
+            JBTokenSnapshotData memory snapshot = _takeSnapshotOf(hook, token);
+            uint256 distributable = snapshot.balance - snapshot.vestingAmount;
+
+            // Only auto-vest if there's something to distribute and there's stake.
+            if (distributable > 0 && totalStakeAmount > 0) {
+                uint256 totalVestingAmount =
+                    _vestTokenIds(hook, tokenIds, token, distributable, totalStakeAmount, round + vestingRounds);
+
+                unchecked {
+                    totalVestingAmountOf[hook][token] += totalVestingAmount;
+                }
+            }
+
+            unchecked {
+                ++i;
+            }
+        }
+
         // Unlock the rewards and send them to the beneficiary.
         _unlockRewards(hook, tokenIds, tokens, beneficiary, true);
     }
@@ -386,6 +389,47 @@ abstract contract JBDistributor is IJBDistributor {
     // ---------------------- internal transactions ---------------------- //
     //*********************************************************************//
 
+    /// @notice Ensures that a snapshot block is recorded for the given round.
+    /// @dev Uses `block.number - 1` because `IVotes.getPastVotes` requires a strictly past block.
+    /// @param round The round to ensure a snapshot block for.
+    function _ensureSnapshotBlock(uint256 round) internal {
+        // slither-disable-next-line incorrect-equality
+        if (roundSnapshotBlock[round] == 0) {
+            roundSnapshotBlock[round] = block.number - 1;
+            emit RoundSnapshotRecorded(round, block.number - 1);
+        }
+        // Eagerly lock the next round's snapshot to prevent first-caller manipulation.
+        // slither-disable-next-line incorrect-equality
+        if (roundSnapshotBlock[round + 1] == 0) {
+            roundSnapshotBlock[round + 1] = block.number - 1;
+            emit RoundSnapshotRecorded(round + 1, block.number - 1);
+        }
+    }
+
+    /// @notice Takes a snapshot of the token balance and vesting amount for the current round.
+    /// @param hook The hook to take the snapshot for.
+    /// @param token The token address to take a snapshot of.
+    /// @return snapshot The snapshot data.
+    function _takeSnapshotOf(address hook, IERC20 token) internal returns (JBTokenSnapshotData memory snapshot) {
+        // Keep a reference to the current round.
+        uint256 round = currentRound();
+
+        // Keep a reference to the token's snapshot.
+        snapshot = _snapshotAtRoundOf[hook][token][round];
+
+        // If a snapshot was already taken at this cycle, do not take a new one.
+        if (snapshot.balance != 0) return snapshot;
+
+        // Take a snapshot using the hook's tracked balance.
+        snapshot =
+            JBTokenSnapshotData({balance: _balanceOf[hook][token], vestingAmount: totalVestingAmountOf[hook][token]});
+
+        // Store the snapshot.
+        _snapshotAtRoundOf[hook][token][round] = snapshot;
+
+        emit SnapshotCreated(hook, round, token, snapshot.balance, snapshot.vestingAmount);
+    }
+
     /// @notice Unlocks rewards for the given token IDs and tokens, either for collection or forfeiture.
     /// @param hook The hook the tokens belong to.
     /// @param tokenIds The IDs of the tokens to unlock rewards for.
@@ -508,32 +552,68 @@ abstract contract JBDistributor is IJBDistributor {
         }
     }
 
-    /// @notice Takes a snapshot of the token balance and vesting amount for the current round.
-    /// @param hook The hook to take the snapshot for.
-    /// @param token The token address to take a snapshot of.
-    /// @return snapshot The snapshot data.
-    function _takeSnapshotOf(address hook, IERC20 token) internal returns (JBTokenSnapshotData memory snapshot) {
-        // Keep a reference to the current round.
-        uint256 round = currentRound();
+    /// @notice Vests each token ID for a given reward token and returns the total amount vested.
+    /// @dev Silently skips already-vested tokenIds instead of reverting, to support auto-vest.
+    /// @param hook The hook whose stakers are vesting.
+    /// @param tokenIds The IDs to claim rewards for.
+    /// @param token The reward token.
+    /// @param distributable The distributable amount for this round.
+    /// @param totalStakeAmount The total stake amount.
+    /// @param vestingReleaseRound The round at which vesting will be released.
+    /// @return totalVestingAmount The total amount that began vesting.
+    function _vestTokenIds(
+        address hook,
+        uint256[] calldata tokenIds,
+        IERC20 token,
+        uint256 distributable,
+        uint256 totalStakeAmount,
+        uint256 vestingReleaseRound
+    )
+        internal
+        virtual
+        returns (uint256 totalVestingAmount)
+    {
+        for (uint256 j; j < tokenIds.length;) {
+            uint256 tokenId = tokenIds[j];
 
-        // Keep a reference to the token's snapshot.
-        snapshot = _snapshotAtRoundOf[hook][token][round];
+            // Skip burned tokens — they are excluded from _totalStake, so including them would overbook vesting.
+            if (_tokenBurned(hook, tokenId)) {
+                unchecked {
+                    ++j;
+                }
+                continue;
+            }
 
-        // If a snapshot was already taken at this cycle, do not take a new one.
-        if (snapshot.balance != 0) return snapshot;
+            // Keep a reference to the vesting data for this hook/tokenId/token.
+            JBVestingData[] storage vestings = vestingDataOf[hook][tokenId][token];
 
-        // Take a snapshot using the hook's tracked balance.
-        snapshot =
-            JBTokenSnapshotData({balance: _balanceOf[hook][token], vestingAmount: totalVestingAmountOf[hook][token]});
+            // Skip if this token has already been vested for this round (same releaseRound).
+            uint256 numVesting = vestings.length;
+            // slither-disable-next-line incorrect-equality
+            if (numVesting != 0 && vestings[numVesting - 1].releaseRound == vestingReleaseRound) {
+                unchecked {
+                    ++j;
+                }
+                continue;
+            }
 
-        // Store the snapshot.
-        _snapshotAtRoundOf[hook][token][round] = snapshot;
+            // Keep a reference to the amount of tokens being claimed.
+            uint256 tokenAmount = mulDiv(distributable, _tokenStake(hook, tokenId), totalStakeAmount);
 
-        emit SnapshotCreated(hook, round, token, snapshot.balance, snapshot.vestingAmount);
+            // Add to the list of vesting data.
+            vestings.push(JBVestingData({releaseRound: vestingReleaseRound, amount: tokenAmount, shareClaimed: 0}));
+
+            emit Claimed(hook, tokenId, token, tokenAmount, vestingReleaseRound);
+
+            unchecked {
+                totalVestingAmount += tokenAmount;
+                ++j;
+            }
+        }
     }
 
     //*********************************************************************//
-    // ----------------------- virtual transactions ---------------------- //
+    // ----------------------- internal views ---------------------------- //
     //*********************************************************************//
 
     /// @notice A flag indicating if an account can currently claim their tokens.
@@ -543,11 +623,11 @@ abstract contract JBDistributor is IJBDistributor {
     /// @return canClaim A flag indicating if claiming is allowed.
     function _canClaim(address hook, uint256 tokenId, address account) internal view virtual returns (bool canClaim);
 
-    /// @notice The total amount staked at the given block.
-    /// @param hook The hook to get the total stake for.
-    /// @param blockNumber The block number to get the total staked amount at.
-    /// @return totalStakedAmount The total amount staked at a block number.
-    function _totalStake(address hook, uint256 blockNumber) internal view virtual returns (uint256 totalStakedAmount);
+    /// @notice Checks if the given token was burned or not.
+    /// @param hook The hook the token belongs to.
+    /// @param tokenId The tokenId to check.
+    /// @return tokenWasBurned A boolean that is true if the token was burned.
+    function _tokenBurned(address hook, uint256 tokenId) internal view virtual returns (bool tokenWasBurned);
 
     /// @notice The amount of tokens staked for the given token ID.
     /// @param hook The hook the token belongs to.
@@ -555,9 +635,9 @@ abstract contract JBDistributor is IJBDistributor {
     /// @return tokenStakeAmount The amount of staked tokens that is being represented by the token.
     function _tokenStake(address hook, uint256 tokenId) internal view virtual returns (uint256 tokenStakeAmount);
 
-    /// @notice Checks if the given token was burned or not.
-    /// @param hook The hook the token belongs to.
-    /// @param tokenId The tokenId to check.
-    /// @return tokenWasBurned A boolean that is true if the token was burned.
-    function _tokenBurned(address hook, uint256 tokenId) internal view virtual returns (bool tokenWasBurned);
+    /// @notice The total amount staked at the given block.
+    /// @param hook The hook to get the total stake for.
+    /// @param blockNumber The block number to get the total staked amount at.
+    /// @return totalStakedAmount The total amount staked at a block number.
+    function _totalStake(address hook, uint256 blockNumber) internal view virtual returns (uint256 totalStakedAmount);
 }