Skip to content

Commit

Permalink
fix(docs): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
helius-wedtm committed Mar 6, 2023
1 parent 9896098 commit d221f0f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Helius RPC Proxy

> NOTE: You must have an existing Helius account and API key for this to work! Get one for free at https://helius.xyz.
[![RPC Proxy](docs/rpc_proxy.png)](https://helius.xyz)

This repo hosts a one-click-deploy Cloudflare worker that proxies RPC requests to Helius. The proxy will allow you to keep your API key
hidden from public requests made by clients.
hidden from public requests made by clients. You will need both a [Helius](https://helius.xyz) account and a [Cloudflare](https://cloudflare.com) account to deploy this. Helius offers 100k credits for free each month, and Cloudflare workers can execute 100k invocations each day for free. Most projects can easily get started within these free tiers.

[Video Walkthrough](https://www.loom.com/share/a7add579f1c349d2a4bcab96ee04c47e)
Both standard JSON RPC and Websockets are supported!

[Video Walkthrough](https://www.loom.com/share/a7add579f1c349d2a4bcab96ee04c47e)

# Setup
### Step 1
Expand Down Expand Up @@ -42,5 +43,5 @@ lock down your RPC proxy further, consider the following steps after you have su


* Update the `Access-Control-Allow-Origin` header in `src/index.ts` to contain the host that your requests are coming from (usually your client application).
* Cloudflare Web Application Firewall (WAF) - You can configure the WAF to inspect requests and allow/deny based on your own business logic.
* [Cloudflare Web Application Firewall (WAF)](https://www.cloudflare.com/lp/ppc/waf-x/) - You can configure the WAF to inspect requests and allow/deny based on your own business logic.
* Modify the IP address allow list in Helius for your API key to only accept connections from the Cloudflare ranges (https://cloudflare.com/ips-v4).
Binary file added docs/rpc_proxy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d221f0f

Please sign in to comment.