Closed
Conversation
added 30 commits
May 16, 2024 11:16
…mp-package feat(rework): implement `bump-package`
…nfig and runtime config
…ript feat(rework): implement `script`
…er-defined-config feat(rework): implement `user-defined-config`
…d-initialize-guard feat(rework): implement `add-initialize-guard`
…d-default-contracts feat(rework): implement `add-default-contracts`
…d-profile feat(rework): implement `add-profile`
…th-to-generate-artifact
…store-transparent-proxy-v4_9_5 feat(rework): implement `restore-transparent-proxy-v4_9_5`
…adapt new forge version when generating storage layout
Co-authored-by: HuyHuynh <63286199+huyhuynh3103@users.noreply.github.com>
…x-bug feat(rework): implement `fix-bug`
…nitializer fix: add --json when inspecting methodIdentifiers
BREAKING_CHANGE: adapt soldeer, enhance script runtime, extra features
…e/rework chore(`rework`): merge from `release/v0.3.0`
This file contains hidden or 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
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.
Description
This pull request introduces significant updates to the repository, including workflow enhancements, dependency management improvements, and the removal of legacy submodules. It also adds new scripts for artifact generation and deployment, updates configuration files, and replaces Solidity-based artifact generation with a shell script. Below are the most important changes grouped by theme:
Workflow and Dependency Management:
.github/workflows/test.ymlto include new branch patterns (implement-feature/**) and replaced the nightly Foundry version installation with asoldeerinstallation step. ([[1]](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-faff1af3d8ff408964a57b2e475f69a6b7c7b71c9978cccc8f471798caac2c88L6-R15),[[2]](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-faff1af3d8ff408964a57b2e475f69a6b7c7b71c9978cccc8f471798caac2c88L34-R41))forge-std,openzeppelin-contracts,solady, andcontract-libs) and replaced them with direct dependencies infoundry.toml. Dependencies are now managed viasoldeer. ([[1]](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-fe7afb5c9c916e521401d3fcfb4277d5071798c3baf83baf11d6071742823584L1-L16),[[2]](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-bac743fe3d899998e32393af53af8cc7d28c89c3d7fabfa48b01361cf8d42d9bL4-R55))Configuration Updates:
foundry.tomlto reflect changes in dependency paths, compiler version (solcupdated to0.8.23), and Ethereum Virtual Machine (EVM) version (istanbultolondon). Added new formatting options and dependency definitions. ([foundry.tomlL4-R55](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-bac743fe3d899998e32393af53af8cc7d28c89c3d7fabfa48b01361cf8d42d9bL4-R55))package.jsonandremappings.txt, indicating a shift away from JavaScript-based tooling and remapping configurations. ([[1]](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519L1-L23),[[2]](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-6ea402a2ca81b3b6f5dba5eed6bfac5e5d8bf8660be870732ad6e202e1038a68L1))New Scripts:
generate-artifact.shto replace Solidity-based artifact generation with a shell script, simplifying the process and leveragingforge inspectfor metadata extraction. ([generate-artifact.shR1-R124](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-ce6a3d39c6970f58a987c35113b1aa2f8528c2914449a4d75c5e11ee90eccfd9R1-R124))run.shfor enhanced deployment scripting, including options for pre/post-checks, artifact generation, and address export functionality. ([run.shR1-R210](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-d31ce0453051853c17ba2a5225b3d1bfab548e095bab0967d6acfd1b3ce1b35dR1-R210))Legacy Code Removal:
ArtifactFactory.sol, which previously handled artifact generation, and replaced it with the new shell-based approach. ([script/ArtifactFactory.solL1-L97](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-8d64589e28c7a8d88da4a49043b57e08a40f860af1d5fa32b49ba36b2bd50bb5L1-L97))BaseGeneralConfig.soland related configurations, consolidating functionality into updated runtime and dependency configurations. ([script/BaseGeneralConfig.solL1-R30](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-a8ea1183e31f5ca535bcc1bf9ecead71e19ec7aae389e8a28b6d6a2954952c1aL1-R30))Installation Enhancements:
install.shto automate the installation of dependencies (foundry,rustup,soldeer, andjq) and ensure the environment is correctly set up. ([install.shR1-R28](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-043df5bdbf6639d7a77e1d44c5226fd7371e5259a1e4df3a0dd5d64c30dca44fR1-R28))Checklist