57 Commits

Author SHA1 Message Date
Calin Culianu 73b8911292 Revert "Add and document address and scripthash transactions subscription methods" 2022-07-25 21:05:19 -05:00
mainnet-pat e10abfb0a3 Bump version to 1.4.6; Add blochain.scripthash.transactions.subscribe, blochain.scripthash.transactions.unsubscribe, blochain.address.transactions.subscribe, blochain.address.transactions.unsubscribe methods 2021-09-13 14:00:48 +00:00
Calin Culianu 005253d108 Added blockchain.transaction.dsproof.* documentation
Plus misc fixups and added a section in Protocol Basics describing what
a double-spend proof object contains.

Bumped docs version to 1.4.5.
2021-03-02 16:40:56 +02:00
Calin Culianu 9061333153 Added blockchain.transaction.subscribe and unsubscribe
Plus misc. fixups.

Still left to document: the blockchain.transaction.dsproof.* methods.
2021-03-02 15:21:34 +02:00
Calin Culianu 5f7d78a12b Fix: Make blockchain.utxo.get_info use snake_case
The params were being listed in a weird way.

- fixed: prevoutHash -> tx_hash
- fixed: prevoutN -> out_n
2020-06-24 00:28:26 +03:00
Calin Culianu 4435f3b2b0 Added documentation for blockchain.utxo.get_info 2020-06-24 00:17:29 +03:00
Calin Culianu fa97adfe96 Corrected errata. get_balance returns numeric, not string balance
This has been an error for far too long. Finally fixed.
2020-06-23 21:16:26 +03:00
Calin Culianu 09bfe76816 Added ws_port and wss_port description to server.features 2020-04-16 01:47:11 +03:00
Calin Culianu 123aef81b1 Updated conf.py, also removed reference to AuXPoW data 2020-03-26 23:57:32 +02:00
Calin Culianu d9a7152ba9 Updated conf.py, and also the blockchain.address.* address description 2020-03-26 23:48:44 +02:00
Calin Culianu f9ce2d910f More changes for Fulcrum 2020-03-26 20:49:29 +02:00
Calin Culianu 48839428c5 More Fulcrum specific edits 2020-03-26 20:38:23 +02:00
Calin Culianu ea49396dd5 Reworded the address paremeter to not require Legacy
@dagurval says he doesn't want to support legacy addresses necessarily,
so I reworded the text to indicate servers may or may not support
legacy.
2020-03-23 20:34:02 +02:00
Calin Culianu 8acb8978a0 Added documentation for new method blockchain.address.get_scripthash
I went ahead and created this method because it might be useful for
clients to prefer to work with script hashes directly (since they are
unambiguous) whereas addresses have some ambiguity attached to them.

I documented this method and also fixed some typos and some nits in the
existing documentation.
2020-03-23 20:23:40 +02:00
Calin Culianu 9191d735aa Added documentation for the resurrected blockchain.address.* methods
Updated protocol-changes, protocol-methods, and protocol-removed to
reflect their new (old) documentation and their status as revived in
version 1.4.3 of the protocol.
2020-03-23 09:35:45 +02:00
dagurval 7bd94147e4 "coin units" -> "satoshis"
Fix units used in `blockchain.scripthash.get_balance`
2020-01-20 20:15:08 +01:00
Calin Culianu 576b88768a Clarification for server.features missing 'hosts'
The implicit assumption in the code of ElectronX/ElectrumX and Fulcrum already is that a missing hosts key or a missing 'route' in `server.features` indicates the peer server no longer wishes to peer or that the route in question is not available for peering.  As such,  I added language to the `server.featutes` description to indicate this subtlety.
2020-01-16 10:40:58 +02:00
Calin Culianu 8a3d8ba275 Clarify the caveat of the missing hosts key from features
Added language to explain that if the hosts key is missing, other servers will not peer with the server.
2020-01-16 09:25:18 +02:00
dagurval a47742078f Merge pull request #2 from dagurval/dash-be-gone
Remove Dash-specific RPC methods
2020-01-14 08:50:24 +01:00
Dagur Valberg Johannsson 2fe10cded3 Remove Dash-specific RPC methods 2020-01-13 10:07:54 +01:00
Dagur Valberg Johannsson af8dee9e00 servers.feature: Make key hosts RECOMMENDED
Rationale:
It can be difficult for the server to auto-discover its host and ports.
For example if SSL is provided through reverse proxy.

Having this feature as MUST will thus force manual configuration, which
increases the difficulty for operators to setup and maintain a server.
2020-01-10 12:06:31 +00:00
ghost43 a268315237 docs: fix method signature for blockchain.transaction.get (#930)
The 'merkle' arg might be added in a later protocol version
but it is not present atm.
2019-12-01 14:46:04 +00:00
Neil Booth a12ec38a4d Update protocol docs 2019-04-16 14:45:31 +01:00
Neil Booth 3a71db37ce Portocol: add blockchain.scripthash.unsubscribe 2019-04-16 14:14:50 +01:00
Neil Booth f24df4722e Fix docs for cp_height 2019-02-07 21:05:30 +08:00
JeremyRand 2050bf8dd7 Truncate AuxPoW for block heights covered by a checkpoint (#710) 2019-01-26 04:55:05 +08:00
Neil Booth 31bd326cad Update documentation 2019-01-10 21:24:29 +08:00
zebra-lucky 1fee00f189 add dash dip3 protx.diff, protx.info protocol methods (#683) 2019-01-09 00:28:07 +01:00
Michael Schmoock 2b034ca9d1 chore: fix a markle merkle typo (#673) 2018-12-19 16:44:49 +08:00
Neil Booth a0c8fbe631 Note 1.5 protocol as draft 2018-08-11 18:38:13 +09:00
Neil Booth 0d642c28a3 Populate the header merkle cache in a thread
- It can take a while
- Client requests that need it will block until it's done
- It's a function of FS state so move it to the DB
- Tweak docs

Fixes #558
2018-08-08 17:26:34 +09:00
Neil Booth 920fb0b6c0 Add documentation of proposed protocol 1.5 changes 2018-08-07 15:09:26 +09:00
Neil Booth 9f1472647a Fix doc linkage 2018-07-18 19:21:39 +08:00
Neil Booth 311aa330ea Use JSON RPC terms in docs, not Python 2018-07-18 14:28:44 +08:00
Neil Booth 6457b8cbba Minor tweaks. 2018-07-18 08:46:37 +08:00
ghost43 70a47c62a9 new protocol method: blockchain.transaction.id_from_pos (#524) 2018-07-18 08:35:34 +08:00
Neil Booth 9beb501218 Protocol 1.4: only accept a single server.version message
- remove unused self.client_version
- coerce client_name to a str
2018-07-17 09:16:26 +08:00
Neil Booth 2267b239d9 Update docs for raw headers. 2018-07-16 19:29:04 +08:00
Neil Booth 508f78cef5 Implement merkle proof for blockchain.block.headers 2018-07-16 17:32:49 +08:00
Neil Booth 851722f5d3 Implement merkle proofs for blockchain.block.header 2018-07-16 16:02:55 +08:00
Neil Booth a957668831 Update documentation for protocol 1.4 2018-07-16 14:49:14 +08:00
Neil Booth caf143bb41 More doc updates 2018-07-12 11:49:49 +08:00
Neil Booth ff0198a2ef Document removed metohds in new file 2018-07-12 11:30:42 +08:00
Neil Booth 8d876da1bd blockchain.headers.subscribe: raw defaults to True in 1.3
Update docs for this and other omissions.
2018-07-12 11:23:18 +08:00
Neil Booth d60f442c86 Deprecate blockchain.block.get_header as of protocol 1.3
Use new blockchain.block.header instead.
2018-07-12 00:31:49 +08:00
Neil Booth 7f807a4d63 Fix underscore length 2018-07-03 18:04:00 -07:00
elmora-do 8ec4e0718e Update masternode doc and masternode_list rpc method (#493)
* Update protocol-methods.rst

* Error is raised if the payees is not a list in RPC method masternode_list
2018-06-13 01:30:05 +08:00
elmora-do 7f18d7dedd Add $PAC (#474)
* Add $PAC

* Refactor and improve masternode notifications
* Update DASH/$PAC RPC documentation

These RPC commands were documented:

masternode.announce.broadcast
masternode.subscribe
masternode.list
masternode.info
2018-06-06 09:15:36 +09:00
Neil Booth 39fca5268e Fix doc typo 2018-03-11 23:11:43 +08:00
Neil Booth bf317702da Documentation updates 2018-03-08 17:43:06 +08:00