transaction.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 commands

import (
	"encoding/hex"
	"fmt"

	"code.vegaprotocol.io/vega/libs/crypto"
	commandspb "code.vegaprotocol.io/vega/protos/vega/commands/v1"
	wcrypto "code.vegaprotocol.io/vega/wallet/crypto"

	"github.com/golang/protobuf/proto"
)

const ChainIDDelimiter = '\000'

func NewTransaction(pubKey string, data []byte, signature *commandspb.Signature) *commandspb.Transaction {
	return &commandspb.Transaction{
		InputData: data,
		Signature: signature,
		From: &commandspb.Transaction_PubKey{
			PubKey: pubKey,
		},
		Version: commandspb.TxVersion_TX_VERSION_V3,
	}
}

func BundleInputDataForSigning(inputDataBytes []byte, chainID string) []byte {
	return append([]byte(fmt.Sprintf("%s%c", chainID, ChainIDDelimiter)), inputDataBytes...)
}

func NewInputData(height uint64) *commandspb.InputData {
	return &commandspb.InputData{
		Nonce:       crypto.NewNonce(),
		BlockHeight: height,
	}
}

func MarshalInputData(inputData *commandspb.InputData) ([]byte, error) {
	data, err := proto.Marshal(inputData)
	if err != nil {
		return nil, err
	}

	return data, nil
}

func UnmarshalInputData(rawInputData []byte) (*commandspb.InputData, error) {
	inputData := &commandspb.InputData{}
	if err := proto.Unmarshal(rawInputData, inputData); err != nil {
		return nil, fmt.Errorf("couldn't unmarshall input data: %w", err)
	}
	return inputData, nil
}

func NewSignature(sig []byte, algo string, version uint32) *commandspb.Signature {
	return &commandspb.Signature{
		Value:   hex.EncodeToString(sig),
		Algo:    algo,
		Version: version,
	}
}

func CheckTransaction(tx *commandspb.Transaction, chainID string) (*commandspb.InputData, error) {
	errs := NewErrors()

	if tx == nil {
		return nil, errs.FinalAddForProperty("tx", ErrIsRequired)
	}

	if tx.Version == commandspb.TxVersion_TX_VERSION_UNSPECIFIED {
		return nil, errs.FinalAddForProperty("tx.version", ErrIsRequired)
	}
	if tx.Version != commandspb.TxVersion_TX_VERSION_V2 && tx.Version != commandspb.TxVersion_TX_VERSION_V3 {
		return nil, errs.FinalAddForProperty("tx.version", ErrIsNotSupported)
	}

	if tx.From == nil {
		errs.AddForProperty("tx.from", ErrIsRequired)
	} else if len(tx.GetPubKey()) == 0 {
		errs.AddForProperty("tx.from.pub_key", ErrIsRequired)
	} else if !IsVegaPublicKey(tx.GetPubKey()) {
		errs.AddForProperty("tx.from.pub_key", ErrShouldBeAValidVegaPublicKey)
	}

	// We need the above check to pass, so we verify it's all good.
	if !errs.Empty() {
		return nil, errs.ErrorOrNil()
	}

	inputData, inputErrs := CheckInputData(tx.InputData)
	if !inputErrs.Empty() {
		errs.Merge(inputErrs)
		return nil, errs.ErrorOrNil()
	}

	inputDataBytes := tx.InputData
	if tx.Version == commandspb.TxVersion_TX_VERSION_V3 {
		inputDataBytes = append([]byte(fmt.Sprintf("%s%c", chainID, ChainIDDelimiter)), inputDataBytes...)
	}

	errs.Merge(checkSignature(tx.Signature, tx.GetPubKey(), inputDataBytes))
	if !errs.Empty() {
		return nil, errs.ErrorOrNil()
	}

	return inputData, nil
}

func checkSignature(signature *commandspb.Signature, pubKey string, rawInputData []byte) Errors {
	errs := NewErrors()

	if signature == nil {
		return errs.FinalAddForProperty("tx.signature", ErrIsRequired)
	}

	if len(signature.Value) == 0 {
		errs.AddForProperty("tx.signature.value", ErrIsRequired)
	}
	decodedSig, err := hex.DecodeString(signature.Value)
	if err != nil {
		errs.AddForProperty("tx.signature.value", ErrShouldBeHexEncoded)
	}

	if len(signature.Algo) == 0 {
		errs.AddForProperty("tx.signature.algo", ErrIsRequired)
	}
	algo, err := wcrypto.NewSignatureAlgorithm(signature.Algo, signature.Version)
	if err != nil {
		errs.AddForProperty("tx.signature.algo", ErrUnsupportedAlgorithm)
		errs.AddForProperty("tx.signature.version", ErrUnsupportedAlgorithm)
	}

	// We need the above check to pass, so we verify it's all good.
	if !errs.Empty() {
		return errs
	}

	decodedPubKey := []byte(pubKey)
	if IsVegaPublicKey(pubKey) {
		// We can ignore the error has it should have been checked earlier.
		decodedPubKey, _ = hex.DecodeString(pubKey)
	}

	isValid, err := algo.Verify(decodedPubKey, rawInputData, decodedSig)
	if err != nil {
		// This shouldn't happen. If it does, we need to add better checks up-hill.
		return errs.FinalAddForProperty("tx.signature.value", ErrSignatureNotVerifiable)
	}

	if !isValid {
		errs.AddForProperty("tx.signature.value", ErrInvalidSignature)
		return errs
	}

	return nil
}

func CheckInputData(rawInputData []byte) (*commandspb.InputData, Errors) {
	errs := NewErrors()

	if len(rawInputData) == 0 {
		return nil, errs.FinalAddForProperty("tx.input_data", ErrIsRequired)
	}

	inputData, err := UnmarshalInputData(rawInputData)
	if err != nil {
		return nil, errs.FinalAddForProperty("tx.input_data", err)
	}

	if inputData.Nonce == 0 {
		errs.AddForProperty("tx.input_data.nonce", ErrMustBePositive)
	}

	if inputData.Command == nil {
		errs.AddForProperty("tx.input_data.command", ErrIsRequired)
	} else {
		switch cmd := inputData.Command.(type) {
		case *commandspb.InputData_OrderSubmission:
			errs.Merge(checkOrderSubmission(cmd.OrderSubmission))
		case *commandspb.InputData_OrderCancellation:
			break // No verification to be made
		case *commandspb.InputData_OrderAmendment:
			errs.Merge(checkOrderAmendment(cmd.OrderAmendment))
		case *commandspb.InputData_VoteSubmission:
			errs.Merge(checkVoteSubmission(cmd.VoteSubmission))
		case *commandspb.InputData_WithdrawSubmission:
			errs.Merge(checkWithdrawSubmission(cmd.WithdrawSubmission))
		case *commandspb.InputData_LiquidityProvisionSubmission:
			errs.Merge(checkLiquidityProvisionSubmission(cmd.LiquidityProvisionSubmission))
		case *commandspb.InputData_LiquidityProvisionCancellation:
			errs.Merge(checkLiquidityProvisionCancellation(cmd.LiquidityProvisionCancellation))
		case *commandspb.InputData_LiquidityProvisionAmendment:
			errs.Merge(checkLiquidityProvisionAmendment(cmd.LiquidityProvisionAmendment))
		case *commandspb.InputData_ProposalSubmission:
			errs.Merge(checkProposalSubmission(cmd.ProposalSubmission))
		case *commandspb.InputData_BatchProposalSubmission:
			errs.Merge(checkBatchProposalSubmission(cmd.BatchProposalSubmission))
		case *commandspb.InputData_AnnounceNode:
			errs.Merge(checkAnnounceNode(cmd.AnnounceNode))
		case *commandspb.InputData_NodeVote:
			errs.Merge(checkNodeVote(cmd.NodeVote))
		case *commandspb.InputData_NodeSignature:
			errs.Merge(checkNodeSignature(cmd.NodeSignature))
		case *commandspb.InputData_ChainEvent:
			errs.Merge(checkChainEvent(cmd.ChainEvent))
		case *commandspb.InputData_OracleDataSubmission:
			errs.Merge(checkOracleDataSubmission(cmd.OracleDataSubmission))
		case *commandspb.InputData_DelegateSubmission:
			errs.Merge(checkDelegateSubmission(cmd.DelegateSubmission))
		case *commandspb.InputData_UndelegateSubmission:
			errs.Merge(checkUndelegateSubmission(cmd.UndelegateSubmission))
		case *commandspb.InputData_KeyRotateSubmission:
			errs.Merge(checkKeyRotateSubmission(cmd.KeyRotateSubmission))
		case *commandspb.InputData_StateVariableProposal:
			errs.Merge(checkStateVariableProposal(cmd.StateVariableProposal))
		case *commandspb.InputData_Transfer:
			errs.Merge(checkTransfer(cmd.Transfer))
		case *commandspb.InputData_CancelTransfer:
			errs.Merge(checkCancelTransfer(cmd.CancelTransfer))
		case *commandspb.InputData_ValidatorHeartbeat:
			errs.Merge(checkValidatorHeartbeat(cmd.ValidatorHeartbeat))
		case *commandspb.InputData_EthereumKeyRotateSubmission:
			errs.Merge(checkEthereumKeyRotateSubmission(cmd.EthereumKeyRotateSubmission))
		case *commandspb.InputData_ProtocolUpgradeProposal:
			errs.Merge(checkProtocolUpgradeProposal(cmd.ProtocolUpgradeProposal))
		case *commandspb.InputData_IssueSignatures:
			errs.Merge(checkIssueSignatures(cmd.IssueSignatures))
		case *commandspb.InputData_BatchMarketInstructions:
			errs.Merge(checkBatchMarketInstructions(cmd.BatchMarketInstructions))
		case *commandspb.InputData_StopOrdersSubmission:
			errs.Merge(checkStopOrdersSubmission(cmd.StopOrdersSubmission))
		case *commandspb.InputData_StopOrdersCancellation:
			errs.Merge(checkStopOrdersCancellation(cmd.StopOrdersCancellation))
		case *commandspb.InputData_CreateReferralSet:
			errs.Merge(checkCreateReferralSet(cmd.CreateReferralSet))
		case *commandspb.InputData_UpdateReferralSet:
			errs.Merge(checkUpdateReferralSet(cmd.UpdateReferralSet))
		case *commandspb.InputData_ApplyReferralCode:
			errs.Merge(checkApplyReferralCode(cmd.ApplyReferralCode))
		case *commandspb.InputData_UpdateMarginMode:
			errs.Merge(checkUpdateMarginMode(cmd.UpdateMarginMode))
		case *commandspb.InputData_JoinTeam:
			errs.Merge(checkJoinTeam(cmd.JoinTeam))
		case *commandspb.InputData_UpdatePartyProfile:
			errs.Merge(checkUpdatePartyProfile(cmd.UpdatePartyProfile))
		default:
			errs.AddForProperty("tx.input_data.command", ErrIsNotSupported)
		}
	}

	return inputData, errs
}