code.vegaprotocol.io/vega@v0.79.0/wallet/api/admin_sign_transaction_test.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 api_test

import (
	"context"
	"errors"
	"fmt"
	"testing"
	"time"

	vgcrypto "code.vegaprotocol.io/vega/libs/crypto"
	"code.vegaprotocol.io/vega/libs/jsonrpc"
	vgrand "code.vegaprotocol.io/vega/libs/rand"
	"code.vegaprotocol.io/vega/wallet/api"
	"code.vegaprotocol.io/vega/wallet/api/mocks"
	walletnode "code.vegaprotocol.io/vega/wallet/api/node"
	nodemocks "code.vegaprotocol.io/vega/wallet/api/node/mocks"
	"code.vegaprotocol.io/vega/wallet/api/node/types"

	"github.com/golang/mock/gomock"
	"github.com/stretchr/testify/assert"
)

func TestAdminSignTransaction(t *testing.T) {
	t.Run("Documentation matches the code", testAdminSignTransactionSchemaCorrect)
	t.Run("Signing transaction with invalid params fails", testAdminSigningTransactionWithInvalidParamsFails)
	t.Run("Signing transaction with valid params succeeds", testAdminSigningTransactionWithValidParamsSucceeds)
	t.Run("Getting internal error during wallet verification fails", testAdminSignTransactionGettingInternalErrorDuringWalletVerificationFails)
	t.Run("Signing transaction with wallet that doesn't exist fails", testAdminSigningTransactionWithWalletThatDoesntExistFails)
	t.Run("Getting internal error during wallet retrieval fails", testAdminSignTransactionGettingInternalErrorDuringWalletRetrievalFails)
	t.Run("Signing transaction with malformed transaction fails", testAdminSigningTransactionWithMalformedTransactionFails)
	t.Run("Signing transaction which is invalid fails", testAdminSigningTransactionWithInvalidTransactionFails)
}

func testAdminSignTransactionSchemaCorrect(t *testing.T) {
	assertEqualSchema(t, "admin.sign_transaction", api.AdminSignTransactionParams{}, api.AdminSignTransactionResult{})
}

func testAdminSigningTransactionWithInvalidParamsFails(t *testing.T) {
	tcs := []struct {
		name          string
		params        interface{}
		expectedError error
	}{
		{
			name:          "with nil params",
			params:        nil,
			expectedError: api.ErrParamsRequired,
		},
		{
			name:          "with wrong type of params",
			params:        "test",
			expectedError: api.ErrParamsDoNotMatch,
		},
		{
			name: "with empty wallet",
			params: api.AdminSignTransactionParams{
				Wallet:        "",
				PublicKey:     vgrand.RandomStr(5),
				Transaction:   testTransaction(t),
				Network:       vgrand.RandomStr(5),
				LastBlockData: nil,
			},
			expectedError: api.ErrWalletIsRequired,
		},
		{
			name: "with empty public key",
			params: api.AdminSignTransactionParams{
				Wallet:        vgrand.RandomStr(5),
				PublicKey:     "",
				Transaction:   testTransaction(t),
				Network:       vgrand.RandomStr(5),
				LastBlockData: nil,
			},
			expectedError: api.ErrPublicKeyIsRequired,
		},
		{
			name: "with empty transaction",
			params: api.AdminSignTransactionParams{
				Wallet:        vgrand.RandomStr(5),
				PublicKey:     vgrand.RandomStr(5),
				Transaction:   "",
				Network:       vgrand.RandomStr(5),
				LastBlockData: nil,
			},
			expectedError: api.ErrTransactionIsRequired,
		},
		{
			name: "with no network of block data",
			params: api.AdminSignTransactionParams{
				Wallet:        vgrand.RandomStr(5),
				PublicKey:     vgrand.RandomStr(5),
				Network:       "",
				LastBlockData: nil,
				Transaction:   testTransaction(t),
			},
			expectedError: api.ErrLastBlockDataOrNetworkIsRequired,
		},
		{
			name: "with both network and block data",
			params: api.AdminSignTransactionParams{
				Wallet:        vgrand.RandomStr(5),
				PublicKey:     vgrand.RandomStr(5),
				Network:       "fairground",
				LastBlockData: &api.AdminLastBlockData{},
				Transaction:   testTransaction(t),
			},
			expectedError: api.ErrSpecifyingNetworkAndLastBlockDataIsNotSupported,
		},
		{
			name: "with block data without chain ID",
			params: api.AdminSignTransactionParams{
				Wallet:    vgrand.RandomStr(5),
				PublicKey: vgrand.RandomStr(5),
				LastBlockData: &api.AdminLastBlockData{
					ChainID:                 "",
					BlockHeight:             12,
					BlockHash:               vgrand.RandomStr(64),
					ProofOfWorkHashFunction: "sha3_24_rounds",
					ProofOfWorkDifficulty:   12,
				},
				Transaction: testTransaction(t),
			},
			expectedError: api.ErrChainIDIsRequired,
		},
		{
			name: "with block data without block hash",
			params: api.AdminSignTransactionParams{
				Wallet:    vgrand.RandomStr(5),
				PublicKey: vgrand.RandomStr(5),
				LastBlockData: &api.AdminLastBlockData{
					ChainID:                 "chain-id",
					BlockHeight:             12,
					BlockHash:               "",
					ProofOfWorkHashFunction: "sha3_24_rounds",
					ProofOfWorkDifficulty:   12,
				},
				Transaction: testTransaction(t),
			},
			expectedError: api.ErrBlockHashIsRequired,
		},
		{
			name: "with block data without pow difficulty",
			params: api.AdminSignTransactionParams{
				Wallet:    vgrand.RandomStr(5),
				PublicKey: vgrand.RandomStr(5),
				LastBlockData: &api.AdminLastBlockData{
					ChainID:                 "chain-id",
					BlockHeight:             12,
					BlockHash:               vgrand.RandomStr(64),
					ProofOfWorkHashFunction: "sha3_24_rounds",
					ProofOfWorkDifficulty:   0,
				},
				Transaction: testTransaction(t),
			},
			expectedError: api.ErrProofOfWorkDifficultyRequired,
		},
		{
			name: "with block data without block height",
			params: api.AdminSignTransactionParams{
				Wallet:    vgrand.RandomStr(5),
				PublicKey: vgrand.RandomStr(5),
				LastBlockData: &api.AdminLastBlockData{
					BlockHeight:             0,
					ChainID:                 "chain-id",
					BlockHash:               vgrand.RandomStr(64),
					ProofOfWorkDifficulty:   12,
					ProofOfWorkHashFunction: "sha3_24_rounds",
				},
				Transaction: testTransaction(t),
			},
			expectedError: api.ErrBlockHeightIsRequired,
		},
		{
			name: "with block data without hash function",
			params: api.AdminSignTransactionParams{
				Wallet:    vgrand.RandomStr(5),
				PublicKey: vgrand.RandomStr(5),
				LastBlockData: &api.AdminLastBlockData{
					BlockHeight:             150,
					ChainID:                 "chain-id",
					BlockHash:               vgrand.RandomStr(64),
					ProofOfWorkDifficulty:   12,
					ProofOfWorkHashFunction: "",
				},
				Transaction: testTransaction(t),
			},
			expectedError: api.ErrProofOfWorkHashFunctionRequired,
		},
	}

	for _, tc := range tcs {
		t.Run(tc.name, func(tt *testing.T) {
			// given
			ctx := context.Background()

			// setup
			handler := newAdminSignTransactionHandler(tt, unexpectedNodeSelectorCall(tt))

			// when
			result, errorDetails := handler.handle(t, ctx, tc.params)

			// then
			assertInvalidParams(tt, errorDetails, tc.expectedError)
			assert.Empty(tt, result)
		})
	}
}

func testAdminSigningTransactionWithValidParamsSucceeds(t *testing.T) {
	// given
	ctx := context.Background()
	network := newNetwork(t)
	w, kp := walletWithKey(t)

	// setup
	handler := newAdminSignTransactionHandler(t, func(hosts []string, _ uint64, _ time.Duration) (walletnode.Selector, error) {
		ctrl := gomock.NewController(t)
		nodeSelector := nodemocks.NewMockSelector(ctrl)
		node := nodemocks.NewMockNode(ctrl)
		nodeSelector.EXPECT().Node(ctx, gomock.Any()).Times(1).Return(node, nil)
		node.EXPECT().LastBlock(ctx).Times(1).Return(types.LastBlock{
			BlockHeight:             150,
			BlockHash:               vgrand.RandomStr(64),
			ProofOfWorkHashFunction: vgcrypto.Sha3,
			ProofOfWorkDifficulty:   1,
			ChainID:                 vgrand.RandomStr(5),
		}, nil)
		return nodeSelector, nil
	})

	// -- expected calls
	handler.walletStore.EXPECT().WalletExists(ctx, w.Name()).Times(1).Return(true, nil)
	handler.walletStore.EXPECT().IsWalletAlreadyUnlocked(ctx, w.Name()).Times(1).Return(true, nil)
	handler.walletStore.EXPECT().GetWallet(ctx, w.Name()).Times(1).Return(w, nil)
	handler.networkStore.EXPECT().NetworkExists(network.Name).Times(1).Return(true, nil)
	handler.networkStore.EXPECT().GetNetwork(network.Name).Times(1).Return(&network, nil)

	// when
	result, errorDetails := handler.handle(t, ctx, api.AdminSignTransactionParams{
		Wallet:      w.Name(),
		PublicKey:   kp.PublicKey(),
		Network:     network.Name,
		Transaction: testTransaction(t),
	})

	// then
	assert.Nil(t, errorDetails)
	assert.NotEmpty(t, result.EncodedTransaction)
	assert.NotEmpty(t, result.Transaction)
}

func testAdminSignTransactionGettingInternalErrorDuringWalletVerificationFails(t *testing.T) {
	// given
	ctx := context.Background()
	network := newNetwork(t)
	walletName := vgrand.RandomStr(5)

	// setup
	handler := newAdminSignTransactionHandler(t, func(hosts []string, _ uint64, _ time.Duration) (walletnode.Selector, error) {
		ctrl := gomock.NewController(t)
		nodeSelector := nodemocks.NewMockSelector(ctrl)
		node := nodemocks.NewMockNode(ctrl)
		nodeSelector.EXPECT().Node(ctx, gomock.Any()).Times(1).Return(node, nil)
		node.EXPECT().LastBlock(ctx).Times(1).Return(types.LastBlock{
			BlockHeight:             150,
			BlockHash:               vgrand.RandomStr(64),
			ProofOfWorkHashFunction: vgcrypto.Sha3,
			ProofOfWorkDifficulty:   1,
			ChainID:                 vgrand.RandomStr(5),
		}, nil)
		return nodeSelector, nil
	})

	// -- expected calls
	handler.walletStore.EXPECT().WalletExists(ctx, walletName).Times(1).Return(false, assert.AnError)

	// when
	result, errorDetails := handler.handle(t, ctx, api.AdminSignTransactionParams{
		Wallet:      walletName,
		PublicKey:   vgrand.RandomStr(5),
		Network:     network.Name,
		Transaction: testTransaction(t),
	})

	// then
	assertInternalError(t, errorDetails, fmt.Errorf("could not verify the wallet exists: %w", assert.AnError))
	assert.Empty(t, result)
}

func testAdminSigningTransactionWithWalletThatDoesntExistFails(t *testing.T) {
	// given
	ctx := context.Background()
	params := api.AdminSignTransactionParams{
		Wallet:      vgrand.RandomStr(5),
		PublicKey:   vgrand.RandomStr(5),
		Network:     "fairground",
		Transaction: testTransaction(t),
	}

	// setup
	handler := newAdminSignTransactionHandler(t, unexpectedNodeSelectorCall(t))

	// -- expected calls
	handler.walletStore.EXPECT().WalletExists(ctx, params.Wallet).Times(1).Return(false, nil)

	// when
	result, errorDetails := handler.handle(t, ctx, params)

	// then
	assertInvalidParams(t, errorDetails, api.ErrWalletDoesNotExist)
	assert.Empty(t, result)
}

func testAdminSignTransactionGettingInternalErrorDuringWalletRetrievalFails(t *testing.T) {
	// given
	ctx := context.Background()
	network := newNetwork(t)
	walletName := vgrand.RandomStr(5)

	// setup
	handler := newAdminSignTransactionHandler(t, func(hosts []string, _ uint64, _ time.Duration) (walletnode.Selector, error) {
		ctrl := gomock.NewController(t)
		nodeSelector := nodemocks.NewMockSelector(ctrl)
		node := nodemocks.NewMockNode(ctrl)
		nodeSelector.EXPECT().Node(ctx, gomock.Any()).Times(1).Return(node, nil)
		node.EXPECT().LastBlock(ctx).Times(1).Return(types.LastBlock{
			BlockHeight:             150,
			BlockHash:               vgrand.RandomStr(64),
			ProofOfWorkHashFunction: vgcrypto.Sha3,
			ProofOfWorkDifficulty:   1,
			ChainID:                 vgrand.RandomStr(5),
		}, nil)
		return nodeSelector, nil
	})

	// -- expected calls
	handler.walletStore.EXPECT().WalletExists(ctx, walletName).Times(1).Return(true, nil)
	handler.walletStore.EXPECT().IsWalletAlreadyUnlocked(ctx, walletName).Times(1).Return(true, nil)
	handler.walletStore.EXPECT().GetWallet(ctx, walletName).Times(1).Return(nil, assert.AnError)

	// when
	result, errorDetails := handler.handle(t, ctx, api.AdminSignTransactionParams{
		Wallet:      walletName,
		PublicKey:   vgrand.RandomStr(5),
		Network:     network.Name,
		Transaction: testTransaction(t),
	})

	// then
	assertInternalError(t, errorDetails, fmt.Errorf("could not retrieve the wallet: %w", assert.AnError))
	assert.Empty(t, result)
}

func testAdminSigningTransactionWithMalformedTransactionFails(t *testing.T) {
	// given
	ctx := context.Background()
	network := vgrand.RandomStr(5)
	w, kp := walletWithKey(t)

	// setup
	handler := newAdminSignTransactionHandler(t, unexpectedNodeSelectorCall(t))

	// -- expected calls
	handler.walletStore.EXPECT().WalletExists(ctx, w.Name()).Times(1).Return(true, nil)
	handler.walletStore.EXPECT().IsWalletAlreadyUnlocked(ctx, w.Name()).Times(1).Return(true, nil)
	handler.walletStore.EXPECT().GetWallet(ctx, w.Name()).Times(1).Return(w, nil)

	// when
	result, errorDetails := handler.handle(t, ctx, api.AdminSignTransactionParams{
		Wallet:      w.Name(),
		PublicKey:   kp.PublicKey(),
		Network:     network,
		Transaction: map[string]int{"bob": 5},
	})

	// then
	assertInvalidParams(t, errorDetails, errors.New("the transaction does not use a valid Vega command: unknown field \"bob\" in vega.wallet.v1.SubmitTransactionRequest"))
	assert.Empty(t, result)
}

func testAdminSigningTransactionWithInvalidTransactionFails(t *testing.T) {
	// given
	ctx := context.Background()
	network := newNetwork(t)
	w, kp := walletWithKey(t)

	// setup
	handler := newAdminSignTransactionHandler(t, unexpectedNodeSelectorCall(t))

	// -- expected calls
	handler.walletStore.EXPECT().WalletExists(ctx, w.Name()).Times(1).Return(true, nil)
	handler.walletStore.EXPECT().IsWalletAlreadyUnlocked(ctx, w.Name()).Times(1).Return(true, nil)
	handler.walletStore.EXPECT().GetWallet(ctx, w.Name()).Times(1).Return(w, nil)

	// when
	result, errorDetails := handler.handle(t, ctx, api.AdminSignTransactionParams{
		Wallet:      w.Name(),
		PublicKey:   kp.PublicKey(),
		Network:     network.Name,
		Transaction: testMalformedTransaction(t),
	})

	// then
	assertInvalidParams(t, errorDetails, fmt.Errorf("vote_submission.proposal_id (should be a valid Vega ID)"))
	assert.Empty(t, result)
}

type AdminSignTransactionHandler struct {
	*api.AdminSignTransaction
	ctrl         *gomock.Controller
	walletStore  *mocks.MockWalletStore
	networkStore *mocks.MockNetworkStore
}

func (h *AdminSignTransactionHandler) handle(t *testing.T, ctx context.Context, params jsonrpc.Params) (api.AdminSignTransactionResult, *jsonrpc.ErrorDetails) {
	t.Helper()

	rawResult, err := h.Handle(ctx, params)
	if rawResult != nil {
		result, ok := rawResult.(api.AdminSignTransactionResult)
		if !ok {
			t.Fatal("AdminUpdatePermissions handler result is not a AdminSignTransactionResult")
		}
		return result, err
	}
	return api.AdminSignTransactionResult{}, err
}

func newAdminSignTransactionHandler(t *testing.T, builder api.NodeSelectorBuilder) *AdminSignTransactionHandler {
	t.Helper()

	ctrl := gomock.NewController(t)
	walletStore := mocks.NewMockWalletStore(ctrl)
	networkStore := mocks.NewMockNetworkStore(ctrl)

	return &AdminSignTransactionHandler{
		AdminSignTransaction: api.NewAdminSignTransaction(walletStore, networkStore, builder),
		ctrl:                 ctrl,
		walletStore:          walletStore,
		networkStore:         networkStore,
	}
}