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.
555 Commits
24 Branches
16 Tags
1.8 MiB
 
 
 
 
Tree: 0f02dfdcba
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0f02dfdcba'
${ noResults }
Roman Zeyde 0f02dfdcba
Add testnet support for address-based balance query tool 		6 years ago
doc Update usage.md with Electrum installation URL 6 years ago
examples Allow setting index batch size from command-line 6 years ago
scripts Use stable Rust from ./scripts/run.sh 6 years ago
src Support 'blockchain.address.subscribe' Electrum API 6 years ago
tools Add testnet support for address-based balance query tool 6 years ago
.gitignore Ignore *~ files 6 years ago
.travis.yml Update stable Rust to 1.28 6 years ago
Cargo.toml Export more metrics from server 6 years ago
LICENSE Add MIT license and small README 7 years ago
README.md Update README with latest performance metrics 6 years ago
RELEASE-NOTES.md Add release notes 6 years ago
TODO.md Add HDD tuning guide to TODO.md 6 years ago

README.md

Electrum Server in Rust

Build Status 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.2
  • 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.