fix: zetaclient should pick up new connector and erc20 custody addres…

…ses (#1890)

* zetaclient should pick up new connector and erc20 custody addresses

* a bit refactor and more unit tests

* fix compile error

changelog.md

@@ -44,6 +44,7 @@
 ### Fixes
 
 * [1861](https://github.com/zeta-chain/node/pull/1861) - fix `ObserverSlashAmount` invalid read
+* [1633](https://github.com/zeta-chain/node/issues/1633) - zetaclient should be able to pick up new connector and erc20Custody addresses
 
 ### Chores
 

cmd/zetaclientd/utils.go

@@ -3,7 +3,6 @@ package main
 import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	ethcommon "github.com/ethereum/go-ethereum/common"
-	"github.com/zeta-chain/zetacore/common"
 	"github.com/zeta-chain/zetacore/common/cosmos"
 	appcontext "github.com/zeta-chain/zetacore/zetaclient/app_context"
 	"github.com/zeta-chain/zetacore/zetaclient/authz"
@@ -55,8 +54,8 @@ func CreateSignerMap(
 	tss interfaces.TSSSigner,
 	loggers clientcommon.ClientLogger,
 	ts *metrics.TelemetryServer,
-) (map[common.Chain]interfaces.ChainSigner, error) {
-	signerMap := make(map[common.Chain]interfaces.ChainSigner)
+) (map[int64]interfaces.ChainSigner, error) {
+	signerMap := make(map[int64]interfaces.ChainSigner)
 	// EVM signers
 	for _, evmConfig := range appContext.Config().GetAllEVMConfigs() {
 		if evmConfig.Chain.IsZetaChain() {
@@ -77,7 +76,7 @@ func CreateSignerMap(
 			loggers.Std.Error().Err(err).Msgf("NewEVMSigner error for chain %s", evmConfig.Chain.String())
 			continue
 		}
-		signerMap[evmConfig.Chain] = signer
+		signerMap[evmConfig.Chain.ChainId] = signer
 	}
 	// BTC signer
 	btcChain, btcConfig, enabled := appContext.GetBTCChainAndConfig()
@@ -86,7 +85,7 @@ func CreateSignerMap(
 		if err != nil {
 			loggers.Std.Error().Err(err).Msgf("NewBTCSigner error for chain %s", btcChain.String())
 		} else {
-			signerMap[btcChain] = signer
+			signerMap[btcChain.ChainId] = signer
 		}
 	}
 
@@ -100,8 +99,8 @@ func CreateChainClientMap(
 	dbpath string,
 	loggers clientcommon.ClientLogger,
 	ts *metrics.TelemetryServer,
-) (map[common.Chain]interfaces.ChainClient, error) {
-	clientMap := make(map[common.Chain]interfaces.ChainClient)
+) (map[int64]interfaces.ChainClient, error) {
+	clientMap := make(map[int64]interfaces.ChainClient)
 	// EVM clients
 	for _, evmConfig := range appContext.Config().GetAllEVMConfigs() {
 		if evmConfig.Chain.IsZetaChain() {
@@ -120,17 +119,17 @@ func CreateChainClientMap(
 			loggers.Std.Error().Err(err).Msgf("NewEVMChainClient error for chain %s", evmConfig.Chain.String())
 			continue
 		}
-		clientMap[evmConfig.Chain] = co
+		clientMap[evmConfig.Chain.ChainId] = co
 	}
 	// BTC client
-	btcChain, _, enabled := appContext.GetBTCChainAndConfig()
+	btcChain, btcConfig, enabled := appContext.GetBTCChainAndConfig()
 	if enabled {
-		co, err := bitcoin.NewBitcoinClient(appContext, btcChain, bridge, tss, dbpath, loggers, ts)
+		co, err := bitcoin.NewBitcoinClient(appContext, btcChain, bridge, tss, dbpath, loggers, btcConfig, ts)
 		if err != nil {
 			loggers.Std.Error().Err(err).Msgf("NewBitcoinClient error for chain %s", btcChain.String())
 
 		} else {
-			clientMap[btcChain] = co
+			clientMap[btcChain.ChainId] = co
 		}
 	}
 

zetaclient/bitcoin/bitcoin_client.go

@@ -140,6 +140,7 @@ func NewBitcoinClient(
 	tss interfaces.TSSSigner,
 	dbpath string,
 	loggers clientcommon.ClientLogger,
+	btcCfg config.BTCConfig,
 	ts *metrics.TelemetryServer,
 ) (*BTCChainClient, error) {
 	ob := BTCChainClient{
@@ -174,7 +175,6 @@ func NewBitcoinClient(
 	}
 	ob.params = *chainParams
 	// initialize the Client
-	btcCfg := appcontext.Config().BitcoinConfig
 	ob.logger.ChainLogger.Info().Msgf("Chain %s endpoint %s", ob.chain.String(), btcCfg.RPCHost)
 	connCfg := &rpcclient.ConnConfig{
 		Host:         btcCfg.RPCHost,

zetaclient/bitcoin/bitcoin_client_rpc_test.go

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

zetaclient/bitcoin/bitcoin_signer.go

@@ -8,6 +8,7 @@ import (
 	"math/rand"
 	"time"
 
+	ethcommon "github.com/ethereum/go-ethereum/common"
 	clientcommon "github.com/zeta-chain/zetacore/zetaclient/common"
 	"github.com/zeta-chain/zetacore/zetaclient/interfaces"
 	"github.com/zeta-chain/zetacore/zetaclient/metrics"
@@ -34,6 +35,7 @@ const (
 	outTxBytesMax      = uint64(1531) // 1531v == EstimateSegWitTxSize(21, 3)
 )
 
+// BTCSigner deals with signing BTC transactions and implements the ChainSigner interface
 type BTCSigner struct {
 	tssSigner        interfaces.TSSSigner
 	rpcClient        interfaces.BTCRPCClient
@@ -71,6 +73,24 @@ func NewBTCSigner(
 	}, nil
 }
 
+// SetZetaConnectorAddress does nothing for BTC
+func (signer *BTCSigner) SetZetaConnectorAddress(_ ethcommon.Address) {
+}
+
+// SetERC20CustodyAddress does nothing for BTC
+func (signer *BTCSigner) SetERC20CustodyAddress(_ ethcommon.Address) {
+}
+
+// GetZetaConnectorAddress returns dummy address
+func (signer *BTCSigner) GetZetaConnectorAddress() ethcommon.Address {
+	return ethcommon.Address{}
+}
+
+// GetERC20CustodyAddress returns dummy address
+func (signer *BTCSigner) GetERC20CustodyAddress() ethcommon.Address {
+	return ethcommon.Address{}
+}
+
 // SignWithdrawTx receives utxos sorted by value, amount in BTC, feeRate in BTC per Kb
 func (signer *BTCSigner) SignWithdrawTx(
 	to *btcutil.AddressWitnessPubKeyHash,

zetaclient/evm/evm_client.go

@@ -64,6 +64,8 @@ type Log struct {
 	Compliance           zerolog.Logger // Compliance logger
 }
 
+var _ interfaces.ChainClient = &ChainClient{}
+
 // ChainClient represents the chain configuration for an EVM chain
 // Filled with above constants depending on chain
 type ChainClient struct {

zetaclient/evm/evm_signer.go

@@ -32,21 +32,21 @@ import (
 	zbridge "github.com/zeta-chain/zetacore/zetaclient/zetabridge"
 )
 
+// Signer deals with the signing EVM transactions and implements the ChainSigner interface
 type Signer struct {
-	client                      interfaces.EVMRPCClient
-	chain                       *common.Chain
-	chainID                     *big.Int
-	tssSigner                   interfaces.TSSSigner
-	ethSigner                   ethtypes.Signer
-	abi                         abi.ABI
-	erc20CustodyABI             abi.ABI
-	metaContractAddress         ethcommon.Address
-	erc20CustodyContractAddress ethcommon.Address
-	logger                      clientcommon.ClientLogger
-	ts                          *metrics.TelemetryServer
-
-	// for outTx tracker report only
+	client    interfaces.EVMRPCClient
+	chain     *common.Chain
+	tssSigner interfaces.TSSSigner
+	ethSigner ethtypes.Signer
+	logger    clientcommon.ClientLogger
+	ts        *metrics.TelemetryServer
+
+	// mu protects below fields from concurrent access
 	mu                     *sync.Mutex
+	zetaConnectorABI       abi.ABI
+	erc20CustodyABI        abi.ABI
+	zetaConnectorAddress   ethcommon.Address
+	er20CustodyAddress     ethcommon.Address
 	outTxHashBeingReported map[string]bool
 }
 
@@ -56,36 +56,35 @@ func NewEVMSigner(
 	chain common.Chain,
 	endpoint string,
 	tssSigner interfaces.TSSSigner,
-	abiString string,
-	erc20CustodyABIString string,
-	metaContract ethcommon.Address,
-	erc20CustodyContract ethcommon.Address,
+	zetaConnectorABI string,
+	erc20CustodyABI string,
+	zetaConnectorAddress ethcommon.Address,
+	erc20CustodyAddress ethcommon.Address,
 	loggers clientcommon.ClientLogger,
 	ts *metrics.TelemetryServer,
 ) (*Signer, error) {
-	client, chainID, ethSigner, err := getEVMRPC(endpoint)
+	client, ethSigner, err := getEVMRPC(endpoint)
 	if err != nil {
 		return nil, err
 	}
-	connectorABI, err := abi.JSON(strings.NewReader(abiString))
+	connectorABI, err := abi.JSON(strings.NewReader(zetaConnectorABI))
 	if err != nil {
 		return nil, err
 	}
-	erc20CustodyABI, err := abi.JSON(strings.NewReader(erc20CustodyABIString))
+	custodyABI, err := abi.JSON(strings.NewReader(erc20CustodyABI))
 	if err != nil {
 		return nil, err
 	}
 
 	return &Signer{
-		client:                      client,
-		chain:                       &chain,
-		tssSigner:                   tssSigner,
-		chainID:                     chainID,
-		ethSigner:                   ethSigner,
-		abi:                         connectorABI,
-		erc20CustodyABI:             erc20CustodyABI,
-		metaContractAddress:         metaContract,
-		erc20CustodyContractAddress: erc20CustodyContract,
+		client:               client,
+		chain:                &chain,
+		tssSigner:            tssSigner,
+		ethSigner:            ethSigner,
+		zetaConnectorABI:     connectorABI,
+		erc20CustodyABI:      custodyABI,
+		zetaConnectorAddress: zetaConnectorAddress,
+		er20CustodyAddress:   erc20CustodyAddress,
 		logger: clientcommon.ClientLogger{
 			Std:        loggers.Std.With().Str("chain", chain.ChainName.String()).Str("module", "EVMSigner").Logger(),
 			Compliance: loggers.Compliance,
@@ -96,6 +95,34 @@ func NewEVMSigner(
 	}, nil
 }
 
+// SetZetaConnectorAddress sets the zeta connector address
+func (signer *Signer) SetZetaConnectorAddress(addr ethcommon.Address) {
+	signer.mu.Lock()
+	defer signer.mu.Unlock()
+	signer.zetaConnectorAddress = addr
+}
+
+// SetERC20CustodyAddress sets the erc20 custody address
+func (signer *Signer) SetERC20CustodyAddress(addr ethcommon.Address) {
+	signer.mu.Lock()
+	defer signer.mu.Unlock()
+	signer.er20CustodyAddress = addr
+}
+
+// GetZetaConnectorAddress returns the zeta connector address
+func (signer *Signer) GetZetaConnectorAddress() ethcommon.Address {
+	signer.mu.Lock()
+	defer signer.mu.Unlock()
+	return signer.zetaConnectorAddress
+}
+
+// GetERC20CustodyAddress returns the erc20 custody address
+func (signer *Signer) GetERC20CustodyAddress() ethcommon.Address {
+	signer.mu.Lock()
+	defer signer.mu.Unlock()
+	return signer.er20CustodyAddress
+}
+
 // Sign given data, and metadata (gas, nonce, etc)
 // returns a signed transaction, sig bytes, hash bytes, and error
 func (signer *Signer) Sign(
@@ -150,7 +177,7 @@ func (signer *Signer) SignOutboundTx(txData *OutBoundTransactionData) (*ethtypes
 	var data []byte
 	var err error
 
-	data, err = signer.abi.Pack("onReceive",
+	data, err = signer.zetaConnectorABI.Pack("onReceive",
 		txData.sender.Bytes(),
 		txData.srcChainID,
 		txData.to,
@@ -162,7 +189,7 @@ func (signer *Signer) SignOutboundTx(txData *OutBoundTransactionData) (*ethtypes
 	}
 
 	tx, _, _, err := signer.Sign(data,
-		signer.metaContractAddress,
+		signer.zetaConnectorAddress,
 		txData.gasLimit,
 		txData.gasPrice,
 		txData.nonce,
@@ -188,7 +215,7 @@ func (signer *Signer) SignRevertTx(txData *OutBoundTransactionData) (*ethtypes.T
 	var data []byte
 	var err error
 
-	data, err = signer.abi.Pack("onRevert",
+	data, err = signer.zetaConnectorABI.Pack("onRevert",
 		txData.sender,
 		txData.srcChainID,
 		txData.to.Bytes(),
@@ -201,7 +228,7 @@ func (signer *Signer) SignRevertTx(txData *OutBoundTransactionData) (*ethtypes.T
 	}
 
 	tx, _, _, err := signer.Sign(data,
-		signer.metaContractAddress,
+		signer.zetaConnectorAddress,
 		txData.gasLimit,
 		txData.gasPrice,
 		txData.nonce,
@@ -556,7 +583,7 @@ func (signer *Signer) SignERC20WithdrawTx(txData *OutBoundTransactionData) (*eth
 		return nil, fmt.Errorf("pack error: %w", err)
 	}
 
-	tx, _, _, err := signer.Sign(data, signer.erc20CustodyContractAddress, txData.gasLimit, txData.gasPrice, txData.nonce, txData.height)
+	tx, _, _, err := signer.Sign(data, signer.er20CustodyAddress, txData.gasLimit, txData.gasPrice, txData.nonce, txData.height)
 	if err != nil {
 		return nil, fmt.Errorf("sign error: %w", err)
 	}
@@ -589,7 +616,7 @@ func (signer *Signer) SignWhitelistTx(
 		return nil, fmt.Errorf("pack error: %w", err)
 	}
 
-	tx, _, _, err := signer.Sign(data, signer.erc20CustodyContractAddress, gasLimit, gasPrice, nonce, height)
+	tx, _, _, err := signer.Sign(data, signer.er20CustodyAddress, gasLimit, gasPrice, nonce, height)
 	if err != nil {
 		return nil, fmt.Errorf("Sign error: %w", err)
 	}
@@ -612,25 +639,25 @@ func (signer *Signer) EvmSigner() ethtypes.Signer {
 // ________________________
 
 // getEVMRPC is a helper function to set up the client and signer, also initializes a mock client for unit tests
-func getEVMRPC(endpoint string) (interfaces.EVMRPCClient, *big.Int, ethtypes.Signer, error) {
+func getEVMRPC(endpoint string) (interfaces.EVMRPCClient, ethtypes.Signer, error) {
 	if endpoint == stub.EVMRPCEnabled {
 		chainID := big.NewInt(common.BscMainnetChain().ChainId)
 		ethSigner := ethtypes.NewEIP155Signer(chainID)
 		client := &stub.MockEvmClient{}
-		return client, chainID, ethSigner, nil
+		return client, ethSigner, nil
 	}
 
 	client, err := ethclient.Dial(endpoint)
 	if err != nil {
-		return nil, nil, nil, err
+		return nil, nil, err
 	}
 
 	chainID, err := client.ChainID(context.TODO())
 	if err != nil {
-		return nil, nil, nil, err
+		return nil, nil, err
 	}
 	ethSigner := ethtypes.LatestSignerForChainID(chainID)
-	return client, chainID, ethSigner, nil
+	return client, ethSigner, nil
 }
 
 func roundUpToNearestGwei(gasPrice *big.Int) *big.Int {