Merge pull request #34 from smartcontractkit/rpc-headers

use DialOptions, set default timeout, use custom RPC headers

Author: skudasov

client.go

@@ -5,7 +5,9 @@ import (
 	"crypto/ecdsa"
 	verr "errors"
 	"fmt"
+	"github.com/ethereum/go-ethereum/rpc"
 	"math/big"
+	"net/http"
 	"path/filepath"
 	"strconv"
 	"strings"
@@ -133,7 +135,7 @@ func NewClientWithConfig(cfg *Config) (*Client, error) {
 	if len(cfg.Network.URLs) == 0 {
 		return nil, fmt.Errorf("at least one url should be present in config in 'secret_urls = []'")
 	}
-	tr, err := NewTracer(cfg.Network.URLs[0], cs, &abiFinder, cfg, contractAddressToNameMap, addrs)
+	tr, err := NewTracer(cs, &abiFinder, cfg, contractAddressToNameMap, addrs)
 	if err != nil {
 		return nil, errors.Wrap(err, ErrCreateTracer)
 	}
@@ -215,6 +217,10 @@ func ValidateConfig(cfg *Config) error {
 		return fmt.Errorf("KeyFileSource is set to 'file' but the path to the key file is not set")
 	}
 
+	if cfg.Network.DialTimeout == nil {
+		cfg.Network.DialTimeout = &Duration{D: DefaultDialTimeout}
+	}
+
 	return nil
 }
 
@@ -240,11 +246,19 @@ func NewClientRaw(
 	if len(cfg.Network.URLs) > 1 {
 		L.Warn().Msg("Multiple RPC URLs provided, only the first one will be used")
 	}
-
-	client, err := ethclient.Dial(cfg.Network.URLs[0])
+	ctx, cancel := context.WithTimeout(context.Background(), cfg.Network.DialTimeout.Duration())
+	defer cancel()
+	rpcClient, err := rpc.DialOptions(ctx,
+		cfg.FirstNetworkURL(),
+		rpc.WithHeaders(cfg.RPCHeaders),
+		rpc.WithHTTPClient(&http.Client{
+			Transport: NewLoggingTransport(),
+		}),
+	)
 	if err != nil {
-		return nil, fmt.Errorf("failed to connect to '%s' due to: %w", cfg.Network.URLs[0], err)
+		return nil, fmt.Errorf("failed to connect RPC client to '%s' due to: %w", cfg.FirstNetworkURL(), err)
 	}
+	client := ethclient.NewClient(rpcClient)
 
 	chainId, err := client.ChainID(context.Background())
 	if err != nil {
@@ -255,16 +269,16 @@ func NewClientRaw(
 	if err != nil {
 		return nil, err
 	}
-	ctx, cancel := context.WithCancel(context.Background())
+	ctx, cancelFunc := context.WithCancel(context.Background())
 	c := &Client{
 		Cfg:         cfg,
 		Client:      client,
 		Addresses:   addrs,
 		PrivateKeys: pkeys,
-		URL:         cfg.Network.URLs[0],
+		URL:         cfg.FirstNetworkURL(),
 		ChainID:     int64(cID),
 		Context:     ctx,
-		CancelFunc:  cancel,
+		CancelFunc:  cancelFunc,
 	}
 	for _, o := range opts {
 		o(c)
@@ -320,7 +334,7 @@ func NewClientRaw(
 	L.Info().
 		Str("NetworkName", cfg.Network.Name).
 		Interface("Addresses", addrs).
-		Str("RPC", cfg.Network.URLs[0]).
+		Str("RPC", cfg.FirstNetworkURL()).
 		Str("ChainID", cfg.Network.ChainID).
 		Int64("Ephemeral keys", *cfg.EphemeralAddrs).
 		Msg("Created new client")
@@ -364,7 +378,7 @@ func NewClientRaw(
 			abiFinder := NewABIFinder(c.ContractAddressToNameMap, c.ContractStore)
 			c.ABIFinder = &abiFinder
 		}
-		tr, err := NewTracer(cfg.Network.URLs[0], c.ContractStore, c.ABIFinder, cfg, c.ContractAddressToNameMap, addrs)
+		tr, err := NewTracer(c.ContractStore, c.ABIFinder, cfg, c.ContractAddressToNameMap, addrs)
 		if err != nil {
 			return nil, errors.Wrap(err, ErrCreateTracer)
 		}

client_main_test.go

@@ -122,7 +122,7 @@ func newClientWithContractMapFromEnv(t *testing.T) *seth.Client {
 	c.ContractAddressToNameMap = contractMap
 
 	// now let's recreate the Tracer, so that it has the same contract map
-	tracer, err := seth.NewTracer(c.Cfg.Network.URLs[0], c.ContractStore, c.ABIFinder, c.Cfg, contractMap, c.Addresses)
+	tracer, err := seth.NewTracer(c.ContractStore, c.ABIFinder, c.Cfg, contractMap, c.Addresses)
 	require.NoError(t, err, "failed to create tracer")
 
 	c.Tracer = tracer
@@ -154,7 +154,7 @@ func NewDebugContractSetup() (
 	contractMap := seth.NewEmptyContractMap()
 
 	abiFinder := seth.NewABIFinder(contractMap, cs)
-	tracer, err := seth.NewTracer(cfg.Network.URLs[0], cs, &abiFinder, cfg, contractMap, addrs)
+	tracer, err := seth.NewTracer(cs, &abiFinder, cfg, contractMap, addrs)
 	if err != nil {
 		return nil, nil, common.Address{}, common.Address{}, nil, err
 	}

cmd/seth.go

@@ -3,6 +3,7 @@ package seth
 import (
 	"context"
 	"fmt"
+	"github.com/ethereum/go-ethereum/rpc"
 	"math/big"
 	"os"
 	"path/filepath"
@@ -354,10 +355,16 @@ func RunCLI(args []string) error {
 							return fmt.Errorf("default network not defined in the TOML file")
 						}
 
-						client, err := ethclient.Dial(cfg.Network.URLs[0])
+						if cfg.Network.DialTimeout == nil {
+							cfg.Network.DialTimeout = &seth.Duration{D: seth.DefaultDialTimeout}
+						}
+						ctx, cancel := context.WithTimeout(context.Background(), cfg.Network.DialTimeout.Duration())
+						defer cancel()
+						rpcClient, err := rpc.DialOptions(ctx, cfg.FirstNetworkURL(), rpc.WithHeaders(cfg.RPCHeaders))
 						if err != nil {
-							return fmt.Errorf("failed to connect to '%s' due to: %w", cfg.Network.URLs[0], err)
+							return fmt.Errorf("failed to connect RPC client to '%s' due to: %w", cfg.FirstNetworkURL(), err)
 						}
+						client := ethclient.NewClient(rpcClient)
 						defer client.Close()
 
 						if cfg.Network.Name == seth.DefaultNetworkName {
@@ -372,6 +379,9 @@ func RunCLI(args []string) error {
 					zero := int64(0)
 					cfg.EphemeralAddrs = &zero
 					cfg.TracingLevel = seth.TracingLevel_All
+					if cfg.Network.DialTimeout == nil {
+						cfg.Network.DialTimeout = &seth.Duration{D: seth.DefaultDialTimeout}
+					}
 
 					client, err := seth.NewClientWithConfig(cfg)
 					if err != nil {

config.go

@@ -4,6 +4,7 @@ import (
 	"crypto/ecdsa"
 	"encoding/base64"
 	"fmt"
+	"net/http"
 	"os"
 	"path/filepath"
 	"strings"
@@ -36,6 +37,7 @@ const (
 	ONE_PASS_VAULT_ENV_VAR = "SETH_ONE_PASS_VAULT"
 
 	DefaultNetworkName = "Default"
+	DefaultDialTimeout = 1 * time.Minute
 )
 
 type KeyFileSource string
@@ -49,6 +51,7 @@ type Config struct {
 	// internal fields
 	RevertedTransactionsFile string
 	ephemeral                bool
+	RPCHeaders               http.Header
 
 	// external fields
 	KeyFileSource                 KeyFileSource     `toml:"keyfile_source"`
@@ -87,6 +90,7 @@ type Network struct {
 	GasTipCap                    int64     `toml:"gas_tip_cap"`
 	GasLimit                     uint64    `toml:"gas_limit"`
 	TxnTimeout                   *Duration `toml:"transaction_timeout"`
+	DialTimeout                  *Duration `toml:"dial_timeout"`
 	TransferGasFee               int64     `toml:"transfer_gas_fee"`
 	PrivateKeys                  []string  `toml:"private_keys_secret"`
 	GasPriceEstimationEnabled    bool      `toml:"gas_price_estimation_enabled"`
@@ -162,10 +166,18 @@ func ReadConfig() (*Config, error) {
 	} else {
 		cfg.Network.PrivateKeys = append(cfg.Network.PrivateKeys, rootPrivateKey)
 	}
+	if cfg.Network.DialTimeout == nil {
+		cfg.Network.DialTimeout = &Duration{D: DefaultDialTimeout}
+	}
 	L.Trace().Interface("Config", cfg).Msg("Parsed seth config")
 	return cfg, nil
 }
 
+// FirstNetworkURL returns first network URL
+func (c *Config) FirstNetworkURL() string {
+	return c.Network.URLs[0]
+}
+
 // ParseKeys parses private keys from the config
 func (c *Config) ParseKeys() ([]common.Address, []*ecdsa.PrivateKey, error) {
 	addresses := make([]common.Address, 0)

examples_wasp/client_main_test.go

@@ -55,7 +55,7 @@ func NewDebugContractSetup() (
 	contractMap := seth.NewEmptyContractMap()
 
 	abiFinder := seth.NewABIFinder(contractMap, cs)
-	tracer, err := seth.NewTracer(cfg.Network.URLs[0], cs, &abiFinder, cfg, contractMap, addrs)
+	tracer, err := seth.NewTracer(cs, &abiFinder, cfg, contractMap, addrs)
 	if err != nil {
 		return nil, nil, common.Address{}, common.Address{}, nil, err
 	}

http_logging_transport.go

@@ -0,0 +1,64 @@
+package seth
+
+import (
+	"crypto/tls"
+	"fmt"
+	"net/http"
+	"net/http/httputil"
+	"os"
+	"time"
+)
+
+// LoggingTransport is a custom transport to log requests and responses
+type LoggingTransport struct {
+	Transport http.RoundTripper
+}
+
+// RoundTrip implements the RoundTripper interface
+func (t *LoggingTransport) RoundTrip(req *http.Request) (*http.Response, error) {
+	start := time.Now()
+
+	reqDump, err := httputil.DumpRequestOut(req, true)
+	if err != nil {
+		L.Error().Err(err).Msg("Error dumping request")
+	} else {
+		fmt.Printf("Request:\n%s\n", string(reqDump))
+	}
+
+	transport := t.Transport
+	if transport == nil {
+		transport = http.DefaultTransport
+	}
+
+	resp, err := transport.RoundTrip(req)
+	if err != nil {
+		return nil, err
+	}
+
+	respDump, err := httputil.DumpResponse(resp, true)
+	if err != nil {
+		L.Error().Err(err).Msg("Error dumping response")
+	} else {
+		fmt.Printf("Response:\n%s\n", string(respDump))
+	}
+
+	fmt.Printf("Request took %s\n", time.Since(start))
+	return resp, nil
+}
+
+// NewLoggingTransport creates a new logging transport for GAP or default transport
+// controlled by SETH_LOG_LEVEL
+func NewLoggingTransport() http.RoundTripper {
+	if os.Getenv(LogLevelEnvVar) == "debug" {
+		return &LoggingTransport{
+			// TODO: GAP, add proper certificates
+			Transport: &http.Transport{
+				TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
+			},
+		}
+	} else {
+		return &http.Transport{
+			TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
+		}
+	}
+}

seth.toml

@@ -60,6 +60,7 @@ key_sync_retries = 10
 
 [[networks]]
 name = "Anvil"
+dial_timeout="1m"
 transaction_timeout = "30s"
 urls_secret = ["ws://localhost:8545"]
 transfer_gas_fee = 21_000
@@ -73,6 +74,7 @@ gas_tip_cap = 1_000_000_000
 
 [[networks]]
 name = "Geth"
+dial_timeout="1m"
 transaction_timeout = "30s"
 urls_secret = ["ws://localhost:8546"]
 transfer_gas_fee = 21_000
@@ -86,6 +88,7 @@ gas_tip_cap = 3_000_000_000
 
 [[networks]]
 name = "Default"
+dial_timeout="1m"
 transaction_timeout = "30s"
 # enable EIP-1559 transactions, because Seth will disable them if they are not supported
 eip_1559_dynamic_fees = true
@@ -102,6 +105,7 @@ gas_tip_cap = 50_000_000_000 #50 gwei
 
 [[networks]]
 name = "Fuji"
+dial_timeout="1m"
 transaction_timeout = "30s"
 eip_1559_dynamic_fees = true
 
@@ -124,6 +128,7 @@ eip_1559_dynamic_fees = true
 
 [[networks]]
 name = "Sepolia"
+dial_timeout="1m"
 transaction_timeout = "30s"
 eip_1559_dynamic_fees = true
 
@@ -147,6 +152,7 @@ gas_tip_cap = 5_000_000_000
 
 [[networks]]
 name = "Mumbai"
+dial_timeout="1m"
 transaction_timeout = "30s"
 eip_1559_dynamic_fees = true
 
@@ -173,6 +179,7 @@ gas_tip_cap = 30460480806
 
 [[networks]]
 name = "zkEVM"
+dial_timeout="1m"
 transaction_timeout = "30s"
 eip_1559_dynamic_fees = false
 
@@ -196,6 +203,7 @@ gas_tip_cap = 1_800_000_000
 
 [[networks]]
 name = "ARBITRUM_SEPOLIA"
+dial_timeout="1m"
 transaction_timeout = "10m"
 transfer_gas_fee = 50_000
 # gas_limit = 15_000_000

tracing.go

@@ -1,6 +1,7 @@
 package seth
 
 import (
+	"context"
 	"fmt"
 	"strconv"
 	"strings"
@@ -92,10 +93,12 @@ type Call struct {
 	Calls   []Call     `json:"calls"`
 }
 
-func NewTracer(url string, cs *ContractStore, abiFinder *ABIFinder, cfg *Config, contractAddressToNameMap ContractMap, addresses []common.Address) (*Tracer, error) {
-	c, err := rpc.Dial(url)
+func NewTracer(cs *ContractStore, abiFinder *ABIFinder, cfg *Config, contractAddressToNameMap ContractMap, addresses []common.Address) (*Tracer, error) {
+	ctx, cancel := context.WithTimeout(context.Background(), cfg.Network.DialTimeout.Duration())
+	defer cancel()
+	c, err := rpc.DialOptions(ctx, cfg.FirstNetworkURL(), rpc.WithHeaders(cfg.RPCHeaders))
 	if err != nil {
-		return nil, fmt.Errorf("failed to connect to '%s' due to: %w", url, err)
+		return nil, fmt.Errorf("failed to connect to '%s' due to: %w", cfg.FirstNetworkURL(), err)
 	}
 	return &Tracer{
 		Cfg:                      cfg,