go-ethereum/internal/cli/peers_remove.go
Jerry a131e427f6 Automatically generate markdown pages from bor CLI
Adding a script that can automatically generate markdown pages from bor
CLI, so we can avoid copy-pasting helper strings whenever a flag is created,
deleted, or modified.

CLI docs could be generated with command `make docs`.
2022-05-09 17:10:36 +02:00

83 lines
1.7 KiB
Go

package cli
import (
"context"
"strings"
"github.com/ethereum/go-ethereum/internal/cli/flagset"
"github.com/ethereum/go-ethereum/internal/cli/server/proto"
)
// PeersRemoveCommand is the command to group the peers commands
type PeersRemoveCommand struct {
*Meta2
trusted bool
}
// MarkDown implements cli.MarkDown interface
func (p *PeersRemoveCommand) MarkDown() string {
items := []string{
"# Peers remove",
"The ```peers remove <enode>``` command disconnects the local client from a connected peer if exists.",
p.Flags().MarkDown(),
}
return strings.Join(items, "\n\n")
}
// Help implements the cli.Command interface
func (p *PeersRemoveCommand) Help() string {
return `Usage: bor peers remove <enode>
Disconnects the local client from a connected peer if exists.
` + p.Flags().Help()
}
func (p *PeersRemoveCommand) Flags() *flagset.Flagset {
flags := p.NewFlagSet("peers remove")
flags.BoolFlag(&flagset.BoolFlag{
Name: "trusted",
Usage: "Add the peer as a trusted",
Value: &p.trusted,
})
return flags
}
// Synopsis implements the cli.Command interface
func (c *PeersRemoveCommand) Synopsis() string {
return "Disconnects a peer from the client"
}
// Run implements the cli.Command interface
func (c *PeersRemoveCommand) Run(args []string) int {
flags := c.Flags()
if err := flags.Parse(args); err != nil {
c.UI.Error(err.Error())
return 1
}
args = flags.Args()
if len(args) != 1 {
c.UI.Error("No enode address provided")
return 1
}
borClt, err := c.BorConn()
if err != nil {
c.UI.Error(err.Error())
return 1
}
req := &proto.PeersRemoveRequest{
Enode: args[0],
Trusted: c.trusted,
}
if _, err := borClt.PeersRemove(context.Background(), req); err != nil {
c.UI.Error(err.Error())
return 1
}
return 0
}