Merge pull request #32 from probe-lab/add-custom-slots

* Allow scan on custom slots, non-missed blocks, or blocks with blobs. 

* Fixes some connection bans

* Target specific clients at the API when giving the eth-panda-ops workbalancer

Author: cortze

README.md

@@ -6,7 +6,7 @@ It can extract and present all available information for a given [ENR](https://g
 - **Relevant ENR Entries**:
   - `cgc`: Column Custody Group
   - Computed DataColumn indexes from the Custody Group
-- **Node's Chain Status and Metadata (v3)**
+- **Node's Chain Status (v1-v2) and Metadata (v2-v3)**
 - **Libp2p Information**:
   - UserAgent (typically Client + Version)
   - Supported protocols
@@ -17,10 +17,10 @@ It can extract and present all available information for a given [ENR](https://g
 
 ## Supported Networks
 
-This experimental version of the tool is compatible with existing PeerDAS devnets. It has been tested and confirmed to work with `peerdas-devnet-7`.
+This experimental version of the tool is compatible with existing PeerDAS devnets. It has been tested and confirmed to work with `fusaka-devnet-2`.
 
 More details available at:
-- EF's [devnet-7 dashboard](https://peerdas-devnet-7.ethpandaops.io/)
+- EF's [fusaka-devnet-2 dashboard](https://fusaka-devnet-2.ethpandaops.io/)
 
 ## PeerDAS Specifications
 
@@ -53,66 +53,67 @@ The tool exposes a single CLI command. Basic usage:
 $ das-guardian --help
 
 NAME:
-   das-guardian - An Ethereum DAS custody checker
+   das-guardian - An ethereum DAS custody checker
 
 USAGE:
-   das-guardian [global options]
+   das-guardian [global options] [command [command options]]
+
+COMMANDS:
+   scan     Connects and scans a given node for its custody and network status
+   monitor  Connects and monitors a given node for its custody and network status
+   help, h  Shows a list of commands or help for one command
 
 GLOBAL OPTIONS:
-   --node.key string              ENR of the node to probe
-   --libp2p.host string           IP address for the Libp2p host (default: "127.0.0.1")
-   --libp2p.port int              Port for the Libp2p host (default: 9013)
-   --api.endpoint string          URL of a Beacon API (default: "http://127.0.0.1:5052/")
-   --connection.retries int       Number of connection retries (default: 3)
-   --connection.timeout duration  Connection timeout duration (default: 30s)
-   --help, -h                     Show help
+   --libp2p.host string           IP for the Libp2p host (default: "127.0.0.1")
+   --libp2p.port int              Port for the libp2p host (default: 9013)
+   --api.endpoint string          The url endpoint of a Beacon API (http://localhost:5052/) (default: "http://127.0.0.1:5052/")
+   --api.custom.cl string         Name of a custom CL client that we would like to query from the work-balancer ('lighthouse', 'prysm', 'nimbus')
+   --connection.retries int       Number of retries when connecting the node (default: 3)
+   --connection.timeout duration  Timeout for the connection attempt to the node (default: 30s)
+   --init.timeout duration        Timeout to limit the time it can take the guardian to init itself (default: 30s)
+   --wait.fulu                    The guardian command will wait until fulu hardfork has happened before proceeding to test the custody (default: true)
+   --help, -h                     show help
 ```
 
 Example of how to use it:
 ```bash
-$ das-guardian \
-  --api.endpoint "https://beacon.peerdas-devnet-7.ethpandaops.io/" \
-  --node.key "enr:-Oi4QJpqAuqmnU4iwQLrmyhIt62wrUeexYrTeXsCm06PWLnfPDK99h5mBt4IRmiLzvASKWjw74wsZV9UkzoPVggZj7kah2F0dG5ldHOIAAAAAAAAYACDY2djBIZjbGllbnTXiEdyYW5kaW5ljTEuMS4wLWExNTgwMjeEZXRoMpCDR4TGcFUmR4oCAAAAAAAAgmlkgnY0gmlwhM69sO-EcXVpY4IjKYlzZWNwMjU2azGhAoh6xQUKUjNR3_OtxCO9eOUAfxhTofTAbSFYLfr6a5pWiHN5bmNuZXRzD4N0Y3CCIyiDdWRwgiMo"
-
-INFO[0000] Running eth-das-guardian                      beacon-api="https://beacon.peerdas-devnet-7.ethpandaops.io/" connection-retries=3 connection-timeout=30s libp2p-host=127.0.0.1 libp2p-port=9013 node-key="enr:-Oi4QJ..."
-INFO[0000] Successfully connected to the Beacon API      node-version=Lodestar/v1.28.1/1f339ea
-INFO[0000] Connected to the Beacon API...
-INFO[0002] Downloaded beacon head-state
-INFO[0002]   * Validators:      336
-INFO[0002]   * Version:         fulu
-INFO[0002]   * Finalized:       false
-INFO[0002]   * Optimistic EL:   false
+$ das-guardian --api.endpoint "https://beacon.fusaka-devnet-2.ethpandaops.io/" --api.custom.cl "lighthouse" scan --scan.key "enr:-PO4QFAZca5TDfbiiCKouERBRao_oLgy5KCPvbezPfhTacxHWlBqfDgsfsghRLBUH9W8bj08v1jkd64UoUjSaWZx-6UHh2F0dG5ldHOIAAAAAAADAACDY2djgYCGY2xpZW502IpMaWdodGhvdXNljDcuMS4wLWJldGEuMIRldGgykIEAExpwk3VEAAEAAAAAAACCaWSCdjSCaXCEn99xd4NuZmSENp-J94RxdWljgiMpiXNlY3AyNTZrMaEDzVa77_o452OzzqylcK2mA0DREidLotbGonvz3nogDS-Ic3luY25ldHMPg3RjcIIjKIN1ZHCCIyg"
+INFO[0000] running das-guardian                          beacon-api="https://beacon.fusaka-devnet-2.ethpandaops.io/" beacon-cl-client=lighthouse connection-retries=3 connection-timeout=30s init-timeout=30s libp2p-host=127.0.0.1 libp2p-port=9013 slot-range-number=5 slot-range-slots="[]" slot-range-type=random wait-fulu=true
+INFO[0001] successfull connection to the beacon-api      node-version=Lighthouse/v7.1.0-beta.0-9993fdf/x86_64-linux
+INFO[0001] connected to the beacon API...
+INFO[0001] Beacon node identity                          enr="enr:-O24QMLrZGfQAo8_Svw5lG83kn6XTfiUmMP9Zz6yFayAX1sLNKjAegt04iXwWxVsclGtz0E1Ec77mTe6xT0zlJKdgn2BmIdhdHRuZXRziAAABgAAAAAAg2NnY4GAhmNsaWVudNGKTGlnaHRob3VzZYU3LjEuMIRldGgykLYvKw5wk3VE__________-CaWSCdjSCaXCEpFrLSoNuZmSEti8rDoRxdWljgiMpiXNlY3AyNTZrMaEC-HAEr6PikSNtSPQj7LoDBjzA4lRhjKXzLZMkfPa6c1CIc3luY25ldHMNg3RjcIIjKIN1ZHCCIyg" peer_id=16Uiu2HAmC9UA9nyCov1VAaWPSjycJPLjSLd49SEQWzFpp4EBSa4P
+INFO[0005] fulu is supported
+INFO[0005] dowloaded beacon head-state
+INFO[0005] 	* version:	fulu
+INFO[0005] 	* finalized:	false
+INFO[0005] 	* optimistic-el:	false
+INFO[0005] 	* validators:	736
+INFO[0005] local beacon-status
+INFO[0005] 	* head-slot:	152900
+INFO[0005] 	* fork-digest:	0xb62f2b0e
+INFO[0005] local beacon-metadata
+INFO[0005] 	* syncnets:	[0]
+INFO[0005] 	* seq-number:	0
+INFO[0005] 	* attnets:	[0 0 0 0 0 0 0 0]
+INFO[0005] das-guardian initialized                      peer-id=16Uiu2HAmVMkBPZgCq4oqzEvTBrfkPwwHK3K8HKixCsheKeRFtEAH
+INFO[0006] connected to remote node...
+INFO[0006] libp2p info...
+INFO[0006] 	* ping_rtt:	105.853822ms
 ...
-INFO[0003] requesting slot-blocks from beacon API...     slots="[113791 99432 73995 66414]"
-INFO[0005] sampling node for...                          columns=4 slots=4
-INFO[0005] req info...                                   das-result="4/4 columns" req-duration=231.7413ms slot=113791
-INFO[0005] req info...                                   das-result="4/4 columns" req-duration=121.785912ms slot=99432
-INFO[0005] req info...                                   das-result="4/4 columns" req-duration=118.819413ms slot=73995
-INFO[0005] req info...                                   das-result="4/4 columns" req-duration=119.066869ms slot=66414
-INFO[0005] node custody sampling done...                 duration=592.556056ms
-┌────────┬────────────────────────────────┬────────────────────────────────┬────────────────────────────────┬────────────────────────────────┐
-│  SLOT  │          COL  [ 28 ]           │          COL  [ 32 ]           │          COL  [ 57 ]           │          COL  [ 117 ]          │
-├────────┼────────────────────────────────┼────────────────────────────────┼────────────────────────────────┼────────────────────────────────┤
-│ 113791 │ blobs (5/5) / kzg-cmts (5/5/5) │ blobs (5/5) / kzg-cmts (5/5/5) │ blobs (5/5) / kzg-cmts (5/5/5) │ blobs (5/5) / kzg-cmts (5/5/5) │
-│ 99432  │ blobs (7/7) / kzg-cmts (7/7/7) │ blobs (7/7) / kzg-cmts (7/7/7) │ blobs (7/7) / kzg-cmts (7/7/7) │ blobs (7/7) / kzg-cmts (7/7/7) │
-│ 73995  │ blobs (5/5) / kzg-cmts (5/5/5) │ blobs (5/5) / kzg-cmts (5/5/5) │ blobs (5/5) / kzg-cmts (5/5/5) │ blobs (5/5) / kzg-cmts (5/5/5) │
-│ 66414  │ blobs (4/4) / kzg-cmts (4/4/4) │ blobs (4/4) / kzg-cmts (4/4/4) │ blobs (4/4) / kzg-cmts (4/4/4) │ blobs (4/4) / kzg-cmts (4/4/4) │
-└────────┴────────────────────────────────┴────────────────────────────────┴────────────────────────────────┴────────────────────────────────┘
+INFO[0013] sampling node for...                          columns=128 slots=5
+INFO[0014] req info...                                   das-result="128/128 columns" req-duration=1.063251291s slot=99067
+INFO[0015] req info...                                   das-result="0/128 columns" req-duration=537.631558ms slot=78000
+INFO[0015] req info...                                   das-result="128/128 columns" req-duration=435.80515ms slot=147141
+INFO[0016] req info...                                   das-result="0/128 columns" req-duration=189.822971ms slot=107529
+INFO[0016] req info...                                   das-result="128/128 columns" req-duration=130.425776ms slot=33121
+INFO[0016] node custody sampling done...                 duration=2.35818963s
 ```
 
 Note: This tool is a demonstration prototype for debugging CL nodes on devnets. The codebase is experimental — please be gentle regarding its current style and implementation.
 
-## TODOs:
-- [ ] structure code on right packages
-- [ ] make interface to evaluate the results
-- [ ] make logic to limit requested slots for fulu-only slots
-- [ ] add nebula logic
-- [ ] 
-
 ## Maintainers
-
 [@cortze](https://github.com/cortze) from [@probe-lab](https://github.com/probe-lab)
+[@EthPandaOps](https://github.com/ethpandaops) team
 
 ## Contributing
-
 Due to the debugging and research nature of the project, feedback and feature suggestions are very welcome. Feel free to open an issue or submit a pull request.

api/block.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"strings"
 
 	"github.com/attestantio/go-eth2-client/spec"
 	"github.com/attestantio/go-eth2-client/spec/electra"
@@ -19,6 +20,10 @@ type BeaconBlock struct {
 	Data                *electra.SignedBeaconBlock `json:"data"`
 }
 
+func (b *BeaconBlock) IsMissed() bool {
+	return b.Data == nil
+}
+
 type FuluBeaconBlock struct {
 	Slot          string                  `json:"slot"`
 	ProposerIndex string                  `json:"proposer_index"`
@@ -34,6 +39,10 @@ func (c *Client) GetBeaconBlock(ctx context.Context, slot uint64) (*spec.Version
 	beaconBlock := &BeaconBlock{}
 	resp, err := c.get(ctx, c.cfg.QueryTimeout, fmt.Sprintf(BlockBase, slot), "")
 	if err != nil {
+		if strings.Contains(err.Error(), "404 Not Found") {
+			fmt.Println("not found!")
+			return new(spec.VersionedSignedBeaconBlock), nil
+		}
 		return nil, errors.Wrap(err, "requesting beacon-block")
 	}
 	err = json.Unmarshal(resp, &beaconBlock)

api/client.go

@@ -14,16 +14,18 @@ import (
 )
 
 type ClientConfig struct {
-	Endpoint     string
-	StateTimeout time.Duration
-	QueryTimeout time.Duration
-	Logger       log.FieldLogger
+	Endpoint       string
+	StateTimeout   time.Duration
+	QueryTimeout   time.Duration
+	CustomClClient string
+	Logger         log.FieldLogger
 }
 
 type Client struct {
-	cfg    ClientConfig
-	base   *url.URL
-	client *http.Client
+	cfg            ClientConfig
+	base           *url.URL
+	client         *http.Client
+	customClClient string
 }
 
 func NewClient(cfg ClientConfig) (*Client, error) {
@@ -44,9 +46,10 @@ func NewClient(cfg ClientConfig) (*Client, error) {
 	}
 
 	cli := &Client{
-		cfg:    cfg,
-		base:   urlBase,
-		client: httpCli,
+		cfg:            cfg,
+		base:           urlBase,
+		client:         httpCli,
+		customClClient: cfg.CustomClClient,
 	}
 
 	return cli, nil
@@ -85,14 +88,17 @@ func (c *Client) get(
 
 	// we will only handle JSONs
 	req.Header.Set("Accept", "application/json")
+	// select an specific cl client from the work-balancer if defined
+	if c.customClClient != "" {
+		req.Header.Set("X-Dugtrio-Next-Endpoint", c.customClClient)
+	}
 
 	l := c.cfg.Logger.WithFields(log.Fields{
 		"url":    callURL,
 		"method": req.Method,
 	})
 	l.Info("requesting beacon API")
 	resp, err := c.client.Do(req)
-
 	if err != nil {
 		l.WithError(err).Warn("error requesting beacon API")
 		return respBody, errors.Wrap(err, fmt.Sprintf("unable to request URL %s", callURL.String()))
@@ -104,6 +110,20 @@ func (c *Client) get(
 	}
 	defer resp.Body.Close()
 
+	if resp.StatusCode < 200 || resp.StatusCode >= 300 {
+		l.WithFields(log.Fields{
+			"status_code": resp.StatusCode,
+			"status":      resp.Status,
+		}).Warn("beacon API returned non-success status code")
+
+		// Read the error response body for better error messages
+		errorBody, readErr := io.ReadAll(resp.Body)
+		if readErr != nil {
+			return respBody, fmt.Errorf("unable to read api-response %s", err.Error())
+		}
+		return respBody, fmt.Errorf("beacon API request failed %s - %s", resp.Status, string(errorBody))
+	}
+
 	respBody, err = io.ReadAll(resp.Body)
 	if err != nil {
 		l.WithError(err).Warn("failed to read response body")

api/client_test.go

@@ -5,17 +5,18 @@ import (
 	"testing"
 	"time"
 
+	log "github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/require"
 )
 
 var (
-	localAvailTestIP = "https://beacon.berlinterop-devnet-2.ethpandaops.io/"
+	localAvailTestIP = "https://beacon.fusaka-devnet-2.ethpandaops.io/"
 	StateTimeout     = 30 * time.Second
 	QueryTimeout     = 10 * time.Second
 )
 
 // API connection
-func Test_APIClient(t *testing.T) {
+func TestApiClient(t *testing.T) {
 	httpCli, testMainCtx, cancel := genTestAPICli(t)
 	defer cancel()
 
@@ -24,46 +25,54 @@ func Test_APIClient(t *testing.T) {
 }
 
 // API endpoints
-func Test_ApiGetNodeVersion(t *testing.T) {
+func TestApiClient_GetNodeVersion(t *testing.T) {
 	httpCli, testMainCtx, cancel := genTestAPICli(t)
 	defer cancel()
 
 	_, err := httpCli.GetNodeVersion(testMainCtx)
 	require.NoError(t, err)
 }
 
-func Test_ApiGetPeerDASstate(t *testing.T) {
+func TestApiClient_GetPeerDASstate(t *testing.T) {
 	httpCli, testMainCtx, cancel := genTestAPICli(t)
 	defer cancel()
 
 	_, err := httpCli.GetBeaconStateHead(testMainCtx)
 	require.NoError(t, err)
 }
 
-func Test_ApiGetForkChoice(t *testing.T) {
+func TestApiClient_GetForkChoice(t *testing.T) {
 	httpCli, testMainCtx, cancel := genTestAPICli(t)
 	defer cancel()
 
 	_, err := httpCli.GetForkChoice(testMainCtx)
 	require.NoError(t, err)
 }
 
-func Test_ApiGetNetworkConfig(t *testing.T) {
+func TestApiClient_GetNetworkConfig(t *testing.T) {
 	httpCli, testMainCtx, cancel := genTestAPICli(t)
 	defer cancel()
 
 	_, err := httpCli.GetNetworkConfig(testMainCtx)
 	require.NoError(t, err)
 }
 
-func Test_ApiGetNodeIdentity(t *testing.T) {
+func TestApiClient_GetNodeIdentity(t *testing.T) {
 	httpCli, testMainCtx, cancel := genTestAPICli(t)
 	defer cancel()
 
 	_, err := httpCli.GetNodeIdentity(testMainCtx)
 	require.NoError(t, err)
 }
 
+func TestApiClient_GetConfigSpec(t *testing.T) {
+	httpCli, testMainCtx, cancel := genTestAPICli(t)
+	defer cancel()
+
+	_, err := httpCli.GetConfigSpecs(testMainCtx)
+	require.NoError(t, err)
+}
+
 // generics
 func genTestAPICli(t *testing.T) (*Client, context.Context, context.CancelFunc) {
 	testMainCtx, cancel := context.WithCancel(context.Background())
@@ -72,6 +81,7 @@ func genTestAPICli(t *testing.T) (*Client, context.Context, context.CancelFunc)
 		Endpoint:     localAvailTestIP,
 		StateTimeout: StateTimeout,
 		QueryTimeout: QueryTimeout,
+		Logger:       log.WithFields(log.Fields{}),
 	}
 
 	httpCli, err := NewClient(cfg)

api/fork_choice.go

@@ -16,17 +16,17 @@ type ForkChoice struct {
 }
 
 type Checkpoint struct {
-	Epoch uint64 `json:"epoch"`
+	Epoch string `json:"epoch"`
 	Root  string `json:"root"`
 }
 
 type ForkChoiceNode struct {
-	Slot               uint64 `json:"slot"`
+	Slot               string `json:"slot"`
 	BlockRoot          string `json:"block_root"`
 	ParentRoot         string `json:"parent_root"`
 	JustifiedEpoch     string `json:"justified_epoch"`
 	FinalizedEpoch     string `json:"finalized_epoch"`
-	Weight             uint64 `json:"weight"`
+	Weight             string `json:"weight"`
 	Validity           string `json:"validity"`
 	ExecutionBlockHash string `json:"execution_block_hash"`
 }