Skip to content

Commit ba2a323

Browse files
Add --rpc-config description to login.md
1 parent 91970cf commit ba2a323

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

src/getting_started/login.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,32 @@ Options:
5858
```
5959

6060
A home directory must be supplied — where the node will store its files.
61-
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).
61+
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).
6262
If this is not supplied, the node will use a set of default RPC providers served by other nodes on the network.
63+
Alternatively, use the `--rpc-config` flag to specify more than one `wss://` provider and/or to include authentication credentials -- see the description below.
6364
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.
6465
If no `--port` flag is supplied, Hyperdrive will bind to `8080` if it is available, or the first port above `8080` if not.
6566

67+
<details><summary>OPTIONAL: The --rpc-config File Format</summary>
68+
69+
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:
70+
```
71+
[
72+
{
73+
"url": "wss://mytoppriority.eth-provider.net",
74+
"auth": {
75+
"Bearer": "7f94d4799c13"
76+
}
77+
},
78+
{
79+
"url": "wss://wss://mysecondpriority.unauthenticated-eth.org"
80+
}
81+
]
82+
```
83+
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.
84+
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.
85+
86+
</details>
6687
<details><summary>OPTIONAL: Acquiring an RPC API Key</summary>
6788

6889
### Acquiring an RPC API Key

0 commit comments

Comments
 (0)