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
882 Commits 12 Branches 54 Tags 12 MiB
Rust 89.4%
Python 8.1%
Shell 2.1%
Dockerfile 0.4%
15ec11f8b6
Go to file
Roman Zeyde 15ec11f8b6 Disable default features for rocksdb dependency
2021-05-30 21:38:51 +03:00
.github/workflows Refactor and sync using p2p protocol 2021-04-14 18:38:59 +03:00
contrib Fix contrib/get_tip.py 2021-05-25 18:08:21 +03:00
doc Refactor and sync using p2p protocol 2021-04-14 18:38:59 +03:00
internal Remove unused configuration parameters 2021-05-26 15:18:55 +03:00
scripts Use stable Rust from ./scripts/run.sh 2018-08-02 15:51:21 +03:00
src Run sync in a loop 2021-05-30 09:29:09 +03:00
tests Refactor and sync using p2p protocol 2021-04-14 18:38:59 +03:00
.dockerignore Refactor and sync using p2p protocol 2021-04-14 18:38:59 +03:00
.gitignore Refactor and sync using p2p protocol 2021-04-14 18:38:59 +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 Allow optional metrics collection 2021-05-29 12:24:19 +03:00
Cargo.toml Disable default features for rocksdb dependency 2021-05-30 21:38:51 +03:00
Dockerfile Fixup Rust version in Dockerfile 2021-04-16 09:46:35 +03:00
LICENSE Add MIT license and small README 2018-04-08 23:54:29 +03:00
query.sh Refactor and sync using p2p protocol 2021-04-14 18:38:59 +03:00
README.md Link to electrumx-spesmilo.readthedocs.io 2021-05-09 14:05:01 +03: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
server.sh Refactor and sync using p2p protocol 2021-04-14 18:38:59 +03:00
sync.sh Ignore mempool in sync.sh 2021-05-21 22:05:26 +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.