[DataApi] Add EigenDA Public Service Availability Handler (#276)

Co-authored-by: Siddharth More <Siddhi More>
Layr-Labs · Mar 8, 2024 · e903682 · e903682
1 parent 32d449a
commit e903682
Show file tree

Hide file tree

Showing 10 changed files with 866 additions and 36 deletions.
diff --git a/disperser/cmd/dataapi/config.go b/disperser/cmd/dataapi/config.go
@@ -28,6 +28,9 @@ type Config struct {
 
 	BLSOperatorStateRetrieverAddr string
 	EigenDAServiceManagerAddr     string
+
+	DisperserHostname string
+	ChurnerHostname   string
 }
 
 func NewConfig(ctx *cli.Context) Config {
@@ -54,8 +57,10 @@ func NewConfig(ctx *cli.Context) Config {
 		AllowOrigins: ctx.GlobalStringSlice(flags.AllowOriginsFlag.Name),
 		MetricsConfig: dataapi.MetricsConfig{
 			HTTPPort:      ctx.GlobalString(flags.MetricsHTTPPort.Name),
-			EnableMetrics: ctx.GlobalBool(flags.EnableMetrics.Name),
+			EnableMetrics: ctx.GlobalBool(flags.EnableMetricsFlag.Name),
 		},
+		DisperserHostname: ctx.GlobalString(flags.DisperserHostnameFlag.Name),
+		ChurnerHostname:   ctx.GlobalString(flags.ChurnerHostnameFlag.Name),
 	}
 	return config
 }
diff --git a/disperser/cmd/dataapi/flags/flags.go b/disperser/cmd/dataapi/flags/flags.go
@@ -96,12 +96,28 @@ var (
 		EnvVar:   common.PrefixEnvVar(envVarPrefix, "ALLOW_ORIGINS"),
 		Required: true,
 	}
-	EnableMetrics = cli.BoolFlag{
+	EnableMetricsFlag = cli.BoolFlag{
 		Name:     common.PrefixFlag(FlagPrefix, "enable-metrics"),
 		Usage:    "start metrics server",
 		Required: true,
 		EnvVar:   common.PrefixEnvVar(envVarPrefix, "ENABLE_METRICS"),
 	}
+	// EigenDA Disperser and Churner Hostnames to check Server Availability
+	// ex:
+	// disperser-goerli.eigenda.eigenops.xyz,
+	// churner-goerli.eigenda.eigenops.xyz
+	DisperserHostnameFlag = cli.StringFlag{
+		Name:     common.PrefixFlag(FlagPrefix, "eigenda-disperser-hostname"),
+		Usage:    "HostName of EigenDA Disperser",
+		Required: true,
+		EnvVar:   common.PrefixEnvVar(envVarPrefix, "EIGENDA_DISPERSER_HOSTNAME"),
+	}
+	ChurnerHostnameFlag = cli.StringFlag{
+		Name:     common.PrefixFlag(FlagPrefix, "eigenda-churner-hostname"),
+		Usage:    "HostName of EigenDA Churner",
+		Required: true,
+		EnvVar:   common.PrefixEnvVar(envVarPrefix, "EIGENDA_CHURNER_HOSTNAME"),
+	}
 	/* Optional Flags*/
 	MetricsHTTPPort = cli.StringFlag{
 		Name:     common.PrefixFlag(FlagPrefix, "metrics-http-port"),
@@ -125,7 +141,9 @@ var requiredFlags = []cli.Flag{
 	PrometheusServerSecretFlag,
 	PrometheusMetricsClusterLabelFlag,
 	AllowOriginsFlag,
-	EnableMetrics,
+	EnableMetricsFlag,
+	DisperserHostnameFlag,
+	ChurnerHostnameFlag,
 }
 
 var optionalFlags = []cli.Flag{

diff --git a/disperser/cmd/dataapi/main.go b/disperser/cmd/dataapi/main.go
@@ -5,6 +5,8 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"os/signal"
+	"syscall"
 
 	"github.com/Layr-Labs/eigenda/common/aws/dynamodb"
 	"github.com/Layr-Labs/eigenda/common/aws/s3"
@@ -90,9 +92,11 @@ func RunDataApi(ctx *cli.Context) error {
 		metrics           = dataapi.NewMetrics(blobMetadataStore, config.MetricsConfig.HTTPPort, logger)
 		server            = dataapi.NewServer(
 			dataapi.Config{
-				ServerMode:   config.ServerMode,
-				SocketAddr:   config.SocketAddr,
-				AllowOrigins: config.AllowOrigins,
+				ServerMode:        config.ServerMode,
+				SocketAddr:        config.SocketAddr,
+				AllowOrigins:      config.AllowOrigins,
+				DisperserHostname: config.DisperserHostname,
+				ChurnerHostname:   config.ChurnerHostname,
 			},
 			sharedStorage,
 			promClient,
@@ -101,6 +105,8 @@ func RunDataApi(ctx *cli.Context) error {
 			chainState,
 			logger,
 			metrics,
+			nil,
+			nil,
 		)
 	)
 
@@ -111,5 +117,26 @@ func RunDataApi(ctx *cli.Context) error {
 		logger.Info("Enabled metrics for Data Access API", "socket", httpSocket)
 	}
 
+	// Setup channel to listen for termination signals
+	quit := make(chan os.Signal, 1)
+	// catch SIGINT (Ctrl+C) and SIGTERM (e.g., from `kill`)
+	signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
+
+	// Run server in a separate goroutine so that it doesn't block.
+	go func() {
+		if err := server.Start(); err != nil {
+			logger.Fatalf("Failed to start server: %v", err)
+		}
+	}()
+
+	// Block until a signal is received.
+	<-quit
+	logger.Info("Shutting down server...")
+	err = server.Shutdown()
+
+	if err != nil {
+		logger.Errorf("Failed to shutdown server: %v", err)
+	}
+
 	return server.Start()
 }
diff --git a/disperser/dataapi/config.go b/disperser/dataapi/config.go
@@ -1,7 +1,9 @@
 package dataapi
 
 type Config struct {
-	SocketAddr   string
-	ServerMode   string
-	AllowOrigins []string
+	SocketAddr        string
+	ServerMode        string
+	AllowOrigins      []string
+	DisperserHostname string
+	ChurnerHostname   string
 }
diff --git a/disperser/dataapi/docs/docs.go b/disperser/dataapi/docs/docs.go
@@ -15,6 +15,43 @@ const docTemplate = `{
     "host": "{{.Host}}",
     "basePath": "{{.BasePath}}",
     "paths": {
+        "/eigenda/service-availability": {
+            "get": {
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "ServiceAvailability"
+                ],
+                "summary": "Get status of public EigenDA services.",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/dataapi.ServiceAvailabilityResponse"
+                        }
+                    },
+                    "400": {
+                        "description": "error: Bad request",
+                        "schema": {
+                            "$ref": "#/definitions/dataapi.ErrorResponse"
+                        }
+                    },
+                    "404": {
+                        "description": "error: Not found",
+                        "schema": {
+                            "$ref": "#/definitions/dataapi.ErrorResponse"
+                        }
+                    },
+                    "500": {
+                        "description": "error: Server error",
+                        "schema": {
+                            "$ref": "#/definitions/dataapi.ErrorResponse"
+                        }
+                    }
+                }
+            }
+        },
         "/feed/blobs": {
             "get": {
                 "produces": [
@@ -542,6 +579,31 @@ const docTemplate = `{
                 }
             }
         },
+        "dataapi.ServiceAvailability": {
+            "type": "object",
+            "properties": {
+                "service_name": {
+                    "type": "string"
+                },
+                "service_status": {
+                    "type": "string"
+                }
+            }
+        },
+        "dataapi.ServiceAvailabilityResponse": {
+            "type": "object",
+            "properties": {
+                "data": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/dataapi.ServiceAvailability"
+                    }
+                },
+                "meta": {
+                    "$ref": "#/definitions/dataapi.Meta"
+                }
+            }
+        },
         "dataapi.Throughput": {
             "type": "object",
             "properties": {

diff --git a/disperser/dataapi/docs/swagger.json b/disperser/dataapi/docs/swagger.json
@@ -11,6 +11,43 @@
         "version": "1"
     },
     "paths": {
+        "/eigenda/service-availability": {
+            "get": {
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "ServiceAvailability"
+                ],
+                "summary": "Get status of public EigenDA services.",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/dataapi.ServiceAvailabilityResponse"
+                        }
+                    },
+                    "400": {
+                        "description": "error: Bad request",
+                        "schema": {
+                            "$ref": "#/definitions/dataapi.ErrorResponse"
+                        }
+                    },
+                    "404": {
+                        "description": "error: Not found",
+                        "schema": {
+                            "$ref": "#/definitions/dataapi.ErrorResponse"
+                        }
+                    },
+                    "500": {
+                        "description": "error: Server error",
+                        "schema": {
+                            "$ref": "#/definitions/dataapi.ErrorResponse"
+                        }
+                    }
+                }
+            }
+        },
         "/feed/blobs": {
             "get": {
                 "produces": [
@@ -538,6 +575,31 @@
                 }
             }
         },
+        "dataapi.ServiceAvailability": {
+            "type": "object",
+            "properties": {
+                "service_name": {
+                    "type": "string"
+                },
+                "service_status": {
+                    "type": "string"
+                }
+            }
+        },
+        "dataapi.ServiceAvailabilityResponse": {
+            "type": "object",
+            "properties": {
+                "data": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/dataapi.ServiceAvailability"
+                    }
+                },
+                "meta": {
+                    "$ref": "#/definitions/dataapi.Meta"
+                }
+            }
+        },
         "dataapi.Throughput": {
             "type": "object",
             "properties": {

diff --git a/disperser/dataapi/docs/swagger.yaml b/disperser/dataapi/docs/swagger.yaml
@@ -132,6 +132,22 @@ definitions:
       meta:
         $ref: '#/definitions/dataapi.Meta'
     type: object
+  dataapi.ServiceAvailability:
+    properties:
+      service_name:
+        type: string
+      service_status:
+        type: string
+    type: object
+  dataapi.ServiceAvailabilityResponse:
+    properties:
+      data:
+        items:
+          $ref: '#/definitions/dataapi.ServiceAvailability'
+        type: array
+      meta:
+        $ref: '#/definitions/dataapi.Meta'
+    type: object
   dataapi.Throughput:
     properties:
       throughput:
@@ -194,6 +210,30 @@ info:
   title: EigenDA Data Access API
   version: "1"
 paths:
+  /eigenda/service-availability:
+    get:
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/dataapi.ServiceAvailabilityResponse'
+        "400":
+          description: 'error: Bad request'
+          schema:
+            $ref: '#/definitions/dataapi.ErrorResponse'
+        "404":
+          description: 'error: Not found'
+          schema:
+            $ref: '#/definitions/dataapi.ErrorResponse'
+        "500":
+          description: 'error: Server error'
+          schema:
+            $ref: '#/definitions/dataapi.ErrorResponse'
+      summary: Get status of public EigenDA services.
+      tags:
+      - ServiceAvailability
   /feed/blobs:
     get:
       parameters: