PBpool - Installation and Usage Guide

📋 Table of Contents

1. Requirements
2. Installation
3. Configuration
4. Running the Pool
5. Connecting Miners
6. Monitoring
7. Troubleshooting

⚙️ Requirements

System Requirements

• Linux/Windows server (2GB RAM minimum)
• Python 3.8 or higher
• Bitcoin Core (fully synced)
• Root/administrator access (for Bitcoin Core configuration)

Python Packages

The following packages will be automatically installed:

Package	Purpose
flask	Web server for pool interface
python-bitcoinrpc	Bitcoin Core RPC communication
requests	HTTP client for API calls
hashlib	Cryptographic hashing (built-in)

📥 Installation

1. Clone the Repository

git clone https://github.com/HugoXOX3/PBpool.git
cd PBpool

2. Install Python Dependencies

pip install -r requirements.txt

3. Set Up Bitcoin Core

1. Edit your bitcoin.conf (usually found in ~/.bitcoin/bitcoin.conf):

   server=1
   rpcuser=your_username
   rpcpassword=your_password
   rpcallowip=127.0.0.1
   txindex=1

2. Restart Bitcoin Core:

   bitcoind -daemon

⚙️ Configuration

Edit config.json with your preferred settings:

{
  "rpc_user": "your_username",
  "rpc_password": "your_password",
  "rpc_host": "127.0.0.1",
  "rpc_port": 8332,
  "pool_fee": 0.01,
  "min_payout": 0.001,
  "pool_port": 3333,
  "join_password": "Support_HCMLXOX",
  "difficulty": 1024,
  "confirmations_required": 100,
  "payout_interval": 3600,
  "backup_interval": 300
}

🚀 Running the Pool

Start the mining pool server:

python main.py

The pool will start on port 3333 by default. For production use, consider running it as a service:

nohup python main.py > pool.log 2>&1 &

⛏️ Connecting Miners

For ASIC Miners

Configure your miner with these settings:

Pool URL: your-server-ip:3333
Username: your bitcoin address
Worker: ANY_STRING
Password: x

How to Run

1. Clone PythonBitcoinMiner:

   git clone https://github.com/HugoXOX3/PythonBitcoinMiner.git
   cd PythonBitcoinMiner

2. Run and type in with your pool configuration:

   python SoloMiner.py

Key Integration Points

1. Work Fetching
   PythonBitcoinMiner will call /getwork/<address> to receive:

   • Block template (version, previous hash, merkle root, etc.)
   • Target difficulty

2. Share Submission
   The miner will submit solutions to /submit/<address> with:

   {
     "nonce": "discovered_nonce",
     "hash": "block_header_hash",
     "height": "current_block_height"
   }

3. Automatic Payouts
   The pool's existing payout processor will handle rewards as before, sending BTC to the miner's address when thresholds are met.

4. Advantages of This Integration

• Compatibility: PythonBitcoinMiner uses the same HTTP API as your original client.
• Performance: The miner includes optimizations like multi-threading .
• Persistence: Your pool's miners.json tracking remains unchanged.
• Security: Password protection (Support_HCMLXOX) is still enforced.

5. Monitoring Miners

Check individual miner stats via the pool's existing endpoint:

curl http://localhost:3333/stats/yourminingaddress?password=Support_HCMLXOX

Troubleshooting

• If the miner won't connect, verify:
  • The pool URL includes the miner's Bitcoin address.
  • The password in miner_config.json matches the pool's join_password.
• For slow performance, adjust threads in the miner config.

---

📊 Monitoring

Check Pool Status

curl http://localhost:3333/stats/YOUR_BITCOIN_ADDRESS?password=Support_HCMLXOX

View Logs

tail -f pool.log

🔧 Troubleshooting

Common Issues

1. Bitcoin Core not responding

   • Verify Bitcoin Core is running: bitcoin-cli getblockchaininfo
   • Check RPC credentials in bitcoin.conf

2. Connection refused errors

   • Ensure firewall allows the pool port (default: 3333)
   • Check if the pool is running: netstat -tulnp | grep 3333

3. Miner not submitting shares

   • Verify password is correct
   • Check miner logs for error messages

Recovering from Crashes

The pool automatically maintains backups of miner data in miners.json.bak. To restore:

cp miners.json.bak miners.json

📈 Performance Tips

• For high hashrate setups, consider increasing the difficulty in config.json
• Run Bitcoin Core on a separate machine for better performance
• Use a reverse proxy (Nginx) if exposing the pool to the internet

🛡️ Security Recommendations

1. Change the default password in config.json
2. Use HTTPS if exposing the pool publicly
3. Regularly backup the miners.json file
4. Monitor server resources (CPU/RAM usage)

📚 Additional Resources

• Bitcoin Core Documentation
• Stratum Mining Protocol
• Python Flask Documentation

Happy Mining! ⛏️💰

Donations

If you find this project useful, consider supporting it with a Bitcoin donation:

Bitcoin Address: bc1qt7a6vl28czf00vmuse9j7xwpyr7jjt83m2hljh

Star History

License

This project is licensed under the MIT License. See the LICENSE file for details.