Merge pull request #30 from flare-foundation/include-api-key

Include API key in RPC URL

config/config.go

@@ -3,11 +3,13 @@ package config
 import (
 	"fmt"
 	"log"
+	"net/url"
 	"os"
 	"strings"
 
 	"github.com/BurntSushi/toml"
 	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/ethclient"
 	"github.com/kelseyhightower/envconfig"
 )
 
@@ -67,6 +69,35 @@ func (cfg ChainConfig) GetPrivateKey() (string, error) {
 	}
 }
 
+// Dial the chain node and return an ethclient.Client.
+func (chain *ChainConfig) DialETH() (*ethclient.Client, error) {
+	rpcURL, err := chain.getRPCURL()
+	if err != nil {
+		return nil, err
+	}
+
+	return ethclient.Dial(rpcURL)
+}
+
+// Get the full RPC URL which may be passed to ethclient.Dial. Includes API key
+// as query param if it is configured.
+func (chain *ChainConfig) getRPCURL() (string, error) {
+	u, err := url.Parse(chain.EthRPCURL)
+	if err != nil {
+		return "", err
+	}
+
+	if chain.ApiKey == "" {
+		return u.String(), nil
+	}
+
+	q := u.Query()
+	q.Set("x-apikey", chain.ApiKey)
+	u.RawQuery = q.Encode()
+
+	return u.String(), nil
+}
+
 type EpochConfig struct {
 	First int64 `toml:"first" envconfig:"EPOCH_FIRST"`
 }

indexer/cronjob/mirror_stubs.go

@@ -81,7 +81,7 @@ func initMirrorJobContracts(cfg *config.Config) (mirrorContracts, error) {
 		return nil, errors.New("voting contract address not set")
 	}
 
-	eth, err := ethclient.Dial(cfg.Chain.EthRPCURL)
+	eth, err := cfg.Chain.DialETH()
 	if err != nil {
 		return nil, err
 	}

indexer/cronjob/uptime_voting.go

@@ -16,7 +16,6 @@ import (
 	"github.com/ava-labs/avalanchego/ids"
 	mapset "github.com/deckarep/golang-set/v2"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
-	"github.com/ethereum/go-ethereum/ethclient"
 	"github.com/pkg/errors"
 	"gorm.io/gorm"
 )
@@ -59,7 +58,7 @@ func NewUptimeVotingCronjob(ctx context.IndexerContext) (*uptimeVotingCronjob, e
 		return &uptimeVotingCronjob{}, nil
 	}
 
-	eth, err := ethclient.Dial(cfg.Chain.EthRPCURL)
+	eth, err := cfg.Chain.DialETH()
 	if err != nil {
 		return nil, err
 	}

indexer/cronjob/voting_stubs.go

@@ -12,7 +12,6 @@ import (
 	"time"
 
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
-	"github.com/ethereum/go-ethereum/ethclient"
 	"gorm.io/gorm"
 )
 
@@ -40,8 +39,7 @@ type votingContractCChain struct {
 }
 
 func newVotingContractCChain(cfg *config.Config) (votingContract, error) {
-
-	eth, err := ethclient.Dial(cfg.Chain.EthRPCURL)
+	eth, err := cfg.Chain.DialETH()
 	if err != nil {
 		return nil, err
 	}

services/context/context.go

@@ -41,7 +41,7 @@ func BuildContext() (ServicesContext, error) {
 		return nil, err
 	}
 
-	ethRPCClient, err := ethclient.Dial(cfg.Chain.EthRPCURL)
+	ethRPCClient, err := cfg.Chain.DialETH()
 	if err != nil {
 		return nil, err
 	}

services/routes/mirroring.go

@@ -15,7 +15,6 @@ import (
 	"time"
 
 	"github.com/ethereum/go-ethereum/common/hexutil"
-	"github.com/ethereum/go-ethereum/ethclient"
 	"gorm.io/gorm"
 )
 
@@ -66,7 +65,7 @@ func newMirroringRouteHandlers(ctx context.ServicesContext) (*mirroringRouteHand
 }
 
 func getEpochStartAndPeriod(cfg *config.Config) (time.Time, time.Duration, error) {
-	eth, err := ethclient.Dial(cfg.Chain.EthRPCURL)
+	eth, err := cfg.Chain.DialETH()
 	if err != nil {
 		return time.Time{}, 0, err
 	}