Skip to content

README.md

Latest commit

 

History

History
87 lines (64 loc) · 2.11 KB

README.md

File metadata and controls

87 lines (64 loc) · 2.11 KB
Raw

Xpub Aggregator

Connect Xpub Aggregator to your own Electrum Server and add your XPUBs to get your overall balance across different wallets.

Installation

Prerequisites

  • Python 3.8 or higher
  • An Electrum Server running locally or accessible on your network

Setup

  1. Clone the repository:
git clone <repository-url>
cd xpub-aggregator
  1. Create a virtual environment:
python3 -m venv localenv
source localenv/bin/activate
  1. Install dependencies:
pip install -r requirements.txt

Configuration

Edit config.py and set your Electrum Server connection details and XPUB:

# Electrum Server Configuration
ELECTRUM_HOST = "xxx.xxx.xxx.xxx"  # Your Electrum Server IP
ELECTRUM_PORT = xxxxx            # Your Electrum Server Port

# Bitcoin XPUB to monitor
XPUB = "your_xpub_here"

Running the Application

Make sure your virtual environment is activated:

source localenv/bin/activate

Run the application:

python main.py

The application will:

  1. Connect to your Electrum Server
  2. Fetch your wallet balance
  3. Display your XPUB and total balance in the GUI

Features

  • Real-time Balance: Connects directly to your Electrum Server for live data
  • Balance Display: View your XPUB and total balance in the GUI
  • Add XPUBs through GUI: Add new XPUBs through GUI button
  • Multiple XPUBs: Monitor multiple wallets in one place
  • Balance Tracking: View your aggregated balance across wallets
  • Transaction History: See your transaction history
  • Balance Charts: Visual representation of balance over time
  • Export Data: Export wallet data to CSV/JSON

Troubleshooting

If you encounter connection issues:

  • Verify your Electrum Server is running and accessible
  • Check that ELECTRUM_HOST and ELECTRUM_PORT in config.py are correct
  • Ensure your firewall allows connections to port 50001
  • Check the console logs for detailed error messages

Requirements

See requirements.txt for all dependencies:

  • PySide6 - GUI framework
  • pycoin - Bitcoin utilities

License

MIT License