feat: make inflation share weight a decimal

docs/static/openapi.yml

@@ -694,7 +694,6 @@ paths:
                                     title: logo of the pool
                                   inflation_share_weight:
                                     type: string
-                                    format: uint64
                                     title: >-
                                       inflation_share_weight is the base payout
                                       for each bundle reward
@@ -1127,7 +1126,6 @@ paths:
                           title: logo of the pool
                         inflation_share_weight:
                           type: string
-                          format: uint64
                           title: >-
                             inflation_share_weight is the base payout for each
                             bundle reward
@@ -4028,7 +4026,6 @@ paths:
                                     title: logo of the pool
                                   inflation_share_weight:
                                     type: string
-                                    format: uint64
                                     title: >-
                                       inflation_share_weight is the base payout
                                       for each bundle reward
@@ -5051,7 +5048,6 @@ paths:
                         description: upload_interval ...
                       inflation_share_weight:
                         type: string
-                        format: uint64
                         description: inflation_share_weight ...
                       min_delegation:
                         type: string
@@ -5639,7 +5635,6 @@ paths:
                           description: upload_interval ...
                         inflation_share_weight:
                           type: string
-                          format: uint64
                           description: inflation_share_weight ...
                         min_delegation:
                           type: string
@@ -6400,7 +6395,6 @@ paths:
                               title: logo of the pool
                             inflation_share_weight:
                               type: string
-                              format: uint64
                               title: >-
                                 inflation_share_weight is the base payout for
                                 each bundle reward
@@ -6858,7 +6852,6 @@ paths:
                                 title: logo of the pool
                               inflation_share_weight:
                                 type: string
-                                format: uint64
                                 title: >-
                                   inflation_share_weight is the base payout for
                                   each bundle reward
@@ -7427,7 +7420,6 @@ paths:
                                     title: logo of the pool
                                   inflation_share_weight:
                                     type: string
-                                    format: uint64
                                     title: >-
                                       inflation_share_weight is the base payout
                                       for each bundle reward
@@ -7929,7 +7921,6 @@ paths:
                                 title: logo of the pool
                               inflation_share_weight:
                                 type: string
-                                format: uint64
                                 title: >-
                                   inflation_share_weight is the base payout for
                                   each bundle reward

proto/kyve/pool/v1beta1/events.proto

@@ -40,7 +40,10 @@ message EventCreatePool {
   uint64 upload_interval = 7;
   // inflation_share_weight is the fixed cost which gets paid out
   // to every successful uploader
-  uint64 inflation_share_weight = 8;
+  string inflation_share_weight = 8 [
+    (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec",
+    (gogoproto.nullable) = false
+  ];
   // min_delegation is the minimum amount of $KYVE the pool has
   // to have in order to produce bundles
   uint64 min_delegation = 9;
@@ -126,7 +129,10 @@ message EventPoolUpdated {
   uint64 upload_interval = 7;
   // inflation_share_weight is the fixed cost which gets paid out
   // to every successful uploader
-  uint64 inflation_share_weight = 8;
+  string inflation_share_weight = 8 [
+    (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec",
+    (gogoproto.nullable) = false
+  ];
   // min_delegation is the minimum amount of $KYVE the pool has
   // to have in order to produce bundles
   uint64 min_delegation = 9;

proto/kyve/pool/v1beta1/pool.proto

@@ -93,7 +93,10 @@ message Pool {
   // upload_interval ...
   uint64 upload_interval = 11;
   // inflation_share_weight ...
-  uint64 inflation_share_weight = 12;
+  string inflation_share_weight = 12 [
+    (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec",
+    (gogoproto.nullable) = false
+  ];
   // min_delegation ...
   uint64 min_delegation = 13;
   // max_bundle_size ...

proto/kyve/pool/v1beta1/tx.proto

@@ -4,6 +4,7 @@ package kyve.pool.v1beta1;
 
 import "cosmos/msg/v1/msg.proto";
 import "cosmos_proto/cosmos.proto";
+import "gogoproto/gogo.proto";
 
 option go_package = "github.com/KYVENetwork/chain/x/pool/types";
 
@@ -51,7 +52,10 @@ message MsgCreatePool {
   // upload_interval ...
   uint64 upload_interval = 7;
   // inflation_share_weight ...
-  uint64 inflation_share_weight = 8;
+  string inflation_share_weight = 8 [
+    (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec",
+    (gogoproto.nullable) = false
+  ];
   // min_delegation ...
   uint64 min_delegation = 9;
   // max_bundle_size ...

proto/kyve/query/v1beta1/query.proto

@@ -41,7 +41,10 @@ message BasicPool {
   string logo = 4;
 
   // inflation_share_weight is the base payout for each bundle reward
-  uint64 inflation_share_weight = 5;
+  string inflation_share_weight = 5 [
+    (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec",
+    (gogoproto.nullable) = false
+  ];
 
   // upload_interval is the interval bundles get created
   uint64 upload_interval = 6;

x/bundles/abci.go

@@ -46,7 +46,7 @@ func SplitInflation(ctx sdk.Context, k bundlesKeeper.Keeper, bk util.BankKeeper,
 	for _, pool := range pk.GetAllPools(ctx) {
 		// only include active pools
 		if err := k.AssertPoolCanRun(ctx, pool.Id); err == nil {
-			totalInflationShareWeight += pool.InflationShareWeight
+			totalInflationShareWeight += uint64(pool.InflationShareWeight.TruncateInt64())
 		}
 	}
 
@@ -59,7 +59,7 @@ func SplitInflation(ctx sdk.Context, k bundlesKeeper.Keeper, bk util.BankKeeper,
 		// only include active pools
 		if err := k.AssertPoolCanRun(ctx, pool.Id); err == nil {
 			// calculate pool share based of inflation share weight
-			amount := uint64(math.LegacyNewDec(int64(pool.InflationShareWeight)).
+			amount := uint64(pool.InflationShareWeight.
 				Quo(math.LegacyNewDec(int64(totalInflationShareWeight))).
 				Mul(math.LegacyNewDec(protocolBlockProvision)).
 				TruncateInt64())

x/bundles/keeper/abci_protocol_split_test.go

@@ -44,7 +44,7 @@ var _ = Describe("abci.go", Ordered, func() {
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
 			UploadInterval:       60,
-			InflationShareWeight: 1_000_000,
+			InflationShareWeight: math.LegacyNewDec(1_000_000),
 			MinDelegation:        100 * i.KYVE,
 			MaxBundleSize:        100,
 			Version:              "0.0.0",
@@ -124,7 +124,7 @@ var _ = Describe("abci.go", Ordered, func() {
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
 			UploadInterval:       60,
-			InflationShareWeight: 2_000_000,
+			InflationShareWeight: math.LegacyNewDec(2_000_000),
 			MinDelegation:        100 * i.KYVE,
 			MaxBundleSize:        100,
 			Version:              "0.0.0",
@@ -191,7 +191,7 @@ var _ = Describe("abci.go", Ordered, func() {
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
 			UploadInterval:       60,
-			InflationShareWeight: 0,
+			InflationShareWeight: math.LegacyZeroDec(),
 			MinDelegation:        100 * i.KYVE,
 			MaxBundleSize:        100,
 			Version:              "0.0.0",
@@ -240,7 +240,7 @@ var _ = Describe("abci.go", Ordered, func() {
 	It("every pool has zero inflation share weight", func() {
 		// ARRANGE
 		pool1, _ := s.App().PoolKeeper.GetPool(s.Ctx(), 0)
-		pool1.InflationShareWeight = 0
+		pool1.InflationShareWeight = math.LegacyZeroDec()
 		s.App().PoolKeeper.SetPool(s.Ctx(), pool1)
 
 		msg := &pooltypes.MsgCreatePool{
@@ -251,7 +251,7 @@ var _ = Describe("abci.go", Ordered, func() {
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
 			UploadInterval:       60,
-			InflationShareWeight: 0,
+			InflationShareWeight: math.LegacyZeroDec(),
 			MinDelegation:        100 * i.KYVE,
 			MaxBundleSize:        100,
 			Version:              "0.0.0",

x/bundles/keeper/keeper_suite_dropped_bundles_test.go

@@ -1,6 +1,7 @@
 package keeper_test
 
 import (
+	"cosmossdk.io/math"
 	funderstypes "github.com/KYVENetwork/chain/x/funders/types"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -42,7 +43,7 @@ var _ = Describe("dropped bundles", Ordered, func() {
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
 			UploadInterval:       60,
-			InflationShareWeight: 10_000,
+			InflationShareWeight: math.LegacyNewDec(10_000),
 			MinDelegation:        100 * i.KYVE,
 			MaxBundleSize:        100,
 			Version:              "0.0.0",

x/bundles/keeper/keeper_suite_funding_bundles_test.go

@@ -1,6 +1,7 @@
 package keeper_test
 
 import (
+	"cosmossdk.io/math"
 	i "github.com/KYVENetwork/chain/testutil/integration"
 	bundletypes "github.com/KYVENetwork/chain/x/bundles/types"
 	funderstypes "github.com/KYVENetwork/chain/x/funders/types"
@@ -50,7 +51,7 @@ var _ = Describe("funding bundles", Ordered, func() {
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
 			UploadInterval:       60,
-			InflationShareWeight: 10_000,
+			InflationShareWeight: math.LegacyNewDec(10_000),
 			MinDelegation:        100 * i.KYVE,
 			MaxBundleSize:        100,
 			Version:              "0.0.0",

x/bundles/keeper/keeper_suite_inflation_splitting_test.go

@@ -51,7 +51,7 @@ var _ = Describe("inflation splitting", Ordered, func() {
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
 			UploadInterval:       60,
-			InflationShareWeight: 10_000,
+			InflationShareWeight: math.LegacyNewDec(10_000),
 			MinDelegation:        100 * i.KYVE,
 			MaxBundleSize:        100,
 			Version:              "0.0.0",
@@ -462,7 +462,7 @@ var _ = Describe("inflation splitting", Ordered, func() {
 
 		// the total payout is the inflation share weight because the funding is sufficient
 		// and there is no additional inflation
-		totalPayout := pool.InflationShareWeight
+		totalPayout := uint64(pool.InflationShareWeight.TruncateInt64())
 
 		networkFee := s.App().BundlesKeeper.GetNetworkFee(s.Ctx())
 		treasuryReward := uint64(math.LegacyNewDec(int64(totalPayout)).Mul(networkFee).TruncateInt64())
@@ -569,7 +569,7 @@ var _ = Describe("inflation splitting", Ordered, func() {
 		uploader, _ := s.App().StakersKeeper.GetStaker(s.Ctx(), i.STAKER_0)
 
 		// the total payout is the inflation share weight plus the inflation payout
-		totalPayout := pool.InflationShareWeight + payout
+		totalPayout := uint64(pool.InflationShareWeight.TruncateInt64()) + payout
 
 		networkFee := s.App().BundlesKeeper.GetNetworkFee(s.Ctx())
 		treasuryReward := uint64(math.LegacyNewDec(int64(totalPayout)).Mul(networkFee).TruncateInt64())
@@ -676,7 +676,7 @@ var _ = Describe("inflation splitting", Ordered, func() {
 		uploader, _ := s.App().StakersKeeper.GetStaker(s.Ctx(), i.STAKER_0)
 
 		// the total payout is the inflation share weight plus the inflation payout
-		totalPayout := pool.InflationShareWeight + payout
+		totalPayout := uint64(pool.InflationShareWeight.TruncateInt64()) + payout
 
 		networkFee := s.App().BundlesKeeper.GetNetworkFee(s.Ctx())
 		treasuryReward := uint64(math.LegacyNewDec(int64(totalPayout)).Mul(networkFee).TruncateInt64())
@@ -1100,7 +1100,7 @@ var _ = Describe("inflation splitting", Ordered, func() {
 		uploader, _ := s.App().StakersKeeper.GetStaker(s.Ctx(), i.STAKER_0)
 
 		// the total payout is the total funds
-		totalPayout := (pool.InflationShareWeight / 2) + 200
+		totalPayout := (uint64(pool.InflationShareWeight.TruncateInt64()) / 2) + 200
 
 		networkFee := s.App().BundlesKeeper.GetNetworkFee(s.Ctx())
 		treasuryReward := uint64(math.LegacyNewDec(int64(totalPayout)).Mul(networkFee).TruncateInt64())
@@ -1207,7 +1207,7 @@ var _ = Describe("inflation splitting", Ordered, func() {
 		uploader, _ := s.App().StakersKeeper.GetStaker(s.Ctx(), i.STAKER_0)
 
 		// the total payout is the inflation share weight plus the inflation payout
-		totalPayout := (pool.InflationShareWeight / 2) + 200 + payout
+		totalPayout := (uint64(pool.InflationShareWeight.TruncateInt64()) / 2) + 200 + payout
 
 		networkFee := s.App().BundlesKeeper.GetNetworkFee(s.Ctx())
 		treasuryReward := uint64(math.LegacyNewDec(int64(totalPayout)).Mul(networkFee).TruncateInt64())
@@ -1314,7 +1314,7 @@ var _ = Describe("inflation splitting", Ordered, func() {
 		uploader, _ := s.App().StakersKeeper.GetStaker(s.Ctx(), i.STAKER_0)
 
 		// the total payout is the inflation share weight plus the inflation payout
-		totalPayout := (pool.InflationShareWeight / 2) + 200 + payout
+		totalPayout := (uint64(pool.InflationShareWeight.TruncateInt64()) / 2) + 200 + payout
 
 		networkFee := s.App().BundlesKeeper.GetNetworkFee(s.Ctx())
 		treasuryReward := uint64(math.LegacyNewDec(int64(totalPayout)).Mul(networkFee).TruncateInt64())

x/bundles/keeper/keeper_suite_invalid_bundles_test.go

@@ -49,7 +49,7 @@ var _ = Describe("invalid bundles", Ordered, func() {
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
 			UploadInterval:       60,
-			InflationShareWeight: 10_000,
+			InflationShareWeight: math.LegacyNewDec(10_000),
 			MinDelegation:        100 * i.KYVE,
 			MaxBundleSize:        100,
 			Version:              "0.0.0",

x/bundles/keeper/keeper_suite_points_test.go

@@ -43,7 +43,7 @@ var _ = Describe("points", Ordered, func() {
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
 			UploadInterval:       60,
-			InflationShareWeight: 10_000,
+			InflationShareWeight: math.LegacyNewDec(10_000),
 			MinDelegation:        100 * i.KYVE,
 			MaxBundleSize:        100,
 			Version:              "0.0.0",

x/bundles/keeper/keeper_suite_stakers_leave_test.go

@@ -45,7 +45,7 @@ var _ = Describe("stakers leave", Ordered, func() {
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
 			UploadInterval:       60,
-			InflationShareWeight: 10_000,
+			InflationShareWeight: math.LegacyNewDec(10_000),
 			MinDelegation:        0 * i.KYVE,
 			MaxBundleSize:        100,
 			Version:              "0.0.0",
@@ -244,19 +244,19 @@ var _ = Describe("stakers leave", Ordered, func() {
 
 		// calculate uploader rewards
 		networkFee := s.App().BundlesKeeper.GetNetworkFee(s.Ctx())
-		treasuryReward := uint64(math.LegacyNewDec(int64(pool.InflationShareWeight)).Mul(networkFee).TruncateInt64())
-		storageReward := uint64(s.App().BundlesKeeper.GetStorageCost(s.Ctx(), pool.CurrentStorageProviderId).MulInt64(100).TruncateInt64())
-		totalUploaderReward := pool.InflationShareWeight - treasuryReward - storageReward
+		treasuryReward := pool.InflationShareWeight.Mul(networkFee)
+		storageReward := s.App().BundlesKeeper.GetStorageCost(s.Ctx(), pool.CurrentStorageProviderId).MulInt64(100)
+		totalUploaderReward := pool.InflationShareWeight.Sub(treasuryReward).Sub(storageReward)
 
-		uploaderPayoutReward := uint64(math.LegacyNewDec(int64(totalUploaderReward)).Mul(uploader.Commission).TruncateInt64())
-		uploaderDelegationReward := totalUploaderReward - uploaderPayoutReward
+		uploaderPayoutReward := totalUploaderReward.Mul(uploader.Commission)
+		uploaderDelegationReward := totalUploaderReward.Sub(uploaderPayoutReward)
 
 		// assert payout transfer
 		Expect(balanceUploader).To(Equal(initialBalanceStaker0))
 		// assert commission rewards
-		Expect(uploader.CommissionRewards.AmountOf(globalTypes.Denom).Uint64()).To(Equal(uploaderPayoutReward + storageReward))
+		Expect(uploader.CommissionRewards.AmountOf(globalTypes.Denom).Uint64()).To(Equal(uint64(uploaderPayoutReward.Add(storageReward).TruncateInt64())))
 		// assert uploader self delegation rewards
-		Expect(s.App().DelegationKeeper.GetOutstandingRewards(s.Ctx(), i.STAKER_0, i.STAKER_0).AmountOf(globalTypes.Denom).Uint64()).To(Equal(uploaderDelegationReward))
+		Expect(s.App().DelegationKeeper.GetOutstandingRewards(s.Ctx(), i.STAKER_0, i.STAKER_0).AmountOf(globalTypes.Denom).Uint64()).To(Equal(uint64(uploaderDelegationReward.TruncateInt64())))
 	})
 
 	It("Staker leaves, although he was the uploader of the previous round and should get slashed", func() {