Rename "AccountStateProvider" to "SelectionSession".

Author: andreibancioiu

testscommon/txcachemocks/accountStateProviderMock.go testscommon/txcachemocks/selectionSessionMock.go

@@ -8,24 +8,24 @@ import (
 	"github.com/multiversx/mx-chain-storage-go/types"
 )
 
-// AccountStateProviderMock -
-type AccountStateProviderMock struct {
+// SelectionSessionMock -
+type SelectionSessionMock struct {
 	mutex sync.Mutex
 
 	AccountStateByAddress map[string]*types.AccountState
 	GetAccountStateCalled func(address []byte) (*types.AccountState, error)
 	IsBadlyGuardedCalled  func(tx data.TransactionHandler) bool
 }
 
-// NewAccountStateProviderMock -
-func NewAccountStateProviderMock() *AccountStateProviderMock {
-	return &AccountStateProviderMock{
+// NewSelectionSessionMock -
+func NewSelectionSessionMock() *SelectionSessionMock {
+	return &SelectionSessionMock{
 		AccountStateByAddress: make(map[string]*types.AccountState),
 	}
 }
 
 // SetNonce -
-func (mock *AccountStateProviderMock) SetNonce(address []byte, nonce uint64) {
+func (mock *SelectionSessionMock) SetNonce(address []byte, nonce uint64) {
 	mock.mutex.Lock()
 	defer mock.mutex.Unlock()
 
@@ -39,7 +39,7 @@ func (mock *AccountStateProviderMock) SetNonce(address []byte, nonce uint64) {
 }
 
 // SetBalance -
-func (mock *AccountStateProviderMock) SetBalance(address []byte, balance *big.Int) {
+func (mock *SelectionSessionMock) SetBalance(address []byte, balance *big.Int) {
 	mock.mutex.Lock()
 	defer mock.mutex.Unlock()
 
@@ -53,7 +53,7 @@ func (mock *AccountStateProviderMock) SetBalance(address []byte, balance *big.In
 }
 
 // GetAccountState -
-func (mock *AccountStateProviderMock) GetAccountState(address []byte) (*types.AccountState, error) {
+func (mock *SelectionSessionMock) GetAccountState(address []byte) (*types.AccountState, error) {
 	mock.mutex.Lock()
 	defer mock.mutex.Unlock()
 
@@ -70,7 +70,7 @@ func (mock *AccountStateProviderMock) GetAccountState(address []byte) (*types.Ac
 }
 
 // IsBadlyGuarded -
-func (mock *AccountStateProviderMock) IsBadlyGuarded(tx data.TransactionHandler) bool {
+func (mock *SelectionSessionMock) IsBadlyGuarded(tx data.TransactionHandler) bool {
 	if mock.IsBadlyGuardedCalled != nil {
 		return mock.IsBadlyGuardedCalled(tx)
 	}
@@ -79,7 +79,7 @@ func (mock *AccountStateProviderMock) IsBadlyGuarded(tx data.TransactionHandler)
 }
 
 // IsInterfaceNil -
-func (mock *AccountStateProviderMock) IsInterfaceNil() bool {
+func (mock *SelectionSessionMock) IsInterfaceNil() bool {
 	return mock == nil
 }
 

txcache/errors.go

@@ -3,6 +3,6 @@ package txcache
 import "errors"
 
 var errNilTxGasHandler = errors.New("nil tx gas handler")
-var errNilAccountStateProvider = errors.New("nil account state provider")
+var errNilSelectionSession = errors.New("nil selection session")
 var errItemAlreadyInCache = errors.New("item already in cache")
 var errEmptyBunchOfTransactions = errors.New("empty bunch of transactions")

txcache/interface.go

@@ -13,8 +13,8 @@ type TxGasHandler interface {
 	IsInterfaceNil() bool
 }
 
-// AccountStateProvider defines the behavior of a component able to provide the state of an account
-type AccountStateProvider interface {
+// SelectionSession provides blockchain information for transaction selection
+type SelectionSession interface {
 	GetAccountState(accountKey []byte) (*types.AccountState, error)
 	IsBadlyGuarded(tx data.TransactionHandler) bool
 	IsInterfaceNil() bool

txcache/selection.go

@@ -5,19 +5,19 @@ import (
 	"time"
 )
 
-func (cache *TxCache) doSelectTransactions(accountStateProvider AccountStateProvider, gasRequested uint64, maxNum int, selectionLoopMaximumDuration time.Duration) (bunchOfTransactions, uint64) {
+func (cache *TxCache) doSelectTransactions(session SelectionSession, gasRequested uint64, maxNum int, selectionLoopMaximumDuration time.Duration) (bunchOfTransactions, uint64) {
 	senders := cache.getSenders()
 	bunches := make([]bunchOfTransactions, 0, len(senders))
 
 	for _, sender := range senders {
 		bunches = append(bunches, sender.getTxs())
 	}
 
-	return selectTransactionsFromBunches(accountStateProvider, bunches, gasRequested, maxNum, selectionLoopMaximumDuration)
+	return selectTransactionsFromBunches(session, bunches, gasRequested, maxNum, selectionLoopMaximumDuration)
 }
 
 // Selection tolerates concurrent transaction additions / removals.
-func selectTransactionsFromBunches(accountStateProvider AccountStateProvider, bunches []bunchOfTransactions, gasRequested uint64, maxNum int, selectionLoopMaximumDuration time.Duration) (bunchOfTransactions, uint64) {
+func selectTransactionsFromBunches(session SelectionSession, bunches []bunchOfTransactions, gasRequested uint64, maxNum int, selectionLoopMaximumDuration time.Duration) (bunchOfTransactions, uint64) {
 	selectedTransactions := make(bunchOfTransactions, 0, initialCapacityOfSelectionSlice)
 
 	// Items popped from the heap are added to "selectedTransactions".
@@ -57,7 +57,7 @@ func selectTransactionsFromBunches(accountStateProvider AccountStateProvider, bu
 			}
 		}
 
-		err := item.requestAccountStateIfNecessary(accountStateProvider)
+		err := item.requestAccountStateIfNecessary(session)
 		if err != nil {
 			// Skip this sender.
 			logSelect.Debug("TxCache.selectTransactionsFromBunches, could not retrieve account state", "sender", item.sender, "err", err)
@@ -71,7 +71,7 @@ func selectTransactionsFromBunches(accountStateProvider AccountStateProvider, bu
 			continue
 		}
 
-		shouldSkipTransaction := detectSkippableTransaction(accountStateProvider, item)
+		shouldSkipTransaction := detectSkippableTransaction(session, item)
 		if shouldSkipTransaction {
 			// Transaction isn't selected, but the sender is still in the game (will contribute with other transactions).
 		} else {
@@ -104,11 +104,11 @@ func detectSkippableSender(item *transactionsHeapItem) bool {
 	return false
 }
 
-func detectSkippableTransaction(accountStateProvider AccountStateProvider, item *transactionsHeapItem) bool {
+func detectSkippableTransaction(session SelectionSession, item *transactionsHeapItem) bool {
 	if item.detectLowerNonce() {
 		return true
 	}
-	if item.detectBadlyGuarded(accountStateProvider) {
+	if item.detectBadlyGuarded(session) {
 		return true
 	}
 	if item.detectNonceDuplicate() {