helpers.go

package validator

import (
	"context"
	"fmt"

	tmrand "github.com/cometbft/cometbft/libs/rand"
	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
	sdk "github.com/cosmos/cosmos-sdk/types"
	"github.com/stretchr/testify/require"
	testconstants "github.com/zigbee-alliance/distributed-compliance-ledger/integration_tests/constants"
	test_dclauth "github.com/zigbee-alliance/distributed-compliance-ledger/integration_tests/grpc_rest/dclauth"
	"github.com/zigbee-alliance/distributed-compliance-ledger/integration_tests/utils"
	dclauthtypes "github.com/zigbee-alliance/distributed-compliance-ledger/x/dclauth/types"
	validatortypes "github.com/zigbee-alliance/distributed-compliance-ledger/x/validator/types"
)

const (
	DCLValidatorDisabledNodesEndpoint       = "/dcl/validator/disabled-nodes/"
	DCLValidatorProposedDisableNodeEndpoint = "/dcl/validator/proposed-disable-nodes/"
	DCLValidatorRejectedDisableNodeEndpoint = "/dcl/validator/rejected-disable-nodes/"
)

func GetDisabledValidator(suite *utils.TestSuite, address sdk.ValAddress) (*validatortypes.DisabledValidator, error) {
	var res validatortypes.DisabledValidator

	if suite.Rest {
		var resp validatortypes.QueryGetDisabledValidatorResponse
		err := suite.QueryREST(DCLValidatorDisabledNodesEndpoint+address.String(), &resp)
		if err != nil {
			return nil, err
		}
		res = resp.GetDisabledValidator()
	} else {
		grpcConn := suite.GetGRPCConn()
		defer grpcConn.Close()

		// This creates a gRPC client to query the x/validator service.
		validatorClient := validatortypes.NewQueryClient(grpcConn)
		resp, err := validatorClient.DisabledValidator(
			context.Background(),
			&validatortypes.QueryGetDisabledValidatorRequest{Address: address.String()},
		)
		if err != nil {
			return nil, err
		}
		res = resp.GetDisabledValidator()
	}

	return &res, nil
}

func GetDisabledValidators(suite *utils.TestSuite) (res []validatortypes.DisabledValidator, err error) {
	if suite.Rest {
		var resp validatortypes.QueryAllDisabledValidatorResponse
		err := suite.QueryREST(DCLValidatorDisabledNodesEndpoint, &resp)
		if err != nil {
			return nil, err
		}
		res = resp.GetDisabledValidator()
	} else {
		grpcConn := suite.GetGRPCConn()
		defer grpcConn.Close()

		// This creates a gRPC client to query the x/validator service.
		validatorClient := validatortypes.NewQueryClient(grpcConn)
		resp, err := validatorClient.DisabledValidatorAll(
			context.Background(),
			&validatortypes.QueryAllDisabledValidatorRequest{},
		)
		if err != nil {
			return nil, err
		}
		res = resp.GetDisabledValidator()
	}

	return res, nil
}

func GetProposedValidatorToDisable(suite *utils.TestSuite, address sdk.ValAddress) (*validatortypes.ProposedDisableValidator, error) {
	var res validatortypes.ProposedDisableValidator

	if suite.Rest {
		var resp validatortypes.QueryGetProposedDisableValidatorResponse
		err := suite.QueryREST(fmt.Sprintf(DCLValidatorProposedDisableNodeEndpoint+address.String()), &resp)
		if err != nil {
			return nil, err
		}
		res = resp.GetProposedDisableValidator()
	} else {
		grpcConn := suite.GetGRPCConn()
		defer grpcConn.Close()

		// This creates a gRPC client to query the x/validator service.
		validatorClient := validatortypes.NewQueryClient(grpcConn)
		resp, err := validatorClient.ProposedDisableValidator(
			context.Background(),
			&validatortypes.QueryGetProposedDisableValidatorRequest{Address: address.String()},
		)
		if err != nil {
			return nil, err
		}
		res = resp.GetProposedDisableValidator()
	}

	return &res, nil
}

func GetProposedValidatorsToDisable(suite *utils.TestSuite) (
	res []validatortypes.ProposedDisableValidator, err error,
) {
	if suite.Rest {
		var resp validatortypes.QueryAllProposedDisableValidatorResponse
		err := suite.QueryREST(DCLValidatorProposedDisableNodeEndpoint, &resp)
		if err != nil {
			return nil, err
		}
		res = resp.GetProposedDisableValidator()
	} else {
		grpcConn := suite.GetGRPCConn()
		defer grpcConn.Close()

		// This creates a gRPC client to query the x/validator service.
		validatorClient := validatortypes.NewQueryClient(grpcConn)
		resp, err := validatorClient.ProposedDisableValidatorAll(
			context.Background(),
			&validatortypes.QueryAllProposedDisableValidatorRequest{},
		)
		if err != nil {
			return nil, err
		}
		res = resp.GetProposedDisableValidator()
	}

	return res, nil
}

func GetRejectedValidatorToDisable(
	suite *utils.TestSuite, address sdk.ValAddress,
) (*validatortypes.RejectedDisableValidator, error) {
	var res validatortypes.RejectedDisableValidator

	if suite.Rest {
		var resp validatortypes.QueryGetRejectedDisableValidatorResponse
		err := suite.QueryREST(fmt.Sprintf(DCLValidatorRejectedDisableNodeEndpoint+address.String()), &resp)
		if err != nil {
			return nil, err
		}
		res = resp.GetRejectedValidator()
	} else {
		grpcConn := suite.GetGRPCConn()
		defer grpcConn.Close()

		// This creates a gRPC client to query the x/validator service.
		validatorClient := validatortypes.NewQueryClient(grpcConn)
		resp, err := validatorClient.RejectedDisableValidator(
			context.Background(),
			&validatortypes.QueryGetRejectedDisableValidatorRequest{Owner: address.String()},
		)
		if err != nil {
			return nil, err
		}
		res = resp.GetRejectedValidator()
	}

	return &res, nil
}

func GetRejectedValidatorsToDisable(suite *utils.TestSuite) (
	res []validatortypes.RejectedDisableValidator, err error,
) {
	if suite.Rest {
		var resp validatortypes.QueryAllRejectedDisableValidatorResponse
		err := suite.QueryREST(DCLValidatorRejectedDisableNodeEndpoint, &resp)
		if err != nil {
			return nil, err
		}
		res = resp.GetRejectedValidator()
	} else {
		grpcConn := suite.GetGRPCConn()
		defer grpcConn.Close()

		// This creates a gRPC client to query the x/validator service.
		validatorClient := validatortypes.NewQueryClient(grpcConn)
		resp, err := validatorClient.RejectedDisableValidatorAll(
			context.Background(),
			&validatortypes.QueryAllRejectedDisableValidatorRequest{},
		)
		if err != nil {
			return nil, err
		}
		res = resp.GetRejectedValidator()
	}

	return res, nil
}

func CreateValidator(
	suite *utils.TestSuite,
	valAddr sdk.ValAddress,
	signerName string,
	signerAccount *dclauthtypes.Account,
	pubkey cryptotypes.PubKey,
	moniker string,
) (*sdk.TxResponse, error) {
	msg, err := validatortypes.NewMsgCreateValidator(valAddr, pubkey, &validatortypes.Description{Moniker: moniker})
	require.NoError(suite.T, err)

	return suite.BuildAndBroadcastTx([]sdk.Msg{msg}, signerName, signerAccount)
}

func DisableValidator(
	suite *utils.TestSuite,
	valAddr sdk.ValAddress,
	signerName string,
	signerAccount *dclauthtypes.Account,
) (*sdk.TxResponse, error) {
	msg := validatortypes.NewMsgDisableValidator(valAddr)

	return suite.BuildAndBroadcastTx([]sdk.Msg{msg}, signerName, signerAccount)
}

func EnableValidator(
	suite *utils.TestSuite,
	valAddr sdk.ValAddress,
	signerName string,
	signerAccount *dclauthtypes.Account,
) (*sdk.TxResponse, error) {
	msg := validatortypes.NewMsgEnableValidator(valAddr)

	return suite.BuildAndBroadcastTx([]sdk.Msg{msg}, signerName, signerAccount)
}

func ProposeDisableValidator(
	suite *utils.TestSuite,
	valAddr sdk.ValAddress,
	signerName string,
	signerAccount *dclauthtypes.Account,
	info string,
) (*sdk.TxResponse, error) {
	msg := validatortypes.NewMsgProposeDisableValidator(suite.GetAddress(signerName), valAddr, info)

	return suite.BuildAndBroadcastTx([]sdk.Msg{msg}, signerName, signerAccount)
}

func ApproveDisableValidator(
	suite *utils.TestSuite,
	valAddr sdk.ValAddress,
	signerName string,
	signerAccount *dclauthtypes.Account,
	info string,
) (*sdk.TxResponse, error) {
	msg := validatortypes.NewMsgApproveDisableValidator(suite.GetAddress(signerName), valAddr, info)

	return suite.BuildAndBroadcastTx([]sdk.Msg{msg}, signerName, signerAccount)
}

func RejectDisableValidator(
	suite *utils.TestSuite,
	valAddr sdk.ValAddress,
	signerName string,
	signerAccount *dclauthtypes.Account,
	info string,
) (*sdk.TxResponse, error) {
	msg := validatortypes.NewMsgRejectDisableValidator(suite.GetAddress(signerName), valAddr, info)

	return suite.BuildAndBroadcastTx([]sdk.Msg{msg}, signerName, signerAccount)
}

// Common Test Logic

//nolint:funlen
func Demo(suite *utils.TestSuite) {
	// Jack, Alice and Bob are predefined Trustees
	jackName := testconstants.JackAccount
	jackKeyInfo, err := suite.Kr.Key(jackName)
	require.NoError(suite.T, err)
	address, err := jackKeyInfo.GetAddress()
	require.NoError(suite.T, err)
	jackAccount, err := test_dclauth.GetAccount(suite, address)
	require.NoError(suite.T, err)

	aliceName := testconstants.AliceAccount
	aliceKeyInfo, err := suite.Kr.Key(aliceName)
	require.NoError(suite.T, err)
	address, err = aliceKeyInfo.GetAddress()
	require.NoError(suite.T, err)
	aliceAccount, err := test_dclauth.GetAccount(suite, address)
	require.NoError(suite.T, err)

	bobName := testconstants.BobAccount
	bobKeyInfo, err := suite.Kr.Key(bobName)
	require.NoError(suite.T, err)
	address, err = bobKeyInfo.GetAddress()
	require.NoError(suite.T, err)
	bobAccount, err := test_dclauth.GetAccount(suite, address)
	require.NoError(suite.T, err)

	// Register new Vendor account
	vid := int32(tmrand.Uint16())
	nodeAdminName := utils.RandString()
	nodeAdminAcc := test_dclauth.CreateAccount(
		suite,
		nodeAdminName,
		dclauthtypes.AccountRoles{dclauthtypes.NodeAdmin},
		vid,
		testconstants.ProductIDsEmpty,
		aliceName,
		aliceAccount,
		jackName,
		jackAccount,
		testconstants.Info,
	)
	nodeAdminAddr, err := sdk.AccAddressFromBech32(nodeAdminAcc.Address)
	require.NoError(suite.T, err)
	validatorAddr := sdk.ValAddress(nodeAdminAddr)

	_, err = CreateValidator(suite, validatorAddr, nodeAdminName, nodeAdminAcc, testconstants.ValidatorPubKey1, "test123")
	require.NoError(suite.T, err)

	// Query all proposed disable validators
	proposedDisableValidators, err := GetProposedValidatorsToDisable(suite)
	require.NoError(suite.T, err)
	require.Equal(suite.T, 0, len(proposedDisableValidators))

	// Query unknown disable validator
	valAddress, err := sdk.ValAddressFromBech32(testconstants.ValidatorAddress1)
	require.NoError(suite.T, err)

	_, err = GetDisabledValidator(suite, valAddress)
	suite.AssertNotFound(err)

	// Query unknown proposed disable validator
	_, err = GetProposedValidatorToDisable(suite, valAddress)
	suite.AssertNotFound(err)

	_, err = DisableValidator(suite, validatorAddr, nodeAdminName, nodeAdminAcc)
	require.NoError(suite.T, err)

	// node admin doesn't add a new validator with new pubkey, because node admin already has disabled validator
	_, err = CreateValidator(suite, validatorAddr, nodeAdminName, nodeAdminAcc, testconstants.ValidatorPubKey2, "test123")
	require.Error(suite.T, err)

	// Query disabled validator
	disabledValidator, err := GetDisabledValidator(suite, validatorAddr)
	require.NoError(suite.T, err)
	require.True(suite.T, disabledValidator.DisabledByNodeAdmin)
	require.Equal(suite.T, validatorAddr.String(), disabledValidator.Address)
	require.Empty(suite.T, disabledValidator.Approvals)

	// Query all disabled validators
	disabledValidators, err := GetDisabledValidators(suite)
	require.NoError(suite.T, err)
	require.Equal(suite.T, 1, len(disabledValidators))

	// Enable validator
	_, err = EnableValidator(suite, validatorAddr, nodeAdminName, nodeAdminAcc)
	require.NoError(suite.T, err)

	// Query all disabled validators
	disabledValidators, err = GetDisabledValidators(suite)
	require.NoError(suite.T, err)
	require.Empty(suite.T, disabledValidators)

	// Propose disable validator
	_, err = ProposeDisableValidator(suite, validatorAddr, aliceName, aliceAccount, testconstants.Info)
	require.NoError(suite.T, err)

	// Reject new disable validator
	_, err = RejectDisableValidator(suite, validatorAddr, jackName, jackAccount, testconstants.Info)
	require.NoError(suite.T, err)

	// Cannot reject the second time from same trustee
	_, err = RejectDisableValidator(suite, validatorAddr, jackName, jackAccount, testconstants.Info)
	require.Error(suite.T, err)

	// Query all validators proposed to be disabled
	proposedValidatorsToDisable, err := GetProposedValidatorsToDisable(suite)
	require.NoError(suite.T, err)
	require.Equal(suite.T, 1, len(proposedValidatorsToDisable))

	// Query proposed disable validator
	proposedValidatorToDisable, err := GetProposedValidatorToDisable(suite, validatorAddr)
	require.NoError(suite.T, err)
	require.Equal(suite.T, validatorAddr.String(), proposedValidatorToDisable.Address)
	require.Equal(suite.T, aliceAccount.Address, proposedValidatorToDisable.Creator)
	require.Equal(suite.T, 1, len(proposedValidatorToDisable.Approvals))

	// Revote from reject to approve from same trustee
	_, err = ApproveDisableValidator(suite, validatorAddr, jackName, jackAccount, testconstants.Info)
	require.NoError(suite.T, err)

	// node admin cannot add a new validator with new pubkey, because node admin already has disabled validator
	_, err = CreateValidator(suite, validatorAddr, nodeAdminName, nodeAdminAcc, testconstants.ValidatorPubKey2, "test123")
	require.Error(suite.T, err)

	// Query disabled validator
	disabledValidator, err = GetDisabledValidator(suite, validatorAddr)
	require.NoError(suite.T, err)
	require.False(suite.T, disabledValidator.DisabledByNodeAdmin)
	require.Equal(suite.T, validatorAddr.String(), disabledValidator.Address)
	require.Equal(suite.T, 2, len(disabledValidator.Approvals))

	// Query all disabled validators
	disabledValidators, err = GetDisabledValidators(suite)
	require.NoError(suite.T, err)
	require.Equal(suite.T, 1, len(disabledValidators))

	// Query all proposed disable validators
	proposedValidatorsToDisable, _ = GetProposedValidatorsToDisable(suite)
	require.Equal(suite.T, 0, len(proposedValidatorsToDisable))

	// Query all rejected disable validators
	rejectedDisableValidator, _ := GetRejectedValidatorsToDisable(suite)
	require.Equal(suite.T, 0, len(rejectedDisableValidator))

	// Enable validator
	_, err = EnableValidator(suite, validatorAddr, nodeAdminName, nodeAdminAcc)
	require.NoError(suite.T, err)

	// Propose disable validator
	_, err = ProposeDisableValidator(suite, validatorAddr, aliceName, aliceAccount, testconstants.Info)
	require.NoError(suite.T, err)

	_, err = RejectDisableValidator(suite, validatorAddr, aliceName, aliceAccount, testconstants.Info)
	require.NoError(suite.T, err)

	_, err = GetProposedValidatorToDisable(suite, valAddress)
	suite.AssertNotFound(err)

	_, err = GetDisabledValidator(suite, valAddress)
	suite.AssertNotFound(err)

	_, err = GetRejectedValidatorToDisable(suite, valAddress)
	suite.AssertNotFound(err)

	// Propose disable validator
	_, err = ProposeDisableValidator(suite, validatorAddr, aliceName, aliceAccount, testconstants.Info)
	require.NoError(suite.T, err)

	// Query proposed disable validator
	proposedValidatorToDisable, err = GetProposedValidatorToDisable(suite, validatorAddr)
	require.NoError(suite.T, err)
	require.Equal(suite.T, validatorAddr.String(), proposedValidatorToDisable.Address)
	require.Equal(suite.T, aliceAccount.Address, proposedValidatorToDisable.Creator)
	require.Equal(suite.T, 1, len(proposedValidatorToDisable.Approvals))

	// Reject new disable validator
	_, err = RejectDisableValidator(suite, validatorAddr, jackName, jackAccount, testconstants.Info)
	require.NoError(suite.T, err)

	// Cannot reject the second time from same trustee
	_, err = RejectDisableValidator(suite, validatorAddr, jackName, jackAccount, testconstants.Info)
	require.Error(suite.T, err)

	// Query all rejected disable validators
	rejectedValidatorsToDisable, _ := GetRejectedValidatorsToDisable(suite)
	require.Equal(suite.T, 0, len(rejectedValidatorsToDisable))

	// Query proposed disable validator
	proposedValidatorToDisable, err = GetProposedValidatorToDisable(suite, validatorAddr)
	require.NoError(suite.T, err)
	require.Equal(suite.T, validatorAddr.String(), proposedValidatorToDisable.Address)
	require.Equal(suite.T, aliceAccount.Address, proposedValidatorToDisable.Creator)
	require.Equal(suite.T, 1, len(proposedValidatorToDisable.Approvals))
	require.Equal(suite.T, 1, len(proposedValidatorToDisable.Rejects))
	require.Equal(suite.T, aliceAccount.Address, proposedValidatorToDisable.Approvals[0].Address)
	require.Equal(suite.T, testconstants.Info, proposedValidatorToDisable.Rejects[0].Info)
	require.Equal(suite.T, jackAccount.Address, proposedValidatorToDisable.Rejects[0].Address)
	require.Equal(suite.T, testconstants.Info, proposedValidatorToDisable.Rejects[0].Info)

	// Reject new disable validator
	_, err = RejectDisableValidator(suite, validatorAddr, bobName, bobAccount, testconstants.Info)
	require.NoError(suite.T, err)

	// Query all proposed disable validators
	proposedValidatorsToDisable, _ = GetProposedValidatorsToDisable(suite)
	require.Equal(suite.T, 0, len(proposedValidatorsToDisable))

	// Query all rejected disable validators
	rejectedValidatorsToDisable, _ = GetRejectedValidatorsToDisable(suite)
	require.Equal(suite.T, 1, len(rejectedValidatorsToDisable))

	// Query rejected disable validator
	rejectedValidatorToDisable, err := GetRejectedValidatorToDisable(suite, validatorAddr)
	require.NoError(suite.T, err)
	require.Equal(suite.T, validatorAddr.String(), rejectedValidatorToDisable.Address)
	require.Equal(suite.T, aliceAccount.Address, rejectedValidatorToDisable.Creator)
	require.Equal(suite.T, 1, len(rejectedValidatorToDisable.Approvals))
	require.Equal(suite.T, 2, len(rejectedValidatorToDisable.Rejects))
	require.Equal(suite.T, aliceAccount.Address, rejectedValidatorToDisable.Approvals[0].Address)
	require.Equal(suite.T, testconstants.Info, rejectedValidatorToDisable.Approvals[0].Info)
	require.Equal(suite.T, jackAccount.Address, rejectedValidatorToDisable.Rejects[0].Address)
	require.Equal(suite.T, testconstants.Info, rejectedValidatorToDisable.Rejects[0].Info)
	require.Equal(suite.T, bobAccount.Address, rejectedValidatorToDisable.Rejects[1].Address)
	require.Equal(suite.T, testconstants.Info, rejectedValidatorToDisable.Rejects[1].Info)
}