lukechilds
/
electrs
mirror of https://github.com/lukechilds/electrs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
749 Commits
24 Branches
16 Tags
1.8 MiB
 
 
 
 
Tree: 2c50791dc5
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '2c50791dc5'
${ noResults }
Martin Habovstiak 2c50791dc5
Fixed db subdir 		5 years ago
.circleci Update CI and documentation for Rust 1.32 6 years ago
contrib Add a script for computing tx fee 5 years ago
doc Updated doc regarding config files and env vars 5 years ago
examples Add metrics to blocktxids cache 5 years ago
scripts Use stable Rust from ./scripts/run.sh 6 years ago
src Fixed db subdir 5 years ago
.dockerignore Update Dockerfile to install libsnappy-dev and to use current source code 6 years ago
.gitignore Ignore _* directories 6 years ago
.travis.yml travis: add clippy via rustup 6 years ago
Cargo.lock Use configure_me instead of clap 5 years ago
Cargo.toml Use configure_me instead of clap 5 years ago
Dockerfile Update Dockerfile to use Rust 1.34.0 6 years ago
LICENSE Add MIT license and small README 7 years ago
README.md Update Electrum protocol support 6 years ago
RELEASE-NOTES.md Bump version 5 years ago
TODO.md Remove TLS-related TODO 6 years ago
build.rs Use configure_me instead of clap 5 years ago
config_spec.toml Use configure_me instead of clap 5 years ago

README.md

Electrum Server in Rust

CircleCI 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.