refactor(p2p/nodekey)!: remove NodeKey suffix (cometbft#4304)

Refs cometbft#4302 **Important: no logic has been changed; just moving stuff and updating interfaces.**
skip-mev · Oct 24, 2024 · dd9b65b · dd9b65b
1 parent 3bd747e
commit dd9b65b
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 23 deletions.
diff --git a/abci/tutorials/abci-v2-forum-app/forum.go b/abci/tutorials/abci-v2-forum-app/forum.go
@@ -57,7 +57,7 @@ func main() {
 		panic(fmt.Errorf("failed to create Forum Application: %w", err))
 	}
 
-	nodeKey, err := nodekey.LoadNodeKey(config.NodeKeyFile())
+	nodeKey, err := nodekey.Load(config.NodeKeyFile())
 	if err != nil {
 		panic(fmt.Errorf("failed to load node key: %w", err))
 	}

diff --git a/cmd/cometbft/commands/gen_node_key.go b/cmd/cometbft/commands/gen_node_key.go
@@ -24,7 +24,7 @@ func genNodeKey(*cobra.Command, []string) error {
 		return fmt.Errorf("node key at %s already exists", nodeKeyFile)
 	}
 
-	nk, err := nodekey.LoadOrGenNodeKey(nodeKeyFile)
+	nk, err := nodekey.LoadOrGen(nodeKeyFile)
 	if err != nil {
 		return err
 	}

diff --git a/cmd/cometbft/commands/init.go b/cmd/cometbft/commands/init.go
@@ -55,7 +55,7 @@ func initFilesWithConfig(config *cfg.Config) error {
 	if cmtos.FileExists(nodeKeyFile) {
 		logger.Info("Found node key", "path", nodeKeyFile)
 	} else {
-		if _, err := nodekey.LoadOrGenNodeKey(nodeKeyFile); err != nil {
+		if _, err := nodekey.LoadOrGen(nodeKeyFile); err != nil {
 			return err
 		}
 		logger.Info("Generated node key", "path", nodeKeyFile)

diff --git a/cmd/cometbft/commands/show_node_id.go b/cmd/cometbft/commands/show_node_id.go
@@ -17,7 +17,7 @@ var ShowNodeIDCmd = &cobra.Command{
 }
 
 func showNodeID(*cobra.Command, []string) error {
-	nk, err := nodekey.LoadNodeKey(config.NodeKeyFile())
+	nk, err := nodekey.Load(config.NodeKeyFile())
 	if err != nil {
 		return err
 	}

diff --git a/cmd/cometbft/commands/testnet.go b/cmd/cometbft/commands/testnet.go
@@ -252,7 +252,7 @@ func persistentPeersString(config *cfg.Config) (string, error) {
 	for i := 0; i < nValidators+nNonValidators; i++ {
 		nodeDir := filepath.Join(outputDir, fmt.Sprintf("%s%d", nodeDirPrefix, i))
 		config.SetRoot(nodeDir)
-		nk, err := nodekey.LoadNodeKey(config.NodeKeyFile())
+		nk, err := nodekey.Load(config.NodeKeyFile())
 		if err != nil {
 			return "", err
 		}

diff --git a/node/node_test.go b/node/node_test.go
@@ -485,7 +485,7 @@ func TestNodeNewNodeCustomReactors(t *testing.T) {
 	}
 	customBlocksyncReactor := p2pmock.NewReactor()
 
-	nodeKey, err := nodekey.LoadOrGenNodeKey(config.NodeKeyFile())
+	nodeKey, err := nodekey.LoadOrGen(config.NodeKeyFile())
 	require.NoError(t, err)
 
 	pv, err := privval.LoadOrGenFilePV(config.PrivValidatorKeyFile(), config.PrivValidatorStateFile(), nil)
@@ -538,7 +538,7 @@ func TestNodeNewNodeDeleteGenesisFileFromDB(t *testing.T) {
 
 	stateDB.Close()
 
-	nodeKey, err := nodekey.LoadOrGenNodeKey(config.NodeKeyFile())
+	nodeKey, err := nodekey.LoadOrGen(config.NodeKeyFile())
 	require.NoError(t, err)
 
 	pv, err := privval.LoadOrGenFilePV(config.PrivValidatorKeyFile(), config.PrivValidatorStateFile(), nil)
@@ -581,7 +581,7 @@ func TestNodeNewNodeGenesisHashMismatch(t *testing.T) {
 	// Use goleveldb so we can reuse the same db for the second NewNode()
 	config.DBBackend = string(dbm.PebbleDBBackend)
 
-	nodeKey, err := nodekey.LoadOrGenNodeKey(config.NodeKeyFile())
+	nodeKey, err := nodekey.LoadOrGen(config.NodeKeyFile())
 	require.NoError(t, err)
 
 	pv, err := privval.LoadOrGenFilePV(config.PrivValidatorKeyFile(), config.PrivValidatorStateFile(), nil)
@@ -649,7 +649,7 @@ func TestNodeGenesisHashFlagMatch(t *testing.T) {
 	defer os.RemoveAll(config.RootDir)
 
 	config.DBBackend = string(dbm.PebbleDBBackend)
-	nodeKey, err := nodekey.LoadOrGenNodeKey(config.NodeKeyFile())
+	nodeKey, err := nodekey.LoadOrGen(config.NodeKeyFile())
 	require.NoError(t, err)
 	// Get correct hash of correct genesis file
 	jsonBlob, err := os.ReadFile(config.GenesisFile())
@@ -683,7 +683,7 @@ func TestNodeGenesisHashFlagMismatch(t *testing.T) {
 	// Use goleveldb so we can reuse the same db for the second NewNode()
 	config.DBBackend = string(dbm.PebbleDBBackend)
 
-	nodeKey, err := nodekey.LoadOrGenNodeKey(config.NodeKeyFile())
+	nodeKey, err := nodekey.LoadOrGen(config.NodeKeyFile())
 	require.NoError(t, err)
 
 	// Generate hash of wrong file

diff --git a/node/setup.go b/node/setup.go
@@ -105,7 +105,7 @@ func DefaultNewNode(
 	cliParams CliParams,
 	keyGenF func() (crypto.PrivKey, error),
 ) (*Node, error) {
-	nodeKey, err := nodekey.LoadOrGenNodeKey(config.NodeKeyFile())
+	nodeKey, err := nodekey.LoadOrGen(config.NodeKeyFile())
 	if err != nil {
 		return nil, ErrorLoadOrGenNodeKey{Err: err, NodeKeyFile: config.NodeKeyFile()}
 	}

diff --git a/p2p/nodekey/key.go → p2p/nodekey/nodekey.go b/p2p/nodekey/key.go → p2p/nodekey/nodekey.go
@@ -45,11 +45,11 @@ func PubKeyToID(pubKey crypto.PubKey) ID {
 	return ID(hex.EncodeToString(pubKey.Address()))
 }
 
-// LoadOrGenNodeKey attempts to load the NodeKey from the given filePath. If
+// LoadOrGen attempts to load the NodeKey from the given filePath. If
 // the file does not exist, it generates and saves a new NodeKey.
-func LoadOrGenNodeKey(filePath string) (*NodeKey, error) {
+func LoadOrGen(filePath string) (*NodeKey, error) {
 	if cmtos.FileExists(filePath) {
-		nodeKey, err := LoadNodeKey(filePath)
+		nodeKey, err := Load(filePath)
 		if err != nil {
 			return nil, err
 		}
@@ -68,8 +68,8 @@ func LoadOrGenNodeKey(filePath string) (*NodeKey, error) {
 	return nodeKey, nil
 }
 
-// LoadNodeKey loads NodeKey located in filePath.
-func LoadNodeKey(filePath string) (*NodeKey, error) {
+// Load loads NodeKey located in filePath.
+func Load(filePath string) (*NodeKey, error) {
 	jsonBytes, err := os.ReadFile(filePath)
 	if err != nil {
 		return nil, err

diff --git a/p2p/nodekey/key_test.go → p2p/nodekey/nodekey_test.go b/p2p/nodekey/key_test.go → p2p/nodekey/nodekey_test.go
@@ -16,10 +16,10 @@ import (
 func TestLoadOrGenNodeKey(t *testing.T) {
 	filePath := filepath.Join(os.TempDir(), cmtrand.Str(12)+"_peer_id.json")
 
-	nodeKey, err := LoadOrGenNodeKey(filePath)
+	nodeKey, err := LoadOrGen(filePath)
 	require.NoError(t, err)
 
-	nodeKey2, err := LoadOrGenNodeKey(filePath)
+	nodeKey2, err := LoadOrGen(filePath)
 	require.NoError(t, err)
 
 	assert.Equal(t, nodeKey, nodeKey2)
@@ -28,13 +28,13 @@ func TestLoadOrGenNodeKey(t *testing.T) {
 func TestLoadNodeKey(t *testing.T) {
 	filePath := filepath.Join(os.TempDir(), cmtrand.Str(12)+"_peer_id.json")
 
-	_, err := LoadNodeKey(filePath)
+	_, err := Load(filePath)
 	assert.True(t, os.IsNotExist(err))
 
-	_, err = LoadOrGenNodeKey(filePath)
+	_, err = LoadOrGen(filePath)
 	require.NoError(t, err)
 
-	nodeKey, err := LoadNodeKey(filePath)
+	nodeKey, err := Load(filePath)
 	require.NoError(t, err)
 	assert.NotNil(t, nodeKey)
 }

diff --git a/rpc/test/helpers.go b/rpc/test/helpers.go
@@ -158,7 +158,7 @@ func NewCometBFT(app abci.Application, opts *Options) *nm.Node {
 		panic(err)
 	}
 	papp := proxy.NewLocalClientCreator(app)
-	nodeKey, err := nodekey.LoadOrGenNodeKey(config.NodeKeyFile())
+	nodeKey, err := nodekey.LoadOrGen(config.NodeKeyFile())
 	if err != nil {
 		panic(err)
 	}

diff --git a/test/e2e/node/main.go b/test/e2e/node/main.go
@@ -278,7 +278,7 @@ func setupNode() (*config.Config, log.Logger, *nodekey.NodeKey, error) {
 
 	nodeLogger = nodeLogger.With("module", "main")
 
-	nodeKey, err := nodekey.LoadOrGenNodeKey(cmtcfg.NodeKeyFile())
+	nodeKey, err := nodekey.LoadOrGen(cmtcfg.NodeKeyFile())
 	if err != nil {
 		return nil, nil, nil, fmt.Errorf("failed to load or gen node key %s: %w", cmtcfg.NodeKeyFile(), err)
 	}