Skip to content

Docs/readme rpc auth and env vars #387

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
Musab1258 wants to merge 2 commits into
base: master
Choose a base branch
from
+27 −2
Open

Docs/readme rpc auth and env vars #387

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7878e84
docs(readme): correct rpc auth options in wallet config usage
Musab1258 Nov 12, 2026
e5df5a8
docs(readme): document env vars accepted by wallet config
Musab1258 Nov 12, 2026
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
29 changes: 27 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,10 +334,12 @@ The `wallet config` sub-command allows you to save wallet settings to a `config.
To save a wallet settings:

```shell
cargo run --features <list-of-features> -- -n <network> wallet --wallet <wallet_name> config [ -f ] --ext-descriptor <ext_descriptor> --int-descriptor <int_descriptor> --client-type <client_type> --url <server_url> [--database-type <database_type>] [--rpc-user <rpc_user>]
[--rpc-password <rpc_password>]
cargo run --features <list-of-features> -- -n <network> wallet --wallet <wallet_name> config [ -f ] --ext-descriptor <ext_descriptor> --int-descriptor <int_descriptor> --client-type <client_type> --url <server_url> [--database-type <database_type>] [--basic-auth <user:password>]
[<cookie>]
```

The `--basic-auth` option and the `<cookie>` file path apply to the `rpc` backend. If a cookie is given, it is used instead of the user and password.

For example, to initialize a wallet named `my_wallet` with `electrum` as the backend on `signet` network:

```shell
Expand All @@ -346,6 +348,29 @@ cargo run --features electrum -- -n signet wallet -w my_wallet config -e "tr(tpr

To overwrite an existing wallet configuration, use the `--force` flag after the `config` sub-command.

#### Setting options with environment variables

Most `wallet config` options can also be set through an environment variable. A flag given on the command line takes precedence over its variable. The values are saved to `config.toml`, and the other wallet commands read that file, so changing a variable later does not change a wallet that is already saved.

| Variable | Option | Used by |
| --- | --- | --- |
| `NETWORK` | `-n`, `--network` | all commands |
| `DATADIR` | `-d`, `--datadir` | all commands |
| `WALLET_NAME` | `-w`, `--wallet` | `wallet` and `repl` |
| `EXT_DESCRIPTOR` | `-e`, `--ext-descriptor` | `wallet config` |
| `INT_DESCRIPTOR` | `-i`, `--int-descriptor` | `wallet config` |
| `CLIENT_TYPE` | `-c`, `--client-type` | `wallet config` |
| `DATABASE_TYPE` | `-d`, `--database-type` | `wallet config` |
| `SERVER_URL` | `-u`, `--url` | `wallet config`, backends `electrum`, `esplora` and `rpc` |
| `ELECTRUM_BATCH_SIZE` | `-b`, `--batch-size` | `wallet config`, backend `electrum` |
| `ESPLORA_PARALLEL_REQUESTS` | `-p`, `--parallel-requests` | `wallet config`, backend `esplora` |
| `RPC_BASIC_AUTH` | `-a`, `--basic-auth` (as `user:password`) | `wallet config`, backend `rpc` |
| `COOKIE` | the `<cookie>` argument | `wallet config`, backend `rpc` |
| `PROXY_ADDRS_PORT` | `--proxy` | `wallet config`, backends `electrum`, `esplora` and `cbf` |
| `PROXY_USER_PASSWD` | `--proxy_auth` (as `user:password`) | `wallet config`, backends `electrum` and `esplora` |
| `PROXY_RETRIES` | `-r`, `--retries` | `wallet config`, backends `electrum` and `esplora` |
| `PROXY_TIMEOUT` | `-t`, `--timeout` | `wallet config`, backends `electrum` and `esplora` |

#### Using a Configured Wallet

Once configured, use any wallet command with just the wallet name:
Expand Down
Loading