Using the SDK
Resources
Docs Version Switcher
Cosmos
Hub
IBC
Go
Tendermint
Core
Search

# Client

# CLI

A user can query and interact with the upgrade module using the CLI.

# Query

The query commands allow users to query upgrade state.

Copy simd query upgrade --help

# applied

The applied command allows users to query the block header for height at which a completed upgrade was applied.

Copy simd query upgrade applied [upgrade-name] [flags]

If upgrade-name was previously executed on the chain, this returns the header for the block at which it was applied. This helps a client determine which binary was valid over a given range of blocks, as well as more context to understand past migrations.

Example:

Copy simd query upgrade applied "test-upgrade"

Example Output:

Copy "block_id": { "hash": "A769136351786B9034A5F196DC53F7E50FCEB53B48FA0786E1BFC45A0BB646B5", "parts": { "total": 1, "hash": "B13CBD23011C7480E6F11BE4594EE316548648E6A666B3575409F8F16EC6939E" } }, "block_size": "7213", "header": { "version": { "block": "11" }, "chain_id": "testnet-2", "height": "455200", "time": "2021-04-10T04:37:57.085493838Z", "last_block_id": { "hash": "0E8AD9309C2DC411DF98217AF59E044A0E1CCEAE7C0338417A70338DF50F4783", "parts": { "total": 1, "hash": "8FE572A48CD10BC2CBB02653CA04CA247A0F6830FF19DC972F64D339A355E77D" } }, "last_commit_hash": "DE890239416A19E6164C2076B837CC1D7F7822FC214F305616725F11D2533140", "data_hash": "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", "validators_hash": "A31047ADE54AE9072EE2A12FF260A8990BA4C39F903EAF5636B50D58DBA72582", "next_validators_hash": "A31047ADE54AE9072EE2A12FF260A8990BA4C39F903EAF5636B50D58DBA72582", "consensus_hash": "048091BC7DDC283F77BFBF91D73C44DA58C3DF8A9CBC867405D8B7F3DAADA22F", "app_hash": "28ECC486AFC332BA6CC976706DBDE87E7D32441375E3F10FD084CD4BAF0DA021", "last_results_hash": "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", "evidence_hash": "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", "proposer_address": "2ABC4854B1A1C5AA8403C4EA853A81ACA901CC76" }, "num_txs": "0" }

# module versions

The module_versions command gets a list of module names and their respective consensus versions.

Following the command with a specific module name will return only that module's information.

Copy simd query upgrade module_versions [optional module_name] [flags]

Example:

Copy simd query upgrade module_versions

Example Output:

Copy module_versions: - name: auth version: "2" - name: authz version: "1" - name: bank version: "2" - name: capability version: "1" - name: crisis version: "1" - name: distribution version: "2" - name: evidence version: "1" - name: feegrant version: "1" - name: genutil version: "1" - name: gov version: "2" - name: ibc version: "2" - name: mint version: "1" - name: params version: "1" - name: slashing version: "2" - name: staking version: "2" - name: transfer version: "1" - name: upgrade version: "1" - name: vesting version: "1"

Example:

Copy regen query upgrade module_versions ibc

Example Output:

Copy module_versions: - name: ibc version: "2"

# plan

The plan command gets the currently scheduled upgrade plan, if one exists.

Copy regen query upgrade plan [flags]

Example:

Copy simd query upgrade plan

Example Output:

Copy height: "130" info: "" name: test-upgrade time: "0001-01-01T00:00:00Z" upgraded_client_state: null

# REST

A user can query the upgrade module using REST endpoints.

# Applied Plan

AppliedPlan queries a previously applied upgrade plan by its name.

Copy /cosmos/upgrade/v1beta1/applied_plan/{name}

Example:

Copy curl -X GET "http://localhost:1317/cosmos/upgrade/v1beta1/applied_plan/v2.0-upgrade" -H "accept: application/json"

Example Output:

Copy { "height": "30" }

# Current Plan

CurrentPlan queries the current upgrade plan.

Copy /cosmos/upgrade/v1beta1/current_plan

Example:

Copy curl -X GET "http://localhost:1317/cosmos/upgrade/v1beta1/current_plan" -H "accept: application/json"

Example Output:

Copy { "plan": "v2.1-upgrade" }

# Module versions

ModuleVersions queries the list of module versions from state.

Copy /cosmos/upgrade/v1beta1/module_versions

Example:

Copy curl -X GET "http://localhost:1317/cosmos/upgrade/v1beta1/module_versions" -H "accept: application/json"

Example Output:

Copy { "module_versions": [ { "name": "auth", "version": "2" }, { "name": "authz", "version": "1" }, { "name": "bank", "version": "2" }, { "name": "capability", "version": "1" }, { "name": "crisis", "version": "1" }, { "name": "distribution", "version": "2" }, { "name": "evidence", "version": "1" }, { "name": "feegrant", "version": "1" }, { "name": "genutil", "version": "1" }, { "name": "gov", "version": "2" }, { "name": "ibc", "version": "2" }, { "name": "mint", "version": "1" }, { "name": "params", "version": "1" }, { "name": "slashing", "version": "2" }, { "name": "staking", "version": "2" }, { "name": "transfer", "version": "1" }, { "name": "upgrade", "version": "1" }, { "name": "vesting", "version": "1" } ] }

# gRPC

A user can query the upgrade module using gRPC endpoints.

# Applied Plan

AppliedPlan queries a previously applied upgrade plan by its name.

Copy cosmos.upgrade.v1beta1.Query/AppliedPlan

Example:

Copy grpcurl -plaintext \ -d '{"name":"v2.0-upgrade"}' \ localhost:9090 \ cosmos.upgrade.v1beta1.Query/AppliedPlan

Example Output:

Copy { "height": "30" }

# Current Plan

CurrentPlan queries the current upgrade plan.

Copy cosmos.upgrade.v1beta1.Query/CurrentPlan

Example:

Copy grpcurl -plaintext localhost:9090 cosmos.slashing.v1beta1.Query/CurrentPlan

Example Output:

Copy { "plan": "v2.1-upgrade" }

# Module versions

ModuleVersions queries the list of module versions from state.

Copy cosmos.upgrade.v1beta1.Query/ModuleVersions

Example:

Copy grpcurl -plaintext localhost:9090 cosmos.slashing.v1beta1.Query/ModuleVersions

Example Output:

Copy { "module_versions": [ { "name": "auth", "version": "2" }, { "name": "authz", "version": "1" }, { "name": "bank", "version": "2" }, { "name": "capability", "version": "1" }, { "name": "crisis", "version": "1" }, { "name": "distribution", "version": "2" }, { "name": "evidence", "version": "1" }, { "name": "feegrant", "version": "1" }, { "name": "genutil", "version": "1" }, { "name": "gov", "version": "2" }, { "name": "ibc", "version": "2" }, { "name": "mint", "version": "1" }, { "name": "params", "version": "1" }, { "name": "slashing", "version": "2" }, { "name": "staking", "version": "2" }, { "name": "transfer", "version": "1" }, { "name": "upgrade", "version": "1" }, { "name": "vesting", "version": "1" } ] }
Found an Issue?
Help us improve this page by suggesting edits on GitHub.
Questions?
Chat with Cosmos developers in Discord or reach out on the SDK Developer Forum to learn more.
cosmos.network
The development of the Cosmos SDK is led primarily by Interchain Core Teams. Funding for this development comes primarily from the Interchain Foundation, a Swiss non-profit.