Allow 0 premined reward wallet (#1776)

* Allow 0 premined reward wallet * Add unit test * Fix && logic * Fix validateRewardWallet() logic
0xPolygon · Aug 4, 2023 · d5be69a · d5be69a
1 parent 927f02f
commit d5be69a
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 7 deletions.
diff --git a/command/genesis/params.go b/command/genesis/params.go
@@ -466,16 +466,17 @@ func (p *genesisParams) validateRewardWallet() error {
 		return errors.New("reward wallet address must be defined")
 	}
 
-	if p.rewardWallet == types.AddressToString(types.ZeroAddress) {
-		return errors.New("reward wallet address must not be zero address")
-	}
-
 	premineInfo, err := parsePremineInfo(p.rewardWallet)
 	if err != nil {
 		return err
 	}
 
-	if premineInfo.amount.Cmp(big.NewInt(0)) < 1 {
+	if premineInfo.address == types.ZeroAddress {
+		return errors.New("reward wallet address must not be zero address")
+	}
+
+	// If epoch rewards are enabled, reward wallet must have some amount of premine
+	if p.epochReward > 0 && premineInfo.amount.Cmp(big.NewInt(0)) < 1 {
 		return errRewardWalletAmountZero
 	}
 

diff --git a/command/genesis/params_test.go b/command/genesis/params_test.go
@@ -185,3 +185,40 @@ func Test_validatePremineInfo(t *testing.T) {
 		})
 	}
 }
+
+func Test_validateRewardWallet(t *testing.T) {
+	t.Parallel()
+
+	cases := []struct {
+		name              string
+		rewardWallet      string
+		epochReward       uint64
+		expectValidateErr error
+	}{
+		{
+			name:              "invalid reward wallet: no premine + reward",
+			rewardWallet:      types.StringToAddress("1").String() + ":0",
+			epochReward:       10,
+			expectValidateErr: errRewardWalletAmountZero,
+		},
+		{
+			name:              "valid reward wallet: no premine + no reward",
+			rewardWallet:      types.StringToAddress("1").String() + ":0",
+			epochReward:       0,
+			expectValidateErr: nil,
+		},
+	}
+	for _, c := range cases {
+		c := c
+		t.Run(c.name, func(t *testing.T) {
+			t.Parallel()
+
+			p := &genesisParams{
+				rewardWallet: c.rewardWallet,
+				epochReward:  c.epochReward,
+			}
+			err := p.validateRewardWallet()
+			require.ErrorIs(t, err, c.expectValidateErr)
+		})
+	}
+}
diff --git a/command/genesis/polybft_params.go b/command/genesis/polybft_params.go
@@ -100,8 +100,10 @@ func (p *genesisParams) generatePolyBftChainConfig(o command.OutputFormatter) er
 
 	if p.rewardTokenCode == "" {
 		// native token is used as a reward token, and reward wallet is not a zero address
-		// so we need to add that address to premine map
-		premineBalances[walletPremineInfo.address] = walletPremineInfo
+		if p.epochReward > 0 {
+			// epoch reward is non zero so premine reward wallet
+			premineBalances[walletPremineInfo.address] = walletPremineInfo
+		}
 	} else {
 		bytes, err := hex.DecodeString(p.rewardTokenCode)
 		if err != nil {