-
Notifications
You must be signed in to change notification settings - Fork 30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor(backend): ♻️ substantial refactor of generic usage in the codebase #22
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
New code uses explicit `madara_runtime::opaque::Block` as Substrate block type with `H256` hash. This makes it easier to reason about types in the codebase, since in any case we are only dealing with one block time which should be cleary stated. > **TODO**: futher refactor needed
antiyro
reviewed
Mar 22, 2024
antiyro
reviewed
Mar 22, 2024
antiyro
reviewed
Mar 22, 2024
antiyro
reviewed
Mar 22, 2024
antiyro
reviewed
Mar 22, 2024
antiyro
reviewed
Mar 22, 2024
Also added some new `check` and `ready` options to `./scripts/deoxys` to make these easier to detect.
Tbelleng
reviewed
Mar 22, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Backend refacto seems good to me 👍
Tbelleng
approved these changes
Mar 22, 2024
antiyro
approved these changes
Mar 23, 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.
Pull Request type
Please add the labels corresponding to the type of changes your PR introduces:
What is the current behavior?
Deoxys in its current state overly relies on generic types to satisfy Substrate function requirements. This is not necessary since we know the type of our blocks at compile time. This PR aims to fix this issue.
What is the new behavior?
sp_runtime::traits::Block as BlockT
andsp_runtime::traits::Block::Hash as HashT
throughout the codebase.DBlockT
,DHeaderT
andDHashT
. These serve as a standard for the types deoxys uses throughout the codebase and allow for easier reasoning as to the types we are working with. This is especially the case inl2.rs
which can undoubtedly be further refactored as a result.mc_db::Backend
tomc_db::DeoxysBackend
and made it a singleton. Note that this means that backend databases now have to be accessed via static methods. Take a look at the code incrates/client/db/src/lib.rs
for more information.Does this introduce a breaking change?
No.
Other information