code.vegaprotocol.io/vega@v0.79.0/cmd/vegawallet/commands/network_describe.go

// Copyright (C) 2023 Gobalsky Labs Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package cmd

import (
	"context"
	"errors"
	"fmt"
	"io"

	"code.vegaprotocol.io/vega/cmd/vegawallet/commands/cli"
	"code.vegaprotocol.io/vega/cmd/vegawallet/commands/flags"
	"code.vegaprotocol.io/vega/cmd/vegawallet/commands/printer"
	"code.vegaprotocol.io/vega/paths"
	"code.vegaprotocol.io/vega/wallet/api"
	networkStoreV1 "code.vegaprotocol.io/vega/wallet/network/store/v1"

	"github.com/spf13/cobra"
)

var (
	describeNetworkLong = cli.LongDesc(`
	    Describe all known information about the specified network.
	`)

	describeNetworkExample = cli.Examples(`
		# Describe a network
		{{.Software}} network describe --network NETWORK
	`)
)

type DescribeNetworkHandler func(api.AdminDescribeNetworkParams) (api.AdminNetwork, error)

func NewCmdDescribeNetwork(w io.Writer, rf *RootFlags) *cobra.Command {
	h := func(params api.AdminDescribeNetworkParams) (api.AdminNetwork, error) {
		vegaPaths := paths.New(rf.Home)

		networkStore, err := networkStoreV1.InitialiseStore(vegaPaths)
		if err != nil {
			return api.AdminNetwork{}, fmt.Errorf("couldn't initialise network store: %w", err)
		}

		describeNetwork := api.NewAdminDescribeNetwork(networkStore)
		rawResult, errorDetails := describeNetwork.Handle(context.Background(), params)
		if errorDetails != nil {
			return api.AdminNetwork{}, errors.New(errorDetails.Data)
		}
		return rawResult.(api.AdminNetwork), nil
	}

	return BuildCmdDescribeNetwork(w, h, rf)
}

type DescribeNetworkFlags struct {
	Network string
}

func (f *DescribeNetworkFlags) Validate() (api.AdminDescribeNetworkParams, error) {
	req := api.AdminDescribeNetworkParams{}

	if len(f.Network) == 0 {
		return api.AdminDescribeNetworkParams{}, flags.MustBeSpecifiedError("network")
	}
	req.Name = f.Network

	return req, nil
}

func BuildCmdDescribeNetwork(w io.Writer, handler DescribeNetworkHandler, rf *RootFlags) *cobra.Command {
	f := &DescribeNetworkFlags{}
	cmd := &cobra.Command{
		Use:     "describe",
		Short:   "Describe the specified network",
		Long:    describeNetworkLong,
		Example: describeNetworkExample,
		RunE: func(_ *cobra.Command, _ []string) error {
			req, err := f.Validate()
			if err != nil {
				return err
			}
			resp, err := handler(req)
			if err != nil {
				return err
			}

			switch rf.Output {
			case flags.InteractiveOutput:
				PrintDescribeNetworkResponse(w, resp)
			case flags.JSONOutput:
				return printer.FprintJSON(w, resp)
			}

			return nil
		},
	}

	cmd.Flags().StringVarP(&f.Network,
		"network", "n",
		"",
		"Network to describe",
	)

	autoCompleteNetwork(cmd, rf.Home)

	return cmd
}

func PrintDescribeNetworkResponse(w io.Writer, resp api.AdminNetwork) {
	p := printer.NewInteractivePrinter(w)

	str := p.String()
	defer p.Print(str)

	str.NextLine().Text("Network").NextLine()
	str.Text("  Name: ").WarningText(resp.Name).NextLine()
	str.Text("  Metadata: ")
	if len(resp.Metadata) > 0 {
		str.NextLine()
		padding := 0
		for _, m := range resp.Metadata {
			keyLen := len(m.Key)
			if keyLen > padding {
				padding = keyLen
			}
		}

		for _, m := range resp.Metadata {
			str.ListItem().WarningText(fmt.Sprintf("%-*s", padding, m.Key)).Text(" | ").WarningText(m.Value).NextLine()
		}
		str.NextLine()
	} else {
		str.DangerText(" <not set>").NextSection()
	}

	str.NextLine().Text("Linked applications").NextLine()
	str.ListItem().Text("- Console: ")
	PrintDescribeNetworkWithValueNotSet(str, resp.Apps.Console)
	str.ListItem().Text("- Governance: ")
	PrintDescribeNetworkWithValueNotSet(str, resp.Apps.Governance)
	str.ListItem().Text("- Explorer: ")
	PrintDescribeNetworkWithValueNotSet(str, resp.Apps.Explorer)
	str.NextSection()

	str.Text("API.GRPC").NextLine()
	str.Text("  Hosts:")
	PrintDescribeNetworkWithValuesNotSet(str, resp.API.GRPC.Hosts)
	str.NextLine()

	str.Text("API.REST").NextLine()
	str.Text("  Hosts:")
	PrintDescribeNetworkWithValuesNotSet(str, resp.API.REST.Hosts)
	str.NextLine()

	str.Text("API.GraphQL").NextLine()
	str.Text("  Hosts:")
	PrintDescribeNetworkWithValuesNotSet(str, resp.API.GraphQL.Hosts)
	str.NextLine()
}

func PrintDescribeNetworkWithValueNotSet(str *printer.FormattedString, value string) {
	if value == "" {
		str.DangerText("<not set>")
	} else {
		str.WarningText(value)
	}
	str.NextLine()
}

func PrintDescribeNetworkWithValuesNotSet(str *printer.FormattedString, hosts []string) {
	if len(hosts) == 0 {
		str.DangerText(" <not set>").NextLine()
		return
	}

	str.NextLine()
	for _, h := range hosts {
		str.ListItem().Text("- ").WarningText(h).NextLine()
	}
}