LaconicNetwork/cosmos-sdk
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

docs: create v2 upgrading guide skeleton (backport #22696) (#23036)

Browse Source 
Co-authored-by: Julien Robert <julien@rbrt.fr>
This commit is contained in:
mergify[bot] 2024-12-20 12:16:36 +01:00 committed by GitHub
parent 0e797c8066
commit f796021c99
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 50 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
UPGRADING_v2.md Normal file
View File

@ -0,0 +1,50 @@
# Upgrading Cosmos SDK v2 [DRAFT, see #22531](https://github.com/cosmos/cosmos-sdk/issues/22531)
This guide provides instructions for upgrading to specific versions of Cosmos SDK.
Note, always read the **SimApp** section for more information on application wiring updates.
## Upgrading from v0.52.x to v2.
First and foremost, v2 uses [depinject](./depinject/README.md) to wire the module and application dependencies.
This guide assumes that you have already made your modules depinject compatible, and that you made use of depinject in your application.
### Modules
### Server
### SimApp
With the migration to server/v2 and runtime/v2 some changes are required in the `root.go` and `app.go` of your application.
#### `app.go`
#### `root.go`
Thanks to the more modular design of v2, the application developer is free to pick which server to use in their application:
```go
// wire server commands
return serverv2.AddCommands[T](
rootCmd,
logger,
simApp,
deps.GlobalConfig,
initServerConfig(),
deps.ConsensusServer,
grpcServer,
storeComponent,
telemetryServer,
restServer,
grpcgatewayServer,
)
```
## Upgrading from v0.50.x to v2
Upgrading directly from v0.50.x to v2 is supported.
Modules should be updated to support all the latest changes in the SDK.
Read the module section from the v0.52 [UPGRADING.md](UPGRADING.md) file for more information.
Then simply follow the instructions from the [v0.52 section](#upgrading-from-v052x-to-v200) from this file.