#bitcoin #electrum #server #index #database

bin+lib electrs

An efficient re-implementation of Electrum Server in Rust

23 releases

0.8.10 May 14, 2021
0.8.9 Mar 19, 2021
0.8.8 Feb 22, 2021
0.8.6 Nov 25, 2020
0.1.0 Jul 2, 2018

#178 in Magic Beans

Download history 22/week @ 2021-04-04 27/week @ 2021-04-11 5/week @ 2021-04-18 23/week @ 2021-04-25 25/week @ 2021-05-02 13/week @ 2021-05-09 30/week @ 2021-05-16 52/week @ 2021-05-23 1/week @ 2021-05-30 29/week @ 2021-06-06 14/week @ 2021-06-13 1/week @ 2021-06-20 5/week @ 2021-06-27 7/week @ 2021-07-04 4/week @ 2021-07-11 26/week @ 2021-07-18

116 downloads per month

MIT license

170KB
4.5K SLoC

Electrum Server in Rust

workflows 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.4
  • 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.

Dependencies

~40MB
~853K SLoC