This repo contains the source code for the distributed validator client Charon (pronounced 'kharon'); a HTTP middleware client for Ethereum Staking that enables you to safely run a single validator across a group of independent nodes.
Charon is accompanied by a webapp called the Distributed Validator Launchpad for distributed validator key creation.
Charon is used by stakers to distribute the responsibility of running Ethereum Validators across a number of different instances and client implementations.
A Distributed Validator Cluster that uses the Charon client to hedge client and hardware failure risks
The easiest way to test out charon is with the charon-distributed-validator-cluster repo which contains a docker compose setup for running a full charon cluster on your local machine.
The Obol Docs website is the best place to get started. The important sections are intro, key concepts and charon.
For detailed documentation on this repo, see the docs folder:
- Configuration: Configuring a charon node
- Architecture: Overview of charon cluster and node architecture
- Project Structure: Project folder structure
- Branching and Release Model: Git branching and release model
- Go Guidelines: Guidelines and principals relating to go development
- Contributing: How to contribute to charon; githooks, PR templates, etc.
There is always the charon godocs for the source code documentation.
A table detailing Charon compatibility with upstream consensus clients and downstream validators can be found in the changelog of each release, in the Compatibility Matrix section.
Considering semver as the project's versioning scheme, two given versions of Charon are:
- compatible if their
MAJORnumber is the same,MINORandPATCHnumbers differ - incompatible if their
MAJORnumber differs
There are several reasons to justify a new MAJOR release, for example:
- a new Ethereum hardfork
- an old Ethereum hardfork is removed due to network inactivity
- modifications to the internal P2P network or consensus mechanism requiring deep changes to the codebase
The charon dkg subcommand is more restrictive than this general compatibility promise; all peers should use matchingMAJOR andMINOR versions of Charon for the DKG process, patch versions may differ though it is recommended to use the latest patch of any version.