Adding interface EthClientInterface

Layr-Labs · Oct 14, 2024 · 4e03208 · 4e03208
1 parent fef94ea
commit 4e03208
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 22 deletions.
diff --git a/common/abi.go b/common/abi.go
@@ -1,8 +1,34 @@
 package common
 
 import (
+	"context"
 	_ "embed"
+	"math/big"
+
+	"github.com/Layr-Labs/eigensdk-go/chainio/clients/wallet"
+	"github.com/ethereum/go-ethereum"
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/types"
 )
 
 //go:embed abis/IncredibleSquaringTaskManager.json
 var IncredibleSquaringTaskManagerAbi []byte
+
+type EthClientInterface interface {
+	wallet.EthBackend
+	TransactionByHash(context.Context, common.Hash) (*types.Transaction, bool, error)
+	ChainID(ctx context.Context) (*big.Int, error)
+
+	SuggestGasTipCap(ctx context.Context) (*big.Int, error)
+	HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error)
+	EstimateGas(ctx context.Context, call ethereum.CallMsg) (uint64, error)
+	CallContract(ctx context.Context, call ethereum.CallMsg, blockNumber *big.Int) ([]byte, error)
+	BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error)
+	BlockNumber(ctx context.Context) (uint64, error)
+	CodeAt(ctx context.Context, contract common.Address, blockNumber *big.Int) ([]byte, error)
+	PendingCodeAt(ctx context.Context, account common.Address) ([]byte, error)
+	FilterLogs(ctx context.Context, query ethereum.FilterQuery) ([]types.Log, error)
+	PendingNonceAt(ctx context.Context, account common.Address) (uint64, error)
+	SubscribeFilterLogs(ctx context.Context, query ethereum.FilterQuery, ch chan<- types.Log) (ethereum.Subscription, error)
+	SuggestGasPrice(ctx context.Context) (*big.Int, error)
+}
diff --git a/core/chainio/avs_writer.go b/core/chainio/avs_writer.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"math/big"
 
+	sdkcommon "github.com/Layr-Labs/incredible-squaring-avs/common"
 	gethcommon "github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 
@@ -48,19 +49,19 @@ type AvsWriter struct {
 	client              eth.HttpBackend
 }
 
-//var _ AvsWriterer = (*AvsWriter)(nil)
+var _ AvsWriterer = (*AvsWriter)(nil)
 
 func BuildAvsWriterFromConfig(c *config.Config) (*AvsWriter, error) {
-	return BuildAvsWriter(c.TxMgr, c.IncredibleSquaringRegistryCoordinatorAddr, c.OperatorStateRetrieverAddr, c.EthHttpClient, c.Logger)
+	return BuildAvsWriter(c.TxMgr, c.IncredibleSquaringRegistryCoordinatorAddr, c.OperatorStateRetrieverAddr, &c.EthHttpClient, c.Logger)
 }
 
-func BuildAvsWriter(txMgr txmgr.TxManager, registryCoordinatorAddr, operatorStateRetrieverAddr gethcommon.Address, ethHttpClient eth.InstrumentedClient, logger logging.Logger) (*AvsWriter, error) {
-	avsServiceBindings, err := NewAvsManagersBindings(registryCoordinatorAddr, operatorStateRetrieverAddr, &ethHttpClient, logger)
+func BuildAvsWriter(txMgr txmgr.TxManager, registryCoordinatorAddr, operatorStateRetrieverAddr gethcommon.Address, ethHttpClient sdkcommon.EthClientInterface, logger logging.Logger) (*AvsWriter, error) {
+	avsServiceBindings, err := NewAvsManagersBindings(registryCoordinatorAddr, operatorStateRetrieverAddr, ethHttpClient, logger)
 	if err != nil {
 		logger.Error("Failed to create contract bindings", "err", err)
 		return nil, err
 	}
-	avsRegistryWriter, err := avsregistry.BuildAvsRegistryChainWriter(registryCoordinatorAddr, operatorStateRetrieverAddr, logger, &ethHttpClient, txMgr)
+	avsRegistryWriter, err := avsregistry.BuildAvsRegistryChainWriter(registryCoordinatorAddr, operatorStateRetrieverAddr, logger, ethHttpClient, txMgr)
 	if err != nil {
 		return nil, err
 	}

diff --git a/core/chainio/bindings.go b/core/chainio/bindings.go
@@ -9,6 +9,7 @@ import (
 	gethcommon "github.com/ethereum/go-ethereum/common"
 
 	regcoord "github.com/Layr-Labs/eigensdk-go/contracts/bindings/RegistryCoordinator"
+	sdkcommon "github.com/Layr-Labs/incredible-squaring-avs/common"
 	erc20mock "github.com/Layr-Labs/incredible-squaring-avs/contracts/bindings/ERC20Mock"
 	csservicemanager "github.com/Layr-Labs/incredible-squaring-avs/contracts/bindings/IncredibleSquaringServiceManager"
 	cstaskmanager "github.com/Layr-Labs/incredible-squaring-avs/contracts/bindings/IncredibleSquaringTaskManager"
@@ -21,7 +22,7 @@ type AvsManagersBindings struct {
 	logger         logging.Logger
 }
 
-func NewAvsManagersBindings(registryCoordinatorAddr, operatorStateRetrieverAddr gethcommon.Address, ethclient eth.HttpBackend, logger logging.Logger) (*AvsManagersBindings, error) {
+func NewAvsManagersBindings(registryCoordinatorAddr, operatorStateRetrieverAddr gethcommon.Address, ethclient sdkcommon.EthClientInterface, logger logging.Logger) (*AvsManagersBindings, error) {
 	contractRegistryCoordinator, err := regcoord.NewContractRegistryCoordinator(registryCoordinatorAddr, ethclient)
 	if err != nil {
 		return nil, err

diff --git a/core/config/config.go b/core/config/config.go
@@ -32,7 +32,7 @@ type Config struct {
 	// only take an ethclient or an rpcUrl (and build the ethclient at each constructor site)
 	EthHttpRpcUrl                             string
 	EthWsRpcUrl                               string
-	EthHttpClient                             eth.InstrumentedClient
+	EthHttpClient                             ethclient.Client
 	EthWsClient                               eth.WsBackend
 	OperatorStateRetrieverAddr                common.Address
 	IncredibleSquaringRegistryCoordinatorAddr common.Address
@@ -90,7 +90,6 @@ func NewConfig(ctx *cli.Context) (*Config, error) {
 		logger.Errorf("Cannot create http ethclient", "err", err)
 		return nil, err
 	}
-	ethRpcClientInstrumented := eth.NewInstrumentedClientFromClient(ethRpcClient, nil)
 
 	ethWsClient, err := ethclient.Dial(configRaw.EthWsUrl)
 	if err != nil {
@@ -135,7 +134,7 @@ func NewConfig(ctx *cli.Context) (*Config, error) {
 		Logger:                     logger,
 		EthWsRpcUrl:                configRaw.EthWsUrl,
 		EthHttpRpcUrl:              configRaw.EthRpcUrl,
-		EthHttpClient:              *ethRpcClientInstrumented,
+		EthHttpClient:              *ethRpcClient,
 		EthWsClient:                ethWsClient,
 		OperatorStateRetrieverAddr: common.HexToAddress(credibleSquaringDeploymentRaw.Addresses.OperatorStateRetrieverAddr),
 		IncredibleSquaringRegistryCoordinatorAddr: common.HexToAddress(credibleSquaringDeploymentRaw.Addresses.RegistryCoordinatorAddr),

diff --git a/operator/operator.go b/operator/operator.go
@@ -8,9 +8,11 @@ import (
 
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/ethclient"
 	"github.com/prometheus/client_golang/prometheus"
 
 	"github.com/Layr-Labs/incredible-squaring-avs/aggregator"
+	sdkcommon "github.com/Layr-Labs/incredible-squaring-avs/common"
 	cstaskmanager "github.com/Layr-Labs/incredible-squaring-avs/contracts/bindings/IncredibleSquaringTaskManager"
 	"github.com/Layr-Labs/incredible-squaring-avs/core"
 	"github.com/Layr-Labs/incredible-squaring-avs/core/chainio"
@@ -40,7 +42,7 @@ const SEM_VER = "0.0.1"
 type Operator struct {
 	config    types.NodeConfig
 	logger    logging.Logger
-	ethClient eth.InstrumentedClient
+	ethClient sdkcommon.EthClientInterface
 	// TODO(samlaf): remove both avsWriter and eigenlayerWrite from operator
 	// they are only used for registration, so we should make a special registration package
 	// this way, auditing this operator code makes it obvious that operators don't need to
@@ -88,7 +90,7 @@ func NewOperatorFromConfig(c types.NodeConfig) (*Operator, error) {
 	// Setup Node Api
 	nodeApi := nodeapi.NewNodeApi(AVS_NAME, SEM_VER, c.NodeApiIpPortAddress, logger)
 
-	var ethRpcClient, ethWsClient *eth.InstrumentedClient
+	var ethRpcClient, ethWsClient sdkcommon.EthClientInterface
 	if c.EnableMetrics {
 		rpcCallsCollector := rpccalls.NewCollector(AVS_NAME, reg)
 		ethRpcClient, err = eth.NewInstrumentedClient(c.EthRpcUrl, rpcCallsCollector)
@@ -102,12 +104,12 @@ func NewOperatorFromConfig(c types.NodeConfig) (*Operator, error) {
 			return nil, err
 		}
 	} else {
-		ethRpcClient, err = eth.NewInstrumentedClient(c.EthRpcUrl, nil)
+		ethRpcClient, err = ethclient.Dial(c.EthRpcUrl)
 		if err != nil {
 			logger.Errorf("Cannot create http ethclient", "err", err)
 			return nil, err
 		}
-		ethWsClient, err = eth.NewInstrumentedClient(c.EthWsUrl, nil)
+		ethWsClient, err = ethclient.Dial(c.EthWsUrl)
 		if err != nil {
 			logger.Errorf("Cannot create ws ethclient", "err", err)
 			return nil, err
@@ -171,7 +173,7 @@ func NewOperatorFromConfig(c types.NodeConfig) (*Operator, error) {
 
 	avsWriter, err := chainio.BuildAvsWriter(
 		txMgr, common.HexToAddress(c.AVSRegistryCoordinatorAddress),
-		common.HexToAddress(c.OperatorStateRetrieverAddress), *ethRpcClient, logger,
+		common.HexToAddress(c.OperatorStateRetrieverAddress), ethRpcClient, logger,
 	)
 	if err != nil {
 		logger.Error("Cannot create AvsWriter", "err", err)
@@ -216,7 +218,7 @@ func NewOperatorFromConfig(c types.NodeConfig) (*Operator, error) {
 		metricsReg:                         reg,
 		metrics:                            avsAndEigenMetrics,
 		nodeApi:                            nodeApi,
-		ethClient:                          *ethRpcClient,
+		ethClient:                          ethRpcClient,
 		avsWriter:                          avsWriter,
 		avsReader:                          avsReader,
 		avsSubscriber:                      avsSubscriber,

diff --git a/plugin/cmd/main.go b/plugin/cmd/main.go
@@ -9,7 +9,6 @@ import (
 	"time"
 
 	sdkclients "github.com/Layr-Labs/eigensdk-go/chainio/clients"
-	"github.com/Layr-Labs/eigensdk-go/chainio/clients/eth"
 	"github.com/Layr-Labs/eigensdk-go/chainio/clients/wallet"
 	"github.com/Layr-Labs/eigensdk-go/chainio/txmgr"
 	regcoord "github.com/Layr-Labs/eigensdk-go/contracts/bindings/RegistryCoordinator"
@@ -153,12 +152,11 @@ func plugin(ctx *cli.Context) {
 		return
 	}
 	txMgr := txmgr.NewSimpleTxManager(skWallet, ethHttpClient, logger, common.HexToAddress(avsConfig.OperatorAddress))
-	ethRpcClientInstrumented := eth.NewInstrumentedClientFromClient(ethHttpClient, nil)
 	avsWriter, err := chainio.BuildAvsWriter(
 		txMgr,
 		common.HexToAddress(avsConfig.AVSRegistryCoordinatorAddress),
 		common.HexToAddress(avsConfig.OperatorStateRetrieverAddress),
-		*ethRpcClientInstrumented,
+		ethHttpClient,
 		logger,
 	)
 	if err != nil {

diff --git a/tests/integration/integration_test.go b/tests/integration/integration_test.go
@@ -11,7 +11,6 @@ import (
 	"time"
 
 	"github.com/Layr-Labs/eigensdk-go/chainio/clients"
-	"github.com/Layr-Labs/eigensdk-go/chainio/clients/eth"
 	"github.com/Layr-Labs/eigensdk-go/chainio/clients/wallet"
 	"github.com/Layr-Labs/eigensdk-go/chainio/txmgr"
 	sdklogging "github.com/Layr-Labs/eigensdk-go/logging"
@@ -98,13 +97,11 @@ func TestIntegration(t *testing.T) {
 	}
 	txMgr := txmgr.NewSimpleTxManager(skWallet, ethRpcClient, logger, aggregatorAddr)
 
-	ethRpcClientInstrumented := eth.NewInstrumentedClientFromClient(ethRpcClient, nil)
-
 	config := &config.Config{
 		EcdsaPrivateKey:            aggregatorEcdsaPrivateKey,
 		Logger:                     logger,
 		EthHttpRpcUrl:              aggConfigRaw.EthRpcUrl,
-		EthHttpClient:              *ethRpcClientInstrumented,
+		EthHttpClient:              *ethRpcClient,
 		EthWsRpcUrl:                aggConfigRaw.EthWsUrl,
 		EthWsClient:                ethWsClient,
 		OperatorStateRetrieverAddr: common.HexToAddress(credibleSquaringDeploymentRaw.Addresses.OperatorStateRetrieverAddr),