Skip to content

Commit ca996b3

Browse files
committed
docs: fix typos across source and test contracts
- BGT.sol:296 — 'gaurentees' → 'guarantees' - IFeeCollector.sol:25 — 'transfered' → 'transferred' - BlockRewardController.sol:235 — 'gauranteed' → 'guaranteed' - RewardVault.t.sol:307 — 'afftects' → 'affects' - BGTStaker.t.sol:154 — 'afftects' → 'affects' Found during security audit of RewardVault, BGT, and WBERAStakerVault.
1 parent 340ff9c commit ca996b3

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

src/pol/BGT.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ contract BGT is IBGT, ERC20VotesUpgradeable, OwnableUpgradeable, Multicallable {
293293
// `withdraw` will fail with zero amount.
294294
if (amount == 0 || !_checkEnoughTimePassed(blockNumberLast, dropBoostDelay)) return false;
295295
unchecked {
296-
// queue drop boost gaurentees that the user has enough boosted balance to drop
296+
// queue drop boost guarantees that the user has enough boosted balance to drop
297297
boosted[user][pubkey] -= amount;
298298
// `totalBoosts` >= `userBoosts[user].boost` >= `boosted[user][validator]`
299299
totalBoosts -= amount;

src/pol/interfaces/IFeeCollector.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ interface IFeeCollector is IPOLErrors {
2222

2323
/// @notice Emitted when the `PayoutToken` is donated.
2424
/// @param caller Caller of the `donate` function.
25-
/// @param amount The amount of payout token that is transfered.
25+
/// @param amount The amount of payout token that is transferred.
2626
event PayoutDonated(address indexed caller, uint256 amount);
2727

2828
/// @notice Emitted when the fees are claimed.

src/pol/rewards/BlockRewardController.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ contract BlockRewardController is IBlockRewardController, OwnableUpgradeable, UU
232232

233233
emit BlockRewardProcessed(pubkey, nextTimestamp, base, reward);
234234

235-
// Use the beaconDepositContract to fetch the operator, Its gauranteed to return a valid address.
235+
// Use the beaconDepositContract to fetch the operator, Its guaranteed to return a valid address.
236236
// Beacon Deposit contract will enforce validators to set an operator.
237237
address operator = beaconDepositContract.getOperator(pubkey);
238238
if (base > 0) bgt.mint(operator, base);

test/pol/BGTStaker.t.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ contract BGTStakerTest is POLTest, StakingTest {
151151
assertApproxEqAbs(bgtStaker.earned(user), expectedEarned, 2e2);
152152
}
153153

154-
/// @dev Changing rewards duration during reward cycle afftects users staking in different times.
154+
/// @dev Changing rewards duration during reward cycle affects users staking in different times.
155155
function test_SetRewardsDurationDuringCycleMultipleUsers() public {
156156
address user2 = makeAddr("user2");
157157
uint256 blockTimestamp = vm.getBlockTimestamp();

test/pol/RewardVault.t.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ contract RewardVaultTest is DistributorTest, StakingTest {
304304
assertApproxEqAbs(vault.earned(user), expectedEarned, 2e2);
305305
}
306306

307-
/// @dev Changing rewards duration during reward cycle afftects users staking in different times.
307+
/// @dev Changing rewards duration during reward cycle affects users staking in different times.
308308
function test_SetRewardsDurationDuringCycleMultipleUsers() public {
309309
address user2 = makeAddr("user2");
310310
uint256 blockTimestamp = vm.getBlockTimestamp();

0 commit comments

Comments
 (0)