gen-upgrade-proposal.sh is a script to help the chain participant (usually a validator) generate a governance proposal transaction to upgrade an agoric-sdk based chain.
Some of the information must be provided, such as expected upgrade height, or upgrade name, and descriptions.
The script is currently outputting plain text instruction, including a command template meant to be copy/pasted with placeholders data for the above information. This results in the inability to script this process, and this helper script no longer being used for upgrades of the agoric-3 chain.
Description of the Design
Script accepting needed input as command line parameters or environment variables
Consider a way to extract information such as upgrade name (possibly related to #7012 for a way to configure the codebase with the expected upgrade name)
Consider integrating the block estimator to calculate an upgrade height
Consider an interactive prompt with sane defaults if some information is not provided, e.g. for the title and description
Issue the command directly instead of printing it out
There should remain an option to print out the agd tx command, albeit fully populated, so that the validator can manually verify the transaction before submitting it
Furthermore the script does not currently support indicating core proposal information, which is needed for upgrade-14
Security Considerations
The script must remain legible, especially around how the tx command is generated, for validators to trust its output.
Scaling Considerations
None
Test Plan
Manual?
Upgrade Considerations
This is to facilitate upgrade instructions, but has no bearing on the actual upgrade.
mhofman
commented
5 months ago
What is the Problem Being Solved?
gen-upgrade-proposal.shis a script to help the chain participant (usually a validator) generate a governance proposal transaction to upgrade an agoric-sdk based chain.Some of the information must be provided, such as expected upgrade height, or upgrade name, and descriptions.
The script is currently outputting plain text instruction, including a command template meant to be copy/pasted with placeholders data for the above information. This results in the inability to script this process, and this helper script no longer being used for upgrades of the
agoric-3chain.Description of the Design
agd txcommand, albeit fully populated, so that the validator can manually verify the transaction before submitting itFurthermore the script does not currently support indicating core proposal information, which is needed for upgrade-14
Security Considerations
The script must remain legible, especially around how the
txcommand is generated, for validators to trust its output.Scaling Considerations
None
Test Plan
Manual?
Upgrade Considerations
This is to facilitate upgrade instructions, but has no bearing on the actual upgrade.