Add upgrade module

CHANGELOG.md

@@ -100,6 +100,7 @@ upgrade via: `sudo rm -rf /Library/Developer/CommandLineTools; xcode-select --in
 correct version via: `pkgutil --pkg-info=com.apple.pkg.CLTools_Executables`.
 * (keys) [\#5097](https://github.com/cosmos/cosmos-sdk/pull/5097) New `keys migrate` command to assist users migrate their keys
 to the new keyring.
+* (modules) [\#4233](https://github.com/cosmos/cosmos-sdk/pull/4233) Add upgrade module that coordinates software upgrades of live chains.
 * [\#4486](https://github.com/cosmos/cosmos-sdk/issues/4486) Introduce new `PeriodicVestingAccount` vesting account type
 that allows for arbitrary vesting periods.
 * (baseapp) [\#5196](https://github.com/cosmos/cosmos-sdk/pull/5196) Baseapp has a new `runTxModeReCheck` to allow applications to skip expensive and unnecessary re-checking of transactions.

x/gov/alias.go

@@ -41,7 +41,6 @@ const (
  StatusRejected = types.StatusRejected
  StatusFailed = types.StatusFailed
  ProposalTypeText = types.ProposalTypeText
- ProposalTypeSoftwareUpgrade = types.ProposalTypeSoftwareUpgrade
  QueryParams = types.QueryParams
  QueryProposals = types.QueryProposals
  QueryProposal = types.QueryProposal
@@ -111,7 +110,6 @@ var (
  ProposalStatusFromString = types.ProposalStatusFromString
  ValidProposalStatus = types.ValidProposalStatus
  NewTextProposal = types.NewTextProposal
- NewSoftwareUpgradeProposal = types.NewSoftwareUpgradeProposal
  RegisterProposalType = types.RegisterProposalType
  ContentFromProposalType = types.ContentFromProposalType
  IsValidProposalType = types.IsValidProposalType
@@ -142,32 +140,31 @@ var (
 )
 
 type (
- Keeper = keeper.Keeper
- Content = types.Content
- Handler = types.Handler
- Deposit = types.Deposit
- Deposits = types.Deposits
- GenesisState = types.GenesisState
- MsgSubmitProposal = types.MsgSubmitProposal
- MsgDeposit = types.MsgDeposit
- MsgVote = types.MsgVote
- DepositParams = types.DepositParams
- TallyParams = types.TallyParams
- VotingParams = types.VotingParams
- Params = types.Params
- Proposal = types.Proposal
- Proposals = types.Proposals
- ProposalQueue = types.ProposalQueue
- ProposalStatus = types.ProposalStatus
- TextProposal = types.TextProposal
- SoftwareUpgradeProposal = types.SoftwareUpgradeProposal
- QueryProposalParams = types.QueryProposalParams
- QueryDepositParams = types.QueryDepositParams
- QueryVoteParams = types.QueryVoteParams
- QueryProposalsParams = types.QueryProposalsParams
- ValidatorGovInfo = types.ValidatorGovInfo
- TallyResult = types.TallyResult
- Vote = types.Vote
- Votes = types.Votes
- VoteOption = types.VoteOption
+ Keeper = keeper.Keeper
+ Content = types.Content
+ Handler = types.Handler
+ Deposit = types.Deposit
+ Deposits = types.Deposits
+ GenesisState = types.GenesisState
+ MsgSubmitProposal = types.MsgSubmitProposal
+ MsgDeposit = types.MsgDeposit
+ MsgVote = types.MsgVote
+ DepositParams = types.DepositParams
+ TallyParams = types.TallyParams
+ VotingParams = types.VotingParams
+ Params = types.Params
+ Proposal = types.Proposal
+ Proposals = types.Proposals
+ ProposalQueue = types.ProposalQueue
+ ProposalStatus = types.ProposalStatus
+ TextProposal = types.TextProposal
+ QueryProposalParams = types.QueryProposalParams
+ QueryDepositParams = types.QueryDepositParams
+ QueryVoteParams = types.QueryVoteParams
+ QueryProposalsParams = types.QueryProposalsParams
+ ValidatorGovInfo = types.ValidatorGovInfo
+ TallyResult = types.TallyResult
+ Vote = types.Vote
+ Votes = types.Votes
+ VoteOption = types.VoteOption
 )

x/gov/client/rest/rest.go

@@ -39,7 +39,7 @@ type PostProposalReq struct {
  BaseReq rest.BaseReq `json:"base_req" yaml:"base_req"`
  Title string `json:"title" yaml:"title"` // Title of the proposal
  Description string `json:"description" yaml:"description"` // Description of the proposal
- ProposalType string `json:"proposal_type" yaml:"proposal_type"` // Type of proposal. Initial set {PlainTextProposal, SoftwareUpgradeProposal}
+ ProposalType string `json:"proposal_type" yaml:"proposal_type"` // Type of proposal. Initial set {PlainTextProposal }
  Proposer sdk.AccAddress `json:"proposer" yaml:"proposer"` // Address of the proposer
  InitialDeposit sdk.Coins `json:"initial_deposit" yaml:"initial_deposit"` // Coins to add to the proposal's deposit
 }

x/gov/client/utils/utils.go

@@ -28,9 +28,6 @@ func NormalizeProposalType(proposalType string) string {
  case "Text", "text":
  return types.ProposalTypeText
 
- case "SoftwareUpgrade", "software_upgrade":
- return types.ProposalTypeSoftwareUpgrade
-
  default:
  return ""
  }

x/gov/handler.go

@@ -48,14 +48,13 @@ func handleMsgSubmitProposal(ctx sdk.Context, keeper Keeper, msg MsgSubmitPropos
  ),
  )
 
+ submitEvent := sdk.NewEvent(types.EventTypeSubmitProposal, sdk.NewAttribute(types.AttributeKeyProposalType, msg.Content.ProposalType()))
  if votingStarted {
- ctx.EventManager().EmitEvent(
- sdk.NewEvent(
- types.EventTypeSubmitProposal,
- sdk.NewAttribute(types.AttributeKeyVotingPeriodStart, fmt.Sprintf("%d", proposal.ProposalID)),
- ),
+ submitEvent = submitEvent.AppendAttributes(
+ sdk.NewAttribute(types.AttributeKeyVotingPeriodStart, fmt.Sprintf("%d", proposal.ProposalID)),
  )
  }
+ ctx.EventManager().EmitEvent(submitEvent)
 
  return sdk.Result{
  Data: GetProposalIDBytes(proposal.ProposalID),

x/gov/legacy/v0_34/types.go

@@ -13,7 +13,6 @@ import (
 
 var (
  _ ProposalContent = TextProposal{}
- _ ProposalContent = SoftwareUpgradeProposal{}
 )
 
 const (
@@ -35,14 +34,9 @@ const (
  ProposalTypeNil ProposalKind = 0x00
  ProposalTypeText ProposalKind = 0x01
  ProposalTypeParameterChange ProposalKind = 0x02
- ProposalTypeSoftwareUpgrade ProposalKind = 0x03
 )
 
 type (
- SoftwareUpgradeProposal struct {
- TextProposal
- }
-
  ProposalQueue []uint64
 
  ProposalKind byte
@@ -142,8 +136,6 @@ func (tp TextProposal) GetTitle() string { return tp.Title }
 func (tp TextProposal) GetDescription() string { return tp.Description }
 func (tp TextProposal) ProposalType() ProposalKind { return ProposalTypeText }
 
-func (sup SoftwareUpgradeProposal) ProposalType() ProposalKind { return ProposalTypeSoftwareUpgrade }
-
 // ProposalStatusToString turns a string into a ProposalStatus
 func ProposalStatusFromString(str string) (ProposalStatus, error) {
  switch str {
@@ -290,8 +282,6 @@ func ProposalTypeFromString(str string) (ProposalKind, error) {
  return ProposalTypeText, nil
  case "ParameterChange":
  return ProposalTypeParameterChange, nil
- case "SoftwareUpgrade":
- return ProposalTypeSoftwareUpgrade, nil
  default:
  return ProposalKind(0xff), fmt.Errorf("'%s' is not a valid proposal type", str)
  }
@@ -331,8 +321,6 @@ func (pt ProposalKind) String() string {
  return "Text"
  case ProposalTypeParameterChange:
  return "ParameterChange"
- case ProposalTypeSoftwareUpgrade:
- return "SoftwareUpgrade"
  default:
  return ""
  }
@@ -341,5 +329,4 @@ func (pt ProposalKind) String() string {
 func RegisterCodec(cdc *codec.Codec) {
  cdc.RegisterInterface((*ProposalContent)(nil), nil)
  cdc.RegisterConcrete(TextProposal{}, "gov/TextProposal", nil)
- cdc.RegisterConcrete(SoftwareUpgradeProposal{}, "gov/SoftwareUpgradeProposal", nil)
 }

x/gov/legacy/v0_36/migrate.go

@@ -43,8 +43,6 @@ func migrateContent(proposalContent v034gov.ProposalContent) (content Content) {
  switch proposalContent.ProposalType() {
  case v034gov.ProposalTypeText:
  return NewTextProposal(proposalContent.GetTitle(), proposalContent.GetDescription())
- case v034gov.ProposalTypeSoftwareUpgrade:
- return NewSoftwareUpgradeProposal(proposalContent.GetTitle(), proposalContent.GetDescription())
  default:
  return nil
  }

x/gov/legacy/v0_36/types.go

@@ -18,8 +18,7 @@ const (
 
  DefaultCodespace sdk.CodespaceType = "gov"
 
- ProposalTypeText string = "Text"
- ProposalTypeSoftwareUpgrade string = "SoftwareUpgrade"
+ ProposalTypeText string = "Text"
 
  MaxDescriptionLength int = 5000
  MaxTitleLength int = 140
@@ -29,7 +28,6 @@ const (
 
 var (
  _ Content = TextProposal{}
- _ Content = SoftwareUpgradeProposal{}
 )
 
 type (
@@ -41,11 +39,6 @@ type (
  Description string `json:"description"`
  }
 
- SoftwareUpgradeProposal struct {
- Title string `json:"title"`
- Description string `json:"description"`
- }
-
  Content interface {
  GetTitle() string
  GetDescription() string
@@ -114,25 +107,6 @@ func (tp TextProposal) String() string {
 `, tp.Title, tp.Description)
 }
 
-func NewSoftwareUpgradeProposal(title, description string) Content {
- return SoftwareUpgradeProposal{title, description}
-}
-
-func (sup SoftwareUpgradeProposal) GetTitle() string { return sup.Title }
-func (sup SoftwareUpgradeProposal) GetDescription() string { return sup.Description }
-func (sup SoftwareUpgradeProposal) ProposalRoute() string { return RouterKey }
-func (sup SoftwareUpgradeProposal) ProposalType() string { return ProposalTypeSoftwareUpgrade }
-func (sup SoftwareUpgradeProposal) ValidateBasic() sdk.Error {
- return ValidateAbstract(DefaultCodespace, sup)
-}
-
-func (sup SoftwareUpgradeProposal) String() string {
- return fmt.Sprintf(`Software Upgrade Proposal:
- Title: %s
- Description: %s
-`, sup.Title, sup.Description)
-}
-
 func ErrInvalidProposalContent(cs sdk.CodespaceType, msg string) sdk.Error {
  return sdk.NewError(cs, CodeInvalidContent, fmt.Sprintf("invalid proposal content: %s", msg))
 }
@@ -160,5 +134,4 @@ func ValidateAbstract(codespace sdk.CodespaceType, c Content) sdk.Error {
 func RegisterCodec(cdc *codec.Codec) {
  cdc.RegisterInterface((*Content)(nil), nil)
  cdc.RegisterConcrete(TextProposal{}, "cosmos-sdk/TextProposal", nil)
- cdc.RegisterConcrete(SoftwareUpgradeProposal{}, "cosmos-sdk/SoftwareUpgradeProposal", nil)
 }

x/gov/test_common.go

@@ -195,7 +195,7 @@ const contextKeyBadProposal = "contextKeyBadProposal"
 // for the key contextKeyBadProposal or if the value is false.
 func badProposalHandler(ctx sdk.Context, c types.Content) sdk.Error {
  switch c.ProposalType() {
- case types.ProposalTypeText, types.ProposalTypeSoftwareUpgrade:
+ case types.ProposalTypeText:
  v := ctx.Value(contextKeyBadProposal)
 
  if v == nil || !v.(bool) {

x/gov/types/codec.go

@@ -17,7 +17,6 @@ func RegisterCodec(cdc *codec.Codec) {
  cdc.RegisterConcrete(MsgVote{}, "cosmos-sdk/MsgVote", nil)
 
  cdc.RegisterConcrete(TextProposal{}, "cosmos-sdk/TextProposal", nil)
- cdc.RegisterConcrete(SoftwareUpgradeProposal{}, "cosmos-sdk/SoftwareUpgradeProposal", nil)
 }
 
 // RegisterProposalTypeCodec registers an external proposal content type defined

x/gov/types/events.go

@@ -17,4 +17,5 @@ const (
  AttributeValueProposalPassed = "proposal_passed" // met vote quorum
  AttributeValueProposalRejected = "proposal_rejected" // didn't meet vote quorum
  AttributeValueProposalFailed = "proposal_failed" // error on proposal handler
+ AttributeKeyProposalType = "proposal_type"
 )

x/gov/types/msgs.go

@@ -39,12 +39,6 @@ func (msg MsgSubmitProposal) ValidateBasic() sdk.Error {
  if msg.Content == nil {
  return ErrInvalidProposalContent(DefaultCodespace, "missing content")
  }
- if msg.Content.ProposalType() == ProposalTypeSoftwareUpgrade {
- // Disable software upgrade proposals as they are currently equivalent
- // to text proposals. Re-enable once a valid software upgrade proposal
- // handler is implemented.
- return ErrInvalidProposalType(DefaultCodespace, msg.Content.ProposalType())
- }
  if msg.Proposer.Empty() {
  return sdk.ErrInvalidAddress(msg.Proposer.String())
  }

x/gov/types/msgs_test.go

@@ -35,7 +35,6 @@ func TestMsgSubmitProposal(t *testing.T) {
  {"Test Proposal", "the purpose of this proposal is to test", ProposalTypeText, addrs[0], coinsPos, true},
  {"", "the purpose of this proposal is to test", ProposalTypeText, addrs[0], coinsPos, false},
  {"Test Proposal", "", ProposalTypeText, addrs[0], coinsPos, false},
- {"Test Proposal", "the purpose of this proposal is to test", ProposalTypeSoftwareUpgrade, addrs[0], coinsPos, false},
  {"Test Proposal", "the purpose of this proposal is to test", ProposalTypeText, sdk.AccAddress{}, coinsPos, false},
  {"Test Proposal", "the purpose of this proposal is to test", ProposalTypeText, addrs[0], coinsZero, true},
  {"Test Proposal", "the purpose of this proposal is to test", ProposalTypeText, addrs[0], coinsMulti, true},

x/gov/types/proposal.go

@@ -201,8 +201,7 @@ func (status ProposalStatus) Format(s fmt.State, verb rune) {
 
 // Proposal types
 const (
- ProposalTypeText string = "Text"
- ProposalTypeSoftwareUpgrade string = "SoftwareUpgrade"
+ ProposalTypeText string = "Text"
 )
 
 // TextProposal defines a standard text proposal whose changes need to be
@@ -243,52 +242,8 @@ func (tp TextProposal) String() string {
 `, tp.Title, tp.Description)
 }
 
-// SoftwareUpgradeProposal defines a proposal for upgrading the network nodes
-// without the need of manually halting at a given height
-//
-// TODO: We have to add fields for SUP specific arguments e.g. commit hash,
-// upgrade date, etc.
-type SoftwareUpgradeProposal struct {
- Title string `json:"title" yaml:"title"`
- Description string `json:"description" yaml:"description"`
-}
-
-// NewSoftwareUpgradeProposal creates a software upgrade proposal Content
-func NewSoftwareUpgradeProposal(title, description string) Content {
- return SoftwareUpgradeProposal{title, description}
-}
-
-// Implements Content Interface
-var _ Content = SoftwareUpgradeProposal{}
-
-// GetTitle returns the proposal title
-func (sup SoftwareUpgradeProposal) GetTitle() string { return sup.Title }
-
-// GetDescription returns the proposal description
-func (sup SoftwareUpgradeProposal) GetDescription() string { return sup.Description }
-
-// ProposalRoute returns the proposal router key
-func (sup SoftwareUpgradeProposal) ProposalRoute() string { return RouterKey }
-
-// ProposalType is "SoftwareUpgrade"
-func (sup SoftwareUpgradeProposal) ProposalType() string { return ProposalTypeSoftwareUpgrade }
-
-// ValidateBasic validates the content's title and description of the proposal
-func (sup SoftwareUpgradeProposal) ValidateBasic() sdk.Error {
- return ValidateAbstract(DefaultCodespace, sup)
-}
-
-// String implements Stringer interface
-func (sup SoftwareUpgradeProposal) String() string {
- return fmt.Sprintf(`Software Upgrade Proposal:
- Title: %s
- Description: %s
-`, sup.Title, sup.Description)
-}
-
 var validProposalTypes = map[string]struct{}{
- ProposalTypeText: {},
- ProposalTypeSoftwareUpgrade: {},
+ ProposalTypeText: {},
 }
 
 // RegisterProposalType registers a proposal type. It will panic if the type is
@@ -307,9 +262,6 @@ func ContentFromProposalType(title, desc, ty string) Content {
  case ProposalTypeText:
  return NewTextProposal(title, desc)
 
- case ProposalTypeSoftwareUpgrade:
- return NewSoftwareUpgradeProposal(title, desc)
-
  default:
  return nil
  }
@@ -325,12 +277,12 @@ func IsValidProposalType(ty string) bool {
 }
 
 // ProposalHandler implements the Handler interface for governance module-based
-// proposals (ie. TextProposal and SoftwareUpgradeProposal). Since these are
+// proposals (ie. TextProposal ). Since these are
 // merely signaling mechanisms at the moment and do not affect state, it
 // performs a no-op.
 func ProposalHandler(_ sdk.Context, c Content) sdk.Error {
  switch c.ProposalType() {
- case ProposalTypeText, ProposalTypeSoftwareUpgrade:
+ case ProposalTypeText:
  // both proposal types do not change state so this performs a no-op
  return nil