v4 upgrade

CHANGELOG.md

@@ -40,6 +40,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v4.0.0](https://github.com/Stride-Labs/stride/releases/tag/v4.0.0) - 2022-11-27
+### On-Chain changes
+
+
+
+### Off-Chain changes
+
+These changes do not affect any on-chain functionality, but have been implemented since `v4.0.0`.
+
+
+
 ## [v3.0.0](https://github.com/Stride-Labs/stride/releases/tag/v3.0.0) - 2022-11-18
 ### On-Chain changes
 

app/app.go

@@ -136,7 +136,7 @@ import (
 const (
 	AccountAddressPrefix = "stride"
 	Name                 = "stride"
-	Version              = "3.0.0"
+	Version              = "4.0.0"
 )
 
 // this line is used by starport scaffolding # stargate/wasm/app/enabledProposals
@@ -1002,6 +1002,8 @@ func initParamsKeeper(appCodec codec.BinaryCodec, legacyAmino *codec.LegacyAmino
 	paramsKeeper.Subspace(icacallbacksmoduletypes.ModuleName)
 	// this line is used by starport scaffolding # stargate/app/paramSubspace
 
+	paramsKeeper.Subspace(claimtypes.ModuleName)
+	paramsKeeper.Subspace(authz.ModuleName)
 	return paramsKeeper
 }
 

app/apptesting/test_helpers.go

@@ -2,12 +2,15 @@ package apptesting
 
 import (
 	"strings"
+	"time"
 
+	abci "github.com/tendermint/tendermint/abci/types"
 	ibctransfertypes "github.com/cosmos/ibc-go/v3/modules/apps/transfer/types"
 
 	"github.com/cosmos/cosmos-sdk/baseapp"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	minttypes "github.com/cosmos/cosmos-sdk/x/mint/types"
+	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
 	icatypes "github.com/cosmos/ibc-go/v3/modules/apps/27-interchain-accounts/types"
 	transfertypes "github.com/cosmos/ibc-go/v3/modules/apps/transfer/types"
 	channeltypes "github.com/cosmos/ibc-go/v3/modules/core/04-channel/types"
@@ -36,6 +39,7 @@ var (
 type AppTestHelper struct {
 	suite.Suite
 
+	Context 	sdk.Context
 	App     *app.StrideApp
 	HostApp *simapp.SimApp
 
@@ -57,6 +61,7 @@ func (s *AppTestHelper) Setup() {
 		GRPCQueryRouter: s.App.GRPCQueryRouter(),
 		Ctx:             s.Ctx(),
 	}
+	s.Context = s.App.BaseApp.NewContext(false, tmtypes.Header{Height: 1, ChainID: StrideChainID, Time: time.Now().UTC()})
 	s.TestAccs = CreateRandomAccounts(3)
 	s.IbcEnabled = false
 	s.IcaAddresses = make(map[string]string)
@@ -311,3 +316,20 @@ func (s *AppTestHelper) ICS20PacketAcknowledgement() channeltypes.Acknowledgemen
 	ack := channeltypes.NewResultAcknowledgement(s.MarshalledICS20PacketData())
 	return ack
 }
+
+func (s *AppTestHelper) ConfirmUpgradeSucceededs(upgradeName string, upgradeHeight int64) {
+	contextBeforeUpgrade := s.Ctx().WithBlockHeight(upgradeHeight - 1)
+	contextAtUpgrade := s.Ctx().WithBlockHeight(upgradeHeight)
+
+	plan := upgradetypes.Plan{Name: upgradeName, Height: upgradeHeight}
+	err := s.App.UpgradeKeeper.ScheduleUpgrade(contextBeforeUpgrade, plan)
+	s.Require().NoError(err)
+
+	plan, exists := s.App.UpgradeKeeper.GetUpgradePlan(contextBeforeUpgrade)
+	s.Require().True(exists)
+
+	s.Require().NotPanics(func() {
+	 beginBlockRequest := abci.RequestBeginBlock{}
+	 s.App.BeginBlocker(contextAtUpgrade, beginBlockRequest)
+	})
+ }

app/upgrades.go

@@ -8,7 +8,9 @@ import (
 
 	v2 "github.com/Stride-Labs/stride/v3/app/upgrades/v2"
 	v3 "github.com/Stride-Labs/stride/v3/app/upgrades/v3"
+	v4 "github.com/Stride-Labs/stride/v3/app/upgrades/v4"
 	claimtypes "github.com/Stride-Labs/stride/v3/x/claim/types"
+	authzkeeper "github.com/cosmos/cosmos-sdk/x/authz/keeper"
 )
 
 func (app *StrideApp) setupUpgradeHandlers() {
@@ -24,6 +26,12 @@ func (app *StrideApp) setupUpgradeHandlers() {
 		v3.CreateUpgradeHandler(app.mm, app.configurator, app.ClaimKeeper),
 	)
 
+	// v4 upgrade handler
+	app.UpgradeKeeper.SetUpgradeHandler(
+		v4.UpgradeName,
+		v4.CreateUpgradeHandler(app.mm, app.configurator),
+	)
+
 	upgradeInfo, err := app.UpgradeKeeper.ReadUpgradeInfoFromDisk()
 	if err != nil {
 		panic(fmt.Errorf("Failed to read upgrade info from disk: %w", err))
@@ -41,6 +49,10 @@ func (app *StrideApp) setupUpgradeHandlers() {
 		storeUpgrades = &storetypes.StoreUpgrades{
 			Added: []string{claimtypes.StoreKey},
 		}
+	case "v4":
+		storeUpgrades = &storetypes.StoreUpgrades{
+			Added: []string{authzkeeper.StoreKey},
+		}
 	}
 
 	if storeUpgrades != nil {

app/upgrades/v3/upgrades_test.go

@@ -0,0 +1,64 @@
+package v3_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/suite"
+
+	"github.com/Stride-Labs/stride/v3/app/apptesting"
+)
+var (
+	airdropIdentifiers = []string{"stride", "gaia", "osmosis", "juno", "stars"}
+)
+const dummyUpgradeHeight = 5
+
+type UpgradeTestSuite struct {
+	apptesting.AppTestHelper
+}
+
+func (s *UpgradeTestSuite) SetupTest() {
+	s.Setup()
+}
+
+func TestKeeperTestSuite(t *testing.T) {
+	suite.Run(t, new(UpgradeTestSuite))
+}
+
+func (suite *UpgradeTestSuite) TestUpgrade() {
+	testCases := []struct {
+		msg         string
+		preUpdate  func()
+		update      func()
+		postUpdate func()
+		expPass     bool
+	}{
+		{
+			"Test that upgrade does not panic",
+			func() {
+				suite.Setup()
+			},
+			func() {
+				suite.ConfirmUpgradeSucceededs("v3", dummyUpgradeHeight)
+
+				// make sure claim record was set
+				afterCtx := suite.Ctx().WithBlockHeight(dummyUpgradeHeight)
+				for _, identifier := range(airdropIdentifiers) {
+					claimRecords := suite.App.ClaimKeeper.GetClaimRecords(afterCtx, identifier)
+					suite.Require().NotEqual(0, len(claimRecords))
+				}
+			},
+			func() {
+			},
+			true,
+		},
+	}
+
+	for _, tc := range testCases {
+		suite.Run(fmt.Sprintf("Case %s", tc.msg), func() {
+			tc.preUpdate()
+			tc.update()
+			tc.postUpdate()
+		})
+	}
+}

app/upgrades/v4/README.md

@@ -0,0 +1,6 @@
+# Upgrade v4 Changelog
+
+1. Add authz storeKey to StoreLoader
+2. Add authz & claim modules to params subspaces
+
+

app/upgrades/v4/upgrades.go

@@ -0,0 +1,27 @@
+package v4
+
+import (
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/types/module"
+	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
+)
+
+// Note: ensure these values are properly set before running upgrade
+var (
+	UpgradeName         = "v4"
+)
+
+// CreateUpgradeHandler creates an SDK upgrade handler for v3
+func CreateUpgradeHandler(
+	mm *module.Manager,
+	configurator module.Configurator,
+) upgradetypes.UpgradeHandler {
+	return func(ctx sdk.Context, _ upgradetypes.Plan, vm module.VersionMap) (module.VersionMap, error) {
+		newVm, err := mm.RunMigrations(ctx, configurator, vm)
+		if err != nil {
+			return newVm, err
+		}
+		return newVm, nil
+	}
+}

app/upgrades/v4/upgrades_test.go

@@ -0,0 +1,64 @@
+package v4_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/suite"
+
+	authz "github.com/cosmos/cosmos-sdk/x/authz"
+
+	"github.com/Stride-Labs/stride/v3/app/apptesting"
+)
+
+const dummyUpgradeHeight = 5
+
+type UpgradeTestSuite struct {
+	apptesting.AppTestHelper
+}
+
+func (s *UpgradeTestSuite) SetupTest() {
+	s.Setup()
+}
+
+func TestKeeperTestSuite(t *testing.T) {
+	suite.Run(t, new(UpgradeTestSuite))
+}
+
+func (suite *UpgradeTestSuite) TestUpgrade() {
+	testCases := []struct {
+		msg         string
+		preUpdate  func()
+		update      func()
+		postUpdate func()
+		expPass     bool
+	}{
+		{
+			"Test that upgrade does not panic",
+			func() {
+				suite.Setup()
+			},
+			func() {
+				suite.ConfirmUpgradeSucceededs("v4", dummyUpgradeHeight)
+
+				// make sure authz module was init
+				afterCtx := suite.Ctx().WithBlockHeight(dummyUpgradeHeight)
+				actGenState := suite.App.AuthzKeeper.ExportGenesis(afterCtx)
+				expGenState := authz.DefaultGenesisState()
+				suite.Require().NotNil(actGenState)
+				suite.Require().Equal(&expGenState, &actGenState)
+			},
+			func() {
+			},
+			true,
+		},
+	}
+
+	for _, tc := range testCases {
+		suite.Run(fmt.Sprintf("Case %s", tc.msg), func() {
+			tc.preUpdate()
+			tc.update()
+			tc.postUpdate()
+		})
+	}
+}

cmd/strided/config/config.go

@@ -40,7 +40,7 @@ func SetupConfig() {
 
 	version.AppName = "stride"
 	version.Name = "strided"
-	version.Version = "v3.0.0"
+	version.Version = "v4.0.0"
 }
 
 // SetBech32Prefixes sets the global prefixes to be used when serializing addresses and public keys to Bech32 strings.