Remove legacy Mercury plugin and associated code

.changeset/moody-swans-worry.md

@@ -0,0 +1,9 @@
+---
+"chainlink": major
+---
+
+Remove support for mercury #removed
+
+Remove support for wsrpc protocol for LLO
+
+Remove `Mercury.Cache` configuration options

core/cmd/shell.go

@@ -49,8 +49,6 @@ import (
 	"github.com/smartcontractkit/chainlink/v2/core/services/keystore"
 	"github.com/smartcontractkit/chainlink/v2/core/services/llo"
 	"github.com/smartcontractkit/chainlink/v2/core/services/periodicbackup"
-	"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/wsrpc"
-	"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/wsrpc/cache"
 	"github.com/smartcontractkit/chainlink/v2/core/services/versioning"
 	"github.com/smartcontractkit/chainlink/v2/core/services/webhook"
 	"github.com/smartcontractkit/chainlink/v2/core/services/workflows"
@@ -231,12 +229,6 @@ func (n ChainlinkAppFactory) NewApplication(ctx context.Context, cfg chainlink.G
 
 	loopRegistry := plugins.NewLoopRegistry(appLggr, cfg.Database(), cfg.Tracing(), cfg.Telemetry(), beholderAuthHeaders, csaPubKeyHex)
 
-	mercuryPool := wsrpc.NewPool(appLggr, cache.Config{
-		LatestReportTTL:      cfg.Mercury().Cache().LatestReportTTL(),
-		MaxStaleAge:          cfg.Mercury().Cache().MaxStaleAge(),
-		LatestReportDeadline: cfg.Mercury().Cache().LatestReportDeadline(),
-	})
-
 	capabilitiesRegistry := capabilities.NewRegistry(appLggr)
 
 	retirementReportCache := llo.NewRetirementReportCache(appLggr, ds)
@@ -249,7 +241,6 @@ func (n ChainlinkAppFactory) NewApplication(ctx context.Context, cfg chainlink.G
 		Registerer:            appRegisterer,
 		LoopRegistry:          loopRegistry,
 		GRPCOpts:              grpcOpts,
-		MercuryPool:           mercuryPool,
 		CapabilitiesRegistry:  capabilitiesRegistry,
 		HTTPClient:            unrestrictedClient,
 		RetirementReportCache: retirementReportCache,
@@ -325,7 +316,6 @@ func (n ChainlinkAppFactory) NewApplication(ctx context.Context, cfg chainlink.G
 		SecretGenerator:            chainlink.FilePersistedSecretGenerator{},
 		LoopRegistry:               loopRegistry,
 		GRPCOpts:                   grpcOpts,
-		MercuryPool:                mercuryPool,
 		RetirementReportCache:      retirementReportCache,
 		LLOTransmissionReaper:      lloReaper,
 	})

core/config/docs/core.toml

@@ -683,27 +683,6 @@ env = 'test' # Example
 # by default.
 VerboseLogging = false # Default
 
-# Mercury.Cache controls settings for the price retrieval cache querying a mercury server
-[Mercury.Cache]
-# LatestReportTTL controls how "stale" we will allow a price to be e.g. if
-# set to 1s, a new price will always be fetched if the last result was
-# from 1 second ago or older.
-# 
-# Another way of looking at it is such: the cache will _never_ return a
-# price that was queried from now-LatestReportTTL or before.
-# 
-# Setting to zero disables caching entirely.
-LatestReportTTL = "1s" # Default
-# MaxStaleAge is that maximum amount of time that a value can be stale
-# before it is deleted from the cache (a form of garbage collection).
-# 
-# This should generally be set to something much larger than
-# LatestReportTTL. Setting to zero disables garbage collection.
-MaxStaleAge = "1h" # Default
-# LatestReportDeadline controls how long to wait for a response from the
-# mercury server before retrying. Setting this to zero will wait indefinitely.
-LatestReportDeadline = "5s" # Default
-
 # Mercury.TLS controls client settings for when the node talks to traditional web servers or load balancers.
 [Mercury.TLS]
 # CertFile is the path to a PEM file of trusted root certificate authority certificates
@@ -713,8 +692,7 @@ CertFile = "/path/to/client/certs.pem" # Example
 [Mercury.Transmitter]
 # Protocol is the protocol to use for the transmitter.
 #
-# Options are either:
-# - "wsrpc" for the legacy websocket protocol
+# Options are currently:
 # - "grpc" for the gRPC protocol
 Protocol = "grpc" # Default
 # TransmitQueueMaxSize controls the size of the transmit queue. This is scoped

core/config/mercury_config.go

@@ -2,27 +2,19 @@ package config
 
 import (
 	"fmt"
-	"time"
 
 	commonconfig "github.com/smartcontractkit/chainlink-common/pkg/config"
 	"github.com/smartcontractkit/chainlink-common/pkg/types"
 )
 
-type MercuryCache interface {
-	LatestReportTTL() time.Duration
-	MaxStaleAge() time.Duration
-	LatestReportDeadline() time.Duration
-}
-
 type MercuryTLS interface {
 	CertFile() string
 }
 
 type MercuryTransmitterProtocol string
 
 const (
-	MercuryTransmitterProtocolWSRPC MercuryTransmitterProtocol = "wsrpc"
-	MercuryTransmitterProtocolGRPC  MercuryTransmitterProtocol = "grpc"
+	MercuryTransmitterProtocolGRPC MercuryTransmitterProtocol = "grpc"
 )
 
 func (m MercuryTransmitterProtocol) String() string {
@@ -31,8 +23,6 @@ func (m MercuryTransmitterProtocol) String() string {
 
 func (m *MercuryTransmitterProtocol) UnmarshalText(text []byte) error {
 	switch string(text) {
-	case "wsrpc":
-		*m = MercuryTransmitterProtocolWSRPC
 	case "grpc":
 		*m = MercuryTransmitterProtocolGRPC
 	default:
@@ -52,7 +42,6 @@ type MercuryTransmitter interface {
 
 type Mercury interface {
 	Credentials(credName string) *types.MercuryCredentials
-	Cache() MercuryCache
 	TLS() MercuryTLS
 	Transmitter() MercuryTransmitter
 	VerboseLogging() bool

core/config/toml/types.go

@@ -1422,24 +1422,6 @@ func (ins *Insecure) setFrom(f *Insecure) {
 	}
 }
 
-type MercuryCache struct {
-	LatestReportTTL      *commonconfig.Duration
-	MaxStaleAge          *commonconfig.Duration
-	LatestReportDeadline *commonconfig.Duration
-}
-
-func (mc *MercuryCache) setFrom(f *MercuryCache) {
-	if v := f.LatestReportTTL; v != nil {
-		mc.LatestReportTTL = v
-	}
-	if v := f.MaxStaleAge; v != nil {
-		mc.MaxStaleAge = v
-	}
-	if v := f.LatestReportDeadline; v != nil {
-		mc.LatestReportDeadline = v
-	}
-}
-
 type MercuryTLS struct {
 	CertFile *string
 }
@@ -1490,14 +1472,12 @@ func (m *MercuryTransmitter) setFrom(f *MercuryTransmitter) {
 }
 
 type Mercury struct {
-	Cache          MercuryCache       `toml:",omitempty"`
 	TLS            MercuryTLS         `toml:",omitempty"`
 	Transmitter    MercuryTransmitter `toml:",omitempty"`
 	VerboseLogging *bool              `toml:",omitempty"`
 }
 
 func (m *Mercury) setFrom(f *Mercury) {
-	m.Cache.setFrom(&f.Cache)
 	m.TLS.setFrom(&f.TLS)
 	m.Transmitter.setFrom(&f.Transmitter)
 	if v := f.VerboseLogging; v != nil {

core/internal/cltest/cltest.go

@@ -86,8 +86,6 @@
 	p2ptypes "github.com/smartcontractkit/chainlink/v2/core/services/p2p/types"
 	"github.com/smartcontractkit/chainlink/v2/core/services/pg"
 	"github.com/smartcontractkit/chainlink/v2/core/services/pipeline"
-	"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/wsrpc"
-	"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/wsrpc/cache"
 	"github.com/smartcontractkit/chainlink/v2/core/services/standardcapabilities"
 	"github.com/smartcontractkit/chainlink/v2/core/services/webhook"
 	clsessions "github.com/smartcontractkit/chainlink/v2/core/sessions"
@@ -263,10 +261,10 @@
 	}
 
 	if len(app.Keys) == 0 {
 		k, _ := MustInsertRandomKey(t, app.KeyStore.Eth(), chainID)
 		app.Keys = []ethkey.KeyV2{k}
 	} else {
 		id, ks := chainID.ToInt(), app.KeyStore.Eth()
 		for _, k := range app.Keys {
 			ks.XXXTestingOnlyAdd(ctx, k)
 			require.NoError(t, ks.Add(ctx, k.Address, id))
@@ -285,11 +283,11 @@
 		case ethkey.KeyV2:
 			app.Keys = append(app.Keys, v)
 		case p2pkey.KeyV2:
 			require.NoError(t, app.GetKeyStore().P2P().Add(ctx, v))
 		case csakey.KeyV2:
 			require.NoError(t, app.GetKeyStore().CSA().Add(ctx, v))
 		case ocr2key.KeyBundle:
 			require.NoError(t, app.GetKeyStore().OCR2().Add(ctx, v))
 		}
 	}
 
@@ -415,20 +413,13 @@
 	mailMon := mailbox.NewMonitor(cfg.AppID().String(), lggr.Named("Mailbox"))
 	loopRegistry := plugins.NewLoopRegistry(lggr, cfg.Database(), cfg.Tracing(), cfg.Telemetry(), nil, "")
 
-	mercuryPool := wsrpc.NewPool(lggr, cache.Config{
-		LatestReportTTL:      cfg.Mercury().Cache().LatestReportTTL(),
-		MaxStaleAge:          cfg.Mercury().Cache().MaxStaleAge(),
-		LatestReportDeadline: cfg.Mercury().Cache().LatestReportDeadline(),
-	})
-
 	c := clhttptest.NewTestLocalOnlyHTTPClient()
 	retirementReportCache := llo.NewRetirementReportCache(lggr, ds)
 	relayerFactory := chainlink.RelayerFactory{
 		Logger:                lggr,
 		LoopRegistry:          loopRegistry,
 		GRPCOpts:              loop.GRPCOpts{},
 		Registerer:            prometheus.NewRegistry(), // Don't use global registry here since otherwise multiple apps can create name conflicts. Could also potentially give a mock registry to test prometheus.
-		MercuryPool:           mercuryPool,
 		CapabilitiesRegistry:  capabilitiesRegistry,
 		HTTPClient:            c,
 		RetirementReportCache: retirementReportCache,
@@ -510,7 +501,9 @@
 		UnrestrictedHTTPClient:     c,
 		SecretGenerator:            MockSecretGenerator{},
 		LoopRegistry:               plugins.NewTestLoopRegistry(lggr),
-		MercuryPool:                mercuryPool,
+		CapabilitiesRegistry:       capabilitiesRegistry,
+		CapabilitiesDispatcher:     dispatcher,
+		CapabilitiesPeerWrapper:    peerWrapper,
 		NewOracleFactoryFn:         newOracleFactoryFn,
 		RetirementReportCache:      retirementReportCache,
 		LLOTransmissionReaper:      llo.NewTransmissionReaper(ds, lggr, cfg.Mercury().Transmitter().ReaperFrequency().Duration(), cfg.Mercury().Transmitter().ReaperMaxAge().Duration()),
@@ -656,15 +649,15 @@
 	ctx := testutils.Context(ta.t)
 	session := NewSession()
 	ta.Logger.Infof("TestApplication creating session (id: %s, email: %s, last used: %s)", session.ID, email, session.LastUsed.String())
 	err := ta.GetDB().GetContext(ctx, &id, `INSERT INTO sessions (id, email, last_used, created_at) VALUES ($1, $2, $3, NOW()) RETURNING id`, session.ID, email, session.LastUsed)
 	require.NoError(ta.t, err)
 	return id
 }
 
 // ImportKey adds private key to the application keystore and database
 func (ta *TestApplication) Import(ctx context.Context, content string) {
 	require.NoError(ta.t, ta.KeyStore.Unlock(ctx, Password))
 	_, err := ta.KeyStore.Eth().Import(ctx, []byte(content), Password, &FixtureChainID)
 	require.NoError(ta.t, err)
 }
 
@@ -692,7 +685,7 @@
 	u, err := clsessions.NewUser(user.Email, Password, user.Role)
 	require.NoError(ta.t, err)
 
 	err = ta.BasicAdminUsersORM().CreateUser(ctx, &u)
 	require.NoError(ta.t, err)
 
 	sessionID := ta.MustSeedNewSession(user.Email)
@@ -714,7 +707,7 @@
 	lggr := logger.TestLogger(ta.t)
 	client := &cmd.Shell{
 		Renderer:                       r,
 		Config:                         ta.GetConfig(),
 		Logger:                         lggr,
 		AppFactory:                     seededAppFactory{ta.ChainlinkApplication},
 		FallbackAPIInitializer:         NewMockAPIInitializer(ta.t),

core/services/chainlink/application.go

@@ -67,8 +67,6 @@ import (
 	"github.com/smartcontractkit/chainlink/v2/core/services/periodicbackup"
 	"github.com/smartcontractkit/chainlink/v2/core/services/pipeline"
 	"github.com/smartcontractkit/chainlink/v2/core/services/registrysyncer"
-	"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury"
-	"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/wsrpc"
 	"github.com/smartcontractkit/chainlink/v2/core/services/standardcapabilities"
 	"github.com/smartcontractkit/chainlink/v2/core/services/streams"
 	"github.com/smartcontractkit/chainlink/v2/core/services/telemetry"
@@ -195,7 +193,6 @@ type ApplicationOpts struct {
 	SecretGenerator            SecretGenerator
 	LoopRegistry               *plugins.LoopRegistry
 	GRPCOpts                   loop.GRPCOpts
-	MercuryPool                wsrpc.Pool
 	RetirementReportCache      llo.RetirementReportCache
 	LLOTransmissionReaper      services.ServiceCtx
 	NewOracleFactoryFn         standardcapabilities.NewOracleFactoryFn
@@ -349,10 +346,7 @@ func NewApplication(opts ApplicationOpts) (Application, error) {
 		globalLogger.Info("DatabaseBackup: periodic database backups are disabled. To enable automatic backups, set Database.Backup.Mode=lite or Database.Backup.Mode=full")
 	}
 
-	// pool must be started before all relayers and stopped after them
-	if opts.MercuryPool != nil {
-		srvcs = append(srvcs, opts.MercuryPool)
-	}
+	// LLO-related services
 	if opts.RetirementReportCache != nil {
 		srvcs = append(srvcs, opts.RetirementReportCache)
 	}
@@ -403,7 +397,6 @@ func NewApplication(opts ApplicationOpts) (Application, error) {
 	var (
 		pipelineORM    = pipeline.NewORM(opts.DS, globalLogger, cfg.JobPipeline().MaxSuccessfulRuns())
 		bridgeORM      = bridges.NewORM(opts.DS)
-		mercuryORM     = mercury.NewORM(opts.DS)
 		pipelineRunner = pipeline.NewRunner(pipelineORM, bridgeORM, cfg.JobPipeline(), cfg.WebServer(), legacyEVMChains, keyStore.Eth(), keyStore.VRF(), globalLogger, restrictedHTTPClient, unrestrictedHTTPClient)
 		jobORM         = job.NewORM(opts.DS, pipelineORM, bridgeORM, keyStore, globalLogger)
 		txmORM         = txmgr.NewTxStore(opts.DS, globalLogger)
@@ -565,7 +558,6 @@ func NewApplication(opts ApplicationOpts) (Application, error) {
 				Ds:                    opts.DS,
 				JobORM:                jobORM,
 				BridgeORM:             bridgeORM,
-				MercuryORM:            mercuryORM,
 				PipelineRunner:        pipelineRunner,
 				StreamRegistry:        streamRegistry,
 				PeerWrapper:           peerWrapper,

core/services/chainlink/config_mercury.go

@@ -1,31 +1,13 @@
 package chainlink
 
 import (
-	"time"
-
 	commonconfig "github.com/smartcontractkit/chainlink-common/pkg/config"
 	"github.com/smartcontractkit/chainlink-common/pkg/types"
 
 	"github.com/smartcontractkit/chainlink/v2/core/config"
 	"github.com/smartcontractkit/chainlink/v2/core/config/toml"
 )
 
-var _ config.MercuryCache = (*mercuryCacheConfig)(nil)
-
-type mercuryCacheConfig struct {
-	c toml.MercuryCache
-}
-
-func (m *mercuryCacheConfig) LatestReportTTL() time.Duration {
-	return m.c.LatestReportTTL.Duration()
-}
-func (m *mercuryCacheConfig) MaxStaleAge() time.Duration {
-	return m.c.MaxStaleAge.Duration()
-}
-func (m *mercuryCacheConfig) LatestReportDeadline() time.Duration {
-	return m.c.LatestReportDeadline.Duration()
-}
-
 var _ config.MercuryTLS = (*mercuryTLSConfig)(nil)
 
 type mercuryTLSConfig struct {
@@ -86,10 +68,6 @@ func (m *mercuryConfig) Credentials(credName string) *types.MercuryCredentials {
 	return nil
 }
 
-func (m *mercuryConfig) Cache() config.MercuryCache {
-	return &mercuryCacheConfig{c: m.c.Cache}
-}
-
 func (m *mercuryConfig) TLS() config.MercuryTLS {
 	return &mercuryTLSConfig{c: m.c.TLS}
 }

core/services/chainlink/config_test.go

@@ -789,11 +789,6 @@ func TestConfig_Marshal(t *testing.T) {
 		},
 	}
 	full.Mercury = toml.Mercury{
-		Cache: toml.MercuryCache{
-			LatestReportTTL:      commoncfg.MustNewDuration(100 * time.Second),
-			MaxStaleAge:          commoncfg.MustNewDuration(101 * time.Second),
-			LatestReportDeadline: commoncfg.MustNewDuration(102 * time.Second),
-		},
 		TLS: toml.MercuryTLS{
 			CertFile: ptr("/path/to/cert.pem"),
 		},
@@ -1268,11 +1263,6 @@ SendOnly = true
 		{"Mercury", Config{Core: toml.Core{Mercury: full.Mercury}}, `[Mercury]
 VerboseLogging = true
 
-[Mercury.Cache]
-LatestReportTTL = '1m40s'
-MaxStaleAge = '1m41s'
-LatestReportDeadline = '1m42s'
-
 [Mercury.TLS]
 CertFile = '/path/to/cert.pem'
 

core/services/chainlink/relayer_factory.go

@@ -25,7 +25,6 @@ import (
 	"github.com/smartcontractkit/chainlink/v2/core/services/relay"
 	"github.com/smartcontractkit/chainlink/v2/core/services/relay/dummy"
 	evmrelay "github.com/smartcontractkit/chainlink/v2/core/services/relay/evm"
-	"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/wsrpc"
 	"github.com/smartcontractkit/chainlink/v2/plugins"
 )
 
@@ -34,7 +33,6 @@ type RelayerFactory struct {
 	*plugins.LoopRegistry
 	loop.GRPCOpts
 	Registerer            prometheus.Registerer
-	MercuryPool           wsrpc.Pool
 	CapabilitiesRegistry  coretypes.CapabilitiesRegistry
 	HTTPClient            *http.Client
 	RetirementReportCache llo.RetirementReportCache
@@ -80,7 +78,6 @@ func (r *RelayerFactory) NewEVM(ctx context.Context, config EVMFactoryConfig) (m
 			DS:                    ccOpts.DS,
 			Registerer:            r.Registerer,
 			CSAETHKeystore:        config.CSAETHKeystore,
-			MercuryPool:           r.MercuryPool,
 			MercuryConfig:         config.MercuryConfig,
 			CapabilitiesRegistry:  r.CapabilitiesRegistry,
 			HTTPClient:            r.HTTPClient,

core/services/chainlink/testdata/config-empty-effective.toml

@@ -227,11 +227,6 @@ TLSCertPath = ''
 [Mercury]
 VerboseLogging = false
 
-[Mercury.Cache]
-LatestReportTTL = '1s'
-MaxStaleAge = '1h0m0s'
-LatestReportDeadline = '5s'
-
 [Mercury.TLS]
 CertFile = ''
 

core/services/chainlink/testdata/config-full.toml

@@ -237,11 +237,6 @@ test = 'load'
 [Mercury]
 VerboseLogging = true
 
-[Mercury.Cache]
-LatestReportTTL = '1m40s'
-MaxStaleAge = '1m41s'
-LatestReportDeadline = '1m42s'
-
 [Mercury.TLS]
 CertFile = '/path/to/cert.pem'
 

core/services/chainlink/testdata/config-multi-chain-effective.toml

@@ -227,11 +227,6 @@ TLSCertPath = ''
 [Mercury]
 VerboseLogging = false
 
-[Mercury.Cache]
-LatestReportTTL = '1s'
-MaxStaleAge = '1h0m0s'
-LatestReportDeadline = '5s'
-
 [Mercury.TLS]
 CertFile = ''