move IsValidCandidateName to action package (#3706)

* move IsValidCandidateName to action package

* move IsValidCandidateName to action package

* delete validations.go

* update tests

* delete ErrInvalidAmount in staking

action/candidate_register.go

@@ -87,6 +87,9 @@ var (
 
 	// ErrInvalidAmount represents that amount is 0 or negative
 	ErrInvalidAmount = errors.New("invalid amount")
+
+	//ErrInvalidCanName represents that candidate name is invalid
+	ErrInvalidCanName = errors.New("invalid candidate name")
 )
 
 // CandidateRegister is the action to register a candidate
@@ -380,3 +383,16 @@ func (cr *CandidateRegister) ToEthTx() (*types.Transaction, error) {
 	}
 	return types.NewTransaction(cr.Nonce(), ethAddr, big.NewInt(0), cr.GasLimit(), cr.GasPrice(), data), nil
 }
+
+// IsValidCandidateName check if a candidate name string is valid.
+func IsValidCandidateName(s string) bool {
+	if len(s) == 0 || len(s) > 12 {
+		return false
+	}
+	for _, c := range s {
+		if !(('a' <= c && c <= 'z') || ('0' <= c && c <= '9')) {
+			return false
+		}
+	}
+	return true
+}

action/candidateregister_test.go

@@ -146,3 +146,49 @@ func TestCandidateRegisterABIEncodeAndDecode(t *testing.T) {
 	require.Equal(test.AutoStake, stake.AutoStake())
 	require.Equal(test.Payload, stake.Payload())
 }
+
+func TestIsValidCandidateName(t *testing.T) {
+	require := require.New(t)
+	tests := []struct {
+		input  string
+		output bool
+	}{
+		{
+			input:  "abc",
+			output: true,
+		},
+		{
+			input:  "123",
+			output: true,
+		},
+		{
+			input:  "abc123abc123",
+			output: true,
+		},
+		{
+			input:  "Abc123",
+			output: false,
+		},
+		{
+			input:  "Abc 123",
+			output: false,
+		},
+		{
+			input:  "Abc-123",
+			output: false,
+		},
+		{
+			input:  "abc123abc123abc123",
+			output: false,
+		},
+		{
+			input:  "",
+			output: false,
+		},
+	}
+
+	for _, tt := range tests {
+		output := IsValidCandidateName(tt.input)
+		require.Equal(tt.output, output)
+	}
+}

action/protocol/staking/candidate.go

@@ -16,6 +16,7 @@ import (
 	"github.com/pkg/errors"
 	"google.golang.org/protobuf/proto"
 
+	"github.com/iotexproject/iotex-core/action"
 	"github.com/iotexproject/iotex-core/action/protocol/staking/stakingpb"
 	"github.com/iotexproject/iotex-core/state"
 )
@@ -69,11 +70,11 @@ func (d *Candidate) Equal(c *Candidate) bool {
 // Validate does the sanity check
 func (d *Candidate) Validate() error {
 	if d.Votes == nil {
-		return ErrInvalidAmount
+		return action.ErrInvalidAmount
 	}
 
 	if d.Name == "" {
-		return ErrInvalidCanName
+		return action.ErrInvalidCanName
 	}
 
 	if d.Owner == nil {
@@ -89,7 +90,7 @@ func (d *Candidate) Validate() error {
 	}
 
 	if d.SelfStake == nil {
-		return ErrInvalidAmount
+		return action.ErrInvalidAmount
 	}
 	return nil
 }
@@ -100,7 +101,7 @@ func (d *Candidate) Collision(c *Candidate) error {
 		return nil
 	}
 	if c.Name == d.Name {
-		return ErrInvalidCanName
+		return action.ErrInvalidCanName
 	}
 	if address.Equal(c.Operator, d.Operator) {
 		return ErrInvalidOperator
@@ -114,7 +115,7 @@ func (d *Candidate) Collision(c *Candidate) error {
 // AddVote adds vote
 func (d *Candidate) AddVote(amount *big.Int) error {
 	if amount.Sign() < 0 {
-		return ErrInvalidAmount
+		return action.ErrInvalidAmount
 	}
 	d.Votes.Add(d.Votes, amount)
 	return nil
@@ -123,11 +124,11 @@ func (d *Candidate) AddVote(amount *big.Int) error {
 // SubVote subtracts vote
 func (d *Candidate) SubVote(amount *big.Int) error {
 	if amount.Sign() < 0 {
-		return ErrInvalidAmount
+		return action.ErrInvalidAmount
 	}
 
 	if d.Votes.Cmp(amount) == -1 {
-		return ErrInvalidAmount
+		return action.ErrInvalidAmount
 	}
 	d.Votes.Sub(d.Votes, amount)
 	return nil
@@ -136,7 +137,7 @@ func (d *Candidate) SubVote(amount *big.Int) error {
 // AddSelfStake adds self stake
 func (d *Candidate) AddSelfStake(amount *big.Int) error {
 	if amount.Sign() < 0 {
-		return ErrInvalidAmount
+		return action.ErrInvalidAmount
 	}
 	d.SelfStake.Add(d.SelfStake, amount)
 	return nil
@@ -145,11 +146,11 @@ func (d *Candidate) AddSelfStake(amount *big.Int) error {
 // SubSelfStake subtracts self stake
 func (d *Candidate) SubSelfStake(amount *big.Int) error {
 	if amount.Sign() < 0 {
-		return ErrInvalidAmount
+		return action.ErrInvalidAmount
 	}
 
 	if d.Votes.Cmp(amount) == -1 {
-		return ErrInvalidAmount
+		return action.ErrInvalidAmount
 	}
 	d.SelfStake.Sub(d.SelfStake, amount)
 	return nil
@@ -215,13 +216,13 @@ func (d *Candidate) fromProto(pb *stakingpb.Candidate) error {
 	var ok bool
 	d.Votes, ok = new(big.Int).SetString(pb.GetVotes(), 10)
 	if !ok {
-		return ErrInvalidAmount
+		return action.ErrInvalidAmount
 	}
 
 	d.SelfStakeBucketIdx = pb.GetSelfStakeBucketIdx()
 	d.SelfStake, ok = new(big.Int).SetString(pb.GetSelfStake(), 10)
 	if !ok {
-		return ErrInvalidAmount
+		return action.ErrInvalidAmount
 	}
 	return nil
 }

action/protocol/staking/candidate_center.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/iotexproject/iotex-address/address"
 
+	"github.com/iotexproject/iotex-core/action"
 	"github.com/iotexproject/iotex-core/action/protocol"
 )
 
@@ -294,7 +295,7 @@ func (m *CandidateCenter) collision(d *Candidate) error {
 
 	name, oper, self := m.base.collision(d)
 	if name != nil && !m.change.containsOwner(name) {
-		return ErrInvalidCanName
+		return action.ErrInvalidCanName
 	}
 
 	if oper != nil && !m.change.containsOwner(oper) {

action/protocol/staking/candidate_center_test.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 
+	"github.com/iotexproject/iotex-core/action"
 	"github.com/iotexproject/iotex-core/action/protocol"
 	"github.com/iotexproject/iotex-core/pkg/unit"
 	"github.com/iotexproject/iotex-core/test/identityset"
@@ -241,7 +242,7 @@ func TestCandCenter(t *testing.T) {
 		// d1 conflict with existing
 		conflict := list[(u1+3)%size]
 		d1.Name = conflict.Name
-		r.Equal(ErrInvalidCanName, m.Upsert(d1))
+		r.Equal(action.ErrInvalidCanName, m.Upsert(d1))
 		d1.Name = name1
 		d1.Operator = conflict.Operator
 		r.Equal(ErrInvalidOperator, m.Upsert(d1))
@@ -261,7 +262,7 @@ func TestCandCenter(t *testing.T) {
 
 		// d2 conflict d1
 		d2.Name = d1.Name
-		r.Equal(ErrInvalidCanName, m.Upsert(d2))
+		r.Equal(action.ErrInvalidCanName, m.Upsert(d2))
 		d2.Name = name2
 		d2.Operator = d1.Operator
 		r.Equal(ErrInvalidOperator, m.Upsert(d2))
@@ -278,7 +279,7 @@ func TestCandCenter(t *testing.T) {
 		// new n1 conflict with existing
 		n1 := list[(u2+size/2)%size].Clone()
 		n1.Owner = identityset.Address(15 + i*2)
-		r.Equal(ErrInvalidCanName, m.Upsert(n1))
+		r.Equal(action.ErrInvalidCanName, m.Upsert(n1))
 		n1.Name = name1
 		r.Equal(ErrInvalidOperator, m.Upsert(n1))
 		n1.Operator = op1
@@ -290,7 +291,7 @@ func TestCandCenter(t *testing.T) {
 		// new n2 conflict with dirty d2
 		n2 := d2.Clone()
 		n2.Owner = identityset.Address(16 + i*2)
-		r.Equal(ErrInvalidCanName, m.Upsert(n2))
+		r.Equal(action.ErrInvalidCanName, m.Upsert(n2))
 		n2.Name = name2
 		r.Equal(ErrInvalidOperator, m.Upsert(n2))
 		n2.Operator = op2
@@ -302,7 +303,7 @@ func TestCandCenter(t *testing.T) {
 		// verify conflict with n1
 		n2 = n1.Clone()
 		n2.Owner = identityset.Address(0)
-		r.Equal(ErrInvalidCanName, m.Upsert(n2))
+		r.Equal(action.ErrInvalidCanName, m.Upsert(n2))
 		n2.Name = "noconflict"
 		r.Equal(ErrInvalidOperator, m.Upsert(n2))
 		n2.Operator = identityset.Address(0)

action/protocol/staking/candidate_test.go

@@ -14,6 +14,7 @@ import (
 	"github.com/pkg/errors"
 	"github.com/stretchr/testify/require"
 
+	"github.com/iotexproject/iotex-core/action"
 	"github.com/iotexproject/iotex-core/pkg/unit"
 	"github.com/iotexproject/iotex-core/state"
 	"github.com/iotexproject/iotex-core/test/identityset"
@@ -89,7 +90,7 @@ func TestClone(t *testing.T) {
 	r.False(d.Equal(d2))
 	r.NoError(d.Collision(d2))
 	d.Owner = identityset.Address(0)
-	r.Equal(ErrInvalidCanName, d.Collision(d2))
+	r.Equal(action.ErrInvalidCanName, d.Collision(d2))
 	d.Name = "noconflict"
 	r.Equal(ErrInvalidOperator, d.Collision(d2))
 	d.Operator = identityset.Address(0)

action/protocol/staking/handlers.go

@@ -651,7 +651,7 @@ func (p *Protocol) handleCandidateRegister(ctx context.Context, act *action.Cand
 	// cannot collide with existing name
 	if csm.ContainsName(act.Name()) && (!ownerExist || act.Name() != c.Name) {
 		return log, nil, &handleError{
-			err:           ErrInvalidCanName,
+			err:           action.ErrInvalidCanName,
 			failureStatus: iotextypes.ReceiptStatus_ErrCandidateConflict,
 		}
 	}
@@ -843,7 +843,7 @@ func csmErrorToHandleError(caller string, err error) error {
 	}
 
 	switch errors.Cause(err) {
-	case ErrInvalidCanName:
+	case action.ErrInvalidCanName:
 		hErr.failureStatus = iotextypes.ReceiptStatus_ErrCandidateConflict
 		return hErr
 	case ErrInvalidOperator:
@@ -852,7 +852,7 @@ func csmErrorToHandleError(caller string, err error) error {
 	case ErrInvalidSelfStkIndex:
 		hErr.failureStatus = iotextypes.ReceiptStatus_ErrCandidateConflict
 		return hErr
-	case ErrInvalidAmount:
+	case action.ErrInvalidAmount:
 		hErr.failureStatus = iotextypes.ReceiptStatus_ErrCandidateNotExist
 		return hErr
 	case ErrInvalidOwner:

action/protocol/staking/handlers_test.go

@@ -147,7 +147,7 @@ func TestProtocol_HandleCreateStake(t *testing.T) {
 			1,
 			time.Now(),
 			10000,
-			ErrInvalidCanName,
+			action.ErrInvalidCanName,
 			iotextypes.ReceiptStatus_ErrCandidateNotExist,
 		},
 		{
@@ -162,7 +162,7 @@ func TestProtocol_HandleCreateStake(t *testing.T) {
 			1,
 			time.Now(),
 			10000,
-			ErrInvalidAmount,
+			action.ErrInvalidAmount,
 			iotextypes.ReceiptStatus_Failure,
 		},
 		{
@@ -358,7 +358,7 @@ func TestProtocol_HandleCandidateRegister(t *testing.T) {
 			uint64(1000000),
 			big.NewInt(1),
 			true,
-			ErrInvalidAmount,
+			action.ErrInvalidAmount,
 			iotextypes.ReceiptStatus_Failure,
 		},
 		// invalid candidate name
@@ -379,7 +379,7 @@ func TestProtocol_HandleCandidateRegister(t *testing.T) {
 			uint64(1000000),
 			big.NewInt(1),
 			true,
-			ErrInvalidCanName,
+			action.ErrInvalidCanName,
 			iotextypes.ReceiptStatus_Failure,
 		},
 		// success for the following test
@@ -762,7 +762,7 @@ func TestProtocol_HandleCandidateUpdate(t *testing.T) {
 			"!invalidname",
 			identityset.Address(31).String(),
 			identityset.Address(32).String(),
-			ErrInvalidCanName,
+			action.ErrInvalidCanName,
 			iotextypes.ReceiptStatus_Failure,
 		},
 		// success,update name, operator and reward address
@@ -1522,7 +1522,7 @@ func TestProtocol_HandleChangeCandidate(t *testing.T) {
 			time.Now(),
 			10000,
 			false,
-			ErrInvalidCanName,
+			action.ErrInvalidCanName,
 			iotextypes.ReceiptStatus_Failure,
 		},
 		// invalid candidate name 2
@@ -1542,7 +1542,7 @@ func TestProtocol_HandleChangeCandidate(t *testing.T) {
 			time.Now(),
 			10000,
 			false,
-			ErrInvalidCanName,
+			action.ErrInvalidCanName,
 			iotextypes.ReceiptStatus_Failure,
 		},
 		// invalid candidate name 3
@@ -1562,7 +1562,7 @@ func TestProtocol_HandleChangeCandidate(t *testing.T) {
 			time.Now(),
 			10000,
 			false,
-			ErrInvalidCanName,
+			action.ErrInvalidCanName,
 			iotextypes.ReceiptStatus_Failure,
 		},
 		// Upsert error cannot happen,because CreateStake already check collision

action/protocol/staking/protocol.go

@@ -129,17 +129,17 @@ func NewProtocol(
 
 	minStakeAmount, ok := new(big.Int).SetString(cfg.Staking.MinStakeAmount, 10)
 	if !ok {
-		return nil, ErrInvalidAmount
+		return nil, action.ErrInvalidAmount
 	}
 
 	regFee, ok := new(big.Int).SetString(cfg.Staking.RegistrationConsts.Fee, 10)
 	if !ok {
-		return nil, ErrInvalidAmount
+		return nil, action.ErrInvalidAmount
 	}
 
 	minSelfStake, ok := new(big.Int).SetString(cfg.Staking.RegistrationConsts.MinSelfStake, 10)
 	if !ok {
-		return nil, ErrInvalidAmount
+		return nil, action.ErrInvalidAmount
 	}
 
 	// new vote reviser, revise ate greenland
@@ -231,7 +231,7 @@ func (p *Protocol) CreateGenesisStates(
 
 		selfStake, ok := new(big.Int).SetString(bc.SelfStakingTokens, 10)
 		if !ok {
-			return ErrInvalidAmount
+			return action.ErrInvalidAmount
 		}
 		bucket := NewVoteBucket(owner, owner, selfStake, 7, time.Now(), true)
 		bucketIdx, err := csm.putBucketAndIndex(bucket)