types

package
v0.49.1 Latest Latest
Warning

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

 Go to latest Published: Jun 24, 2024 License: Apache-2.0 Imports: 33 Imported by: 10

Documentation

Overview

Package types is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

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

	// VersionMapByte is a prefix to look up module names (key) and versions (value)
	VersionMapByte = 0x2

	// ProtocolVersionByte is a prefix to look up Protocol Version
	ProtocolVersionByte = 0x3

	// KeyUpgradedIBCState is the key under which upgraded ibc state is stored in the upgrade store
	KeyUpgradedIBCState = "upgradedIBCState"

	// KeyUpgradedClient is the sub-key under which upgraded client state will be stored
	KeyUpgradedClient = "upgradedClient"

	// KeyUpgradedConsState is the sub-key under which upgraded consensus state will be stored
	KeyUpgradedConsState = "upgradedConsState"
)
View Source 
const (
	ProposalTypeSoftwareUpgrade       string = "SoftwareUpgrade"
	ProposalTypeCancelSoftwareUpgrade string = "CancelSoftwareUpgrade"
)
View Source 
const (
	QueryCurrent = "current"
	QueryApplied = "applied"
)

query endpoints supported by the upgrade Querier

Variables

View Source 
var (
	ErrInvalidLengthQuery        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowQuery          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupQuery = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	ErrInvalidLengthUpgrade        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowUpgrade          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupUpgrade = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	ModuleCdc = codec.NewAminoCodec(amino)
)

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 RegisterInterfaces 

func RegisterInterfaces(registry types.InterfaceRegistry)

func RegisterLegacyAminoCodec 

func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)

RegisterLegacyAminoCodec registers concrete types on the LegacyAmino codec

func RegisterQueryHandler 

func RegisterQueryHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterQueryHandler registers the http handlers for service Query to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterQueryHandlerClient 

func RegisterQueryHandlerClient(ctx context.Context, mux *runtime.ServeMux, client QueryClient) error

RegisterQueryHandlerClient registers the http handlers for service Query to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "QueryClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "QueryClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "QueryClient" to call the correct interceptors.

func RegisterQueryHandlerFromEndpoint 

func RegisterQueryHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterQueryHandlerServer 

func RegisterQueryHandlerServer(ctx context.Context, mux *runtime.ServeMux, server QueryServer) error

RegisterQueryHandlerServer registers the http handlers for service Query to "mux". UnaryRPC :call QueryServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features (such as grpc.SendHeader, etc) to stop working. Consider using RegisterQueryHandlerFromEndpoint instead.

func RegisterQueryServer 

func RegisterQueryServer(s grpc1.Server, srv QueryServer)

func UpgradeStoreLoader 

func UpgradeStoreLoader(upgradeHeight int64, storeUpgrades *store.StoreUpgrades) baseapp.StoreLoader

UpgradeStoreLoader is used to prepare baseapp with a fixed StoreLoader pattern. This is useful for custom upgrade loading logic.

func UpgradedClientKey 

func UpgradedClientKey(height int64) []byte

UpgradedClientKey is the key under which the upgraded client state is saved Connecting IBC chains can verify against the upgraded client in this path before upgrading their clients

func UpgradedConsStateKey 

func UpgradedConsStateKey(height int64) []byte

UpgradedConsStateKey is the key under which the upgraded consensus state is saved Connecting IBC chains can verify against the upgraded consensus state in this path before upgrading their clients.

Types

type CancelSoftwareUpgradeProposal 

type CancelSoftwareUpgradeProposal struct {
	Title       string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
}

CancelSoftwareUpgradeProposal is a gov Content type for cancelling a software upgrade.

func (*CancelSoftwareUpgradeProposal) Descriptor 

func (*CancelSoftwareUpgradeProposal) Descriptor() ([]byte, []int)

func (*CancelSoftwareUpgradeProposal) Equal 

func (this *CancelSoftwareUpgradeProposal) Equal(that interface{}) bool

func (*CancelSoftwareUpgradeProposal) GetDescription 

func (csup *CancelSoftwareUpgradeProposal) GetDescription() string

func (*CancelSoftwareUpgradeProposal) GetTitle 

func (csup *CancelSoftwareUpgradeProposal) GetTitle() string

func (*CancelSoftwareUpgradeProposal) Marshal 

func (m *CancelSoftwareUpgradeProposal) Marshal() (dAtA []byte, err error)

func (*CancelSoftwareUpgradeProposal) MarshalTo 

func (m *CancelSoftwareUpgradeProposal) MarshalTo(dAtA []byte) (int, error)

func (*CancelSoftwareUpgradeProposal) MarshalToSizedBuffer 

func (m *CancelSoftwareUpgradeProposal) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*CancelSoftwareUpgradeProposal) ProposalRoute 

func (csup *CancelSoftwareUpgradeProposal) ProposalRoute() string

func (*CancelSoftwareUpgradeProposal) ProposalType 

func (csup *CancelSoftwareUpgradeProposal) ProposalType() string

func (*CancelSoftwareUpgradeProposal) ProtoMessage 

func (*CancelSoftwareUpgradeProposal) ProtoMessage()

func (*CancelSoftwareUpgradeProposal) Reset 

func (m *CancelSoftwareUpgradeProposal) Reset()

func (*CancelSoftwareUpgradeProposal) Size 

func (m *CancelSoftwareUpgradeProposal) Size() (n int)

func (CancelSoftwareUpgradeProposal) String 

func (csup CancelSoftwareUpgradeProposal) String() string

func (*CancelSoftwareUpgradeProposal) Unmarshal 

func (m *CancelSoftwareUpgradeProposal) Unmarshal(dAtA []byte) error

func (*CancelSoftwareUpgradeProposal) ValidateBasic 

func (csup *CancelSoftwareUpgradeProposal) ValidateBasic() error

func (*CancelSoftwareUpgradeProposal) XXX_DiscardUnknown 

func (m *CancelSoftwareUpgradeProposal) XXX_DiscardUnknown()

func (*CancelSoftwareUpgradeProposal) XXX_Marshal 

func (m *CancelSoftwareUpgradeProposal) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CancelSoftwareUpgradeProposal) XXX_Merge 

func (m *CancelSoftwareUpgradeProposal) XXX_Merge(src proto.Message)

func (*CancelSoftwareUpgradeProposal) XXX_Size 

func (m *CancelSoftwareUpgradeProposal) XXX_Size() int

func (*CancelSoftwareUpgradeProposal) XXX_Unmarshal 

func (m *CancelSoftwareUpgradeProposal) XXX_Unmarshal(b []byte) error

type ModuleVersion 

type ModuleVersion struct {
	// name of the app module
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// consensus version of the app module
	Version uint64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
}

ModuleVersion specifies a module and its consensus version.

Since: cosmos-sdk 0.43

func (*ModuleVersion) Descriptor 

func (*ModuleVersion) Descriptor() ([]byte, []int)

func (*ModuleVersion) Equal 

func (this *ModuleVersion) Equal(that interface{}) bool

func (*ModuleVersion) Marshal 

func (m *ModuleVersion) Marshal() (dAtA []byte, err error)

func (*ModuleVersion) MarshalTo 

func (m *ModuleVersion) MarshalTo(dAtA []byte) (int, error)

func (*ModuleVersion) MarshalToSizedBuffer 

func (m *ModuleVersion) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ModuleVersion) ProtoMessage 

func (*ModuleVersion) ProtoMessage()

func (*ModuleVersion) Reset 

func (m *ModuleVersion) Reset()

func (*ModuleVersion) Size 

func (m *ModuleVersion) Size() (n int)

func (*ModuleVersion) String 

func (m *ModuleVersion) String() string

func (*ModuleVersion) Unmarshal 

func (m *ModuleVersion) Unmarshal(dAtA []byte) error

func (*ModuleVersion) XXX_DiscardUnknown 

func (m *ModuleVersion) XXX_DiscardUnknown()

func (*ModuleVersion) XXX_Marshal 

func (m *ModuleVersion) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ModuleVersion) XXX_Merge 

func (m *ModuleVersion) XXX_Merge(src proto.Message)

func (*ModuleVersion) XXX_Size 

func (m *ModuleVersion) XXX_Size() int

func (*ModuleVersion) XXX_Unmarshal 

func (m *ModuleVersion) XXX_Unmarshal(b []byte) error

type Plan 

type Plan struct {
	// Sets the name for the upgrade. This name will be used by the upgraded
	// version of the software to apply any special "on-upgrade" commands during
	// the first BeginBlock method after the upgrade is applied. It is also used
	// to detect whether a software version can handle a given upgrade. If no
	// upgrade handler with this name has been set in the software, it will be
	// assumed that the software is out-of-date when the upgrade Time or Height is
	// reached and the software will exit.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Deprecated: Time based upgrades have been deprecated. Time based upgrade logic
	// has been removed from the SDK.
	// If this field is not empty, an error will be thrown.
	Time time.Time `protobuf:"bytes,2,opt,name=time,proto3,stdtime" json:"time"` // Deprecated: Do not use.
	// The height at which the upgrade must be performed.
	// Only used if Time is not set.
	Height int64 `protobuf:"varint,3,opt,name=height,proto3" json:"height,omitempty"`
	// Any application specific upgrade info to be included on-chain
	// such as a git commit that validators could automatically upgrade to
	Info string `protobuf:"bytes,4,opt,name=info,proto3" json:"info,omitempty"`
	// Deprecated: UpgradedClientState field has been deprecated. IBC upgrade logic has been
	// moved to the IBC module in the sub module 02-client.
	// If this field is not empty, an error will be thrown.
	UpgradedClientState *types.Any `` // Deprecated: Do not use.
	/* 149-byte string literal not displayed */
}

Plan specifies information about a planned upgrade and when it should occur.

func (*Plan) Descriptor 

func (*Plan) Descriptor() ([]byte, []int)

func (Plan) DueAt 

func (p Plan) DueAt() string

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

func (*Plan) Equal 

func (this *Plan) Equal(that interface{}) bool

func (*Plan) Marshal 

func (m *Plan) Marshal() (dAtA []byte, err error)

func (*Plan) MarshalTo 

func (m *Plan) MarshalTo(dAtA []byte) (int, error)

func (*Plan) MarshalToSizedBuffer 

func (m *Plan) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Plan) ProtoMessage 

func (*Plan) ProtoMessage()

func (*Plan) Reset 

func (m *Plan) Reset()

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) Size 

func (m *Plan) Size() (n int)

func (Plan) String 

func (p Plan) String() string

func (*Plan) Unmarshal 

func (m *Plan) Unmarshal(dAtA []byte) error

func (Plan) ValidateBasic 

func (p Plan) ValidateBasic() error

ValidateBasic does basic validation of a Plan

func (*Plan) XXX_DiscardUnknown 

func (m *Plan) XXX_DiscardUnknown()

func (*Plan) XXX_Marshal 

func (m *Plan) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Plan) XXX_Merge 

func (m *Plan) XXX_Merge(src proto.Message)

func (*Plan) XXX_Size 

func (m *Plan) XXX_Size() int

func (*Plan) XXX_Unmarshal 

func (m *Plan) XXX_Unmarshal(b []byte) error

type QueryAppliedPlanRequest 

type QueryAppliedPlanRequest struct {
	// name is the name of the applied plan to query for.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
}

QueryCurrentPlanRequest is the request type for the Query/AppliedPlan RPC method.

func (*QueryAppliedPlanRequest) Descriptor 

func (*QueryAppliedPlanRequest) Descriptor() ([]byte, []int)

func (*QueryAppliedPlanRequest) GetName 

func (m *QueryAppliedPlanRequest) GetName() string

func (*QueryAppliedPlanRequest) Marshal 

func (m *QueryAppliedPlanRequest) Marshal() (dAtA []byte, err error)

func (*QueryAppliedPlanRequest) MarshalTo 

func (m *QueryAppliedPlanRequest) MarshalTo(dAtA []byte) (int, error)

func (*QueryAppliedPlanRequest) MarshalToSizedBuffer 

func (m *QueryAppliedPlanRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryAppliedPlanRequest) ProtoMessage 

func (*QueryAppliedPlanRequest) ProtoMessage()

func (*QueryAppliedPlanRequest) Reset 

func (m *QueryAppliedPlanRequest) Reset()

func (*QueryAppliedPlanRequest) Size 

func (m *QueryAppliedPlanRequest) Size() (n int)

func (*QueryAppliedPlanRequest) String 

func (m *QueryAppliedPlanRequest) String() string

func (*QueryAppliedPlanRequest) Unmarshal 

func (m *QueryAppliedPlanRequest) Unmarshal(dAtA []byte) error

func (*QueryAppliedPlanRequest) XXX_DiscardUnknown 

func (m *QueryAppliedPlanRequest) XXX_DiscardUnknown()

func (*QueryAppliedPlanRequest) XXX_Marshal 

func (m *QueryAppliedPlanRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryAppliedPlanRequest) XXX_Merge 

func (m *QueryAppliedPlanRequest) XXX_Merge(src proto.Message)

func (*QueryAppliedPlanRequest) XXX_Size 

func (m *QueryAppliedPlanRequest) XXX_Size() int

func (*QueryAppliedPlanRequest) XXX_Unmarshal 

func (m *QueryAppliedPlanRequest) XXX_Unmarshal(b []byte) error

type QueryAppliedPlanResponse 

type QueryAppliedPlanResponse struct {
	// height is the block height at which the plan was applied.
	Height int64 `protobuf:"varint,1,opt,name=height,proto3" json:"height,omitempty"`
}

QueryAppliedPlanResponse is the response type for the Query/AppliedPlan RPC method.

func (*QueryAppliedPlanResponse) Descriptor 

func (*QueryAppliedPlanResponse) Descriptor() ([]byte, []int)

func (*QueryAppliedPlanResponse) GetHeight 

func (m *QueryAppliedPlanResponse) GetHeight() int64

func (*QueryAppliedPlanResponse) Marshal 

func (m *QueryAppliedPlanResponse) Marshal() (dAtA []byte, err error)

func (*QueryAppliedPlanResponse) MarshalTo 

func (m *QueryAppliedPlanResponse) MarshalTo(dAtA []byte) (int, error)

func (*QueryAppliedPlanResponse) MarshalToSizedBuffer 

func (m *QueryAppliedPlanResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryAppliedPlanResponse) ProtoMessage 

func (*QueryAppliedPlanResponse) ProtoMessage()

func (*QueryAppliedPlanResponse) Reset 

func (m *QueryAppliedPlanResponse) Reset()

func (*QueryAppliedPlanResponse) Size 

func (m *QueryAppliedPlanResponse) Size() (n int)

func (*QueryAppliedPlanResponse) String 

func (m *QueryAppliedPlanResponse) String() string

func (*QueryAppliedPlanResponse) Unmarshal 

func (m *QueryAppliedPlanResponse) Unmarshal(dAtA []byte) error

func (*QueryAppliedPlanResponse) XXX_DiscardUnknown 

func (m *QueryAppliedPlanResponse) XXX_DiscardUnknown()

func (*QueryAppliedPlanResponse) XXX_Marshal 

func (m *QueryAppliedPlanResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryAppliedPlanResponse) XXX_Merge 

func (m *QueryAppliedPlanResponse) XXX_Merge(src proto.Message)

func (*QueryAppliedPlanResponse) XXX_Size 

func (m *QueryAppliedPlanResponse) XXX_Size() int

func (*QueryAppliedPlanResponse) XXX_Unmarshal 

func (m *QueryAppliedPlanResponse) XXX_Unmarshal(b []byte) error

type QueryClient 

type QueryClient interface {
	// CurrentPlan queries the current upgrade plan.
	CurrentPlan(ctx context.Context, in *QueryCurrentPlanRequest, opts ...grpc.CallOption) (*QueryCurrentPlanResponse, error)
	// AppliedPlan queries a previously applied upgrade plan by its name.
	AppliedPlan(ctx context.Context, in *QueryAppliedPlanRequest, opts ...grpc.CallOption) (*QueryAppliedPlanResponse, error)
	// UpgradedConsensusState queries the consensus state that will serve
	// as a trusted kernel for the next version of this chain. It will only be
	// stored at the last height of this chain.
	// UpgradedConsensusState RPC not supported with legacy querier
	// This rpc is deprecated now that IBC has its own replacement
	// (https://github.com/cosmos/ibc-go/blob/2c880a22e9f9cc75f62b527ca94aa75ce1106001/proto/ibc/core/client/v1/query.proto#L54)
	UpgradedConsensusState(ctx context.Context, in *QueryUpgradedConsensusStateRequest, opts ...grpc.CallOption) (*QueryUpgradedConsensusStateResponse, error)
	// ModuleVersions queries the list of module versions from state.
	//
	// Since: cosmos-sdk 0.43
	ModuleVersions(ctx context.Context, in *QueryModuleVersionsRequest, opts ...grpc.CallOption) (*QueryModuleVersionsResponse, error)
}

QueryClient is the client API for Query service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewQueryClient 

func NewQueryClient(cc grpc1.ClientConn) QueryClient

type QueryCurrentPlanRequest 

type QueryCurrentPlanRequest struct {
}

QueryCurrentPlanRequest is the request type for the Query/CurrentPlan RPC method.

func (*QueryCurrentPlanRequest) Descriptor 

func (*QueryCurrentPlanRequest) Descriptor() ([]byte, []int)

func (*QueryCurrentPlanRequest) Marshal 

func (m *QueryCurrentPlanRequest) Marshal() (dAtA []byte, err error)

func (*QueryCurrentPlanRequest) MarshalTo 

func (m *QueryCurrentPlanRequest) MarshalTo(dAtA []byte) (int, error)

func (*QueryCurrentPlanRequest) MarshalToSizedBuffer 

func (m *QueryCurrentPlanRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryCurrentPlanRequest) ProtoMessage 

func (*QueryCurrentPlanRequest) ProtoMessage()

func (*QueryCurrentPlanRequest) Reset 

func (m *QueryCurrentPlanRequest) Reset()

func (*QueryCurrentPlanRequest) Size 

func (m *QueryCurrentPlanRequest) Size() (n int)

func (*QueryCurrentPlanRequest) String 

func (m *QueryCurrentPlanRequest) String() string

func (*QueryCurrentPlanRequest) Unmarshal 

func (m *QueryCurrentPlanRequest) Unmarshal(dAtA []byte) error

func (*QueryCurrentPlanRequest) XXX_DiscardUnknown 

func (m *QueryCurrentPlanRequest) XXX_DiscardUnknown()

func (*QueryCurrentPlanRequest) XXX_Marshal 

func (m *QueryCurrentPlanRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryCurrentPlanRequest) XXX_Merge 

func (m *QueryCurrentPlanRequest) XXX_Merge(src proto.Message)

func (*QueryCurrentPlanRequest) XXX_Size 

func (m *QueryCurrentPlanRequest) XXX_Size() int

func (*QueryCurrentPlanRequest) XXX_Unmarshal 

func (m *QueryCurrentPlanRequest) XXX_Unmarshal(b []byte) error

type QueryCurrentPlanResponse 

type QueryCurrentPlanResponse struct {
	// plan is the current upgrade plan.
	Plan *Plan `protobuf:"bytes,1,opt,name=plan,proto3" json:"plan,omitempty"`
}

QueryCurrentPlanResponse is the response type for the Query/CurrentPlan RPC method.

func (*QueryCurrentPlanResponse) Descriptor 

func (*QueryCurrentPlanResponse) Descriptor() ([]byte, []int)

func (*QueryCurrentPlanResponse) GetPlan 

func (m *QueryCurrentPlanResponse) GetPlan() *Plan

func (*QueryCurrentPlanResponse) Marshal 

func (m *QueryCurrentPlanResponse) Marshal() (dAtA []byte, err error)

func (*QueryCurrentPlanResponse) MarshalTo 

func (m *QueryCurrentPlanResponse) MarshalTo(dAtA []byte) (int, error)

func (*QueryCurrentPlanResponse) MarshalToSizedBuffer 

func (m *QueryCurrentPlanResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryCurrentPlanResponse) ProtoMessage 

func (*QueryCurrentPlanResponse) ProtoMessage()

func (*QueryCurrentPlanResponse) Reset 

func (m *QueryCurrentPlanResponse) Reset()

func (*QueryCurrentPlanResponse) Size 

func (m *QueryCurrentPlanResponse) Size() (n int)

func (*QueryCurrentPlanResponse) String 

func (m *QueryCurrentPlanResponse) String() string

func (*QueryCurrentPlanResponse) Unmarshal 

func (m *QueryCurrentPlanResponse) Unmarshal(dAtA []byte) error

func (*QueryCurrentPlanResponse) XXX_DiscardUnknown 

func (m *QueryCurrentPlanResponse) XXX_DiscardUnknown()

func (*QueryCurrentPlanResponse) XXX_Marshal 

func (m *QueryCurrentPlanResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryCurrentPlanResponse) XXX_Merge 

func (m *QueryCurrentPlanResponse) XXX_Merge(src proto.Message)

func (*QueryCurrentPlanResponse) XXX_Size 

func (m *QueryCurrentPlanResponse) XXX_Size() int

func (*QueryCurrentPlanResponse) XXX_Unmarshal 

func (m *QueryCurrentPlanResponse) XXX_Unmarshal(b []byte) error

type QueryModuleVersionsRequest 

type QueryModuleVersionsRequest struct {
	// module_name is a field to query a specific module
	// consensus version from state. Leaving this empty will
	// fetch the full list of module versions from state
	ModuleName string `protobuf:"bytes,1,opt,name=module_name,json=moduleName,proto3" json:"module_name,omitempty"`
}

QueryModuleVersionsRequest is the request type for the Query/ModuleVersions RPC method.

Since: cosmos-sdk 0.43

func (*QueryModuleVersionsRequest) Descriptor 

func (*QueryModuleVersionsRequest) Descriptor() ([]byte, []int)

func (*QueryModuleVersionsRequest) GetModuleName 

func (m *QueryModuleVersionsRequest) GetModuleName() string

func (*QueryModuleVersionsRequest) Marshal 

func (m *QueryModuleVersionsRequest) Marshal() (dAtA []byte, err error)

func (*QueryModuleVersionsRequest) MarshalTo 

func (m *QueryModuleVersionsRequest) MarshalTo(dAtA []byte) (int, error)

func (*QueryModuleVersionsRequest) MarshalToSizedBuffer 

func (m *QueryModuleVersionsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryModuleVersionsRequest) ProtoMessage 

func (*QueryModuleVersionsRequest) ProtoMessage()

func (*QueryModuleVersionsRequest) Reset 

func (m *QueryModuleVersionsRequest) Reset()

func (*QueryModuleVersionsRequest) Size 

func (m *QueryModuleVersionsRequest) Size() (n int)

func (*QueryModuleVersionsRequest) String 

func (m *QueryModuleVersionsRequest) String() string

func (*QueryModuleVersionsRequest) Unmarshal 

func (m *QueryModuleVersionsRequest) Unmarshal(dAtA []byte) error

func (*QueryModuleVersionsRequest) XXX_DiscardUnknown 

func (m *QueryModuleVersionsRequest) XXX_DiscardUnknown()

func (*QueryModuleVersionsRequest) XXX_Marshal 

func (m *QueryModuleVersionsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryModuleVersionsRequest) XXX_Merge 

func (m *QueryModuleVersionsRequest) XXX_Merge(src proto.Message)

func (*QueryModuleVersionsRequest) XXX_Size 

func (m *QueryModuleVersionsRequest) XXX_Size() int

func (*QueryModuleVersionsRequest) XXX_Unmarshal 

func (m *QueryModuleVersionsRequest) XXX_Unmarshal(b []byte) error

type QueryModuleVersionsResponse 

type QueryModuleVersionsResponse struct {
	// module_versions is a list of module names with their consensus versions.
	ModuleVersions []*ModuleVersion `protobuf:"bytes,1,rep,name=module_versions,json=moduleVersions,proto3" json:"module_versions,omitempty"`
}

QueryModuleVersionsResponse is the response type for the Query/ModuleVersions RPC method.

Since: cosmos-sdk 0.43

func (*QueryModuleVersionsResponse) Descriptor 

func (*QueryModuleVersionsResponse) Descriptor() ([]byte, []int)

func (*QueryModuleVersionsResponse) GetModuleVersions 

func (m *QueryModuleVersionsResponse) GetModuleVersions() []*ModuleVersion

func (*QueryModuleVersionsResponse) Marshal 

func (m *QueryModuleVersionsResponse) Marshal() (dAtA []byte, err error)

func (*QueryModuleVersionsResponse) MarshalTo 

func (m *QueryModuleVersionsResponse) MarshalTo(dAtA []byte) (int, error)

func (*QueryModuleVersionsResponse) MarshalToSizedBuffer 

func (m *QueryModuleVersionsResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryModuleVersionsResponse) ProtoMessage 

func (*QueryModuleVersionsResponse) ProtoMessage()

func (*QueryModuleVersionsResponse) Reset 

func (m *QueryModuleVersionsResponse) Reset()

func (*QueryModuleVersionsResponse) Size 

func (m *QueryModuleVersionsResponse) Size() (n int)

func (*QueryModuleVersionsResponse) String 

func (m *QueryModuleVersionsResponse) String() string

func (*QueryModuleVersionsResponse) Unmarshal 

func (m *QueryModuleVersionsResponse) Unmarshal(dAtA []byte) error

func (*QueryModuleVersionsResponse) XXX_DiscardUnknown 

func (m *QueryModuleVersionsResponse) XXX_DiscardUnknown()

func (*QueryModuleVersionsResponse) XXX_Marshal 

func (m *QueryModuleVersionsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryModuleVersionsResponse) XXX_Merge 

func (m *QueryModuleVersionsResponse) XXX_Merge(src proto.Message)

func (*QueryModuleVersionsResponse) XXX_Size 

func (m *QueryModuleVersionsResponse) XXX_Size() int

func (*QueryModuleVersionsResponse) XXX_Unmarshal 

func (m *QueryModuleVersionsResponse) XXX_Unmarshal(b []byte) error

type QueryServer 

type QueryServer interface {
	// CurrentPlan queries the current upgrade plan.
	CurrentPlan(context.Context, *QueryCurrentPlanRequest) (*QueryCurrentPlanResponse, error)
	// AppliedPlan queries a previously applied upgrade plan by its name.
	AppliedPlan(context.Context, *QueryAppliedPlanRequest) (*QueryAppliedPlanResponse, error)
	// UpgradedConsensusState queries the consensus state that will serve
	// as a trusted kernel for the next version of this chain. It will only be
	// stored at the last height of this chain.
	// UpgradedConsensusState RPC not supported with legacy querier
	// This rpc is deprecated now that IBC has its own replacement
	// (https://github.com/cosmos/ibc-go/blob/2c880a22e9f9cc75f62b527ca94aa75ce1106001/proto/ibc/core/client/v1/query.proto#L54)
	UpgradedConsensusState(context.Context, *QueryUpgradedConsensusStateRequest) (*QueryUpgradedConsensusStateResponse, error)
	// ModuleVersions queries the list of module versions from state.
	//
	// Since: cosmos-sdk 0.43
	ModuleVersions(context.Context, *QueryModuleVersionsRequest) (*QueryModuleVersionsResponse, error)
}

QueryServer is the server API for Query service.

type QueryUpgradedConsensusStateRequest deprecated 

type QueryUpgradedConsensusStateRequest struct {
	// last height of the current chain must be sent in request
	// as this is the height under which next consensus state is stored
	LastHeight int64 `protobuf:"varint,1,opt,name=last_height,json=lastHeight,proto3" json:"last_height,omitempty"`
}

QueryUpgradedConsensusStateRequest is the request type for the Query/UpgradedConsensusState RPC method.

Deprecated: Do not use.

func (*QueryUpgradedConsensusStateRequest) Descriptor 

func (*QueryUpgradedConsensusStateRequest) Descriptor() ([]byte, []int)

func (*QueryUpgradedConsensusStateRequest) GetLastHeight 

func (m *QueryUpgradedConsensusStateRequest) GetLastHeight() int64

func (*QueryUpgradedConsensusStateRequest) Marshal 

func (m *QueryUpgradedConsensusStateRequest) Marshal() (dAtA []byte, err error)

func (*QueryUpgradedConsensusStateRequest) MarshalTo 

func (m *QueryUpgradedConsensusStateRequest) MarshalTo(dAtA []byte) (int, error)

func (*QueryUpgradedConsensusStateRequest) MarshalToSizedBuffer 

func (m *QueryUpgradedConsensusStateRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryUpgradedConsensusStateRequest) ProtoMessage 

func (*QueryUpgradedConsensusStateRequest) ProtoMessage()

func (*QueryUpgradedConsensusStateRequest) Reset 

func (m *QueryUpgradedConsensusStateRequest) Reset()

func (*QueryUpgradedConsensusStateRequest) Size 

func (m *QueryUpgradedConsensusStateRequest) Size() (n int)

func (*QueryUpgradedConsensusStateRequest) String 

func (m *QueryUpgradedConsensusStateRequest) String() string

func (*QueryUpgradedConsensusStateRequest) Unmarshal 

func (m *QueryUpgradedConsensusStateRequest) Unmarshal(dAtA []byte) error

func (*QueryUpgradedConsensusStateRequest) XXX_DiscardUnknown 

func (m *QueryUpgradedConsensusStateRequest) XXX_DiscardUnknown()

func (*QueryUpgradedConsensusStateRequest) XXX_Marshal 

func (m *QueryUpgradedConsensusStateRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryUpgradedConsensusStateRequest) XXX_Merge 

func (m *QueryUpgradedConsensusStateRequest) XXX_Merge(src proto.Message)

func (*QueryUpgradedConsensusStateRequest) XXX_Size 

func (m *QueryUpgradedConsensusStateRequest) XXX_Size() int

func (*QueryUpgradedConsensusStateRequest) XXX_Unmarshal 

func (m *QueryUpgradedConsensusStateRequest) XXX_Unmarshal(b []byte) error

type QueryUpgradedConsensusStateResponse deprecated 

type QueryUpgradedConsensusStateResponse struct {
	// Since: cosmos-sdk 0.43
	UpgradedConsensusState []byte `` /* 129-byte string literal not displayed */
}

QueryUpgradedConsensusStateResponse is the response type for the Query/UpgradedConsensusState RPC method.

Deprecated: Do not use.

func (*QueryUpgradedConsensusStateResponse) Descriptor 

func (*QueryUpgradedConsensusStateResponse) Descriptor() ([]byte, []int)

func (*QueryUpgradedConsensusStateResponse) GetUpgradedConsensusState 

func (m *QueryUpgradedConsensusStateResponse) GetUpgradedConsensusState() []byte

func (*QueryUpgradedConsensusStateResponse) Marshal 

func (m *QueryUpgradedConsensusStateResponse) Marshal() (dAtA []byte, err error)

func (*QueryUpgradedConsensusStateResponse) MarshalTo 

func (m *QueryUpgradedConsensusStateResponse) MarshalTo(dAtA []byte) (int, error)

func (*QueryUpgradedConsensusStateResponse) MarshalToSizedBuffer 

func (m *QueryUpgradedConsensusStateResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*QueryUpgradedConsensusStateResponse) ProtoMessage 

func (*QueryUpgradedConsensusStateResponse) ProtoMessage()

func (*QueryUpgradedConsensusStateResponse) Reset 

func (m *QueryUpgradedConsensusStateResponse) Reset()

func (*QueryUpgradedConsensusStateResponse) Size 

func (m *QueryUpgradedConsensusStateResponse) Size() (n int)

func (*QueryUpgradedConsensusStateResponse) String 

func (m *QueryUpgradedConsensusStateResponse) String() string

func (*QueryUpgradedConsensusStateResponse) Unmarshal 

func (m *QueryUpgradedConsensusStateResponse) Unmarshal(dAtA []byte) error

func (*QueryUpgradedConsensusStateResponse) XXX_DiscardUnknown 

func (m *QueryUpgradedConsensusStateResponse) XXX_DiscardUnknown()

func (*QueryUpgradedConsensusStateResponse) XXX_Marshal 

func (m *QueryUpgradedConsensusStateResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*QueryUpgradedConsensusStateResponse) XXX_Merge 

func (m *QueryUpgradedConsensusStateResponse) XXX_Merge(src proto.Message)

func (*QueryUpgradedConsensusStateResponse) XXX_Size 

func (m *QueryUpgradedConsensusStateResponse) XXX_Size() int

func (*QueryUpgradedConsensusStateResponse) XXX_Unmarshal 

func (m *QueryUpgradedConsensusStateResponse) XXX_Unmarshal(b []byte) error

type SoftwareUpgradeProposal 

type SoftwareUpgradeProposal struct {
	Title       string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	Plan        Plan   `protobuf:"bytes,3,opt,name=plan,proto3" json:"plan"`
}

SoftwareUpgradeProposal is a gov Content type for initiating a software upgrade.

func (*SoftwareUpgradeProposal) Descriptor 

func (*SoftwareUpgradeProposal) Descriptor() ([]byte, []int)

func (*SoftwareUpgradeProposal) Equal 

func (this *SoftwareUpgradeProposal) Equal(that interface{}) bool

func (*SoftwareUpgradeProposal) GetDescription 

func (sup *SoftwareUpgradeProposal) GetDescription() string

func (*SoftwareUpgradeProposal) GetTitle 

func (sup *SoftwareUpgradeProposal) GetTitle() string

func (*SoftwareUpgradeProposal) Marshal 

func (m *SoftwareUpgradeProposal) Marshal() (dAtA []byte, err error)

func (*SoftwareUpgradeProposal) MarshalTo 

func (m *SoftwareUpgradeProposal) MarshalTo(dAtA []byte) (int, error)

func (*SoftwareUpgradeProposal) MarshalToSizedBuffer 

func (m *SoftwareUpgradeProposal) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*SoftwareUpgradeProposal) ProposalRoute 

func (sup *SoftwareUpgradeProposal) ProposalRoute() string

func (*SoftwareUpgradeProposal) ProposalType 

func (sup *SoftwareUpgradeProposal) ProposalType() string

func (*SoftwareUpgradeProposal) ProtoMessage 

func (*SoftwareUpgradeProposal) ProtoMessage()

func (*SoftwareUpgradeProposal) Reset 

func (m *SoftwareUpgradeProposal) Reset()

func (*SoftwareUpgradeProposal) Size 

func (m *SoftwareUpgradeProposal) Size() (n int)

func (SoftwareUpgradeProposal) String 

func (sup SoftwareUpgradeProposal) String() string

func (*SoftwareUpgradeProposal) Unmarshal 

func (m *SoftwareUpgradeProposal) Unmarshal(dAtA []byte) error

func (*SoftwareUpgradeProposal) ValidateBasic 

func (sup *SoftwareUpgradeProposal) ValidateBasic() error

func (*SoftwareUpgradeProposal) XXX_DiscardUnknown 

func (m *SoftwareUpgradeProposal) XXX_DiscardUnknown()

func (*SoftwareUpgradeProposal) XXX_Marshal 

func (m *SoftwareUpgradeProposal) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SoftwareUpgradeProposal) XXX_Merge 

func (m *SoftwareUpgradeProposal) XXX_Merge(src proto.Message)

func (*SoftwareUpgradeProposal) XXX_Size 

func (m *SoftwareUpgradeProposal) XXX_Size() int

func (*SoftwareUpgradeProposal) XXX_Unmarshal 

func (m *SoftwareUpgradeProposal) XXX_Unmarshal(b []byte) error

type UnimplementedQueryServer 

type UnimplementedQueryServer struct {
}

UnimplementedQueryServer can be embedded to have forward compatible implementations.

func (*UnimplementedQueryServer) AppliedPlan 

func (*UnimplementedQueryServer) AppliedPlan(ctx context.Context, req *QueryAppliedPlanRequest) (*QueryAppliedPlanResponse, error)

func (*UnimplementedQueryServer) CurrentPlan 

func (*UnimplementedQueryServer) CurrentPlan(ctx context.Context, req *QueryCurrentPlanRequest) (*QueryCurrentPlanResponse, error)

func (*UnimplementedQueryServer) ModuleVersions 

func (*UnimplementedQueryServer) ModuleVersions(ctx context.Context, req *QueryModuleVersionsRequest) (*QueryModuleVersionsResponse, error)

func (*UnimplementedQueryServer) UpgradedConsensusState 

func (*UnimplementedQueryServer) UpgradedConsensusState(ctx context.Context, req *QueryUpgradedConsensusStateRequest) (*QueryUpgradedConsensusStateResponse, error)

type UpgradeHandler 

type UpgradeHandler func(ctx sdk.Context, plan Plan, fromVM module.VersionMap) (module.VersionMap, error)

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

`fromVM` is a VersionMap of moduleName to fromVersion (unit64), where fromVersion denotes the version from which we should migrate the module, the target version being the module's latest version in the return VersionMap, let's call it `toVM`.

`fromVM` is retrieved from x/upgrade's store, whereas `toVM` is chosen arbitrarily by the app developer (and persisted to x/upgrade's store right after the upgrade handler runs). In general, `toVM` should map all modules to their latest ConsensusVersion so that x/upgrade can track each module's latest ConsensusVersion; `fromVM` can be left as-is, but can also be modified inside the upgrade handler, e.g. to skip running InitGenesis or migrations for certain modules when calling the `module.Manager#RunMigrations` function.

Please also refer to docs/core/upgrade.md for more information.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.