mirrors/electrs
1
0
Fork 0
mirror of https://github.com/romanz/electrs.git synced 2025-02-24 15:02:21 +01:00
Code Issues Projects Releases Wiki Activity
An efficient re-implementation of Electrum Server in Rust
780 commits 15 branches 56 tags 6.8 MiB
Rust 89.6%
Python 7.9%
Shell 2.1%
Dockerfile 0.4%
Find a file
Martin Habovstiak 5549287ac6 Implemented custom cookie file 
This change allows the user to specify a custom cookie file, which is then
used instead of `~/.bitcoin/.cookie`. This resolves situations when the
user wants to have the cookie file in non-standard path.

Aside from that, the code now pre-computes the default path, improving
the performance by avoiding allocation (and copying). Unfortunately, due
to limitations of Rust, the code doesn't print out cookie configuration
anymore. This however might be safer, since the cookie isn't printed,
and thus doesn't end up in some readable logs by accident.

Closes #176
Closes #189
2019-11-13 15:52:32 +02:00
.circleci Support Rust >=1.34 2019-09-07 12:00:24 +03:00
contrib Add a script for computing tx fee 2019-08-03 14:46:39 +03:00
doc Add more duration metrics to query.rs 2019-10-15 10:42:06 +03:00
examples Add metrics to blocktxids cache 2019-07-04 08:18:54 +00:00
scripts Use stable Rust from ./scripts/run.sh 2018-08-02 15:51:21 +03:00
src Implemented custom cookie file 2019-11-13 15:52:32 +02:00
.dockerignore Update Dockerfile to install libsnappy-dev and to use current source code 2019-03-03 22:34:39 +02:00
.gitignore Ignore _* directories 2018-12-23 10:05:05 +02: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 Bump version 2019-10-28 22:25:59 +02:00
Cargo.toml Bump version 2019-10-28 22:25:59 +02:00
config_spec.toml Implemented custom cookie file 2019-11-13 15:52:32 +02:00
Dockerfile Update Dockerfile to use Rust 1.34.0 2019-04-30 20:36:16 +03:00
LICENSE Add MIT license and small README 2018-04-08 23:54:29 +03:00
README.md Update Electrum protocol support 2019-03-08 22:03:16 +02:00
RELEASE-NOTES.md Implemented custom cookie file 2019-11-13 15:52:32 +02:00
TODO.md Remove TLS-related TODO 2018-08-15 15:05:40 +03:00

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.