code.vegaprotocol.io/vega@v0.79.0/cmd/vegawallet/commands/raw_transaction_send.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"
	"encoding/base64"
	"errors"
	"fmt"
	"io"
	"time"

	"code.vegaprotocol.io/vega/cmd/vegawallet/commands/cli"
	"code.vegaprotocol.io/vega/cmd/vegawallet/commands/flags"
	"code.vegaprotocol.io/vega/cmd/vegawallet/commands/printer"
	vgzap "code.vegaprotocol.io/vega/libs/zap"
	"code.vegaprotocol.io/vega/paths"
	commandspb "code.vegaprotocol.io/vega/protos/vega/commands/v1"
	"code.vegaprotocol.io/vega/wallet/api"
	walletnode "code.vegaprotocol.io/vega/wallet/api/node"
	networkStore "code.vegaprotocol.io/vega/wallet/network/store/v1"

	"github.com/golang/protobuf/proto"
	"github.com/spf13/cobra"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
)

var (
	sendTxLong = cli.LongDesc(`
		Send a signed 'raw' transaction to a Vega node via the gRPC API. The command can be sent to
		any node of a registered network or to a specific node address.

		The transaction should be base64-encoded.
	`)

	sendTxExample = cli.Examples(`
		# Send a transaction to a registered network
		{{.Software}} raw_transaction send --network NETWORK BASE64_TRANSACTION

		# Send a transaction to a specific Vega node address
		{{.Software}} raw_transaction send --node-address ADDRESS BASE64_TRANSACTION

		# Send a transaction with a log level set to debug
		{{.Software}} raw_transaction send --network NETWORK --level debug BASE64_TRANSACTION

		# Send a transaction with a maximum of 10 retries
		{{.Software}} raw_transaction send --network NETWORK --retries 10 BASE64_TRANSACTION

		# Send a transaction with a maximum request duration of 10 seconds
		{{.Software}} raw_transaction send --network NETWORK --max-request-duration "10s" BASE64_TRANSACTION

		# Send a transaction without verifying network version compatibility
		{{.Software}} raw_transaction send --network NETWORK --retries 10 BASE64_TRANSACTION --no-version-check
	`)
)

type SendRawTransactionHandler func(api.AdminSendRawTransactionParams, *zap.Logger) (api.AdminSendRawTransactionResult, error)

func NewCmdRawTransactionSend(w io.Writer, rf *RootFlags) *cobra.Command {
	h := func(params api.AdminSendRawTransactionParams, log *zap.Logger) (api.AdminSendRawTransactionResult, error) {
		vegaPaths := paths.New(rf.Home)

		netStore, err := networkStore.InitialiseStore(vegaPaths)
		if err != nil {
			return api.AdminSendRawTransactionResult{}, fmt.Errorf("could not initialise network store: %w", err)
		}

		sendTransaction := api.NewAdminSendRawTransaction(netStore, func(hosts []string, retries uint64, requestTTL time.Duration) (walletnode.Selector, error) {
			return walletnode.BuildRoundRobinSelectorWithRetryingNodes(log, hosts, retries, requestTTL)
		})
		rawResult, errorDetails := sendTransaction.Handle(context.Background(), params)
		if errorDetails != nil {
			return api.AdminSendRawTransactionResult{}, errors.New(errorDetails.Data)
		}
		return rawResult.(api.AdminSendRawTransactionResult), nil
	}
	return BuildCmdRawTransactionSend(w, h, rf)
}

func BuildCmdRawTransactionSend(w io.Writer, handler SendRawTransactionHandler, rf *RootFlags) *cobra.Command {
	f := &SendRawTransactionFlags{}

	cmd := &cobra.Command{
		Use:     "send",
		Short:   "Send a raw transaction to a Vega node",
		Long:    sendTxLong,
		Example: sendTxExample,
		RunE: func(_ *cobra.Command, args []string) error {
			if aLen := len(args); aLen == 0 {
				return flags.ArgMustBeSpecifiedError("transaction")
			} else if aLen > 1 {
				return flags.TooManyArgsError("transaction")
			}
			f.RawTx = args[0]

			req, err := f.Validate()
			if err != nil {
				return err
			}

			log, err := buildCmdLogger(rf.Output, f.LogLevel)
			if err != nil {
				return fmt.Errorf("could not initialise logger: %w", err)
			}
			defer vgzap.Sync(log)

			resp, err := handler(req, log)
			if err != nil {
				return err
			}

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

			return nil
		},
	}

	cmd.Flags().StringVarP(&f.Network,
		"network", "n",
		"",
		"Network to which the command is sent",
	)
	cmd.Flags().StringVar(&f.NodeAddress,
		"node-address",
		"",
		"Vega node address to which the command is sent",
	)
	cmd.Flags().StringVar(&f.LogLevel,
		"level",
		zapcore.InfoLevel.String(),
		fmt.Sprintf("Set the log level: %v", vgzap.SupportedLogLevels),
	)
	cmd.Flags().Uint64Var(&f.Retries,
		"retries",
		defaultRequestRetryCount,
		"Number of retries when contacting the Vega node",
	)
	cmd.Flags().DurationVar(&f.MaximumRequestDuration,
		"max-request-duration",
		defaultMaxRequestDuration,
		"Maximum duration the wallet will wait for a node to respond. Supported format: <number>+<time unit>. Valid time units are `s` and `m`.",
	)
	cmd.Flags().BoolVar(&f.NoVersionCheck,
		"no-version-check",
		false,
		"Do not check for network version compatibility",
	)

	autoCompleteNetwork(cmd, rf.Home)
	autoCompleteLogLevel(cmd)
	return cmd
}

type SendRawTransactionFlags struct {
	Network                string
	NodeAddress            string
	Retries                uint64
	LogLevel               string
	RawTx                  string
	NoVersionCheck         bool
	MaximumRequestDuration time.Duration
}

func (f *SendRawTransactionFlags) Validate() (api.AdminSendRawTransactionParams, error) {
	req := api.AdminSendRawTransactionParams{
		Retries:                f.Retries,
		MaximumRequestDuration: f.MaximumRequestDuration,
	}

	if len(f.LogLevel) == 0 {
		return api.AdminSendRawTransactionParams{}, flags.MustBeSpecifiedError("level")
	}
	if err := vgzap.EnsureIsSupportedLogLevel(f.LogLevel); err != nil {
		return api.AdminSendRawTransactionParams{}, err
	}

	if len(f.NodeAddress) == 0 && len(f.Network) == 0 {
		return api.AdminSendRawTransactionParams{}, flags.OneOfFlagsMustBeSpecifiedError("network", "node-address")
	}
	if len(f.NodeAddress) != 0 && len(f.Network) != 0 {
		return api.AdminSendRawTransactionParams{}, flags.MutuallyExclusiveError("network", "node-address")
	}
	req.NodeAddress = f.NodeAddress
	req.Network = f.Network
	req.SendingMode = "TYPE_ASYNC"

	if len(f.RawTx) == 0 {
		return api.AdminSendRawTransactionParams{}, flags.ArgMustBeSpecifiedError("transaction")
	}
	decodedTx, err := base64.StdEncoding.DecodeString(f.RawTx)
	if err != nil {
		return api.AdminSendRawTransactionParams{}, flags.MustBase64EncodedError("transaction")
	}
	tx := &commandspb.Transaction{}
	if err := proto.Unmarshal(decodedTx, tx); err != nil {
		return api.AdminSendRawTransactionParams{}, fmt.Errorf("could not unmarshal transaction: %w", err)
	}
	req.EncodedTransaction = f.RawTx

	return req, nil
}

func PrintTXSendResponse(w io.Writer, res api.AdminSendRawTransactionResult) {
	p := printer.NewInteractivePrinter(w)

	str := p.String()
	defer p.Print(str)
	str.CheckMark().SuccessText("Transaction successfully sent").NextSection()
	str.Text("Transaction Hash:").NextLine().WarningText(res.TransactionHash).NextSection()
	str.Text("Sent at:").NextLine().WarningText(res.SentAt.Format(time.ANSIC)).NextSection()
	str.Text("Selected node:").NextLine().WarningText(res.Node.Host).NextLine()
}