From 441b7e86b72069061ee3dd534520ef9c7b39a8ac Mon Sep 17 00:00:00 2001 From: pasta Date: Wed, 11 Nov 2026 18:27:44 -0600 Subject: [PATCH] docs: fix stale or incorrect paths, names and links --- contrib/README.md | 4 ++-- contrib/devtools/README.md | 4 ++-- contrib/init/dashd.service | 2 +- contrib/verifybinaries/README.md | 18 +++++++++--------- contrib/verifybinaries/verify.py | 8 ++++---- doc/Doxyfile.in | 2 +- doc/README.md | 1 + doc/build-netbsd.md | 16 ++++++++-------- doc/build-openbsd.md | 2 -- doc/build-osx.md | 2 +- doc/developer-notes.md | 21 ++++++--------------- doc/files.md | 22 +++++++++++++--------- doc/init.md | 4 ++-- doc/tor.md | 2 +- test/lint/README.md | 2 ++ 15 files changed, 53 insertions(+), 57 deletions(-) diff --git a/contrib/README.md b/contrib/README.md index 46d365db3f58..de3bb9c5e53b 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -33,8 +33,8 @@ Test and Verify Tools ### [TestGen](/contrib/testgen) ### Utilities to generate test vectors for the data-driven Dash tests. -### [Verify-Binaries](/contrib/verify-binaries) ### -This script attempts to download and verify the signature file SHA256SUMS.asc from bitcoin.org. +### [Verify-Binaries](/contrib/verifybinaries) ### +This script attempts to download and verify the signature file `SHA256SUMS.asc` from GitHub releases and `dashcore-binaries.thepasta.org`. Command Line Tools --------------------- diff --git a/contrib/devtools/README.md b/contrib/devtools/README.md index ea370f3caace..7211c5b91b01 100644 --- a/contrib/devtools/README.md +++ b/contrib/devtools/README.md @@ -118,7 +118,7 @@ For example: dashpay/dash repository. What it does: -* Fetch master and the pull request. +* Fetch the target branch (the pull request's base by default) and the pull request. * Locally construct a merge commit. * Show the diff that merge results in. * Ask you to verify the resulting source tree (so you can do a make @@ -191,7 +191,7 @@ It will do the following automatically: - update git for added translations - update build system -See doc/translation-process.md for more information. +See doc/translation_process.md for more information. circular-dependencies.py ======================== diff --git a/contrib/init/dashd.service b/contrib/init/dashd.service index c0d00a469fcb..d58fde6929d3 100644 --- a/contrib/init/dashd.service +++ b/contrib/init/dashd.service @@ -42,7 +42,7 @@ TimeoutStopSec=600 # Directory creation and permissions #################################### -# Run as dash:dash +# Run as dashcore:dashcore User=dashcore Group=dashcore diff --git a/contrib/verifybinaries/README.md b/contrib/verifybinaries/README.md index ab831eea280c..15ce939e0bb1 100644 --- a/contrib/verifybinaries/README.md +++ b/contrib/verifybinaries/README.md @@ -2,29 +2,29 @@ #### Usage: -This script attempts to download the signature file `SHA256SUMS.asc` from https://bitcoin.org. +This script attempts to download the signature file `SHA256SUMS.asc` from GitHub releases (`https://github.com/dashpay/dash/releases`) and `https://dashcore-binaries.thepasta.org` and compares them. It first checks if the signature passes, and then downloads the files specified in the file, and checks if the hashes of these files match those that are specified in the signature file. -The script returns 0 if everything passes the checks. It returns 1 if either the signature check or the hash check doesn't pass. If an error occurs the return value is 2. +The script returns 0 if everything passes the checks. It returns 1 if either the signature check or the hash check doesn't pass. If an error occurs the return value is >= 2. ```sh -./verify.py bitcoin-core-0.11.2 -./verify.py bitcoin-core-0.12.0 -./verify.py bitcoin-core-0.13.0-rc3 +./verify.py 21.1.1 +./verify.py 22.0.0 +./verify.py 22.1.0-rc.1 ``` If you only want to download the binaries of certain platform, add the corresponding suffix, e.g.: ```sh -./verify.py bitcoin-core-0.11.2-osx -./verify.py 0.12.0-linux -./verify.py bitcoin-core-0.13.0-rc3-win64 +./verify.py 21.1.1-darwin +./verify.py 22.0.0-linux +./verify.py 22.1.0-rc.1-win64 ``` If you do not want to keep the downloaded binaries, specify anything as the second parameter. ```sh -./verify.py bitcoin-core-0.13.0 delete +./verify.py 22.0.0 delete ``` diff --git a/contrib/verifybinaries/verify.py b/contrib/verifybinaries/verify.py index 3622743152cf..815937ceced6 100755 --- a/contrib/verifybinaries/verify.py +++ b/contrib/verifybinaries/verify.py @@ -106,8 +106,8 @@ def main(args): if not success: print("Error: couldn't fetch signature file. " "Have you specified the version number in the following format?") - print(f"[{VERSIONPREFIX}][-rc[0-9]][-platform] " - f"(example: {VERSIONPREFIX}0.21.0-rc3-osx)") + print(f"[{VERSIONPREFIX}][-rc.N][-platform] " + f"(example: {VERSIONPREFIX}22.0.0-darwin)") print("wget output:") print(indent(output, '\t')) return 4 @@ -116,8 +116,8 @@ def main(args): sigfile2 = SIGNATUREFILENAME + ".2" success, output = download_with_wget(HOST2 + remote_sigfile, sigfile2) if not success: - print("github.com failed to provide signature file, " - "but dashcore-binaries.thepasta.org did?") + print("dashcore-binaries.thepasta.org failed to provide signature file, " + "but github.com did?") print("wget output:") print(indent(output, '\t')) remove_files([sigfile1]) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 611e4941a07e..6eab2544793c 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -793,7 +793,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = src dash-docs doc/release-notes/dash doc/README_doxygen.md +INPUT = src doc/release-notes/dash doc/README_doxygen.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/doc/README.md b/doc/README.md index e0be1a3834fa..c2c57fd8e244 100644 --- a/doc/README.md +++ b/doc/README.md @@ -37,6 +37,7 @@ The following are developer notes on how to build Dash Core on your native platf - [macOS Build Notes](build-osx.md) - [Unix Build Notes](build-unix.md) - [Windows Build Notes](build-windows.md) +- [FreeBSD Build Notes](build-freebsd.md) - [OpenBSD Build Notes](build-openbsd.md) - [NetBSD Build Notes](build-netbsd.md) diff --git a/doc/build-netbsd.md b/doc/build-netbsd.md index e24fd7e49648..29dd9363048d 100644 --- a/doc/build-netbsd.md +++ b/doc/build-netbsd.md @@ -18,19 +18,19 @@ pkgin install autoconf automake libtool pkg-config git gmake boost libevent gmp ``` -NetBSD currently ships with an older version of `gcc` than is needed to build. You should upgrade your `gcc` and then pass this new version to the configure script. +NetBSD may ship with an older version of `gcc` than is needed to build C++20 (GCC 11.1+ is required). You should install a newer `gcc` and pass it to the configure script. -For example, grab `gcc9`: +For example, grab `gcc12`: ``` -pkgin install gcc9 +pkgin install gcc12 ``` Then, when configuring, pass the following: ```bash ./configure ... - CC="/usr/pkg/gcc9/bin/gcc" \ - CXX="/usr/pkg/gcc9/bin/g++" \ + CC="/usr/pkg/gcc12/bin/gcc" \ + CXX="/usr/pkg/gcc12/bin/g++" \ ... ``` @@ -52,7 +52,7 @@ It is not necessary to build wallet functionality to run dashd or the GUI. ###### Descriptor Wallet Support -`sqlite3` is required to enable support for [descriptor wallets](https://github.com/dashpay/dash/blob/master/doc/descriptors.md). +`sqlite3` is required to enable support for [descriptor wallets](descriptors.md). ```bash pkgin install sqlite3 @@ -83,10 +83,10 @@ pkgin install qrencode #### Test Suite Dependencies There is an included test suite that is useful for testing code changes when developing. -To run the test suite (recommended), you will need to have Python 3 installed: +To run the test suite (recommended), you will need to have Python 3.10+ installed: ```bash -pkgin install python37 +pkgin install python312 ``` ### Building Dash Core diff --git a/doc/build-openbsd.md b/doc/build-openbsd.md index 8ccc3e7e25e4..5a9c1beba8f1 100644 --- a/doc/build-openbsd.md +++ b/doc/build-openbsd.md @@ -13,8 +13,6 @@ Run the following as root to install the base dependencies for building. pkg_add bash git gmake gmp libevent libtool boost zstd # Select the newest version of the following packages: pkg_add autoconf automake python - -git clone https://github.com/dashpay/dash.git ``` See [dependencies.md](dependencies.md) for a complete overview. diff --git a/doc/build-osx.md b/doc/build-osx.md index b7590ca99b44..7439a7f78b4c 100644 --- a/doc/build-osx.md +++ b/doc/build-osx.md @@ -238,7 +238,7 @@ This process could take many hours, or even days on slower than average systems. By default, blockchain and wallet data files will be stored in: ``` bash -/Users/${USER}/Library/Application Support/Dash/ +/Users/${USER}/Library/Application Support/DashCore/ ``` Before running, you may create an empty configuration file: diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 7737c51824ae..56511991ff7e 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -1279,6 +1279,12 @@ Current subtrees include: - src/minisketch - Upstream at https://github.com/sipa/minisketch ; maintained by Core contributors. +- src/dashbls + - Upstream at https://github.com/dashpay/bls-signatures ; maintained by Dash Core contributors. + +- src/immer + - Upstream at https://github.com/arximboldi/immer ; provides the immutable containers used by the deterministic masternode list. + Upgrading LevelDB --------------------- @@ -1398,21 +1404,6 @@ Release notes should be added to a PR-specific release note file at All `release-notes*` files are merged into a single [/doc/release-notes.md](/doc/release-notes.md) file prior to the release. -Release notes -------------- - -Release notes should be written for any PR that: - -- introduces a notable new feature -- fixes a significant bug -- changes an API or configuration model -- makes any other visible change to the end-user experience. - -Release notes should be added to a PR-specific release note file at -`/doc/release-notes-.md` to avoid conflicts between multiple PRs. -All `release-notes*` files are merged into a single -[/doc/release-notes.md](/doc/release-notes.md) file prior to the release. - RPC interface guidelines -------------------------- diff --git a/doc/files.md b/doc/files.md index 4f655a672471..ee5f323b204e 100644 --- a/doc/files.md +++ b/doc/files.md @@ -27,8 +27,8 @@ The data directory is the default location where the Dash Core files are stored. Platform | Data directory path ---------|-------------------- Linux | `$HOME/.dashcore/` -macOS | `$HOME/Library/Application Support/Dashcore/` -Windows | `%APPDATA%\Dashcore\` [\[1\]](#note1) +macOS | `$HOME/Library/Application Support/DashCore/` +Windows | `%APPDATA%\DashCore\` [\[1\]](#note1) 2. A custom data directory path can be specified with the `-datadir` option. @@ -47,10 +47,13 @@ Subdirectory | File(s) | Description -------------------|-----------------------|------------ `blocks/` | | Blocks directory; can be specified by `-blocksdir` option (except for `blocks/index/`) `blocks/index/` | LevelDB database | Block index; `-blocksdir` option does not affect this path -`blocks/` | `blkNNNNN.dat`[\[2\]](#note2) | Actual Dash blocks (in network format, dumped in raw on disk, 128 MiB per file) -`blocks/` | `revNNNNN.dat`[\[2\]](#note2) | Block undo data (custom format) +`blocks/` | `blkNNNNN.dat`[\[2\]](#note2) | Actual Dash blocks (in network format, optionally zstd-compressed with `-blockcompression`, 128 MiB per file) +`blocks/` | `revNNNNN.dat`[\[2\]](#note2) | Block undo data (custom format, optionally zstd-compressed with `-blockcompression`) `chainstate/` | LevelDB database | Blockchain state (a compact representation of all currently unspent transaction outputs (UTXOs) and metadata about the transactions they are from) `indexes/txindex/` | LevelDB database | Transaction index; *optional*, used if `-txindex=1` +`indexes/addressindex/` | LevelDB database | Address index; *optional*, used if `-addressindex=1` +`indexes/spentindex/` | LevelDB database | Spent output index; *optional*, used if `-spentindex=1` +`indexes/timestampindex/` | LevelDB database | Block timestamp index; *optional*, used if `-timestampindex=1` `indexes/blockfilter/basic/db/` | LevelDB database | Blockfilter index LevelDB database for the basic filtertype; *optional*, used if `-blockfilterindex=basic` `indexes/blockfilter/basic/` | `fltrNNNNN.dat`[\[2\]](#note2) | Blockfilter index filters for the basic filtertype; *optional*, used if `-blockfilterindex=basic` `indexes/coinstats/db/` | LevelDB database | Coinstats index; *optional*, used if `-coinstatsindex=1` @@ -66,6 +69,7 @@ Subdirectory | File(s) | Description `./` | `governance.dat` | stores data for governance objects `./` | `mncache.dat` | stores data for masternode list `./` | `netfulfilled.dat` | stores data about recently made network requests +`./` | `sporks.dat` | stores spork state `./` | `fee_estimates.dat` | Stores statistics used to estimate minimum transaction fees required for confirmation `./` | `guisettings.ini.bak` | Backup of former [GUI settings](#gui-settings) after `-resetguisettings` option is used `./` | `ip_asn.map` | IP addresses to Autonomous System Numbers (ASNs) mapping used for bucketing of the peers; path can be specified with the `-asmap` option @@ -120,11 +124,11 @@ These subdirectories and files are no longer used by Dash Core: Path | Description | Repository notes ---------------|-------------|----------------- `banlist.dat` | Stores the addresses/subnets of banned nodes; completely ignored and superseded by `banlist.json` in 20.0 | [PR #5574](https://github.com/dashpay/dash/pull/5574) -`blktree/` | Blockchain index; replaced by `blocks/index/` in [0.8.0](https://github.com/dash/dash/blob/master/doc/release-notes/release-notes-0.8.0.md#improvements) | [PR #2231](https://github.com/dash/dash/pull/2231), [`8fdc94cc`](https://github.com/dash/dash/commit/8fdc94cc8f0341e96b1edb3a5b56811c0b20bd15) -`coins/` | Unspent transaction output database; replaced by `chainstate/` in 0.8.0 | [PR #2231](https://github.com/dash/dash/pull/2231), [`8fdc94cc`](https://github.com/dash/dash/commit/8fdc94cc8f0341e96b1edb3a5b56811c0b20bd15) -`blkindex.dat` | Blockchain index BDB database; replaced by {`chainstate/`, `blocks/index/`, `blocks/revNNNNN.dat`[\[2\]](#note2)} in 0.8.0 | [PR #1677](https://github.com/dash/dash/pull/1677) -`blk000?.dat` | Block data (custom format, 2 GiB per file); replaced by `blocks/blkNNNNN.dat`[\[2\]](#note2) in 0.8.0 | [PR #1677](https://github.com/dash/dash/pull/1677) -`addr.dat` | Peer IP address BDB database; replaced by `peers.dat` in [0.7.0](https://github.com/dash/dash/blob/master/doc/release-notes/release-notes-0.7.0.md) | [PR #1198](https://github.com/dash/dash/pull/1198), [`928d3a01`](https://github.com/dash/dash/commit/928d3a011cc66c7f907c4d053f674ea77dc611cc) +`blktree/` | Blockchain index; replaced by `blocks/index/` in [0.8.0](https://github.com/bitcoin/bitcoin/blob/master/doc/release-notes/release-notes-0.8.0.md#improvements) | [PR #2231](https://github.com/bitcoin/bitcoin/pull/2231), [`8fdc94cc`](https://github.com/bitcoin/bitcoin/commit/8fdc94cc8f0341e96b1edb3a5b56811c0b20bd15) +`coins/` | Unspent transaction output database; replaced by `chainstate/` in 0.8.0 | [PR #2231](https://github.com/bitcoin/bitcoin/pull/2231), [`8fdc94cc`](https://github.com/bitcoin/bitcoin/commit/8fdc94cc8f0341e96b1edb3a5b56811c0b20bd15) +`blkindex.dat` | Blockchain index BDB database; replaced by {`chainstate/`, `blocks/index/`, `blocks/revNNNNN.dat`[\[2\]](#note2)} in 0.8.0 | [PR #1677](https://github.com/bitcoin/bitcoin/pull/1677) +`blk000?.dat` | Block data (custom format, 2 GiB per file); replaced by `blocks/blkNNNNN.dat`[\[2\]](#note2) in 0.8.0 | [PR #1677](https://github.com/bitcoin/bitcoin/pull/1677) +`addr.dat` | Peer IP address BDB database; replaced by `peers.dat` in [0.7.0](https://github.com/bitcoin/bitcoin/blob/master/doc/release-notes/release-notes-0.7.0.md) | [PR #1198](https://github.com/bitcoin/bitcoin/pull/1198), [`928d3a01`](https://github.com/bitcoin/bitcoin/commit/928d3a011cc66c7f907c4d053f674ea77dc611cc) ## Notes diff --git a/doc/init.md b/doc/init.md index 87fa5cd81ee4..d557cfb0541a 100644 --- a/doc/init.md +++ b/doc/init.md @@ -125,8 +125,8 @@ use old versions of Upstart and do not supply the start-stop-daemon utility. Copy dashd.init to /etc/init.d/dashd. Test by running `service dashd start`. Using this script, you can adjust the path and flags to the dashd program by -setting the DASHD and FLAGS environment variables in the file -/etc/sysconfig/dashd. You can also use the DAEMONOPTS environment variable here. +setting the `BITCOIND_BIN` and `BITCOIND_OPTS` environment variables in the file +/etc/sysconfig/dashd. You can also use the `DAEMONOPTS` environment variable here. ### macOS diff --git a/doc/tor.md b/doc/tor.md index 9fdf7ef602f0..daf884ad5528 100644 --- a/doc/tor.md +++ b/doc/tor.md @@ -173,7 +173,7 @@ details). If you configure your Tor system accordingly, it is possible to make your node also reachable from the Tor network. Add these lines to your /etc/tor/torrc (or equivalent config file): *Needed for Tor version 0.2.7.0 and older versions of Tor only. For newer -versions of Tor see [Section 4](#4-automatically-listen-on-tor).* +versions of Tor see [Section 2](#2-automatically-create-a-dash-core-onion-service).* HiddenServiceDir /var/lib/tor/dashcore-service/ HiddenServicePort 9999 127.0.0.1:9996 diff --git a/test/lint/README.md b/test/lint/README.md index a09b2398b540..312409b01f51 100644 --- a/test/lint/README.md +++ b/test/lint/README.md @@ -84,6 +84,8 @@ maintained: * for `src/crypto/ctaes`: https://github.com/bitcoin-core/ctaes.git (branch master) * for `src/crc32c`: https://github.com/bitcoin-core/crc32c-subtree.git (branch bitcoin-fork) * for `src/minisketch`: https://github.com/sipa/minisketch.git (branch master) +* for `src/dashbls`: https://github.com/dashpay/bls-signatures.git (branch develop) +* for `src/immer`: https://github.com/arximboldi/immer.git (branch master) To do so, add the upstream repository as remote: