Skip to content
This repository has been archived by the owner on Jan 22, 2025. It is now read-only.

Commit

Permalink
Add links to new doc
Browse files Browse the repository at this point in the history
  • Loading branch information
publish-docs.sh committed Jul 29, 2020
1 parent 1516bdc commit 4e8c69b
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 16 deletions.
1 change: 1 addition & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ module.exports = {
"running-validator",
"running-validator/validator-reqs",
"running-validator/validator-start",
"running-validator/vote-accounts",
"running-validator/validator-stake",
"running-validator/validator-monitor",
"running-validator/validator-info",
Expand Down
5 changes: 4 additions & 1 deletion docs/src/running-validator/validator-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,12 +168,15 @@ vote account on the network. If you have completed this step, you should see the
solana-keygen new -o ~/vote-account-keypair.json
```

Create your vote account on the blockchain:
The following command can be used to create your vote account on the blockchain
with all the default options:

```bash
solana create-vote-account ~/vote-account-keypair.json ~/validator-keypair.json
```

Read more about [creating and managing a vote account](vote-accounts.md).

## Trusted validators

If you know and trust other validator nodes, you can specify this on the command line with the `--trusted-validator <PUBKEY>`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Configuring a Vote Account
title: Vote Account Structure and Configuration
---

This page describes how to set up an on-chain vote account. Creating a vote
Expand All @@ -9,8 +9,6 @@ All settings for a vote account can be configured at the time the account is
created, or they can be set after the account is created while the corresponding
validator is running.

## Vote Account Structure

### Vote Account Address

A vote account is created at an address that is either the public key of a
Expand Down Expand Up @@ -75,19 +73,42 @@ voter account changes.

### Authorized Withdrawer

The Authorized Withdrawer keypair is used to withdraw funds from a vote account
using the `withdraw-from-vote-account` command. Any network rewards a validator
earns are deposited into the vote account and are only retrievable by signing
with the Authorized Withdrawer keypair.

The Authorized Withdrawer is also required to sign any transaction to change
a vote account's commission.

Because the vote account could accrue a significant balance, it is recommended
to keep the Authorized Withdrawer keypair in an offline/cold wallet, as it is
not needed to sign frequent transactions.

The Authorized Withdrawer can be set at vote account creation with the
`--authorized-withdrawer` option. If this is not provided, the Validator
Identity will be set as the Authorized Withdrawer by default.

The Authorized Withdrawer can be changed later with the `vote-authorize-withdrawer`
command.

### Commission

## Vote Account Operations
```bash
create-vote-account Create a vote account
vote-account Show the contents of a vote account
vote-authorize-voter Authorize a new vote signing keypair for the given vote account
vote-authorize-withdrawer Authorize a new withdraw signing keypair for the given vote account
vote-update-commission Update the vote account's commission
vote-update-validator Update the vote account's validator identity
withdraw-from-vote-account Withdraw lamports from a vote account into a specified account
```
Commission is the percent of network rewards earned by a validator that are
deposited into the validator's vote account. The remainder of the rewards
are distributed to all of the stake accounts delegated to that vote account,
proportional to the active stake weight of each stake account.

For example, if a vote account has a commission of 10%, for all rewards earned
by that validator in a given epoch, 10% of these rewards will be deposited into
the vote account in the first block of the following epoch. The remaining 90%
will be deposited into delegated stake accounts as immediately active stake.

Commission can be set upon vote account creation with the `--commission` option.
If it is not provided, it will default to 100%.

## Credits
Commission can also be changed later with the `vote-update-commission` command.

## Commission/Inflation/Delegation
When setting the commission, only integer values in the set [0-100] are accepted.
The integer represent the number of percentage points for the commission, so
creating an account with `--commission 10` will set a 10% commission.

0 comments on commit 4e8c69b

Please sign in to comment.