feat: add end-key to pool (#177)

Co-authored-by: Troy Kessler <[email protected]>
KYVENetwork · May 3, 2024 · cee3a98 · cee3a98
1 parent 99e96af
commit cee3a98
Show file tree

Hide file tree

Showing 16 changed files with 413 additions and 171 deletions.
diff --git a/docs/static/openapi.yml b/docs/static/openapi.yml
@@ -694,6 +694,7 @@ paths:
                                       - POOL_STATUS_NOT_ENOUGH_DELEGATION
                                       - POOL_STATUS_UPGRADING
                                       - POOL_STATUS_VOTING_POWER_TOO_HIGH
+                                      - POOL_STATUS_END_KEY_REACHED
                                     default: POOL_STATUS_UNSPECIFIED
                               points:
                                 type: string
@@ -1092,6 +1093,7 @@ paths:
                             - POOL_STATUS_NOT_ENOUGH_DELEGATION
                             - POOL_STATUS_UPGRADING
                             - POOL_STATUS_VOTING_POWER_TOO_HIGH
+                            - POOL_STATUS_END_KEY_REACHED
                           default: POOL_STATUS_UNSPECIFIED
                       title: >-
                         BasicPool contains the necessary properties need for a
@@ -3966,6 +3968,7 @@ paths:
                                       - POOL_STATUS_NOT_ENOUGH_DELEGATION
                                       - POOL_STATUS_UPGRADING
                                       - POOL_STATUS_VOTING_POWER_TOO_HIGH
+                                      - POOL_STATUS_END_KEY_REACHED
                                     default: POOL_STATUS_UNSPECIFIED
                               points:
                                 type: string
@@ -4985,6 +4988,13 @@ paths:
                         type: integer
                         format: int64
                         description: compression_id ...
+                      end_key:
+                        type: string
+                        title: >-
+                          end_key is the last key before the pool should stop
+                          indexing, it is
+
+                          inclusive
                   bundle_proposal:
                     description: bundle_proposal ...
                     type: object
@@ -5102,6 +5112,7 @@ paths:
                       - POOL_STATUS_NOT_ENOUGH_DELEGATION
                       - POOL_STATUS_UPGRADING
                       - POOL_STATUS_VOTING_POWER_TOO_HIGH
+                      - POOL_STATUS_END_KEY_REACHED
                     default: POOL_STATUS_UNSPECIFIED
                   account:
                     type: string
@@ -5518,6 +5529,13 @@ paths:
                           type: integer
                           format: int64
                           description: compression_id ...
+                        end_key:
+                          type: string
+                          title: >-
+                            end_key is the last key before the pool should stop
+                            indexing, it is
+
+                            inclusive
                     bundle_proposal:
                       description: bundle_proposal ...
                       type: object
@@ -5635,6 +5653,7 @@ paths:
                         - POOL_STATUS_NOT_ENOUGH_DELEGATION
                         - POOL_STATUS_UPGRADING
                         - POOL_STATUS_VOTING_POWER_TOO_HIGH
+                        - POOL_STATUS_END_KEY_REACHED
                       default: POOL_STATUS_UNSPECIFIED
                     account:
                       type: string
@@ -6153,6 +6172,7 @@ paths:
                                 - POOL_STATUS_NOT_ENOUGH_DELEGATION
                                 - POOL_STATUS_UPGRADING
                                 - POOL_STATUS_VOTING_POWER_TOO_HIGH
+                                - POOL_STATUS_END_KEY_REACHED
                               default: POOL_STATUS_UNSPECIFIED
                         points:
                           type: string
@@ -6580,6 +6600,7 @@ paths:
                                   - POOL_STATUS_NOT_ENOUGH_DELEGATION
                                   - POOL_STATUS_UPGRADING
                                   - POOL_STATUS_VOTING_POWER_TOO_HIGH
+                                  - POOL_STATUS_END_KEY_REACHED
                                 default: POOL_STATUS_UNSPECIFIED
                           points:
                             type: string
@@ -7120,6 +7141,7 @@ paths:
                                       - POOL_STATUS_NOT_ENOUGH_DELEGATION
                                       - POOL_STATUS_UPGRADING
                                       - POOL_STATUS_VOTING_POWER_TOO_HIGH
+                                      - POOL_STATUS_END_KEY_REACHED
                                     default: POOL_STATUS_UNSPECIFIED
                               points:
                                 type: string
@@ -7589,6 +7611,7 @@ paths:
                                   - POOL_STATUS_NOT_ENOUGH_DELEGATION
                                   - POOL_STATUS_UPGRADING
                                   - POOL_STATUS_VOTING_POWER_TOO_HIGH
+                                  - POOL_STATUS_END_KEY_REACHED
                                 default: POOL_STATUS_UNSPECIFIED
                           points:
                             type: string

diff --git a/proto/kyve/pool/v1beta1/events.proto b/proto/kyve/pool/v1beta1/events.proto
@@ -57,6 +57,9 @@ message EventCreatePool {
   // compression_id is the unique id of the compression type the bundles
   // get compressed with
   uint32 compression_id = 14;
+  // end_key is the last key before the pool should stop indexing, it is
+  // inclusive
+  string end_key = 15;
 }
 
 // EventPoolEnabled ...

diff --git a/proto/kyve/pool/v1beta1/pool.proto b/proto/kyve/pool/v1beta1/pool.proto
@@ -32,6 +32,9 @@ enum PoolStatus {
   // POOL_STATUS_VOTING_POWER_TOO_HIGH indicates, that one validator
   // has more than 50% voting power and that the pool is halted
   POOL_STATUS_VOTING_POWER_TOO_HIGH = 6;
+  // POOL_STATUS_END_KEY_REACHED indicates, that the end key has been
+  // reached and that the pool is halted
+  POOL_STATUS_END_KEY_REACHED = 7;
 }
 
 // Protocol holds all info about the current pool version and the
@@ -109,4 +112,8 @@ message Pool {
   uint32 current_storage_provider_id = 18;
   // compression_id ...
   uint32 current_compression_id = 19;
+
+  // end_key is the last key before the pool should stop indexing, it is
+  // inclusive
+  string end_key = 20;
 }
diff --git a/proto/kyve/pool/v1beta1/tx.proto b/proto/kyve/pool/v1beta1/tx.proto
@@ -64,6 +64,8 @@ message MsgCreatePool {
   uint32 storage_provider_id = 13;
   // compression_id ...
   uint32 compression_id = 14;
+  // end_key ...
+  string end_key = 15;
 }
 
 // MsgCreatePoolResponse defines the Msg/CreatePool response type.

diff --git a/x/bundles/keeper/logic_bundles.go b/x/bundles/keeper/logic_bundles.go
@@ -31,6 +31,13 @@ func (k Keeper) AssertPoolCanRun(ctx sdk.Context, poolId uint64) error {
 		return types.ErrPoolDisabled
 	}
 
+	// Error if the end key is reached. The pool will simply halt if this is the case,
+	// it is the responsibility of the protocol nodes to reach final consensus and that
+	// a bundle does not exceed the end_key
+	if pool.EndKey != "" && pool.CurrentKey == pool.EndKey {
+		return types.ErrEndKeyReached
+	}
+
 	// Get the total and the highest delegation of a single validator in the pool
 	totalDelegation, highestDelegation := k.delegationKeeper.GetTotalAndHighestDelegationOfPool(ctx, poolId)
 

diff --git a/x/bundles/keeper/logic_bundles_test.go b/x/bundles/keeper/logic_bundles_test.go
@@ -20,6 +20,7 @@ TEST CASES - logic_bundles.go
 * Assert pool can run while min delegation is not reached
 * Assert pool can run
 * Assert pool can run while pool has no funds
+* Assert pool can run when endKey is reached
 
 * Assert can vote if sender is no staker
 * Assert can vote if bundle is dropped
@@ -84,7 +85,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	// ASSERT POOL CAN RUN
 
 	It("Assert pool can run while pool is upgrading", func() {
-		// ASSERT
+		// ARRANGE
 		pool, _ := s.App().PoolKeeper.GetPool(s.Ctx(), 0)
 		pool.UpgradePlan = &pooltypes.UpgradePlan{
 			Version:     "1.0.0",
@@ -126,7 +127,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert pool can run while pool is disabled", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  100 * i.KYVE,
@@ -164,7 +165,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert pool can run while min delegation is not reached", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  20 * i.KYVE,
@@ -197,7 +198,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert pool can run while voting power of one node is too high", func() {
-		// ASSERT
+		// ARRANGE
 		msg := &pooltypes.MsgCreatePool{
 			Authority:            gov,
 			Name:                 "PoolTest",
@@ -248,7 +249,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert pool can run", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  50 * i.KYVE,
@@ -281,7 +282,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert pool can run while pool has no funds", func() {
-		// ASSERT
+		// ARRANGE
 		msg := &pooltypes.MsgCreatePool{
 			Authority:            gov,
 			Name:                 "PoolTest",
@@ -331,10 +332,24 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 		Expect(err).NotTo(HaveOccurred())
 	})
 
+	It("Assert pool can run when endKey is reached", func() {
+		// ARRANGE
+		pool, _ := s.App().PoolKeeper.GetPool(s.Ctx(), 0)
+		pool.EndKey = "0"
+		pool.CurrentKey = "0"
+		s.App().PoolKeeper.SetPool(s.Ctx(), pool)
+
+		// ACT
+		err := s.App().BundlesKeeper.AssertPoolCanRun(s.Ctx(), 0)
+
+		// ASSERT
+		Expect(err).To(Equal(bundlesTypes.ErrEndKeyReached))
+	})
+
 	// ASSERT CAN VOTE
 
 	It("Assert can vote if sender is no staker", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  100 * i.KYVE,
@@ -396,7 +411,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert can vote if bundle is dropped", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  100 * i.KYVE,
@@ -455,7 +470,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert can vote if storage id does not match", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  100 * i.KYVE,
@@ -513,7 +528,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert can vote if sender has already voted valid", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  100 * i.KYVE,
@@ -580,7 +595,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert can vote if sender has already voted invalid", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  100 * i.KYVE,
@@ -647,7 +662,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert can vote", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  100 * i.KYVE,
@@ -708,7 +723,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	// ASSERT CAN PROPOSE
 
 	It("Assert can propose if sender is no staker", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  100 * i.KYVE,
@@ -750,7 +765,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert can propose if sender is not next uploader", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  100 * i.KYVE,
@@ -792,7 +807,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert can propose if upload interval has not passed", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  100 * i.KYVE,
@@ -837,7 +852,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert can propose if index does not match", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  100 * i.KYVE,
@@ -879,7 +894,7 @@ var _ = Describe("logic_bundles.go", Ordered, func() {
 	})
 
 	It("Assert can propose", func() {
-		// ASSERT
+		// ARRANGE
 		s.RunTxStakersSuccess(&stakertypes.MsgCreateStaker{
 			Creator: i.STAKER_0,
 			Amount:  100 * i.KYVE,

diff --git a/x/bundles/types/errors.go b/x/bundles/types/errors.go
@@ -23,4 +23,5 @@ var (
 	ErrAlreadyVotedInvalid     = errors.Register(ModuleName, 1205, "already voted invalid on bundle proposal")
 	ErrAlreadyVotedAbstain     = errors.Register(ModuleName, 1206, "already voted abstain on bundle proposal")
 	ErrVotingPowerTooHigh      = errors.Register(ModuleName, 1207, "staker in pool has more than 50% voting power")
+	ErrEndKeyReached           = errors.Register(ModuleName, 1208, "end key reached")
 )
diff --git a/x/pool/keeper/msg_server_create_pool.go b/x/pool/keeper/msg_server_create_pool.go
@@ -32,6 +32,7 @@ func (k msgServer) CreatePool(goCtx context.Context, req *types.MsgCreatePool) (
 		Logo:                 req.Logo,
 		Config:               req.Config,
 		StartKey:             req.StartKey,
+		EndKey:               req.EndKey,
 		UploadInterval:       req.UploadInterval,
 		InflationShareWeight: req.InflationShareWeight,
 		MinDelegation:        req.MinDelegation,
@@ -56,6 +57,7 @@ func (k msgServer) CreatePool(goCtx context.Context, req *types.MsgCreatePool) (
 		Logo:                 req.Logo,
 		Config:               req.Config,
 		StartKey:             req.StartKey,
+		EndKey:               req.EndKey,
 		UploadInterval:       req.UploadInterval,
 		InflationShareWeight: req.InflationShareWeight,
 		MinDelegation:        req.MinDelegation,

diff --git a/x/pool/keeper/msg_server_create_pool_test.go b/x/pool/keeper/msg_server_create_pool_test.go
@@ -102,6 +102,7 @@ var _ = Describe("msg_server_create_pool.go", Ordered, func() {
 			Logo:                 "ar://Tewyv2P5VEG8EJ6AUQORdqNTectY9hlOrWPK8wwo-aU",
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
+			EndKey:               "100",
 			UploadInterval:       60,
 			InflationShareWeight: 10000,
 			MinDelegation:        100 * i.KYVE,
@@ -137,6 +138,7 @@ var _ = Describe("msg_server_create_pool.go", Ordered, func() {
 			Logo:                 "ar://Tewyv2P5VEG8EJ6AUQORdqNTectY9hlOrWPK8wwo-aU",
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
+			EndKey:               "100",
 			CurrentKey:           "",
 			CurrentSummary:       "",
 			CurrentIndex:         0,
@@ -244,6 +246,7 @@ var _ = Describe("msg_server_create_pool.go", Ordered, func() {
 			Logo:                 "ar://Tewyv2P5VEG8EJ6AUQORdqNTectY9hlOrWPK8wwo-aU",
 			Config:               "ar://DgdB-2hLrxjhyEEbCML__dgZN5_uS7T6Z5XDkaFh3P0",
 			StartKey:             "0",
+			EndKey:               "",
 			CurrentKey:           "",
 			CurrentSummary:       "",
 			CurrentIndex:         0,

diff --git a/x/pool/keeper/msg_server_update_pool.go b/x/pool/keeper/msg_server_update_pool.go
@@ -59,6 +59,9 @@ func (k msgServer) UpdatePool(goCtx context.Context, req *types.MsgUpdatePool) (
 	if update.CompressionId != nil {
 		pool.CurrentCompressionId = *update.CompressionId
 	}
+	if update.EndKey != nil {
+		pool.EndKey = *update.EndKey
+	}
 
 	k.SetPool(ctx, pool)