valtrack

Valtrack

Valtrack ist eine Reihe von Tools, die darauf abzielen, Ethereum-Validatoren zu verfolgen.

Beispielausgabe in CSV: validator_metadata_events_sample.csv

Erste Schritte

Um mit Valtrack zu beginnen, müssen Sie das Repository klonen und die Abhängigkeiten installieren.

1. Klonen Sie das Repository klonen

git clone [email protected]:chainbound/valtrack.git

2. Installieren Sie Abhängigkeiten und bauen Sie

Valtrack:

go mod download
go build

Nats:

• https://docs.nats.io/running-a-nats-service/inTroduction/installation

3. Führen Sie die Anwendung aus

Valtrack besteht aus 3 Hauptkomponenten: dem Sentry , dem Verbraucher und einem Nats -Jetstream -Server. Der Sentry ist dafür verantwortlich, Ethereum -Validatoren zu entdecken und zu verfolgen, während der Verbraucher die vom Sentry veröffentlichten Daten konsumiert, verarbeitet und in einer Datenbank gespeichert (für den Moment). Lesen Sie mehr unter Architektur.

Posten

Um den Wachposten auszuführen:

./valtrack --nats-url nats://localhost:4222 sentry

Verbraucher

./valtrack --nats-url nats://localhost:4222 consumer

Nats Jetstream

Wir bieten eine Beispielkonfigurationsdatei für den NATS-Server in Server/nats-server.conf. Um den NATS -Server mit aktivierter Jetstream auszuführen, können Sie den folgenden Befehl ausführen:

nats-server --jetstream --config server/nats-server.conf

Dadurch wird ein data im aktuellen Arbeitsverzeichnis mit allen Jetstream -Daten erstellt.

Dies sollte diesen Hilfestext drucken

 NAME:
   valtrack - Ethereum consensus validator tracking tool

USAGE:
   valtrack [global options] command [command options] [arguments...]

COMMANDS:
   sentry    run the sentry node
   consumer  run the consumer
   help, h   Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --log-level value, -l value  log level (default: "info")
   --nats-url value, -n value   NATS server URL (needs JetStream) (default: "nats://localhost:4222")
   --help, -h                   show help

Architektur

Wachsinn

Der Beacon -Sentry ist ein Dienst, der das Ethereum dishv5 DHT kriecht und Knoten entdeckt und auf eingehende Verbindungen hört. Es versucht, sich mit allen entdeckten Kollegen zu verbinden, und führt einen Handschlag für ihren Status und MetaData durch.

Parallel dazu wird versucht, die Klatschsub -Abonnements des Peer zu messen, insbesondere auf die Subnetzthemen der Bescheinigung. Sobald es all diese Daten hat, wird es an den Nats Jetstream Server veröffentlicht.

Gleichaltrige werden in einem Peerstore gespeichert, das in regelmäßigen Abständen (jede Epoche) diesen Prozess wieder durchläuft. Dies ermöglicht es uns, im Laufe der Zeit mehrere Datenpunkte zu erhalten, die mehr Genauigkeit bei der Ermittlung der Anzahl der an einen Beacon -Knoten angeschlossenen Validatoren bieten.

TODO: Der Beacon Sentry sollte später Schätzungen über die Anzahl der an einen Beacon -Knoten angeschlossenen Validatoren speichern. Es sollte es dann über eine API aufdecken.

Verbraucher

Consumer ist ein Dienst, der die Sentry -Daten vom NATS Jetstream -Server konsumiert und in der Parquetdatei (Datenbank in Kürze) speichert. Verwaltet 3 Tische:

• discovery_events : Enthält die Entdeckungsereignisse des Wachpostens
• metadata_events : enthält die Metadatenereignisse des Wachpostens
• validator_metadata_events : Eine abgeleitete Tabelle aus den Metadatenereignissen, die Datenpunkte von Validatoren enthält

NATS Server

Nats ist eine meldungsorientierte Middleware. Valtrack verwendet Nats Jetstream, mit dem die Funktionen von Nachrichtenpersistenz ermöglicht werden.

Installation

Überprüfen Sie die offizielle NATS -Dokumentation für NATS -Installationsanweisungen Dokumente

So führen Sie den Nats Jetstream Server aus:

nats-server --jetstream

Stream -Konfiguration

Es ist wichtig, Stream mit der richtigen Konfiguration gemäß den Anforderungen zu erstellen. Dokumente

Valtrack verwendet die folgende Konfiguration:

 jetstreamCfg := jetstream. StreamConfig {
		Name :      "EVENTS" ,
		Retention : jetstream . InterestPolicy ,
		Subjects :  [] string { "events.metadata_received" , "events.peer_discovered" },
	}

• RetentionPolicy wird auf Interesse eingestellt, was bedeutet, dass die Nachrichten auf der Grundlage des Verbrauchers an den Nachrichten zurückgeführt werden. Die Nachrichten werden aufbewahrt, bis alle Verbraucher anerkannt werden. Wenn es keine Verbraucher gibt, bleiben die Nachrichten nicht aufbewahrt. Dokumente
• Die Probanden sind die NATS -Probanden, bei denen die Sentry -Daten veröffentlicht werden.

Verbraucherkonfiguration

Consumer Configuration DOCs Valtrack verwendet die folgende Konfiguration:

 consumerCfg := jetstream. ConsumerConfig {
		Name :        fmt . Sprintf ( "consumer-%s" , uniqueID ),
		Durable :     fmt . Sprintf ( "consumer-%s" , uniqueID ),
		Description : "Consumes valtrack events" ,
		AckPolicy :   jetstream . AckExplicitPolicy ,
	}

• Langlebig ist festgelegt, was bedeutet, dass der Verbraucher bis ausdrücklich gelöscht wird.
• AckPolicy ist auf ackexplicitPolicy eingestellt, was bedeutet, dass der Verbraucher die Nachricht explizit anerkennen muss. Dokumente

API -Verwendung

Der Verbraucher wird eine API zur Abfrage der in der Datenbank gespeicherten Daten aussetzen. Die API wird eine REST -API sein.

Öffentlicher Zugriff (regulärer Benutzer, kein Schlüssel erforderlich):

curl http://localhost:8080/validators

Administratorzugriff (erfordert einen API -Schlüssel):

curl -H " X-API-KEY: <API-KEY> " http://localhost:8080/validators

API -Tasten können in der Datei api_keys.txt hinzugefügt werden.

Credits

Ruf zu den folgenden Projekten zur Inspiration und Referenz:

• Hermes
• Armiarma