mirrors/electrs
1
0
Fork 0
mirror of https://github.com/romanz/electrs.git synced 2024-11-19 01:43:29 +01:00
Code Issues Projects Releases Wiki Activity
An efficient re-implementation of Electrum Server in Rust
875 Commits 12 Branches 54 Tags 12 MiB
Rust 89.4%
Python 8.1%
Shell 2.1%
Dockerfile 0.4%
723028aafc
Go to file
Martin Habovstiak 723028aafc Added issue templates 
This adds four GitHub issue templates with these properties:

* Nudge people to read the docs
* Nudge inexperienced people to use automation
* Nudge people to provide important information (env, logs...)
* Assign myself (Kixunil) in case of build and config issues
2020-11-24 16:02:01 +01:00
.github Added issue templates 2020-11-24 16:02:01 +01:00
contrib Add health-check tool 2020-11-15 22:26:52 +02:00
doc Fix a small typo 2020-11-15 20:42:24 +02:00
examples Add a 'blocks_dir' option analogous to bitcoind's '-blocksdir' 2020-06-30 14:46:25 +02:00
scripts Use stable Rust from ./scripts/run.sh 2018-08-02 15:51:21 +03:00
src Fix #317 2020-11-06 16:28:39 +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 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 Updated librocksdb-sys and bindgen 2020-11-14 10:27:07 +01:00
Cargo.toml Make rocksdb compression algos optional 2020-11-05 00:33:20 +01:00
config_spec.toml Add a 'blocks_dir' option analogous to bitcoind's '-blocksdir' 2020-06-30 14:46:25 +02:00
Dockerfile Add simple health check to Dockerfile. 2020-11-15 09:31:26 +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 2020-07-01 22:50:32 +03: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.