Skip to content

Commit

Permalink
feat: Add light client proxy mode config option
Browse files Browse the repository at this point in the history
  • Loading branch information
samcm committed Oct 24, 2024
1 parent 0eeef42 commit bceb6c1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Checkpointz simplifies the process of running an Ethereum Beacon Chain checkpoin
- Resource reduction
- Adds HTTP cache-control headers depending on the content
- DOS protection
- Never routes an incoming request directly to an upstream beacon node
- Never routes an incoming request directly to an upstream beacon node unless `light_client.mode` is set to `proxy`
- Support for multiple upstream beacon nodes
- Only serves a new finalized epoch once 50%+ of upstream beacon nodes agree
- Extensive Prometheus metrics
Expand Down Expand Up @@ -168,7 +168,14 @@ checkpointz:
# brand_name: Brandname
# The public URL of where the frontend will be served from (optional)
# public_url: https://www.domain.com

light_client:
# Enables light_client routes
enabled: false
# Proxy mode will proxy requests to the upstream beacon node
# WARNING: This will increase the load on the upstream beacon node
# AND EXPOSES YOUR BEACON NODE TO UNPREDICTABLE API LOAD.
# DO NOT USE THIS ON A VALIDATOR NODE.
mode: proxy
beacon:
# Upstreams configures the upstream beacon nodes to use.
upstreams:
Expand Down
9 changes: 8 additions & 1 deletion example_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,14 @@ checkpointz:
brand_name: Brandname
# public url where frontend will be served from (optional)
public_url: https://www.domain.com

light_client:
# Enables light_client routes
enabled: false
# Proxy mode will proxy requests to the upstream beacon node
# WARNING: This will increase the load on the upstream beacon node
# AND EXPOSES YOUR BEACON NODE TO UNPREDICTABLE API LOAD.
# DO NOT USE THIS ON A VALIDATOR NODE.
mode: proxy

beacon:
upstreams:
Expand Down

0 comments on commit bceb6c1

Please sign in to comment.