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

cmd/checkpoint-admin/common.go

@@ -28,12 +28,12 @@ import (
 	"github.com/ethereum/go-ethereum/ethclient"
 	"github.com/ethereum/go-ethereum/params"
 	"github.com/ethereum/go-ethereum/rpc"
-	"gopkg.in/urfave/cli.v1"
+	"github.com/urfave/cli/v2"
 )
 
 // newClient creates a client with specified remote URL.
 func newClient(ctx *cli.Context) *ethclient.Client {
-	client, err := ethclient.Dial(ctx.GlobalString(nodeURLFlag.Name))
+	client, err := ethclient.Dial(ctx.String(nodeURLFlag.Name))
 	if err != nil {
 		utils.Fatalf("Failed to connect to Ethereum node: %v", err)
 	}
@@ -64,9 +64,9 @@ func getContractAddr(client *rpc.Client) common.Address {
 func getCheckpoint(ctx *cli.Context, client *rpc.Client) *params.TrustedCheckpoint {
 	var checkpoint *params.TrustedCheckpoint
 
-	if ctx.GlobalIsSet(indexFlag.Name) {
+	if ctx.IsSet(indexFlag.Name) {
 		var result [3]string
-		index := uint64(ctx.GlobalInt64(indexFlag.Name))
+		index := uint64(ctx.Int64(indexFlag.Name))
 		if err := client.Call(&result, "les_getCheckpoint", index); err != nil {
 			utils.Fatalf("Failed to get local checkpoint %v, please ensure the les API is exposed", err)
 		}

cmd/checkpoint-admin/exec.go

@@ -36,10 +36,10 @@ import (
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/ethereum/go-ethereum/params"
 	"github.com/ethereum/go-ethereum/rpc"
-	"gopkg.in/urfave/cli.v1"
+	"github.com/urfave/cli/v2"
 )
 
-var commandDeploy = cli.Command{
+var commandDeploy = &cli.Command{
 	Name:  "deploy",
 	Usage: "Deploy a new checkpoint oracle contract",
 	Flags: []cli.Flag{
@@ -49,10 +49,10 @@ var commandDeploy = cli.Command{
 		signersFlag,
 		thresholdFlag,
 	},
-	Action: utils.MigrateFlags(deploy),
+	Action: deploy,
 }
 
-var commandSign = cli.Command{
+var commandSign = &cli.Command{
 	Name:  "sign",
 	Usage: "Sign the checkpoint with the specified key",
 	Flags: []cli.Flag{
@@ -63,10 +63,10 @@ var commandSign = cli.Command{
 		hashFlag,
 		oracleFlag,
 	},
-	Action: utils.MigrateFlags(sign),
+	Action: sign,
 }
 
-var commandPublish = cli.Command{
+var commandPublish = &cli.Command{
 	Name:  "publish",
 	Usage: "Publish a checkpoint into the oracle",
 	Flags: []cli.Flag{
@@ -76,7 +76,7 @@ var commandPublish = cli.Command{
 		indexFlag,
 		signaturesFlag,
 	},
-	Action: utils.MigrateFlags(publish),
+	Action: publish,
 }
 
 // deploy deploys the checkpoint registrar contract.
@@ -132,7 +132,7 @@ func sign(ctx *cli.Context) error {
 		node   *rpc.Client
 		oracle *checkpointoracle.CheckpointOracle
 	)
-	if !ctx.GlobalIsSet(nodeURLFlag.Name) {
+	if !ctx.IsSet(nodeURLFlag.Name) {
 		// Offline mode signing
 		offline = true
 		if !ctx.IsSet(hashFlag.Name) {
@@ -151,7 +151,7 @@ func sign(ctx *cli.Context) error {
 		address = common.HexToAddress(ctx.String(oracleFlag.Name))
 	} else {
 		// Interactive mode signing, retrieve the data from the remote node
-		node = newRPCClient(ctx.GlobalString(nodeURLFlag.Name))
+		node = newRPCClient(ctx.String(nodeURLFlag.Name))
 
 		checkpoint := getCheckpoint(ctx, node)
 		chash, cindex, address = checkpoint.Hash(), checkpoint.SectionIndex, getContractAddr(node)
@@ -265,7 +265,7 @@ func publish(ctx *cli.Context) error {
 	}
 	// Retrieve the checkpoint we want to sign to sort the signatures
 	var (
-		client       = newRPCClient(ctx.GlobalString(nodeURLFlag.Name))
+		client       = newRPCClient(ctx.String(nodeURLFlag.Name))
 		addr, oracle = newContract(client)
 		checkpoint   = getCheckpoint(ctx, client)
 		sighash      = sighash(checkpoint.SectionIndex, addr, checkpoint.Hash())

cmd/checkpoint-admin/main.go

@@ -25,20 +25,20 @@ import (
 	"github.com/ethereum/go-ethereum/common/fdlimit"
 	"github.com/ethereum/go-ethereum/internal/flags"
 	"github.com/ethereum/go-ethereum/log"
-	"gopkg.in/urfave/cli.v1"
+	"github.com/urfave/cli/v2"
 )
 
 var (
 	// Git SHA1 commit hash of the release (set via linker flags)
 	gitCommit = ""
 	gitDate   = ""
-)
 
-var app *cli.App
+	app *cli.App
+)
 
 func init() {
 	app = flags.NewApp(gitCommit, gitDate, "ethereum checkpoint helper tool")
-	app.Commands = []cli.Command{
+	app.Commands = []*cli.Command{
 		commandStatus,
 		commandDeploy,
 		commandSign,
@@ -48,46 +48,45 @@ func init() {
 		oracleFlag,
 		nodeURLFlag,
 	}
-	cli.CommandHelpTemplate = flags.OriginCommandHelpTemplate
 }
 
 // Commonly used command line flags.
 var (
-	indexFlag = cli.Int64Flag{
+	indexFlag = &cli.Int64Flag{
 		Name:  "index",
 		Usage: "Checkpoint index (query latest from remote node if not specified)",
 	}
-	hashFlag = cli.StringFlag{
+	hashFlag = &cli.StringFlag{
 		Name:  "hash",
 		Usage: "Checkpoint hash (query latest from remote node if not specified)",
 	}
-	oracleFlag = cli.StringFlag{
+	oracleFlag = &cli.StringFlag{
 		Name:  "oracle",
 		Usage: "Checkpoint oracle address (query from remote node if not specified)",
 	}
-	thresholdFlag = cli.Int64Flag{
+	thresholdFlag = &cli.Int64Flag{
 		Name:  "threshold",
 		Usage: "Minimal number of signatures required to approve a checkpoint",
 	}
-	nodeURLFlag = cli.StringFlag{
+	nodeURLFlag = &cli.StringFlag{
 		Name:  "rpc",
 		Value: "http://localhost:8545",
 		Usage: "The rpc endpoint of a local or remote geth node",
 	}
-	clefURLFlag = cli.StringFlag{
+	clefURLFlag = &cli.StringFlag{
 		Name:  "clef",
 		Value: "http://localhost:8550",
 		Usage: "The rpc endpoint of clef",
 	}
-	signerFlag = cli.StringFlag{
+	signerFlag = &cli.StringFlag{
 		Name:  "signer",
 		Usage: "Signer address for clef signing",
 	}
-	signersFlag = cli.StringFlag{
+	signersFlag = &cli.StringFlag{
 		Name:  "signers",
 		Usage: "Comma separated accounts of trusted checkpoint signers",
 	}
-	signaturesFlag = cli.StringFlag{
+	signaturesFlag = &cli.StringFlag{
 		Name:  "signatures",
 		Usage: "Comma separated checkpoint signatures to submit",
 	}

cmd/checkpoint-admin/status.go

@@ -19,24 +19,23 @@ package main
 import (
 	"fmt"
 
-	"github.com/ethereum/go-ethereum/cmd/utils"
 	"github.com/ethereum/go-ethereum/common"
-	"gopkg.in/urfave/cli.v1"
+	"github.com/urfave/cli/v2"
 )
 
-var commandStatus = cli.Command{
+var commandStatus = &cli.Command{
 	Name:  "status",
 	Usage: "Fetches the signers and checkpoint status of the oracle contract",
 	Flags: []cli.Flag{
 		nodeURLFlag,
 	},
-	Action: utils.MigrateFlags(status),
+	Action: status,
 }
 
 // status fetches the admin list of specified registrar contract.
 func status(ctx *cli.Context) error {
 	// Create a wrapper around the checkpoint oracle contract
-	addr, oracle := newContract(newRPCClient(ctx.GlobalString(nodeURLFlag.Name)))
+	addr, oracle := newContract(newRPCClient(ctx.String(nodeURLFlag.Name)))
 	fmt.Printf("Oracle => %s\n", addr.Hex())
 	fmt.Println()