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
893 Commits 12 Branches 54 Tags 12 MiB
Rust 89.4%
Python 8.1%
Shell 2.1%
Dockerfile 0.4%
8ca4f7ae7f
Go to file
Martin Habovstiak 8ca4f7ae7f Improve documentation 
This improves documentation of configuration based on @BTCBellyButton
suggestions in #344. It contains a few more tweaks.
2021-02-01 22:33:04 +01:00
.github Merge remote-tracking branch 'kixunil/issue_templates' 2020-11-25 09:10:19 +02:00
contrib Add health-check tool 2020-11-15 22:26:52 +02:00
doc Improve documentation 2021-02-01 22:33:04 +01:00
examples Add a 'blocks_dir' option analogous to bitcoind's '-blocksdir' 2020-06-30 14:46:25 +02:00
internal Adding support for signet 2021-01-14 19:35:26 +01:00
scripts Use stable Rust from ./scripts/run.sh 2018-08-02 15:51:21 +03:00
src Adding support for signet 2021-01-14 19:35:26 +01:00
.dockerignore Update Dockerfile to install libsnappy-dev and to use current source code 2019-03-03 22:34:39 +02:00
.gitignore Ignore more patterns 2020-07-13 08:38:46 +03:00
.travis.yml Revert "Test Travis CI on ARM" 2019-10-15 10:48:04 +03:00
build.rs Update configure_me as well as other packages 2019-10-18 17:14:53 +02:00
Cargo.lock Bump version 2021-01-15 09:23:29 +02:00
Cargo.toml Bump version 2021-01-15 09:23:29 +02:00
Dockerfile Run cargo install with --locked in Dockerfile 2020-11-23 16:26:42 +01:00
LICENSE Add MIT license and small README 2018-04-08 23:54:29 +03:00
README.md Use GitHub workflows badge 2019-12-02 10:40:56 +02:00
RELEASE-NOTES.md Bump version 2021-01-15 09:23:29 +02:00
rust-toolchain Set Rust toolchain to 1.41.1 2020-09-28 13:27:15 +03:00
TODO.md Remove TLS-related TODO 2018-08-15 15:05:40 +03:00

README.md

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.