Skip to content

Add --rpc-config format to login.md #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dolled-possum wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add --rpc-config format to login.md #286

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
051b030
Add --rpc-config format to login.md
dolled-possum Aug 27, 2025
60c4294
additional info about the possible auth choices
dolled-possum Aug 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion src/getting_started/login.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,36 @@ Options:
```

A home directory must be supplied — where the node will store its files.
The `--rpc` flag is an optional `wss://` WebSocket link to an Ethereum RPC, allowing Hyperdrive to send and receive Ethereum transactions — used in the [identity system](../getting_started/hypermap.md#hns-hyperware-name-system) as mentioned [above](#creating-an-alchemy-account).
The `--rpc` flag is an optional `wss://` WebSocket link to an Ethereum RPC, allowing Hyperdrive to send and receive Ethereum transactions — used in the [identity system](../getting_started/hypermap.md#hns-hyperware-name-system) as mentioned [below](#creating-an-alchemy-account).
If this is not supplied, the node will use a set of default RPC providers served by other nodes on the network.
Alternatively, use the `--rpc-config` flag to specify more than one `wss://` provider and/or to include authentication credentials -- see the description below.
If the `--port` flag is supplied, Hyperdrive will attempt to bind that port for serving HTTP and will exit if that port is already taken.
If no `--port` flag is supplied, Hyperdrive will bind to `8080` if it is available, or the first port above `8080` if not.

<details><summary>OPTIONAL: The --rpc-config File Format</summary>

If you wish to designate more than one Ethereum RPC providers, or if your provider requires authentication headers, you can replace the `--rpc <url>` flag with `--rpc-config <rpc_config_file_path>` instead, where `<rpc_config_file_path>` is a file structured as follows:
```
[
{
"url": "wss://mytoppriority.eth-provider.net",
"auth": {
"Bearer": "7f94d4799c13"
}
},
{
"url": "wss://wss://mysecondpriority.unauthenticated-eth.org"
}
]
```
Your node will attempt to use the Ethereum RPC providers in the order you have listed them. Possible "auth" types are Basic, Bearer, and Raw.
* `Basic` will base64 encode the string value in the form of `user:password` and generate a header of `Authorization: Basic <the base64 encoding of user:password>`
* `Bearer` will use the value as a bearer token and generate a header of `Authorization: Bearer <value>`
* `Raw` will use the value directly and generate a header of `Authorization: <values>`

Additionally, you may view, add, and remove RPC providers from a running node at the terminal prompt using the `get-providers`, `add-rpcurl-provider`, and `remove-provider` commands.

</details>
<details><summary>OPTIONAL: Acquiring an RPC API Key</summary>

### Acquiring an RPC API Key
Expand Down