refactor: move crosschain flags to core context in zetaclient

changelog.md

@@ -19,6 +19,7 @@
 * [1848](https://github.com/zeta-chain/node/issues/1848) - create a method to observe deposits to tss address in one evm block
 * [1885](https://github.com/zeta-chain/node/pull/1885) - change important metrics on port 8123 to be prometheus compatible
 * [1863](https://github.com/zeta-chain/node/pull/1863) - remove duplicate ValidateChainParams function
+* [1914](https://github.com/zeta-chain/node/pull/1914) - move crosschain flags to core context in zetaclient
 
 ### Features
 

cmd/zetaclientd/utils.go

@@ -55,13 +55,15 @@ func CreateSignerMap(
 	loggers clientcommon.ClientLogger,
 	ts *metrics.TelemetryServer,
 ) (map[int64]interfaces.ChainSigner, error) {
+	coreContext := appContext.ZetaCoreContext()
 	signerMap := make(map[int64]interfaces.ChainSigner)
+
 	// EVM signers
 	for _, evmConfig := range appContext.Config().GetAllEVMConfigs() {
 		if evmConfig.Chain.IsZetaChain() {
 			continue
 		}
-		evmChainParams, found := appContext.ZetaCoreContext().GetEVMChainParams(evmConfig.Chain.ChainId)
+		evmChainParams, found := coreContext.GetEVMChainParams(evmConfig.Chain.ChainId)
 		if !found {
 			loggers.Std.Error().Msgf("ChainParam not found for chain %s", evmConfig.Chain.String())
 			continue
@@ -71,7 +73,17 @@ func CreateSignerMap(
 		}
 		mpiAddress := ethcommon.HexToAddress(evmChainParams.ConnectorContractAddress)
 		erc20CustodyAddress := ethcommon.HexToAddress(evmChainParams.Erc20CustodyContractAddress)
-		signer, err := evm.NewEVMSigner(evmConfig.Chain, evmConfig.Endpoint, tss, config.GetConnectorABI(), config.GetERC20CustodyABI(), mpiAddress, erc20CustodyAddress, loggers, ts)
+		signer, err := evm.NewEVMSigner(
+			evmConfig.Chain,
+			evmConfig.Endpoint,
+			tss,
+			config.GetConnectorABI(),
+			config.GetERC20CustodyABI(),
+			mpiAddress,
+			erc20CustodyAddress,
+			coreContext,
+			loggers,
+			ts)
 		if err != nil {
 			loggers.Std.Error().Err(err).Msgf("NewEVMSigner error for chain %s", evmConfig.Chain.String())
 			continue
@@ -81,7 +93,7 @@ func CreateSignerMap(
 	// BTC signer
 	btcChain, btcConfig, enabled := appContext.GetBTCChainAndConfig()
 	if enabled {
-		signer, err := bitcoin.NewBTCSigner(btcConfig, tss, loggers, ts)
+		signer, err := bitcoin.NewBTCSigner(btcConfig, tss, loggers, ts, coreContext)
 		if err != nil {
 			loggers.Std.Error().Err(err).Msgf("NewBTCSigner error for chain %s", btcChain.String())
 		} else {

zetaclient/bitcoin/bitcoin_client.go

@@ -13,6 +13,8 @@
 	"sync/atomic"
 	"time"
 
+	corecontext "github.com/zeta-chain/zetacore/zetaclient/core_context"
+
 	appcontext "github.com/zeta-chain/zetacore/zetaclient/app_context"
 	clientcommon "github.com/zeta-chain/zetacore/zetaclient/common"
 	"github.com/zeta-chain/zetacore/zetaclient/compliance"
@@ -76,6 +78,7 @@
 	broadcastedTx     map[string]string                        // key: chain-tss-nonce, value: outTx hash
 	utxos             []btcjson.ListUnspentResult
 	params            observertypes.ChainParams
+	coreContext       *corecontext.ZetaCoreContext
 
 	db     *gorm.DB
 	stop   chan struct{}
@@ -167,6 +170,7 @@
 
 	ob.zetaClient = bridge
 	ob.Tss = tss
+	ob.coreContext = appcontext.ZetaCoreContext()
 	ob.includedTxHashes = make(map[string]bool)
 	ob.includedTxResults = make(map[string]*btcjson.GetTransactionResult)
 	ob.broadcastedTx = make(map[string]string)
@@ -328,7 +332,7 @@
 	for {
 		select {
 		case <-ticker.C():
-			err := ob.observeInTx()
+			err := ob.ObserveInTx()
 			if err != nil {
 				ob.logger.WatchInTx.Error().Err(err).Msg("WatchInTx error observing in tx")
 			}
@@ -375,12 +379,9 @@
 	return err
 }
 
-func (ob *BTCChainClient) observeInTx() error {
+func (ob *BTCChainClient) ObserveInTx() error {
 	// make sure inbound TXS / Send is enabled by the protocol
-	flags, err := ob.zetaClient.GetCrosschainFlags()
-	if err != nil {
-		return err
-	}
+	flags := ob.coreContext.GetCrossChainFlags()
 	if !flags.IsInboundEnabled {
 		return errors.New("inbound TXS / Send has been disabled by the protocol")
 	}

zetaclient/bitcoin/bitcoin_client_rpc_test.go

@@ -47,7 +47,7 @@ func (suite *BitcoinClientTestSuite) SetupTest() {
 		PrivKey: privateKey,
 	}
 	appContext := appcontext.NewAppContext(&corecontext.ZetaCoreContext{}, config.Config{})
-	client, err := NewBitcoinClient(appContext, common.BtcRegtestChain(), nil, tss, "/tmp",
+	client, err := NewBitcoinClient(appContext, common.BtcRegtestChain(), nil, tss, tempSQLiteDbPath,
 		clientcommon.DefaultLoggers(), config.BTCConfig{}, nil)
 	suite.Require().NoError(err)
 	suite.BitcoinChainClient = client

zetaclient/bitcoin/bitcoin_client_test.go

@@ -16,20 +16,47 @@ import (
 	"github.com/rs/zerolog/log"
 	"github.com/stretchr/testify/require"
 	"github.com/zeta-chain/zetacore/common"
+	"github.com/zeta-chain/zetacore/testutil/sample"
 	observertypes "github.com/zeta-chain/zetacore/x/observer/types"
+	appcontext "github.com/zeta-chain/zetacore/zetaclient/app_context"
 	clientcommon "github.com/zeta-chain/zetacore/zetaclient/common"
+	"github.com/zeta-chain/zetacore/zetaclient/config"
+	corecontext "github.com/zeta-chain/zetacore/zetaclient/core_context"
+	"github.com/zeta-chain/zetacore/zetaclient/metrics"
 	"github.com/zeta-chain/zetacore/zetaclient/testutils"
 	"github.com/zeta-chain/zetacore/zetaclient/testutils/stub"
 )
 
 func MockBTCClientMainnet() *BTCChainClient {
+	cfg := config.NewConfig()
+	coreContext := corecontext.NewZetaCoreContext(cfg)
+
 	return &BTCChainClient{
-		chain:      common.BtcMainnetChain(),
-		zetaClient: stub.NewMockZetaCoreBridge(),
-		Tss:        stub.NewTSSMainnet(),
+		chain:       common.BtcMainnetChain(),
+		zetaClient:  stub.NewMockZetaCoreBridge(),
+		Tss:         stub.NewTSSMainnet(),
+		coreContext: coreContext,
 	}
 }
 
+func TestNewBitcoinClient(t *testing.T) {
+	t.Run("should return error because zetacore doesn't update core context", func(t *testing.T) {
+		cfg := config.NewConfig()
+		coreContext := corecontext.NewZetaCoreContext(cfg)
+		appContext := appcontext.NewAppContext(coreContext, cfg)
+		chain := common.BtcMainnetChain()
+		bridge := stub.NewMockZetaCoreBridge()
+		tss := stub.NewMockTSS(sample.EthAddress().String(), "")
+		loggers := clientcommon.ClientLogger{}
+		btcCfg := cfg.BitcoinConfig
+		ts := metrics.NewTelemetryServer()
+
+		client, err := NewBitcoinClient(appContext, chain, bridge, tss, tempSQLiteDbPath, loggers, btcCfg, ts)
+		require.ErrorContains(t, err, "btc chains params not initialized")
+		require.Nil(t, client)
+	})
+}
+
 func TestConfirmationThreshold(t *testing.T) {
 	client := &BTCChainClient{Mu: &sync.Mutex{}}
 	t.Run("should return confirmations in chain param", func(t *testing.T) {
@@ -320,3 +347,12 @@ func TestCheckTSSVoutCancelled(t *testing.T) {
 		require.ErrorContains(t, err, "not match TSS address")
 	})
 }
+
+func TestBTCChainClient_ObserveInTx(t *testing.T) {
+	t.Run("should return error", func(t *testing.T) {
+		// create mainnet mock client
+		btcClient := MockBTCClientMainnet()
+		err := btcClient.ObserveInTx()
+		require.ErrorContains(t, err, "inbound TXS / Send has been disabled by the protocol")
+	})
+}

zetaclient/bitcoin/bitcoin_signer.go

@@ -8,6 +8,8 @@
 	"math/rand"
 	"time"
 
+	corecontext "github.com/zeta-chain/zetacore/zetaclient/core_context"
+
 	ethcommon "github.com/ethereum/go-ethereum/common"
 	clientcommon "github.com/zeta-chain/zetacore/zetaclient/common"
 	"github.com/zeta-chain/zetacore/zetaclient/compliance"
@@ -43,6 +45,7 @@
 	logger           zerolog.Logger
 	loggerCompliance zerolog.Logger
 	ts               *metrics.TelemetryServer
+	coreContext      *corecontext.ZetaCoreContext
 }
 
 var _ interfaces.ChainSigner = &BTCSigner{}
@@ -51,7 +54,8 @@
 	cfg config.BTCConfig,
 	tssSigner interfaces.TSSSigner,
 	loggers clientcommon.ClientLogger,
-	ts *metrics.TelemetryServer) (*BTCSigner, error) {
+	ts *metrics.TelemetryServer,
+	coreContext *corecontext.ZetaCoreContext) (*BTCSigner, error) {
 	connCfg := &rpcclient.ConnConfig{
 		Host:         cfg.RPCHost,
 		User:         cfg.RPCUsername,
@@ -71,6 +75,7 @@
 		logger:           loggers.Std.With().Str("chain", "BTC").Str("module", "BTCSigner").Logger(),
 		loggerCompliance: loggers.Compliance,
 		ts:               ts,
+		coreContext:      coreContext,
 	}, nil
 }
 
@@ -291,11 +296,7 @@
 		logger.Error().Msgf("chain client is not a bitcoin client")
 		return
 	}
-	flags, err := zetaBridge.GetCrosschainFlags()
-	if err != nil {
-		logger.Error().Err(err).Msgf("cannot get crosschain flags")
-		return
-	}
+	flags := signer.coreContext.GetCrossChainFlags()
 	if !flags.IsOutboundEnabled {
 		logger.Info().Msgf("outbound is disabled")
 		return

zetaclient/bitcoin/bitcoin_signer_test.go

@@ -9,10 +9,6 @@ import (
 	"sync"
 	"testing"
 
-	clientcommon "github.com/zeta-chain/zetacore/zetaclient/common"
-	"github.com/zeta-chain/zetacore/zetaclient/interfaces"
-	"github.com/zeta-chain/zetacore/zetaclient/metrics"
-
 	"github.com/btcsuite/btcd/blockchain"
 	"github.com/btcsuite/btcd/btcec"
 	"github.com/btcsuite/btcd/btcjson"
@@ -24,7 +20,11 @@ import (
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/stretchr/testify/require"
 	"github.com/zeta-chain/zetacore/common"
+	clientcommon "github.com/zeta-chain/zetacore/zetaclient/common"
 	"github.com/zeta-chain/zetacore/zetaclient/config"
+	corecontext "github.com/zeta-chain/zetacore/zetaclient/core_context"
+	"github.com/zeta-chain/zetacore/zetaclient/interfaces"
+	"github.com/zeta-chain/zetacore/zetaclient/metrics"
 	. "gopkg.in/check.v1"
 )
 
@@ -75,7 +75,13 @@ func (s *BTCSignerSuite) SetUpTest(c *C) {
 	tss := interfaces.TestSigner{
 		PrivKey: privateKey,
 	}
-	s.btcSigner, err = NewBTCSigner(config.BTCConfig{}, &tss, clientcommon.DefaultLoggers(), &metrics.TelemetryServer{})
+	cfg := config.NewConfig()
+	s.btcSigner, err = NewBTCSigner(
+		config.BTCConfig{},
+		&tss,
+		clientcommon.DefaultLoggers(),
+		&metrics.TelemetryServer{},
+		corecontext.NewZetaCoreContext(cfg))
 	c.Assert(err, IsNil)
 }
 

zetaclient/core_context/zeta_core_context.go

@@ -20,6 +20,7 @@ type ZetaCoreContext struct {
 	evmChainParams     map[int64]*observertypes.ChainParams
 	bitcoinChainParams *observertypes.ChainParams
 	currentTssPubkey   string
+	crossChainFlags    observertypes.CrosschainFlags
 }
 
 // NewZetaCoreContext creates and returns new ZetaCoreContext
@@ -39,6 +40,7 @@ func NewZetaCoreContext(cfg config.Config) *ZetaCoreContext {
 		chainsEnabled:      []common.Chain{},
 		evmChainParams:     evmChainParams,
 		bitcoinChainParams: bitcoinChainParams,
+		crossChainFlags:    observertypes.CrosschainFlags{},
 	}
 }
 
@@ -106,6 +108,12 @@ func (c *ZetaCoreContext) GetBTCChainParams() (common.Chain, *observertypes.Chai
 	return *chain, c.bitcoinChainParams, true
 }
 
+func (c *ZetaCoreContext) GetCrossChainFlags() observertypes.CrosschainFlags {
+	c.coreContextLock.RLock()
+	defer c.coreContextLock.RUnlock()
+	return c.crossChainFlags
+}
+
 // Update updates core context and params for all chains
 // this must be the ONLY function that writes to core context
 func (c *ZetaCoreContext) Update(
@@ -114,6 +122,7 @@ func (c *ZetaCoreContext) Update(
 	evmChainParams map[int64]*observertypes.ChainParams,
 	btcChainParams *observertypes.ChainParams,
 	tssPubKey string,
+	crosschainFlags observertypes.CrosschainFlags,
 	init bool,
 	logger zerolog.Logger,
 ) {
@@ -148,8 +157,11 @@ func (c *ZetaCoreContext) Update(
 			}
 		}
 	}
-	c.keygen = *keygen
+	if keygen != nil {
+		c.keygen = *keygen
+	}
 	c.chainsEnabled = newChains
+	c.crossChainFlags = crosschainFlags
 	// update chain params for bitcoin if it has config in file
 	if c.bitcoinChainParams != nil && btcChainParams != nil {
 		c.bitcoinChainParams = btcChainParams

zetaclient/core_context/zeta_core_context_test.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 	"github.com/zeta-chain/zetacore/common"
+	"github.com/zeta-chain/zetacore/testutil/sample"
 	observertypes "github.com/zeta-chain/zetacore/x/observer/types"
 	clientcommon "github.com/zeta-chain/zetacore/zetaclient/common"
 	"github.com/zeta-chain/zetacore/zetaclient/config"
@@ -125,12 +126,15 @@ func TestUpdateZetaCoreContext(t *testing.T) {
 		}
 		tssPubKeyToUpdate := "tsspubkeytest"
 		loggers := clientcommon.DefaultLoggers()
+		crosschainFlags := sample.CrosschainFlags()
+		require.NotNil(t, crosschainFlags)
 		zetaContext.Update(
 			&keyGenToUpdate,
 			enabledChainsToUpdate,
 			evmChainParamsToUpdate,
 			btcChainParamsToUpdate,
 			tssPubKeyToUpdate,
+			*crosschainFlags,
 			false,
 			loggers.Std,
 		)
@@ -154,6 +158,9 @@ func TestUpdateZetaCoreContext(t *testing.T) {
 		// assert evm chain params still empty because they were not specified in config
 		allEVMChainParams := zetaContext.GetAllEVMChainParams()
 		require.Empty(t, allEVMChainParams)
+
+		ccFlags := zetaContext.GetCrossChainFlags()
+		require.Equal(t, *crosschainFlags, ccFlags)
 	})
 
 	t.Run("should update core context after being created from config with evm and btc chain params", func(t *testing.T) {
@@ -210,13 +217,16 @@ func TestUpdateZetaCoreContext(t *testing.T) {
 			ChainId: testBtcChain.ChainId,
 		}
 		tssPubKeyToUpdate := "tsspubkeytest"
+		crosschainFlags := sample.CrosschainFlags()
+		require.NotNil(t, crosschainFlags)
 		loggers := clientcommon.DefaultLoggers()
 		zetaContext.Update(
 			&keyGenToUpdate,
 			enabledChainsToUpdate,
 			evmChainParamsToUpdate,
 			btcChainParamsToUpdate,
 			tssPubKeyToUpdate,
+			*crosschainFlags,
 			false,
 			loggers.Std,
 		)
@@ -248,6 +258,9 @@ func TestUpdateZetaCoreContext(t *testing.T) {
 		evmChainParams2, found := zetaContext.GetEVMChainParams(2)
 		require.True(t, found)
 		require.Equal(t, evmChainParamsToUpdate[2], evmChainParams2)
+
+		ccFlags := zetaContext.GetCrossChainFlags()
+		require.Equal(t, ccFlags, *crosschainFlags)
 	})
 }
 

zetaclient/evm/evm_client.go

@@ -908,10 +908,7 @@
 
 func (ob *ChainClient) observeInTX(sampledLogger zerolog.Logger) error {
 	// make sure inbound TXS / Send is enabled by the protocol
-	flags, err := ob.zetaClient.GetCrosschainFlags()
-	if err != nil {
-		return err
-	}
+	flags := ob.coreContext.GetCrossChainFlags()
 	if !flags.IsInboundEnabled {
 		return errors.New("inbound TXS / Send has been disabled by the protocol")
 	}