You've already forked electroncash-protocol
Calin Culianu
231 lines
6.3 KiB
ReStructuredText
231 lines
6.3 KiB
ReStructuredText
================
|
|
Protocol Changes
|
|
================
|
|
|
|
This documents lists changes made by protocol version.
|
|
|
|
Version 1.0
|
|
===========
|
|
|
|
Deprecated methods
|
|
------------------
|
|
|
|
* :func:`blockchain.utxo.get_address`
|
|
* :func:`blockchain.numblocks.subscribe`
|
|
|
|
.. _version 1.1:
|
|
|
|
Version 1.1
|
|
===========
|
|
|
|
Changes
|
|
-------
|
|
|
|
* improved semantics of :func:`server.version` to aid protocol
|
|
negotiation, and a changed return value.
|
|
* :func:`blockchain.transaction.get` no longer takes the *height*
|
|
argument that was ignored anyway.
|
|
* :func:`blockchain.transaction.broadcast` returns errors like any
|
|
other JSON RPC call. A transaction hash result is only returned on
|
|
success.
|
|
|
|
New methods
|
|
-----------
|
|
|
|
* :func:`blockchain.scripthash.get_balance`
|
|
* :func:`blockchain.scripthash.get_history`
|
|
* :func:`blockchain.scripthash.get_mempool`
|
|
* :func:`blockchain.scripthash.listunspent`
|
|
* :func:`blockchain.scripthash.subscribe`
|
|
* :func:`server.features`
|
|
* :func:`server.add_peer`
|
|
|
|
Removed methods
|
|
---------------
|
|
|
|
* :func:`blockchain.utxo.get_address`
|
|
* :func:`blockchain.numblocks.subscribe`
|
|
|
|
.. _version 1.2:
|
|
|
|
Version 1.2
|
|
===========
|
|
|
|
Changes
|
|
-------
|
|
|
|
* :func:`blockchain.transaction.get` now has an optional parameter
|
|
*verbose*.
|
|
* :func:`blockchain.headers.subscribe` now has an optional parameter
|
|
*raw*.
|
|
* :func:`server.version` should not be used for "ping" functionality;
|
|
use the new :func:`server.ping` method instead.
|
|
|
|
New methods
|
|
-----------
|
|
|
|
* :func:`blockchain.block.headers`
|
|
* :func:`mempool.get_fee_histogram`
|
|
* :func:`server.ping`
|
|
|
|
Deprecated methods
|
|
------------------
|
|
|
|
* :func:`blockchain.block.get_chunk`. Switch to
|
|
:func:`blockchain.block.headers`
|
|
* :func:`blockchain.address.get_balance`. Switch to
|
|
:func:`blockchain.scripthash.get_balance`.
|
|
* :func:`blockchain.address.get_history`. Switch to
|
|
:func:`blockchain.scripthash.get_history`.
|
|
* :func:`blockchain.address.get_mempool`. Switch to
|
|
:func:`blockchain.scripthash.get_mempool`.
|
|
* :func:`blockchain.address.listunspent`. Switch to
|
|
:func:`blockchain.scripthash.listunspent`.
|
|
* :func:`blockchain.address.subscribe`. Switch to
|
|
:func:`blockchain.scripthash.subscribe`.
|
|
* :func:`blockchain.headers.subscribe` with *raw* other than :const:`True`.
|
|
|
|
.. _version 1.3:
|
|
|
|
Version 1.3
|
|
===========
|
|
|
|
Changes
|
|
-------
|
|
|
|
* :func:`blockchain.headers.subscribe` argument *raw* switches default to
|
|
:const:`True`
|
|
|
|
New methods
|
|
-----------
|
|
|
|
* :func:`blockchain.block.header`
|
|
|
|
Removed methods
|
|
---------------
|
|
|
|
* :func:`blockchain.address.get_balance`
|
|
* :func:`blockchain.address.get_history`
|
|
* :func:`blockchain.address.get_mempool`
|
|
* :func:`blockchain.address.listunspent`
|
|
* :func:`blockchain.address.subscribe`
|
|
|
|
Deprecated methods
|
|
------------------
|
|
|
|
* :func:`blockchain.block.get_header`. Switch to
|
|
:func:`blockchain.block.header`.
|
|
|
|
.. _version 1.4:
|
|
|
|
Version 1.4
|
|
===========
|
|
|
|
This version removes all support for :ref:`deserialized headers
|
|
<deserialized header>`.
|
|
|
|
Changes
|
|
-------
|
|
|
|
* Deserialized headers are no longer available, so removed argument
|
|
*raw* from :func:`blockchain.headers.subscribe`.
|
|
* Only the first :func:`server.version` message is accepted.
|
|
* Optional *cp_height* argument added to
|
|
:func:`blockchain.block.header` and :func:`blockchain.block.headers`
|
|
to return merkle proofs of the header to a given checkpoint.
|
|
|
|
New methods
|
|
-----------
|
|
|
|
* :func:`blockchain.transaction.id_from_pos` to return a transaction
|
|
hash, and optionally a merkle proof, given a block height and
|
|
position in the block.
|
|
|
|
Removed methods
|
|
---------------
|
|
|
|
* :func:`blockchain.block.get_header`
|
|
* :func:`blockchain.block.get_chunk`
|
|
|
|
Version 1.4.1
|
|
=============
|
|
|
|
Changes
|
|
-------
|
|
|
|
* :func:`blockchain.block.header` and :func:`blockchain.block.headers` now
|
|
truncate AuxPoW data (if using an AuxPoW chain) when *cp_height* is
|
|
nonzero. AuxPoW data is still present when *cp_height* is zero.
|
|
Non-AuxPoW chains are unaffected.
|
|
|
|
|
|
Version 1.4.1
|
|
=============
|
|
|
|
New methods
|
|
-----------
|
|
|
|
* :func:`blockchain.scipthash.unsubscribe` to unsubscribe from a script hash.
|
|
|
|
Version 1.4.2
|
|
=============
|
|
* :func:`server.features` changed the requirement of key *hosts* from being MUST be present to RECOMMENDED. Note that Fulcrum and ElectrumX will not peer with your server without this key.
|
|
|
|
Version 1.4.3
|
|
=============
|
|
|
|
New methods
|
|
-----------
|
|
|
|
* :func:`blockchain.address.get_balance` was brought back after having been
|
|
removed in 1.3.
|
|
* :func:`blockchain.address.get_history` was brought back after having been
|
|
removed in 1.3.
|
|
* :func:`blockchain.address.get_mempool` was brought back after having been
|
|
removed in 1.3.
|
|
* :func:`blockchain.address.get_scripthash` to translate an address into a
|
|
script hash.
|
|
* :func:`blockchain.address.listunspent` was brought back after having been
|
|
removed in 1.3.
|
|
* :func:`blockchain.address.subscribe` was brought back after having been
|
|
removed in 1.3.
|
|
* :func:`blockchain.address.unsubscribe` to unsubscribe from an address.
|
|
|
|
Version 1.4.4
|
|
=============
|
|
|
|
New methods
|
|
-----------
|
|
|
|
* :func:`blockchain.utxo.get_info` gets information for an unspent transaction output.
|
|
|
|
Version 1.4.5
|
|
=============
|
|
|
|
Changes
|
|
-------
|
|
|
|
* :func:`blockchain.transaction.get_merkle` now no longer requires the second
|
|
argument *height*. This argument is now optional but still recommended, in
|
|
order to save the server from having to look it up.
|
|
* :func:`server.features` added a new optional key, :const:`"dsproof"`.
|
|
|
|
New methods
|
|
-----------
|
|
|
|
* :func:`blockchain.transaction.get_height` to retrieve the height of a
|
|
transaction.
|
|
* :func:`blockchain.transaction.subscribe` to be notified of transaction
|
|
confirmation status changes.
|
|
* :func:`blockchain.transaction.unsubscribe` to unsubscribe from a
|
|
previously subscribed-to transaction.
|
|
* :func:`blockchain.transaction.dsproof.get` to retrieve information about a
|
|
double-spend proof associated with a *tx_hash*.
|
|
* :func:`blockchain.transaction.dsproof.list` to list the double-spend proofs
|
|
currently being tracked in the bitcoin daemon's mempool.
|
|
* :func:`blockchain.transaction.dsproof.subscribe` to receive notifications on
|
|
whether a particular transaction is known by the network to have been
|
|
double-spent.
|
|
* :func:`blockchain.transaction.dsproof.unsubscribe` to unsubscribe from
|
|
receiving dsproof notifications for a particular transaction.
|