feat: add public url to status api

ethpandaops · Aug 30, 2022 · 5a22b97 · 5a22b97
1 parent 72c1bdb
commit 5a22b97
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 3 deletions.
diff --git a/example_config.yaml b/example_config.yaml
@@ -10,7 +10,9 @@ checkpointz:
     states:
       max_items: 5
   historical_epoch_count: 20
-
+  # set public url where checkpointz will be served from
+  # public_url: https://www.domain.com
+
 beacon:
   upstreams:
   - name: remote

diff --git a/pkg/api/handler.go b/pkg/api/handler.go
@@ -25,16 +25,18 @@ type Handler struct {
 
 	eth         *eth.Handler
 	checkpointz *checkpointz.Handler
+	publicURL   string
 
 	metrics Metrics
 }
 
-func NewHandler(log logrus.FieldLogger, beac beacon.FinalityProvider) *Handler {
+func NewHandler(log logrus.FieldLogger, beac beacon.FinalityProvider, publicURL string) *Handler {
 	return &Handler{
 		log: log.WithField("module", "api"),
 
 		eth:         eth.NewHandler(log, beac, "checkpointz"),
 		checkpointz: checkpointz.NewHandler(log, beac),
+		publicURL:   publicURL,
 
 		metrics: NewMetrics("http"),
 	}
@@ -215,6 +217,8 @@ func (h *Handler) handleCheckpointzStatus(ctx context.Context, r *http.Request,
 		return NewInternalServerErrorResponse(nil), err
 	}
 
+	status.PublicURL = h.publicURL
+
 	return NewSuccessResponse(ContentTypeResolvers{
 		ContentTypeJSON: func() ([]byte, error) {
 			return json.Marshal(status)

diff --git a/pkg/beacon/config.go b/pkg/beacon/config.go
@@ -14,6 +14,9 @@ type Config struct {
 
 	// HistoricalEpochCount determines how many historical epochs the provider will cache.
 	HistoricalEpochCount int `yaml:"historical_epoch_count"`
+
+	// PublicURL is the public URL where checkpointz will be served from
+	PublicURL string `yaml:"public_url"`
 }
 
 // Cache configuration holds configuration for the caches.

diff --git a/pkg/checkpointz/checkpointz.go b/pkg/checkpointz/checkpointz.go
@@ -41,7 +41,7 @@ func NewServer(log *logrus.Logger, conf *Config) *Server {
 		Cfg: *conf,
 		log: log,
 
-		http: api.NewHandler(log, provider),
+		http: api.NewHandler(log, provider, conf.Checkpointz.PublicURL),
 
 		provider: provider,
 	}

diff --git a/pkg/service/checkpointz/responses.go b/pkg/service/checkpointz/responses.go
@@ -10,6 +10,7 @@ import (
 type StatusResponse struct {
 	Upstreams map[string]*beacon.UpstreamStatus `json:"upstreams"`
 	Finality  *v1.Finality                      `json:"finality"`
+	PublicURL string                            `json:"public_url,omitempty"`
 }
 
 type BeaconSlot struct {