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.
819 Commits
24 Branches
16 Tags
1.8 MiB
 
 
 
 
Branch: android-patches
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'android-patches'
${ noResults }
Luke Childs 2019458de2
Remove sysconf dep 		4 years ago
.circleci Support Rust >=1.34 5 years ago
.github/workflows Remove --verbose from GitHub workflow 5 years ago
contrib Update contrib/ scripts to use latest PyCoin 5 years ago
doc Typo fixes 5 years ago
examples Add metrics to blocktxids cache 5 years ago
scripts Use stable Rust from ./scripts/run.sh 6 years ago
src Remove sysconf dep 4 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 Revert "Test Travis CI on ARM" 5 years ago
Cargo.lock WIP on migrating to new bitcoin::hash_types 5 years ago
Cargo.toml Remove sysconf dep 4 years ago
Dockerfile Pin Docker Rust base image to Debian Buster 5 years ago
LICENSE Add MIT license and small README 7 years ago
README.md Use GitHub workflows badge 5 years ago
RELEASE-NOTES.md Bump version 5 years ago
TODO.md Remove TLS-related TODO 6 years ago
build.rs Update `configure_me` as well as other packages 5 years ago
config_spec.toml Correct --network arg values in the doc 5 years ago

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.