Skip to content

Commit

Permalink
cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
dB2510 committed May 5, 2022
1 parent 466b71d commit 40935a0
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions cmd/bootnode.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ func newBootnodeCmd(runFunc func(context.Context, BootnodeConfig) error) *cobra.

cmd := &cobra.Command{
Use: "bootnode",
Short: "Starts a p2p-udp discv5 bootnode",
Long: `Starts a p2p-udp discv5 bootnode that charon nodes can use to bootstrap their p2p cluster`,
Short: "Start a discv5 bootnode server",
Long: `Starts a discv5 bootnode that charon nodes can use to bootstrap their p2p cluster`,
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error {
return runFunc(cmd.Context(), config)
Expand Down
3 changes: 2 additions & 1 deletion cmd/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ import "github.com/spf13/cobra"
func newCreateCmd(cmds ...*cobra.Command) *cobra.Command {
root := &cobra.Command{
Use: "create",
Short: "Create different artifacts required for running a Charon cluster",
Short: "Create artifacts for a distributed validator cluster",
Long: "Create artifacts for a distributed validator cluster. These commands can be used to facilitate the creation of a distributed validator cluster between a group of operators by performing a distributed key generation ceremony, or they can be used to create a local cluster for single operator use cases.",
}

root.AddCommand(cmds...)
Expand Down
2 changes: 1 addition & 1 deletion cmd/createcluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ func newCreateClusterCmd(runFunc func(io.Writer, clusterConfig) error) *cobra.Co

cmd := &cobra.Command{
Use: "cluster",
Short: "Creates configuration files and private keys for a local charon cluster",
Short: "Create private keys and configuration files needed to run a distributed validator cluster locally",
Long: "Creates a local charon cluster configuration including validator keys, charon p2p keys, and a cluster manifest. " +
"See flags for supported features.",
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down
2 changes: 1 addition & 1 deletion cmd/createdkg.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ func newCreateDKGCmd(runFunc func(context.Context, createDKGConfig) error) *cobr

cmd := &cobra.Command{
Use: "dkg",
Short: "Creates a charon DKG configuration file for charon dkg",
Short: "Create the configuration for a new Distributed Key Generation ceremony using charon dkg",
Long: `Create a cluster definition file that will be used by all participants of a DKG.`,
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down
3 changes: 1 addition & 2 deletions cmd/createenr.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ func newCreateEnrCmd(runFunc func(io.Writer, p2p.Config, string) error) *cobra.C

cmd := &cobra.Command{
Use: "enr",
Short: "Creates a new enr private key",
Long: `Creates an Ethereum Node Record (ENR) private key to identify charon`,
Short: "Create an Ethereum Node Record (ENR) private key to identify this charon client",
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error {
return runFunc(cmd.OutOrStdout(), config, dataDir)
Expand Down
2 changes: 1 addition & 1 deletion cmd/dkg.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ func newDKGCmd(runFunc func(context.Context, dkg.Config) error) *cobra.Command {

cmd := &cobra.Command{
Use: "dkg",
Short: "Create distributed validator key shares by participating in a DKG ceremony",
Short: "Participate in a Distributed Key Generation ceremony",
Long: `Participate in a distributed key generation ceremony for a specific cluster definition that creates
distributed validator key shares and a final cluster lock configuration. Note that all other cluster operators should run
this command at the same time.`,
Expand Down
2 changes: 1 addition & 1 deletion cmd/enr.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ func newEnrCmd(runFunc func(io.Writer, p2p.Config, string) error) *cobra.Command

cmd := &cobra.Command{
Use: "enr",
Short: "Return this node's ENR",
Short: "Print this client's Ethereum Node Record",
Long: `Return information on this node's Ethereum Node Record (ENR)`,
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down
2 changes: 1 addition & 1 deletion cmd/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func newRunCmd(runFunc func(context.Context, app.Config) error) *cobra.Command {

cmd := &cobra.Command{
Use: "run",
Short: "Runs the Charon middleware",
Short: "Run the charon middleware client",
Long: "Starts the long-running Charon middleware process to perform distributed validator duties.",
RunE: func(cmd *cobra.Command, args []string) error {
ctx, cancel := signal.NotifyContext(cmd.Context(), os.Interrupt)
Expand Down

0 comments on commit 40935a0

Please sign in to comment.