Add documentation on Validator Sets

This commit is contained in:
Luke Parker
2022-07-20 01:45:07 -04:00
parent d320af06a7
commit 1994dab634
3 changed files with 90 additions and 9 deletions

View File

@@ -1,17 +1,19 @@
# Register (message)
# Validators
### Register (message)
- `validator` (signer): Address which will be the validator on Substrate.
- `manager` (signer): Address which will manage this validator.
- `set` (u8): Validator set being joined.
- `set` (VS): Validator set being joined.
Marks `validator` as a validator candidate for the given validator set, enabling
delegation.
Marks `validator` as a validator candidate for the specified validator set,
enabling delegation.
# Delegate (message)
### Delegate (message)
- `delegator` (signer): Address delegating funds to `validator`.
- `validator` (address): Registered validator being delegated to.
- `amount` (u64): Amount of funds being delegated to `validator`.
- `amount` (Amount): Amount of funds being delegated to `validator`.
Delegated funds will be removed from `delegator`'s wallet and moved to
`validator`'s bond. If `validator`'s bond is not a multiple of the validator
@@ -21,11 +23,11 @@ delegator reduces their bond.
Note: At launch, only `validator`'s manager will be able to delegate to
`validator`, and only in multiples of the validator set's bond.
# Undelegate (message)
### Undelegate (message)
- `delegator` (signer): Address removing delegated funds from `validator`.
- `validator` (address): Registered validator no longer being delegated to.
- `amount` (u64): Amount of funds no longer being delegated to
- `amount` (Amount): Amount of funds no longer being delegated to
`validator`.
If a sufficient amount of funds are queued, the `validator`'s operation
@@ -36,7 +38,7 @@ forming a sufficient queue.
Note: At launch, only multiples of the validator set's bond will be valid.
# Resign (message)
### Resign (message)
- `validator` (address): Validator being removed from the pool/candidacy.
- `manager` (signer): Manage of `validator`.