This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
ValidatorIndex
is context-dependent but the docs don't explain that.
#1899
Labels
I7-documentation
Documentation needs fixing, improving or augmenting.
We have a type
ValidatorIndex
which is an alias to a u32 which represents a validator, as the docs say, in a lightweight manner. As far as I understand, theValidatorIndex
implicitly depends on the current validator set. The problem is the notion of current.While we could update the
ValidatorIndex
's docs, I think there is a bigger problem. It is not immediately obvious what does "current" means.For example, let's take the AV subsystem (note that the issue is not limited to this particular area). It has the following message
as far as I understand, this index is the index of a validator from the set of all active validators in the session when this candidate got backed, but that requires a bit of knowledge and requires some guess work. That seems to be inviting for some subtle issues.
The text was updated successfully, but these errors were encountered: