docs(wip): add protoc workflow to readme

Signed-off-by: Lorenz Herzberger <lorenzherzberger@gmail.com>
This commit is contained in:
Lorenz Herzberger 2024-11-28 13:01:56 +01:00
parent 1d89241599
commit 1e8e60ecd5
No known key found for this signature in database
GPG Key ID: FA5EE906EB55316A

View File

@ -54,6 +54,11 @@ Use the `ignite scaffold` [command](https://docs.ignite.com/references/cli#ignit
### Migrations ### Migrations
Module migrations must be registered in each respective module in the `AppModule.RegisterServices(cfg module.Configurator)` function. For each module that is to be upgraded in a migration the ConsensusVersion must be updated. In addition an `UpgradeHandler` needs to be added to the `App.setupUpgradeHandlers()`. Upgrade handlers have a name that needs to be added to an upgrade proposal which needs to be voted on by participating validators. Module migrations must be registered in each respective module in the `AppModule.RegisterServices(cfg module.Configurator)` function. For each module that is to be upgraded in a migration the ConsensusVersion must be updated. In addition an `UpgradeHandler` needs to be added to the `App.setupUpgradeHandlers()`. Upgrade handlers have a name that needs to be added to an upgrade proposal which needs to be voted on by participating validators.
### Add depinject module capabilities with protoc
Define `Module` message in `proto/planetmintgo/<module>/module.proto`. (example machine module).
git clone cosmos-sdk repo v0.47.14
use protoc -I="./proto" -I="./cosmos-sdk/proto" --go_out=./proto "./proto/planetmintgo/machine/module.proto"
For more info see [here](https://docs.cosmos.network/v0.47/learn/advanced/upgrade). For more info see [here](https://docs.cosmos.network/v0.47/learn/advanced/upgrade).
## Learn more ## Learn more