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
942 Commits 12 Branches 54 Tags 12 MiB
Rust 89.4%
Python 8.1%
Shell 2.1%
Dockerfile 0.4%
f7ec78a024
Go to file
Roman Zeyde f7ec78a024
Use GPG to verify Electrum wallet
2020-12-07 21:24:35 +02:00
.github/workflows Add integration tests to CI 2020-12-03 15:55:10 +02:00
contrib Fixup integration tests 2020-12-01 20:42:33 +02:00
doc Set Rust toolchain to 1.41.1 2020-09-28 13:27:15 +03:00
electrs_index Print config to stderr 2020-12-02 09:29:24 +02:00
electrs_query Fixup versions 2020-11-30 22:55:17 +02:00
electrs_rpc Print config to stderr 2020-12-02 09:29:24 +02:00
scripts Use stable Rust from ./scripts/run.sh 2018-08-02 15:51:21 +03:00
tests Small fixes to tests/run.sh 2020-12-07 10:21:56 +02:00
.dockerignore Add integration tests to CI 2020-12-03 15:55:10 +02:00
.gitignore Small fixes to tests/run.sh 2020-12-07 10:21:56 +02: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 Use configure_me instead of clap 2020-12-01 13:32:28 +02:00
Cargo.toml Add new code 2020-10-24 20:00:46 +03:00
config_spec.toml Add a 'blocks_dir' option analogous to bitcoind's '-blocksdir' 2020-06-30 14:46:25 +02:00
Dockerfile Use GPG to verify Electrum wallet 2020-12-07 21:24:35 +02:00
LICENSE Add MIT license and small README 2018-04-08 23:54:29 +03:00
query.sh Add helper scripts 2020-10-25 14:24:24 +02: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 Support older Rust versions 2020-10-25 20:26:36 +02:00
server.sh Add helper scripts 2020-10-25 14:24:24 +02: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.