MAGICGrants/autoforward-autoconvert
1
0
Fork 0
mirror of https://github.com/MAGICGrants/autoforward-autoconvert.git synced 2026-01-09 21:48:04 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs(README): add MONERO_DAEMON_ADDRESS to env variables table and add more instructions

Browse Source
This commit is contained in:
Artur
2024-10-04 17:09:00 -03:00
parent 7d5c8ad442
commit 8baff95555
2 changed files with 20 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
.env.example
View File

@@ -1,11 +1,6 @@
ELECTRUM_RPC_URL="http://electrum-client:7000"
MONERO_RPC_URL="http://monero-wallet-rpc:18082/json_rpc"
ELECTRUM_RPC_USERNAME="user"
MONERO_RPC_USERNAME="user"
MONERO_DAEMON_ADDRESS="xmr.tcpcat.net:18089"
ELECTRUM_RPC_PASSWORD=""
ELECTRUM_SERVER_ADDRESS=""
MONERO_DAEMON_ADDRESS=""
ELECTRUM_RPC_PASSWORD=""
MONERO_RPC_PASSWORD=""
BITCOIN_WALLET_SEED=""
MONERO_WALLET_SEED=""

22
README.md
View File

@@ -2,8 +2,6 @@
Programs to auto-forward BTC and XMR wallets to Kraken, and then auto-convert to USD.
# Usage
## Requirements
- Docker
@@ -17,18 +15,20 @@ Create a `.env` file as a copy of `.env.example` and set the values for the empt
| Variable name | Required | Default | Description |
| - | - | - | - |
| `BITCOIN_WALLET_SEED` | Yes | - | Your BIP39 mnemonic seed. |
| `MONERO_WALLET_SEED` | Yes | - | Your 14/16/24 word mnemonic seed. |
| `BITCOIN_WALLET_SEED` | Yes | - | Your BIP39 Bitcoin mnemonic seed. |
| `MONERO_WALLET_SEED` | Yes | - | Your 25 word Monero mnemonic seed. |
| `MONERO_WALLET_HEIGHT` | Yes | - | The restore height of your Monero wallet. |
| `ELECTRUM_RPC_PASSWORD` | Yes | - | A new strong password for your Electrum RPC. |
| `MONERO_RPC_PASSWORD` | Yes | - | A new strong password for your Monero RPC. |
| `MONERO_WALLET_PASSWORD` | Yes | - | A new strong password for your Monero Wallet. |
| `KRAKEN_API_KEY` | Yes | - | Your API key from Kraken. |
| `KRAKEN_API_SECRET` | Yes | - | Your API secret from Kraken. |
| `MONERO_DAEMON_ADDRESS` | Yes | - | The address of a Monero daemon you own or trust. |
| `ELECTRUM_SERVER_ADDRESS` | **No** | - | The address of an Electrum server you own or trust. E.g.: `localhost:50001:t` (no SSL) or `my.electrum.server:50001:s` (SSL). By leaving this blank you're letting Electrum select a random server for you, which may be a privacy concern. |
| `MAX_BITCOIN_FEE_PERCENT` | **No** | `10` | The maximum accepted bitcoin miner's fee percent when auto-forwarding. |
| `MAX_SLIPPAGE_PERCENT` | **No** | `1` | The maximum accepted slippage percent when auto-converting. |
## Running
After setting the required environment variable values, you can run the containers:
@@ -37,6 +37,20 @@ After setting the required environment variable values, you can run the containe
$ docker-compose --env-file .env up -d
```
## Changing seeds
If you wish to change any of the wallet seeds in the future, first you have to take down all Docker Compose services and delete the volumes:
```bash
$ docker-compose down -v
```
Change the seeds in the `.env` file and start all services again:
```bash
$ docker-compose --env-file .env up -d
```
# Contributing
Pull requests welcome!