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
1,142 Commits 12 Branches 54 Tags 12 MiB
Rust 89.4%
Python 8.1%
Shell 2.1%
Dockerfile 0.4%
a07de5aa5c
Go to file
Roman Zeyde a07de5aa5c
Merge pull request #518 from Kixunil/patch-4 
Update documentation regarding cargo features
2021-09-30 15:59:52 +03:00
.github Use latest cargo-audit 2021-09-23 17:53:20 +03:00
contrib Don't use TRACE verbosity in contrib/electrs.service 2021-09-19 14:15:52 +03:00
doc Update documentation regarding cargo features 2021-09-30 14:09:26 +02:00
internal Fix description 2021-09-30 13:58:49 +03:00
logo fixed color in logo and icon export 2021-09-28 19:36:06 +02:00
src Fixup timeout log warning 2021-09-28 08:37:37 +03:00
tests Probe metrics endpoint in CI 2021-08-27 22:28:54 +03:00
.dockerignore Refactor and sync using p2p protocol 2021-04-14 18:38:59 +03:00
.gitignore Ignore IntelliJ .idea/ dir 2021-06-29 15:44:40 +03:00
build.rs Update configure_me as well as other packages 2019-10-18 17:14:53 +02:00
Cargo.lock Release 0.9.0 2021-09-30 10:13:10 +03:00
Cargo.toml Release 0.9.0 2021-09-30 10:13:10 +03:00
Dockerfile Use docker only for integration tests 2021-09-15 18:03:23 +03:00
LICENSE Add MIT license and small README 2018-04-08 23:54:29 +03:00
README.md Fixup https://github.com/DominoPrusa link 2021-09-28 20:01:39 +03:00
RELEASE-NOTES.md Release 0.9.0 2021-09-30 10:13:10 +03:00
rust-toolchain Set Rust toolchain to 1.41.1 2020-09-28 13:27:15 +03:00
server.sh Build with 'prometheus/process' in server.sh 2021-09-19 21:21:51 +03:00
TODO.md Remove TLS-related TODO 2018-08-15 15:05:40 +03:00

README.md

Logo

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.

Usage

Please prefer to use OUR usage guide!

External guides such as RaspiBolt can be out-of-date and have various problems. At least double-check that the guide you're using is actively maintained. If you can't use our guide ask about what you don't understand or consider using automated deployments.

See here for installation, build and usage instructions.

Features

  • Supports Electrum protocol v1.4
  • Maintains an index over transaction inputs and outputs, allowing fast balance queries
  • Fast synchronization of the Bitcoin blockchain (~4 hours for ~336GB @ August 2021) using HDD storage.
  • Low index storage overhead (~10%), 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

Index database

The database schema is described here.

Our logo is generously provided by Dominik Průša under the MIT license. Based on the Electrum logo and the Rust language logo.