Go to file
2023-08-12 12:08:06 -04:00
contrib Add systemd service file example 2018-10-01 21:13:07 +03:00
doc remove unused size_on_disk 2018-08-21 17:59:34 +02:00
examples Add simple transaction ID prefix collision length calculator 2018-10-01 21:15:12 +03:00
scripts Use stable Rust from ./scripts/run.sh 2018-08-02 15:51:21 +03:00
src Don't run full compaction after initial import is over 2018-10-14 10:58:48 +03:00
tools Support testnet mempool visualization 2018-08-14 10:08:11 +03:00
.gitignore remove extra stuff again 2023-08-12 08:20:52 -04:00
.travis.yml Check formatting on Travis 2018-09-28 11:27:02 +03:00
Cargo.lock Add nix flake 2023-08-11 23:50:50 -04:00
Cargo.toml Bump version 2018-10-14 14:40:55 +03:00
Dockerfile Specify user, workdir, ports and signal at Dockerfile 2018-08-20 19:27:23 +03:00
flake.lock Add nix flake 2023-08-11 23:50:50 -04:00
flake.nix fix variables 2023-08-12 12:00:13 -04:00
LICENSE Add MIT license and small README 2018-04-08 23:54:29 +03:00
module.nix try to split out package 2023-08-12 11:55:44 -04:00
package.nix use pkgs.lib instead 2023-08-12 12:08:06 -04:00
README.md Update README with latest performance metrics 2018-07-12 23:26:37 +03:00
RELEASE-NOTES.md Bump version 2018-10-14 14:40:55 +03:00
TODO.md Remove TLS-related TODO 2018-08-15 15:05:40 +03:00

Electrum Server in Rust

Build Status 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 run his own 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 his balances and his 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.

Features

  • Supports Electrum protocol v1.2
  • Maintains an index over transaction inputs and outputs, allowing fast balance queries
  • Fast synchronization of the Bitcoin blockchain (~2 hours for ~187GB @ July 2018) on modest hardware
  • Low index storage overhead (~20%), 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

Usage

See here for installation, build and usage instructions.

Index database

The database schema is described here.