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
1,280 Commits 12 Branches 54 Tags 12 MiB
Rust 89.4%
Python 8.1%
Shell 2.1%
Dockerfile 0.4%
global-tx-id
Go to file
Roman Zeyde 5d7655efc1 WIP: gtxid
2021-12-05 22:04:00 +02:00
.cargo Add cargo audit configuration file 2021-10-20 13:27:31 +03:00
.github Add dependabot config for autmatic cargo update PRs 2021-11-13 09:59:36 +01:00
contrib Fixup --log-filters documentation and examples 2021-11-12 19:59:11 +02:00
doc Add asciinema screencasts for quickstart installation and usage 2021-11-17 14:37:03 +02:00
internal Disable index_lookup_limit by default 2021-12-04 10:42:01 +02:00
logo fixed color in logo and icon export 2021-09-28 19:36:06 +02:00
src WIP: gtxid 2021-12-05 22:04:00 +02:00
tests Don't ignore signals during IBD 2021-10-06 11:20:37 +03:00
.dockerignore Refactor and sync using p2p protocol 2021-04-14 18:38:59 +03:00
.gitignore Ignore a few more extensions 2021-10-20 10:14:29 +03:00
build.rs Update configure_me as well as other packages 2019-10-18 17:14:53 +02:00
Cargo.lock Bump anyhow from 1.0.47 to 1.0.50 2021-11-29 17:15:21 +02:00
Cargo.toml Bump version 2021-11-19 09:09:53 +02:00
Dockerfile Dockerfile: re-add curl, so it can be used for docker health checks 2021-11-14 12:14:25 +02:00
Dockerfile.ci Support Rust 1.48.0 and test on Debian 11 2021-10-24 10:04:53 +03:00
LICENSE Add MIT license and small README 2018-04-08 23:54:29 +03:00
README.md Clarify that electrs is intended for personal use 2021-12-03 20:04:16 +02:00
RELEASE-NOTES.md Update release notes 2021-12-04 10:45:11 +02:00
rust-toolchain Support Rust 1.48.0 and test on Debian 11 2021-10-24 10:04:53 +03:00
server.sh WIP: gtxid 2021-12-05 22:04:00 +02:00
TODO.md Remove TLS-related TODO 2018-08-15 15:05:40 +03:00

README.md

Logo

Electrum Server in Rust

CI 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 self host an 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 balances and 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 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, please ask about what you don't understand or consider using automated deployments.

Note that this implementation of Electrum server is optimized for personal/small-scale (family/friends) usage. It's a bad idea to run it publicly as it'd expose you to DoS and maybe also other attacks. If you want to run a public server you may be interested in the Blockstream fork of electrs which is better optimized for public usage at the cost of consuming significantly more resources.

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.