diff --git a/simapp/app_test.go b/simapp/app_test.go index 7dd4f73917..72acc777d9 100644 --- a/simapp/app_test.go +++ b/simapp/app_test.go @@ -106,7 +106,7 @@ func TestRunMigrations(t *testing.T) { testCases := []struct { name string moduleName string - forVersion uint64 + fromVersion uint64 expRegErr bool // errors while registering migration expRegErrMsg string expRunErr bool // errors while running migration @@ -134,7 +134,7 @@ func TestRunMigrations(t *testing.T) { false, "", false, "", 1, }, { - "cannot register migration handler for same module & forVersion", + "cannot register migration handler for same module & fromVersion", "bank", 1, true, "another migration for module bank and version 1 already exists: internal logic error", false, "", 0, }, @@ -151,8 +151,8 @@ func TestRunMigrations(t *testing.T) { called := 0 if tc.moduleName != "" { - // Register migration for module from version `forVersion` to `forVersion+1`. - err = app.configurator.RegisterMigration(tc.moduleName, tc.forVersion, func(sdk.Context) error { + // Register migration for module from version `fromVersion` to `fromVersion+1`. + err = app.configurator.RegisterMigration(tc.moduleName, tc.fromVersion, func(sdk.Context) error { called++ return nil diff --git a/types/module/configurator.go b/types/module/configurator.go index 07c3b50942..c0b25a82e9 100644 --- a/types/module/configurator.go +++ b/types/module/configurator.go @@ -26,14 +26,14 @@ type Configurator interface { // RegisterMigration registers an in-place store migration for a module. The // handler is a migration script to perform in-place migrations from version - // `forVersion` to version `forVersion+1`. + // `fromVersion` to version `fromVersion+1`. // // EACH TIME a module's ConsensusVersion increments, a new migration MUST // be registered using this function. If a migration handler is missing for // a particular function, the upgrade logic (see RunMigrations function) // will panic. If the ConsensusVersion bump does not introduce any store // changes, then a no-op function must be registered here. - RegisterMigration(moduleName string, forVersion uint64, handler MigrationHandler) error + RegisterMigration(moduleName string, fromVersion uint64, handler MigrationHandler) error } type configurator struct { @@ -41,7 +41,7 @@ type configurator struct { msgServer grpc.Server queryServer grpc.Server - // migrations is a map of moduleName -> forVersion -> migration script handler + // migrations is a map of moduleName -> fromVersion -> migration script handler migrations map[string]map[uint64]MigrationHandler } @@ -68,8 +68,8 @@ func (c configurator) QueryServer() grpc.Server { } // RegisterMigration implements the Configurator.RegisterMigration method -func (c configurator) RegisterMigration(moduleName string, forVersion uint64, handler MigrationHandler) error { - if forVersion == 0 { +func (c configurator) RegisterMigration(moduleName string, fromVersion uint64, handler MigrationHandler) error { + if fromVersion == 0 { return sdkerrors.Wrap(sdkerrors.ErrInvalidVersion, "module migration versions should start at 1") } @@ -77,11 +77,11 @@ func (c configurator) RegisterMigration(moduleName string, forVersion uint64, ha c.migrations[moduleName] = map[uint64]MigrationHandler{} } - if c.migrations[moduleName][forVersion] != nil { - return sdkerrors.Wrapf(sdkerrors.ErrLogic, "another migration for module %s and version %d already exists", moduleName, forVersion) + if c.migrations[moduleName][fromVersion] != nil { + return sdkerrors.Wrapf(sdkerrors.ErrLogic, "another migration for module %s and version %d already exists", moduleName, fromVersion) } - c.migrations[moduleName][forVersion] = handler + c.migrations[moduleName][fromVersion] = handler return nil }