bitcoin/doc
Andrew Chow 92be831847
Merge bitcoin/bitcoin#25412: rest: add `/deploymentinfo` endpoint
a8250e30f1 doc: add release note about `/rest/deploymentinfo` (brunoerg)
5c96020024 doc: add `/deploymentinfo` in REST-interface (brunoerg)
3e44bee08e test: add coverage for `/rest/deploymentinfo` (brunoerg)
91497031cb rest: add `/deploymentinfo` (brunoerg)

Pull request description:

  #23508 added a new RPC named `getdeploymentinfo`, it moved the softfork section from `getblockchaininfo` into this new one. In the REST interface, we have an endpoint named`/rest/chaininfo.json` (which refers to `getblockchaininfo`), so, this PR adds a new REST endpoint named `/deploymentinfo` which refers to `getdeploymentinfo`.

  You can use it by passing a block hash, e.g: '/rest/deploymentinfo/<BLOCKHASH>.json' or you can use it without passing a block hash to get the 'deploymentinfo' for the last block.

ACKs for top commit:
  jonatack:
    re-ACK a8250e30f1 rebase-only since my last review at c65f82bb
  achow101:
    ACK a8250e30f1
  stickies-v:
    re-ACK a8250e30f1

Tree-SHA512: 0735183b6828d51a72ed0e2be5a09b314ac4693f548982c6e9adaa0ef07a55aa428d3b2d1b1de70b83169811a663a8624b686166e5797f624dcc00178b9796e6
2022-10-13 13:30:55 -04:00
..
design doc: add note about snapshot chainstate init 2022-09-13 13:31:37 -04:00
man
policy [doc] remove non-signaling mentions of BIP125 2022-08-04 16:56:33 +01:00
release-notes doc: add historical 0.21.2 release notes 2022-09-20 09:30:10 +01:00
.gitignore
Doxyfile.in
JSON-RPC-interface.md
README.md doc: consolidate & remove release-note fragments 2022-09-15 16:02:17 +01:00
README_doxygen.md
README_windows.txt
REST-interface.md Merge bitcoin/bitcoin#25412: rest: add `/deploymentinfo` endpoint 2022-10-13 13:30:55 -04:00
assets-attribution.md
benchmarking.md
bips.md doc: bump bips.md up-to-date version to v24.0 2022-10-03 01:25:31 +02:00
bitcoin-conf.md Security config warning 2022-08-19 23:18:13 -04:00
bitcoin_logo_doxygen.png
build-android.md
build-freebsd.md
build-netbsd.md doc: update for NetBSD 9.2, add GUI Build Instructions 2022-07-06 21:27:05 -04:00
build-openbsd.md doc: Fix command in "OpenBSD Build Guide" 2022-06-07 23:04:20 +02:00
build-osx.md Revert "doc: note that brew installed qt is not supported" 2022-09-14 13:51:17 +01:00
build-unix.md doc: remove note on arm cross-compilation from build-unix.md 2022-07-05 14:09:36 -04:00
build-windows.md
cjdns.md
dependencies.md Merge bitcoin/bitcoin#25917: depends: libnatpmp 07004b97cf691774efebe70404cf22201e4d330d 2022-09-21 17:04:16 +01:00
descriptors.md doc: add `{import,list}descriptors` to list of descriptor RPCs 2022-08-25 00:04:01 +02:00
developer-notes.md scripted-diff: rename CChainState -> Chainstate 2022-09-09 11:47:27 -04:00
dnsseed-policy.md
external-signer.md
files.md
fuzzing.md
guix.md
i2p.md doc: document I2P transient addresses usage in doc/i2p.md 2022-08-16 13:02:19 +02:00
init.md
managing-wallets.md doc: Release notes and other docs for migration 2022-08-29 17:30:38 -04:00
multisig-tutorial.md
p2p-bad-ports.md
productivity.md doc: add distcc to productivity notes 2022-06-13 16:13:11 +02:00
psbt.md
reduce-memory.md
reduce-traffic.md
release-notes-22087.md Validate `port` options 2022-10-05 19:30:15 +02:00
release-notes-25412.md doc: add release note about `/rest/deploymentinfo` 2022-08-16 19:21:51 -03:00
release-notes-empty-template.md
release-process.md Merge bitcoin/bitcoin#24424: doc: release process chainparams updates 2022-05-30 15:55:12 +02:00
shared-libraries.md
tor.md
tracing.md doc: document coin selection tracepoints 2022-04-21 11:11:02 -04:00
translation_process.md
translation_strings_policy.md
zmq.md Update zmq.md: Fix parameter in hwm example block 2022-05-25 23:49:15 +02:00

README.md

Bitcoin Core

Setup

Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions, which requires a few hundred gigabytes of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.

To download Bitcoin Core, visit bitcoincore.org.

Running

The following are some helpful notes on how to run Bitcoin Core on your native platform.

Unix

Unpack the files into a directory and run:

  • bin/bitcoin-qt (GUI) or
  • bin/bitcoind (headless)

Windows

Unpack the files into a directory, and then run bitcoin-qt.exe.

macOS

Drag Bitcoin Core to your applications folder, and then run Bitcoin Core.

Need Help?

Building

The following are developer notes on how to build Bitcoin Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

Development

The Bitcoin repo's root README contains relevant information on the development process and automated testing.

Resources

Miscellaneous

License

Distributed under the MIT software license.