clarified method naming

Author: AlexHentschel

engine/access/ingestion/engine.go

@@ -372,7 +372,7 @@ func (e *Engine) processFinalizedBlock(block *flow.Block) error {
 	// TODO: substitute an indexer module as layer between engine and storage
 
 	// index the block storage with each of the collection guarantee
-	err := e.blocks.IndexBlockForCollectionGuarantees(block.ID(), flow.GetIDs(block.Payload.Guarantees))
+	err := e.blocks.IndexBlockContainingCollectionGuarantee(block.ID(), flow.GetIDs(block.Payload.Guarantees))
 	if err != nil {
 		return fmt.Errorf("could not index block for collections: %w", err)
 	}

engine/access/ingestion2/finalized_block_processor.go

@@ -145,7 +145,7 @@ func (p *FinalizedBlockProcessor) processFinalizedBlockJobCallback(
 //
 // No errors are expected during normal operations.
 func (p *FinalizedBlockProcessor) indexFinalizedBlock(block *flow.Block) error {
-	err := p.blocks.IndexBlockForCollectionGuarantees(block.ID(), flow.GetIDs(block.Payload.Guarantees))
+	err := p.blocks.IndexBlockContainingCollectionGuarantee(block.ID(), flow.GetIDs(block.Payload.Guarantees))
 	if err != nil {
 		return fmt.Errorf("could not index block for collections: %w", err)
 	}

storage/blocks.go

@@ -82,7 +82,7 @@ type Blocks interface {
 	//     to decode an existing database value
 	ByCollectionID(collID flow.Identifier) (*flow.Block, error)
 
-	// IndexBlockForCollectionGuarantees populates an index `guaranteeID->blockID` for each guarantee
+	// IndexBlockContainingCollectionGuarantee populates an index `guaranteeID->blockID` for each guarantee
 	// which appears in the block.
 	// CAUTION: a collection can be included in multiple *unfinalized* blocks. However, the implementation
 	// assumes a one-to-one map from collection ID to a *single* block ID. This holds for FINALIZED BLOCKS ONLY
@@ -92,5 +92,5 @@ type Blocks interface {
 	//
 	// Error returns:
 	//   - generic error in case of unexpected failure from the database layer or encoding failure.
-	IndexBlockForCollectionGuarantees(blockID flow.Identifier, collIDs []flow.Identifier) error
+	IndexBlockContainingCollectionGuarantee(blockID flow.Identifier, collIDs []flow.Identifier) error
 }

storage/operation/headers.go

@@ -124,7 +124,7 @@ func BlockExists(r storage.Reader, blockID flow.Identifier) (bool, error) {
 	return KeyExists(r, MakePrefix(codeHeader, blockID))
 }
 
-// IndexBlockContainingCollection produces a mapping from collection ID to the block ID containing this collection.
+// IndexBlockContainingCollectionGuarantee produces a mapping from collection ID to the block ID containing this collection.
 //
 // CAUTION:
 //   - The caller must acquire the lock ??? and hold it until the database write has been committed.
@@ -137,11 +137,11 @@ func BlockExists(r storage.Reader, blockID flow.Identifier) (bool, error) {
 //
 // Expected errors during normal operations:
 // TODO: return [storage.ErrAlreadyExists] or [storage.ErrDataMismatch]
-func IndexBlockContainingCollection(w storage.Writer, collID flow.Identifier, blockID flow.Identifier) error {
+func IndexBlockContainingCollectionGuarantee(w storage.Writer, collID flow.Identifier, blockID flow.Identifier) error {
 	return UpsertByKey(w, MakePrefix(codeCollectionBlock, collID), blockID)
 }
 
-// LookupBlockContainingCollection retrieves the block containing the collection with the given ID.
+// LookupBlockContainingCollectionGuarantee retrieves the block containing the collection with the given ID.
 //
 // CAUTION: A collection can be included in multiple *unfinalized* blocks. However, the implementation
 // assumes a one-to-one map from collection ID to a *single* block ID. This holds for FINALIZED BLOCKS ONLY
@@ -151,7 +151,7 @@ func IndexBlockContainingCollection(w storage.Writer, collID flow.Identifier, bl
 //
 // Expected errors during normal operations:
 //   - [storage.ErrNotFound] if no block is known that contains the specified collection ID.
-func LookupBlockContainingCollection(r storage.Reader, collID flow.Identifier, blockID *flow.Identifier) error {
+func LookupBlockContainingCollectionGuarantee(r storage.Reader, collID flow.Identifier, blockID *flow.Identifier) error {
 	return RetrieveByKey(r, MakePrefix(codeCollectionBlock, collID), blockID)
 }
 

storage/operation/headers_test.go

@@ -55,12 +55,12 @@ func TestHeaderIDIndexByCollectionID(t *testing.T) {
 		collectionGuaranteeID := unittest.IdentifierFixture()
 
 		err := db.WithReaderBatchWriter(func(rw storage.ReaderBatchWriter) error {
-			return operation.IndexBlockContainingCollection(rw.Writer(), collectionGuaranteeID, headerID)
+			return operation.IndexBlockContainingCollectionGuarantee(rw.Writer(), collectionGuaranteeID, headerID)
 		})
 		require.NoError(t, err)
 
 		actualID := &flow.Identifier{}
-		err = operation.LookupBlockContainingCollection(db.Reader(), collectionGuaranteeID, actualID)
+		err = operation.LookupBlockContainingCollectionGuarantee(db.Reader(), collectionGuaranteeID, actualID)
 		require.NoError(t, err)
 		assert.Equal(t, headerID, *actualID)
 	})

storage/store/blocks.go

@@ -196,14 +196,14 @@ func (b *Blocks) ByCollectionID(collID flow.Identifier) (*flow.Block, error) {
 		return nil, fmt.Errorf("could not look up guarantee: %w", err)
 	}
 	var blockID flow.Identifier
-	err = operation.LookupBlockContainingCollection(b.db.Reader(), guarantee.ID(), &blockID)
+	err = operation.LookupBlockContainingCollectionGuarantee(b.db.Reader(), guarantee.ID(), &blockID)
 	if err != nil {
 		return nil, fmt.Errorf("could not look up block: %w", err)
 	}
 	return b.ByID(blockID)
 }
 
-// IndexBlockForCollectionGuarantees populates an index `guaranteeID->blockID` for each guarantee
+// IndexBlockContainingCollectionGuarantee populates an index `guaranteeID->blockID` for each guarantee
 // which appears in the block.
 // CAUTION: a collection can be included in multiple *unfinalized* blocks. However, the implementation
 // assumes a one-to-one map from collection ID to a *single* block ID. This holds for FINALIZED BLOCKS ONLY
@@ -213,10 +213,10 @@ func (b *Blocks) ByCollectionID(collID flow.Identifier) (*flow.Block, error) {
 //
 // Error returns:
 //   - generic error in case of unexpected failure from the database layer or encoding failure.
-func (b *Blocks) IndexBlockForCollectionGuarantees(blockID flow.Identifier, guaranteeIDs []flow.Identifier) error {
+func (b *Blocks) IndexBlockContainingCollectionGuarantee(blockID flow.Identifier, guaranteeIDs []flow.Identifier) error {
 	return b.db.WithReaderBatchWriter(func(rw storage.ReaderBatchWriter) error {
 		for _, guaranteeID := range guaranteeIDs {
-			err := operation.IndexBlockContainingCollection(rw.Writer(), guaranteeID, blockID)
+			err := operation.IndexBlockContainingCollectionGuarantee(rw.Writer(), guaranteeID, blockID)
 			if err != nil {
 				return fmt.Errorf("could not index collection block (%x): %w", guaranteeID, err)
 			}