An efficient re-implementation of Electrum Server in Rust
Go to file
Roman Zeyde 603830f1b9
Release 0.10.5
2024-05-17 19:55:05 +03:00
.cargo RUSTSEC-2020-0159 is no longer an issue 2022-10-10 21:20:11 +03:00
.github --jsonrpc-import is no longer supported 2023-06-30 18:43:37 +03:00
contrib Allow skipping merkle proof downloads in `history.py` (#915) 2023-08-11 23:08:02 +03:00
doc Document cleanse of build artifacts (#1014) 2024-03-08 15:10:05 +02:00
examples Add txid collision scanner (#928) 2023-08-28 13:55:41 +03:00
internal Use Option<> for 'db_log_dir' config 2023-11-28 20:13:03 +02:00
logo fixed color in logo and icon export 2021-09-28 19:36:06 +02:00
src Bump 'bitcoin' dependency to 0.32.0 2024-05-17 19:33:27 +03:00
tests Fix electrum integration test script 2023-10-10 22:08:20 +03:00
.dockerignore Refactor and sync using p2p protocol 2021-04-14 18:38:59 +03:00
.gitignore Ignore a few more extensions 2021-10-20 10:14:29 +03:00
CONTRIBUTING.md Fix typos (#847) 2023-02-13 20:19:39 +02:00
Cargo.lock Release 0.10.5 2024-05-17 19:55:05 +03:00
Cargo.toml Release 0.10.5 2024-05-17 19:55:05 +03:00
Dockerfile Dockerfile: re-add curl for the second time, so it can be used for docker health checks (#912) 2023-07-26 15:28:03 +03:00
Dockerfile.ci Use bicoind 27.0 in CI (#1035) 2024-05-10 17:44:49 +03:00
LICENSE Add MIT license and small README 2018-04-08 23:54:29 +03:00
README.md Update expected sync duration for Aug 2023 (#923) 2023-08-19 00:09:38 +03:00
RELEASE-NOTES.md Release 0.10.5 2024-05-17 19:55:05 +03:00
TODO.md Remove TLS-related TODO 2018-08-15 15:05:40 +03:00
build.rs Update `configure_me_codegen` 2022-11-17 01:25:06 +01:00
rust-toolchain.toml Update 'rust-toolchain' file to TOML format (#946) 2023-10-27 20:52:06 +03:00
server.sh Allow setting DB name via `server.sh` 2023-08-18 22:03:16 +03:00

README.md

Logo

Electrum Server in Rust

CI PRs Welcome crates.io gitter.im

An efficient re-implementation of Electrum Server, inspired by ElectrumX, Electrum Personal Server and bitcoincore-indexd.

The motivation behind this project is to enable a user to self host an Electrum server, with required hardware resources not much beyond those of a full node. The server indexes the entire Bitcoin blockchain, and the resulting index enables fast queries for any given user wallet, allowing the user to keep real-time track of balances and transaction history using the Electrum wallet. Since it runs on the user's own machine, there is no need for the wallet to communicate with external Electrum servers, thus preserving the privacy of the user's addresses and balances.

Usage

Please prefer to use OUR usage guide!

External guides can be out-of-date and have various problems. At least double-check that the guide you're using is actively maintained. If you can't use our guide, please ask about what you don't understand or consider using automated deployments.

Note that this implementation of Electrum server is optimized for personal/small-scale (family/friends) usage. It's a bad idea to run it publicly as it'd expose you to DoS and maybe also other attacks. If you want to run a public server you may be interested in the Blockstream fork of electrs which is better optimized for public usage at the cost of consuming significantly more resources.

Features

  • Supports Electrum protocol v1.4
  • Maintains an index over transaction inputs and outputs, allowing fast balance queries
  • Fast synchronization of the Bitcoin blockchain (~6.5 hours for ~504GB @ August 2023) using HDD storage.
  • Low index storage overhead (~10%), relying on a local full node for transaction retrieval
  • Efficient mempool tracker (allowing better fee estimation)
  • Low CPU & memory usage (after initial indexing)
  • txindex is not required for the Bitcoin node
  • Uses a single RocksDB database, for better consistency and crash recovery

Altcoins

Altcoins are not supported! Forks of Bitcoin codebase that relax the consensus rules (hard forks) are also not supported.

You may be able to find a fork of electrs that does support them, look around or make your own, just don't file issues/PRs here.

Index database

The database schema is described here.

Contributing

All contributions to this project are welcome. Please refer to the Contributing Guidelines for more details.

Our logo is generously provided by Dominik Průša under the MIT license. Based on the Electrum logo and the Rust language logo.