code.vegaprotocol.io/vega@v0.79.0/cmd/vegawallet/commands/network_import.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"
	netstore "code.vegaprotocol.io/vega/wallet/network/store/v1"

	"github.com/spf13/cobra"
)

var (
	importNetworkLong = cli.LongDesc(`
		Import a network configuration from a file or an URL.
	`)

	importNetworkExample = cli.Examples(`
		# import a network configuration from a file
		{{.Software}} network import --from-file PATH_TO_NETWORK

		# import a network configuration from an URL
		{{.Software}} network import --from-url URL_TO_NETWORK

		# overwrite existing network configuration
		{{.Software}} network import --from-url URL_TO_NETWORK --force

		# import a network configuration with a different name
		{{.Software}} network import --from-url URL_TO_NETWORK --with-name NEW_NAME
	`)
)

type adminImportNetworkResult struct {
	api.AdminImportNetworkResult
	FilePath string `json:"filePath"`
}

type ImportNetworkFromSourceHandler func(api.AdminImportNetworkParams) (adminImportNetworkResult, error)

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

		s, err := netstore.InitialiseStore(vegaPaths)
		if err != nil {
			return adminImportNetworkResult{}, fmt.Errorf("couldn't initialise networks store: %w", err)
		}
		importNetwork := api.NewAdminImportNetwork(s)
		rawResult, errorDetails := importNetwork.Handle(context.Background(), params)
		if errorDetails != nil {
			return adminImportNetworkResult{}, errors.New(errorDetails.Data)
		}

		result := rawResult.(api.AdminImportNetworkResult)
		return adminImportNetworkResult{
			AdminImportNetworkResult: result,
			FilePath:                 s.GetNetworkPath(result.Name),
		}, nil
	}

	return BuildCmdImportNetwork(w, h, rf)
}

func BuildCmdImportNetwork(w io.Writer, handler ImportNetworkFromSourceHandler, rf *RootFlags) *cobra.Command {
	f := &ImportNetworkFlags{}

	cmd := &cobra.Command{
		Use:     "import",
		Short:   "Import a network configuration",
		Long:    importNetworkLong,
		Example: importNetworkExample,
		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:
				PrintImportNetworkResponse(w, resp)
			case flags.JSONOutput:
				return printer.FprintJSON(w, resp)
			}

			return nil
		},
	}

	cmd.Flags().StringVar(&f.FilePath,
		"from-file",
		"",
		"Path to the file containing the network configuration to import",
	)
	cmd.Flags().StringVar(&f.URL,
		"from-url",
		"",
		"URL of the file containing the network configuration to import",
	)
	cmd.Flags().StringVar(&f.Name,
		"with-name",
		"",
		"Change the name of the imported network",
	)
	cmd.Flags().BoolVarP(&f.Force,
		"force", "f",
		false,
		"Overwrite the existing network if it has the same name",
	)

	return cmd
}

type ImportNetworkFlags struct {
	FilePath string
	URL      string
	Name     string
	Force    bool
}

func (f *ImportNetworkFlags) Validate() (api.AdminImportNetworkParams, error) {
	if len(f.FilePath) == 0 && len(f.URL) == 0 {
		return api.AdminImportNetworkParams{}, flags.OneOfFlagsMustBeSpecifiedError("from-file", "from-url")
	}

	if len(f.FilePath) != 0 && len(f.URL) != 0 {
		return api.AdminImportNetworkParams{}, flags.MutuallyExclusiveError("from-file", "from-url")
	}

	url := f.URL
	if len(f.FilePath) != 0 {
		url = api.FileSchemePrefix + f.FilePath
	}
	return api.AdminImportNetworkParams{
		URL:       url,
		Name:      f.Name,
		Overwrite: f.Force,
	}, nil
}

func PrintImportNetworkResponse(w io.Writer, resp adminImportNetworkResult) {
	p := printer.NewInteractivePrinter(w)

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

	str.CheckMark().SuccessText("Importing the network succeeded").NextSection()
	str.Text("Name:").NextLine().WarningText(resp.Name).NextLine()
	str.Text("File path:").NextLine().WarningText(resp.FilePath).NextLine()
}