bitcoin/doc
Ava Chow a7129f827c
Merge bitcoin/bitcoin#24313: Improve display address handling for external signer
4357158c47 wallet: return and display signer error (Sjors Provoost)
dc55531087 wallet: compare address returned by displayaddress (Sjors Provoost)
6c1a2cc09a test: use h marker for external signer mock (Sjors Provoost)

Pull request description:

  * HWI returns the requested address: as a sanity check, we now compare that to what we expected
     * external signer documentation now reflects that HWI alternatives must implement this check
  * both RPC and GUI will now return an error text, rather than just fail (the GUI even failed silently in some cases)

ACKs for top commit:
  brunoerg:
    ACK 4357158c47
  achow101:
    ACK 4357158c47

Tree-SHA512: 4f56edf3846745c8e7d08ef55cf29e8bb468256457149377c5f02da097931f9ca0c06bdbd856dc2385cde4fd11e4dc3b634c5a48814ff27f5562c8a25d43da93
2024-04-23 17:20:54 -04:00
..
design Merge bitcoin/bitcoin#29648: Remove libbitcoinconsensus 2024-04-01 17:53:31 +02:00
man
policy [doc] fix docs and comments from v3 2024-02-12 14:27:25 +00:00
release-notes doc: archive 27.0 release notes 2024-04-16 09:10:33 +01:00
.gitignore
assets-attribution.md
benchmarking.md
bips.md doc: document that BIP324 on by default for v27.0 2024-02-19 15:37:59 +00:00
bitcoin_logo_doxygen.png
bitcoin-conf.md
build-android.md
build-freebsd.md
build-netbsd.md
build-openbsd.md doc: Update OpenBSD build docs to 7.4 2024-02-26 16:05:47 +00:00
build-osx.md doc: remove mention of missing bdb being a configure error 2023-11-15 13:34:50 +00:00
build-unix.md Merge bitcoin/bitcoin#29756: doc: Override -g properly to skip debugging information 2024-04-01 16:54:44 +02:00
build-windows.md doc: remove mingw-w64 install for "older" systems 2023-11-17 10:57:51 +00:00
cjdns.md
dependencies.md depends: qt 5.15.13 2024-03-27 16:45:21 +00:00
descriptors.md doc: Add example of mixing private and public keys in descriptors 2024-03-15 16:28:43 +03:00
developer-notes.md [clang-tidy] Enable the misc-no-recursion check 2024-04-07 14:04:45 +01:00
dnsseed-policy.md Update the developer mailing list address. 2024-04-02 15:38:40 -03:00
Doxyfile.in
external-signer.md wallet: compare address returned by displayaddress 2024-04-16 17:47:43 +02:00
files.md
fuzzing.md doc: remove references to disable-asm option now that it's gone 2024-02-29 19:10:31 +00:00
guix.md
i2p.md
init.md
JSON-RPC-interface.md Update JSON-RPC-interface.md 2023-08-17 13:46:18 +01:00
managing-wallets.md doc: explain what the wallet password does 2024-04-22 18:07:23 +03:00
multiprocess.md doc: Add multiprocess design doc 2023-12-22 16:23:33 -05:00
multisig-tutorial.md
offline-signing-tutorial.md doc: update signet faucet link in offline-signing-tutorial.md 2024-03-04 00:14:29 +07:00
p2p-bad-ports.md
productivity.md
psbt.md
README_doxygen.md
README_windows.txt
README.md remove libbitcoinconsensus 2024-03-18 16:59:39 +00:00
reduce-memory.md doc: Be vague instead of wrong about MALLOC_ARENA_MAX 2023-09-20 17:12:24 +00:00
reduce-traffic.md doc: update/clarify max outbound connection count 2023-12-11 20:05:25 +01:00
release-notes-27114.md docs: add release notes for #27114 2024-02-28 10:05:56 -03:00
release-notes-27375.md doc: add release notes and help text for unix sockets 2024-03-01 14:47:29 -05:00
release-notes-27679.md doc: release notes for PR 27679 2024-04-16 14:14:42 -04:00
release-notes-empty-template.md doc: add minimum required Linux Kernel to release-notes 2023-12-07 13:53:41 +00:00
release-process.md doc: Add link to needs-release-notes label 2023-12-07 15:56:39 +01:00
REST-interface.md
tor.md
tracing.md
translation_process.md doc: Update translation_process.md 2024-02-14 21:39:39 -03:00
translation_strings_policy.md
zmq.md validationinterface: only send zmq notifications for active 2023-09-30 06:38:47 -04:00

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.