(dot/state) chore: rename SubChain to RangeInMemory (#3011)

ChainSafe · Jan 4, 2023 · eded603 · eded603
1 parent 58ce668
commit eded603
Show file tree

Hide file tree

Showing 16 changed files with 88 additions and 89 deletions.
diff --git a/dot/core/interfaces.go b/dot/core/interfaces.go
@@ -56,7 +56,7 @@ type BlockState interface {
 	BestBlockHeader() (*types.Header, error)
 	AddBlock(*types.Block) error
 	GetBlockStateRoot(bhash common.Hash) (common.Hash, error)
-	SubChain(start, end common.Hash) ([]common.Hash, error)
+	RangeInMemory(start, end common.Hash) ([]common.Hash, error)
 	GetBlockBody(hash common.Hash) (*types.Body, error)
 	HandleRuntimeChanges(newState *rtstorage.TrieState, in state.Runtime, bHash common.Hash) error
 	GetRuntime(blockHash common.Hash) (instance state.Runtime, err error)

diff --git a/dot/core/mocks_test.go b/dot/core/mocks_test.go
diff --git a/dot/core/service.go b/dot/core/service.go
@@ -333,7 +333,7 @@ func (s *Service) handleChainReorg(best, curr common.Hash) error {
 		return nil
 	}
 
-	subchain, err := s.blockState.SubChain(ancestor, best)
+	subchain, err := s.blockState.RangeInMemory(ancestor, best)
 	if err != nil {
 		return err
 	}

diff --git a/dot/core/service_test.go b/dot/core/service_test.go
@@ -808,7 +808,7 @@ func TestService_handleChainReorg(t *testing.T) {
 		mockBlockState := NewMockBlockState(ctrl)
 		mockBlockState.EXPECT().LowestCommonAncestor(testPrevHash, testCurrentHash).
 			Return(testAncestorHash, nil)
-		mockBlockState.EXPECT().SubChain(testAncestorHash, testPrevHash).Return([]common.Hash{}, errDummyErr)
+		mockBlockState.EXPECT().RangeInMemory(testAncestorHash, testPrevHash).Return([]common.Hash{}, errDummyErr)
 
 		service := &Service{
 			blockState: mockBlockState,
@@ -822,7 +822,7 @@ func TestService_handleChainReorg(t *testing.T) {
 		mockBlockState := NewMockBlockState(ctrl)
 		mockBlockState.EXPECT().LowestCommonAncestor(testPrevHash, testCurrentHash).
 			Return(testAncestorHash, nil)
-		mockBlockState.EXPECT().SubChain(testAncestorHash, testPrevHash).Return([]common.Hash{}, nil)
+		mockBlockState.EXPECT().RangeInMemory(testAncestorHash, testPrevHash).Return([]common.Hash{}, nil)
 
 		service := &Service{
 			blockState: mockBlockState,
@@ -836,7 +836,7 @@ func TestService_handleChainReorg(t *testing.T) {
 		mockBlockState := NewMockBlockState(ctrl)
 		mockBlockState.EXPECT().LowestCommonAncestor(testPrevHash, testCurrentHash).
 			Return(testAncestorHash, nil)
-		mockBlockState.EXPECT().SubChain(testAncestorHash, testPrevHash).Return(testSubChain, nil)
+		mockBlockState.EXPECT().RangeInMemory(testAncestorHash, testPrevHash).Return(testSubChain, nil)
 		mockBlockState.EXPECT().BestBlockHash().Return(common.Hash{1})
 		mockBlockState.EXPECT().GetRuntime(common.Hash{1}).Return(nil, errDummyErr)
 
@@ -869,7 +869,7 @@ func TestService_handleChainReorg(t *testing.T) {
 		mockBlockState := NewMockBlockState(ctrl)
 		mockBlockState.EXPECT().LowestCommonAncestor(testPrevHash, testCurrentHash).
 			Return(testAncestorHash, nil)
-		mockBlockState.EXPECT().SubChain(testAncestorHash, testPrevHash).Return(testSubChain, nil)
+		mockBlockState.EXPECT().RangeInMemory(testAncestorHash, testPrevHash).Return(testSubChain, nil)
 		mockBlockState.EXPECT().BestBlockHash().Return(common.Hash{1})
 		mockBlockState.EXPECT().GetRuntime(common.Hash{1}).Return(runtimeMockErr, nil)
 		mockBlockState.EXPECT().GetBlockBody(testCurrentHash).Return(nil, errDummyErr)
@@ -908,7 +908,7 @@ func TestService_handleChainReorg(t *testing.T) {
 		mockBlockState := NewMockBlockState(ctrl)
 		mockBlockState.EXPECT().LowestCommonAncestor(testPrevHash, testCurrentHash).
 			Return(testAncestorHash, nil)
-		mockBlockState.EXPECT().SubChain(testAncestorHash, testPrevHash).Return(testSubChain, nil)
+		mockBlockState.EXPECT().RangeInMemory(testAncestorHash, testPrevHash).Return(testSubChain, nil)
 		mockBlockState.EXPECT().BestBlockHash().Return(common.Hash{1})
 		mockBlockState.EXPECT().GetRuntime(common.Hash{1}).Return(runtimeMockOk, nil)
 		mockBlockState.EXPECT().GetBlockBody(testCurrentHash).Return(nil, errDummyErr)

diff --git a/dot/rpc/interfaces.go b/dot/rpc/interfaces.go
@@ -45,7 +45,7 @@ type BlockAPI interface {
 	FreeImportedBlockNotifierChannel(ch chan *types.Block)
 	GetFinalisedNotifierChannel() chan *types.FinalisationInfo
 	FreeFinalisedNotifierChannel(ch chan *types.FinalisationInfo)
-	SubChain(start, end common.Hash) ([]common.Hash, error)
+	RangeInMemory(start, end common.Hash) ([]common.Hash, error)
 	RegisterRuntimeUpdatedChannel(ch chan<- runtime.Version) (uint32, error)
 	UnregisterRuntimeUpdatedChannel(id uint32) bool
 	GetRuntime(blockHash common.Hash) (runtime state.Runtime, err error)

diff --git a/dot/rpc/modules/api.go b/dot/rpc/modules/api.go
@@ -47,7 +47,7 @@ type BlockAPI interface {
 	FreeImportedBlockNotifierChannel(ch chan *types.Block)
 	GetFinalisedNotifierChannel() chan *types.FinalisationInfo
 	FreeFinalisedNotifierChannel(ch chan *types.FinalisationInfo)
-	SubChain(start, end common.Hash) ([]common.Hash, error)
+	RangeInMemory(start, end common.Hash) ([]common.Hash, error)
 	RegisterRuntimeUpdatedChannel(ch chan<- runtime.Version) (uint32, error)
 	UnregisterRuntimeUpdatedChannel(id uint32) bool
 	GetRuntime(blockHash common.Hash) (instance state.Runtime, err error)

diff --git a/dot/rpc/modules/mocks/block_api.go b/dot/rpc/modules/mocks/block_api.go
diff --git a/dot/rpc/modules/mocks_test.go b/dot/rpc/modules/mocks_test.go
diff --git a/dot/state/block.go b/dot/state/block.go
@@ -673,13 +673,13 @@ func (bs *BlockState) retrieveRangeFromDatabase(startHash common.Hash,
 	return hashes, nil
 }
 
-// SubChain returns the sub-blockchain between the starting hash and the ending hash using the block tree
-func (bs *BlockState) SubChain(start, end common.Hash) ([]common.Hash, error) {
+// RangeInMemory returns the sub-blockchain between the starting hash and the ending hash using the block tree
+func (bs *BlockState) RangeInMemory(start, end common.Hash) ([]common.Hash, error) {
 	if bs.bt == nil {
 		return nil, fmt.Errorf("%w", errNilBlockTree)
 	}
 
-	return bs.bt.SubBlockchain(start, end)
+	return bs.bt.RangeInMemory(start, end)
 }
 
 // IsDescendantOf returns true if child is a descendant of parent, false otherwise.

diff --git a/dot/state/block_finalisation.go b/dot/state/block_finalisation.go
@@ -215,7 +215,7 @@ func (bs *BlockState) handleFinalisedBlock(curr common.Hash) error {
 		return nil
 	}
 
-	subchain, err := bs.SubChain(prev, curr)
+	subchain, err := bs.RangeInMemory(prev, curr)
 	if err != nil {
 		return err
 	}

diff --git a/dot/sync/interfaces.go b/dot/sync/interfaces.go
@@ -25,7 +25,7 @@ type BlockState interface {
 	GetBlockBody(common.Hash) (*types.Body, error)
 	GetHeader(common.Hash) (*types.Header, error)
 	HasHeader(hash common.Hash) (bool, error)
-	SubChain(start, end common.Hash) ([]common.Hash, error)
+	RangeInMemory(start, end common.Hash) ([]common.Hash, error)
 	GetReceipt(common.Hash) ([]byte, error)
 	GetMessageQueue(common.Hash) ([]byte, error)
 	GetJustification(common.Hash) ([]byte, error)

diff --git a/dot/sync/message.go b/dot/sync/message.go
@@ -291,7 +291,7 @@ func (s *Service) handleDescendingByNumber(start, end uint,
 func (s *Service) handleChainByHash(ancestor, descendant common.Hash,
 	max uint, requestedData byte, direction network.SyncDirection) (
 	*network.BlockResponseMessage, error) {
-	subchain, err := s.blockState.SubChain(ancestor, descendant)
+	subchain, err := s.blockState.RangeInMemory(ancestor, descendant)
 	if err != nil {
 		return nil, fmt.Errorf("retrieving subchain: %w", err)
 	}

diff --git a/dot/sync/message_test.go b/dot/sync/message_test.go
@@ -103,7 +103,7 @@ func TestService_CreateBlockResponse(t *testing.T) {
 				mockBlockState.EXPECT().GetHashByNumber(uint(2)).Return(common.Hash{1, 2, 3}, nil)
 				mockBlockState.EXPECT().IsDescendantOf(common.Hash{}, common.Hash{1, 2, 3}).Return(true,
 					nil)
-				mockBlockState.EXPECT().SubChain(common.Hash{}, common.Hash{1, 2, 3}).Return([]common.Hash{{1,
+				mockBlockState.EXPECT().RangeInMemory(common.Hash{}, common.Hash{1, 2, 3}).Return([]common.Hash{{1,
 					2}},
 					nil)
 				return mockBlockState
@@ -125,7 +125,7 @@ func TestService_CreateBlockResponse(t *testing.T) {
 				mockBlockState.EXPECT().GetHeaderByNumber(uint(1)).Return(&types.Header{
 					Number: 1,
 				}, nil)
-				mockBlockState.EXPECT().SubChain(common.MustHexToHash(
+				mockBlockState.EXPECT().RangeInMemory(common.MustHexToHash(
 					"0x6443a0b46e0412e626363028115a9f2cf963eeed526b8b33e5316f08b50d0dc3"),
 					common.Hash{}).Return([]common.Hash{{1, 2}}, nil)
 				return mockBlockState

diff --git a/dot/sync/mocks_test.go b/dot/sync/mocks_test.go
diff --git a/lib/blocktree/blocktree.go b/lib/blocktree/blocktree.go
@@ -165,8 +165,8 @@ func (bt *BlockTree) Range(startHash common.Hash, endHash common.Hash) (hashes [
 	return hashes, nil
 }
 
-// SubBlockchain returns the path from the node with Hash start to the node with Hash end
-func (bt *BlockTree) SubBlockchain(startHash common.Hash, endHash common.Hash) (hashes []common.Hash, err error) {
+// RangeInMemory returns the path from the node with Hash start to the node with Hash end
+func (bt *BlockTree) RangeInMemory(startHash common.Hash, endHash common.Hash) (hashes []common.Hash, err error) {
 	bt.Lock()
 	defer bt.Unlock()