feat(blockchain): introducing validator size cap size #2119

abi87 · 2024-11-01T09:51:03Z

This PR:

Introduces a cap on the validator set size
Schedule withdrawals of deposits for validators which would breach the validator set size cap

This PR currently fails e2e tests since it's based on #2110

coderabbitai · 2024-11-01T09:51:10Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2024-11-01T09:53:19Z

Codecov Report

Attention: Patch coverage is 45.45455% with 18 lines in your changes missing coverage. Please review.

Project coverage is 26.58%. Comparing base (d8a267e) to head (32fbbbc).

Files with missing lines	Patch %	Lines
...ate-transition/pkg/core/state_processor_genesis.go	0.00%	6 Missing and 1 partial ⚠️
...ate-transition/pkg/core/state_processor_staking.go	73.68%	2 Missing and 3 partials ⚠️
mod/chain-spec/pkg/chain/chain_spec.go	0.00%	2 Missing ⚠️
mod/consensus-types/pkg/types/validator.go	0.00%	2 Missing ⚠️
mod/state-transition/pkg/core/state_processor.go	0.00%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@                        Coverage Diff                         @@
##           fix-maximum-number-withdrawals    #2119      +/-   ##
==================================================================
+ Coverage                           26.41%   26.58%   +0.16%     
==================================================================
  Files                                 357      357              
  Lines                               16075    16097      +22     
  Branches                               12       12              
==================================================================
+ Hits                                 4247     4280      +33     
+ Misses                              11560    11547      -13     
- Partials                              268      270       +2

Files with missing lines	Coverage Δ
mod/config/pkg/spec/testnet.go	`100.00% <100.00%> (ø)`
mod/chain-spec/pkg/chain/chain_spec.go	`12.50% <0.00%> (-0.33%)`	⬇️
mod/consensus-types/pkg/types/validator.go	`94.06% <0.00%> (-1.63%)`	⬇️
mod/state-transition/pkg/core/state_processor.go	`29.82% <0.00%> (-1.51%)`	⬇️
...ate-transition/pkg/core/state_processor_staking.go	`60.10% <73.68%> (+7.85%)`	⬆️
...ate-transition/pkg/core/state_processor_genesis.go	`46.60% <0.00%> (-3.40%)`	⬇️

... and 1 file with indirect coverage changes

abi87 · 2024-11-01T11:32:46Z

mod/state-transition/pkg/core/state_processor_genesis.go

+	if uint32(len(deposits)) > sp.cs.GetValidatorsSetCapSize() {
+		return nil, fmt.Errorf("validator set cap %d, deposits count %d: %w",
+			sp.cs.GetValidatorsSetCapSize(),
+			len(deposits),
+			ErrHitValidatorsSetCap,
+		)
+	}


here I assume deposits in genesis maps one to one with genesis validators and we do not have two different updates for the same validator.
Is it a fair assumption @chuck-bear, @itsdevbear?

may be necessary to allow multiple deposits per genesis validator if each deposit is capped to some amount like 32

abi87 · 2024-11-01T11:37:00Z

mod/state-transition/pkg/core/state_processor_staking.go

+	if sp.cs.DepositEth1ChainID() == bArtioChainID {
+		return st.AddValidatorBartio(val)
+	}


replicating here the fix from #2111 to avoid double counting Bartio Validators balances (done implicitly in AddValidatorBartio)

abi87 · 2024-11-01T11:56:27Z

mod/state-transition/pkg/core/state_processor_staking.go

-	// TODO: This is a bug that lives on bArtio. Delete this eventually.
-	if sp.cs.DepositEth1ChainID() == bArtioChainID {
-		if err := st.AddValidatorBartio(val); err != nil {
+	if !sp.processingGenesis {


minor optimization which we may drop for readability.
Currently I chose to fail node initialization if genesis has more validators than the validator set cap, so here I can skip the check.
However we may chose to allow genesis have more validators than cap and immediately mark the ready for eviction.
@itsdevbear @chuck-bear thoughts?

calbera · 2024-11-04T20:05:06Z

mod/chain-spec/pkg/chain/chain_spec.go

@@ -183,6 +183,8 @@ type Spec[
 	// GetCometBFTConfigForSlot retrieves the CometBFT config for a specific
 	// slot.
 	GetCometBFTConfigForSlot(slot SlotT) CometBFTConfigT
+
+	GetValidatorsSetCapSize() uint32


Suggested change

GetValidatorsSetCapSize() uint32

// GetValidatorSetCap retrieves the maximum number of validators allowed in the active set.

GetValidatorSetCap() uint32

nit + comment

It seems comment was changed, but function name still needs to be changed to GetValidatorSetCap

mod/chain-spec/pkg/chain/chain_spec.go

mod/state-transition/pkg/core/errors.go

mod/consensus-types/pkg/types/validator.go

mod/state-transition/pkg/core/types.go

nidhi-singh02 · 2024-11-05T10:27:57Z

mod/chain-spec/pkg/chain/chain_spec.go

+// allowed in the active set.
+func (c chainSpec[
+	DomainTypeT, EpochT, ExecutionAddressT, SlotT, CometBFTConfigT,
+]) GetValidatorsSetCapSize() uint32 {


nit: GetValidatorSetCap

added validator set cap size to chain specs

b395ac2

abi87 self-assigned this Nov 1, 2024

abi87 changed the base branch from main to fix-maximum-number-withdrawals November 1, 2024 09:51

Merge branch 'fix-maximum-number-withdrawals' into validator-size-cap

63e4db0

abi87 added 3 commits November 1, 2024 11:03

enforce validator set size cap on genesis

36fe774

appease gosec

e64bc74

mark extra validators as withdrawable

c6c68c3

abi87 force-pushed the validator-size-cap branch from eb0a88d to c6c68c3 Compare November 1, 2024 11:24

abi87 marked this pull request as ready for review November 1, 2024 11:26

abi87 requested a review from itsdevbear as a code owner November 1, 2024 11:26

abi87 added the DO NOT MERGE just don't merge it (just yet) label Nov 1, 2024

abi87 commented Nov 1, 2024

View reviewed changes

nit

37542a0

abi87 force-pushed the validator-size-cap branch from 63c2092 to 37542a0 Compare November 1, 2024 11:35

abi87 commented Nov 1, 2024

View reviewed changes

avoid double validators set cap checks on genesis

ea69a35

abi87 commented Nov 1, 2024

View reviewed changes

add UT showing extra validator is added ready for withdrawal

af43b93

abi87 force-pushed the validator-size-cap branch from 838c2a7 to af43b93 Compare November 1, 2024 12:59

abi87 added 3 commits November 1, 2024 14:48

extend UT to show extra validator deposit is withdrawn

a728bcb

Merge branch 'fix-maximum-number-withdrawals' into validator-size-cap

826351d

Merge branch 'fix-erigon' into validator-size-cap

43b1eb4

abi87 force-pushed the validator-size-cap branch from 39fc15e to 43b1eb4 Compare November 2, 2024 09:36

Merge branch 'fix-maximum-number-withdrawals' into validator-size-cap

561f95f

abi87 force-pushed the fix-maximum-number-withdrawals branch from 2778c79 to 09eee8e Compare November 2, 2024 20:35

abi87 force-pushed the validator-size-cap branch from 6e64587 to 561f95f Compare November 3, 2024 09:19

abi87 added 2 commits November 4, 2024 09:31

Merge branch 'fix-maximum-number-withdrawals' into validator-size-cap

72539e0

Merge branch 'fix-maximum-number-withdrawals' into validator-size-cap

3603f6b

abi87 added Ready for Review and removed DO NOT MERGE just don't merge it (just yet) labels Nov 4, 2024

calbera reviewed Nov 4, 2024

View reviewed changes

mod/chain-spec/pkg/chain/chain_spec.go Show resolved Hide resolved

calbera reviewed Nov 4, 2024

View reviewed changes

mod/state-transition/pkg/core/errors.go Outdated Show resolved Hide resolved

calbera reviewed Nov 4, 2024

View reviewed changes

mod/consensus-types/pkg/types/validator.go Show resolved Hide resolved

calbera reviewed Nov 4, 2024

View reviewed changes

mod/state-transition/pkg/core/types.go Show resolved Hide resolved

nits

32fbbbc

abi87 requested a review from calbera November 4, 2024 23:17

nidhi-singh02 reviewed Nov 5, 2024

View reviewed changes

abi87 mentioned this pull request Nov 5, 2024

chore(all): Cumulative branch - attempt 2 #2127

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(blockchain): introducing validator size cap size #2119

feat(blockchain): introducing validator size cap size #2119

abi87 commented Nov 1, 2024 •

edited

Loading

coderabbitai bot commented Nov 1, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented Nov 1, 2024 •

edited

Loading

abi87 Nov 1, 2024 •

edited

Loading

calbera Nov 4, 2024

abi87 Nov 1, 2024

abi87 Nov 1, 2024

calbera Nov 4, 2024

nidhi-singh02 Nov 5, 2024

nidhi-singh02 Nov 5, 2024

	GetValidatorsSetCapSize() uint32
	// GetValidatorSetCap retrieves the maximum number of validators allowed in the active set.
	GetValidatorSetCap() uint32

feat(blockchain): introducing validator size cap size #2119

Are you sure you want to change the base?

feat(blockchain): introducing validator size cap size #2119

Conversation

abi87 commented Nov 1, 2024 • edited Loading

coderabbitai bot commented Nov 1, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented Nov 1, 2024 • edited Loading

Codecov Report

abi87 Nov 1, 2024 • edited Loading

Choose a reason for hiding this comment

calbera Nov 4, 2024

Choose a reason for hiding this comment

abi87 Nov 1, 2024

Choose a reason for hiding this comment

abi87 Nov 1, 2024

Choose a reason for hiding this comment

calbera Nov 4, 2024

Choose a reason for hiding this comment

nidhi-singh02 Nov 5, 2024

Choose a reason for hiding this comment

nidhi-singh02 Nov 5, 2024

Choose a reason for hiding this comment

abi87 commented Nov 1, 2024 •

edited

Loading

coderabbitai bot commented Nov 1, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Nov 1, 2024 •

edited

Loading

abi87 Nov 1, 2024 •

edited

Loading