Merge pull request #186 from stader-labs/node-diver-metrics

Node diver metrics

.github/workflows/go.yml

@@ -20,6 +20,9 @@ jobs:
               with:
                   go-version: 1.19
 
+            - name: Test with the Go CLI
+              run: go test ./...
+
             - name: Golangci
               uses: golangci/golangci-lint-action@v3
               with:

shared/services/bc-manager.go

@@ -134,6 +134,16 @@ func (m *BeaconClientManager) GetSyncStatus() (beacon.SyncStatus, error) {
 	return result.(beacon.SyncStatus), nil
 }
 
+func (m *BeaconClientManager) GetNodeVersion() (beacon.NodeVersion, error) {
+	result, err := m.runFunction1(func(client beacon.Client) (interface{}, error) {
+		return client.GetNodeVersion()
+	})
+	if err != nil {
+		return beacon.NodeVersion{}, err
+	}
+	return result.(beacon.NodeVersion), nil
+}
+
 // Get the Beacon configuration
 func (m *BeaconClientManager) GetEth2Config() (beacon.Eth2Config, error) {
 	result, err := m.runFunction1(func(client beacon.Client) (interface{}, error) {

shared/services/beacon/client.go

@@ -97,6 +97,10 @@ type AttestationInfo struct {
 	CommitteeIndex  uint64
 }
 
+type NodeVersion struct {
+	Version string
+}
+
 // Beacon client type
 type BeaconClientType int
 
@@ -133,6 +137,7 @@ const (
 type Client interface {
 	GetClientType() (BeaconClientType, error)
 	GetSyncStatus() (SyncStatus, error)
+	GetNodeVersion() (NodeVersion, error)
 	GetEth2Config() (Eth2Config, error)
 	GetEth2DepositContract() (Eth2DepositContract, error)
 	GetAttestations(blockId string) ([]AttestationInfo, bool, error)

shared/services/beacon/client/std-http-client.go

@@ -48,6 +48,7 @@ const (
 	RequestContentType = "application/json"
 
 	RequestSyncStatusPath            = "/eth/v1/node/syncing"
+	RequestNodeVersionPath           = "/eth/v1/node/version"
 	RequestEth2ConfigPath            = "/eth/v1/config/spec"
 	RequestEth2DepositContractMethod = "/eth/v1/config/deposit_contract"
 	RequestGenesisPath               = "/eth/v1/beacon/genesis"
@@ -107,6 +108,17 @@ func (c *StandardHttpClient) GetSyncStatus() (beacon.SyncStatus, error) {
 
 }
 
+func (c *StandardHttpClient) GetNodeVersion() (beacon.NodeVersion, error) {
+	nodeVersion, err := c.getNodeVersion()
+	if err != nil {
+		return beacon.NodeVersion{}, err
+	}
+
+	return beacon.NodeVersion{
+		Version: nodeVersion.Data.Version,
+	}, nil
+}
+
 // Get the eth2 config
 func (c *StandardHttpClient) GetEth2Config() (beacon.Eth2Config, error) {
 
@@ -572,6 +584,21 @@ func (c *StandardHttpClient) getSyncStatus() (SyncStatusResponse, error) {
 	return syncStatus, nil
 }
 
+func (c *StandardHttpClient) getNodeVersion() (NodeVersionResponse, error) {
+	responseBody, status, err := c.getRequest(RequestNodeVersionPath)
+	if err != nil {
+		return NodeVersionResponse{}, fmt.Errorf("Could not get node sync status: %w", err)
+	}
+	if status != http.StatusOK {
+		return NodeVersionResponse{}, fmt.Errorf("Could not get node sync status: HTTP status %d; response body: '%s'", status, string(responseBody))
+	}
+	var nodeVersion NodeVersionResponse
+	if err := json.Unmarshal(responseBody, &nodeVersion); err != nil {
+		return NodeVersionResponse{}, fmt.Errorf("Could not decode node sync status: %w", err)
+	}
+	return nodeVersion, nil
+}
+
 // Get the eth2 config
 func (c *StandardHttpClient) getEth2Config() (Eth2ConfigResponse, error) {
 	responseBody, status, err := c.getRequest(RequestEth2ConfigPath)

shared/services/beacon/client/types.go

@@ -46,6 +46,13 @@ type SyncStatusResponse struct {
 		SyncDistance uinteger `json:"sync_distance"`
 	} `json:"data"`
 }
+
+type NodeVersionResponse struct {
+	Data struct {
+		Version string `json:"version"`
+	} `json:"data"`
+}
+
 type Eth2ConfigResponse struct {
 	Data struct {
 		SecondsPerSlot               uinteger `json:"SECONDS_PER_SLOT"`

shared/services/config/stadernode-config.go

@@ -324,6 +324,10 @@ func (cfg *StaderNodeConfig) GetMerkleProofApi() string {
 	return cfg.baseStaderBackendUrl[cfg.Network.Value.(config.Network)] + "/merklesForElRewards/proofs/%s"
 }
 
+func (cfg *StaderNodeConfig) GetNodeDiversityApi() string {
+	return cfg.baseStaderBackendUrl[cfg.Network.Value.(config.Network)] + "/saveNodeDiversity"
+}
+
 func (cfg *StaderNodeConfig) GetTxWatchUrl() string {
 	return cfg.txWatchUrl[cfg.Network.Value.(config.Network)]
 }

shared/services/ec-manager.go

@@ -21,7 +21,9 @@ package services
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
+	"io"
 	"math"
 	"math/big"
 	"strings"
@@ -36,6 +38,7 @@ import (
 	"github.com/stader-labs/stader-node/shared/types/api"
 	cfgtypes "github.com/stader-labs/stader-node/shared/types/config"
 	"github.com/stader-labs/stader-node/shared/utils/log"
+	"github.com/stader-labs/stader-node/shared/utils/net"
 )
 
 // This is a proxy for multiple ETH clients, providing natural fallback support if one of them fails.
@@ -520,3 +523,51 @@ func (p *ExecutionClientManager) runFunction(function ecFunction) (interface{},
 func (p *ExecutionClientManager) isDisconnected(err error) bool {
 	return strings.Contains(err.Error(), "dial tcp")
 }
+
+func (p *ExecutionClientManager) Version() (string, error) {
+	if !p.primaryReady && !p.fallbackReady {
+		return "", fmt.Errorf("EC not ready")
+	}
+
+	var url string
+
+	if p.primaryReady {
+		url = p.primaryEcUrl
+	} else {
+		url = p.fallbackEcUrl
+	}
+
+	payload := struct {
+		Jsonrpc string   `json:"jsonrpc"`
+		Method  string   `json:"method"`
+		Params  []string `json:"params"`
+		Id      int64    `json:"id"`
+	}{
+		Jsonrpc: "2.0",
+		Method:  "web3_clientVersion",
+		Params:  []string{},
+		Id:      1,
+	}
+
+	res, err := net.MakePostRequest(url, payload)
+	if err != nil {
+		return "", err
+	}
+	defer res.Body.Close()
+
+	body, err := io.ReadAll(res.Body)
+	if err != nil {
+		return "", err
+	}
+
+	response := struct {
+		Result string `json:"result"`
+	}{}
+
+	err = json.Unmarshal(body, &response)
+	if err != nil {
+		return "", err
+	}
+
+	return response.Result, nil
+}

shared/services/gas/gas.go

@@ -184,7 +184,7 @@ func handleEtherscanGasPrices(gasSuggestion etherscan.GasFeeSuggestion, priority
 
 		desiredPriceFloat, err := strconv.ParseFloat(desiredPrice, 64)
 		if err != nil {
-			fmt.Println("Not a valid gas price (%s), try again.", err.Error())
+			fmt.Printf("Not a valid gas price (%s), try again.\n", err.Error())
 			continue
 		}
 		if desiredPriceFloat <= 0 {

shared/services/requirements.go

@@ -499,7 +499,7 @@ func waitBeaconClientSynced(c *cli.Context, verbose bool, timeout int64) (bool,
 		// Check sync status
 		if syncStatus.Syncing {
 			if verbose {
-				log.Println("Eth 2.0 node syncing: %.2f%%\n", syncStatus.Progress*100)
+				log.Printf("Eth 2.0 node syncing: %.2f%%\n", syncStatus.Progress*100)
 			}
 		} else {
 			return true, nil

shared/services/stader/client.go

@@ -298,7 +298,7 @@ func (c *Client) UpdatePrometheusConfiguration(settings map[string]string) error
 	}
 	err = os.Chmod(prometheusConfigPath, 0664)
 	if err != nil {
-		return fmt.Errorf("Could not set Prometheus config file permissions: %w", shellescape.Quote(prometheusConfigPath), err)
+		return fmt.Errorf("Could not set Prometheus config file permissions: %s:  %w", shellescape.Quote(prometheusConfigPath), err)
 	}
 
 	return nil
@@ -795,7 +795,6 @@ func (c *Client) GetDockerContainerShutdownTime(container string) (time.Time, er
 }
 
 func (c *Client) UpdateGuardianConfiguration(contents []byte) error {
-
 	guardianTemplatePath, err := homedir.Expand(fmt.Sprintf("%s/%s/%s", c.configPath, templatesDir, GuardianFileTemplate))
 	if err != nil {
 		return fmt.Errorf("error expanding Guardian template path: %w", err)

shared/services/wallet/node.go

@@ -22,6 +22,7 @@ package wallet
 import (
 	"context"
 	"crypto/ecdsa"
+	"encoding/hex"
 	"errors"
 	"fmt"
 	"math/big"
@@ -186,3 +187,29 @@ func (w *Wallet) getNodeDerivedKey(index uint) (*hdkeychain.ExtendedKey, string,
 	return key, derivationPath, nil
 
 }
+
+// Get the node hex encoding public key
+func (w *Wallet) GetNodePubkey() (string, error) {
+
+	// Check wallet is initialized
+	if !w.IsInitialized() {
+		return "", errors.New("Wallet is not initialized")
+	}
+
+	// Get private key
+	privateKey, _, err := w.getNodePrivateKey()
+	if err != nil {
+		return "", err
+	}
+
+	// Get public key
+	publicKey := privateKey.Public()
+	publicKeyECDSA, ok := publicKey.(*ecdsa.PublicKey)
+	if !ok {
+		return "", errors.New("Could not get node public key")
+	}
+
+	publickeyBytes := crypto.FromECDSAPub(publicKeyECDSA)
+
+	return hex.EncodeToString(publickeyBytes), nil
+}

shared/types/stader-backend/node-diversity.go

@@ -0,0 +1,21 @@
+package stader_backend
+
+type NodeDiversityRequest struct {
+	Signature string         `json:"signature"`
+	Message   *NodeDiversity `json:"message"`
+}
+
+type NodeDiversity struct {
+	ExecutionClient      string `json:"executionClient"`
+	ConsensusClient      string `json:"consensusClient"`
+	ValidatorClient      string `json:"validatorClient"`
+	TotalNonTerminalKeys uint64 `json:"totalNonTerminalKeys"`
+	NodeAddress          string `json:"nodeAddress"`
+	NodePublicKey        string `json:"nodePublicKey"`
+	Relays               string `json:"relays"`
+}
+
+type NodeDiversityResponseType struct {
+	Success bool   `json:"success"`
+	Error   string `json:"error"`
+}

shared/utils/stader/node-diversity.go

@@ -0,0 +1,37 @@
+package stader
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/stader-labs/stader-node/shared/services"
+	stader_backend "github.com/stader-labs/stader-node/shared/types/stader-backend"
+	"github.com/stader-labs/stader-node/shared/utils/net"
+	"github.com/urfave/cli"
+)
+
+func SendNodeDiversityResponseType(
+	c *cli.Context,
+	request *stader_backend.NodeDiversityRequest,
+) (*stader_backend.NodeDiversityResponseType, error) {
+	config, err := services.GetConfig(c)
+	if err != nil {
+		return nil, err
+	}
+
+	res, err := net.MakePostRequest(config.StaderNode.GetNodeDiversityApi(), request)
+	if err != nil {
+		return nil, fmt.Errorf("request to GetNodeDiversityApi %w", err)
+	}
+	defer res.Body.Close()
+
+	var resp stader_backend.NodeDiversityResponseType
+	err = json.NewDecoder(res.Body).Decode(&resp)
+
+	if err != nil {
+		return nil, fmt.Errorf("decode NodeDiversityResponseType %w", err)
+	}
+
+	return &resp, nil
+
+}

stader-cli/node/claim-sp-rewards.go

@@ -66,9 +66,9 @@ func ClaimSpRewards(c *cli.Context) error {
 		cycleIndexes = append(cycleIndexes, big.NewInt(cycleInfo.MerkleProofInfo.Cycle))
 	}
 
-	fmt.Println("Following are the unclaimed cycles, Please enter in a comma seperated string the cycles you want to claim rewards for:\n")
+	fmt.Println("Following are the unclaimed cycles, Please enter in a comma separated string the cycles you want to claim rewards for:")
 
-	fmt.Printf("%-18s%-14.30s%-14.10s%-10s\n", "Cycle Number", "Cycle Date", "ETH Rewards", "SD Rewards")
+	fmt.Printf("\n%-18s%-14.30s%-14.10s%-10s\n", "Cycle Number", "Cycle Date", "ETH Rewards", "SD Rewards")
 	cyclesToClaim := map[int64]bool{}
 	for {
 		for _, cycleInfo := range detailedCyclesInfo.DetailedCyclesInfo {

stader-cli/service/service.go

@@ -684,8 +684,8 @@ func startService(
 			fmt.Printf("%sWarning: couldn't verify that the validator container can be safely restarted:\n\t%s\n", colorYellow, err.Error())
 			fmt.Println("If you are changing to a different ETH2 client, it may resubmit an attestation you have already submitted.")
 			fmt.Println("This will slash your validator!")
-			fmt.Println("To prevent slashing, you must wait 15 minutes from the time you stopped the clients before starting them again.\n")
-			fmt.Println("**If you did NOT change clients, you can safely ignore this warning.**\n")
+			fmt.Println("To prevent slashing, you must wait 15 minutes from the time you stopped the clients before starting them again.")
+			fmt.Println("**If you did NOT change clients, you can safely ignore this warning.**")
 			if !cliutils.Confirm(fmt.Sprintf("Press y when you understand the above warning, have waited, and are ready to start Stader:%s", colorReset)) {
 				fmt.Println("Cancelled.")
 				return nil
@@ -914,7 +914,7 @@ func pruneExecutionClient(c *cli.Context) error {
 	}
 
 	fmt.Println("This will shut down your main execution client and prune its database, freeing up disk space.")
-	fmt.Println("Once pruning is complete, your execution client will restart automatically.\n")
+	fmt.Println("Once pruning is complete, your execution client will restart automatically.")
 
 	if selectedEc == cfgtypes.ExecutionClient_Geth {
 		if cfg.UseFallbackClients.Value == false {
@@ -1488,7 +1488,7 @@ func exportEcData(c *cli.Context, targetDir string) error {
 
 	fmt.Println("This will export your execution client's chain data to an external directory, such as a portable hard drive.")
 	fmt.Println("If your execution client is running, it will be shut down.")
-	fmt.Println("Once the export is complete, your execution client will restart automatically.\n")
+	fmt.Println("Once the export is complete, your execution client will restart automatically.")
 
 	// Get the container prefix
 	prefix, err := getContainerPrefix(staderClient)
@@ -1606,7 +1606,7 @@ func importEcData(c *cli.Context, sourceDir string) error {
 
 	fmt.Println("This will import execution layer chain data that you previously exported into your execution client.")
 	fmt.Println("If your execution client is running, it will be shut down.")
-	fmt.Println("Once the import is complete, your execution client will restart automatically.\n")
+	fmt.Println("Once the import is complete, your execution client will restart automatically.")
 
 	// Get the volume to import into
 	executionContainerName := prefix + ExecutionContainerSuffix

stader-cli/wallet/export.go

@@ -51,8 +51,8 @@ func exportWallet(c *cli.Context) error {
 		// Check if stdout is interactive
 		stat, err := os.Stdout.Stat()
 		if err != nil {
-			fmt.Fprintf(os.Stderr, "An error occured while determining whether or not the output is a tty: %w\n"+
-				"Use \"stader-cli --secure-session wallet export\" to bypass.\n", err)
+			fmt.Fprintf(os.Stderr, "An error occured while determining whether or not the output is a tty: %s\n"+
+				"Use \"stader-cli --secure-session wallet export\" to bypass.\n", err.Error())
 			os.Exit(1)
 		}