mirror of
https://github.com/romanz/electrs.git
synced 2024-11-19 01:43:29 +01:00
73 lines
4.2 KiB
Markdown
73 lines
4.2 KiB
Markdown
|
|
|
|
# Electrum Server in Rust
|
|
|
|
[](https://github.com/romanz/electrs/actions)
|
|
[](http://makeapullrequest.com)
|
|
[](https://crates.io/crates/electrs)
|
|
[](https://gitter.im/romanz/electrs)
|
|
|
|
An efficient re-implementation of Electrum Server, inspired by [ElectrumX](https://github.com/kyuupichan/electrumx), [Electrum Personal Server](https://github.com/chris-belcher/electrum-personal-server) and [bitcoincore-indexd](https://github.com/jonasschnelli/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](https://en.bitcoin.it/wiki/Full_node#Why_should_you_use_a_full_node_wallet).
|
|
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](https://electrum.org/).
|
|
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.
|
|
|
|
[BTC Prague 2024 dev/hack/day](https://btcprague.com/dev-hack-day/) slides are here: https://bit.ly/electrs
|
|
|
|
|
|
## 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](https://github.com/Blockstream/electrs)
|
|
which is better optimized for public usage at the cost of consuming *significantly* more resources.
|
|
|
|
* [Installation from source](doc/install.md)
|
|
* [Pre-built binaries](doc/binaries.md) (No official binaries available but a beta repository is available for installation)
|
|
* [Configuration](doc/config.md)
|
|
* [Usage](doc/usage.md)
|
|
* [Monitoring](doc/monitoring.md)
|
|
* [Upgrading](doc/upgrading.md) - **contains information about important changes from older versions**
|
|
|
|
## Features
|
|
|
|
* Supports Electrum protocol [v1.4](https://electrumx-spesmilo.readthedocs.io/en/latest/protocol.html)
|
|
* Maintains an index over transaction inputs and outputs, allowing fast balance queries
|
|
* Fast synchronization of the Bitcoin blockchain (~6.5 hours for ~504GB @ August 2023) using HDD storage.
|
|
* Low index storage overhead (~10%), relying on a local full node for transaction retrieval
|
|
* Efficient mempool tracker (allowing better fee [estimation](https://github.com/spesmilo/electrum/blob/59c1d03f018026ac301c4e74facfc64da8ae4708/RELEASE-NOTES#L34-L46))
|
|
* Low CPU & memory usage (after initial indexing)
|
|
* [`txindex`](https://github.com/bitcoinbook/bitcoinbook/blob/develop/ch03.asciidoc#txindex) is not required for the Bitcoin node
|
|
* Uses a single [RocksDB](https://github.com/spacejam/rust-rocksdb) database, for better consistency and crash recovery
|
|
|
|
## Altcoins
|
|
|
|
Altcoins are **not supported**!
|
|
Forks of Bitcoin codebase that relax the consensus rules (hard forks) are also **not supported**.
|
|
|
|
You may be able to find a fork of electrs that does support them, look around or make your own, just don't file issues/PRs here.
|
|
|
|
## Index database
|
|
|
|
The database schema is described [here](doc/schema.md).
|
|
|
|
## Contributing
|
|
|
|
All contributions to this project are welcome. Please refer to the [Contributing Guidelines](CONTRIBUTING.md) for more details.
|
|
|
|
## Logo
|
|
|
|
[Our logo](logo/) is generously provided by [Dominik Průša](https://github.com/DominoPrusa) under the MIT license.
|
|
Based on the [Electrum logo](https://github.com/spesmilo/electrum/blob/master/LICENCE)
|
|
and the [Rust language logo](https://www.rust-lang.org/policies/media-guide).
|