mirrors/electrs
1
0
Fork 0
mirror of https://github.com/romanz/electrs.git synced 2024-11-19 09:54:09 +01:00
Code Issues Projects Releases Wiki Activity
An efficient re-implementation of Electrum Server in Rust
491 Commits 12 Branches 54 Tags 12 MiB
Rust 89.4%
Python 8.1%
Shell 2.1%
Dockerfile 0.4%
ebdc252a24
Go to file
Roman Zeyde ebdc252a24
Ignore *~ files
2018-07-19 22:24:58 +03:00
doc Add cmake to installation instructions 2018-07-15 07:49:23 +03:00
examples Rename a few Config members following #19 2018-07-15 22:39:19 +03:00
src Skip already indexed blocks during bulk indexing 2018-07-19 22:02:41 +03:00
tools Refactor mempool visualization tool 2018-07-17 10:11:28 +03:00
.gitignore Ignore *~ files 2018-07-19 22:24:58 +03:00
.travis.yml Allow caching for Travis builds 2018-07-16 12:57:50 +03:00
Cargo.toml Bump version 2018-07-14 18:04:27 +03:00
LICENSE Add MIT license and small README 2018-04-08 23:54:29 +03:00
README.md Update README with latest performance metrics 2018-07-12 23:26:37 +03:00
RELEASE-NOTES.md Add release notes 2018-07-15 09:14:45 +03:00
TODO.md Update TODOs 2018-07-13 21:12:26 +03:00

README.md

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.