Remove unused dBFT APIs #104
Merged
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
|
If everything is OK wrt these movements, then I'll update the documentation. |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #104 +/- ##
==========================================
- Coverage 63.60% 62.80% -0.80%
==========================================
Files 26 27 +1
Lines 1547 1546 -1
==========================================
- Hits 984 971 -13
- Misses 495 508 +13
+ Partials 68 67 -1 ☔ View full report in Codecov by Sentry. |
roman-khimov
requested changes
Mar 6, 2024
NextConsensus API is not used by the users of dBFT. NextConsensus handling (proposal, verification and agrreement) is moved to the upper level of dBFT users. Starting from this commit NextConsensus verification should be performed by dBFT user manually in WithVerifyPrepareRequest callback. A part of #84. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>
AnnaShaleva
force-pushed
the
reduce-apis
branch
2 times, most recently
from
7a66df1
to
f1951ae
Compare
Version context field is always set to 0. There is no API to change Version in dBFT context. Given a possibility of Block version change, we either need to introduce this Version initializer or need to move Version handling out of dBFT. The latter case is chosen, because in this case block/PrepareRequest version can be handled directly by node depending on block index fetched from dBFT context. Also remove Version() block API, it's unused. A part of #84. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>
It's unused by dBFT, and thus, it's not needed in this interface. If this property is used by dBFT user, then the user need to convert dBFT Block to user's Block and retrieve all necessary info. A part of #84. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>
All dBFT payloads implementations should be kept in the same package or have exported fields. It's inevitable since dBFT user have to refer to payload fields via converting dBFT interfaces to user-defined local structures. dBFT test (`dbft_test` package) imports custom payloads implementations from `internal`. Since all payloads will be moved to the same package, we need to split this package from `main` package of simulation. A consequence of #84. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>
It's needed to be able to cast dBFT payload interfaces to local user-defined payloads implementations during consensus service functioning. A psrt of #84. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>
It's unused by dBFT and thus, should be removed from Block interface. If user need to access this data, then he should convert dbft.Block to the local user-defined Block implementation. A part of #84. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>
This API is unused by dBFT. If a user needs to access ChangeView timestamp, he has to convert dbft.ChangeView to the user-defined ChangeView implementation. A part of #84. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>
roman-khimov
reviewed
Mar 6, 2024
Store Timer interface along with other dBFT interfaces and provide default timer implementation in `timer` package. Create `dbft.HV` interface and configuration for its customisation. Provide default implementation of `dbft.HV` in `timer` package. A part of #84. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>
Also add a record to CHANGELOG.md. A part of #84. Signed-off-by: Anna Shaleva <shaleva.ann@nspcc.ru>
roman-khimov
approved these changes
Mar 8, 2024
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.
This PR removes exported APIs from interfaces declared in the dbft package. Those APIs are remove that are not used by dBFT. If dBFT user wants to access some of removed dbft payloads APIs, then it should cast dbft payload interface to the corresponding locally-defined payload implementation.
Regarding to the rest of APIs, @roman-khimov, need your opinion:
Timerrelated Config API is currently unused in both NeoGo and Bane (WithTimer,WithTimestampIncrement). Default timer implementation is used, thus, timer API may be removed (exceptWithSecondsPerBlock). However, in general it's nice to have the ability to customize timer. What is the desired behaviour? (I vote to keep it).VerifyPrepareResponseis currently unused by NeoGo and Bane, no verification is being performed, but it may be useful for future Bane consensus, thus I'd suggest to keep it.Close #84.