@bananapus/distributor-v6 0.0.9 → 0.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bananapus/distributor-v6",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/JB721Distributor.sol

@@ -169,7 +169,7 @@ contract JB721Distributor is JBDistributor, IJB721Distributor {
     ///      Silently skips burned tokens, already-vested tokens, and tokens whose owner had no snapshot voting power.
     /// @param hook The address of the 721 hook whose stakers are vesting.
     /// @param tokenIds The NFT token IDs to vest rewards for.
-    /// @param token The ERC-20 reward token being distributed.
+    /// @param token The ERC-20 reward token to distribute.
     /// @param distributable The total distributable amount of `token` for this round.
     /// @param totalStakeAmount The aggregate voting power at the round's snapshot block.
     /// @param vestingReleaseRound The round number at which the vesting period ends and tokens become fully claimable.

package/src/JBDistributor.sol

@@ -72,7 +72,7 @@ abstract contract JBDistributor is IJBDistributor {
     /// @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.
+    /// @custom:param token The address of the token vested.
     mapping(address hook => mapping(uint256 tokenId => mapping(IERC20 token => uint256))) public latestVestedIndexOf;
 
     /// @notice The block number recorded as the snapshot point for each round.
@@ -87,7 +87,7 @@ abstract contract JBDistributor is IJBDistributor {
     /// @notice All vesting data of a tokenId for any number of vesting tokens.
     /// @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.
+    /// @custom:param token The address of the token vested.
     // slither-disable-next-line uninitialized-state
     mapping(address hook => mapping(uint256 tokenId => mapping(IERC20 token => JBVestingData[]))) public vestingDataOf;
 
@@ -106,7 +106,7 @@ abstract contract JBDistributor is IJBDistributor {
 
     /// @notice The snapshot data of the token information for each round.
     /// @custom:param hook The hook the snapshot is for.
-    /// @custom:param token The address of the token being claimed and vested.
+    /// @custom:param token The address of the token claimed and vested.
     /// @custom:param round The round to which the data applies.
     mapping(address hook => mapping(IERC20 token => mapping(uint256 round => JBTokenSnapshotData snapshot))) internal
         _snapshotAtRoundOf;
@@ -321,7 +321,7 @@ abstract contract JBDistributor is IJBDistributor {
 
     /// @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 token The address of the token claimed and vested.
     /// @param round The round to which the data applies.
     function snapshotAtRoundOf(
         address hook,
@@ -466,7 +466,7 @@ abstract contract JBDistributor is IJBDistributor {
     /// @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.
-    /// @param tokens The address of the tokens being unlocked.
+    /// @param tokens The addresses of the tokens to unlock.
     /// @param beneficiary The recipient of the unlocked tokens.
     /// @param ownerClaim Whether this is a claim by the owner (true) or a forfeiture release (false).
     function _unlockRewards(
@@ -521,7 +521,7 @@ abstract contract JBDistributor is IJBDistributor {
     /// @notice Unlocks rewards for a set of token IDs for a single reward token.
     /// @param hook The hook the tokens belong to.
     /// @param tokenIds The IDs of the tokens to unlock rewards for.
-    /// @param token The reward token being unlocked.
+    /// @param token The reward token to unlock.
     /// @param round The current round.
     /// @return totalTokenAmount The total amount of reward tokens unlocked.
     function _unlockTokenIds(
@@ -559,10 +559,10 @@ abstract contract JBDistributor is IJBDistributor {
 
                 uint256 claimAmount = mulDiv(vesting.amount, MAX_SHARE - vesting.shareClaimed - lockedShare, MAX_SHARE);
 
-                // Update to reflect the amount claimed.
-                vestings[vestedIndex].shareClaimed = MAX_SHARE - lockedShare;
-
                 if (claimAmount != 0) {
+                    // Only update the claimed share when a nonzero transfer will occur.
+                    // This keeps dust entries unconsumed so future claims can accumulate enough for a nonzero amount.
+                    vestings[vestedIndex].shareClaimed = MAX_SHARE - lockedShare;
                     totalTokenAmount += claimAmount;
                     emit Collected(hook, tokenId, token, claimAmount, vesting.releaseRound);
                 }

package/src/interfaces/IJBDistributor.sol

@@ -16,8 +16,8 @@ interface IJBDistributor {
     /// @notice Emitted when a staker begins vesting tokens.
     /// @param hook The hook whose stakers are vesting.
     /// @param tokenId The ID of the staked token that is claiming.
-    /// @param token The address of the token being vested.
-    /// @param amount The amount of tokens being vested.
+    /// @param token The address of the token to vest.
+    /// @param amount The amount of tokens to vest.
     /// @param vestingReleaseRound The round at which the tokens will be fully released.
     event Claimed(
         address indexed hook, uint256 indexed tokenId, IERC20 token, uint256 amount, uint256 vestingReleaseRound
@@ -26,7 +26,7 @@ interface IJBDistributor {
     /// @notice Emitted when vested tokens are collected.
     /// @param hook The hook whose stakers are collecting.
     /// @param tokenId The ID of the staked token collecting.
-    /// @param token The address of the token being collected.
+    /// @param token The address of the token collected.
     /// @param amount The amount of tokens collected.
     /// @param vestingReleaseRound The round at which the tokens will be fully released.
     event Collected(
@@ -60,13 +60,13 @@ interface IJBDistributor {
     /// @notice Calculate how much of the token has been claimed for the given tokenId.
     /// @param hook The hook the tokenId belongs to.
     /// @param tokenId The ID of the token to calculate the token amount for.
-    /// @param token The address of the token being claimed.
+    /// @param token The address of the token to check.
     function claimedFor(address hook, uint256 tokenId, IERC20 token) external view returns (uint256);
 
     /// @notice Calculate how much of the token is currently ready to be collected for the given tokenId.
     /// @param hook The hook the tokenId belongs to.
     /// @param tokenId The ID of the token to calculate the token amount for.
-    /// @param token The address of the token being claimed.
+    /// @param token The address of the token to check.
     function collectableFor(address hook, uint256 tokenId, IERC20 token) external view returns (uint256);
 
     /// @notice The number of the current round.
@@ -86,7 +86,7 @@ interface IJBDistributor {
 
     /// @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 token The address of the token to check.
     /// @param round The round to which the data applies.
     function snapshotAtRoundOf(
         address hook,
@@ -118,7 +118,7 @@ interface IJBDistributor {
     /// @notice Collect vested tokens.
     /// @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.
+    /// @param tokens The addresses of the tokens to collect.
     /// @param beneficiary The recipient of the collected tokens.
     function collectVestedRewards(
         address hook,
@@ -141,7 +141,7 @@ interface IJBDistributor {
     /// @notice Release vested rewards for burned tokens.
     /// @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 tokens The addresses of the tokens to release.
     /// @param beneficiary The recipient of the released tokens.
     function releaseForfeitedRewards(
         address hook,