RanchiMall/electrumx
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc updates

Browse Source
This commit is contained in:
Neil Booth 2017-09-07 17:00:39 +09:00
parent 8f004785af
commit af9c82dbdb
2 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.rst
View File

@ -122,10 +122,11 @@ and associated complications.
Roadmap Roadmap
======= =======
- Python 3.6, which has several performance improvements relevant to - Require Python 3.6, which has several performance improvements
ElectrumX relevant to ElectrumX
- UTXO root logic and implementation - offloading more work to synchronize to the client
- incremental history serving / pruning - supporting better client privacy
- wallet server engine
- new features such as possibly adding label server functionality - new features such as possibly adding label server functionality
- potentially move some functionality to C or C++ - potentially move some functionality to C or C++
@ -141,8 +142,8 @@ which the next Electrum client release will use.
*NOTE*: the **COIN** environment variable is now mandatory, and if you *NOTE*: the **COIN** environment variable is now mandatory, and if you
were running for any bitcoin flavour (Cash, Segwit, mainnet or were running for any bitcoin flavour (Cash, Segwit, mainnet or
testnet) you will need to update your environment variable settings as testnet) you will need to update your **COIN** and **NET** environment
the old ones will no longer work. variable settings as the old ones will no longer work.
- implement protocol version 1.1 and update protocol documentation - implement protocol version 1.1 and update protocol documentation
- rework lib/coins.py for the various bitcoin flavours - rework lib/coins.py for the various bitcoin flavours
@ -337,6 +338,7 @@ Version 1.0
.. _#162: https://github.com/kyuupichan/electrumx/issues/162 .. _#162: https://github.com/kyuupichan/electrumx/issues/162
.. _#163: https://github.com/kyuupichan/electrumx/issues/163 .. _#163: https://github.com/kyuupichan/electrumx/issues/163
.. _#180: https://github.com/kyuupichan/electrumx/issues/180 .. _#180: https://github.com/kyuupichan/electrumx/issues/180
.. _#223: https://github.com/kyuupichan/electrumx/issues/223
.. _docs/HOWTO.rst: https://github.com/kyuupichan/electrumx/blob/master/docs/HOWTO.rst .. _docs/HOWTO.rst: https://github.com/kyuupichan/electrumx/blob/master/docs/HOWTO.rst
.. _docs/ENVIRONMENT.rst: https://github.com/kyuupichan/electrumx/blob/master/docs/ENVIRONMENT.rst .. _docs/ENVIRONMENT.rst: https://github.com/kyuupichan/electrumx/blob/master/docs/ENVIRONMENT.rst
.. _docs/PEER_DISCOVERY.rst: https://github.com/kyuupichan/electrumx/blob/master/docs/PEER_DISCOVERY.rst .. _docs/PEER_DISCOVERY.rst: https://github.com/kyuupichan/electrumx/blob/master/docs/PEER_DISCOVERY.rst

8
docs/PROTOCOL.rst
View File

@ -690,7 +690,7 @@ Return the confirmed and unconfirmed balances of a script hash.
blockchain.scripthash.get_balance(**scripthash**) blockchain.scripthash.get_balance(**scripthash**)
**schripthash** **scripthash**
The script hash as a hexadecimal string. The script hash as a hexadecimal string.
@ -706,7 +706,7 @@ Return the confirmed and unconfirmed history of a script hash.
blockchain.scripthash.get_history(**scripthash**) blockchain.scripthash.get_history(**scripthash**)
**schripthash** **scripthash**
The script hash as a hexadecimal string. The script hash as a hexadecimal string.
@ -722,7 +722,7 @@ Return the unconfirmed transactions of a script hash.
blockchain.scripthash.get_mempool(**scripthash**) blockchain.scripthash.get_mempool(**scripthash**)
**schripthash** **scripthash**
The script hash as a hexadecimal string. The script hash as a hexadecimal string.
@ -738,7 +738,7 @@ Return an ordered list of UTXOs sent to a script hash.
blockchain.scripthash.listunspent(**scripthash**) blockchain.scripthash.listunspent(**scripthash**)
**schripthash** **scripthash**
The script hash as a hexadecimal string. The script hash as a hexadecimal string.