Master (#1262)

* clear

* feat: Add everything

* fix: Commenht

app/upgrades/noop/upgrades.go

@@ -1,3 +1,5 @@
+// Package noop provides a no-operation upgrade handler for testing and development.
+// This upgrade performs no actual state migrations but runs module migrations.
 package noop
 
 import (
@@ -8,10 +10,12 @@ import (
 
 	"github.com/cosmos/cosmos-sdk/types/module"
 
-	"github.com/sonr-io/snrd/app/upgrades"
+	"github.com/sonr-io/sonr/app/upgrades"
 )
 
-// NewUpgrade constructor
+// NewUpgrade creates a new no-operation upgrade with the specified semantic version.
+// This upgrade is typically used for testing upgrade mechanisms without performing
+// actual state changes beyond standard module migrations.
 func NewUpgrade(semver string) upgrades.Upgrade {
 	return upgrades.Upgrade{
 		UpgradeName:          semver,
@@ -23,6 +27,9 @@ func NewUpgrade(semver string) upgrades.Upgrade {
 	}
 }
 
+// CreateUpgradeHandler creates an upgrade handler that performs only module migrations.
+// It does not perform any custom upgrade logic, making it suitable for minor version
+// upgrades that only require standard module migrations.
 func CreateUpgradeHandler(
 	mm upgrades.ModuleManager,
 	configurator module.Configurator,

app/upgrades/types.go

@@ -1,3 +1,4 @@
+// Package upgrades provides types and interfaces for chain upgrade handling.
 package upgrades
 
 import (
@@ -14,12 +15,13 @@ import (
 	authkeeper "github.com/cosmos/cosmos-sdk/x/auth/keeper"
 	consensusparamkeeper "github.com/cosmos/cosmos-sdk/x/consensus/keeper"
 	paramskeeper "github.com/cosmos/cosmos-sdk/x/params/keeper"
-	didkeeper "github.com/sonr-io/snrd/x/did/keeper"
 )
 
+// AppKeepers holds references to all the keepers needed during chain upgrades.
+// This struct is passed to upgrade handlers to provide access to various
+// module keepers and core functionality.
 type AppKeepers struct {
 	AccountKeeper         *authkeeper.AccountKeeper
-	DidKeeper             *didkeeper.Keeper
 	ParamsKeeper          *paramskeeper.Keeper
 	ConsensusParamsKeeper *consensusparamkeeper.Keeper
 	Codec                 codec.Codec
@@ -27,8 +29,15 @@ type AppKeepers struct {
 	CapabilityKeeper      *capabilitykeeper.Keeper
 	IBCKeeper             *ibckeeper.Keeper
 }
+
+// ModuleManager defines the interface for running module migrations during upgrades.
+// It provides methods to execute migrations and retrieve the current version map.
 type ModuleManager interface {
-	RunMigrations(ctx context.Context, cfg module.Configurator, fromVM module.VersionMap) (module.VersionMap, error)
+	RunMigrations(
+		ctx context.Context,
+		cfg module.Configurator,
+		fromVM module.VersionMap,
+	) (module.VersionMap, error)
 	GetVersionMap() module.VersionMap
 }
 
@@ -37,10 +46,14 @@ type ModuleManager interface {
 // An upgrade must implement this struct, and then set it in the app.go.
 // The app.go will then define the handler.
 type Upgrade struct {
-	// Upgrade version name, for the upgrade handler, e.g. `v7`
+	// UpgradeName is the version name for the upgrade handler, e.g. `v7`.
+	// This must match the upgrade name in the governance proposal.
 	UpgradeName string
 
-	// CreateUpgradeHandler defines the function that creates an upgrade handler
+	// CreateUpgradeHandler defines the function that creates an upgrade handler.
+	// The handler performs the actual upgrade logic when the chain reaches the upgrade height.
 	CreateUpgradeHandler func(ModuleManager, module.Configurator, *AppKeepers) upgradetypes.UpgradeHandler
-	StoreUpgrades        storetypes.StoreUpgrades
+	// StoreUpgrades defines any store migrations needed for this upgrade,
+	// including adding, renaming, or deleting stores.
+	StoreUpgrades storetypes.StoreUpgrades
 }