refactor(wallet-registry): update withdrawRewards#3945
Open
lionakhnazarov wants to merge 4 commits intothreshold-network:mainfrom
Open
refactor(wallet-registry): update withdrawRewards#3945lionakhnazarov wants to merge 4 commits intothreshold-network:mainfrom
lionakhnazarov wants to merge 4 commits intothreshold-network:mainfrom
Conversation
…dd tests for allowlist integration - Enhanced documentation for the function to clarify the beneficiary retrieval process based on the current authorization source. - Removed historical migration rationale as it is no longer relevant. - Added new tests to verify reward distribution when the allowlist is active, ensuring correct beneficiary handling and reward payouts.
- Updated import statements to include 'ethers' alongside 'helpers' for clarity. - Refactored test code for better readability by adjusting line breaks and formatting. - Ensured consistent handling of the 'stakingProvider' variable for improved code maintainability.
… function - Changed the beneficiary retrieval logic in the withdrawRewards function to use the current authorization source, improving accuracy in reward distribution. - This change ensures that the correct beneficiary is identified based on the latest authorization context.
…test
The "NOT MIGRATED Touchpoints" describe block in
WalletRegistry.Authorization.test.ts asserted that withdrawRewards
retained TokenStaking beneficiary lookup post-initializeV2. With
withdrawRewards now routed through _currentAuthorizationSource(),
that invariant no longer holds. The test still passed because it
never invoked withdrawRewards -- it only read staking.rolesOf and
walletRegistry.allowlist() -- but its name, rationale comment, and
block-level documentation advertised behavior the code no longer
exhibits and would mislead future maintainers.
Positive coverage for post-upgrade Allowlist routing lives in
WalletRegistry.Rewards.test.ts ("withdrawRewards when allowlist !=
address(0)"). The top-of-file coverage summary is updated so the
remaining "NOT MIGRATED touchpoints" line continues to reflect the
still-valid slashing path (challengeDkgResult) without the removed
beneficiary claim.
lrsaturnino
approved these changes
Apr 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents and tests
WalletRegistry.withdrawRewardsbeneficiary resolution via_currentAuthorizationSource().rolesOf(stakingProvider)(Allowlist whenallowlist != address(0), otherwise TokenStaking), addressing review feedback that this path differs from always usingTokenStaking.rolesOfafter upgrade.Changes
Contract
WalletRegistry.withdrawRewards: NatSpec updated to match implementation and to explain Allowlist vs TokenStakingrolesOfsemantics (TIP-092 Allowlist uses staking-provider-as-beneficiary; TokenStaking can use a delegated beneficiary). Removed outdated wording that implied lookup stayed on TokenStaking only.Tests
WalletRegistry.Rewards.test.ts: New case usingwalletRegistryFixture({ useAllowlist: true })— asserts non-zero allowlist, readsAllowlist.rolesOf, funds the sortition pool, callswithdrawRewards, and checks rewards land on the expected beneficiary. (Hardhat + TypeScript; this package does not use Foundry.t.sol.)Auditor / reviewer notes
On networks where the proxy
allowlistis set (e.g. mainnet),withdrawRewardspays the address returned by the Allowlist contract, which may differ from a legacy TokenStaking delegated beneficiary when owner ≠ beneficiary delegation applied only under staking.Merge / scope
Intended as a small, isolated PR (separate from unrelated testnet or infra work) so beneficiary routing and documentation get focused review.