-
Notifications
You must be signed in to change notification settings - Fork 232
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: remove params
dependency on modules
#1261
Draft
ARR4N
wants to merge
27
commits into
master
Choose a base branch
from
arr4n/circular-dep-types-precompiles
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
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
…epend on `modules`
…msjson"` instead
…f precompile addresses
…ns to minimise diff
* Stop exporting any identifiers, relying solely on `_` importing * Split out `Unmarshal()` type switch into specific functions
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
Note
This will probably be replaced by #1271
Importing
core/types
fromprecompile/{modules,contract}
results in a circular dependency becausetypes
->params
->precompile/modules
->precompile/contract
->types
.How this works
As you can see from the commit history, this took a lot of experimentation! The final result:
params
only depended onmodules
for unmarshalling JSON, so all such functionality is abstracted into a newparamsjson
package. To avoid having to importparamsjson
, theparams
package instead exposesparams.RegisterJSONUnmarshalers()
, which allowsparamsjson
to inject its functionality in aninit()
function.The
paramsjson
package doesn't export anything, and should instead be blank_
imported. This is similar to registering SQL drivers. The_
import has been added where necessary.The alternative of using
paramsjson.Unmarshal()
in lieu ofjson.Unmarshal()
proved problematic because of the number of other types withparams.ChainConfig
and other problematic types as fields.Methods on
*params.ChainConfig
that relied on themodules
package were only using it to access all precompile addresses.precompileconfig.Config
now exposes the precompile's address, and theChainConfig
methods only know of the addresses that they receive as arguments or carry inGenesisPrecompiles
andUpgradeConfig
fields.How this was tested
All existing CI tests.
How is this documented
Standard Go comments.