Skip to content

Feature/rework#170

Closed
huyhuynh3103 wants to merge 117 commits intomainnetfrom
feature/rework
Closed

Feature/rework#170
huyhuynh3103 wants to merge 117 commits intomainnetfrom
feature/rework

Conversation

@huyhuynh3103
Copy link
Contributor

@huyhuynh3103 huyhuynh3103 commented Aug 4, 2025

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:

  • Updated .github/workflows/test.yml to include new branch patterns (implement-feature/**) and replaced the nightly Foundry version installation with a soldeer installation 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))
  • Removed Git submodules (forge-std, openzeppelin-contracts, solady, and contract-libs) and replaced them with direct dependencies in foundry.toml. Dependencies are now managed via soldeer. ([[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:

  • Updated foundry.toml to reflect changes in dependency paths, compiler version (solc updated to 0.8.23), and Ethereum Virtual Machine (EVM) version (istanbul to london). Added new formatting options and dependency definitions. ([foundry.tomlL4-R55](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-bac743fe3d899998e32393af53af8cc7d28c89c3d7fabfa48b01361cf8d42d9bL4-R55))
  • Removed package.json and remappings.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:

  • Added generate-artifact.sh to replace Solidity-based artifact generation with a shell script, simplifying the process and leveraging forge inspect for metadata extraction. ([generate-artifact.shR1-R124](https://github.com/axieinfinity/foundry-deployment-kit/pull/170/files#diff-ce6a3d39c6970f58a987c35113b1aa2f8528c2914449a4d75c5e11ee90eccfd9R1-R124))
  • Introduced run.sh for 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:

  • Removed the Solidity-based 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))
  • Removed BaseGeneralConfig.sol and 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:

  • Added install.sh to automate the installation of dependencies (foundry, rustup, soldeer, and jq) 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

  • I have clearly commented on all the main functions following the NatSpec Format
  • The box that allows repo maintainers to update this PR is checked
  • I tested locally to make sure this feature/fix works

TuDo1403 added 30 commits May 16, 2024 11:16
…mp-package

feat(rework): implement `bump-package`
…er-defined-config

feat(rework): implement `user-defined-config`
tringuyenskymavis and others added 29 commits August 27, 2024 17:26
…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`
…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>
…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`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants