cosmos/upgrade
Table of Contents
cosmos/upgrade/v1beta1/query.proto
TopQueryAppliedPlanRequest
QueryCurrentPlanRequest is the request type for the Query/AppliedPlan RPC
method.
| Field | Type | Label | Description |
| name | string | name is the name of the applied plan to query for. |
QueryAppliedPlanResponse
QueryAppliedPlanResponse is the response type for the Query/AppliedPlan RPC
method.
| Field | Type | Label | Description |
| height | int64 | height is the block height at which the plan was applied. |
QueryCurrentPlanRequest
QueryCurrentPlanRequest is the request type for the Query/CurrentPlan RPC
method.
QueryCurrentPlanResponse
QueryCurrentPlanResponse is the response type for the Query/CurrentPlan RPC
method.
| Field | Type | Label | Description |
| plan | Plan | plan is the current upgrade plan. |
QueryModuleVersionsRequest
QueryModuleVersionsRequest is the request type for the Query/ModuleVersions
RPC method.
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| module_name | string | 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 |
QueryModuleVersionsResponse
QueryModuleVersionsResponse is the response type for the Query/ModuleVersions
RPC method.
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| module_versions | ModuleVersion | repeated | module_versions is a list of module names with their consensus versions. |
QueryUpgradedConsensusStateRequest
QueryUpgradedConsensusStateRequest is the request type for the Query/UpgradedConsensusState
RPC method.
| Field | Type | Label | Description |
| last_height | int64 | last height of the current chain must be sent in request as this is the height under which next consensus state is stored |
QueryUpgradedConsensusStateResponse
QueryUpgradedConsensusStateResponse is the response type for the Query/UpgradedConsensusState
RPC method.
| Field | Type | Label | Description |
| upgraded_consensus_state | bytes | Since: cosmos-sdk 0.43 |
Query
Query defines the gRPC upgrade querier service.
| Method Name | Request Type | Response Type | Description |
| CurrentPlan | QueryCurrentPlanRequest | QueryCurrentPlanResponse | CurrentPlan queries the current upgrade plan. |
| AppliedPlan | QueryAppliedPlanRequest | QueryAppliedPlanResponse | AppliedPlan queries a previously applied upgrade plan by its name. |
| UpgradedConsensusState | QueryUpgradedConsensusStateRequest | QueryUpgradedConsensusStateResponse | 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) |
| ModuleVersions | QueryModuleVersionsRequest | QueryModuleVersionsResponse | ModuleVersions queries the list of module versions from state. Since: cosmos-sdk 0.43 |
Methods with deprecated option
| Method Name | Option |
| UpgradedConsensusState | true |
Methods with HTTP bindings
| Method Name | Method | Pattern | Body |
| CurrentPlan | GET | /cosmos/upgrade/v1beta1/current_plan | |
| AppliedPlan | GET | /cosmos/upgrade/v1beta1/applied_plan/{name} | |
| UpgradedConsensusState | GET | /cosmos/upgrade/v1beta1/upgraded_consensus_state/{last_height} | |
| ModuleVersions | GET | /cosmos/upgrade/v1beta1/module_versions |
cosmos/upgrade/v1beta1/upgrade.proto
TopCancelSoftwareUpgradeProposal
CancelSoftwareUpgradeProposal is a gov Content type for cancelling a software
upgrade.
| Field | Type | Label | Description |
| title | string |
|
|
| description | string |
|
ModuleVersion
ModuleVersion specifies a module and its consensus version.
Since: cosmos-sdk 0.43
| Field | Type | Label | Description |
| name | string | name of the app module |
|
| version | uint64 | consensus version of the app module |
Plan
Plan specifies information about a planned upgrade and when it should occur.
| Field | Type | Label | Description |
| name | string | 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. |
|
| time | google.protobuf.Timestamp | Deprecated. 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. |
|
| height | int64 | The height at which the upgrade must be performed. Only used if Time is not set. |
|
| info | string | Any application specific upgrade info to be included on-chain such as a git commit that validators could automatically upgrade to |
|
| upgraded_client_state | google.protobuf.Any | Deprecated. 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. |
Fields with deprecated option
| Name | Option |
| time | true |
| upgraded_client_state | true |
SoftwareUpgradeProposal
SoftwareUpgradeProposal is a gov Content type for initiating a software
upgrade.
| Field | Type | Label | Description |
| title | string |
|
|
| description | string |
|
|
| plan | Plan |
|
Scalar Value Types
| .proto Type | Notes | Python Type |
| double | float | |
| float | float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long |
| uint32 | Uses variable-length encoding. | int/long |
| uint64 | Uses variable-length encoding. | int/long |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long |
| sfixed32 | Always four bytes. | int |
| sfixed64 | Always eight bytes. | int/long |
| bool | boolean | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode |
| bytes | May contain any arbitrary sequence of bytes. | str |