Skip to content

Prepopulate all Reward Accounts with 0 after Upgrade #3765

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

Open
bfish713 wants to merge 4 commits into
base: main
Choose a base branch
from
+35 −2
Open

Prepopulate all Reward Accounts with 0 after Upgrade #3765

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
82c6fdc
pre populate all accounts with 0 when rewards start
bfish713 Nov 17, 2025
c12aa98
Merge branch 'main' into bf/rewards
bfish713 Nov 19, 2025
52dc8e1
Merge branch 'main' into bf/rewards
bfish713 Nov 20, 2025
d234bf7
Update types/src/v0/impls/reward.rs
bfish713 Nov 21, 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
37 changes: 35 additions & 2 deletions types/src/v0/impls/reward.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ use hotshot::types::BLSPubKey;
use hotshot_contract_adapter::reward::RewardProofSiblings;
use hotshot_types::{
data::{EpochNumber, ViewNumber},
traits::{election::Membership, node_implementation::ConsensusTime},
epoch_membership::EpochMembershipCoordinator,
traits::{
election::Membership, node_implementation::ConsensusTime,
signature_key::StakeTableEntryType,
},
utils::epoch_from_block_number,
};
use jf_merkle_tree_compat::{
Expand Down Expand Up @@ -41,7 +45,7 @@ use crate::{
RewardMerkleTreeV1,
},
v0_4::{Delta, REWARD_MERKLE_TREE_V2_ARITY, REWARD_MERKLE_TREE_V2_HEIGHT},
DrbAndHeaderUpgradeVersion, EpochVersion, FeeAccount,
DrbAndHeaderUpgradeVersion, EpochVersion, FeeAccount, SeqTypes,
};

impl_serde_from_string_or_integer!(RewardAmount);
Expand Down Expand Up @@ -778,6 +782,28 @@ impl RewardDistributor {
}
}

async fn pre_populate_reward_merkle_tree(
coordinator: EpochMembershipCoordinator<SeqTypes>,
validated_state: &mut ValidatedState,
epoch: EpochNumber,
) -> anyhow::Result<()> {
let epoch_membership = coordinator.stake_table_for_epoch(Some(epoch)).await?;
let membership = epoch_membership.coordinator.membership().read().await;

let reward_merkle_tree_v2 = &mut validated_state.reward_merkle_tree_v2;
for peer_config in epoch_membership.stake_table().await.0 {
let address = peer_config.stake_table_entry.public_key();
let validator = membership.get_validator_config(&epoch, address)?;
*reward_merkle_tree_v2 = reward_merkle_tree_v2
.persistent_update(RewardAccountV2(validator.account), RewardAmount(U256::ZERO))?;
for delegator in validator.delegators.keys() {
*reward_merkle_tree_v2 = reward_merkle_tree_v2
.persistent_update(RewardAccountV2(*delegator), RewardAmount(U256::ZERO))?;
}
}
Ok(())
}

/// Distributes the block reward for a given block height
///
/// Rewards are only distributed if the block belongs to an epoch beyond the second epoch.
Expand Down Expand Up @@ -839,6 +865,13 @@ pub async fn distribute_block_reward(
instance_state.fixed_block_reward().await?
};

// If we just upgraded to V4 from any version we should pre-populate the merkle tree
// with accounts from the stake table, giving each address 0 initial balance
if version >= DrbAndHeaderUpgradeVersion::version()
Copy link
Contributor

@imabdulbasit imabdulbasit Dec 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh I think this should be before

let leader = get_leader_and_fetch_missing_rewards(
        instance_state,
        validated_state,
        parent_leaf,
        view_number,
    )
    .await?;

so that get_leader_and_fetch_missing_rewards doesn't trigger catchup

&& parent_header.version() < DrbAndHeaderUpgradeVersion::version()
{
pre_populate_reward_merkle_tree(coordinator.clone(), validated_state, epoch).await?;
}
// If we are in the DRB + header upgrade
// and the parent block is from V3 (which does not have a previously distributed reward field),
// we need to recompute the previously distributed rewards
Expand Down
Loading