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
450 Commits 12 Branches 54 Tags 12 MiB
Rust 89.4%
Python 8.1%
Shell 2.1%
Dockerfile 0.4%
4d322d4819
Go to file
Roman Zeyde 4d322d4819
Substract signed integers
2018-07-12 19:38:39 +03:00
doc Update usage documentation for JSONRPC cookie 2018-07-08 22:22:32 +03:00
examples Move bulk reader and indexer to separate module 2018-07-12 16:47:39 +03:00
src Substract signed integers 2018-07-12 19:38:39 +03:00
tools Show # of mempool transactions 2018-07-03 15:38:30 +03:00
.gitignore Ignore other DB directories 2018-06-12 00:01:20 +03:00
.travis.yml Don't build on nightly Rust 2018-05-17 12:28:40 +03:00
Cargo.toml Increase open files limit explicitly 2018-07-12 14:44:10 +03:00
LICENSE Add MIT license and small README 2018-04-08 23:54:29 +03:00
README.md Add Gitter badge 2018-07-08 14:11:48 +03:00
TODO.md Update TODOs 2018-07-05 12:37:25 +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.5 hours for ~185GB @ June 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.