From 741a60682be00eedd367388ffae9dfcd4f279ebf Mon Sep 17 00:00:00 2001 From: sukoneck <19413126+sukoneck@users.noreply.github.com> Date: Tue, 31 Oct 2023 11:36:04 -0700 Subject: [PATCH] website custom data origin (#549) * add LinkDataAPI env to website service * fix env name * fix env name * fix payload link * add website env to readme * Update README.md Co-authored-by: shana --------- Co-authored-by: shana --- README.md | 11 ++++++++++- cmd/website.go | 4 ++++ services/website/html.go | 1 + services/website/website.go | 2 ++ services/website/website.html | 5 +++-- 5 files changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e05da051..e78e0302 100644 --- a/README.md +++ b/README.md @@ -160,10 +160,19 @@ redis-cli DEL boost-relay/sepolia:validators-registration boost-relay/sepolia:va * `RUN_INTEGRATION_TESTS` - when set to "1" enables integration tests, currently used for testing Memcached using comma separated list of endpoints specified by `MEMCACHED_URIS` * `TEST_DB_DSN` - specifies connection string using Data Source Name (DSN) for Postgres (default: postgres://postgres:postgres@localhost:5432/postgres?sslmode=disable) -#### Redis tuning +#### Redis Tuning * `REDIS_CONNECTION_POOL_SIZE`, `REDIS_MIN_IDLE_CONNECTIONS`, `REDIS_READ_TIMEOUT_SEC`, `REDIS_POOL_TIMEOUT_SEC`, `REDIS_WRITE_TIMEOUT_SEC` (see also [the code here](https://github.com/flashbots/mev-boost-relay/blob/e39cd38010de26bf9a51d1a3e77fc235ea87b12f/datastore/redis.go#L35-L41)) +#### Website + +* `LINK_BEACONCHAIN` - url for beaconcha.in (default: `https://beaconcha.in`) +* `LINK_DATA_API` - origin url for data api (https://domain:port) +* `LINK_ETHERSCAN` - url for etherscan (default: `https://etherscan.io`) +* `LISTEN_ADDR` - listen address for webserver (default: `localhost:9060`) +* `RELAY_URL` - full url for the relay (https://pubkey@host) +* `SHOW_CONFIG_DETAILS` - when set to "1", logs configuration details + ## Updating the website * Edit the HTML in `services/website/website.html` diff --git a/cmd/website.go b/cmd/website.go index e075f43a..e7781416 100644 --- a/cmd/website.go +++ b/cmd/website.go @@ -17,6 +17,7 @@ var ( websiteDefaultShowConfigDetails = os.Getenv("SHOW_CONFIG_DETAILS") == "1" websiteDefaultLinkBeaconchain = common.GetEnv("LINK_BEACONCHAIN", "https://beaconcha.in") websiteDefaultLinkEtherscan = common.GetEnv("LINK_ETHERSCAN", "https://etherscan.io") + websiteDefaultLinkDataAPI = common.GetEnv("LINK_DATA_API", "") websiteDefaultRelayURL = common.GetEnv("RELAY_URL", "") websiteListenAddr string @@ -25,6 +26,7 @@ var ( websiteLinkBeaconchain string websiteLinkEtherscan string + websiteLinkDataAPI string websiteRelayURL string ) @@ -43,6 +45,7 @@ func init() { websiteCmd.Flags().BoolVar(&websiteShowConfigDetails, "show-config-details", websiteDefaultShowConfigDetails, "show config details") websiteCmd.Flags().StringVar(&websiteLinkBeaconchain, "link-beaconchain", websiteDefaultLinkBeaconchain, "url for beaconcha.in") websiteCmd.Flags().StringVar(&websiteLinkEtherscan, "link-etherscan", websiteDefaultLinkEtherscan, "url for etherscan") + websiteCmd.Flags().StringVar(&websiteLinkDataAPI, "link-data-api", websiteDefaultLinkDataAPI, "origin url for data api (https://domain:port)") websiteCmd.Flags().StringVar(&websiteRelayURL, "relay-url", websiteDefaultRelayURL, "full url for the relay (https://pubkey@host)") } @@ -110,6 +113,7 @@ var websiteCmd = &cobra.Command{ ShowConfigDetails: websiteShowConfigDetails, LinkBeaconchain: websiteLinkBeaconchain, LinkEtherscan: websiteLinkEtherscan, + LinkDataAPI: websiteLinkDataAPI, RelayURL: websiteRelayURL, } diff --git a/services/website/html.go b/services/website/html.go index ec7f718c..56870631 100644 --- a/services/website/html.go +++ b/services/website/html.go @@ -40,6 +40,7 @@ type StatusHTMLData struct { //nolint:musttag ShowConfigDetails bool LinkBeaconchain string LinkEtherscan string + LinkDataAPI string RelayURL string } diff --git a/services/website/website.go b/services/website/website.go index 61b2d6e2..5044ad12 100644 --- a/services/website/website.go +++ b/services/website/website.go @@ -42,6 +42,7 @@ type WebserverOpts struct { ShowConfigDetails bool LinkBeaconchain string LinkEtherscan string + LinkDataAPI string RelayURL string } @@ -110,6 +111,7 @@ func NewWebserver(opts *WebserverOpts) (*Webserver, error) { ShowConfigDetails: opts.ShowConfigDetails, LinkBeaconchain: opts.LinkBeaconchain, LinkEtherscan: opts.LinkEtherscan, + LinkDataAPI: opts.LinkDataAPI, RelayURL: opts.RelayURL, } diff --git a/services/website/website.html b/services/website/website.html index 25f5f69e..877a6b76 100644 --- a/services/website/website.html +++ b/services/website/website.html @@ -248,11 +248,12 @@

{{$linkBeaconchain := .LinkBeaconchain}} {{$linkEtherscan := .LinkEtherscan}} + {{$linkDataAPI := .LinkDataAPI}} {{ range .Payloads }} {{.Epoch | prettyInt}} - {{.Slot | prettyInt}} + {{.Slot | prettyInt}} {{.BlockNumber | prettyInt}} {{.Value | weiToEth}} @@ -279,7 +280,7 @@

{{.NumPayloadsDelivered | prettyInt}} payloads delivered

- Data API · Bulk Data · Docs + Data API · Bulk Data · Docs