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.

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

Prepare for NPM publishing, update instructions for NPM and Soldeer #86

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

ericglau
Copy link
Member

  • Updates package.json for publishing to NPM
    • Sets upgrades-core and defender-deploy-client-cli as optionalDependencies, since those are often run but not always required (for example if users do not run upgrade safety checks or Defender)
    • Updates the package name to @openzeppelin/foundry-upgrades
      • Users can use the package name as @openzeppelin/foundry-upgrades in their Solidity scripts/tests, but we leave the examples as openzeppelin-foundry-upgrades and use remappings to avoid confusion (since the same instructions are also used for Git submodules or Soldeer)
  • Adds instructions for NPM and Soldeer installations
    • While OpenZeppelin Contracts (and Upgradeable Contracts) could also be installed with NPM or Soldeer, we omit that from the instructions to avoid further confusion, since the steps are already complex

Fixes #40

@ericglau ericglau requested a review from a team November 26, 2024 22:25
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.

Consider using NPM for distributing this package
1 participant