-
Notifications
You must be signed in to change notification settings - Fork 206
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: make software upgrade
coreProposals conditional on upgrade pl…
…an name (#9575) closes: #9571 ## Description Parametrize the price feed core proposals by the upgrade handler name. The proposal for a3p remains with the deprecated ambient (from environment) oracle addresses. Additionally fix and add some logging to the upgrade vault proposal ### Security Considerations None ### Scaling Considerations Not a typical scaling consideration, but this introduces a "basic" upgrade name that skips all vaults related proposals. The correctly parametrized info can be provided in the chain software upgrade proposal's upgrade info for any chain that has different configuration. ### Documentation Considerations Need to communicate to validators that the pattern of upgrade names has changed. ### Testing Considerations A3P and manually tested on mainfork ### Upgrade Considerations See above
- Loading branch information
Showing
8 changed files
with
332 additions
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,215 @@ | ||
| package gaia | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "strings" | ||
| "text/template" | ||
|
|
||
| "github.com/Agoric/agoric-sdk/golang/cosmos/vm" | ||
| swingsetkeeper "github.com/Agoric/agoric-sdk/golang/cosmos/x/swingset/keeper" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/cosmos/cosmos-sdk/types/module" | ||
| upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types" | ||
| ) | ||
|
|
||
| var upgradeNamesOfThisVersion = map[string]bool{ | ||
| "UNRELEASED_BASIC": true, // no-frills | ||
| "UNRELEASED_A3P_INTEGRATION": true, | ||
| "UNRELEASED_main": true, | ||
| "UNRELEASED_devnet": true, | ||
| } | ||
|
|
||
| func isFirstTimeUpgradeOfThisVersion(app *GaiaApp, ctx sdk.Context) bool { | ||
| for name := range upgradeNamesOfThisVersion { | ||
| if app.UpgradeKeeper.GetDoneHeight(ctx, name) != 0 { | ||
| return false | ||
| } | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| // upgradePriceFeedCoreProposalSteps returns the core proposal steps for the | ||
| // price feed upgrade and associated changes to scaledPriceAuthority and | ||
| // vaultManager. | ||
| func upgradePriceFeedCoreProposalSteps(upgradeName string) ([]vm.CoreProposalStep, error) { | ||
| isThisUpgrade := func(expectedUpgradeName string) bool { | ||
| if !upgradeNamesOfThisVersion[expectedUpgradeName] { | ||
| panic(fmt.Errorf("invalid upgrade name: %s", expectedUpgradeName)) | ||
| } | ||
| return upgradeName == expectedUpgradeName | ||
| } | ||
|
|
||
| t := template.Must(template.New("").Parse(`{ | ||
| "module": "@agoric/builders/scripts/vats/priceFeedSupport.js", | ||
| "entrypoint": {{.entrypointJson}}, | ||
| "args": [{ | ||
| "AGORIC_INSTANCE_NAME": {{.instanceNameJson}}, | ||
| "ORACLE_ADDRESSES": {{.oracleAddressesJson}}, | ||
| "IN_BRAND_LOOKUP": {{.inBrandLookupJson}}, | ||
| "IN_BRAND_DECIMALS": 6, | ||
| "OUT_BRAND_LOOKUP": ["agoricNames", "oracleBrand", "USD"], | ||
| "OUT_BRAND_DECIMALS": 4 | ||
| }] | ||
| }`)) | ||
|
|
||
| var oracleAddresses []string | ||
|
|
||
| var entrypoint string | ||
| switch { | ||
| case isThisUpgrade("UNRELEASED_A3P_INTEGRATION"): | ||
| entrypoint = "deprecatedPriceFeedProposalBuilder" | ||
| case isThisUpgrade("UNRELEASED_main"): | ||
| oracleAddresses = []string{ | ||
| "agoric144rrhh4m09mh7aaffhm6xy223ym76gve2x7y78", // DSRV | ||
| "agoric19d6gnr9fyp6hev4tlrg87zjrzsd5gzr5qlfq2p", // Stakin | ||
| "agoric19uscwxdac6cf6z7d5e26e0jm0lgwstc47cpll8", // 01node | ||
| "agoric1krunjcqfrf7la48zrvdfeeqtls5r00ep68mzkr", // Simply Staking | ||
| "agoric1n4fcxsnkxe4gj6e24naec99hzmc4pjfdccy5nj", // P2P | ||
| } | ||
| entrypoint = "strictPriceFeedProposalBuilder" | ||
| case isThisUpgrade("UNRELEASED_devnet"): | ||
| oracleAddresses = []string{ | ||
| "agoric1lw4e4aas9q84tq0q92j85rwjjjapf8dmnllnft", // DSRV | ||
| "agoric1zj6vrrrjq4gsyr9lw7dplv4vyejg3p8j2urm82", // Stakin | ||
| "agoric1ra0g6crtsy6r3qnpu7ruvm7qd4wjnznyzg5nu4", // 01node | ||
| "agoric1qj07c7vfk3knqdral0sej7fa6eavkdn8vd8etf", // Simply Staking | ||
| "agoric10vjkvkmpp9e356xeh6qqlhrny2htyzp8hf88fk", // P2P | ||
| } | ||
| entrypoint = "strictPriceFeedProposalBuilder" | ||
|
|
||
| // No price feed upgrade for this version. | ||
| case isThisUpgrade("UNRELEASED_BASIC"): | ||
| } | ||
|
|
||
| if entrypoint == "" { | ||
| return []vm.CoreProposalStep{}, nil | ||
| } | ||
|
|
||
| entrypointJson, err := json.Marshal(entrypoint) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| var inBrandNames []string | ||
| switch { | ||
| case isThisUpgrade("UNRELEASED_A3P_INTEGRATION"), isThisUpgrade("UNRELEASED_main"): | ||
| inBrandNames = []string{ | ||
| "ATOM", | ||
| "stATOM", | ||
| "stOSMO", | ||
| "stTIA", | ||
| "stkATOM", | ||
| } | ||
| case isThisUpgrade("UNRELEASED_devnet"): | ||
| inBrandNames = []string{ | ||
| "ATOM", | ||
| "stTIA", | ||
| "stkATOM", | ||
| } | ||
| } | ||
|
|
||
| oracleAddressesJson, err := json.Marshal(oracleAddresses) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| proposals := make(vm.CoreProposalStep, 0, len(inBrandNames)) | ||
| for _, inBrandName := range inBrandNames { | ||
| instanceName := inBrandName + "-USD price feed" | ||
| instanceNameJson, err := json.Marshal(instanceName) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| inBrandLookup := []string{"agoricNames", "oracleBrand", inBrandName} | ||
| inBrandLookupJson, err := json.Marshal(inBrandLookup) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| var result strings.Builder | ||
| err = t.Execute(&result, map[string]any{ | ||
| "entrypointJson": string(entrypointJson), | ||
| "inBrandLookupJson": string(inBrandLookupJson), | ||
| "instanceNameJson": string(instanceNameJson), | ||
| "oracleAddressesJson": string(oracleAddressesJson), | ||
| }) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| jsonStr := result.String() | ||
| jsonBz := []byte(jsonStr) | ||
| if !json.Valid(jsonBz) { | ||
| return nil, fmt.Errorf("invalid JSON: %s", jsonStr) | ||
| } | ||
| proposals = append(proposals, vm.ArbitraryCoreProposal{Json: jsonBz}) | ||
| } | ||
| return []vm.CoreProposalStep{ | ||
| // Add new vats for price feeds. The existing ones will be retired shortly. | ||
| vm.CoreProposalStepForModules(proposals...), | ||
| // Add new auction contract. The old one will be retired shortly. | ||
| vm.CoreProposalStepForModules("@agoric/builders/scripts/vats/add-auction.js"), | ||
| // upgrade vaultFactory. | ||
| vm.CoreProposalStepForModules("@agoric/builders/scripts/vats/upgradeVaults.js"), | ||
| }, nil | ||
| } | ||
|
|
||
| // unreleasedUpgradeHandler performs standard upgrade actions plus custom actions for the unreleased upgrade. | ||
| func unreleasedUpgradeHandler(app *GaiaApp, targetUpgrade string) func(sdk.Context, upgradetypes.Plan, module.VersionMap) (module.VersionMap, error) { | ||
| return func(ctx sdk.Context, plan upgradetypes.Plan, fromVm module.VersionMap) (module.VersionMap, error) { | ||
| app.CheckControllerInited(false) | ||
|
|
||
| CoreProposalSteps := []vm.CoreProposalStep{} | ||
|
|
||
| // These CoreProposalSteps are not idempotent and should only be executed | ||
| // as part of the first upgrade using this handler on any given chain. | ||
| if isFirstTimeUpgradeOfThisVersion(app, ctx) { | ||
| // Each CoreProposalStep runs sequentially, and can be constructed from | ||
| // one or more modules executing in parallel within the step. | ||
| CoreProposalSteps = []vm.CoreProposalStep{ | ||
| // Upgrade Zoe + ZCF | ||
| vm.CoreProposalStepForModules("@agoric/builders/scripts/vats/replace-zoe.js"), | ||
| // Revive KREAd characters | ||
| vm.CoreProposalStepForModules("@agoric/builders/scripts/vats/revive-kread.js"), | ||
|
|
||
| // upgrade the provisioning vat | ||
| vm.CoreProposalStepForModules("@agoric/builders/scripts/vats/replace-provisioning.js"), | ||
| // Enable low-level Orchestration. | ||
| vm.CoreProposalStepForModules( | ||
| "@agoric/builders/scripts/vats/init-network.js", | ||
| "@agoric/builders/scripts/vats/init-localchain.js", | ||
| "@agoric/builders/scripts/vats/init-transfer.js", | ||
| ), | ||
| } | ||
| priceFeedSteps, err := upgradePriceFeedCoreProposalSteps(targetUpgrade) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| CoreProposalSteps = append(CoreProposalSteps, priceFeedSteps...) | ||
| } | ||
|
|
||
| app.upgradeDetails = &upgradeDetails{ | ||
| // Record the plan to send to SwingSet | ||
| Plan: plan, | ||
| // Core proposals that should run during the upgrade block | ||
| // These will be merged with any coreProposals specified in the | ||
| // upgradeInfo field of the upgrade plan ran as subsequent steps | ||
| CoreProposals: vm.CoreProposalsFromSteps(CoreProposalSteps...), | ||
| } | ||
|
|
||
| // Always run module migrations | ||
| mvm, err := app.mm.RunMigrations(ctx, app.configurator, fromVm) | ||
| if err != nil { | ||
| return mvm, err | ||
| } | ||
|
|
||
| m := swingsetkeeper.NewMigrator(app.SwingSetKeeper) | ||
| err = m.MigrateParams(ctx) | ||
| if err != nil { | ||
| return mvm, err | ||
| } | ||
|
|
||
| return mvm, nil | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.