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
964 Commits 12 Branches 54 Tags 12 MiB
Rust 89.4%
Python 8.1%
Shell 2.1%
Dockerfile 0.4%
89bca4900d
Go to file
Roman Zeyde 89bca4900d Use latest Bitcoin Core release (22.0) in CI
2021-09-14 08:52:04 +03:00
.github Update documentation for the upcoming 0.9 version 2021-09-13 11:09:51 +03:00
contrib Propagate Electrum JSON RPC error 2021-08-28 20:05:39 +03:00
doc Update documentation for the upcoming 0.9 version 2021-09-13 11:09:51 +03:00
internal Allow single-sync invocation using --sync-once commandline flag 2021-09-11 11:01:05 +03:00
src Use try_from for explicit type conversion (instead of try_into) 2021-09-12 16:22:32 +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
.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 Update Cargo dependencies 2021-09-12 23:27:48 +03:00
Cargo.toml Downgrade librocksdb-sys to 6.11.4 2021-09-10 21:04:29 +03:00
Dockerfile Use latest Bitcoin Core release (22.0) in CI 2021-09-14 08:52:04 +03:00
LICENSE Add MIT license and small README 2018-04-08 23:54:29 +03:00
README.md Update documentation for the upcoming 0.9 version 2021-09-13 11:09:51 +03:00
RELEASE-NOTES.md Update documentation for the upcoming 0.9 version 2021-09-13 11:09:51 +03:00
rust-toolchain Set Rust toolchain to 1.41.1 2020-09-28 13:27:15 +03:00
server.sh Use './db' as default DB directory in server.sh 2021-08-27 14:47:48 +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.

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.