Split writeCurrentStakers into multiple functions
#3500
+208
−183
Conversation
This file contains 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
StephenButtolph
commented
Oct 27, 2024
| @@ -273,6 +274,34 @@ type diffValidator struct { | |||
| deletedDelegators map[ids.ID]*Staker | |||
| } | |||
|
|
|||
| func (d *diffValidator) WeightDiff() (ValidatorWeightDiff, error) { | |||
There was a problem hiding this comment.
This was previously implemented in writeCurrentStakersSubnetDiff.
| // | ||
| // Note: This function may return a nil public key and no error if the primary | ||
| // network validator does not have a public key. | ||
| func (s *state) getInheritedPublicKey(nodeID ids.NodeID) (*bls.PublicKey, error) { |
There was a problem hiding this comment.
This logic previously existed as part of writeCurrentStakersSubnetDiff.
Comment on lines
+1797
to
+1799
| s.updateValidatorManager(updateValidators), | ||
| s.writeValidatorDiffs(height), | ||
| s.writeCurrentStakers(codecVersion), |
There was a problem hiding this comment.
While splitting these out is technically less efficient (and contains similar code). The functions were just getting too complex to understand. This is explicitly trading off some (imo insignificant) level of performance for clarity.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why this should be merged
writeCurrentStakersis extremely complex as it is doing 3 things:As we implement ACP-77:
and
become more complex, as it is possible that the same
subnetID + nodeIDpair are removed from the pre-ACP-77 validator sets and added to the post-ACP-77 validator sets.To avoid
writeCurrentStakersfrom including ACP-77 validators as well (making one of the most complex functions even more complex), this PR moves the functionality into separate functions.How this works
Moves code around and implements helper functions where possible.
How this was tested
Existing tests.
Need to be documented in RELEASES.md?
There are no user facing changes.