cmd: migrate to urfave/cli/v2 (#24751)

This change updates our urfave/cli dependency to the v2 branch of the library. There are some Go API changes in cli v2: - Flag values can now be accessed using the methods ctx.Bool, ctx.Int, ctx.String, ... regardless of whether the flag is 'local' or 'global'. - v2 has built-in support for flag categories. Our home-grown category system is removed and the categories of flags are assigned as part of the flag definition. For users, there is only one observable difference with cli v2: flags must now strictly appear before regular arguments. For example, the following command is now invalid: geth account import mykey.json --password file.txt Instead, the command must be invoked as follows: geth account import --password file.txt mykey.json
2022-06-27 18:22:36 +02:00
parent 119f955686
commit 52ed3570c4
61 changed files with 2353 additions and 2320 deletions
@@ -40,26 +40,24 @@ import (
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/ethereum/go-ethereum/trie"
 	"github.com/olekukonko/tablewriter"
-	"gopkg.in/urfave/cli.v1"
+	"github.com/urfave/cli/v2"
 )

 var (
-	removedbCommand = cli.Command{
-		Action:    utils.MigrateFlags(removeDB),
+	removedbCommand = &cli.Command{
+		Action:    removeDB,
 		Name:      "removedb",
 		Usage:     "Remove blockchain and state databases",
 		ArgsUsage: "",
 		Flags:     utils.DatabasePathFlags,
-		Category:  "DATABASE COMMANDS",
 		Description: `
 Remove blockchain and state databases`,
 	}
-	dbCommand = cli.Command{
+	dbCommand = &cli.Command{
 		Name:      "db",
 		Usage:     "Low level database operations",
 		ArgsUsage: "",
-		Category:  "DATABASE COMMANDS",
-		Subcommands: []cli.Command{
+		Subcommands: []*cli.Command{
 			dbInspectCmd,
 			dbStatCmd,
 			dbCompactCmd,
@@ -75,8 +73,8 @@ Remove blockchain and state databases`,
 			dbCheckStateContentCmd,
 		},
 	}
-	dbInspectCmd = cli.Command{
-		Action:    utils.MigrateFlags(inspect),
+	dbInspectCmd = &cli.Command{
+		Action:    inspect,
 		Name:      "inspect",
 		ArgsUsage: "<prefix> <start>",
 		Flags: utils.GroupFlags([]cli.Flag{
@@ -85,8 +83,8 @@ Remove blockchain and state databases`,
 		Usage:       "Inspect the storage size for each type of data in the database",
 		Description: `This commands iterates the entire database. If the optional 'prefix' and 'start' arguments are provided, then the iteration is limited to the given subset of data.`,
 	}
-	dbCheckStateContentCmd = cli.Command{
-		Action:    utils.MigrateFlags(checkStateContent),
+	dbCheckStateContentCmd = &cli.Command{
+		Action:    checkStateContent,
 		Name:      "check-state-content",
 		ArgsUsage: "<start (optional)>",
 		Flags:     utils.GroupFlags(utils.NetworkFlags, utils.DatabasePathFlags),
@@ -95,16 +93,16 @@ Remove blockchain and state databases`,
 For each trie node encountered, it checks that the key corresponds to the keccak256(value). If this is not true, this indicates
 a data corruption.`,
 	}
-	dbStatCmd = cli.Command{
-		Action: utils.MigrateFlags(dbStats),
+	dbStatCmd = &cli.Command{
+		Action: dbStats,
 		Name:   "stats",
 		Usage:  "Print leveldb statistics",
 		Flags: utils.GroupFlags([]cli.Flag{
 			utils.SyncModeFlag,
 		}, utils.NetworkFlags, utils.DatabasePathFlags),
 	}
-	dbCompactCmd = cli.Command{
-		Action: utils.MigrateFlags(dbCompact),
+	dbCompactCmd = &cli.Command{
+		Action: dbCompact,
 		Name:   "compact",
 		Usage:  "Compact leveldb database. WARNING: May take a very long time",
 		Flags: utils.GroupFlags([]cli.Flag{
@@ -116,8 +114,8 @@ a data corruption.`,
 WARNING: This operation may take a very long time to finish, and may cause database
 corruption if it is aborted during execution'!`,
 	}
-	dbGetCmd = cli.Command{
-		Action:    utils.MigrateFlags(dbGet),
+	dbGetCmd = &cli.Command{
+		Action:    dbGet,
 		Name:      "get",
 		Usage:     "Show the value of a database key",
 		ArgsUsage: "<hex-encoded key>",
@@ -126,8 +124,8 @@ corruption if it is aborted during execution'!`,
 		}, utils.NetworkFlags, utils.DatabasePathFlags),
 		Description: "This command looks up the specified database key from the database.",
 	}
-	dbDeleteCmd = cli.Command{
-		Action:    utils.MigrateFlags(dbDelete),
+	dbDeleteCmd = &cli.Command{
+		Action:    dbDelete,
 		Name:      "delete",
 		Usage:     "Delete a database key (WARNING: may corrupt your database)",
 		ArgsUsage: "<hex-encoded key>",
@@ -137,8 +135,8 @@ corruption if it is aborted during execution'!`,
 		Description: `This command deletes the specified database key from the database. 
 WARNING: This is a low-level operation which may cause database corruption!`,
 	}
-	dbPutCmd = cli.Command{
-		Action:    utils.MigrateFlags(dbPut),
+	dbPutCmd = &cli.Command{
+		Action:    dbPut,
 		Name:      "put",
 		Usage:     "Set the value of a database key (WARNING: may corrupt your database)",
 		ArgsUsage: "<hex-encoded key> <hex-encoded value>",
@@ -148,8 +146,8 @@ WARNING: This is a low-level operation which may cause database corruption!`,
 		Description: `This command sets a given database key to the given value. 
 WARNING: This is a low-level operation which may cause database corruption!`,
 	}
-	dbGetSlotsCmd = cli.Command{
-		Action:    utils.MigrateFlags(dbDumpTrie),
+	dbGetSlotsCmd = &cli.Command{
+		Action:    dbDumpTrie,
 		Name:      "dumptrie",
 		Usage:     "Show the storage key/values of a given storage trie",
 		ArgsUsage: "<hex-encoded storage trie root> <hex-encoded start (optional)> <int max elements (optional)>",
@@ -158,8 +156,8 @@ WARNING: This is a low-level operation which may cause database corruption!`,
 		}, utils.NetworkFlags, utils.DatabasePathFlags),
 		Description: "This command looks up the specified database key from the database.",
 	}
-	dbDumpFreezerIndex = cli.Command{
-		Action:    utils.MigrateFlags(freezerInspect),
+	dbDumpFreezerIndex = &cli.Command{
+		Action:    freezerInspect,
 		Name:      "freezer-index",
 		Usage:     "Dump out the index of a given freezer type",
 		ArgsUsage: "<type> <start (int)> <end (int)>",
@@ -168,8 +166,8 @@ WARNING: This is a low-level operation which may cause database corruption!`,
 		}, utils.NetworkFlags, utils.DatabasePathFlags),
 		Description: "This command displays information about the freezer index.",
 	}
-	dbImportCmd = cli.Command{
-		Action:    utils.MigrateFlags(importLDBdata),
+	dbImportCmd = &cli.Command{
+		Action:    importLDBdata,
 		Name:      "import",
 		Usage:     "Imports leveldb-data from an exported RLP dump.",
 		ArgsUsage: "<dumpfile> <start (optional)",
@@ -178,8 +176,8 @@ WARNING: This is a low-level operation which may cause database corruption!`,
 		}, utils.NetworkFlags, utils.DatabasePathFlags),
 		Description: "The import command imports the specific chain data from an RLP encoded stream.",
 	}
-	dbExportCmd = cli.Command{
-		Action:    utils.MigrateFlags(exportChaindata),
+	dbExportCmd = &cli.Command{
+		Action:    exportChaindata,
 		Name:      "export",
 		Usage:     "Exports the chain data into an RLP dump. If the <dumpfile> has .gz suffix, gzip compression will be used.",
 		ArgsUsage: "<type> <dumpfile>",
@@ -188,8 +186,8 @@ WARNING: This is a low-level operation which may cause database corruption!`,
 		}, utils.NetworkFlags, utils.DatabasePathFlags),
 		Description: "Exports the specified chain data to an RLP encoded stream, optionally gzip-compressed.",
 	}
-	dbMetadataCmd = cli.Command{
-		Action: utils.MigrateFlags(showMetaData),
+	dbMetadataCmd = &cli.Command{
+		Action: showMetaData,
 		Name:   "metadata",
 		Usage:  "Shows metadata about the chain status.",
 		Flags: utils.GroupFlags([]cli.Flag{
@@ -197,8 +195,8 @@ WARNING: This is a low-level operation which may cause database corruption!`,
 		}, utils.NetworkFlags, utils.DatabasePathFlags),
 		Description: "Shows metadata about the chain status.",
 	}
-	dbMigrateFreezerCmd = cli.Command{
-		Action:    utils.MigrateFlags(freezerMigrate),
+	dbMigrateFreezerCmd = &cli.Command{
+		Action:    freezerMigrate,
 		Name:      "freezer-migrate",
 		Usage:     "Migrate legacy parts of the freezer. (WARNING: may take a long time)",
 		ArgsUsage: "",