Skip to content

docs: comments on update_rewards assertions #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
noa-starkware merged 2 commits into from
Nov 30, 2025
Merged

docs: comments on update_rewards assertions #96

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a8633e
docs: comments on update_rewards assertions
noa-starkware Nov 27, 2025
92fdb6d
Merge branch 'main' into noa/staking/v3/update-rewards-comment
noa-starkware Nov 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions src/staking/staking.cairo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1404,7 +1404,12 @@ pub mod Staking {
Error::REWARDS_ALREADY_UPDATED,
);

// Assert staker exists.
// Assert staker exists and active.
// Staker is considered to exist from the moment of `stake` (when `InternalStakerInfo`
// struct is created) until the calling to `unstake_action` (when `InternalStakerInfo`
// struct is deleted).
// Staker remains active until the intent period begins, i.e. K epochs after
// `unstake_intent` is called.
let staker_info = self.internal_staker_info(:staker_address);
let curr_epoch = self.get_current_epoch();
assert!(
Expand All @@ -1418,7 +1423,9 @@ pub mod Staking {
.get_staker_total_strk_btc_balance_at_epoch(
:staker_address, :staker_pool_info, epoch_id: curr_epoch,
);
// Assert staker has balance.
// Assert staker has non-zero balance.
// Staker exists with zero balance for the first K epochs after `stake`, then the stake
// becomes effective.
assert!(staker_total_strk_balance.is_non_zero(), "{}", Error::INVALID_STAKER);

// Update last block rewards.
Expand Down