Skip to content

cmd: add alpha vc-bundle command - #4844

Open
KaloyanTanev wants to merge 8 commits into
kalo/proposer-config-default-fee-recipientfrom
kalo/vc-bundle
Open

KaloyanTanev wants to merge 8 commits into
kalo/proposer-config-default-fee-recipientfrom
kalo/vc-bundle

Conversation

@KaloyanTanev

@KaloyanTanev KaloyanTanev commented Nov 13, 2026 •

Copy link
Copy Markdown
Collaborator

Every distribution renders vc-config/proposer-config.json into each validator client's own format by hand: CDVN's run.sh adapters do it with jq and node, and Helm, DappNode and custom setups have to copy them.

charon alpha vc-bundle <teku|prysm|lodestar|nimbus|lighthouse> renders it in charon instead, from the node's validator_keys/ and proposer config, into a staging directory (--output-dir, default .charon/vc-bundle) that operators move into the validator client's directory. --include picks the parts, all by default:

  • keystores: copies of the key shares in the client's layout, so no client reads charon's directory. Prysm gets a wallet of the decrypted shares.
  • proposer-settings: the client's native proposer settings, builders included (Lighthouse in builder_definitions.yml, Teku for releases after 26.10.3). Lighthouse's definitions name the keystores by absolute path under --lighthouse-dir, its data directory as Lighthouse sees it.
  • vc-flags: vc-flags.txt, every flag a distributed validator needs on that client (--distributed, --Xobol-dvt-integration-enabled, --payloadLocal=true, --builder.selection=maxprofit, …) plus the builder flags for Nimbus, which takes builders only as flags.

It is meant for clusters past the gloas fork: builders are enabled exactly when the proposer config has a builder block, and a proposer config missing a value a client needs is refused before anything is written. The command logs the client version the bundle is made for (Teku develop, Prysm v7.3.1, Lodestar v1.50.1, Nimbus v26.10.2, Lighthouse v8.3.3) and where each client takes its keystores and builders from, with builder URLs redacted. Tested end to end on Sepolia with CDVN rewired to it in ObolNetwork/charon-distributed-validator-node#523: all five VCs load their keys and proposer settings from the bundle. Lighthouse's copied keystores came after that run, and are checked locally with Lighthouse v8.3.3 loading them and keeping its slashing protection DB across restarts.

category: feature
ticket: #4324

@KaloyanTanev KaloyanTanev self-assigned this Nov 13, 2026
@github-actions github-actions Bot added the branch-invalid PR raised against invalid branch. Not a main or release branch. label Nov 13, 2026
@KaloyanTanev
KaloyanTanev added this pull request to stack #4832 November 13, 2026 18:25
@codecov

codecov Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 91.26984% with 44 lines in your changes missing coverage. Please review.
✅ Project coverage is 69.57%. Comparing base (1c4df6b) to head (0757fd9).

Files with missing lines Patch % Lines
eth2util/vcbundle/keystores.go 87.20% 11 Missing ⚠️
eth2util/vcbundle/proposerconfig.go 92.25% 11 Missing ⚠️
eth2util/vcbundle/write.go 90.35% 11 Missing ⚠️
eth2util/vcbundle/prysm.go 82.50% 7 Missing ⚠️
eth2util/vcbundle/flags.go 96.22% 2 Missing ⚠️
cmd/cmd.go 0.00% 1 Missing ⚠️
cmd/vcbundle.go 97.67% 1 Missing ⚠️
Additional details and impacted files
@@                              Coverage Diff                               @@
##           kalo/proposer-config-default-fee-recipient    #4844      +/-   ##
==============================================================================
+ Coverage                                       69.29%   69.57%   +0.27%     
==============================================================================
  Files                                             269      276       +7     
  Lines                                           35655    36154     +499     
==============================================================================
+ Hits                                            24707    25153     +446     
- Misses                                          10947    11000      +53     
  Partials                                            1        1              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sonarqubecloud

Copy link
Copy Markdown

@KaloyanTanev
KaloyanTanev marked this pull request as ready for review November 17, 2026 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch-invalid PR raised against invalid branch. Not a main or release branch.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant