Commit Graph

25 Commits

Author SHA1 Message Date
MarcoFalke
d40eedbf01 Merge #19050: doc: Add warning for rest interface limitation
5c3eaf9983043db1b61a98c95d692a6958670b86 doc: Add warnings for http interfaces limitations (Fabian Jahr)

Pull request description:

  `libevent`, which is used for our rest interface, can use up all of the available file descriptors in a system if too many connections are opened at once. If a new block is connected at the same time and can not be written to disk because there are no file descriptors available, the node crashes. Based on my investigation so far the issue is best solved upstream which means we have to wait for the next release (2.2). In the meantime it would be good if we would warn users of this limitation.

  See #11368 for more background.

ACKs for top commit:
  MarcoFalke:
    ACK 5c3eaf9983043db1b61a98c95d692a6958670b86

Tree-SHA512: 73914538588477ead19068f5832fdcc8e0eb736e51f73b3aca501c93165e5ad634c2511a3fcffff251adcd3efda23a742b48211ad9d3b2a29cdeac17201d06a1
2021-07-15 19:38:52 -05:00
Wladimir J. van der Laan
f1e0b21c8e Merge #18810: doc: update rest info on block size and json
ff6549c3c84ca7324032dbc37744645bf2fe1c3e fix: update rest info on block size and json (Chris Abrams)

Pull request description:

  Addressing the ambiguous block size text in rest docs: https://github.com/bitcoin/bitcoin/issues/18703

  Also makes sure to let developers know there is `.json` option for the rest output format.

ACKs for top commit:
  MarcoFalke:
    ACK ff6549c3c84ca7324032dbc37744645bf2fe1c3e
  promag:
    ACK ff6549c3c84ca7324032dbc37744645bf2fe1c3e.

Tree-SHA512: 9ef93c1432d650b1f9599778ba092c1ca5b084a537af257078e1c713c76c5d3a4cc4b1ede8a2489964be8ed0303ad8bea58c1cb4759bbb9b24dbdebfec8001d3
2021-07-13 21:05:56 -05:00
Wladimir J. van der Laan
8d4a65d196 Merge #14592: doc: Add external interface consistency guarantees
fa77aaa5ad21563dd18ce3e407d391d37ac8c201 doc: Add external interface consistency guarantees (MarcoFalke)

Pull request description:

  An attempt to clarify our consistency guarantees for developers and users

Tree-SHA512: 8bad6a2bcfd85f0aeeecf3b090332f64c778c69a838a519d11ea83f2cb51929b9f43a7e9b2469567f305a1277206cafe8e65041f1a002dadbe69259d6a0adc18
2021-07-03 13:44:50 -05:00
Jonas Schnelli
517788dabc
Merge #14353: REST: add blockhash call, fetch blockhash by height
42ff30ec6 [Docs] add short documentation for /rest/blockhashbyheight (Jonas Schnelli)
579d418f7 [QA] add rest tests for /rest/blockhashbyheight/<HEIGHT>.<FORMAT> (Jonas Schnelli)
eb9ef04c4 REST: add "blockhashbyheight" call, fetch blockhash by height (Jonas Schnelli)

Pull request description:

  Completes the REST interface for trivial block exploring by adding a call that allows to fetch the blockhash in the main chain by a given height.

Tree-SHA512: 94be9e56718f857279b11cc16dfa8d04f3b5a762e87ae54281b4d87247c71c844895f4944d5a47f09056bf851f4c4761ac4fbdbaaee957265d14de5c1c73e8d2
2021-06-28 13:40:57 -05:00
Wladimir J. van der Laan
949f158bc1
Merge #15177: rest: Improve tests and documention of /headers and /block
7cf994d5cfd53dcff76ebd0e0007e3477a7570e8 qa: Improve tests of /rest/headers and /rest/block (João Barbosa)
0825b86b280c684c32c60bac9e862298c7279f27 doc: /rest/block responds with 404 if block does not exist (João Barbosa)
be625f7c5562afed517ff51d2d85268ba5ce6017 doc: Explain empty result of /rest/headers (João Barbosa)

Pull request description:

  Follow up of #15107.

Tree-SHA512: a7fdeed05216e3eda9604664db529237c2d0ddf422cfac139d6345a22b6e00bfe870d4e3f177423db7d4efb295ac2dc0ca2eb20c9c27c0719b89fd5428860d03
2021-06-28 13:40:57 -05:00
MarcoFalke
62047500d2
Merge #12584: Fix typos and cleanup documentation
a9761cae1c Fix typos and cleanup (Dimitris Apostolou)

Pull request description:

  [ci-skip]

Tree-SHA512: 6d7e02d8fdf6add702bbfe4439ace9c8621b45d21111abc69d85be9120347b06a029bc1885665547c1230ebc41da9d97210f6d1325b7692a4585356969ecb127
2020-07-17 15:42:50 -05:00
UdjinM6
becca24fcc
Few fixes in docs/comments (#3068)
* Few fixes in docs/comments

* Add descriptions
2019-08-28 10:54:19 +03:00
Pasta
2b9216e98d
/s/BTC/DASH
Signed-off-by: Pasta <pasta@dashboost.org>
2019-07-17 19:01:41 -05:00
Wladimir J. van der Laan
a60f1e2b5c
Merge #10710: REST/RPC example update
b8bb425 REST/RPC example update (Michael Rotarius)

Tree-SHA512: 3a7003f5996f58d9881e7b7a9155f8b1c233faea2977cd02c481567b60fa47105433184da3d887ef3ec28775ad33719b779bff2753d64b775b29d8a7a6214fda
2019-07-17 18:55:31 -05:00
Wladimir J. van der Laan
7269e4a901 Merge #8567: Add default port numbers to REST doc
c911035 Add default port numbers to REST doc (djpnewton)
2018-01-09 14:04:19 +01:00
Will Wray
82a4643135 Doc: fix broken formatting in markdown #headers (#1462)
* Doc: fix broken formatting in markdown #headers

Insert a space in markdown headers between the #'s and the header text.
(It appears that the space is required since a github update a year ago
https://github.com/blog/2100-github-pages-now-faster-and-simpler-with-jekyll-3-0)

* Update REST-interface.md

* Update guide-startmany.md

* Update instantsend.md

* Update keepass.md

* Update release-process.md
2017-05-05 14:28:08 +03:00
Pavel Janík
70180b2e57 Implement REST mempool API, add test and documentation. 2015-08-14 07:01:03 +02:00
Simon Males
0ef9858707 Documenting pruned, pruneheight and softforks in getblockchaininfo 2015-07-19 14:07:35 +02:00
Simon Males
0c895799c8 Include pruned state in chaininfo.json 2015-07-18 10:32:09 +02:00
tailsjoin
9fbca205d4 doc: Remove recommendation to add old repos for libd4.8*
It is unreasonable to ask to change the global package configuration
just to build a package. Not only that, this is potentially harmful to the system.

Also do a few punctuation fixes in REST-interface.md.
2015-07-15 09:20:51 +02:00
Jonas Schnelli
c45c7ea0fa [REST] add JSON support for /rest/headers/ 2015-07-05 15:48:33 +02:00
Jonas Schnelli
6e71efa9f0 [REST] remove json input for getutxos, limit to query max. 15 outpoints
Remove possibility to send json encoded parameters to `/rest/getutxos/` to avoid possible DoS scenarios.

The JSON output option is untouched.
2015-05-27 20:10:02 +02:00
Jonas Schnelli
b448002772 [Docs] fix and improve REST documentation
- fix bad formatting of getutxos
- added getztxos example
- fix different command syntax
2015-05-18 16:52:01 +02:00
Wladimir J. van der Laan
1fd2d39529
Merge pull request #5420
6b4feb8 [QA] rest.py RPC test: change setgenerate() to generate() (Jonas Schnelli)
97ee866 [REST] getutxos REST command (based on Bip64) (Jonas Schnelli)
2015-05-06 16:50:05 +02:00
Jonas Schnelli
2ccfc6360d [REST] update documentation
- add documentation for /rest/headers
- reformat sections
2015-04-23 14:49:40 +02:00
Jonas Schnelli
6b4feb89a8 [QA] rest.py RPC test: change setgenerate() to generate() 2015-04-21 20:33:02 +02:00
paveljanik
abcec3082e Update REST URL to match reality 2015-04-20 13:29:21 +02:00
Jonas Schnelli
2c0f901ea9 [REST] rest/chaininfos add documentation 2014-12-29 20:27:46 +01:00
Jonas Schnelli
cae548685d [REST] added /rest/block/notxdetails/<hash> into REST-interface.md documentation 2014-12-09 16:05:50 +01:00
Jonas Schnelli
199627c94c [REST] adding basic documentation 2014-11-26 14:34:44 +01:00