Merge pull request #315 from multiversx/MX-16238-tx-hash-extractor

tx hashes extractor implementation

factory/runType/interface.go

@@ -1,5 +1,9 @@
 package runType
 
+import (
+	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc/transactions"
+)
+
 // RunTypeComponentsCreator is the interface for creating run type components
 type RunTypeComponentsCreator interface {
 	Create() *runTypeComponents
@@ -22,6 +26,7 @@ type RunTypeComponentsHandler interface {
 
 // RunTypeComponentsHolder holds the run type components
 type RunTypeComponentsHolder interface {
+	TxHashExtractorCreator() transactions.TxHashExtractor
 	Create() error
 	Close() error
 	CheckSubcomponents() error

factory/runType/runTypeComponents.go

@@ -1,6 +1,12 @@
 package runType
 
-type runTypeComponents struct{}
+import (
+	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc/transactions"
+)
+
+type runTypeComponents struct {
+	txHashExtractor transactions.TxHashExtractor
+}
 
 // Close does nothing
 func (rtc *runTypeComponents) Close() error {

factory/runType/runTypeComponentsFactory.go

@@ -1,5 +1,9 @@
 package runType
 
+import (
+	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc/transactions"
+)
+
 type runTypeComponentsFactory struct{}
 
 // NewRunTypeComponentsFactory will return a new instance of run type components factory
@@ -9,7 +13,9 @@ func NewRunTypeComponentsFactory() *runTypeComponentsFactory {
 
 // Create will create the run type components
 func (rtcf *runTypeComponentsFactory) Create() *runTypeComponents {
-	return &runTypeComponents{}
+	return &runTypeComponents{
+		txHashExtractor: transactions.NewTxHashExtractor(),
+	}
 }
 
 // IsInterfaceNil returns true if there is no value under the interface

factory/runType/runTypeComponentsHandler.go

@@ -4,6 +4,8 @@ import (
 	"sync"
 
 	"github.com/multiversx/mx-chain-core-go/core/check"
+
+	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc/transactions"
 )
 
 const runTypeComponentsName = "managedRunTypeComponents"
@@ -67,9 +69,24 @@ func (mrtc *managedRunTypeComponents) CheckSubcomponents() error {
 	if check.IfNil(mrtc.runTypeComponents) {
 		return errNilRunTypeComponents
 	}
+	if check.IfNil(mrtc.txHashExtractor) {
+		return transactions.ErrNilTxHashExtractor
+	}
 	return nil
 }
 
+// TxHashExtractorCreator returns tx hash extractor
+func (mrtc *managedRunTypeComponents) TxHashExtractorCreator() transactions.TxHashExtractor {
+	mrtc.mutRunTypeCoreComponents.Lock()
+	defer mrtc.mutRunTypeCoreComponents.Unlock()
+
+	if check.IfNil(mrtc.runTypeComponents) {
+		return nil
+	}
+
+	return mrtc.runTypeComponents.txHashExtractor
+}
+
 // IsInterfaceNil returns true if the interface is nil
 func (mrtc *managedRunTypeComponents) IsInterfaceNil() bool {
 	return mrtc == nil

factory/runType/runTypeComponentsHandler_test.go

@@ -36,9 +36,13 @@ func TestManagedRunTypeComponents_Create(t *testing.T) {
 		managedRunTypeComponents, err := createComponents()
 		require.NoError(t, err)
 
+		require.Nil(t, managedRunTypeComponents.TxHashExtractorCreator())
+
 		err = managedRunTypeComponents.Create()
 		require.NoError(t, err)
 
+		require.NotNil(t, managedRunTypeComponents.TxHashExtractorCreator())
+
 		require.Equal(t, runTypeComponentsName, managedRunTypeComponents.String())
 		require.NoError(t, managedRunTypeComponents.Close())
 	})

factory/runType/sovereignRunTypeComponentsFactory.go

@@ -1,5 +1,9 @@
 package runType
 
+import (
+	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc/transactions"
+)
+
 type sovereignRunTypeComponentsFactory struct{}
 
 // NewSovereignRunTypeComponentsFactory will return a new instance of sovereign run type components factory
@@ -9,7 +13,9 @@ func NewSovereignRunTypeComponentsFactory() *sovereignRunTypeComponentsFactory {
 
 // Create will create the run type components
 func (srtcf *sovereignRunTypeComponentsFactory) Create() *runTypeComponents {
-	return &runTypeComponents{}
+	return &runTypeComponents{
+		txHashExtractor: transactions.NewSovereignTxHashExtractor(),
+	}
 }
 
 // IsInterfaceNil returns true if there is no value under the interface

integrationtests/utils.go

@@ -12,13 +12,15 @@ import (
 
 	"github.com/elastic/go-elasticsearch/v7"
 	"github.com/multiversx/mx-chain-core-go/core/pubkeyConverter"
+	logger "github.com/multiversx/mx-chain-logger-go"
+
 	"github.com/multiversx/mx-chain-es-indexer-go/client"
 	"github.com/multiversx/mx-chain-es-indexer-go/client/logging"
 	"github.com/multiversx/mx-chain-es-indexer-go/mock"
 	"github.com/multiversx/mx-chain-es-indexer-go/process/dataindexer"
 	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc"
 	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc/factory"
-	logger "github.com/multiversx/mx-chain-logger-go"
+	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc/transactions"
 )
 
 var (
@@ -60,7 +62,8 @@ func CreateElasticProcessor(
 		EnabledIndexes: []string{dataindexer.TransactionsIndex, dataindexer.LogsIndex, dataindexer.AccountsESDTIndex, dataindexer.ScResultsIndex,
 			dataindexer.ReceiptsIndex, dataindexer.BlockIndex, dataindexer.AccountsIndex, dataindexer.TokensIndex, dataindexer.TagsIndex, dataindexer.EventsIndex,
 			dataindexer.OperationsIndex, dataindexer.DelegatorsIndex, dataindexer.ESDTsIndex, dataindexer.SCDeploysIndex, dataindexer.MiniblocksIndex, dataindexer.ValuesIndex},
-		Denomination: 18,
+		Denomination:    18,
+		TxHashExtractor: transactions.NewTxHashExtractor(),
 	}
 
 	return factory.CreateElasticProcessor(args)

mock/txHashExtractorMock.go

@@ -0,0 +1,24 @@
+package mock
+
+import (
+	coreData "github.com/multiversx/mx-chain-core-go/data"
+)
+
+// TxHashExtractorMock -
+type TxHashExtractorMock struct {
+	ExtractExecutedTxHashesCalled func(mbIndex int, mbTxHashes [][]byte, header coreData.HeaderHandler) [][]byte
+}
+
+// ExtractExecutedTxHashes -
+func (the *TxHashExtractorMock) ExtractExecutedTxHashes(mbIndex int, mbTxHashes [][]byte, header coreData.HeaderHandler) [][]byte {
+	if the.ExtractExecutedTxHashesCalled != nil {
+		return the.ExtractExecutedTxHashesCalled(mbIndex, mbTxHashes, header)
+	}
+
+	return make([][]byte, 0)
+}
+
+// IsInterfaceNil returns true if there is no value under the interface
+func (the *TxHashExtractorMock) IsInterfaceNil() bool {
+	return the == nil
+}

process/elasticproc/elasticProcessor_test.go

@@ -12,6 +12,8 @@ import (
 	dataBlock "github.com/multiversx/mx-chain-core-go/data/block"
 	"github.com/multiversx/mx-chain-core-go/data/outport"
 	"github.com/multiversx/mx-chain-core-go/data/transaction"
+	"github.com/stretchr/testify/require"
+
 	"github.com/multiversx/mx-chain-es-indexer-go/data"
 	"github.com/multiversx/mx-chain-es-indexer-go/mock"
 	"github.com/multiversx/mx-chain-es-indexer-go/process/dataindexer"
@@ -25,7 +27,6 @@ import (
 	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc/tags"
 	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc/transactions"
 	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc/validators"
-	"github.com/stretchr/testify/require"
 )
 
 func newElasticsearchProcessor(elasticsearchWriter DatabaseClientHandler, arguments *ArgElasticProcessor) *elasticProcessor {
@@ -354,6 +355,7 @@ func TestElasticseachSaveTransactions(t *testing.T) {
 		Hasher:                 &mock.HasherMock{},
 		Marshalizer:            &mock.MarshalizerMock{},
 		BalanceConverter:       bc,
+		TxHashExtractor:        transactions.NewTxHashExtractor(),
 	}
 	txDbProc, _ := transactions.NewTransactionsProcessor(args)
 	arguments.TransactionsProc = txDbProc

process/elasticproc/factory/elasticProcessorFactory.go

@@ -4,6 +4,7 @@ import (
 	"github.com/multiversx/mx-chain-core-go/core"
 	"github.com/multiversx/mx-chain-core-go/hashing"
 	"github.com/multiversx/mx-chain-core-go/marshal"
+
 	"github.com/multiversx/mx-chain-es-indexer-go/process/dataindexer"
 	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc"
 	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc/accounts"
@@ -31,6 +32,7 @@ type ArgElasticProcessorFactory struct {
 	BulkRequestMaxSize       int
 	UseKibana                bool
 	ImportDB                 bool
+	TxHashExtractor          transactions.TxHashExtractor
 }
 
 // CreateElasticProcessor will create a new instance of ElasticProcessor
@@ -87,6 +89,7 @@ func CreateElasticProcessor(arguments ArgElasticProcessorFactory) (dataindexer.E
 		Hasher:                 arguments.Hasher,
 		Marshalizer:            arguments.Marshalizer,
 		BalanceConverter:       balanceConverter,
+		TxHashExtractor:        arguments.TxHashExtractor,
 	}
 	txsProc, err := transactions.NewTransactionsProcessor(argsTxsProc)
 	if err != nil {

process/elasticproc/factory/elasticProcessorFactory_test.go

@@ -3,8 +3,9 @@ package factory
 import (
 	"testing"
 
-	"github.com/multiversx/mx-chain-es-indexer-go/mock"
 	"github.com/stretchr/testify/require"
+
+	"github.com/multiversx/mx-chain-es-indexer-go/mock"
 )
 
 func TestCreateElasticProcessor(t *testing.T) {
@@ -18,6 +19,7 @@ func TestCreateElasticProcessor(t *testing.T) {
 		EnabledIndexes:           []string{"blocks"},
 		Denomination:             1,
 		UseKibana:                false,
+		TxHashExtractor:          &mock.TxHashExtractorMock{},
 	}
 
 	ep, err := CreateElasticProcessor(args)

process/elasticproc/transactions/checkers.go

@@ -10,9 +10,10 @@ import (
 	"github.com/multiversx/mx-chain-core-go/core/check"
 	coreData "github.com/multiversx/mx-chain-core-go/data"
 	"github.com/multiversx/mx-chain-core-go/data/outport"
+	vmcommon "github.com/multiversx/mx-chain-vm-common-go"
+
 	"github.com/multiversx/mx-chain-es-indexer-go/data"
 	elasticIndexer "github.com/multiversx/mx-chain-es-indexer-go/process/dataindexer"
-	vmcommon "github.com/multiversx/mx-chain-vm-common-go"
 )
 
 const (
@@ -35,6 +36,9 @@ func checkTxsProcessorArg(args *ArgsTransactionProcessor) error {
 	if check.IfNil(args.BalanceConverter) {
 		return elasticIndexer.ErrNilBalanceConverter
 	}
+	if check.IfNil(args.TxHashExtractor) {
+		return ErrNilTxHashExtractor
+	}
 
 	return nil
 }

process/elasticproc/transactions/checkers_test.go

@@ -9,18 +9,23 @@ import (
 	coreData "github.com/multiversx/mx-chain-core-go/data"
 	"github.com/multiversx/mx-chain-core-go/data/block"
 	"github.com/multiversx/mx-chain-core-go/data/outport"
+	vmcommon "github.com/multiversx/mx-chain-vm-common-go"
+	"github.com/stretchr/testify/require"
+
 	"github.com/multiversx/mx-chain-es-indexer-go/data"
 	"github.com/multiversx/mx-chain-es-indexer-go/mock"
 	elasticIndexer "github.com/multiversx/mx-chain-es-indexer-go/process/dataindexer"
-	vmcommon "github.com/multiversx/mx-chain-vm-common-go"
-	"github.com/stretchr/testify/require"
+	"github.com/multiversx/mx-chain-es-indexer-go/process/elasticproc/converters"
 )
 
 func createMockArgs() *ArgsTransactionProcessor {
+	bc, _ := converters.NewBalanceConverter(18)
 	return &ArgsTransactionProcessor{
 		AddressPubkeyConverter: &mock.PubkeyConverterMock{},
 		Hasher:                 &mock.HasherMock{},
 		Marshalizer:            &mock.MarshalizerMock{},
+		BalanceConverter:       bc,
+		TxHashExtractor:        &mock.TxHashExtractorMock{},
 	}
 }
 
@@ -59,6 +64,24 @@ func TestNewTransactionsProcessor(t *testing.T) {
 			},
 			exErr: elasticIndexer.ErrNilHasher,
 		},
+		{
+			name: "NilBalanceConverter",
+			args: func() *ArgsTransactionProcessor {
+				args := createMockArgs()
+				args.BalanceConverter = nil
+				return args
+			},
+			exErr: elasticIndexer.ErrNilBalanceConverter,
+		},
+		{
+			name: "NilTxHashExtractor",
+			args: func() *ArgsTransactionProcessor {
+				args := createMockArgs()
+				args.TxHashExtractor = nil
+				return args
+			},
+			exErr: ErrNilTxHashExtractor,
+		},
 	}
 
 	for _, tt := range tests {

process/elasticproc/transactions/errors.go

@@ -0,0 +1,8 @@
+package transactions
+
+import (
+	"errors"
+)
+
+// ErrNilTxHashExtractor signals that a nil tx hash extractor has been provided
+var ErrNilTxHashExtractor = errors.New("nil tx hash extractor")

process/elasticproc/transactions/interface.go

@@ -1,6 +1,7 @@
 package transactions
 
 import (
+	coreData "github.com/multiversx/mx-chain-core-go/data"
 	"github.com/multiversx/mx-chain-core-go/data/outport"
 	datafield "github.com/multiversx/mx-chain-vm-common-go/parsers/dataField"
 )
@@ -13,3 +14,9 @@ type DataFieldParser interface {
 type feeInfoHandler interface {
 	GetFeeInfo() *outport.FeeInfo
 }
+
+// TxHashExtractor defines what tx hash extractor should be able to do
+type TxHashExtractor interface {
+	ExtractExecutedTxHashes(mbIndex int, mbTxHashes [][]byte, header coreData.HeaderHandler) [][]byte
+	IsInterfaceNil() bool
+}

process/elasticproc/transactions/sovereignTxHashExtractor.go

@@ -0,0 +1,22 @@
+package transactions
+
+import (
+	coreData "github.com/multiversx/mx-chain-core-go/data"
+)
+
+type sovereignTxHashExtractor struct{}
+
+// NewSovereignTxHashExtractor creates a new sovereign tx hash extractor
+func NewSovereignTxHashExtractor() *sovereignTxHashExtractor {
+	return &sovereignTxHashExtractor{}
+}
+
+// ExtractExecutedTxHashes returns directly the provided mini block tx hashes
+func (the *sovereignTxHashExtractor) ExtractExecutedTxHashes(_ int, mbTxHashes [][]byte, _ coreData.HeaderHandler) [][]byte {
+	return mbTxHashes
+}
+
+// IsInterfaceNil returns true if there is no value under the interface
+func (the *sovereignTxHashExtractor) IsInterfaceNil() bool {
+	return the == nil
+}

process/elasticproc/transactions/sovereignTxHashExtractor_test.go

@@ -0,0 +1,23 @@
+package transactions
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestNewSovereignTxHashExtractor(t *testing.T) {
+	t.Parallel()
+
+	sthe := NewSovereignTxHashExtractor()
+	require.False(t, sthe.IsInterfaceNil())
+}
+
+func TestSovereignTxHashExtractor_ExtractExecutedTxHashes(t *testing.T) {
+	t.Parallel()
+
+	sthe := NewSovereignTxHashExtractor()
+	mbTxHashes := [][]byte{[]byte("hash1"), []byte("hash2")}
+	txHashes := sthe.ExtractExecutedTxHashes(0, mbTxHashes, nil)
+	require.Equal(t, mbTxHashes, txHashes)
+}