ElectrumX

A reimplementation of Electrum-Server for a future with bigger blocks.

The current version is ElectrumX 1.20.2.

Source Code

The project is hosted on GitHub. and uses Azure Pipelines for Continuous Integration.

Please submit an issue on the bug tracker if you have found a bug or have a suggestion to improve the server.

Authors and License

Neil Booth wrote the vast majority of the code; see Authors. Python version at least 3.8 is required.

The code is released under the MIT Licence.

Getting Started

See HOWTO.

There is also an installer available that simplifies the installation on various Linux-based distributions, and a Dockerfile available .

Documentation

• Features
• Implementation
• Roadmap
• ChangeLog
  • Version 1.20.0 (21 Oct 2021)
  • Version 1.19.0 (11 Jun 2021)
  • Version 1.18.1 (26 Apr 2021)
  • Version 1.17.0 (04 Feb 2021)
  • Version 1.16.0 (03 Feb 2021)
  • Version 1.15.0 (27 May 2020)
  • Version 1.14.0 (19 Jan 2020)
  • Version 1.13.0 (26 Sep 2019)
  • Version 1.12.0 (13 May 2019)
  • Version 1.11.0 (18 Apr 2019)
  • Version 1.10.1 (13 Apr 2019)
  • Version 1.10.0 (15 Mar 2019)
  • Version 1.9.5 (08 Feb 2019)
  • Version 1.9.4 (07 Feb 2019)
  • Version 1.9.3 (05 Feb 2019)
  • Version 1.9.2 (03 Feb 2019)
  • Version 1.9.1 (11 Jan 2019)
  • Version 1.9.0 (10 Jan 2019)
• HOWTO
  • Prerequisites
  • Database Engine
  • Running
    • Process limits
    • Using daemontools
    • Using systemd
    • Installing on Raspberry Pi 3
  • Sync Progress
  • Terminating ElectrumX
  • Understanding the Logs
  • Creating a self-signed SSL certificate
  • Running on a privileged port
• Environment Variables
  • Required
  • For the run script
  • Services
  • Miscellaneous
  • Resource Usage Limits
  • Peer Discovery
  • Cache
• Electrum Protocol
  • Protocol Basics
    • Message Stream
    • Notifications
    • Version Negotiation
    • Script Hashes
    • Status
    • Block Headers
  • Protocol Methods
    • blockchain.block.header
    • blockchain.block.headers
    • blockchain.estimatefee
    • blockchain.headers.subscribe
    • blockchain.relayfee
    • blockchain.scripthash.get_balance
    • blockchain.scripthash.get_history
    • blockchain.scripthash.get_mempool
    • blockchain.scripthash.listunspent
    • blockchain.scripthash.subscribe
    • blockchain.scripthash.unsubscribe
    • blockchain.transaction.broadcast
    • blockchain.transaction.get
    • blockchain.transaction.get_merkle
    • blockchain.transaction.get_tsc_merkle
    • blockchain.transaction.id_from_pos
    • mempool.get_fee_histogram
    • server.add_peer
    • server.banner
    • server.donation_address
    • server.features
    • server.peers.subscribe
    • server.ping
    • server.version
    • Masternode methods (Dash and compatible coins)
    • masternode.announce.broadcast
    • masternode.subscribe
    • masternode.list
    • ProTx methods (Dash DIP3)
    • protx.diff
    • protx.info
  • Protocol Changes
    • Version 1.0
      • Deprecated methods
    • Version 1.1
      • Changes
      • New methods
      • Removed methods
    • Version 1.2
      • Changes
      • New methods
      • Deprecated methods
    • Version 1.3
      • Changes
      • New methods
      • Removed methods
      • Deprecated methods
    • Version 1.4
      • Changes
      • New methods
      • Removed methods
    • Version 1.4.1
      • Changes
    • Version 1.4.1
      • New methods
  • Removed Protocol Methods
    • Deserialized Headers
      • blockchain.address.get_balance
      • blockchain.address.get_history
      • blockchain.address.get_mempool
      • blockchain.address.listunspent
      • blockchain.address.subscribe
      • blockchain.headers.subscribe
      • blockchain.numblocks.subscribe
      • blockchain.utxo.get_address
      • blockchain.block.get_header
      • blockchain.block.get_chunk
      • server.version
  • Protocol Ideas
    • blockchain.scripthash.subscribe
    • blockchain.scripthash.history
    • blockchain.scripthash.utxos
    • blockchain.transaction.get
    • mempool.changes
• Peer Discovery
  • Hard-coded Peers
  • server.peers.subscribe
  • Maintaining the Peer Database
  • server.features
  • server.add_peer
  • Notes for Implementors
• RPC Interface
  • add_peer
  • daemon_url
  • disconnect
  • getinfo
  • groups
  • log
  • peers
  • query
  • reorg
  • sessions
  • stop
• Architecture
  • Env
  • Controller
  • LocalRPC
  • ElectrumX
  • Daemon
  • Block Processor
  • Prefetcher
  • Mempool
  • Database
• Authors

Indices and tables

• Index
• Search Page