This guide provides instructions for upgrading to specific versions of Cosmos SDK.
A new tool have been created for migrating configuration of the SDK. Use the following command to migrate your configuration:
simd config migrate v0.48
More information about confix.
gRPC-Web is now listening to the same address as the gRPC Gateway API server (default: localhost:1317
).
The possibility to listen to a different address has been removed, as well as its settings.
Use confix
to clean-up your app.toml
. A nginx (or alike) reverse-proxy can be set to keep the previous behavior.
ClevelDB, BoltDB and BadgerDB are not supported anymore. To migrate from a unsupported database to a supported database please use the database migration tool.
The SDK is in the process of removing all gogoproto
annotations.
The gogoproto.goproto_stringer = false
annotation has been removed from most proto files. This means that the String()
method is being generated for types that previously had this annotation. The generated String()
method uses proto.CompactTextString
for stringifying structs.
Verify the usage of the modified String()
methods and double-check that they are not used in state-machine code.
References to types/store.go
which contained aliases for store types have been remapped to point to appropriate store/types, hence the types/store.go
file is no longer needed and has been removed.
The store
module is extracted to have a separate go.mod file which allows it be a standalone module.
All the store imports are now renamed to use cosmossdk.io/store
instead of github.com/cosmos/cosmos-sdk/store
across the SDK.
Previously, all modules were required to be set in OrderBeginBlockers
, OrderEndBlockers
and OrderInitGenesis / OrderExportGenesis
in app.go
/ app_config.go
.
This is no longer the case, the assertion has been loosened to only require modules implementing, respectively, the module.BeginBlockAppModule
, module.EndBlockAppModule
and module.HasGenesis
interfaces.
The gov
module has been updated to support the ability to cancel governance proposals. When a proposal is canceled, all the deposits of the proposal are either burnt or sent to ProposalCancelDest
address. The deposits burn rate will be determined by a new parameter called ProposalCancelRatio
parameter.
1. deposits * proposal_cancel_ratio will be burned or sent to `ProposalCancelDest` address , if `ProposalCancelDest` is empty then deposits will be burned.
2. deposits * (1 - proposal_cancel_ratio) will be sent to depositors.
By default, the new ProposalCancelRatio
parameter is set to 0.5 during migration and ProposalCancelDest
is set to empty string (i.e. burnt).
The x/evidence
module is extracted to have a separate go.mod file which allows it be a standalone module.
All the evidence imports are now renamed to use cosmossdk.io/x/evidence
instead of github.com/cosmos/cosmos-sdk/x/evidence
across the SDK.
The x/nft
module is extracted to have a separate go.mod file which allows it to be a standalone module.
The x/feegrant
module is extracted to have a separate go.mod file which allows it to be a standalone module.
All the feegrant imports are now renamed to use cosmossdk.io/x/feegrant
instead of github.com/cosmos/cosmos-sdk/x/feegrant
across the SDK.
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.
A new gRPC service, proto/cosmos/base/node/v1beta1/query.proto
, has been introduced
which exposes various operator configuration. App developers should be sure to
register the service with the gRPC-gateway service via
nodeservice.RegisterGRPCGatewayRoutes
in their application construction, which
is typically found in RegisterAPIRoutes
.
Support for the AppModule
Querier
, Route
and LegacyQuerier
methods has been entirely removed from the AppModule
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.
Most other existing AppModule
methods have been moved to extension interfaces in preparation for the migration
to the cosmossdk.io/core/appmodule
API in the next release. Most AppModule
implementations should not be broken
by this change.
The simapp
package should not be imported in your own app. Instead, you should import the runtime.AppI
interface, that defines an App
, and use the simtestutil
package for application testing.
SimApp's app_v2.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 previous behavior, without the dependency injection framework, is still present in app.go
and is not going anywhere.
If you are using a app.go
without dependency injection, add the following lines to your app.go
in order to provide newer gRPC services:
autocliv1.RegisterQueryServer(app.GRPCQueryRouter(), runtimeservices.NewAutoCLIQueryService(app.ModuleManager.Modules))
reflectionSvc, err := runtimeservices.NewReflectionService()
if err != nil {
panic(err)
}
reflectionv1.RegisterReflectionServiceServer(app.GRPCQueryRouter(), reflectionSvc)
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 instantiateSimApp
for getting the encoding configuration.NewSimApp
now usesAppOptions
for getting the home path (homePath
) and the invariant checks period (invCheckPeriod
). These were unnecessary given as arguments as they were already present in theAppOptions
.
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).
ExportAppStateAndValidators
takes an extra argument, modulesToExport
, which is a list of module names to export.
That argument should be passed to the module maanager ExportGenesisFromModules
method.
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.
Please use the ghcr.io/cosmos/proto-builder
image (version >= 0.11.5
) for generating protobuf files.
See which buf commit for cosmos/cosmos-sdk
to pin in your buf.yaml
file here.
The SDK is normalizing the strings inside the Protobuf accepts_interface
and implements_interface
annotations. We require them to be fully-scoped names. They will soon be used by code generators like Pulsar and Telescope to match which messages can or cannot be packed inside Any
s.
Here are the following replacements that you need to perform on your proto files:
- "Content"
+ "cosmos.gov.v1beta1.Content"
- "Authorization"
+ "cosmos.authz.v1beta1.Authorization"
- "sdk.Msg"
+ "cosmos.base.v1beta1.Msg"
- "AccountI"
+ "cosmos.auth.v1beta1.AccountI"
- "ModuleAccountI"
+ "cosmos.auth.v1beta1.ModuleAccountI"
- "FeeAllowanceI"
+ "cosmos.feegrant.v1beta1.FeeAllowanceI"
Please also check that in your own app's proto files that there are no single-word names for those two proto annotations. If so, then replace them with fully-qualified names, even though those names don't actually resolve to an actual protobuf entity.
For more information, see the encoding guide.
Broadcast mode block
was deprecated and has been removed. Please use sync
mode
instead. When upgrading your tests from block
to sync
and checking for a
transaction code, you need to query the transaction first (with its hash) to get
the correct code.
EventTypeMessage
events, with sdk.AttributeKeyModule
and sdk.AttributeKeySender
are now emitted directly at message excecution (in baseapp
).
This means that you can remove the following boilerplate from all your custom modules:
ctx.EventManager().EmitEvent(
sdk.NewEvent(
sdk.EventTypeMessage,
sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
sdk.NewAttribute(sdk.AttributeKeySender, `signer/sender`),
),
)
The module name is assumed by baseapp
to be the second element of the message route: "cosmos.bank.v1beta1.MsgSend" -> "bank"
.
In case a module does not follow the standard message path, (e.g. IBC), it is advised to keep emitting the module name event.
Baseapp
only emits that event if the module have not already done so.
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.
The Proposal
proto has been updated with proposer field. For proposal state migraton developers can call v4.AddProposerAddressToProposal
in their upgrade handler to update all existing proposal and make them compatible and this migration is optional.
import (
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/cosmos/cosmos-sdk/types/module"
v4 "github.com/cosmos/cosmos-sdk/x/gov/migrations/v4"
upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
)
func (app SimApp) RegisterUpgradeHandlers() {
app.UpgradeKeeper.SetUpgradeHandler(UpgradeName,
func(ctx sdk.Context, plan upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
// this migration is optional
// add proposal ids with proposers which are active (deposit or voting period)
proposals := make(map[uint64]string)
proposals[1] = "cosmos1luyncewxk4lm24k6gqy8y5dxkj0klr4tu0lmnj" ...
v4.AddProposerAddressToProposal(ctx, sdk.NewKVStoreKey(v4.ModuleName), app.appCodec, proposals)
return app.ModuleManager.RunMigrations(ctx, app.Configurator(), fromVM)
})
}
Introducing a new x/consensus
module to handle managing Tendermint consensus
parameters. For migration it is required to call a specific migration to migrate
existing parameters from the deprecated x/params
to x/consensus
module. App
developers should ensure to call baseapp.MigrateParams
in their upgrade handler.
Example:
func (app SimApp) RegisterUpgradeHandlers() {
----> baseAppLegacySS := app.ParamsKeeper.Subspace(baseapp.Paramspace).WithKeyTable(paramstypes.ConsensusParamsKeyTable()) <----
app.UpgradeKeeper.SetUpgradeHandler(
UpgradeName,
func(ctx sdk.Context, _ upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
// Migrate Tendermint consensus parameters from x/params module to a
// dedicated x/consensus module.
----> baseapp.MigrateParams(ctx, baseAppLegacySS, &app.ConsensusParamsKeeper) <----
// ...
return app.ModuleManager.RunMigrations(ctx, app.Configurator(), fromVM)
},
)
// ...
}
The old params module is required to still be imported in your app.go in order to handle this migration.
Previous:
bApp.SetParamStore(app.ParamsKeeper.Subspace(baseapp.Paramspace).WithKeyTable(paramstypes.ConsensusParamsKeyTable()))
After:
app.ConsensusParamsKeeper = consensusparamkeeper.NewKeeper(appCodec, keys[upgradetypes.StoreKey], authtypes.NewModuleAddress(govtypes.ModuleName).String())
bApp.SetParamStore(&app.ConsensusParamsKeeper)
The SDK does not validate anymore the classID
and nftID
of an NFT, for extra flexibility in your NFT implementation.
This means chain developers need to validate the classID
and nftID
of an NFT.
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.
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.
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 replacetypes/errors
when registering errors or wrapping SDK errors.math
contains theInt
orUint
types that are used in the SDK.x/nft
an NFT base module.x/group
a group module allowing to create DAOs, multisig and policies. Greatly composes withx/authz
.
authz.NewMsgGrant
expiration
is now a pointer. Whennil
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.
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
andkeyring.New
takes now acodec.Codec
.- Take
keyring.Record
instead ofInfo
as first argument in: *MkConsKeyOutput
*MkValKeyOutput
*MkAccKeyOutput
- Rename:
*
SavePubKey
toSaveOfflineKey
and remove thealgo
argument. *NewMultiInfo
,NewLedgerInfo
toNewLegacyMultiInfo
,newLegacyLedgerInfo
respectively. *NewOfflineInfo
tonewLegacyOfflineInfo
and move it tomigration_test.go
.
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.
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.
- The
x/params
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.
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.
The staking module
added a new message type to cancel unbonding delegations. Users that have unbonded by accident or wish to cancel a undelegation can now specify the amount and valdiator they would like to cancel the unbond from
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:8cb30a2c4de74dc9bd8d260b1e75e176 --output <some_folder>
.
Cosmos message protobufs should be extended with cosmos.msg.v1.signer
:
message MsgSetWithdrawAddress {
option (cosmos.msg.v1.signer) = "delegator_address"; ++
option (gogoproto.equal) = false;
option (gogoproto.goproto_getters) = false;
string delegator_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
string withdraw_address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
}
When clients interract with a node they are required to set a codec in in the grpc.Dial. More information can be found in this doc.