core/config/docs: config enhancements (#17091)

Author: jmank88

GNUmakefile

@@ -39,7 +39,7 @@ gomodtidy: gomods ## Run go mod tidy on all modules.
 
 .PHONY: tidy
 tidy: gomodtidy ## Tidy all modules and add to git.
-	git add '**go.*'
+	git add '**go.*' 'plugins/plugins.public.yaml'
 
 .PHONY: docs
 docs: ## Install and run pkgsite to view Go docs

core/cmd/blocks_commands_test.go

@@ -44,7 +44,7 @@ func Test_ReplayFromBlock(t *testing.T) {
 		require.NoError(t, set.Set("chain-id", "1"))
 		require.NoError(t, set.Set("family", "evm"))
 		c = cli.NewContext(nil, set, nil)
-		require.ErrorContains(t, client.ReplayFromBlock(c), "does not match any local chains")
+		require.ErrorContains(t, client.ReplayFromBlock(c), "chain id does not exist: 1")
 
 		// Incorrect chain family
 		require.NoError(t, set.Set("chain-id", "5"))

core/cmd/node_commands_test.go

@@ -98,7 +98,7 @@ func TestShell_IndexEVMNodes(t *testing.T) {
 
 func solanaStartNewApplication(t *testing.T, cfgs ...*solcfg.TOMLConfig) *cltest.TestApplication {
 	for i := range cfgs {
-		cfgs[i].Chain.SetDefaults()
+		cfgs[i].SetDefaults()
 	}
 	return startNewApplicationV2(t, func(c *chainlink.Config, s *chainlink.Secrets) {
 		c.Solana = cfgs

core/cmd/shell_remote_test.go

@@ -139,7 +139,7 @@ func TestShell_ReplayBlocks(t *testing.T) {
 	require.NoError(t, set.Set("chain-id", "12345678"))
 	require.NoError(t, set.Set("family", "evm"))
 	c := cli.NewContext(nil, set, nil)
-	assert.ErrorContains(t, client.ReplayFromBlock(c), "chain id does not match any local chains")
+	assert.ErrorContains(t, client.ReplayFromBlock(c), "chain id does not exist: 12345678") //nolint:testifylint // non-fatal
 
 	require.NoError(t, set.Set("chain-id", testutils.FixtureChainID.String()))
 	c = cli.NewContext(nil, set, nil)

core/cmd/shell_test.go

@@ -360,40 +360,39 @@ func TestSetupSolanaRelayer(t *testing.T) {
 
 	// config 3 chains but only enable 2 => should only be 2 relayer
 	nEnabledChains := 2
-	chainCfg := solcfg.Chain{}
-	chainCfg.SetDefaults()
+
 	tConfig := configtest.NewGeneralConfig(t, func(c *chainlink.Config, s *chainlink.Secrets) {
 		c.Solana = solcfg.TOMLConfigs{
 			&solcfg.TOMLConfig{
 				ChainID: ptr[string]("solana-id-1"),
 				Enabled: ptr(true),
-				Chain:   chainCfg,
 				Nodes:   []*solcfg.Node{},
 			},
 			&solcfg.TOMLConfig{
 				ChainID: ptr[string]("solana-id-2"),
 				Enabled: ptr(true),
-				Chain:   chainCfg,
 				Nodes:   []*solcfg.Node{},
 			},
 			&solcfg.TOMLConfig{
 				ChainID: ptr[string]("disabled-solana-id-1"),
 				Enabled: ptr(false),
-				Chain:   chainCfg,
 				Nodes:   []*solcfg.Node{},
 			},
 		}
+		for i := range c.Solana {
+			c.Solana[i].SetDefaults()
+		}
 	})
 
 	t2Config := configtest.NewGeneralConfig(t, func(c *chainlink.Config, s *chainlink.Secrets) {
 		c.Solana = solcfg.TOMLConfigs{
 			&solcfg.TOMLConfig{
 				ChainID: ptr[string]("solana-id-1"),
 				Enabled: ptr(true),
-				Chain:   solcfg.Chain{},
 				Nodes:   []*solcfg.Node{},
 			},
 		}
+		c.Solana[0].SetDefaults()
 	})
 
 	rf := chainlink.RelayerFactory{
@@ -432,16 +431,15 @@ func TestSetupSolanaRelayer(t *testing.T) {
 			&solcfg.TOMLConfig{
 				ChainID: ptr[string]("dupe"),
 				Enabled: ptr(true),
-				Chain:   chainCfg,
-				Nodes:   []*solcfg.Node{},
 			},
 			&solcfg.TOMLConfig{
 				ChainID: ptr[string]("dupe"),
 				Enabled: ptr(true),
-				Chain:   chainCfg,
-				Nodes:   []*solcfg.Node{},
 			},
 		}
+		for i := range c.Solana {
+			c.Solana[i].SetDefaults()
+		}
 	})
 	dupCfg := chainlink.SolanaFactoryConfig{
 		TOMLConfigs: duplicateConfig.SolanaConfigs(),

core/config/docs/chains-evm.toml

@@ -1,6 +1,5 @@
 # EVM defaults depend on ChainID:
 #
-# **EXTENDED**
 [[EVM]]
 # ChainID is the EVM chain ID. Mandatory.
 ChainID = '1' # Example

core/config/docs/chains-solana.toml

@@ -2,7 +2,7 @@
 # ChainID is the Solana chain ID. Must be one of: mainnet, testnet, devnet, localnet. Mandatory.
 ChainID = 'mainnet' # Example
 # Enabled enables this chain.
-Enabled = false # Default
+Enabled = true # Default
 # BlockTime specifies the average time between blocks on this chain
 BlockTime = '500ms' # Default
 # BalancePollPeriod is the rate to poll for SOL balance and update Prometheus metrics.
@@ -59,6 +59,24 @@ EstimateComputeUnitLimit = false # Default
 # LogPollerStartingLookback
 LogPollerStartingLookback = '24h0m0s' # Default
 
+[Solana.Workflow]
+# AcceptanceTimeout is the default timeout for a tranmission to be accepted on chain
+AcceptanceTimeout = '45s' # Default
+# ForwarderAddress is the keystone forwarder program address on chain.
+ForwarderAddress = '14grJpemFaf88c8tiVb77W7TYg2W3ir6pfkKz3YjhhZ5' # Example
+# ForwarderState is the keystone forwarder program state account on chain.
+ForwarderState = '14grJpemFaf88c8tiVb77W7TYg2W3ir6pfkKz3YjhhZ5' # Example
+# FromAddress is Address of the transmitter key to use for workflow writes.
+FromAddress = '4BJXYkfvg37zEmBbsacZjeQDpTNx91KppxFJxRqrz48e' # Example
+# GasLimitDefault is the default gas limit for workflow transactions.
+GasLimitDefault = 300_000 # Default
+# Local defines if relayer runs against local devnet
+Local = false # Default
+# PollPeriod is the default poll period for checking transmission state
+PollPeriod = '3s' # Default
+# TxAcceptanceState is the default acceptance state for writer DON tranmissions.
+TxAcceptanceState = 3 # Default
+
 [Solana.MultiNode]
 # Enabled enables the multinode feature.
 Enabled = false # Default
@@ -95,24 +113,6 @@ FinalityTagEnabled = true # Default
 # FinalizedBlockOffset is the offset from the finalized block to use for finality tags.
 FinalizedBlockOffset = 0 # Default
 
-[Solana.Workflow]
-# AcceptanceTimeout is the default timeout for a tranmission to be accepted on chain
-AcceptanceTimeout = '45s' # Default
-# PollPeriod is the default poll period for checking transmission state
-PollPeriod = '3s' # Default
-# ForwarderAddress is the keystone forwarder program address on chain.
-ForwarderAddress = '14grJpemFaf88c8tiVb77W7TYg2W3ir6pfkKz3YjhhZ5' # Example
-# ForwarderState is the keystone forwarder program state account on chain.
-ForwarderState = '14grJpemFaf88c8tiVb77W7TYg2W3ir6pfkKz3YjhhZ5' # Example
-# FromAddress is Address of the transmitter key to use for workflow writes.
-FromAddress = '4BJXYkfvg37zEmBbsacZjeQDpTNx91KppxFJxRqrz48e' # Example
-# GasLimitDefault is the default gas limit for workflow transactions.
-GasLimitDefault = 300_000 # Default
-# TxAcceptanceState is the default acceptance state for writer DON tranmissions.
-TxAcceptanceState = 3 # Default
-# Local determines whether Relayer runs against a local devnet
-Local = false # Default
-
 [[Solana.Nodes]]
 # Name is a unique (per-chain) identifier for this node.
 Name = 'primary' # Example

core/config/docs/cmd/generate/main.go

@@ -6,7 +6,7 @@ import (
 	"flag"
 	"fmt"
 	"os"
-	"path"
+	"path/filepath"
 
 	"github.com/smartcontractkit/chainlink/v2/core/config/docs"
 )
@@ -26,11 +26,11 @@ func main() {
 		fmt.Fprintf(os.Stderr, "invalid secrets docs: %v\n", err)
 		os.Exit(1)
 	}
-	if err = os.WriteFile(path.Join(*outDir, "CONFIG.md"), []byte(c), 0600); err != nil {
+	if err = os.WriteFile(filepath.Join(*outDir, "CONFIG.md"), []byte(c), 0600); err != nil {
 		fmt.Fprintf(os.Stderr, "failed to write config docs: %v\n", err)
 		os.Exit(1)
 	}
-	if err = os.WriteFile(path.Join(*outDir, "SECRETS.md"), []byte(s), 0600); err != nil {
+	if err = os.WriteFile(filepath.Join(*outDir, "SECRETS.md"), []byte(s), 0600); err != nil {
 		fmt.Fprintf(os.Stderr, "failed to write secrets docs: %v\n", err)
 		os.Exit(1)
 	}

core/config/docs/defaults.go

@@ -5,18 +5,18 @@ import (
 	"strings"
 
 	"github.com/smartcontractkit/chainlink-common/pkg/config"
+	"github.com/smartcontractkit/chainlink-common/pkg/config/configdoc"
 	pgcommon "github.com/smartcontractkit/chainlink-common/pkg/sqlutil/pg"
 
 	"github.com/smartcontractkit/chainlink/v2/core/config/toml"
-	"github.com/smartcontractkit/chainlink/v2/core/services/chainlink/cfgtest"
 )
 
 var (
 	defaults toml.Core
 )
 
 func init() {
-	if err := cfgtest.DocDefaultsOnly(strings.NewReader(coreTOML), &defaults, config.DecodeTOML); err != nil {
+	if err := configdoc.DefaultsOnly(strings.NewReader(coreTOML), &defaults, config.DecodeTOML); err != nil {
 		log.Fatalf("Failed to initialize defaults from docs: %v", err)
 	}
 }

core/config/docs/defaults_test.go

@@ -3,9 +3,9 @@ package docs
 import (
 	"testing"
 
-	"github.com/smartcontractkit/chainlink/v2/core/services/chainlink/cfgtest"
+	"github.com/smartcontractkit/chainlink-common/pkg/config/configtest"
 )
 
 func TestCoreDefaults_notNil(t *testing.T) {
-	cfgtest.AssertFieldsNotNil(t, CoreDefaults())
+	configtest.AssertFieldsNotNil(t, CoreDefaults())
 }