fix(consensus): Refactor block subsidy to handle Height::MAX without panicking #5787
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.
Motivation
Zebra panics when doing the block subsidy calculations for
Height::MAX
.This is unlikely to ever happen on mainnet, because it only happens when block subsidies are all zero zats. But it's good to clean it up anyway, to avoid future changes causing actual panics in production.
Specifications
https://zips.z.cash/protocol/protocol.pdf#subsidies
Designs
Use
Option<u64>
internally whenever 2Halving(height) would overflow au64
.Solution
Refactor the halving divisor to avoid overflows and panics.
Add tests for
Height::MAX
and other large values.Review
This is a routine consensus rule fix, it would be good to get two people to review it.
This doesn't need to be included in the audit, because it only happens with very large heights.
Reviewer Checklist