Does get-signer-grant-message-hash's docstring mention pox-addr by mistake?

Open Beginner friendly
#7,469 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Domain
documentation

Research direction

Open stackslib/src/chainstate/stacks/boot/pox-5.clar at get-signer-grant-message-hash and compare its docstring with the function arguments and hash fields described in the issue. Remove the unrelated pox-addr sentence, then review the surrounding documentation to confirm the function description matches its current interface.

Written by the indexing model from the issue text.

Description

In pox-5.clar at 4.0.1, the docstring on get-signer-grant-message-hash ends:

The pox-addr field is optional. When none, it means the signer key can be used for any PoX address.

But the function takes only signer-manager and auth-id, and hashes {topic, signer-manager, auth-id} — no pox-addr. Carry-over from pox-4? Worth deleting I think.

Dominant language
Rust
Stars
3.1k
Forks
762
Avg merge
4d 6h
Merged PRs (30d)
76

Contributor guide

Open the contributing guide

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.

More from stacks-network/stacks-core

All issues in stacks-network/stacks-core

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.