livepeer / livepeer/go-livepeer
Unclear which flags are used by which roles
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 586
- Forks
- 226
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 19
Description
Describe the bug
Currently, it isn't easy to determine which flags (e.g. -maxTicketEV) are used by which role (e.g. -broadcaster or -orchestrator)
To Reproduce
- Run
./livepeer --help - See a number of flags, with descriptions of how to use them e.g.:
-maxTicketEV string
The maximum acceptable expected value for PM tickets (default "3000000000000")
- Be confused about whether this flag is to be used with
-broadcasterrole or-orchestratorrole. - Try running
./livepeerwith the-orchestratorflag and also-maxTicketEV - Discover that setting the
-maxTicketEVin this case is ignored - Be confused about why it didn't throw an error saying "you can't use
-maxTicketEVwith-orchestrator" (or something similar)
Expected behavior
I expect it to be made clear (e.g. in --help) which flags can influence the operations of which role.
Also, if I use a flag with a role where the role ignores the flag, I at least expect to be warned about it :)
Contributor guide
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
Start by running ./livepeer --help and tracing how role flags such as -broadcaster, -orchestrator, and -maxTicketEV are registered and processed. Done means the help output identifies each flag's applicable role and using an irrelevant flag either warns or reports an error instead of silently ignoring it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100