Replace snowball/snowflake interface with single shared snow interface #2717
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aaronbuchwald
commented
Feb 8, 2024
aaronbuchwald
commented
Feb 8, 2024
aaronbuchwald
commented
Feb 8, 2024
aaronbuchwald
commented
Feb 8, 2024
aaronbuchwald
commented
Feb 8, 2024
aaronbuchwald
commented
Feb 8, 2024
aaronbuchwald
commented
Feb 8, 2024
Signed-off-by: aaronbuchwald <aaron.buchwald56@gmail.com>
Signed-off-by: aaronbuchwald <aaron.buchwald56@gmail.com>
aaronbuchwald
requested review from
gyuho and
StephenButtolph
as code owners
joshua-kim
reviewed
Feb 12, 2024
joshua-kim
added
cleanup
joshua-kim
approved these changes
Feb 12, 2024
StephenButtolph
approved these changes
Feb 12, 2024
Signed-off-by: Stephen Buttolph <stephen@avalabs.org>
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why this should be merged
This PR replaces the separate snowball/snowflake interfaces for the Unary, Binary, and Nnary consensus types with a single shared snow interface.
The only difference that we change is previously
UnarySnowballhad aRecordPollPreferencefunction whereasUnarySnowflakedid not. The reason for this is that in the unary case, there is only one possible preference and we have not received enough votes to increment our confidence towards finalizing.Therefore, in the snowball case where we maintain a confidence counter for preference, this has the impact of increasing our confidence in our current preference even though we don't get closer to finalizing.
In snowflake, there is no notion of incrementing confidence in our preference, so
RecordPollPreferencesimply resets the confidence counter on a unary instance.This also removes the slush interfaces since there is only a single implementation.
How this works
This code change is intended solely as a refactor to reduce instances where we have an interface where there is only a single implementation.
How this was tested
This was tested with the existing unit tests and uses the same snowball/snowflake consensus factory as the unit tests previously used since the current tests are specific to the snowball/snowflake implementation behaviors.