Merge branch 'main' into cre-1322

Author: mchain0

.github/workflows/golangci_lint.yml

@@ -1,14 +1,18 @@
 name: Golangci-lint
 
-on: [pull_request]
+on: [pull_request, merge_group]
 
 jobs:
   golangci-lint:
+    # Avoid running in merge queue since we run in PR's and have an optional
+    # label to skip lint issues on a PR which would be ignored in the merge queue.
+    if: ${{ github.event_name != 'merge_group' }}
     runs-on: ubuntu-latest
     permissions:
       id-token: write
       contents: read
       actions: read
+      pull-requests: read
     steps:
       - name: Checkout code
         uses: actions/checkout@v5

.github/workflows/keystore.yml

@@ -2,7 +2,7 @@ name: Keystore Checks
 permissions:
   contents: read
 
-on: push
+on: [push, merge_group]
 
 jobs:
   changes:

.github/workflows/pkg.yml

@@ -1,6 +1,6 @@
 name: PKG Build and Test
 
-on: [push]
+on: [push, merge_group]
 
 jobs:
   build-test:

pkg/settings/cresettings/defaults.json

@@ -42,6 +42,7 @@
 		"LogLineLimit": "1kb",
 		"LogEventLimit": "1000",
 		"CRONTrigger": {
+			"FastestScheduleInterval": "30s",
 			"RateLimit": "every30s:1"
 		},
 		"HTTPTrigger": {

pkg/settings/cresettings/defaults.toml

@@ -43,6 +43,7 @@ LogLineLimit = '1kb'
 LogEventLimit = '1000'
 
 [PerWorkflow.CRONTrigger]
+FastestScheduleInterval = '30s'
 RateLimit = 'every30s:1'
 
 [PerWorkflow.HTTPTrigger]

pkg/settings/cresettings/settings.go

@@ -16,8 +16,14 @@ import (
 	. "github.com/smartcontractkit/chainlink-common/pkg/settings"
 )
 
-func init() {
-	if v, ok := os.LookupEnv("CL_CRE_SETTINGS_DEFAULT"); ok {
+const (
+	envNameSettings        = "CL_CRE_SETTINGS"
+	envNameSettingsDefault = "CL_CRE_SETTINGS_DEFAULT"
+)
+
+func init() { reinit() }
+func reinit() {
+	if v, ok := os.LookupEnv(envNameSettingsDefault); ok {
 		err := json.Unmarshal([]byte(v), &Default)
 		if err != nil {
 			log.Fatalf("failed to initialize defaults: %v", err)
@@ -29,7 +35,7 @@ func init() {
 	}
 	Config = Default
 
-	if v, ok := os.LookupEnv("CL_CRE_SETTINGS"); ok {
+	if v, ok := os.LookupEnv(envNameSettings); ok {
 		DefaultGetter, err = NewJSONGetter([]byte(v))
 		if err != nil {
 			log.Fatalf("failed to initialize settings: %v", err)
@@ -99,7 +105,8 @@ var Default = Schema{
 		LogEventLimit:                 Int(1_000),
 
 		CRONTrigger: cronTrigger{
-			RateLimit: Rate(rate.Every(30*time.Second), 1),
+			FastestScheduleInterval: Duration(30 * time.Second),
+			RateLimit:               Rate(rate.Every(30*time.Second), 1),
 		},
 		HTTPTrigger: httpTrigger{
 			RateLimit: Rate(rate.Every(30*time.Second), 3),
@@ -214,6 +221,7 @@ type Workflows struct {
 }
 
 type cronTrigger struct {
+	FastestScheduleInterval Setting[time.Duration]
 	// Deprecated: to be removed
 	RateLimit Setting[config.Rate]
 }

pkg/settings/cresettings/settings_test.go

@@ -15,6 +15,7 @@ import (
 	"golang.org/x/time/rate"
 
 	"github.com/smartcontractkit/chainlink-common/pkg/config"
+	"github.com/smartcontractkit/chainlink-common/pkg/contexts"
 )
 
 var update = flag.Bool("update", false, "update the golden files of this test")
@@ -110,3 +111,50 @@ func TestSchema_Unmarshal(t *testing.T) {
 	assert.Equal(t, uint64(500000), cfg.PerWorkflow.ChainWrite.EVM.TransactionGasLimit.DefaultValue)
 	assert.Equal(t, 3, cfg.PerWorkflow.ChainRead.CallLimit.DefaultValue)
 }
+
+func TestDefaultGetter(t *testing.T) {
+	limit := Default.PerWorkflow.HTTPAction.CallLimit
+
+	ctx := contexts.WithCRE(t.Context(), contexts.CRE{Owner: "owner-id", Workflow: "foo"})
+	overrideCtx := contexts.WithCRE(t.Context(), contexts.CRE{Owner: "owner-id", Workflow: "test-wf-id"})
+
+	// Default 5
+	got, err := limit.GetOrDefault(ctx, DefaultGetter)
+	require.NoError(t, err)
+	require.Equal(t, 5, got)
+
+	// No override
+	got, err = limit.GetOrDefault(overrideCtx, DefaultGetter)
+	require.NoError(t, err)
+	require.Equal(t, 5, got)
+
+	t.Cleanup(reinit) // restore default vars
+	t.Setenv(envNameSettings, `{
+	"workflow": {
+		"test-wf-id": {
+			"PerWorkflow": {
+				"HTTPAction": {
+					"CallLimit": "20"
+				}
+			}
+		}
+	}
+}`)
+	reinit() // set default vars
+
+	_ = `
+[workflow.test-wf-id]
+PerWorkflow.HTTPAction.CallLimit = 20
+`
+
+	// Default unchanged
+	got, err = limit.GetOrDefault(ctx, DefaultGetter)
+	require.NoError(t, err)
+	require.Equal(t, 5, got)
+
+	// Override applied
+	got, err = limit.GetOrDefault(overrideCtx, DefaultGetter)
+	require.NoError(t, err)
+	require.Equal(t, 20, got)
+
+}

pkg/settings/toml.go

@@ -44,6 +44,7 @@ func CombineTOMLFiles(files fs.FS) ([]byte, error) {
 	tree.Set("workflow", workflows)
 	var b bytes.Buffer
 	e := toml.NewEncoder(&b).Indentation("")
+	e.Order(toml.OrderAlphabetical)
 	err = e.Encode(tree)
 	return b.Bytes(), err
 }

pkg/types/ccipocr3/chainaccessor.go

@@ -8,19 +8,9 @@ import (
 	"github.com/smartcontractkit/chainlink-common/pkg/types/query/primitives"
 )
 
-// ChainFeeComponents redeclares the ChainFeeComponents type from the chainlink-common/pkg/types to avoid
-// a cyclic dependency caused by provider_ccip_ocr3.go importing this package.
-type ChainFeeComponents struct {
-	// The cost of executing transaction in the chain's EVM (or the L2 environment).
-	ExecutionFee *big.Int
-
-	// The cost associated with an L2 posting a transaction's data to the L1.
-	DataAvailabilityFee *big.Int
-}
-
-// ChainAccessor for all direct chain access. The accessor is responsible for
-// in addition to direct access to the chain, this interface also translates
-// onchain representations of data to the plugin representation.
+// ChainAccessor is responsible for direct access to the chain. In addition
+// to direct access, this interface also translates onchain representations
+// of data to the plugin representation.
 type ChainAccessor interface {
 	AllAccessors
 	SourceAccessor
@@ -29,12 +19,10 @@ type ChainAccessor interface {
 	PriceReader
 }
 
-// AllAccessors contains functionality that is available to all types of accessors.
+// AllAccessors contains functionality that is available to all types of accessors (source and dest).
 type AllAccessors interface {
-	// GetContractAddress returns the contract address that is registered for the provided contract name and chain.
-	// WARNING: This function will fail if the oracle does not support the requested chain.
-	//
-	// TODO(NONEVM-1865): do we want to mark this as deprecated in favor of Metadata()?
+	// GetContractAddress returns the contract address that is registered for the provided contract name
+	// on the chain associated with the specific accessor implementation.
 	GetContractAddress(contractName string) ([]byte, error)
 
 	// GetAllConfig is the next iteration of GetAllConfigsLegacy(). Instead of returning a large snapshot
@@ -49,19 +37,18 @@ type AllAccessors interface {
 	// GetAllConfigsLegacy returns a snapshot of all chain configurations for this chain using the legacy
 	// config structs.
 	//
-	// destChainSelector is used to determine whether or not destination chain specific configs should be fetched.
-	// sourceChainSelectors is used to determine which source chain configs should be fetched.
+	// When called on a destination chain accessor:
+	//   - destChainSelector should match the accessor's chain
+	//   - sourceChainSelectors determines which source chain configs to fetch from the OffRamp
+	//   - Returns ChainConfigSnapshot with OffRamp, FeeQuoter, RMNProxy, RMNRemote, CurseInfo configs
+	//   - Returns map of SourceChainConfig for each requested source chain
 	//
-	// This includes the following contracts:
-	// - Router
-	// - OffRamp
-	// - OnRamp
-	// - FeeQuoter
-	// - RMNProxy
-	// - RMNRemote
-	// - CurseInfo
+	// When called on a source chain accessor:
+	//   - destChainSelector is used to fetch OnRamp dest chain specific configs
+	//   - sourceChainSelectors will likely be empty and/or ignored by the accessor impl
+	//   - Returns ChainConfigSnapshot with OnRamp, FeeQuoter, Router configs
+	//   - Returns empty map for source chain configs
 	//
-	// Access Type: Method(many, see code)
 	// Contract: Many
 	// Confidence: Unconfirmed
 	GetAllConfigsLegacy(
@@ -70,24 +57,24 @@ type AllAccessors interface {
 		sourceChainSelectors []ChainSelector,
 	) (ChainConfigSnapshot, map[ChainSelector]SourceChainConfig, error)
 
-	// GetChainFeeComponents Returns all fee components for given chains if corresponding
-	// chain writer is available.
+	// GetChainFeeComponents returns all fee components for the chain.
 	//
-	// Access Type: ChainWriter
 	// Contract: N/A
 	// Confidence: N/A
 	GetChainFeeComponents(ctx context.Context) (ChainFeeComponents, error)
 
-	// Sync can be used to perform frequent syncing operations inside the reader implementation.
-	// Returns an error if the sync operation failed.
+	// Sync binds a contract to the accessor implementation by contract name and address so the accessor
+	// can use the contract addresses for subsequent calls. This is used to dynamically discover and bind
+	// contracts (e.g., OnRamps, FeeQuoter, RMNRemote).
+	// Returns an error if the bind operation failed.
 	Sync(ctx context.Context, contractName string, contractAddress UnknownAddress) error
 }
 
-// DestinationAccessor contains all functions typically associated by the destination chain.
+// DestinationAccessor contains all functions typically associated with the destination chain.
 type DestinationAccessor interface {
 
 	// CommitReportsGTETimestamp reads CommitReportAccepted events starting from a given timestamp.
-	// The number of results are limited according to limit.
+	// The number of results is limited according to the limit parameter.
 	//
 	// Access Type: Event(CommitReportAccepted)
 	// Contract: OffRamp
@@ -113,31 +100,32 @@ type DestinationAccessor interface {
 		confidence primitives.ConfidenceLevel,
 	) (map[ChainSelector][]SeqNum, error)
 
-	// NextSeqNum reads the source chain config to get the next expected
-	// sequence number for the given source chains.
+	// NextSeqNum reads the source chain config from the OffRamp to get the next expected
+	// sequence number (MinSeqNr) for the given source chains.
 	//
-	// Access Type: Method(NextSeqNum)
+	// Access Type: Method(GetSourceChainConfig)
 	// Contract: OffRamp
 	// Confidence: Unconfirmed
 	NextSeqNum(ctx context.Context, sources []ChainSelector) (map[ChainSelector]SeqNum, error)
 
-	// Nonces for all provided selector/address pairs. Addresses must be encoded
+	// Nonces returns nonces for all provided selector/address pairs. Addresses must be encoded
 	// according to the source chain requirements by using the AddressCodec.
 	//
 	// Access Type: Method(GetInboundNonce)
 	// Contract: NonceManager
 	// Confidence: Unconfirmed
 	Nonces(ctx context.Context, addresses map[ChainSelector][]UnknownEncodedAddress) (map[ChainSelector]map[string]uint64, error)
 
-	// GetChainFeePriceUpdate Gets latest chain fee price update for the provided chains.
+	// GetChainFeePriceUpdate returns the latest chain fee price update for the provided selectors. This queries
+	// the FeeQuoter contract on the chain accociated with this accessor.
 	//
 	// Access Type: Method(GetChainFeePriceUpdate)
 	// Contract: FeeQuoter
 	// Confidence: Unconfirmed
 	GetChainFeePriceUpdate(ctx context.Context, selectors []ChainSelector) (map[ChainSelector]TimestampedUnixBig, error)
 
 	// GetLatestPriceSeqNr returns the latest price sequence number for the destination chain.
-	// Not to confuse with the sequence number of the messages. This is the OCR sequence number.
+	// Not to be confused with the sequence number of the messages. This is the OCR sequence number.
 	//
 	// Access Type: Method(GetLatestPriceSequenceNumber)
 	// Contract: OffRamp
@@ -164,23 +152,20 @@ type SourceAccessor interface {
 	LatestMessageTo(ctx context.Context, dest ChainSelector) (SeqNum, error)
 
 	// GetExpectedNextSequenceNumber returns the expected next sequence number
-	// messages being sent to the provided destination.
+	// for messages being sent to the provided destination.
 	//
 	// Access Type: Method(GetExpectedNextSequenceNumber)
 	// Contract: OnRamp
 	// Confidence: Unconfirmed
 	GetExpectedNextSequenceNumber(ctx context.Context, dest ChainSelector) (SeqNum, error)
 
-	// GetTokenPriceUSD looks up a token price in USD. The address value should
-	// be retrieved from a configuration cache (i.e. ConfigPoller).
+	// GetTokenPriceUSD looks up a token price in USD for the provided address.
+	// Serves as a general price interface for fetching both LINK price and wrapped
+	// native token price in USD.
 	//
 	// Access Type: Method(GetTokenPrice)
 	// Contract: FeeQuoter
 	// Confidence: Unconfirmed
-	//
-	// Notes: This function is new and serves as a general price interface for
-	//        both LinkPriceUSD and GetWrappedNativeTokenPriceUSD.
-	//        See Design Doc (Combined Token Price Helper) for notes.
 	GetTokenPriceUSD(ctx context.Context, address UnknownAddress) (TimestampedUnixBig, error)
 
 	// GetFeeQuoterDestChainConfig returns the fee quoter destination chain config.
@@ -222,3 +207,13 @@ type PriceReader interface {
 		tokensBytes []UnknownAddress,
 	) (map[UnknownEncodedAddress]TimestampedUnixBig, error)
 }
+
+// ChainFeeComponents redeclares the ChainFeeComponents type from the chainlink-common/pkg/types to avoid
+// a cyclic dependency caused by provider_ccip_ocr3.go importing this package.
+type ChainFeeComponents struct {
+	// The cost of executing transaction in the chain's EVM (or the L2 environment).
+	ExecutionFee *big.Int
+
+	// The cost associated with an L2 posting a transaction's data to the L1.
+	DataAvailabilityFee *big.Int
+}