Clarify or Utilize `round` Parameter in `PendingStake` Method
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 42/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- solidity
- Domain
- blockchain
Research direction
Start with the PendingStake method in contracts/bonding/BondingManager.sol around line 935 and review how its round parameter is exposed in the BondingManager interface and documentation. Determine whether the parameter has an intended use; done means either documenting that it is unused and explaining its purpose, or defining and implementing an agreed round-specific behavior.
Written by the indexing model from the issue text.
Description
In the PendingStake method of the
BondingManager, the round parameter is currently unused:
To improve clarity and reduce potential confusion for integrators and developers, I propose one of the following actions:
-
Update the method description and documentation to explicitly state that the
roundparameter is currently unused, and clarify its intended purpose (if any future usage is planned). -
Upgrade the protocol to make use of the
roundparameter, if there is an intended use case (e.g., allowing querying of stake at a specific round).
This change will help avoid misinterpretation and make the API more intuitive and self-explanatory for future development and integrations.
- Dominant language
- JavaScript
- Stars
- 155
- Forks
- 50
- PR merge metrics
- No merged PRs in 30d
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.
More from livepeer/protocol
-
known-issue
Difficulty 4/5 3-5 days Newbie friendliness 30/100
-
Winning tickets can settle for less than their face value once the recipient’s reserve is exhausted Openknown-issue
Difficulty 4/5 3-5 days Newbie friendliness 25/100
-
blockchain enhancement pm
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
known-issue
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
known-issue
Difficulty 5/5 Over a week Newbie friendliness 25/100
All issues in livepeer/protocol
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
[Block] Latest Posts [Type] Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·