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

Adding scripts to help the upgrade process #111

Merged
merged 11 commits into from
Mar 14, 2022
Merged

Conversation

TrevorJTClarke
Copy link
Contributor

No description provided.

@ctindogaru
Copy link
Collaborator

This is an amazing effort, but I feel like it adds a lot of complexity, the scripts are hard to grasp and more complicated than they should be.

Instead, I think it would be more useful to show commands examples: how to add a transfer proposal/how to create an account etc and let the user decide what flow they want to test.

@TrevorJTClarke
Copy link
Contributor Author

This is an amazing effort, but I feel like it adds a lot of complexity, the scripts are hard to grasp and more complicated than they should be.

Instead, I think it would be more useful to show commands examples: how to add a transfer proposal/how to create an account etc and let the user decide what flow they want to test.

This PR is for setting up reproducibility for upgrades. The idea is to have:

  • dev script: quick commands you, me & anyone (like auditors) else can quickly uncomment for spot testing
  • testnet script: a stable, full script that goes from current state to fully upgraded state contracts, so there i no guessing or making mistakes in commands.
  • mainnet script: a stable, full script that goes from current state to fully upgraded state contracts, same as testnet but even more careful attention to reproducible results.

Thanks for feedback on the scripts themselves, let's keep this setup going and move toward only using scripts for the upgrade process rather than comment/examples. It will help reproducible results & maintainability. Upgrade is scary, scripts will keep us sane :)

Copy link
Collaborator

@ctindogaru ctindogaru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank for putting in the work 👍

I must say some can be harder to grasp, but they can definitely be very handy during the upgrade process.

@TrevorJTClarke TrevorJTClarke added C-docs Category: documentation, including rustdoc C-Enhancement Category: An issue proposing an enhancement or a PR with one. C-housekeeping Category: Refactoring, cleanups, code quality P-High Priority: High S-L2 Size: Minor 10-20 code line change labels Feb 28, 2022
@TrevorJTClarke TrevorJTClarke merged commit 1901a30 into main Mar 14, 2022
@TrevorJTClarke TrevorJTClarke deleted the ft/upgrade-scripts branch March 14, 2022 05:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-docs Category: documentation, including rustdoc C-Enhancement Category: An issue proposing an enhancement or a PR with one. C-housekeeping Category: Refactoring, cleanups, code quality P-High Priority: High S-L2 Size: Minor 10-20 code line change
Projects
Status: Ready For QA
Development

Successfully merging this pull request may close these issues.

2 participants