[BCI-3989][core] - CR methods err when service unstarted

.changeset/rotten-timers-remain.md

@@ -0,0 +1,5 @@
+---
+"chainlink": minor
+---
+
+chainReader methods return err when called and service is not started yet. #internal

core/capabilities/ccip/delegate.go

@@ -289,6 +289,11 @@ func (d *Delegate) getHomeChainContractReader(
 		return nil, types.BoundContract{}, fmt.Errorf("failed to create home chain contract reader: %w", err)
 	}
 
+	err = reader.Start(ctx)
+	if err != nil {
+		return nil, types.BoundContract{}, err
+	}
+
 	reader, ccipConfigBinding, err := bindReader(ctx, reader, d.capabilityConfig.ExternalRegistry().Address(), capabilityLabelledName, capabilityVersion)
 	if err != nil {
 		return nil, types.BoundContract{}, fmt.Errorf("failed to bind home chain contract reader: %w", err)

core/scripts/go.mod

@@ -22,7 +22,7 @@
 	github.com/prometheus/client_golang v1.20.0
 	github.com/shopspring/decimal v1.4.0
 	github.com/smartcontractkit/chainlink-automation v1.0.4
-	github.com/smartcontractkit/chainlink-common v0.2.2-0.20240913161926-ce5d667907ce
+	github.com/smartcontractkit/chainlink-common v0.2.2-0.20240916214706-e7280848cd7b
 	github.com/smartcontractkit/chainlink/v2 v2.0.0-00010101000000-000000000000
 	github.com/smartcontractkit/libocr v0.0.0-20240717100443-f6226e09bee7
 	github.com/spf13/cobra v1.8.1

core/scripts/go.sum

@@ -1083,8 +1083,8 @@ github.com/smartcontractkit/chainlink-automation v1.0.4 h1:iyW181JjKHLNMnDleI8um
 github.com/smartcontractkit/chainlink-automation v1.0.4/go.mod h1:u4NbPZKJ5XiayfKHD/v3z3iflQWqvtdhj13jVZXj/cM=
 github.com/smartcontractkit/chainlink-ccip v0.0.0-20240916150615-85b8aa5fa7e6 h1:cbHlV2CSphQ+ghDye21M8ym0aAO/Y649H2Mg60M2AuE=
 github.com/smartcontractkit/chainlink-ccip v0.0.0-20240916150615-85b8aa5fa7e6/go.mod h1:Lv77O13ZxOdmlvnu2vaUC0Lg+t3JAL+N+9K8dRsgmDI=
-github.com/smartcontractkit/chainlink-common v0.2.2-0.20240913161926-ce5d667907ce h1:qXS0aWiDFDoLRCB+kSGnzp77iYT2luflUyzE5BnNmpY=
-github.com/smartcontractkit/chainlink-common v0.2.2-0.20240913161926-ce5d667907ce/go.mod h1:sjiiPwd4KsYOCf68MwL86EKphdXeT66EY7j53WH5DCc=
+github.com/smartcontractkit/chainlink-common v0.2.2-0.20240916214706-e7280848cd7b h1:7RyN8+dNTN+hjnKfgfEYdRfxqeHTnPq8ILcHn/gOe6k=
+github.com/smartcontractkit/chainlink-common v0.2.2-0.20240916214706-e7280848cd7b/go.mod h1:sjiiPwd4KsYOCf68MwL86EKphdXeT66EY7j53WH5DCc=
 github.com/smartcontractkit/chainlink-cosmos v0.4.1-0.20240911175228-daf2600bb7b7 h1:lTGIOQYLk1Ufn++X/AvZnt6VOcuhste5yp+C157No/Q=
 github.com/smartcontractkit/chainlink-cosmos v0.4.1-0.20240911175228-daf2600bb7b7/go.mod h1:BMYE1vC/pGmdFSsOJdPrAA0/4gZ0Xo0SxTMdGspBtRo=
 github.com/smartcontractkit/chainlink-data-streams v0.0.0-20240906125718-9f0a98d32fbc h1:tRmTlaoAt+7FakMXXgeCuRPmzzBo5jsGpeCVvcU6KMc=

core/services/registrysyncer/syncer.go

@@ -277,6 +277,11 @@ func (s *registrySyncer) Sync(ctx context.Context, isInitialSync bool) error {
 			return err
 		}
 
+		err = reader.Start(ctx)
+		if err != nil {
+			return err
+		}
+
 		s.reader = reader
 	}
 

core/services/registrysyncer/syncer_test.go

@@ -87,7 +87,7 @@ func (c *crFactory) NewContractReader(ctx context.Context, cfg []byte) (types.Co
 		return nil, err
 	}
 
-	return svc, svc.Start(ctx)
+	return svc, nil
 }
 
 func newContractReaderFactory(t *testing.T, simulatedBackend *backends.SimulatedBackend) *crFactory {

core/services/relay/evm/chain_reader.go

@@ -163,17 +163,30 @@ func (cr *chainReader) HealthReport() map[string]error {
 	return map[string]error{cr.Name(): nil}
 }
 
-func (cr *chainReader) GetLatestValue(ctx context.Context, readName string, confidenceLevel primitives.ConfidenceLevel, params any, returnVal any) error {
-	binding, address, err := cr.bindings.GetReader(readName)
-	if err != nil {
-		return err
+func (cr *chainReader) GetLatestValue(ctx context.Context, readName string, confidenceLevel primitives.ConfidenceLevel, params any, returnVal any) (err error) {
+	if ok := cr.StateMachine.IfStarted(func() {
+		binding, address, bindingErr := cr.bindings.GetReader(readName)
+		if bindingErr != nil {
+			err = bindingErr
+			return
+		}
+
+		err = binding.GetLatestValue(ctx, common.HexToAddress(address), confidenceLevel, params, returnVal)
+	}); !ok {
+		return fmt.Errorf("ContractReader should be in Started state before calling GetLatestValue. Current state: %s", cr.StateMachine.State())
 	}
 
-	return binding.GetLatestValue(ctx, common.HexToAddress(address), confidenceLevel, params, returnVal)
+	return err
 }
 
-func (cr *chainReader) BatchGetLatestValues(ctx context.Context, request commontypes.BatchGetLatestValuesRequest) (commontypes.BatchGetLatestValuesResult, error) {
-	return cr.bindings.BatchGetLatestValues(ctx, request)
+func (cr *chainReader) BatchGetLatestValues(ctx context.Context, request commontypes.BatchGetLatestValuesRequest) (res commontypes.BatchGetLatestValuesResult, err error) {
+	if ok := cr.StateMachine.IfStarted(func() {
+		res, err = cr.bindings.BatchGetLatestValues(ctx, request)
+	}); !ok {
+		return nil, fmt.Errorf("ContractReader should be in Started state before calling BatchGetLatestValues. Current state: %s", cr.StateMachine.State())
+	}
+
+	return res, err
 }
 
 func (cr *chainReader) Bind(ctx context.Context, bindings []commontypes.BoundContract) error {
@@ -190,13 +203,20 @@ func (cr *chainReader) QueryKey(
 	filter query.KeyFilter,
 	limitAndSort query.LimitAndSort,
 	sequenceDataType any,
-) ([]commontypes.Sequence, error) {
-	binding, address, err := cr.bindings.GetReader(contract.ReadIdentifier(filter.Key))
-	if err != nil {
-		return nil, err
+) (seq []commontypes.Sequence, err error) {
+	if ok := cr.StateMachine.IfStarted(func() {
+		binding, address, bindingErr := cr.bindings.GetReader(contract.ReadIdentifier(filter.Key))
+		if bindingErr != nil {
+			seq, err = nil, bindingErr
+			return
+		}
+
+		seq, err = binding.QueryKey(ctx, common.HexToAddress(address), filter, limitAndSort, sequenceDataType)
+	}); !ok {
+		return nil, fmt.Errorf("ContractReader should be in Started state before calling QueryKey. Current state: %s", cr.StateMachine.State())
 	}
 
-	return binding.QueryKey(ctx, common.HexToAddress(address), filter, limitAndSort, sequenceDataType)
+	return seq, err
 }
 
 func (cr *chainReader) CreateContractType(readIdentifier string, forEncoding bool) (any, error) {

core/services/relay/evm/evmtesting/chain_components_interface_tester.go

@@ -75,36 +75,58 @@ type EVMChainComponentsInterfaceTester[T TestingT[T]] struct {
 	gasEstimator      gas.EvmFeeEstimator
 }
 
-func (it *EVMChainComponentsInterfaceTester[T]) Setup(t T) {
+func (it *EVMChainComponentsInterfaceTester[T]) Setup(t T, startCR bool) {
+	it.setChainReader(t, startCR)
+	// cw always will return started
+	it.setChainWriter(t)
+	it.deployNewContracts(t)
+}
+
+func (it *EVMChainComponentsInterfaceTester[T]) setChainReader(t T, started bool) {
 	t.Cleanup(func() {
 		// DB may be closed by the test already, ignore errors
-		if it.cr != nil {
+		if started {
 			_ = it.cr.Close()
 		}
 		it.cr = nil
+	})
 
-		if it.dirtyContracts {
-			it.contractTesters = nil
-		}
+	it.setChainReaderConfig(t)
 
-		if it.cw != nil {
-			_ = it.cw.Close()
-		}
-		it.cw = nil
-	})
+	ctx := it.Helper.Context(t)
 
-	// can re-use the same chain for tests, just make new contract for each test
-	if it.client != nil {
-		it.deployNewContracts(t)
-		return
+	lggr := logger.NullLogger
+	db := it.Helper.NewSqlxDB(t)
+	lpOpts := logpoller.Opts{
+		PollPeriod:               time.Millisecond,
+		FinalityDepth:            finalityDepth,
+		BackfillBatchSize:        1,
+		RpcBatchSize:             1,
+		KeepFinalizedBlocksDepth: 10000,
 	}
+	ht := headtracker.NewSimulatedHeadTracker(it.Helper.Client(t), lpOpts.UseFinalityTag, lpOpts.FinalityDepth)
+	lp := logpoller.NewLogPoller(logpoller.NewORM(it.Helper.ChainID(), db, lggr), it.Helper.Client(t), lggr, ht, lpOpts)
+	require.NoError(t, lp.Start(ctx))
 
-	// Need to separate accounts to ensure the nonce doesn't get misaligned after the
-	// contract deployments.
-	accounts := it.Helper.Accounts(t)
-	it.deployerAuth = accounts[0]
-	it.senderAuth = accounts[1]
+	// encode and decode the config to ensure the test covers type issues
+	confBytes, err := json.Marshal(it.chainReaderConfig)
+	require.NoError(t, err)
 
+	conf, err := types.ChainReaderConfigFromBytes(confBytes)
+	require.NoError(t, err)
+
+	it.client = it.Helper.ChainReaderEVMClient(ctx, t, ht, conf)
+	cr, err := evm.NewChainReaderService(ctx, lggr, lp, ht, it.client, conf)
+	require.NoError(t, err)
+
+	if started {
+		require.NoError(t, cr.Start(ctx))
+	}
+
+	it.cr = cr
+}
+
+func (it *EVMChainComponentsInterfaceTester[T]) setChainReaderConfig(_ T) {
 	testStruct := CreateTestStruct[T](0, it)
 
 	methodTakingLatestParamsReturningTestStructConfig := types.ChainReaderDefinition{
@@ -204,9 +226,41 @@ func (it *EVMChainComponentsInterfaceTester[T]) Setup(t T) {
 			},
 		},
 	}
-	it.GetContractReader(t)
+}
+
+func (it *EVMChainComponentsInterfaceTester[T]) GetContractReader(t T) clcommontypes.ContractReader {
+	return it.cr
+}
+
+func (it *EVMChainComponentsInterfaceTester[T]) setChainWriter(t T) {
+	t.Cleanup(func() {
+		// DB may be closed by the test already, ignore errors
+		_ = it.cw.Close()
+		it.cw = nil
+	})
+
+	it.setAccounts(t)
 	it.txm = it.Helper.TXM(t, it.client)
+	it.setChainWriterConfig(t)
+
+	ctx := it.Helper.Context(t)
 
+	cw, err := evm.NewChainWriterService(logger.NullLogger, it.client, it.txm, it.gasEstimator, it.chainWriterConfig)
+	require.NoError(t, err)
+	require.NoError(t, cw.Start(ctx))
+
+	it.cw = it.Helper.WrappedChainWriter(cw, it.client)
+}
+
+func (it *EVMChainComponentsInterfaceTester[T]) setAccounts(t T) {
+	// Need to separate accounts to ensure the nonce doesn't get misaligned after the
+	// contract deployments.
+	accounts := it.Helper.Accounts(t)
+	it.deployerAuth = accounts[0]
+	it.senderAuth = accounts[1]
+}
+
+func (it *EVMChainComponentsInterfaceTester[T]) setChainWriterConfig(t T) {
 	it.chainWriterConfig = types.ChainWriterConfig{
 		Contracts: map[string]*types.ContractConfig{
 			AnyContractName: {
@@ -273,7 +327,10 @@ func (it *EVMChainComponentsInterfaceTester[T]) Setup(t T) {
 		},
 		MaxGasPrice: assets.NewWei(big.NewInt(1000000000000000000)),
 	}
-	it.deployNewContracts(t)
+}
+
+func (it *EVMChainComponentsInterfaceTester[T]) GetChainWriter(t T) clcommontypes.ChainWriter {
+	return it.cw
 }
 
 func (it *EVMChainComponentsInterfaceTester[T]) Name() string {
@@ -287,61 +344,10 @@ func (it *EVMChainComponentsInterfaceTester[T]) GetAccountBytes(i int) []byte {
 	return account[:]
 }
 
-func (it *EVMChainComponentsInterfaceTester[T]) GetContractReader(t T) clcommontypes.ContractReader {
-	ctx := it.Helper.Context(t)
-	if it.cr != nil {
-		return it.cr
-	}
-
-	lggr := logger.NullLogger
-	db := it.Helper.NewSqlxDB(t)
-	lpOpts := logpoller.Opts{
-		PollPeriod:               time.Millisecond,
-		FinalityDepth:            finalityDepth,
-		BackfillBatchSize:        1,
-		RpcBatchSize:             1,
-		KeepFinalizedBlocksDepth: 10000,
-	}
-	ht := headtracker.NewSimulatedHeadTracker(it.Helper.Client(t), lpOpts.UseFinalityTag, lpOpts.FinalityDepth)
-	lp := logpoller.NewLogPoller(logpoller.NewORM(it.Helper.ChainID(), db, lggr), it.Helper.Client(t), lggr, ht, lpOpts)
-	require.NoError(t, lp.Start(ctx))
-
-	// encode and decode the config to ensure the test covers type issues
-	confBytes, err := json.Marshal(it.chainReaderConfig)
-	require.NoError(t, err)
-
-	conf, err := types.ChainReaderConfigFromBytes(confBytes)
-	require.NoError(t, err)
-
-	cwh := it.Helper.ChainReaderEVMClient(ctx, t, ht, conf)
-	it.client = cwh
-
-	cr, err := evm.NewChainReaderService(ctx, lggr, lp, ht, it.client, conf)
-	require.NoError(t, err)
-	require.NoError(t, cr.Start(ctx))
-	it.cr = cr
-	return cr
-}
-
 // This function is no longer necessary for Simulated Backend or Testnet tests.
 func (it *EVMChainComponentsInterfaceTester[T]) GenerateBlocksTillConfidenceLevel(t T, contractName, readName string, confidenceLevel primitives.ConfidenceLevel) {
 }
 
-func (it *EVMChainComponentsInterfaceTester[T]) GetChainWriter(t T) clcommontypes.ChainWriter {
-	ctx := it.Helper.Context(t)
-	if it.cw != nil {
-		return it.cw
-	}
-
-	cw, err := evm.NewChainWriterService(logger.NullLogger, it.client, it.txm, it.gasEstimator, it.chainWriterConfig)
-	require.NoError(t, err)
-	it.cw = it.Helper.WrappedChainWriter(cw, it.client)
-
-	require.NoError(t, err)
-	require.NoError(t, cw.Start(ctx))
-	return it.cw
-}
-
 func (it *EVMChainComponentsInterfaceTester[T]) GetBindings(_ T) []clcommontypes.BoundContract {
 	return []clcommontypes.BoundContract{
 		{Name: AnyContractName, Address: it.address},
@@ -378,6 +384,12 @@ func (it *EVMChainComponentsInterfaceTester[T]) AwaitTx(t T, tx *gethtypes.Trans
 }
 
 func (it *EVMChainComponentsInterfaceTester[T]) deployNewContracts(t T) {
+	t.Cleanup(func() {
+		if it.dirtyContracts {
+			it.contractTesters = nil
+		}
+	})
+
 	// First test deploy both contracts, otherwise only deploy contracts if cleanup decides that we need to.
 	if it.address == "" || it.contractTesters == nil {
 		it.contractTesters = make(map[string]*chain_reader_tester.ChainReaderTester, 2)

core/services/relay/evm/evmtesting/run_tests.go

@@ -27,7 +27,7 @@ func RunContractReaderEvmTests[T TestingT[T]](t T, it *EVMChainComponentsInterfa
 	RunContractReaderInterfaceTests[T](t, it, false)
 
 	t.Run("Dynamically typed topics can be used to filter and have type correct in return", func(t T) {
-		it.Setup(t)
+		it.Setup(t, true)
 
 		anyString := "foo"
 		ctx := it.Helper.Context(t)
@@ -64,7 +64,7 @@ func RunContractReaderEvmTests[T TestingT[T]](t T, it *EVMChainComponentsInterfa
 	})
 
 	t.Run("Multiple topics can filter together", func(t T) {
-		it.Setup(t)
+		it.Setup(t, true)
 		ctx := it.Helper.Context(t)
 		cr := it.GetContractReader(t)
 		bindings := it.GetBindings(t)
@@ -95,7 +95,7 @@ func RunContractReaderEvmTests[T TestingT[T]](t T, it *EVMChainComponentsInterfa
 	})
 
 	t.Run("Filtering can be done on indexed topics that get hashed", func(t T) {
-		it.Setup(t)
+		it.Setup(t, true)
 
 		cr := it.GetContractReader(t)
 		ctx := it.Helper.Context(t)
@@ -130,7 +130,7 @@ func RunContractReaderEvmTests[T TestingT[T]](t T, it *EVMChainComponentsInterfa
 	})
 
 	t.Run("Bind returns error on missing contract at address", func(t T) {
-		it.Setup(t)
+		it.Setup(t, false)
 
 		addr := common.BigToAddress(big.NewInt(42))
 		reader := it.GetContractReader(t)

core/services/relay/evm/write_target.go

@@ -47,6 +47,11 @@ func NewWriteTarget(ctx context.Context, relayer *Relayer, chain legacyevm.Chain
 		return nil, err
 	}
 
+	err = cr.Start(ctx)
+	if err != nil {
+		return nil, err
+	}
+
 	chainWriterConfig := relayevmtypes.ChainWriterConfig{
 		Contracts: map[string]*relayevmtypes.ContractConfig{
 			"forwarder": {

go.mod

@@ -75,7 +75,7 @@
 	github.com/smartcontractkit/chain-selectors v1.0.23
 	github.com/smartcontractkit/chainlink-automation v1.0.4
 	github.com/smartcontractkit/chainlink-ccip v0.0.0-20240916150615-85b8aa5fa7e6
-	github.com/smartcontractkit/chainlink-common v0.2.2-0.20240913161926-ce5d667907ce
+	github.com/smartcontractkit/chainlink-common v0.2.2-0.20240916214706-e7280848cd7b
 	github.com/smartcontractkit/chainlink-cosmos v0.4.1-0.20240911175228-daf2600bb7b7
 	github.com/smartcontractkit/chainlink-data-streams v0.0.0-20240906125718-9f0a98d32fbc
 	github.com/smartcontractkit/chainlink-feeds v0.0.0-20240910155501-42f20443189f

go.sum

@@ -1044,8 +1044,8 @@ github.com/smartcontractkit/chainlink-automation v1.0.4 h1:iyW181JjKHLNMnDleI8um
 github.com/smartcontractkit/chainlink-automation v1.0.4/go.mod h1:u4NbPZKJ5XiayfKHD/v3z3iflQWqvtdhj13jVZXj/cM=
 github.com/smartcontractkit/chainlink-ccip v0.0.0-20240916150615-85b8aa5fa7e6 h1:cbHlV2CSphQ+ghDye21M8ym0aAO/Y649H2Mg60M2AuE=
 github.com/smartcontractkit/chainlink-ccip v0.0.0-20240916150615-85b8aa5fa7e6/go.mod h1:Lv77O13ZxOdmlvnu2vaUC0Lg+t3JAL+N+9K8dRsgmDI=
-github.com/smartcontractkit/chainlink-common v0.2.2-0.20240913161926-ce5d667907ce h1:qXS0aWiDFDoLRCB+kSGnzp77iYT2luflUyzE5BnNmpY=
-github.com/smartcontractkit/chainlink-common v0.2.2-0.20240913161926-ce5d667907ce/go.mod h1:sjiiPwd4KsYOCf68MwL86EKphdXeT66EY7j53WH5DCc=
+github.com/smartcontractkit/chainlink-common v0.2.2-0.20240916214706-e7280848cd7b h1:7RyN8+dNTN+hjnKfgfEYdRfxqeHTnPq8ILcHn/gOe6k=
+github.com/smartcontractkit/chainlink-common v0.2.2-0.20240916214706-e7280848cd7b/go.mod h1:sjiiPwd4KsYOCf68MwL86EKphdXeT66EY7j53WH5DCc=
 github.com/smartcontractkit/chainlink-cosmos v0.4.1-0.20240911175228-daf2600bb7b7 h1:lTGIOQYLk1Ufn++X/AvZnt6VOcuhste5yp+C157No/Q=
 github.com/smartcontractkit/chainlink-cosmos v0.4.1-0.20240911175228-daf2600bb7b7/go.mod h1:BMYE1vC/pGmdFSsOJdPrAA0/4gZ0Xo0SxTMdGspBtRo=
 github.com/smartcontractkit/chainlink-data-streams v0.0.0-20240906125718-9f0a98d32fbc h1:tRmTlaoAt+7FakMXXgeCuRPmzzBo5jsGpeCVvcU6KMc=