Feat: Refactor and Enhance Artifact Management Functions #6
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.
Overview:
This PR introduces a comprehensive update to the artifact management functions within the
zodiac-core
package, with the goal of improving usability, clarity, and maintainability. The changes include renaming, restructuring, and enhancing various artifact-related methods, as well as updating the corresponding documentation to reflect these improvements.Key Changes:
Function Renaming & Restructuring:
writeMastercopyArtifact
is now split into two distinct functions:writeMastercopyFromBuild
: Collects and stores artifact data from a local contract build.writeMastercopyFromExplorer
: Retrieves and stores artifact data from a deployed contract by querying a blockchain explorer.deployMastercopies
is nowdeployAllMastercopies
.verifyMastercopies
is nowverifyAllMastercopies
.readMastercopyArtifact
is nowreadMastercopy
.New Functionality:
getSourceCode
utility to fetch contract source code, ABI, and other relevant data from an explorer API.verifySourceCode
method, which offers improved source code verification capabilities.Documentation Updates:
Codebase Cleanup:
Impact:
These changes make it easier for developers to manage and verify mastercopy artifacts, whether they are working with locally built contracts or deployed contracts on a blockchain. The updates also align the codebase with best practices, facilitating future enhancements and maintenance.