elements/doc
Andrew Poelstra e0532f60c7
Merge ElementsProject/elements#933: doc: add document describing Taproot sighashes
cca82245f8 doc: fix `SigMsg` length in taproot sighash (Andrew Poelstra)
7ca7983c2a doc/taproot-sighash: encode issuance rangeproofs in sighash; clean up padding etc (Andrew Poelstra)
04cb40010f doc/taproot-sighash: clarify text about pegin input data (Andrew Poelstra)
a88e4c5b1d doc/taproot-sighash: remove "padded" CTxOut format from doc (Andrew Poelstra)
41de29493f taproot-sighash.mediawiki: address formatting/typo comments from Russell (Andrew Poelstra)
dc5b3185b4 taproot-sighash.mediawiki: remove input `nNonce` field (Andrew Poelstra)
f62c8d19d3 taproot-sighash.mediawiki: fix ambiguity in text (Andrew Poelstra)
a552fbf470 update taphash doc (sanket1729)
88d41e5ba2 doc: add missing nNonce field for ACP taproot sighashes (Andrew Poelstra)
639f6f3a98 doc: expand all confidential fields in taproot-sighash to fixed 33 bytes (Andrew Poelstra)
d19dd01ce6 doc: add document describing Taproot sighashes (Andrew Poelstra)

Pull request description:

  Thanks to @roconnor-blockstream for writing the first draft of this document.

ACKs for top commit:
  sanket1729:
    ACK cca82245f8

Tree-SHA512: a534a0be313b5ba3c74ad4f2cdb1e009f1c240f5f85aeb06195325ff87348a1c1457252c9b347de4400446d0fc98def8c4df55176d4481c44449f5bc4e2917b1
2021-07-07 17:06:45 +00:00
..
man Merge 2065ef66ee into merged_master (Bitcoin PR #17265) 2020-11-09 23:10:12 +00:00
release-notes doc: Add historical release notes for 0.20.1 2020-08-01 14:17:14 +02:00
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 2017-04-07 16:28:12 +02:00
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 2015-09-18 18:14:42 +02:00
benchmarking.md Replace current benchmarking framework with nanobench 2020-06-13 12:24:18 +02:00
bips.md docs: mention BIPs 340-342 in doc/bips.md 2020-10-15 14:20:20 -07:00
bitcoin-conf.md doc: add default bitcoin.conf locations 2019-08-19 19:34:57 +02:00
bitcoin_logo_doxygen.png Lossless image optimization 2013-12-02 10:10:22 +01:00
build-freebsd.md Merge f28c949f72 into merged_master (Elements PR #815) 2020-11-26 01:09:05 +00:00
build-netbsd.md doc: mention MAKE=gmake workaround when building on a BSD 2020-03-18 07:55:07 +08:00
build-openbsd.md Add OpenBSD instructions for building the Qt GUI 2020-09-10 16:02:10 +02:00
build-osx.md Merge 8ed37f6c84 into merged_master (Bitcoin PR #19077) 2020-11-30 20:20:56 +00:00
build-unix.md Merge f3727fd735 into merged_master (Bitcoin PR #20156) 2020-12-01 18:41:26 +00:00
build-windows.md Add Windows WSL build recommendation to temporarily disable Win32 PE support. 2020-06-29 13:25:59 +01:00
dependencies.md Make sqlite support optional (compile-time) 2020-10-20 13:44:43 +00:00
descriptors.md Output a descriptor in createmultisig and addmultisigaddress 2020-01-30 23:55:36 -05:00
developer-notes.md Remove unused LockAssertion struct 2020-09-19 18:02:42 +03:00
dnsseed-policy.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
Doxyfile.in [doc] include Doxygen comments for HAVE_BOOST_PROCESS 2020-07-31 13:38:10 +02:00
elements-upstream-tracking.md Further revisions in response to comments 2021-02-26 01:00:16 -08:00
files.md Merge #20152: doc: Update wallet files in files.md 2020-10-27 15:43:53 +08:00
fuzzing.md doc: afl fuzzing comment about afl-gcc and afl-g++ 2020-07-05 20:55:11 -04:00
gitian-building.md doc: move gitian building to external repo 2017-09-25 15:45:38 +02:00
init.md fixing documentation to not require rpcpassword 2020-03-21 19:51:31 +05:30
JSON-RPC-interface.md Replace hidden service with onion service 2020-08-07 14:55:02 +02:00
multiprocess.md build: multiprocess autotools changes 2020-05-12 09:47:06 -04:00
productivity.md doc: Drop protobuf stuff 2020-05-23 10:14:18 +03:00
psbt.md doc: fix/improve analyzepsbt in doc/psbt.md 2019-05-19 17:31:37 +02:00
pset.mediawiki Mark PSET as being implemented 2021-06-22 14:42:19 -04:00
README.md Merge be60e37e40 into merged_master (Bitcoin PR #18505) 2020-11-26 01:08:08 +00:00
README_doxygen.md doc: Improve doxygen readme navigation section 2019-09-23 19:22:06 -04:00
README_windows.txt QT: Remove ^M and trailing whitespace 2019-04-10 13:22:52 -04:00
reduce-memory.md doc: block-relay-only is not blocksonly 2020-03-30 09:09:12 -04:00
reduce-traffic.md doc: Use precise permission flags where possible 2020-07-10 15:37:42 +02:00
release-notes.md addrman: ensure old versions don't parse peers.dat 2020-11-11 16:05:15 +01:00
release-process.md doc: fix getchaintxstats fields in release-process.md 2020-11-01 22:19:24 +01:00
REST-interface.md Merge #19390: doc/REST-interface: Remove stale info 2020-06-29 13:32:01 +08:00
shared-libraries.md doc: correct bitcoinconsensus_version in shared-libraries 2019-04-07 21:42:32 +08:00
taproot-sighash.mediawiki doc: fix SigMsg length in taproot sighash 2021-07-01 22:20:37 +00:00
tapscript_opcodes.md Address Andrew's suggestions 2021-06-28 13:43:39 -07:00
tor.md doc: Update onion service target port numbers in tor.md 2020-10-01 19:19:43 +03:00
translation_process.md build: Factor out qt translations from build system 2019-09-29 14:24:54 +02:00
translation_strings_policy.md doc: Do not translate technical or extremely rare errors 2020-05-05 04:46:08 +03:00
zmq.md doc: Adjust ZMQ usage to support multiple interfaces 2020-09-23 23:14:28 +02: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/elementsd (headless)
  • bin/elements-qt (GUI)

Windows

Unpack the files into a directory, and then run elements-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.