Merge branch 'develop' into BCFR-945-improve-contract-reader-logs

.changeset/nervous-books-push.md

@@ -0,0 +1,5 @@
+---
+"chainlink": minor
+---
+
+#internal Updated QueryKey to be able to do advanced queries on contract event data words

.changeset/tidy-apricots-care.md

@@ -0,0 +1,5 @@
+---
+"chainlink": minor
+---
+
+#added Pass the home chain selector to the commit plugin factory

contracts/.changeset/tall-donkeys-flow.md

@@ -0,0 +1,10 @@
+---
+'@chainlink/contracts': minor
+---
+
+#internal Updated ChainReaderTester to include dynamic and static nested structs in TestStruct
+
+
+PR issue: BCFR-44
+
+Solidity Review issue: BCFR-957

contracts/src/v0.8/shared/test/helpers/ChainReaderTester.sol

@@ -10,29 +10,41 @@ struct TestStruct {
   address Account;
   address[] Accounts;
   int192 BigField;
-  MidLevelTestStruct NestedStruct;
+  MidLevelDynamicTestStruct NestedDynamicStruct;
+  MidLevelStaticTestStruct NestedStaticStruct;
 }
 
-struct MidLevelTestStruct {
+struct MidLevelDynamicTestStruct {
   bytes2 FixedBytes;
-  InnerTestStruct Inner;
+  InnerDynamicTestStruct Inner;
 }
 
-struct InnerTestStruct {
+struct InnerDynamicTestStruct {
   int64 IntVal;
   string S;
 }
 
+struct MidLevelStaticTestStruct {
+  bytes2 FixedBytes;
+  InnerStaticTestStruct Inner;
+}
+
+struct InnerStaticTestStruct {
+  int64 IntVal;
+  address A;
+}
+
 contract ChainReaderTester {
   event Triggered(
     int32 indexed field,
     uint8 oracleId,
+    MidLevelDynamicTestStruct nestedDynamicStruct,
+    MidLevelStaticTestStruct nestedStaticStruct,
     uint8[32] oracleIds,
     address Account,
     address[] Accounts,
     string differentField,
-    int192 bigField,
-    MidLevelTestStruct nestedStruct
+    int192 bigField
   );
 
   event TriggeredEventWithDynamicTopic(string indexed fieldHash, string field);
@@ -61,9 +73,22 @@ contract ChainReaderTester {
     address account,
     address[] calldata accounts,
     int192 bigField,
-    MidLevelTestStruct calldata nestedStruct
+    MidLevelDynamicTestStruct calldata nestedDynamicStruct,
+    MidLevelStaticTestStruct calldata nestedStaticStruct
   ) public {
-    s_seen.push(TestStruct(field, differentField, oracleId, oracleIds, account, accounts, bigField, nestedStruct));
+    s_seen.push(
+      TestStruct(
+        field,
+        differentField,
+        oracleId,
+        oracleIds,
+        account,
+        accounts,
+        bigField,
+        nestedDynamicStruct,
+        nestedStaticStruct
+      )
+    );
   }
 
   function setAlterablePrimitiveValue(uint64 value) public {
@@ -78,9 +103,21 @@ contract ChainReaderTester {
     address account,
     address[] calldata accounts,
     int192 bigField,
-    MidLevelTestStruct calldata nestedStruct
+    MidLevelDynamicTestStruct calldata nestedDynamicStruct,
+    MidLevelStaticTestStruct calldata nestedStaticStruct
   ) public pure returns (TestStruct memory) {
-    return TestStruct(field, differentField, oracleId, oracleIds, account, accounts, bigField, nestedStruct);
+    return
+      TestStruct(
+        field,
+        differentField,
+        oracleId,
+        oracleIds,
+        account,
+        accounts,
+        bigField,
+        nestedDynamicStruct,
+        nestedStaticStruct
+      );
   }
 
   function getElementAtIndex(uint256 i) public view returns (TestStruct memory) {
@@ -110,14 +147,25 @@ contract ChainReaderTester {
   function triggerEvent(
     int32 field,
     uint8 oracleId,
+    MidLevelDynamicTestStruct calldata nestedDynamicStruct,
+    MidLevelStaticTestStruct calldata nestedStaticStruct,
     uint8[32] calldata oracleIds,
     address account,
     address[] calldata accounts,
     string calldata differentField,
-    int192 bigField,
-    MidLevelTestStruct calldata nestedStruct
+    int192 bigField
   ) public {
-    emit Triggered(field, oracleId, oracleIds, account, accounts, differentField, bigField, nestedStruct);
+    emit Triggered(
+      field,
+      oracleId,
+      nestedDynamicStruct,
+      nestedStaticStruct,
+      oracleIds,
+      account,
+      accounts,
+      differentField,
+      bigField
+    );
   }
 
   function triggerEventWithDynamicTopic(string calldata field) public {

core/capabilities/ccip/configs/evm/contract_reader.go

@@ -28,8 +28,12 @@ var (
 	nonceManagerABI         = evmtypes.MustGetABI(nonce_manager.NonceManagerABI)
 	priceFeedABI            = evmtypes.MustGetABI(aggregator_v3_interface.AggregatorV3InterfaceABI)
 	rmnRemoteABI            = evmtypes.MustGetABI(rmn_remote.RMNRemoteABI)
+	rmnHomeABI              = evmtypes.MustGetABI(rmnHomeString)
 )
 
+// TODO: replace with generated ABI when the contract will be defined
+var rmnHomeString = "[{\"inputs\":[],\"name\":\"getAllConfigs\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"\",\"type\":\"uint256\"}],\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[{\"internalType\":\"uint256\",\"name\":\"num\",\"type\":\"uint256\"}],\"name\":\"store\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"}]"
+
 // MustSourceReaderConfig returns a ChainReaderConfig that can be used to read from the onramp.
 // The configuration is marshaled into JSON so that it can be passed to the relayer NewContractReader() method.
 func MustSourceReaderConfig() []byte {
@@ -249,6 +253,14 @@ var HomeChainReaderConfigRaw = evmrelaytypes.ChainReaderConfig{
 				},
 			},
 		},
+		consts.ContractNameRMNHome: {
+			ContractABI: rmnHomeString,
+			Configs: map[string]*evmrelaytypes.ChainReaderDefinition{
+				consts.MethodNameGetAllConfigs: {
+					ChainSpecificName: mustGetMethodName("getAllConfigs", rmnHomeABI),
+				},
+			},
+		},
 	},
 }
 

core/capabilities/ccip/delegate.go

@@ -3,6 +3,7 @@ package ccip
 import (
 	"context"
 	"fmt"
+	"strconv"
 	"time"
 
 	"github.com/smartcontractkit/chainlink-common/pkg/loop"
@@ -23,7 +24,11 @@ import (
 	"github.com/smartcontractkit/chainlink-common/pkg/types"
 	"github.com/smartcontractkit/chainlink-common/pkg/types/query/primitives"
 
+	chainsel "github.com/smartcontractkit/chain-selectors"
+
+	cciptypes "github.com/smartcontractkit/chainlink-common/pkg/types/ccipocr3"
 	cctypes "github.com/smartcontractkit/chainlink/v2/core/capabilities/ccip/types"
+
 	"github.com/smartcontractkit/chainlink/v2/core/chains/legacyevm"
 	"github.com/smartcontractkit/chainlink/v2/core/config"
 	kcr "github.com/smartcontractkit/chainlink/v2/core/gethwrappers/keystone/generated/capabilities_registry"
@@ -162,6 +167,16 @@ func (d *Delegate) ServicesForSpec(ctx context.Context, spec job.Job) (services
 		ccipConfigBinding,
 	)
 
+	// get the chain selector for the home chain
+	homeChainChainID, err := strconv.ParseUint(d.capabilityConfig.ExternalRegistry().RelayID().ChainID, 10, 64)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse chain ID %s: %w", d.capabilityConfig.ExternalRegistry().RelayID().ChainID, err)
+	}
+	homeChainChainSelector, err := chainsel.SelectorFromChainId(homeChainChainID)
+	if err != nil {
+		return nil, fmt.Errorf("failed to get chain selector from chain ID %d", homeChainChainID)
+	}
+
 	// if bootstrappers are provided we assume that the node is a plugin oracle.
 	// the reason for this is that bootstrap oracles do not need to be aware
 	// of other bootstrap oracles. however, plugin oracles, at least initially,
@@ -182,6 +197,7 @@ func (d *Delegate) ServicesForSpec(ctx context.Context, spec job.Job) (services
 			d.monitoringEndpointGen,
 			bootstrapperLocators,
 			hcr,
+			cciptypes.ChainSelector(homeChainChainSelector),
 		)
 	} else {
 		oracleCreator = oraclecreator.NewBootstrapOracleCreator(

core/capabilities/ccip/oraclecreator/plugin.go

@@ -67,6 +67,7 @@ type pluginOracleCreator struct {
 	monitoringEndpointGen telemetry.MonitoringEndpointGenerator
 	bootstrapperLocators  []commontypes.BootstrapperLocator
 	homeChainReader       ccipreaderpkg.HomeChain
+	homeChainSelector     cciptypes.ChainSelector
 }
 
 func NewPluginOracleCreator(
@@ -83,6 +84,7 @@ func NewPluginOracleCreator(
 	monitoringEndpointGen telemetry.MonitoringEndpointGenerator,
 	bootstrapperLocators []commontypes.BootstrapperLocator,
 	homeChainReader ccipreaderpkg.HomeChain,
+	homeChainSelector cciptypes.ChainSelector,
 ) cctypes.OracleCreator {
 	return &pluginOracleCreator{
 		ocrKeyBundles:         ocrKeyBundles,
@@ -98,6 +100,7 @@ func NewPluginOracleCreator(
 		monitoringEndpointGen: monitoringEndpointGen,
 		bootstrapperLocators:  bootstrapperLocators,
 		homeChainReader:       homeChainReader,
+		homeChainSelector:     homeChainSelector,
 	}
 }
 
@@ -220,6 +223,7 @@ func (i *pluginOracleCreator) createFactoryAndTransmitter(
 			ccipevm.NewCommitPluginCodecV1(),
 			ccipevm.NewMessageHasherV1(),
 			i.homeChainReader,
+			i.homeChainSelector,
 			contractReaders,
 			chainWriters,
 		)
@@ -273,6 +277,11 @@ func (i *pluginOracleCreator) createReadersAndWriters(
 		execBatchGasLimit = ofc.exec().BatchGasLimit
 	}
 
+	homeChainID, err := i.getChainID(i.homeChainSelector)
+	if err != nil {
+		return nil, nil, err
+	}
+
 	contractReaders := make(map[cciptypes.ChainSelector]types.ContractReader)
 	chainWriters := make(map[cciptypes.ChainSelector]types.ChainWriter)
 	for _, chain := range i.chains.Slice() {
@@ -281,7 +290,7 @@ func (i *pluginOracleCreator) createReadersAndWriters(
 			return nil, nil, err1
 		}
 
-		chainReaderConfig := getChainReaderConfig(chain.ID().Uint64(), destChainID, ofc, chainSelector)
+		chainReaderConfig := getChainReaderConfig(chain.ID().Uint64(), destChainID, homeChainID, ofc, chainSelector)
 		cr, err1 := createChainReader(i.lggr, chain, chainReaderConfig, pluginType)
 		if err1 != nil {
 			return nil, nil, err1
@@ -348,9 +357,18 @@ func (i *pluginOracleCreator) getChainSelector(chainID uint64) (cciptypes.ChainS
 	return cciptypes.ChainSelector(chainSelector), nil
 }
 
+func (i *pluginOracleCreator) getChainID(chainSelector cciptypes.ChainSelector) (uint64, error) {
+	chainID, err := chainsel.ChainIdFromSelector(uint64(chainSelector))
+	if err != nil {
+		return 0, fmt.Errorf("failed to get chain ID from chain selector %d: %w", chainSelector, err)
+	}
+	return chainID, nil
+}
+
 func getChainReaderConfig(
 	chainID uint64,
 	destChainID uint64,
+	homeChainID uint64,
 	ofc offChainConfig,
 	chainSelector cciptypes.ChainSelector,
 ) evmrelaytypes.ChainReaderConfig {
@@ -364,6 +382,10 @@ func getChainReaderConfig(
 	if !ofc.commitEmpty() && ofc.commit().PriceFeedChainSelector == chainSelector {
 		chainReaderConfig = evmconfig.MergeReaderConfigs(chainReaderConfig, evmconfig.FeedReaderConfig)
 	}
+
+	if chainID == homeChainID {
+		chainReaderConfig = evmconfig.MergeReaderConfigs(chainReaderConfig, evmconfig.HomeChainReaderConfigRaw)
+	}
 	return chainReaderConfig
 }
 

core/capabilities/encoder_factory.go

@@ -0,0 +1,21 @@
+package capabilities
+
+import (
+	"fmt"
+
+	"github.com/smartcontractkit/chainlink-common/pkg/capabilities/consensus/ocr3/types"
+	"github.com/smartcontractkit/chainlink-common/pkg/logger"
+	"github.com/smartcontractkit/chainlink-common/pkg/values"
+	"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm"
+)
+
+func NewEncoder(name string, config *values.Map, lggr logger.Logger) (types.Encoder, error) {
+	switch name {
+	case "EVM":
+		return evm.NewEVMEncoder(config)
+	// TODO: add a "no-op" encoder for users who only want to use dynamic ones?
+	// https://smartcontract-it.atlassian.net/browse/CAPPL-88
+	default:
+		return nil, fmt.Errorf("encoder %s not supported", name)
+	}
+}

core/capabilities/integration_tests/setup.go

@@ -41,7 +41,6 @@ import (
 	"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/ethkey"
 	"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/ocr2key"
 	p2ptypes "github.com/smartcontractkit/chainlink/v2/core/services/p2p/types"
-	"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm"
 	"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/v3/reportcodec"
 	"github.com/smartcontractkit/chainlink/v2/core/utils/testutils/heavyweight"
 )
@@ -153,7 +152,7 @@ func createDons(ctx context.Context, t *testing.T, lggr logger.Logger, reportsSi
 		requestTimeout := 10 * time.Minute
 		cfg := ocr3.Config{
 			Logger:            lggr,
-			EncoderFactory:    evm.NewEVMEncoder,
+			EncoderFactory:    capabilities.NewEncoder,
 			AggregatorFactory: capabilities.NewAggregator,
 			RequestTimeout:    &requestTimeout,
 		}

core/chains/evm/logpoller/orm_test.go

@@ -916,7 +916,7 @@ func TestORM_DataWords(t *testing.T) {
 		},
 	}))
 
-	wordFilter := func(wordIdx uint8, word1, word2 uint64) []query.Expression {
+	wordFilter := func(wordIdx int, word1, word2 uint64) []query.Expression {
 		return []query.Expression{
 			logpoller.NewAddressFilter(addr),
 			logpoller.NewEventSigFilter(eventSig),

core/chains/evm/logpoller/parser.go

@@ -504,11 +504,11 @@ type HashedValueComparator struct {
 }
 
 type eventByWordFilter struct {
-	WordIndex            uint8
+	WordIndex            int
 	HashedValueComparers []HashedValueComparator
 }
 
-func NewEventByWordFilter(wordIndex uint8, valueComparers []HashedValueComparator) query.Expression {
+func NewEventByWordFilter(wordIndex int, valueComparers []HashedValueComparator) query.Expression {
 	return query.Expression{Primitive: &eventByWordFilter{
 		WordIndex:            wordIndex,
 		HashedValueComparers: valueComparers,