[FAB-14019] move proto common.Block helpers

Replace common/Blockdata.Hash, common/BlockData.Bytes,
common/BlockHeader.Hash, and common/BlockHeader.Bytes with pure
functions in protoutil.

Change-Id: I1d9d441ae16e762377e6585941293fa301d2a292
Signed-off-by: Matthew Sykes <sykesmat@us.ibm.com>

Author: sykesm

common/genesis/genesis.go

@@ -44,7 +44,7 @@ func (f *factory) Block(channelID string) *cb.Block {
 
 	block := protoutil.NewBlock(0, nil)
 	block.Data = &cb.BlockData{Data: [][]byte{protoutil.MarshalOrPanic(envelope)}}
-	block.Header.DataHash = block.Data.Hash()
+	block.Header.DataHash = protoutil.BlockDataHash(block.Data)
 	block.Metadata.Metadata[cb.BlockMetadataIndex_LAST_CONFIG] = protoutil.MarshalOrPanic(&cb.Metadata{
 		Value: protoutil.MarshalOrPanic(&cb.LastConfig{Index: 0}),
 	})

common/ledger/blkstorage/fsblkstorage/blockfile_mgr.go

@@ -157,7 +157,7 @@ func newBlockfileMgr(id string, conf *Conf, indexConfig *blkstorage.IndexConfig,
 		if err != nil {
 			panic(fmt.Sprintf("Could not retrieve header of the last block form file: %s", err))
 		}
-		lastBlockHash := lastBlockHeader.Hash()
+		lastBlockHash := protoutil.BlockHeaderHash(lastBlockHeader)
 		previousBlockHash := lastBlockHeader.PreviousHash
 		bcInfo = &common.BlockchainInfo{
 			Height:            cpInfo.lastBlockNumber + 1,
@@ -260,7 +260,7 @@ func (mgr *blockfileMgr) addBlock(block *common.Block) error {
 	if err != nil {
 		return errors.WithMessage(err, "error serializing block")
 	}
-	blockHash := block.Header.Hash()
+	blockHash := protoutil.BlockHeaderHash(block.Header)
 	//Get the location / offset where each transaction starts in the block and where the block ends
 	txOffsets := info.txOffsets
 	currentOffset := mgr.cpInfo.latestFileChunksize
@@ -408,7 +408,7 @@ func (mgr *blockfileMgr) syncIndex() error {
 		}
 
 		//Update the blockIndexInfo with what was actually stored in file system
-		blockIdxInfo.blockHash = info.blockHeader.Hash()
+		blockIdxInfo.blockHash = protoutil.BlockHeaderHash(info.blockHeader)
 		blockIdxInfo.blockNum = info.blockHeader.Number
 		blockIdxInfo.flp = &fileLocPointer{fileSuffixNum: blockPlacementInfo.fileNum,
 			locPointer: locPointer{offset: int(blockPlacementInfo.blockStartOffset)}}

common/ledger/blkstorage/fsblkstorage/blockindex_test.go

@@ -162,7 +162,7 @@ func testBlockIndexSelectiveIndexing(t *testing.T, indexItems []blkstorage.Index
 
 		// if index has been configured for an indexItem then the item should be indexed else not
 		// test 'retrieveBlockByHash'
-		block, err := blockfileMgr.retrieveBlockByHash(blocks[0].Header.Hash())
+		block, err := blockfileMgr.retrieveBlockByHash(protoutil.BlockHeaderHash(blocks[0].Header))
 		if containsAttr(indexItems, blkstorage.IndexableAttrBlockHash) {
 			assert.NoError(t, err, "Error while retrieving block by hash")
 			assert.Equal(t, blocks[0], block)

common/ledger/blkstorage/fsblkstorage/fs_blockstore_provider_test.go

@@ -48,7 +48,7 @@ func TestMultipleBlockStores(t *testing.T) {
 func checkBlocks(t *testing.T, expectedBlocks []*common.Block, store blkstorage.BlockStore) {
 	bcInfo, _ := store.GetBlockchainInfo()
 	assert.Equal(t, uint64(len(expectedBlocks)), bcInfo.Height)
-	assert.Equal(t, expectedBlocks[len(expectedBlocks)-1].GetHeader().Hash(), bcInfo.CurrentBlockHash)
+	assert.Equal(t, protoutil.BlockHeaderHash(expectedBlocks[len(expectedBlocks)-1].GetHeader()), bcInfo.CurrentBlockHash)
 
 	itr, _ := store.RetrieveBlocks(0)
 	for i := 0; i < len(expectedBlocks); i++ {
@@ -62,7 +62,7 @@ func checkBlocks(t *testing.T, expectedBlocks []*common.Block, store blkstorage.
 		retrievedBlock, _ := store.RetrieveBlockByNumber(uint64(blockNum))
 		assert.Equal(t, block, retrievedBlock)
 
-		retrievedBlock, _ = store.RetrieveBlockByHash(block.Header.Hash())
+		retrievedBlock, _ = store.RetrieveBlockByHash(protoutil.BlockHeaderHash(block.Header))
 		assert.Equal(t, block, retrievedBlock)
 
 		for txNum := 0; txNum < len(block.Data.Data); txNum++ {

common/ledger/blkstorage/fsblkstorage/pkg_test.go

@@ -25,6 +25,7 @@ import (
 	"github.com/hyperledger/fabric/common/flogging"
 	"github.com/hyperledger/fabric/common/ledger/blkstorage"
 	"github.com/hyperledger/fabric/protos/common"
+	"github.com/hyperledger/fabric/protoutil"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -93,7 +94,7 @@ func (w *testBlockfileMgrWrapper) addBlocks(blocks []*common.Block) {
 
 func (w *testBlockfileMgrWrapper) testGetBlockByHash(blocks []*common.Block) {
 	for i, block := range blocks {
-		hash := block.Header.Hash()
+		hash := protoutil.BlockHeaderHash(block.Header)
 		b, err := w.blockfileMgr.retrieveBlockByHash(hash)
 		assert.NoError(w.t, err, "Error while retrieving [%d]th block from blockfileMgr", i)
 		assert.Equal(w.t, block, b)

common/ledger/blockledger/blackbox_test.go

@@ -14,6 +14,7 @@ import (
 	"github.com/hyperledger/fabric/common/ledger/blockledger"
 	cb "github.com/hyperledger/fabric/protos/common"
 	ab "github.com/hyperledger/fabric/protos/orderer"
+	"github.com/hyperledger/fabric/protoutil"
 )
 
 type ledgerTestable interface {
@@ -91,7 +92,7 @@ func testReinitialization(lf ledgerTestFactory, t *testing.T) {
 	if block == nil {
 		t.Fatalf("Error retrieving block 1")
 	}
-	if !bytes.Equal(block.Header.Hash(), aBlock.Header.Hash()) {
+	if !bytes.Equal(protoutil.BlockHeaderHash(block.Header), protoutil.BlockHeaderHash(aBlock.Header)) {
 		t.Fatalf("Block hashes did no match")
 	}
 }
@@ -106,7 +107,7 @@ func testAddition(lf ledgerTestFactory, t *testing.T) {
 	if genesis == nil {
 		t.Fatalf("Could not retrieve genesis block")
 	}
-	prevHash := genesis.Header.Hash()
+	prevHash := protoutil.BlockHeaderHash(genesis.Header)
 
 	li.Append(blockledger.CreateNextBlock(li, []*cb.Envelope{{Payload: []byte("My Data")}}))
 	if li.Height() != 2 {

common/ledger/blockledger/file/impl_test.go

@@ -132,7 +132,7 @@ func TestInitialization(t *testing.T) {
 
 	block := blockledger.GetBlock(fl, 0)
 	assert.NotNil(t, block, "Error retrieving genesis block")
-	assert.Equal(t, genesisBlock.Header.Hash(), block.Header.Hash(), "Block hashes did no match")
+	assert.Equal(t, protoutil.BlockHeaderHash(genesisBlock.Header), protoutil.BlockHeaderHash(block.Header), "Block hashes did no match")
 }
 
 func TestReinitialization(t *testing.T) {
@@ -170,7 +170,7 @@ func TestReinitialization(t *testing.T) {
 
 	block := blockledger.GetBlock(fl, 1)
 	assert.NotNil(t, block, "Error retrieving block 1")
-	assert.Equal(t, b1.Header.Hash(), block.Header.Hash(), "Block hashes did no match")
+	assert.Equal(t, protoutil.BlockHeaderHash(b1.Header), protoutil.BlockHeaderHash(block.Header), "Block hashes did no match")
 }
 
 func TestAddition(t *testing.T) {

common/ledger/blockledger/json/factory.go

@@ -15,6 +15,7 @@ import (
 
 	"github.com/golang/protobuf/jsonpb"
 	"github.com/hyperledger/fabric/common/ledger/blockledger"
+	"github.com/hyperledger/fabric/protoutil"
 	"github.com/pkg/errors"
 )
 
@@ -95,7 +96,7 @@ func (jl *jsonLedger) initializeBlockHeight() {
 	if block == nil {
 		logger.Panicf("Error reading block %d", jl.height-1)
 	}
-	jl.lastHash = block.Header.Hash()
+	jl.lastHash = protoutil.BlockHeaderHash(block.Header)
 }
 
 // ChainIDs returns the chain IDs the factory is aware of

common/ledger/blockledger/json/impl.go

@@ -18,6 +18,7 @@ import (
 	"github.com/hyperledger/fabric/common/ledger/blockledger"
 	cb "github.com/hyperledger/fabric/protos/common"
 	ab "github.com/hyperledger/fabric/protos/orderer"
+	"github.com/hyperledger/fabric/protoutil"
 	"github.com/pkg/errors"
 )
 
@@ -135,7 +136,7 @@ func (jl *jsonLedger) Append(block *cb.Block) error {
 	}
 
 	jl.writeBlock(block)
-	jl.lastHash = block.Header.Hash()
+	jl.lastHash = protoutil.BlockHeaderHash(block.Header)
 	jl.height++
 
 	// Manage the signal channel under lock to avoid race with read in Next

common/ledger/blockledger/json/impl_test.go

@@ -62,7 +62,7 @@ func TestInitialization(t *testing.T) {
 	block, found := fl.readBlock(0)
 	assert.NotNil(t, block, "Error retrieving genesis block")
 	assert.True(t, found, "Error retrieving genesis block")
-	assert.Equal(t, fl.lastHash, block.Header.Hash(), "Block hashes did no match")
+	assert.Equal(t, fl.lastHash, protoutil.BlockHeaderHash(block.Header), "Block hashes did no match")
 
 }
 
@@ -83,7 +83,7 @@ func TestReinitialization(t *testing.T) {
 	block, found := fl.readBlock(1)
 	assert.NotNil(t, block, "Error retrieving block")
 	assert.True(t, found, "Error retrieving block")
-	assert.Equal(t, fl.lastHash, block.Header.Hash(), "Block hashes did no match")
+	assert.Equal(t, fl.lastHash, protoutil.BlockHeaderHash(block.Header), "Block hashes did no match")
 }
 
 func TestMultiReinitialization(t *testing.T) {