Update docstrings of Storage
fields relating to blocks
#650
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates some docstrings of fields that relate to blocks, to make it clearer how they are currently used in the code.
storage.last_height
andstorage.last_epoch
are always to do with the most recently committed block (assuming at least one block has been committed). Which block other block-related fields are concerned with depends on the stage of ABCI the shell is in. e.g.storage.block.height
is the next block to be committed duringFinalizeBlock
andCommit
, but otherwise is the same asstorage.last_height
.We could probably at some point get rid of either
storage.block.height
/storage.block.epoch
orstorage.last_block
/storage.last_epoch
and just use one or the other, to simplify things.