pkg/settings/cresettings: add PerWorkflow.ChainAllowed

Author: jmank88

pkg/capabilities/capabilities.go

@@ -5,15 +5,17 @@ import (
 	"fmt"
 	"iter"
 	"regexp"
+	"strconv"
 	"strings"
 	"time"
 
 	p2ptypes "github.com/smartcontractkit/libocr/ragep2p/types"
 	"google.golang.org/protobuf/proto"
 	"google.golang.org/protobuf/types/known/anypb"
 
-	"github.com/smartcontractkit/chainlink-common/pkg/contexts"
 	"github.com/smartcontractkit/chainlink-protos/cre/go/values"
+
+	"github.com/smartcontractkit/chainlink-common/pkg/contexts"
 )
 
 // CapabilityType is an enum for the type of capability.
@@ -180,6 +182,35 @@ func ParseID(id string) (name string, labels iter.Seq2[string, string], version
 	return
 }
 
+// ChainSelectorLabel returns a chain selector value from the labels if one is present.
+// It supports both a normal key/value pair, and sequential keys for historical reasons.
+func ChainSelectorLabel(labels iter.Seq2[string, string]) (*uint64, error) {
+	const key = "ChainSelector"
+	var next bool
+	for k, v := range labels {
+		if next {
+			cs, err := strconv.ParseUint(k, 10, 64)
+			if err != nil {
+				return nil, fmt.Errorf("invalid chain selector: %s", v)
+			}
+			return &cs, nil
+		}
+		if k == key {
+			if v != "" {
+				cs, err := strconv.ParseUint(v, 10, 64)
+				if err != nil {
+					return nil, fmt.Errorf("invalid chain selector: %s", v)
+				}
+				return &cs, nil
+			} else {
+				// empty value means it will be in the next key
+				next = true
+			}
+		}
+	}
+	return nil, nil
+}
+
 type RegisterToWorkflowRequest struct {
 	Metadata RegistrationMetadata
 	Config   *values.Map

pkg/capabilities/capabilities_test.go

@@ -302,3 +302,32 @@ func TestParseID(t *testing.T) {
 		})
 	}
 }
+
+func TestChainSelectorLabel(t *testing.T) {
+	for _, tc := range []struct {
+		id     string
+		cs     *uint64
+		errMsg string
+	}{
+		{"[email protected]", nil, ""},
+		{"kv:[email protected]", ptr[uint64](1), ""},
+		{"kk:ChainSelector:[email protected]", ptr[uint64](1), ""},
+		{"kv-others:k_v:[email protected]", ptr[uint64](1), ""},
+		{"kk-others:k_v:ChainSelector:[email protected]", ptr[uint64](1), ""},
+
+		{"kv:[email protected]", ptr[uint64](1), "invalid chain selector"},
+		{"kk:ChainSelector:[email protected]", ptr[uint64](1), "invalid chain selector"},
+	} {
+		t.Run(tc.id, func(t *testing.T) {
+			_, labels, _ := ParseID(tc.id)
+			cs, err := ChainSelectorLabel(labels)
+			if tc.errMsg != "" {
+				require.ErrorContains(t, err, tc.errMsg)
+			} else {
+				require.Equal(t, tc.cs, cs)
+			}
+		})
+	}
+}
+
+func ptr[T any](v T) *T { return &v }

pkg/contexts/chains.go

@@ -0,0 +1,23 @@
+package contexts
+
+import (
+	"context"
+	"errors"
+)
+
+const chainSelectorCtxKey key = "chainSelectorCtx"
+
+// WithChainSelector returns a new context that includes the chain selector.
+// Use ChainSelectorValue to get the value.
+func WithChainSelector(ctx context.Context, cs uint64) context.Context {
+	return context.WithValue(ctx, chainSelectorCtxKey, cs)
+}
+
+// ChainSelectorValue returns the chain selector, if one was set via WithChainSelector.
+func ChainSelectorValue(ctx context.Context) (uint64, error) {
+	val := Value[uint64](ctx, chainSelectorCtxKey)
+	if val == 0 {
+		return 0, errors.New("context missing chain selector")
+	}
+	return val, nil
+}

pkg/settings/cresettings/defaults.json

@@ -41,6 +41,13 @@
 		"ConsensusCallsLimit": "2000",
 		"LogLineLimit": "1kb",
 		"LogEventLimit": "1000",
+		"ChainAllowed": {
+			"Default": "false",
+			"Values": {
+				"12922642891491394802": "true",
+				"3379446385462418246": "true"
+			}
+		},
 		"CRONTrigger": {
 			"FastestScheduleInterval": "30s",
 			"RateLimit": "every30s:1"

pkg/settings/cresettings/defaults.toml

@@ -42,6 +42,13 @@ ConsensusCallsLimit = '2000'
 LogLineLimit = '1kb'
 LogEventLimit = '1000'
 
+[PerWorkflow.ChainAllowed]
+Default = 'false'
+
+[PerWorkflow.ChainAllowed.Values]
+12922642891491394802 = 'true'
+3379446385462418246 = 'true'
+
 [PerWorkflow.CRONTrigger]
 FastestScheduleInterval = '30s'
 RateLimit = 'every30s:1'

pkg/settings/cresettings/settings.go

@@ -103,6 +103,12 @@ var Default = Schema{
 		ConsensusCallsLimit:           Int(2000),
 		LogLineLimit:                  Size(config.KByte),
 		LogEventLimit:                 Int(1_000),
+		ChainAllowed: PerChainSelector(Bool(false), map[string]bool{
+			// geth-testnet
+			"3379446385462418246": true,
+			// geth-devnet2
+			"12922642891491394802": true,
+		}),
 
 		CRONTrigger: cronTrigger{
 			FastestScheduleInterval: Duration(30 * time.Second),
@@ -210,6 +216,8 @@ type Workflows struct {
 	LogLineLimit  Setting[config.Size]
 	LogEventLimit Setting[int] `unit:"{log}"`
 
+	ChainAllowed SettingMap[bool]
+
 	CRONTrigger cronTrigger
 	HTTPTrigger httpTrigger
 	LogTrigger  logTrigger

pkg/settings/cresettings/settings_test.go

@@ -16,6 +16,8 @@ import (
 
 	"github.com/smartcontractkit/chainlink-common/pkg/config"
 	"github.com/smartcontractkit/chainlink-common/pkg/contexts"
+	"github.com/smartcontractkit/chainlink-common/pkg/logger"
+	"github.com/smartcontractkit/chainlink-common/pkg/settings/limits"
 )
 
 var update = flag.Bool("update", false, "update the golden files of this test")
@@ -74,6 +76,12 @@ func TestSchema_Unmarshal(t *testing.T) {
 	},
 	"PerWorkflow": {
 		"WASMMemoryLimit": "250mb",
+		"ChainAllowed": {
+			"Default": "false",
+			"Values": {
+				"1": "true"
+			}
+		},
 		"CRONTrigger": {
 			"RateLimit": "every10s:5"
 		},
@@ -103,6 +111,10 @@ func TestSchema_Unmarshal(t *testing.T) {
 	assert.Equal(t, 48*time.Hour, cfg.PerOrg.ZeroBalancePruningTimeout.DefaultValue)
 	assert.Equal(t, 99, cfg.PerOwner.WorkflowExecutionConcurrencyLimit.DefaultValue)
 	assert.Equal(t, 250*config.MByte, cfg.PerWorkflow.WASMMemoryLimit.DefaultValue)
+	assert.Equal(t, false, cfg.PerWorkflow.ChainAllowed.Default.DefaultValue)
+	assert.Equal(t, "true", cfg.PerWorkflow.ChainAllowed.Values["1"])
+	assert.NotNil(t, cfg.PerWorkflow.ChainAllowed.Default.Parse)
+	assert.NotNil(t, cfg.PerWorkflow.ChainAllowed.KeyFromCtx)
 	assert.Equal(t, config.Rate{Limit: rate.Every(10 * time.Second), Burst: 5}, cfg.PerWorkflow.CRONTrigger.RateLimit.DefaultValue)
 	assert.Equal(t, config.Rate{Limit: rate.Every(30 * time.Second), Burst: 3}, cfg.PerWorkflow.HTTPTrigger.RateLimit.DefaultValue)
 	assert.Equal(t, config.Rate{Limit: rate.Every(13 * time.Second), Burst: 6}, cfg.PerWorkflow.LogTrigger.EventRateLimit.DefaultValue)
@@ -142,11 +154,6 @@ func TestDefaultGetter(t *testing.T) {
 }`)
 	reinit() // set default vars
 
-	_ = `
-[workflow.test-wf-id]
-PerWorkflow.HTTPAction.CallLimit = 20
-`
-
 	// Default unchanged
 	got, err = limit.GetOrDefault(ctx, DefaultGetter)
 	require.NoError(t, err)
@@ -158,3 +165,81 @@ PerWorkflow.HTTPAction.CallLimit = 20
 	require.Equal(t, 20, got)
 
 }
+
+func TestDefaultGetter_SettingMap(t *testing.T) {
+	limit := Default.PerWorkflow.ChainAllowed
+
+	ctx := contexts.WithCRE(t.Context(), contexts.CRE{Owner: "owner-id", Workflow: "foo"})
+	ctx = contexts.WithChainSelector(ctx, 1234)
+	overrideCtx := contexts.WithCRE(t.Context(), contexts.CRE{Owner: "owner-id", Workflow: "test-wf-id"})
+	overrideCtx = contexts.WithChainSelector(overrideCtx, 1234)
+
+	// None allowed by default
+	got, err := limit.GetOrDefault(ctx, DefaultGetter)
+	require.NoError(t, err)
+	require.False(t, got)
+	got, err = limit.GetOrDefault(overrideCtx, DefaultGetter)
+	require.NoError(t, err)
+	require.False(t, got)
+
+	t.Cleanup(reinit) // restore default vars
+
+	// Org override to allow
+	t.Setenv(envNameSettings, `{
+	"workflow": {
+		"test-wf-id": {
+			"PerWorkflow": {
+				"ChainAllowed": {
+					"Values": {
+						"1234": "true"
+					}
+				}
+			}
+		}
+	}
+}`)
+	reinit() // set default vars
+	got, err = limit.GetOrDefault(ctx, DefaultGetter)
+	require.NoError(t, err)
+	require.False(t, got)
+	got, err = limit.GetOrDefault(overrideCtx, DefaultGetter)
+	require.NoError(t, err)
+	require.True(t, got)
+
+	// Org override to allow by default, but disallow some
+	t.Setenv(envNameSettings, `{
+	"workflow": {
+		"test-wf-id": {
+			"PerWorkflow": {
+				"ChainAllowed": {
+					"Default": true,
+					"Values": {
+						"1234": "false"
+					}
+				}
+			}
+		}
+	}
+}`)
+	reinit() // set default vars
+	got, err = limit.GetOrDefault(ctx, DefaultGetter)
+	require.NoError(t, err)
+	require.False(t, got)
+	got, err = limit.GetOrDefault(overrideCtx, DefaultGetter)
+	require.NoError(t, err)
+	require.False(t, got)
+	got, err = limit.GetOrDefault(contexts.WithChainSelector(overrideCtx, 42), DefaultGetter)
+	require.NoError(t, err)
+	require.True(t, got)
+}
+
+func TestChainAllows(t *testing.T) {
+	gl, err := limits.MakeGateLimiter(limits.Factory{Logger: logger.Test(t)}, Default.PerWorkflow.ChainAllowed)
+	require.NoError(t, err)
+
+	ctx := contexts.WithCRE(t.Context(), contexts.CRE{Owner: "owner-id", Workflow: "foo"})
+
+	assert.NoError(t, gl.AllowErr(contexts.WithChainSelector(ctx, 3379446385462418246)))
+	assert.NoError(t, gl.AllowErr(contexts.WithChainSelector(ctx, 12922642891491394802)))
+	assert.ErrorIs(t, gl.AllowErr(contexts.WithChainSelector(ctx, 1234)), limits.ErrorNotAllowed{})
+}

pkg/settings/json.go

@@ -8,14 +8,16 @@ import (
 	"io/fs"
 	"maps"
 	"slices"
+	"strconv"
 	"strings"
 )
 
 // CombineJSONFiles reads a set of JSON config files and combines them in to one file. The expected inputs are:
-//	- global.json
-// 	- org/*.json
-// 	- owner/*.json
-// 	- workflow/*.json
+//   - global.json
+//   - org/*.json
+//   - owner/*.json
+//   - workflow/*.json
+//
 // The directory and file names translate to keys in the JSON structure, while the file extensions are discarded.
 // For example: owner/0x1234.json:Foo.Bar becomes owner.0x1234.Foo.Bar
 func CombineJSONFiles(files fs.FS) ([]byte, error) {
@@ -152,11 +154,17 @@ func (s *jsonSettings) get(key string) (string, error) {
 	}
 
 	field := parts[len(parts)-1]
-	switch t := m[field].(type) {
-	case string:
-		return t, nil
-	case json.Number:
-		return t.String(), nil
+	if val, ok := m[field]; ok {
+		switch t := val.(type) {
+		case string:
+			return t, nil
+		case json.Number:
+			return t.String(), nil
+		case bool:
+			return strconv.FormatBool(t), nil
+		default:
+			return "", fmt.Errorf("non-string value: %s: %t(%v)", key, val, val)
+		}
 	}
 	return "", nil // no value
 }
@@ -166,7 +174,7 @@ type jsonGetter struct {
 }
 
 // NewJSONGetter returns a static Getter backed by the given JSON.
-//TODO https://smartcontract-it.atlassian.net/browse/CAPPL-775
+// TODO https://smartcontract-it.atlassian.net/browse/CAPPL-775
 // NewJSONRegistry with polling & subscriptions
 func NewJSONGetter(b []byte) (Getter, error) {
 	s, err := newJSONSettings(b)

pkg/settings/keys.go

@@ -17,8 +17,9 @@ func (s Scope) rawKeys(ctx context.Context, key string) (keys []string, err erro
 			if i.IsTenantRequired() {
 				err = errors.Join(err, fmt.Errorf("empty %s key", i))
 			}
+		} else {
+			keys = append(keys, i.String()+"."+tenant+"."+key)
 		}
-		keys = append(keys, i.String()+"."+tenant+"."+key)
 	}
 	keys = append(keys, ScopeGlobal.String()+"."+key) // ScopeGlobal
 	return

pkg/settings/limits/bound.go

@@ -54,9 +54,8 @@ func newBoundLimiter[N Number](f Factory, bound settings.Setting[N]) (BoundLimit
 		updater: newUpdater[N](nil, func(ctx context.Context) (N, error) {
 			return bound.GetOrDefault(ctx, f.Settings)
 		}, nil),
-		defaultBound: bound.DefaultValue,
-		key:          bound.Key,
-		scope:        bound.Scope,
+		key:   bound.Key,
+		scope: bound.Scope,
 	}
 	b.updater.recordLimit = func(ctx context.Context, n N) { b.recordBound(ctx, n) }
 
@@ -115,7 +114,6 @@ func newBoundLimiter[N Number](f Factory, bound settings.Setting[N]) (BoundLimit
 
 type boundLimiter[N Number] struct {
 	*updater[N]
-	defaultBound N
 
 	key   string // optional
 	scope settings.Scope