Skip to content

Commit ae0a84c

Browse files
Update README.md
1 parent ae51d7e commit ae0a84c

File tree

1 file changed

+57
-1
lines changed

1 file changed

+57
-1
lines changed

README.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,62 @@ After saving, **reboot the miner** for changes to take effect.
268268
> 📌 Make sure the `Prefix` matches your naming in the Grafana dashboard to correctly group your stats.
269269

270270

271+
## ⚡ Fulcrum - Electrum Server for Fast Wallet Access
272+
Fulcrum is a high-performance Electrum server written in C++, designed to serve light wallets with fast, index-based blockchain access. It's a critical component if you're running interfaces like **Mempool** or **Electrum wallets** and want **fast, efficient querying** of the Bitcoin blockchain without bogging down your full node.
273+
274+
### 🧠 Why Do We Need Fulcrum?
275+
- **Index-based lookups**: Fulcrum allows wallet clients to quickly check balances, transactions, and history using indexed data.
276+
- **Mempool UI Backend**: The Mempool interface relies on Fulcrum to fetch live blockchain data and mempool information.
277+
- **Separation of Concerns**: Keeps your Bitcoin Core node lean while providing fast query capabilities to external tools.
278+
279+
> ❗ **Important:** Only start Fulcrum **after your Bitcoin node is fully synced**. Running Fulcrum during initial sync can lead to database corruption.
280+
281+
### 🧊 Performance and Stability Warning
282+
Even with NVMe storage, **initialising Fulcrum takes time**. On a Synology DS1019+ with NVMe volumes, the initial index sync **took over a week**.
283+
- Do **not stop** Fulcrum or the NAS during this phase.
284+
- Any interruption can **corrupt the index** and require a full rebuild.
285+
- Consider disabling automatic reboots or DSM updates during initialisation.
286+
287+
### ▶️ Starting Fulcrum
288+
```bash
289+
docker compose --profile bitcoin --profile mempool up -d fulcrum
290+
```
291+
292+
You can monitor its logs with:
293+
```bash
294+
docker logs -f mempool-fulcrum
295+
```
296+
> ✅ Only proceed to set up Mempool or Electrum clients **after** Fulcrum has successfully completed its initial sync.
297+
298+
At that point, Fulcrum will be fully indexed and ready to serve queries. You should see log lines indicating it's listening for connections and serving indexes, e.g.:
299+
```
300+
[info] Now listening on 0.0.0.0:50001 (TCP) and 0.0.0.0:50002 (SSL)
301+
[info] Indexing complete. Ready to serve clients.
302+
```
303+
304+
## Bitcoin Explorer
305+
[Bitcoin RPC Explorer](https://github.com/janoside/btc-rpc-explorer) is a web-based tool for inspecting and querying your local Bitcoin node. It provides an intuitive interface for viewing blocks, transactions, mempool activity, and various statistics pulled via RPC.
306+
307+
This is particularly useful when running your own full node, as it allows you to visualize what your node sees without needing to interact with raw RPC commands.
308+
309+
### Prerequisites
310+
Before starting Bitcoin Explorer, make sure that:
311+
- The **Bitcoin Node** is fully synced and running.
312+
- **Fulcrum** has completed its initial indexing (optional but recommended for completeness).
313+
314+
### Starting the Explorer
315+
316+
Start the container using:
317+
318+
```bash
319+
docker compose --profile bitcoin up -d bitcoin-explorer
320+
```
321+
The explorer will attempt to connect to your Bitcoin node using the credentials from the `.env` file. If everything is set up correctly, you’ll be able to browse blocks, transactions, and node status in real time. Once running, the explorer is accessible via: `http://<your-server-ip>:3002`:
322+
<img width="1370" height="1130" alt="image" src="https://github.com/user-attachments/assets/be89c6bc-b817-420e-af77-18ce0a7fac05" />
323+
324+
325+
326+
271327
## Donations are always welcome
272328

273329
[paypal]: https://paypal.me/GerdNaschenweng
@@ -290,4 +346,4 @@ Crypto.com PayString: magicdude$paystring.crypto.com
290346
🧾 **Recommended Platforms**
291347
- 👉 [Curve.com](https://www.curve.com/join#DWPXKG6E): Add your Crypto.com card to Apple Pay
292348
- 🔐 [Crypto.com](https://crypto.com/app/ref6ayzqvp): Stake and get your free Crypto Visa card
293-
- 📈 [Binance](https://accounts.binance.com/register?ref=13896895): Trade altcoins easily
349+
- 📈 [Binance](https://accounts.binance.com/register?ref=13896895): Trade altcoins easily

0 commit comments

Comments
 (0)