ObolNetwork / ObolNetwork/obol-docs
Add docs for `fee-recipient-address`
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 27
- Forks
- 61
- Avg merge
- 1h 22m
- Merged PRs (30d)
- 2
Description
🎯 Problem to be solved
We need to add documentation on how Charon handles the fee-recipient-address for block proposals as it is not trivial. And it can be confusing for operators as they can get confused whether to set fee-recipient-address on validator client or not.
🛠️ Proposed solution
Add docs describing how charon handles fee-recipient-address. The documentation can include:
- Charon sets fee recipient address based on what is there in
cluster-lock.jsonwhich is generated at the end of DKG ceremony: https://github.com/ObolNetwork/charon/blob/db040d559dae37b44f5c24ea6534ce4946cb6482/app/app.go#L911-L953 - It sets fee recipient address by periodically calling
prepareBeaconProposerbeacon API: https://ethereum.github.io/beacon-APIs/#/Validator/prepareBeaconProposer - Charon swallows this API call if called by a validator client.
🧪 Tests
- Netlify deployment build tests passing
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the linked app/app.go section and the Beacon API prepareBeaconProposer documentation first. Add operator-facing documentation covering cluster-lock.json, Charon's periodic API calls, and how calls from a validator client are handled; confirm the Netlify deployment build passes.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100