bitcoin/doc
Andrew Chow fa53611cf1
Merge bitcoin/bitcoin#26076: Switch hardened derivation marker to h
fe49f06c0e doc: clarify PR 26076 release note (Sjors Provoost)
bd13dc2f46 Switch hardened derivation marker to h in descriptors (Sjors Provoost)

Pull request description:

  This makes it easier to handle descriptor strings manually, especially when importing from another Bitcoin Core wallet.

  For example the `importdescriptors` RPC call is easiest to use `h` as the marker: `'["desc": ".../0h/..."]'`, avoiding the need for escape characters. With this change `listdescriptors` will use `h`, so you can copy-paste the result, without having to add escape characters or switch `'` to 'h' manually.

  Both markers can still be parsed.

  The `hdkeypath` field in `getaddressinfo` is also impacted by this change, except for legacy wallets. The latter is to prevent accidentally breaking ancient software that uses our legacy wallet.

  See discussion in #15740

ACKs for top commit:
  achow101:
    ACK fe49f06c0e
  darosior:
    re-ACK fe49f06c0e

Tree-SHA512: f78bc873b24a6f7a2bf38f5dd58f2b723e35e6b10e4d65c36ec300e2d362d475eeca6e5afa04b3037ab4bee0bf8ebc93ea5fc18102a2111d3d88fc873c08dc89
2023-05-08 13:31:28 -04:00
..
design docs: update assumeutxo.md 2023-03-07 16:06:20 -05:00
man
policy [policy] disallow transactions under min relay fee, even in packages 2023-04-17 09:53:59 +01:00
release-notes doc: add 23.1 release notes 2022-12-16 09:43:56 +00:00
.gitignore
assets-attribution.md
benchmarking.md
bips.md doc: mention BIP86 in doc/bips.md 2022-11-01 20:50:51 +01:00
bitcoin_logo_doxygen.png
bitcoin-conf.md
build-android.md
build-freebsd.md Merge bitcoin/bitcoin#26773: doc: FreeBSD build doc updates to reflect removal of install_db4.sh 2023-02-16 14:50:00 +00:00
build-netbsd.md
build-openbsd.md doc: update OpenBSD build docs for 7.3 (external signer support available) 2023-04-11 22:59:08 +02:00
build-osx.md
build-unix.md build: remove --enable-upnp-default from configure 2023-01-28 15:27:23 +00:00
build-windows.md doc: Correct linked Microsoft URLs 2022-12-31 16:54:13 +01:00
cjdns.md
dependencies.md Bump python minimum version to 3.8 2023-04-21 10:18:19 +02:00
descriptors.md doc: correct deriveaddresses RPC name 2022-10-30 18:11:45 +00:00
developer-notes.md Update developer-notes.md 2023-04-14 20:11:51 +03:30
dnsseed-policy.md
Doxyfile.in
external-signer.md
files.md
fuzzing.md doc: use arch agnostic clang path in fuzzing doc (macOS) 2023-02-08 09:45:04 +00:00
guix.md
i2p.md doc: remove recommended I2P router versions 2023-01-09 08:18:58 -08:00
init.md Remove -sysperms option 2023-02-05 08:09:16 +00:00
JSON-RPC-interface.md rpc: Allow named and positional arguments to be used together 2022-11-05 05:32:39 -04:00
managing-wallets.md Change dots to an ellipsis and fix capitalization 2023-01-12 11:15:02 -05:00
multisig-tutorial.md
p2p-bad-ports.md
productivity.md
psbt.md
README_doxygen.md
README_windows.txt
README.md
reduce-memory.md doc: NetPermissionFlags for tx relay in blocksonly 2023-01-30 11:21:49 +00:00
reduce-traffic.md
release-notes-25158.md doc: add release notes for abandoned field in gettransaction and listtransactions 2023-01-13 10:29:05 -03:00
release-notes-26076.md doc: clarify PR 26076 release note 2023-05-08 16:07:15 +02:00
release-notes-26094.md rpc: return block hash & height in getbalances, gettransaction & getwalletinfo JSONs 2023-04-26 16:07:47 +02:00
release-notes-empty-template.md doc: Mac -> macOS in release notes template 2022-11-17 14:43:56 +00:00
release-process.md [doc] Add post branch-off note about fuzz input pruning 2023-05-04 19:39:57 +02:00
REST-interface.md Merge bitcoin/bitcoin#26207: rest: add verbose and mempool_sequence query params for mempool/contents 2023-03-15 19:39:30 -04:00
shared-libraries.md
tor.md doc: update DataDirectoryGroupReadable 1 in tor.md 2023-04-07 12:31:58 -05:00
tracing.md Add mempool tracepoints 2023-03-20 15:57:31 +01:00
translation_process.md
translation_strings_policy.md
zmq.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.