Skip to content

Latest commit

 

History

History
151 lines (96 loc) · 10 KB

UPGRADING.md

File metadata and controls

151 lines (96 loc) · 10 KB
Raw

Upgrading Cosmos SDK

This guide provides instructions for upgrading to specific versions of Cosmos SDK.

[Unreleased]

Simulation

Remove RandomizedParams from AppModuleSimulation interface. Previously, it used to generate random parameter changes during simulations, however, it does so through ParamChangeProposal which is now legacy. Since all modules were migrated, we can now safely remove this from AppModuleSimulation interface.

AppModule Interface

Remove Querier, Route and LegacyQuerier from the app module interface. This removes and fully deprecates all legacy queriers. All modules no longer support the REST API previously known as the LCD, and the sdk.Msg#Route method won't be used anymore.

SimApp

SimApp's app.go is using App Wiring, the dependency injection framework of the Cosmos SDK. This means that modules are injected directly into SimApp thanks to a configuration file. The old behavior is preserved and still can be used, without the dependency injection framework, as shows app_legacy.go.

The constructor, NewSimApp has been simplified:

  • NewSimApp does not take encoding parameters (encodingConfig) as input, instead the encoding parameters are injected (when using app wiring), or directly created in the constructor. Instead, we can instantiate SimApp for getting the encoding configuration.
  • NewSimApp now uses AppOptions for getting the home path (homePath) and the invariant checks period (invCheckPeriod). These were unnecessary given as arguments as they were already present in the AppOptions.

Encoding

simapp.MakeTestEncodingConfig() was deprecated and has been removed. Instead you can use the TestEncodingConfig from the types/module/testutil package. This means you can replace your usage of simapp.MakeTestEncodingConfig in tests to moduletestutil.MakeTestEncodingConfig, which takes a series of relevant AppModuleBasic as input (the module being tested and any potential dependencies).

Protobuf

The SDK has migrated from gogo/protobuf (which is currently unmaintained), to our own maintained fork, cosmos/gogoproto.

This means you should replace all imports of github.com/gogo/protobuf to github.com/cosmos/gogoproto. This allows you to remove the replace directive replace github.com/gogo/protobuf => github.com/regen-network/protobuf v1.3.3-alpha.regen.1 from your go.mod file.

x/gov

Minimum Proposal Deposit At Time of Submission

The gov module has been updated to support a minimum proposal deposit at submission time. It is determined by a new parameter called MinInitialDepositRatio. When multiplied by the existing MinDeposit parameter, it produces the necessary proportion of coins needed at the proposal submission time. The motivation for this change is to prevent proposal spamming.

By default, the new MinInitialDepositRatio parameter is set to zero during migration. The value of zero signifies that this feature is disabled. If chains wish to utilize the minimum proposal deposits at time of submission, the migration logic needs to be modified to set the new parameter to the desired value.

Ledger

Ledger support has been generalized to enable use of different apps and keytypes that use secp256k1. The Ledger interface remains the same, but it can now be provided through the Keyring Options, allowing higher-level chains to connect to different Ledger apps or use custom implementations. In addition, higher-level chains can provide custom key implementations around the Ledger public key, to enable greater flexibility with address generation and signing.

This is not a breaking change, as all values will default to use the standard Cosmos app implementation unless specified otherwise.

v0.46.x

Go API Changes

The replace google.golang.org/grpc directive can be removed from the go.mod, it is no more required to block the version.

A few packages that were deprecated in the previous version are now removed.

For instance, the REST API, deprecated in v0.45, is now removed. If you have not migrated yet, please follow the instructions.

To improve clarity of the API, some renaming and improvements has been done:

Package Previous Current
simapp encodingConfig.Marshaler encodingConfig.Codec
simapp FundAccount, FundModuleAccount Functions moved to x/bank/testutil
types AccAddressFromHex AccAddressFromHexUnsafe
x/auth MempoolFeeDecorator Use DeductFeeDecorator instead
x/bank AddressFromBalancesStore AddressAndDenomFromBalancesStore
x/gov keeper.DeleteDeposits keeper.DeleteAndBurnDeposits
x/gov keeper.RefundDeposits keeper.RefundAndDeleteDeposits
x/{mod} package legacy package migrations

For the exhaustive list of API renaming, please refer to the CHANGELOG.

new packages

Additionally, new packages have been introduced in order to further split the codebase. Aliases are available for a new API breaking migration, but it is encouraged to migrate to this new packages:

  • errors should replace types/errors when registering errors or wrapping SDK errors.
  • math contains the Int or Uint types that are used in the SDK.

x/authz

  • authz.NewMsgGrant expiration is now a pointer. When nil is used, then no expiration will be set (grant won't expire).
  • authz.NewGrant takes a new argument: block time, to correctly validate expire time.

Keyring

The keyring has been refactored in v0.46.

  • The Unsafe* interfaces have been removed from the keyring package. Please use interface casting if you wish to access those unsafe functions.
  • The keys' implementation has been refactored to be serialized as proto.
  • keyring.NewInMemory and keyring.New takes now a codec.Codec.
  • Take keyring.Record instead of Info as first argument in: * MkConsKeyOutput * MkValKeyOutput * MkAccKeyOutput
  • Rename: * SavePubKey to SaveOfflineKey and remove the algo argument. * NewMultiInfo, NewLedgerInfo to NewLegacyMultiInfo, newLegacyLedgerInfo respectively. * NewOfflineInfo to newLegacyOfflineInfo and move it to migration_test.go.

PostHandler

A postHandler is like an antehandler, but is run after the runMsgs execution. It is in the same store branch that runMsgs, meaning that both runMsgs and postHandler. This allows to run a custom logic after the execution of the messages.

IAVL

v0.19.0 IAVL introduces a new "fast" index. This index represents the latest state of the IAVL laid out in a format that preserves data locality by key. As a result, it allows for faster queries and iterations since data can now be read in lexicographical order that is frequent for Cosmos-SDK chains.

The first time the chain is started after the upgrade, the aforementioned index is created. The creation process might take time and depends on the size of the latest state of the chain. For example, Osmosis takes around 15 minutes to rebuild the index.

While the index is being created, node operators can observe the following in the logs: "Upgrading IAVL storage for faster queries + execution on the live state. This may take a while". The store key is appended to the message. The message is printed for every module that has a non-transient store. As a result, it gives a good indication of the progress of the upgrade.

There is also downgrade and re-upgrade protection. If a node operator chooses to downgrade to IAVL pre-fast index, and then upgrade again, the index is rebuilt from scratch. This implementation detail should not be relevant in most cases. It was added as a safeguard against operator mistakes.

Modules

x/params

  • The x/param module has been depreacted in favour of each module housing and providing way to modify their parameters. Each module that has parameters that are changable during runtime have an authority, the authority can be a module or user account. The Cosmos-SDK team recommends migrating modules away from using the param module. An example of how this could look like can be found here.
  • The Param module will be maintained until April 18, 2023. At this point the module will reach end of life and be removed from the Cosmos SDK.

x/gov

The gov module has been greatly improved. The previous API has been moved to v1beta1 while the new implementation is called v1.

In order to submit a proposal with submit-proposal you now need to pass a proposal.json file. You can still use the old way by using submit-legacy-proposal. This is not recommended. More information can be found in the gov module client documentation.

Protobuf

The third_party/proto folder that existed in previous version now does not contains directly the proto files.

Instead, the SDK uses buf. Clients should have their own buf.yaml with buf.build/cosmos/cosmos-sdk as dependency, in order to avoid having to copy paste these files.

The protos can as well be downloaded using buf export buf.build/cosmos/cosmos-sdk:$(curl -sS https://api.github.com/repos/cosmos/cosmos-sdk/commits/v0.46.0 | jq -r .sha) --output <some_folder>.