Minor documentation updates
This commit is contained in:
parent
fe90dfaf7c
commit
3e6ced6039
@ -33,9 +33,7 @@ Features
|
|||||||
time to height 448k (mid January 2017) reported is under 4h 30m. On
|
time to height 448k (mid January 2017) reported is under 4h 30m. On
|
||||||
the same hardware JElectrum would take around 4 days and
|
the same hardware JElectrum would take around 4 days and
|
||||||
electrum-server probably around 1 month.
|
electrum-server probably around 1 month.
|
||||||
- The full Electrum protocol is implemented. The only exception is
|
- The full current Electrum protocol is implemented.
|
||||||
the blockchain.address.get_proof RPC call, which is not used by
|
|
||||||
Electrum GUI clients, and can only be invoked from the command line.
|
|
||||||
- Various configurable means of controlling resource consumption and
|
- Various configurable means of controlling resource consumption and
|
||||||
handling denial of service attacks. These include maximum
|
handling denial of service attacks. These include maximum
|
||||||
connection counts, subscription limits per-connection and across all
|
connection counts, subscription limits per-connection and across all
|
||||||
|
|||||||
@ -5,11 +5,11 @@ Electrum Protocol
|
|||||||
This is intended to be a reference for client and server authors
|
This is intended to be a reference for client and server authors
|
||||||
alike.
|
alike.
|
||||||
|
|
||||||
I have attempted to ensure what is written is correct for the three
|
I have attempted to ensure what is written is correct for the two
|
||||||
known server implementations: electrum-server, jelectrum and
|
known remaining server implementations: jelectrum and ElectrumX, and
|
||||||
ElectrumX, and also for Electrum clients of the 2.x series. We know
|
also for Electrum clients of the 2.x series. We know other clients
|
||||||
other clients exist but I am not aware of the source of any being
|
exist but I am not aware of the source of any being publicly
|
||||||
publicly available.
|
available.
|
||||||
|
|
||||||
|
|
||||||
Message Stream
|
Message Stream
|
||||||
@ -25,14 +25,14 @@ requests should limit their size depending on the nature of their
|
|||||||
query, because servers will limit response size as an anti-DoS
|
query, because servers will limit response size as an anti-DoS
|
||||||
mechanism.
|
mechanism.
|
||||||
|
|
||||||
RPC calls and responses are separated by newlines in the stream. The
|
Eeach RPC call, and each response, is separated by a single newline in
|
||||||
JSON specification does not permit control characters within strings,
|
their respective streams. The JSON specification does not permit
|
||||||
so no confusion is possible there. However it does permit newlines as
|
control characters within strings, so no confusion is possible there.
|
||||||
extraneous whitespace between elements; client and server MUST NOT use
|
However it does permit newlines as extraneous whitespace between
|
||||||
newlines in such a way.
|
elements; client and server MUST NOT use newlines in such a way.
|
||||||
|
|
||||||
If using JSON RPC 2.0's feature of parameter passing by name, the
|
If using JSON RPC 2.0's feature of parameter passing by name, the
|
||||||
names shown in the protocol versions's description MUST be used.
|
names shown in the protocol version's description MUST be used.
|
||||||
|
|
||||||
A server advertising support for a particular protocol version MUST
|
A server advertising support for a particular protocol version MUST
|
||||||
support each method documented for that protocol version, unless the
|
support each method documented for that protocol version, unless the
|
||||||
@ -41,6 +41,7 @@ additional parameters with unspecified behaviour. Use of additional
|
|||||||
parameters is discouraged as it may conflict with future versions of
|
parameters is discouraged as it may conflict with future versions of
|
||||||
the protocol.
|
the protocol.
|
||||||
|
|
||||||
|
|
||||||
Notifications
|
Notifications
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
@ -257,19 +258,6 @@ Return the unconfirmed transactions of a bitcoin address.
|
|||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
blockchain.address.get_proof
|
|
||||||
============================
|
|
||||||
|
|
||||||
This method is optional and deprecated, and hence its response will
|
|
||||||
not be described here.
|
|
||||||
|
|
||||||
blockchain.address.get_proof(**address**)
|
|
||||||
|
|
||||||
**address**
|
|
||||||
|
|
||||||
The address as a Base58 string.
|
|
||||||
|
|
||||||
|
|
||||||
blockchain.address.listunspent
|
blockchain.address.listunspent
|
||||||
==============================
|
==============================
|
||||||
|
|
||||||
@ -681,9 +669,8 @@ following changes:
|
|||||||
|
|
||||||
* improved semantics of `server.version` to aid protocol negotiation,
|
* improved semantics of `server.version` to aid protocol negotiation,
|
||||||
and a changed return value.
|
and a changed return value.
|
||||||
* version 1.0 methods `blockchain.address.get_proof`,
|
* version 1.0 methods `blockchain.utxo.get_address`
|
||||||
`blockchain.utxo.get_address` and `blockchain.numblocks.subscribe`
|
and `blockchain.numblocks.subscribe` have been removed.
|
||||||
have been removed.
|
|
||||||
* method `blockchain.transaction.get` no longer takes the *height*
|
* method `blockchain.transaction.get` no longer takes the *height*
|
||||||
argument that was ignored in 1.0, providing one will return an
|
argument that was ignored in 1.0, providing one will return an
|
||||||
error.
|
error.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user