refactor validator into own module

Author: peterargue

access/ratelimit/limiter.go

@@ -0,0 +1,24 @@
+package ratelimit
+
+import (
+	"github.com/onflow/flow-go/model/flow"
+)
+
+// RateLimiter is an interface for checking if an address is rate limited.
+// By convention, the address used is the payer field of a transaction.
+// This rate limiter is applied when a transaction is first received by a
+// node, meaning that if a transaction is rate-limited it will be dropped.
+type RateLimiter interface {
+	// IsRateLimited returns true if the address is rate limited
+	IsRateLimited(address flow.Address) bool
+}
+
+type NoopLimiter struct{}
+
+func NewNoopLimiter() *NoopLimiter {
+	return &NoopLimiter{}
+}
+
+func (l *NoopLimiter) IsRateLimited(address flow.Address) bool {
+	return false
+}

access/errors.go access/validator/errors.go

@@ -1,4 +1,4 @@
-package access
+package validator
 
 import (
 	"errors"

access/validator.go access/validator/validator.go

@@ -1,4 +1,4 @@
-package access
+package validator
 
 import (
 	"context"
@@ -13,6 +13,7 @@ import (
 	"github.com/onflow/crypto"
 	"github.com/onflow/flow-core-contracts/lib/go/templates"
 
+	"github.com/onflow/flow-go/access/ratelimit"
 	cadenceutils "github.com/onflow/flow-go/access/utils"
 	"github.com/onflow/flow-go/fvm"
 	"github.com/onflow/flow-go/fvm/systemcontracts"
@@ -81,25 +82,6 @@ func (b *ProtocolStateBlocks) IndexedHeight() (uint64, error) {
 	return 0, IndexReporterNotInitialized
 }
 
-// RateLimiter is an interface for checking if an address is rate limited.
-// By convention, the address used is the payer field of a transaction.
-// This rate limiter is applied when a transaction is first received by a
-// node, meaning that if a transaction is rate-limited it will be dropped.
-type RateLimiter interface {
-	// IsRateLimited returns true if the address is rate limited
-	IsRateLimited(address flow.Address) bool
-}
-
-type NoopLimiter struct{}
-
-func NewNoopLimiter() *NoopLimiter {
-	return &NoopLimiter{}
-}
-
-func (l *NoopLimiter) IsRateLimited(address flow.Address) bool {
-	return false
-}
-
 // PayerBalanceMode represents the mode for checking the payer's balance
 // when validating transactions. It controls whether and how the balance
 // check is performed during transaction validation.
@@ -175,7 +157,7 @@ type TransactionValidator struct {
 	chain                        flow.Chain // for checking validity of addresses
 	options                      TransactionValidationOptions
 	serviceAccountAddress        flow.Address
-	limiter                      RateLimiter
+	limiter                      ratelimit.RateLimiter
 	scriptExecutor               execution.ScriptExecutor
 	verifyPayerBalanceScript     []byte
 	transactionValidationMetrics module.TransactionValidationMetrics
@@ -201,7 +183,7 @@ func NewTransactionValidator(
 		chain:                        chain,
 		options:                      options,
 		serviceAccountAddress:        chain.ServiceAddress(),
-		limiter:                      NewNoopLimiter(),
+		limiter:                      ratelimit.NewNoopLimiter(),
 		scriptExecutor:               executor,
 		verifyPayerBalanceScript:     templates.GenerateVerifyPayerBalanceForTxExecution(env),
 		transactionValidationMetrics: transactionValidationMetrics,
@@ -217,7 +199,7 @@ func NewTransactionValidatorWithLimiter(
 	chain flow.Chain,
 	options TransactionValidationOptions,
 	transactionValidationMetrics module.TransactionValidationMetrics,
-	rateLimiter RateLimiter,
+	rateLimiter ratelimit.RateLimiter,
 ) *TransactionValidator {
 	txValidator := &TransactionValidator{
 		blocks:                       blocks,

access/validator_test.go access/validator/validator_test.go

@@ -1,4 +1,4 @@
-package access_test
+package validator_test
 
 import (
 	"context"
@@ -13,8 +13,8 @@ import (
 
 	jsoncdc "github.com/onflow/cadence/encoding/json"
 
-	"github.com/onflow/flow-go/access"
 	accessmock "github.com/onflow/flow-go/access/mock"
+	"github.com/onflow/flow-go/access/validator"
 	"github.com/onflow/flow-go/fvm"
 	"github.com/onflow/flow-go/model/flow"
 	"github.com/onflow/flow-go/module"
@@ -32,7 +32,7 @@ type TransactionValidatorSuite struct {
 	blocks           *accessmock.Blocks
 	header           *flow.Header
 	chain            flow.Chain
-	validatorOptions access.TransactionValidationOptions
+	validatorOptions validator.TransactionValidationOptions
 	metrics          module.TransactionValidationMetrics
 }
 
@@ -57,8 +57,8 @@ func (s *TransactionValidatorSuite) SetupTest() {
 		Return(s.header, nil)
 
 	s.chain = flow.Testnet.Chain()
-	s.validatorOptions = access.TransactionValidationOptions{
-		CheckPayerBalanceMode:  access.EnforceCheck,
+	s.validatorOptions = validator.TransactionValidationOptions{
+		CheckPayerBalanceMode:  validator.EnforceCheck,
 		MaxTransactionByteSize: flow.DefaultMaxTransactionByteSize,
 		MaxCollectionByteSize:  flow.DefaultMaxCollectionByteSize,
 	}
@@ -97,7 +97,7 @@ func (s *TransactionValidatorSuite) TestTransactionValidator_ScriptExecutorInter
 		Return(nil, errors.New("script executor internal error")).
 		Once()
 
-	validator, err := access.NewTransactionValidator(s.blocks, s.chain, s.metrics, s.validatorOptions, scriptExecutor)
+	validator, err := validator.NewTransactionValidator(s.blocks, s.chain, s.metrics, s.validatorOptions, scriptExecutor)
 	assert.NoError(s.T(), err)
 	assert.NotNil(s.T(), validator)
 
@@ -128,7 +128,7 @@ func (s *TransactionValidatorSuite) TestTransactionValidator_SufficientBalance()
 		Return(actualResponse, nil).
 		Once()
 
-	validator, err := access.NewTransactionValidator(s.blocks, s.chain, s.metrics, s.validatorOptions, scriptExecutor)
+	validator, err := validator.NewTransactionValidator(s.blocks, s.chain, s.metrics, s.validatorOptions, scriptExecutor)
 	assert.NoError(s.T(), err)
 	assert.NotNil(s.T(), validator)
 
@@ -164,7 +164,7 @@ func (s *TransactionValidatorSuite) TestTransactionValidator_InsufficientBalance
 
 	validateTx := func() error {
 		txBody := unittest.TransactionBodyFixture()
-		validator, err := access.NewTransactionValidator(s.blocks, s.chain, s.metrics, s.validatorOptions, scriptExecutor)
+		validator, err := validator.NewTransactionValidator(s.blocks, s.chain, s.metrics, s.validatorOptions, scriptExecutor)
 		assert.NoError(s.T(), err)
 		assert.NotNil(s.T(), validator)
 
@@ -174,15 +174,15 @@ func (s *TransactionValidatorSuite) TestTransactionValidator_InsufficientBalance
 	s.Run("with enforce check", func() {
 		err := validateTx()
 
-		expectedError := access.InsufficientBalanceError{
+		expectedError := validator.InsufficientBalanceError{
 			Payer:           unittest.AddressFixture(),
 			RequiredBalance: requiredBalance,
 		}
 		assert.ErrorIs(s.T(), err, expectedError)
 	})
 
 	s.Run("with warn check", func() {
-		s.validatorOptions.CheckPayerBalanceMode = access.WarnCheck
+		s.validatorOptions.CheckPayerBalanceMode = validator.WarnCheck
 		err := validateTx()
 		assert.NoError(s.T(), err)
 	})
@@ -198,7 +198,7 @@ func (s *TransactionValidatorSuite) TestTransactionValidator_SealedIndexedHeight
 		On("IndexedHeight").
 		Return(indexedHeight, nil)
 
-	validator, err := access.NewTransactionValidator(s.blocks, s.chain, s.metrics, s.validatorOptions, scriptExecutor)
+	validator, err := validator.NewTransactionValidator(s.blocks, s.chain, s.metrics, s.validatorOptions, scriptExecutor)
 	assert.NoError(s.T(), err)
 	assert.NotNil(s.T(), validator)
 

cmd/access/node_builder/access_node_builder.go

@@ -27,7 +27,7 @@ import (
 	"google.golang.org/grpc/credentials"
 	"google.golang.org/grpc/credentials/insecure"
 
-	accessNode "github.com/onflow/flow-go/access"
+	txvalidator "github.com/onflow/flow-go/access/validator"
 	"github.com/onflow/flow-go/admin/commands"
 	stateSyncCommands "github.com/onflow/flow-go/admin/commands/state_synchronization"
 	storageCommands "github.com/onflow/flow-go/admin/commands/storage"
@@ -290,7 +290,7 @@ func DefaultAccessNodeConfig() *AccessNodeConfig {
 		registerCacheType:                    pstorage.CacheTypeTwoQueue.String(),
 		registerCacheSize:                    0,
 		programCacheSize:                     0,
-		checkPayerBalanceMode:                accessNode.Disabled.String(),
+		checkPayerBalanceMode:                txvalidator.Disabled.String(),
 		versionControlEnabled:                true,
 		storeTxResultErrorMessages:           false,
 		stopControlEnabled:                   false,
@@ -1538,7 +1538,7 @@ func (builder *FlowAccessNodeBuilder) extraFlags() {
 			}
 		}
 
-		if builder.checkPayerBalanceMode != accessNode.Disabled.String() && !builder.executionDataIndexingEnabled {
+		if builder.checkPayerBalanceMode != txvalidator.Disabled.String() && !builder.executionDataIndexingEnabled {
 			return errors.New("execution-data-indexing-enabled must be set if check-payer-balance is enabled")
 		}
 
@@ -2004,7 +2004,7 @@ func (builder *FlowAccessNodeBuilder) Build() (cmd.Node, error) {
 				indexReporter = builder.Reporter
 			}
 
-			checkPayerBalanceMode, err := accessNode.ParsePayerBalanceMode(builder.checkPayerBalanceMode)
+			checkPayerBalanceMode, err := txvalidator.ParsePayerBalanceMode(builder.checkPayerBalanceMode)
 			if err != nil {
 				return nil, fmt.Errorf("could not parse payer balance mode: %w", err)
 

engine/access/rpc/backend/backend.go

@@ -12,6 +12,7 @@ import (
 	"github.com/rs/zerolog"
 
 	"github.com/onflow/flow-go/access"
+	"github.com/onflow/flow-go/access/validator"
 	"github.com/onflow/flow-go/cmd/build"
 	"github.com/onflow/flow-go/engine/access/index"
 	"github.com/onflow/flow-go/engine/access/rpc/connection"
@@ -100,7 +101,7 @@ type Params struct {
 	TxResultCacheSize     uint
 	ScriptExecutor        execution.ScriptExecutor
 	ScriptExecutionMode   IndexQueryMode
-	CheckPayerBalanceMode access.PayerBalanceMode
+	CheckPayerBalanceMode validator.PayerBalanceMode
 	EventQueryMode        IndexQueryMode
 	BlockTracker          subscription.BlockTracker
 	SubscriptionHandler   *subscription.SubscriptionHandler
@@ -274,13 +275,13 @@ func configureTransactionValidator(
 	indexReporter state_synchronization.IndexReporter,
 	transactionMetrics module.TransactionValidationMetrics,
 	executor execution.ScriptExecutor,
-	checkPayerBalanceMode access.PayerBalanceMode,
-) (*access.TransactionValidator, error) {
-	return access.NewTransactionValidator(
-		access.NewProtocolStateBlocks(state, indexReporter),
+	checkPayerBalanceMode validator.PayerBalanceMode,
+) (*validator.TransactionValidator, error) {
+	return validator.NewTransactionValidator(
+		validator.NewProtocolStateBlocks(state, indexReporter),
 		chainID.Chain(),
 		transactionMetrics,
-		access.TransactionValidationOptions{
+		validator.TransactionValidationOptions{
 			Expiry:                       flow.DefaultTransactionExpiry,
 			ExpiryBuffer:                 flow.DefaultTransactionExpiryBuffer,
 			AllowEmptyReferenceBlockID:   false,

engine/access/rpc/backend/backend_transactions.go

@@ -15,6 +15,7 @@ import (
 	"google.golang.org/grpc/status"
 
 	"github.com/onflow/flow-go/access"
+	"github.com/onflow/flow-go/access/validator"
 	"github.com/onflow/flow-go/engine/access/rpc/connection"
 	"github.com/onflow/flow-go/engine/common/rpc"
 	commonrpc "github.com/onflow/flow-go/engine/common/rpc"
@@ -38,7 +39,7 @@ type backendTransactions struct {
 	txResultErrorMessages storage.TransactionResultErrorMessages
 	chainID               flow.ChainID
 	transactionMetrics    module.TransactionMetrics
-	transactionValidator  *access.TransactionValidator
+	transactionValidator  *validator.TransactionValidator
 	retry                 *Retry
 	connFactory           connection.ConnectionFactory
 
@@ -352,8 +353,8 @@ func (b *backendTransactions) GetTransactionResult(
 // retrieveBlock function returns a block based on the input argument. The block ID lookup has the highest priority,
 // followed by the collection ID lookup. If both are missing, the default lookup by transaction ID is performed.
 func (b *backendTransactions) retrieveBlock(
-	// the requested block or collection was not found. If looking up the block based solely on the txID returns
-	// not found, then no error is returned.
+// the requested block or collection was not found. If looking up the block based solely on the txID returns
+// not found, then no error is returned.
 	blockID flow.Identifier,
 	collectionID flow.Identifier,
 	txID flow.Identifier,

engine/collection/ingest/engine.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/rs/zerolog"
 
-	"github.com/onflow/flow-go/access"
+	"github.com/onflow/flow-go/access/validator"
 	"github.com/onflow/flow-go/engine"
 	"github.com/onflow/flow-go/engine/common/fifoqueue"
 	"github.com/onflow/flow-go/model/flow"
@@ -38,7 +38,7 @@ type Engine struct {
 	pendingTransactions  engine.MessageStore
 	messageHandler       *engine.MessageHandler
 	pools                *epochs.TransactionPools
-	transactionValidator *access.TransactionValidator
+	transactionValidator *validator.TransactionValidator
 
 	config Config
 }
@@ -60,10 +60,10 @@ func New(
 
 	logger := log.With().Str("engine", "ingest").Logger()
 
-	transactionValidator := access.NewTransactionValidatorWithLimiter(
-		access.NewProtocolStateBlocks(state, nil),
+	transactionValidator := validator.NewTransactionValidatorWithLimiter(
+		validator.NewProtocolStateBlocks(state, nil),
 		chain,
-		access.TransactionValidationOptions{
+		validator.TransactionValidationOptions{
 			Expiry:                 flow.DefaultTransactionExpiry,
 			ExpiryBuffer:           config.ExpiryBuffer,
 			MaxGasLimit:            config.MaxGasLimit,