Simplify common.Engine API #3406
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
yacovm
force-pushed
the
tidyEngineAPI
branch
4 times, most recently
from
26015d1
to
4a200b1
Compare
philipjonsen
approved these changes
Sep 20, 2024
darioush
approved these changes
Sep 23, 2024
yacovm
force-pushed
the
tidyEngineAPI
branch
2 times, most recently
from
a839591
to
3cacae5
Compare
chains/manager.go
Outdated
| @@ -1013,17 +1017,19 @@ func (m *manager) createAvalancheChain( | |||
| avalancheBootstrapperConfig.StopVertexID = m.Upgrades.CortinaXChainStopVertexID | |||
| } | |||
|
|
|||
| avalancheBootstrapper, err := avbootstrap.New( | |||
| var avalancheBootstrapper common.BootstrapableEngine | |||
| avBoot, err := avbootstrap.New( | |||
There was a problem hiding this comment.
I don't think we actually need the avBoot var.
Suggested change
| avBoot, err := avbootstrap.New( | |
| avalancheBootstrapper, err = avbootstrap.New( |
I think the only place we use avBoot we could just use avalancheBootstrapper
There was a problem hiding this comment.
avbootstrap.New now returns a concrete type.
common.TraceBootstrapableEngine returns an interface type, so we cannot override the original reference of the bootstrapper any longer.
There was a problem hiding this comment.
I understand that, but avalancheBootstrapper has type common.TraceBootstrapableEngine. We can assign to it directly here without creating an intermediate variable avBoot.
There was a problem hiding this comment.
Got it, thanks for clarifying.
Fixed!
yacovm
force-pushed
the
tidyEngineAPI
branch
from
3cacae5
to
50841e1
Compare
Halt() is only used for the bootstrapper engine, and not invoked on other engine types. Context() is only used in tests. Therefore, this commit removes these methods from the common engine API to simplify it. Signed-off-by: Yacov Manevich <yacov.manevich@avalabs.org>
yacovm
force-pushed
the
tidyEngineAPI
branch
from
50841e1
to
438f527
Compare
StephenButtolph
approved these changes
Sep 24, 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.
Why this should be merged
Halt() is only used for the bootstrapper engine, and not invoked on other engine types.
Context() is only used in tests.
Therefore, this commit removes these methods from the common engine API to simplify it.
How this works
Tidies up some code.
How this was tested
Unit tests