package upgrades

import (
	store "github.com/cosmos/cosmos-sdk/store/types"
	sdk "github.com/cosmos/cosmos-sdk/types"
	"github.com/cosmos/cosmos-sdk/types/module"
	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
)

// Upgrade defines a struct containing necessary fields that a
// SoftwareUpgradeProposal must have written, in order for the state migration
// to go smoothly.
//
// An upgrade must implement this struct, and then set it in the app.go.
// The app.go will then define the handler.
type Upgrade struct {
	// version name for the upgrade handler, e.g. `v7`
	UpgradeName string

	// CreateUpgradeHandler defines the function that creates an upgrade handler
	CreateUpgradeHandler func(*module.Manager, module.Configurator) upgradetypes.UpgradeHandler

	// used for any new modules introduced, new modules deleted, or store names renamed
	StoreUpgrades store.StoreUpgrades
}

// Fork defines a struct containing the requisite fields for a non-software
// upgrade proposal Hard Fork at a given height to implement.
//
// There is one time code that can be added for the start of the Fork, in
// `BeginForkLogic`.
//
// Any other change in the code should be height-gated, if the goal is to have
// old and new binaries to be compatible prior to the upgrade height.
type Fork struct {
	// version name for the upgrade handler, e.g. `v7`
	UpgradeName string

	// height the upgrade occurs at
	UpgradeHeight int64

	// function that runs some custom state transition code at the beginning of a fork
	BeginForkLogic func(ctx sdk.Context)
}
