types

package
v0.9.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 20, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// ModuleName is the name of this module
	ModuleName = "upgrade"

	// RouterKey is used to route governance proposals
	RouterKey = ModuleName

	// StoreKey is the prefix under which we store this module's data
	StoreKey = ModuleName

	// QuerierKey is used to handle abci_query requests
	QuerierKey = ModuleName
)
View Source
const (
	// PlanByte specifies the Byte under which a pending upgrade plan is stored in the store
	PlanByte = 0x0
	// DoneByte is a prefix for to look up completed upgrade plan by name
	DoneByte = 0x1
)
View Source
const (
	DefaultCodespace                  sdk.CodespaceType = "upgrade"
	ProposalTypeSoftwareUpgrade       string            = "SoftwareUpgrade"
	ProposalTypeCancelSoftwareUpgrade string            = "CancelSoftwareUpgrade"
)
View Source
const (
	QueryCurrent = "current"
	QueryApplied = "applied"
)

query endpoints supported by the upgrade Querier

Variables

This section is empty.

Functions

func NewCancelSoftwareUpgradeProposal

func NewCancelSoftwareUpgradeProposal(title, description string) gov.Content

func NewSoftwareUpgradeProposal

func NewSoftwareUpgradeProposal(title, description string, plan Plan) gov.Content

func PlanKey

func PlanKey() []byte

PlanKey is the key under which the current plan is saved We store PlanByte as a const to keep it immutable (unlike a []byte)

func RegisterCodec

func RegisterCodec(cdc *codec.Codec)

RegisterCodec registers concrete types on the Amino codec

Types

type CancelSoftwareUpgradeProposal

type CancelSoftwareUpgradeProposal struct {
	Title       string `json:"title"`
	Description string `json:"description"`
}

func (*CancelSoftwareUpgradeProposal) GetDescription

func (sup *CancelSoftwareUpgradeProposal) GetDescription() string

func (*CancelSoftwareUpgradeProposal) GetTitle

func (sup *CancelSoftwareUpgradeProposal) GetTitle() string

func (*CancelSoftwareUpgradeProposal) ProposalRoute

func (sup *CancelSoftwareUpgradeProposal) ProposalRoute() string

func (*CancelSoftwareUpgradeProposal) ProposalToken

func (sup *CancelSoftwareUpgradeProposal) ProposalToken() string

func (*CancelSoftwareUpgradeProposal) ProposalType

func (sup *CancelSoftwareUpgradeProposal) ProposalType() string

func (CancelSoftwareUpgradeProposal) String

func (*CancelSoftwareUpgradeProposal) ValidateBasic

func (sup *CancelSoftwareUpgradeProposal) ValidateBasic() sdk.Error

type Plan

type Plan struct {
	Name   string    `json:"name"`
	Time   time.Time `json:"time"`
	Height int64     `json:"height"`
	Info   string    `json:"info"`
}

func (Plan) DueAt

func (p Plan) DueAt() string

DueAt is a string representation of when this plan is due to be executed

func (Plan) ShouldExecute

func (p Plan) ShouldExecute(ctx sdk.Context) bool

ShouldExecute returns true if the Plan is ready to execute given the current context

func (Plan) String

func (p Plan) String() string

func (Plan) ValidateBasic

func (p Plan) ValidateBasic() sdk.Error

ValidateBasic does basic validation of a Plan

type QueryAppliedParams

type QueryAppliedParams struct {
	Name string
}

QueryAppliedParams is passed as data with QueryApplied

func NewQueryAppliedParams

func NewQueryAppliedParams(name string) QueryAppliedParams

NewQueryAppliedParams creates a new instance to query if a named plan was applied

type SoftwareUpgradeProposal

type SoftwareUpgradeProposal struct {
	Title       string `json:"title"`
	Description string `json:"description"`
	Plan        Plan   `json:"plan"`
}

func (*SoftwareUpgradeProposal) GetDescription

func (sup *SoftwareUpgradeProposal) GetDescription() string

func (*SoftwareUpgradeProposal) GetTitle

func (sup *SoftwareUpgradeProposal) GetTitle() string

func (*SoftwareUpgradeProposal) ProposalRoute

func (sup *SoftwareUpgradeProposal) ProposalRoute() string

func (*SoftwareUpgradeProposal) ProposalToken

func (sup *SoftwareUpgradeProposal) ProposalToken() string

func (*SoftwareUpgradeProposal) ProposalType

func (sup *SoftwareUpgradeProposal) ProposalType() string

func (SoftwareUpgradeProposal) String

func (sup SoftwareUpgradeProposal) String() string

func (*SoftwareUpgradeProposal) ValidateBasic

func (sup *SoftwareUpgradeProposal) ValidateBasic() sdk.Error

type UpgradeHandler

type UpgradeHandler func(ctx sdk.Context, plan Plan)

UpgradeHandler specifies the type of function that is called when an upgrade is applied

type UpgradeInfo

type UpgradeInfo struct {
	Name   string `json:"name"`
	Height int64  `json:"height"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL