94 lines
3.7 KiB
Go
94 lines
3.7 KiB
Go
package upgrade
|
|
|
|
import (
|
|
"fmt"
|
|
"time"
|
|
|
|
abci "github.com/tendermint/tendermint/abci/types"
|
|
|
|
"github.com/cosmos/cosmos-sdk/telemetry"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
"github.com/cosmos/cosmos-sdk/x/upgrade/keeper"
|
|
"github.com/cosmos/cosmos-sdk/x/upgrade/types"
|
|
)
|
|
|
|
// BeginBlock will check if there is a scheduled plan and if it is ready to be executed.
|
|
// If the current height is in the provided set of heights to skip, it will skip and clear the upgrade plan.
|
|
// If it is ready, it will execute it if the handler is installed, and panic/abort otherwise.
|
|
// If the plan is not ready, it will ensure the handler is not registered too early (and abort otherwise).
|
|
//
|
|
// The purpose is to ensure the binary is switched EXACTLY at the desired block, and to allow
|
|
// a migration to be executed if needed upon this switch (migration defined in the new binary)
|
|
// skipUpgradeHeightArray is a set of block heights for which the upgrade must be skipped
|
|
func BeginBlocker(k keeper.Keeper, ctx sdk.Context, _ abci.RequestBeginBlock) {
|
|
defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyBeginBlocker)
|
|
|
|
plan, found := k.GetUpgradePlan(ctx)
|
|
|
|
if !k.DowngradeVerified() {
|
|
k.SetDowngradeVerified(true)
|
|
lastAppliedPlan, _ := k.GetLastCompletedUpgrade(ctx)
|
|
// This check will make sure that we are using a valid binary.
|
|
// It'll panic in these cases if there is no upgrade handler registered for the last applied upgrade.
|
|
// 1. If there is no scheduled upgrade.
|
|
// 2. If the plan is not ready.
|
|
// 3. If the plan is ready and skip upgrade height is set for current height.
|
|
if !found || !plan.ShouldExecute(ctx) || (plan.ShouldExecute(ctx) && k.IsSkipHeight(ctx.BlockHeight())) {
|
|
if lastAppliedPlan != "" && !k.HasHandler(lastAppliedPlan) {
|
|
panic(fmt.Sprintf("Wrong app version %d, upgrade handler is missing for %s upgrade plan", ctx.ConsensusParams().Version.AppVersion, lastAppliedPlan))
|
|
}
|
|
}
|
|
}
|
|
|
|
if !found {
|
|
return
|
|
}
|
|
logger := ctx.Logger()
|
|
|
|
// To make sure clear upgrade is executed at the same block
|
|
if plan.ShouldExecute(ctx) {
|
|
// If skip upgrade has been set for current height, we clear the upgrade plan
|
|
if k.IsSkipHeight(ctx.BlockHeight()) {
|
|
skipUpgradeMsg := fmt.Sprintf("UPGRADE \"%s\" SKIPPED at %d: %s", plan.Name, plan.Height, plan.Info)
|
|
logger.Info(skipUpgradeMsg)
|
|
|
|
// Clear the upgrade plan at current height
|
|
k.ClearUpgradePlan(ctx)
|
|
return
|
|
}
|
|
|
|
// Prepare shutdown if we don't have an upgrade handler for this upgrade name (meaning this software is out of date)
|
|
if !k.HasHandler(plan.Name) {
|
|
// Write the upgrade info to disk. The UpgradeStoreLoader uses this info to perform or skip
|
|
// store migrations.
|
|
err := k.DumpUpgradeInfoToDisk(ctx.BlockHeight(), plan)
|
|
if err != nil {
|
|
panic(fmt.Errorf("unable to write upgrade info to filesystem: %s", err.Error()))
|
|
}
|
|
|
|
upgradeMsg := BuildUpgradeNeededMsg(plan)
|
|
logger.Error(upgradeMsg)
|
|
panic(upgradeMsg)
|
|
}
|
|
|
|
// We have an upgrade handler for this upgrade name, so apply the upgrade
|
|
ctx.Logger().Info(fmt.Sprintf("applying upgrade \"%s\" at %s", plan.Name, plan.DueAt()))
|
|
ctx = ctx.WithBlockGasMeter(sdk.NewInfiniteGasMeter())
|
|
k.ApplyUpgrade(ctx, plan)
|
|
return
|
|
}
|
|
|
|
// if we have a pending upgrade, but it is not yet time, make sure we did not
|
|
// set the handler already
|
|
if k.HasHandler(plan.Name) {
|
|
downgradeMsg := fmt.Sprintf("BINARY UPDATED BEFORE TRIGGER! UPGRADE \"%s\" - in binary but not executed on chain. Downgrade your binary", plan.Name)
|
|
ctx.Logger().Error(downgradeMsg)
|
|
panic(downgradeMsg)
|
|
}
|
|
}
|
|
|
|
// BuildUpgradeNeededMsg prints the message that notifies that an upgrade is needed.
|
|
func BuildUpgradeNeededMsg(plan types.Plan) string {
|
|
return fmt.Sprintf("UPGRADE \"%s\" NEEDED at %s: %s", plan.Name, plan.DueAt(), plan.Info)
|
|
}
|