Merge pull request #5585 from multiversx/state-changes-collector

State changes collector

cmd/node/config/config.toml

@@ -662,6 +662,7 @@
     MaxStateTrieLevelInMemory = 5
     MaxPeerTrieLevelInMemory = 5
     StateStatisticsEnabled = false
+    CollectStateChangesEnabled = false
 
 [BlockSizeThrottleConfig]
     MinSizeInBytes = 104857 # 104857 is 10% from 1MB

config/config.go

@@ -311,6 +311,7 @@ type StateTriesConfig struct {
 	SnapshotsEnabled            bool
 	AccountsStatePruningEnabled bool
 	PeerStatePruningEnabled     bool
+	CollectStateChangesEnabled  bool
 	MaxStateTrieLevelInMemory   uint
 	MaxPeerTrieLevelInMemory    uint
 	StateStatisticsEnabled      bool

epochStart/bootstrap/disabled/disabledAccountsAdapter.go

@@ -128,6 +128,15 @@ func (a *accountsAdapter) GetStackDebugFirstEntry() []byte {
 	return nil
 }
 
+// SetTxHashForLatestStateChanges -
+func (a *accountsAdapter) SetTxHashForLatestStateChanges(_ []byte) {
+}
+
+// ResetStateChangesCollector -
+func (a *accountsAdapter) ResetStateChangesCollector() []state.StateChangesForTx {
+	return nil
+}
+
 // Close -
 func (a *accountsAdapter) Close() error {
 	return nil

epochStart/metachain/systemSCs_test.go

@@ -763,6 +763,7 @@ func createAccountsDB(
 		StoragePruningManager: spm,
 		AddressConverter:      &testscommon.PubkeyConverterMock{},
 		SnapshotsManager:      disabledState.NewDisabledSnapshotsManager(),
+		StateChangesCollector: disabledState.NewDisabledStateChangesCollector(),
 	}
 	adb, _ := state.NewAccountsDB(args)
 	return adb

factory/api/apiResolverFactory.go

@@ -601,6 +601,7 @@ func createNewAccountsAdapterApi(args scQueryElementArgs, chainHandler data.Chai
 		StoragePruningManager: storagePruning,
 		AddressConverter:      args.coreComponents.AddressPubKeyConverter(),
 		SnapshotsManager:      disabledState.NewDisabledSnapshotsManager(),
+		StateChangesCollector: disabledState.NewDisabledStateChangesCollector(),
 	}
 
 	provider, err := blockInfoProviders.NewCurrentBlockInfo(chainHandler)

factory/processing/blockProcessorCreator_test.go

@@ -213,6 +213,7 @@ func createAccountAdapter(
 		StoragePruningManager: disabled.NewDisabledStoragePruningManager(),
 		AddressConverter:      &testscommon.PubkeyConverterMock{},
 		SnapshotsManager:      disabledState.NewDisabledSnapshotsManager(),
+		StateChangesCollector: disabledState.NewDisabledStateChangesCollector(),
 	}
 	adb, err := state.NewAccountsDB(args)
 	if err != nil {

factory/state/stateComponents.go

@@ -152,6 +152,11 @@ func (scf *stateComponentsFactory) createAccountsAdapters(triesContainer common.
 		return nil, nil, nil, err
 	}
 
+	stateChangesCollector := disabled.NewDisabledStateChangesCollector()
+	if scf.config.StateTriesConfig.CollectStateChangesEnabled {
+		stateChangesCollector = state.NewStateChangesCollector()
+	}
+
 	argStateMetrics := stateMetrics.ArgsStateMetrics{
 		SnapshotInProgressKey:   common.MetricAccountsSnapshotInProgress,
 		LastSnapshotDurationKey: common.MetricLastAccountsSnapshotDurationSec,
@@ -168,13 +173,14 @@ func (scf *stateComponentsFactory) createAccountsAdapters(triesContainer common.
 	}
 
 	argsProcessingAccountsDB := state.ArgsAccountsDB{
-		Trie:                  merkleTrie,
-		Hasher:                scf.core.Hasher(),
-		Marshaller:            scf.core.InternalMarshalizer(),
-		AccountFactory:        accountFactory,
-		StoragePruningManager: storagePruning,
-		AddressConverter:      scf.core.AddressPubKeyConverter(),
-		SnapshotsManager:      snapshotsManager,
+		Trie:                     merkleTrie,
+		Hasher:                   scf.core.Hasher(),
+		Marshaller:               scf.core.InternalMarshalizer(),
+		AccountFactory:           accountFactory,
+		StoragePruningManager:    storagePruning,
+		AddressConverter:         scf.core.AddressPubKeyConverter(),
+		SnapshotsManager:         snapshotsManager,
+		StateChangesCollector:    stateChangesCollector,
 	}
 	accountsAdapter, err := state.NewAccountsDB(argsProcessingAccountsDB)
 	if err != nil {
@@ -189,6 +195,7 @@ func (scf *stateComponentsFactory) createAccountsAdapters(triesContainer common.
 		StoragePruningManager: storagePruning,
 		AddressConverter:      scf.core.AddressPubKeyConverter(),
 		SnapshotsManager:      disabled.NewDisabledSnapshotsManager(),
+		StateChangesCollector: disabled.NewDisabledStateChangesCollector(),
 	}
 
 	accountsAdapterApiOnFinal, err := factoryState.CreateAccountsAdapterAPIOnFinal(argsAPIAccountsDB, scf.chainHandler)
@@ -228,6 +235,11 @@ func (scf *stateComponentsFactory) createPeerAdapter(triesContainer common.Tries
 		return nil, err
 	}
 
+	stateChangesCollector := disabled.NewDisabledStateChangesCollector()
+	if scf.config.StateTriesConfig.CollectStateChangesEnabled {
+		stateChangesCollector = state.NewStateChangesCollector()
+	}
+
 	argStateMetrics := stateMetrics.ArgsStateMetrics{
 		SnapshotInProgressKey:   common.MetricPeersSnapshotInProgress,
 		LastSnapshotDurationKey: common.MetricLastPeersSnapshotDurationSec,
@@ -244,13 +256,14 @@ func (scf *stateComponentsFactory) createPeerAdapter(triesContainer common.Tries
 	}
 
 	argsProcessingPeerAccountsDB := state.ArgsAccountsDB{
-		Trie:                  merkleTrie,
-		Hasher:                scf.core.Hasher(),
-		Marshaller:            scf.core.InternalMarshalizer(),
-		AccountFactory:        accountFactory,
-		StoragePruningManager: storagePruning,
-		AddressConverter:      scf.core.AddressPubKeyConverter(),
-		SnapshotsManager:      snapshotManager,
+		Trie:                     merkleTrie,
+		Hasher:                   scf.core.Hasher(),
+		Marshaller:               scf.core.InternalMarshalizer(),
+		AccountFactory:           accountFactory,
+		StoragePruningManager:    storagePruning,
+		AddressConverter:         scf.core.AddressPubKeyConverter(),
+		SnapshotsManager:         snapshotManager,
+		StateChangesCollector:    stateChangesCollector,
 	}
 	peerAdapter, err := state.NewPeerAccountsDB(argsProcessingPeerAccountsDB)
 	if err != nil {

genesis/mock/userAccountMock.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/multiversx/mx-chain-core-go/core"
 	"github.com/multiversx/mx-chain-go/common"
+	"github.com/multiversx/mx-chain-go/state"
 )
 
 // ErrNegativeValue -
@@ -147,8 +148,8 @@ func (uam *UserAccountMock) GetUserName() []byte {
 }
 
 // SaveDirtyData -
-func (uam *UserAccountMock) SaveDirtyData(_ common.Trie) ([]core.TrieData, error) {
-	return nil, nil
+func (uam *UserAccountMock) SaveDirtyData(_ common.Trie) ([]state.DataTrieChange, []core.TrieData, error) {
+	return nil, nil, nil
 }
 
 // IsGuarded -

genesis/process/memoryComponents.go

@@ -34,6 +34,7 @@ func createAccountAdapter(
 		StoragePruningManager: disabled.NewDisabledStoragePruningManager(),
 		AddressConverter:      addressConverter,
 		SnapshotsManager:      disabledState.NewDisabledSnapshotsManager(),
+		StateChangesCollector: state.NewStateChangesCollector(),
 	}
 
 	adb, err := state.NewAccountsDB(args)

integrationTests/state/stateTrie/stateTrie_test.go

@@ -1083,6 +1083,7 @@ func createAccounts(
 		StoragePruningManager: spm,
 		AddressConverter:      &testscommon.PubkeyConverterMock{},
 		SnapshotsManager:      snapshotsManager,
+		StateChangesCollector: state.NewStateChangesCollector(),
 	}
 	adb, _ := state.NewAccountsDB(argsAccountsDB)
 
@@ -2757,6 +2758,7 @@ func createAccountsDBTestSetup() *state.AccountsDB {
 		StoragePruningManager: spm,
 		AddressConverter:      &testscommon.PubkeyConverterMock{},
 		SnapshotsManager:      snapshotsManager,
+		StateChangesCollector: state.NewStateChangesCollector(),
 	}
 	adb, _ := state.NewAccountsDB(argsAccountsDB)
 

integrationTests/testInitializer.go

@@ -487,6 +487,7 @@ func CreateAccountsDBWithEnableEpochsHandler(
 		StoragePruningManager: spm,
 		AddressConverter:      &testscommon.PubkeyConverterMock{},
 		SnapshotsManager:      snapshotsManager,
+		StateChangesCollector: state.NewStateChangesCollector(),
 	}
 	adb, _ := state.NewAccountsDB(args)
 

integrationTests/vm/staking/componentsHolderCreator.go

@@ -27,6 +27,7 @@ import (
 	"github.com/multiversx/mx-chain-go/sharding"
 	"github.com/multiversx/mx-chain-go/sharding/nodesCoordinator"
 	"github.com/multiversx/mx-chain-go/state"
+	disabledState "github.com/multiversx/mx-chain-go/state/disabled"
 	stateFactory "github.com/multiversx/mx-chain-go/state/factory"
 	"github.com/multiversx/mx-chain-go/state/storagePruningManager"
 	"github.com/multiversx/mx-chain-go/state/storagePruningManager/evictionWaitingList"
@@ -215,6 +216,7 @@ func createAccountsDB(
 		StoragePruningManager: spm,
 		AddressConverter:      coreComponents.AddressPubKeyConverter(),
 		SnapshotsManager:      &stateTests.SnapshotsManagerStub{},
+		StateChangesCollector: disabledState.NewDisabledStateChangesCollector(),
 	}
 	adb, _ := state.NewAccountsDB(argsAccountsDb)
 	return adb

process/transaction/metaProcess.go

@@ -123,6 +123,8 @@ func (txProc *metaTxProcessor) ProcessTransaction(tx *transaction.Transaction) (
 		txProc.pubkeyConv,
 	)
 
+	defer txProc.accounts.SetTxHashForLatestStateChanges(txHash)
+
 	err = txProc.checkTxValues(tx, acntSnd, acntDst, false)
 	if err != nil {
 		if errors.Is(err, process.ErrUserNameDoesNotMatchInCrossShardTx) {
@@ -136,6 +138,7 @@ func (txProc *metaTxProcessor) ProcessTransaction(tx *transaction.Transaction) (
 	}
 
 	txType, _ := txProc.txTypeHandler.ComputeTransactionType(tx)
+
 	switch txType {
 	case process.SCDeployment:
 		return txProc.processSCDeployment(tx, tx.SndAddr)

process/transaction/shardProcess.go

@@ -209,6 +209,9 @@ func (txProc *txProcessor) ProcessTransaction(tx *transaction.Transaction) (vmco
 		txProc.pubkeyConv,
 	)
 
+	// TODO refactor to set the tx hash for the following state changes before the processing occurs
+	defer txProc.accounts.SetTxHashForLatestStateChanges(txHash)
+
 	txType, dstShardTxType := txProc.txTypeHandler.ComputeTransactionType(tx)
 	err = txProc.checkTxValues(tx, acntSnd, acntDst, false)
 	if err != nil {

process/transactionEvaluator/simulationAccountsDB.go

@@ -167,6 +167,16 @@ func (r *simulationAccountsDB) GetStackDebugFirstEntry() []byte {
 	return nil
 }
 
+// SetTxHashForLatestStateChanges -
+func (r *simulationAccountsDB) SetTxHashForLatestStateChanges(txHash []byte) {
+	r.originalAccounts.SetTxHashForLatestStateChanges(txHash)
+}
+
+// ResetStateChangesCollector -
+func (r *simulationAccountsDB) ResetStateChangesCollector() []state.StateChangesForTx {
+	return nil
+}
+
 // Close will handle the closing of the underlying components
 func (r *simulationAccountsDB) Close() error {
 	return nil