chore: added more detailed descriptions

KYVENetwork · May 3, 2024 · d7f4681 · d7f4681
1 parent 33a3e52
commit d7f4681
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 7 deletions.
diff --git a/docs/static/openapi.yml b/docs/static/openapi.yml
@@ -4990,7 +4990,11 @@ paths:
                         description: compression_id ...
                       end_key:
                         type: string
-                        description: end_key ...
+                        title: >-
+                          end_key is the last key before the pool should stop
+                          indexing, it is
+
+                          inclusive
                   bundle_proposal:
                     description: bundle_proposal ...
                     type: object
@@ -5527,7 +5531,11 @@ paths:
                           description: compression_id ...
                         end_key:
                           type: string
-                          description: end_key ...
+                          title: >-
+                            end_key is the last key before the pool should stop
+                            indexing, it is
+
+                            inclusive
                     bundle_proposal:
                       description: bundle_proposal ...
                       type: object

diff --git a/proto/kyve/pool/v1beta1/events.proto b/proto/kyve/pool/v1beta1/events.proto
@@ -57,7 +57,8 @@ 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
+  // end_key is the last key before the pool should stop indexing, it is
+  // inclusive
   string end_key = 15;
 }
 

diff --git a/proto/kyve/pool/v1beta1/pool.proto b/proto/kyve/pool/v1beta1/pool.proto
@@ -113,6 +113,7 @@ message Pool {
   // compression_id ...
   uint32 current_compression_id = 19;
 
-  // end_key ...
+  // end_key is the last key before the pool should stop indexing, it is
+  // inclusive
   string end_key = 20;
 }
diff --git a/x/bundles/keeper/logic_bundles.go b/x/bundles/keeper/logic_bundles.go
@@ -31,7 +31,9 @@ func (k Keeper) AssertPoolCanRun(ctx sdk.Context, poolId uint64) error {
 		return types.ErrPoolDisabled
 	}
 
-	// Error if the end key is reached
+	// Error if the end key is reached. The chain 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
 	}

diff --git a/x/pool/types/events.pb.go b/x/pool/types/events.pb.go
diff --git a/x/pool/types/pool.pb.go b/x/pool/types/pool.pb.go