ObolNetwork / ObolNetwork/obol-docs

Add docs for `fee-recipient-address`

Open Beginner friendly
#220 0 comments 0 reactions 0 assignees View on GitHub

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:

🧪 Tests

  • Netlify deployment build tests passing

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.