2018-03-07 18:13:13 +08:00
|
|
|
=========
|
|
|
|
|
ElectrumX
|
|
|
|
|
=========
|
2018-03-07 10:30:40 +08:00
|
|
|
|
2018-03-07 13:14:45 +08:00
|
|
|
.. image:: https://travis-ci.org/kyuupichan/electrumx.svg?branch=master
|
|
|
|
|
:target: https://travis-ci.org/kyuupichan/electrumx
|
|
|
|
|
.. image:: https://coveralls.io/repos/github/kyuupichan/electrumx/badge.svg
|
|
|
|
|
:target: https://coveralls.io/github/kyuupichan/electrumx
|
|
|
|
|
|
|
|
|
|
A reimplementation of Electrum-Server for a future with bigger blocks.
|
|
|
|
|
|
2018-03-08 17:11:41 +08:00
|
|
|
The current version is |release|.
|
2018-03-07 13:14:45 +08:00
|
|
|
|
2018-03-08 16:20:26 +08:00
|
|
|
Source Code
|
|
|
|
|
===========
|
|
|
|
|
|
2018-03-08 17:11:41 +08:00
|
|
|
The project is hosted on `GitHub
|
|
|
|
|
<https://github.com/kyuupichan/electrumx/>`_. and uses `Travis
|
|
|
|
|
<https://travis-ci.org/kyuupichan/electrumx>`_ for Continuous
|
|
|
|
|
Integration.
|
|
|
|
|
|
|
|
|
|
Please submit an issue on the `bug tracker
|
|
|
|
|
<https://github.com/kyuupichan/electrumx/issues>`_ 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 :ref:`Authors`.
|
|
|
|
|
Python version at least 3.6 is required.
|
|
|
|
|
|
|
|
|
|
The code is released under the `MIT Licence
|
|
|
|
|
<https://github.com/kyuupichan/electrumx/LICENCE>`_.
|
2018-03-07 13:14:45 +08:00
|
|
|
|
|
|
|
|
Getting Started
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
See :ref:`HOWTO`.
|
|
|
|
|
|
|
|
|
|
There is also an `installer`_ available that simplifies the
|
|
|
|
|
installation on various Linux-based distributions, and a `Dockerfile`_
|
|
|
|
|
available .
|
|
|
|
|
|
|
|
|
|
.. _installer: https://github.com/bauerj/electrumx-installer
|
|
|
|
|
.. _Dockerfile: https://github.com/lukechilds/docker-electrumx
|
|
|
|
|
|
2018-03-08 17:11:41 +08:00
|
|
|
Documentation
|
|
|
|
|
=============
|
2018-03-07 13:14:45 +08:00
|
|
|
|
2018-03-07 10:30:40 +08:00
|
|
|
.. toctree::
|
|
|
|
|
|
2018-03-07 18:13:13 +08:00
|
|
|
features
|
2018-03-08 13:54:16 +08:00
|
|
|
changelog
|
2018-03-07 13:14:45 +08:00
|
|
|
HOWTO
|
2018-03-07 18:13:13 +08:00
|
|
|
ENVIRONMENT
|
2018-03-08 13:49:05 +08:00
|
|
|
PROTOCOL
|
2018-03-07 13:14:45 +08:00
|
|
|
PEER_DISCOVERY
|
|
|
|
|
RPC-INTERFACE
|
|
|
|
|
ARCHITECTURE
|
2018-03-08 17:11:41 +08:00
|
|
|
authors
|
2018-03-07 10:30:40 +08:00
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`search`
|
