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

chore: add upgrade guide for v.1.5 #507

Merged
merged 1 commit into from
Jul 8, 2024

Conversation

marcelstanley
Copy link
Collaborator

@marcelstanley marcelstanley commented Jul 5, 2024

Relates to #432. Requirement for v1.5


Evidence that the steps were executed on devnet and that inputs/outputs from v1.4.0 match the ones in v1.5.0 after the upgrade is complete:

@marcelstanley marcelstanley added this to the 1.5.0 milestone Jul 5, 2024
@marcelstanley marcelstanley requested review from pedroargento, guidanoli and a team July 5, 2024 20:52
@marcelstanley marcelstanley self-assigned this Jul 5, 2024
@marcelstanley marcelstanley force-pushed the chore/upgrade_script_for_1_5 branch 4 times, most recently from ee0e655 to a7189df Compare July 5, 2024 21:50
Copy link
Contributor

@guidanoli guidanoli left a comment

Choose a reason for hiding this comment

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

It might be worth noting that the new History will contain no claims, and that they will need to be submitted by the Authority again, one by one.

Might be interesting also to run these cast commands locally, on a local fork or local devnet, and show an example of the expected output, so that users can know if they're following the migration guide correctly.

Also, would be interesting to show how these read and write functions can be called on Etherscan. Might be a more friendly UI for less seasoned web3 developers. We have contracts verified for the main networks, and one can easily call read-only functions (such as calculateHistoryAddress, and, after connecting their browser wallets, submit state-changing txs (such as newHistory and setHistory). In this case, screenshots might be useful.

docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
@marcelstanley marcelstanley force-pushed the chore/upgrade_script_for_1_5 branch 3 times, most recently from 0ffb064 to a2dab18 Compare July 6, 2024 20:02
@marcelstanley
Copy link
Collaborator Author

marcelstanley commented Jul 6, 2024

It might be worth noting that the new History will contain no claims, and that they will need to be submitted by the Authority again, one by one.

Added note

Might be interesting also to run these cast commands locally, on a local fork or local devnet, and show an example of the expected output, so that users can know if they're following the migration guide correctly.

Sure, that was always the plan! I've just added that to the PR description above.

Also, would be interesting to show how these read and write functions can be called on Etherscan. Might be a more friendly UI for less seasoned web3 developers. We have contracts verified for the main networks, and one can easily call read-only functions (such as calculateHistoryAddress, and, after connecting their browser wallets, submit state-changing txs (such as newHistory and setHistory). In this case, screenshots might be useful.

That would be a nice addition. Perhaps we should move this whole guide to the wiki, then. 🤔

Thanks a lot for your help, @guidanoli!

@marcelstanley marcelstanley requested a review from guidanoli July 6, 2024 20:13
@marcelstanley marcelstanley force-pushed the chore/upgrade_script_for_1_5 branch from a2dab18 to f68869e Compare July 6, 2024 20:18
GMKrieger
GMKrieger previously approved these changes Jul 6, 2024
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
docs/upgrade_to_1_5.md Outdated Show resolved Hide resolved
@marcelstanley marcelstanley force-pushed the chore/upgrade_script_for_1_5 branch from 2f00199 to 9837d0d Compare July 8, 2024 13:56
@marcelstanley marcelstanley requested a review from guidanoli July 8, 2024 13:56
Copy link
Contributor

@guidanoli guidanoli left a comment

Choose a reason for hiding this comment

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

LGTM

@marcelstanley marcelstanley merged commit c200b94 into main Jul 8, 2024
6 checks passed
@marcelstanley marcelstanley deleted the chore/upgrade_script_for_1_5 branch July 8, 2024 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants