Merge branch 'main' into feat/fee-components-pointers

.golangci.yml

@@ -16,6 +16,7 @@ linters:
     - whitespace
     - depguard
     - containedctx
+    - gomodguard
 linters-settings:
   exhaustive:
     default-signifies-exhaustive: true
@@ -113,6 +114,9 @@ linters-settings:
             desc: Use gopkg.in/guregu/null.v4 instead
           - pkg: "gopkg.in/guregu/null.v3"
             desc: Use gopkg.in/guregu/null.v4 instead
+  gomodguard:
+    blocked:
+      local_replace_directives: true
 issues:
   exclude-rules:
     - path: test

README.md

@@ -1,3 +1,12 @@
 # chainlink-common
 
 SDK for implementing Chainlink Services, like Chain Relayers or Product Plugins.
+
+Internal references
+
+- [loop](pkg/loop/README.md)
+  - [loop/internal](./pkg/loop/internal/README.md)
+    - Reporting plugins
+    - Protobuf definitions
+
+

observability-lib/cmd/deploy.go

@@ -37,7 +37,7 @@ var DeployCmd = &cobra.Command{
 		case "core-node":
 			builder, err = corenode.BuildDashboard(name, dataSourcesType.Metrics, platform)
 		case "core-node-components":
-			builder, err = corenodecomponents.BuildDashboard(name, dataSourcesType.Metrics)
+			builder, err = corenodecomponents.BuildDashboard(name, dataSourcesType.Metrics, dataSourcesType.Logs)
 		case "core-node-resources":
 			builder, err = k8sresources.BuildDashboard(name, dataSourcesType.Metrics, dataSourcesType.Logs)
 		case "ocr":

observability-lib/cmd/generate.go

@@ -36,7 +36,7 @@ var GenerateCmd = &cobra.Command{
 		case "core-node":
 			builder, err = corenode.BuildDashboard(name, dataSourcesType.Metrics, platform)
 		case "core-node-components":
-			builder, err = corenodecomponents.BuildDashboard(name, dataSourcesType.Metrics)
+			builder, err = corenodecomponents.BuildDashboard(name, dataSourcesType.Metrics, dataSourcesType.Logs)
 		case "core-node-resources":
 			builder, err = k8sresources.BuildDashboard(name, dataSourcesType.Metrics, dataSourcesType.Logs)
 		case "ocr":

observability-lib/core-node-components/component.go

@@ -9,9 +9,10 @@ import (
 	"github.com/smartcontractkit/chainlink-common/observability-lib/utils"
 )
 
-func BuildDashboard(name string, dataSourceMetric string) (dashboard.Dashboard, error) {
+func BuildDashboard(name string, dataSourceMetric string, dataSourceLog string) (dashboard.Dashboard, error) {
 	props := Props{
 		MetricsDataSource: dataSourceMetric,
+		LogsDataSource:    dataSourceLog,
 		PlatformOpts:      PlatformPanelOpts(),
 	}
 
@@ -140,5 +141,17 @@ func panelsGeneralInfo(p Props) []cog.Builder[dashboard.Panel] {
 		},
 	).Min(0).Max(100))
 
+	panelsArray = append(panelsArray, utils.LogPanel(
+		p.LogsDataSource,
+		"Logs with severity >= error",
+		"",
+		6,
+		24,
+		utils.PrometheusQuery{
+			Query:  `{env="${env}", cluster="${cluster}", product="${product}", network_type="${network_type}", instance=~"${service}"} | json | level=~"(error|panic|fatal|crit)"`,
+			Legend: "",
+		},
+	))
+
 	return panelsArray
 }

observability-lib/core-node-components/platform.go

@@ -11,6 +11,7 @@ type PlatformOpts struct {
 
 type Props struct {
 	MetricsDataSource string
+	LogsDataSource    string
 	PlatformOpts      PlatformOpts
 }
 

observability-lib/utils/common.go

@@ -5,6 +5,7 @@ import (
 	"github.com/grafana/grafana-foundation-sdk/go/common"
 	"github.com/grafana/grafana-foundation-sdk/go/dashboard"
 	"github.com/grafana/grafana-foundation-sdk/go/gauge"
+	"github.com/grafana/grafana-foundation-sdk/go/logs"
 	"github.com/grafana/grafana-foundation-sdk/go/prometheus"
 	"github.com/grafana/grafana-foundation-sdk/go/stat"
 	"github.com/grafana/grafana-foundation-sdk/go/table"
@@ -189,3 +190,25 @@ func TablePanel(
 
 	return panel
 }
+
+func LogPanel(
+	datasource string,
+	title string,
+	description string,
+	height uint32,
+	span uint32,
+	query ...PrometheusQuery,
+) *logs.PanelBuilder {
+	panel := logs.NewPanelBuilder().
+		Datasource(datasourceRef(datasource)).
+		Height(height).
+		Span(span).
+		Title(title).
+		Description(description)
+
+	for _, q := range query {
+		panel.WithTarget(prometheusQuery(q.Query, q.Legend))
+	}
+
+	return panel
+}

pkg/loop/internal/README.md

@@ -77,6 +77,9 @@ Product specific development is the most nuanced kind of development. There are
 
 ## Protobuf best practices
 
+
 It's extremely important to be mindful of compatibility when changing protobuf definition. See the [official best practices](https://protobuf.dev/programming-guides/dos-donts/) for details.
 
+To update protobuf, update the corresponding `.proto` file in the `pb` package. Then run `make generate` to regenerate the code.
+
 ## FAQ 

pkg/loop/internal/pb/ccip/offramp.proto

@@ -207,5 +207,5 @@ message OffRampStaticConfig {
 message OffRampTokens {
     repeated string destination_tokens = 1; // []Address
     repeated string source_tokens = 2; // []Address
-    map<string,string> destination_pool = 3; // map[Address]Address
+    reserved 3;
 }

pkg/loop/internal/relayer/pluginprovider/ext/ccip/offramp.go

@@ -632,15 +632,10 @@ func offRampTokens(in *ccippb.OffRampTokens) cciptypes.OffRampTokens {
 	for i, t := range in.DestinationTokens {
 		dest[i] = cciptypes.Address(t)
 	}
-	destPool := make(map[cciptypes.Address]cciptypes.Address)
-	for k, v := range in.DestinationPool {
-		destPool[cciptypes.Address(k)] = cciptypes.Address(v)
-	}
 
 	return cciptypes.OffRampTokens{
 		SourceTokens:      source,
 		DestinationTokens: dest,
-		DestinationPool:   destPool,
 	}
 }
 
@@ -653,15 +648,10 @@ func offRampTokensToPB(in cciptypes.OffRampTokens) *ccippb.OffRampTokens {
 	for i, t := range in.DestinationTokens {
 		dest[i] = string(t)
 	}
-	destPool := make(map[string]string)
-	for k, v := range in.DestinationPool {
-		destPool[string(k)] = string(v)
-	}
 
 	return &ccippb.OffRampTokens{
 		SourceTokens:      source,
 		DestinationTokens: dest,
-		DestinationPool:   destPool,
 	}
 }
 

pkg/loop/internal/relayer/pluginprovider/ext/ccip/test/offramp.go

@@ -148,9 +148,6 @@ var OffRampReader = staticOffRamp{
 				ccip.Address("sourceToken1"),
 				ccip.Address("sourceToken2"),
 			},
-			DestinationPool: map[ccip.Address]ccip.Address{
-				ccip.Address("key1"): ccip.Address("value1"),
-			},
 		},
 
 		// GetRouter test data
@@ -245,7 +242,7 @@ func (s staticOffRamp) DecodeExecutionReport(ctx context.Context, report []byte)
 // EncodeExecutionReport implements OffRampEvaluator.
 func (s staticOffRamp) EncodeExecutionReport(ctx context.Context, report ccip.ExecReport) ([]byte, error) {
 	// struggling to get full report equality via  reflect.DeepEqual or assert.ObjectsAreEqual
-	// take a short cut and compare the fields we care about
+	// take a shortcut and compare the fields we care about
 	if len(report.Messages) != len(s.encodeExecutionReportRequest.Messages) {
 		return nil, fmt.Errorf(" encodeExecutionReport message len %v but got %v", len(s.encodeExecutionReportRequest.Messages), len(report.Messages))
 	}
@@ -378,12 +375,12 @@ func (s staticOffRamp) Evaluate(ctx context.Context, other ccip.OffRampReader) e
 		return fmt.Errorf("expected gasPrice %v but got %v", GasPriceEstimatorExec.getGasPriceResponse, price)
 	}
 	// DenoteInUSD test case
-	gotusd, err := gasPriceEstimator.DenoteInUSD(GasPriceEstimatorExec.denoteInUSDRequest.p, GasPriceEstimatorExec.denoteInUSDRequest.wrappedNativePrice)
+	gotUsd, err := gasPriceEstimator.DenoteInUSD(GasPriceEstimatorExec.denoteInUSDRequest.p, GasPriceEstimatorExec.denoteInUSDRequest.wrappedNativePrice)
 	if err != nil {
 		return fmt.Errorf("failed to get other usd: %w", err)
 	}
-	if gotusd.Cmp(GasPriceEstimatorExec.denoteInUSDResponse.result) != 0 {
-		return fmt.Errorf("expected usd %v but got %v", GasPriceEstimatorExec.denoteInUSDResponse.result, gotusd)
+	if gotUsd.Cmp(GasPriceEstimatorExec.denoteInUSDResponse.result) != 0 {
+		return fmt.Errorf("expected usd %v but got %v", GasPriceEstimatorExec.denoteInUSDResponse.result, gotUsd)
 	}
 	// EstimateMsgCostUSD test case
 	cost, err := gasPriceEstimator.EstimateMsgCostUSD(

pkg/types/ccip/offramp.go

@@ -106,7 +106,6 @@ type OffRampStaticConfig struct {
 type OffRampTokens struct {
 	DestinationTokens []Address
 	SourceTokens      []Address
-	DestinationPool   map[Address]Address
 }
 
 // MessageExecutionState defines the execution states of CCIP messages.

pkg/types/interfacetests/chain_reader_interface_tests.go

@@ -235,13 +235,14 @@ func runQueryKeyInterfaceTests[T TestingT[T]](t T, tester ChainReaderInterfaceTe
 				ctx := tests.Context(t)
 				cr := tester.GetChainReader(t)
 				require.NoError(t, cr.Bind(ctx, tester.GetBindings(t)))
-				ts1 := CreateTestStruct[T](0, tester)
+				ts1 := CreateTestStruct[T](1, tester)
 				tester.TriggerEvent(t, &ts1)
-				ts2 := CreateTestStruct[T](1, tester)
+				ts2 := CreateTestStruct[T](0, tester)
 				tester.TriggerEvent(t, &ts2)
 
 				ts := &TestStruct{}
 				assert.Eventually(t, func() bool {
+					// sequences from queryKey without limit and sort should be in descending order
 					sequences, err := cr.QueryKey(ctx, AnyContractName, query.KeyFilter{Key: EventName}, query.LimitAndSort{}, ts)
 					return err == nil && len(sequences) == 2 && reflect.DeepEqual(&ts1, sequences[0].Data) && reflect.DeepEqual(&ts2, sequences[1].Data)
 				}, tester.MaxWaitTimeForEvents(), time.Millisecond*10)