Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Vote Account Management Doc #11278

Merged
merged 8 commits into from
Jul 31, 2020
Merged

Conversation

danpaul000
Copy link
Contributor

Problem

We have no doc describing the features and knobs for managing a vote account.

Summary of Changes

Add one.

docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
@danpaul000 danpaul000 marked this pull request as ready for review July 29, 2020 23:05
@danpaul000 danpaul000 requested review from garious and t-nelson July 29, 2020 23:05
### Vote Account Address

A vote account is created at an address that is either the public key of a
keypair file, or at a derived address from the authorized voter's public key.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Authorized voter

docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
### Vote Account Address

A vote account is created at an address that is either the public key of a
keypair file, or at a derived address from the authorized voter's public key.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A derived address doesn't technically have to be based off either authority. It can be any ole keypair. Perhaps that technicality doesn't need communicated here though?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can leave the technicality out, but the CLI description is actually rather confusing to me, looking at it again:

        --seed <STRING>
            Seed for address generation; if specified, the resulting account will be at a derived address of the VOTE
            ACCOUNT pubkey

That's the only place we use the term VOTE ACCOUNT in the help text. I assume this is referring to the vote account keypair positional arg? In which case my description here about deriving from the vote auth pubkey is just wrong anyway.

docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
@mergify mergify bot dismissed t-nelson’s stale review July 30, 2020 15:08

Pull request has been modified.

docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Show resolved Hide resolved
docs/src/running-validator/vote-accounts.md Outdated Show resolved Hide resolved
@danpaul000 danpaul000 added the automerge Merge this Pull Request automatically once CI passes label Jul 31, 2020
@mergify mergify bot merged commit a5b6fd3 into solana-labs:master Jul 31, 2020
mergify bot pushed a commit that referenced this pull request Jul 31, 2020
* Add vote account management doc

* Add links to new doc

* Whitespace

* Fixup language

* Cleaner title

* Apply review feedback

* Apply further feedback

* Fix usage page header

Co-authored-by: publish-docs.sh <maintainers@solana.com>
(cherry picked from commit a5b6fd3)
mergify bot added a commit that referenced this pull request Jul 31, 2020
* Add vote account management doc

* Add links to new doc

* Whitespace

* Fixup language

* Cleaner title

* Apply review feedback

* Apply further feedback

* Fix usage page header

Co-authored-by: publish-docs.sh <maintainers@solana.com>
(cherry picked from commit a5b6fd3)

Co-authored-by: Dan Albert <dan@solana.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this Pull Request automatically once CI passes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants