Skip to content

Commit

Permalink
Add env variable docs to readme (#434)
Browse files Browse the repository at this point in the history
* Add env variable docs to readme

* Update README.md

---------

Co-authored-by: Joey Hiller <[email protected]>
  • Loading branch information
madninja and jthiller authored Dec 18, 2024
1 parent 8b9266d commit 21208fc
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,13 @@ actual payment to the API for processing by the blockchain.

The following environment variables are supported:

* `HELIUM_API_URL` - The API URL to use for commands that need API
access, for example sending tokens.
* `SOLANA_MAINNET_URL` - The Solana RPC URL to use for mainnet.
This will get used by default or when `--url m` is passed in.
The default mainnet URL is a rate limited API served by the Helium
Foundation. Use a custom provider for repeated or large requests.

* `SOLANA_DEVNET_URL` - The Solana RPC URL to use for devnet.
This will get used when `--url d` is passed in.

* `HELIUM_WALLET_PASSWORD` - The password to use to decrypt the
wallet. Useful for scripting or other non-interactive commands, but
Expand All @@ -200,6 +205,8 @@ The following environment variables are supported:
* `HELIUM_WALLET_SEED_WORDS` - Space separated list of seed words to use
when restoring a wallet from a mnemonic word list.

* `HELIUM_WALLET_SECRET` - Solana style byte array form of the keypair secret.

### Building from Source

You will need a working Rust tool-chain installed to build this CLI
Expand Down

0 comments on commit 21208fc

Please sign in to comment.