Skip to content
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.

Sign up for GitHub

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

Update docs for Foundry Upgrades to v0.4.0 #1120

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Update docs for Foundry Upgrades to v0.4.0 #1120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions docs/modules/ROOT/pages/foundry/pages/foundry-upgrades.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,27 +59,25 @@ Follow the steps above, but instead of running `forge install OpenZeppelin/openz
npm install @openzeppelin/foundry-upgrades
----

Then add the following additional lines to `remappings.txt`, in addition to the ones described above:
Then add the following additional line to `remappings.txt`, in addition to the ones described above:
[source,console]
----
openzeppelin-foundry-upgrades/=node_modules/@openzeppelin/foundry-upgrades/src/
solidity-stringutils/=node_modules/@openzeppelin/foundry-upgrades/lib/solidity-stringutils/
----

==== Soldeer

Follow the steps above, but instead of running `forge install OpenZeppelin/openzeppelin-foundry-upgrades`, use one of the install commands described in https://soldeer.xyz/project/openzeppelin-foundry-upgrades

Then add the following additional lines to `remappings.txt`, in addition to the ones described above (replace `0.3.6` with the version of the plugin that you installed):
Then add the following additional line to `remappings.txt`, in addition to the ones described above (replace `0.3.6` with the version of the plugin that you installed):
[source,console]
----
openzeppelin-foundry-upgrades/=dependencies/openzeppelin-foundry-upgrades-0.3.6/src/
solidity-stringutils/=dependencies/openzeppelin-foundry-upgrades-0.3.6/lib/solidity-stringutils/
----

== Foundry Requirements

This library requires https://github.com/foundry-rs/forge-std[forge-std] version 1.8.0 or higher.
This library requires https://github.com/foundry-rs/forge-std[forge-std] version 1.9.5 or higher.

== Before Running

Expand Down
2 changes: 1 addition & 1 deletion submodules/openzeppelin-foundry-upgrades
Open in desktop
Submodule openzeppelin-foundry-upgrades updated 21 files
+0 −3 .gitmodules
+13 −1 CHANGELOG.md
+1 −1 LICENSE
+3 −5 README.md
+3 −5 docs/modules/pages/foundry-upgrades.adoc
+1 −1 lib/forge-std
+0 −1 lib/solidity-stringutils
+4 −5 package.json
+30 −13 src/internal/Core.sol
+47 −35 src/internal/DefenderDeploy.sol
+46 −0 src/internal/StringFinder.sol
+23 −34 src/internal/Utils.sol
+1 −1 src/internal/Versions.sol
+4 −4 test-profiles/build-info-v2-bad/test/Upgrades.t.sol
+19 −9 test/Upgrades.t.sol
+20 −28 test/UpgradesUseDefenderDeploy.t.sol
+9 −0 test/contracts/Validations.sol
+13 −11 test/internal/DefenderDeploy.t.sol
+56 −0 test/internal/StringFinder.t.sol
+5 −4 test/internal/Utils.t.sol
+970 −33 yarn.lock
Loading