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
711 Commits 12 Branches 54 Tags 12 MiB
Rust 89.4%
Python 8.1%
Shell 2.1%
Dockerfile 0.4%
ac7ba501cf
Go to file
Dagur Valberg Johannsson ac7ba501cf [stats] Update index height when chain shortens 
This makes electrs_index_height report the right height after
`invalidateblock` call in bitcoind
2019-05-14 15:42:59 +02:00
.circleci Update CI and documentation for Rust 1.32 2019-05-11 10:07:43 +03:00
contrib Consolidate tools/* under contrib/ 2018-11-22 10:52:21 +02:00
doc Update CI and documentation for Rust 1.32 2019-05-11 10:07:43 +03:00
examples Fix more Clippy warnings 2019-03-08 21:16:35 +02:00
scripts Use stable Rust from ./scripts/run.sh 2018-08-02 15:51:21 +03:00
src [stats] Update index height when chain shortens 2019-05-14 15:42:59 +02:00
.dockerignore Update Dockerfile to install libsnappy-dev and to use current source code 2019-03-03 22:34:39 +02:00
.gitignore Ignore _* directories 2018-12-23 10:05:05 +02:00
.travis.yml travis: add clippy via rustup 2019-03-25 20:37:47 +02:00
Cargo.lock Update Cargo.lock 2019-05-10 21:47:43 +03:00
Cargo.toml Revert "Use TryInto to convert slices into array" 2019-05-10 21:45:19 +03:00
Dockerfile Update Dockerfile to use Rust 1.34.0 2019-04-30 20:36:16 +03:00
LICENSE Add MIT license and small README 2018-04-08 23:54:29 +03:00
README.md Update Electrum protocol support 2019-03-08 22:03:16 +02:00
RELEASE-NOTES.md Update CI and documentation for Rust 1.32 2019-05-11 10:07:43 +03:00
TODO.md Remove TLS-related TODO 2018-08-15 15:05:40 +03:00

README.md

Electrum Server in Rust

CircleCI 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.