feat: add command to modify genesis before import (#1979)

* add script to modify genesis * fix unit tests * copy only nonce to cctx and ballot list while importing genesis state * skip copying group data * generate files * use constant for max items * generate files 2 * undate sample genesis * Fix lint * Update cmd/zetacored/parse_genesis.go Co-authored-by: Lucas Bertrand <[email protected]> * add more comments * add more comments * add error checks * Update cmd/zetacored/parse_genesis.go Co-authored-by: Lucas Bertrand <[email protected]> * generate files * generate files --------- Co-authored-by: Lucas Bertrand <[email protected]>
zeta-chain · Apr 19, 2024 · fb05f0d · fb05f0d
1 parent fe916e2
commit fb05f0d
Show file tree

Hide file tree

Showing 10 changed files with 541 additions and 24 deletions.
diff --git a/app/app.go b/app/app.go
@@ -591,30 +591,7 @@ func New(
 	// so that other modules that want to create or claim capabilities afterwards in InitChain
 	// can do so safely.
 	// NOTE: Cross-chain module must be initialized after observer module, as pending nonces in crosschain needs the tss pubkey from observer module
-	app.mm.SetOrderInitGenesis(
-		authtypes.ModuleName,
-		banktypes.ModuleName,
-		distrtypes.ModuleName,
-		stakingtypes.ModuleName,
-		slashingtypes.ModuleName,
-		govtypes.ModuleName,
-		crisistypes.ModuleName,
-		evmtypes.ModuleName,
-		feemarkettypes.ModuleName,
-		paramstypes.ModuleName,
-		group.ModuleName,
-		genutiltypes.ModuleName,
-		upgradetypes.ModuleName,
-		evidencetypes.ModuleName,
-		vestingtypes.ModuleName,
-		observertypes.ModuleName,
-		crosschaintypes.ModuleName,
-		fungibletypes.ModuleName,
-		emissionstypes.ModuleName,
-		authz.ModuleName,
-		authoritytypes.ModuleName,
-		lightclienttypes.ModuleName,
-	)
+	app.mm.SetOrderInitGenesis(InitGenesisModuleList()...)
 
 	app.mm.RegisterInvariants(&app.CrisisKeeper)
 	app.mm.RegisterRoutes(app.Router(), app.QueryRouter(), encodingConfig.Amino)

diff --git a/app/init_genesis.go b/app/init_genesis.go
@@ -0,0 +1,53 @@
+package app
+
+import (
+	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+	vestingtypes "github.com/cosmos/cosmos-sdk/x/auth/vesting/types"
+	"github.com/cosmos/cosmos-sdk/x/authz"
+	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+	crisistypes "github.com/cosmos/cosmos-sdk/x/crisis/types"
+	distrtypes "github.com/cosmos/cosmos-sdk/x/distribution/types"
+	evidencetypes "github.com/cosmos/cosmos-sdk/x/evidence/types"
+	genutiltypes "github.com/cosmos/cosmos-sdk/x/genutil/types"
+	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
+	"github.com/cosmos/cosmos-sdk/x/group"
+	paramstypes "github.com/cosmos/cosmos-sdk/x/params/types"
+	slashingtypes "github.com/cosmos/cosmos-sdk/x/slashing/types"
+	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
+	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
+	evmtypes "github.com/evmos/ethermint/x/evm/types"
+	feemarkettypes "github.com/evmos/ethermint/x/feemarket/types"
+	authoritytypes "github.com/zeta-chain/zetacore/x/authority/types"
+	crosschaintypes "github.com/zeta-chain/zetacore/x/crosschain/types"
+	emissionsModuleTypes "github.com/zeta-chain/zetacore/x/emissions/types"
+	fungibleModuleTypes "github.com/zeta-chain/zetacore/x/fungible/types"
+	lightclienttypes "github.com/zeta-chain/zetacore/x/lightclient/types"
+	observertypes "github.com/zeta-chain/zetacore/x/observer/types"
+)
+
+func InitGenesisModuleList() []string {
+	return []string{
+		authtypes.ModuleName,
+		banktypes.ModuleName,
+		distrtypes.ModuleName,
+		stakingtypes.ModuleName,
+		slashingtypes.ModuleName,
+		govtypes.ModuleName,
+		crisistypes.ModuleName,
+		evmtypes.ModuleName,
+		feemarkettypes.ModuleName,
+		paramstypes.ModuleName,
+		group.ModuleName,
+		genutiltypes.ModuleName,
+		upgradetypes.ModuleName,
+		evidencetypes.ModuleName,
+		vestingtypes.ModuleName,
+		observertypes.ModuleName,
+		crosschaintypes.ModuleName,
+		fungibleModuleTypes.ModuleName,
+		emissionsModuleTypes.ModuleName,
+		authz.ModuleName,
+		authoritytypes.ModuleName,
+		lightclienttypes.ModuleName,
+	}
+}
diff --git a/changelog.md b/changelog.md
@@ -52,6 +52,7 @@
 * [1942](https://github.com/zeta-chain/node/pull/1982) - support Bitcoin P2TR, P2WSH, P2SH, P2PKH addresses
 * [1935](https://github.com/zeta-chain/node/pull/1935) - add an operational authority group
 * [1954](https://github.com/zeta-chain/node/pull/1954) - add metric for concurrent keysigns
+* [1979](https://github.com/zeta-chain/node/pull/1979) - add script to import genesis data into an existing genesis file
 * [2006](https://github.com/zeta-chain/node/pull/2006) - add Amoy testnet static chain information
 * [2046](https://github.com/zeta-chain/node/pull/2046) - add state variable in crosschain for rate limiter flags
 * [2034](https://github.com/zeta-chain/node/pull/2034) - add support for zEVM message passing

diff --git a/cmd/zetacored/parse_genesis.go b/cmd/zetacored/parse_genesis.go
@@ -0,0 +1,202 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"cosmossdk.io/math"
+	"github.com/cosmos/cosmos-sdk/client"
+	"github.com/cosmos/cosmos-sdk/codec"
+	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+	vestingtypes "github.com/cosmos/cosmos-sdk/x/auth/vesting/types"
+	"github.com/cosmos/cosmos-sdk/x/authz"
+	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+	crisistypes "github.com/cosmos/cosmos-sdk/x/crisis/types"
+	distributiontypes "github.com/cosmos/cosmos-sdk/x/distribution/types"
+	evidencetypes "github.com/cosmos/cosmos-sdk/x/evidence/types"
+	"github.com/cosmos/cosmos-sdk/x/genutil"
+	genutiltypes "github.com/cosmos/cosmos-sdk/x/genutil/types"
+	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
+	"github.com/cosmos/cosmos-sdk/x/group"
+	paramstypes "github.com/cosmos/cosmos-sdk/x/params/types"
+	slashingtypes "github.com/cosmos/cosmos-sdk/x/slashing/types"
+	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
+	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
+	evmtypes "github.com/evmos/ethermint/x/evm/types"
+	feemarkettypes "github.com/evmos/ethermint/x/feemarket/types"
+	"github.com/spf13/cobra"
+	"github.com/tendermint/tendermint/types"
+	"github.com/zeta-chain/zetacore/app"
+	crosschaintypes "github.com/zeta-chain/zetacore/x/crosschain/types"
+	emissionstypes "github.com/zeta-chain/zetacore/x/emissions/types"
+	fungibletypes "github.com/zeta-chain/zetacore/x/fungible/types"
+	observertypes "github.com/zeta-chain/zetacore/x/observer/types"
+)
+
+const MaxItemsForList = 10
+
+// Copy represents a set of modules for which, the entire state is copied without any modifications
+var Copy = map[string]bool{
+	slashingtypes.ModuleName:  true,
+	govtypes.ModuleName:       true,
+	crisistypes.ModuleName:    true,
+	feemarkettypes.ModuleName: true,
+	paramstypes.ModuleName:    true,
+	upgradetypes.ModuleName:   true,
+	evidencetypes.ModuleName:  true,
+	vestingtypes.ModuleName:   true,
+	fungibletypes.ModuleName:  true,
+	emissionstypes.ModuleName: true,
+	authz.ModuleName:          true,
+}
+
+// Skip represents a set of modules for which, the entire state is skipped and nothing gets imported
+var Skip = map[string]bool{
+	evmtypes.ModuleName:          true,
+	stakingtypes.ModuleName:      true,
+	genutiltypes.ModuleName:      true,
+	authtypes.ModuleName:         true,
+	banktypes.ModuleName:         true,
+	distributiontypes.ModuleName: true,
+	group.ModuleName:             true,
+}
+
+// Modify represents a set of modules for which, the state is modified before importing. Each Module should have a corresponding Modify function
+var Modify = map[string]bool{
+	crosschaintypes.ModuleName: true,
+	observertypes.ModuleName:   true,
+}
+
+func CmdParseGenesisFile() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "parse-genesis-file [import-genesis-file] [optional-genesis-file]",
+		Short: "Parse the provided genesis file and import the required data into the optionally provided genesis file",
+		Args:  cobra.MaximumNArgs(2),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx := client.GetClientContextFromCmd(cmd)
+			cdc := clientCtx.Codec
+			genesisFilePath := filepath.Join(app.DefaultNodeHome, "config", "genesis.json")
+			if len(args) == 2 {
+				genesisFilePath = args[1]
+			}
+			genDoc, err := GetGenDoc(genesisFilePath)
+			if err != nil {
+				return err
+			}
+			importData, err := GetGenDoc(args[0])
+			if err != nil {
+				return err
+			}
+			err = ImportDataIntoFile(genDoc, importData, cdc)
+			if err != nil {
+				return err
+			}
+
+			err = genutil.ExportGenesisFile(genDoc, genesisFilePath)
+			if err != nil {
+				return err
+			}
+
+			return nil
+		},
+	}
+	return cmd
+}
+
+func ImportDataIntoFile(genDoc *types.GenesisDoc, importFile *types.GenesisDoc, cdc codec.Codec) error {
+
+	appState, err := genutiltypes.GenesisStateFromGenDoc(*genDoc)
+	if err != nil {
+		return err
+	}
+	importAppState, err := genutiltypes.GenesisStateFromGenDoc(*importFile)
+	if err != nil {
+		return err
+	}
+	moduleList := app.InitGenesisModuleList()
+	for _, m := range moduleList {
+		if Skip[m] {
+			continue
+		}
+		if Copy[m] {
+			appState[m] = importAppState[m]
+		}
+		if Modify[m] {
+			switch m {
+			case crosschaintypes.ModuleName:
+				err := ModifyCrosschainState(appState, importAppState, cdc)
+				if err != nil {
+					return err
+				}
+			case observertypes.ModuleName:
+				err := ModifyObserverState(appState, importAppState, cdc)
+				if err != nil {
+					return err
+				}
+			default:
+				return fmt.Errorf("modify function for %s not found", m)
+			}
+		}
+	}
+
+	appStateJSON, err := json.Marshal(appState)
+	if err != nil {
+		return fmt.Errorf("failed to marshal application genesis state: %w", err)
+	}
+	genDoc.AppState = appStateJSON
+
+	return nil
+}
+
+// ModifyCrosschainState modifies the crosschain state before importing
+// It truncates the crosschain transactions, inbound transactions and finalized inbounds to MaxItemsForList
+func ModifyCrosschainState(appState map[string]json.RawMessage, importAppState map[string]json.RawMessage, cdc codec.Codec) error {
+	importedCrossChainGenState := crosschaintypes.GetGenesisStateFromAppState(cdc, importAppState)
+	importedCrossChainGenState.CrossChainTxs = importedCrossChainGenState.CrossChainTxs[:math.Min(MaxItemsForList, len(importedCrossChainGenState.CrossChainTxs))]
+	importedCrossChainGenState.InTxHashToCctxList = importedCrossChainGenState.InTxHashToCctxList[:math.Min(MaxItemsForList, len(importedCrossChainGenState.InTxHashToCctxList))]
+	importedCrossChainGenState.FinalizedInbounds = importedCrossChainGenState.FinalizedInbounds[:math.Min(MaxItemsForList, len(importedCrossChainGenState.FinalizedInbounds))]
+	importedCrossChainStateBz, err := json.Marshal(importedCrossChainGenState)
+	if err != nil {
+		return fmt.Errorf("failed to marshal zetacrosschain genesis state: %w", err)
+	}
+	appState[crosschaintypes.ModuleName] = importedCrossChainStateBz
+	return nil
+}
+
+// ModifyObserverState modifies the observer state before importing
+// It truncates the ballots and nonce to cctx list to MaxItemsForList
+func ModifyObserverState(appState map[string]json.RawMessage, importAppState map[string]json.RawMessage, cdc codec.Codec) error {
+	importedObserverGenState := observertypes.GetGenesisStateFromAppState(cdc, importAppState)
+	importedObserverGenState.Ballots = importedObserverGenState.Ballots[:math.Min(MaxItemsForList, len(importedObserverGenState.Ballots))]
+	importedObserverGenState.NonceToCctx = importedObserverGenState.NonceToCctx[:math.Min(MaxItemsForList, len(importedObserverGenState.NonceToCctx))]
+
+	currentGenState := observertypes.GetGenesisStateFromAppState(cdc, appState)
+	currentGenState.Ballots = importedObserverGenState.Ballots
+	currentGenState.NonceToCctx = importedObserverGenState.NonceToCctx
+
+	currentGenStateBz, err := cdc.MarshalJSON(&currentGenState)
+	if err != nil {
+		return fmt.Errorf("failed to marshal observer genesis state: %w", err)
+	}
+
+	appState[observertypes.ModuleName] = currentGenStateBz
+	return nil
+}
+
+func GetGenDoc(fp string) (*types.GenesisDoc, error) {
+	path, err := filepath.Abs(fp)
+	if err != nil {
+		return nil, err
+	}
+	jsonBlob, err := os.ReadFile(filepath.Clean(path))
+	if err != nil {
+		return nil, err
+	}
+	genData, err := types.GenesisDocFromJSON(jsonBlob)
+	if err != nil {
+		return nil, err
+	}
+	return genData, nil
+}