Skip to main content

Upgrade

ℹ️info

JMES's upgrade module inherits from the Cosmos SDK's upgrade module. This document is a stub and mainly covers important JMES-specific notes on how it is used.

The upgrade module allows live chains to be upgraded with breaking changes smoothly.

State​

The upgrade module is relatively straightforward:


_13
_13
The state contains the currently active upgrade Plan (if one exists) by key 0x0 and if a Plan is marked as "done" by key 0x1.
_13
_13
The state contains the consensus versions of all app modules in the application.
_13
_13
The versions are stored as big endian uint64 and can be accessed with prefix 0x2 appended by the corresponding module name of type string.
_13
_13
The state maintains a Protocol Version which can be accessed by key 0x3.
_13
_13
Plan: 0x0 -> Plan
_13
Done: 0x1 | byte(plan name) -> BigEndian(Block Height)
_13
ConsensusVersion: 0x2 | byte(module name) -> BigEndian(Module Consensus Version)
_13
ProtocolVersion: 0x3 -> BigEndian(Protocol Version)